PathTrait::getPath() - Code Metrics - m1/Vars - Measure and Improve Code Quality continuously with Scrutinizer

PathTrait::getPath() A
last analyzed 2018-06-20 16:58 UTC

↳ Parent: PathTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * This file is part of the m1\vars library
 *
 * (c) m1 <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     m1/vars
 * @version     1.1.0
 * @author      Miles Croxford <[email protected]>
 * @copyright   Copyright (c) Miles Croxford <[email protected]>
 * @license     http://github.com/m1/vars/blob/master/LICENSE
 * @link        http://github.com/m1/vars/blob/master/README.MD Documentation
 */

namespace M1\Vars\Traits;

/**
 * Path trait gives common operation functions needed for Paths in Vars
 *
 * @since 0.1.0
 */
trait PathTrait
{
    /**
     * The base path for the Vars config and cache folders
     *
     * @var string $path
     */
    public $path;

    /**
     * Get the path
     *
     * @return string The path
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Set the Vars base path
     *
     * @param string  $path            The  path to set
     * @param boolean $check_writeable Check whether dir is writeable

     * @throws \InvalidArgumentException If the path does not exist or is not writable
     *
     * @return \M1\Vars\Vars
     */
    public function setPath($path, $check_writeable = false)
    {
        if (is_null($path)) {
            return;
        }

        if (!is_dir($path) || ($check_writeable && !is_writable($path))) {
            throw new \InvalidArgumentException(sprintf(
                "'%s' base path does not exist or is not writable",
                $path
            ));
        }

        $this->path = realpath($path);
        return $this;
    }
}


1		<?php
2
3		/**
4		* This file is part of the m1\vars library
5		*
6		* (c) m1 <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* @package m1/vars
12		* @version 1.1.0
13		* @author Miles Croxford <[email protected]>
14		* @copyright Copyright (c) Miles Croxford <[email protected]>
15		* @license http://github.com/m1/vars/blob/master/LICENSE
16		* @link http://github.com/m1/vars/blob/master/README.MD Documentation
17		*/
18
19		namespace M1\Vars\Traits;
20
21		/**
22		* Path trait gives common operation functions needed for Paths in Vars
23		*
24		* @since 0.1.0
25		*/
26		trait PathTrait
27		{
28		/**
29		* The base path for the Vars config and cache folders
30		*
31		* @var string $path
32		*/
33		public $path;
34
35		/**
36		* Get the path
37		*
38		* @return string The path
39		*/
40	75	public function getPath()
41		{
42	75	return $this->path;
43		}
44
45		/**
46		* Set the Vars base path
47		*
48		* @param string $path The path to set
49		* @param boolean $check_writeable Check whether dir is writeable
50
51		* @throws \InvalidArgumentException If the path does not exist or is not writable
52		*
53		* @return \M1\Vars\Vars
54		*/
55	86	public function setPath($path, $check_writeable = false)
56		{
57	86	if (is_null($path)) {
58	83	return;
59		}
60
61	77	if (!is_dir($path) \|\| ($check_writeable && !is_writable($path))) {
62	2	throw new \InvalidArgumentException(sprintf(
63	2	"'%s' base path does not exist or is not writable",
64	2	$path
65		));
66		}
67
68	75	$this->path = realpath($path);
69	75	return $this;
70		}
71		}
72

m1 / Vars

GitHub Access Token became invalid

PathTrait::getPath() A last analyzed 2018-06-20 16:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PathTrait::getPath() A
last analyzed 2018-06-20 16:58 UTC