class.ilTermsOfServiceTableGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Table/classes/class.ilTable2GUI.php';

abstract class ilTermsOfServiceTableGUI extends ilTable2GUI
{
        protected $ctrl;

        protected $visibleOptionalColumns = array();

        protected $provider;

        protected $optionalColumns = array();

        protected $filter = array();

        protected $optional_filter = array();

        public function setProvider(ilTermsOfServiceTableDataProvider $provider)
        {
                $this->provider = $provider;
        }

        public function getProvider()
        {
                return $this->provider;
        }

        protected function isColumnVisible($column)
        {
                if(array_key_exists($column, $this->optionalColumns) && !isset($this->visibleOptionalColumns[$column]))
                {
                        return false;
                }

                return true;
        }

        protected function prepareData(array &$data)
        {
        }

        protected function prepareRow(array &$row)
        {
        }

        protected function formatCellValue($column, array $row)
        {
                return $row[$column];
        }

        final protected function fillRow(array $row)
        {
                $this->prepareRow($row);

                foreach($this->getStaticData() as $column)
                {
                        $value = $this->formatCellValue($column, $row);
                        $this->tpl->setVariable('VAL_' . strtoupper($column), $value);
                }

                foreach($this->optionalColumns as $index => $definition)
                {
                        if(!$this->isColumnVisible($index))
                        {
                                continue;
                        }

                        $this->tpl->setCurrentBlock('optional_column');
                        $value = $this->formatCellValue($index, $row);
                        if((string)$value === '')
                        {
                                $this->tpl->touchBlock('optional_column');
                        }
                        else
                        {
                                $this->tpl->setVariable('OPTIONAL_COLUMN_VAL', $value);
                        }

                        $this->tpl->parseCurrentBlock();
                }
        }

        abstract protected function getStaticData();

        public function populate()
        {
                if(!$this->getExternalSegmentation() && $this->getExternalSorting())
                {
                        $this->determineOffsetAndOrder(true);
                }
                else if($this->getExternalSegmentation() || $this->getExternalSorting())
                {
                        $this->determineOffsetAndOrder();
                }

                $params = array();
                if($this->getExternalSegmentation())
                {
                        $params['limit']  = $this->getLimit();
                        $params['offset'] = $this->getOffset();
                }
                if($this->getExternalSorting())
                {
                        $params['order_field']     = $this->getOrderField();
                        $params['order_direction'] = $this->getOrderDirection();
                }

                $this->determineSelectedFilters();
                $filter = $this->filter;
                
                foreach($this->optional_filter as $key => $value)
                {
                        if($this->isFilterSelected($key))
                        {
                                $filter[$key] = $value;
                        }
                }

                $data = $this->getProvider()->getList($params, $filter);

                if(!count($data['items']) && $this->getOffset() > 0 && $this->getExternalSegmentation())
                {
                        $this->resetOffset();
                        $params['limit']  = $this->getLimit();
                        $params['offset'] = $this->getOffset();
                        $data             = $this->getProvider()->getList($params, $filter);
                }

                $this->prepareData($data);

                $this->setData($data['items']);
                if($this->getExternalSegmentation())
                {
                        $this->setMaxCount($data['cnt']);
                }
        }
}