capwelton / libapp

programs/Set/AppCustomSection.php

<?php

// -------------------------------------------------------------------------
// OVIDENTIA http://www.ovidentia.org
// Ovidentia is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2, or (at your option)
// any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.
// -------------------------------------------------------------------------
/**
 * @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)
 * @copyright Copyright (c) 2022 by SI4YOU ({@link https://www.siforyou.com})
 */
namespace Capwelton\LibApp\Set;

use bab_charset;
use Capwelton\LibOrm\MySql\ORMMySqlIterator;

The type Capwelton\LibOrm\MySql\ORMMySqlIterator was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_StringField;

The function Capwelton\LibOrm\ORM_StringField was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * @property string $name
 * @property string $sectionname
 * @property string $description
 * @property string $object
 * @property string $view
 * @property string $fields
 * @property string $classname
 * @property string $sizePolicy
 * @property string $fieldsLayout
 * @property bool $foldable
 * @property bool $folded
 * @property int $rank
 * @property string $visibilityCriteria
 *
 * @property AppCustomContainer $container
 * @method AppCustomContainer container()
 * @method Func_App App()
 */
class AppCustomSection extends AppTraceableRecord
{
    
    const FIELDS_LAYOUT_VERTICAL_LABEL = 'verticalLabel';
    
    const FIELDS_LAYOUT_HORIZONTAL_LABEL = 'horizontalLabel';
    
    const FIELDS_LAYOUT_WIDE_HORIZONTAL_LABEL = 'wideHorizontalLabel';
    
    const FIELDS_LAYOUT_VERY_WIDE_HORIZONTAL_LABEL = 'veryWideHorizontalLabel';
    
    const FIELDS_LAYOUT_NO_LABEL = 'noLabel';
    
    /**
     * @return string[]
     */
    public static function getFieldsLayouts()
    {
        $App = app_App();
        static $fieldsLayouts = null;
        
        if(! isset($fieldsLayouts)){
            $fieldsLayouts = array(
                self::FIELDS_LAYOUT_VERTICAL_LABEL => $App->translate('Vertical label'),
                self::FIELDS_LAYOUT_HORIZONTAL_LABEL => $App->translate('Horizontal label'),
                self::FIELDS_LAYOUT_WIDE_HORIZONTAL_LABEL => $App->translate('Horizontal label (wide)'),
                self::FIELDS_LAYOUT_VERY_WIDE_HORIZONTAL_LABEL => $App->translate('Horizontal label (very wide)'),
                self::FIELDS_LAYOUT_NO_LABEL => $App->translate('No label')
            );
        }
        return $fieldsLayouts;
    }
    
    /**
     * @return string[]
     */
    public function getRawFields()
    {
        if(empty($this->fields)){
            return array();
        }
        return explode(',', $this->fields);
    }
    
    /**
     * Return an array containing the fields in the section and their associated parameters.
     * [
     * [
     * 'fieldname' => the_field_name,
     * 'parameters => [
     * 'type' => the_field_type,
     * 'label' => the_field_label,
     * 'classname' => the field_classname,
     * ...
     * ]
     * ],
     * ...
     * ]
     *
     * @return string[][]
     */
    public function getFields()
    {
        if(empty($this->fields)){
            return array();
        }
        $fields = json_decode($this->fields, true);
        
        if(json_last_error() === JSON_ERROR_NONE){
            if(bab_charset::getIso() != bab_charset::UTF_8){
                $fields = app_utf8Decode($fields);
            }
            return $fields;

The expression return $fields also could return the type string which is incompatible with the documented return type array<mixed,string[]>.

        }
        
        $fields = array();
        $rawFields = $this->getRawFields();
        foreach ($rawFields as $rawField){
            if(empty($rawField)){
                continue;
            }
            $params = array();
            
            if(strpos($rawField, ':') === false){
                $fieldName = $rawField;
            }
            else{
                list ($fieldName, $parameters) = explode(':', $rawField);
                $parameters = explode(';', $parameters);
                foreach ($parameters as $parameter){
                    list ($key, $value) = explode('=', $parameter);
                    $params[$key] = $value;
                }
            }
            
            $fields[$fieldName] = array(
                'block' => '',
                'fieldname' => $fieldName,
                'parameters' => $params
            );
        }
        return $fields;
    }
    
