Soluble\FlexStore\Writer\AbstractWriter

Complexity

Total Complexity

13

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

64.1%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	getData()	0	1	?
A	__construct()	0	9	3
A	setStore()	0	6	1
A	save()	0	33	2
A	setDebug()	0	6	1
A	getOptions()	0	4	1
A	setOptions()	0	30	5

<?php

/*
 * soluble-flexstore library
 *
 * @author    Vanvelthem Sébastien
 * @link      https://github.com/belgattitude/soluble-flexstore
 * @copyright Copyright (c) 2016-2017 Vanvelthem Sébastien
 * @license   MIT License https://github.com/belgattitude/soluble-flexstore/blob/master/LICENSE.md
 *
 */

namespace Soluble\FlexStore\Writer;

use Soluble\FlexStore\Exception;
use Traversable;
use Soluble\FlexStore\Options;
use Soluble\FlexStore\Store\StoreInterface;

abstract class AbstractWriter
{
    /**
     * @var StoreInterface
     */
    protected $store;

    /**
     * @var array
     */
    protected $options = [
        'debug' => false,
        'charset' => 'UTF-8'
    ];

    /**
     * @param StoreInterface|null    $store
     * @param array|Traversable|null $options
     */
    public function __construct(StoreInterface $store = null, $options = null)
    {
        if ($store !== null) {
            $this->setStore($store);
        }
        if ($options !== null) {
            $this->setOptions($options);
        }
    }

    /**
     * @param StoreInterface $store
     *
     * @return AbstractWriter
     */
    public function setStore(StoreInterface $store)
    {
        $this->store = $store;

        return $this;
    }

    /**
     * Return data.
     *
     * @param Options $options
     */
    abstract public function getData(Options $options = null);

    /**
     * Save content to a file.
     *
     * @param string $filename
     * @param string $charset
     */
    public function save($filename, $charset = null)

The parameter $charset is not used and could be removed.

    {
        $data = $this->getData();

        /*
        if ($charset === null) {
            $charset = $this->options['charset'];
        }

        */
        // UTF-8 : file_put_contents("file.txt", "\xEF\xBB\xBF" . $data);

        /*

            $data = file_get_contents($npath);
            $data = mb_convert_encoding($data, 'UTF-8', 'OLD-ENCODING');
            file_put_contents('tempfolder/'.$a, $data);

            Or alternatively, with PHP's stream filters:

            $fd = fopen($file, 'r');
            stream_filter_append($fd, 'convert.iconv.UTF-8/OLD-ENCODING');
            stream_copy_to_stream($fd, fopen($output, 'w'));
         *
         * mb_convert_encoding($data, 'UTF-8', 'auto');
         * mb_convert_encoding($data, 'UTF-8', mb_detect_encoding($data));
         */

        $ret = file_put_contents($filename, $data);
        if (!$ret) {
            throw new \Exception("Filename $filename cannot be written");
        }
    }

    /**
     * @param bool $debug
     *
     * @return AbstractWriter
     */
    public function setDebug($debug = true)
    {
        $this->options['debug'] = $debug;

        return $this;
    }

    /**
     * Set options.
     *
     * @throws Exception\InvalidArgumentException
     *
     * @return AbstractWriter
     */
    public function setOptions(iterable $options)
    {
        if (!is_iterable($options)) {
            throw new Exception\InvalidArgumentException(
                sprintf(
                '"%s" expects an array or Traversable; received "%s"',
                __METHOD__,
                gettype($options)
            )
            );
        }

        foreach ($options as $key => $value) {
            $setter = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
            if (method_exists($this, $setter)) {
                $this->{$setter}($value);
            } elseif (array_key_exists($key, $this->options)) {
                $this->options[$key] = $value;
            } else {
                throw new Exception\InvalidArgumentException(sprintf(
                    'The option "%s" does not have a matching %s setter method or options[%s] array key',
                    $key,
                    $setter,
                    $key
                ));
            }
        }

        return $this;
    }

    /**
     * Retrieve options.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }
}