CakeSchema Class Info:
- Class Declaration:
class CakeSchema extends Object
- File name:
- cake/libs/model/cake_schema.php
- Description:
Base Class for Schema management
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.model
Properties:
-
connection string
Connection used for read
-
file string
File to write
-
name string
Name of the App Schema
-
path string
Path to write location
-
plugin string
plugin name.
-
tables array
Set of tables
Method Summary:
- after( $event = array ( ) )
- _arrayDiffAssoc( $array1, $array2 )
- before( $event = array ( ) )
- _build( $data )
- cakeError( $method, $messages = array ( ) )
- __columns( $Obj )
- compare( $old, $new = NULL )
- _compareIndexes( $new, $old )
- _compareTableParameters( $new, $old )
- __construct( $options = array ( ) )
- dispatchMethod( $method, $params = array ( ) )
- generateTable( $table, $fields )
- load( $options = array ( ) )
- log( $msg, $type = 2 )
- _noPrefixTable( $prefix, $table )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- read( $options = array ( ) )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- toString( )
- __values( $values )
- write( $object, $options = array ( ) )
after
topAfter callback to be implemented in subclasses
- Parameters:
-
-
$event optional array ( )
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 154
- Access
public
_arrayDiffAssoc
topExtended array_diff_assoc noticing change from/to NULL values
It behaves almost the same way as array_diff_assoc except for NULL values: if one of the values is not NULL - change is detected. It is useful in situation where one value is strval('') ant other is strval(null) - in string comparing methods this results as EQUAL, while it is not.
- Parameters:
-
-
array $array1 required
Base array
-
array $array2 required
Corresponding array checked for equality
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 542
- Return
array Difference as array with array(keys => values) from input array where match was not found.
- Access
protected
before
topBefore callback to be implemented in subclasses
- Parameters:
-
-
$event optional array ( )
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 144
- Return
boolean Should process continue
- Access
public
_build
topBuilds schema object properties
- Parameters:
-
-
array $data required
loaded object properties
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 115
- Return
void
- Access
protected
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
__columns
topFormats Schema columns from Model Object
- Parameters:
-
-
array $Obj required
model object
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 597
- Return
array Formatted columns
- Access
public
compare
topCompares two sets of schemas
- Parameters:
-
-
mixed $old required
Schema object or array
-
mixed $new optional NULL
Schema object or array
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 449
- Return
array Tables (that are added, dropped, or changed)
- Access
public
_compareIndexes
topCompare two schema indexes
- Parameters:
-
-
array $new required
New indexes
-
array $old required
Old indexes
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 655
- Return
mixed false on failure or array of indexes to add and drop
_compareTableParameters
topCompare two schema files table Parameters
- Parameters:
-
-
array $new required
New indexes
-
array $old required
Old indexes
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 640
- Return
mixed False on failure, or an array of parameters to add & drop.
__construct
topConstructor
- Parameters:
-
-
array $options optional array ( )
optional load object properties
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 82
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
generateTable
topGenerate the code for a table. Takes a table name and $fields array Returns a completed variable declaration to be used in schema classes
- Parameters:
-
-
string $table required
Table name you want returned.
-
array $fields required
Array of field information to generate the table with.
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 403
- Return
string Variable declaration for a schema class
load
topReads database and creates schema tables
- Parameters:
-
-
array $options optional array ( )
schema object properties
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 164
- Return
array Set of name and tables
- Access
public
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
_noPrefixTable
topTrim the table prefix from the full table name, and return the prefix-less table
- Parameters:
-
-
string $prefix required
Table prefix
-
string $table required
Full table name
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 706
- Return
string Prefix-less table name
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
read
topReads database and creates schema tables
Options
- 'connection' - the db connection to use
- 'name' - name of the schema
- 'models' - a list of models to use, or false to ignore models
- Parameters:
-
-
array $options optional array ( )
schema object properties
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 203
- Return
array Array indexed by name and tables
- Access
public
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
_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
__values
topFormats Schema columns from Model Object
- Parameters:
-
-
array $values required
options keys(type, null, default, key, length, extra)
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 575
- Return
array Formatted values
- Access
public
write
topWrites schema file from object or options
- Parameters:
-
-
mixed $object required
schema object or options array
-
array $options optional array ( )
schema object properties to override object
-
- Method defined in:
- cake/libs/model/cake_schema.php on line 341
- Return
mixed false or string written to file
- Access
public
