ObjectController - Code Metrics - mambax7/smartobject - Measure and Improve Code Quality continuously with Scrutinizer

ObjectController F
last analyzed 2019-01-19 04:07 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	510
Duplicated Lines	10.98 %
Coupling/Cohesion

Components	1
Dependencies	3
Importance

Changes
Metric	Value
dl	56
loc	510
rs	2
c	0
b	0
f	0
wmc	85
lcom	1
cbo	3
15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
D	postDataToObject()	14	76	24
C	doStoreFromDefaultForm()	0	81	17
B	storeFromDefaultForm()	12	49	7
A	storeSmartObjectD()	0	4	1
A	storeSmartObject()	0	6	1
B	handleObjectDeletion()	3	38	6
B	handleObjectDeletionFromUserSide()	3	35	6
A	getAdminViewItemLink()	0	11	3
B	getItemLink()	0	25	6
A	getEditLanguageLink()	0	11	3
A	getEditItemLink()	12	12	4
A	getDeleteItemLink()	12	12	4
A	getPrintAndMailLink()	0	29	1
A	getModuleItemString()	0	6	1
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like ObjectController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ObjectController, and based on these observations, apply Extract Interface, too.
<?php namespace XoopsModules\Smartobject;

/**
 * Contains the basis classes for managing any objects derived from SmartObjects
 *
 * @license    GNU
 * @author     marcan <[email protected]>
 * @link       http://smartfactory.ca The SmartFactory
 * @package    SmartObject
 * @subpackage SmartObjectCore
 */

use XoopsModules\Smartobject;

// defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * Persistable SmartObject Controller class.
 *
 * This class is responsible for providing operations to an object
 * for managing the object's manipulation
 *
 * @package SmartObject
 * @author  marcan <[email protected]>
 * @credit  Jan Keller Pedersen <[email protected]> - IDG Danmark A/S <www.idg.dk>
 * @link    http://smartfactory.ca The SmartFactory
 */
//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobjecthandler.php';

/**
 * Class SmartObjectController
 */
class ObjectController
{
    public $handler;

    /**
     * SmartObjectController constructor.
     * @param $handler
     */
    public function __construct($handler)
    {
        $this->handler = $handler;
    }

    /**
     * @param $smartObj
     */
    public function postDataToObject(&$smartObj)
    {
        foreach (array_keys($smartObj->vars) as $key) {
            switch ($smartObj->vars[$key]['data_type']) {
                case XOBJ_DTYPE_IMAGE:
                    if (isset($_POST['url_' . $key]) && '' !== $_POST['url_' . $key]) {

                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
                        $smartObj->setVar($key, $_POST['url_' . $key]);
                        if (file_exists($oldFile)) {
                            unlink($oldFile);
                        }
                    }
                    if (isset($_POST['delete_' . $key]) && '1' == $_POST['delete_' . $key]) {

                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
                        $smartObj->setVar($key, '');
                        if (file_exists($oldFile)) {
                            unlink($oldFile);
                        }
                    }
                    break;

                case XOBJ_DTYPE_URLLINK:
                    $linkObj = $smartObj->getUrlLinkObj($key);
                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
                    $linkObj->setVar('description', $_POST['desc_' . $key]);
                    $linkObj->setVar('target', $_POST['target_' . $key]);
                    $linkObj->setVar('url', $_POST['url_' . $key]);
                    if ('' !== $linkObj->getVar('url')) {
                        $smartObj->storeUrlLinkObj($linkObj);
                    }
                    //todo: catch errors
                    $smartObj->setVar($key, $linkObj->getVar('urllinkid'));
                    break;

                case XOBJ_DTYPE_FILE:
                    if (!isset($_FILES['upload_' . $key]['name']) || '' === $_FILES['upload_' . $key]['name']) {
                        $fileObj = $smartObj->getFileObj($key);
                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
                        $fileObj->setVar('description', $_POST['desc_' . $key]);
                        $fileObj->setVar('url', $_POST['url_' . $key]);
                        if (!('' === $fileObj->getVar('url') && '' === $fileObj->getVar('url')
                              && '' === $fileObj->getVar('url'))) {
                            $res = $smartObj->storeFileObj($fileObj);
                            if ($res) {
                                $smartObj->setVar($key, $fileObj->getVar('fileid'));
                            } else {
                                //error setted, but no error message (to be improved)
                                $smartObj->setErrors($fileObj->getErrors());
                            }
                        }
                    }
                    break;

                case XOBJ_DTYPE_STIME:
                case XOBJ_DTYPE_MTIME:
                case XOBJ_DTYPE_LTIME:
                    // check if this field's value is available in the POST array
                    if (is_array($_POST[$key]) && isset($_POST[$key]['date'])) {
                        $value = strtotime($_POST[$key]['date']) + $_POST[$key]['time'];
                    } else {
                        $value = strtotime($_POST[$key]);
                        //if strtotime returns false, the value is already a time stamp
                        if (!$value) {
                            $value = (int)$_POST[$key];
                        }
                    }
                    $smartObj->setVar($key, $value);

                    break;

                default:
                    $smartObj->setVar($key, $_POST[$key]);
                    break;
            }
        }
    }

