@@ -32,145 +32,145 @@ discard block |
||
| 32 | 32 | |
| 33 | 33 | class Container |
| 34 | 34 | { |
| 35 | - use Traits\AppTrait; |
|
| 36 | - use Traits\PsrTrait; |
|
| 37 | - use Traits\RequestTrait; |
|
| 38 | - use Traits\ResponseTrait; |
|
| 39 | - use Traits\PluginTrait; |
|
| 40 | - use Traits\CallableTrait; |
|
| 41 | - use Traits\ViewTrait; |
|
| 42 | - use Traits\UtilTrait; |
|
| 43 | - use Traits\MetadataTrait; |
|
| 44 | - use Traits\DiAutoTrait; |
|
| 35 | +use Traits\AppTrait; |
|
| 36 | +use Traits\PsrTrait; |
|
| 37 | +use Traits\RequestTrait; |
|
| 38 | +use Traits\ResponseTrait; |
|
| 39 | +use Traits\PluginTrait; |
|
| 40 | +use Traits\CallableTrait; |
|
| 41 | +use Traits\ViewTrait; |
|
| 42 | +use Traits\UtilTrait; |
|
| 43 | +use Traits\MetadataTrait; |
|
| 44 | +use Traits\DiAutoTrait; |
|
| 45 | 45 | |
| 46 | - /** |
|
| 46 | +/** |
|
| 47 | 47 | * The library Dependency Injection Container |
| 48 | 48 | * |
| 49 | 49 | * @var PimpleContainer |
| 50 | 50 | */ |
| 51 | - private $xLibContainer; |
|
| 51 | +private $xLibContainer; |
|
| 52 | 52 | |
| 53 | - /** |
|
| 53 | +/** |
|
| 54 | 54 | * The application or framework Dependency Injection Container |
| 55 | 55 | * |
| 56 | 56 | * @var ContainerInterface |
| 57 | 57 | */ |
| 58 | - private $xAppContainer = null; |
|
| 58 | +private $xAppContainer = null; |
|
| 59 | 59 | |
| 60 | - /** |
|
| 60 | +/** |
|
| 61 | 61 | * The class constructor |
| 62 | 62 | */ |
| 63 | - public function __construct() |
|
| 64 | - { |
|
| 65 | - $this->xLibContainer = new PimpleContainer(); |
|
| 63 | +public function __construct() |
|
| 64 | +{ |
|
| 65 | +$this->xLibContainer = new PimpleContainer(); |
|
| 66 | 66 | |
| 67 | - $this->val(Container::class, $this); |
|
| 67 | +$this->val(Container::class, $this); |
|
| 68 | 68 | |
| 69 | - // Register the null logger by default |
|
| 70 | - $this->setLogger(new NullLogger()); |
|
| 69 | +// Register the null logger by default |
|
| 70 | +$this->setLogger(new NullLogger()); |
|
| 71 | 71 | |
| 72 | - // Template directory |
|
| 73 | - $sTemplateDir = realpath(__DIR__ . '/../../templates'); |
|
| 74 | - $this->val('jaxon.core.dir.template', $sTemplateDir); |
|
| 72 | +// Template directory |
|
| 73 | +$sTemplateDir = realpath(__DIR__ . '/../../templates'); |
|
| 74 | +$this->val('jaxon.core.dir.template', $sTemplateDir); |
|
| 75 | 75 | |
| 76 | - // Translation directory |
|
| 77 | - $sTranslationDir = realpath(__DIR__ . '/../../translations'); |
|
| 78 | - $this->val('jaxon.core.dir.translation', $sTranslationDir); |
|
| 76 | +// Translation directory |
|
| 77 | +$sTranslationDir = realpath(__DIR__ . '/../../translations'); |
|
| 78 | +$this->val('jaxon.core.dir.translation', $sTranslationDir); |
|
| 79 | 79 | |
| 80 | - $this->registerAll(); |
|
| 81 | - $this->setEventHandlers(); |
|
| 82 | - } |
|
| 80 | +$this->registerAll(); |
|
| 81 | +$this->setEventHandlers(); |
|
| 82 | +} |
|
| 83 | 83 | |
| 84 | - /** |
|
| 84 | +/** |
|
| 85 | 85 | * The container for parameters |
| 86 | 86 | * |
| 87 | 87 | * @return Container |
| 88 | 88 | */ |
| 89 | - protected function cn(): Container |
|
| 90 | - { |
|
| 91 | - return $this; |
|
| 92 | - } |
|
| 89 | +protected function cn(): Container |
|
| 90 | +{ |
|
| 91 | +return $this; |
|
| 92 | +} |
|
| 93 | 93 | |
| 94 | - /** |
|
| 94 | +/** |
|
| 95 | 95 | * Register the values into the container |
| 96 | 96 | * |
| 97 | 97 | * @return void |
| 98 | 98 | */ |
| 99 | - private function registerAll() |
|
| 100 | - { |
|
| 101 | - $this->registerApp(); |
|
| 102 | - $this->registerPsr(); |
|
| 103 | - $this->registerRequests(); |
|
| 104 | - $this->registerResponses(); |
|
| 105 | - $this->registerPlugins(); |
|
| 106 | - $this->registerCallables(); |
|
| 107 | - $this->registerViews(); |
|
| 108 | - $this->registerUtils(); |
|
| 109 | - $this->registerMetadataReader(); |
|
| 110 | - } |
|
| 99 | +private function registerAll() |
|
| 100 | +{ |
|
| 101 | +$this->registerApp(); |
|
| 102 | +$this->registerPsr(); |
|
| 103 | +$this->registerRequests(); |
|
| 104 | +$this->registerResponses(); |
|
| 105 | +$this->registerPlugins(); |
|
| 106 | +$this->registerCallables(); |
|
| 107 | +$this->registerViews(); |
|
| 108 | +$this->registerUtils(); |
|
| 109 | +$this->registerMetadataReader(); |
|
| 110 | +} |
|
| 111 | 111 | |
| 112 | - /** |
|
| 112 | +/** |
|
| 113 | 113 | * Set the logger |
| 114 | 114 | * |
| 115 | 115 | * @param LoggerInterface|Closure $xLogger |
| 116 | 116 | * |
| 117 | 117 | * @return void |
| 118 | 118 | */ |
| 119 | - public function setLogger(LoggerInterface|Closure $xLogger) |
|
| 120 | - { |
|
| 121 | - is_a($xLogger, LoggerInterface::class) ? |
|
| 122 | - $this->val(LoggerInterface::class, $xLogger) : |
|
| 123 | - $this->set(LoggerInterface::class, $xLogger); |
|
| 124 | - } |
|
| 119 | +public function setLogger(LoggerInterface|Closure $xLogger) |
|
| 120 | +{ |
|
| 121 | +is_a($xLogger, LoggerInterface::class) ? |
|
| 122 | +$this->val(LoggerInterface::class, $xLogger) : |
|
| 123 | +$this->set(LoggerInterface::class, $xLogger); |
|
| 124 | +} |
|
| 125 | 125 | |
| 126 | - /** |
|
| 126 | +/** |
|
| 127 | 127 | * Get the logger |
| 128 | 128 | * |
| 129 | 129 | * @return LoggerInterface |
| 130 | 130 | */ |
| 131 | - public function getLogger(): LoggerInterface |
|
| 132 | - { |
|
| 133 | - return $this->get(LoggerInterface::class); |
|
| 134 | - } |
|
| 131 | +public function getLogger(): LoggerInterface |
|
| 132 | +{ |
|
| 133 | +return $this->get(LoggerInterface::class); |
|
| 134 | +} |
|
| 135 | 135 | |
| 136 | - /** |
|
| 136 | +/** |
|
| 137 | 137 | * Set the container provided by the integrated framework |
| 138 | 138 | * |
| 139 | 139 | * @param ContainerInterface $xContainer The container implementation |
| 140 | 140 | * |
| 141 | 141 | * @return void |
| 142 | 142 | */ |
| 143 | - public function setContainer(ContainerInterface $xContainer) |
|
| 144 | - { |
|
| 145 | - $this->xAppContainer = $xContainer; |
|
| 146 | - } |
|
| 143 | +public function setContainer(ContainerInterface $xContainer) |
|
| 144 | +{ |
|
| 145 | +$this->xAppContainer = $xContainer; |
|
| 146 | +} |
|
| 147 | 147 | |
| 148 | - /** |
|
| 148 | +/** |
|
| 149 | 149 | * Check if a class is defined in the container |
| 150 | 150 | * |
| 151 | 151 | * @param string $sClass The full class name |
| 152 | 152 | * |
| 153 | 153 | * @return bool |
| 154 | 154 | */ |
| 155 | - public function h(string $sClass): bool |
|
| 156 | - { |
|
| 157 | - return $this->xLibContainer->offsetExists($sClass); |
|
| 158 | - } |
|
| 155 | +public function h(string $sClass): bool |
|
| 156 | +{ |
|
| 157 | +return $this->xLibContainer->offsetExists($sClass); |
|
| 158 | +} |
|
| 159 | 159 | |
| 160 | - /** |
|
| 160 | +/** |
|
| 161 | 161 | * Check if a class is defined in the container |
| 162 | 162 | * |
| 163 | 163 | * @param string $sClass The full class name |
| 164 | 164 | * |
| 165 | 165 | * @return bool |
| 166 | 166 | */ |
| 167 | - public function has(string $sClass): bool |
|
| 168 | - { |
|
| 169 | - return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ? |
|
| 170 | - true : $this->xLibContainer->offsetExists($sClass); |
|
| 171 | - } |
|
| 167 | +public function has(string $sClass): bool |
|
| 168 | +{ |
|
| 169 | +return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ? |
|
| 170 | +true : $this->xLibContainer->offsetExists($sClass); |
|
| 171 | +} |
|
| 172 | 172 | |
| 173 | - /** |
|
| 173 | +/** |
|
| 174 | 174 | * Get a class instance |
| 175 | 175 | * |
| 176 | 176 | * @template T |
@@ -178,12 +178,12 @@ discard block |
||
| 178 | 178 | * |
| 179 | 179 | * @return T |
| 180 | 180 | */ |
| 181 | - public function g(string $sClass): mixed |
|
| 182 | - { |
|
| 183 | - return $this->xLibContainer->offsetGet($sClass); |
|
| 184 | - } |
|
| 181 | +public function g(string $sClass): mixed |
|
| 182 | +{ |
|
| 183 | +return $this->xLibContainer->offsetGet($sClass); |
|
| 184 | +} |
|
| 185 | 185 | |
| 186 | - /** |
|
| 186 | +/** |
|
| 187 | 187 | * Get a class instance |
| 188 | 188 | * |
| 189 | 189 | * @template T |
@@ -192,24 +192,24 @@ discard block |
||
| 192 | 192 | * @return T |
| 193 | 193 | * @throws SetupException |
| 194 | 194 | */ |
| 195 | - public function get(string $sClass): mixed |
|
| 196 | - { |
|
| 197 | - try |
|
| 198 | - { |
|
| 199 | - return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ? |
|
| 200 | - $this->xAppContainer->get($sClass) : $this->xLibContainer->offsetGet($sClass); |
|
| 201 | - } |
|
| 202 | - catch(Throwable $e) |
|
| 203 | - { |
|
| 204 | - $xLogger = $this->g(LoggerInterface::class); |
|
| 205 | - $xTranslator = $this->g(Translator::class); |
|
| 206 | - $sMessage = $e->getMessage() . ': ' . $xTranslator->trans('errors.class.container', ['name' => $sClass]); |
|
| 207 | - $xLogger->error($e->getMessage(), ['message' => $sMessage]); |
|
| 208 | - throw new SetupException($sMessage); |
|
| 209 | - } |
|
| 210 | - } |
|
| 195 | +public function get(string $sClass): mixed |
|
| 196 | +{ |
|
| 197 | +try |
|
| 198 | +{ |
|
| 199 | +return $this->xAppContainer != null && $this->xAppContainer->has($sClass) ? |
|
| 200 | + $this->xAppContainer->get($sClass) : $this->xLibContainer->offsetGet($sClass); |
|
| 201 | +} |
|
| 202 | +catch(Throwable $e) |
|
| 203 | +{ |
|
| 204 | +$xLogger = $this->g(LoggerInterface::class); |
|
| 205 | +$xTranslator = $this->g(Translator::class); |
|
| 206 | +$sMessage = $e->getMessage() . ': ' . $xTranslator->trans('errors.class.container', ['name' => $sClass]); |
|
| 207 | +$xLogger->error($e->getMessage(), ['message' => $sMessage]); |
|
| 208 | +throw new SetupException($sMessage); |
|
| 209 | +} |
|
| 210 | +} |
|
| 211 | 211 | |
| 212 | - /** |
|
| 212 | +/** |
|
| 213 | 213 | * Save a closure in the container |
| 214 | 214 | * |
| 215 | 215 | * @param string|class-string $sClass The full class name |
@@ -218,15 +218,15 @@ discard block |
||
| 218 | 218 | * |
| 219 | 219 | * @return void |
| 220 | 220 | */ |
| 221 | - public function set(string $sClass, Closure $xClosure, bool $bIsSingleton = true) |
|
| 222 | - { |
|
| 223 | - // Wrap the user closure into a new closure, so it can take this container as a parameter. |
|
| 224 | - $xClosure = fn() => $xClosure($this); |
|
| 225 | - $this->xLibContainer->offsetSet($sClass, $bIsSingleton ? |
|
| 226 | - $xClosure : $this->xLibContainer->factory($xClosure)); |
|
| 227 | - } |
|
| 221 | +public function set(string $sClass, Closure $xClosure, bool $bIsSingleton = true) |
|
| 222 | +{ |
|
| 223 | +// Wrap the user closure into a new closure, so it can take this container as a parameter. |
|
| 224 | +$xClosure = fn() => $xClosure($this); |
|
| 225 | +$this->xLibContainer->offsetSet($sClass, $bIsSingleton ? |
|
| 226 | +$xClosure : $this->xLibContainer->factory($xClosure)); |
|
| 227 | +} |
|
| 228 | 228 | |
| 229 | - /** |
|
| 229 | +/** |
|
| 230 | 230 | * Save a value in the container |
| 231 | 231 | * |
| 232 | 232 | * @param string|class-string $sKey The key |
@@ -234,12 +234,12 @@ discard block |
||
| 234 | 234 | * |
| 235 | 235 | * @return void |
| 236 | 236 | */ |
| 237 | - public function val(string $sKey, $xValue) |
|
| 238 | - { |
|
| 239 | - $this->xLibContainer->offsetSet($sKey, $xValue); |
|
| 240 | - } |
|
| 237 | +public function val(string $sKey, $xValue) |
|
| 238 | +{ |
|
| 239 | +$this->xLibContainer->offsetSet($sKey, $xValue); |
|
| 240 | +} |
|
| 241 | 241 | |
| 242 | - /** |
|
| 242 | +/** |
|
| 243 | 243 | * Set an alias in the container |
| 244 | 244 | * |
| 245 | 245 | * @param string|class-string $sAlias The alias name |
@@ -247,60 +247,60 @@ discard block |
||
| 247 | 247 | * |
| 248 | 248 | * @return void |
| 249 | 249 | */ |
| 250 | - public function alias(string $sAlias, string $sClass) |
|
| 251 | - { |
|
| 252 | - $this->set($sAlias, function($di) use ($sClass) { |
|
| 253 | - return $di->get($sClass); |
|
| 254 | - }); |
|
| 255 | - } |
|
| 250 | +public function alias(string $sAlias, string $sClass) |
|
| 251 | +{ |
|
| 252 | +$this->set($sAlias, function($di) use ($sClass) { |
|
| 253 | +return $di->get($sClass); |
|
| 254 | +}); |
|
| 255 | +} |
|
| 256 | 256 | |
| 257 | - /** |
|
| 257 | +/** |
|
| 258 | 258 | * @param ReflectionClass $xClass |
| 259 | 259 | * @param ReflectionParameter $xParameter |
| 260 | 260 | * |
| 261 | 261 | * @return mixed |
| 262 | 262 | * @throws SetupException |
| 263 | 263 | */ |
| 264 | - public function getParameter(ReflectionClass $xClass, ReflectionParameter $xParameter) |
|
| 265 | - { |
|
| 266 | - $xType = $xParameter->getType(); |
|
| 267 | - // Check the parameter class first. |
|
| 268 | - if($xType instanceof ReflectionNamedType) |
|
| 269 | - { |
|
| 270 | - // Check the class + the name |
|
| 271 | - if($this->has($xType->getName() . ' $' . $xParameter->getName())) |
|
| 272 | - { |
|
| 273 | - return $this->get($xType->getName() . ' $' . $xParameter->getName()); |
|
| 274 | - } |
|
| 275 | - // Check the class only |
|
| 276 | - if($this->has($xType->getName())) |
|
| 277 | - { |
|
| 278 | - return $this->get($xType->getName()); |
|
| 279 | - } |
|
| 280 | - } |
|
| 281 | - // Check the name only |
|
| 282 | - return $this->get('$' . $xParameter->getName()); |
|
| 283 | - } |
|
| 264 | +public function getParameter(ReflectionClass $xClass, ReflectionParameter $xParameter) |
|
| 265 | +{ |
|
| 266 | +$xType = $xParameter->getType(); |
|
| 267 | +// Check the parameter class first. |
|
| 268 | +if($xType instanceof ReflectionNamedType) |
|
| 269 | +{ |
|
| 270 | +// Check the class + the name |
|
| 271 | +if($this->has($xType->getName() . ' $' . $xParameter->getName())) |
|
| 272 | +{ |
|
| 273 | + return $this->get($xType->getName() . ' $' . $xParameter->getName()); |
|
| 274 | +} |
|
| 275 | +// Check the class only |
|
| 276 | +if($this->has($xType->getName())) |
|
| 277 | +{ |
|
| 278 | + return $this->get($xType->getName()); |
|
| 279 | +} |
|
| 280 | +} |
|
| 281 | +// Check the name only |
|
| 282 | +return $this->get('$' . $xParameter->getName()); |
|
| 283 | +} |
|
| 284 | 284 | |
| 285 | - /** |
|
| 285 | +/** |
|
| 286 | 286 | * Get the session manager |
| 287 | 287 | * |
| 288 | 288 | * @return SessionInterface|null |
| 289 | 289 | */ |
| 290 | - public function getSessionManager(): ?SessionInterface |
|
| 291 | - { |
|
| 292 | - return $this->h(SessionInterface::class) ? $this->g(SessionInterface::class) : null; |
|
| 293 | - } |
|
| 290 | +public function getSessionManager(): ?SessionInterface |
|
| 291 | +{ |
|
| 292 | +return $this->h(SessionInterface::class) ? $this->g(SessionInterface::class) : null; |
|
| 293 | +} |
|
| 294 | 294 | |
| 295 | - /** |
|
| 295 | +/** |
|
| 296 | 296 | * Set the session manager |
| 297 | 297 | * |
| 298 | 298 | * @param Closure $xClosure A closure to create the session manager instance |
| 299 | 299 | * |
| 300 | 300 | * @return void |
| 301 | 301 | */ |
| 302 | - public function setSessionManager(Closure $xClosure) |
|
| 303 | - { |
|
| 304 | - $this->set(SessionInterface::class, $xClosure); |
|
| 305 | - } |
|
| 302 | +public function setSessionManager(Closure $xClosure) |
|
| 303 | +{ |
|
| 304 | +$this->set(SessionInterface::class, $xClosure); |
|
| 305 | +} |
|
| 306 | 306 | } |
@@ -13,25 +13,25 @@ |
||
| 13 | 13 | |
| 14 | 14 | class Page |
| 15 | 15 | { |
| 16 | - /** |
|
| 16 | +/** |
|
| 17 | 17 | * @var string |
| 18 | 18 | */ |
| 19 | - public $sType; |
|
| 19 | +public $sType; |
|
| 20 | 20 | |
| 21 | - /** |
|
| 21 | +/** |
|
| 22 | 22 | * @var string |
| 23 | 23 | */ |
| 24 | - public $sText; |
|
| 24 | +public $sText; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 26 | +/** |
|
| 27 | 27 | * @var int |
| 28 | 28 | */ |
| 29 | - public $nNumber; |
|
| 29 | +public $nNumber; |
|
| 30 | 30 | |
| 31 | - public function __construct(string $sType, string $sText, int $nNumber) |
|
| 32 | - { |
|
| 33 | - $this->sType = $sType; |
|
| 34 | - $this->sText = $sText; |
|
| 35 | - $this->nNumber = $nNumber; |
|
| 36 | - } |
|
| 31 | +public function __construct(string $sType, string $sText, int $nNumber) |
|
| 32 | +{ |
|
| 33 | +$this->sType = $sType; |
|
| 34 | +$this->sText = $sText; |
|
| 35 | +$this->nNumber = $nNumber; |
|
| 36 | +} |
|
| 37 | 37 | } |
| 38 | 38 | \ No newline at end of file |
@@ -32,110 +32,110 @@ |
||
| 32 | 32 | |
| 33 | 33 | final class Jaxon |
| 34 | 34 | { |
| 35 | - use Traits\ConfigTrait; |
|
| 36 | - use Traits\ServicesTrait; |
|
| 37 | - use Traits\PluginTrait; |
|
| 38 | - use Traits\RequestTrait; |
|
| 39 | - use Traits\ResponseTrait; |
|
| 40 | - use Traits\SendResponseTrait; |
|
| 41 | - |
|
| 42 | - /** |
|
| 35 | +use Traits\ConfigTrait; |
|
| 36 | +use Traits\ServicesTrait; |
|
| 37 | +use Traits\PluginTrait; |
|
| 38 | +use Traits\RequestTrait; |
|
| 39 | +use Traits\ResponseTrait; |
|
| 40 | +use Traits\SendResponseTrait; |
|
| 41 | + |
|
| 42 | +/** |
|
| 43 | 43 | * @var Jaxon|null |
| 44 | 44 | */ |
| 45 | - private static $xInstance = null; |
|
| 45 | +private static $xInstance = null; |
|
| 46 | 46 | |
| 47 | - /** |
|
| 47 | +/** |
|
| 48 | 48 | * The constructor |
| 49 | 49 | * |
| 50 | 50 | * @param Container $xContainer |
| 51 | 51 | * @param ComponentContainer $xComponentContainer |
| 52 | 52 | */ |
| 53 | - private function __construct(Container $xContainer, ComponentContainer $xComponentContainer) |
|
| 54 | - { |
|
| 55 | - $this->xContainer = $xContainer; |
|
| 56 | - $this->xComponentContainer = $xComponentContainer; |
|
| 57 | - } |
|
| 53 | +private function __construct(Container $xContainer, ComponentContainer $xComponentContainer) |
|
| 54 | +{ |
|
| 55 | +$this->xContainer = $xContainer; |
|
| 56 | +$this->xComponentContainer = $xComponentContainer; |
|
| 57 | +} |
|
| 58 | 58 | |
| 59 | - /** |
|
| 59 | +/** |
|
| 60 | 60 | * @return Jaxon |
| 61 | 61 | */ |
| 62 | - private static function createInstance(): Jaxon |
|
| 63 | - { |
|
| 64 | - $xContainer = new Container(); |
|
| 65 | - $xComponentContainer = new ComponentContainer($xContainer); |
|
| 66 | - self::$xInstance = new Jaxon($xContainer, $xComponentContainer); |
|
| 62 | +private static function createInstance(): Jaxon |
|
| 63 | +{ |
|
| 64 | +$xContainer = new Container(); |
|
| 65 | +$xComponentContainer = new ComponentContainer($xContainer); |
|
| 66 | +self::$xInstance = new Jaxon($xContainer, $xComponentContainer); |
|
| 67 | 67 | |
| 68 | - // Save the Jaxon and container instances |
|
| 69 | - $xContainer->val(Jaxon::class, self::$xInstance); |
|
| 70 | - $xContainer->val(ComponentContainer::class, $xComponentContainer); |
|
| 68 | +// Save the Jaxon and container instances |
|
| 69 | +$xContainer->val(Jaxon::class, self::$xInstance); |
|
| 70 | +$xContainer->val(ComponentContainer::class, $xComponentContainer); |
|
| 71 | 71 | |
| 72 | - // Make the helpers functions available in the global namespace. |
|
| 73 | - self::$xInstance->getCallbackManager()->boot(function() { |
|
| 74 | - self::$xInstance->config()->globals(); |
|
| 75 | - }); |
|
| 72 | +// Make the helpers functions available in the global namespace. |
|
| 73 | +self::$xInstance->getCallbackManager()->boot(function() { |
|
| 74 | +self::$xInstance->config()->globals(); |
|
| 75 | +}); |
|
| 76 | 76 | |
| 77 | - return self::$xInstance; |
|
| 78 | - } |
|
| 77 | +return self::$xInstance; |
|
| 78 | +} |
|
| 79 | 79 | |
| 80 | - /** |
|
| 80 | +/** |
|
| 81 | 81 | * @return Jaxon |
| 82 | 82 | */ |
| 83 | - public static function getInstance(): Jaxon |
|
| 84 | - { |
|
| 85 | - return self::$xInstance ?: self::$xInstance = self::createInstance(); |
|
| 86 | - } |
|
| 83 | +public static function getInstance(): Jaxon |
|
| 84 | +{ |
|
| 85 | +return self::$xInstance ?: self::$xInstance = self::createInstance(); |
|
| 86 | +} |
|
| 87 | 87 | |
| 88 | - /** |
|
| 88 | +/** |
|
| 89 | 89 | * @return string |
| 90 | 90 | */ |
| 91 | - public function getVersion(): string |
|
| 92 | - { |
|
| 93 | - return \Jaxon\Jaxon::VERSION; |
|
| 94 | - } |
|
| 91 | +public function getVersion(): string |
|
| 92 | +{ |
|
| 93 | +return \Jaxon\Jaxon::VERSION; |
|
| 94 | +} |
|
| 95 | 95 | |
| 96 | - /** |
|
| 96 | +/** |
|
| 97 | 97 | * @return ConfigManager |
| 98 | 98 | */ |
| 99 | - public function config(): ConfigManager |
|
| 100 | - { |
|
| 101 | - return $this->di()->g(ConfigManager::class); |
|
| 102 | - } |
|
| 99 | +public function config(): ConfigManager |
|
| 100 | +{ |
|
| 101 | +return $this->di()->g(ConfigManager::class); |
|
| 102 | +} |
|
| 103 | 103 | |
| 104 | - /** |
|
| 104 | +/** |
|
| 105 | 105 | * Set the ajax endpoint URI |
| 106 | 106 | * |
| 107 | 107 | * @param string $sUri The ajax endpoint URI |
| 108 | 108 | * |
| 109 | 109 | * @return void |
| 110 | 110 | */ |
| 111 | - public function setUri(string $sUri): void |
|
| 112 | - { |
|
| 113 | - $this->config()->setOption('core.request.uri', $sUri); |
|
| 114 | - } |
|
| 111 | +public function setUri(string $sUri): void |
|
| 112 | +{ |
|
| 113 | +$this->config()->setOption('core.request.uri', $sUri); |
|
| 114 | +} |
|
| 115 | 115 | |
| 116 | - /** |
|
| 116 | +/** |
|
| 117 | 117 | * @return AppInterface |
| 118 | 118 | */ |
| 119 | - public function app(): AppInterface |
|
| 120 | - { |
|
| 121 | - return $this->xContainer->getApp(); |
|
| 122 | - } |
|
| 119 | +public function app(): AppInterface |
|
| 120 | +{ |
|
| 121 | +return $this->xContainer->getApp(); |
|
| 122 | +} |
|
| 123 | 123 | |
| 124 | - /** |
|
| 124 | +/** |
|
| 125 | 125 | * Get the callback manager |
| 126 | 126 | * |
| 127 | 127 | * @return CallbackManager |
| 128 | 128 | */ |
| 129 | - public function callback(): CallbackManager |
|
| 130 | - { |
|
| 131 | - return $this->getCallbackManager(); |
|
| 132 | - } |
|
| 129 | +public function callback(): CallbackManager |
|
| 130 | +{ |
|
| 131 | +return $this->getCallbackManager(); |
|
| 132 | +} |
|
| 133 | 133 | |
| 134 | - /** |
|
| 134 | +/** |
|
| 135 | 135 | * @return void |
| 136 | 136 | */ |
| 137 | - public function reset(): void |
|
| 138 | - { |
|
| 139 | - self::$xInstance = null; |
|
| 140 | - } |
|
| 137 | +public function reset(): void |
|
| 138 | +{ |
|
| 139 | +self::$xInstance = null; |
|
| 140 | +} |
|
| 141 | 141 | } |
@@ -28,27 +28,27 @@ discard block |
||
| 28 | 28 | |
| 29 | 29 | trait PluginTrait |
| 30 | 30 | { |
| 31 | - /** |
|
| 31 | +/** |
|
| 32 | 32 | * @return PluginManager |
| 33 | 33 | */ |
| 34 | - abstract public function getPluginManager(): PluginManager; |
|
| 34 | +abstract public function getPluginManager(): PluginManager; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 36 | +/** |
|
| 37 | 37 | * @return PackageManager |
| 38 | 38 | */ |
| 39 | - abstract public function getPackageManager(): PackageManager; |
|
| 39 | +abstract public function getPackageManager(): PackageManager; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 41 | +/** |
|
| 42 | 42 | * @return CodeGenerator |
| 43 | 43 | */ |
| 44 | - abstract public function getCodeGenerator(): CodeGenerator; |
|
| 44 | +abstract public function getCodeGenerator(): CodeGenerator; |
|
| 45 | 45 | |
| 46 | - /** |
|
| 46 | +/** |
|
| 47 | 47 | * @return Bootstrap |
| 48 | 48 | */ |
| 49 | - abstract protected function getBootstrap(): Bootstrap; |
|
| 49 | +abstract protected function getBootstrap(): Bootstrap; |
|
| 50 | 50 | |
| 51 | - /** |
|
| 51 | +/** |
|
| 52 | 52 | * Register request handlers, including functions, callable classes and directories. |
| 53 | 53 | * |
| 54 | 54 | * @param string $sType The type of request handler being registered |
@@ -65,14 +65,14 @@ discard block |
||
| 65 | 65 | * @return void |
| 66 | 66 | * @throws SetupException |
| 67 | 67 | */ |
| 68 | - public function register(string $sType, string $sName, $xOptions = []): void |
|
| 69 | - { |
|
| 70 | - // We need the library to have been bootstrapped. |
|
| 71 | - $this->getBootstrap()->onBoot(); |
|
| 72 | - $this->getPluginManager()->registerCallable($sType, $sName, $xOptions); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - /** |
|
| 68 | +public function register(string $sType, string $sName, $xOptions = []): void |
|
| 69 | +{ |
|
| 70 | +// We need the library to have been bootstrapped. |
|
| 71 | +$this->getBootstrap()->onBoot(); |
|
| 72 | +$this->getPluginManager()->registerCallable($sType, $sName, $xOptions); |
|
| 73 | +} |
|
| 74 | + |
|
| 75 | +/** |
|
| 76 | 76 | * Register a plugin |
| 77 | 77 | * |
| 78 | 78 | * Below is a table for priorities and their description: |
@@ -87,14 +87,14 @@ discard block |
||
| 87 | 87 | * @return void |
| 88 | 88 | * @throws SetupException |
| 89 | 89 | */ |
| 90 | - public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000) |
|
| 91 | - { |
|
| 92 | - // We need the library to have been bootstrapped. |
|
| 93 | - $this->getBootstrap()->onBoot(); |
|
| 94 | - $this->getPluginManager()->registerPlugin($sClassName, $sPluginName, $nPriority); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 90 | +public function registerPlugin(string $sClassName, string $sPluginName, int $nPriority = 1000) |
|
| 91 | +{ |
|
| 92 | +// We need the library to have been bootstrapped. |
|
| 93 | +$this->getBootstrap()->onBoot(); |
|
| 94 | +$this->getPluginManager()->registerPlugin($sClassName, $sPluginName, $nPriority); |
|
| 95 | +} |
|
| 96 | + |
|
| 97 | +/** |
|
| 98 | 98 | * Register a package |
| 99 | 99 | * |
| 100 | 100 | * @param string $sClassName The package class |
@@ -103,14 +103,14 @@ discard block |
||
| 103 | 103 | * @return void |
| 104 | 104 | * @throws SetupException |
| 105 | 105 | */ |
| 106 | - public function registerPackage(string $sClassName, array $xPkgOptions = []) |
|
| 107 | - { |
|
| 108 | - // We need the library to have been bootstrapped. |
|
| 109 | - $this->getBootstrap()->onBoot(); |
|
| 110 | - $this->getPackageManager()->registerPackage($sClassName, $xPkgOptions); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 106 | +public function registerPackage(string $sClassName, array $xPkgOptions = []) |
|
| 107 | +{ |
|
| 108 | +// We need the library to have been bootstrapped. |
|
| 109 | +$this->getBootstrap()->onBoot(); |
|
| 110 | +$this->getPackageManager()->registerPackage($sClassName, $xPkgOptions); |
|
| 111 | +} |
|
| 112 | + |
|
| 113 | +/** |
|
| 114 | 114 | * Find a response plugin by name or class name |
| 115 | 115 | * |
| 116 | 116 | * @template R of ResponsePluginInterface |
@@ -118,12 +118,12 @@ discard block |
||
| 118 | 118 | * |
| 119 | 119 | * @return ($sName is class-string ? R : ResponsePluginInterface)|null |
| 120 | 120 | */ |
| 121 | - public function plugin(string $sName): ResponsePluginInterface|null |
|
| 122 | - { |
|
| 123 | - return $this->getPluginManager()->getResponsePlugin($sName); |
|
| 124 | - } |
|
| 121 | +public function plugin(string $sName): ResponsePluginInterface|null |
|
| 122 | +{ |
|
| 123 | +return $this->getPluginManager()->getResponsePlugin($sName); |
|
| 124 | +} |
|
| 125 | 125 | |
| 126 | - /** |
|
| 126 | +/** |
|
| 127 | 127 | * Get a package instance |
| 128 | 128 | * |
| 129 | 129 | * @template P of AbstractPackage |
@@ -131,52 +131,52 @@ discard block |
||
| 131 | 131 | * |
| 132 | 132 | * @return P|null |
| 133 | 133 | */ |
| 134 | - public function package(string $sClassName): ?AbstractPackage |
|
| 135 | - { |
|
| 136 | - return $this->getPackageManager()->getPackage($sClassName); |
|
| 137 | - } |
|
| 134 | +public function package(string $sClassName): ?AbstractPackage |
|
| 135 | +{ |
|
| 136 | +return $this->getPackageManager()->getPackage($sClassName); |
|
| 137 | +} |
|
| 138 | 138 | |
| 139 | - /** |
|
| 139 | +/** |
|
| 140 | 140 | * Get the HTML tags to include Jaxon javascript files into the page. |
| 141 | 141 | * |
| 142 | 142 | * @return string |
| 143 | 143 | */ |
| 144 | - public function getJs(): string |
|
| 145 | - { |
|
| 146 | - return $this->getCodeGenerator()->getJs(); |
|
| 147 | - } |
|
| 144 | +public function getJs(): string |
|
| 145 | +{ |
|
| 146 | +return $this->getCodeGenerator()->getJs(); |
|
| 147 | +} |
|
| 148 | 148 | |
| 149 | - /** |
|
| 149 | +/** |
|
| 150 | 150 | * Get the HTML tags to include Jaxon javascript files into the page. |
| 151 | 151 | * |
| 152 | 152 | * @return string the javascript code |
| 153 | 153 | */ |
| 154 | - public function js(): string |
|
| 155 | - { |
|
| 156 | - return $this->getCodeGenerator()->getJs(); |
|
| 157 | - } |
|
| 154 | +public function js(): string |
|
| 155 | +{ |
|
| 156 | +return $this->getCodeGenerator()->getJs(); |
|
| 157 | +} |
|
| 158 | 158 | |
| 159 | - /** |
|
| 159 | +/** |
|
| 160 | 160 | * Get the HTML tags to include Jaxon CSS code and files into the page. |
| 161 | 161 | * |
| 162 | 162 | * @return string |
| 163 | 163 | */ |
| 164 | - public function getCss(): string |
|
| 165 | - { |
|
| 166 | - return $this->getCodeGenerator()->getCss(); |
|
| 167 | - } |
|
| 164 | +public function getCss(): string |
|
| 165 | +{ |
|
| 166 | +return $this->getCodeGenerator()->getCss(); |
|
| 167 | +} |
|
| 168 | 168 | |
| 169 | - /** |
|
| 169 | +/** |
|
| 170 | 170 | * Get the HTML tags to include Jaxon CSS code and files into the page. |
| 171 | 171 | * |
| 172 | 172 | * @return string |
| 173 | 173 | */ |
| 174 | - public function css(): string |
|
| 175 | - { |
|
| 176 | - return $this->getCodeGenerator()->getCss(); |
|
| 177 | - } |
|
| 174 | +public function css(): string |
|
| 175 | +{ |
|
| 176 | +return $this->getCodeGenerator()->getCss(); |
|
| 177 | +} |
|
| 178 | 178 | |
| 179 | - /** |
|
| 179 | +/** |
|
| 180 | 180 | * Returns the js header and wrapper code to be printed into the page |
| 181 | 181 | * |
| 182 | 182 | * The javascript code returned by this function depends on the plugins |
@@ -188,12 +188,12 @@ discard block |
||
| 188 | 188 | * @return string |
| 189 | 189 | * @throws UriException |
| 190 | 190 | */ |
| 191 | - public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string |
|
| 192 | - { |
|
| 193 | - return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss); |
|
| 194 | - } |
|
| 191 | +public function getScript(bool $bIncludeJs = false, bool $bIncludeCss = false): string |
|
| 192 | +{ |
|
| 193 | +return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss); |
|
| 194 | +} |
|
| 195 | 195 | |
| 196 | - /** |
|
| 196 | +/** |
|
| 197 | 197 | * Returns the js header and wrapper code to be printed into the page |
| 198 | 198 | * |
| 199 | 199 | * @param bool $bIncludeJs Also get the js code |
@@ -202,8 +202,8 @@ discard block |
||
| 202 | 202 | * @return string the javascript code |
| 203 | 203 | * @throws UriException |
| 204 | 204 | */ |
| 205 | - public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string |
|
| 206 | - { |
|
| 207 | - return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss); |
|
| 208 | - } |
|
| 205 | +public function script(bool $bIncludeJs = false, bool $bIncludeCss = false): string |
|
| 206 | +{ |
|
| 207 | +return $this->getCodeGenerator()->getScript($bIncludeJs, $bIncludeCss); |
|
| 208 | +} |
|
| 209 | 209 | } |
@@ -9,35 +9,35 @@ discard block |
||
| 9 | 9 | |
| 10 | 10 | class Store implements JsonSerializable, Stringable |
| 11 | 11 | { |
| 12 | - /** |
|
| 12 | +/** |
|
| 13 | 13 | * The view renderer |
| 14 | 14 | * |
| 15 | 15 | * @var ViewInterface|null |
| 16 | 16 | */ |
| 17 | - protected $xRenderer = null; |
|
| 17 | +protected $xRenderer = null; |
|
| 18 | 18 | |
| 19 | - /** |
|
| 19 | +/** |
|
| 20 | 20 | * The view namespace |
| 21 | 21 | * |
| 22 | 22 | * @var string |
| 23 | 23 | */ |
| 24 | - protected $sNamespace; |
|
| 24 | +protected $sNamespace; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 26 | +/** |
|
| 27 | 27 | * The view name |
| 28 | 28 | * |
| 29 | 29 | * @var string |
| 30 | 30 | */ |
| 31 | - protected $sViewName; |
|
| 31 | +protected $sViewName; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 33 | +/** |
|
| 34 | 34 | * The view data |
| 35 | 35 | * |
| 36 | 36 | * @var array |
| 37 | 37 | */ |
| 38 | - protected $aViewData = []; |
|
| 38 | +protected $aViewData = []; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 40 | +/** |
|
| 41 | 41 | * Make a piece of data available for the rendered view |
| 42 | 42 | * |
| 43 | 43 | * @param string $sName The data name |
@@ -45,26 +45,26 @@ discard block |
||
| 45 | 45 | * |
| 46 | 46 | * @return Store |
| 47 | 47 | */ |
| 48 | - public function with(string $sName, $xValue): Store |
|
| 49 | - { |
|
| 50 | - $this->aViewData[$sName] = $xValue; |
|
| 51 | - return $this; |
|
| 52 | - } |
|
| 48 | +public function with(string $sName, $xValue): Store |
|
| 49 | +{ |
|
| 50 | +$this->aViewData[$sName] = $xValue; |
|
| 51 | +return $this; |
|
| 52 | +} |
|
| 53 | 53 | |
| 54 | - /** |
|
| 54 | +/** |
|
| 55 | 55 | * Set the data to be rendered |
| 56 | 56 | * |
| 57 | 57 | * @param array $aViewData The view data |
| 58 | 58 | * |
| 59 | 59 | * @return Store |
| 60 | 60 | */ |
| 61 | - public function setData(array $aViewData): Store |
|
| 62 | - { |
|
| 63 | - $this->aViewData = array_merge($this->aViewData, $aViewData); |
|
| 64 | - return $this; |
|
| 65 | - } |
|
| 61 | +public function setData(array $aViewData): Store |
|
| 62 | +{ |
|
| 63 | +$this->aViewData = array_merge($this->aViewData, $aViewData); |
|
| 64 | +return $this; |
|
| 65 | +} |
|
| 66 | 66 | |
| 67 | - /** |
|
| 67 | +/** |
|
| 68 | 68 | * Set the view to be rendered, with optional data |
| 69 | 69 | * |
| 70 | 70 | * @param ViewInterface $xRenderer The view renderer |
@@ -74,65 +74,65 @@ discard block |
||
| 74 | 74 | * |
| 75 | 75 | * @return Store |
| 76 | 76 | */ |
| 77 | - public function setView(ViewInterface $xRenderer, |
|
| 78 | - string $sNamespace, string $sViewName, array $aViewData = []): Store |
|
| 79 | - { |
|
| 80 | - $this->xRenderer = $xRenderer; |
|
| 81 | - $this->sNamespace = trim($sNamespace); |
|
| 82 | - $this->sViewName = trim($sViewName); |
|
| 83 | - $this->aViewData = array_merge($this->aViewData, $aViewData); |
|
| 84 | - return $this; |
|
| 85 | - } |
|
| 77 | +public function setView(ViewInterface $xRenderer, |
|
| 78 | +string $sNamespace, string $sViewName, array $aViewData = []): Store |
|
| 79 | +{ |
|
| 80 | +$this->xRenderer = $xRenderer; |
|
| 81 | +$this->sNamespace = trim($sNamespace); |
|
| 82 | +$this->sViewName = trim($sViewName); |
|
| 83 | +$this->aViewData = array_merge($this->aViewData, $aViewData); |
|
| 84 | +return $this; |
|
| 85 | +} |
|
| 86 | 86 | |
| 87 | - /** |
|
| 87 | +/** |
|
| 88 | 88 | * Get the view namespace |
| 89 | 89 | * |
| 90 | 90 | * @return string The view namespace |
| 91 | 91 | */ |
| 92 | - public function getNamespace(): string |
|
| 93 | - { |
|
| 94 | - return $this->sNamespace; |
|
| 95 | - } |
|
| 92 | +public function getNamespace(): string |
|
| 93 | +{ |
|
| 94 | +return $this->sNamespace; |
|
| 95 | +} |
|
| 96 | 96 | |
| 97 | - /** |
|
| 97 | +/** |
|
| 98 | 98 | * Get the view name |
| 99 | 99 | * |
| 100 | 100 | * @return string The view name |
| 101 | 101 | */ |
| 102 | - public function getViewName(): string |
|
| 103 | - { |
|
| 104 | - return $this->sViewName; |
|
| 105 | - } |
|
| 102 | +public function getViewName(): string |
|
| 103 | +{ |
|
| 104 | +return $this->sViewName; |
|
| 105 | +} |
|
| 106 | 106 | |
| 107 | - /** |
|
| 107 | +/** |
|
| 108 | 108 | * Get the view data |
| 109 | 109 | * |
| 110 | 110 | * @return array The view data |
| 111 | 111 | */ |
| 112 | - public function getViewData(): array |
|
| 113 | - { |
|
| 114 | - return $this->aViewData; |
|
| 115 | - } |
|
| 112 | +public function getViewData(): array |
|
| 113 | +{ |
|
| 114 | +return $this->aViewData; |
|
| 115 | +} |
|
| 116 | 116 | |
| 117 | - /** |
|
| 117 | +/** |
|
| 118 | 118 | * Render a view using third party view system |
| 119 | 119 | * |
| 120 | 120 | * @return string The string representation of the view |
| 121 | 121 | */ |
| 122 | - public function __toString(): string |
|
| 123 | - { |
|
| 124 | - return !$this->xRenderer ? '' : $this->xRenderer->render($this); |
|
| 125 | - } |
|
| 122 | +public function __toString(): string |
|
| 123 | +{ |
|
| 124 | +return !$this->xRenderer ? '' : $this->xRenderer->render($this); |
|
| 125 | +} |
|
| 126 | 126 | |
| 127 | - /** |
|
| 127 | +/** |
|
| 128 | 128 | * Convert this object to string for json. |
| 129 | 129 | * |
| 130 | 130 | * This is a method of the JsonSerializable interface. |
| 131 | 131 | * |
| 132 | 132 | * @return string |
| 133 | 133 | */ |
| 134 | - public function jsonSerialize(): string |
|
| 135 | - { |
|
| 136 | - return $this->__toString(); |
|
| 137 | - } |
|
| 134 | +public function jsonSerialize(): string |
|
| 135 | +{ |
|
| 136 | +return $this->__toString(); |
|
| 137 | +} |
|
| 138 | 138 | } |
@@ -13,58 +13,58 @@ discard block |
||
| 13 | 13 | |
| 14 | 14 | class ViewRenderer |
| 15 | 15 | { |
| 16 | - /** |
|
| 16 | +/** |
|
| 17 | 17 | * @var Container |
| 18 | 18 | */ |
| 19 | - protected $di; |
|
| 19 | +protected $di; |
|
| 20 | 20 | |
| 21 | - /** |
|
| 21 | +/** |
|
| 22 | 22 | * The view data store |
| 23 | 23 | * |
| 24 | 24 | * @var Store|null |
| 25 | 25 | */ |
| 26 | - protected $xStore = null; |
|
| 26 | +protected $xStore = null; |
|
| 27 | 27 | |
| 28 | - /** |
|
| 28 | +/** |
|
| 29 | 29 | * The view data store |
| 30 | 30 | * |
| 31 | 31 | * @var Store |
| 32 | 32 | */ |
| 33 | - protected $xEmptyStore = null; |
|
| 33 | +protected $xEmptyStore = null; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 35 | +/** |
|
| 36 | 36 | * The view namespaces |
| 37 | 37 | * |
| 38 | 38 | * @var array |
| 39 | 39 | */ |
| 40 | - protected $aNamespaces = []; |
|
| 40 | +protected $aNamespaces = []; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 42 | +/** |
|
| 43 | 43 | * The default namespace |
| 44 | 44 | * |
| 45 | 45 | * @var string |
| 46 | 46 | */ |
| 47 | - protected $sDefaultNamespace = 'jaxon'; |
|
| 47 | +protected $sDefaultNamespace = 'jaxon'; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 49 | +/** |
|
| 50 | 50 | * The view global data |
| 51 | 51 | * |
| 52 | 52 | * @var array |
| 53 | 53 | */ |
| 54 | - protected $aViewData = []; |
|
| 54 | +protected $aViewData = []; |
|
| 55 | 55 | |
| 56 | - /** |
|
| 56 | +/** |
|
| 57 | 57 | * The class constructor |
| 58 | 58 | * |
| 59 | 59 | * @param Container $di |
| 60 | 60 | */ |
| 61 | - public function __construct(Container $di) |
|
| 62 | - { |
|
| 63 | - $this->di = $di; |
|
| 64 | - $this->xEmptyStore = new Store(); |
|
| 65 | - } |
|
| 61 | +public function __construct(Container $di) |
|
| 62 | +{ |
|
| 63 | +$this->di = $di; |
|
| 64 | +$this->xEmptyStore = new Store(); |
|
| 65 | +} |
|
| 66 | 66 | |
| 67 | - /** |
|
| 67 | +/** |
|
| 68 | 68 | * Add a view namespace, and set the corresponding renderer. |
| 69 | 69 | * |
| 70 | 70 | * @param string $sNamespace The namespace name |
@@ -74,59 +74,59 @@ discard block |
||
| 74 | 74 | * |
| 75 | 75 | * @return void |
| 76 | 76 | */ |
| 77 | - public function addNamespace(string $sNamespace, string $sDirectory, |
|
| 78 | - string $sExtension, string $sRenderer): void |
|
| 79 | - { |
|
| 80 | - $aNamespace = [ |
|
| 81 | - 'directory' => $sDirectory, |
|
| 82 | - 'extension' => $sExtension, |
|
| 83 | - 'renderer' => $sRenderer, |
|
| 84 | - ]; |
|
| 85 | - $this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 86 | - } |
|
| 77 | +public function addNamespace(string $sNamespace, string $sDirectory, |
|
| 78 | +string $sExtension, string $sRenderer): void |
|
| 79 | +{ |
|
| 80 | +$aNamespace = [ |
|
| 81 | +'directory' => $sDirectory, |
|
| 82 | +'extension' => $sExtension, |
|
| 83 | +'renderer' => $sRenderer, |
|
| 84 | +]; |
|
| 85 | +$this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 86 | +} |
|
| 87 | 87 | |
| 88 | - /** |
|
| 88 | +/** |
|
| 89 | 89 | * Set the view namespaces. |
| 90 | 90 | * |
| 91 | 91 | * @param Config $xAppConfig The config options provided in the library |
| 92 | 92 | * |
| 93 | 93 | * @return void |
| 94 | 94 | */ |
| 95 | - public function addNamespaces(Config $xAppConfig): void |
|
| 96 | - { |
|
| 97 | - if(empty($aNamespaces = $xAppConfig->getOptionNames('views'))) |
|
| 98 | - { |
|
| 99 | - return; |
|
| 100 | - } |
|
| 95 | +public function addNamespaces(Config $xAppConfig): void |
|
| 96 | +{ |
|
| 97 | +if(empty($aNamespaces = $xAppConfig->getOptionNames('views'))) |
|
| 98 | +{ |
|
| 99 | +return; |
|
| 100 | +} |
|
| 101 | 101 | |
| 102 | - $sPackage = $xAppConfig->getOption('package', ''); |
|
| 103 | - foreach($aNamespaces as $sNamespace => $sOption) |
|
| 104 | - { |
|
| 105 | - // Save the namespace |
|
| 106 | - $aNamespace = $xAppConfig->getOption($sOption); |
|
| 107 | - $aNamespace['package'] = $sPackage; |
|
| 108 | - if(!isset($aNamespace['renderer'])) |
|
| 109 | - { |
|
| 110 | - $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer. |
|
| 111 | - } |
|
| 112 | - $this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 113 | - } |
|
| 114 | - } |
|
| 102 | +$sPackage = $xAppConfig->getOption('package', ''); |
|
| 103 | +foreach($aNamespaces as $sNamespace => $sOption) |
|
| 104 | +{ |
|
| 105 | +// Save the namespace |
|
| 106 | +$aNamespace = $xAppConfig->getOption($sOption); |
|
| 107 | +$aNamespace['package'] = $sPackage; |
|
| 108 | +if(!isset($aNamespace['renderer'])) |
|
| 109 | +{ |
|
| 110 | + $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer. |
|
| 111 | +} |
|
| 112 | +$this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 113 | +} |
|
| 114 | +} |
|
| 115 | 115 | |
| 116 | - /** |
|
| 116 | +/** |
|
| 117 | 117 | * Get the view renderer |
| 118 | 118 | * |
| 119 | 119 | * @param string $sId The unique identifier of the view renderer |
| 120 | 120 | * |
| 121 | 121 | * @return ViewInterface |
| 122 | 122 | */ |
| 123 | - public function getRenderer(string $sId): ViewInterface |
|
| 124 | - { |
|
| 125 | - // Return the view renderer with the given id |
|
| 126 | - return $this->di->g("jaxon.app.view.$sId"); |
|
| 127 | - } |
|
| 123 | +public function getRenderer(string $sId): ViewInterface |
|
| 124 | +{ |
|
| 125 | +// Return the view renderer with the given id |
|
| 126 | +return $this->di->g("jaxon.app.view.$sId"); |
|
| 127 | +} |
|
| 128 | 128 | |
| 129 | - /** |
|
| 129 | +/** |
|
| 130 | 130 | * Add a view renderer with an id |
| 131 | 131 | * |
| 132 | 132 | * @param string $sId The unique identifier of the view renderer |
@@ -134,25 +134,25 @@ discard block |
||
| 134 | 134 | * |
| 135 | 135 | * @return void |
| 136 | 136 | */ |
| 137 | - public function addRenderer(string $sId, Closure $xClosure): void |
|
| 138 | - { |
|
| 139 | - // Return the initialized view renderer |
|
| 140 | - $this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) { |
|
| 141 | - // Get the defined renderer |
|
| 142 | - $xRenderer = $xClosure($di); |
|
| 143 | - // Init the renderer with the template namespaces |
|
| 144 | - $aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) { |
|
| 145 | - return $aOptions['renderer'] === $sId; |
|
| 146 | - }); |
|
| 147 | - foreach($aNamespaces as $sName => $aOptions) |
|
| 148 | - { |
|
| 149 | - $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']); |
|
| 150 | - } |
|
| 151 | - return $xRenderer; |
|
| 152 | - }); |
|
| 153 | - } |
|
| 137 | +public function addRenderer(string $sId, Closure $xClosure): void |
|
| 138 | +{ |
|
| 139 | +// Return the initialized view renderer |
|
| 140 | +$this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) { |
|
| 141 | +// Get the defined renderer |
|
| 142 | +$xRenderer = $xClosure($di); |
|
| 143 | +// Init the renderer with the template namespaces |
|
| 144 | +$aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) { |
|
| 145 | + return $aOptions['renderer'] === $sId; |
|
| 146 | +}); |
|
| 147 | +foreach($aNamespaces as $sName => $aOptions) |
|
| 148 | +{ |
|
| 149 | + $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']); |
|
| 150 | +} |
|
| 151 | +return $xRenderer; |
|
| 152 | +}); |
|
| 153 | +} |
|
| 154 | 154 | |
| 155 | - /** |
|
| 155 | +/** |
|
| 156 | 156 | * Add a view renderer with an id |
| 157 | 157 | * |
| 158 | 158 | * @param string $sId The unique identifier of the view renderer |
@@ -161,55 +161,55 @@ discard block |
||
| 161 | 161 | * |
| 162 | 162 | * @return void |
| 163 | 163 | */ |
| 164 | - public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void |
|
| 165 | - { |
|
| 166 | - $this->setDefaultNamespace($sId); |
|
| 167 | - $this->addNamespace($sId, '', $sExtension, $sId); |
|
| 168 | - $this->addRenderer($sId, $xClosure); |
|
| 169 | - } |
|
| 164 | +public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void |
|
| 165 | +{ |
|
| 166 | +$this->setDefaultNamespace($sId); |
|
| 167 | +$this->addNamespace($sId, '', $sExtension, $sId); |
|
| 168 | +$this->addRenderer($sId, $xClosure); |
|
| 169 | +} |
|
| 170 | 170 | |
| 171 | - /** |
|
| 171 | +/** |
|
| 172 | 172 | * Get the view renderer for a given namespace |
| 173 | 173 | * |
| 174 | 174 | * @param string $sNamespace The namespace name |
| 175 | 175 | * |
| 176 | 176 | * @return ViewInterface|null |
| 177 | 177 | */ |
| 178 | - public function getNamespaceRenderer(string $sNamespace): ?ViewInterface |
|
| 179 | - { |
|
| 180 | - if(!isset($this->aNamespaces[$sNamespace])) |
|
| 181 | - { |
|
| 182 | - return null; |
|
| 183 | - } |
|
| 184 | - // Return the view renderer with the configured id |
|
| 185 | - return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']); |
|
| 186 | - } |
|
| 178 | +public function getNamespaceRenderer(string $sNamespace): ?ViewInterface |
|
| 179 | +{ |
|
| 180 | +if(!isset($this->aNamespaces[$sNamespace])) |
|
| 181 | +{ |
|
| 182 | +return null; |
|
| 183 | +} |
|
| 184 | +// Return the view renderer with the configured id |
|
| 185 | +return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']); |
|
| 186 | +} |
|
| 187 | 187 | |
| 188 | - /** |
|
| 188 | +/** |
|
| 189 | 189 | * Set the default namespace |
| 190 | 190 | * |
| 191 | 191 | * @param string $sDefaultNamespace |
| 192 | 192 | */ |
| 193 | - public function setDefaultNamespace(string $sDefaultNamespace): void |
|
| 194 | - { |
|
| 195 | - $this->sDefaultNamespace = $sDefaultNamespace; |
|
| 196 | - } |
|
| 193 | +public function setDefaultNamespace(string $sDefaultNamespace): void |
|
| 194 | +{ |
|
| 195 | +$this->sDefaultNamespace = $sDefaultNamespace; |
|
| 196 | +} |
|
| 197 | 197 | |
| 198 | - /** |
|
| 198 | +/** |
|
| 199 | 199 | * Get the current store or create a new store |
| 200 | 200 | * |
| 201 | 201 | * @return Store |
| 202 | 202 | */ |
| 203 | - protected function store(): Store |
|
| 204 | - { |
|
| 205 | - if(!$this->xStore) |
|
| 206 | - { |
|
| 207 | - $this->xStore = new Store(); |
|
| 208 | - } |
|
| 209 | - return $this->xStore; |
|
| 210 | - } |
|
| 203 | +protected function store(): Store |
|
| 204 | +{ |
|
| 205 | +if(!$this->xStore) |
|
| 206 | +{ |
|
| 207 | +$this->xStore = new Store(); |
|
| 208 | +} |
|
| 209 | +return $this->xStore; |
|
| 210 | +} |
|
| 211 | 211 | |
| 212 | - /** |
|
| 212 | +/** |
|
| 213 | 213 | * Make a piece of data available for the rendered view |
| 214 | 214 | * |
| 215 | 215 | * @param string $sName The data name |
@@ -217,13 +217,13 @@ discard block |
||
| 217 | 217 | * |
| 218 | 218 | * @return ViewRenderer |
| 219 | 219 | */ |
| 220 | - public function set(string $sName, $xValue): ViewRenderer |
|
| 221 | - { |
|
| 222 | - $this->store()->with($sName, $xValue); |
|
| 223 | - return $this; |
|
| 224 | - } |
|
| 220 | +public function set(string $sName, $xValue): ViewRenderer |
|
| 221 | +{ |
|
| 222 | +$this->store()->with($sName, $xValue); |
|
| 223 | +return $this; |
|
| 224 | +} |
|
| 225 | 225 | |
| 226 | - /** |
|
| 226 | +/** |
|
| 227 | 227 | * Make a piece of data available for all views |
| 228 | 228 | * |
| 229 | 229 | * @param string $sName The data name |
@@ -231,29 +231,29 @@ discard block |
||
| 231 | 231 | * |
| 232 | 232 | * @return ViewRenderer |
| 233 | 233 | */ |
| 234 | - public function share(string $sName, $xValue): ViewRenderer |
|
| 235 | - { |
|
| 236 | - $this->aViewData[$sName] = $xValue; |
|
| 237 | - return $this; |
|
| 238 | - } |
|
| 234 | +public function share(string $sName, $xValue): ViewRenderer |
|
| 235 | +{ |
|
| 236 | +$this->aViewData[$sName] = $xValue; |
|
| 237 | +return $this; |
|
| 238 | +} |
|
| 239 | 239 | |
| 240 | - /** |
|
| 240 | +/** |
|
| 241 | 241 | * Make an array of data available for all views |
| 242 | 242 | * |
| 243 | 243 | * @param array $aValues The data values |
| 244 | 244 | * |
| 245 | 245 | * @return ViewRenderer |
| 246 | 246 | */ |
| 247 | - public function shareValues(array $aValues): ViewRenderer |
|
| 248 | - { |
|
| 249 | - foreach($aValues as $sName => $xValue) |
|
| 250 | - { |
|
| 251 | - $this->share($sName, $xValue); |
|
| 252 | - } |
|
| 253 | - return $this; |
|
| 254 | - } |
|
| 247 | +public function shareValues(array $aValues): ViewRenderer |
|
| 248 | +{ |
|
| 249 | +foreach($aValues as $sName => $xValue) |
|
| 250 | +{ |
|
| 251 | +$this->share($sName, $xValue); |
|
| 252 | +} |
|
| 253 | +return $this; |
|
| 254 | +} |
|
| 255 | 255 | |
| 256 | - /** |
|
| 256 | +/** |
|
| 257 | 257 | * Render a view using a store |
| 258 | 258 | * |
| 259 | 259 | * The store returned by this function will later be used with the make() method to render the view. |
@@ -263,32 +263,32 @@ discard block |
||
| 263 | 263 | * |
| 264 | 264 | * @return Store A store populated with the view data |
| 265 | 265 | */ |
| 266 | - public function render(string $sViewName, array $aViewData = []): Store |
|
| 267 | - { |
|
| 268 | - $xStore = $this->store(); |
|
| 269 | - // Get the default view namespace |
|
| 270 | - $sNamespace = $this->sDefaultNamespace; |
|
| 271 | - // Get the namespace from the view name |
|
| 272 | - $nSeparatorPosition = strrpos($sViewName, '::'); |
|
| 273 | - if($nSeparatorPosition !== false) |
|
| 274 | - { |
|
| 275 | - $sNamespace = substr($sViewName, 0, $nSeparatorPosition); |
|
| 276 | - $sViewName = substr($sViewName, $nSeparatorPosition + 2); |
|
| 277 | - } |
|
| 266 | +public function render(string $sViewName, array $aViewData = []): Store |
|
| 267 | +{ |
|
| 268 | +$xStore = $this->store(); |
|
| 269 | +// Get the default view namespace |
|
| 270 | +$sNamespace = $this->sDefaultNamespace; |
|
| 271 | +// Get the namespace from the view name |
|
| 272 | +$nSeparatorPosition = strrpos($sViewName, '::'); |
|
| 273 | +if($nSeparatorPosition !== false) |
|
| 274 | +{ |
|
| 275 | +$sNamespace = substr($sViewName, 0, $nSeparatorPosition); |
|
| 276 | +$sViewName = substr($sViewName, $nSeparatorPosition + 2); |
|
| 277 | +} |
|
| 278 | 278 | |
| 279 | - $xRenderer = $this->getNamespaceRenderer($sNamespace); |
|
| 280 | - if(!$xRenderer) |
|
| 281 | - { |
|
| 282 | - // Cannot render a view if there's no renderer corresponding to the namespace. |
|
| 283 | - return $this->xEmptyStore; |
|
| 284 | - } |
|
| 279 | +$xRenderer = $this->getNamespaceRenderer($sNamespace); |
|
| 280 | +if(!$xRenderer) |
|
| 281 | +{ |
|
| 282 | +// Cannot render a view if there's no renderer corresponding to the namespace. |
|
| 283 | +return $this->xEmptyStore; |
|
| 284 | +} |
|
| 285 | 285 | |
| 286 | - $xStore->setData(array_merge($this->aViewData, $aViewData)) |
|
| 287 | - ->setView($xRenderer, $sNamespace, $sViewName); |
|
| 286 | +$xStore->setData(array_merge($this->aViewData, $aViewData)) |
|
| 287 | +->setView($xRenderer, $sNamespace, $sViewName); |
|
| 288 | 288 | |
| 289 | - // Set the store to null so a new store will be created for the next view. |
|
| 290 | - $this->xStore = null; |
|
| 291 | - // Return the store |
|
| 292 | - return $xStore; |
|
| 293 | - } |
|
| 289 | +// Set the store to null so a new store will be created for the next view. |
|
| 290 | +$this->xStore = null; |
|
| 291 | +// Return the store |
|
| 292 | +return $xStore; |
|
| 293 | +} |
|
| 294 | 294 | } |
@@ -22,213 +22,213 @@ |
||
| 22 | 22 | |
| 23 | 23 | class Metadata |
| 24 | 24 | { |
| 25 | - /** |
|
| 25 | +/** |
|
| 26 | 26 | * @var array<string, array<string, Data\AbstractData>> |
| 27 | 27 | */ |
| 28 | - private array $aAttributes = [ |
|
| 29 | - 'exclude' => [], |
|
| 30 | - 'export' => [], |
|
| 31 | - 'container' => [], |
|
| 32 | - 'databag' => [], |
|
| 33 | - 'callback' => [], |
|
| 34 | - 'before' => [], |
|
| 35 | - 'after' => [], |
|
| 36 | - 'upload' => [], |
|
| 37 | - ]; |
|
| 38 | - |
|
| 39 | - /** |
|
| 28 | +private array $aAttributes = [ |
|
| 29 | +'exclude' => [], |
|
| 30 | +'export' => [], |
|
| 31 | +'container' => [], |
|
| 32 | +'databag' => [], |
|
| 33 | +'callback' => [], |
|
| 34 | +'before' => [], |
|
| 35 | +'after' => [], |
|
| 36 | +'upload' => [], |
|
| 37 | +]; |
|
| 38 | + |
|
| 39 | +/** |
|
| 40 | 40 | * @return array<string, array<string, Data\AbstractData>> |
| 41 | 41 | */ |
| 42 | - public function getAttributes(): array |
|
| 43 | - { |
|
| 44 | - return $this->aAttributes; |
|
| 45 | - } |
|
| 42 | +public function getAttributes(): array |
|
| 43 | +{ |
|
| 44 | +return $this->aAttributes; |
|
| 45 | +} |
|
| 46 | 46 | |
| 47 | - /** |
|
| 47 | +/** |
|
| 48 | 48 | * @param string $sMethod |
| 49 | 49 | * |
| 50 | 50 | * @return Data\ExcludeData |
| 51 | 51 | */ |
| 52 | - public function exclude(string $sMethod = '*'): Data\ExcludeData |
|
| 53 | - { |
|
| 54 | - return $this->aAttributes['exclude'][$sMethod] ?? |
|
| 55 | - $this->aAttributes['exclude'][$sMethod] = new Data\ExcludeData(); |
|
| 56 | - } |
|
| 52 | +public function exclude(string $sMethod = '*'): Data\ExcludeData |
|
| 53 | +{ |
|
| 54 | +return $this->aAttributes['exclude'][$sMethod] ?? |
|
| 55 | +$this->aAttributes['exclude'][$sMethod] = new Data\ExcludeData(); |
|
| 56 | +} |
|
| 57 | 57 | |
| 58 | - /** |
|
| 58 | +/** |
|
| 59 | 59 | * @param string $sMethod |
| 60 | 60 | * |
| 61 | 61 | * @return Data\ExportData |
| 62 | 62 | */ |
| 63 | - public function export(string $sMethod = '*'): Data\ExportData |
|
| 64 | - { |
|
| 65 | - $sMethod = '*'; // On classes only |
|
| 66 | - return $this->aAttributes['export'][$sMethod] ?? |
|
| 67 | - $this->aAttributes['export'][$sMethod] = new Data\ExportData(); |
|
| 68 | - } |
|
| 63 | +public function export(string $sMethod = '*'): Data\ExportData |
|
| 64 | +{ |
|
| 65 | +$sMethod = '*'; // On classes only |
|
| 66 | +return $this->aAttributes['export'][$sMethod] ?? |
|
| 67 | +$this->aAttributes['export'][$sMethod] = new Data\ExportData(); |
|
| 68 | +} |
|
| 69 | 69 | |
| 70 | - /** |
|
| 70 | +/** |
|
| 71 | 71 | * @param string $sMethod |
| 72 | 72 | * |
| 73 | 73 | * @return Data\ContainerData |
| 74 | 74 | */ |
| 75 | - public function container(string $sMethod = '*'): Data\ContainerData |
|
| 76 | - { |
|
| 77 | - return $this->aAttributes['container'][$sMethod] ?? |
|
| 78 | - $this->aAttributes['container'][$sMethod] = new Data\ContainerData(); |
|
| 79 | - } |
|
| 75 | +public function container(string $sMethod = '*'): Data\ContainerData |
|
| 76 | +{ |
|
| 77 | +return $this->aAttributes['container'][$sMethod] ?? |
|
| 78 | +$this->aAttributes['container'][$sMethod] = new Data\ContainerData(); |
|
| 79 | +} |
|
| 80 | 80 | |
| 81 | - /** |
|
| 81 | +/** |
|
| 82 | 82 | * @param string $sMethod |
| 83 | 83 | * |
| 84 | 84 | * @return Data\DatabagData |
| 85 | 85 | */ |
| 86 | - public function databag(string $sMethod = '*'): Data\DatabagData |
|
| 87 | - { |
|
| 88 | - return $this->aAttributes['databag'][$sMethod] ?? |
|
| 89 | - $this->aAttributes['databag'][$sMethod] = new Data\DatabagData(); |
|
| 90 | - } |
|
| 86 | +public function databag(string $sMethod = '*'): Data\DatabagData |
|
| 87 | +{ |
|
| 88 | +return $this->aAttributes['databag'][$sMethod] ?? |
|
| 89 | +$this->aAttributes['databag'][$sMethod] = new Data\DatabagData(); |
|
| 90 | +} |
|
| 91 | 91 | |
| 92 | - /** |
|
| 92 | +/** |
|
| 93 | 93 | * @param string $sMethod |
| 94 | 94 | * |
| 95 | 95 | * @return Data\CallbackData |
| 96 | 96 | */ |
| 97 | - public function callback(string $sMethod = '*'): Data\CallbackData |
|
| 98 | - { |
|
| 99 | - return $this->aAttributes['callback'][$sMethod] ?? |
|
| 100 | - $this->aAttributes['callback'][$sMethod] = new Data\CallbackData(); |
|
| 101 | - } |
|
| 97 | +public function callback(string $sMethod = '*'): Data\CallbackData |
|
| 98 | +{ |
|
| 99 | +return $this->aAttributes['callback'][$sMethod] ?? |
|
| 100 | +$this->aAttributes['callback'][$sMethod] = new Data\CallbackData(); |
|
| 101 | +} |
|
| 102 | 102 | |
| 103 | - /** |
|
| 103 | +/** |
|
| 104 | 104 | * @param string $sMethod |
| 105 | 105 | * |
| 106 | 106 | * @return Data\BeforeData |
| 107 | 107 | */ |
| 108 | - public function before(string $sMethod = '*'): Data\BeforeData |
|
| 109 | - { |
|
| 110 | - return $this->aAttributes['before'][$sMethod] ?? |
|
| 111 | - $this->aAttributes['before'][$sMethod] = new Data\BeforeData(); |
|
| 112 | - } |
|
| 108 | +public function before(string $sMethod = '*'): Data\BeforeData |
|
| 109 | +{ |
|
| 110 | +return $this->aAttributes['before'][$sMethod] ?? |
|
| 111 | +$this->aAttributes['before'][$sMethod] = new Data\BeforeData(); |
|
| 112 | +} |
|
| 113 | 113 | |
| 114 | - /** |
|
| 114 | +/** |
|
| 115 | 115 | * @param string $sMethod |
| 116 | 116 | * |
| 117 | 117 | * @return Data\AfterData |
| 118 | 118 | */ |
| 119 | - public function after(string $sMethod = '*'): Data\AfterData |
|
| 120 | - { |
|
| 121 | - return $this->aAttributes['after'][$sMethod] ?? |
|
| 122 | - $this->aAttributes['after'][$sMethod] = new Data\AfterData(); |
|
| 123 | - } |
|
| 119 | +public function after(string $sMethod = '*'): Data\AfterData |
|
| 120 | +{ |
|
| 121 | +return $this->aAttributes['after'][$sMethod] ?? |
|
| 122 | +$this->aAttributes['after'][$sMethod] = new Data\AfterData(); |
|
| 123 | +} |
|
| 124 | 124 | |
| 125 | - /** |
|
| 125 | +/** |
|
| 126 | 126 | * @param string $sMethod |
| 127 | 127 | * |
| 128 | 128 | * @return Data\UploadData |
| 129 | 129 | */ |
| 130 | - public function upload(string $sMethod = '*'): Data\UploadData |
|
| 131 | - { |
|
| 132 | - return $this->aAttributes['upload'][$sMethod] ?? |
|
| 133 | - $this->aAttributes['upload'][$sMethod] = new Data\UploadData(); |
|
| 134 | - } |
|
| 130 | +public function upload(string $sMethod = '*'): Data\UploadData |
|
| 131 | +{ |
|
| 132 | +return $this->aAttributes['upload'][$sMethod] ?? |
|
| 133 | +$this->aAttributes['upload'][$sMethod] = new Data\UploadData(); |
|
| 134 | +} |
|
| 135 | 135 | |
| 136 | - /** |
|
| 136 | +/** |
|
| 137 | 137 | * True if the class is excluded |
| 138 | 138 | * |
| 139 | 139 | * @return bool |
| 140 | 140 | */ |
| 141 | - public function isExcluded(): bool |
|
| 142 | - { |
|
| 143 | - $xData = $this->aAttributes['exclude']['*'] ?? null; |
|
| 144 | - return $xData !== null && $xData->getValue() === true; |
|
| 145 | - } |
|
| 141 | +public function isExcluded(): bool |
|
| 142 | +{ |
|
| 143 | +$xData = $this->aAttributes['exclude']['*'] ?? null; |
|
| 144 | +return $xData !== null && $xData->getValue() === true; |
|
| 145 | +} |
|
| 146 | 146 | |
| 147 | - /** |
|
| 147 | +/** |
|
| 148 | 148 | * Get the properties of the class methods |
| 149 | 149 | * |
| 150 | 150 | * @return array |
| 151 | 151 | */ |
| 152 | - public function getProperties(): array |
|
| 152 | +public function getProperties(): array |
|
| 153 | +{ |
|
| 154 | +$aProperties = []; |
|
| 155 | +$aClassProperties = []; |
|
| 156 | +foreach($this->aAttributes as $sType => $aValues) |
|
| 157 | +{ |
|
| 158 | +if($sType === 'exclude') |
|
| 159 | +{ |
|
| 160 | + continue; |
|
| 161 | +} |
|
| 162 | + |
|
| 163 | +foreach($aValues as $sMethod => $xData) |
|
| 164 | +{ |
|
| 165 | + if($sMethod === '*') |
|
| 153 | 166 | { |
| 154 | - $aProperties = []; |
|
| 155 | - $aClassProperties = []; |
|
| 156 | - foreach($this->aAttributes as $sType => $aValues) |
|
| 157 | - { |
|
| 158 | - if($sType === 'exclude') |
|
| 159 | - { |
|
| 160 | - continue; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - foreach($aValues as $sMethod => $xData) |
|
| 164 | - { |
|
| 165 | - if($sMethod === '*') |
|
| 166 | - { |
|
| 167 | - $aClassProperties[$xData->getName()] = $xData->getValue(); |
|
| 168 | - continue; |
|
| 169 | - } |
|
| 170 | - $aProperties[$sMethod][$xData->getName()] = $xData->getValue(); |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - if(count($aClassProperties) > 0) |
|
| 175 | - { |
|
| 176 | - $aProperties['*'] = $aClassProperties; |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - return $aProperties; |
|
| 167 | + $aClassProperties[$xData->getName()] = $xData->getValue(); |
|
| 168 | + continue; |
|
| 180 | 169 | } |
| 170 | + $aProperties[$sMethod][$xData->getName()] = $xData->getValue(); |
|
| 171 | +} |
|
| 172 | +} |
|
| 181 | 173 | |
| 182 | - /** |
|
| 174 | +if(count($aClassProperties) > 0) |
|
| 175 | +{ |
|
| 176 | +$aProperties['*'] = $aClassProperties; |
|
| 177 | +} |
|
| 178 | + |
|
| 179 | +return $aProperties; |
|
| 180 | +} |
|
| 181 | + |
|
| 182 | +/** |
|
| 183 | 183 | * Get the methods in the export attributes |
| 184 | 184 | * |
| 185 | 185 | * @return array |
| 186 | 186 | */ |
| 187 | - public function getExportMethods(): array |
|
| 188 | - { |
|
| 189 | - /** @var array<Data\ExcludeData> */ |
|
| 190 | - $aAttributes = $this->aAttributes['exclude']; |
|
| 191 | - $aExcludeMethods = array_keys($aAttributes); |
|
| 192 | - $aExcludeMethods = array_values(array_filter($aExcludeMethods, |
|
| 193 | - fn(string $sName) => $sName !== '*' && |
|
| 194 | - $aAttributes[$sName]->getValue() === true)); |
|
| 195 | - |
|
| 196 | - /** @var Data\ExportData|null */ |
|
| 197 | - $xExportData = $this->aAttributes['export']['*'] ?? null; |
|
| 198 | - $aExportMethods = $xExportData?->getValue() ?? []; |
|
| 199 | - |
|
| 200 | - $aExceptMethods = $aExportMethods['except'] ?? []; |
|
| 201 | - $aExportMethods['except'] = array_merge($aExcludeMethods, $aExceptMethods); |
|
| 202 | - return $aExportMethods; |
|
| 203 | - } |
|
| 187 | +public function getExportMethods(): array |
|
| 188 | +{ |
|
| 189 | +/** @var array<Data\ExcludeData> */ |
|
| 190 | +$aAttributes = $this->aAttributes['exclude']; |
|
| 191 | +$aExcludeMethods = array_keys($aAttributes); |
|
| 192 | +$aExcludeMethods = array_values(array_filter($aExcludeMethods, |
|
| 193 | +fn(string $sName) => $sName !== '*' && |
|
| 194 | + $aAttributes[$sName]->getValue() === true)); |
|
| 195 | + |
|
| 196 | +/** @var Data\ExportData|null */ |
|
| 197 | +$xExportData = $this->aAttributes['export']['*'] ?? null; |
|
| 198 | +$aExportMethods = $xExportData?->getValue() ?? []; |
|
| 199 | + |
|
| 200 | +$aExceptMethods = $aExportMethods['except'] ?? []; |
|
| 201 | +$aExportMethods['except'] = array_merge($aExcludeMethods, $aExceptMethods); |
|
| 202 | +return $aExportMethods; |
|
| 203 | +} |
|
| 204 | 204 | |
| 205 | - /** |
|
| 205 | +/** |
|
| 206 | 206 | * Get the exluded methods |
| 207 | 207 | * |
| 208 | 208 | * @return array |
| 209 | 209 | */ |
| 210 | - public function getExceptMethods(): array |
|
| 211 | - { |
|
| 212 | - return $this->getExportMethods()['except']; |
|
| 213 | - } |
|
| 210 | +public function getExceptMethods(): array |
|
| 211 | +{ |
|
| 212 | +return $this->getExportMethods()['except']; |
|
| 213 | +} |
|
| 214 | 214 | |
| 215 | - /** |
|
| 215 | +/** |
|
| 216 | 216 | * Get the export base methods |
| 217 | 217 | * |
| 218 | 218 | * @return array |
| 219 | 219 | */ |
| 220 | - public function getExportBaseMethods(): array |
|
| 221 | - { |
|
| 222 | - return $this->getExportMethods()['base'] ?? []; |
|
| 223 | - } |
|
| 220 | +public function getExportBaseMethods(): array |
|
| 221 | +{ |
|
| 222 | +return $this->getExportMethods()['base'] ?? []; |
|
| 223 | +} |
|
| 224 | 224 | |
| 225 | - /** |
|
| 225 | +/** |
|
| 226 | 226 | * Get the export only methods |
| 227 | 227 | * |
| 228 | 228 | * @return array |
| 229 | 229 | */ |
| 230 | - public function getExportOnlyMethods(): array |
|
| 231 | - { |
|
| 232 | - return $this->getExportMethods()['only'] ?? []; |
|
| 233 | - } |
|
| 230 | +public function getExportOnlyMethods(): array |
|
| 231 | +{ |
|
| 232 | +return $this->getExportMethods()['only'] ?? []; |
|
| 233 | +} |
|
| 234 | 234 | } |
@@ -22,61 +22,61 @@ |
||
| 22 | 22 | |
| 23 | 23 | class DatabagData extends AbstractData |
| 24 | 24 | { |
| 25 | - /** |
|
| 25 | +/** |
|
| 26 | 26 | * The databag names |
| 27 | 27 | * |
| 28 | 28 | * @var array |
| 29 | 29 | */ |
| 30 | - protected $aNames = []; |
|
| 30 | +protected $aNames = []; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 32 | +/** |
|
| 33 | 33 | * @return string |
| 34 | 34 | */ |
| 35 | - public function getName(): string |
|
| 36 | - { |
|
| 37 | - return 'bags'; |
|
| 38 | - } |
|
| 35 | +public function getName(): string |
|
| 36 | +{ |
|
| 37 | +return 'bags'; |
|
| 38 | +} |
|
| 39 | 39 | |
| 40 | - /** |
|
| 40 | +/** |
|
| 41 | 41 | * @return mixed |
| 42 | 42 | */ |
| 43 | - public function getValue(): mixed |
|
| 44 | - { |
|
| 45 | - return array_values($this->aNames); |
|
| 46 | - } |
|
| 43 | +public function getValue(): mixed |
|
| 44 | +{ |
|
| 45 | +return array_values($this->aNames); |
|
| 46 | +} |
|
| 47 | 47 | |
| 48 | - /** |
|
| 48 | +/** |
|
| 49 | 49 | * @param string $sName |
| 50 | 50 | * |
| 51 | 51 | * @return void |
| 52 | 52 | */ |
| 53 | - protected function validateName(string $sName): void |
|
| 54 | - { |
|
| 55 | - if(preg_match('/^[a-zA-Z][a-zA-Z0-9_\-\.]*$/', $sName) > 0) |
|
| 56 | - { |
|
| 57 | - return; |
|
| 58 | - } |
|
| 59 | - throw new SetupException("$sName is not a valid \"name\" value for databag"); |
|
| 60 | - } |
|
| 53 | +protected function validateName(string $sName): void |
|
| 54 | +{ |
|
| 55 | +if(preg_match('/^[a-zA-Z][a-zA-Z0-9_\-\.]*$/', $sName) > 0) |
|
| 56 | +{ |
|
| 57 | +return; |
|
| 58 | +} |
|
| 59 | +throw new SetupException("$sName is not a valid \"name\" value for databag"); |
|
| 60 | +} |
|
| 61 | 61 | |
| 62 | - /** |
|
| 62 | +/** |
|
| 63 | 63 | * @param string $sName |
| 64 | 64 | * |
| 65 | 65 | * @return void |
| 66 | 66 | */ |
| 67 | - public function addValue(string $sName): void |
|
| 68 | - { |
|
| 69 | - $this->validateName($sName); |
|
| 67 | +public function addValue(string $sName): void |
|
| 68 | +{ |
|
| 69 | +$this->validateName($sName); |
|
| 70 | 70 | |
| 71 | - $this->aNames[$sName] = $sName; |
|
| 72 | - } |
|
| 71 | +$this->aNames[$sName] = $sName; |
|
| 72 | +} |
|
| 73 | 73 | |
| 74 | - /** |
|
| 74 | +/** |
|
| 75 | 75 | * @inheritDoc |
| 76 | 76 | */ |
| 77 | - public function encode(string $sVarName): array |
|
| 78 | - { |
|
| 79 | - return array_map(fn($sName) => |
|
| 80 | - "{$sVarName}->addValue('$sName');", $this->aNames); |
|
| 81 | - } |
|
| 77 | +public function encode(string $sVarName): array |
|
| 78 | +{ |
|
| 79 | +return array_map(fn($sName) => |
|
| 80 | +"{$sVarName}->addValue('$sName');", $this->aNames); |
|
| 81 | +} |
|
| 82 | 82 | } |
@@ -22,61 +22,61 @@ |
||
| 22 | 22 | |
| 23 | 23 | class CallbackData extends AbstractData |
| 24 | 24 | { |
| 25 | - /** |
|
| 25 | +/** |
|
| 26 | 26 | * The callback js objects |
| 27 | 27 | * |
| 28 | 28 | * @var array |
| 29 | 29 | */ |
| 30 | - protected $aNames = []; |
|
| 30 | +protected $aNames = []; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 32 | +/** |
|
| 33 | 33 | * @return string |
| 34 | 34 | */ |
| 35 | - public function getName(): string |
|
| 36 | - { |
|
| 37 | - return 'callback'; |
|
| 38 | - } |
|
| 35 | +public function getName(): string |
|
| 36 | +{ |
|
| 37 | +return 'callback'; |
|
| 38 | +} |
|
| 39 | 39 | |
| 40 | - /** |
|
| 40 | +/** |
|
| 41 | 41 | * @return mixed |
| 42 | 42 | */ |
| 43 | - public function getValue(): mixed |
|
| 44 | - { |
|
| 45 | - return array_values($this->aNames); |
|
| 46 | - } |
|
| 43 | +public function getValue(): mixed |
|
| 44 | +{ |
|
| 45 | +return array_values($this->aNames); |
|
| 46 | +} |
|
| 47 | 47 | |
| 48 | - /** |
|
| 48 | +/** |
|
| 49 | 49 | * @param string $sName |
| 50 | 50 | * |
| 51 | 51 | * @return void |
| 52 | 52 | */ |
| 53 | - protected function validateObjectName(string $sName): void |
|
| 54 | - { |
|
| 55 | - if(preg_match('/^[a-zA-Z][a-zA-Z0-9_\-\.]*$/', $sName) > 0) |
|
| 56 | - { |
|
| 57 | - return; |
|
| 58 | - } |
|
| 59 | - throw new SetupException("$sName is not a valid \"name\" value for callback"); |
|
| 60 | - } |
|
| 53 | +protected function validateObjectName(string $sName): void |
|
| 54 | +{ |
|
| 55 | +if(preg_match('/^[a-zA-Z][a-zA-Z0-9_\-\.]*$/', $sName) > 0) |
|
| 56 | +{ |
|
| 57 | +return; |
|
| 58 | +} |
|
| 59 | +throw new SetupException("$sName is not a valid \"name\" value for callback"); |
|
| 60 | +} |
|
| 61 | 61 | |
| 62 | - /** |
|
| 62 | +/** |
|
| 63 | 63 | * @param string $sName |
| 64 | 64 | * |
| 65 | 65 | * @return void |
| 66 | 66 | */ |
| 67 | - public function addValue(string $sName): void |
|
| 68 | - { |
|
| 69 | - $this->validateObjectName($sName); |
|
| 67 | +public function addValue(string $sName): void |
|
| 68 | +{ |
|
| 69 | +$this->validateObjectName($sName); |
|
| 70 | 70 | |
| 71 | - $this->aNames[$sName] = $sName; |
|
| 72 | - } |
|
| 71 | +$this->aNames[$sName] = $sName; |
|
| 72 | +} |
|
| 73 | 73 | |
| 74 | - /** |
|
| 74 | +/** |
|
| 75 | 75 | * @inheritDoc |
| 76 | 76 | */ |
| 77 | - public function encode(string $sVarName): array |
|
| 78 | - { |
|
| 79 | - return array_map(fn($sName) => |
|
| 80 | - "{$sVarName}->addValue('$sName');", $this->aNames); |
|
| 81 | - } |
|
| 77 | +public function encode(string $sVarName): array |
|
| 78 | +{ |
|
| 79 | +return array_map(fn($sName) => |
|
| 80 | +"{$sVarName}->addValue('$sName');", $this->aNames); |
|
| 81 | +} |
|
| 82 | 82 | } |