Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
25.93% |
7 / 27 |
|
50.00% |
2 / 4 |
CRAP | |
0.00% |
0 / 1 |
| tao_models_classes_Service | |
25.93% |
7 / 27 |
|
50.00% |
2 / 4 |
60.18 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| getServiceByName | |
0.00% |
0 / 19 |
|
0.00% |
0 / 1 |
56 | |||
| singleton | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
2 | |||
| getServiceLocator | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg |
| 19 | * (under the project TAO & TAO2); |
| 20 | * 2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung |
| 21 | * (under the project TAO-TRANSFER); |
| 22 | * 2009-2012 (update and modification) Public Research Centre Henri Tudor |
| 23 | * (under the project TAO-SUSTAIN & TAO-DEV); |
| 24 | * |
| 25 | */ |
| 26 | |
| 27 | use oat\oatbox\service\ServiceManager; |
| 28 | |
| 29 | /** |
| 30 | * Service is the base class of all services, and implements the singleton |
| 31 | * for derived services |
| 32 | * |
| 33 | * @abstract |
| 34 | * @access public |
| 35 | * @author Joel Bout, <joel.bout@tudor.lu> |
| 36 | * @package tao |
| 37 | |
| 38 | */ |
| 39 | abstract class tao_models_classes_Service |
| 40 | { |
| 41 | // --- ASSOCIATIONS --- |
| 42 | // --- ATTRIBUTES --- |
| 43 | |
| 44 | /** |
| 45 | * Contains the references of each service instance. |
| 46 | * The service name is used as key. |
| 47 | * |
| 48 | * @access private |
| 49 | * @var array |
| 50 | */ |
| 51 | private static $instances = []; |
| 52 | |
| 53 | /** |
| 54 | * pattern to create service dynamically. |
| 55 | * Use the printf syntax, where %1$ is the short name of the service |
| 56 | * |
| 57 | * @access private |
| 58 | * @var string |
| 59 | * |
| 60 | * phpcs:disable Generic.NamingConventions.UpperCaseConstantName |
| 61 | */ |
| 62 | public const namePattern = 'tao%1$s_models_classes_%1$sService'; |
| 63 | // phpcs:enable Generic.NamingConventions.UpperCaseConstantName |
| 64 | |
| 65 | // --- OPERATIONS --- |
| 66 | |
| 67 | /** |
| 68 | * protected constructor to enforce the singleton pattern |
| 69 | * |
| 70 | * @access protected |
| 71 | * @author Joel Bout, <joel.bout@tudor.lu> |
| 72 | * @return mixed |
| 73 | */ |
| 74 | protected function __construct() |
| 75 | { |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * returns an instance of the service defined by servicename. Always returns |
| 80 | * same instance for a class |
| 81 | * |
| 82 | * @access public |
| 83 | * @author Joel Bout, <joel.bout@tudor.lu> |
| 84 | * @deprecated |
| 85 | * |
| 86 | * @param string $serviceName |
| 87 | * |
| 88 | * @return tao_models_classes_Service |
| 89 | * @throws common_exception_Error |
| 90 | */ |
| 91 | public static function getServiceByName($serviceName) |
| 92 | { |
| 93 | $returnValue = null; |
| 94 | |
| 95 | |
| 96 | $className = (!class_exists($serviceName) || !preg_match("/^(tao|wf)/", $serviceName)) |
| 97 | ? sprintf(self::namePattern, ucfirst(strtolower($serviceName))) |
| 98 | : $serviceName; |
| 99 | |
| 100 | // does the class exist |
| 101 | if (!class_exists($className)) { |
| 102 | throw new common_exception_Error('Tried to init abstract class ' . $className); |
| 103 | } |
| 104 | |
| 105 | $class = new ReflectionClass($className); |
| 106 | // is it concrete |
| 107 | if ($class->isAbstract()) { |
| 108 | throw new common_exception_Error( |
| 109 | 'Tried to init abstract class ' . $className . ' for param \'' . $serviceName . '\'' |
| 110 | ); |
| 111 | } |
| 112 | // does it extend Service |
| 113 | if (!$class->isSubclassOf('tao_models_classes_Service')) { |
| 114 | throw new common_exception_Error( |
| 115 | "$className must referr to a class extending the tao_models_classes_Service" |
| 116 | ); |
| 117 | } |
| 118 | |
| 119 | //create the instance only once |
| 120 | if (!isset(self::$instances[$className])) { |
| 121 | self::$instances[$className] = new $className(); |
| 122 | } |
| 123 | |
| 124 | //get the instance |
| 125 | $returnValue = self::$instances[$className]; |
| 126 | |
| 127 | |
| 128 | return $returnValue; |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * returns an instance of the service the function was called from. Always |
| 133 | * the same instance for a class |
| 134 | * |
| 135 | * @access public |
| 136 | * @author Joel Bout, <joel.bout@tudor.lu> |
| 137 | * @return $this |
| 138 | */ |
| 139 | public static function singleton() |
| 140 | { |
| 141 | $returnValue = null; |
| 142 | |
| 143 | |
| 144 | $serviceName = get_called_class(); |
| 145 | if (!isset(self::$instances[$serviceName])) { |
| 146 | self::$instances[$serviceName] = new $serviceName(); |
| 147 | } |
| 148 | |
| 149 | $returnValue = self::$instances[$serviceName]; |
| 150 | |
| 151 | |
| 152 | return $returnValue; |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Placeholder until the servicemanage is passed properly |
| 157 | * |
| 158 | * @return \oat\oatbox\service\ServiceManager |
| 159 | */ |
| 160 | public function getServiceLocator() |
| 161 | { |
| 162 | return ServiceManager::getServiceManager(); |
| 163 | } |
| 164 | } |