Trait ControlApi

Provides an easy means of creating self documenting control apis. This trait affects instantiated objects. For static control methods, use StaticControl. This functionality is separated into two traits to maintain object organization.

Direct Known Users

oroboros\core\traits\adapters\AdapterTrait

Namespace: oroboros\core\traits\patterns\structural
Author: Brian Dayhoff mopsyd@me.com
See: \oroboros\traits\patterns\structural\StaticControlApi
Located at core/traits/patterns/structural/ControlApi.php

Methods summary

`public array\|false`	# `api( string $index = null, string $action = null )` Provides an api of control methods for quick useage documentation. Provides an api of control methods for quick useage documentation. Parameters `$index` (optional) If provided, returns the api within the scope of the specified control method. Otherwise returns an array of all registered control methods and their individual apis `$action` $method (optional) If provided, constrains the scope of the specified control method to the specific action. If not provided, returns the default action. Has no effect if [$index] is not provided Returns array\|false Returns false if no api exists as specified, otherwise returns an array of information
`public mixed`	# `__call( string $name, string $args = array() )` Provides the control method api when methods are called directly. Provides the control method api when methods are called directly. Parameters `$name` `$args` Returns mixed Throws oroboros\lib\exception\LibraryException if no control method is found to handle the request
`protected`	# `_registerControlMethodSet( $method )`
`private`	# `_loadMethod( $name, $method = null, $args = null, $flags = null )`
`private`	# `_constructControlWorkerMethodName( $control, $method = null )`
`private`	# `_runControlMethod( $method, $command, $arguments, $flags, $args, $arg_count )`
`private`	# `_getControlMethodApi( $method )`
`private`	# `_reverseParseControlMethodName( $index, $method = null )`
`private`	# `_splitAtUpperCase( $s )`

Properties summary

`private array`	`$_control_methods`	# `array()`
`private array`	`$_api`	# `array()`

Namespaces

Traits

Trait ControlApi

Direct Known Users

Methods summary

Parameters

Returns

Parameters

Returns

Throws

Properties summary