Common::__construct() - Code Metrics - HuasoFoundries/math_histogram - Measure and Improve Code Quality continuously with Scrutinizer

Common::__construct() A
last analyzed 2018-06-06 14:42 UTC

↳ Parent: Common

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace HuasoFoundries\Histogram\Printer;

/**
 * Base class for histogram printer objects
 *
 * @author  Jesus M. Castagnetto <[email protected]>
 * @version 0.9.1beta
 * @access  public
 * @package Histogram
 */
class Common
{

    // properties

    /**
     * An associative array of options for the printer object
     *
     * @access private
     * @var array
     */
    public $_options;

    /**
     * The Histogram object
     *
     * @access private
     * @var object Histogram
     * @see Histogram
     */
    public $_hist;

    //

    /**
     * Constructor
     *
     * @access  public
     * @param   optional array $options     An associative array of printer options
     * @param   optional object Histogram $hist    A Histogram object
     * @return  object  Histogram_Printer_Common
     */
    public function __construct($hist = null, $options = null)
    {
        $this->setHistogram($hist);
        $this->setOptions($options);
    }

    /**
     * Sets the printer options
     *
     * @access  public
     * @param   array $options     An associative array of printer options
     *              Common options:
     *              'useHTTPHeaders' (default = false), whether to output HTTP headers when using printOutput()
     *              'outputStatistics' (default = false), whether to include histogram statistics when generating the output
     * @return  boolean TRUE on success, FALSE otherwise
     */
    public function setOptions($options)
    {
        if (!is_array($options)) {

            $this->_options = null;
            return false;
        } else {
            $this->_options = $options;
            return true;
        }
        if (!array_key_exists('useHTTPHeaders', $this->_options)) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            $this->_options['useHTTPHeaders'] = false;
        }
        if (!array_key_exists('outputStatistics', $this->_options)) {
            $this->_options['outputStatistics'] = false;
        }
    }

    /**
     * Sets the Histogram object to plot
     *
     * @access  public
     * @param   object Histogram $hist A Histogram instance
filter:
    dependency_paths: ["lib/*"]
     * @return  boolean TRUE on success, FALSE otherwise
     */
    public function setHistogram(&$hist)
    {
        if (\HuasoFoundries\Histogram\Histogram::isValidHistogram($hist)) {
            $this->_hist = &$hist;
            return true;
        } else {
            $this->_hist = null;
            return false;
        }
    }

    // override this method in child classes
    /**
     * Returns a (binary safe) string representation of a Histogram plot
     *
     * @access public
     * @return string|PEAR_Error A string on succcess, a \PEAR_Error otherwise
filter:
    dependency_paths: ["lib/*"]
     */
    public function generateOutput()
    {
        throw new \PEAR_Exception('Unimplemented method');
    }

    // override this method in child classes
    /**
     * Prints out a graphic representation of a Histogram
     *
     * @access public
     * @return boolean|PEAR_Error TRUE on success, a \PEAR_Error otherwise
     */
    public function printOutput()
    {
        throw new \PEAR_Exception('Unimplemented method');
    }

    // override this method in child classes
    /**
     * Static method to print out a graphic representation of a Histogram
     *
     * @static
     * @access public
     * @param object Histogram $hist A Histogram instance
     * @param array $options An array of options for the printer object
     * @return boolean|PEAR_Error TRUE on success, a \PEAR_Error otherwise
     */
    public function printHistogram(&$hist, $options = array())
    {
        throw new \PEAR_Exception('Unimplemented method');
    }

    /**
     * Utility method to do static printing
     *
     * @static
     * @access private
     * @param object $printer An instance of a Histogram_Printer_* class
     * @param object Histogram $hist A Histogram instance
     * @param array $options An array of options for the printer object
     * @return boolean|PEAR_Error TRUE on success, a \PEAR_Error otherwise
     */
    public function _doStaticPrint(&$printer, &$hist, $options)
    {
        if (!$printer->setHistogram($hist)) {
            throw new \PEAR_Exception('Not a valid Histogram object');
        }
        if (!$printer->setOptions($options)) {
            throw new \PEAR_Exception('Expecting an associative array of options');
        }
        // try to plot, clean up object, and return
        $err = $printer->printOutput();
        unset($printer);
        return $err;
    }
}

// vim: ts=4:sw=4:et:
// vim6: fdl=1:


