HTML_QuickForm_file::freeze() - Code Metrics - Inspection of "Remove unused file" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.10.x ( 021894...0e6d9a )

unknown

created 2016-04-25 14:17 UTC

HTML_QuickForm_file::freeze() A

↳ Parent: HTML_QuickForm_file

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

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

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

/**
 * HTML class for a file upload field
 *
 * PHP versions 4 and 5
 *
 * LICENSE: This source file is subject to version 3.01 of the PHP license
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_01.txt If you did not receive a copy of
 * the PHP License and are unable to obtain it through the web, please
 * send a note to [email protected] so we can mail you a copy immediately.
 *
 * @category    HTML
 * @package     HTML_QuickForm
 * @author      Adam Daniel <[email protected]>
 * @author      Bertrand Mansion <[email protected]>
 * @author      Alexey Borzov <[email protected]>
 * @copyright   2001-2009 The PHP Group
 * @license     http://www.php.net/license/3_01.txt PHP License 3.01
 * @version     CVS: $Id: file.php,v 1.25 2009/04/04 21:34:02 avb Exp $
 * @link        http://pear.php.net/package/HTML_QuickForm
 */

/**
 * HTML class for a file upload field
 *
 * @category    HTML
 * @package     HTML_QuickForm
 * @author      Adam Daniel <[email protected]>
 * @author      Bertrand Mansion <[email protected]>
 * @author      Alexey Borzov <[email protected]>
 * @version     Release: 3.2.11
 * @since       1.0
 */
class HTML_QuickForm_file extends HTML_QuickForm_input
{
    // {{{ properties

   /**
    * Uploaded file data, from $_FILES
    * @var array
    */
    var $_value = null;

    // }}}
    // {{{ constructor

    /**
     * Class constructor
     *
     * @param     string    Input field name attribute
     * @param     string    Input field label
     * @param     mixed     (optional)Either a typical HTML attribute string
     *                      or an associative array
     * @since     1.0
     * @access    public
     */
    public function __construct($elementName=null, $elementLabel=null, $attributes=null)
    {
        parent::__construct($elementName, $elementLabel, $attributes);
        $this->setType('file');
    } //end constructor

    // }}}
    // {{{ setSize()

    /**
     * Sets size of file element
     *
     * @param     int    Size of file element
     * @since     1.0
     * @access    public
     */
    function setSize($size)
    {
        $this->updateAttributes(array('size' => $size));
    } //end func setSize

    // }}}
    // {{{ getSize()

    /**
     * Returns size of file element
     *
     * @since     1.0
     * @access    public
     * @return    int
     */
    function getSize()
    {
        return $this->getAttribute('size');
    } //end func getSize

    // }}}
    // {{{ freeze()

    /**
     * Freeze the element so that only its value is returned
     *
     * @access    public
     * @return    bool
     */
    function freeze()
    {
        return false;
    } //end func freeze

    // }}}
    // {{{ setValue()

    /**
     * Sets value for file element.
     *
     * Actually this does nothing. The function is defined here to override
     * HTML_Quickform_input's behaviour of setting the 'value' attribute. As
     * no sane user-agent uses <input type="file">'s value for anything
     * (because of security implications) we implement file's value as a
     * read-only property with a special meaning.
     *
     * @param     mixed    Value for file element
     * @since     3.0
     * @access    public
     */
    function setValue($value)
    {
        return null;
    } //end func setValue

    // }}}
    // {{{ getValue()

    /**
     * Returns information about the uploaded file
     *
     * @since     3.0
     * @access    public
     * @return    array
     */
    function getValue()
    {
        return $this->_value;
    } // end func getValue

    // }}}
    // {{{ onQuickFormEvent()

