Versioner::getReaders() - Code Metrics - naneau/php-project-versioner - Measure and Improve Code Quality continuously with Scrutinizer

Versioner::getReaders() A
last analyzed 2017-06-15 15:50 UTC

↳ Parent: Versioner

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * Versioner.php
 *
 * @package         ProjectVersioner
 * @subpackage      Versioner
 */

namespace Naneau\ProjectVersioner;

use Naneau\ProjectVersioner\ReaderInterface as Reader;

use \RuntimeException;

/**
 * Versioner
 *
 * Uses a set of readers to fetch versions from directories
 *
 * @category        Naneau
 * @package         ProjectVersioner
 * @subpackage      Versioner
 */
class Versioner
{
    /**
     * The readers
     *
     * @var Reader[]
     **/
    private $readers;

    /**
     * Constructor
     *
     * @param  Reader[] $readers
     * @return void

     **/
    public function __construct(array $readers = array())
    {
        $this->setReaders($readers);
    }

    /**
     * Get the version for a directory
     *
     * @param  string $directory
     * @return string
     **/
    public function get($directory)
    {
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                return $reader->read($directory);
            }
        }

        throw new RuntimeException(sprintf(
            'Can not read version from directory "%s"',
            $directory
        ));
    }

    /**
     * Get the version for a directory
     *
     * Combining the output of all writers using the given separator
     *
     * Version will be considered "found" if at least one versioner returns
     * output.
     *
     * @param  string $directory
     * @param  string $separator
     * @return string
     **/
    public function getCombined($directory, $separator = '-')
    {
        $found = array();
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                $found[] = $reader->read($directory);
            }
        }

        if (count($found) === 0) {
            throw new RuntimeException(sprintf(
                'Can not read version from directory "%s"',
                $directory
            ));
        }

        return implode($separator, $found);
    }

    /**
     * Does a directory have a version?
     *
     * @param string $directory
     * @return bool
     **/
    public function has($directory)
    {
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the set of readers
     *
     * @return Reader[]
     */
    public function getReaders()
    {
        return $this->readers;
    }

    /**
     * Set the set of readers
     *
     * @param  Reader[]  $readers
     * @return Versioner
     */
    public function setReaders(array $readers)
    {
        $this->readers = $readers;

        return $this;
    }

    /**
     * Add a reader
     *
     * @param  Reader[]  $reader
     * @return Versioner
     */
    public function addReader(Reader $reader)
    {
        $this->readers[] = $reader;

        return $this;
    }
}


1			<?php
2			/**
3			* Versioner.php
4			*
5			* @package ProjectVersioner
6			* @subpackage Versioner
7			*/
8
9			namespace Naneau\ProjectVersioner;
10
11			use Naneau\ProjectVersioner\ReaderInterface as Reader;
12
13			use \RuntimeException;
14
15			/**
16			* Versioner
17			*
18			* Uses a set of readers to fetch versions from directories
19			*
20			* @category Naneau
21			* @package ProjectVersioner
22			* @subpackage Versioner
23			*/
24			class Versioner
25			{
26			/**
27			* The readers
28			*
29			* @var Reader[]
30			**/
31			private $readers;
32
33			/**
34			* Constructor
35			*
36			* @param Reader[] $readers
37			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-06-15 15:29 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
38			**/
39			public function __construct(array $readers = array())
40			{
41			$this->setReaders($readers);
42			}
43
44			/**
45			* Get the version for a directory
46			*
47			* @param string $directory
48			* @return string
49			**/
50			public function get($directory)
51			{
52			foreach ($this->getReaders() as $reader) {
53			if ($reader->canRead($directory)) {
54			return $reader->read($directory);
55			}
56			}
57
58			throw new RuntimeException(sprintf(
59			'Can not read version from directory "%s"',
60			$directory
61			));
62			}
63
64			/**
65			* Get the version for a directory
66			*
67			* Combining the output of all writers using the given separator
68			*
69			* Version will be considered "found" if at least one versioner returns
70			* output.
71			*
72			* @param string $directory
73			* @param string $separator
74			* @return string
75			**/
76			public function getCombined($directory, $separator = '-')
77			{
78			$found = array();
79			foreach ($this->getReaders() as $reader) {
80			if ($reader->canRead($directory)) {
81			$found[] = $reader->read($directory);
82			}
83			}
84
85			if (count($found) === 0) {
86			throw new RuntimeException(sprintf(
87			'Can not read version from directory "%s"',
88			$directory
89			));
90			}
91
92			return implode($separator, $found);
93			}
94
95			/**
96			* Does a directory have a version?
97			*
98			* @param string $directory
99			* @return bool
100			**/
101			public function has($directory)
102			{
103			foreach ($this->getReaders() as $reader) {
104			if ($reader->canRead($directory)) {
105			return true;
106			}
107			}
108
109			return false;
110			}
111
112			/**
113			* Get the set of readers
114			*
115			* @return Reader[]
116			*/
117			public function getReaders()
118			{
119			return $this->readers;
120			}
121
122			/**
123			* Set the set of readers
124			*
125			* @param Reader[] $readers
126			* @return Versioner
127			*/
128			public function setReaders(array $readers)
129			{
130			$this->readers = $readers;
131
132			return $this;
133			}
134
135			/**
136			* Add a reader
137			*
138			* @param Reader[] $reader
139			* @return Versioner
140			*/
141			public function addReader(Reader $reader)
142			{
143			$this->readers[] = $reader;
144
145			return $this;
146			}
147			}
148

naneau / php-project-versioner

GitHub Access Token became invalid

Versioner::getReaders() A last analyzed 2017-06-15 15:50 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Versioner::getReaders() A
last analyzed 2017-06-15 15:50 UTC