Oroboros Core
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • None
  • oroboros
    • core
      • abstracts
        • adapters
        • bootstrap
        • controllers
        • libraries
          • auth
          • bootstrap
          • cache
          • codex
          • config
          • container
          • data
          • database
          • dns
          • entity
          • enum
          • error
          • event
          • extension
          • file
          • flags
          • hooks
          • job
          • logger
          • manager
          • message
          • prototype
          • request
          • response
          • routine
          • shell
          • startup
          • stream
          • template
          • uri
          • utility
          • validation
            • workers
          • worker
        • models
        • patterns
          • behavioral
          • creational
        • utilities
          • exception
            • cache
            • container
          • http
        • views
      • interfaces
        • adapters
          • interpreters
          • sdk
        • api
          • adapters
          • bootstrap
          • controllers
          • psr
        • contract
          • adapters
          • bootstrap
          • codex
          • components
          • controllers
          • data
          • entities
          • errors
          • events
          • extensions
          • jobs
          • libraries
            • auth
            • cache
            • config
            • container
            • enum
            • file
            • flags
            • hooks
            • module
            • promise
            • record
            • request
            • response
            • server
            • shutdown
            • site
            • stream
            • template
            • theme
            • uri
          • models
          • patterns
            • behavioral
            • concurrency
            • creational
            • structural
          • routes
          • routines
            • bootload
            • declarative
            • procedural
            • subsystem
          • services
            • consumer
              • cgi
              • rest
                • local
                • remote
                  • authenticated
                  • unauthenticated
            • provider
              • cgi
              • rest
                • local
                • remote
                  • authenticated
                  • unauthenticated
          • utilities
            • datetime
            • exception
              • cache
              • container
            • filebase
            • http
            • math
            • parser
            • regex
            • session
          • views
        • enumerated
          • environment
          • flags
          • http
          • views
        • libraries
          • manager
          • worker
      • libraries
        • api
        • codex
        • container
        • enum
          • http
        • file
        • hooks
        • logger
        • math
        • psr4
        • request
        • response
        • stream
        • uri
      • patterns
        • creational
      • traits
        • adapters
        • bootstrap
        • codex
        • components
        • controllers
        • data
        • entities
        • events
        • extensions
        • jobs
        • libraries
          • container
          • file
          • request
          • response
          • stream
          • uri
        • models
        • modules
        • patterns
          • behavioral
          • concurrency
          • creational
          • structural
        • routes
        • services
        • utilities
          • core
            • api
            • config
            • contract
              • contract
            • enum
            • environment
            • routines
          • datetime
          • error
          • exception
          • filebase
          • hooks
          • html
          • http
          • logic
          • math
          • parsers
          • regex
          • session
        • views
      • utilities
        • exception
          • cache
          • container
        • http
      • views
    • tests
      • patterns
        • creational
      • psr
        • psr7
      • utilities
        • exception
  • PasswordCompat
    • binary
  • PHP

Interfaces

  • BaseAbstractInterface

Interface BaseAbstractInterface

oroboros\core\interfaces\BaseAbstractInterface implements oroboros\OroborosInterface, oroboros\core\interfaces\api\ExceptionCodeApi, oroboros\core\interfaces\api\FlagApi, oroboros\core\interfaces\api\LogLevelApi

Direct known implementers

oroboros\core\abstracts\OroborosBaseAbstract

Indirect known implementers