    /**
     * @param        $smartObj
     * @param        $objectid
     * @param        $created_success_msg
     * @param        $modified_success_msg
     * @param  bool  $redirect_page
     * @param  bool  $debug
     * @return mixed
     */
    public function doStoreFromDefaultForm(
        &$smartObj,
        $objectid,

        $created_success_msg,
        $modified_success_msg,
        $redirect_page = false,
        $debug = false
    ) {
        global $smart_previous_page;

        $this->postDataToObject($smartObj);

        if ($smartObj->isNew()) {
            $redirect_msg = $created_success_msg;
        } else {
            $redirect_msg = $modified_success_msg;
        }

        // Check if there were uploaded files
        if (isset($_POST['smart_upload_image']) || isset($_POST['smart_upload_file'])) {
//            require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
            $uploaderObj = new Uploader($smartObj->getImageDir(true), $this->handler->_allowedMimeTypes, $this->handler->_maxFileSize, $this->handler->_maxWidth, $this->handler->_maxHeight);
            foreach ($_FILES as $name => $file_array) {
                if (isset($file_array['name']) && '' !== $file_array['name']
                    && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
                    if ($uploaderObj->fetchMedia($name)) {
                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
                        if ($uploaderObj->upload()) {
                            // Find the related field in the SmartObject
                            $related_field   = str_replace('upload_', '', $name);
                            $uploadedArray[] = $related_field;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                            //si c'est un fichier Rich
                            if (XOBJ_DTYPE_FILE === $smartObj->vars[$related_field]['data_type']) {
                                $object_fileurl = $smartObj->getUploadDir();
                                $fileObj        = $smartObj->getFileObj($related_field);
                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
                                $smartObj->storeFileObj($fileObj);
                                //todo: catch errors
                                $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
                            } else {
                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
                                unlink($old_file);
                                $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
                            }
                        } else {
                            $smartObj->setErrors($uploaderObj->getErrors(false));
                        }
                    } else {
                        $smartObj->setErrors($uploaderObj->getErrors(false));
                    }
                }
            }
        }

        if ($debug) {
            $storeResult = $this->handler->insertD($smartObj);
        } else {
            $storeResult = $this->handler->insert($smartObj);
        }

        if ($storeResult) {
            if ($this->handler->getPermissions()) {
                $smartPermissionsHandler = new PermissionHandler($this->handler);
                $smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
            }
        }

        if (null === $redirect_page) {
            return $smartObj;
        } else {
            if (!$storeResult) {
                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
            }

            $redirect_page = $redirect_page ?: Smartobject\Utility::getPageBeforeForm();

            redirect_header($redirect_page, 2, $redirect_msg);
        }
    }

