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

  • BaseContract
  • CoreContract

Interface BaseContract

This interface represents the root level contract interface. All other contract interfaces extend from this root. This is a null contract, meant to designate the origin of a chain of related interface constructs. It has no base level requirements on it's own.


Contract interfaces enforce expected behavior in a non-colliding way. They are tasked with enforcing methods, and extending interfaces provided by standards and other packages for compatibility.

All valid oroboros classes MUST extend at

least one Contract Interface to be considered valid.

Direct known implementers

oroboros\core\interfaces\contract\adapters\AdapterContract, oroboros\core\interfaces\contract\bootstrap\BootstrapContract, oroboros\core\interfaces\contract\extensions\ExtensionContract, oroboros\core\interfaces\contract\jobs\JobContract, oroboros\core\interfaces\contract\libraries\LibraryContract, oroboros\core\interfaces\contract\models\ModelContract, oroboros\core\interfaces\contract\patterns\PatternContract, oroboros\core\interfaces\contract\routes\RouteContract, oroboros\core\interfaces\contract\routes\RouterContract, oroboros\core\interfaces\contract\routines\RoutineContract, oroboros\core\interfaces\contract\services\ServiceContract, oroboros\core\interfaces\contract\utilities\UtilityContract, oroboros\core\interfaces\contract\codex\CodexContract, oroboros\core\interfaces\contract\views\ViewContract, oroboros\core\interfaces\contract\components\ComponentContract, oroboros\core\interfaces\contract\controllers\ControllerContract, oroboros\core\interfaces\contract\CoreContract, oroboros\core\interfaces\contract\data\DataObjectContract, oroboros\core\interfaces\contract\entities\EntityContract, oroboros\core\interfaces\contract\errors\ErrorContract, oroboros\core\interfaces\contract\events\EventContract

Indirect known implementers

