AppRecordView::__spacer() - Code Metrics - capwelton/libapp - Measure and Improve Code Quality continuously with Scrutinizer

AppRecordView::__spacer() A
last analyzed 2022-10-21 15:18 UTC

↳ Parent: AppRecordView
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
nc	1
nop	0
<?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\Ui;

use Capwelton\Widgets\Widgets\Interfaces\WidgetDisplayableInterface;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\Widgets\Widgets\Layout\WidgetFlexLayout;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\Widgets\Widgets\Layout\WidgetLayout;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\Widgets\Widgets\Item\WidgetSection;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\Widgets\Widgets\Item\WidgetLink;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\LibApp\AppUiObject;
use Capwelton\LibApp\Ctrl\AppCtrlRecord;
use Capwelton\LibApp\Func_App;
use Capwelton\LibApp\Set\AppRecord;
use Capwelton\LibApp\Set\AppRecordSet;
use Capwelton\LibApp\Set\AppCustomSection;
use Capwelton\LibOrm\Exceptions\ORMException;
filter:
    dependency_paths: ["lib/*"]
use Capwelton\LibOrm\Field\ORMCurrencyField;
filter:
    dependency_paths: ["lib/*"]

class AppRecordView extends AppUiObject
{
    /**
     * @var AppRecord
     */
    protected $record = null;
    
    /**
     * @var AppRecordSet
     */
    protected $recordSet = null;
    
    /**
     * @var WidgetSection[]
     */
    protected $sections = array();
    
    protected $view = '';
    
    /**
     * @var AppCtrlRecord
     */
    protected $recordController = null;
    
    protected $recordIsReadable = false;
    protected $recordIsUpdateable = false;
    protected $recordIsDeletable = false;
    
    /**
     * @param Func_App $App
     * @param string $id
     * @param WidgetLayout $layout
     */
    public function __construct(Func_App $App, $id = null, WidgetLayout $layout = null)
    {
        parent::__construct($App);
        
        if (!isset($layout)) {
            $W = bab_Widgets();
            $layout = $W->Items();
        }
        
        $this->setInheritedItem($layout);
    }
    
    
    /**
     * @param AppRecord $record
     * @return self
     */
    public function setRecord(AppRecord $record)
    {
        $this->record = $record;
        $this->recordSet = $record->getParentSet();
        
        $this->recordIsReadable = $record->isReadable();
        $this->recordIsUpdateable = $record->isUpdatable();
        $this->recordIsDeletable = $record->isDeletable();
        
        return $this;
    }
    
    
    /**
     * @param string $view
     * @return self
     */
    public function setView($view)
    {
        $this->view = $view;
        return $this;
    }
    
    
    /**
     * @return string
     */
    public function getView()
    {
        return $this->view;
    }
    
    
    
    /**
     * Creates section in the editor.
     * If a section with the same header text (title) was already
     * created it is replaced by an empty section.
     *
     * @param string $headerText
     * @return WidgetSection
     */
    protected function addSection($id, $headerText, $layout = null)
    {
        $W = bab_Widgets();
        if (!isset($layout)) {
            $layout = $W->VBoxLayout();
        }
        $this->sections[$id] = $W->Section(
            $headerText,
            $layout
            )->setFoldable(true);
            
            return $this->sections[$id];
    }
    
    /**
     * Creates section in the editor.
     * If a section with the same header text (title) was already
     * created it is replaced by an empty section.
     *
     * @param string $headerText
     * @return WidgetSection
     */
    protected function createSection($headerText, $layout = null)
    {
        return $this->addSection($headerText, $headerText, $layout);
    }
    
    
    /**
     * Retrieves a section in the editor.
     *
     * @param string $headerText
     * @return WidgetSection
     */
    protected function getSection($id)
    {
        if (!isset($this->sections[$id])) {
            return null;
        }
        return $this->sections[$id];
    }
    
    
    /**
     * Returns the list of sections created via createSection().
     *
     * @return WidgetSection[]
     */
    public function getSections()
    {
        return $this->sections;
    }
    
    
    
    
    /**
     * @param string $textLabel
     * @param mixed $value
     * @param AppCustomSection $section
     * @return WidgetLayout
     */
    public function labelledWidget($textLabel, $value, AppCustomSection $section = null)
    {
        $W = bab_Widgets();
        
        if ($value instanceof WidgetDisplayableInterface) {
            $widget = $value;
        } else {
            $widget = $W->Label($value);
        }
        
        if (isset($section)) {
            if ($textLabel === '__') {
                $fieldLayout = AppCustomSection::FIELDS_LAYOUT_NO_LABEL;
            } else {
                $fieldLayout = $section->fieldsLayout;
            }
            switch ($fieldLayout) {
                case AppCustomSection::FIELDS_LAYOUT_HORIZONTAL_LABEL:
                    return $W->FlowItems(

                    $W->Label($textLabel)->addClass('crm-horizontal-display-label', 'widget-strong')
                    ->setSizePolicy('widget-25pc'),
                    $widget
                    )->addClass('widget-labelled-widget')
                    ->setHorizontalSpacing(1, 'ex')
                    ->setVerticalAlign('top');
                    
                case AppCustomSection::FIELDS_LAYOUT_WIDE_HORIZONTAL_LABEL:
                    return $W->FlowItems(

                    $W->Label($textLabel)->addClass('crm-horizontal-display-label', 'widget-strong')
                    ->setSizePolicy('widget-50pc'),
                    $widget
                    )->addClass('widget-labelled-widget')
                    ->setHorizontalSpacing(1, 'ex')
                    ->setVerticalAlign('top');
                    
                case AppCustomSection::FIELDS_LAYOUT_NO_LABEL:
                    return $widget;

                    
                case AppCustomSection::FIELDS_LAYOUT_VERTICAL_LABEL:
                default:
                    return $W->LabelledWidget($textLabel, $widget);

            }
        }
    }
    
    
    public function labelledWidgetOptional($textLabel, $displayedValue, $value = null, AppCustomSection $section = null)
    {
        if (!isset($value)) {
            $value = $displayedValue;
        }
        if (!isset($value) || is_numeric($value) && $value == 0 || is_string($value) && trim($value) == '' || ($value instanceof WidgetLayout && count($value->getItems()) <= 0)) {
            return null;
        }
        return $this->labelledWidget($textLabel, $displayedValue, $section);
    }
    
    
    
