WebLibrary::isAsync() - Code Metrics - Inspection of "Merge pull request #7 from donatienLef/asyncOption" - thecodingmachine/html.utils.weblibrarymanager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.0 ( 6f2c9f )

by David

created 2018-08-23 09:21 UTC

WebLibrary::isAsync() A

↳ Parent: WebLibrary

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php
namespace Mouf\Html\Utils\WebLibraryManager;

/**
 * A WebLibrary represents a set of CSS and JS files that can be integrated into your web application.
 * 
 * @author David Négrier
 */
class WebLibrary implements WebLibraryInterface {
	
	
	/**
	 * List of JS files to add in header.
     * If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
     * 
	 * @var array<string>
	 */
	private $jsFiles = array();

	/**
	 * List of CSS files to add in header.
	 * If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
	 *
	 * @var array<string>
	 */
	private $cssFiles = array();

	/**
	 * List of libraries this library depends on.
	 * 
	 * @var array<WebLibraryInterface>
	 */
	private $dependencies = array();

    /**
     * Boolean whether the dependencies are called asynchronously
     *
     * @var bool
     */
    private $async = false;
	
	
	/**
	 * Constructor
	 * 
	 * @param string[] $jsFiles List of JS files to add in header. If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
	 * @param string[] $cssFiles List of CSS files to add in header. If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
	 */
	
	public function __construct($jsFiles = array(), $cssFiles = array() ) {
		$this->jsFiles= $jsFiles;
		$this->cssFiles = $cssFiles;
	}
	
	/**
	 * Returns an array of Javascript files to be included for this library.
	 * 
	 * @return array<string>
	 */
	public function getJsFiles() {
		return $this->jsFiles;
	}
	
	/**
	 * List of JS files to put in the web library.
	 * <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
	 * <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
     * 
	 * @Property
	 * @param array<string> $jsFiles
	 */
	public function setJsFiles($jsFiles) {
		$this->jsFiles = $jsFiles;
	}
	
	/**
	 * Adds a JS file to the web library.
	 * <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
	 * <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
	 * 
	 * @param string $jsFile
	 */
	public function addJsFile($jsFile) {
		$this->jsFiles[] = $jsFile;
	}
	
	/**
	 * Returns an array of CSS files to be included for this library.
	 *
	 * @return array<string>
	 */
	public function getCssFiles() {
		return $this->cssFiles;
	}
	
	/**
	 * List of CSS files to add in web library.
	 * <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
	 * <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
	 *
	 * @Property
	 * @param array<string> $cssFiles
	 */
	public function setCssFiles($cssFiles) {
		$this->cssFiles = $cssFiles;
	}
	
	/**
	 * Adds a CSS file to the web library.
	 * <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
	 * <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
	 * 
	 * @param string $jsFile
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 */
	public function addCssFile($cssFile) {
		$this->cssFiles[] = $cssFile;
	}
	
	/**
	 * Returns a list of libraries that must be included before this library is included.
	 *
	 * @return array<WebLibraryInterface>
	 */
	public function getDependencies() {
		return $this->dependencies;
	}
	
	/**
	 * Returns a list of features provided by this library.
	 * A feature is typically a string describing what the file contains.
	 *
	 * For instance, an object representing the JQuery library would provide the "jquery" feature.
	 *
	 * @return array<string>
	 */
	public function getFeatures() {
		throw new \Exception("Not implemented yet!");
	}
	
	/**
	 * The list of all libraries that are needed for this library
	 * 
	 * @Property
	 * @param array<WebLibraryInterface> $libraries
	 */
	public function setDependencies($libraries) {
		$this->dependencies = $libraries;
	}

    /**
     * Returns if the dependencies are loaded asynchronously
     *
     * @return bool
     */
    public function isAsync() {
        return $this->async;
    }

    /**
     * Set if the dependencies are loaded asynchronously
     *
     * @Property
     * @param bool $async
     */
    public function setIsAsync($async) {
        $this->async = $async;
    }
}

