/Ip/Internal/Grid/Model/Config.php

<?php
/**
 * @package   ImpressPages
 */

namespace Ip\Internal\Grid\Model;


class Config
{
    /**
     * @var Config
     */
    protected $config = null;

    protected $configChecked = false;

    protected $multilingual = null;


    /**
     * @var Field[]
     */
    protected $fieldObjects = null;

    public function __construct($config)
    {
        $this->config = $config;

        if (empty($this->config['table'])) {
            throw new \Ip\Exception('\'table\' configuration value missing.');
        }

        if (empty($this->config['pageSize'])) {
            $this->config['pageSize'] = 20;
        }

        if (empty($this->config['pagerSize'])) {
            $this->config['pagerSize'] = 10;
        }

        if (!isset($this->config['fields']) || !is_array($this->config['fields'])) {
            $this->config['fields'] = $this->getTableFields($this->tableName(), $this->languageTableName());
        }

        $this->checkConfig($this->config);

    }




    public function pageVariableName()
    {
        if (!empty($this->config['pageVariableName'])) {
            return $this->config['pageVariableName'];
        }
        return 'page';
    }

    /**
     * Get sql part to be used in where clause
     * @return string
     */
    public function filter()
    {
        if (!empty($this->config['filter'])) {
            return $this->config['filter'];
        }
        return '1';
    }

    /**
     * Get field name responsible for connection of subgrid to the parent grid.
     * You can think of it as a foreign key in SQL
     * @return string
     */
    public function connectionField()
    {
        if (!empty($this->config['connectionField'])) {
            return $this->config['connectionField'];
        }
        return false;
    }

    public function deleteWarning()
    {
        if (!empty($this->config['deleteWarning'])) {
            return $this->config['deleteWarning'];
        }
        return __('Are you sure you want to delete?', 'Ip-admin', false);
    }

    public function actions()
    {
        if (!empty($this->config['actions'])) {
            return $this->config['actions'];
        }
        return array();
    }

    /**
     * @return string
     */
    public function actionsFilter()
    {
        if (!empty($this->config['actionsFilter'])) {
            return $this->config['actionsFilter'];
        }
        return false;
    }

    public function beforeDelete()
    {
        if (empty($this->config['beforeDelete'])) {
            return false;
        }
        return $this->config['beforeDelete'];
    }

    public function afterDelete()
    {
        if (empty($this->config['afterDelete'])) {
            return false;
        }
        return $this->config['afterDelete'];
    }

    public function beforeUpdate()
    {
        if (empty($this->config['beforeUpdate'])) {
            return false;
        }
        return $this->config['beforeUpdate'];
    }

    public function afterUpdate()
    {
        if (empty($this->config['afterUpdate'])) {
            return false;
        }
        return $this->config['afterUpdate'];
    }


    public function beforeCreate()
    {
        if (empty($this->config['beforeCreate'])) {
            return false;
        }
        return $this->config['beforeCreate'];
    }

    public function afterCreate()
    {
        if (empty($this->config['afterCreate'])) {
            return false;
        }
        return $this->config['afterCreate'];
    }


    public function beforeMove()
    {
        if (empty($this->config['beforeMove'])) {
            return false;
        }
        return $this->config['beforeMove'];
    }

    public function afterMove()
    {
        if (empty($this->config['afterMove'])) {
            return false;
        }
        return $this->config['afterMove'];
    }

    public function preventAction()
    {
        if (empty($this->config['preventAction'])) {
            return false;
        }
        return $this->config['preventAction'];
    }


    /**
     * @param $field
     * @throws \Ip\Exception
     * @return \Ip\Internal\Grid\Model\Field
     */
    public function fieldObject($field)
    {
        if (empty($field['type'])) {
            $field['type'] = 'Text';
        }
        $class = '\\Ip\\Internal\\Grid\\Model\\Field\\' . $field['type'];
        if (!class_exists($class)) {
            if (class_exists($field['type'])) {
                $class = $field['type']; //type is full class name
            } else {
                throw new \Ip\Exception('Class doesn\'t exist "' . esc($field['type']) . '"');
            }

        }
        $fieldObject = new $class($field, $this->config);
        return $fieldObject;
    }

    public function fields()
    {
        if (!$this->configChecked) {
            $this->checkConfig($this->config);
        }
        return $this->config['fields'];
    }

    public function allowCreate()
    {
        return !array_key_exists('allowCreate', $this->config) || $this->config['allowCreate'];
    }

    public function allowSearch()
    {
        return !array_key_exists('allowSearch', $this->config) || $this->config['allowSearch'];
    }

    public function allowUpdate()
    {
        return !array_key_exists('allowUpdate', $this->config) || $this->config['allowUpdate'];
    }

    public function allowSort()
    {
        if (!empty($this->config['sortField'])) {
            if (isset($this->config['allowSort'])) {
                return $this->config['allowSort'];
            } else {
                return true;
            }
        } else {
            return false;
        }
    }

