Class AbstractHookParser

Abstract Hook Defines a set of methods for identifying and replacing hooks within supplied data.

oroboros\core\abstracts\OroborosBaseAbstract implements oroboros\core\interfaces\BaseAbstractInterface uses oroboros\core\traits\BaseTrait

oroboros\core\abstracts\libraries\AbstractLibrary implements oroboros\core\interfaces\psr3\LoggerAwareInterface uses oroboros\core\traits\utilities\LoaderTrait, oroboros\core\traits\utilities\DefaultLoggerTrait

oroboros\core\abstracts\libraries\hooks\AbstractHookParser uses oroboros\core\traits\patterns\behavioral\Registry (not available)

Abstract
Namespace: oroboros\core\abstracts\libraries\hooks
Author: Brian Dayhoff mopsyd@me.com
Located at core/abstracts/libraries/hooks/AbstractHookParser.php

Methods summary

`public`	# `__construct( array $params = array(), array $flags = array() )` Parameters `$params` `$flags` Overrides `oroboros\core\abstracts\libraries\AbstractLibrary::__construct`
`public`	# `initialize( array $params = array(), array $flags = array() )` Parameters `$params` `$flags` Overrides `oroboros\core\abstracts\libraries\AbstractLibrary::initialize`
`public`	# `__toString( )`
`public`	# `registerHook( $hook, $result = null )`
`public`	# `unregisterHook( $hook )`
`public`	# `getHookValue( $hook )`
`public`	# `getIndices( $hook )`
`public`	# `setContent( $content )`
`public`	# `getRawContent( )`
`public`	# `parse( )` Publicly accessible parse method. Prevents child classes from tampering with the baseline parse operation. Publicly accessible parse method. Prevents child classes from tampering with the baseline parse operation.
`public`	# `reset( )` Publicly accessible reset method. Prevents child classes from tampering with the baseline reset operation. Publicly accessible reset method. Prevents child classes from tampering with the baseline reset operation.
`public`	# `resetContent( )`
`public`	# `resetHooks( )`
`public`	# `getContent( )`
`protected string`	# `_hookOverridePrefix( )` If you need a more granular means of generating a debug prefix than a simple string, override this method. If you need a more granular means of generating a debug prefix than a simple string, override this method. If a simple string is acceptable, override the class constant: HOOK_DEBUG_PREFIX instead. Returns string
`protected string`	# `_hookDebugOverrideSuffix( )` If you need a more granular means of generating a debug suffix than a simple string, override this method. If you need a more granular means of generating a debug suffix than a simple string, override this method. If a simple string is acceptable, override the class constant: HOOK_DEBUG_SUFFIX instead. Returns string
`private`	# `_getHookIndices( $content, $hook )` Under the hood stuff. Under the hood stuff.
`private`	# `_getHookDebugInformation( $hook )`
`private`	# `_validateHook( $hook )`
`private`	# `_replaceHook( $content, $value = null )`
`private`	# `_getHookCallbackContent( $callable )`
`private string;`	# `_getRawContent( )` Returns the baseline raw content. Returns the baseline raw content. Returns string;
`private`	# `_parse( )` Performs the baseline parse operation. Performs the baseline parse operation.
`private`	# `_reset( )` Performs the baseline reset operation. Performs the baseline reset operation.
`private`	# `_resetContent( )`
`private`	# `_resetHooks( )`
`private string`	# `_contencateContentSafely( mixed $content )` Safely generates content recursively without allowing errors to arise. Will throw an exception if it cannot proceed without errors, and does not make any assumption that partial content is acceptable. Safely generates content recursively without allowing errors to arise. Will throw an exception if it cannot proceed without errors, and does not make any assumption that partial content is acceptable. If supplied content is multidimensional, all leaf nodes must be able to be cast to string or an exception will arise. This method uses recursion if given multidimensional content. Large content complexity may cause performance to hang. If this becomes an issue, chunk out your request more granularly in the referencing class, and ideally populate a stream with the partially processed content so it is not bloating runtime memory. Parameters `$content` any of the following: [string, int, float, double, bool, null, an object that is iterable, an object with the __toString method] Returns string Throws `oroboros\core\utilities\exception\InvalidArgumentException` if it encounters un-stringable content.
`private boolean`	# `_isIterableObject( stdClass $object )` Returns whether or not the object passed is iterable, and can be handled similarly to an array. Returns whether or not the object passed is iterable, and can be handled similarly to an array. Will only accept an actual object (all php classes extend \stdClass). Type checking needs to be done earlier on if it applies. Will produce a fatal error if you give it anything else. Checks against native php valid iterable interfaces, and returns true if the object or it's parent implements either of them. Parameters `$object` Returns boolean See http://php.net/manual/en/class.iterator.php http://php.net/manual/en/class.iteratoraggregate.php http://php.net/manual/en/class.traversable.php Note when only PHP 7.0+ is supported, this will be replaced with the native is_iterable function.
`private boolean`	# `_isDebugEnabled( )` Checks if debug is enabled for the current object instance. Checks if debug is enabled for the current object instance. Returns boolean
`private string\|null`	# `_getDebugPrefix( string $hook )` Returns the debug hook replacement prefix if debug is enabled, and null if it isn't. Returns the debug hook replacement prefix if debug is enabled, and null if it isn't. Parameters `$hook` Returns string\|null See \oroboros\core\abstracts\libraries\hooks\AbstractHook::_isDebugEnabled
`private string\|null`	# `_getDebugSuffix( string $hook )` Returns the debug hook replacement suffix if debug is enabled, and null if it isn't. Returns the debug hook replacement suffix if debug is enabled, and null if it isn't. Parameters `$hook` Returns string\|null See \oroboros\core\abstracts\libraries\hooks\AbstractHook::_isDebugEnabled
`private`	# `_getHookValue( $hook )`
`private`	# `_setHook( $hook, $value )`
`private`	# `_unsetHook( $hook )`
`private`	# `_listHooks( )`
`private`	# `_getValidHookNames( )`
`private`	# `_getHookValueByKey( $hook )`

