Base Class for Schema management.
$connection
public string
$file
public string
$name
public string
$path
public string
$plugin
public string
$tables
public array
Trim the table prefix from the full table name, and return the prefix-less table.
__construct( array $options array() )
Constructor
$options
optional array() Object::__construct()
_arrayDiffAssoc( array $array1 , array $array2 )
Extended 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.
$array1
$array2
Difference as array with array(keys => values) from input array where match was not found.
_columns( array $Obj )
Formats Schema columns from Model Object.
$Obj
_compareIndexes( array $new , array $old )
Compare two schema indexes.
$new
$old
_compareTableParameters( array $new , array $old )
Compare two schema files table Parameters.
$new
$old
_noPrefixTable( string $prefix , string $table )
Trim the table prefix from the full table name, and return the prefix-less table.
$prefix
$table
_requireFile( string $path , string $file )
Attempts to require the schema file specified.
$path
$file
_values( array $values )
Formats Schema columns from Model Object.
$values
after( array $event array() )
After callback to be implemented in subclasses.
$event
optional array() before( array $event array() )
Before callback to be implemented in subclasses.
$event
optional array() build( array $data )
Builds schema object properties.
$data
compare( array|object $old , array|object $new null )
Compares two sets of schemas.
$old
$new
optional null generateTable( string $table , array $fields )
Generate the schema code for a table.
Takes a table name and $fields array and returns a completed, escaped variable declaration to be used in schema classes.
$table
$fields
load( array $options array() )
Reads database and creates schema tables.
$options
optional array() read( array $options array() )
Reads database and creates schema tables.
Options
$options
optional array() write( array|object $object , array $options array() )
Writes schema file from object or options.
$object
$options
optional array() _mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
$properties
$class
$normalize
optional true _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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 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
$method
$params
optional array() log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
requestAction( string|array $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.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.
$extra
optional array() if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
Object-to-string conversion. Each class can override this method as necessary.
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-CakeSchema.html