tao-test/app/tao/models/classes/iconBuilder/IconBuilderTrait.php

52 lines
1.9 KiB
PHP

<?php
/**
* This program 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; under version 2
* of the License (non-upgradable).
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2014 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
*/
namespace oat\tao\model\iconBuilder;
use DOMDocument;
trait IconBuilderTrait
{
/**
* This function builds the actual HTML element and is used by all other functions.
* The doc for $options is the applicable for all other functions.
*
* @param string $iconName name of the icon to display
* @param array $options (optional) hashtable with HTML attributes, also allows to set element="almostAnyHtmlElement"
*
* @return string HTML element with icon
*/
protected static function buildIcon(string $iconName, array $options = [])
{
$dom = new DOMDocument();
$element = $options['element'] ?? 'span';
$icon = $options['icon'] ?? '';
$options['class'] = trim(implode(' ', [$icon, $iconName]));
unset($options['element']); // remove element from options as others should be mapped to html attributes
$element = $dom->createElement($element);
foreach ($options as $key => $value) {
$element->setAttribute($key, $value);
}
return $dom->saveHTML($element);
}
}