Permission.php

Go to the documentation of this file.

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

namespace Xmf\Module;

use Xmf\Loader;
use Xmf\Module\Helper;
use Xmf\Module\Helper\AbstractHelper;

class Permission extends AbstractHelper
{
    private $mid;

    private $dirname;

    private $db;

    private $perm;

    private $xoops = null;

    public function init()
    {
        if (!class_exists('XoopsGroupPermHandler', true)) {
            Loader::loadFile(\XoopsBaseConfig::get('root-path') . '/kernel/groupperm.php');
        }
        $this->mid = $this->module->getVar('mid');
        $this->dirname = $this->module->getVar('dirname');
        $this->db = \XoopsDatabaseFactory::getConnection();
        $this->perm = new \XoopsGroupPermHandler($this->db);
        if (class_exists('Xoops', false)) {
            $this->xoops = \Xoops::getInstance();
        }
    }

    public function checkPermission($gperm_name, $gperm_itemid)
    {
        $gperm_groupid = $this->xoops->getUserGroups();

        return $this->perm->checkRight(
            $gperm_name,
            $gperm_itemid,
            $gperm_groupid,
            $this->mid
        );
    }

    public function checkPermissionRedirect(
        $gperm_name,
        $gperm_itemid,
        $url,
        $time = 3,
        $message = ''
    ) {
        $gperm_groupid = $this->xoops->getUserGroups();
        $permission = $this->perm->checkRight(
            $gperm_name,
            $gperm_itemid,
            $gperm_groupid,
            $this->mid
        );
        if (!$permission) {
            $helper = Helper::getHelper($this->dirname);
            $helper->redirect($url, $time, $message);
        }
    }

    public function getGroupsForItem($gperm_name, $gperm_itemid)
    {
        return $this->perm->getGroupIds($gperm_name, $gperm_itemid, $this->mid);
    }

    public function savePermissionForItem($gperm_name, $gperm_itemid, $groups)
    {
        $result = true;

        // First, delete any existing permissions for this name and id
        $this->deletePermissionForItem($gperm_name, $gperm_itemid);

        // Save the new permissions
        if (count($groups) > 0) {
            foreach ($groups as $group_id) {
                $this->perm->addRight(
                    $gperm_name,
                    $gperm_itemid,
                    $group_id,
                    $this->mid
                );
            }
        }

        return $result;
    }

    public function deletePermissionForItem($gperm_name, $gperm_itemid)
    {
        return $this->perm->deleteByModule($this->mid, $gperm_name, $gperm_itemid);
    }

    public function getGroupSelectFormForItem(
        $gperm_name,
        $gperm_itemid,
        $caption,
        $name = null,
        $include_anon = false,
        $size = 5,
        $multiple = true
    ) {
        if (empty($name)) {
            $name = $this->defaultFieldName($gperm_name, $gperm_itemid);
        }
        $value = $this->getGroupsForItem($gperm_name, $gperm_itemid);
        $element = new \Xoops\Form\SelectGroup(
            $caption,
            $name,
            $include_anon,
            $value,
            $size,
            $multiple
        );

        return $element;

    }

    public function defaultFieldName($gperm_name, $gperm_itemid)
    {
        $name = $this->module->getVar('dirname') . '_' .
            $gperm_name . '_' . $gperm_itemid;

        return $name;
    }
}