1			<?php
2			namespace Mouf\Html\Utils\WebLibraryManager;
3
4			/**
5			* A WebLibrary represents a set of CSS and JS files that can be integrated into your web application.
6			*
7			* @author David Négrier
8			*/
9			class WebLibrary implements WebLibraryInterface {
10
11
12			/**
13			* List of JS files to add in header.
14			* If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
15			*
16			* @var array<string>
17			*/
18			private $jsFiles = array();
19
20			/**
21			* List of CSS files to add in header.
22			* If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
23			*
24			* @var array<string>
25			*/
26			private $cssFiles = array();
27
28			/**
29			* List of libraries this library depends on.
30			*
31			* @var array<WebLibraryInterface>
32			*/
33			private $dependencies = array();
34
35			/**
36			* Boolean whether the dependencies are called asynchronously
37			*
38			* @var bool
39			*/
40			private $async = false;
41
42
43			/**
44			* Constructor
45			*
46			* @param string[] $jsFiles List of JS files to add in header. If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
47			* @param string[] $cssFiles List of CSS files to add in header. If you don't specify http:// or https:// and if your URL does not start with /, the file is considered to be relative to ROOT_URL.
48			*/
49
50			public function __construct($jsFiles = array(), $cssFiles = array() ) {
51			$this->jsFiles= $jsFiles;
52			$this->cssFiles = $cssFiles;
53			}
54
55			/**
56			* Returns an array of Javascript files to be included for this library.
57			*
58			* @return array<string>
59			*/
60			public function getJsFiles() {
61			return $this->jsFiles;
62			}
63
64			/**
65			* List of JS files to put in the web library.
66			* <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
67			* <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
68			*
69			* @Property
70			* @param array<string> $jsFiles
71			*/
72			public function setJsFiles($jsFiles) {
73			$this->jsFiles = $jsFiles;
74			}
75
76			/**
77			* Adds a JS file to the web library.
78			* <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
79			* <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
80			*
81			* @param string $jsFile
82			*/
83			public function addJsFile($jsFile) {
84			$this->jsFiles[] = $jsFile;
85			}
86
87			/**
88			* Returns an array of CSS files to be included for this library.
89			*
90			* @return array<string>
91			*/
92			public function getCssFiles() {
93			return $this->cssFiles;
94			}
95
96			/**
97			* List of CSS files to add in web library.
98			* <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
99			* <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
100			*
101			* @Property
102			* @param array<string> $cssFiles
103			*/
104			public function setCssFiles($cssFiles) {
105			$this->cssFiles = $cssFiles;
106			}
107
108			/**
109			* Adds a CSS file to the web library.
110			* <p>If you don't specify http:// or https:// and if the file does not start with /, the file is considered to be relative to ROOT_URL.</p>
111			* <div class="info">It is a good practice to make sure the file does not start with /, http:// or https:// (unless you are using a CDN).</div>
112			*
113			* @param string $jsFile
			0 ignored issues – show Bug introduced 2017-01-12 11:23 UTC by Report Bug Copy Issue Report There is no parameter named `$jsFile`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
114			*/
115			public function addCssFile($cssFile) {
116			$this->cssFiles[] = $cssFile;
117			}
118
119			/**
120			* Returns a list of libraries that must be included before this library is included.
121			*
122			* @return array<WebLibraryInterface>
123			*/
124			public function getDependencies() {
125			return $this->dependencies;
126			}
127
128			/**
129			* Returns a list of features provided by this library.
130			* A feature is typically a string describing what the file contains.
131			*
132			* For instance, an object representing the JQuery library would provide the "jquery" feature.
133			*
134			* @return array<string>
135			*/
136			public function getFeatures() {
137			throw new \Exception("Not implemented yet!");
138			}
139
140			/**
141			* The list of all libraries that are needed for this library
142			*
143			* @Property
144			* @param array<WebLibraryInterface> $libraries
145			*/
146			public function setDependencies($libraries) {
147			$this->dependencies = $libraries;
148			}
149
150			/**
151			* Returns if the dependencies are loaded asynchronously
152			*
153			* @return bool
154			*/
155			public function isAsync() {
156			return $this->async;
157			}
158
159			/**
160			* Set if the dependencies are loaded asynchronously
161			*
162			* @Property
163			* @param bool $async
164			*/
165			public function setIsAsync($async) {
166			$this->async = $async;
167			}
168			}

thecodingmachine / html.utils.weblibrarymanager

Push — 4.0 ( 6f2c9f )

WebLibrary::isAsync() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like