    protected function fieldOutput($field, $record, $fieldName)
    {
        if ($field instanceof ORMCurrencyField) {
            $App = $this->App();
            $value = $App->shortFormatWithUnit($this->record->$fieldName, $App->translate('_euro_'));
        } else {
            $value = $field->output($this->record->$fieldName);
        }
        return $value;
    }
    
    protected function addSections($view = '')
    {
        $App = $this->App();
        $W = bab_Widgets();
        
        $objectName = $this->getViewObjectName();
        
        $customContainerSet = $App->CustomContainerSet();
        $customContainers = $customContainerSet->select(
            $customContainerSet->object->is($objectName)->_AND_($customContainerSet->view->is($view))
            );
        $customContainers->orderAsc($customContainerSet->rank);
        
        
        $customSectionSet = $App->CustomSectionSet();
        
        foreach ($customContainers as $customContainer) {
            
            if (isset($this->record) && !$customContainer->isVisibleForRecord($this->record)) {
                continue;
            }
            
            $container = $W->Items()
            ->addClass($customContainer->classname)
            ->setSizePolicy("app-container {$customContainer->sizePolicy}");
            
            $this->addItem($container);
            
            $customSections = $customSectionSet->select(
                $customSectionSet->container->is($customContainer->id)
                );
            $customSections->orderAsc($customSectionSet->rank);
            
            $currentColumn = 0;
            $nbCol = 0;
            $row = $W->Items()->setSizePolicy('row');
            $row->addClass('row');
            
            foreach ($customSections as $customSection) {
                
                if (isset($this->record) && !$customSection->isVisibleForRecord($this->record)) {
                    continue;
                }
                
                list(, , $nbCol) = explode('-', $customSection->sizePolicy);
                
                if ($currentColumn + $nbCol > 12) {
                    $container->addItem($row);
                    $row = $W->Items()->setSizePolicy('row');
                    $row->addClass('row');
                    $currentColumn = 0;
                }
                $currentColumn += $nbCol;
                
                if (strpos($customSection->classname, 'horizontal') !== false) {
                    $box = $W->FlowItems()
                    ->setVerticalAlign('top')
                    ->setSpacing(1, 'em');
                } else {
                    $box = null;
                }
                
                $section = $this->getSection($customSection->id);
                if (!isset($section)) {
                    $section = $this->addSection($customSection->id, $customSection->name, $box);
                    $section->addClass($customSection->classname);
                    $section->setSizePolicy($customSection->sizePolicy);
                    
                    $menu = $section->addContextMenu('inline');
                    $menu->addClass(\Func_Icons::ICON_LEFT_16);
                    
                    if ($customSection->editable && $this->recordIsUpdateable) {
                        $menu->addItem(
                            $W->Link(
                                '',
                                $this->record->getController()->editSection($this->record->id, $customSection->id)
                                $this->record->getController()->/** @scrutinizer ignore-call */ editSection($this->record->id, $customSection->id)
                                )->addClass('widget-actionbutton', 'section-button', 'icon', \Func_Icons::ACTIONS_DOCUMENT_EDIT)
                            ->setOpenMode(WidgetLink::OPEN_DIALOG)->setDialogClass('customSectionEditorDialog '.$customSection->classname)
                            ->setOpenMode(WidgetLink::OPEN_DIALOG)->/** @scrutinizer ignore-call */ setDialogClass('customSectionEditorDialog '.$customSection->classname)
                            );
                    }
                    
                    $section->setFoldable($customSection->foldable, $customSection->folded);
                    $row->addItem($section);
                }
                
                
                
                $displayFields = $customSection->getFields();
                
                foreach ($displayFields as $displayFieldId => $displayField) {
                    $isGroupField = strpos($displayFieldId, '_fieldsGroup') !== false;
                    $item = null;
                    $displayFieldName = $displayField['fieldname'];
                    $parameters = $displayField['parameters'];
                    $classname = isset($parameters['classname']) ? $parameters['classname'] : '';
                    $label = isset($parameters['label']) && !empty($parameters['label']) ? $parameters['label'] : null;
                    $sizePolicy = 'customsection-field-box ';
                    $sizePolicy .= isset($parameters['sizePolicy']) ? $parameters['sizePolicy'] : '';
                    $sizePolicy .= isset($parameters['transparentBackground']) && $parameters['transparentBackground'] ? 'customsection-field-box-transparentBackground' : '';
                    
                    $displayFieldMethod = '_' . $displayFieldName;
                    if (!$isGroupField && method_exists($this, $displayFieldMethod)) {
                        $item = $this->$displayFieldMethod($customSection, $label);
                    }
                    else {
                        if($isGroupField){
                            list(, $groupId) = explode('_fieldsGroup', $displayFieldId);
                            if (method_exists($this, '__fieldsGroup')) {
                                $item = $this->__fieldsGroup($customSection, $groupId, $label);
                            }
                            $sizePolicy .= ' customsection-fieldsgroup-box';
                        }
                        else{
                            try {
                                $field = $this->recordSet->getField($displayFieldName);
                                $value = $this->fieldOutput($field, $this->record, $displayFieldName);

                                if (!isset($label)) {
                                    $label = $App->translate($field->getDescription());
                                }
                                
                                $outputWidget = $field->outputWidget($this->record->$displayFieldName);
                                
                                $item = $this->labelledWidget(
                                    $label,
                                    $outputWidget,
                                    $customSection
                                    );
                            } catch (ORMException $e) {
                                $item = null;
                            }
                        }
                    }
                    if (isset($item) && $item instanceof WidgetDisplayableInterface) {
                        $item->setSizePolicy($sizePolicy);
                        $item->addClass($classname);
                        $section->addItem($item);
                    }
                }
            }
            
            if ($currentColumn + $nbCol> 0) {
                $container->addItem($row);
            }
        }
    }
    
    
    protected function __spacer()
    {
        $W = bab_Widgets();
        return $W->Label('')->addClass('spacer');
    }
    
