@@ -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 |
| 16 | 16 | */ |
| 17 | - protected $xRenderer; |
|
| 17 | +protected $xRenderer; |
|
| 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 | } |
@@ -16,58 +16,58 @@ discard block |
||
| 16 | 16 | |
| 17 | 17 | class ViewRenderer |
| 18 | 18 | { |
| 19 | - /** |
|
| 19 | +/** |
|
| 20 | 20 | * @var Container |
| 21 | 21 | */ |
| 22 | - protected $di; |
|
| 22 | +protected $di; |
|
| 23 | 23 | |
| 24 | - /** |
|
| 24 | +/** |
|
| 25 | 25 | * The view data store |
| 26 | 26 | * |
| 27 | 27 | * @var Store |
| 28 | 28 | */ |
| 29 | - protected $xStore = null; |
|
| 29 | +protected $xStore = null; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 31 | +/** |
|
| 32 | 32 | * The view data store |
| 33 | 33 | * |
| 34 | 34 | * @var Store |
| 35 | 35 | */ |
| 36 | - protected $xEmptyStore = null; |
|
| 36 | +protected $xEmptyStore = null; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 38 | +/** |
|
| 39 | 39 | * The view namespaces |
| 40 | 40 | * |
| 41 | 41 | * @var array |
| 42 | 42 | */ |
| 43 | - protected $aNamespaces = []; |
|
| 43 | +protected $aNamespaces = []; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 45 | +/** |
|
| 46 | 46 | * The default namespace |
| 47 | 47 | * |
| 48 | 48 | * @var string |
| 49 | 49 | */ |
| 50 | - protected $sDefaultNamespace = 'jaxon'; |
|
| 50 | +protected $sDefaultNamespace = 'jaxon'; |
|
| 51 | 51 | |
| 52 | - /** |
|
| 52 | +/** |
|
| 53 | 53 | * The view global data |
| 54 | 54 | * |
| 55 | 55 | * @var array |
| 56 | 56 | */ |
| 57 | - protected $aViewData = []; |
|
| 57 | +protected $aViewData = []; |
|
| 58 | 58 | |
| 59 | - /** |
|
| 59 | +/** |
|
| 60 | 60 | * The class constructor |
| 61 | 61 | * |
| 62 | 62 | * @param Container $di |
| 63 | 63 | */ |
| 64 | - public function __construct(Container $di) |
|
| 65 | - { |
|
| 66 | - $this->di = $di; |
|
| 67 | - $this->xEmptyStore = new Store(); |
|
| 68 | - } |
|
| 64 | +public function __construct(Container $di) |
|
| 65 | +{ |
|
| 66 | +$this->di = $di; |
|
| 67 | +$this->xEmptyStore = new Store(); |
|
| 68 | +} |
|
| 69 | 69 | |
| 70 | - /** |
|
| 70 | +/** |
|
| 71 | 71 | * Add a view namespace, and set the corresponding renderer. |
| 72 | 72 | * |
| 73 | 73 | * @param string $sNamespace The namespace name |
@@ -77,59 +77,59 @@ discard block |
||
| 77 | 77 | * |
| 78 | 78 | * @return void |
| 79 | 79 | */ |
| 80 | - public function addNamespace(string $sNamespace, string $sDirectory, |
|
| 81 | - string $sExtension, string $sRenderer): void |
|
| 82 | - { |
|
| 83 | - $aNamespace = [ |
|
| 84 | - 'directory' => $sDirectory, |
|
| 85 | - 'extension' => $sExtension, |
|
| 86 | - 'renderer' => $sRenderer, |
|
| 87 | - ]; |
|
| 88 | - $this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 89 | - } |
|
| 80 | +public function addNamespace(string $sNamespace, string $sDirectory, |
|
| 81 | +string $sExtension, string $sRenderer): void |
|
| 82 | +{ |
|
| 83 | +$aNamespace = [ |
|
| 84 | +'directory' => $sDirectory, |
|
| 85 | +'extension' => $sExtension, |
|
| 86 | +'renderer' => $sRenderer, |
|
| 87 | +]; |
|
| 88 | +$this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 89 | +} |
|
| 90 | 90 | |
| 91 | - /** |
|
| 91 | +/** |
|
| 92 | 92 | * Set the view namespaces. |
| 93 | 93 | * |
| 94 | 94 | * @param Config $xAppConfig The config options provided in the library |
| 95 | 95 | * |
| 96 | 96 | * @return void |
| 97 | 97 | */ |
| 98 | - public function addNamespaces(Config $xAppConfig): void |
|
| 99 | - { |
|
| 100 | - if(empty($aNamespaces = $xAppConfig->getOptionNames('views'))) |
|
| 101 | - { |
|
| 102 | - return; |
|
| 103 | - } |
|
| 98 | +public function addNamespaces(Config $xAppConfig): void |
|
| 99 | +{ |
|
| 100 | +if(empty($aNamespaces = $xAppConfig->getOptionNames('views'))) |
|
| 101 | +{ |
|
| 102 | +return; |
|
| 103 | +} |
|
| 104 | 104 | |
| 105 | - $sPackage = $xAppConfig->getOption('package', ''); |
|
| 106 | - foreach($aNamespaces as $sNamespace => $sOption) |
|
| 107 | - { |
|
| 108 | - // Save the namespace |
|
| 109 | - $aNamespace = $xAppConfig->getOption($sOption); |
|
| 110 | - $aNamespace['package'] = $sPackage; |
|
| 111 | - if(!isset($aNamespace['renderer'])) |
|
| 112 | - { |
|
| 113 | - $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer. |
|
| 114 | - } |
|
| 115 | - $this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 116 | - } |
|
| 117 | - } |
|
| 105 | +$sPackage = $xAppConfig->getOption('package', ''); |
|
| 106 | +foreach($aNamespaces as $sNamespace => $sOption) |
|
| 107 | +{ |
|
| 108 | +// Save the namespace |
|
| 109 | +$aNamespace = $xAppConfig->getOption($sOption); |
|
| 110 | +$aNamespace['package'] = $sPackage; |
|
| 111 | +if(!isset($aNamespace['renderer'])) |
|
| 112 | +{ |
|
| 113 | + $aNamespace['renderer'] = 'jaxon'; // 'jaxon' is the default renderer. |
|
| 114 | +} |
|
| 115 | +$this->aNamespaces[$sNamespace] = $aNamespace; |
|
| 116 | +} |
|
| 117 | +} |
|
| 118 | 118 | |
| 119 | - /** |
|
| 119 | +/** |
|
| 120 | 120 | * Get the view renderer |
| 121 | 121 | * |
| 122 | 122 | * @param string $sId The unique identifier of the view renderer |
| 123 | 123 | * |
| 124 | 124 | * @return ViewInterface |
| 125 | 125 | */ |
| 126 | - public function getRenderer(string $sId): ViewInterface |
|
| 127 | - { |
|
| 128 | - // Return the view renderer with the given id |
|
| 129 | - return $this->di->g("jaxon.app.view.$sId"); |
|
| 130 | - } |
|
| 126 | +public function getRenderer(string $sId): ViewInterface |
|
| 127 | +{ |
|
| 128 | +// Return the view renderer with the given id |
|
| 129 | +return $this->di->g("jaxon.app.view.$sId"); |
|
| 130 | +} |
|
| 131 | 131 | |
| 132 | - /** |
|
| 132 | +/** |
|
| 133 | 133 | * Add a view renderer with an id |
| 134 | 134 | * |
| 135 | 135 | * @param string $sId The unique identifier of the view renderer |
@@ -137,25 +137,25 @@ discard block |
||
| 137 | 137 | * |
| 138 | 138 | * @return void |
| 139 | 139 | */ |
| 140 | - public function addRenderer(string $sId, Closure $xClosure): void |
|
| 141 | - { |
|
| 142 | - // Return the initialized view renderer |
|
| 143 | - $this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) { |
|
| 144 | - // Get the defined renderer |
|
| 145 | - $xRenderer = $xClosure($di); |
|
| 146 | - // Init the renderer with the template namespaces |
|
| 147 | - $aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) { |
|
| 148 | - return $aOptions['renderer'] === $sId; |
|
| 149 | - }); |
|
| 150 | - foreach($aNamespaces as $sName => $aOptions) |
|
| 151 | - { |
|
| 152 | - $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']); |
|
| 153 | - } |
|
| 154 | - return $xRenderer; |
|
| 155 | - }); |
|
| 156 | - } |
|
| 140 | +public function addRenderer(string $sId, Closure $xClosure): void |
|
| 141 | +{ |
|
| 142 | +// Return the initialized view renderer |
|
| 143 | +$this->di->set("jaxon.app.view.$sId", function($di) use($sId, $xClosure) { |
|
| 144 | +// Get the defined renderer |
|
| 145 | +$xRenderer = $xClosure($di); |
|
| 146 | +// Init the renderer with the template namespaces |
|
| 147 | +$aNamespaces = array_filter($this->aNamespaces, function($aOptions) use($sId) { |
|
| 148 | + return $aOptions['renderer'] === $sId; |
|
| 149 | +}); |
|
| 150 | +foreach($aNamespaces as $sName => $aOptions) |
|
| 151 | +{ |
|
| 152 | + $xRenderer->addNamespace($sName, $aOptions['directory'], $aOptions['extension']); |
|
| 153 | +} |
|
| 154 | +return $xRenderer; |
|
| 155 | +}); |
|
| 156 | +} |
|
| 157 | 157 | |
| 158 | - /** |
|
| 158 | +/** |
|
| 159 | 159 | * Add a view renderer with an id |
| 160 | 160 | * |
| 161 | 161 | * @param string $sId The unique identifier of the view renderer |
@@ -164,55 +164,55 @@ discard block |
||
| 164 | 164 | * |
| 165 | 165 | * @return void |
| 166 | 166 | */ |
| 167 | - public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void |
|
| 168 | - { |
|
| 169 | - $this->setDefaultNamespace($sId); |
|
| 170 | - $this->addNamespace($sId, '', $sExtension, $sId); |
|
| 171 | - $this->addRenderer($sId, $xClosure); |
|
| 172 | - } |
|
| 167 | +public function setDefaultRenderer(string $sId, string $sExtension, Closure $xClosure): void |
|
| 168 | +{ |
|
| 169 | +$this->setDefaultNamespace($sId); |
|
| 170 | +$this->addNamespace($sId, '', $sExtension, $sId); |
|
| 171 | +$this->addRenderer($sId, $xClosure); |
|
| 172 | +} |
|
| 173 | 173 | |
| 174 | - /** |
|
| 174 | +/** |
|
| 175 | 175 | * Get the view renderer for a given namespace |
| 176 | 176 | * |
| 177 | 177 | * @param string $sNamespace The namespace name |
| 178 | 178 | * |
| 179 | 179 | * @return ViewInterface|null |
| 180 | 180 | */ |
| 181 | - public function getNamespaceRenderer(string $sNamespace): ?ViewInterface |
|
| 182 | - { |
|
| 183 | - if(!isset($this->aNamespaces[$sNamespace])) |
|
| 184 | - { |
|
| 185 | - return null; |
|
| 186 | - } |
|
| 187 | - // Return the view renderer with the configured id |
|
| 188 | - return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']); |
|
| 189 | - } |
|
| 181 | +public function getNamespaceRenderer(string $sNamespace): ?ViewInterface |
|
| 182 | +{ |
|
| 183 | +if(!isset($this->aNamespaces[$sNamespace])) |
|
| 184 | +{ |
|
| 185 | +return null; |
|
| 186 | +} |
|
| 187 | +// Return the view renderer with the configured id |
|
| 188 | +return $this->getRenderer($this->aNamespaces[$sNamespace]['renderer']); |
|
| 189 | +} |
|
| 190 | 190 | |
| 191 | - /** |
|
| 191 | +/** |
|
| 192 | 192 | * Set the default namespace |
| 193 | 193 | * |
| 194 | 194 | * @param string $sDefaultNamespace |
| 195 | 195 | */ |
| 196 | - public function setDefaultNamespace(string $sDefaultNamespace): void |
|
| 197 | - { |
|
| 198 | - $this->sDefaultNamespace = $sDefaultNamespace; |
|
| 199 | - } |
|
| 196 | +public function setDefaultNamespace(string $sDefaultNamespace): void |
|
| 197 | +{ |
|
| 198 | +$this->sDefaultNamespace = $sDefaultNamespace; |
|
| 199 | +} |
|
| 200 | 200 | |
| 201 | - /** |
|
| 201 | +/** |
|
| 202 | 202 | * Get the current store or create a new store |
| 203 | 203 | * |
| 204 | 204 | * @return Store |
| 205 | 205 | */ |
| 206 | - protected function store(): Store |
|
| 207 | - { |
|
| 208 | - if(!$this->xStore) |
|
| 209 | - { |
|
| 210 | - $this->xStore = new Store(); |
|
| 211 | - } |
|
| 212 | - return $this->xStore; |
|
| 213 | - } |
|
| 206 | +protected function store(): Store |
|
| 207 | +{ |
|
| 208 | +if(!$this->xStore) |
|
| 209 | +{ |
|
| 210 | +$this->xStore = new Store(); |
|
| 211 | +} |
|
| 212 | +return $this->xStore; |
|
| 213 | +} |
|
| 214 | 214 | |
| 215 | - /** |
|
| 215 | +/** |
|
| 216 | 216 | * Make a piece of data available for the rendered view |
| 217 | 217 | * |
| 218 | 218 | * @param string $sName The data name |
@@ -220,13 +220,13 @@ discard block |
||
| 220 | 220 | * |
| 221 | 221 | * @return ViewRenderer |
| 222 | 222 | */ |
| 223 | - public function set(string $sName, $xValue): ViewRenderer |
|
| 224 | - { |
|
| 225 | - $this->store()->with($sName, $xValue); |
|
| 226 | - return $this; |
|
| 227 | - } |
|
| 223 | +public function set(string $sName, $xValue): ViewRenderer |
|
| 224 | +{ |
|
| 225 | +$this->store()->with($sName, $xValue); |
|
| 226 | +return $this; |
|
| 227 | +} |
|
| 228 | 228 | |
| 229 | - /** |
|
| 229 | +/** |
|
| 230 | 230 | * Make a piece of data available for all views |
| 231 | 231 | * |
| 232 | 232 | * @param string $sName The data name |
@@ -234,29 +234,29 @@ discard block |
||
| 234 | 234 | * |
| 235 | 235 | * @return ViewRenderer |
| 236 | 236 | */ |
| 237 | - public function share(string $sName, $xValue): ViewRenderer |
|
| 238 | - { |
|
| 239 | - $this->aViewData[$sName] = $xValue; |
|
| 240 | - return $this; |
|
| 241 | - } |
|
| 237 | +public function share(string $sName, $xValue): ViewRenderer |
|
| 238 | +{ |
|
| 239 | +$this->aViewData[$sName] = $xValue; |
|
| 240 | +return $this; |
|
| 241 | +} |
|
| 242 | 242 | |
| 243 | - /** |
|
| 243 | +/** |
|
| 244 | 244 | * Make an array of data available for all views |
| 245 | 245 | * |
| 246 | 246 | * @param array $aValues The data values |
| 247 | 247 | * |
| 248 | 248 | * @return ViewRenderer |
| 249 | 249 | */ |
| 250 | - public function shareValues(array $aValues): ViewRenderer |
|
| 251 | - { |
|
| 252 | - foreach($aValues as $sName => $xValue) |
|
| 253 | - { |
|
| 254 | - $this->share($sName, $xValue); |
|
| 255 | - } |
|
| 256 | - return $this; |
|
| 257 | - } |
|
| 250 | +public function shareValues(array $aValues): ViewRenderer |
|
| 251 | +{ |
|
| 252 | +foreach($aValues as $sName => $xValue) |
|
| 253 | +{ |
|
| 254 | +$this->share($sName, $xValue); |
|
| 255 | +} |
|
| 256 | +return $this; |
|
| 257 | +} |
|
| 258 | 258 | |
| 259 | - /** |
|
| 259 | +/** |
|
| 260 | 260 | * Render a view using a store |
| 261 | 261 | * |
| 262 | 262 | * The store returned by this function will later be used with the make() method to render the view. |
@@ -266,32 +266,32 @@ discard block |
||
| 266 | 266 | * |
| 267 | 267 | * @return Store A store populated with the view data |
| 268 | 268 | */ |
| 269 | - public function render(string $sViewName, array $aViewData = []): Store |
|
| 270 | - { |
|
| 271 | - $xStore = $this->store(); |
|
| 272 | - // Get the default view namespace |
|
| 273 | - $sNamespace = $this->sDefaultNamespace; |
|
| 274 | - // Get the namespace from the view name |
|
| 275 | - $nSeparatorPosition = strrpos($sViewName, '::'); |
|
| 276 | - if($nSeparatorPosition !== false) |
|
| 277 | - { |
|
| 278 | - $sNamespace = substr($sViewName, 0, $nSeparatorPosition); |
|
| 279 | - $sViewName = substr($sViewName, $nSeparatorPosition + 2); |
|
| 280 | - } |
|
| 269 | +public function render(string $sViewName, array $aViewData = []): Store |
|
| 270 | +{ |
|
| 271 | +$xStore = $this->store(); |
|
| 272 | +// Get the default view namespace |
|
| 273 | +$sNamespace = $this->sDefaultNamespace; |
|
| 274 | +// Get the namespace from the view name |
|
| 275 | +$nSeparatorPosition = strrpos($sViewName, '::'); |
|
| 276 | +if($nSeparatorPosition !== false) |
|
| 277 | +{ |
|
| 278 | +$sNamespace = substr($sViewName, 0, $nSeparatorPosition); |
|
| 279 | +$sViewName = substr($sViewName, $nSeparatorPosition + 2); |
|
| 280 | +} |
|
| 281 | 281 | |
| 282 | - $xRenderer = $this->getNamespaceRenderer($sNamespace); |
|
| 283 | - if(!$xRenderer) |
|
| 284 | - { |
|
| 285 | - // Cannot render a view if there's no renderer corresponding to the namespace. |
|
| 286 | - return $this->xEmptyStore; |
|
| 287 | - } |
|
| 282 | +$xRenderer = $this->getNamespaceRenderer($sNamespace); |
|
| 283 | +if(!$xRenderer) |
|
| 284 | +{ |
|
| 285 | +// Cannot render a view if there's no renderer corresponding to the namespace. |
|
| 286 | +return $this->xEmptyStore; |
|
| 287 | +} |
|
| 288 | 288 | |
| 289 | - $xStore->setData(array_merge($this->aViewData, $aViewData)) |
|
| 290 | - ->setView($xRenderer, $sNamespace, $sViewName); |
|
| 289 | +$xStore->setData(array_merge($this->aViewData, $aViewData)) |
|
| 290 | +->setView($xRenderer, $sNamespace, $sViewName); |
|
| 291 | 291 | |
| 292 | - // Set the store to null so a new store will be created for the next view. |
|
| 293 | - $this->xStore = null; |
|
| 294 | - // Return the store |
|
| 295 | - return $xStore; |
|
| 296 | - } |
|
| 292 | +// Set the store to null so a new store will be created for the next view. |
|
| 293 | +$this->xStore = null; |
|
| 294 | +// Return the store |
|
| 295 | +return $xStore; |
|
| 296 | +} |
|
| 297 | 297 | } |
@@ -6,53 +6,53 @@ |
||
| 6 | 6 | |
| 7 | 7 | abstract class PageComponent extends NodeComponent |
| 8 | 8 | { |
| 9 | - /** |
|
| 9 | +/** |
|
| 10 | 10 | * The current page number. |
| 11 | 11 | * |
| 12 | 12 | * @var int |
| 13 | 13 | */ |
| 14 | - private int $currentPage = 1; |
|
| 14 | +private int $currentPage = 1; |
|
| 15 | 15 | |
| 16 | - /** |
|
| 16 | +/** |
|
| 17 | 17 | * Get the total number of items to paginate. |
| 18 | 18 | * |
| 19 | 19 | * @return int |
| 20 | 20 | */ |
| 21 | - abstract protected function count(): int; |
|
| 21 | +abstract protected function count(): int; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 23 | +/** |
|
| 24 | 24 | * Get the max number of items per page. |
| 25 | 25 | * |
| 26 | 26 | * @return int |
| 27 | 27 | */ |
| 28 | - abstract protected function limit(): int; |
|
| 28 | +abstract protected function limit(): int; |
|
| 29 | 29 | |
| 30 | - /** |
|
| 30 | +/** |
|
| 31 | 31 | * Get the paginator for the component. |
| 32 | 32 | * |
| 33 | 33 | * @param int $pageNumber |
| 34 | 34 | * |
| 35 | 35 | * @return Paginator |
| 36 | 36 | */ |
| 37 | - protected function paginator(int $pageNumber): Paginator |
|
| 38 | - { |
|
| 39 | - return $this->cl(Component\Pagination::class) |
|
| 40 | - // Use the js class name as component item identifier. |
|
| 41 | - ->item($this->rq()->_class()) |
|
| 42 | - ->paginator($pageNumber > 0 ? $pageNumber : 1, $this->limit(), $this->count()) |
|
| 43 | - // This callback will receive the final value of the current page number. |
|
| 44 | - ->page(function(int $currentPage) { |
|
| 45 | - $this->currentPage = $currentPage; |
|
| 46 | - }); |
|
| 47 | - } |
|
| 37 | +protected function paginator(int $pageNumber): Paginator |
|
| 38 | +{ |
|
| 39 | +return $this->cl(Component\Pagination::class) |
|
| 40 | +// Use the js class name as component item identifier. |
|
| 41 | +->item($this->rq()->_class()) |
|
| 42 | +->paginator($pageNumber > 0 ? $pageNumber : 1, $this->limit(), $this->count()) |
|
| 43 | +// This callback will receive the final value of the current page number. |
|
| 44 | +->page(function(int $currentPage) { |
|
| 45 | + $this->currentPage = $currentPage; |
|
| 46 | +}); |
|
| 47 | +} |
|
| 48 | 48 | |
| 49 | - /** |
|
| 49 | +/** |
|
| 50 | 50 | * Get the current page number |
| 51 | 51 | * |
| 52 | 52 | * @return int |
| 53 | 53 | */ |
| 54 | - protected function currentPage(): int |
|
| 55 | - { |
|
| 56 | - return $this->currentPage; |
|
| 57 | - } |
|
| 54 | +protected function currentPage(): int |
|
| 55 | +{ |
|
| 56 | +return $this->currentPage; |
|
| 57 | +} |
|
| 58 | 58 | } |
@@ -6,81 +6,81 @@ |
||
| 6 | 6 | |
| 7 | 7 | trait PageDatabagTrait |
| 8 | 8 | { |
| 9 | - /** |
|
| 9 | +/** |
|
| 10 | 10 | * The current page number. |
| 11 | 11 | * |
| 12 | 12 | * @var int |
| 13 | 13 | */ |
| 14 | - private int $currentPage = 1; |
|
| 14 | +private int $currentPage = 1; |
|
| 15 | 15 | |
| 16 | - /** |
|
| 16 | +/** |
|
| 17 | 17 | * Get the pagination databag name. |
| 18 | 18 | * |
| 19 | 19 | * @return string |
| 20 | 20 | */ |
| 21 | - abstract protected function bagName(): string; |
|
| 21 | +abstract protected function bagName(): string; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 23 | +/** |
|
| 24 | 24 | * Get the pagination databag attribute. |
| 25 | 25 | * |
| 26 | 26 | * @return string |
| 27 | 27 | */ |
| 28 | - abstract protected function bagAttr(): string; |
|
| 28 | +abstract protected function bagAttr(): string; |
|
| 29 | 29 | |
| 30 | - /** |
|
| 30 | +/** |
|
| 31 | 31 | * Get the page number. |
| 32 | 32 | * |
| 33 | 33 | * @param int $pageNumber |
| 34 | 34 | * |
| 35 | 35 | * @return int |
| 36 | 36 | */ |
| 37 | - private function getPageNumber(int $pageNumber): int |
|
| 38 | - { |
|
| 39 | - // If no page number is provided, then get the value from the databag. |
|
| 40 | - return $pageNumber > 0 ? $pageNumber : |
|
| 41 | - (int)$this->bag($this->bagName())->get($this->bagAttr(), 1); |
|
| 42 | - } |
|
| 37 | +private function getPageNumber(int $pageNumber): int |
|
| 38 | +{ |
|
| 39 | +// If no page number is provided, then get the value from the databag. |
|
| 40 | +return $pageNumber > 0 ? $pageNumber : |
|
| 41 | +(int)$this->bag($this->bagName())->get($this->bagAttr(), 1); |
|
| 42 | +} |
|
| 43 | 43 | |
| 44 | - /** |
|
| 44 | +/** |
|
| 45 | 45 | * Set the page number. |
| 46 | 46 | * |
| 47 | 47 | * @param int $currentPage |
| 48 | 48 | * |
| 49 | 49 | * @return void |
| 50 | 50 | */ |
| 51 | - private function setCurrentPage(int $currentPage): void |
|
| 52 | - { |
|
| 53 | - // Save the current page in the databag. |
|
| 54 | - $this->bag($this->bagName())->set($this->bagAttr(), $currentPage); |
|
| 55 | - $this->currentPage = $currentPage; |
|
| 56 | - } |
|
| 51 | +private function setCurrentPage(int $currentPage): void |
|
| 52 | +{ |
|
| 53 | +// Save the current page in the databag. |
|
| 54 | +$this->bag($this->bagName())->set($this->bagAttr(), $currentPage); |
|
| 55 | +$this->currentPage = $currentPage; |
|
| 56 | +} |
|
| 57 | 57 | |
| 58 | - /** |
|
| 58 | +/** |
|
| 59 | 59 | * Get the paginator for the component. |
| 60 | 60 | * |
| 61 | 61 | * @param int $pageNumber |
| 62 | 62 | * |
| 63 | 63 | * @return Paginator |
| 64 | 64 | */ |
| 65 | - protected function paginator(int $pageNumber): Paginator |
|
| 66 | - { |
|
| 67 | - return $this->cl(Component\Pagination::class) |
|
| 68 | - // Use the js class name as component item identifier. |
|
| 69 | - ->item($this->rq()->_class()) |
|
| 70 | - ->paginator($this->getPageNumber($pageNumber), $this->limit(), $this->count()) |
|
| 71 | - // This callback will receive the final value of the current page number. |
|
| 72 | - ->page(function(int $currentPage) { |
|
| 73 | - $this->setCurrentPage($currentPage); |
|
| 74 | - }); |
|
| 75 | - } |
|
| 65 | +protected function paginator(int $pageNumber): Paginator |
|
| 66 | +{ |
|
| 67 | +return $this->cl(Component\Pagination::class) |
|
| 68 | +// Use the js class name as component item identifier. |
|
| 69 | +->item($this->rq()->_class()) |
|
| 70 | +->paginator($this->getPageNumber($pageNumber), $this->limit(), $this->count()) |
|
| 71 | +// This callback will receive the final value of the current page number. |
|
| 72 | +->page(function(int $currentPage) { |
|
| 73 | + $this->setCurrentPage($currentPage); |
|
| 74 | +}); |
|
| 75 | +} |
|
| 76 | 76 | |
| 77 | - /** |
|
| 77 | +/** |
|
| 78 | 78 | * Get the current page number |
| 79 | 79 | * |
| 80 | 80 | * @return int |
| 81 | 81 | */ |
| 82 | - protected function currentPage(): int |
|
| 83 | - { |
|
| 84 | - return $this->currentPage; |
|
| 85 | - } |
|
| 82 | +protected function currentPage(): int |
|
| 83 | +{ |
|
| 84 | +return $this->currentPage; |
|
| 85 | +} |
|
| 86 | 86 | } |
@@ -21,5 +21,5 @@ |
||
| 21 | 21 | */ |
| 22 | 22 | function jaxon(): Jaxon |
| 23 | 23 | { |
| 24 | - return Jaxon::getInstance(); |
|
| 24 | +return Jaxon::getInstance(); |
|
| 25 | 25 | } |
@@ -16,8 +16,8 @@ |
||
| 16 | 16 | |
| 17 | 17 | class Exception extends \Exception |
| 18 | 18 | { |
| 19 | - public function __construct(string $sMessage) |
|
| 20 | - { |
|
| 21 | - parent::__construct($sMessage); |
|
| 22 | - } |
|
| 19 | +public function __construct(string $sMessage) |
|
| 20 | +{ |
|
| 21 | +parent::__construct($sMessage); |
|
| 22 | +} |
|
| 23 | 23 | } |
@@ -4,17 +4,17 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface TargetInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 7 | +/** |
|
| 8 | 8 | * The target method name. |
| 9 | 9 | * |
| 10 | 10 | * @return string |
| 11 | 11 | */ |
| 12 | - public function method(): string; |
|
| 12 | +public function method(): string; |
|
| 13 | 13 | |
| 14 | - /** |
|
| 14 | +/** |
|
| 15 | 15 | * The target method args. |
| 16 | 16 | * |
| 17 | 17 | * @return array |
| 18 | 18 | */ |
| 19 | - public function args(): array; |
|
| 19 | +public function args(): array; |
|
| 20 | 20 | } |
@@ -29,73 +29,73 @@ |
||
| 29 | 29 | |
| 30 | 30 | class Validator |
| 31 | 31 | { |
| 32 | - /** |
|
| 32 | +/** |
|
| 33 | 33 | * The config manager |
| 34 | 34 | * |
| 35 | 35 | * @var ConfigManager |
| 36 | 36 | */ |
| 37 | - protected $xConfigManager; |
|
| 37 | +protected $xConfigManager; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 39 | +/** |
|
| 40 | 40 | * The translator |
| 41 | 41 | * |
| 42 | 42 | * @var Translator |
| 43 | 43 | */ |
| 44 | - protected $xTranslator; |
|
| 44 | +protected $xTranslator; |
|
| 45 | 45 | |
| 46 | - public function __construct(ConfigManager $xConfigManager, Translator $xTranslator) |
|
| 47 | - { |
|
| 48 | - // Set the config manager |
|
| 49 | - $this->xConfigManager = $xConfigManager; |
|
| 50 | - // Set the translator |
|
| 51 | - $this->xTranslator = $xTranslator; |
|
| 52 | - } |
|
| 46 | +public function __construct(ConfigManager $xConfigManager, Translator $xTranslator) |
|
| 47 | +{ |
|
| 48 | +// Set the config manager |
|
| 49 | +$this->xConfigManager = $xConfigManager; |
|
| 50 | +// Set the translator |
|
| 51 | +$this->xTranslator = $xTranslator; |
|
| 52 | +} |
|
| 53 | 53 | |
| 54 | - /** |
|
| 54 | +/** |
|
| 55 | 55 | * Validate a function name |
| 56 | 56 | * |
| 57 | 57 | * @param string $sName The function name |
| 58 | 58 | * |
| 59 | 59 | * @return bool |
| 60 | 60 | */ |
| 61 | - public function validateFunction(string $sName): bool |
|
| 62 | - { |
|
| 63 | - return preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $sName) > 0; |
|
| 64 | - } |
|
| 61 | +public function validateFunction(string $sName): bool |
|
| 62 | +{ |
|
| 63 | +return preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $sName) > 0; |
|
| 64 | +} |
|
| 65 | 65 | |
| 66 | - /** |
|
| 66 | +/** |
|
| 67 | 67 | * Validate a class name |
| 68 | 68 | * |
| 69 | 69 | * @param string $sName The class name |
| 70 | 70 | * |
| 71 | 71 | * @return bool |
| 72 | 72 | */ |
| 73 | - public function validateJsObject(string $sName): bool |
|
| 74 | - { |
|
| 75 | - return preg_match('/^([a-zA-Z][a-zA-Z0-9_]*)(\.[a-zA-Z][a-zA-Z0-9_]*)*$/', $sName) > 0; |
|
| 76 | - } |
|
| 73 | +public function validateJsObject(string $sName): bool |
|
| 74 | +{ |
|
| 75 | +return preg_match('/^([a-zA-Z][a-zA-Z0-9_]*)(\.[a-zA-Z][a-zA-Z0-9_]*)*$/', $sName) > 0; |
|
| 76 | +} |
|
| 77 | 77 | |
| 78 | - /** |
|
| 78 | +/** |
|
| 79 | 79 | * Validate a class name |
| 80 | 80 | * |
| 81 | 81 | * @param string $sName The class name |
| 82 | 82 | * |
| 83 | 83 | * @return bool |
| 84 | 84 | */ |
| 85 | - public function validateClass(string $sName): bool |
|
| 86 | - { |
|
| 87 | - return preg_match('/^([a-zA-Z][a-zA-Z0-9_]*)(\\\\[a-zA-Z][a-zA-Z0-9_]*)*$/', $sName) > 0; |
|
| 88 | - } |
|
| 85 | +public function validateClass(string $sName): bool |
|
| 86 | +{ |
|
| 87 | +return preg_match('/^([a-zA-Z][a-zA-Z0-9_]*)(\\\\[a-zA-Z][a-zA-Z0-9_]*)*$/', $sName) > 0; |
|
| 88 | +} |
|
| 89 | 89 | |
| 90 | - /** |
|
| 90 | +/** |
|
| 91 | 91 | * Validate a method name |
| 92 | 92 | * |
| 93 | 93 | * @param string $sName The function name |
| 94 | 94 | * |
| 95 | 95 | * @return bool |
| 96 | 96 | */ |
| 97 | - public function validateMethod(string $sName): bool |
|
| 98 | - { |
|
| 99 | - return preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $sName) > 0; |
|
| 100 | - } |
|
| 97 | +public function validateMethod(string $sName): bool |
|
| 98 | +{ |
|
| 99 | +return preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $sName) > 0; |
|
| 100 | +} |
|
| 101 | 101 | } |
@@ -25,54 +25,54 @@ |
||
| 25 | 25 | |
| 26 | 26 | class PsrAjaxMiddleware implements MiddlewareInterface |
| 27 | 27 | { |
| 28 | - /** |
|
| 28 | +/** |
|
| 29 | 29 | * @var Container |
| 30 | 30 | */ |
| 31 | - private $di; |
|
| 31 | +private $di; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 33 | +/** |
|
| 34 | 34 | * @var RequestHandler |
| 35 | 35 | */ |
| 36 | - private $xRequestHandler; |
|
| 36 | +private $xRequestHandler; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 38 | +/** |
|
| 39 | 39 | * @var ResponseManager |
| 40 | 40 | */ |
| 41 | - private $xResponseManager; |
|
| 41 | +private $xResponseManager; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 43 | +/** |
|
| 44 | 44 | * The constructor |
| 45 | 45 | * |
| 46 | 46 | * @param Container $di |
| 47 | 47 | * @param RequestHandler $xRequestHandler |
| 48 | 48 | * @param ResponseManager $xResponseManager |
| 49 | 49 | */ |
| 50 | - public function __construct(Container $di, RequestHandler $xRequestHandler, ResponseManager $xResponseManager) |
|
| 51 | - { |
|
| 52 | - $this->di = $di; |
|
| 53 | - $this->xRequestHandler = $xRequestHandler; |
|
| 54 | - $this->xResponseManager = $xResponseManager; |
|
| 55 | - } |
|
| 50 | +public function __construct(Container $di, RequestHandler $xRequestHandler, ResponseManager $xResponseManager) |
|
| 51 | +{ |
|
| 52 | +$this->di = $di; |
|
| 53 | +$this->xRequestHandler = $xRequestHandler; |
|
| 54 | +$this->xResponseManager = $xResponseManager; |
|
| 55 | +} |
|
| 56 | 56 | |
| 57 | - /** |
|
| 57 | +/** |
|
| 58 | 58 | * @inheritDoc |
| 59 | 59 | * @throws RequestException |
| 60 | 60 | */ |
| 61 | - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface |
|
| 62 | - { |
|
| 63 | - // Save the request in the container. This will override the default request, |
|
| 64 | - // and the other classes will get this request from there. |
|
| 65 | - $this->di->val(ServerRequestInterface::class, $request); |
|
| 61 | +public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface |
|
| 62 | +{ |
|
| 63 | +// Save the request in the container. This will override the default request, |
|
| 64 | +// and the other classes will get this request from there. |
|
| 65 | +$this->di->val(ServerRequestInterface::class, $request); |
|
| 66 | 66 | |
| 67 | - if(!$this->xRequestHandler->canProcessRequest()) |
|
| 68 | - { |
|
| 69 | - // Unable to find a plugin to process the request |
|
| 70 | - return $handler->handle($request); |
|
| 71 | - } |
|
| 67 | +if(!$this->xRequestHandler->canProcessRequest()) |
|
| 68 | +{ |
|
| 69 | +// Unable to find a plugin to process the request |
|
| 70 | +return $handler->handle($request); |
|
| 71 | +} |
|
| 72 | 72 | |
| 73 | - // Process the request |
|
| 74 | - $this->xRequestHandler->processRequest(); |
|
| 75 | - // Return a Psr7 response |
|
| 76 | - return $this->xResponseManager->getResponse()->toPsr(); |
|
| 77 | - } |
|
| 73 | +// Process the request |
|
| 74 | +$this->xRequestHandler->processRequest(); |
|
| 75 | +// Return a Psr7 response |
|
| 76 | +return $this->xResponseManager->getResponse()->toPsr(); |
|
| 77 | +} |
|
| 78 | 78 | } |