phpbb-extensions/boardrules

<?php
/**
*
* Board Rules extension for the phpBB Forum Software package.
*
* @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
*/

namespace phpbb\boardrules\operators;

use Symfony\Component\DependencyInjection\ContainerInterface;

/**
* Operator for a set of rules
*/
class rule implements rule_interface
{
    /** @var ContainerInterface */
    protected $container;

    /**
    * Nestedset for board rules
    *
    * @var \phpbb\boardrules\operators\nestedset_rules
    */
    protected $nestedset_rules;

    /**
    * Constructor
    *
    * @param ContainerInterface $container Service container interface
    * @param \phpbb\boardrules\operators\nestedset_rules $nestedset_rules Nestedset object for tree functionality
    * @access public
    */
    public function __construct(ContainerInterface $container, \phpbb\boardrules\operators\nestedset_rules $nestedset_rules)
    {
        $this->container = $container;
        $this->nestedset_rules = $nestedset_rules;
    }

    /**
    * Get the rules
    *
    * @param string $language Language selection iso
    * @param int $parent_id Category to display rules from; default: 0
    * @return array Array of rule data entities
    * @access public
    */
    public function get_rules($language, $parent_id = 0)
    {
        $entities = array();

        // Load all rule data from the database into an array
        $rowset = $this->nestedset_rules
            ->use_language($language)
            ->get_rules_data($parent_id);

        // Import each rule into an entity, and store them in an array
        foreach ($rowset as $row)
        {
            $entities[] = $this->container->get('phpbb.boardrules.entity')
                ->import($row);
        }

        // Return all rule entities
        return $entities;
    }

    /**
    * Add a rule
    *
    * @param \phpbb\boardrules\entity\rule_interface $entity Rule entity with new data to insert
    * @param string $language Language selection iso
    * @param int $parent_id Category to display rules from; default: 0
    * @return \phpbb\boardrules\entity\rule_interface Added rule entity
    * @access public
    * @throws \phpbb\boardrules\exception\out_of_bounds
    */
    public function add_rule($entity, $language, $parent_id = 0)
    {
        // Insert the rule data to the database for the given language selection
        $entity->insert($language);

        // Get the newly inserted rule's identifier
        $rule_id = $entity->get_id();

        // Update the tree for the rule in the database
        $this->nestedset_rules->add_to_nestedset($rule_id);

        // If a parent id was supplied, update the rule's parent id and tree ids
        if ($parent_id)
        {
            $this->nestedset_rules->change_parent($rule_id, $parent_id);
        }

        // Reload the data to return a fresh rule entity
        return $entity->load($rule_id);
    }

    /**
    * Delete a rule
    *
    * @param int $rule_id The rule identifier to delete
    * @return void
    * @access public
    * @throws \phpbb\boardrules\exception\out_of_bounds
    */
    public function delete_rule($rule_id)
    {
        $rule_id = (int) $rule_id;

        // Try to delete the rule or category from the database
        try
        {
            $this->nestedset_rules->delete($rule_id);
        }
        catch (\OutOfBoundsException $e)
        {
            throw new \phpbb\boardrules\exception\out_of_bounds('rule_id');
        }
    }

    /**
    * Move a rule up/down
    *
    * @param int $rule_id The rule identifier to move
    * @param string $direction The direction (up|down)
    * @param int $amount The number of places to move the rule
    * @return void
    * @access public
    * @throws \phpbb\boardrules\exception\out_of_bounds
    */
    public function move($rule_id, $direction = 'up', $amount = 1)
    {
        $rule_id = (int) $rule_id;
        $amount = (int) $amount;

        // Try to move the rule or category up/down
        try
        {
            $this->nestedset_rules->move($rule_id, (($direction !== 'up') ? -$amount : $amount));
        }
        catch (\OutOfBoundsException $e)
        {
            throw new \phpbb\boardrules\exception\out_of_bounds('rule_id');
        }
    }

    /**
    * Change rule parent
    *
    * @param int $rule_id The current rule identifier
    * @param int $new_parent_id The new rule parent identifier
    * @return void
    * @access public
    * @throws \phpbb\boardrules\exception\out_of_bounds
    */
    public function change_parent($rule_id, $new_parent_id)
    {
        $rule_id = (int) $rule_id;
        $new_parent_id = (int) $new_parent_id;

        // Try to change rule parent
        try
        {
            $this->nestedset_rules->change_parent($rule_id, $new_parent_id);
        }
        catch (\OutOfBoundsException $e)
        {
            $field = (strpos($e->getMessage(), 'INVALID_ITEM') !== false) ? 'rule_id' : 'new_parent_id';

            throw new \phpbb\boardrules\exception\out_of_bounds($field);
        }
    }

    /**
    * Get a rule's parent rules (for use in breadcrumbs)
    *
    * @param string $language Language selection iso
    * @param int $parent_id Category to display rules from
    * @return array Array of rule data for a rule's parent rules
    * @access public
    */
    public function get_rule_parents($language, $parent_id)
    {
        $entities = array();

        // Load all parent rule data from the database into an array
        $rowset = $this->nestedset_rules
            ->use_language($language)
            ->get_path_data($parent_id);

        // Import each rule into an entity, and store them in an array
        foreach ($rowset as $row)
        {
            $entities[] = $this->container->get('phpbb.boardrules.entity')
                ->import($row);
        }
        return $entities;
    }
}