Security Class Info:

Class Declaration:
class Security extends Object
File name:
cake/libs/security.php
Summary:
Short description for file. Long description for file
Class Inheritance

Object

package
cake
subpackage
cake.cake.libs

Properties:

Show/Hide parent properties
public hashType Default hash method
protected _log Log object

cakeError

top
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:
$method string Method to be called in the error class (AppError or ErrorHandler classes) required (no default)
$messages array Message that is to be displayed by the error class optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 189
return
error message
access
public

cipher

top
Encrypts/Decrypts a text using the given key.
Parameters:
$text string Encrypted string to decrypt, normal string to encrypt required (no default)
$key string Key to use required (no default)
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 172
return
string Encrypted/Decrypted string
access
public
static

__construct

top
Class constructor, overridden in descendant classes.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 63

dispatchMethod

top
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters:
$method string Name of the method to call required (no default)
$params array Parameter list to use when calling $method optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 113
return
mixed Returns the result of the method call
access
public

generateAuthKey

top
Generate authorization hash.
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 86
return
string Hash
access
public
static

getInstance

top
Singleton implementation to get object instance.
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 50
return
object
access
public
static

hash

top
Create a hash from string using given method. Fallback on next available method. value to $string (Security.salt)
Parameters:
$string string String to hash required (no default)
$type string Method to use (sha1/sha256/md5) optional NULL
$salt boolean If true, automatically appends the application's salt optional false
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 116
return
string Hash
access
public
static

inactiveMins

top
Get allowed minutes of inactivity based on security level.
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 64
return
integer Allowed inactivity in minutes
access
public
static

log

top
API for logging events.
Parameters:
$msg string Log message required (no default)
$type integer Error type constant. Defined in app/config/core.php. optional 2
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 150
return
boolean Success of log write
access
public

Object

top
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()
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 53
return
Object

_persist

top
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:
$name string name of the class to persist required (no default)
$return required (no default)
$object string the object to persist required (no default)
$type optional NULL
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 219
return
boolean Success
access
protected
todo
add examples to manual

requestAction

top
Calls a controller's method from any location.
Parameters:
$url mixed String or array-based url. required (no default)
$extra array if array includes the key "return" it sets the AutoRender to true. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 86
return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
access
public

_savePersistent

top
You should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters:
$name string name used for object to cache required (no default)
$object object the object to persist required (no default)
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 247
return
boolean true on save, throws error if file can not be created
access
protected

_set

top
Allows setting of multiple properties of the object in a single line of code.
Parameters:
$properties array An associative array containing properties and corresponding values. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 169
return
void
access
protected

setHash

top
Sets the default hash method for the Security object. This affects all objects using Security::hash().
Parameters:
$hash string Method to use (sha1/sha256/md5) required (no default)
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 159
access
public
return
void
static
see
Security::hash()

_stop

top
Stop execution of the current script
Parameters:
$status optional 0
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 139
return
void
access
public

toString

top
Object-to-string conversion. Each class can override this method as necessary.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 73
return
string The name of this class
access
public

validateAuthKey

top
Validate authorization hash.
Parameters:
$authKey string Authorization hash required (no default)
Method defined in class:
Security
Method defined in file:
cake/libs/security.php on line 101
return
boolean Success
access
public
static
todo
Complete implementation