allejo\stakx\Document\DynamicPageView

Complexity

Total Complexity

7

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

81.82%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	addRepeatableItem()	0	5	1
A	delRepeatableItem()	0	4	1
A	getRepeatableItems()	0	4	1
A	getObjectName()	0	4	1
A	getRepeatableNamespace()	0	11	2

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Document;

/**
 * A dynamic PageView is created when the following keywords are found in the FrontMatter of a PageView:
 *
 *   - collection
 *   - dataset
 *
 * This PageView type will contain references to all of the RepeatableItems
 */
class DynamicPageView extends PageView
{
    /**
     * The RepeatableItems that belong to this PageView.
     *
     * @var RepeatableItem[]
     */
    private $repeatableItems;

    /**
     * {@inheritdoc}
     */
    public function __construct($filePath)
    {
        parent::__construct($filePath);

        $this->repeatableItems = array();
        $this->type = PageView::DYNAMIC_TYPE;
    }

    /**
     * Add a RepeatableItem to this dynamic PageView.
     *
     * @param RepeatableItem $repeatableItem
     */
    public function addRepeatableItem(RepeatableItem &$repeatableItem)
    {
        $this->repeatableItems[$repeatableItem->getObjectName()] = &$repeatableItem;
        $repeatableItem->setParentPageView($this);
    }

    /**
     * Remove a RepeatableItem from the list of items that this dynamic PageView is responsible for.
     *
     * @param RepeatableItem $repeatableItem
     */
    public function delRepeatableItem(RepeatableItem &$repeatableItem)
    {
        unset($this->repeatableItems[$repeatableItem->getObjectName()]);
    }

    /**
     * Get all of the RepeatableItem that belong to this dynamic PageView.
     *
     * @return RepeatableItem[]
     */
    public function getRepeatableItems()
    {
        return $this->repeatableItems;
    }

    public function getRepeatableNamespace()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fm = $this->getFrontMatter(false);

Avoid variables with short names like $fm. Configured minimum length is 3.

        if (isset($fm['collection']))
        {
            return $fm['collection'];
        }

        return $fm['dataset'];
    }

    public function getObjectName()
    {
        return $this->getRepeatableNamespace();
    }
}