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

  • AbstractDataObject
  • AbstractDataObjectCollection

Class AbstractDataObject

Abstract Data Object Provides the baseline set of methods for interacting with data objects.

oroboros\core\abstracts\OroborosBaseAbstract implements oroboros\core\interfaces\BaseAbstractInterface uses oroboros\core\traits\BaseTrait
Extended by oroboros\core\abstracts\libraries\data\AbstractDataObject implements oroboros\core\interfaces\api\DataObjectApi

Direct known subclasses

oroboros\core\abstracts\libraries\hooks\AbstractHook

Indirect known subclasses

oroboros\core\libraries\hooks\SimpleHook

Abstract
Namespace: oroboros\core\abstracts\libraries\data
Author: Brian Dayhoff brian@mopsyd.me
Located at core/abstracts/libraries/data/AbstractDataObject.php

Methods summary

public
# __construct( array $params = array(), array $flags = array() )

All non-utility classes in the oroboros system use this constructor. Utility classes are considered to be any class that extends from a non-core class.

All non-utility classes in the oroboros system use this constructor. Utility classes are considered to be any class that extends from a non-core class.

Parameters

$params
$flags

Since

0.0.2a

Overrides

oroboros\core\traits\BaseTrait::__construct
public
# __toString( )
public
# initialize( array $params = array(), array $flags = array() )

Provides an unopinionated way to initialize parameters and flags. This class does nothing with the parameters or flags aside from storing them so they can be referenced and checked against. Child classes should implement their own functionality around this, but it can be safely ignored entirely.

Provides an unopinionated way to initialize parameters and flags. This class does nothing with the parameters or flags aside from storing them so they can be referenced and checked against. Child classes should implement their own functionality around this, but it can be safely ignored entirely.

Parameters

$params
$flags

Since

0.0.1a

Note

Parameter and flag initialization can also happen directly in the constructor if they need to be exposed before your class initialization method runs, or may be exposed at both if you need to separate pre-initialization parameters from initialization parameters.
public mixed
# get( string $id )

Default standard getter. Throws an oroboros exception if resource not found instead of an error. Otherwise behaves the same as the native php getter.

Default standard getter. Throws an oroboros exception if resource not found instead of an error. Otherwise behaves the same as the native php getter.

Parameters

$id
$key

Returns

mixed

Throws

oroboros\core\utilities\exception\Exception

Since

0.0.1a
public boolean
# set( type $id, mixed $value )

Default standard setter. Performs the same as the native php getter, except that it honors locks if they are defined.

Default standard setter. Performs the same as the native php getter, except that it honors locks if they are defined.

Parameters

$id
$key
$value

Returns

boolean

Since

0.0.1a
private
# _init( array $params = array(), array $flags = array() )
public
# package( array $data = array(), $format = 'object' )
protected
# _updateFlagConditions( )

Overrule this method with how your flags passed into the constructor or initialization method should be handled. It will be called whenever those parameters are updated.

Overrule this method with how your flags passed into the constructor or initialization method should be handled. It will be called whenever those parameters are updated.

Since

0.0.1a

Methods inherited from oroboros\core\interfaces\BaseAbstractInterface

fingerprint()

Methods used from oroboros\core\traits\BaseTrait

__destruct()

Constants summary

Constants inherited from oroboros\core\abstracts\OroborosBaseAbstract

API, CLASS_SCOPE

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Constants inherited from oroboros\core\interfaces\api\ExceptionCodeApi

