Class MagicDb
A class to parse and use the MagicDb for file type analysis
- Object
-
MagicDb
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: magic_db.php
Properties summary
-
$dbpublicarrayHolds the parsed MagicDb for this class instance
Method Summary
-
analyze() public
Analyzes a given $file using the currently loaded MagicDb information based on the desired $options -
read() public
Reads a MagicDb from various formats -
toArray() public
Parses a MagicDb $data string into an array or returns the current MagicDb instance as an array -
validates() public
Returns true if the MagicDb instance or the passed $magicDb is valid
Method Detail
analyze() public ¶
analyze( string $file , array $options = array() )
Analyzes a given $file using the currently loaded MagicDb information based on the desired $options
Parameters
- string $file
- Absolute path to the file to analyze
- array $options optional array()
- TBT
Returns
read() public ¶
read( $magicDb = null )
Reads a MagicDb from various formats
Returns
Returns false if reading / validation failed or true on success.
Var
Author
toArray() public ¶
toArray( string $data = null )
Parses a MagicDb $data string into an array or returns the current MagicDb instance as an array
Parameters
- string $data optional null
- A MagicDb string to turn into an array
Returns
A parsed MagicDb array or an empty array if the $data param was invalid. Returns the db property if $data is not set.
validates() public ¶
validates( mixed $magicDb = null )
Returns true if the MagicDb instance or the passed $magicDb is valid
Parameters
- mixed $magicDb optional null
- A $magicDb string / array to validate (optional)
Returns
True if the $magicDb / instance db validates, false if not
Methods inherited from Object
Object() public ¶
Object( )
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()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
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
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_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.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
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
- string $method
- 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
Returns
message
dispatchMethod() public ¶
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
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $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.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class