Form - Code Metrics - pH7Software/pH7-Social-Dating-CMS - Measure and Improve Code Quality continuously with Scrutinizer

Form F
last analyzed 2019-03-31 04:46 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	534
Duplicated Lines	0 %
Coupling/Cohesion

Components	2
Dependencies	6
Importance

Changes
Metric	Value
dl	0
loc	534
rs	2
c	0
b	0
f	0
wmc	89
lcom	2
cbo	6
34 Methods

Rating	Name	Size	Complexity
A	__construct()	26	5
C	isValid()	67	13
A	recover()	8	2
A	clearValues()	6	2
A	clearErrors()	6	2
A	setSessionValue()	4	1
A	setError()	14	4
A	getFormId()	4	1
A	renderAjaxErrorResponse()	7	2
A	setSuccess()	4	1
A	__sleep()	4	1
A	addElement()	14	3
A	getAjax()	4	1
A	getElements()	4	1
A	getError()	4	1
A	getId()	4	1
A	getJQueryUIButtons()	4	1
A	getPrevent()	4	1
A	getResourcesPath()	4	1
A	getErrors()	15	3
A	getWidth()	4	1
A	getWidthSuffix()	4	1
A	render()	31	4
A	getSessionValues()	7	2
A	setValues()	4	1
A	applyValues()	13	5
A	formatWidthProperties()	15	4
A	renderCSS()	10	2
B	renderJS()	81	8
A	renderJSFiles()	27	5
A	save()	4	1
A	renderCSSFiles()	24	5
A	isNotJQueryUiButtons()	4	1
A	isFormFocusNotOnHomepage()	5	2
How to fix Complexity

<?php

/**
 *  This file has been modified by pH7 developers team (Pierre-Henry SORIA).
 */

namespace PFBC;

use PH7\Framework\Layout\Html\Design;
use PH7\Framework\Mvc\Request\Http as HttpRequest;

/*This project's namespace structure is leveraged to autoload requested classes at runtime.*/
function load($class)
{
    $file = __DIR__ . '/../' . str_replace('\\', PH7_DS, $class) . '.php';
    if (is_file($file)) {
        include $file;
    }
}

spl_autoload_register('PFBC\load');
if (in_array('__autoload', spl_autoload_functions(), true)) {
    spl_autoload_register('__autoload');
}

class Form extends Base
{
    private static $sFormId;
    protected $ajax;
    protected $attributes;
    protected $error;
    protected $jQueryUITheme = 'smoothness';
    protected $resourcesPath;
    protected $prevent = [];
    protected $view;
    /*jQueryUI themes can be previewed at http://jqueryui.com/themeroller/.*/
    protected $width;
    private $elements = [];
    /*Prevents various automated from being automatically applied.  Current options for this array
    included jQuery, jQueryUI, jQueryUIButtons, focus, and style.*/
    private $prefix = 'http';
    private $values = [];
    private $ajaxCallback;
    private $widthSuffix = 'px';

    public function __construct($id = 'pfbc', $width = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        self::$sFormId = $id;
        $this->configure([
            'width' => $width,
            'action' => basename($_SERVER['SCRIPT_NAME']),
            'id' => preg_replace("/\W/", '-', $id),
            'method' => 'post'
        ]);

        if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
            $this->prefix = 'https';
        }

        /*The Standard view class is applied by default and will be used unless a different view is
        specified in the form's configure method*/
        if (empty($this->view)) {
            $this->view = new View\CStandard;
        }

        if (empty($this->error)) {
            $this->error = new Error\Standard;
        }

