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

Classes

  • AbstractAdapter
  • AbstractBrowserAdapter
  • AbstractDatabaseAdapter
  • AbstractLibraryAdapter
  • AbstractProxyAdapter
  • AbstractSdkAdapter
  • AbstractServiceAdapter
  • AbstractShellAdapter
  • AbstractSocketAdapter

Class AbstractAdapter

Within the Oroboros class structure, an adapter is a class that wraps a 3rd party library, external asset, or any non-PHP construct that needs to be interacted with. Adapters are registered into the system as satisfying requirements for a specific exteral asset or package, and will be passed directly by the adapter factory by keyword.

Adapters inherently rely on the ControlApi trait to generate their Api dynamically. This trait allows the class to control specific prefixed protected methods publicly, and keep an indexed registration of them by prefix keyword. This allows you to easily scrape any connected class's public methods and create a passthru for them that is externally documented using their doc-block comments similar to how apigen produces code coverage documentation.

oroboros\core\abstracts\OroborosBaseAbstract implements oroboros\core\interfaces\BaseAbstractInterface uses oroboros\core\traits\BaseTrait
Extended by oroboros\core\abstracts\adapters\AbstractAdapter uses oroboros\core\traits\views\ViewTrait

Direct known subclasses

oroboros\core\abstracts\adapters\AbstractBrowserAdapter, oroboros\core\abstracts\adapters\AbstractDatabaseAdapter, oroboros\core\abstracts\adapters\AbstractLibraryAdapter, oroboros\core\abstracts\adapters\AbstractProxyAdapter, oroboros\core\abstracts\adapters\AbstractSdkAdapter, oroboros\core\abstracts\adapters\AbstractServiceAdapter, oroboros\core\abstracts\adapters\AbstractShellAdapter, oroboros\core\abstracts\adapters\AbstractSocketAdapter, oroboros\core\abstracts\libraries\shell\AbstractShell

Abstract
Namespace: oroboros\core\abstracts\adapters
Author: Brian Dayhoff brian@mopsyd.me
Satisfies: CLASS_TYPE = '::adapter::'
Located at core/abstracts/adapters/AbstractAdapter.php

Methods summary

Methods inherited from oroboros\core\interfaces\BaseAbstractInterface

__construct(), fingerprint(), initialize()

Methods used from oroboros\core\traits\views\ViewTrait

__construct(), __destruct(), _buildContent(), _processHeaders(), _resetHeaders(), _setHeaders(), _toUrl(), _updateParameterConditions(), initialize(), redirect(), render(), reset()

Constants summary

string CLASS_TYPE
# \oroboros\core\interfaces\api\ClassTypeApi::CLASS_TYPE_ADAPTER

Constants inherited from oroboros\core\abstracts\OroborosBaseAbstract

API, CLASS_SCOPE

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

Properties summary

Properties used from oroboros\core\traits\BaseTrait

$_constructed

Properties used from oroboros\core\traits\views\ViewTrait

$_allowed_loader_types, $_base_url, $_content, $_css, $_fonts, $_headers, $_meta, $_output_mode, $_scripts, $_valid_output_modes

Oroboros Core API documentation generated by ApiGen