package.xml 0000666 0000000 0000000 00000022620 14221306737 010074 0 ustar
HTML_Common2pear.php.netHTML_CommonAbstract base class for HTML classes (PHP5 port of HTML_Common package).HTML_Common2 package provides methods for HTML code display and attributes handling.
* Provides methods to set, remove, merge HTML attributes.
* Handles global document options (charset, linebreak and indentation characters).
* Provides methods to handle indentation and HTML comments (useful in subclasses).Alexey Borzovavbavb@php.netyesKlaus Guentherthesaurthesaur@php.netno2022-03-312.3.12.1.0stablestableBSD License
This release is mostly needed for running psalm on HTML_QuickForm2 package
* Type hints fixed to better reflect reality
* CS fixes, minor changes to parseAttributes() method
5.6.01.10.02022-03-262.3.02.1.0stablestableBSD License
* Upgraded tests, PHPUnit-Polyfills is used to run them on PHP 5.6 to PHP 8.1
* Test suite now runs on Github Actions rather than on Travis
* The package runs under PHP 8.1 without E_DEPRECATED messages
* Minimum required PHP version is now 5.6
2021-04-252.2.02.1.0stablestableBSD License
* Minimum required PHP version is now 5.4
* Added constants for predefined global option names
* Fixed composer autoloading to prevent errors on classmap generation,
see https://github.com/pear/HTML_QuickForm2/issues/4
2019-04-072.1.22.1.0stablestableBSD License
Minor updates to tests setup, no code changes
Removed include-path from composer.json, use autoloading when installing with composer
2014-06-182.1.12.1.0stablestableBSD License
Minor updates to PHPDoc and tests setup, no code changes
2012-04-082.1.02.1.0stablestableBSD License
* HTML_Common2 now implements ArrayAccess, allowing more intuitive attribute
handling similar to that of SimpleXML extension
* Unit tests properly run under recent PHPUnit versions and from SVN checkout
* Coding standards fixes
2010-10-202.0.02.0.0stablestableBSD License
* Due to addition of end-user docs to PEAR manual, the package is now
declared stable
* Added array type hinting to removeAttributeArray() and getAttributesString()
methods
* Packaging fix: tests now install without redundant subdirectory, to
@test_dir@/HTML_Common2 rather than to @test_dir@/HTML_Common2/tests
2.0.0RC12.0.0RC1betabeta2009-09-27BSD License
* HTML_Common2::getOption() now returns an array of all options if no option
name is given (see request #11209), setOption() can accept an array of options
* Implemented hasClass() / addClass() / removeClass() methods for working with
element's CSS classes (see request #10191).
* Packaging fixes: added AllTests.php, updated PEAR installer dependency
2.0.0beta12.0.0beta1betabeta2007-05-04BSD License
* Use phpunit/PHPUnit rather than pear/PHPUnit2 for unit testing needs
* "Fluent interfaces": all methods that didn't return anything now
return $this. The following methods are affected: mergeAttributes(),
removeAttribute(), setAttribute(), setAttributes(), setComment() and
setIndentLevel().
0.3.00.3.0alphaalpha2006-10-16BSD License
Radical changes to API are not expected after this release, you may use the
package for development.
Changes:
* Renamed 'encoding' option to 'charset', as htmlspecialchars() parameter is named
* Removed toHtml() and display() methods, __toString() is now declared abstract
* Attribute values are always converted to strings
* Minor performance tweaks
* Switched to BSD license and package.xml 2.0
0.2.00.2.0develdevel2006-07-03PHP License
* $attributes array is now protected rather than private (and thus renamed
from $_attributes)
* parseAttributes() was renamed to prepareAttributes(), string parsing logic
was extracted into the new parseAttributes() method
* Added magic __toString() method as an alias for toHtml(), deprecated
display(): it is now possible to print an instance of HTML_Common2 subclass
by simply using the 'echo $object;'
* It is now possible to watch some attributes for changes, this can be used to
- Make attributes read-only (like 'type' attribute of <input /> tag)
- Do some custom processing (update the element's value if its name changes)
0.1.00.1.0develdevel2004-10-27PHP License
First release of a new major version.
HTML_Common2-2.3.1/tests/stubs/Common2Impl.php 0000666 0000000 0000000 00000004166 14221306737 015730 0 ustar
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://pear.php.net/package/HTML_Common2
*/
/**
* A non-abstract subclass of HTML_Common2
*
* HTML_Common2 cannot be instantiated due to abstract __toString() method,
* we need to (sort of) implement that.
*/
class Common2Impl extends HTML_Common2
{
public function __toString()
{
return '';
}
}
?>
HTML_Common2-2.3.1/tests/stubs/WatchedAttributes.php 0000666 0000000 0000000 00000005476 14221306737 017227 0 ustar
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://pear.php.net/package/HTML_Common2
*/
/**
* A subclass to test the 'watched attributes' functionality of HTML_Common2
*
* Two attributes are watched here: 'readonly' and 'uppercase'. The former
* should not be changed by any of the methods and the value of the latter
* should always be uppercase. This is achieved by implementing the
* onAttributeChange() method defined in HTML_Common2
*/
class WatchedAttributes extends Common2Impl
{
protected $watchedAttributes = ['readonly', 'uppercase'];
protected $attributes = [
'readonly' => 'this attribute is readonly',
'uppercase' => 'VALUE OF THIS IS ALWAYS UPPERCASE'
];
protected function onAttributeChange($name, $value = null)
{
if ('readonly' == $name) {
return;
}
if ('uppercase' == $name) {
if (null === $value) {
unset($this->attributes[$name]);
} else {
$this->attributes[$name] = strtoupper($value);
}
}
}
}
?>
HTML_Common2-2.3.1/tests/HTML_Common2_Test.php 0000666 0000000 0000000 00000021305 14221306737 015563 0 ustar
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://pear.php.net/package/HTML_Common2
*/
/** Sets up includes */
require_once __DIR__ . '/TestHelper.php';
use Yoast\PHPUnitPolyfills\TestCases\TestCase;
/**
* Unit test for HTML_Common2 class
*/
class HTML_Common2_Test extends TestCase
{
public function testUnknownOptionIsNull()
{
$this->assertNull(HTML_Common2::getOption('foobar'));
}
public function testAnyOptionAllowed()
{
HTML_Common2::setOption('foobar', 'baz');
$this->assertEquals('baz', HTML_Common2::getOption('foobar'));
}
public function testArrayOfOptionsAllowed()
{
HTML_Common2::setOption([
'quux' => 'xyzzy'
]);
$this->assertEquals('xyzzy', HTML_Common2::getOption('quux'));
$this->assertArrayHasKey(HTML_Common2::OPTION_CHARSET, HTML_Common2::getOption());
}
public function testConstructorSetsDefaultAttributes()
{
$obj = new Common2Impl();
$this->assertEquals([], $obj->getAttributes());
$obj = new Common2Impl(['foo' => 'bar']);
$this->assertEquals(['foo' => 'bar'], $obj->getAttributes());
}
public function testUnknownAttributeIsNull()
{
$obj = new Common2Impl();
$this->assertNull($obj->getAttribute('foobar'));
}
public function testAttributeNamesAreLowercased()
{
$obj = new Common2Impl();
$obj->setAttributes(['BAZ' => 'quux']);
$obj->setAttribute('Foo', 'bar');
$obj->mergeAttributes(['XyZZy' => 'xyzzy value']);
$this->assertEquals('bar', $obj->getAttribute('FOO'));
$obj->removeAttribute('fOO');
$this->assertEquals(
['baz' => 'quux', 'xyzzy' => 'xyzzy value'],
$obj->getAttributes()
);
}
public function testAttributeValuesAreStrings()
{
$obj = new Common2Impl();
$obj->setAttributes(['foo' => null, 'bar' => 10]);
$obj->setAttribute('baz', 2.5);
$obj->mergeAttributes(['foobar' => 42]);
foreach ($obj->getAttributes() as $attribute) {
$this->assertIsString($attribute);
}
}
public function testDefaultIndentLevelIsZero()
{
$obj = new Common2Impl();
$this->assertEquals(0, $obj->getIndentLevel());
}
public function testIndentLevelIsNonnegative()
{
$obj = new Common2Impl();
$obj->setIndentLevel(-1);
$this->assertEquals(0, $obj->getIndentLevel());
$obj->setIndentLevel(1);
$this->assertEquals(1, $obj->getIndentLevel());
}
public function testDefaultCommentIsNull()
{
$obj = new Common2Impl();
$this->assertNull($obj->getComment());
}
public function testAttributesAsStringAccepted()
{
$obj = new Common2Impl('multiple style= "height: 2em;" class=\'foo\' width=100% ');
$this->assertEquals(
['multiple' => 'multiple', 'style' => 'height: 2em;',
'class' => 'foo', 'width' => '100%'],
$obj->getAttributes()
);
}
public function testNonXhtmlAttributesTransformed()
{
$obj = new Common2Impl(['multiple']);
$obj->setAttribute('selected');
$obj->mergeAttributes('checked nowrap');
$this->assertEquals(
['multiple' => 'multiple', 'selected' => 'selected',
'checked' => 'checked', 'nowrap' => 'nowrap'],
$obj->getAttributes()
);
}
public function testWellFormedXhtmlGenerated()
{
$obj = new Common2Impl(['foo' => 'bar&"baz"', 'quux' => 'xyz\'zy']);
$this->assertEquals(
' foo="bar&"baz"" quux="xyz'zy"',
$obj->getAttributes(true)
);
}
public function testCanWatchAttributes()
{
$obj = new WatchedAttributes();
$obj->setAttributes(['readonly' => 'something', 'uppercase' => 'new value', 'foo' => 'bar']);
$this->assertEquals(
['readonly' => 'this attribute is readonly', 'uppercase' => 'NEW VALUE', 'foo' => 'bar'],
$obj->getAttributes()
);
$obj->mergeAttributes(['readonly' => 'something', 'uppercase' => 'other value', 'foo' => 'baz']);
$this->assertEquals(
['readonly' => 'this attribute is readonly', 'uppercase' => 'OTHER VALUE', 'foo' => 'baz'],
$obj->getAttributes()
);
$obj->setAttribute('readonly', 'something else');
$obj->setAttribute('uppercase', 'yet another value');
$obj->setAttribute('foo', 'quux');
$this->assertEquals(
['readonly' => 'this attribute is readonly', 'uppercase' => 'YET ANOTHER VALUE', 'foo' => 'quux'],
$obj->getAttributes()
);
$obj->removeAttribute('readonly');
$obj->removeAttribute('uppercase');
$obj->removeAttribute('foo');
$this->assertEquals(
['readonly' => 'this attribute is readonly'],
$obj->getAttributes()
);
}
public function testFluentInterfaces()
{
$obj = new Common2Impl();
$this->assertSame($obj, $obj->setAttributes(['foo' => 'foo value']));
$this->assertSame($obj, $obj->mergeAttributes(['bar' => 'bar value']));
$this->assertSame($obj, $obj->setAttribute('baz', 'baz value'));
$this->assertSame($obj, $obj->removeAttribute('bar'));
$this->assertSame($obj, $obj->setComment('A comment'));
$this->assertSame($obj, $obj->setIndentLevel(3));
}
public function testCanAddCssClasses()
{
$obj = new Common2Impl();
$obj->addClass('foobar');
$obj->addClass('foobar');
$this->assertEquals('foobar', $obj->getAttribute('class'));
$obj->addClass('quux xyzzy');
$this->assertFalse($obj->hasClass('bar'));
$this->assertTrue($obj->hasClass('foobar'));
$this->assertTrue($obj->hasClass('quux'));
$this->assertTrue($obj->hasClass('xyzzy'));
$obj->addClass(['newclass']);
$this->assertTrue($obj->hasClass('newclass'));
}
public function testCanRemoveCssClasses()
{
$obj = new Common2Impl(['class' => 'foobar quux xyzzy']);
$obj->removeClass('foobar xyzzy');
$this->assertFalse($obj->hasClass('xyzzy'));
$this->assertFalse($obj->hasClass('foobar'));
$this->assertTrue($obj->hasClass('quux'));
$obj->removeClass(['quux']);
$this->assertEquals(null, $obj->getAttribute('class'));
}
public function testArrayAccess()
{
$obj = new Common2Impl(['baz' => 'quux']);
$this->assertTrue(isset($obj['baz']));
$this->assertEquals('quux', $obj['baz']);
$obj['foo'] = 'bar';
$this->assertTrue(isset($obj['foo']));
$this->assertEquals('bar', $obj['foo']);
unset($obj['fOo']);
$this->assertFalse(isset($obj['foo']));
$obj[] = 'disabled';
$this->assertTrue(isset($obj['disabled']));
$this->assertEquals('disabled', $obj['disabled']);
}
}
?>
HTML_Common2-2.3.1/tests/TestHelper.php 0000666 0000000 0000000 00000004631 14221306737 014510 0 ustar
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://pear.php.net/package/HTML_Common2
*/
if (file_exists(dirname(__DIR__) . '/vendor/autoload.php')) {
require_once dirname(__DIR__) . '/vendor/autoload.php';
}
if (!class_exists('HTML_Common2', true)) {
if ('@' . 'package_version@' == '@package_version@') {
// If running from SVN checkout, do a relative include
require_once dirname(__DIR__) . '/HTML/Common2.php';
} else {
// If installed, use include_path
require_once 'HTML/Common2.php';
}
require_once __DIR__ . '/stubs/Common2Impl.php';
require_once __DIR__ . '/stubs/WatchedAttributes.php';
}
?>
HTML_Common2-2.3.1/HTML/Common2.php 0000666 0000000 0000000 00000044321 14221306737 013345 0 ustar
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://pear.php.net/package/HTML_Common2
*/
/**
* Base class for HTML classes
*
* Implements methods for working with HTML attributes, parsing and generating
* attribute strings. Port of HTML_Common class for PHP4 originally written by
* Adam Daniel with contributions from numerous other developers.
*
* @category HTML
* @package HTML_Common2
* @author Alexey Borzov
* @license https://opensource.org/licenses/bsd-license.php New BSD License
* @version Release: 2.3.1
* @link https://pear.php.net/package/HTML_Common2
* @implements ArrayAccess
*/
abstract class HTML_Common2 implements ArrayAccess
{
/**
* Constant for predefined 'charset' option
*/
const OPTION_CHARSET = 'charset';
/**
* Constant for predefined 'indent' option
*/
const OPTION_INDENT = 'indent';
/**
* Constant for predefined 'linebreak' option
*/
const OPTION_LINEBREAK = 'linebreak';
/**
* Line break for Windows platform
*/
const LINEBREAK_WIN = "\15\12";
/**
* Line break for Unix platform
*/
const LINEBREAK_UNIX = "\12";
/**
* Line break for Mac platform
*/
const LINEBREAK_MAC = "\15";
/**
* Associative array of attributes
*
* @var array
*/
protected $attributes = [];
/**
* Changes to attributes in this list will be announced via onAttributeChange()
* method rather than performed by HTML_Common2 class itself
*
* @var string[]
* @see onAttributeChange()
*/
protected $watchedAttributes = [];
/**
* Indentation level of the element
*
* @var int
*/
private $_indentLevel = 0;
/**
* Comment associated with the element
*
* @var string|null
*/
private $_comment = null;
/**
* Global options for all elements generated by subclasses of HTML_Common2
*
* Preset options are
* - 'charset': charset parameter used in htmlspecialchars() calls,
* defaults to 'ISO-8859-1'
* - 'indent': string used to indent HTML elements, defaults to "\11"
* - 'linebreak': string used to indicate linebreak, defaults to "\12"
*
* @var array
*/
private static $_options = [
self::OPTION_CHARSET => 'ISO-8859-1',
self::OPTION_INDENT => "\11",
self::OPTION_LINEBREAK => self::LINEBREAK_UNIX
];
/**
* Mapping "platform name" => "linebreak symbol(s)"
*
* @var array
*/
private static $_linebreaks = [
'win' => self::LINEBREAK_WIN,
'unix' => self::LINEBREAK_UNIX,
'mac' => self::LINEBREAK_MAC
];
/**
* Sets global option(s)
*
* @param string|array $nameOrOptions Option name or array
* ('option name' => 'option value')
* @param mixed $value Option value,
* if first argument is not an array
*
* @return void
*/
public static function setOption($nameOrOptions, $value = null)
{
if (is_array($nameOrOptions)) {
foreach ($nameOrOptions as $k => $v) {
self::setOption($k, $v);
}
} else {
if (self::OPTION_LINEBREAK === $nameOrOptions
&& isset(self::$_linebreaks[$value])
) {
$value = self::$_linebreaks[$value];
}
self::$_options[$nameOrOptions] = $value;
}
}
/**
* Returns global option(s)
*
* @param string $name Option name
*
* @return mixed Option value, null if option does not exist,
* array of all options if $name is not given
*/
public static function getOption($name = null)
{
if (null === $name) {
return self::$_options;
} else {
return isset(self::$_options[$name])? self::$_options[$name]: null;
}
}
/**
* Parses the HTML attributes given as string
*
* @param string $attrString HTML attribute string
*
* @return array An associative array of attributes
*/
protected static function parseAttributes($attrString)
{
$attributes = [];
$matchCount = preg_match_all(
"/(([A-Za-z_:]|[^\\x00-\\x7F])([A-Za-z0-9_:.-]|[^\\x00-\\x7F])*)"
. "([ \\n\\t\\r]+)?"
. "(=([ \\n\\t\\r]+)?(\"[^\"]*\"|'[^']*'|[^ \\n\\t\\r]*))?/",
$attrString,
$regs
);
for ($i = 0; $i < (int)$matchCount; $i++) {
$name = trim($regs[1][$i]);
$check = trim($regs[0][$i]);
$value = trim($regs[7][$i]);
if ($name === $check) {
$attributes[strtolower($name)] = strtolower($name);
} else {
if (!empty($value) && ($value[0] === '\'' || $value[0] === '"')) {
$value = substr($value, 1, -1);
}
$attributes[strtolower($name)] = $value;
}
}
return $attributes;
}
/**
* Creates a valid attribute array from either a string or an array
*
* @param string|array $attributes Array of attributes or HTML attribute string
*
* @return array An associative array of attributes
*/
protected static function prepareAttributes($attributes)
{
$prepared = [];
if (is_string($attributes)) {
return self::parseAttributes($attributes);
} elseif (is_array($attributes)) {
foreach ($attributes as $key => $value) {
if (is_int($key)) {
$key = strtolower($value);
$prepared[$key] = $key;
} else {
$prepared[strtolower($key)] = (string)$value;
}
}
}
return $prepared;
}
/**
* Removes an attribute from an attribute array
*
* @param array $attributes Attribute array
* @param string $name Name of attribute to remove
*
* @return void
*/
protected static function removeAttributeArray(array &$attributes, $name)
{
unset($attributes[strtolower($name)]);
}
/**
* Creates HTML attribute string from array
*
* @param array $attributes Attribute array
*
* @return string Attribute string
*/
protected static function getAttributesString(array $attributes)
{
$str = '';
$charset = self::getOption(self::OPTION_CHARSET);
foreach ($attributes as $key => $value) {
$str .= ' ' . $key . '="'
. htmlspecialchars($value, ENT_QUOTES, $charset) . '"';
}
return $str;
}
/**
* Class constructor, sets default attributes
*
* @param array|string $attributes Array of attribute 'name' => 'value' pairs
* or HTML attribute string
*/
public function __construct($attributes = null)
{
$this->mergeAttributes($attributes);
}
/**
* Sets the value of the attribute
*
* @param string $name Attribute name
* @param string $value Attribute value (will be set to $name if omitted)
*
* @return $this
*/
public function setAttribute($name, $value = null)
{
$name = strtolower($name);
if (is_null($value)) {
$value = $name;
}
if (in_array($name, $this->watchedAttributes)) {
$this->onAttributeChange($name, $value);
} else {
$this->attributes[$name] = (string)$value;
}
return $this;
}
/**
* Returns the value of an attribute
*
* @param string $name Attribute name
*
* @return string|null Attribute value, null if attribute does not exist
*/
public function getAttribute($name)
{
$name = strtolower($name);
return isset($this->attributes[$name])? $this->attributes[$name]: null;
}
/**
* Sets the attributes
*
* @param string|array|null $attributes Array of 'name' => 'value' pairs
* or HTML attribute string
*
* @return $this
*/
public function setAttributes($attributes)
{
$attributes = self::prepareAttributes($attributes);
$watched = [];
foreach ($this->watchedAttributes as $watchedKey) {
if (isset($attributes[$watchedKey])) {
$this->setAttribute($watchedKey, $attributes[$watchedKey]);
unset($attributes[$watchedKey]);
} else {
$this->removeAttribute($watchedKey);
}
if (isset($this->attributes[$watchedKey])) {
$watched[$watchedKey] = $this->attributes[$watchedKey];
}
}
$this->attributes = array_merge($watched, $attributes);
return $this;
}
/**
* Returns the attribute array or string
*
* @param bool $asString Whether to return attributes as string
*
* @return array|string
* @psalm-return ($asString is true ? string : array)
*/
public function getAttributes($asString = false)
{
if ($asString) {
return self::getAttributesString($this->attributes);
} else {
return $this->attributes;
}
}
/**
* Merges the existing attributes with the new ones
*
* @param array|string|null $attributes Array of 'name' => 'value' pairs
* or HTML attribute string
*
* @return $this
*/
public function mergeAttributes($attributes)
{
$attributes = self::prepareAttributes($attributes);
foreach ($this->watchedAttributes as $watchedKey) {
if (isset($attributes[$watchedKey])) {
$this->onAttributeChange($watchedKey, $attributes[$watchedKey]);
unset($attributes[$watchedKey]);
}
}
$this->attributes = array_merge($this->attributes, $attributes);
return $this;
}
/**
* Removes an attribute
*
* @param string $attribute Name of attribute to remove
*
* @return $this
*/
public function removeAttribute($attribute)
{
if (in_array(strtolower($attribute), $this->watchedAttributes)) {
$this->onAttributeChange(strtolower($attribute), null);
} else {
self::removeAttributeArray($this->attributes, $attribute);
}
return $this;
}
/**
* Sets the indentation level
*
* @param int $level Indentation level
*
* @return $this
*/
public function setIndentLevel($level)
{
$level = intval($level);
if (0 <= $level) {
$this->_indentLevel = $level;
}
return $this;
}
/**
* Gets the indentation level
*
* @return int
*/
public function getIndentLevel()
{
return $this->_indentLevel;
}
/**
* Returns the string to indent the element
*
* @return string
*/
protected function getIndent()
{
return str_repeat(
self::getOption(self::OPTION_INDENT),
$this->getIndentLevel()
);
}
/**
* Sets the comment for the element
*
* @param string|null $comment String to output as HTML comment
*
* @return $this
*/
public function setComment($comment)
{
$this->_comment = $comment;
return $this;
}
/**
* Returns the comment associated with the element
*
* @return string|null
*/
public function getComment()
{
return $this->_comment;
}
/**
* Checks whether the element has given CSS class
*
* @param string $class CSS Class name
*
* @return bool
*/
public function hasClass($class)
{
$regex = '/(^|\s)' . preg_quote($class, '/') . '(\s|$)/';
return (bool)preg_match($regex, $this->getAttribute('class'));
}
/**
* Adds the given CSS class(es) to the element
*
* @param string|array $class Class name, multiple class names separated by
* whitespace, array of class names
*
* @return $this
*/
public function addClass($class)
{
if (!is_array($class)) {
$class = preg_split('/\s+/', $class, -1, PREG_SPLIT_NO_EMPTY);
}
$curClass = null !== ($classAttr = $this->getAttribute('class'))
? preg_split('/\s+/', $classAttr, -1, PREG_SPLIT_NO_EMPTY)
: [];
foreach ($class as $c) {
if (!in_array($c, $curClass)) {
$curClass[] = $c;
}
}
$this->setAttribute('class', implode(' ', $curClass));
return $this;
}
/**
* Removes the given CSS class(es) from the element
*
* @param string|array $class Class name, multiple class names separated by
* whitespace, array of class names
*
* @return $this
*/
public function removeClass($class)
{
if (!is_array($class)) {
$class = preg_split('/\s+/', $class, -1, PREG_SPLIT_NO_EMPTY);
}
if (null === ($classAttr = $this->getAttribute('class'))) {
$curClass = [];
} else {
$curClass = array_diff(
preg_split('/\s+/', $classAttr, -1, PREG_SPLIT_NO_EMPTY),
$class
);
}
if ([] === $curClass) {
$this->removeAttribute('class');
} else {
$this->setAttribute('class', implode(' ', $curClass));
}
return $this;
}
/**
* Returns the HTML representation of the element
*
* This magic method allows using the instances of HTML_Common2 in string
* contexts
*
* @return string
*/
abstract public function __toString();
/**
* Called if trying to change an attribute with name in $watchedAttributes
*
* This method is called for each attribute whose name is in the
* $watchedAttributes array and which is being changed by setAttribute(),
* setAttributes() or mergeAttributes() or removed via removeAttribute().
* Note that the operation for the attribute is not carried on after calling
* this method, it is the responsibility of this method to change or remove
* (or not) the attribute.
*
* @param string $name Attribute name
* @param string|null $value Attribute value, null if attribute is being removed
*
* @return void
*/
protected function onAttributeChange($name, $value = null)
{
}
#[ReturnTypeWillChange]
/**
* Whether or not an offset (HTML attribute) exists
*
* @param string $offset An offset to check for.
*
* @return boolean Returns true on success or false on failure.
* @link http://php.net/manual/en/arrayaccess.offsetexists.php
*/
public function offsetExists($offset)
{
return isset($this->attributes[strtolower($offset)]);
}
#[ReturnTypeWillChange]
/**
* Returns the value at specified offset (i.e. attribute name)
*
* @param string $offset The offset to retrieve.
*
* @return string|null
* @link http://php.net/manual/en/arrayaccess.offsetget.php
* @see getAttribute()
*/
public function offsetGet($offset)
{
return $this->getAttribute($offset);
}
#[ReturnTypeWillChange]
/**
* Assigns a value to the specified offset (i.e. attribute name)
*
* @param string $offset The offset to assign the value to
* @param string $value The value to set
*
* @return void
* @link http://php.net/manual/en/arrayaccess.offsetset.php
* @see setAttribute()
*/
public function offsetSet($offset, $value)
{
if (null !== $offset) {
$this->setAttribute($offset, $value);
} else {
// handles $foo[] = 'disabled';
$this->setAttribute($value);
}
}
#[ReturnTypeWillChange]
/**
* Unsets an offset (i.e. removes an attribute)
*
* @param string $offset The offset to unset
*
* @return void
* @link http://php.net/manual/en/arrayaccess.offsetunset.php
* @see removeAttribute()
*/
public function offsetUnset($offset)
{
$this->removeAttribute($offset);
}
}
?>