ITSSTOOLS/sources/renderer/formrenderer.class.inc.php

<?php

// Copyright (C) 2010-2016 Combodo SARL
//
//   This file is part of iTop.
//
//   iTop is free software; you can redistribute it and/or modify	
//   it under the terms of the GNU Affero General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
//   iTop 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 Affero General Public License for more details.
//
//   You should have received a copy of the GNU Affero General Public License
//   along with iTop. If not, see <http://www.gnu.org/licenses/>

namespace Combodo\iTop\Renderer;

use \Dict;
use \Combodo\iTop\Form\Form;

/**
 * Description of FormRenderer
 *
 * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
 */
abstract class FormRenderer
{
    const ENUM_RENDER_MODE_EXPLODED = 'exploded';
    const ENUM_RENDER_MODE_JOINED = 'joined';
    const DEFAULT_RENDERER_NAMESPACE = '';

    protected $oForm;
    protected $sEndpoint;
    protected $aSupportedFields;
    protected $sBaseLayout;
    protected $aOutputs;

    /**
     * Default constructor
     * 
     * @param \Combodo\iTop\Form\Form $oForm
     */
    public function __construct(Form $oForm = null)
    {
        if ($oForm !== null)
        {
            $this->oForm = $oForm;
        }
        $this->sBaseLayout = '';
        $this->InitOutputs();
    }

    public function GetForm()
    {
        return $this->oForm;
    }

    public function SetForm($oForm)
    {
        $this->oForm = $oForm;
        return $this;
    }

    public function GetEndpoint()
    {
        return $this->sEndpoint;
    }

    public function SetEndpoint($sEndpoint)
    {
        $this->sEndpoint = $sEndpoint;
        return $this;
    }

    public function GetBaseLayout()
    {
        return $this->sBaseLayout;
    }

    public function SetBaseLayout($sBaseLayout)
    {
        $this->sBaseLayout = $sBaseLayout;
        return $this;
    }

    public function GetFieldRendererClass($oField)
    {
        if (array_key_exists(get_class($oField), $this->aSupportedFields))
        {
            return $this->aSupportedFields[get_class($oField)];
        }
        else
        {
            // TODO : We might want to throw an exception.
            return null;
        }
    }

    /**
     * Returns the field identified by the id $sId in $this->oForm.
     *
     * @param string $sId
     * @return Combodo\iTop\Renderer\FieldRenderer
     */
    public function GetFieldRendererClassFromId($sId)
    {
        return $this->GetFieldRendererClass($this->oForm->GetField($sId));
    }

    /**
     *
     * @return array
     */
    public function GetOutputs()
    {
        return $this->aOutputs;
    }


    /**
     * Registers a Renderer class for the specified Field class.
     * 
     * If the Field class is not fully qualified, the default "Combodo\iTop\Form\Field" will be prepend.
     * If the Field class already had a registered Renderer, it is replaced.
     *
     * @param string $sFieldClass
     * @param string $sRendererClass
     */
    public function AddSupportedField($sFieldClass, $sRendererClass)
    {
        $sFieldClass = (strpos($sFieldClass, '\\') !== false) ? $sFieldClass : 'Combodo\\iTop\\Form\\Field\\' . $sFieldClass;
        $sRendererClass = (strpos($sRendererClass, '\\') !== false) ? $sRendererClass : static::DEFAULT_RENDERER_NAMESPACE . $sRendererClass;

        $this->aSupportedFields[$sFieldClass] = $sRendererClass;

        return $this;
    }

    public function InitOutputs()
    {
        $this->aOutputs = array();
        return $this;
    }

    public function Render()
    {
        $this->InitOutputs();

        foreach ($this->oForm->GetFields() as $oField)
        {
            $this->aOutputs[$oField->GetId()] = $this->PrepareOutputForField($oField);
        }

        return $this->aOutputs;
    }

    /**
     * Returns the output for the $oField. Output format depends on the $sMode.
     *
     * If $sMode = 'exploded', output is an has array with id / html / js_inline / js_files / css_inline / css_files / validators
     * Else if $sMode = 'joined', output is a string with everything in it
     *
     * @param Combodo\iTop\Form\Field\Field $oField
     * @param string $sMode 'exploded'|'joined'
     * @return mixed
     */
    protected function PrepareOutputForField($oField, $sMode = 'exploded')
    {
        $output = array(
            'id' => $oField->GetId(),
            'html' => '',
            'js_inline' => '',
            'css_inline' => '',
            'js_files' => array(),
            'css_files' => array(),
            'validators' => null
        );

        $sFieldRendererClass = $this->GetFieldRendererClass($oField);
        // TODO : We might want to throw an exception instead when there is no renderer for that field
        if ($sFieldRendererClass !== null)
        {
            $oFieldRenderer = new $sFieldRendererClass($oField);
            $oFieldRenderer->SetEndpoint($this->GetEndpoint());

            $oRenderingOutput = $oFieldRenderer->Render();

            // HTML
            if ($oRenderingOutput->GetHtml() !== '')
            {
                if ($sMode === static::ENUM_RENDER_MODE_EXPLODED)
                {
                    $output['html'] = $oRenderingOutput->GetHtml();
                }
                else
                {
                    $output['html'] .= $oRenderingOutput->GetHtml();
                }
            }

            // JS files
            foreach ($oRenderingOutput->GetJsFiles() as $sJsFile)
            {
                if ($sMode === static::ENUM_RENDER_MODE_EXPLODED)
                {
                    if (!in_array($sJsFile, $output['js_files']))
                    {
                        $output['js_files'][] = $sJsFile;
                    }
                }
                else
                {
                    $output['html'] .= '<script src="' . $sJsFile . '" type="text/javascript"></script>';
                }
            }
            // JS inline
            if ($oRenderingOutput->GetJs() !== '')
            {
                if ($sMode === static::ENUM_RENDER_MODE_EXPLODED)
                {
                    $output['js_inline'] .= ' ' . $oRenderingOutput->GetJs();
                }
                else
                {
                    $output['html'] .= '<script type="text/javascript">' . $oRenderingOutput->GetJs() . '</script>';
                }
            }

            // CSS files
            foreach ($oRenderingOutput->GetCssFiles() as $sCssFile)
            {
                if ($sMode === static::ENUM_RENDER_MODE_EXPLODED)
                {
                    if (!in_array($sCssFile, $output['css_files']))
                    {
                        $output['css_files'][] = $sCssFile;
                    }
                }
                else
                {
                    $output['html'] .= '<link href="' . $sCssFile . '" rel="stylesheet" />';
                }
            }
            // CSS inline
            if ($oRenderingOutput->GetCss() !== '')
            {
                if ($sMode === static::ENUM_RENDER_MODE_EXPLODED)
                {
                    $output['css_inline'] .= ' ' . $oRenderingOutput->GetCss();
                }
                else
                {
                    $output['html'] .= '<style>' . $oRenderingOutput->GetCss() . '</style>';
                }
            }

            // Validators
            foreach ($oField->GetValidators() as $oValidator)
            {
                $output['validators'][$oValidator::GetName()] = array(
                    'reg_exp' => $oValidator->GetRegExp(),
                    'message' => Dict::S($oValidator->GetErrorMessage())
                );
            }

            // Subfields
            // TODO
        }

        return $output;
    }
}