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

  • LibraryContract

Interface LibraryContract

This interface enforces the methods required for a valid library object. These methods may be manually honored, or may be satisfied by using the corresponding library trait. Traits that extend upon this functionality

should be expected to implement this for you.

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.

oroboros\core\interfaces\contract\libraries\LibraryContract implements oroboros\core\interfaces\contract\BaseContract

Direct known implementers

oroboros\core\interfaces\contract\libraries\auth\AuthContract, oroboros\core\interfaces\contract\libraries\cache\CacheItemContract, oroboros\core\interfaces\contract\libraries\promise\PromiseContract, oroboros\core\interfaces\contract\libraries\record\RecordContract, 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\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\libraries\manager\ManagerContract, oroboros\core\interfaces\contract\libraries\cache\CachePoolContract, oroboros\core\interfaces\libraries\worker\WorkerContract, oroboros\core\interfaces\contract\libraries\config\ConfigContract, oroboros\core\interfaces\contract\libraries\container\ContainerContract, 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

Indirect known implementers

oroboros\core\abstracts\libraries\container\AbstractCollection, oroboros\core\abstracts\libraries\container\AbstractContainer, oroboros\core\interfaces\contract\libraries\request\RequestContract, oroboros\core\interfaces\contract\libraries\request\ServerRequestContract, oroboros\core\interfaces\contract\libraries\response\ResponseContract, oroboros\core\interfaces\contract\libraries\response\ServerResponseContract, oroboros\core\interfaces\contract\libraries\stream\MessageContract, 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\abstracts\libraries\file\AbstractFile, oroboros\core\libraries\stream\Message, oroboros\core\libraries\stream\Stream, oroboros\core\libraries\uri\Uri, oroboros\core\abstracts\libraries\request\AbstractRequest, oroboros\core\abstracts\libraries\request\AbstractServerRequest, oroboros\core\abstracts\libraries\response\AbstractResponse, oroboros\core\abstracts\libraries\stream\AbstractMessage, oroboros\core\abstracts\libraries\stream\AbstractStream, oroboros\core\abstracts\libraries\uri\AbstractUri, oroboros\core\interfaces\contract\libraries\container\CollectionContract

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