Class OroborosBaseAbstract

This class defines a few very simple configurations to identify as part of Oroboros, and implements common interfaces. All other Oroboros classes descend from this one wherever possible. There is a also a trait to emulate this behavior for classes that must extend a different class for some reason.

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

Direct known subclasses

Indirect known subclasses

Abstract
Namespace: oroboros\core\abstracts
Author: Brian Dayhoff brian@mopsyd.me
Since: 0.0.1a
See:

\oroboros\core\traits\BaseTrait

- implements \oroboros\core\interfaces\BaseAbstractInterface - use \oroboros\core\traits\BaseTrait; - const CLASS_SCOPE = \oroboros\core\interfaces\api\ClassScopeApi::CLASS_SCOPE_LIBRARY_ABSTRACT; - const API = false;

Any class can emulate this behavior without extending this class

and still be recognized as a valid Oroboros internal by doing the following:

Extend one of the classes located in: \oroboros\core\abstracts
Declare the class constant: CLASS_SCOPE using one of the values in: \oroboros\core\interfaces\api\ClassScopeApi
Declare the class constant: API

, either as false,

or as one of the Api interfaces located in: \oroboros\core\interfaces\api - Profit.

IF YOUR CONSTRUCTOR IS COMPATIBLE WITH THE ONE DEFINED HERE: (In this case we will register a fully qualified Oroboros class) - In your class

use the trait: \oroboros\core\traits\BaseTrait - Implement the interface: \oroboros\core\interfaces\BaseAbstractInterface - Declare the class constant: CLASS_SCOPE using one of the values in: \oroboros\core\interfaces\api\ClassScopeApi - Declare the class constant: API

, either as false,

or as one of the Api interfaces located in: \oroboros\core\interfaces\api - Profit.

IF YOUR CONSTRUCTOR IS INCOMPATIBLE WITH THE ONE DEFINED ABOVE: (in this case we will register a utility

which is a 3rd party class that still connects to the system correctly) - In your class

use the trait: \oroboros\core\traits\utility\UtilityApiTrait - Implement the interface: \oroboros\core\interfaces\api\UtilityApi - Declare the class constant: CLASS_SCOPE using one of the values in: \oroboros\core\interfaces\api\ClassScopeApi - Declare the class constant: API

, either as false,

or as one of the Api interfaces located in: \oroboros\core\interfaces\api -Profit.

it is suggested that you instead provide a utility

or alternately wrap it in an adapter. Larger packages may be provided as a module or extension.

See: oroboros\core\interfaces\api\UtilityApi
See: oroboros\core\interfaces\api\AdapterApi
See: oroboros\core\interfaces\api\ModuleApi
See: \oroboros\core\interfaces\api\ExtensionApi
Covers: rootclass
Located at core/abstracts/OroborosBaseAbstract.php

Methods summary

Methods inherited from oroboros\core\interfaces\BaseAbstractInterface

__construct(), fingerprint(), initialize()

Methods used from oroboros\core\traits\BaseTrait

__construct(), __destruct()

Constants summary

`string`	`CLASS_SCOPE` The class type and class scope determine what functionality to provide to the system. This default value resolves to ::abstract-library:: The class type and class scope determine what functionality to provide to the system. This default value resolves to ::abstract-library:: You may override this within your class using the following definitions: See `oroboros\core\interfaces\api\ClassScopeApi`	# `\oroboros\core\interfaces\api\ClassScopeApi::CLASS_SCOPE_LIBRARY_ABSTRACT`
`boolean`	`API` Override this in child classes to define an API for the class. If you have an api, it should be a valid API interface, or a reference to it's enumerated getter object. (mandatory) Override this in child classes to define an API for the class. If you have an api, it should be a valid API interface, or a reference to it's enumerated getter object. (mandatory) See `oroboros\core\interfaces\api\ClassTypeApi` Example \oroboros\core\interfaces\api\DefaultApi Note You must define this as false by default in your class, or alternately follow the below instructions. (optional) bind to an existing provided Api, or: create an Api interface using the following criteria: Api interfaces MUST have Api.php as their suffix (no "." characters prior to this either) Api interfaces MUST declare a CLASS_TYPE constant, with a value provided by: Api CLASS_TYPE determines what portion of the system the class is registered as an override for. You will probably only need to use ::module:: or ::extension::, but you may use any provided there. Api interfaces MUST declare the following class constants (all may be false by default): [API_DOCS, API_NAME, API_SDK, API_REPO, API_VERSION, API_AUTHOR, API_LICENSE, API_SITE]; Api interface constant values MUST be false if not provided. Api interfaces SHOULD NOT extend other API interfaces, or the constants will collide. DO NOT DO THIS IN AN INTERFACE OR YOU WILL WHITESCREEN API is repeatedly declared WITHIN CLASSES throughout the system. Any child class that inherits from a class that has this defined in their interface will not be able to declare their own api without causing a fatal error. For this reason, you should never declare this constant in an interface, or implement an interface that has it defined.	# `false`