AbstractResources::getKeys() - Code Metrics - appserver-io/resources - Measure and Improve Code Quality continuously with Scrutinizer

AbstractResources::getKeys() A
last analyzed 2018-05-14 17:07 UTC

↳ Parent: AbstractResources

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	6
nc	4
nop	0
dl	0
loc	17
rs	9.2
c	0
b	0
f	0

<?PHP

/**
 * AppserverIo\Resources\Interfaces\Resources
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2018 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/resources
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Resources;

use AppserverIo\Lang\String;
use AppserverIo\Collections\HashMap;
use AppserverIo\Collections\ArrayList;
use AppserverIo\Resources\Interfaces\ResourcesInterface;
use AppserverIo\Resources\Interfaces\ResourceBundleInterface;
use AppserverIo\Resources\Exceptions\SystemLocaleNotExistsException;

/**
 * Abstract class of all resources.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2018 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/resources
 * @link      http://www.appserver.io
 */
abstract class AbstractResources implements ResourcesInterface
{

    /**
     * Holds the flag to return null if a requested propert does not exists.
     *
     * @var boolean
     */
    protected $returnNull = true;

    /**
     * Holds the default system locale of this resources.
     *
     * @var \AppserverIo\Resources\SystemLocale
     */
    protected $defaultSystemLocale = null;

    /**
     * Holds the name of the resource bundle
     *
     * @var \AppserverIo\Lang\String
     */
    protected $name = null;

    /**
     * Holds the HashMap with the initialized ResourceBundle instances.
     *
     * @var \AppserverIo\Collections\HashMap
     */
    protected $bundles = null;

    /**
     * The constructor initializes the resources with the database connection to
     * load the resources from.
     *
     * @param \AppserverIo\Lang\String $name Holds the logical name of the Resources to create
     *
     * @return void
     */
    public function __construct(String $name)
    {
        $this->setName($name);
    }

    /**
     * This method sets the name of the resource bundle.
     *
     * @param \AppserverIo\Lang\String $name The name of the resource bundle
     *
     * @return void
     */
    public function setName(String $name)
    {
        $this->name = $name;

    }

    /**
     * This method returns the name of the resource bundle.
     *
     * @return \AppserverIo\Lang\String The name of the resource bundle
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Return TRUE if resource getter methods will return null instead of throwing an exception on invalid
     * key values.
     *
     * @return boolean TRUE if null is returned for invalid key values.
     * @see \AppserverIo\Resources\Interfaces\ResourcesInterface::isReturnNull()
     */
    public function isReturnNull()
    {
        return $this->returnNull;
    }

    /**
     * Set a flag determining whether resource getter methods should return null instead of throwing an
     * exception on invalid key values.
     *
     * @param boolean $returnNull The new flag value
     *
     * @return void
     * @see \AppserverIo\Resources\Interfaces\ResourcesInterface::setReturnNull($returnNull)
     */
    public function setReturnNull($returnNull)
    {
        $this->returnNull = $returnNull;
    }

    /**
     * Sets the default system locale for this resources.
     *
     * @param \AppserverIo\Resources\SystemLocale $systemLocale The default system locale for this resources
     *
     * @return void
     */
    public function setDefaultSystemLocale(SystemLocale $systemLocale)
    {
        $this->defaultSystemLocale = $systemLocale;
    }

    /**
     * Returns the default system locale for this resources.
     *
     * @return \AppserverIo\Resources\SystemLocale The default system locale for this resources
     */
    public function getDefaultSystemLocale()
    {
        return $this->defaultSystemLocale;
    }

    /**
     * Create (if necessary) and return a Resources instance for the specified logical name, with a
     * configuration based on the specified configuration string.
     *
     * @return void
     * @throws \AppserverIo\Resources\Exceptions\ResourcesException Is thrown if an exception occurs when the Resources are initialized
     * @see \AppserverIo\Resources\Interfaces\ResourcesInterface::initialize()
     */
    public function initialize()
    {
        $this->bundles = new HashMap();
    }

