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

  • AdapterApi
  • AuthApi
  • BaseApi
  • BehavioralPatternApi
  • BootstrapApi
  • CacheApi
  • ClassScopeApi
  • ClassTypeApi
  • CodexApi
  • CollectionApi
  • ConcurrencyPatternApi
  • ContainerApi
  • ControllerApi
  • CoreApi
  • CreationalPatternApi
  • DatabaseApi
  • DataObjectApi
  • DataObjectCollectionApi
  • DefaultApi
  • EntityApi
  • EntityCollectionApi
  • EnumApi
  • EnvironmentApi
  • EventApi
  • ExceptionApi
  • ExceptionCodeApi
  • ExceptionMessageApi
  • ExtensionrApi
  • FlagApi
  • HtmlTemplateApi
  • JobApi
  • JobCollectionApi
  • LibraryApi
  • LoggerApi
  • LogLevelApi
  • MathApi
  • ModelApi
  • ModuleApi
  • OroborosApi
  • ParserApi
  • PatternApi
  • RecordApi
  • RecordCollectionApi
  • RegexApi
  • RequestApi
  • ResponseApi
  • RouteApi
  • RouterApi
  • RoutineApi
  • ServerApi
  • ServiceApi
  • ServiceCollectionApi
  • ShellApi
  • StreamApi
  • StructuralPatternApi
  • TemplateApi
  • UtilityApi
  • ViewApi

Namespace oroboros\core\interfaces\api

Namespaces summary

oroboros\core\interfaces\api\adapters
oroboros\core\interfaces\api\bootstrap
oroboros\core\interfaces\api\controllers
oroboros\core\interfaces\api\psr

Interfaces summary

AdapterApi

Defines the standard methods for interacting with adapter objects.

AuthApi

Defines the standard methods for interacting with auth objects.

BaseApi

This interface represents the root level api interface. All other api interfaces extend from this root, excluding the enumerated api interface chain. This is a null api, meant to designate the origin of a chain of related interface constructs.

BehavioralPatternApi

Defines the standard methods for interacting with behavioral patterns.

BootstrapApi

Defines the standard methods for interacting with bootstrap objects.

CacheApi

Defines the standard methods for interacting with cache objects.

ClassScopeApi
ClassTypeApi
CodexApi

Defines the standard methods for interacting with the codex.

CollectionApi

Defines the standard methods for interacting with collections.

ConcurrencyPatternApi

Defines the standard methods for interacting with concurrency patterns.

ContainerApi

The Container Api introduces a uniform, interoperable approach to containers, which complies with the Psr-11 ContainerInterface. This is the root api used for data-objects, which are a low-level class type used throughout this system.

ControllerApi

Defines the standard methods for interacting with controllers.

CoreApi

This interface represents method contract for the Oroboros core global accessor. This requires the methods neccessary for dynamic line item usage of the static accessor.

CreationalPatternApi

Defines the standard methods for interacting with creational patterns.

DatabaseApi

Defines the standard method set for interacting with databases.

DataObjectApi

Defines the standard method set for interacting with data objects.

DataObjectCollectionApi

Defines the standard methods for interacting with data object collections.

DefaultApi

This class provides a null API if another API is not attached to an evaluated class.

EntityApi

Defines the standard methods for interacting with entities.

EntityCollectionApi

Defines the standard methods for interacting with entity collections.

EnumApi

Defines the standard methods for interacting with entities.

EnvironmentApi

Defines a set of consistent parameters regarding the environment in a read-only way at compile-time.

EventApi

Defines the standard methods for interacting with events.

ExceptionApi

Defines the standard methods for interacting with oroboros exceptions.

ExceptionCodeApi

This interface declares all of the exception codes used by the system. It may be implemented to provide easy access to error code levels for checking or throwing

system compliant exceptions.

If you throwing an exception from a trait, you can reference these definitions like so:

ExceptionMessageApi

Provides default message bodies for error messages.

ExtensionrApi

Defines the standard methods for interacting with extension objects.

FlagApi

Defines the base level system flags, and the standard methods for interacting with flags.

HtmlTemplateApi

Provides the standard methods for interacting with html templates.

JobApi

Provides the standard methods for interracting with jobs.

JobCollectionApi

Provides the standard methods for interacting with job collections.

LibraryApi

Defines the standard methods for interacting with parsers.

LoggerApi

Defines the standard methods for interacting with the logger. This follows the Psr-3 standards for logger objects

LogLevelApi

Provides the valid Psr-3 Log levels through an interface. This interface does NOT cause the class to validate as Psr-3 compliant, it only insures that all of the valid log levels are known to the implementing class, allowing them to be called natively by using self::ERRORLEVEL

MathApi

Defines the standard methods for interacting with the math library.

ModelApi

Defines the standard methods for interacting with models.

ModuleApi

Defines the standard methods for interacting with modules.

OroborosApi

Defines the standard methods accessible through the oroboros core object.

ParserApi

Defines the standard methods for interacting with parsers.

PatternApi

Defines the standard methods for interacting with utilities.

RecordApi

Defines the standard methods for interacting with records.

RecordCollectionApi

Defines the standard methods for interacting with record collections.

RegexApi

Defines the universal regex patterns used throughout the system.

RequestApi

Defines the standard methods for interacting with a request object. This follows the \Psr\Http\Message\ServerRequestInterface standards outlined in Psr-7 standards. In contrast to the Psr-7, spec, this also allows for a uniform approach to cli arguments.

ResponseApi

Defines the standard methods for interacting with a request object. This follows the \Psr\Http\Message\ResponseInterface standards outlined in Psr-7 standards. In contrast to the Psr-7, spec, this also allows for a uniform approach to cli arguments.

RouteApi

Defines the standard methods for interacting with routes.

RouterApi

Defines the standard methods for interacting with routers.

RoutineApi

Defines the standard methods for interacting with a routine object.

ServerApi

Defines the standard methods for interacting with webserver wrapper objects.

ServiceApi

Defines the standard methods for interacting with webserver wrapper objects.

ServiceCollectionApi

Defines the standard methods for interacting with service collections.

ShellApi

Defines the standard methods for interacting with shell wrappers.

StreamApi

Defines the standard methods for interacting with streams. This follows the \Psr\Http\Message\StreamInterface standards outlined in Psr-7 standards.

StructuralPatternApi

Defines the standard methods for interacting with structural patterns.

TemplateApi

This interface provides the public API for usage of html template classes in the Oroboros Core.

UtilityApi

Defines the standard methods for interacting with utilities.

ViewApi

Defines the standard methods for interacting with views.

Oroboros Core API documentation generated by ApiGen