PropertiesUtil::__construct() - Code Metrics - appserver-io/properties - Measure and Improve Code Quality continuously with Scrutinizer

PropertiesUtil::__construct() A
last analyzed 2017-06-07 10:16 UTC

↳ Parent: PropertiesUtil

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * \AppserverIo\Properties\PropertiesUtil
 *
 * 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 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://github.com/appserver-io/properties
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Properties;

use AppserverIo\Properties\Filter\PropertyStreamFilter;
use AppserverIo\Properties\Filter\PropertyStreamFilterParams;

/**
 * Utility class providing some helper functionality to handle properties files.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://github.com/appserver-io/properties
 * @link      http://www.appserver.io
 */
class PropertiesUtil
{

    /**
     * The singleton instance.
     *
     * @var \AppserverIo\Properties\PropertiesUtil
     */
    protected static $instance;

    /**
     * This is a utility class, so protect it against direct
     * instantiation.
     */
    private function __construct()
    {
    }

    /**
     * This is a utility class, so protect it against cloning.
     *
     * @return void
     */
    private function __clone()
    {
    }

    /**
     * Return's the singleton instance and creates a new one if necessary.
     *
     * @return \AppserverIo\Properties\PropertiesUtil The singleton instance
     */
    public static function singleton()
    {

        // query whether or not we've already an instance created
        if (PropertiesUtil::$instance == null) {
            PropertiesUtil::$instance = new PropertiesUtil();
        }

        // return the singleton instance
        return PropertiesUtil::$instance;
    }

    /**
     * Replaces the variables declared in the properties with the
     * properties value itself.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the variables/values to replace
     * @param string                                      $pattern    The pattern that declares the variables (in valid sprintf format)
     *
     * @return void
     */
    public function replaceProperties(PropertiesInterface $properties, $pattern = PropertyStreamFilterParams::PATTERN)

    {
        foreach ($properties as $key => $value) {

            $properties->setProperty($key, $this->replacePropertiesInString($properties, $value));
        }
    }

    /**
     * Replaces the variables declared by the passed token with the
     * properties and returns the content.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the values to replace
     * @param string                                      $string     The string to replace the variables with the properties
     * @param string                                      $pattern    The pattern that declares the variables (in valid sprintf format)
     *
     * @return string The content of the file with the replaced variables
     */
    public function replacePropertiesInString(PropertiesInterface $properties, $string, $pattern = PropertyStreamFilterParams::PATTERN)
    {

        // open the stream
        $fp = fopen('php://temp', 'r+');

        // write/rewind the content into the string to allow using stream filters
        fputs($fp, $string);
        rewind($fp);

        // replace the properties and close the stream
        $replaced = $this->replacePropertiesInStream($properties, $fp, $pattern);
        fclose($fp);

        // return the string with the properties replaced
        return $replaced;
    }

    /**
     * Replaces the variables declared by the passed token with the
     * properties and returns the content.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the values to replace
     * @param resource                                    $fp         The file pointer to replace the variables with the properties
     * @param string                                      $pattern    The pattern that declares the variables (in valid sprintf format)
     *
     * @return string The content of the file with the replaced variables
     */
    public function replacePropertiesInStream(PropertiesInterface $properties, $fp, $pattern = PropertyStreamFilterParams::PATTERN)
    {

        // initialize the params for the stream filter
        $params = new PropertyStreamFilterParams($properties, $pattern);

        // register the filter
        stream_filter_register(PropertyStreamFilter::NAME, 'AppserverIo\Properties\Filter\PropertyStreamFilter');
        stream_filter_append($fp, PropertyStreamFilter::NAME, STREAM_FILTER_READ, $params);

        // replace the properties and close the stream
        return stream_get_contents($fp);
    }
}


