GBookUtilities

Complexity

Total Complexity

18

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	createFolder()	0	12	4
A	copyFile()	0	14	1
B	recurseCopy()	0	15	5
B	getEditor()	0	25	3
A	gbookSignForm()	0	18	1
A	gbookIP()	0	17	4

<?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

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * 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)) {

67% of this comment could be valid code. Did you maybe forget this after debugging?

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

63% of this comment could be valid code. Did you maybe forget this after debugging?

        //            } else {

50% of this comment could be valid code. Did you maybe forget this after debugging?

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

64% of this comment could be valid code. Did you maybe forget this after debugging?

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

50% of this comment could be valid code. Did you maybe forget this after debugging?

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

67% of this comment could be valid code. Did you maybe forget this after debugging?

        //        }
        //        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;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $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);

75% of this comment could be valid code. Did you maybe forget this after debugging?

        return $descEditor;
    }

    /**
     * @param $nameTmp
     * @param $emailTmp
     * @param $urlTmp
     * @param $messageTmp
     * @return XoopsThemeForm
     */
    public static function gbookSignForm($nameTmp, $emailTmp, $urlTmp, $messageTmp)
    {
        $name      = new XoopsFormText(_GBOOK_NAME, 'Name', 43, 100, $nameTmp);
        $email     = new XoopsFormText(_GBOOK_EMAIL, 'Email', 43, 100, $emailTmp);
        $url       = new XoopsFormText(_GBOOK_URL, 'URL', 43, 100, $urlTmp);
        $message   = new XoopsFormTextArea(_GBOOK_MESSAGE, 'Message', $messageTmp);
        $submit    = new XoopsFormButton('', 'submit', _GBOOK_SUBMIT, 'submit');
        $gbookform = new XoopsThemeForm(_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;
    }
}