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

Functions

  • is_ajax
  • is_cli
  • localize_url
  • oroboros_classfile_to_classname
  • oroboros_run_routine
  • request_headers
  • require_safely

Namespace oroboros\core

Namespaces summary

oroboros\core\abstracts
oroboros\core\interfaces
oroboros\core\libraries
oroboros\core\patterns
oroboros\core\traits
oroboros\core\utilities
oroboros\core\views

Functions summary

is_ajax

In order for the system to bootstrap the same way for both page and ajax requests, there needs to be a switch to determine which kind of request it is, so the correct controller can be loaded to handle the request. Oroboros uses the standard HTTP ajax header: X-Requested-With=XMLHttpRequest.

is_cli

It is common for scripts to crash if the wrong output headers are sent when a script runs from the command line. This function will return a simple boolean, allowing you to easily check for this.

localize_url

This will return a URL based on the current hostname, relative to the Oroboros Core base.

oroboros_classfile_to_classname

This will only work on files within the oroboros directory. Returns [false] if either of: File not found OR outside of oroboros directory.

oroboros_run_routine

Runs a valid procedural routine within the Oroboros core system. Does not return any output. If the routine is not valid, throws an Exception. If the routine runs, but produces an exception or error, it will be caught and replaced with an \OroborosRoutineException, providing the original exception as the third parameter.

request_headers
require_safely

Safely requires a file that should only be included once. If already loaded, this function will simply return false. If file does not exist, will throw an exception instead of an error, making it catcheable even if error mode is not set to exception.

Oroboros Core API documentation generated by ApiGen