capwelton / libapp

programs/AppUiObject.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;

use Capwelton\Widgets\Widgets\Abstracts\WidgetCanvas;

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

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\LibApp\Func_App;

/**
 * The AppUiObject class is used to simulate multiple inheritance from
 * both a AppObject and a WidgetItem
 * Typically to simulate inheritance from a WidgetVBoxLayout for example,
 * the constructor of the class will be defined as follow:
 * <pre>
 * public function __construct($app, $id = null)
 * {
 * parent::__construct($app);
 * // We simulate inheritance from WidgetVBoxLayout.
 * $this->setInheritedItem(bab_Functionality::get('Widgets')->VBoxLayout($id));
 * }
 * </pre>
 */
class AppUiObject extends AppObject implements WidgetDisplayableInterface
{
    
    /**
     * @var WidgetItem $item
     */
    protected $item = null;
    
    /**
     * @param Func_App $app
     */
    public function __construct(Func_App $app)
    {
        parent::__construct($app);
    }
    
    /**
     * Sets the item from which we will 'inherit'.
     *
     * @param WidgetItem $item
     * @return $this
     */
    public function setInheritedItem($item)
    {
        $this->item = $item;
        return $this;
    }
    
    /**
     * @ignore
     */
    public function __call($name, $arguments)
    {
        // We delegate all undefined methods to the $item object.
        if(isset($this->item)){
            $returnedValue = call_user_func_array(array(
                $this->item,
                $name
            ), $arguments);
            if($returnedValue === $this->item){
                $returnedValue = $this;
            }
            return $returnedValue;
        }
        else{
            trigger_error('the method ' . $name . ' does not exists on ' . get_class($this) . ' and there is no widget defined with the setInheritedItem method');
        }
    }
    
    /**
     * @param WidgetCanvas $canvas
     * @ignore
     */
    public function display(WidgetCanvas $canvas)
    {
        return $this->item->display($canvas);
    }
}