CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.3 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.3
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BakeTask
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeRoute
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbConfigTask
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • FileLog
  • FixtureTask
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • MootoolsEngineHelper
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginShortRoute
  • PluginTask
  • ProjectTask
  • PrototypeEngineHelper
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • Set
  • Shell
  • String
  • TemplateTask
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count

Class PagesController

Static content controller

Override this controller by placing a copy in controllers directory of an application

Object
Extended by Controller
Extended by AppController
Extended by PagesController
Package: cake\cake\libs\controller
Link: http://book.cakephp.org/view/958/The-Pages-Controller
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: controller/pages_controller.php

Properties summary

  • $helpers public
    array
    Default helper
  • $name public
    string
    Controller name
  • $uses public
    array
    This controller does not use a model

Inherited Properties

  • Component, __httpCodes, action, autoLayout, autoRender, base, cacheAction, components, data, ext, here, layout, layoutPath, methods, modelClass, modelKey, modelNames, output, paginate, params, passedArgs, persistModel, plugin, scaffold, validationErrors, view, viewPath, viewVars, webroot

Method Summary

  • display() public
    Displays a view

Method Detail

display() public ¶

display( )

Displays a view

Methods inherited from Controller

__construct() public ¶

__construct( )

Constructor.

Overrides
Object::__construct()

__mergeVars() public ¶

__mergeVars( )

Merge components, helpers, and uses vars from AppController and PluginAppController.

_afterScaffoldSave() public ¶

_afterScaffoldSave( string $method )

This method should be overridden in child classes.

Parameters
string $method
name of method called either edit or update.
Returns
boolean
Success
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

_afterScaffoldSaveError() public ¶

_afterScaffoldSaveError( string $method )

This method should be overridden in child classes.

Parameters
string $method
name of method called either edit or update.
Returns
boolean
Success
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

_beforeScaffold() public ¶

_beforeScaffold( string $method )

This method should be overridden in child classes.

Parameters
string $method
name of method called example index, edit, etc.
Returns
boolean
Success
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

_scaffoldError() public ¶

_scaffoldError( string $method )

This method should be overridden in child classes. If not it will render a scaffold error. Method MUST return true in child classes

Parameters
string $method
name of method called example index, edit, etc.
Returns
boolean
Success
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

afterFilter() public ¶

afterFilter( )

Called after the controller action is run and rendered.

Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

beforeFilter() public ¶

beforeFilter( )

Called before the controller action.

Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

beforeRender() public ¶

beforeRender( )

Called after the controller action is run, but before the view is rendered.

Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Callbacks

constructClasses() public ¶

constructClasses( )

Loads Model classes based on the uses property see Controller::loadModel(); for more info. Loads Components and prepares them for initialization.

Returns
mixed
true if models found and instance created, or cakeError if models not found.
See
Controller::loadModel()
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Controller-Methods#constructClasses-986

disableCache() public ¶

disableCache( )

Forces the user's browser not to cache the results of the current request.

Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#disableCache

flash() public ¶

flash( string $message , mixed $url , integer $pause = 1 , string $layout = 'flash' )

Shows a message to the user for $pause seconds, then redirects to $url. Uses flash.ctp as the default layout for the message. Does not work if the current debug level is higher than 0.

Parameters
string $message
Message to display to the user
mixed $url
Relative string or array-based URL to redirect to after the time expires
integer $pause optional 1
Time to show the message
string $layout optional 'flash'
Layout you want to use, defaults to 'flash'
Returns

Renders flash layout
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#flash

header() public ¶

header( string $status )

Convenience and object wrapper method for header(). Useful when doing tests and asserting that particular headers have been set.

Parameters
string $status
The header message that is being set.

httpCodes() public ¶

httpCodes( mixed $code = null )

Queries & sets valid HTTP response codes & messages.

Parameters
mixed $code optional null

If $code is an integer, then the corresponding code/message is returned if it exists, null if it does not exist. If $code is an array, then the 'code' and 'message' keys of each nested array are added to the default HTTP codes. Example:

   httpCodes(404); // returns array(404 => 'Not Found')

   httpCodes(array(
       701 => 'Unicorn Moved',
       800 => 'Unexpected Minotaur'
   )); // sets these new values, and returns true
Returns
mixed

Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.


isAuthorized() public ¶

isAuthorized( )

Controller callback to tie into Auth component. Only called when AuthComponent::$authorize is set to 'controller'.

Returns
boolean
true if authorized, false otherwise
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#authorize

loadModel() public ¶

loadModel( string $modelClass = null , mixed $id = null )

Loads and instantiates models required by this controller. If Controller::$persistModel; is true, controller will cache model instances on first request, additional request will used cached models. If the model is non existent, it will throw a missing database table error, as Cake generates dynamic models for the time being.

