Skip to content
Snippets Groups Projects
Select Git revision
  • 47f4b434ec7793d9b4858c49ac91c9b8556cc481
  • main default protected
  • issue-56
  • testing-systems
4 results

mergerequests.php

Blame
  • Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    ResourceTreeWidget.class.php 4.61 KiB
    <?php
    
    /**
     * This class provides a resource tree view for the sidebar.
     *
     * @author      Moritz Strohm <strohm@data-quest.de>
     * @copyright   2017-2019
     * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
     * @category    Stud.IP
     * @since       4.5
     */
    class ResourceTreeWidget extends SidebarWidget
    {
        /**
         * $root_resource is the resource whose resource tree
         * shall be displayed by this widget.
         * The resource itself and all its children are displayed.
         */
        protected $root_resources = [];
        protected $parameter_name = '';
        protected $foldable = false;
        protected $current_resource_id = null;
    
        /**
         * This widget must be initialised by providing at least one
         * Resource object in an array.
         *
         * @param array $root_resources The root resource objects which will be
         *     displayed by this tree view.
         * @param string $title The title of this widget.
         * @param string|null $parameter_name The name of the URL parameter which
         *     will be set when one of the resources in the tree is selected.
         *     If parameter_name is set to null the items in the resource tree
         *     widget will link to the resource's details page.
         */
        public function __construct(
            array $root_resources = [],
            $title = '',
            $parameter_name = 'tree_selected_resource'
        )
        {
            parent::__construct();
    
            if (!$root_resources) {
                throw new InvalidArgumentException(
                    'ResourceTreeWidget instances must be initalised with at least one resource object!'
                );
            }
    
            //Extra check to make sure the root_resources attribute of this instance
            //is an array containing only Resource objects or objects derived
            //from the Resource class:
            foreach ($root_resources as $root_resource) {
                if ($root_resource instanceof Resource) {
                    $this->root_resources[] = $root_resource;
                }
            }
    
            if (!$this->root_resources) {
                throw new InvalidArgumentException(
                    'No Resource object has been provided to the constructor of the ResourceTreeWidget class!'
                );
            }
    
            $this->root_resources = SimpleORMapCollection::createFromArray(
                $this->root_resources
            );
            $this->root_resources->orderBy('sort_position DESC, name ASC, mkdate ASC');
    
            $this->template = 'sidebar/resource-tree-widget';