Packageindex Classtrees Modulegroups Elementlist Report XML Files

Request

Request

private class Request

 
Direct known subclasses: ModuleRequest, SectionRequest

Public Method Summary

void Request()
Initialize the class. Sets the $arrRequestVars attribute.
void isIncluded([ boolean $new_value ])
Whether or not the current request is being included within another
string getPath()
Gets a string representation of current path.
string getPathElement(integer $num)
Gets a specified element from the path. (starting at 0).
void setPathElement(integer $num, string $value)
Sets a specified element of the path.
integer countPathElements()
Returns a count of the number of elements in the path
void setVar(string $varname, mixed $value)
Sets a specific var in $arrRequestVars array.
array getTrailStart()
Gets the top-level section/node.
void setTrail(array $trail)
Set the breadcrumb trail that will be appended to top-level node.
void addTrailPoint(array $point)
Appends a trail "point" (e.g. node) to the breadcrumb trail.
void setTrailPoint(array $index, $point)
Manually sets a trail "point" (e.g. node) in the breadcrumb trail.
array getTrail()
An abstract method that you should override in your subclasses.
string getSidebarScript()
Returns the script to use for the sidebar.
void setSidebarScript(string $script)
Sets the script to use for sidebar.
string getPageTitle()
An abstract method that you may override in your subclasses.
string getWindowTitle([ string $delim ])
A method for getting the window title.
void setPageTitle(string $page_title)
A method to manually set PageTitle, for cases when it cannot be dynamically
string getMetaKeywords()
An abstract method that you must override in your subclasses.
void setMetaKeywords(string $keywords)
A method to manually set MetaKeywords, for cases when it cannot be dynamically
string getMetaDescription()
An abstract method that you must override in your subclasses.
void setMetaDescription(string $desc)
A method to manually set MetaDescription, for cases when it cannot be dynamically
string getVarsAsQueryString([ array $ignore ])
Returns a query string for all the variablies in the Request
string getVarsAsHiddenInputs([ array $ignore ])
Returns a query string for all the variablies in the Request

Private Method Summary

string setPath(string $path)
Set the request path to use (processes to account for default_path)
void setPathDefault(string $path_to_redirect, string $redirected_path)
Sets a default path to use for a module. Use
mixed getPathDefault(string $pathToRedirect)
Gets a default rewrite path (if set). Use
mixed getVar(string $varname)
Gets a value from request (by default $_REQUEST).
array getVars()
Gets all values from request (by default $_REQUEST).
void delVar(string $varname)
Unsets a variable.
void setVars([ array $vars ])
Set the $arrRequestVars variable.
void addVars(array $vars)
Adds an array of vars to the $arrRequestVars variable.
object PEAR getScript()
An abstract method that you must override in your subclasses.

Private Field Summary

array $children
Sub-requests
$parent
Parent request
array $arrPath

array $arrPathDefaults

array $arrRequestVars

boolean $blnIncluded
blnIncluded
string $strPageTitle
Page Title
string $strMetaKeywords
META Keywords
string $strMetaDescription
META Description
array $arrTrail
Hard-coded breadcrumb trail.
$sidebarScript
Name of script to use for right side bar.

Public Method Details

Request

public void Request()

 

Returns void


isIncluded

public void isIncluded([ boolean $new_value ])

  page.

Parameter
boolean $new_value = >>null<<
The new value for $_included.
Returns void


getPath

public string getPath()

 

Returns string

Path built from $arrPath


getPathElement

public string getPathElement(integer $num)

 

Parameter
integer $num
The index to retrieve
Returns string

element of $arrPath


setPathElement

public void setPathElement(integer $num, string $value)

 

Parameter
integer $num
The index to set.
string $value
The value to set it to.
Returns void


countPathElements

public integer countPathElements()

 

Returns integer


setVar

public void setVar(string $varname, mixed $value)

 

Parameter
string $varname
mixed $value
Returns void


getTrailStart

public array getTrailStart()

  This is the HOME section. The main navigation tier happens to be a section for this site framework. You could of course change this, but more than likely a "homepage" is going to be a site section (with customized template) rather than a content module / application.

Returns array

The Top-level navigation component.


setTrail

public void setTrail(array $trail)

 

Parameter
array $trail
The multi-dimentional array that is the breadcrumb trail.
Returns void


addTrailPoint