    /**
     * Return an array containing the description of the specified field in the section and its associated parameters or
     * null if the field is not present in the section.
     * [
     * 'fieldname' => the_field_name,
     * 'parameters => [
     * 'type' => the_field_type,
     * 'label' => the_field_label,
     * 'classname' => the field_classname,
     * ...
     * ]
     * ],
     *
     * @param string $searchedFieldName
     * @return NULL|array[]
     */
    public function getField($searchedFieldName)
    {
        if(empty($this->fields)){
            return null;
        }
        
        $fields = $this->getFields();
        return isset($fields[$searchedFieldName]) ? $fields[$searchedFieldName] : null;

The expression return IssetNode ? $fields[$searchedFieldName] : null also could return the type string[] which is incompatible with the documented return type array<mixed,array>|null.

    }
    
    /**
     * Appends the field to the list of contained fields.
     *
     * @param string $fieldName
     * @param array $parameters
     */
    public function addField($fieldName, $parameters = null)
    {
        $fields = $this->getFields();
        if(! isset($parameters)){
            $fields[$fieldName] = array(
                'block' => ''
            );
            $parameters = array();
        }
        $fields[$fieldName]['fieldname'] = $fieldName;
        $fields[$fieldName]['parameters'] = $parameters;
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    /**
     * @param string $removedFieldName
     */
    public function removeField($removedFieldName)
    {
        $fields = $this->getFields();
        unset($fields[$removedFieldName]);
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    /**
     * Update the field, or create it if it does not exist
     *
     * @param string $updatedFieldName
     * @param array $parameters
     * @return self
     */
    public function updateField($updatedFieldName, $parameters = null)
    {
        $isFieldsGroup = false;
        $fields = $this->getFields();
        if(strpos($updatedFieldName, '_fieldsGroup') !== false){
            $isFieldsGroup = true;
            list (, $groupPos) = explode('_fieldsGroup', $updatedFieldName);
            if(! isset($groupPos) || empty($groupPos)){
                $groupPos = 0;
            }
        }
        if(! isset($fields[$updatedFieldName])){
            if($isFieldsGroup){
                while (isset($fields[$updatedFieldName . $groupPos])){

The variable $groupPos does not seem to be defined for all execution paths leading up to this point.

                    $groupPos ++;
                }
                $updatedFieldName .= $groupPos;
            }
            $this->addField($updatedFieldName, $parameters);
            return $this;
        }
        if(! isset($parameters)){
            $fields[$updatedFieldName] = array(
                'block' => ''
            );
            $parameters = array();
        }
        $fields[$updatedFieldName]['fieldname'] = $updatedFieldName;
        $fields[$updatedFieldName]['parameters'] = $parameters;
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    public function addFieldToGroup($fieldGroupName, $fieldName, $parameters = null)
    {
        $fields = $this->getFields();
        if(! isset($fields[$fieldGroupName])){
            return $this;
        }
        $groupFields = isset($fields[$fieldGroupName]['fields']) ? $fields[$fieldGroupName]['fields'] : array();
        if(! isset($parameters)){
            $groupFields[$fieldName] = array(
                'block' => ''
            );
            $parameters = array();
        }
        $groupFields[$fieldName]['fieldname'] = $fieldName;
        $groupFields[$fieldName]['parameters'] = $parameters;
        $fields[$fieldGroupName]['fields'] = $groupFields;
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    /**
     * @param string $removedFieldName
     */
    public function removeFieldFromGroup($fieldGroupName, $removedFieldName)
    {
        $fields = $this->getFields();
        unset($fields[$fieldGroupName]['fields'][$removedFieldName]);
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    /**
     * Update the field, or create it if it does not exist
     *
     * @param string $updatedFieldName
     * @param array $parameters
     * @return self
     */
    public function updateFieldGroup($fieldGroupName, $updatedFieldName, $parameters = null)
    {
        $fields = $this->getFields();
        if(! isset($fields[$fieldGroupName])){
            return $this;
        }
        $groupFields = isset($fields[$fieldGroupName]['fields']) ? $fields[$fieldGroupName]['fields'] : array();
        if(! isset($groupFields[$updatedFieldName])){
            $this->addFieldToGroup($fieldGroupName, $updatedFieldName, $parameters);
            return $this;
        }
        if(! isset($parameters)){
            $groupFields[$updatedFieldName] = array(
                'block' => ''
            );
            $parameters = array();
        }
        $groupFields[$updatedFieldName]["parameters"]["label"] = ORM_StringField("")->input($groupFields[$updatedFieldName]["parameters"]["label"]);
        $groupFields[$updatedFieldName]['fieldname'] = $updatedFieldName;
        $groupFields[$updatedFieldName]['parameters'] = $parameters;
        $fields[$fieldGroupName]['fields'] = $groupFields;
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $fields = app_utf8Encode($fields);
        }
        $this->fields = json_encode($fields);
        return $this;
    }
    
    /**
     * @param AppRecord $record
     *
     * @return bool
     */
    public function isVisibleForRecord(AppRecord $record)
    {
        if(empty($this->visibilityCriteria)){
            return true;
        }
        
        $App = \bab_functionality::get('App');
        $recordSet = $record->getParentSet();
        $arrCriteria = json_decode($this->visibilityCriteria, true);
        if(bab_charset::getIso() != bab_charset::UTF_8){
            $arrCriteria = app_utf8Decode($arrCriteria);
        }
        foreach ($arrCriteria as $fieldName => $condition){
            if(strpos($fieldName, '/') !== false){
                list ($oneField, $foreignField) = explode('/', $fieldName);
                $field = $recordSet->$oneField()->$foreignField;
            }
            else{
                $field = $recordSet->$fieldName;
            }
            foreach ($condition as $op => $value){
                if(! is_array($value)){
                    $criteria = $field->$op($value);
                }
                else{
                    foreach ($value as $foreignClassName => $foreignValues){
                        $foreignClassName = str_replace($App->classPrefix, '', $foreignClassName) . 'Set';
                        $foreignSet = $App->$foreignClassName();
                        $foreignField = '';
                        $foreignCondition = '';
                        foreach ($foreignValues as $foreignFieldName => $foreignConditions){
                            if($foreignFieldName === '_foreignField'){
                                $foreignField = $foreignConditions;
                            }
                            else{
                                foreach ($foreignConditions as $key => $val){
                                    $foreignCondition = $foreignSet->$foreignFieldName->$key($val);
                                }
                            }
                        }
                    }
                    if(method_exists($foreignSet, 'getDefaultCriteria')){

The variable $foreignSet does not seem to be defined for all execution paths leading up to this point.

                        $foreignCondition = $foreignCondition->_AND_($foreignSet->getDefaultCriteria());

The variable $foreignCondition does not seem to be defined for all execution paths leading up to this point.

                    }
                    $criteria = $field->in($foreignCondition, $foreignField);

The variable $foreignField does not seem to be defined for all execution paths leading up to this point.

                }
            }
        }
        
        $criteria = $criteria->_AND_($recordSet->id->is($record->id));

The variable $criteria does not seem to be defined for all execution paths leading up to this point.

        
        /**
         * @var ORMMySqlIterator
         */
        $records = $recordSet->select($criteria);
        
        return ($records->count() != 0);
    }
}