        $this->resourcesPath = PH7_URL_STATIC . 'PFBC';
    }

    public static function isValid($id = 'pfbc', $clearValues = true)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $valid = true;
        /*The form's instance is recovered (unserialized) from the session.*/
        $form = self::recover($id);
        if (!empty($form)) {
            if ($_SERVER['REQUEST_METHOD'] == 'POST')
                $data = $_POST;
            else
                $data = $_GET;

            /*Any values/errors stored in the session for this form are cleared.*/
            self::clearValues($id);
            self::clearErrors($id);

            /*Each element's value is saved in the session and checked against any validation rules applied
            to the element.*/
            if (!empty($form->elements)) {
                foreach ($form->elements as $element) {
                    $name = $element->getName();
                    if (substr($name, -2) == '[]') {
                        $name = substr($name, 0, -2);
                    }

                    /*The File element must be handled differently b/c it uses the $_FILES superglobal and
                    not $_GET or $_POST.*/
                    if ($element instanceof Element\File) {
                        $data[$name] = $_FILES[$name]['name'];
                    }

                    if (isset($data[$name])) {
                        $value = $data[$name];
                        if (is_array($value)) {
                            $valueSize = sizeof($value);
                            for ($v = 0; $v < $valueSize; ++$v) {
                                $value[$v] = stripslashes($value[$v]);
                            }
                        } else {
                            $value = stripslashes($value);
                        }
                        self::setSessionValue($id, $name, $value);
                    } else {
                        $value = null;
                    }

                    /*If a validation error is found, the error message is saved in the session along with
                    the element's name.*/
                    if (!$element->isValid($value)) {
                        self::setError($id, $element->getErrors(), $name);
                        $valid = false;
                    }
                }
            }

            /*If no validation errors were found, the form's session values are cleared.*/
            if ($valid) {
                if ($clearValues) {
                    self::clearValues($id);
                }
                self::clearErrors($id);
            }
        } else {
            $valid = false;
        }

        return $valid;
    }

    private static function recover($id)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SESSION['pfbc'][$id]['form'])) {
            return unserialize($_SESSION['pfbc'][$id]['form']);
        }

        return '';
    }

    public static function clearValues($id = 'pfbc')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SESSION['pfbc'][$id]['values'])) {
            unset($_SESSION['pfbc'][$id]['values']);
        }
    }

    public static function clearErrors($id = 'pfbc')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SESSION['pfbc'][$id]['errors'])) {
            unset($_SESSION['pfbc'][$id]['errors']);
        }
    }

    public static function setSessionValue($id, $element, $value)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_SESSION['pfbc'][$id]['values'][$element] = $value;
    }

    /**
     * Validation errors are saved in the session after the form submission, and will be displayed to the user
     * when redirected back to the form.
     */
    public static function setError($id, $messages, $element = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!is_array($messages)) {
            $messages = [$messages];
        }

        if (empty($_SESSION['pfbc'][$id]['errors'][$element])) {
            $_SESSION['pfbc'][$id]['errors'][$element] = [];
        }

        foreach ($messages as $message) {
            $_SESSION['pfbc'][$id]['errors'][$element][] = $message;
        }
    }

    /**
     * @return string The ID of the form.
     */
    public static function getFormId()
    {
        return self::$sFormId;
    }

    /**
     * When ajax is used to submit the form's data, validation errors need to be manually sent back to the
     * form using json.
     *
     * @param string $id
     */
    public static function renderAjaxErrorResponse($id = 'pfbc')
    {
        $form = self::recover($id);
        if (!empty($form)) {
            $form->error->renderAjaxErrorResponse();
        }
    }

    public static function setSuccess($id, $message, $element = '')

    {
        return (new Design)->setFlashMsg($message, Design::SUCCESS_TYPE);
    }

    /**
     * When a form is serialized and stored in the session, this function prevents any
     * non-essential information from being included.
     */
    public function __sleep()
    {
        return ['attributes', 'elements', 'error'];
    }

    public function addElement(Element $element)
    {
        $element->setForm($this);
        //If the element doesn't have a specified id, a generic identifier is applied.
        $id = $element->getID();
        if (empty($id))
            $element->setID($this->attributes['id'] . '-element-' . sizeof($this->elements));
        $this->elements[] = $element;

        /*For ease-of-use, the form tag's encytype attribute is automatically set if the File element
        class is added.*/
        if ($element instanceof Element\File)
            $this->attributes['enctype'] = 'multipart/form-data';
    }

    public function getAjax()
    {
        return $this->ajax;
    }

    public function getElements()
    {
        return $this->elements;
    }

    public function getError()
    {
        return $this->error;
    }

    public function getId()
    {
        return $this->attributes['id'];
    }

    public function getJQueryUIButtons()
    {
        return $this->jQueryUIButtons;
    }

    public function getPrevent()
    {
        return $this->prevent;
    }

    public function getResourcesPath()
    {
        return $this->resourcesPath;
    }

    public function getErrors()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $errors = [];
        if (session_status() !== PHP_SESSION_ACTIVE) {
            $errors[''] = ['Error: pH7CMS requires an active session to work properly.  Simply add session_start() to your script before any output has been sent to the browser.'];
        } else {
            $errors = [];
            $id = $this->attributes['id'];
            if (!empty($_SESSION['pfbc'][$id]['errors'])) {
                $errors = $_SESSION['pfbc'][$id]['errors'];
            }
        }

        return $errors;
    }

    public function getWidth()
    {
        return $this->width;
    }

    public function getWidthSuffix()
    {
        return $this->widthSuffix;
    }

    public function render($returnHTML = false)
    {
        $this->view->setForm($this);
        $this->error->setForm($this);

        /*When validation errors occur, the form's submitted values are saved in a session
        array, which allows them to be pre-populated when the user is redirected to the form.*/
        $values = self::getSessionValues($this->attributes['id']);
        if (!empty($values))
            $this->setValues($values);
        $this->applyValues();

        $this->formatWidthProperties();

        if ($returnHTML) {
            ob_start();
        }

        $this->renderCSS();
        $this->view->render();
        $this->renderJS();

        /*The form's instance is serialized and saved in a session variable for use during validation.*/
        $this->save();

        if ($returnHTML) {
            $html = ob_get_contents();
            ob_end_clean();
            return $html;
        }
    }

    public static function getSessionValues($id = 'pfbc')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $values = [];
        if (!empty($_SESSION['pfbc'][$id]['values']))
            $values = $_SESSION['pfbc'][$id]['values'];
        return $values;
    }

    /**
     * An associative array is used to pre-populate form elements.  The keys of this array correspond with
     * the element names.
     *
     * @param array $values
     */
    public function setValues(array $values)
    {
        $this->values = array_merge($this->values, $values);
    }

    /**
     * Values that have been set through the setValues method, either manually by the developer
     * or after validation errors, are applied to elements within this method.
     */
    private function applyValues()
    {
        foreach ($this->elements as $element) {
            $name = $element->getName();
            if (isset($this->values[$name])) {
                $element->setValue($this->values[$name]);
            } elseif (substr($name, -2) == '[]' &&
                isset($this->values[substr($name, 0, -2)])
            ) {
                $element->setValue($this->values[substr($name, 0, -2)]);
            }
        }
    }

    /**
     * This method parses the form's width property into a numeric width value and a width suffix - either px or %.
     * These values are used by the form's concrete view class.
     */
    public function formatWidthProperties()
    {
        if (!empty($this->width)) {
            if (substr($this->width, -1) == '%') {
                $this->width = substr($this->width, 0, -1);
                $this->widthSuffix = '%';
            } elseif (substr($this->width, -2) == 'px') {
                $this->width = substr($this->width, 0, -2);
            }
        } else {
            /*If the form's width property is empty, 100% will be assumed.*/
            $this->width = 100;
            $this->widthSuffix = '%';
        }
    }

    private function renderCSS()
    {
        echo '<style scoped="scoped">';
        $this->view->renderCSS();
        $this->error->renderCSS();
        foreach ($this->elements as $element) {
            $element->renderCSS();
        }
        echo '</style>';
    }

    private function renderJS()
    {
        $this->renderJSFiles();
        echo '<script>';
        $this->view->renderJS();
        foreach ($this->elements as $element) {
            $element->renderJS();
        }

        $id = $this->attributes['id'];

        echo 'jQuery(document).ready(function() {';

        /*When the form is submitted, disable all submit buttons to prevent duplicate submissions.*/
        echo 'jQuery("#', $id, '").bind("submit", function() {';
        if ($this->isNotJQueryUiButtons()) {
            echo 'jQuery(this).find("button[type=submit]").button("disable");';
            echo 'jQuery(this).find("button[type=submit] span.ui-button-text").css("padding-right", "2.1em").append(\'<img class="pfbc-loading" src="data:image/gif;base64,R0lGODlhEAAQAPIAAIiIiAAAAGdnZyMjIwAAADQ0NEVFRU5OTiH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCgAAACwAAAAAEAAQAAADMwi63P4wyklrE2MIOggZnAdOmGYJRbExwroUmcG2LmDEwnHQLVsYOd2mBzkYDAdKa+dIAAAh+QQJCgAAACwAAAAAEAAQAAADNAi63P5OjCEgG4QMu7DmikRxQlFUYDEZIGBMRVsaqHwctXXf7WEYB4Ag1xjihkMZsiUkKhIAIfkECQoAAAAsAAAAABAAEAAAAzYIujIjK8pByJDMlFYvBoVjHA70GU7xSUJhmKtwHPAKzLO9HMaoKwJZ7Rf8AYPDDzKpZBqfvwQAIfkECQoAAAAsAAAAABAAEAAAAzMIumIlK8oyhpHsnFZfhYumCYUhDAQxRIdhHBGqRoKw0R8DYlJd8z0fMDgsGo/IpHI5TAAAIfkECQoAAAAsAAAAABAAEAAAAzIIunInK0rnZBTwGPNMgQwmdsNgXGJUlIWEuR5oWUIpz8pAEAMe6TwfwyYsGo/IpFKSAAAh+QQJCgAAACwAAAAAEAAQAAADMwi6IMKQORfjdOe82p4wGccc4CEuQradylesojEMBgsUc2G7sDX3lQGBMLAJibufbSlKAAAh+QQJCgAAACwAAAAAEAAQAAADMgi63P7wCRHZnFVdmgHu2nFwlWCI3WGc3TSWhUFGxTAUkGCbtgENBMJAEJsxgMLWzpEAACH5BAkKAAAALAAAAAAQABAAAAMyCLrc/jDKSatlQtScKdceCAjDII7HcQ4EMTCpyrCuUBjCYRgHVtqlAiB1YhiCnlsRkAAAOwAAAAAAAAAAAA==" alt="Loading..."/>\');';
        } else {
            echo 'jQuery(this).find("button[type=submit]").attr("disabled", "disabled");';
        }
        echo '});';

        // Don't want to focus the first form field on the homepage
        if ($this->isFormFocusNotOnHomepage()) {
            // Use jQuery to set the focus of the form's initial element
            echo 'jQuery("#', $id, ' :input:visible:enabled:first").focus();';
        }

        $this->view->jQueryDocumentReady();
        foreach ($this->elements as $element) {
            $element->jQueryDocumentReady();
        }

        /*For ajax, an anonymous onsubmit javascript function is bound to the form using jQuery.  jQuery's
        serialize function is used to grab each element's name/value pair.*/
        if (!empty($this->ajax)) {
            echo 'jQuery("#', $id, '").bind("submit", {';
            $this->error->clear();
            echo <<<JS
            jQuery.ajax({
                url: "{$this->attributes["action"]}",
                type: "{$this->attributes["method"]}",
                data: jQuery("#$id").serialize(),
                success: function(response) {
                    if(typeof response != "undefined" && typeof response == "object" && response.errors) {
JS;
            $this->error->applyAjaxErrorResponse();
            echo <<<JS
                        jQuery("html, body").animate({ scrollTop: jQuery("#$id").offset().top }, 500 );
                    }
                    else {
JS;
            /*A callback function can be specified to handle any post submission events.*/
            if (!empty($this->ajaxCallback)) {
                echo $this->ajaxCallback, '(response);';
            }

            echo '}';

            if ($this->isNotJQueryUiButtons()) {
                echo 'jQuery("#', $id, ' button[type=submit] span.ui-button-text").css("padding-right", "1em").find("img").remove();';
                echo 'jQuery("#', $id, ' button[type=submit]").button("enable");';
            } else {
                echo 'jQuery("#', $id, '").find("button[type=submit]").removeAttr("disabled");';
            }

            echo <<<JS
                }
            });
            return false;
        });

JS;
        }

        echo <<<JS
    });
