Brendt\Stitcher\Site\Page

Complexity

Total Complexity

19

Size/Duplication

Total Lines	236
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	18	5
A	setVariableIsParsed()	0	5	1
A	isParsedVariable()	0	3	1
A	getId()	0	3	1
A	getTemplatePath()	0	3	1
A	getVariables()	0	3	1
A	getAdapters()	0	3	1
A	getAdapterConfig()	0	7	2
A	getVariable()	0	7	2
A	setVariableValue()	0	5	1
A	removeAdapter()	0	7	2
A	setId()	0	5	1

<?php

namespace Brendt\Stitcher\Site;

use Brendt\Stitcher\Exception\TemplateNotFoundException;

/**
 * A Page object represents a page entry configured in a YAML file located in the `src/sites/` directory.
 * Constructing a new Page requires a unique ID and an array of data. This array can hold several different arguments:
 *
 *      - `template`: the only required argument. This variable is a path to a template file.
 *              This path is relative to the `directories.src` or `directories.template` configuration entry
 *              @see \Brendt\Stitcher\Stitcher::loadTemplates
 *
 *
 *      - `data`: an optional array of variables which will be mapped onto the template.
 *              Each of these variables is parsed during compile time.
 *              @see \Brendt\Stitcher\Parser\AbstractParser
 *
 *      - `adapters`: an optional array of Adapters for this page. Adapters are used to adapt a page's configuration
 *              to another one.
 *              @see \Brendt\Stitcher\Adapter\Adapter
 *
 * @package Brendt\Stitcher\Site
 */
class Page {

    /**
     * The page's ID.
     *
     * @var string
     */
    protected $id;

    /**
     * The template path of this page.
     *
     * @var string
     */
    protected $templatePath;

    /**
     * The variables of this page, which will be available in the rendered template.
     *
     * @var array
     */
    protected $variables = [];

    /**
     * The adapters of this page.
     * Adapters will transform a page's variables and/or the page itself into one or more pages.
     *
     * @var Adapter[]
     */
    protected $adapters;

    /**
     * An array containing a list of parsed variables.
     *
     * @see setVariableIsParsed
     *
     * @var array
     */
    protected $parsedVariables = [];

    /**
     * Construct a new page
     *
     * @param string $id
     * @param array  $data
     *
     * @throws TemplateNotFoundException
     */
    public function __construct($id, array $data = []) {
        if (!isset($data['template'])) {
            throw new TemplateNotFoundException("No template was set for page {$id}");
        }

        $this->id = $id;
        $this->templatePath = $data['template'];

        if (isset($data['variables'])) {
            $this->variables += $data['variables'];
        }

        if (isset($data['adapters'])) {
            foreach ($data['adapters'] as $type => $adapterConfig) {
                $this->adapters[$type] = $adapterConfig;
            }
        }
    }

    /**
     * Defines a variable as parsed.
     * Parsed variables will be ignored by Stitcher when compiling the website.
     * Adapters can define parsed variables to indicate Stitcher it should skip parsing that variable during compile time.
     *
     * @param $name
     *
     * @return Page
     *
     * @see \Brendt\Stitcher\Stitcher::parseVariables
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     */
    public function setVariableIsParsed($name) {
        $this->parsedVariables[$name] = true;

        return $this;
    }

    /**
     * Check whether a variable is parsed or not.
     * Parsed variables will be ignored by Stitcher during compile time.
     *
     * @param $name
     *
     * @return bool
     *
     * @see \Brendt\Stitcher\Stitcher::parseVariables
     */
    public function isParsedVariable($name) {
        return isset($this->parsedVariables[$name]);
    }

    /**
     * Get the ID of this page
     *
     * @return string
     *
     * @see \Brendt\Stitcher\Stitcher::stitch
     */
    public function getId() {
        return $this->id;
    }

    /**
     * Get the template path of this page.
     *
     * @return string
     *
     * @see \Brendt\Stitcher\Stitcher::stitch
     */
    public function getTemplatePath() {
        return $this->templatePath;
    }

    /**
     * Get the variables of this page.
     *
     * @return array
     *
     * @see \Brendt\Stitcher\Stitcher::stitch
     * @see \Brendt\Stitcher\Stitcher::parseVariables
     */
    public function getVariables() {
        return $this->variables;
    }

    /**
     * Get the adapters of this page.
     *
     * @return Adapter[]
     *
     * @see \Brendt\Stitcher\Stitcher::parseAdapters
     */
    public function getAdapters() {
        return $this->adapters;
    }

    /**
     * Get an adapter configuration by name.
     *
     * @param $name
     *
     * @return Adapter|null
     *
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     * @see \Brendt\Stitcher\controller\DevController::run
     */
    public function getAdapterConfig($name) {
        if (!isset($this->adapters[$name])) {
            return null;
        }

        return $this->adapters[$name];
    }

    /**
     * Get a variable by name.
     *
     * @param $name
     *
     * @return mixed|null
     *
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     */
    public function getVariable($name) {
        if (!isset($this->variables[$name])) {
            return null;
        }

        return $this->variables[$name];
    }

    /**
     * Set the value of a variable.
     *
     * @param $name
     * @param $value
     *
     * @return Page
     *
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     * @see \Brendt\Stitcher\Stitcher::parseVariables
     */
    public function setVariableValue($name, $value) {
        $this->variables[$name] = $value;

        return $this;
    }

    /**
     * Remove an adapter.
     *
     * @param $name
     *
     * @return Page
     *
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     */
    public function removeAdapter($name) {
        if (isset($this->adapters[$name])) {
            unset($this->adapters[$name]);
        }

        return $this;
    }

    /**
     * Set the ID of this page.
     * An page's ID can be re-set after constructing when an adapter is creating other pages based on an existing page.
     *
     * @param string $id
     *
     * @return Page
     *
     * @see \Brendt\Stitcher\adapter\CollectionAdapter::transform
     * @see \Brendt\Stitcher\adapter\PagincationAdapter::transform
     */
    public function setId($id) {
        $this->id = $id;

        return $this;
    }

}