embedpress
/
vendor
/
wpdevelopers
/
embera
/
src
/
Embera
/
ProviderCollection
/
ProviderCollectionInterface.php
CustomProviderCollection.php
5 years ago
DefaultProviderCollection.php
9 months ago
ProviderCollectionAdapter.php
9 months ago
ProviderCollectionInterface.php
9 months ago
SlimProviderCollection.php
9 months ago
ProviderCollectionInterface.php
81 lines
| 1 | <?php |
| 2 | /** |
| 3 | * ProviderCollectionInterface.php |
| 4 | * |
| 5 | * @package Embera |
| 6 | * @author Michael Pratt <yo@michael-pratt.com> |
| 7 | * @link http://www.michael-pratt.com/ |
| 8 | * |
| 9 | * For the full copyright and license information, please view the LICENSE |
| 10 | * file that was distributed with this source code. |
| 11 | */ |
| 12 | |
| 13 | namespace Embera\ProviderCollection; |
| 14 | |
| 15 | /** |
| 16 | * Interface used by Providercollections |
| 17 | */ |
| 18 | interface ProviderCollectionInterface |
| 19 | { |
| 20 | /** |
| 21 | * Sets the configuration array for this object |
| 22 | * Basically an alias for the setConfig method. |
| 23 | * |
| 24 | * @param array $config Associative array with configuration options |
| 25 | * @return void |
| 26 | */ |
| 27 | // public function __construct(array $config = []); |
| 28 | |
| 29 | /** |
| 30 | * Sets the configuration array for this object |
| 31 | * |
| 32 | * @param array $config Associative array with configuration options |
| 33 | * @return void |
| 34 | */ |
| 35 | public function setConfig(array $config = []); |
| 36 | |
| 37 | /** |
| 38 | * Adds a new Provider into the provider map |
| 39 | * |
| 40 | * @param string $host The host for the map |
| 41 | * @param string|object $class The class or object that should manage the provider |
| 42 | * @return void |
| 43 | */ |
| 44 | public function addProvider($host, $class); |
| 45 | |
| 46 | /** |
| 47 | * Filters a provider from the provider list based on the provider name and returns a new |
| 48 | * collection with the given results |
| 49 | * |
| 50 | * @param string|callable $providerName The name of the provider or a callable function |
| 51 | * @return object |
| 52 | */ |
| 53 | public function filter($providerName); |
| 54 | |
| 55 | /** |
| 56 | * Returns an array with providers found. |
| 57 | * |
| 58 | * @param array|string $data An array with urls or a string with urls |
| 59 | * @return array |
| 60 | */ |
| 61 | public function findProviders($data); |
| 62 | |
| 63 | /** |
| 64 | * Sets the providerList relationship |
| 65 | * |
| 66 | * @param array $list |
| 67 | * @return void |
| 68 | */ |
| 69 | public function setProviderList(array $list); |
| 70 | |
| 71 | |
| 72 | /** |
| 73 | * Registers a provider into the default |
| 74 | * |
| 75 | * @param mixed $names |
| 76 | * @param bool $prefix |
| 77 | * @return void |
| 78 | */ |
| 79 | public function registerProvider($names, $prefix = true); |
| 80 | } |
| 81 |