Class: Router

Source Location: /system/helpers/Router.php

Class Overview [line 32]

Base
   |
   --Router

This application is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Author(s):

Version:

Copyright:

  • Andrew Judd, 2010

Variables

Constants

Methods


Inherited Methods

Class: Base

Base::__construct()
Constructor, will create the Base object setting up anything that it requires.
Base::libxml_display_error()
Base::libxml_display_errors()
Base::__getErrorMessage()
This function is used in order to get external access to the list of error messages from a non-Base object class.
Base::__handleView()
This function is used internally in order to handle the actual processing of everything to do with the view. pieces and then present it in the specified order (as decided by where it is within the array.
Base::__initialize()
This function is used in order to initialize the configuration object if needed as well as set up the error messages based on the XML file located in the directory as speicified by the configuration file.
Base::__loadController()
This fucntion is used in order load a specific controller into the memory so that it is able to be used later on (from the controller folder).
Base::__loadHelper()
This function can be used anywhere in order to load a specific helper library in order to allow it to be used later on.
Base::__loadView()
This function is used to actually load the specified view on the page.
Base::__loadViews()
This function is used in order to load multiple views and display them on the page.
Base::__loadXML()
This function is used in order to load any flat XML file into an array.


Class Details

This application is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This application is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This application is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Tags:

[ Top ]


Class Variables

static $class =  __DEFAULTCLASS__

[line 37]

The class which will be instantiated and have a method called on it.

The class which will be instantiated and have a method called on it.

Tags:

  • access - private

Type: mixed

Overrides:

[ Top ]

static $function =  __DEFAULTFUNCTION__

[line 43]

The function within the specified class which will be called to display the page's information.

The function within the specified class which will be called to display the page's information.

Tags:

  • access - private

Type: mixed

Overrides:

[ Top ]


Class Methods

static __route

static void __route( )

[line 92]

This function completes the actual routing of the data to the corresponding page on the web site.

This function completes the actual routing of the data to the corresponding page on the web site.

Tags:

  • access - public

Parameters:

[ Top ]

static __setRoute

static void __setRoute( )

[line 57]

This function is used in order to set the information about the route which the user will be taking.

  • Class name (first parameter)
  • Function name (second parameter)
Any other values which are included in the URL will be included as a function parameter for the specified function. always be passed into the controller function based on the order which they come in the URI.

This function is used in order to set the information about the route which the user will be taking. The route is describe by two things:

  • Class name (first parameter)
  • Function name (second parameter)
Any other values which are included in the URL will be included as a function parameter for the specified function. These parameters will always be passed into the controller function based on the order which they come in the URI.

Tags:

  • access - public

Parameters:

[ Top ]


Class Constants


Documentation generated on Thu, 01 Jul 2010 20:37:18 -0400 by phpDocumentor 1.4.3