Attributes.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
*/


namespace Xoops\Html;

class Attributes
{
    protected $attributes = array();

    public function setAttribute($name, $value = null)
    {
        // convert boolean to strings, so getAttribute can return boolean
        // false for attributes that are not defined
        $value = ($value===false) ? '0' : $value;
        $value = ($value===true) ? '1' : $value;
        $this->attributes[htmlspecialchars($name, ENT_QUOTES)] = $value;
    }

    public function unsetAttribute($name)
    {
        unset($this->attributes[htmlspecialchars($name, ENT_QUOTES)]);
    }

    public function setAttributes($values)
    {
        if (!empty($values)) {
            foreach ($values as $name => $value) {
                $this->setAttribute($name, $value);
            }
        }
    }

    public function getAttribute($name)
    {
        $value = false;
        $name = htmlspecialchars($name, ENT_QUOTES);
        if (isset($this->attributes[$name])) {
            $value = $this->attributes[$name];
        }
        return $value;
    }

    public function hasAttribute($name)
    {
        $name = htmlspecialchars($name, ENT_QUOTES);
        return array_key_exists($name, $this->attributes);
    }

    public function addAttribute($name, $value)
    {
        if (is_scalar($value)) {
            $value = explode(' ', (string) $value);
        }
        $name = htmlspecialchars($name, ENT_QUOTES);
        if (false==$this->hasAttribute($name)) {
            $this->attributes[$name] = array();
        }
        foreach ($value as $v) {
            if (!in_array($v, $this->attributes[$name])) {
                $this->attributes[$name][] = $v;
            }
        }
    }

    public function renderAttributeString()
    {
        $rendered = '';
        foreach ($this->attributes as $name => $value) {
            if ($name == 'name'
                && $this->hasAttribute('multiple')
                && substr($value, -2) != '[]'
            ) {
                $value .= '[]';
            }
            if (is_array($value)) {
                // arrays can be used for class attributes, space separated
                $set = '="' . htmlspecialchars(implode(' ', $value), ENT_QUOTES) .'"';
            } elseif ($value===null) {
                // null indicates name only, like autofocus or readonly
                $set = '';
            } else {
                $set = '="' . htmlspecialchars($value, ENT_QUOTES) .'"';
            }
            $rendered .= $name . $set . ' ';
        }
        return $rendered;
    }
}