Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
100.00% |
1 / 1 |
|
100.00% |
11 / 11 |
CRAP | |
100.00% |
38 / 38 |
| champlates\HtmlTemplate | |
100.00% |
1 / 1 |
|
100.00% |
11 / 11 |
20 | |
100.00% |
38 / 38 |
| __construct | |
100.00% |
1 / 1 |
2 | |
100.00% |
8 / 8 |
|||
| bindParam | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| bindParams | |
100.00% |
1 / 1 |
2 | |
100.00% |
3 / 3 |
|||
| addInnerTemplate | |
100.00% |
1 / 1 |
2 | |
100.00% |
2 / 2 |
|||
| addInnerTemplates | |
100.00% |
1 / 1 |
2 | |
100.00% |
3 / 3 |
|||
| addCollection | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| addCollectionFromArray | |
100.00% |
1 / 1 |
1 | |
100.00% |
3 / 3 |
|||
| changeTemplate | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| render | |
100.00% |
1 / 1 |
5 | |
100.00% |
11 / 11 |
|||
| generateParamKey | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| generateInnerKey | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| display | n/a |
0 / 0 |
1 | n/a |
0 / 0 |
|||||
| <?php | |
| /** | |
| * Copyright Hermann Krumrey <hermann@krumreyh.com> 2017 | |
| * | |
| * This file is part of champlates. | |
| * | |
| * champlates is free software: you can redistribute it and/or modify | |
| * it under the terms of the GNU General Public License as published by | |
| * the Free Software Foundation, either version 3 of the License, or | |
| * (at your option) any later version. | |
| * | |
| * champlates is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| * GNU General Public License for more details. | |
| * | |
| * You should have received a copy of the GNU General Public License | |
| * along with champlates. If not, see <http://www.gnu.org/licenses/>. | |
| */ | |
| namespace champlates; | |
| /** | |
| * Class HtmlTemplate | |
| * Class that provides base methods for HTML Template objects, which can | |
| * be rendered to HTML | |
| * @package champlates | |
| */ | |
| class HtmlTemplate { | |
| /** | |
| * HtmlTemplate constructor. | |
| * The identifiers are used to identify segments in the template that | |
| * will be filled by strings, other HtmlTemplatess or translated words. | |
| * @param string $template : An HTML file that acts as a template for this | |
| * HTML Template | |
| * @param Dictionary $dictionary : The dictionary used for translating | |
| * words inside this template | |
| * @param string $paramIdentifier: Identifier for strings to be inserted | |
| * @param string $innerIdentifier: identifier for inner HtmlTemplates | |
| * @SuppressWarnings functionMaxParameters | |
| */ | |
| public function __construct(string $template, | |
| ? Dictionary $dictionary, | |
| string $paramIdentifier = "#{KEY}", | |
| string $innerIdentifier = "&{KEY}") { | |
| $this->template = $template; | |
| $this->dictionary = $dictionary; | |
| $this->paramIdentifier = $paramIdentifier; | |
| $this->innerIdentifier = $innerIdentifier; | |
| $this->params = []; | |
| $this->innerTemplates = []; | |
| $this->collections = []; | |
| } | |
| /** | |
| * Adds a replacement string for a given key variable name | |
| * @param string $name: The Key variable name | |
| * @param string $value: The replacement value | |
| */ | |
| public function bindParam(string $name, string $value) { | |
| $this->params[$name] = $value; | |
| } | |
| /** | |
| * Adds multiple replacement strings like bind_param does | |
| * @param array $params: The parameters consisting of [name => value] | |
| */ | |
| public function bindParams(array $params) { | |
| foreach ($params as $name => $value) { | |
| $this->bindParam($name, $value); | |
| } | |
| } | |
| /** | |
| * Adds a child HtmlTemplate and defines where it will be inserted | |
| * Null Templates will replace with an empty string "". | |
| * @param string $name: The identifier key for the template | |
| * @param HtmlTemplate|null $template: The template itself | |
| */ | |
| public function addInnerTemplate(string $name, ? HtmlTemplate $template) { | |
| $this->innerTemplates[$name] = $template; | |
| } | |
| /** | |
| * Adds multiple inner Html Templates | |
| * @param array $templates: The templates to add | |
| */ | |
| public function addInnerTemplates(array $templates) { | |
| foreach ($templates as $name => $template) { | |
| $this->addInnerTemplate($name, $template); | |
| } | |
| } | |
| /** | |
| * Adds a HtmlTemplateCollection to the HtmlTemplate | |
| * @param HtmlTemplateCollection $collection: The Collection to add | |
| */ | |
| public function addCollection(HtmlTemplateCollection $collection) { | |
| $this->innerTemplates[$collection->name] = $collection; | |
| } | |
| /** | |
| * Creates a HtmlTemplateCollection from an array and adds it | |
| * @param string $name: The name of the collection | |
| * @param array $templates: The templates in the collection | |
| */ | |
| public function addCollectionFromArray(string $name, array $templates) { | |
| $collection = new HtmlTemplateCollection($name, $templates); | |
| $this->addCollection($collection); | |
| } | |
| /** | |
| * Changes the template file of the HtmlTemplate object | |
| * @param string $template: The path to the template file to use | |
| */ | |
| public function changeTemplate(string $template) { | |
| $this->template = $template; | |
| } | |
| /** | |
| * Renders the HTML Template to an HTML string. All inner HTML Templates | |
| * are inserted as well as parameter string and then translated into the | |
| * specified language | |
| * @param string $language: The language into which to translate the HTML | |
| * Template into | |
| * @return string: The rendered HTML | |
| */ | |
| public function render(string $language) : string { | |
| $html = file_get_contents($this->template); | |
| foreach ($this->innerTemplates as $name => $template) { | |
| $search = $this->generateInnerKey($name); | |
| $innerHtml = | |
| ($template !== null) ? $template->render($language) : ""; | |
| $html = str_replace($search, $innerHtml, $html); | |
| } | |
| foreach ($this->params as $name => $value) { | |
| $search = $this->generateParamKey($name); | |
| $html = str_replace($search, $value, $html); | |
| } | |
| if ($this->dictionary === null) { | |
| return $html; | |
| } else { | |
| return $this->dictionary->translate($html, $language); | |
| } | |
| } | |
| /** | |
| * Generates a string which can be used by str_replace to replace | |
| * variable placeholder string/params | |
| * @param string $name: The name of the param key | |
| * @return string: The generated param replace key | |
| */ | |
| public function generateParamKey(string $name) : string { | |
| return str_replace("KEY", $name, $this->paramIdentifier); | |
| } | |
| /** | |
| * Generates a string which can be used by str_replace to inner | |
| * HtmlTemplate placeholders. | |
| * @param string $name: The name of the inner template key | |
| * @return string: The generated inner template replace key | |
| */ | |
| public function generateInnerKey(string $name) : string { | |
| return str_replace("KEY", $name, $this->innerIdentifier); | |
| } | |
| /** | |
| * Echoes the HTML template content. | |
| * @param string $language: The language in which to display the page in. | |
| * @codeCoverageIgnore | |
| */ | |
| public function display(string $language) { | |
| echo $this->render($language); | |
| } | |
| } |