URL & RRT

URL

Tequila URL is formed as follows

Yoursite/index.php?task=yourclass&mode=Mode&rrt=bl&YourOtherParameters

Where:

Your Site

Web address of your server, localhost, IP or domain name

Your class

Controller class to execute, this parameter can also take

default: Controller class name
- db.ldapname: Load task parameters from DB (as in version 2.x)
- xml.ldapname: Load task parameters from XML configuration file (pending)
- workitem: ID of a workitem (a running workflow, view workflow section for complete info)

Mode

Mode the controller have to execute, this is normally mapped to a protected function inside the controller.

RRT

Requested Response Type.

The kind of response the developer/system is expecting from this call, the default value is page and can take any of the following:

Available RRT's

Tequila likes precision and reuse, we believe that by specifying the response type you expect is easier to make predictable applications, it also enables you to reuse your content, i.e.

A reuse case:

1. Generate a Projects page and a Project Issues page
2. Use with full headers, just add a menu to access it
3. Mashup
  1. Create a HTML page with many divs
  2. Server side call project Browse method to display the project list on the left side
  3. Modify Browse method to add extra links
4. On Project click,

- 1. Using ajax call Issues page,
  2. Modify issues to filter by project (search method)
  3. You will get a perfect clean HTML code using rrt=bl
  4. Assign the response to the div.innerHTML

1. Edit Project properties link

- 1. Modify Project Browse method to add the extra link
  2. Using JS create an IFRAME or using prototype create a nice layer on top
  3. Set the src of the IFRAME to projects mode edit, rrt =nh

Perhaps is not very clear how to do all this but think about:

Page: will display the stand alone project page

nh, emtpy: will make the content available to show in a nice IFRAME

bl: Will make the content nice and clean to use in ajax text response

pg, page

Complete page with full headers and footers (view Header & footer section)

nh, empty

Page that uses HTML <head> section but empty, (nh = no headers)

This kind of page will include JS, CSS blocks but no logo, menus on headers etc, this page will include emptyheader and emptyfooter files (view Header & footer section for more)

bl, block

- HTML content
- NO HTML headers,
- Very useful to load content on client side using AJAX.
- All JS, JSVars, and CSS are removed
- The parent should include JS and CSS to maintain functionality and looks

xml

- XML response mime-type,
- No headers included,
- No template used,
- No JS & CSS included
- Language file included

xmlt

XML + Template

- XML response mime-type,
- No headers
- USE template
- Use language file

cd,sc, script, code

- Your own code takes care of response
- No response type set
- No template loaded
- No JS, CSS include

ps, html, htm

- passive content, html or text page no php behind
- Content is open and echoed

* Pending implementation

sb, serverblock

- Similar to block but executes on server side
- Useful to mashup content on server

excel

- Send excel mime-type
- Send other useful headers, expire, cache-control, filename,
- Content is normally sent using a table
- Headers are removed as in nh mode

openoffice

- Similar to excel but mime type as openoffice
- Add closing headers

* I see implementation has been altered in early release version, we'll add again in next release

Page updated

Google Sites

Report abuse