dmRoute Class Reference

Public Member Functions

Static Public Member Functions


Detailed Description

Definition at line 19 of file dmRoute.class.php.


Constructor & Destructor Documentation

dmRoute::__construct ( action,
controller,
view = null,
method = null,
id = null,
format = 'html',
dmTemplateSet tpl = null 
) [final]
Parameters:
string action The URI action to which the route is bound
string controller The controller that the action should instantiate
string view The view template that the action should load
string method The method that the action should invoke
string id The ID that should be passed to the method (optional)
dmTemplateSet tpl
Exceptions:
dmInvalidRouteException if the specified action's controller or method are invalid (the controller or method does not exist).
Since:
0.1

Definition at line 223 of file dmRoute.class.php.


Member Function Documentation

dmRoute::getAction (  )  [final]
Returns:
string The URI action for which the route is defined
Since:
0.1

Definition at line 241 of file dmRoute.class.php.

dmRoute::getController (  )  [final]
Returns:
string The CamelCase name of the controller used by this route with the "ControlLer" suffix
Since:
0.1

Definition at line 250 of file dmRoute.class.php.

Referenced by getTemplateSet(), and getViewFilename().

static dmRoute::getCurrent (  )  [static, final]
dmRoute::getFormat (  )  [final]
Returns:
string
Since:
0.1

Definition at line 258 of file dmRoute.class.php.

dmRoute::getID (  )  [final]
Returns:
string The ID of the resource identified by this route
Since:
0.1

Definition at line 266 of file dmRoute.class.php.

Referenced by getTemplateSet().

dmRoute::getMethod (  )  [final]
Returns:
string
Since:
0.1

Definition at line 274 of file dmRoute.class.php.

Referenced by getTemplateSet().

dmRoute::getTemplateSet (  )  [final]
Returns:
dmTemplateSet
Since:
0.4

Definition at line 306 of file dmRoute.class.php.

dmRoute::getView (  )  [final]

Gets the name of the view template (not the full filename).

See also:
dmRoute::getViewFilename()
Returns:
string
Since:
0.1

Definition at line 345 of file dmRoute.class.php.

Referenced by getViewFilename().

dmRoute::getViewFilename ( dmTemplateSet ts  )  [final]

Gets the filename of the view.

Parameters:
dmTemplateSet ts
Returns:
string
See also:
dmRoute::getView()
Since:
0.4

Definition at line 357 of file dmRoute.class.php.

dmRoute::isMobile (  )  [final]
Returns:
Boolean
Since:
0.5

Definition at line 290 of file dmRoute.class.php.

Referenced by getTemplateSet().

dmRoute::setMethod ( str  )  [final]
Parameters:
string str
Since:
0.4

Definition at line 282 of file dmRoute.class.php.

Referenced by __construct().

dmRoute::setMobile ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.5

Definition at line 298 of file dmRoute.class.php.

dmRoute::setTemplateSet ( dmTemplateSet set  )  [final]

Overrides the current template set.

Parameters:
dmTemplateSet set
Since:
0.4

Definition at line 334 of file dmRoute.class.php.

Referenced by __construct().

dmRoute::setView ( view  )  [final]

Overrides the current view.

Parameters:
string view View name (not full filename)
Returns:
void
Since:
0.4

Definition at line 378 of file dmRoute.class.php.

Referenced by __construct().


The documentation for this class was generated from the following file:

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1