Bootstrap, oroboros\core\abstracts\bootstrap\AbstractBootstrap, oroboros\core\abstracts\libraries\stream\AbstractStream, oroboros\core\interfaces\contract\services\provider\rest\remote\unauthenticated\UnauthenticatedRemoteRestServiceProviderContract, oroboros\core\interfaces\contract\services\provider\rest\RestServiceProviderContract, oroboros\core\interfaces\contract\services\provider\ServiceProviderContract, oroboros\core\interfaces\contract\utilities\datetime\DateContract, oroboros\core\interfaces\contract\utilities\datetime\TimeContract, oroboros\core\interfaces\contract\utilities\exception\cache\CacheExceptionContract, oroboros\core\interfaces\contract\utilities\exception\cache\InvalidArgumentExceptionContract, oroboros\core\interfaces\contract\utilities\exception\container\ContainerExceptionContract, oroboros\core\interfaces\contract\utilities\exception\container\NotFoundExceptionContract, oroboros\core\interfaces\contract\utilities\exception\ExceptionContract, oroboros\core\abstracts\libraries\uri\AbstractUri, oroboros\core\interfaces\contract\utilities\filebase\DirectoryContract, oroboros\core\interfaces\contract\utilities\filebase\DirectoryIndexContract, oroboros\core\interfaces\contract\utilities\filebase\FileContract, oroboros\core\interfaces\contract\utilities\http\CookieContract, oroboros\core\interfaces\contract\utilities\http\HeaderContract, oroboros\core\interfaces\contract\utilities\http\ProtocolContract, oroboros\core\interfaces\contract\utilities\http\RequestMethodContract, oroboros\core\interfaces\contract\utilities\http\StatusCodeContract, oroboros\core\interfaces\contract\utilities\math\MathContract, oroboros\core\interfaces\contract\utilities\parser\ParserContract, oroboros\core\abstracts\models\AbstractAdapterModel, oroboros\core\interfaces\contract\utilities\regex\RegexContract, oroboros\core\interfaces\contract\utilities\session\SessionContract, oroboros\core\interfaces\libraries\manager\ManagerContract, oroboros\core\interfaces\libraries\worker\WorkerContract, oroboros\core\libraries\container\Collection, oroboros\core\libraries\file\File, oroboros\core\libraries\request\Request, oroboros\core\libraries\request\ServerRequest, oroboros\core\libraries\response\Response, oroboros\core\libraries\stream\Message, oroboros\core\abstracts\models\AbstractDataModel, oroboros\core\libraries\stream\Stream, oroboros\core\libraries\uri\Uri, oroboros\core\patterns\creational\Prototyper, oroboros\core\utilities\exception\BadFunctionCallException, oroboros\core\utilities\exception\BadMethodCallException, oroboros\core\utilities\exception\cache\CacheException, oroboros\core\utilities\exception\cache\InvalidArgumentException, oroboros\core\utilities\exception\container\ContainerException, oroboros\core\utilities\exception\container\NotFoundException, oroboros\core\utilities\exception\DomainException, oroboros\core\abstracts\models\AbstractEntityModel, oroboros\core\utilities\exception\Exception, oroboros\core\utilities\exception\InvalidArgumentException, oroboros\core\utilities\exception\LengthException, oroboros\core\utilities\exception\LogicException, oroboros\core\utilities\exception\OutOfBoundsException, oroboros\core\utilities\exception\OutOfRangeException, oroboros\core\utilities\exception\OverflowException, oroboros\core\utilities\exception\RangeException, oroboros\core\utilities\exception\RuntimeException, oroboros\core\utilities\exception\UnderflowException, oroboros\core\abstracts\models\AbstractEventModel, oroboros\core\utilities\exception\UnexpectedValueException, oroboros\core\utilities\http\Cookie, oroboros\core\utilities\http\Header, oroboros\core\utilities\http\Protocol, oroboros\core\utilities\http\RequestHeader, oroboros\core\utilities\http\RequestMethod, oroboros\core\utilities\http\ResponseHeader, oroboros\core\utilities\http\StatusCode, oroboros\Oroboros, oroboros\core\abstracts\models\AbstractFileModel, oroboros\core\abstracts\models\AbstractJobModel, oroboros\core\abstracts\models\AbstractModel, oroboros\core\abstracts\models\AbstractServiceModel, oroboros\core\abstracts\libraries\container\AbstractCollection, oroboros\core\abstracts\models\AbstractWorkerModel, oroboros\core\abstracts\patterns\creational\AbstractPrototyper, oroboros\core\abstracts\patterns\creational\AbstractPrototypical, oroboros\core\abstracts\utilities\exception\AbstractBadFunctionCallException, oroboros\core\abstracts\utilities\exception\AbstractBadMethodCallException, oroboros\core\abstracts\utilities\exception\AbstractDomainException, oroboros\core\abstracts\utilities\exception\AbstractException, oroboros\core\abstracts\utilities\exception\AbstractInvalidArgumentException, oroboros\core\abstracts\utilities\exception\AbstractLengthException, oroboros\core\abstracts\utilities\exception\AbstractLogicException, oroboros\core\abstracts\libraries\container\AbstractContainer, oroboros\core\abstracts\utilities\exception\AbstractOutOfBoundsException, oroboros\core\abstracts\utilities\exception\AbstractOutOfRangeException, oroboros\core\abstracts\utilities\exception\AbstractOverflowException, oroboros\core\abstracts\utilities\exception\AbstractRangeException, oroboros\core\abstracts\utilities\exception\AbstractRuntimeException, oroboros\core\abstracts\utilities\exception\AbstractUnderflowException, oroboros\core\abstracts\utilities\exception\AbstractUnexpectedValueException, oroboros\core\abstracts\utilities\exception\cache\AbstractCacheException, oroboros\core\abstracts\utilities\exception\cache\AbstractInvalidArgumentException, oroboros\core\abstracts\utilities\exception\container\AbstractContainerException, oroboros\core\abstracts\libraries\file\AbstractFile, oroboros\core\abstracts\utilities\exception\container\AbstractNotFoundException, oroboros\core\abstracts\utilities\http\AbstractCookie, oroboros\core\abstracts\utilities\http\AbstractHeader, oroboros\core\abstracts\utilities\http\AbstractProtocol, oroboros\core\abstracts\utilities\http\AbstractRequestHeader, oroboros\core\abstracts\utilities\http\AbstractRequestMethod, oroboros\core\abstracts\utilities\http\AbstractResponseHeader, oroboros\core\abstracts\utilities\http\AbstractStatusCode, oroboros\core\abstracts\views\AbstractCssView, oroboros\core\abstracts\views\AbstractHtmlView, oroboros\core\abstracts\libraries\prototype\AbstractPrototyper, oroboros\core\abstracts\views\AbstractJavascriptView, oroboros\core\abstracts\views\AbstractPlaintextView, oroboros\core\abstracts\views\AbstractRssView, oroboros\core\abstracts\views\AbstractView, oroboros\core\interfaces\contract\libraries\auth\AuthContract, oroboros\core\interfaces\contract\libraries\cache\CacheItemContract, oroboros\core\interfaces\contract\libraries\cache\CachePoolContract, oroboros\core\interfaces\contract\libraries\config\ConfigContract, oroboros\core\interfaces\contract\libraries\container\CollectionContract, oroboros\core\interfaces\contract\libraries\container\ContainerContract, oroboros\core\abstracts\libraries\request\AbstractRequest, oroboros\core\interfaces\contract\libraries\enum\EnumContract, oroboros\core\interfaces\contract\libraries\file\FileContract, oroboros\core\interfaces\contract\libraries\flags\FlagContract, oroboros\core\interfaces\contract\libraries\hooks\HookContract, oroboros\core\interfaces\contract\libraries\module\ModuleContract, oroboros\core\interfaces\contract\libraries\promise\PromiseContract, oroboros\core\interfaces\contract\libraries\record\RecordContract, oroboros\core\interfaces\contract\libraries\request\RequestContract, oroboros\core\interfaces\contract\libraries\request\ServerRequestContract, oroboros\core\interfaces\contract\libraries\response\ResponseContract, oroboros\core\abstracts\libraries\request\AbstractServerRequest, oroboros\core\interfaces\contract\libraries\response\ServerResponseContract, oroboros\core\interfaces\contract\libraries\server\ServerContract, oroboros\core\interfaces\contract\libraries\shutdown\ShutdownContract, oroboros\core\interfaces\contract\libraries\site\SiteContract, oroboros\core\interfaces\contract\libraries\stream\MessageContract, oroboros\core\interfaces\contract\libraries\stream\StreamContract, oroboros\core\interfaces\contract\libraries\template\TemplateContract, oroboros\core\interfaces\contract\libraries\theme\ThemeContract, oroboros\core\interfaces\contract\libraries\uri\UriContract, oroboros\core\interfaces\contract\patterns\behavioral\BehavioralContract, oroboros\core\abstracts\libraries\response\AbstractResponse, oroboros\core\interfaces\contract\patterns\concurrency\ConcurrencyContract, oroboros\core\interfaces\contract\patterns\creational\CreationalContract, oroboros\core\interfaces\contract\patterns\creational\PrototypeContract, oroboros\core\interfaces\contract\patterns\creational\PrototypicalContract, oroboros\core\interfaces\contract\patterns\structural\StructuralContract, oroboros\core\interfaces\contract\routines\bootload\BootloadRoutineContract, oroboros\core\interfaces\contract\routines\declarative\DeclarativeRoutineContract, oroboros\core\interfaces\contract\routines\procedural\ProceduralRoutineContract, oroboros\core\interfaces\contract\routines\subsystem\SubsystemRoutineContract, oroboros\core\interfaces\contract\services\consumer\cgi\CgiServiceConsumerContract, oroboros\core\abstracts\libraries\stream\AbstractMessage, oroboros\core\interfaces\contract\services\consumer\rest\local\LocalRestServiceConsumerContract, oroboros\core\interfaces\contract\services\consumer\rest\remote\authenticated\AuthenticatedRemoteRestServiceConsumerContract, oroboros\core\interfaces\contract\services\consumer\rest\remote\RemoteRestServiceConsumerContract, oroboros\core\interfaces\contract\services\consumer\rest\remote\unauthenticated\UnauthenticatedRemoteRestServiceConsumerContract, oroboros\core\interfaces\contract\services\consumer\rest\RestServiceConsumerContract, oroboros\core\interfaces\contract\services\consumer\ServiceConsumerContract, oroboros\core\interfaces\contract\services\provider\cgi\CgiServiceProviderContract, oroboros\core\interfaces\contract\services\provider\rest\local\LocalRestServiceProviderContract, oroboros\core\interfaces\contract\services\provider\rest\remote\authenticated\AuthenticatedRemoteRestServiceProviderContract, oroboros\core\interfaces\contract\services\provider\rest\remote\RemoteRestServiceProviderContract

Namespace: oroboros\core\interfaces\contract
Package: oroboros\core\abstraction
Category: contract-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4-alpha
Since: 0.2.4-alpha
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
Located at core/interfaces/contract/BaseContract.php
Oroboros Core API documentation generated by ApiGen