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 SessionHelper

Session Helper.

Session reading from the view.

Object
Extended by CakeSession
Extended by SessionHelper
Package: cake\cake\libs\view\helpers
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#Session
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: view/helpers/session.php

Properties summary

  • $__active public
    boolean
    Used to determine if methods implementation is used, or bypassed
  • $helpers public
    array
    List of helpers used by this helper

Inherited Properties

  • _userAgent, cookieLifeTime, error, host, id, lastError, path, security, sessionTime, time, timeout, valid, watchKeys

Method Summary

  • __construct() public
    Class constructor
  • __start() public

    Determine if Session has been started and attempt to start it if not

  • activate() public
    Turn sessions on if 'Session.start' is set to false in core.php
  • check() public
    Used to check is a session key has been set
  • error() public
    Returns last error encountered in a session
  • flash() public
    Used to render the message set in Controller::Session::setFlash()
  • read() public
    Used to read a session values set in a controller for a key or return values for all keys.
  • valid() public
    Used to check is a session is valid in a view
  • write() public

    Override CakeSession::write(). This method should not be used in a view

Method Detail

__construct() public ¶

__construct( string $base = null )

Class constructor

Parameters
string $base optional null
Overrides
CakeSession::__construct()

__start() public ¶

__start( )

Determine if Session has been started and attempt to start it if not

Returns
boolean

true if Session is already started, false if Session could not be started


activate() public ¶

activate( string $base = null )

Turn sessions on if 'Session.start' is set to false in core.php

Parameters
string $base optional null

check() public ¶

check( string $name )

Used to check is a session key has been set

In your view: $session->check('Controller.sessKey');

Parameters
string $name
Returns
boolean
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#Methods
Overrides
CakeSession::check()

error() public ¶

error( )

Returns last error encountered in a session

In your view: $session->error();

Returns
string
last error
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#Methods
Overrides
CakeSession::error()

flash() public ¶

flash( string $key = 'flash' )

Used to render the message set in Controller::Session::setFlash()

In your view: $session->flash('somekey'); Will default to flash if no param is passed

Parameters
string $key optional 'flash'
The [Message.]key you are rendering in the view.
Returns
boolean|string
Will return the value if $key is set, or false if not set.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#Methods
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#flash

read() public ¶

read( string $name = null )

Used to read a session values set in a controller for a key or return values for all keys.

In your view: $session->read('Controller.sessKey'); Calling the method without a param will return all session vars

Parameters
string $name optional null
the name of the session key you want to read
Returns
values
from the session vars
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Session.html#Methods
Overrides
CakeSession::read()

valid() public ¶

valid( )

Used to check is a session is valid in a view

Returns
boolean
Overrides
CakeSession::valid()

write() public ¶

write( )

Override CakeSession::write(). This method should not be used in a view

Returns
boolean
Overrides
CakeSession::write()

Methods inherited from CakeSession

__close() public ¶

__close( )

Method called on close of a database session.

Returns
boolean
Success

__destroy() public ¶

__destroy( integer $id )

Method called on the destruction of a database session.

Parameters
integer $id
ID that uniquely identifies session in database
Returns
boolean
True for successful delete, false otherwise.

__error() public ¶

__error( integer $errorNumber )

Return error description for given error number.

Parameters
integer $errorNumber
Error to set
Returns
string
Error as string

__gc() public ¶

__gc( integer $expires = null )

Helper function called on gc for database sessions.

Parameters
integer $expires optional null
Timestamp (defaults to current time)
Returns
boolean
Success

__initSession() public ¶

__initSession( )

Helper method to initialize a session, based on Cake core settings.

__open() public ¶

__open( )

Method called on open of a database session.

Returns
boolean
Success

__overwrite() public ¶

__overwrite( array $old , array $new )

Used to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself

Parameters
array $old
Set of old variables => values
array $new
New set of variable => value

__read() public ¶

__read( mixed $id )

Method used to read from a database session.

Parameters
mixed $id
The key of the value to read
Returns
mixed
The value of the key or false if it does not exist

__regenerateId() public ¶

__regenerateId( )

Helper method to restart a session.

__returnSessionVars() public ¶

__returnSessionVars( )

Returns all session variables.

Returns
mixed
Full $_SESSION array, or false on error.

__setError() public ¶

__setError( integer $errorNumber , string $errorMessage )

Helper method to set an internal error message.

Parameters
integer $errorNumber
Number of the error
string $errorMessage
Description of the error

__startSession() public ¶

__startSession( )

Helper method to start a session

__write() public ¶

__write( integer $id , mixed $data )

Helper function called on write for database sessions.

Parameters
integer $id
ID that uniquely identifies session in database
mixed $data
The value of the data to be saved.
Returns
boolean
True for successful write, false otherwise.

_checkValid() public ¶

_checkValid( )

Helper method to create a new session.

delete() public ¶

delete( string $name )

Removes a variable from session.

Parameters
string $name
Session variable to remove
Returns
boolean
Success

destroy() public ¶

destroy( )

Helper method to destroy invalid sessions.

id() public ¶

id( CakeSession::$id $id = null )

Returns the Session id

Parameters
CakeSession::$id $id optional null
$name string
Returns
string
Session id

ignore() public ¶

ignore( mixed $var )

Tells Session to stop watching a given key path

Parameters
mixed $var
The variable path to watch

renew() public ¶

renew( )

Restarts this session.

start() public ¶

start( )

Starts the Session.

Returns
boolean
True if session was started

started() public ¶

started( )

Determine if Session has been started.

Returns
boolean
True if session has been started.

watch() public ¶

watch( mixed $var )

Tells Session to write a notification when a certain session path or subpath is written to

Parameters
mixed $var
The variable path to watch

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

$__active ¶

public boolean

Used to determine if methods implementation is used, or bypassed

true

$helpers ¶

public array

List of helpers used by this helper

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