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

  • BaseEnvironmentApi
  • BuildEnvironmentApi
  • CgiEnvironmentApi
  • ClientEnvironmentApi
  • CoreEnvironmentApi
  • EnvironmentApi
  • HttpEnvironmentApi
  • ProjectEnvironmentApi
  • ServerEnvironmentApi

Interface BuildEnvironmentApi

This enumerated api interface defines the state of the build, and whether or not it has been executed, whether it is configured for production, staging, or development, whether debug is enabled, whether it needs to be executed, whether supported features like composer and apigen are present, etc. This is used throughout the programming logic to determine what functionality is available and

allowed.

Enumerated Api Interfaces Enumerated Api Interfaces provide sets of fixed, enumerated values that must maintain consistency, and should not be overridden at compile time.

In some cases, these values are considered absolute, and the program will always reference them as defined. In other cases, they provide baseline definitions, which the individual api implementing them may allow for extension upon. In these cases, the fixed values MAY NOT be removed or altered, but additions and aliases will be allowed for. Check the api of the individual contract being considered for extension for information

how to accomplish this as it applies.

oroboros\core\interfaces\enumerated\environment\BuildEnvironmentApi implements oroboros\core\interfaces\enumerated\BaseEnumerated

Direct known implementers

oroboros\core\interfaces\enumerated\environment\EnvironmentApi

Namespace: oroboros\core\interfaces\enumerated\environment
Package: oroboros\core\environment
Category: enumerated-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/enumerated_api_interface.md
Located at core/interfaces/enumerated/environment/BuildEnvironmentApi.php
Oroboros Core API documentation generated by ApiGen