    protected function getObjectName()
    {
        return $this->record->getClassName();
    }
    
    protected function getViewObjectName()
    {
        return $this->getObjectName();
    }
    
    protected function __fieldsGroup(AppCustomSection $customSection, $groupId = 0, $label = null)
    {
        $W = bab_Widgets();
        $App = $this->App();
        
        $box = $W->FlexItems()->setGrowable(true)->setWrap(WidgetFlexLayout::FLEX_WRAP_WRAP);
        $box = $W->/** @scrutinizer ignore-call */ FlexItems()->setGrowable(true)->setWrap(WidgetFlexLayout::FLEX_WRAP_WRAP);
        $groupField = $customSection->getField('_fieldsGroup'.$groupId);
        $originalFieldsLayout = $customSection->fieldsLayout;
        $customSection->fieldsLayout = AppCustomSection::FIELDS_LAYOUT_VERTICAL_LABEL;
        if(isset($groupField['fields'])){
            foreach ($groupField['fields'] as $field){
                $item = null;
                $parameters = $field['parameters'];
                $labelField = isset($parameters['label']) ? $parameters['label'] : '';
                $itemClass = isset($parameters['classname']) ? $parameters['classname'] : '';
                $itemClass .= isset($parameters['sizePolicy']) ? $parameters['sizePolicy'] : '';
                $itemClass .= isset($parameters['transparentBackground']) && $parameters['transparentBackground'] ? 'customsection-field-box-transparentBackground' : '';
                
                $displayFieldName = $field['fieldname'];
                
                $displayFieldMethod = '_' . $displayFieldName;
                if (method_exists($this, $displayFieldMethod)) {
                    $item = $this->$displayFieldMethod($customSection, $labelField);
                }
                else{
                    try {
                        $field = $this->recordSet->getField($displayFieldName);
                        $value = $this->fieldOutput($field, $this->record, $displayFieldName);

                        
                        $outputWidget = $field->outputWidget($this->record->$displayFieldName);
                        
                        $item = $this->labelledWidget(
                            !empty($labelField) ? $labelField : $App->translate($field->getDescription()),
                            $outputWidget,
                            $customSection
                            );
                    } catch (ORMException $e) {
                        $item = null;
                    }
                }
                if(isset($item)){
                    $item->addClass('app-customsection-groupedfield');
                    $item->addClass($itemClass);
                }
                
                $box->addItem($item);
            }
        }
        $customSection->fieldsLayout = $originalFieldsLayout;
        
        return $box;
    }
}
capwelton / libapp

AppRecordView::__spacer() A last analyzed 2022-10-21 15:18 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AppRecordView::__spacer() A
last analyzed 2022-10-21 15:18 UTC
