Class BaseController

Description

This calss extends the functionality of Zend_Controller_Action

All Common Functionlity of Controllers will reside in this class, and will override any default functionality of Zend_Controller_Action (if Required)

Located in /controllers/BaseController.php (line 40)

Zend_Controller_Action
   |
   --BaseController
Direct descendents
Class Description
CompareController Enter description here...
ErrorController ErrorController is the default controller to handle different errors, such as, invalid actions, database connectivity errors, and other application errors.
FilterController FilterController is used for filtering search results. it is not responsible for filtering following actions.
IndexController This is the default controller, which is required to handle all the root level actions. It typically works with the urls such as http://inquiredemo.etilize.com/REST/. It forwards this root request to home page.
ProductController This controller is used to get the content for any product. It uses REST based architecture to talk to the Etilize web services in order to get these content information.
SearchController SearchController is responsible to control all the search actions. However, it is not responsible for filtering actions.
Variable Summary
mixed $endtime
mixed $starttime
Method Summary
$categoriesId, getChildCategories ( $categoryId)
$products populateSearchResults ($phpobject $phpobject)
void postDispatch ()
void preDispatch ()
string renderDynamicTemplates (string $action,  $template, string $tempalte)
$phpobject, serviceRequest ($parameters, $parameters, $requestType, $type)
void setFooter ([ $showSearchBox = true])
void setHeader ( $showSearchBox,  $showDC, [ $populateDCBar = true])
void setHomePage ()
$products setWSRequestFailed ([$phpobject $reason = null], [ $detail = null], [ $suggestion = null])
Variables
mixed $endtime (line 45)
  • access: public
mixed $starttime (line 43)
  • access: public
Methods
getAllCategories (line 501)

Method to get all Categories and cache them

  • access: public
void getAllCategories ()
getAllManufactures (line 453)

Method to get all Manufaturer and cache them

  • access: public
void getAllManufactures ()
getChildCategories (line 394)

Method to Get all the Child Categoris of a category

  • return: containing Categories IDs as an array
  • access: public
$categoriesId, getChildCategories ( $categoryId)
  • $categoryId
populateSearchResults (line 234)

This method populates the required data on Search Result Page

  • return: array of product to be shown
  • access: public
$products populateSearchResults ($phpobject $phpobject)
  • $phpobject $phpobject
postDispatch (line 70)

This method overrides the default functionality of Zend_Controller_Action

and calculates the total tome spent to process the selected action

  • access: public
void postDispatch ()
preDispatch (line 52)

This method overrides the default functionality of Zend_Controller_Action

and sets the rootPath and rootDirectory variable from configuration file and restrict access to logged in users only

  • access: public
void preDispatch ()
renderDynamicTemplates (line 86)

This method wil dispatch to the script path where fragment template need to be included and automatically map it with current script path template directory.

  • access: public
string renderDynamicTemplates (string $action,  $template, string $tempalte)
  • string $action
  • string $tempalte
  • $template
serviceRequest (line 198)

This is helper method and is used to perform web service request. It makes the web service call and return a php object.

  • return: PHP object that is created from the returned XML data
  • access: public
$phpobject, serviceRequest ($parameters, $parameters, $requestType, $type)
  • $parameters, $parameters: contains the request parameters
  • $requestType, $type: which type of request will be created and send to $gateway
setCompareProductPage (line 178)

This method sets the variable that are required for Compare Products Page rendering

  • access: public
void setCompareProductPage ()
setFooter (line 129)

This method renders the Footer template and stores the HTML response in includeFooter variable of viewRenders instance that is available on View

  • access: public
void setFooter ([ $showSearchBox = true])
  • $showSearchBox
setHeader (line 104)

This method renders the header and dislayCategories templates and stores the HTML response in displayCategories & includeHeader variables of viewRenders instance that is available on View

  • access: public
void setHeader ( $showSearchBox,  $showDC, [ $populateDCBar = true])
  • $showSearchBox
  • $showDC
  • $populateDCBar
setHomePage (line 141)

This method sets the variable that are required for Home Page rendering

  • access: public
void setHomePage ()
setSearchResultsPage (line 159)

This method sets the variable that are required for Search Results Page rendering

  • access: public
void setSearchResultsPage ()
setWSRequestFailed (line 277)

This method populates the required data on Search Result Page

  • return: array of product to be shown
  • access: public
$products setWSRequestFailed ([$phpobject $reason = null], [ $detail = null], [ $suggestion = null])
  • $phpobject $reason
  • $detail
  • $suggestion

Documentation generated on Wed, 13 Feb 2008 01:57:30 +0500 by phpDocumentor 1.4.0a2