Apparat\Resource\Infrastructure\Io\File\ReaderTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	4	1
B	validateReaderFile()	0	26	4

<?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\Io\File;

/**
 * File reader trait
 *
 * @package     Apparat\Resource
 * @subpackage  Apparat\Resource\Infrastructure
 * @property string $file File path
 */
trait ReaderTrait
{
    /**
     * Read the file content
     *
     * @return string File content
     */
    public function read()
    {
        return file_get_contents($this->file);
    }

    /**
     * Validate the reader file
     *
     * @throws InvalidReaderArgumentException If the file does not exist
     * @throws InvalidReaderArgumentException If the file is not a file
     * @throws InvalidReaderArgumentException If the file is not readable
     */
    protected function validateReaderFile()
    {
        // If the file does not exist
        if (!@file_exists($this->file)) {
            throw new InvalidReaderArgumentException(
                sprintf('File "%s" does not exist', $this->file),
                InvalidReaderArgumentException::RESOURCE_DOES_NOT_EXIST
            );
        }

        // If the file is not a file
        if (!@is_file($this->file)) {
            throw new InvalidReaderArgumentException(
                sprintf('File "%s" is not a file', $this->file),
                InvalidReaderArgumentException::RESOURCE_IS_OF_WRONG_TYPE
            );
        }

        // If the file is not readable
        if (!@is_readable($this->file)) {
            throw new InvalidReaderArgumentException(
                sprintf('File "%s" is not readable', $this->file),
                InvalidReaderArgumentException::RESOURCE_IS_NOT_READABLE
            );
        }
    }
}