Class MVCnPHP_Mapping

Description

This is the mapping object. This holds all pertinent mapping data for a specific model or view. NOTE: not all available mappings are loaded for each request, only those needed for the current request.

Located in /Mapping.php (line 30)


	
			
Variable Summary
string $baseURL
string $forwards
string $name
string $type
string $typePath
Method Summary
string getBaseURL ()
array|boolean getForward (string $name)
void getForwards ()
string getName ()
string getPath ()
string getType ()
void setBaseURL (string $url)
void setForwards (array $forwards)
void setName (string $name)
void setType (string $type)
void setTypePath (string $path)
Variables
string $baseURL = null (line 59)
  • access: private
string $forwards = null (line 53)
  • access: private
string $name = null (line 35)
  • access: private
string $type = null (line 41)
  • access: private
string $typePath = null (line 47)
  • access: private
Methods
getBaseURL (line 84)

Gets the base URL for any redirects Any forwards to other URL's must be relative to the base URL provided

string getBaseURL ()
getForward (line 171)

Retrieves the requested forward

  • return: The forward data or false if not found
  • access: public
  • author: Tony Bibbs <tony@geeklog.net>
array|boolean getForward (string $name)
  • string $name: Name of forward to get
getForwards (line 157)
  • access: public
void getForwards ()
getName (line 112)

Gets the name for the model or view this mapping belongs to.

  • return: Name of the model or view
  • access: public
  • author: Tony Bibbs <tony@geeklog.net>
string getName ()
getPath (line 202)

Gets the absolute path where the code for this model or view this mapping belongs to can be found

  • return: Path to model or view directory
  • access: public
  • author: Tony Bibbs <tony@geeklog.net>
string getPath ()
getType (line 138)

Gets the type of object this mapping belongs to (model or view)

  • return: Type of object (model or view)
  • access: public
  • author: Tony Bibbs <tony@geeklog.net>
string getType ()
setBaseURL (line 69)

Sets the base URL for any redirects

void setBaseURL (string $url)
  • string $url: Base url for all redirects
setForwards (line 152)

Sets all forwards associated with this mapping. Note that you won't have forwards for any views

void setForwards (array $forwards)
  • array $forwards: Array of forwards tied to this object
setName (line 98)

Sets the name for the model or view this mapping belongs to.

void setName (string $name)
  • string $name: Name of model or view
setType (line 125)

Sets the type of object this mapping belongs to (model or view)

void setType (string $type)
  • string $type: Type of object (model or view)
setTypePath (line 188)

Sets the path where the models or views can be found

void setTypePath (string $path)
  • string $path: Absolute path ending with trailing slash

Documentation generated on Mon, 7 Mar 2005 22:36:22 -0600 by phpDocumentor 1.3.0RC3