capwelton / libapp

programs/Ui/AppCardFrame.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\Ui;

use Capwelton\Widgets\Widgets\Abstracts\WidgetItem;

The type Capwelton\Widgets\Widgets\Abstracts\WidgetItem was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\Widgets\Widgets\Interfaces\WidgetDisplayableInterface;

The type Capwelton\Widgets\Widgets\Interfaces\WidgetDisplayableInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\Widgets\Widgets\Item\WidgetSection;

The type Capwelton\Widgets\Widgets\Item\WidgetSection was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\Widgets\Widgets\Layout\WidgetLayout;

The type Capwelton\Widgets\Widgets\Layout\WidgetLayout was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\LibApp\AppUiObject;
use Capwelton\LibApp\Func_App;
use Capwelton\LibApp\Set\AppRecord;
use Capwelton\LibOrm\Field\ORMField;

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

use Capwelton\LibOrm\Field\ORMTextField;

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

use Capwelton\LibOrm\Field\ORMUrlField;

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

use Capwelton\LibOrm\Field\ORMEmailField;

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

use Capwelton\LibOrm\Field\ORMFkField;

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

/**
 * A card frame is a frame with contact informations
 */
class AppCardFrame extends AppUiObject
{

    const IMAGE_WIDTH = 28;
    const IMAGE_HEIGHT = 28;


    const MAPS_URL = '//maps.google.com/?q=%s';

    const MAPS_ROUTE_URL = '//maps.google.com/maps?saddr=%s&daddr=%s';

    const STATIC_MAPS_URL = '//maps.google.com/maps/api/staticmap?';

    /**
     * @var WidgetSection[] $sections
     */
    protected $sections = array();


    protected $menu = null;

    public function __construct(Func_App $App, $id = null, WidgetLayout $layout = null)
    {
        parent::__construct($App);

        $W = bab_Widgets();

        $this->setInheritedItem($W->Frame($id, $layout));
    }


    /**
     * render a labeled string
     *
     * @param	string | WidgetItem	$label
     * @param	string | WidgetItem	$value
     *
     * @return WidgetItem
     */
    protected function labelStr($label, $value)
    {
        $W = bab_Widgets();

        if (!($label instanceOf WidgetItem)) {
            $label = $W->Label($label);
        }

        if (!($value instanceOf WidgetDisplayableInterface)) {
            $value = $W->Label($value);
        }


        return $W->VBoxItems(

The expression return $W->VBoxItems($label->colon(false)->addClass('crm-display-label'), $value->addClass('crm-display-value'))->setVerticalAlign('middle')->setVerticalSpacing(3, 'px') returns the type Widget_VBoxLayout which is incompatible with the documented return type Capwelton\Widgets\Widgets\Abstracts\WidgetItem.

            $label->colon(false)->addClass('crm-display-label'),
            $value->addClass('crm-display-value')
            )->setVerticalAlign('middle')->setVerticalSpacing(3, 'px');
    }

    /**
     * render a labeled string only if value set
     *
     * @param	string | WidgetItem	$label
     * @param	string | WidgetItem	$value
     *
     * @return WidgetItem | null
     */
    protected function labelStrSet($label, $value)
    {
        if (!isset($value) || '' === $value) {
            return null;
        }

        return $this->labelStr($label, $value);
    }


    /**
     * render a labeled string with a field value, if the value is not set, return null
     *
     *
     * @param string $label
     * @param AppRecord $record
     * @param ORMField $field
     */
    protected function labeledField($label, AppRecord $record, ORMField $field)
    {
        $W = bab_Widgets();

        $fieldName = $field->getName();
        $value = $record->$fieldName;

        if (!$field->isValueSet($value)) {
            return null;
        }

        $displayable = $field->output($value);

        switch(true) {
            case ($field instanceof ORMTextField):
                $displayable = $W->RichText($displayable)->setRenderingOptions(BAB_HTML_ALL ^ BAB_HTML_P);
                break;

            case ($field instanceof ORMUrlField):
                $displayable = $W->Link($displayable, $displayable);
                break;

            case ($field instanceof ORMEmailField):
                $displayable = $W->Link($displayable, 'mailto:'.$displayable);
                break;

            case ($field instanceof ORMFkField):
                $record = $record->$fieldName();
                if (!isset($record)) {
                    return null;
                }
                $displayable = $record->getRecordTitle();
                break;
        }

        return $this->labelStr($label, $displayable);
    }





    /**
     * 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()->setVerticalSpacing(1, 'em');
        }
        $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 WidgetDisplayableInterface $item
     * @return self
     */
    public function addAction(WidgetDisplayableInterface $item)
    {
        if (!isset($this->menu)) {
            $W = bab_Widgets();
            $this->menu = $W->Menu()
                ->setLayout($W->FlowLayout())
                ->addClass(\Func_Icons::ICON_LEFT_SYMBOLIC);

        }
        $this->menu->addItem($item);
        return $this;
    }
}