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 <?php
/*
* The MIT License
*
* Copyright 2016 Brian Dayhoff <brian@mopsyd.me>.
*
* 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\abstracts\adapters;
/**
* <Oroboros Abstract Adapter>
* Within the Oroboros class structure, an adapter is a class
* that wraps a 3rd party library, external asset,
* or any non-PHP construct that needs to be interacted with.
* Adapters are registered into the system as satisfying
* requirements for a specific exteral asset or package,
* and will be passed directly by the adapter factory by keyword.
*
* Adapters inherently rely on the ControlApi trait to generate
* their Api dynamically. This trait allows the class to control
* specific prefixed protected methods publicly, and keep an
* indexed registration of them by prefix keyword. This allows you to easily scrape any connected class's public methods and create a passthru for them that is externally documented using their doc-block comments similar to how apigen produces code coverage documentation.
* @satisfies CLASS_TYPE = '::adapter::'
* @author Brian Dayhoff <brian@mopsyd.me>
*/
abstract class AbstractAdapter
extends \oroboros\core\abstracts\OroborosBaseAbstract
{
use \oroboros\core\traits\views\ViewTrait;
const CLASS_TYPE = \oroboros\core\interfaces\api\ClassTypeApi::CLASS_TYPE_ADAPTER;
const CLASS_SCOPE = \oroboros\core\interfaces\api\ClassScopeApi::CLASS_SCOPE_ADAPTER_ABSTRACT;
const API = '\\oroboros\\core\\interfaces\\api\\adapters\\AdapterApi';
}