    /**
     * Called by HTML_QuickForm whenever form event is made on this element
     *
     * @param     string    Name of event
     * @param     mixed     event arguments
     * @param     object    calling object
     * @since     1.0
     * @access    public
     * @return    bool
     */
    function onQuickFormEvent($event, $arg, &$caller)
    {
        switch ($event) {
            case 'updateValue':
                if ($caller->getAttribute('method') == 'get') {
                    return PEAR::raiseError('Cannot add a file upload field to a GET method form');
                }
                $this->_value = $this->_findValue();

                $caller->updateAttributes(array('enctype' => 'multipart/form-data'));
                $caller->setMaxFileSize();
                break;
            case 'addElement':
                $this->onQuickFormEvent('createElement', $arg, $caller);
                return $this->onQuickFormEvent('updateValue', null, $caller);

                break;
            case 'createElement':
                //$className = get_class($this);
                //$this->$className($arg[0], $arg[1], $arg[2]);
                break;
        }
        return true;
    } // end func onQuickFormEvent

    // }}}
    // {{{ moveUploadedFile()

    /**
     * Moves an uploaded file into the destination
     *
     * @param    string  Destination directory path
     * @param    string  New file name
     * @access   public
     * @return   bool    Whether the file was moved successfully
     */
    public function moveUploadedFile($dest, $fileName = '')
    {
        if ($dest != ''  && substr($dest, -1) != '/') {
            $dest .= '/';
        }
        $fileName = ($fileName != '') ? $fileName : basename($this->_value['name']);
        return move_uploaded_file($this->_value['tmp_name'], $dest . $fileName);
    } // end func moveUploadedFile

    // }}}
    // {{{ isUploadedFile()

    /**
     * Checks if the element contains an uploaded file
     *
     * @access    public
     * @return    bool      true if file has been uploaded, false otherwise
     */
    public function isUploadedFile()
    {
        return self::_ruleIsUploadedFile($this->_value);
    } // end func isUploadedFile


    // }}}
    // {{{ _ruleIsUploadedFile()

    /**
     * Checks if the given element contains an uploaded file
     *
     * @param     array     Uploaded file info (from $_FILES)
     * @access    private
     * @return    bool      true if file has been uploaded, false otherwise
     */
    public static function _ruleIsUploadedFile($elementValue)
    {
        if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
            (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')) {
            return is_uploaded_file($elementValue['tmp_name']);
        } else {
            return false;
        }
    } // end func _ruleIsUploadedFile

    // }}}
    // {{{ _ruleCheckMaxFileSize()

   /**
    * Tries to find the element value from the values array
    *
    * Needs to be redefined here as $_FILES is populated differently from
    * other arrays when element name is of the form foo[bar]
    *
    * @access    private
    * @return    mixed
    */
    function _findValue(&$values = null)
    {
        if (empty($_FILES)) {
            return null;
        }
        $elementName = $this->getName();
        if (isset($_FILES[$elementName])) {
            return $_FILES[$elementName];
        } elseif (false !== ($pos = strpos($elementName, '['))) {
            $base  = str_replace(
                        array('\\', '\''), array('\\\\', '\\\''),
                        substr($elementName, 0, $pos)
                    );
            $idx   = "['" . str_replace(
                        array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
                        substr($elementName, $pos + 1, -1)
                     ) . "']";
            $props = array('name', 'type', 'size', 'tmp_name', 'error');
            $code  = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n" .
                     "    return null;\n" .
                     "} else {\n" .
                     "    \$value = array();\n";
            foreach ($props as $prop) {
                $code .= "    \$value['{$prop}'] = \$_FILES['{$base}']['{$prop}']{$idx};\n";
            }
            return eval($code . "    return \$value;\n}\n");

        } else {
            return null;
        }
    }
}

