PHP Класс AbstractObject, atk4

(c) 2008-2011 Romans Malinovskis Distributed under Affero General Public License v3 See http://agiletoolkit.org/about/license =====================================================ATK4=
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_info Records debug information.
$_initialized boolean To make sure you have called parent::init() properly.
$api
$app App_CLI Always points to current Application
$auto_track_element boolean When this object is added, owner->elements[$this->short_name] will be == $this;.
$controller Controller Reference to the current controller. Read only. Use setController()
$debug boolean Setting this to true will output additional debug info about object
$default_controller string Default controller to initialize when calling setModel()
$default_exception string $default_exception='PathFinder' by default would return 'Exception_PathFinder' from exception(). $default_exceptoin='PathFinder' in combination with ->exception('Blah','_NotFound') will return 'Exception_PathFinder_NotFound' $default_exception='BaseException' in combination with ->exception('Blah', 'PathFinder') will create 'Exception_PathFinder' exception. and finally $default_exception='PathFinder' in combination with ->exception('Blah','NotFound') will return 'Exception_NotFound';
$elements array short_name => object hash of children objects
$hooks {{{ Hooks: http://agiletoolkit.org/doc/hooks
$model Model Reference to the current model. Read only. Use setModel()
$name string Unique object name
$owner AbstractObject Link to object into which we added this object
$short_name string Name of the object in owner's element array

Открытые методы

Метод Описание
__call ( string $method, array $arguments ) : mixed Call method is used to display exception for non-existant methods and provides ability to extend objects with addMethod().
__clone ( ) : AbstractObject Clones associated controller and model. If cloning views, add them to the owner.
__construct ( array $options = [] ) This is default constructor of ATK4. Please do not re-define it and avoid calling it directly. Always use add() and init() methods.
__destruct ( ) Always call parent if you redefine this/.
__sleep ( ) : mixed Do not serialize objects.
__toString ( ) : string Converts into string "Object View(myapp_page_view)".
_removeElement ( string $short_name ) Actually removes the element.
_shorten ( string $desired ) : string Method used internally for shortening object names.
_ticker ( )
_unique ( &$array, string $desired = null ) : string This funcion given the associative $array and desired new key will return the best matching key which is not yet in the array.
_unique_element ( $desired = null )
add ( array | string | object $class, array | string $options = null, string $template_spot = null, array | string $template_branch = null ) : AbstractObject Creates new object and adds it as a child of current object.
addHook ( string $hook_spot, AbstractObject | callable $callable, array $arguments = [], integer $priority = 5 ) If priority is negative, then hooks will be executed in reverse order.
addMethod ( string | array $name, callable $callable ) Add new method for this object.
breakHook ( mixed $return ) When called from inside a hook callable, will stop execution of other callables on same hook. The passed argument will be returned by the hook method.
debug ( boolean | string $msg = true, string $file = null, string $line = null ) Turns on debug mode for this object.
destroy ( $recursive = true ) Removes object from parent and prevents it from rendering \code $view = $this->add('View'); $view -> destroy(); \endcode.
each ( string | callable $callable ) A handy shortcut for foreach(){ .
exception ( string $message = 'Undefined Exception', string $type = null, string $code = null ) : BaseException Returns relevant exception class. Use this method with "throw".
fatal ( string $error, integer $shift ) Reports fatal error. Use ->exception instead.
forget ( string $key = null ) Forget session data for arg $key. If $key is omitted will forget all associated session data.
getElement ( string $short_name ) : AbstractObject Find child element by its short name. Use in chaining.
getModel ( ) : AbstractModel Return current model.
hasElement ( string $short_name ) : AbstractObject | boolean Find child element. Use in condition.
hasMethod ( string $name ) : boolean Return if this object has specified method (either native or dynamic).
hook ( string $hook_spot, array $arg = [] ) : mixed Execute all callables assigned to $hook_spot.
info ( $msg )
init ( ) Initialize object. Always call parent::init(). Do not call directly.
learn ( string $key, mixed $default = null ) : mixed Similar to memorize, but if value for key exist, will return it.
logError ( string $error, string $msg = '' ) Output string into error file.
logInfo ( string $info, string $msg = '' ) Output string into info file.
logVar ( string $var, string $msg = '' ) Output string into log file.
memorize ( string $key, mixed $value ) : mixed Remember data in object-relevant session data.
newInstance ( array $properties = null ) : self Creates one more instance of $this object.
recall ( string $key, mixed $default = null ) : mixed Returns session data for this object. If not previously set, then $default is returned.
removeElement ( string $short_name ) Remove child element if it exists.
removeHook ( string $hook_spot ) Delete all hooks for specified spot.
removeMethod ( string $name ) Remove dynamically registered method.
rename ( string $short_name ) Names object accordingly. May not work on some objects.
runTests ( Tester $tester = null ) This method will find private methods started with test_ in the current class and will execute each method in succession by passing $t argument to it. Before each test execution takes place, $t->prepareForTest($test) will be called. It must return non-false for test to be carried out.
setController ( string | object $controller, string | array $name = null ) : AbstractController Associate controller with the object.
setModel ( string | object $model ) : AbstractModel Associate model with object.
tryCall ( string $method, array $arguments ) : mixed Attempts to call dynamic method. Returns array containing result or false.
upCall ( string $type, array $args = [] ) Call specified method for this class and all parents up to app.
warning ( string $msg, integer $shift ) Records warning.

Описание методов

__call() публичный Метод

Call method is used to display exception for non-existant methods and provides ability to extend objects with addMethod().
public __call ( string $method, array $arguments ) : mixed
$method string Name of the method
$arguments array Arguments
Результат mixed

__clone() публичный Метод

Clones associated controller and model. If cloning views, add them to the owner.
public __clone ( ) : AbstractObject
Результат AbstractObject Copy of this object

__construct() публичный Метод

This is default constructor of ATK4. Please do not re-define it and avoid calling it directly. Always use add() and init() methods.
public __construct ( array $options = [] )
$options array will initialize class properties

__destruct() публичный Метод

Always call parent if you redefine this/.
public __destruct ( )

__sleep() публичный Метод

Do not serialize objects.
public __sleep ( ) : mixed
Результат mixed

__toString() публичный Метод

Converts into string "Object View(myapp_page_view)".
public __toString ( ) : string
Результат string

_removeElement() публичный Метод

Actually removes the element.
public _removeElement ( string $short_name )
$short_name string short name

_shorten() публичный Метод

Method used internally for shortening object names.
public _shorten ( string $desired ) : string
$desired string Desired name of new object.
Результат string Shortened name of new object.

_ticker() публичный Метод

public _ticker ( )

_unique() публичный Метод

For example, if you have array('foo'=>x,'bar'=>x) and $desired is 'foo' function will return 'foo_2'. If 'foo_2' key also exists in that array, then 'foo_3' is returned and so on.
public _unique ( &$array, string $desired = null ) : string
$desired string Desired key for new object
Результат string unique key for new object

_unique_element() публичный Метод

public _unique_element ( $desired = null )

add() публичный Метод

Returns new object.
См. ссылку: http://agiletoolkit.org/learn/understand/base/adding
public add ( array | string | object $class, array | string $options = null, string $template_spot = null, array | string $template_branch = null ) : AbstractObject
$class array | string | object Name of the new class. Can also be array with 0=>name and rest of array will be considered as $options or object.
$options array | string Short name or array of properties. 0=>name will be used as a short-name or your object.
$template_spot string Tag where output will appear
$template_branch array | string Redefine template
Результат AbstractObject

addHook() публичный Метод

If priority is negative, then hooks will be executed in reverse order.
public addHook ( string $hook_spot, AbstractObject | callable $callable, array $arguments = [], integer $priority = 5 )
$hook_spot string Hook identifier to bind on
$callable AbstractObject | callable Will be called on hook()
$arguments array Arguments are passed to $callable
$priority integer Lower priority is called sooner

addMethod() публичный Метод

Add new method for this object.
public addMethod ( string | array $name, callable $callable )
$name string | array Name of new method of $this object
$callable callable Callback

breakHook() публичный Метод

When called from inside a hook callable, will stop execution of other callables on same hook. The passed argument will be returned by the hook method.
public breakHook ( mixed $return )
$return mixed What would hook() return?

debug() публичный Метод

Using first argument as string is obsolete.
public debug ( boolean | string $msg = true, string $file = null, string $line = null )
$msg boolean | string "true" to start debugging
$file string obsolete
$line string obsolete

destroy() публичный Метод

Removes object from parent and prevents it from rendering \code $view = $this->add('View'); $view -> destroy(); \endcode.
public destroy ( $recursive = true )

each() публичный Метод

. } code. Make your callable return "false" if you would like to break the loop.
public each ( string | callable $callable )
$callable string | callable will be executed for each member

exception() публичный Метод

Returns relevant exception class. Use this method with "throw".
public exception ( string $message = 'Undefined Exception', string $type = null, string $code = null ) : BaseException
$message string Static text of exception.
$type string Exception class or class postfix
$code string Optional error code
Результат BaseException

fatal() публичный Метод

Reports fatal error. Use ->exception instead.
public fatal ( string $error, integer $shift )
$error string error text
$shift integer relative offset in backtrace

forget() публичный Метод

Forget session data for arg $key. If $key is omitted will forget all associated session data.
public forget ( string $key = null )
$key string Optional key of data to forget

getElement() публичный Метод

Exception if not found.
public getElement ( string $short_name ) : AbstractObject
$short_name string Short name of the child element
Результат AbstractObject

getModel() публичный Метод

Return current model.
public getModel ( ) : AbstractModel
Результат AbstractModel Currently associated model object

hasElement() публичный Метод

Find child element. Use in condition.
public hasElement ( string $short_name ) : AbstractObject | boolean
$short_name string Short name of the child element
Результат AbstractObject | boolean

hasMethod() публичный Метод

Return if this object has specified method (either native or dynamic).
public hasMethod ( string $name ) : boolean
$name string Name of the method
Результат boolean

hook() публичный Метод

Execute all callables assigned to $hook_spot.
public hook ( string $hook_spot, array $arg = [] ) : mixed
$hook_spot string Hook identifier
$arg array Additional arguments to callables
Результат mixed Array of responses or value specified to breakHook

info() публичный Метод

public info ( $msg )

init() публичный Метод

Initialize object. Always call parent::init(). Do not call directly.
public init ( )

learn() публичный Метод

Similar to memorize, but if value for key exist, will return it.
public learn ( string $key, mixed $default = null ) : mixed
$key string Data Key
$default mixed Default value
Результат mixed Previously memorized data or $default

logError() публичный Метод

Output string into error file.
public logError ( string $error, string $msg = '' )
$error string error
$msg string msg

logInfo() публичный Метод

Output string into info file.
public logInfo ( string $info, string $msg = '' )
$info string info
$msg string msg

logVar() публичный Метод

Output string into log file.
public logVar ( string $var, string $msg = '' )
$var string var
$msg string msg

memorize() публичный Метод

Remember data in object-relevant session data.
public memorize ( string $key, mixed $value ) : mixed
$key string Key for the data
$value mixed Value
Результат mixed $value

newInstance() публичный Метод

Creates one more instance of $this object.
public newInstance ( array $properties = null ) : self
$properties array Set initial properties for new object
Результат self

recall() публичный Метод

Returns session data for this object. If not previously set, then $default is returned.
public recall ( string $key, mixed $default = null ) : mixed
$key string Data Key
$default mixed Default value
Результат mixed Previously memorized data or $default

removeElement() публичный Метод

Remove child element if it exists.
public removeElement ( string $short_name )
$short_name string short name of the element

removeHook() публичный Метод

Delete all hooks for specified spot.
public removeHook ( string $hook_spot )
$hook_spot string Hook identifier to bind on

removeMethod() публичный Метод

Remove dynamically registered method.
public removeMethod ( string $name )
$name string Name of the method

rename() публичный Метод

Names object accordingly. May not work on some objects.
public rename ( string $short_name )
$short_name string Short name of the child element

runTests() публичный Метод

$test will be an array containing keys for 'name', 'object' and 'class'
public runTests ( Tester $tester = null )
$tester Tester

setController() публичный Метод

Associate controller with the object.
public setController ( string | object $controller, string | array $name = null ) : AbstractController
$controller string | object Class or instance of controller
$name string | array Name or property for new controller
Результат AbstractController Newly added controller

setModel() публичный Метод

Associate model with object.
public setModel ( string | object $model ) : AbstractModel
$model string | object Class or instance of model
Результат AbstractModel Newly added Model

tryCall() публичный Метод

Attempts to call dynamic method. Returns array containing result or false.
public tryCall ( string $method, array $arguments ) : mixed
$method string Name of the method
$arguments array Arguments
Результат mixed

upCall() публичный Метод

Call specified method for this class and all parents up to app.
public upCall ( string $type, array $args = [] )
$type string information
$args array relative offset in backtrace

warning() публичный Метод

Records warning.
public warning ( string $msg, integer $shift )
$msg string information
$shift integer relative offset in backtrace

Описание свойств

$_info публичное свойство

Records debug information.
public $_info

$_initialized публичное свойство

To make sure you have called parent::init() properly.
public bool $_initialized
Результат boolean

$api публичное свойство

Устаревший: 4.3.0 Left for compatibility with ATK 4.2 and lower, use ->app instead
public $api

$app публичное свойство

Always points to current Application
public App_CLI $app
Результат App_CLI

$auto_track_element публичное свойство

When this object is added, owner->elements[$this->short_name] will be == $this;.
public bool $auto_track_element
Результат boolean

$controller публичное свойство

Reference to the current controller. Read only. Use setController()
public Controller $controller
Результат Controller

$debug публичное свойство

Setting this to true will output additional debug info about object
public bool $debug
Результат boolean

$default_controller публичное свойство

Default controller to initialize when calling setModel()
public string $default_controller
Результат string

$default_exception публичное свойство

$default_exception='PathFinder' by default would return 'Exception_PathFinder' from exception(). $default_exceptoin='PathFinder' in combination with ->exception('Blah','_NotFound') will return 'Exception_PathFinder_NotFound' $default_exception='BaseException' in combination with ->exception('Blah', 'PathFinder') will create 'Exception_PathFinder' exception. and finally $default_exception='PathFinder' in combination with ->exception('Blah','NotFound') will return 'Exception_NotFound';
public string $default_exception
Результат string

$elements публичное свойство

short_name => object hash of children objects
public array $elements
Результат array

$hooks публичное свойство

{{{ Hooks: http://agiletoolkit.org/doc/hooks
public $hooks

$model публичное свойство

Reference to the current model. Read only. Use setModel()
public Model $model
Результат Model

$name публичное свойство

Unique object name
public string $name
Результат string

$owner публичное свойство

Link to object into which we added this object
public AbstractObject $owner
Результат AbstractObject

$short_name публичное свойство

Name of the object in owner's element array
public string $short_name
Результат string