Security Class Info:
- Class Declaration:
class Security extends Object
- File name:
- cake/libs/security.php
- Description:
Security Library contains utility methods related to security
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
-
hashType string
Default hash method
Method Summary:
- cakeError( $method, $messages = array ( ) )
- cipher( $text, $key )
- __construct( )
- dispatchMethod( $method, $params = array ( ) )
- generateAuthKey( )
- getInstance( )
- hash( $string, $type = NULL, $salt = false )
- inactiveMins( )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- setHash( $hash )
- _stop( $status = 0 )
- toString( )
- validateAuthKey( $authKey )
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
cipher
topEncrypts/Decrypts a text using the given key.
- Parameters:
-
-
string $text required
Encrypted string to decrypt, normal string to encrypt
-
string $key required
Key to use
-
- Method defined in:
- cake/libs/security.php on line 171
- Return
string Encrypted/Decrypted string
- Access
public
- Static
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
generateAuthKey
topGenerate authorization hash.
- Method defined in:
- cake/libs/security.php on line 81
- Return
string Hash
- Access
public
- Static
getInstance
topSingleton implementation to get object instance.
- Method defined in:
- cake/libs/security.php on line 44
- Return
object
- Access
public
- Static
hash
topCreate a hash from string using given method. Fallback on next available method.
- Parameters:
-
-
string $string required
String to hash
-
string $type optional NULL
Method to use (sha1/sha256/md5)
-
boolean $salt optional false
If true, automatically appends the application's salt value to $string (Security.salt)
-
- Method defined in:
- cake/libs/security.php on line 113
- Return
string Hash
- Access
public
- Static
inactiveMins
topGet allowed minutes of inactivity based on security level.
- Method defined in:
- cake/libs/security.php on line 59
- Return
integer Allowed inactivity in minutes
- Access
public
- Static
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA 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:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
setHash
topSets the default hash method for the Security object. This affects all objects using Security::hash().
- Parameters:
-
-
string $hash required
Method to use (sha1/sha256/md5)
-
- Method defined in:
- cake/libs/security.php on line 157
- Access
public
- Return
void
- Static
- See
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
validateAuthKey
topValidate authorization hash.
- Parameters:
-
-
string $authKey required
Authorization hash
-
- Method defined in:
- cake/libs/security.php on line 97
- Return
boolean Success
- Access
public
- Static
- Todo
Complete implementation
