FlameCore/Infernum

<?php
/**
 * Infernum
 * Copyright (C) 2015 IceFlame.net
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all copies.
 *
 * @package  FlameCore\Infernum
 * @version  0.1-dev
 * @link     http://www.flamecore.org
 * @license  http://opensource.org/licenses/ISC ISC License
 */

namespace FlameCore\Infernum\Entity;

/**
 * Object describing a user group.
 *
 * The identifier can be the ID (int) or name (string) of the user group.
 *
 * @author   Christian Neff <christian.neff@gmail.com>
 */
class UserGroup extends AbstractEntity
{
    /**
     * Returns the groups's ID
     *
     * @return int
     */
    public function getID()
    {
        return $this->get('id');
    }

    /**
     * Returns the name of the group
     *
     * @return string
     */
    public function getName()
    {
        return $this->get('name');
    }

    /**
     * Returns the title of the group
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->get('title');
    }

    /**
     * Sets the title of the group
     *
     * @param string $title The new title
     */
    public function setTitle($title)
    {
        $this->set('title', $title);
    }

    /**
     * Returns the access level of the group
     *
     * @return int
     */
    public function getAccessLevel()
    {
        return $this->get('accesslevel');
    }

    /**
     * Sets the access level of the group
     *
     * @param int $level The new access level
     */
    public function setAccessLevel($level)
    {
        $this->set('accesslevel', $level);
    }

    /**
     * Checks if the group is hierarchically equal or superior to the given group
     *
     * @param int|string $mingroup Require at least this user group. Accepts ID (int) or name (string) of the group.
     * @return bool
     */
    public function isAuthorized($mingroup)
    {
        $mingroup = new self($mingroup, $this->database);
        $minlevel = $mingroup->getAccessLevel();

        return $this->get('accesslevel') >= $minlevel;
    }

    /**
     * Parses the user group identifier.
     *
     * @param int|string $identifier The ID (int) or name (string) of the user group
     * @return array
     */
    protected static function parseIdentifier($identifier)
    {
        if (is_string($identifier)) {
            $selector = 'name';
        } elseif (is_int($identifier)) {
            $selector = 'id';
        } else {
            throw new \InvalidArgumentException('Invalid user group identifier given.');
        }

        return array($selector, $identifier);
    }

    /**
     * {@inheritdoc}
     */
    protected static function getTable()
    {
        return 'usergroups';
    }

    /**
     * {@inheritdoc}
     */
    protected static function getKeyName()
    {
        return 'id';
    }

    /**
     * {@inheritdoc}
     */
    protected static function getFields()
    {
        return array(
            'id' => 'int',
            'name' => 'string',
            'title' => 'string',
            'accesslevel' => 'int'
        );
    }
}