    public function allowDelete()
    {
        return !array_key_exists('allowDelete', $this->config) || $this->config['allowDelete'];
    }

    public function pageSize($statusVariables)
    {
        if (!empty($statusVariables['pageSize'])) {
            $pageSize = (int) $statusVariables['pageSize'];
            if ($pageSize < 1) {
                $pageSize = 1;
            }
            return $pageSize;
        }

        return $this->config['pageSize'];
    }

    public function pagerSize()
    {
        return $this->config['pagerSize'];
    }

    public function idField()
    {
        if (!empty($this->config['idField'])) {
            return $this->config['idField'];
        } else {
            return 'id';
        }
    }

    public function tableName()
    {
        return ipTable(str_replace("`", "", $this->config['table']));
    }

    public function languageTableName()
    {
        $tableName = $this->rawTableName() . '_language';
        if (!empty($this->config['languageTable'])) {
            $tableName = $this->config['languageTable'];
        }
        return ipTable(str_replace("`", "", $tableName));
    }

    public function languageForeignKeyField()
    {
        $field = 'itemId';
        if (!empty($this->config['languageForeignKeyField'])) {
            $field = $this->config['languageForeignKeyField'];
        }
        return $field;
    }

    public function languageCodeField()
    {
        $field = 'language';
        if (!empty($this->config['languageCodeField'])) {
            $field = $this->config['languageCodeField'];
        }
        return $field;
    }

    public function selectFields()
    {
        if (empty($this->config['selectFields'])) {
            return '*';
        }
        return $this->config['selectFields'];
    }


    public function rawTableName()
    {
        return $this->config['table'];
    }

    public function rawLanguageTableName()
    {
        if (!empty($this->config['languageTable'])) {
            return $this->config['languageTable'];
        } else {
            return $this->rawTableName() . '_language';
        }
    }

    public function sortField()
    {
        if (empty($this->config['sortField'])) {
            return false;
        }
        return trim($this->config['sortField'], '`');
    }

    public function sortDirection()
    {
        if (empty($this->config['sortDirection'])) {
            return 'asc';
        }
        if ($this->config['sortDirection'] == 'desc') {
            return 'desc';
        } else {
            return 'asc';
        }

    }

    public function orderBy($statusVariables)
    {
        if (!empty($this->config['orderBy'])) {
            return $this->config['orderBy'];
        } else {
            $orderFieldName = $this->orderField($statusVariables);

            $orderField = $this->getField($orderFieldName);
            if (!empty($orderField['multilingual'])) {
                $table = $this->languageTableName();
            } else {
                $table = $this->tableName();
            }
            return $table . ".`" . $orderFieldName . "` " . $this->orderDirection($statusVariables);
        }
    }

    public function getField($fieldName)
    {
        $fields = $this->fields();
        foreach($fields as $field) {
            if (!empty($field['field']) && $field['field'] == $fieldName) {
                return $field;
            }
        }
    }

    public function orderField($statusVariables)
    {
        $manualOrder = false;

        //check if order field is set manually and if it is allowed to order by that field
        if (!empty($statusVariables['order'])) {
            $orderField = $statusVariables['order'];
            foreach($this->config['fields'] as $field) {
                if (!empty($field['field']) && $field['field'] == $orderField && (!isset($field['allowOrder']) || $field['allowOrder'])) {
                    $manualOrder = true;
                    break;
                }
            }
        }

        if ($manualOrder) {
            return $statusVariables['order'];
        } else {
            if ($this->sortField()) {
                return $this->sortField();
            } else {
                return $this->idField();
            }
        }
    }

    public function orderDirection($statusVariables)
    {
        if (!empty($statusVariables['direction']) && $statusVariables['direction'] == 'desc') {
            $direction = 'desc';
        } else {
            $direction = $this->sortDirection();

        }
        return $direction;
    }

    public function createPosition()
    {
        if (!empty($this->config['createPosition']) && $this->config['createPosition'] == 'bottom') {
            return 'bottom';
        }
        return 'top';

    }

    public function getTitle()
    {
        if (empty($this->config['title'])) {
            return $this->config['table'];
        }
        return $this->config['title'];
    }


    protected function getTableFields($tableName, $languageTable)
    {
        $result = array();

        $sql = "SHOW COLUMNS FROM " . $tableName . " " . $this->joinQuery() . " ";

        $fields = ipDb()->fetchColumn($sql);

        foreach ($fields as $fieldName) {
            $result[] = array(
                'label' => $fieldName,
                'field' => $fieldName
            );
        }

        if ($this->isMultilingual()) {
            $sql = "SHOW COLUMNS FROM " . $languageTable . " ";

            $fields = ipDb()->fetchColumn($sql);

            foreach ($fields as $fieldName) {
                if (in_array($fieldName, array($this->languageCodeField(), $this->languageForeignKeyField()))) {
                    continue;
                }
                $result[] = array(
                    'label' => $fieldName,
                    'field' => $fieldName,
                    'multilingual' => 1
                );
            }
        }

        return $result;
    }

