Interface CoreEnvironmentApi

This enumerated api interface defines information about the oroboros core release package being utilized, so that determinations about compatibility of extensions, modules, components, and overrides can be determined, and what

features the platform offers that are currently available.

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\CoreEnvironmentApi implements oroboros\core\interfaces\enumerated\BaseEnumerated

Direct known implementers

oroboros\core\interfaces\enumerated\environment\EnvironmentApi

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/CoreEnvironmentApi.php

Constants summary

	`ROOT_DIRECTORY` Defines the root directory for Oroboros core. Defines the root directory for Oroboros core.	# `OROBOROS`
`string`	`ROOT_NAMESPACE` Defines the root directory for Oroboros core. Defines the root directory for Oroboros core.	# `'\\oroboros\\core'`
	`TEMP_DIRECTORY` Defines the temp directory for Oroboros core. This may be overridden by using the following prior to bootstrapping Oroboros core: define('OROBOROS_TEMP_DIRECTORY', '/path/to/tmp/'); Defines the temp directory for Oroboros core. This may be overridden by using the following prior to bootstrapping Oroboros core: define('OROBOROS_TEMP_DIRECTORY', '/path/to/tmp/');	# `OROBOROS_TEMP_DIRECTORY`
	`ERROR_LOG` Defines the current error log. This value can be overridden. define('OROBOROS_ERROR_LOG', '/path/to/logfile.log'); //or false Defines the current error log. This value can be overridden. define('OROBOROS_ERROR_LOG', '/path/to/logfile.log'); //or false Unless overridden, this value will check for the server error log value, and use that if it is writeable. If that is not writeable, it will be false. A false value disables logging. If you would like to log elsewhere, override the constant with the file to log into.	# `OROBOROS_ERROR_LOG`
	`TEMPLATE_DIRECTORY` Defines the templates directory. This value cannot be overridden. Defines the templates directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_TEMPLATES`
	`THEME_DIRECTORY` Defines the themes directory. This value cannot be overridden. Defines the themes directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_THEMES`
	`TEST_DIRECTORY` Defines the tests directory. This value cannot be overridden. Defines the tests directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_TESTS`
	`LOCAL_TMP_DIRECTORY` Defines the temp directory. This value cannot be overridden. Defines the temp directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_TMP`
	`VENDOR_DIRECTORY` Defines the vendor directory. This value cannot be overridden. Defines the vendor directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_VENDOR`
	`MODULE_DIRECTORY` Defines the modules directory. This value cannot be overridden. Defines the modules directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_MODULES`
	`CACHE_DIRECTORY` Defines the cache directory. This value cannot be overridden. Defines the cache directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_CACHE`
	`CONFIG_DIRECTORY` Defines the config directory. This value cannot be overridden. Defines the config directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_CONFIG`
	`DEPENDENCY_DIRECTORY` Defines the dependencies directory. This value cannot be overridden. Defines the dependencies directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_DEPENDENCIES`
	`DOCUMENTATION_DIRECTORY` Defines the docs directory. This value cannot be overridden. Defines the docs directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_DOCS`
	`SERVICE_DIRECTORY` Defines the services directory. This value cannot be overridden. Defines the services directory. This value cannot be overridden. Todo make this overrideable	# `OROBOROS_SERVICES`
	`BIN_DIRECTORY` Defines the bin directory. This value cannot be overridden. Defines the bin directory. This value cannot be overridden.	# `OROBOROS_BIN`
	`SRC_DIRECTORY` Defines the source directory. This value cannot be overridden. Defines the source directory. This value cannot be overridden.	# `OROBOROS_SRC`
	`LIB_DIRECTORY` Defines the library directory. This value cannot be overridden. Defines the library directory. This value cannot be overridden.	# `OROBOROS_LIB`
	`ROUTINE_DIRECTORY` Defines the routines directory. This value cannot be overridden. Defines the routines directory. This value cannot be overridden.	# `OROBOROS_ROUTINES`

Namespaces

Interfaces

Interface CoreEnvironmentApi

features the platform offers that are currently available.

how to accomplish this as it applies.

Direct known implementers

Constants summary

Todo

Todo

Todo

Todo

Todo

Todo

Todo

Todo

Todo

Todo

Todo