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

  • BaseEnumerated

Interface BaseEnumerated

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

As Enumerated Api Interfaces only provide distinct key value stores, they should be used with the following considerations:

These interfaces DO NOT enforce methods. These interfaces DO declare numerous constants. There is a low probability of constant collision with external codebases. If this causes an issue, wrap the object that implements the api in one that doesn't, and use a pass-through to obtain it's values.

There is a trait that can accomplish this strict enumeration based off of any interface attached to a class that uses it, which can also filter results by prefix or suffix of the constant name. It's super handy for indexing these in any class that uses them.

Direct known implementers

oroboros\core\interfaces\enumerated\environment\BaseEnvironmentApi, oroboros\core\interfaces\enumerated\environment\BuildEnvironmentApi, oroboros\core\interfaces\enumerated\flags\OutputFlagApi, oroboros\core\interfaces\enumerated\http\RequestHeaders, oroboros\core\interfaces\enumerated\http\ResponseHeaders, oroboros\core\interfaces\enumerated\http\StatusCodes, oroboros\core\interfaces\enumerated\views\ViewOutputApi, oroboros\core\interfaces\enumerated\environment\CgiEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ClientEnvironmentApi, oroboros\core\interfaces\enumerated\environment\CoreEnvironmentApi, oroboros\core\interfaces\enumerated\environment\EnvironmentApi, oroboros\core\interfaces\enumerated\environment\HttpEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ProjectEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ServerEnvironmentApi, oroboros\core\interfaces\enumerated\flags\FlagApi

Indirect known implementers

oroboros\core\libraries\enum\http\RequestHeaders, oroboros\core\libraries\enum\http\ResponseHeaders, oroboros\core\libraries\enum\http\StatusCodes

Namespace: oroboros\core\interfaces\enumerated
Package: oroboros\core\abstraction
Category: enumerated-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4-alpha
Since: 0.2.4-alpha
See:

\oroboros\core\traits\libraries\enum\EnumTrait

There are also sets of provided defaults under the concrete namespace


See: \oroboros\core\libraries\enum
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/enumerated_api_interface.md
Located at core/interfaces/enumerated/BaseEnumerated.php
Oroboros Core API documentation generated by ApiGen