    public function joinQuery()
    {
        if (!empty($this->config['joinQuery'])) {
            return $this->config['joinQuery'];
        }
        return false;
    }

    public function layout()
    {
        if (empty($this->config['layout'])) {
            return 'Ip/Internal/Grid/view/layout.php';
        }
        return $this->config['layout'];
    }

    public function updateFilter()
    {
        if (empty($this->config['updateFilter'])) {
            return false;
        }
        return $this->config['updateFilter'];
    }


    public function updateLanguageFilter()
    {
        if (empty($this->config['updateLanguageFilter'])) {
            return false;
        }
        return $this->config['updateLanguageFilter'];
    }

    public function updateFormFilter()
    {
        if (empty($this->config['updateFormFilter'])) {
            return false;
        }
        return $this->config['updateFormFilter'];
    }

    public function createFilter()
    {
        if (empty($this->config['createFilter'])) {
            return false;
        }
        return $this->config['createFilter'];
    }


    public function createLanguageFilter()
    {
        if (empty($this->config['createLanguageFilter'])) {
            return false;
        }
        return $this->config['createLanguageFilter'];
    }

    public function createFormFilter()
    {
        if (empty($this->config['createFormFilter'])) {
            return false;
        }
        return $this->config['createFormFilter'];
    }

    /**
     * @param int $depth
     * @param array $gridBreadcrumb //to detect loop
     * @throws \Ip\Exception
     */
    protected function checkConfig(&$config, $depth = 1, $gridBreadcrumb = array())
    {
        $fields = &$config['fields'];

        if (!is_array($fields)) {
            throw new \Ip\Exception('GRID configuration is missing \'fields\' attribute for table ' . $config['table']);
        }

        foreach($fields as &$field) {
            if (empty($field['type'])) {
                $field['type'] = 'Text';
            }
        }

        //if at least one of the fields is of type 'Tab', then make sure the first field is also 'Tab'. Otherwise tabs don't work.
        if ($fields[0]['type'] != 'Tab') {
            $tabExist = false;
            foreach ($fields as $key => $fieldData) {
                if (!empty($fieldData['type']) && $fieldData['type'] == 'Tab') {
                    $tabExist = true;
                    break;
                }
            }
            if ($tabExist) {
                array_unshift($fields, array('label' => __('General', 'Ip-admin', false), 'type' => 'Tab'));
            }

        }

        //automatically add gridId to grid fields
        $gridIndex = 0;
        foreach ($fields as $key => &$fieldData) {
            if (!empty($fieldData['type']) && $fieldData['type'] == 'Grid') {
                $gridIndex++;
                if (empty($fieldData['gridId'])) {
                    $fieldData['gridId'] = 'grid' . $gridIndex;
                }
                $subConfig = $fieldData['config'];
                $loop = false;
                foreach($gridBreadcrumb as $crumb) {
                    if ($subConfig == $crumb) {
                        $loop = true;
                    }
                }
                if (!$loop) {
                    $newBreadcrumb = array_merge($gridBreadcrumb, array($config));
                    $this->checkConfig($fieldData['config'], $depth + 1, $newBreadcrumb);
                }

            }
        }

        if($depth == 1) {
            $this->configChecked = true;
        }
    }



    /**
     * Return nested grid config object
     * @param $statusVariables
     * @return Config
     * @throws \Ip\Exception
     */
    public function subgridConfig($statusVariables, $depthLimit = null)
    {
        $depth = Status::depth($statusVariables);
        if ($depthLimit !== null && $depthLimit < $depth) {
            $depth = $depthLimit;
        }
        $config = $this->config;
        for ($i = 1; $i < $depth; $i++) {
            $found = false;
            foreach ($config['fields'] as $field) {
                if (!empty($field['type']) && $field['type'] == 'Grid' && $field['gridId'] == $statusVariables['gridId' . $i]) {
                    $config = $field['config'];
                    $found = true;
                    break;
                }
            }
            if (!$found) {
                throw new \Ip\Exception('Unknown subgrid');
            }
        }
        return new self($config);
    }


    public function getBreadcrumbField()
    {
        if (empty($this->config['breadcrumbField'])) {
            return '';
        }
        return $this->config['breadcrumbField'];
    }

    public function isMultilingual()
    {
        if ($this->multilingual !== null) {
            return $this->multilingual;
        }

        if (!empty($this->config['languageTable'])) {
            $this->multilingual = true;
            return true;
        }

        if (empty($this->config['fields'])) { //without this, isMultilingual check in getFields function will result in error.
            return false;
        }

        $fields = $this->fields();
        if (!$fields) {
            $this->multilingual = false;
            return false;
        }

        $multilingual = false;
        foreach($fields as $field) {
            if (!empty($field['multilingual'])) {
                $multilingual = true;
                break;
            }
        }

        $this->multilingual = $multilingual;
        return $multilingual;
    }

}