1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 <?php
/*
* The MIT License
*
* @author Brian Dayhoff <mopsyd@me.com>
* @copyright (c) 2017, Brian Dayhoff <mopsyd@me.com> all rights reserved.
* @license http://opensource.org/licenses/MIT The MIT License (MIT)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
namespace oroboros\core\interfaces\enumerated\environment;
/**
* <Project Environment Enumerated Api Interface>
*
* This enumerated api interface determines information about
* the currently running project. This information includes
* where it's configuration file is located, what external
* dependencies are provided, and a number of other application
* specific details.
* --------
* 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.
* --------
* @author Brian Dayhoff <mopsyd@me.com>
* @license http://opensource.org/licenses/MIT The MIT License (MIT)
* @link bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/enumerated_api_interface.md
* @category enumerated-interfaces
* @package oroboros/core
* @subpackage environment
* @version 0.2.4-alpha
* @since 0.2.4-alpha
*/
interface ProjectEnvironmentApi
extends \oroboros\core\interfaces\enumerated\BaseEnumerated
{
}