oroboros\core\abstracts\adapters\AbstractAdapter, oroboros\core\abstracts\adapters\AbstractBrowserAdapter, oroboros\core\abstracts\controllers\AbstractCgiController, oroboros\core\abstracts\controllers\AbstractController, oroboros\core\abstracts\controllers\AbstractFrontController, oroboros\core\abstracts\controllers\AbstractHttpController, oroboros\core\abstracts\controllers\AbstractRoutineController, oroboros\core\abstracts\libraries\AbstractLibrary, oroboros\core\abstracts\libraries\auth\AbstractAuth, oroboros\core\abstracts\libraries\bootstrap\AbstractBootstrap, oroboros\core\abstracts\libraries\cache\AbstractCache, oroboros\core\abstracts\libraries\data\AbstractDataObject, oroboros\core\abstracts\adapters\AbstractDatabaseAdapter, oroboros\core\abstracts\libraries\database\AbstractDatabaseManager, oroboros\core\abstracts\libraries\dns\AbstractRoute, oroboros\core\abstracts\libraries\dns\AbstractRouter, oroboros\core\abstracts\libraries\entity\AbstractEntity, oroboros\core\abstracts\libraries\error\AbstractErrorEvent, oroboros\core\abstracts\libraries\event\AbstractEvent, oroboros\core\abstracts\libraries\event\AbstractServerEvent, oroboros\core\abstracts\libraries\extension\AbstractExtension, oroboros\core\abstracts\libraries\flags\AbstractFlag, oroboros\core\abstracts\libraries\hooks\AbstractHook, oroboros\core\abstracts\adapters\AbstractLibraryAdapter, oroboros\core\abstracts\libraries\hooks\AbstractHookParser, oroboros\core\abstracts\libraries\job\AbstractJob, oroboros\core\abstracts\libraries\logger\AbstractLogger, oroboros\core\abstracts\libraries\routine\AbstractRoutine, oroboros\core\abstracts\libraries\shell\AbstractShell, oroboros\core\abstracts\libraries\startup\AbstractBootstrap, oroboros\core\abstracts\libraries\template\AbstractTemplate, oroboros\core\abstracts\libraries\utility\AbstractUtility, oroboros\core\abstracts\patterns\behavioral\AbstractDirector, oroboros\core\abstracts\patterns\creational\AbstractFactory, oroboros\core\abstracts\adapters\AbstractProxyAdapter, oroboros\core\abstracts\patterns\creational\AbstractPrototypical, oroboros\core\libraries\codex\Codex, oroboros\core\libraries\hooks\SimpleHook, oroboros\core\libraries\logger\FileLogger, oroboros\core\libraries\logger\NullLogger, oroboros\core\patterns\creational\AdapterFactory, oroboros\core\patterns\creational\AppFactory, oroboros\core\patterns\creational\ControllerFactory, oroboros\core\patterns\creational\FactoryFactory, oroboros\core\patterns\creational\LibraryFactory, oroboros\core\abstracts\adapters\AbstractSdkAdapter, oroboros\core\patterns\creational\ModelFactory, oroboros\core\patterns\creational\ModuleFactory, oroboros\core\patterns\creational\TemplateFactory, oroboros\core\patterns\creational\ViewFactory, oroboros\core\abstracts\adapters\AbstractServiceAdapter, oroboros\core\abstracts\adapters\AbstractShellAdapter, oroboros\core\abstracts\adapters\AbstractSocketAdapter, oroboros\core\abstracts\controllers\AbstractAjaxController

Namespace: oroboros\core\interfaces
Author: Brian Dayhoff brian@mopsyd.me
Located at core/interfaces/BaseAbstractInterface.php

Methods summary

public
# __construct( array $params = array(), array $flags = array() )

Constructors SHOULD NOT perform operations directly. Constructors SHOULD ONLY return a built, non-initialized object with a unique fingerprint.

Constructors SHOULD NOT perform operations directly. Constructors SHOULD ONLY return a built, non-initialized object with a unique fingerprint.

Classes in this system MUST provide a constructor that provides two, and only two parameters, as defined below.

These parameters SHOULD be stored in private class variables, and not be processed until the initialize method is called. This gives an opportunity to allow custom settings for your class, for unit testing and debugging to be injected into an instance of it that has been created, to emulate settings where a bug may be encountered.

Params indicates any arguments you need to pass into the constructor, which should be designated as key => value pairs. Flags indicate any additional constants that should be passed to trigger interal operations. These should either be universal Oroboros Flags as defined in the flag interface, or class constants of the class itself in the format of [ const FLAG_FLAGNAME = "::somevalue::"; ]. Any additional arguments needed should be handled from these two arrays. Both MUST also provide default empty values, so constructors can be called without arguments if required. This should immediately throw an exception in the constructor if that specific class constructor MUST have an input value.

Parameters

$params
$flags

Since

0.0.2a
public object
# initialize( array $params = array(), array $flags = array() )

Classes in this system MUST provide a initialization method that provides two, and only two parameters, as defined below.

Classes in this system MUST provide a initialization method that provides two, and only two parameters, as defined below.

These parameters SHOULD be stored in private class variables before processing, and SHOULD be able to be supplied either in the constructor OR the initialize method with no actual difference in operation (unless initial values are overruled with non-empty values in the initialize method). the initialize method is called externally. This gives an opportunity to allow custom settings for your class, for unit testing and debugging parameters to be injected into an instance of it that has been created, to emulate settings where a bug may be encountered.

Params indicates any arguments you need to pass into the initialization method, which should be designated as key => value pairs. Flags indicate any additional constants that should be passed to trigger interal operations. These should either be universal Oroboros Flags as defined in the flag interface, or class constants of the class itself in the format of [ const FLAG_FLAGNAME = "::somevalue::"; ]. Any additional arguments needed should be handled from these two arrays. Both MUST also provide default empty values, so constructors can be called without arguments if required. This should immediately throw an exception in the initialization method if that specific class constructor MUST have an input value.

Parameters

$params
(optional)
$flags
(optional)

Returns

object
instanceof self (eg: return $this;)

Since

0.0.2a
public string
# fingerprint( )

Returns the unique fingerprint of the object instance created when the base class is constructed. This method cannot be overrided.

Returns the unique fingerprint of the object instance created when the base class is constructed. This method cannot be overrided.

Returns

string

Since

0.0.2a

Constants summary

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

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

