Module::getRelativeResourcePath() - Code Metrics - Inspection of "API: ModulePath template global now takes any comp..." - sminnee/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — resource-url-generator ( 79ebbf )

by Sam

created 2017-06-27 03:16 UTC

Module::getRelativeResourcePath() A

↳ Parent: Module

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace SilverStripe\Core\Manifest;

use Exception;
use Serializable;
use SilverStripe\Core\Injector\Injector;

class Module implements Serializable
{
    /**
     * Directory
     *
     * @var string
     */
    protected $path = null;

    /**
     * Base folder of application
     *
     * @var string
     */
    protected $basePath = null;

    /**
     * Cache of composer data
     *
     * @var array
     */
    protected $composerData = null;

    public function __construct($path, $base)
    {
        $this->path = rtrim($path, '/\\');
        $this->basePath = rtrim($base, '/\\');
        $this->loadComposer();
    }

    /**
     * Gets name of this module. Used as unique key and identifier for this module.
     *
     * If installed by composer, this will be the full composer name (vendor/name).
     * If not insalled by composer this will default to the basedir()
     *
     * @return string
     */
    public function getName()
    {
        return $this->getComposerName() ?: $this->getShortName();
    }

    /**
     * Get full composer name. Will be null if no composer.json is available
     *
     * @return string|null
     */
    public function getComposerName()
    {
        if (isset($this->composerData['name'])) {
            return $this->composerData['name'];
        }
        return null;
    }

    /**
     * Gets "short" name of this module. This is the base directory this module
     * is installed in.
     *
     * If installed in root, this will be generated from the composer name instead
     *
     * @return string
     */
    public function getShortName()
    {
        // If installed in the root directory we need to infer from composer
        if ($this->path === $this->basePath && $this->composerData) {

            // Sometimes we customise installer name
            if (isset($this->composerData['extra']['installer-name'])) {
                return $this->composerData['extra']['installer-name'];
            }

            // Strip from full composer name
            $composerName = $this->getComposerName();
            if ($composerName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                list(, $name) = explode('/', $composerName);
                return $name;
            }
        }

        // Base name of directory
        return basename($this->path);
    }

    /**
     * Get base path for this module
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Get path relative to base dir.
     * If module path is base this will be empty string
     *
     * @return string
     */
    public function getRelativePath()
    {
        return ltrim(substr($this->path, strlen($this->basePath)), '/\\');
    }

    public function serialize()
    {
        return json_encode([$this->path, $this->basePath, $this->composerData]);
    }

    public function unserialize($serialized)
    {
        list($this->path, $this->basePath, $this->composerData) = json_decode($serialized, true);
    }

    /**
     * Activate _config.php for this module, if one exists
     */
    public function activate()
    {
        $config = "{$this->path}/_config.php";
        if (file_exists($config)) {
            require_once $config;
        }
    }

    /**
     * @throws Exception
     */
    protected function loadComposer()
    {
        // Load composer data
        $path = "{$this->path}/composer.json";
        if (file_exists($path)) {
            $content = file_get_contents($path);
            $result = json_decode($content, true);
            if (json_last_error()) {
                $errorMessage = json_last_error_msg();
                throw new Exception("$path: $errorMessage");
            }
            $this->composerData = $result;

        }
    }

    /**
     * Gets path to physical file resource relative to base directory.
     * Directories included
     *
     * This method makes no distinction between public / local resources,
     * which may change in the near future.
     *
     * @internal Experimental API and may change
     * @param string $path File or directory path relative to module directory
     * @return string Path relative to base directory
     */
    public function getRelativeResourcePath($path)
    {
        $base = trim($this->getRelativePath(), '/\\');
        $path = trim($path, '/\\');
        return trim("{$base}/{$path}", '/\\');
    }

    /**
     * Gets path to physical file resource relative to base directory.
     * Directories included
     *
     * This method makes no distinction between public / local resources,
     * which may change in the near future.
     *
     * @internal Experimental API and may change
     * @param string $path File or directory path relative to module directory
     * @return string Path relative to base directory
     */
    public function getResourcePath($path)
    {
        $base = $this->basePath . $this->getRelativeResourcePath($path);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }

    /**
     * Gets the URL for a given resource.
     * Relies on the ModuleURLGenerator Injector service to do the heavy lifting
     *
     * @internal Experimental API and may change
     * @param string $path File or directory path relative to module directory
     * @return string URL, either domain-relative (starting with /) or absolute
     */
    public function getResourceURL($path)
    {
        return Injector::inst()
            ->get(ResourceURLGenerator::class)
            ->urlForResource($this->getRelativeResourcePath($path));
    }

    /**
     * Check if this module has a given resource
     *
     * @internal Experimental API and may change
     * @param string $path
     * @return bool
     */
    public function hasResource($path)
    {
        return file_exists($this->getResourcePath($path));
    }
}