1			<?php
2			namespace HuasoFoundries\Histogram\Printer;
3
4			/**
5			* Base class for histogram printer objects
6			*
7			* @author Jesus M. Castagnetto <[email protected]>
8			* @version 0.9.1beta
9			* @access public
10			* @package Histogram
11			*/
12			class Common
13			{
14
15			// properties
16
17			/**
18			* An associative array of options for the printer object
19			*
20			* @access private
21			* @var array
22			*/
23			public $_options;
24
25			/**
26			* The Histogram object
27			*
28			* @access private
29			* @var object Histogram
30			* @see Histogram
31			*/
32			public $_hist;
33
34			//
35
36			/**
37			* Constructor
38			*
39			* @access public
40			* @param optional array $options An associative array of printer options
41			* @param optional object Histogram $hist A Histogram object
42			* @return object Histogram_Printer_Common
43			*/
44			public function __construct($hist = null, $options = null)
45			{
46			$this->setHistogram($hist);
47			$this->setOptions($options);
48			}
49
50			/**
51			* Sets the printer options
52			*
53			* @access public
54			* @param array $options An associative array of printer options
55			* Common options:
56			* 'useHTTPHeaders' (default = false), whether to output HTTP headers when using printOutput()
57			* 'outputStatistics' (default = false), whether to include histogram statistics when generating the output
58			* @return boolean TRUE on success, FALSE otherwise
59			*/
60			public function setOptions($options)
61			{
62			if (!is_array($options)) {
			0 ignored issues – show introduced 2018-06-06 14:42 UTC by Report Bug Copy Issue Report The condition `is_array($options)` is always `true`. Loading history...
63			$this->_options = null;
64			return false;
65			} else {
66			$this->_options = $options;
67			return true;
68			}
69			if (!array_key_exists('useHTTPHeaders', $this->_options)) {
			0 ignored issues – show Unused Code introduced 2017-10-09 01:52 UTC by Report Bug Copy Issue Report `IfNode` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
70			$this->_options['useHTTPHeaders'] = false;
71			}
72			if (!array_key_exists('outputStatistics', $this->_options)) {
73			$this->_options['outputStatistics'] = false;
74			}
75			}
76
77			/**
78			* Sets the Histogram object to plot
79			*
80			* @access public
81			* @param object Histogram $hist A Histogram instance
			0 ignored issues – show Bug introduced 2018-06-06 14:42 UTC by Report Bug Copy Issue Report The type `HuasoFoundries\Histogram\Printer\Histogram` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
82			* @return boolean TRUE on success, FALSE otherwise
83			*/
84			public function setHistogram(&$hist)
85			{
86			if (\HuasoFoundries\Histogram\Histogram::isValidHistogram($hist)) {
87			$this->_hist = &$hist;
88			return true;
89			} else {
90			$this->_hist = null;
91			return false;
92			}
93			}
94
95			// override this method in child classes
96			/**
97			* Returns a (binary safe) string representation of a Histogram plot
98			*
99			* @access public
100			* @return string\|PEAR_Error A string on succcess, a \PEAR_Error otherwise
			0 ignored issues – show Bug introduced 2017-10-09 01:52 UTC by Report Bug Copy Issue Report The type `HuasoFoundries\Histogram\Printer\PEAR_Error` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
101			*/
102			public function generateOutput()
103			{
104			throw new \PEAR_Exception('Unimplemented method');
105			}
106
107			// override this method in child classes
108			/**
109			* Prints out a graphic representation of a Histogram
110			*
111			* @access public
112			* @return boolean\|PEAR_Error TRUE on success, a \PEAR_Error otherwise
113			*/
114			public function printOutput()
115			{
116			throw new \PEAR_Exception('Unimplemented method');
117			}
118
119			// override this method in child classes
120			/**
121			* Static method to print out a graphic representation of a Histogram
122			*
123			* @static
124			* @access public
125			* @param object Histogram $hist A Histogram instance
126			* @param array $options An array of options for the printer object
127			* @return boolean\|PEAR_Error TRUE on success, a \PEAR_Error otherwise
128			*/
129			public function printHistogram(&$hist, $options = array())
130			{
131			throw new \PEAR_Exception('Unimplemented method');
132			}
133
134			/**
135			* Utility method to do static printing
136			*
137			* @static
138			* @access private
139			* @param object $printer An instance of a Histogram_Printer_* class
140			* @param object Histogram $hist A Histogram instance
141			* @param array $options An array of options for the printer object
142			* @return boolean\|PEAR_Error TRUE on success, a \PEAR_Error otherwise
143			*/
144			public function _doStaticPrint(&$printer, &$hist, $options)
145			{
146			if (!$printer->setHistogram($hist)) {
147			throw new \PEAR_Exception('Not a valid Histogram object');
148			}
149			if (!$printer->setOptions($options)) {
150			throw new \PEAR_Exception('Expecting an associative array of options');
151			}
152			// try to plot, clean up object, and return
153			$err = $printer->printOutput();
154			unset($printer);
155			return $err;
156			}
157			}
158
159			// vim: ts=4:sw=4:et:
160			// vim6: fdl=1:
161

HuasoFoundries / math_histogram

Common::__construct() A last analyzed 2018-06-06 14:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Common::__construct() A
last analyzed 2018-06-06 14:42 UTC