SmartObjectController::getEditLanguageLink() - Code Metrics - Inspection of "bug fixes" - mambax7/smartobject - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 01b1a5...81f493 )

by Michael
created 2016-05-31 09:59 UTC
SmartObjectController::getEditLanguageLink() B

↳ Parent: SmartObjectController
Complexity

Conditions	3
Paths	3
Size

Total Lines	27
Code Lines	23
Duplication

Lines	0
Ratio	0 %
Importance

Changes	5
Bugs	1	Features	0
Metric	Value
cc	3
eloc	23
c	5
b	1
f	0
nc	3
nop	3
dl	0
loc	27
rs	8.8571
<?php

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

// defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');


/**
 * 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
 */
include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobjecthandler.php';

/**
 * Class SmartObjectController
 */
class SmartObjectController
{
    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]) && $_POST['delete_' . $key] == '1') {

                        $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'])) {
            include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
            $uploaderObj = new SmartUploader($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 ($smartObj->vars[$related_field]['data_type'] === XOBJ_DTYPE_FILE) {
                                $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 SmartobjectPermissionHandler($this->handler);
                $smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
            }
        }

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

            $redirect_page = $redirect_page ?: smart_get_page_before_form();

            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 bool
     * @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 = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
        if ($confirm) {
            if (!$this->handler->delete($smartObj)) {

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

            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(array('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 = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
        if ($confirm) {
            if (!$this->handler->delete($smartObj)) {

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

            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(array('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       = smart_getModuleModeSEO($this->handler->_moduleName);
        $seoModuleName = smart_getModuleNameForSEO($this->handler->_moduleName);

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

        $seoIncludeId = true;

        if ($seoMode === 'rewrite') {
            $ret = XOOPS_URL .
                   '/' .
                   $seoModuleName .
                   '.' .
                   $this->handler->_itemname .
                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
                   '/' .
                   $smartObj->getVar('short_url') .
                   '.html';
        } elseif ($seoMode === 'pathinfo') {
            $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 = smart_getModuleInfo($smartObj->handler->_moduleName);
        $link        = smart_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

Push — master ( 01b1a5...81f493 )

SmartObjectController::getEditLanguageLink() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