Parameters
string $modelClass optional null
Name of model class to load
mixed $id optional null
Initial ID the instanced model class should have
Returns
mixed
true when single model found and instance created, error returned if model not found.

paginate() public ¶

paginate( mixed $object = null , mixed $scope = array() , array $whitelist = array() )

Handles automatic pagination of model records.

Parameters
mixed $object optional null
Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel')
mixed $scope optional array()
Conditions to use while paginating
array $whitelist optional array()
List of allowed options for paging
Returns
array
Model query results
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#Controller-Setup

postConditions() public ¶

postConditions( array $data = array() , mixed $op = null , string $bool = 'AND' , boolean $exclusive = false )

Converts POST'ed form data to a model conditions array, suitable for use in a Model::find() call.

Parameters
array $data optional array()
POST'ed data organized by model and field
mixed $op optional null

A string containing an SQL comparison operator, or an array matching operators to fields

string $bool optional 'AND'
SQL boolean operator: AND, OR, XOR, etc.
boolean $exclusive optional false

If true, and $op is an array, fields not included in $op will not be included in the returned conditions

Returns
array
An array of model conditions
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#postConditions

redirect() public ¶

redirect( mixed $url , integer $status = null , boolean $exit = true )

Redirects to given $url, after turning off $this->autoRender. Script execution is halted after the redirect.

Parameters
mixed $url

A string or array-based URL pointing to another location within the app, or an absolute URL

integer $status optional null
Optional HTTP status code (eg: 404)
boolean $exit optional true
If true, exit() will be called after the redirect
Returns
mixed
void if $exit = false. Terminates script if $exit = true
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#redirect

referer() public ¶

referer( string $default = null , boolean $local = false )

Returns the referring URL for this request.

Parameters
string $default optional null
Default URL to use if HTTP_REFERER cannot be read from headers
boolean $local optional false
If true, restrict referring URLs to local server
Returns
string
Referring URL
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#referer

render() public ¶

render( string $action = null , string $layout = null , string $file = null )

Instantiates the correct view class, hands it its data, and uses it to render the view output.

Parameters
string $action optional null
Action name to render
string $layout optional null
Layout to use
string $file optional null
File to use for rendering
Returns
string
Full output string of view contents
Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#render

set() public ¶

set( mixed $one , mixed $two = null )

Saves a variable for use inside a view template.

Parameters
mixed $one
A string or an array of data.
mixed $two optional null

Value in case $one is a string (which then works as the key). Unused if $one is an associative array, otherwise serves as the values to $one's keys.

Link
http://book.cakephp.org/1.3/en/The-Manual/Developing-With-CakePHP/Controllers.html#set

setAction() public ¶

setAction( string $action )

Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()

Examples:

{{{ setAction('another_action'); setAction('action_with_parameters', $parameter1); }}}

Parameters
string $action
The new action to be 'redirected' to
Returns
mixed
Returns the return value of the called action

shutdownProcess() public ¶

shutdownProcess( )

Perform the various shutdown processes for this controller. Fire the Component and Controller callbacks in the correct order.

  • triggers the component shutdown callback.
  • calls the Controller's afterFilter method.

startupProcess() public ¶

startupProcess( )

Perform the startup process for this controller. Fire the Component and Controller callbacks in the correct order.

  • Initializes components, which fires their initialize callback
  • Calls the controller beforeFilter.
  • triggers Component startup methods.

validate() public ¶

validate( )

Returns number of errors in a submitted FORM.

Returns
integer
Number of errors

validateErrors() public ¶

validateErrors( )

Validates models passed by parameters. Example:

$errors = $this->validateErrors($this->Article, $this->User);

Returns
array
Validation errors, or false if none

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns
Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters
string $name
Name of persisted class
string $type optional null
Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters
string $name
name of the class to persist
string $return
$object the object to persist
$object
$type optional null
Returns
boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters
string $name
name used for object to cache
object $object
the object to persist
Returns
boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters
array $properties optional array()
An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters
$status optional 0
http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters
string $method
Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array()
Message that is to be displayed by the error class
Returns
error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters
string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method
Returns
mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters
string $msg
Log message
integer $type optional LOG_ERROR
Error type constant. Defined in app/config/core.php.
Returns
boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters
mixed $url
String or array-based url.
array $extra optional array()
if array includes the key "return" it sets the AutoRender to true.
Returns
mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.


toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns
string
The name of this class

Properties detail

$helpers ¶

public array

Default helper

array('Html', 'Session')

$name ¶

public string

Controller name

'Pages'

$uses ¶

public array

This controller does not use a model

array()
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs