GbookUtilities::gbookIP() - Code Metrics - Inspection of "class name" - mambax7/gbook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( db7223...a1696c )

by Michael

created 2016-09-07 06:18 UTC

GbookUtilities::gbookIP() A

↳ Parent: GbookUtilities

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */
/**
 * GbookUtilities Class
 *
 * @copyright   XOOPS Project (http://xoops.org)
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
 * @author      XOOPS Development Team
 * @package     GBook
 * @since       1.03
 *
 */

//namespace GBook;

/**
 * Class GbookUtilities
 */
class GbookUtilities
namespace YourVendor;

class YourClass { }
{
    /**
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
     *
     * @param string $folder The full path of the directory to check
     *
     * @return void
     */
    public static function createFolder($folder)
    {
        try {
            if (!@mkdir($folder) && !is_dir($folder)) {
                throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
            } else {
                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
            }
        }
        catch (Exception $e) {
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br/>';
        }
    }

    /**
     * @param $file
     * @param $folder
     * @return bool
     */
    public static function copyFile($file, $folder)
    {
        return copy($file, $folder);
        //        try {
        //            if (!is_dir($folder)) {

        //                throw new \RuntimeException(sprintf('Unable to copy file as: %s ', $folder));

        //            } else {

        //                return copy($file, $folder);

        //            }
        //        } catch (Exception $e) {

        //            echo 'Caught exception: ', $e->getMessage(), "\n", "<br/>";

        //        }
        //        return false;
    }

    /**
     * @param $src
     * @param $dst
     */
    public static function recurseCopy($src, $dst)
    {
        $dir = opendir($src);
        //    @mkdir($dst);
        while (false !== ($file = readdir($dir))) {
            if (($file !== '.') && ($file !== '..')) {
                if (is_dir($src . '/' . $file)) {
                    self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
                } else {
                    copy($src . '/' . $file, $dst . '/' . $file);
                }
            }
        }
        closedir($dir);
    }

    /**
     * @param $name
     * @param $value
     * @return XoopsFormDhtmlTextArea|XoopsFormEditor
     */
    public static function getEditor($name, $value)
    {
        global $xoopsUser, $xoopsModule, $xoopsModuleConfig;
function myFunction($a, $b) {
    // Do something
}
        $options = array();
        $isAdmin = $xoopsUser->isAdmin($xoopsModule->getVar('mid'));

        if (class_exists('XoopsFormEditor')) {
            $options['name']   = $name;
            $options['value']  = $value;
            $options['rows']   = 5;
            $options['cols']   = '100%';
            $options['width']  = '100%';
            $options['height'] = '200px';
            if ($isAdmin) {
                $descEditor = new XoopsFormEditor(ucfirst($name), $xoopsModuleConfig['editorAdmin'], $options, $nohtml = false, $onfailure = 'textarea');
            } else {
                $descEditor = new XoopsFormEditor(ucfirst($name), $xoopsModuleConfig['editorUser'], $options, $nohtml = false, $onfailure = 'textarea');
            }
        } else {
            $descEditor = new XoopsFormDhtmlTextArea(ucfirst($name), $name, $value, '100%', '100%');
        }

        //        $form->addElement($descEditor);


        return $descEditor;
    }

    /**
     * @param $nameTmp
     * @param $emailTmp
     * @param $urlTmp
     * @param $messageTmp
     * @return XoopsThemeForm
     */
    public static function getSignForm($nameTmp, $emailTmp, $urlTmp, $messageTmp)
    {
        $name      = new XoopsFormText(_MD_GBOOK_NAME, 'Name', 43, 100, $nameTmp);
        $email     = new XoopsFormText(_MD_GBOOK_EMAIL, 'Email', 43, 100, $emailTmp);
        $url       = new XoopsFormText(_MD_GBOOK_URL, 'URL', 43, 100, $urlTmp);
        $message   = new XoopsFormTextArea(_MD_GBOOK_MESSAGE, 'Message', $messageTmp);
        $submit    = new XoopsFormButton('', 'submit', _MD_GBOOK_SUBMIT, 'submit');
        $gbookform = new XoopsThemeForm(_MD_GBOOK_SIGN, 'gbookform', 'sign.php');

        $gbookform->addElement($name, true);
        $gbookform->addElement($email);
        $gbookform->addElement($url);
        $gbookform->addElement($message, true);
        $gbookform->addElement(new XoopsFormCaptcha(), true);
        $gbookform->addElement($submit);

        return $gbookform;
    }

    /**
     * @return string
     */
    public static function gbookIP()
    {
        $ip = 'UNKNOWN';
        if (getenv('HTTP_CLIENT_IP')) {
            $ip = getenv('HTTP_CLIENT_IP');
        } else {
            if (getenv('HTTP_X_FORWARDED_FOR')) {
                $ip = getenv('HTTP_X_FORWARDED_FOR');
            } else {
                if (getenv('REMOTE_ADDR')) {
                    $ip = getenv('REMOTE_ADDR');
                }
            }
        }

        return $ip;
    }
    /**
     *
     * Verifies XOOPS version meets minimum requirements for this module
     * @static
     * @param XoopsModule $module
     *
     * @return bool true if meets requirements, false if not
     */
    public static function checkXoopsVer(XoopsModule $module)
    {
        xoops_loadLanguage('admin', $module->dirname());
        //check for minimum XOOPS version
        $currentVer  = substr(XOOPS_VERSION, 6); // get the numeric part of string
        $currArray   = explode('.', $currentVer);
        $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
        $reqArray    = explode('.', $requiredVer);
        $success     = true;
        foreach ($reqArray as $k => $v) {
            if (isset($currArray[$k])) {
                if ($currArray[$k] > $v) {
                    break;
                } elseif ($currArray[$k] == $v) {
                    continue;
                } else {
                    $success = false;
                    break;
                }
            } else {
                if ((int)$v > 0) { // handles things like x.x.x.0_RC2
                    $success = false;
                    break;
                }
            }
        }

        if (!$success) {
            $module->setErrors(sprintf(_AM_GBOOK_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
        }

        return $success;
    }

    /**
     *
     * Verifies PHP version meets minimum requirements for this module
     * @static
     * @param XoopsModule $module
     *
     * @return bool true if meets requirements, false if not
     */
    public static function checkPhpVer(XoopsModule $module)
    {
        xoops_loadLanguage('admin', $module->dirname());
        // check for minimum PHP version
        $success = true;
        $verNum  = phpversion();
        $reqVer  =& $module->getInfo('min_php');
        if (false !== $reqVer && '' !== $reqVer) {
            if (version_compare($verNum, $reqVer, '<')) {
                $module->setErrors(sprintf(_AM_GBOOK_ERROR_BAD_PHP, $reqVer, $verNum));
                $success = false;
            }
        }

        return $success;
    }
}


Push — master ( db7223...a1696c )

GbookUtilities::gbookIP() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2			/*
3			You may not change or alter any portion of this comment or credits
4			of supporting developers from this source code or any supporting source code
5			which is considered copyrighted (c) material of the original comment or credit authors.
6
7			This program is distributed in the hope that it will be useful,
8			but WITHOUT ANY WARRANTY; without even the implied warranty of
9			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10			*/
11			/**
12			* GbookUtilities Class
13			*
14			* @copyright XOOPS Project (http://xoops.org)
15			* @license http://www.fsf.org/copyleft/gpl.html GNU public license
16			* @author XOOPS Development Team
17			* @package GBook
18			* @since 1.03
19			*
20			*/
21
22			//namespace GBook;
23
24			/**
25			* Class GbookUtilities
26			*/
27			class GbookUtilities
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
28			{
29			/**
30			* Function responsible for checking if a directory exists, we can also write in and create an index.html file
31			*
32			* @param string $folder The full path of the directory to check
33			*
34			* @return void
35			*/
36			public static function createFolder($folder)
37			{
38			try {
39			if (!@mkdir($folder) && !is_dir($folder)) {
40			throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
41			} else {
42			file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
43			}
44			}
45			catch (Exception $e) {
46			echo 'Caught exception: ', $e->getMessage(), "\n", '<br/>';
47			}
48			}
49
50			/**
51			* @param $file
52			* @param $folder
53			* @return bool
54			*/
55			public static function copyFile($file, $folder)
56			{
57			return copy($file, $folder);
58			// try {
59			// if (!is_dir($folder)) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
60			// throw new \RuntimeException(sprintf('Unable to copy file as: %s ', $folder));
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
61			// } else {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
62			// return copy($file, $folder);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
63			// }
64			// } catch (Exception $e) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
65			// echo 'Caught exception: ', $e->getMessage(), "\n", "<br/>";
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
66			// }
67			// return false;
68			}
69
70			/**
71			* @param $src
72			* @param $dst
73			*/
74			public static function recurseCopy($src, $dst)
75			{
76			$dir = opendir($src);
77			// @mkdir($dst);
78			while (false !== ($file = readdir($dir))) {
79			if (($file !== '.') && ($file !== '..')) {
80			if (is_dir($src . '/' . $file)) {
81			self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
82			} else {
83			copy($src . '/' . $file, $dst . '/' . $file);
84			}
85			}
86			}
87			closedir($dir);
88			}
89
90			/**
91			* @param $name
92			* @param $value
93			* @return XoopsFormDhtmlTextArea\|XoopsFormEditor
94			*/
95			public static function getEditor($name, $value)
96			{
97			global $xoopsUser, $xoopsModule, $xoopsModuleConfig;
			0 ignored issues – show Compatibility Best Practice introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
98			$options = array();
99			$isAdmin = $xoopsUser->isAdmin($xoopsModule->getVar('mid'));
100
101			if (class_exists('XoopsFormEditor')) {
102			$options['name'] = $name;
103			$options['value'] = $value;
104			$options['rows'] = 5;
105			$options['cols'] = '100%';
106			$options['width'] = '100%';
107			$options['height'] = '200px';
108			if ($isAdmin) {
109			$descEditor = new XoopsFormEditor(ucfirst($name), $xoopsModuleConfig['editorAdmin'], $options, $nohtml = false, $onfailure = 'textarea');
110			} else {
111			$descEditor = new XoopsFormEditor(ucfirst($name), $xoopsModuleConfig['editorUser'], $options, $nohtml = false, $onfailure = 'textarea');
112			}
113			} else {
114			$descEditor = new XoopsFormDhtmlTextArea(ucfirst($name), $name, $value, '100%', '100%');
115			}
116
117			// $form->addElement($descEditor);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-05 12:48 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
118
119			return $descEditor;
120			}
121
122			/**
123			* @param $nameTmp
124			* @param $emailTmp
125			* @param $urlTmp
126			* @param $messageTmp
127			* @return XoopsThemeForm
128			*/
129			public static function getSignForm($nameTmp, $emailTmp, $urlTmp, $messageTmp)
130			{
131			$name = new XoopsFormText(_MD_GBOOK_NAME, 'Name', 43, 100, $nameTmp);
132			$email = new XoopsFormText(_MD_GBOOK_EMAIL, 'Email', 43, 100, $emailTmp);
133			$url = new XoopsFormText(_MD_GBOOK_URL, 'URL', 43, 100, $urlTmp);
134			$message = new XoopsFormTextArea(_MD_GBOOK_MESSAGE, 'Message', $messageTmp);
135			$submit = new XoopsFormButton('', 'submit', _MD_GBOOK_SUBMIT, 'submit');
136			$gbookform = new XoopsThemeForm(_MD_GBOOK_SIGN, 'gbookform', 'sign.php');
137
138			$gbookform->addElement($name, true);
139			$gbookform->addElement($email);
140			$gbookform->addElement($url);
141			$gbookform->addElement($message, true);
142			$gbookform->addElement(new XoopsFormCaptcha(), true);
143			$gbookform->addElement($submit);
144
145			return $gbookform;
146			}
147
148			/**
149			* @return string
150			*/
151			public static function gbookIP()
152			{
153			$ip = 'UNKNOWN';
154			if (getenv('HTTP_CLIENT_IP')) {
155			$ip = getenv('HTTP_CLIENT_IP');
156			} else {
157			if (getenv('HTTP_X_FORWARDED_FOR')) {
158			$ip = getenv('HTTP_X_FORWARDED_FOR');
159			} else {
160			if (getenv('REMOTE_ADDR')) {
161			$ip = getenv('REMOTE_ADDR');
162			}
163			}
164			}
165
166			return $ip;
167			}
168			/**
169			*
170			* Verifies XOOPS version meets minimum requirements for this module
171			* @static
172			* @param XoopsModule $module
173			*
174			* @return bool true if meets requirements, false if not
175			*/
176			public static function checkXoopsVer(XoopsModule $module)
177			{
178			xoops_loadLanguage('admin', $module->dirname());
179			//check for minimum XOOPS version
180			$currentVer = substr(XOOPS_VERSION, 6); // get the numeric part of string
181			$currArray = explode('.', $currentVer);
182			$requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
183			$reqArray = explode('.', $requiredVer);
184			$success = true;
185			foreach ($reqArray as $k => $v) {
186			if (isset($currArray[$k])) {
187			if ($currArray[$k] > $v) {
188			break;
189			} elseif ($currArray[$k] == $v) {
190			continue;
191			} else {
192			$success = false;
193			break;
194			}
195			} else {
196			if ((int)$v > 0) { // handles things like x.x.x.0_RC2
197			$success = false;
198			break;
199			}
200			}
201			}
202
203			if (!$success) {
204			$module->setErrors(sprintf(_AM_GBOOK_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
205			}
206
207			return $success;
208			}
209
210			/**
211			*
212			* Verifies PHP version meets minimum requirements for this module
213			* @static
214			* @param XoopsModule $module
215			*
216			* @return bool true if meets requirements, false if not
217			*/
218			public static function checkPhpVer(XoopsModule $module)
219			{
220			xoops_loadLanguage('admin', $module->dirname());
221			// check for minimum PHP version
222			$success = true;
223			$verNum = phpversion();
224			$reqVer =& $module->getInfo('min_php');
225			if (false !== $reqVer && '' !== $reqVer) {
226			if (version_compare($verNum, $reqVer, '<')) {
227			$module->setErrors(sprintf(_AM_GBOOK_ERROR_BAD_PHP, $reqVer, $verNum));
228			$success = false;
229			}
230			}
231
232			return $success;
233			}
234			}
235

mambax7 / gbook

Push — master ( db7223...a1696c )

GbookUtilities::gbookIP() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like