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 EnvironmentApi

This is the master interface for environmental runtime constants. The interfaces extended by this interface represent the collective parameters of runtime that the system expects to apply. For interoperability between http and cgi, bootload will provide all parameters in a nulled state even if they do not apply to the current runtime environment, to maximize compatibility of application logic with both environments.

Individual EnvironmentApi's narrow this to a specific scope, so that extending classes do not need to pull the full set if it is not required. This interface is provided as an index of all environment parameters and their source definitions, so individual source EnvironmentApi's can be referenced accordingly. This approach provides for easy scalability and scope consideration, where sets can be paired down into multiple files and granularly catalogued as needed

throughout ongoing development.

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\EnvironmentApi implements oroboros\core\interfaces\enumerated\BaseEnumerated, oroboros\core\interfaces\enumerated\environment\CgiEnvironmentApi, oroboros\core\interfaces\enumerated\environment\HttpEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ServerEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ClientEnvironmentApi, oroboros\core\interfaces\enumerated\environment\CoreEnvironmentApi, oroboros\core\interfaces\enumerated\environment\BuildEnvironmentApi, oroboros\core\interfaces\enumerated\environment\ProjectEnvironmentApi
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/EnvironmentApi.php

Constants summary

Constants inherited from oroboros\core\interfaces\enumerated\environment\CgiEnvironmentApi

IS_CLI, SHELL_ENABLED, SHELL_USER

Constants inherited from oroboros\core\interfaces\enumerated\environment\HttpEnvironmentApi

IS_AJAX, IS_HTTP, IS_SSL, REQUEST_METHOD, REQUEST_URI, REQUEST_URL

Constants inherited from oroboros\core\interfaces\enumerated\environment\ServerEnvironmentApi

SERVER

Constants inherited from oroboros\core\interfaces\enumerated\environment\CoreEnvironmentApi

BIN_DIRECTORY, CACHE_DIRECTORY, CONFIG_DIRECTORY, DEPENDENCY_DIRECTORY, DOCUMENTATION_DIRECTORY, ERROR_LOG, LIB_DIRECTORY, LOCAL_TMP_DIRECTORY, MODULE_DIRECTORY, ROOT_DIRECTORY, ROOT_NAMESPACE, ROUTINE_DIRECTORY, SERVICE_DIRECTORY, SRC_DIRECTORY, TEMPLATE_DIRECTORY, TEMP_DIRECTORY, TEST_DIRECTORY, THEME_DIRECTORY, VENDOR_DIRECTORY

Oroboros Core API documentation generated by ApiGen