1			<?php
2
3			namespace SilverStripe\Core\Manifest;
4
5			use Exception;
6			use Serializable;
7			use SilverStripe\Core\Injector\Injector;
8
9			class Module implements Serializable
10			{
11			/**
12			* Directory
13			*
14			* @var string
15			*/
16			protected $path = null;
17
18			/**
19			* Base folder of application
20			*
21			* @var string
22			*/
23			protected $basePath = null;
24
25			/**
26			* Cache of composer data
27			*
28			* @var array
29			*/
30			protected $composerData = null;
31
32			public function __construct($path, $base)
33			{
34			$this->path = rtrim($path, '/\\');
35			$this->basePath = rtrim($base, '/\\');
36			$this->loadComposer();
37			}
38
39			/**
40			* Gets name of this module. Used as unique key and identifier for this module.
41			*
42			* If installed by composer, this will be the full composer name (vendor/name).
43			* If not insalled by composer this will default to the basedir()
44			*
45			* @return string
46			*/
47			public function getName()
48			{
49			return $this->getComposerName() ?: $this->getShortName();
50			}
51
52			/**
53			* Get full composer name. Will be null if no composer.json is available
54			*
55			* @return string\|null
56			*/
57			public function getComposerName()
58			{
59			if (isset($this->composerData['name'])) {
60			return $this->composerData['name'];
61			}
62			return null;
63			}
64
65			/**
66			* Gets "short" name of this module. This is the base directory this module
67			* is installed in.
68			*
69			* If installed in root, this will be generated from the composer name instead
70			*
71			* @return string
72			*/
73			public function getShortName()
74			{
75			// If installed in the root directory we need to infer from composer
76			if ($this->path === $this->basePath && $this->composerData) {
			0 ignored issues – show Bug Best Practice introduced 2017-03-13 20:53 UTC by Report Bug Copy Issue Report The expression `$this->composerData` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
77			// Sometimes we customise installer name
78			if (isset($this->composerData['extra']['installer-name'])) {
79			return $this->composerData['extra']['installer-name'];
80			}
81
82			// Strip from full composer name
83			$composerName = $this->getComposerName();
84			if ($composerName) {
			0 ignored issues – show Bug Best Practice introduced 2017-03-13 20:53 UTC by Report Bug Copy Issue Report The expression `$composerName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
85			list(, $name) = explode('/', $composerName);
86			return $name;
87			}
88			}
89
90			// Base name of directory
91			return basename($this->path);
92			}
93
94			/**
95			* Get base path for this module
96			*
97			* @return string
98			*/
99			public function getPath()
100			{
101			return $this->path;
102			}
103
104			/**
105			* Get path relative to base dir.
106			* If module path is base this will be empty string
107			*
108			* @return string
109			*/
110			public function getRelativePath()
111			{
112			return ltrim(substr($this->path, strlen($this->basePath)), '/\\');
113			}
114
115			public function serialize()
116			{
117			return json_encode([$this->path, $this->basePath, $this->composerData]);
118			}
119
120			public function unserialize($serialized)
121			{
122			list($this->path, $this->basePath, $this->composerData) = json_decode($serialized, true);
123			}
124
125			/**
126			* Activate _config.php for this module, if one exists
127			*/
128			public function activate()
129			{
130			$config = "{$this->path}/_config.php";
131			if (file_exists($config)) {
132			require_once $config;
133			}
134			}
135
136			/**
137			* @throws Exception
138			*/
139			protected function loadComposer()
140			{
141			// Load composer data
142			$path = "{$this->path}/composer.json";
143			if (file_exists($path)) {
144			$content = file_get_contents($path);
145			$result = json_decode($content, true);
146			if (json_last_error()) {
147			$errorMessage = json_last_error_msg();
148			throw new Exception("$path: $errorMessage");
149			}
150			$this->composerData = $result;
			0 ignored issues – show Documentation Bug introduced 2017-06-22 23:23 UTC by Report Bug Copy Issue Report It seems like `$result` of type `*` is incompatible with the declared type `array` of property `$composerData`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
151			}
152			}
153
154			/**
155			* Gets path to physical file resource relative to base directory.
156			* Directories included
157			*
158			* This method makes no distinction between public / local resources,
159			* which may change in the near future.
160			*
161			* @internal Experimental API and may change
162			* @param string $path File or directory path relative to module directory
163			* @return string Path relative to base directory
164			*/
165			public function getRelativeResourcePath($path)
166			{
167			$base = trim($this->getRelativePath(), '/\\');
168			$path = trim($path, '/\\');
169			return trim("{$base}/{$path}", '/\\');
170			}
171
172			/**
173			* Gets path to physical file resource relative to base directory.
174			* Directories included
175			*
176			* This method makes no distinction between public / local resources,
177			* which may change in the near future.
178			*
179			* @internal Experimental API and may change
180			* @param string $path File or directory path relative to module directory
181			* @return string Path relative to base directory
182			*/
183			public function getResourcePath($path)
184			{
185			$base = $this->basePath . $this->getRelativeResourcePath($path);
			0 ignored issues – show Unused Code introduced 2017-06-27 03:21 UTC by Report Bug Copy Issue Report `$base` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
186			}
187
188			/**
189			* Gets the URL for a given resource.
190			* Relies on the ModuleURLGenerator Injector service to do the heavy lifting
191			*
192			* @internal Experimental API and may change
193			* @param string $path File or directory path relative to module directory
194			* @return string URL, either domain-relative (starting with /) or absolute
195			*/
196			public function getResourceURL($path)
197			{
198			return Injector::inst()
199			->get(ResourceURLGenerator::class)
200			->urlForResource($this->getRelativeResourcePath($path));
201			}
202
203			/**
204			* Check if this module has a given resource
205			*
206			* @internal Experimental API and may change
207			* @param string $path
208			* @return bool
209			*/
210			public function hasResource($path)
211			{
212			return file_exists($this->getResourcePath($path));
213			}
214			}
215

sminnee / silverstripe-framework

Push — resource-url-generator ( 79ebbf )

Module::getRelativeResourcePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like