Interface FlagApi

Defines the base level system flags, and the standard methods for interacting with flags.

oroboros\core\interfaces\api\FlagApi implements oroboros\OroborosInterface

Direct known implementers

oroboros\core\abstracts\libraries\flags\AbstractFlag, oroboros\core\interfaces\api\OroborosApi, oroboros\core\interfaces\BaseAbstractInterface, oroboros\core\libraries\api\FlagTypes

Indirect known implementers

Namespace: oroboros\core\interfaces\api
Author: Brian Dayhoff brian@mopsyd.me
Located at core/interfaces/api/FlagApi.php

Constants summary

`string`	`FLAG_UNIT_TEST` Designates that the runtime process is a test, and only relevant resources should be loaded. Designates that the runtime process is a test, and only relevant resources should be loaded.	# `'::unit_test::'`
`string`	`FLAG_DEBUG` Designates that additional debugging information should be shown and/or collected. Designates that additional debugging information should be shown and/or collected.	# `'::debug::'`
`string`	`FLAG_SANDBOX` Designates that destructive processes should be emulated. Designates that destructive processes should be emulated.	# `'::sandbox::'`
`string`	`FLAG_PRODUCTION` Production server, all errors and server details should be opaque to the client. Typically, this designates the following behavior: Production server, all errors and server details should be opaque to the client. Typically, this designates the following behavior: Note Errors are not displayed on screen. Alpha features are disabled. Beta features may be disabled, depending on app settings. Errors with level ALERT or EMERGENCY alert the maintainer immediately.	# `'::production::'`
`string`	`FLAG_DEVELOPMENT` Development server, additional statistics and information displayed about performance and errors is ok. Development server, additional statistics and information displayed about performance and errors is ok.	# `'::development::'`
`string`	`FLAG_RECOVERY` Designates that the application is in recovery, and only whitelisted users should have access whatsoever. Also that static resources should be used to bootstrap the application instead of the standard data sources. This flag typically gets tripped when the database is down, or some mission critical resource is not responding. This allows the whitelisted admins to log in and diagnose at least enough information to get the problem corrected with minimal downtime, instead of hunting through logs for nebulous error messages. Designates that the application is in recovery, and only whitelisted users should have access whatsoever. Also that static resources should be used to bootstrap the application instead of the standard data sources. This flag typically gets tripped when the database is down, or some mission critical resource is not responding. This allows the whitelisted admins to log in and diagnose at least enough information to get the problem corrected with minimal downtime, instead of hunting through logs for nebulous error messages.	# `'::recovery::'`
`string`	`FLAG_MAINTENANCE` Designates that the application is in maintenance mode, and only authorized users should have access. Designates that the application is in maintenance mode, and only authorized users should have access.	# `'::maintenance::'`
`string`	`FLAG_BETA` A feature in development, may be unsafe in production. A feature in development, may be unsafe in production.	# `'::beta::'`
`string`	`FLAG_ALPHA` An experimental feature, should not be used in production. An experimental feature, should not be used in production.	# `'::alpha::'`
`string`	`FLAG_MODE_AJAX` Output Mode Flag. ajax request. Check the headers for the request data type. Output Mode Flag. ajax request. Check the headers for the request data type.	# `'::mode-ajax::'`
`string`	`FLAG_MODE_CLI` Output Mode Flag. command line interface, do not use server variables or set headers, output should be plaintext. Output Mode Flag. command line interface, do not use server variables or set headers, output should be plaintext.	# `'::mode-cli::'`
`string`	`FLAG_TYPE_GET` HTTP Response Flag. GET HTTP or GET REST API request. HTTP Response Flag. GET HTTP or GET REST API request.	# `'::type-get::'`
`string`	`FLAG_TYPE_POST` HTTP Response Flag. POST HTTP or POST REST API request. HTTP Response Flag. POST HTTP or POST REST API request.	# `'::type-post::'`
`string`	`FLAG_TYPE_PUT` HTTP Response Flag. PUT REST API request. HTTP Response Flag. PUT REST API request.	# `'::type-put::'`
`string`	`FLAG_TYPE_DELETE` HTTP Response Flag. DELETE REST API request. HTTP Response Flag. DELETE REST API request.	# `'::type-delete::'`
`string`	`FLAG_TYPE_OPTIONS` HTTP Response Flag. Respond with options headers. HTTP Response Flag. Respond with options headers.	# `'::type-options::'`
`string`	`FLAG_TYPE_HEAD` HTTP Response Flag. Respond with only http headers. HTTP Response Flag. Respond with only http headers.	# `'::type-head::'`
`string`	`FLAG_READONLY` Designates that an object is read-only, and may only provide already defined data to other sources. Designates that an object is read-only, and may only provide already defined data to other sources.	# `'::read-only::'`
`string`	`FLAG_LOCK_WRITE` Designates that an object should not be writeable, but may be readable or executeable. Designates that an object should not be writeable, but may be readable or executeable.	# `'::lock-write::'`
`string`	`FLAG_LOCK_READ` Designates that an object should not be readable, but may still be writeable or executeable. Designates that an object should not be readable, but may still be writeable or executeable.	# `'::lock-read::'`
`string`	`FLAG_LOCK_EXECUTE` Designates that an object should be locked, and prevent method execution. Designates that an object should be locked, and prevent method execution.	# `'::lock-execute::'`

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Namespaces

Interfaces

Interface FlagApi

Direct known implementers

Indirect known implementers

Constants summary

Note

Constants inherited from oroboros\OroborosInterface