public void addTrailPoint(array $point)

 

Parameter
array $point
Hash of trail data [crumb, url].
Returns void


setTrailPoint

public void setTrailPoint(array $index, $point)

 

Parameter
array $index
Hash of trail data [crumb, url].
$point
Warning: documentation is missing.
Returns void


getTrail

public array getTrail()

  This class will return contents of $arrTrail array, appended to the top-level section 'HOME'). There is currently no proper way of overriding this auto-prepend behavior.

Returns array


getSidebarScript

public string getSidebarScript()

 

Returns string


setSidebarScript

public void setSidebarScript(string $script)

 

Parameter
string $script
Returns void


getPageTitle

public string getPageTitle()

  By default just returns the value in $strPageTitle

Returns string


getWindowTitle

public string getWindowTitle([ string $delim ])

  This is based on the breadcrumb trail.

Parameter
string $delim = >>': '<<
This is the text to separate elements of title.
Returns string


setPageTitle

public void setPageTitle(string $page_title)

  built. (e.g. modules don't have a rule for page title, while sections do).

Parameter
string $page_title
Returns void


getMetaKeywords

public string getMetaKeywords()

  By default just returns the value in $strMetaKeywords

Returns string

The Keywords to use in META tag.


setMetaKeywords

public void setMetaKeywords(string $keywords)

  built. (e.g. modules don't have a rule for keywords, while sections do).

Parameter
string $keywords
Returns void


getMetaDescription

public string getMetaDescription()

  By default just returns the value in $strMetaDescription.

Returns string

The Description to use in META tag.


setMetaDescription

public void setMetaDescription(string $desc)

  built. (e.g. modules don't have a rule for description, while sections do).

Parameter
string $desc
Returns void


getVarsAsQueryString

public string getVarsAsQueryString([ array $ignore ])

  Useful for persisting of values via href links.

Parameter
array $ignore = >>null<<
set of variables to exclude
Returns string


getVarsAsHiddenInputs

public string getVarsAsHiddenInputs([ array $ignore ])

  Useful for persisting of values via href links.

Parameter
array $ignore = >>null<<
set of variables to exclude
Returns string


Private Method Details

setPath

private string setPath(string $path)

  and now defaults to "list" if no action is specified.

Parameter
string $path
Returns string

the Path that was set. (may be different if default_path was set for that module)


setPathDefault

private void setPathDefault(string $path_to_redirect, string $redirected_path)

  Modules::setAttribute('module_name', 'default_action', 'action_name') now.

Parameter
string $path_to_redirect
string $redirected_path
Returns void


getPathDefault

private mixed getPathDefault(string $pathToRedirect)

  Modules::setAttribute('module_name', 'default_action', 'action_name') now.

Parameter
string $pathToRedirect
Returns mixed

Value at $arrPathDefaults or NULL if not set.


getVar

private mixed getVar(string $varname)

 

Parameter
string $varname
Returns mixed

Value of $arrRequestVars[$vname] or NULL if not set.


getVars

private array getVars()

 

Returns array

All vars.


delVar

private void delVar(string $varname)

 

Parameter
string $varname
The variable name
Returns void


setVars

private void setVars([ array $vars ])

  If no param, or null param, then it will reset the $arrRequestVars to an empty array.

Parameter
array $vars = >>null<<
Returns void


addVars

private void addVars(array $vars)

  Like setVars() but does not erase current contents.

Parameter
array $vars
Returns void


getScript

private object PEAR getScript()

  The assumption is that if you are using Request instead of a subclass, then you are probably already in the script you want to load. (e.g. you're not using load.php)

Returns object PEAR

::Error because this is an abstract method & should not be invoked.


Private Field Details

$children

private array $children

>>array()<<


$parent

private $parent

>>null<<


$arrPath

private array $arrPath

>>array()<<


$arrPathDefaults

private array $arrPathDefaults

>>array()<<


$arrRequestVars

private array $arrRequestVars

>>array()<<


$blnIncluded

private boolean $blnIncluded

>>false<<


$strPageTitle

private string $strPageTitle

>>''<<


$strMetaKeywords

private string $strMetaKeywords

>>''<<


$strMetaDescription

private string $strMetaDescription

>>''<<


$arrTrail

private array $arrTrail

>>array()<<


$sidebarScript

private $sidebarScript

>>null<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de