</script>
JS;
    }

    private function renderJSFiles()
    {
        $urls = [];

        /**
         * These files are already included by default in layout.tpl, therefore it is unnecessary to include them again.
         *
         * if(!in_array("jQuery", $this->prevent))
         * $urls[] = $this->_prefix . "://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js";
         * if(!in_array("jQueryUI", $this->prevent))
         * $urls[] = $this->_prefix . "://ajax.googleapis.com/ajax/libs/jqueryui/1/jquery-ui.min.js";
         */
        foreach ($this->elements as $element) {
            $elementUrls = $element->getJSFiles();
            if (is_array($elementUrls)) {
                $urls = array_merge($urls, $elementUrls);
            }
        }

        /*This section prevents duplicate css files from being loaded.*/
        if (!empty($urls)) {
            $urls = array_values(array_unique($urls));
            foreach ($urls as $url) {
                echo '<script src="', $url, '"></script>';
            }
        }
    }

    /**
     * The save method serialized the form's instance and saves it in the session.
     */
    private function save()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_SESSION['pfbc'][$this->attributes['id']]['form'] = serialize($this);
    }

    private function renderCSSFiles()
    {
        $urls = [];
        /**
         * These files are already included by default in layout.tpl, therefore it is unnecessary to include them again.
         *
         * if(!in_array('jQueryUI', $this->prevent))
         * $urls[] = $this->prefix . '://ajax.googleapis.com/ajax/libs/jqueryui/1/themes/' . $this->jQueryUITheme . '/jquery-ui.css';
         */
        foreach ($this->elements as $element) {
            $elementUrls = $element->getCSSFiles();
            if (is_array($elementUrls)) {
                $urls = array_merge($urls, $elementUrls);
            }
        }

        //*This section prevents duplicate css files from being loaded.*/
        if (!empty($urls)) {
            $urls = array_values(array_unique($urls));
            foreach ($urls as $url) {
                echo '<link rel="stylesheet" href="', $url, '"/>';
            }
        }
    }

    /**
     * @return bool
     */
    private function isNotJQueryUiButtons()
    {
        return !in_array('jQueryUIButtons', $this->prevent, true);
    }

    /**
     * @return bool
     */
    private function isFormFocusNotOnHomepage()
    {
        return ((new HttpRequest)->currentUrl() !== PH7_URL_ROOT) &&
            !in_array('focus', $this->prevent, true);
    }
}

pH7Software / pH7-Social-Dating-CMS

Form F last analyzed 2019-03-31 04:46 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

34 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

Form F
last analyzed 2019-03-31 04:46 UTC
