mambax7 / alumni-26x

class/permission.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 34 and the first side effect is on line 29.

/*
 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\XoopsObjectHandler;
use Xoops\Core\Kernel\Criteria;
use Xoops\Core\Kernel\CriteriaCompo;

/**
 *  Alumni class
 *
 * @copyright       The XUUPS Project http://sourceforge.net/projects/xuups/
 * @license         GNU GPL V2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package         Class
 * @subpackage      Handlers
 * @since           1.0
 * @author          trabis <lusopoemas@gmail.com>
 * @author          The SmartFactory <www.smartfactory.ca>
 * @version         $Id$
 */

include_once dirname(__DIR__) . '/include/common.php';

/**
 * Class AlumniPermissionHandler
 */
class AlumniPermissionHandler extends XoopsObjectHandler

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @var Alumni
     * @access public
     */
    public $alumni = null;

    /**
     * constructor
     */
    public function __construct()
    {
        $this->alumni = Alumni::getInstance();
        $this->db2    = \Xoops::getInstance()->db();
    }

    /**
     * Returns permissions for a certain type
     *
     * @param string $gperm_name "global", "forum" or "topic" (should perhaps have "post" as well - but I don't know)
     * @param int    $id         id of the item (forum, topic or possibly post) to get permissions for
     *
     * @return array
     */
    public function getGrantedGroupsById($gperm_name, $id)

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        static $items;
        if (isset($items[$gperm_name][$id])) {

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            return $items[$gperm_name][$id];

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }
        $groups   = [];
        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('gperm_modid', $this->alumni->getModule()->getVar('mid')));
        $criteria->add(new Criteria('gperm_name', $gperm_name));

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $criteria->add(new Criteria('gperm_itemid', $id));
        //Instead of calling groupperm handler and get objects, we will save some memory and do it our way
        $qb = $this->db2->createXoopsQueryBuilder();

Avoid variables with short names like $qb. Configured minimum length is 3.

        $qb->select('gperm_groupid')->fromPrefix('group_permission', '');
        $criteria->renderQb($qb);
        $result = $qb->execute();

        while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
            $groups[$myrow['gperm_groupid']] = $myrow['gperm_groupid'];
        }
        $items[$gperm_name][$id] = $groups;

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        return $groups;
    }

    /**
     * Returns permissions for a certain type
     *
     * @param string $gperm_name "global", "forum" or "topic" (should perhaps have "post" as well - but I don't know)
     *
     * @return array
     */
    public function getGrantedItems($gperm_name)

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        static $items;
        if (isset($items[$gperm_name])) {

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            return $items[$gperm_name];

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }
        $ret = [];
        //Instead of calling groupperm handler and get objects, we will save some memory and do it our way
        $criteria = new CriteriaCompo(new Criteria('gperm_name', $gperm_name));

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $criteria->add(new Criteria('gperm_modid', $this->alumni->getModule()->getVar('mid')));

        //Get user's groups
        $groups    = \Xoops::getInstance()->getUserGroups();
        $criteria2 = new CriteriaCompo();
        foreach ($groups as $gid) {
            $criteria2->add(new Criteria('gperm_groupid', $gid), 'OR');
        }
        $criteria->add($criteria2);

        $qb = $this->db2->createXoopsQueryBuilder();

Avoid variables with short names like $qb. Configured minimum length is 3.

        $qb->select('gperm_itemid')->fromPrefix('group_permission', '');
        $criteria->renderQb($qb);
        $result = $qb->execute();

        while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
            $ret[$myrow['gperm_itemid']] = $myrow['gperm_itemid'];
        }
        $items[$gperm_name] = $ret;

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        return $ret;
    }

    /**
     * isGranted
     *
     * @param string $gperm_name permission name
     * @param int    $id         item id
     *
     * @return bool
     */
    public function isGranted($gperm_name, $id)

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        if (!$id) {
            return false;
        }
        $permissions = $this->getGrantedItems($gperm_name);

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if (!empty($permissions) && isset($permissions[$id])) {

The if-else statement can be simplified to return !empty($permissions) && isset($permissions[$id]);.

            return true;
        } else {
            return false;
        }
    }

    /**
     * Saves permissions for the selected category
     *  saveCategory_Permissions()
     *
     * @param array   $groups    group with granted permission
     * @param integer $itemid    itemid on which we are setting permissions for Categories and Forums
     * @param string  $perm_name name of the permission
     *
     * @return boolean : TRUE if the no errors occured
     *
     * @todo is this used anywhere?
     */
    public function saveItemPermissions($groups, $itemid, $perm_name)

function saveItemPermissions() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

$perm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        $xoops         = Xoops::getInstance();
        $result        = true;
        $module_id     = $this->alumni->getModule()->getVar('mid');

$module_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $gperm_handler = $xoops->getHandlerGroupPermission();

$gperm_handler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        // First, if the permissions are already there, delete them
        $gperm_handler->deleteByModule($module_id, $perm_name, $itemid);

$gperm_handler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        // Save the new permissions
        if (count($groups) > 0) {
            foreach ($groups as $group_id) {

$group_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                echo $group_id . '-';

$group_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                echo $gperm_handler->addRight($perm_name, $itemid, $group_id, $module_id);

$gperm_handler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            }
        }
        return $result;
    }

    /**
     * Delete all permission for a specific item
     *  deletePermissions()
     *
     * @param integer $itemid     id of the item for which to delete the permissions
     * @param string  $gperm_name permission name
     *
     * @return boolean : TRUE if the no errors occured
     */
    public function deletePermissions($itemid, $gperm_name)

function deletePermissions() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

$gperm_name does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        $xoops         = Xoops::getInstance();
        $result        = true;
        $gperm_handler = $xoops->getHandlerGroupPermission();

$gperm_handler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $gperm_handler->deleteByModule($this->alumni->getModule()->getVar('mid'), $gperm_name, $itemid);

$gperm_handler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        return $result;
    }
}