1			<?php
2			/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
3
4			/**
5			* HTML class for a file upload field
6			*
7			* PHP versions 4 and 5
8			*
9			* LICENSE: This source file is subject to version 3.01 of the PHP license
10			* that is available through the world-wide-web at the following URI:
11			* http://www.php.net/license/3_01.txt If you did not receive a copy of
12			* the PHP License and are unable to obtain it through the web, please
13			* send a note to [email protected] so we can mail you a copy immediately.
14			*
15			* @category HTML
16			* @package HTML_QuickForm
17			* @author Adam Daniel <[email protected]>
18			* @author Bertrand Mansion <[email protected]>
19			* @author Alexey Borzov <[email protected]>
20			* @copyright 2001-2009 The PHP Group
21			* @license http://www.php.net/license/3_01.txt PHP License 3.01
22			* @version CVS: $Id: file.php,v 1.25 2009/04/04 21:34:02 avb Exp $
23			* @link http://pear.php.net/package/HTML_QuickForm
24			*/
25
26			/**
27			* HTML class for a file upload field
28			*
29			* @category HTML
30			* @package HTML_QuickForm
31			* @author Adam Daniel <[email protected]>
32			* @author Bertrand Mansion <[email protected]>
33			* @author Alexey Borzov <[email protected]>
34			* @version Release: 3.2.11
35			* @since 1.0
36			*/
37			class HTML_QuickForm_file extends HTML_QuickForm_input
38			{
39			// {{{ properties
40
41			/**
42			* Uploaded file data, from $_FILES
43			* @var array
44			*/
45			var $_value = null;
46
47			// }}}
48			// {{{ constructor
49
50			/**
51			* Class constructor
52			*
53			* @param string Input field name attribute
54			* @param string Input field label
55			* @param mixed (optional)Either a typical HTML attribute string
56			* or an associative array
57			* @since 1.0
58			* @access public
59			*/
60			public function __construct($elementName=null, $elementLabel=null, $attributes=null)
61			{
62			parent::__construct($elementName, $elementLabel, $attributes);
63			$this->setType('file');
64			} //end constructor
65
66			// }}}
67			// {{{ setSize()
68
69			/**
70			* Sets size of file element
71			*
72			* @param int Size of file element
73			* @since 1.0
74			* @access public
75			*/
76			function setSize($size)
77			{
78			$this->updateAttributes(array('size' => $size));
79			} //end func setSize
80
81			// }}}
82			// {{{ getSize()
83
84			/**
85			* Returns size of file element
86			*
87			* @since 1.0
88			* @access public
89			* @return int
90			*/
91			function getSize()
92			{
93			return $this->getAttribute('size');
94			} //end func getSize
95
96			// }}}
97			// {{{ freeze()
98
99			/**
100			* Freeze the element so that only its value is returned
101			*
102			* @access public
103			* @return bool
104			*/
105			function freeze()
106			{
107			return false;
108			} //end func freeze
109
110			// }}}
111			// {{{ setValue()
112
113			/**
114			* Sets value for file element.
115			*
116			* Actually this does nothing. The function is defined here to override
117			* HTML_Quickform_input's behaviour of setting the 'value' attribute. As
118			* no sane user-agent uses <input type="file">'s value for anything
119			* (because of security implications) we implement file's value as a
120			* read-only property with a special meaning.
121			*
122			* @param mixed Value for file element
123			* @since 3.0
124			* @access public
125			*/
126			function setValue($value)
127			{
128			return null;
129			} //end func setValue
130
131			// }}}
132			// {{{ getValue()
133
134			/**
135			* Returns information about the uploaded file
136			*
137			* @since 3.0
138			* @access public
139			* @return array
140			*/
141			function getValue()
142			{
143			return $this->_value;
144			} // end func getValue
145
146			// }}}
147			// {{{ onQuickFormEvent()
148
149			/**
150			* Called by HTML_QuickForm whenever form event is made on this element
151			*
152			* @param string Name of event
153			* @param mixed event arguments
154			* @param object calling object
155			* @since 1.0
156			* @access public
157			* @return bool
158			*/
159			function onQuickFormEvent($event, $arg, &$caller)
160			{
161			switch ($event) {
162			case 'updateValue':
163			if ($caller->getAttribute('method') == 'get') {
164			return PEAR::raiseError('Cannot add a file upload field to a GET method form');
165			}
166			$this->_value = $this->_findValue();
			0 ignored issues – show Documentation Bug introduced 2016-02-26 17:07 UTC by Report Bug Copy Issue Report It seems like `$this->_findValue()` of type `*` is incompatible with the declared type `array` of property `$_value`. 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...
167			$caller->updateAttributes(array('enctype' => 'multipart/form-data'));
168			$caller->setMaxFileSize();
169			break;
170			case 'addElement':
171			$this->onQuickFormEvent('createElement', $arg, $caller);
172			return $this->onQuickFormEvent('updateValue', null, $caller);
			0 ignored issues – show Bug Compatibility introduced 2016-02-26 17:07 UTC by Report Bug Copy Issue Report The expression `$this->onQuickFormEvent(...Value', null, $caller);` of type `object\|boolean` adds the type `object` to the return on line 172 which is incompatible with the return type of the parent method `HTML_QuickForm_input::onQuickFormEvent` of type `boolean`. Loading history...
173			break;
174			case 'createElement':
175			//$className = get_class($this);
176			//$this->$className($arg[0], $arg[1], $arg[2]);
177			break;
178			}
179			return true;
180			} // end func onQuickFormEvent
181
182			// }}}
183			// {{{ moveUploadedFile()
184
185			/**
186			* Moves an uploaded file into the destination
187			*
188			* @param string Destination directory path
189			* @param string New file name
190			* @access public
191			* @return bool Whether the file was moved successfully
192			*/
193			public function moveUploadedFile($dest, $fileName = '')
194			{
195			if ($dest != '' && substr($dest, -1) != '/') {
196			$dest .= '/';
197			}
198			$fileName = ($fileName != '') ? $fileName : basename($this->_value['name']);
199			return move_uploaded_file($this->_value['tmp_name'], $dest . $fileName);
200			} // end func moveUploadedFile
201
202			// }}}
203			// {{{ isUploadedFile()
204
205			/**
206			* Checks if the element contains an uploaded file
207			*
208			* @access public
209			* @return bool true if file has been uploaded, false otherwise
210			*/
211			public function isUploadedFile()
212			{
213			return self::_ruleIsUploadedFile($this->_value);
214			} // end func isUploadedFile
215
216
217			// }}}
218			// {{{ _ruleIsUploadedFile()
219
220			/**
221			* Checks if the given element contains an uploaded file
222			*
223			* @param array Uploaded file info (from $_FILES)
224			* @access private
225			* @return bool true if file has been uploaded, false otherwise
226			*/
227			public static function _ruleIsUploadedFile($elementValue)
228			{
229			if ((isset($elementValue['error']) && $elementValue['error'] == 0) \|\|
230			(!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')) {
231			return is_uploaded_file($elementValue['tmp_name']);
232			} else {
233			return false;
234			}
235			} // end func _ruleIsUploadedFile
236
237			// }}}
238			// {{{ _ruleCheckMaxFileSize()
239
240			/**
241			* Tries to find the element value from the values array
242			*
243			* Needs to be redefined here as $_FILES is populated differently from
244			* other arrays when element name is of the form foo[bar]
245			*
246			* @access private
247			* @return mixed
248			*/
249			function _findValue(&$values = null)
250			{
251			if (empty($_FILES)) {
252			return null;
253			}
254			$elementName = $this->getName();
255			if (isset($_FILES[$elementName])) {
256			return $_FILES[$elementName];
257			} elseif (false !== ($pos = strpos($elementName, '['))) {
258			$base = str_replace(
259			array('\\', '\''), array('\\\\', '\\\''),
260			substr($elementName, 0, $pos)
261			);
262			$idx = "['" . str_replace(
263			array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
264			substr($elementName, $pos + 1, -1)
265			) . "']";
266			$props = array('name', 'type', 'size', 'tmp_name', 'error');
267			$code = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n" .
268			" return null;\n" .
269			"} else {\n" .
270			" \$value = array();\n";
271			foreach ($props as $prop) {
272			$code .= " \$value['{$prop}'] = \$_FILES['{$base}']['{$prop}']{$idx};\n";
273			}
274			return eval($code . " return \$value;\n}\n");
			0 ignored issues – show Coding Style introduced 2016-02-26 17:08 UTC by Report Bug Copy Issue Report It is generally not recommended to use `eval` unless absolutely required. On one hand, `eval` might be exploited by malicious users if they somehow manage to inject dynamic content. On the other hand, with the emergence of faster PHP runtimes like the HHVM, `eval` prevents some optimization that they perform. Loading history...
275			} else {
276			return null;
277			}
278			}
279			}

chamilo / chamilo-lms

Push — 1.10.x ( 021894...0e6d9a )

HTML_QuickForm_file::freeze() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like