XoopsXmlRpcApi

Complexity

Total Complexity

20

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

81.67%

Importance

Changes	2
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	_setUser()	0	7	2
A	_checkUser()	0	17	3
A	_checkAdmin()	0	14	4
B	_getPostFields()	0	24	1
A	_setXoopsTagMap()	0	6	2
A	_getXoopsTagMap()	0	8	2
A	_getTagCdata()	0	13	3
A	_getXoopsApi()	0	10	2

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

use Xoops\Core\Kernel\Handlers\XoopsModule;

This use statement conflicts with another class in this namespace, XoopsModule.

use Xoops\Core\Kernel\Handlers\XoopsUser;

This use statement conflicts with another class in this namespace, XoopsUser.

/**
 * @copyright       XOOPS Project (http://xoops.org)
 * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package         class
 * @subpackage      xml
 * @since           1.0.0
 * @author          Kazumi Ono (AKA onokazu)
 * @version         $Id $
 */
class XoopsXmlRpcApi
{

    // reference to method parameters
    protected $params;

    // reference to xmlrpc document class object
    /**
     * @var XoopsXmlRpcResponse
     */
    protected $response;

    // reference to module class object
    /**
     * @var XoopsModule
     */
    protected $module;

    // map between xoops tags and blogger specific tags
    protected $xoopsTagMap = array();

    // user class object
    protected $user;

    protected $isadmin = false;

    /**
     * @param $params
     * @param $response
     * @param $module
     */
    public function __construct(&$params, &$response, &$module)
    {
        $this->params = $params;
        $this->response = $response;
        $this->module = $module;
    }

    /**
     * @param      $user
     * @param bool $isadmin
     */
    public function _setUser(&$user, $isadmin = false)
    {
        if (is_object($user)) {
            $this->user = $user;
            $this->isadmin = $isadmin;
        }
    }

    /**
     * @param $username
     * @param $password
     *
     * @return bool
     */
    public function _checkUser($username, $password)
    {
        $xoops = Xoops::getInstance();

        $member_handler = $xoops->getHandlerMember();
        $this->user = $member_handler->loginUser(addslashes($username), addslashes($password));
        if (!is_object($this->user)) {
            $this->user = null;
            return false;
        }
        $moduleperm_handler = $xoops->getHandlerGroupPermission();
        if (!$moduleperm_handler->checkRight('module_read', $this->module->getVar('mid'), $this->user->getGroups())) {
            $this->user = null;
            return false;
        }
        return true;
    }

    /**
     * @return bool
     */
    public function _checkAdmin()
    {
        if ($this->isadmin) {
            return true;
        }
        if (!is_object($this->user)) {
            return false;
        }
        if (!$this->user->isAdmin($this->module->getVar('mid'))) {
            return false;
        }
        $this->isadmin = true;
        return true;
    }

    /**
     * @param null $post_id
     * @param null $blog_id
     *
     * @return array
     */
    public function &_getPostFields($post_id = null, $blog_id = null)

The parameter $post_id is not used and could be removed.

The parameter $blog_id is not used and could be removed.

    {
        $ret = array();
        $ret['title'] = array('required' => true, 'form_type' => 'textbox', 'value_type' => 'text');
        $ret['hometext'] = array('required' => false, 'form_type' => 'textarea', 'data_type' => 'textarea');
        $ret['moretext'] = array('required' => false, 'form_type' => 'textarea', 'data_type' => 'textarea');
        $ret['categories'] = array('required' => false, 'form_type' => 'select_multi', 'data_type' => 'array');

        /*
        if (!isset($blog_id)) {
            if (!isset($post_id)) {
                return false;
            }
            $itemman = $this->mf->get(MANAGER_ITEM);
            $item = $itemman->get($post_id);
            $blog_id = $item->getVar('sect_id');
        }
        $sectman = $this->mf->get(MANAGER_SECTION);
        $this->section = $sectman->get($blog_id);
        $ret = $this->section->getVar('sect_fields');
        */

        return $ret;
    }

    /**
     * @param string $xoopstag
     * @param string $blogtag
     */
    public function _setXoopsTagMap($xoopstag, $blogtag)
    {
        if (trim($blogtag) != '') {
            $this->xoopsTagMap[$xoopstag] = $blogtag;
        }
    }

    /**
     * @param $xoopstag
     *
     * @return mixed
     */
    public function _getXoopsTagMap($xoopstag)
    {
        if (isset($this->xoopsTagMap[$xoopstag])) {
            return $this->xoopsTagMap[$xoopstag];
        }

        return $xoopstag;
    }

    /**
     * @param      $text
     * @param      $tag
     * @param bool $remove
     *
     * @return string
     */
    public function _getTagCdata(&$text, $tag, $remove = true)
    {
        $ret = '';
        $match = array();
        if (preg_match("/\<" . $tag . "\>(.*)\<\/" . $tag . "\>/is", $text, $match)) {
            if ($remove) {
                $text = str_replace($match[0], '', $text);
            }
            $ret = $match[1];
        }

        return $ret;
    }

    // kind of dirty method to load XOOPS API and create a new object thereof
    // returns itself if the calling object is XOOPS API
    /**
     * @param $params
     *
     * @return XoopsApi
     */
    public function _getXoopsApi(&$params)
    {
        if (strtolower(get_class($this)) !== 'xoopsapi') {
            $xoops_root_path = \XoopsBaseConfig::get('root-path');
            require_once($xoops_root_path . '/class/xml/rpc/xoopsapi.php');
            return new XoopsApi($params, $this->response, $this->module);
        } else {
            return $this;
        }
    }
}