1		<?php
2
3		/**
4		* \AppserverIo\Properties\PropertiesUtil
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 2015 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link http://github.com/appserver-io/properties
18		* @link http://www.appserver.io
19		*/
20
21		namespace AppserverIo\Properties;
22
23		use AppserverIo\Properties\Filter\PropertyStreamFilter;
24		use AppserverIo\Properties\Filter\PropertyStreamFilterParams;
25
26		/**
27		* Utility class providing some helper functionality to handle properties files.
28		*
29		* @author Tim Wagner <[email protected]>
30		* @copyright 2015 TechDivision GmbH <[email protected]>
31		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32		* @link http://github.com/appserver-io/properties
33		* @link http://www.appserver.io
34		*/
35		class PropertiesUtil
36		{
37
38		/**
39		* The singleton instance.
40		*
41		* @var \AppserverIo\Properties\PropertiesUtil
42		*/
43		protected static $instance;
44
45		/**
46		* This is a utility class, so protect it against direct
47		* instantiation.
48		*/
49	1	private function __construct()
50		{
51	1	}
52
53		/**
54		* This is a utility class, so protect it against cloning.
55		*
56		* @return void
57		*/
58		private function __clone()
59		{
60		}
61
62		/**
63		* Return's the singleton instance and creates a new one if necessary.
64		*
65		* @return \AppserverIo\Properties\PropertiesUtil The singleton instance
66		*/
67	2	public static function singleton()
68		{
69
70		// query whether or not we've already an instance created
71	2	if (PropertiesUtil::$instance == null) {
72	1	PropertiesUtil::$instance = new PropertiesUtil();
73	1	}
74
75		// return the singleton instance
76	2	return PropertiesUtil::$instance;
77		}
78
79		/**
80		* Replaces the variables declared in the properties with the
81		* properties value itself.
82		*
83		* @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the variables/values to replace
84		* @param string $pattern The pattern that declares the variables (in valid sprintf format)
85		*
86		* @return void
87		*/
88	1	public function replaceProperties(PropertiesInterface $properties, $pattern = PropertyStreamFilterParams::PATTERN)
		0 ignored issues – show Unused Code introduced 2016-04-15 20:02 UTC by Report Bug Copy Issue Report The parameter `$pattern` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
89		{
90	1	foreach ($properties as $key => $value) {
		0 ignored issues – show Bug introduced 2016-04-15 20:02 UTC by Report Bug Copy Issue Report The expression `$properties` of type `object<AppserverIo\Prope...es\PropertiesInterface>` is not traversable. Loading history...
91	1	$properties->setProperty($key, $this->replacePropertiesInString($properties, $value));
92	1	}
93	1	}
94
95		/**
96		* Replaces the variables declared by the passed token with the
97		* properties and returns the content.
98		*
99		* @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the values to replace
100		* @param string $string The string to replace the variables with the properties
101		* @param string $pattern The pattern that declares the variables (in valid sprintf format)
102		*
103		* @return string The content of the file with the replaced variables
104		*/
105	2	public function replacePropertiesInString(PropertiesInterface $properties, $string, $pattern = PropertyStreamFilterParams::PATTERN)
106		{
107
108		// open the stream
109	2	$fp = fopen('php://temp', 'r+');
110
111		// write/rewind the content into the string to allow using stream filters
112	2	fputs($fp, $string);
113	2	rewind($fp);
114
115		// replace the properties and close the stream
116	2	$replaced = $this->replacePropertiesInStream($properties, $fp, $pattern);
117	2	fclose($fp);
118
119		// return the string with the properties replaced
120	2	return $replaced;
121		}
122
123		/**
124		* Replaces the variables declared by the passed token with the
125		* properties and returns the content.
126		*
127		* @param \AppserverIo\Properties\PropertiesInterface $properties The properties with the values to replace
128		* @param resource $fp The file pointer to replace the variables with the properties
129		* @param string $pattern The pattern that declares the variables (in valid sprintf format)
130		*
131		* @return string The content of the file with the replaced variables
132		*/
133	2	public function replacePropertiesInStream(PropertiesInterface $properties, $fp, $pattern = PropertyStreamFilterParams::PATTERN)
134		{
135
136		// initialize the params for the stream filter
137	2	$params = new PropertyStreamFilterParams($properties, $pattern);
138
139		// register the filter
140	2	stream_filter_register(PropertyStreamFilter::NAME, 'AppserverIo\Properties\Filter\PropertyStreamFilter');
141	2	stream_filter_append($fp, PropertyStreamFilter::NAME, STREAM_FILTER_READ, $params);
142
143		// replace the properties and close the stream
144	2	return stream_get_contents($fp);
145		}
146		}
147

appserver-io / properties

PropertiesUtil::__construct() A last analyzed 2017-06-07 10:16 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PropertiesUtil::__construct() A
last analyzed 2017-06-07 10:16 UTC