    /**
     * Release any internal references to Resources instances that have been returned previously, after
     * calling the destroy() method on each such instance.
     *
     * @return void
     * @see \AppserverIo\Resources\Interfaces\ResourcesInterface::destroy()
     */
    public function destroy()
    {

        // invoke the destroy method of the resource bundle instances
        foreach ($this->bundles as $bundle) {
            $bundle->destroy();
        }

        // reset the HashMap
        $this->bundles = new HashMap();
    }

    /**
     * This method saves all resource files back to the file system.
     *
     * @return void
     */
    public function save()
    {

        // iterate over all resources and save them
        foreach ($this->bundles as $resourcesBundle) {
            $resourcesBundle->save();
        }
    }

    /**
     * Returns the keys of this Resources instance
     * as an ArrayList.
     *
     * @return \AppserverIo\Collections\ArrayList Holds the keys of this Resources instance
     * @see \AppserverIo\Resources\Interfaces\ResourcesInterface::getKeys()
     */
    public function getKeys()
    {

        // initialize the array with the keys
        $keys = array();

        // iterate over all bundles and the keys of the bundles
        foreach ($this->bundles as $bundle) {
            foreach ($bundle->getKeys() as $key) {
                if (!in_array($key, $keys)) {
                    $keys[] = $key;
                }
            }
        }

        // return the ArrayList with the unique keys
        return new ArrayList($keys);
    }

    /**
     * This method adds the passed resource bundle instance to the HashMap with the initialized bundles.
     *
     * If resources with the same system locale as the system locale of the passed resource bundle instance
     * exists, they will be replaced by the passed one.
     *
     * @param \AppserverIo\Resources\Interfaces\ResourceBundleInterface $newBundle Holds the resource bundle to add
     *
     * @return void
     */
    protected function add(ResourceBundleInterface $newBundle)
    {
        $this->bundles->add($newBundle->getSystemLocale()->__toString(), $newBundle);
    }

    /**
     * This method returns the resources for the passed system locale.
     *
     * If the requested resources does not exist an exception is thrown.
     *
     * @param \AppserverIo\Resources\SystemLocale $systemLocale Holds the system locale to return the resources for
     *
     * @return \AppserverIo\Resources\Interfaces\ResourceBundleInterface Holds the initialized resource bundle instance
     * @throws \AppserverIo\Resources\Exceptions\SystemLocaleNotExistsException Is throw if the requested resources is not available
     */
    protected function get(SystemLocale $systemLocale)
    {

        // check if resources for the passed system locale exists
        if (!$this->exists($systemLocale)) {
            throw new SystemLocaleNotExistsException('ResourceBundle for system locale ' . $systemLocale->__toString() . ' is not available');
        }

        // returns the requested resources
        return $this->bundles->get($systemLocale->__toString());
    }

    /**
     * This method checks if resources for the passed system locale already exists in the bundle or not.
     *
     * @param \AppserverIo\Resources\SystemLocale $systemLocale Holds the system locale to check for
     *
     * @return boolean TRUE if resources for the passed system locale exists, else FALSE
     */
    protected function exists(SystemLocale $systemLocale)
    {
        return $this->bundles->exists($systemLocale->__toString());

    }
}


