amendoncabh / Tags.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| /** |
| * @method Tags a() |
| * @method Tags href() |
| * @method Tags target() |
| * @method Tags style() |
| * @method Tags div() |
| * @method Tags input() |
| * @method Tags value() |
| * @method Tags required() |
| * @method Tags p() |
| * @method Tags bold() |
| * @method Tags i() |
| * @method Tags em() |
| * @method Tags option() |
| * @method Tags checked |
| * @method Tags optgroup |
| * @method Tags label |
| * @method Tags ul |
| * @method Tags nl |
| * @method Tags li |
| * @method Tags table |
| * @method Tags tr |
| * @method Tags th |
| * @method Tags td |
| * @method Tags span |
| * @method Tags dl |
| * @method Tags dd |
| * @method Tags dt |
| * @method Tags h1 |
| * @method Tags h2 |
| * @method Tags h3 |
| * @method Tags h4 |
| * @method Tags form |
| * @method Tags action |
| * @method Tags method |
| * @method Tags strong |
| */ |
| class Tags |
| /** @var null name of tag, such as span */ |
| protected $ tagName = null ; |
| /** @var array array of contents */ |
| protected $ contents = array (); |
| /** @var array array of attributes */ |
| public $ attributes = array (); |
| /** @var bool for form element’s name */ |
| protected $ multiple = false ; |
| /** @var array normalize tag name */ |
| public static $ normalize_tag = array ( |
| ‘b’ => ‘strong’ , |
| ‘bold’ => ‘strong’ , |
| ‘italic’ => ‘i’ , |
| ‘image’ => ‘img’ , |
| ‘item’ => ‘li’ , |
| ‘order’ => ‘ol’ , |
| ‘number’ => ‘nl’ , |
| ); |
| /** @var array tags without contents */ |
| public static $ tag_no_body = array ( |
| ‘br’ , ‘img’ , ‘input’ , |
| ); |
| /** @var array in-line tags */ |
| public static $ tag_span = array ( |
| ‘span’ , ‘p’ , ‘strong’ , ‘i’ , ‘sub’ , ‘li’ , ‘a’ , ‘label’ , |
| ); |
| /** @var array how to connect attribute values */ |
| public static $ attribute_connectors = array ( |
| ‘class’ => ‘ ‘ , |
| ‘style’ => ‘; ‘ , |
| ); |
| /** @var string encoding */ |
| public static $ encoding = ‘UTF-8’ ; |
| /** @var bool true for tags such as |
| public $ noBodyTag = false ; |
| // +———————————————————————-+ |
| // constructions and static methods |
| // +———————————————————————-+ |
| /** |
| * Start Tag object, with or without tag name. |
| * |
| * @param null $tagName |
| * @param null $contents |
| * @return Tags |
| */ |
| public function __invoke ( $ tagName = NULL , $ contents = NULL ) |
| return $ this -> _ ( $ tagName , $ contents ); |
| > |
| /** |
| * construction of Tag object. |
| * |
| * @param string|null $tagName |
| * @param null|string $contents |
| * @return Tags |
| */ |
| public function __construct ( $ tagName = null , $ contents = null ) |
| $ this -> setTagName_ ( $ tagName ); |
| $ this -> setContents_ ( $ contents ); |
| > |
| /** |
| * @param string|null $tagName |
| * @param null|string $contents |
| * @return Tags |
| */ |
| public function _ ( $ tagName = NULL , $ contents = NULL ) |
| $ class = get_called_class(); |
| return new $ class ( $ tagName , $ contents ); |
| > |
| /** |
| * set attribute, or tagName if tagName is not set. |
| * |
| * @param string $name |
| * @param array $args |
| * @return Tags |
| */ |
| public function __call ( $ name , $ args ) |
| // attribute or tag if not set. |
| if ( is_null( $ this -> tagName ) ) < // set it as a tag name |
| return $ this -> _ ( $ name , $ args ); |
| > |
| else |
| $ this -> setAttribute_ ( $ name , $ args ); |
| > |
| return $ this ; |
| > |
| /** |
| * make string VERY safe for html. |
| * |
| * @param string $value |
| * @return string |
| */ |
| public static function safe_ ( $ value ) |
| if ( empty( $ value ) ) return $ value ; |
| return htmlentities( $ value , ENT_QUOTES , static :: $ encoding ); |
| > |
| /** |
| * wrap value with closure. use this to avoid encoding attribute values. |
| * |
| * @param string $value |
| * @return callable |
| */ |
| public static function wrap_ ( $ value ) |
| return function () use ( $ value ) < return $ value ; >; |
| > |
| public function isSpanTag () |
| return in_array( $ this -> tagName , static :: $ tag_span ); |
| > |
| public function isNoBodyTag () |
| return $ this -> noBodyTag ; |
| > |
| // +———————————————————————-+ |
| // mostly internal functions |
| // +———————————————————————-+ |
| /** |
| * set tag name. |
| * |
| * @param string $tagName |
| * @return Tags |
| */ |
| protected function setTagName_ ( $ tagName ) |
| if ( empty( $ tagName ) ) return $ this ; |
| $ tagName = $ this -> normalize_ ( $ tagName ); |
| if ( array_key_exists( $ tagName , static :: $ normalize_tag ) ) |
| $ tagName = static :: $ normalize_tag [ $ tagName ]; |
| > |
| $ this -> tagName = $ tagName ; |
| if ( in_array( $ this -> tagName , static :: $ tag_no_body ) ) |
| $ this -> noBodyTag = true ; |
| > |
| return $ this ; |
| > |
| /** |
| * set contents. |
| * |
| * @param string|array|Tags $contents |
| * @return Tags |
| */ |
| protected function setContents_ ( $ contents ) |
| if ( empty( $ contents ) ) return $ this ; |
| if ( is_array( $ contents ) ) |
| $ this -> contents = array_merge( $ this -> contents , $ contents ); |
| > |
| else |
| $ this -> contents [] = $ contents ; |
| > |
| return $ this ; |
| > |
| /** |
| * set attribute. if connector is not set, attribute is replaced. |
| * |
| * @param string $name |
| * @param string|array $value |
| * @param bool|string $connector |
| * @return Tags |
| */ |
| protected function setAttribute_ ( $ name , $ value , $ connector = null ) |
| if ( is_array( $ value ) && !empty( $ value ) ) |
| foreach ( $ value as $ val ) |
| $ this -> setAttribute_ ( $ name , $ val , $ connector ); |
| > |
| return $ this ; |
| > |
| elseif ( is_array( $ value ) ) |
| $ value = » ; |
| > |
| if ( $ value === false ) return $ this ; // ignore the property. |
| $ name = $ this -> normalize_ ( $ name ); |
| if ( $ value === true ) $ value = $ name ; // same as name (checked=»checked») |
| // set connector if it is not set. |
| if ( $ connector === null ) |
| $ connector = false ; // default is to replace value. |
| if ( array_key_exists( $ name , static :: $ attribute_connectors ) ) |
| $ connector = static :: $ attribute_connectors [ $ name ]; |
| > |
| > |
| // set attribute. |
| if ( !isset( $ this -> attributes [ $ name ] ) // new attribute. |
| || $ connector === false ) < // replace with new value. |
| $ this -> attributes [ $ name ] = $ value ; |
| > |
| else < // attribute is appended. |
| $ this -> attributes [ $ name ] .= $ connector . $ value ; |
| > |
| return $ this ; |
| > |
| /** |
| * normalize tag and attribute name: lower case, and remove first _ if exists. |
| * |
| * @param string $name |
| * @return string |
| */ |
| protected function normalize_ ( $ name ) |
| $ name = strtolower( $ name ); |
| if ( $ name [ 0 ]== ‘_’ ) $ name = substr( $ name , 1 ); |
| $ name = str_replace( ‘_’ , ‘-‘ , $ name ); |
| return $ name ; |
| > |
| // +———————————————————————-+ |
| // methods for setting tags, attributes, and contents. |
| // +———————————————————————-+ |
| /** |
| * set contents. |
| * |
| * @internal param array|string|Tags $contents |
| * @return Tags |
| */ |
| public function contain_ () |
| /** @var $args array */ |
| $ args = func_get_args(); |
| return $ this -> setContents_ ( $ args ); |
| > |
| /** |
| * set class name. adds to the existing class. |
| * |
| * @param string $class |
| * @param string $connector set FALSE to reset class. |
| * @return Tags |
| */ |
| public function _class ( $ class , $ connector = ‘ ‘ ) |
| return $ this -> setAttribute_ ( ‘class’ , $ class , $ connector ); |
| > |
| /** |
| * set style. adds to the existing style. |
| * |
| * @param string $style |
| * @param string $connector set FALSE to reset style. |
| * @return Tags |
| */ |
| public function _style ( $ style , $ connector = ‘; ‘ ) |
| return $ this -> setAttribute_ ( ‘style’ , $ style , $ connector ); |
| > |
| /** |
| * @param \Closure $func |
| * @param string $attribute |
| */ |
| public function walk ( $ func , $ attribute = null ) |
| if ( ! $ attribute || $ this -> $ attribute || isset( $ this -> attributes [ $ attribute ] ) ) |
| $ func ( $ this ); |
| > |
| if ( !empty( $ this -> contents ) ) |
| foreach ( $ this -> contents as $ content ) |
| if ( $ content instanceof self ) |
| $ content -> walk ( $ func , $ attribute ); |
| > |
| > |
| > |
| > |
| // +———————————————————————-+ |
| // convert Tags to a string. |
| // +———————————————————————-+ |
| /** |
| * @param string $head |
| * @return string |
| */ |
| protected function toContents_ ( $ head =»» ) |
| $ html = » ; |
| if ( empty( $ this -> contents ) ) return $ html ; |
| foreach ( $ this -> contents as $ content ) |
| if ( ! $ this -> isNoBodyTag () && ! $ this -> isSpanTag () && $ html && substr( $ html , — 1 ) != «\n» ) |
| $ html .= «\n»; |
| > |
| if ( is_object( $ content ) && method_exists( $ content , ‘toString_’ ) ) |
| $ html .= $ content -> toString_ ( $ head ); |
| > |
| else |
| $ html .= $ head . ( string ) $ content ; |
| > |
| > |
| return $ html ; |
| > |
| /** |
| * @return string |
| */ |
| protected function toAttribute_ () |
| $ attr = » ; |
| if ( !empty( $ this -> attributes ) ) |
| foreach ( $ this -> attributes as $ name => $ value ) |
| if ( $ value instanceof \ Closure ) |
| $ value = $ value (); // wrapped by closure. use it as is. |
| > |
| else |
| $ value = static :: safe_ ( $ value ); // make it very safe. |
| > |
| $ attr .= » < $ name >= \»< $ value >\»»; |
| > |
| return $ attr ; |
| > |
| /** |
| * @param string $head |
| * @return string |
| */ |
| protected function toString_ ( $ head = » ) |
| $ html = $ head ; |
| if ( $ this -> isNoBodyTag () ) |
| // create tag without content, such as |
| $ html .= » < < $ this ->tagName >» . $ this -> toAttribute_ () . ‘/>’ ; |
| > |
| elseif ( $ this -> isSpanTag () || count( $ this -> contents ) == 1 ) |
| // short tag such as |
| $ html .= » < < $ this ->tagName >» . $ this -> toAttribute_ () . » > «; |
| $ html .= $ this -> toContents_ (); |
| $ html .= « tagName > > «; |
| > |
| else < // create tag with contents inside. |
| $ html .= » < < $ this ->tagName >» . $ this -> toAttribute_ () . » > «; |
| $ html .= «\n»; |
| $ html .= $ this -> toContents_ ( $ head . ‘ ‘ ); |
| if ( substr( $ html , — 1 ) != «\n» ) $ html .= «\n»; |
| $ html .= $ head . « tagName > > «; |
| > |
| if ( ! $ this -> isSpanTag () && ! $ this -> isNoBodyTag () ) |
| // add new-line, except for in-line tags. |
| $ html .= «\n»; |
| > |
| return $ html ; |
| > |
| /** |
| * @return string |
| */ |
| public function __toString () |
| return $ this -> toString_ (); |
| > |
| // +———————————————————————-+ |
| > |
Класс Tag
Сейчас мы с вами сделаем класс Tag для упрощения работы с HTML тегами. Имея такой класс мы, вместо того, чтобы набирать HTML теги вручную, будем использовать для этого PHP.
На самом деле выигрыша в длине кода мы не получим, но сможем динамически формировать теги по определенным условиям, что пригодится нам для решения более сложных задач. Давайте приступим к реализации, а саму выгоду такого класса вы поймете в процессе работы над кодом, либо в следующих уроках, когда мы будем применять наш класс.
Приступим к реализации
Итак, наш класс называется Tag — это неспроста. Каждый объект этого класса будет представлять собой отдельный тег, с которым мы будем производить определенные операции.
Давайте будем передавать имя создаваемого тега в конструктор объекта и записывать в приватное свойство $name :
Сделаем с помощью нашего класса, к примеру, объект для тега (пока на экран ничего не выведется):
Пока мы просто получили объект с инпутом. Давайте добавим еще метод, с помощью которого мы будем выводить тег на экран.
Здесь следует иметь ввиду то, что теги бывают открывающие, например,
. Некоторые теги не имеют закрывающего тега, например, или .
Давайте для начала сделаем метод open , который будет только открывать тег (в случае с инпутами больше никакой метод и не понадобится, так как они не требуют закрытия).
Давайте проверим работу нашего метода:
Запустите этот код, и в окне браузера действительно появится инпут. Чтобы посмотреть исходный HTML код, в окне браузера можно будет нажать комбинацию клавиш Ctrl+U — там вы увидите код нашего инпута.
Открытый исходный код можно обновлять, будто обычную страницу браузера. Вы можете менять ваш PHP код и сразу проверять изменения HTML кода, отправляемого в браузер.
Давайте теперь сделаем метод close для закрывающей части тега:
Воспользуемся этим методом:
Самостоятельно, не подсматривая в мой код, сделайте такой же класс Tag .
Создайте с помощью класса Tag тег и выведите его на экран.
Создайте с помощью класса Tag тег и выведите его на экран с текстом ‘header сайта’ .