ERROR_ADAPTER, ERROR_CLUSTER, ERROR_CONTROLLER, ERROR_CORE, ERROR_CORE_ADAPTER_FAILURE, ERROR_CORE_AUTH_FAILURE, ERROR_CORE_BOOTSTRAP_FAILURE, ERROR_CORE_CONTROLLER_FAILURE, ERROR_CORE_DATA_OBJECT_FAILURE, ERROR_CORE_ENTITY_FAILURE, ERROR_CORE_ENUM_FAILURE, ERROR_CORE_ERROR_FAILURE, ERROR_CORE_EVENT_FAILURE, ERROR_CORE_EXTENSION_FAILURE, ERROR_CORE_FLAG_FAILURE, ERROR_CORE_FUNCTION_FAILURE, ERROR_CORE_JOB_FAILURE, ERROR_CORE_LIBRARY_FAILURE, ERROR_CORE_MODEL_FAILURE, ERROR_CORE_MODULE_FAILURE, ERROR_CORE_PARSER_FAILURE, ERROR_CORE_PATTERN_FAILURE, ERROR_CORE_RECORD_FAILURE, ERROR_CORE_REQUEST_FAILURE, ERROR_CORE_RESPONSE_FAILURE, ERROR_CORE_ROUTER_FAILURE, ERROR_CORE_ROUTINE_FAILURE, ERROR_CORE_SERVICE_FAILURE, ERROR_CORE_STREAM_FAILURE, ERROR_CORE_UTILITY_FAILURE, ERROR_CORE_VIEW_FAILURE, ERROR_DATABASE, ERROR_FILESYSTEM, ERROR_INITIALIZATION, ERROR_INSTALLATION, ERROR_LIBRARY, ERROR_LOGIC, ERROR_LOGIC_BAD_PARAMETERS, ERROR_LOGIC_MISSING_PARAMETERS, ERROR_MODEL, ERROR_MODULE, ERROR_NETWORK, ERROR_NODE, ERROR_PHP, ERROR_PHP_BAD_FUNCTION_CALL, ERROR_PHP_BAD_METHOD_CALL, ERROR_PHP_BAD_PARAMETERS, ERROR_PHP_CALLSTATIC_FAILURE, ERROR_PHP_CALL_FAILURE, ERROR_PHP_CLONE_FAILURE, ERROR_PHP_DEBUG_INFO_FAILURE, ERROR_PHP_DESTRUCTOR_FAILURE, ERROR_PHP_GETTER_FAILURE, ERROR_PHP_INSTANTIATION_FAILURE, ERROR_PHP_INVOCATION_FAILURE, ERROR_PHP_IS_SET_FAILURE, ERROR_PHP_KEY_NOT_FOUND, ERROR_PHP_METHOD_FAILURE, ERROR_PHP_NOT_INITIALIZED, ERROR_PHP_SERIALIZATION_FAILURE, ERROR_PHP_SETTER_FAILURE, ERROR_PHP_SLEEP_FAILURE, ERROR_PHP_TO_ARRAY_FAILURE, ERROR_PHP_UNSERIALIZATION_FAILURE, ERROR_PHP_UN_SET_FAILURE, ERROR_PHP_WAKEUP_FAILURE, ERROR_PHP_WRONG_INSTANCE_SUPPLIED, ERROR_PHP_WRONG_SCHEMA_PROVIDED, ERROR_ROUTINE, ERROR_ROUTING, ERROR_SDK, ERROR_SECURITY, ERROR_SECURITY_LOCKED_COLUMN, ERROR_SECURITY_LOCKED_COMMAND, ERROR_SECURITY_LOCKED_ENTITY, ERROR_SECURITY_LOCKED_EVENT, ERROR_SECURITY_LOCKED_FILE, ERROR_SECURITY_LOCKED_JOB, ERROR_SECURITY_LOCKED_OBJECT, ERROR_SECURITY_LOCKED_POLICY, ERROR_SECURITY_LOCKED_RESOURCE, ERROR_SECURITY_LOCKED_ROUTE, ERROR_SECURITY_LOCKED_TABLE, ERROR_SESSION, ERROR_UNKNOWN, ERROR_VIEW, SAFE_MINIMUM_ERROR_RANGE

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

FLAG_ALPHA, FLAG_BETA, FLAG_DEBUG, FLAG_DEVELOPMENT, FLAG_LOCK_EXECUTE, FLAG_LOCK_READ, FLAG_LOCK_WRITE, FLAG_MAINTENANCE, FLAG_MODE_AJAX, FLAG_MODE_CLI, FLAG_PRODUCTION, FLAG_READONLY, FLAG_RECOVERY, FLAG_SANDBOX, FLAG_TYPE_DELETE, FLAG_TYPE_GET, FLAG_TYPE_HEAD, FLAG_TYPE_OPTIONS, FLAG_TYPE_POST, FLAG_TYPE_PUT, FLAG_UNIT_TEST

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

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

Oroboros Core API documentation generated by ApiGen