1			<?PHP
2
3			/**
4			* AppserverIo\Resources\Interfaces\Resources
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2018 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/appserver-io/resources
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Resources;
22
23			use AppserverIo\Lang\String;
24			use AppserverIo\Collections\HashMap;
25			use AppserverIo\Collections\ArrayList;
26			use AppserverIo\Resources\Interfaces\ResourcesInterface;
27			use AppserverIo\Resources\Interfaces\ResourceBundleInterface;
28			use AppserverIo\Resources\Exceptions\SystemLocaleNotExistsException;
29
30			/**
31			* Abstract class of all resources.
32			*
33			* @author Tim Wagner <[email protected]>
34			* @copyright 2018 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link https://github.com/appserver-io/resources
37			* @link http://www.appserver.io
38			*/
39			abstract class AbstractResources implements ResourcesInterface
40			{
41
42			/**
43			* Holds the flag to return null if a requested propert does not exists.
44			*
45			* @var boolean
46			*/
47			protected $returnNull = true;
48
49			/**
50			* Holds the default system locale of this resources.
51			*
52			* @var \AppserverIo\Resources\SystemLocale
53			*/
54			protected $defaultSystemLocale = null;
55
56			/**
57			* Holds the name of the resource bundle
58			*
59			* @var \AppserverIo\Lang\String
60			*/
61			protected $name = null;
62
63			/**
64			* Holds the HashMap with the initialized ResourceBundle instances.
65			*
66			* @var \AppserverIo\Collections\HashMap
67			*/
68			protected $bundles = null;
69
70			/**
71			* The constructor initializes the resources with the database connection to
72			* load the resources from.
73			*
74			* @param \AppserverIo\Lang\String $name Holds the logical name of the Resources to create
75			*
76			* @return void
77			*/
78			public function __construct(String $name)
79			{
80			$this->setName($name);
81			}
82
83			/**
84			* This method sets the name of the resource bundle.
85			*
86			* @param \AppserverIo\Lang\String $name The name of the resource bundle
87			*
88			* @return void
89			*/
90			public function setName(String $name)
91			{
92			$this->name = $name;
			0 ignored issues – show Documentation Bug introduced 2018-05-14 16:55 UTC by Report Bug Copy Issue Report It seems like `$name` of type `string` is incompatible with the declared type `AppserverIo\Lang\String` of property `$name`. 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...
93			}
94
95			/**
96			* This method returns the name of the resource bundle.
97			*
98			* @return \AppserverIo\Lang\String The name of the resource bundle
99			*/
100			public function getName()
101			{
102			return $this->name;
103			}
104
105			/**
106			* Return TRUE if resource getter methods will return null instead of throwing an exception on invalid
107			* key values.
108			*
109			* @return boolean TRUE if null is returned for invalid key values.
110			* @see \AppserverIo\Resources\Interfaces\ResourcesInterface::isReturnNull()
111			*/
112			public function isReturnNull()
113			{
114			return $this->returnNull;
115			}
116
117			/**
118			* Set a flag determining whether resource getter methods should return null instead of throwing an
119			* exception on invalid key values.
120			*
121			* @param boolean $returnNull The new flag value
122			*
123			* @return void
124			* @see \AppserverIo\Resources\Interfaces\ResourcesInterface::setReturnNull($returnNull)
125			*/
126			public function setReturnNull($returnNull)
127			{
128			$this->returnNull = $returnNull;
129			}
130
131			/**
132			* Sets the default system locale for this resources.
133			*
134			* @param \AppserverIo\Resources\SystemLocale $systemLocale The default system locale for this resources
135			*
136			* @return void
137			*/
138			public function setDefaultSystemLocale(SystemLocale $systemLocale)
139			{
140			$this->defaultSystemLocale = $systemLocale;
141			}
142
143			/**
144			* Returns the default system locale for this resources.
145			*
146			* @return \AppserverIo\Resources\SystemLocale The default system locale for this resources
147			*/
148			public function getDefaultSystemLocale()
149			{
150			return $this->defaultSystemLocale;
151			}
152
153			/**
154			* Create (if necessary) and return a Resources instance for the specified logical name, with a
155			* configuration based on the specified configuration string.
156			*
157			* @return void
158			* @throws \AppserverIo\Resources\Exceptions\ResourcesException Is thrown if an exception occurs when the Resources are initialized
159			* @see \AppserverIo\Resources\Interfaces\ResourcesInterface::initialize()
160			*/
161			public function initialize()
162			{
163			$this->bundles = new HashMap();
164			}
165
166			/**
167			* Release any internal references to Resources instances that have been returned previously, after
168			* calling the destroy() method on each such instance.
169			*
170			* @return void
171			* @see \AppserverIo\Resources\Interfaces\ResourcesInterface::destroy()
172			*/
173			public function destroy()
174			{
175
176			// invoke the destroy method of the resource bundle instances
177			foreach ($this->bundles as $bundle) {
178			$bundle->destroy();
179			}
180
181			// reset the HashMap
182			$this->bundles = new HashMap();
183			}
184
185			/**
186			* This method saves all resource files back to the file system.
187			*
188			* @return void
189			*/
190			public function save()
191			{
192
193			// iterate over all resources and save them
194			foreach ($this->bundles as $resourcesBundle) {
195			$resourcesBundle->save();
196			}
197			}
198
199			/**
200			* Returns the keys of this Resources instance
201			* as an ArrayList.
202			*
203			* @return \AppserverIo\Collections\ArrayList Holds the keys of this Resources instance
204			* @see \AppserverIo\Resources\Interfaces\ResourcesInterface::getKeys()
205			*/
206			public function getKeys()
207			{
208
209			// initialize the array with the keys
210			$keys = array();
211
212			// iterate over all bundles and the keys of the bundles
213			foreach ($this->bundles as $bundle) {
214			foreach ($bundle->getKeys() as $key) {
215			if (!in_array($key, $keys)) {
216			$keys[] = $key;
217			}
218			}
219			}
220
221			// return the ArrayList with the unique keys
222			return new ArrayList($keys);
223			}
224
225			/**
226			* This method adds the passed resource bundle instance to the HashMap with the initialized bundles.
227			*
228			* If resources with the same system locale as the system locale of the passed resource bundle instance
229			* exists, they will be replaced by the passed one.
230			*
231			* @param \AppserverIo\Resources\Interfaces\ResourceBundleInterface $newBundle Holds the resource bundle to add
232			*
233			* @return void
234			*/
235			protected function add(ResourceBundleInterface $newBundle)
236			{
237			$this->bundles->add($newBundle->getSystemLocale()->__toString(), $newBundle);
238			}
239
240			/**
241			* This method returns the resources for the passed system locale.
242			*
243			* If the requested resources does not exist an exception is thrown.
244			*
245			* @param \AppserverIo\Resources\SystemLocale $systemLocale Holds the system locale to return the resources for
246			*
247			* @return \AppserverIo\Resources\Interfaces\ResourceBundleInterface Holds the initialized resource bundle instance
248			* @throws \AppserverIo\Resources\Exceptions\SystemLocaleNotExistsException Is throw if the requested resources is not available
249			*/
250			protected function get(SystemLocale $systemLocale)
251			{
252
253			// check if resources for the passed system locale exists
254			if (!$this->exists($systemLocale)) {
255			throw new SystemLocaleNotExistsException('ResourceBundle for system locale ' . $systemLocale->__toString() . ' is not available');
256			}
257
258			// returns the requested resources
259			return $this->bundles->get($systemLocale->__toString());
260			}
261
262			/**
263			* This method checks if resources for the passed system locale already exists in the bundle or not.
264			*
265			* @param \AppserverIo\Resources\SystemLocale $systemLocale Holds the system locale to check for
266			*
267			* @return boolean TRUE if resources for the passed system locale exists, else FALSE
268			*/
269			protected function exists(SystemLocale $systemLocale)
270			{
271			return $this->bundles->exists($systemLocale->__toString());
			0 ignored issues – show Bug Best Practice introduced 2018-05-14 16:55 UTC by Report Bug Copy Issue Report The expression `return $this->bundles->e...emLocale->__toString())` returns the type `AppserverIo\Lang\Boolean` which is incompatible with the documented return type `boolean`. Loading history...
272			}
273			}
274

appserver-io / resources

AbstractResources::getKeys() A last analyzed 2018-05-14 17:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractResources::getKeys() A
last analyzed 2018-05-14 17:07 UTC