    /**
     * Store the object in the database autmatically from a form sending POST data
     *
     * @param  string      $created_success_msg  message to display if new object was created
     * @param  string      $modified_success_msg message to display if object was successfully edited
     * @param  bool|string $redirect_page        redirect page, if not set, then we backup once
     * @param  bool        $debug
     * @param  bool        $x_param
     * @return bool
     * @internal param string $created_redir_page redirect page after creating the object
     * @internal param string $modified_redir_page redirect page after editing the object
     * @internal param bool $exit if set to TRUE then the script ends
     */
    public function storeFromDefaultForm(
        $created_success_msg,
        $modified_success_msg,
        $redirect_page = false,
        $debug = false,
        $x_param = false
    ) {
        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
        if ($debug) {
            if ($x_param) {

                $smartObj = $this->handler->getD($objectid, true, $x_param);
            } else {
                $smartObj = $this->handler->getD($objectid);
            }
        } else {

            if ($x_param) {
                $smartObj = $this->handler->get($objectid, true, false, false, $x_param);
            } else {
                $smartObj = $this->handler->get($objectid);
            }
        }

        // if handler is the Multilanguage handler, we will need to treat this for multilanguage
        if (is_subclass_of($this->handler, 'smartpersistablemlobjecthandler')) {

            if ($smartObj->isNew()) {
                // This is a new object. We need to store the meta data and then the language data
                // First, we will get rid of the multilanguage data to only store the meta data
                $smartObj->stripMultilanguageFields();
                $newObject = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);

                /**
                 * @todo we need to trap potential errors here
                 */

                // ok, the meta daa is stored. Let's recreate the object and then
                // get rid of anything not multilanguage
                unset($smartObj);
                $smartObj = $this->handler->get($objectid);
                $smartObj->stripNonMultilanguageFields();

                $smartObj->setVar($this->handler->keyName, $newObject->getVar($this->handler->keyName));
                $this->handler->changeTableNameForML();
                $ret = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);


                return $ret;
            }
        } else {
            return $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);

        }
    }

    /**
     * @return bool
     */
    public function storeSmartObjectD()
    {
        return $this->storeSmartObject(true);
    }

    /**
     * @param  bool $debug
     * @param  bool $xparam
     * @return bool
     */
    public function storeSmartObject($debug = false, $xparam = false)
    {
        $ret = $this->storeFromDefaultForm('', '', null, $debug, $xparam);

        return $ret;
    }

    /**
     * Handles deletion of an object which keyid is passed as a GET param
     *
     * @param  bool   $confirm_msg
     * @param  string $op
     * @param  bool   $userSide
     * @return void
     * @internal param string $redir_page redirect page after deleting the object
     */
    public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)

    {
        global $smart_previous_page;

        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
        $smartObj = $this->handler->get($objectid);

        if ($smartObj->isNew()) {
            redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
        }

        $confirm = \Xmf\Request::getInt('confirm', 0, POST);
        if ($confirm) {
            if (!$this->handler->delete($smartObj)) {

                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
            }

            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
        } else {
            // no confirm: show deletion condition

            xoops_cp_header();

            if (!$confirm_msg) {
                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
            }

            xoops_confirm([
                              'op'                    => $op,
                              $this->handler->keyName => $smartObj->getVar($this->handler->keyName),
                              'confirm'               => 1,
                              'redirect_page'         => $smart_previous_page
                          ], xoops_getenv('PHP_SELF'), sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);

            xoops_cp_footer();
        }
        exit();
    }

    /**
     * @param bool   $confirm_msg
     * @param string $op
     */
    public function handleObjectDeletionFromUserSide($confirm_msg = false, $op = 'del')
    {
        global $smart_previous_page, $xoopsTpl;

        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
        $smartObj = $this->handler->get($objectid);

        if ($smartObj->isNew()) {
            redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
        }

        $confirm = \Xmf\Request::getInt('confirm', 0, POST);
        if ($confirm) {
            if (!$this->handler->delete($smartObj)) {

                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
            }

            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
        } else {
            // no confirm: show deletion condition
            if (!$confirm_msg) {
                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
            }

            ob_start();
            xoops_confirm([
                              'op'                    => $op,
                              $this->handler->keyName => $smartObj->getVar($this->handler->keyName),
                              'confirm'               => 1,
                              'redirect_page'         => $smart_previous_page
                          ], xoops_getenv('PHP_SELF'), sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);
            $smartobjectDeleteConfirm = ob_get_clean();
            $xoopsTpl->assign('smartobject_delete_confirm', $smartobjectDeleteConfirm);
        }
    }

    /**
     * Retreive the object admin side link for a {@link SmartObjectSingleView} page
     *
     * @param  SmartObject $smartObj reference to the object from which we want the user side link
     * @param  bool        $onlyUrl  wether or not to return a simple URL or a full <a> link
     * @param  bool        $withimage
     * @return string      admin side link to the object
     */
    public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
    {
        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
        if ($onlyUrl) {
            return $ret;
        } elseif ($withimage) {
            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "viewmag.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_ADMIN_VIEW . "'  title='" . _CO_SOBJECT_ADMIN_VIEW . "'></a>";
        }

        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
    }

    /**
     * Retreive the object user side link
     *
     * @param  SmartObject $smartObj reference to the object from which we want the user side link
     * @param  bool        $onlyUrl  wether or not to return a simple URL or a full <a> link
     * @return string      user side link to the object
     */
    public function getItemLink(SmartObject $smartObj, $onlyUrl = false)
    {
        $seoMode       = Smartobject\Utility::getModuleModeSEO($this->handler->_moduleName);
        $seoModuleName = Smartobject\Utility::getModuleNameForSEO($this->handler->_moduleName);

        /**
         * $seoIncludeId feature is not finished yet, so let's put it always to true
         */
        //$seoIncludeId = Smartobject\Utility::getModuleIncludeIdSEO($this->handler->_moduleName);
        $seoIncludeId = true;

        if ('rewrite' === $seoMode) {
            $ret = XOOPS_URL . '/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
        } elseif ('pathinfo' === $seoMode) {
            $ret = SMARTOBJECT_URL . 'seo.php/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
        } else {
            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
        }

        if (!$onlyUrl) {
            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
        }

        return $ret;
    }

    /**
     * @param         $smartObj
     * @param  bool   $onlyUrl
     * @param  bool   $withimage
     * @return string
     */
    public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
    {
        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName) . '&language=' . $smartObj->getVar('language');
        if ($onlyUrl) {
            return $ret;
        } elseif ($withimage) {
            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "wizard.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_LANGUAGE_MODIFY . "'  title='" . _CO_SOBJECT_LANGUAGE_MODIFY . "'></a>";
        }

        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
    }

    /**
     * @param         $smartObj
     * @param  bool   $onlyUrl
     * @param  bool   $withimage
     * @param  bool   $userSide
     * @return string
     */
    public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)

    {
        $admin_side = $userSide ? '' : 'admin/';
        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
        if ($onlyUrl) {
            return $ret;
        } elseif ($withimage) {
            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "edit.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_MODIFY . "'  title='" . _CO_SOBJECT_MODIFY . "'></a>";
        }

        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
    }

    /**
     * @param         $smartObj
     * @param  bool   $onlyUrl
     * @param  bool   $withimage
     * @param  bool   $userSide
     * @return string
     */
    public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)

    {
        $admin_side = $userSide ? '' : 'admin/';
        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
        if ($onlyUrl) {
            return $ret;
        } elseif ($withimage) {
            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "editdelete.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_DELETE . "'  title='" . _CO_SOBJECT_DELETE . "'></a>";
        }

        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
    }

    /**
     * @param $smartObj
     * @return string
     */
    public function getPrintAndMailLink($smartObj)
    {
        global $xoopsConfig;

        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"></a>';

        $smartModule = Smartobject\Utility::getModuleInfo($smartObj->handler->_moduleName);
        $link        = Smartobject\Utility::getCurrentPage();
        $mid         = $smartModule->getVar('mid');
        $friendlink  = "<a href=\"javascript:openWithSelfMain('"
                       . SMARTOBJECT_URL
                       . 'sendlink.php?link='
                       . $link
                       . '&amp;mid='
                       . $mid
                       . "', ',',',',',','sendmessage', 674, 500);\"><img src=\""
                       . SMARTOBJECT_IMAGES_ACTIONS_URL
                       . 'mail_send.png"  alt="'
                       . _CO_SOBJECT_EMAIL
                       . '" title="'
                       . _CO_SOBJECT_EMAIL
                       . '" style="vertical-align: middle;"></a>';

        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';

        return $ret;
    }

    /**
     * @return string
     */
    public function getModuleItemString()
    {
        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;

        return $ret;
    }
}

mambax7 / smartobject

ObjectController F last analyzed 2019-01-19 04:07 UTC