ERROR_ADAPTER, ERROR_CLUSTER, ERROR_CONTROLLER, ERROR_CORE, ERROR_CORE_ADAPTER_FAILURE, ERROR_CORE_AUTH_FAILURE, ERROR_CORE_BOOTSTRAP_FAILURE, ERROR_CORE_CONTROLLER_FAILURE, ERROR_CORE_DATA_OBJECT_FAILURE, ERROR_CORE_ENTITY_FAILURE, ERROR_CORE_ENUM_FAILURE, ERROR_CORE_ERROR_FAILURE, ERROR_CORE_EVENT_FAILURE, ERROR_CORE_EXTENSION_FAILURE, ERROR_CORE_FLAG_FAILURE, ERROR_CORE_FUNCTION_FAILURE, ERROR_CORE_JOB_FAILURE, ERROR_CORE_LIBRARY_FAILURE, ERROR_CORE_MODEL_FAILURE, ERROR_CORE_MODULE_FAILURE, ERROR_CORE_PARSER_FAILURE, ERROR_CORE_PATTERN_FAILURE, ERROR_CORE_RECORD_FAILURE, ERROR_CORE_REQUEST_FAILURE, ERROR_CORE_RESPONSE_FAILURE, ERROR_CORE_ROUTER_FAILURE, ERROR_CORE_ROUTINE_FAILURE, ERROR_CORE_SERVICE_FAILURE, ERROR_CORE_STREAM_FAILURE, ERROR_CORE_UTILITY_FAILURE, ERROR_CORE_VIEW_FAILURE, ERROR_DATABASE, ERROR_FILESYSTEM, ERROR_INITIALIZATION, ERROR_INSTALLATION, ERROR_LIBRARY, ERROR_LOGIC, ERROR_LOGIC_BAD_PARAMETERS, ERROR_LOGIC_MISSING_PARAMETERS, ERROR_MODEL, ERROR_MODULE, ERROR_NETWORK, ERROR_NODE, ERROR_PHP, ERROR_PHP_BAD_FUNCTION_CALL, ERROR_PHP_BAD_METHOD_CALL, ERROR_PHP_BAD_PARAMETERS, ERROR_PHP_CALLSTATIC_FAILURE, ERROR_PHP_CALL_FAILURE, ERROR_PHP_CLONE_FAILURE, ERROR_PHP_DEBUG_INFO_FAILURE, ERROR_PHP_DESTRUCTOR_FAILURE, ERROR_PHP_GETTER_FAILURE, ERROR_PHP_INSTANTIATION_FAILURE, ERROR_PHP_INVOCATION_FAILURE, ERROR_PHP_IS_SET_FAILURE, ERROR_PHP_KEY_NOT_FOUND, ERROR_PHP_METHOD_FAILURE, ERROR_PHP_NOT_INITIALIZED, ERROR_PHP_SERIALIZATION_FAILURE, ERROR_PHP_SETTER_FAILURE, ERROR_PHP_SLEEP_FAILURE, ERROR_PHP_TO_ARRAY_FAILURE, ERROR_PHP_UNSERIALIZATION_FAILURE, ERROR_PHP_UN_SET_FAILURE, ERROR_PHP_WAKEUP_FAILURE, ERROR_PHP_WRONG_INSTANCE_SUPPLIED, ERROR_PHP_WRONG_SCHEMA_PROVIDED, ERROR_ROUTINE, ERROR_ROUTING, ERROR_SDK, ERROR_SECURITY, ERROR_SECURITY_LOCKED_COLUMN, ERROR_SECURITY_LOCKED_COMMAND, ERROR_SECURITY_LOCKED_ENTITY, ERROR_SECURITY_LOCKED_EVENT, ERROR_SECURITY_LOCKED_FILE, ERROR_SECURITY_LOCKED_JOB, ERROR_SECURITY_LOCKED_OBJECT, ERROR_SECURITY_LOCKED_POLICY, ERROR_SECURITY_LOCKED_RESOURCE, ERROR_SECURITY_LOCKED_ROUTE, ERROR_SECURITY_LOCKED_TABLE, ERROR_SESSION, ERROR_UNKNOWN, ERROR_VIEW, SAFE_MINIMUM_ERROR_RANGE

Constants inherited from oroboros\core\interfaces\api\FlagApi

FLAG_ALPHA, FLAG_BETA, FLAG_DEBUG, FLAG_DEVELOPMENT, FLAG_LOCK_EXECUTE, FLAG_LOCK_READ, FLAG_LOCK_WRITE, FLAG_MAINTENANCE, FLAG_MODE_AJAX, FLAG_MODE_CLI, FLAG_PRODUCTION, FLAG_READONLY, FLAG_RECOVERY, FLAG_SANDBOX, FLAG_TYPE_DELETE, FLAG_TYPE_GET, FLAG_TYPE_HEAD, FLAG_TYPE_OPTIONS, FLAG_TYPE_POST, FLAG_TYPE_PUT, FLAG_UNIT_TEST

Constants inherited from oroboros\core\interfaces\api\LogLevelApi

ALERT, CRITICAL, DEBUG, EMERGENCY, ERROR, INFO, NOTICE, WARNING

Constants inherited from oroboros\core\interfaces\api\DataObjectApi

CLASS_TYPE

Properties summary

private $_data
#
private $_format
#
private array $_valid_formats
# array( 'object', 'array', 'serialized', 'json' )
private array $_access_rights
# array()

Properties used from oroboros\core\traits\BaseTrait

$_constructed

Oroboros Core API documentation generated by ApiGen