Apparat\Resource\Infrastructure\Model\Resource\FrontMarkResource

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	set()	0	4	1
A	get()	0	4	1
A	append()	0	4	1
A	prepend()	0	4	1
A	getHtml()	0	4	1
A	getData()	0	4	1
A	setData()	0	4	1

<?php

/**
 * apparat-resource
 *
 * @category    Apparat
 * @package     Apparat\Resource
 * @subpackage  Apparat\Resource\Infrastructure
 * @author      Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Resource\Infrastructure\Model\Resource;

use Apparat\Resource\Domain\Contract\ReaderInterface;
use Apparat\Resource\Domain\Contract\WriterInterface;
use Apparat\Resource\Domain\Model\Hydrator\HydratorInterface;
use Apparat\Resource\Domain\Model\Part\AbstractContentPart;
use Apparat\Resource\Domain\Model\Part\PartChoice;
use Apparat\Resource\Domain\Model\Resource\AbstractResource;
use Apparat\Resource\Infrastructure\Model\Hydrator\CommonMarkHydrator;
use Apparat\Resource\Infrastructure\Model\Hydrator\FrontMarkHydrator;
use Apparat\Resource\Infrastructure\Model\Hydrator\FrontMatterHydrator;
use Apparat\Resource\Infrastructure\Model\Hydrator\JsonHydrator;
use Apparat\Resource\Infrastructure\Model\Hydrator\YamlHydrator;

/**
 * FrontMark resource (CommonMark resource with YAML or JSON front matter)
 *
 * @package     Apparat\Resource
 * @subpackage  Apparat\Resource\Infrastructure
 * @method FrontMarkResource appendPart(string $data, string $part = '/') appendPart(string $data, string $part = '/')
 *     Append content to the resource
 * @method FrontMarkResource prependPart(string $data, string $part = '/') prependPart(string $data, string $part =
 *     '/') Prepend content to the resource
 * @method string getHtmlPart(string $part = '/') getHtmlPart(string $part = '/') Get the HTML content of the resource
 * @method array getDataPart(string $part = '/') getDataPart(string $part = '/') Get the YAML / JSON front matter data
 *     of the resource
 * @method FrontMarkResource setDataPart(array $data, string $part = '/') setDataPart(array $data, string $part = '/')
 *     Set the YAML / JSON front matter data of the resource
 * @method string getMediaTypePart(string $part = '/') getMediaTypePart(string $part = '/') Get the media type of this
 *     part
 * @method FrontMarkResource from($src, ...$parameters) static from($src, ...$parameters) Instantiate from source
 * @method WriterInterface to($target, ...$parameters) to($target, ...$parameters) Write to target
 */
class FrontMarkResource extends AbstractResource
{
    /**
     * Use resource factory methods and properties
     */
    use ResourceTrait;

    /**
     * FrontMark resource constructor
     *
     * @param ReaderInterface $reader Reader instance
     */
    public function __construct(ReaderInterface $reader = null)
    {
        parent::__construct(
            array(
                [
                    FrontMatterHydrator::FRONTMATTER => [
                        [
                            JsonHydrator::JSON => JsonHydrator::class,
                            YamlHydrator::YAML => YamlHydrator::class
                        ],
                        FrontMatterHydrator::class
                    ],
                    HydratorInterface::STANDARD => CommonMarkHydrator::class,
                ],
                FrontMarkHydrator::class
            ),
            $reader
        );
    }

    /**
     * Set the content of the sole part
     *
     * @param string $data Content
     * @return FrontMarkResource Self reference
     */
    public function set($data)
    {
        return $this->setPart($data, '/0/'.HydratorInterface::STANDARD);
    }

    /**
     * Return the sole part's content
     *
     * @return string Part content
     */
    public function get()
    {
        return $this->getPart('/0/'.HydratorInterface::STANDARD);
    }

    /**
     * Append content to the sole part
     *
     * @param string $data Contents
     * @return FrontMarkResource New part
     */
    public function append($data)
    {
        return $this->appendPart($data, '/0/'.HydratorInterface::STANDARD);
    }

    /**
     * Prepend content to the sole part
     *
     * @param string $data Contents
     * @return FrontMarkResource New text part
     */
    public function prepend($data)
    {
        return $this->prependPart($data, '/0/'.HydratorInterface::STANDARD);
    }

    /**
     * Convert the sole CommonMark source to HTML
     *
     * @return string CommonMark HTML
     */
    public function getHtml()
    {
        return $this->getHtmlPart('/0/'.HydratorInterface::STANDARD);
    }

    /**
     * Return the unserialized sole data content
     *
     * @return array Unserialized data content
     */
    public function getData()
    {
        return $this->getDataPart('/0/'.FrontMatterHydrator::FRONTMATTER.'/0/'.PartChoice::WILDCARD);
    }

    /**
     * Set the sole data content
     *
     * @param array $data New data
     * @return AbstractContentPart Self reference
     */
    public function setData(array $data)
    {
        return $this->setDataPart($data, '/0/'.FrontMatterHydrator::FRONTMATTER.'/0/'.PartChoice::WILDCARD);
    }
}