mambax7 / smartobject

class/Link.php

<?php namespace XoopsModules\Smartobject;

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

/**
 * @copyright    XOOPS Project https://xoops.org/
 * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package
 * @since
 * @author     XOOPS Development Team
 */

use XoopsModules\Smartobject;


// defined('XOOPS_ROOT_PATH') || die('Restricted access');
//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';

/**
 * Class Link
 */
class Link extends Smartobject\BaseSmartObject
{
    /**
     * Link constructor.
     */
    public function __construct()
    {
        $this->initVar('linkid', XOBJ_DTYPE_INT, '', true);
        $this->initVar('date', XOBJ_DTYPE_INT, 0, false, null, '', false, _CO_SOBJECT_LINK_DATE, '', true, true, false);
        $this->initVar('from_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_FROM_UID, _CO_SOBJECT_LINK_FROM_UID_DSC);
        $this->initVar('from_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_EMAIL, _CO_SOBJECT_LINK_FROM_EMAIL_DSC, true);
        $this->initVar('from_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_NAME, _CO_SOBJECT_LINK_FROM_NAME_DSC, true);
        $this->initVar('to_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_TO_UID, _CO_SOBJECT_LINK_TO_UID_DSC);
        $this->initVar('to_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_EMAIL, _CO_SOBJECT_LINK_TO_EMAIL_DSC, true);
        $this->initVar('to_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_NAME, _CO_SOBJECT_LINK_TO_NAME_DSC, true);
        $this->initVar('link', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_LINK, _CO_SOBJECT_LINK_LINK_DSC, true);
        $this->initVar('subject', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_SUBJECT, _CO_SOBJECT_LINK_SUBJECT_DSC, true);
        $this->initVar('body', XOBJ_DTYPE_TXTAREA, '', true, null, '', false, _CO_SOBJECT_LINK_BODY, _CO_SOBJECT_LINK_BODY_DSC);
        $this->initVar('mid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_MID, _CO_SOBJECT_LINK_MID_DSC);
        $this->initVar('mid_name', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_MID_NAME, _CO_SOBJECT_LINK_MID_NAME_DSC, true);
    }

    /**
     * returns a specific variable for the object in a proper format
     *
     * @access public
     * @param  string $key    key of the object's variable to be returned
     * @param  string $format format to use for the output
     * @return mixed  formatted value of the variable
     */
    public function getVar($key, $format = 's')

This method seems to be duplicated in your project.

    {
        if ('s' === $format && in_array($key, ['from_uid', 'to_uid', 'date', 'link'])) {
            //            return call_user_func(array($this, $key));
            return $this->{$key}();
        }

        return parent::getVar($key, $format);
    }

    /**
     * @return string
     */
    public function from_uid()
    {
        $ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid', 'e'), 1, null, true);

null is of type null, but the function expects a array.

        return $ret;
    }

    /**
     * @param  bool $withContact
     * @return string
     */
    public function to_uid($withContact = false)
    {
        $ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid', 'e'), 1, null, true);

null is of type null, but the function expects a array.

        return $ret;
    }

    /**
     * @return string
     */
    public function date()
    {
        $ret = formatTimestamp($this->getVar('date', 'e'));

        return $ret;
    }

    /**
     * @param  bool $full
     * @return mixed|string
     */
    public function link($full = false)
    {
        $ret = $this->getVar('link', 'e');
        if ($full) {
            $myts = \MyTextSanitizer::getInstance();
            $ret  = $myts->displayTarea($ret);

            return $ret;
        } else {
            $ret = '<a href="' . $ret . '" alt="' . $this->getVar('link', 'e') . '" title="' . $this->getVar('link', 'e') . '">' . _AM_SOBJECT_SENT_LINKS_GOTO . '</a>';

            return $ret;
        }
    }

    /**
     * @return string
     */
    public function getViewItemLink()
    {
        $ret = '<a href="' . SMARTOBJECT_URL . 'admin/link.php?op=view&linkid=' . $this->getVar('linkid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'mail_find.png" alt="' . _AM_SOBJECT_SENT_LINK_VIEW . '" title="' . _AM_SOBJECT_SENT_LINK_VIEW . '"></a>';

        return $ret;
    }

    /**
     * @return string
     */
    public function getFromInfo()

This method seems to be duplicated in your project.

    {
        // check if from_uid represent a user

        if ($this->getVar('from_uid')) {
            $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid'));
            if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
                $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
            }
        } else {
            $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
        }

        return $user;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $ret             = parent::toArray();
        $ret['fromInfo'] = $this->getFromInfo();
        $ret['toInfo']   = $this->getToInfo();
        $ret['fullLink'] = $this->link(true);

        return $ret;
    }

    /**
     * @return string
     */
    public function getToInfo()

This method seems to be duplicated in your project.

    {
        // check if from_uid represent a user

        if ($this->getVar('to_uid')) {
            $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid'));
            if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
                $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
            }
        } else {
            $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
        }

        return $user;
    }
}