@@ -13,31 +13,31 @@ |
||
13 | 13 | interface NoticeConverterInterface |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @return NoticesContainerInterface |
|
18 | - */ |
|
19 | - public function getNotices(); |
|
16 | + /** |
|
17 | + * @return NoticesContainerInterface |
|
18 | + */ |
|
19 | + public function getNotices(); |
|
20 | 20 | |
21 | - /** |
|
22 | - * @param bool $throw_exceptions |
|
23 | - */ |
|
24 | - public function setThrowExceptions($throw_exceptions); |
|
21 | + /** |
|
22 | + * @param bool $throw_exceptions |
|
23 | + */ |
|
24 | + public function setThrowExceptions($throw_exceptions); |
|
25 | 25 | |
26 | - /** |
|
27 | - * @return bool |
|
28 | - */ |
|
29 | - public function getThrowExceptions(); |
|
26 | + /** |
|
27 | + * @return bool |
|
28 | + */ |
|
29 | + public function getThrowExceptions(); |
|
30 | 30 | |
31 | - /** |
|
32 | - * Converts NoticesContainerInterface objects into other format |
|
33 | - * |
|
34 | - * @param NoticesContainerInterface $notices |
|
35 | - * @return |
|
36 | - */ |
|
37 | - public function process(NoticesContainerInterface $notices); |
|
31 | + /** |
|
32 | + * Converts NoticesContainerInterface objects into other format |
|
33 | + * |
|
34 | + * @param NoticesContainerInterface $notices |
|
35 | + * @return |
|
36 | + */ |
|
37 | + public function process(NoticesContainerInterface $notices); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return void; |
|
41 | - */ |
|
42 | - public function clearNotices(); |
|
39 | + /** |
|
40 | + * @return void; |
|
41 | + */ |
|
42 | + public function clearNotices(); |
|
43 | 43 | } |
@@ -13,38 +13,38 @@ |
||
13 | 13 | interface NoticeInterface |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @return string |
|
18 | - */ |
|
19 | - public function type(); |
|
16 | + /** |
|
17 | + * @return string |
|
18 | + */ |
|
19 | + public function type(); |
|
20 | 20 | |
21 | 21 | |
22 | - /** |
|
23 | - * @return string |
|
24 | - */ |
|
25 | - public function message(); |
|
22 | + /** |
|
23 | + * @return string |
|
24 | + */ |
|
25 | + public function message(); |
|
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * @return bool |
|
30 | - */ |
|
31 | - public function isDismissible(); |
|
28 | + /** |
|
29 | + * @return bool |
|
30 | + */ |
|
31 | + public function isDismissible(); |
|
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * @return string |
|
36 | - */ |
|
37 | - public function file(); |
|
34 | + /** |
|
35 | + * @return string |
|
36 | + */ |
|
37 | + public function file(); |
|
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function func(); |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function func(); |
|
44 | 44 | |
45 | 45 | |
46 | - /** |
|
47 | - * @return string |
|
48 | - */ |
|
49 | - public function line(); |
|
46 | + /** |
|
47 | + * @return string |
|
48 | + */ |
|
49 | + public function line(); |
|
50 | 50 | } |
@@ -9,13 +9,13 @@ |
||
9 | 9 | interface LocatorInterface |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * given a string or an array of information for where to look, |
|
14 | - * will find all files in that location |
|
15 | - * |
|
16 | - * @access public |
|
17 | - * @param array|string $location |
|
18 | - * @return \FilesystemIterator |
|
19 | - */ |
|
20 | - public function locate($location); |
|
12 | + /** |
|
13 | + * given a string or an array of information for where to look, |
|
14 | + * will find all files in that location |
|
15 | + * |
|
16 | + * @access public |
|
17 | + * @param array|string $location |
|
18 | + * @return \FilesystemIterator |
|
19 | + */ |
|
20 | + public function locate($location); |
|
21 | 21 | } |
@@ -5,18 +5,18 @@ |
||
5 | 5 | interface LoaderDecoratorInterface |
6 | 6 | { |
7 | 7 | |
8 | - /** |
|
9 | - * @param string $fqcn |
|
10 | - * @param array $arguments |
|
11 | - * @param bool $shared |
|
12 | - * @return mixed |
|
13 | - */ |
|
14 | - public function load($fqcn, $arguments = array(), $shared = true); |
|
8 | + /** |
|
9 | + * @param string $fqcn |
|
10 | + * @param array $arguments |
|
11 | + * @param bool $shared |
|
12 | + * @return mixed |
|
13 | + */ |
|
14 | + public function load($fqcn, $arguments = array(), $shared = true); |
|
15 | 15 | |
16 | 16 | |
17 | 17 | |
18 | - /** |
|
19 | - * calls reset() on loader if method exists |
|
20 | - */ |
|
21 | - public function reset(); |
|
18 | + /** |
|
19 | + * calls reset() on loader if method exists |
|
20 | + */ |
|
21 | + public function reset(); |
|
22 | 22 | } |
@@ -12,24 +12,24 @@ |
||
12 | 12 | interface ContainerInterface |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * Finds an entry of the container by its identifier and returns it. |
|
17 | - * |
|
18 | - * @param string $id Identifier of the entry to look for. |
|
19 | - * @return mixed Entry. |
|
20 | - */ |
|
21 | - public function get($id); |
|
15 | + /** |
|
16 | + * Finds an entry of the container by its identifier and returns it. |
|
17 | + * |
|
18 | + * @param string $id Identifier of the entry to look for. |
|
19 | + * @return mixed Entry. |
|
20 | + */ |
|
21 | + public function get($id); |
|
22 | 22 | |
23 | 23 | |
24 | 24 | |
25 | - /** |
|
26 | - * Returns true if the container can return an entry for the given identifier. |
|
27 | - * Returns false otherwise. |
|
28 | - * `has($id)` returning true does not mean that `get($id)` will not throw an exception. |
|
29 | - * It does however mean that `get($id)` will not throw a `NotFoundException`. |
|
30 | - * |
|
31 | - * @param string $id Identifier of the entry to look for. |
|
32 | - * @return boolean |
|
33 | - */ |
|
34 | - public function has($id); |
|
25 | + /** |
|
26 | + * Returns true if the container can return an entry for the given identifier. |
|
27 | + * Returns false otherwise. |
|
28 | + * `has($id)` returning true does not mean that `get($id)` will not throw an exception. |
|
29 | + * It does however mean that `get($id)` will not throw a `NotFoundException`. |
|
30 | + * |
|
31 | + * @param string $id Identifier of the entry to look for. |
|
32 | + * @return boolean |
|
33 | + */ |
|
34 | + public function has($id); |
|
35 | 35 | } |
@@ -11,82 +11,82 @@ |
||
11 | 11 | interface RecipeInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @return string |
|
16 | - */ |
|
17 | - public function identifier(); |
|
14 | + /** |
|
15 | + * @return string |
|
16 | + */ |
|
17 | + public function identifier(); |
|
18 | 18 | |
19 | - /** |
|
20 | - * @return string |
|
21 | - */ |
|
22 | - public function fqcn(); |
|
19 | + /** |
|
20 | + * @return string |
|
21 | + */ |
|
22 | + public function fqcn(); |
|
23 | 23 | |
24 | - /** |
|
25 | - * @return array |
|
26 | - */ |
|
27 | - public function ingredients(); |
|
24 | + /** |
|
25 | + * @return array |
|
26 | + */ |
|
27 | + public function ingredients(); |
|
28 | 28 | |
29 | - /** |
|
30 | - * @return string |
|
31 | - */ |
|
32 | - public function type(); |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + */ |
|
32 | + public function type(); |
|
33 | 33 | |
34 | - /** |
|
35 | - * @return array |
|
36 | - */ |
|
37 | - public function filters(); |
|
34 | + /** |
|
35 | + * @return array |
|
36 | + */ |
|
37 | + public function filters(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return array |
|
41 | - */ |
|
42 | - public function paths(); |
|
39 | + /** |
|
40 | + * @return array |
|
41 | + */ |
|
42 | + public function paths(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @param string $identifier Identifier for the entity class that the Recipe applies to |
|
46 | - * Typically a Fully Qualified Class Name |
|
47 | - */ |
|
48 | - public function setIdentifier($identifier); |
|
44 | + /** |
|
45 | + * @param string $identifier Identifier for the entity class that the Recipe applies to |
|
46 | + * Typically a Fully Qualified Class Name |
|
47 | + */ |
|
48 | + public function setIdentifier($identifier); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Ensures incoming string is a valid Fully Qualified Class Name, |
|
52 | - * except if this is the default wildcard Recipe ( * ), |
|
53 | - * or it's NOT an actual FQCN because the Recipe is using filepaths |
|
54 | - * for classes that are not PSR-4 compatible |
|
55 | - * PLZ NOTE: |
|
56 | - * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
57 | - * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
58 | - * |
|
59 | - * @param string $fqcn |
|
60 | - */ |
|
61 | - public function setFqcn($fqcn); |
|
50 | + /** |
|
51 | + * Ensures incoming string is a valid Fully Qualified Class Name, |
|
52 | + * except if this is the default wildcard Recipe ( * ), |
|
53 | + * or it's NOT an actual FQCN because the Recipe is using filepaths |
|
54 | + * for classes that are not PSR-4 compatible |
|
55 | + * PLZ NOTE: |
|
56 | + * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
57 | + * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
58 | + * |
|
59 | + * @param string $fqcn |
|
60 | + */ |
|
61 | + public function setFqcn($fqcn); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @param array $ingredients an array of dependencies where keys are the aliases and values are the FQCNs |
|
65 | - * example: |
|
66 | - * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
67 | - */ |
|
68 | - public function setIngredients(array $ingredients); |
|
63 | + /** |
|
64 | + * @param array $ingredients an array of dependencies where keys are the aliases and values are the FQCNs |
|
65 | + * example: |
|
66 | + * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
67 | + */ |
|
68 | + public function setIngredients(array $ingredients); |
|
69 | 69 | |
70 | - /** |
|
71 | - * @param string $type one of the class constants returned from CoffeeMaker::getTypes() |
|
72 | - */ |
|
73 | - public function setType($type = CoffeeMaker::BREW_NEW); |
|
70 | + /** |
|
71 | + * @param string $type one of the class constants returned from CoffeeMaker::getTypes() |
|
72 | + */ |
|
73 | + public function setType($type = CoffeeMaker::BREW_NEW); |
|
74 | 74 | |
75 | - /** |
|
76 | - * @param array $filters an array of filters where keys are the aliases and values are the FQCNs |
|
77 | - * example: |
|
78 | - * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
79 | - */ |
|
80 | - public function setFilters(array $filters); |
|
75 | + /** |
|
76 | + * @param array $filters an array of filters where keys are the aliases and values are the FQCNs |
|
77 | + * example: |
|
78 | + * array( 'ClassInterface' => 'Fully\Qualified\ClassName' ) |
|
79 | + */ |
|
80 | + public function setFilters(array $filters); |
|
81 | 81 | |
82 | - /** |
|
83 | - * Ensures incoming paths is a valid filepath, or array of valid filepaths, |
|
84 | - * and merges them in with any existing filepaths |
|
85 | - * PLZ NOTE: |
|
86 | - * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
87 | - * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
88 | - * |
|
89 | - * @param string|array $paths |
|
90 | - */ |
|
91 | - public function setPaths($paths = array()); |
|
82 | + /** |
|
83 | + * Ensures incoming paths is a valid filepath, or array of valid filepaths, |
|
84 | + * and merges them in with any existing filepaths |
|
85 | + * PLZ NOTE: |
|
86 | + * Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not, |
|
87 | + * therefore you should always call Recipe::setPaths() before Recipe::setFqcn() |
|
88 | + * |
|
89 | + * @param string|array $paths |
|
90 | + */ |
|
91 | + public function setPaths($paths = array()); |
|
92 | 92 | } |
@@ -11,37 +11,37 @@ |
||
11 | 11 | interface InjectorInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * getReflectionClass |
|
16 | - * checks if a ReflectionClass object has already been generated for a class |
|
17 | - * and returns that instead of creating a new one |
|
18 | - * |
|
19 | - * @access public |
|
20 | - * @param string $class_name |
|
21 | - * @return \ReflectionClass |
|
22 | - */ |
|
23 | - public function getReflectionClass($class_name); |
|
14 | + /** |
|
15 | + * getReflectionClass |
|
16 | + * checks if a ReflectionClass object has already been generated for a class |
|
17 | + * and returns that instead of creating a new one |
|
18 | + * |
|
19 | + * @access public |
|
20 | + * @param string $class_name |
|
21 | + * @return \ReflectionClass |
|
22 | + */ |
|
23 | + public function getReflectionClass($class_name); |
|
24 | 24 | |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * resolveDependencies |
|
29 | - * examines the constructor for the requested class to determine |
|
30 | - * if any dependencies exist, and if they can be injected. |
|
31 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
32 | - * PLZ NOTE: this is achieved by type hinting the constructor params |
|
33 | - * For example: |
|
34 | - * if attempting to load a class "Foo" with the following constructor: |
|
35 | - * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
36 | - * then $bar_class and $grohl_class will be added to the $arguments array, |
|
37 | - * but only IF they are NOT already present in the incoming arguments array, |
|
38 | - * and the correct classes can be loaded |
|
39 | - * |
|
40 | - * @access public |
|
41 | - * @param \EventEspresso\core\services\container\RecipeInterface $recipe |
|
42 | - * @param \ReflectionClass $reflector |
|
43 | - * @param array $arguments |
|
44 | - * @return array |
|
45 | - */ |
|
46 | - public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array()); |
|
27 | + /** |
|
28 | + * resolveDependencies |
|
29 | + * examines the constructor for the requested class to determine |
|
30 | + * if any dependencies exist, and if they can be injected. |
|
31 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
32 | + * PLZ NOTE: this is achieved by type hinting the constructor params |
|
33 | + * For example: |
|
34 | + * if attempting to load a class "Foo" with the following constructor: |
|
35 | + * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
36 | + * then $bar_class and $grohl_class will be added to the $arguments array, |
|
37 | + * but only IF they are NOT already present in the incoming arguments array, |
|
38 | + * and the correct classes can be loaded |
|
39 | + * |
|
40 | + * @access public |
|
41 | + * @param \EventEspresso\core\services\container\RecipeInterface $recipe |
|
42 | + * @param \ReflectionClass $reflector |
|
43 | + * @param array $arguments |
|
44 | + * @return array |
|
45 | + */ |
|
46 | + public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array()); |
|
47 | 47 | } |
@@ -12,68 +12,68 @@ |
||
12 | 12 | |
13 | 13 | |
14 | 14 | |
15 | - /** |
|
16 | - * returns an instance of the requested entity type using the supplied arguments. |
|
17 | - * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
18 | - * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
19 | - * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
20 | - * then a new entity will be instantiated from the closure and returned. |
|
21 | - * If a closure does not exist, then one will be built and added to the reservoir |
|
22 | - * before instantiating the requested entity. |
|
23 | - * |
|
24 | - * @param string $identifier Identifier for the entity class to be constructed. |
|
25 | - * Typically a Fully Qualified Class Name |
|
26 | - * @param array $arguments an array of arguments to be passed to the entity constructor |
|
27 | - * @param string $type |
|
28 | - * @return mixed |
|
29 | - */ |
|
30 | - public function brew($identifier, $arguments = array(), $type = ''); |
|
31 | - |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * @param string $identifier |
|
36 | - * @param callable $closure |
|
37 | - */ |
|
38 | - public function addClosure($identifier, $closure); |
|
39 | - |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * @param string $identifier |
|
44 | - * @param mixed $service |
|
45 | - * @return boolean |
|
46 | - */ |
|
47 | - public function addService($identifier, $service); |
|
48 | - |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * Adds instructions on how to brew objects |
|
53 | - * |
|
54 | - * @param RecipeInterface $recipe |
|
55 | - * @return mixed |
|
56 | - */ |
|
57 | - public function addRecipe(RecipeInterface $recipe); |
|
58 | - |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * Get instructions on how to brew objects |
|
63 | - * |
|
64 | - * @param string $identifier |
|
65 | - * @return Recipe |
|
66 | - */ |
|
67 | - public function getRecipe($identifier); |
|
68 | - |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * adds class name aliases to list of filters |
|
73 | - * |
|
74 | - * @param string $identifier |
|
75 | - * @param array $aliases |
|
76 | - * @return string |
|
77 | - */ |
|
78 | - public function addAliases($identifier, $aliases); |
|
15 | + /** |
|
16 | + * returns an instance of the requested entity type using the supplied arguments. |
|
17 | + * If a shared service is requested and an instance is already in the carafe, then it will be returned. |
|
18 | + * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned |
|
19 | + * If the request is for a new entity and a closure exists in the reservoir for creating it, |
|
20 | + * then a new entity will be instantiated from the closure and returned. |
|
21 | + * If a closure does not exist, then one will be built and added to the reservoir |
|
22 | + * before instantiating the requested entity. |
|
23 | + * |
|
24 | + * @param string $identifier Identifier for the entity class to be constructed. |
|
25 | + * Typically a Fully Qualified Class Name |
|
26 | + * @param array $arguments an array of arguments to be passed to the entity constructor |
|
27 | + * @param string $type |
|
28 | + * @return mixed |
|
29 | + */ |
|
30 | + public function brew($identifier, $arguments = array(), $type = ''); |
|
31 | + |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * @param string $identifier |
|
36 | + * @param callable $closure |
|
37 | + */ |
|
38 | + public function addClosure($identifier, $closure); |
|
39 | + |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * @param string $identifier |
|
44 | + * @param mixed $service |
|
45 | + * @return boolean |
|
46 | + */ |
|
47 | + public function addService($identifier, $service); |
|
48 | + |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * Adds instructions on how to brew objects |
|
53 | + * |
|
54 | + * @param RecipeInterface $recipe |
|
55 | + * @return mixed |
|
56 | + */ |
|
57 | + public function addRecipe(RecipeInterface $recipe); |
|
58 | + |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * Get instructions on how to brew objects |
|
63 | + * |
|
64 | + * @param string $identifier |
|
65 | + * @return Recipe |
|
66 | + */ |
|
67 | + public function getRecipe($identifier); |
|
68 | + |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * adds class name aliases to list of filters |
|
73 | + * |
|
74 | + * @param string $identifier |
|
75 | + * @param array $aliases |
|
76 | + * @return string |
|
77 | + */ |
|
78 | + public function addAliases($identifier, $aliases); |
|
79 | 79 | } |
@@ -11,31 +11,31 @@ |
||
11 | 11 | interface CoffeeMakerInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @return array |
|
16 | - */ |
|
17 | - public static function getTypes(); |
|
14 | + /** |
|
15 | + * @return array |
|
16 | + */ |
|
17 | + public static function getTypes(); |
|
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * @param $type |
|
23 | - */ |
|
24 | - public static function validateType($type); |
|
21 | + /** |
|
22 | + * @param $type |
|
23 | + */ |
|
24 | + public static function validateType($type); |
|
25 | 25 | |
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * @param RecipeInterface $recipe |
|
30 | - * @param array $arguments |
|
31 | - * @return mixed |
|
32 | - */ |
|
33 | - public function brew(RecipeInterface $recipe, $arguments = array()); |
|
28 | + /** |
|
29 | + * @param RecipeInterface $recipe |
|
30 | + * @param array $arguments |
|
31 | + * @return mixed |
|
32 | + */ |
|
33 | + public function brew(RecipeInterface $recipe, $arguments = array()); |
|
34 | 34 | |
35 | 35 | |
36 | 36 | |
37 | - /** |
|
38 | - * @return string |
|
39 | - */ |
|
40 | - public function type(); |
|
37 | + /** |
|
38 | + * @return string |
|
39 | + */ |
|
40 | + public function type(); |
|
41 | 41 | } |