Files
iTop/sources/Renderer/FieldRenderer.php
2024-05-06 18:35:31 +02:00

120 lines
2.6 KiB
PHP

<?php
/**
* Copyright (C) 2013-2024 Combodo SAS
*
* 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
*/
namespace Combodo\iTop\Renderer;
use Combodo\iTop\Form\Field\Field;
use Combodo\iTop\Form\Validator\AbstractRegexpValidator;
use Dict;
use utils;
/**
* Description of FieldRenderer
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
*/
abstract class FieldRenderer
{
/** @var \Combodo\iTop\Form\Field\Field */
protected $oField;
/** @var string */
protected $sEndpoint;
/**
* Default constructor
*
* @param \Combodo\iTop\Form\Field\Field $oField
*/
public function __construct(Field $oField)
{
$this->oField = $oField;
}
/**
*
* @return string
*/
public function GetEndpoint()
{
return $this->sEndpoint;
}
/**
*
* @param string $sEndpoint
*
* @return \Combodo\iTop\Renderer\FieldRenderer
*/
public function SetEndpoint($sEndpoint)
{
$this->sEndpoint = $sEndpoint;
return $this;
}
/**
* Returns a JSON encoded string that contains the field's validators as an array.
*
* eg :
* {
* validator_id_1 : {reg_exp: /[0-9]/, message: "Error message"},
* validator_id_2 : {reg_exp: /[a-z]/, message: "Another error message"},
* ...
* }
*
* @return string
*/
protected function GetValidatorsAsJson()
{
$aValidators = array();
foreach ($this->oField->GetValidators() as $oValidator)
{
if (false === ($oValidator instanceof AbstractRegexpValidator)) {
// no JS counterpart, so skipping !
continue;
}
$aValidators[$oValidator::GetName()] = array(
'reg_exp' => $oValidator->GetRegExp(),
'message' => Dict::S($oValidator->GetErrorMessage()),
);
}
// - Formatting options
return json_encode($aValidators);
}
/**
* Renders a Field as a RenderingOutput
*
* @return \Combodo\iTop\Renderer\RenderingOutput
*/
public function Render()
{
$oOutput = new RenderingOutput();
// Field metadata
foreach ($this->oField->GetMetadata() as $sMetadataName => $sMetadataValue)
{
$oOutput->AddMetadata($sMetadataName, utils::HtmlEntities($sMetadataValue));
}
return $oOutput;
}
}