Yosymfony\Spress\Core\DataSource\AbstractDataSource

Complexity

Total Complexity

13

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	getItems()	0	1	?
	getLayouts()	0	1	?
	getIncludes()	0	1	?
A	__construct()	0	6	1
A	addItem()	0	3	1
A	load()	0	6	1
A	addUse()	0	17	4
A	removeUse()	0	8	2
A	setUp()	0	3	1
A	tearDown()	0	3	1
A	configure()	0	3	1
A	process()	0	3	1

<?php

/*
 * This file is part of the Yosymfony\Spress.
 *
 * (c) YoSymfony <http://github.com/yosymfony>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Yosymfony\Spress\Core\DataSource;

/**
 * It is the superclass for all data sources.
 *
 * Data sources can load site data from certain locations.
 *
 * @api
 *
 * @author Victor Puertas <vpgugr@gmail.com>
 */
abstract class AbstractDataSource
{
    protected $referenceCounter;
    protected $params;
    protected $isConfigured;

    /**
     * Constructor.
     *
     * @param array $params Params for initialize the data source
     */
    public function __construct(array $params = [])
    {
        $this->params = $params;
        $this->referenceCounter = 0;
        $this->isConfigured = false;
    }

    /**
     * Returns the list of items.
     *
     * @return array Key-value array with Item's id as a key and the Item as value.
     */
    abstract public function getItems();

    /**
     * Returns the list of items with type "layout".
     *
     * @return array Key-value array with Item's id as a key and the Item as value.
     */
    abstract public function getLayouts();

    /**
     * Returns the list of items with type "include".
     *
     * @return array Key-value array with Item's id as a key and the Item as value.
     */
    abstract public function getIncludes();

    /**
     * Creates a new item or layout in the data source.
     *
     * @param Yosymfony\Spress\Core\DataSource\ItemInterface $item
     */
    public function addItem(ItemInterface $item)
    {
    }

    /**
     * Loads the data source.
     */
    public function load()
    {
        $this->addUse();
        $this->process();
        $this->removeUse();
    }

    /**
     * Marks as used the data source.
     * This method increases the internal reference count.
     * When the internal reference count goes from 0 to 1 setUp method
     * is invoked.
     */
    public function addUse()
    {
        if (false === $this->isConfigured) {
            $this->configure();
            $this->isConfigured = true;
        }

        if ($this->referenceCounter < 0) {
            $this->referenceCounter = 0;
        }

        if ($this->referenceCounter === 0) {
            $this->setUp();
        }

        ++$this->referenceCounter;
    }

    /**
     * Marks as unused the data source.
     * This method decreases the internal reference count.
     * When the internal reference count is 0 tearDown method
     * is invoked.
     */
    public function removeUse()
    {
        --$this->referenceCounter;

        if ($this->referenceCounter === 0) {
            $this->tearDown();
        }
    }

    /**
     * Brings up the connections to the data.
     * e.g: this is the ideal place to connect to the database.
     */
    public function setUp()
    {
    }

    /**
     * Brings down the connections to the data.
     * e.g: a database connection established in setUp should be closed in this method.
     */
    public function tearDown()
    {
    }

    /**
     * This method is used for setting up a site’s data source for the first time.
     */
    public function configure()
    {
    }

    /**
     * All data source data manipulations and queries.
     */
    public function process()
    {
    }
}