DbAclSchema Class Info:

Class Declaration:
class DbAclSchema extends CakeSchema
File name:
cake/console/libs/templates/skel/config/sql/db_acl.php
Summary:
This is Acl Schema file Use it to configure database for ACL PHP versions 4 and 5 CakePHP(tm) : Rapid Development Framework (http://www.cakephp.org) Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org) Licensed under The MIT License Redistributions of files must retain the above copyright notice.
Class Inheritance

CakeSchema Object

filesource
copyright
Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)
link
http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
package
cake
subpackage
cake.app.config.sql
since
CakePHP(tm) v 0.2.9
version
$Revision$
modifiedby
$LastChangedBy$
lastmodified
$Date$
license
http://www.opensource.org/licenses/mit-license.php The MIT License

Properties:

Show/Hide parent properties
public acos
public aros
public aros_acos
public connection Connection used for read
public file File to write
protected _log Log object
public name
public path Path to write location
public tables Set of tables

Method Summary:

Show/Hide parent methods
public after( $event = array ( ) )
public before( $event = array ( ) )
protected _build( $data )
public cakeError( $method, $messages = array ( ) )
public __columns( $Obj )
public compare( $old, $new = NULL )
public _compareIndexes( $new, $old )
public __construct( $options = array ( ) )
public dispatchMethod( $method, $params = array ( ) )
public load( $options = array ( ) )
public log( $msg, $type = 2 )
public Object( )
protected _persist( $name, $return, $object, $type = NULL )
public read( $options = array ( ) )
public requestAction( $url, $extra = array ( ) )
protected _savePersistent( $name, $object )
protected _set( $properties = array ( ) )
public _stop( $status = 0 )
public toString( )
public __values( $values )
public write( $object, $options = array ( ) )

after

top
Parameters:
$event optional array ( )
Method defined in class:
DbAclSchema
Method defined in file:
cake/console/libs/templates/skel/config/sql/db_acl.php on line 42

before

top
Parameters:
$event optional array ( )
Method defined in class:
DbAclSchema
Method defined in file:
cake/console/libs/templates/skel/config/sql/db_acl.php on line 38

_build

top
Builds schema object properties
Parameters:
$data array loaded object properties required (no default)
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 98
return
void
access
protected

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

__columns

top
Formats Schema columns from Model Object
Parameters:
$Obj array model object required (no default)
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 466
return
array Formatted columns
access
public

compare

top
Compares two sets of schemas
Parameters:
$old mixed Schema object or array required (no default)
$new mixed Schema object or array optional NULL
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 374
return
array Tables (that are added, dropped, or changed)
access
public

_compareIndexes

top
Compare two schema indexes
Parameters:
$new array New indexes required (no default)
$old array Old indexes required (no default)
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 508
return
mixed false on failure or array of indexes to add and drop

__construct

top
Constructor
Parameters:
$options array optional load object properties optional array ( )
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 73

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

load

top
Reads database and creates schema tables
Parameters:
$options array schema object properties optional array ( )
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 143
return
array Set of name and tables
access
public

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

read

top
Reads 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:
$options array schema object properties optional array ( )
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 180
return
array Array indexed by name and tables
access
public

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

_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

__values

top
Formats Schema columns from Model Object
Parameters:
$values array options keys(type, null, default, key, length, extra) required (no default)
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 445
return
array Formatted values
access
public

write

top
Writes schema file from object or options
Parameters:
$object mixed schema object or options array required (no default)
$options array schema object properties to override object optional array ( )
Method defined in class:
CakeSchema
Method defined in file:
cake/libs/model/schema.php on line 287
return
mixed false or string written to file
access
public