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

Classes

  • AbstractWorker

Class AbstractWorker

Abstract Worker

oroboros\core\abstracts\patterns\behavioral\AbstractWorker
Extended by oroboros\core\abstracts\libraries\worker\AbstractWorker implements oroboros\core\interfaces\api\WorkerApi

Direct known subclasses

oroboros\core\abstracts\libraries\database\AbstractDatabaseWorker, oroboros\core\abstracts\libraries\validation\AbstractValidationWorker

Indirect known subclasses

oroboros\core\abstracts\libraries\validation\workers\AbstractFormValidationWorker

Abstract
Namespace: oroboros\core\abstracts\libraries\worker
Author: Brian Dayhoff mopsyd@me.com
Located at core/abstracts/libraries/worker/AbstractWorker.php

Methods summary

public
# __construct( array $params = array(), array $flags = array() )
public
# initialize( array $params = array(), array $flags = array() )
public boolean
# validate( mixed $data, array $schema = array() )

Null validation step Silences validation. Overrule in a child class for conditional validation.

Null validation step Silences validation. Overrule in a child class for conditional validation.

Parameters

$data
$schema

Returns

boolean
(always true)
public
# execute( )

Nulled worker execution Overrule in a child class to add worker execution tasks as needed.

Nulled worker execution Overrule in a child class to add worker execution tasks as needed.

protected
# _updateParameterConditions( $parameter_key )
protected
# _setSchema( stdClass $schema )

Default schema setter

Default schema setter

Parameters

$schema
protected
# _setConditions( $conditions )
protected mixed
# _schema( string $part = NULL )

Default schema getter returns either the entire schema (if $part=null), the specified schema index, or false if specified and not found.

Default schema getter returns either the entire schema (if $part=null), the specified schema index, or false if specified and not found.

Parameters

$part

Returns

mixed
final protected
# _checkInitialization( )
protected
# _state( $state = NULL )
protected
# _registerStates( array|object $states )

Registers a list of valid states.

Registers a list of valid states.

Parameters

$states
Must be an array or iterable object
protected
# _clearStates( )

Removes all current valid states. Existing state will remain frozen while no valid states are present, but will not otherwise change.

Removes all current valid states. Existing state will remain frozen while no valid states are present, but will not otherwise change.

protected
# _onStateChange( )

Null state change. Overrule this method in a child class to activate state pattern awareness as needed.

Null state change. Overrule this method in a child class to activate state pattern awareness as needed.

Constants summary

string CLASS_SCOPE
# \oroboros\core\interfaces\api\ClassScopeApi::CLASS_SCOPE_WORKER_LIBRARY
string API
# '\\oroboros\\core\\interfaces\\api\\WorkerApi'

Properties summary

private $_schema
# null
private $_state
#
private array $_valid_states
# array()
Oroboros Core API documentation generated by ApiGen