Brickoo\Component\IO\Stream\FileStreamConfig

Complexity

Total Complexity

5

Size/Duplication

Total Lines	65
Duplicated Lines	15.38 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	10	10	1
A	getFilename()	0	3	1
A	getMode()	0	3	1
A	shouldUseIncludePath()	0	3	1
A	getContext()	0	3	1

<?php

/*
 * Copyright (c) 2011-2015, Celestino Diaz <celestino.diaz@gmx.de>
 *
 * 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 Brickoo\Component\IO\Stream;

use Brickoo\Component\Common\Assert;

/**
 * FileStreamConfig
 *
 * Implements a configuration for file based streams.
 * @author Celestino Diaz <celestino.diaz@gmx.de>
 */
class FileStreamConfig {

    /** @var  string */
    private $filename;

    /** @var integer */
    private $mode;

    /** @var boolean */
    private $useIncludePath;

    /** @var array */
    private $context;

    /**
     * @param string $filename
     * @param integer $mode
     * @param boolean $useIncludePath
     * @param array $context
     * @throws \InvalidArgumentException
     */
    public function __construct($filename, $mode, $useIncludePath = false, array $context = array()) {
        Assert::isString($filename);
        Assert::isInteger($mode);
        Assert::isBoolean($useIncludePath);

        $this->filename = $filename;
        $this->mode = $mode;
        $this->useIncludePath = $useIncludePath;
        $this->context = $context;
    }

    /**
     * Returns the configuration file name.
     * @return string the file name
     */
    public function getFilename() {
        return $this->filename;
    }

    /**
     * Returns the file accessing mode.
     * @return integer the file accessing mode
     */
    public function getMode() {
        return $this->mode;
    }

    /**
     * Checks if the include path should also be used.
     * @return boolean check result
     */
    public function shouldUseIncludePath() {
        return $this->useIncludePath;
    }

    /**
     * Returns the file stream context options.
     * @return array the context options
     */
    public function getContext() {
        return $this->context;
    }

}