Constants summary

`string`	`HOOK_PREFIX` Overrideable way of designating the prefix of a valid hook Overrideable way of designating the prefix of a valid hook	# `'::'`
`string`	`HOOK_SUFFIX` Overrideable way of designating the suffix of a valid hook Overrideable way of designating the suffix of a valid hook	# `'::'`
`string`	`HOOK_DEBUG_PREFIX` If the debug flag is passed, parsed output will prefix the hooked content with this value, applying sprintf to it with the parameters $hook and $current_class If the debug flag is passed, parsed output will prefix the hooked content with this value, applying sprintf to it with the parameters $hook and $current_class	# `'\r\n[HOOK_DEBUG: start_hook[hook: _%s_][class: _%s_ ]\r\n'`
`string`	`HOOK_DEBUG_SUFFIX` If the debug flag is passed, parsed output will suffix the hooked content with this value, applying sprintf to it with the parameters $hook and $current_class If the debug flag is passed, parsed output will suffix the hooked content with this value, applying sprintf to it with the parameters $hook and $current_class	# `'\r\n[/hook: _%s_][class: _%s_] /HOOK_DEBUG]\r\n'`
`string`	`CONTENCATION_DELIMITER` Overrideable way of designating the implode delimiter for content that is an array. Overrideable way of designating the implode delimiter for content that is an array. By default, uses line breaks. This only applies if the content is an array or an iterable object.	# `PHP_EOL`

Constants inherited from oroboros\core\abstracts\OroborosBaseAbstract

API, CLASS_SCOPE

Constants inherited from oroboros\core\interfaces\api\LogLevelApi

ALERT, CRITICAL, DEBUG, EMERGENCY, ERROR, INFO, NOTICE, WARNING

Constants inherited from oroboros\core\interfaces\api\ExceptionCodeApi

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Properties summary

`private`	`$_content`	# `null`
`private boolean`	`$_isParsed`	# `false`
`private boolean`	`$_debug_enabled`	# `false`
`private boolean`	`$_use_hook_debug_override_methods`	# `false`

Properties used from oroboros\core\traits\BaseTrait

$_constructed

Properties used from oroboros\core\traits\utilities\LoaderTrait

$_LoaderTrait_allowed_types, $_LoaderTrait_factory, $_LoaderTrait_loader_initialized, $_LoaderTrait_loader_types

Properties used from oroboros\core\traits\utilities\DefaultLoggerTrait

$_DefaultLoggerTrait_logger

Namespaces

Classes

Class AbstractHookParser

Methods summary

Parameters

Overrides

Parameters

Overrides

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

See

Note

Returns

Parameters

Returns

See

Parameters

Returns

See

Methods inherited from oroboros\core\abstracts\libraries\AbstractLibrary

Methods inherited from oroboros\core\interfaces\BaseAbstractInterface

Methods used from oroboros\core\traits\utilities\LoaderTrait

Methods used from oroboros\core\traits\utilities\DefaultLoggerTrait

Constants summary

Constants inherited from oroboros\core\abstracts\OroborosBaseAbstract

Constants inherited from oroboros\core\interfaces\api\LogLevelApi

Constants inherited from oroboros\core\interfaces\api\FlagApi

Constants inherited from oroboros\core\interfaces\api\ExceptionCodeApi

Constants inherited from oroboros\OroborosInterface

Properties summary

Properties used from oroboros\core\traits\BaseTrait

Properties used from oroboros\core\traits\utilities\LoaderTrait

Properties used from oroboros\core\traits\utilities\DefaultLoggerTrait