wpdk-html-tag.php

Go to the documentation of this file.

<?php
class WPDKHTMLTag extends WPDKObject {

  public $__version = '1.1.1';

  // Global attributes

  public $accesskey = '';
  public $class = array();

  public $content = '';
  public $contenteditable;
  public $contextmenu;

  public $data = array();
  public $dir;
  public $draggable;
  public $dropzone;
  public $hidden;
  public $id;
  public $lang;
  public $onclick;
  public $spellcheck;
  public $style;
  public $tabindex;

  public $tagName;

  /* Global events */
  public $title;

  protected $attributes = array();

  protected $close;

  protected $open;

  private $_globalAttributes;

  public function __construct( $tag_name )
  {
    // Store this tag name
    $this->tagName = $tag_name;

    // The global attributes below can be used on any HTML element
    $this->_globalAttributes = array(
      'accesskey',
      'class',
      'contenteditable', // HTML 5
      'contextmenu', // HTML 5
      'dir',
      'draggable', // HTML 5
      'dropzone', // HTML 5
      'hidden', // HTML 5
      'id',
      'lang',
      'spellcheck', // HTML 5
      'style',
      'tabindex',
      'title',
      'onclick'
    );
  }

  public function addData( $name, $value )
  {
    if ( !empty( $name ) ) {
      $this->data[$name] = $value;
    }
  }

  public function addClass( $class )
  {
    if ( !empty( $class ) ) {
      $this->class[$class] = $class;
    }
  }

  public function display()
  {
    echo $this->html();
  }

  public function html() {
    ob_start();

    // Open the tag
    echo $this->open;

    // Cycle for tag specify attributes
    foreach ( $this->attributes as $attr ) {
      if ( isset( $this->$attr ) && !is_null( $this->$attr ) ) {
        printf( ' %s="%s"', $attr, htmlspecialchars( stripslashes( $this->$attr ) ) );
      }
    }

    // Cycle for global common attributes
    foreach ( $this->_globalAttributes as $attr ) {
      if ( isset( $this->$attr ) && !is_null( $this->$attr ) ) {
        if ( 'class' == $attr ) {
          $classes = self::classInline( $this->$attr );
          if( !empty( $classes ) ) {
            printf( ' class="%s"', $classes );
          }
        }
        else {
          printf( ' %s="%s"', $attr, htmlspecialchars( stripslashes( $this->$attr ) ) );
        }
      }
    }

    // Generic data attribute
    $data = self::dataInline( $this->data );
    if ( !empty( $data ) ) {
      printf( ' %s', $data );
    }

    // Content, only for enclousure TAG
    if ( '/>' !== $this->close ) {

      // Close the first part tag
      echo '>';

      // Before content
      $this->beforeContent();

      // Content
      $this->draw();

      // After content
      $this->afterContent();

      // Close
      echo $this->close;
    }

    // Close
    else {
      echo $this->close;
      echo $this->content;
    }

    $content = ob_get_contents();
    ob_end_clean();

    return $content;
  }

  protected function beforeContent()
  {
    /* to override if needed */
  }

  public function draw()
  {
    echo $this->content;
  }

  protected function afterContent()
  {
    /* to override if needed */
  }

  public function setPropertiesByArray( $properties = array() ) {
    if ( !empty( $properties ) ) {
      foreach ( $properties as $key => $value ) {
        if ( in_array( $key, $this->attributes ) || in_array( $key, $this->_globalAttributes ) ) {
          $this->$key = $value;
        }
      }
    }
  }

  // -------------------------------------------------------------------------------------------------------------------
  // SANITIZE
  // -------------------------------------------------------------------------------------------------------------------

  public static function sanitizeAttributes( $attributes )
  {
    $stack = array();
    if ( is_string( $attributes ) && !empty( $attributes ) ) {
      $single_attrobutes = explode( ' ', $attributes );
      foreach ( $single_attrobutes as $attribute ) {
        $parts            = explode( '=', $attribute );
        $stack[$parts[0]] = trim( $parts[1], "\"''" );
      }
    }

    if ( is_array( $attributes ) ) {
      return $attributes;
    }

    return $stack;
  }

  public static function sanitizeData( $attributes )
  {
    $stack = array();
    if ( is_string( $attributes ) && !empty( $attributes ) ) {
      $single_attrobutes = explode( ' ', $attributes );
      foreach ( $single_attrobutes as $attribute ) {
        $parts = explode( '=', $attribute );
        $key   = $parts[0];
        if ( 'data-' == substr( $key, 0, 5 ) ) {
          $key = substr( $key, 5 );
        }
        $stack[$key] = trim( $parts[1], "\"''" );
      }
    }

    if ( is_array( $attributes ) ) {
      foreach ( $attributes as $key => $value ) {
        if ( 'data-' == substr( $key, 0, 5 ) ) {
          $key = substr( $key, 5 );
        }
        $stack[$key] = trim( $value, "\"''" );
      }
    }

    return $stack;
  }

  public static function sanitizeClasses( $classes )
  {
    if( empty( $classes) || is_null( $classes ) ) {
      return array();
    }

    // Convert the string classes in array
    if ( is_string( $classes ) ) {
      $classes = explode( ' ', $classes );
    }

    $classes = array_filter( array_unique( $classes, SORT_STRING ) );

    return array_combine( $classes, $classes );
  }

  public static function sanitizeStyles( $styles )
  {
    if ( empty( $styles ) || is_null( $styles ) ) {
      return array();
    }

    // Convert the string styles in array
    if ( is_string( $styles ) ) {
      $entries = explode( ';', $styles );
      $styles  = array();
      foreach ( $entries as $entry ) {
        list( $key, $value ) = explode( ':', $entry, 2 );
        $styles[$key] = trim( $value );
      }
    }

    return array_unique( $styles, SORT_STRING );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // INLINE
  // -------------------------------------------------------------------------------------------------------------------

  public static function attributeInline( $attributes, $additional_attributes = false )
  {

    $attributes = self::sanitizeAttributes( $attributes );

    if ( !empty( $additional_attributes ) ) {
      $additional_attributes = self::sanitizeAttributes( $additional_attributes );
      $attributes = array_merge( $attributes, $additional_attributes );
    }
    $stack = array();
    foreach ( $attributes as $key => $value ) {
      $stack[] = sprintf( '%s="%s"', $key, htmlspecialchars( stripslashes( $value ) ) );
    }
    return join( ' ', $stack );
  }

  public static function dataInline( $data, $additional_data = false )
  {
    $data = self::sanitizeData( $data );

    if ( !empty( $additional_data ) ) {
      $additional_data = self::sanitizeData( $additional_data );
      $data = array_merge( $data, $additional_data );
    }
    $stack = array();
    foreach ( $data as $key => $value ) {
      $stack[] = sprintf( 'data-%s="%s"', $key, htmlspecialchars( stripslashes( $value ) ) );
    }
    return join( ' ', $stack );
  }

  public static function classInline( $classes, $additional_classes = false )
  {
    $classes = self::sanitizeClasses( $classes );

    if ( !empty( $additional_classes ) ) {
      $additional_classes = self::sanitizeClasses( $additional_classes );
      if ( !empty( $additional_classes ) ) {
        $classes = array_merge( $classes, $additional_classes );
      }
    }

    $keys = array_keys( $classes );

    return join( ' ', $keys );
  }

  public static function styleInline( $styles, $additional_styles = false )
  {
    $styles = self::sanitizeStyles( $styles );

    if ( !empty( $additional_styles ) ) {
      $additional_styles = self::sanitizeStyles( $additional_styles );
      if ( !empty( $additional_styles ) ) {
        $styles = array_merge( $styles, $additional_styles );
      }
    }

    $result = array();
    foreach ( $styles as $key => $value ) {
      $result[] = $key . ':' . $value;
    }

    return rtrim( implode( ';', $result ), ';' );

  }

  // -------------------------------------------------------------------------------------------------------------------
  // UTILITIES
  // -------------------------------------------------------------------------------------------------------------------

  public static function mergeClasses( $class, $class2 = null, $_ = null )
  {
    $class = self::sanitizeClasses( $class );

    if ( func_num_args() < 2 ) {
      return $class;
    }

    for ( $i = 1; $i < func_num_args(); $i++ ) {
      $arg = func_get_arg( $i );
      if ( !is_null( $arg ) ) {
        $s     = self::sanitizeClasses( $arg );
        $class = array_merge( $class, $s );
      }
    }
    return self::sanitizeClasses( $class );
  }

}

class WPDKHTMLTagName {

  // HTML 4.1 tags
  const A        = 'a';
  const BUTTON   = 'button';
  const FIELDSET = 'fieldset';
  const FORM     = 'form';
  const IMG      = 'img';
  const INPUT    = 'input';
  const LABEL    = 'label';
  const LEGEND   = 'legend';
  const SELECT   = 'select';
  const SPAN     = 'span';
  const TEXTAREA = 'textarea';
}

class WPDKHTMLTagInputType {

  // Input types
  const BUTTON         = 'button';
  const CHECKBOX       = 'checkbox';
  const COLOR          = 'color';
  const DATE           = 'date';
  const DATETIME       = 'datetime';
  const DATETIME_LOCAL = 'datetime-local';
  const EMAIL          = 'email';
  const FILE           = 'file';
  const HIDDEN         = 'hidden';
  const IMAGE          = 'image';
  const MONTH          = 'month';
  const NUMBER         = 'number';
  const PASSWORD       = 'password';
  const RADIO          = 'radio';
  const RANGE          = 'range';
  const RESET          = 'reset';
  const SEARCH         = 'search';
  const SUBMIT         = 'submit';
  const TEL            = 'tel';
  const TEXT           = 'text';
  const TIME           = 'time';
  const URL            = 'url';
  const WEEK           = 'week';
}

class WPDKHTMLTagA extends WPDKHTMLTag {

  public $charset;
  public $coords;
  public $href;
  public $hreflang;
  public $media;
  public $name;
  public $rel;
  public $rev;
  public $shape;
  public $target;
  public $type;

  public function __construct( $content = '', $href = '' ) {

    // Create an WPDKHTMLTag instance
    parent::__construct( WPDKHTMLTagName::A );

    // The content
    $this->content = $content;

    // The href. Late binding
    $this->href = $href;

    // Setting
    $this->open       = '<a';
    $this->close      = '</a>';
    $this->attributes = array(
      'charset',
      'coords',
      'href',
      'hreflang',
      'media',
      // HTML 5
      'name',
      'rel',
      'rev',
      'shape',
      'target',
      'type'
      // HTML 5
    );
  }

}

class WPDKHTMLTagButton extends WPDKHTMLTag {

  /* Interface. */

  public $autofocus;

  public $disabled;
  public $form;
  public $formaction;
  public $formenctype;
  public $formmethod;
  public $formnovalidate;
  public $formtarget;

  public $name;

  public $type;

  public $value;

  public function __construct( $content = '' )
  {

    // Create an WPDKHTMLTag instance
    parent::__construct( WPDKHTMLTagName::BUTTON );

    // The content
    $this->content = $content;

    // Setting
    $this->open       = '<button';
    $this->close      = '</button>';
    $this->attributes = array(
      'autofocus',
      'disabled',
      'form',
      'formaction',
      'formenctype',
      'formmethod',
      'formnovalidate',
      'formtarget',
      'name',
      'type',
      'value'
    );
  }

}

class WPDKHTMLTagFieldset extends WPDKHTMLTag {

  /* Interface. */

  public $disabled;
  public $form;
  public $legend;
  public $name;

  public function __construct( $content = '', $legend = '' ) {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::FIELDSET );

    /* The content. */
    $this->content = $content;

    /* Legend. */
    if ( !empty( $legend ) ) {
      $this->legend = new WPDKHTMLTagLegend( $legend );
    }

    /* Setting. */
    $this->open       = '<fieldset';
    $this->close      = '</fieldset>';
    $this->attributes = array(
      'disabled',
      'form',
      'name'
    );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Over-riding
  // -------------------------------------------------------------------------------------------------------------------

  public function beforeContent()
  {
    if ( !empty( $this->legend ) ) {
      $this->legend->display();
    }
  }

}

class WPDKHTMLTagForm extends WPDKHTMLTag {

  public $accept;

  public $accept_charset;

  public $action;

  public $autocomplete;

  public $enctype;

  public $method;

  public $name;

  public $novalidate;

  public $target;

  public function __construct( $content = '' )
  {
    // Create an WPDKHTMLTag instance
    parent::__construct( WPDKHTMLTagName::FORM );

    // The content
    $this->content = $content;

    // Setting
    $this->open       = '<form';
    $this->close      = '</form>';
    $this->attributes = array(
      'accept',
      'accept-charset',
      'action',
      'autocomplete',
      'enctype',
      'method',
      'name',
      'novalidate',
      'target'
    );
  }
}


class WPDKHTMLTagImg extends WPDKHTMLTag {

  /* Interface. */

  public $alt;

  public $crossorigin;

  public $height;

  public $ismap;

  public $src;

  public $usemap;

  public $width;

  public function __construct( $src = '', $alt = '', $width = '', $height = '' )
  {
    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::IMG );

    $this->src    = $src;
    $this->alt    = $alt;
    $this->width  = $width;
    $this->height = $height;

    /* Setting. */
    $this->open       = '<img';
    $this->close      = '/>';
    $this->attributes = array(
      'alt',
      'crossorigin',
      'height',
      'ismap',
      'src',
      'usemap',
      'width',
    );
  }

}


class WPDKHTMLTagInput extends WPDKHTMLTag {

  /* Interface. */

  public $accept;
  public $align;
  public $alt;
  public $autocomplete;
  public $autofocus;
  public $checked;
  public $disabled;
  public $form;
  public $formaction;
  public $formenctype;
  public $formmethod;
  public $formnovalidate;
  public $formtarget;
  public $height;
  public $list;
  public $max;
  public $maxlength;
  public $min;
  public $multiple;
  public $name;
  public $pattern;
  public $placeholder;
  public $readonly;
  public $required;
  public $size;
  public $src;
  public $step;
  public $type;
  public $value;
  public $width;

  public function __construct( $content = '', $name = '', $id = '' ) {

    // Create an WPDKHTMLTag instance
    parent::__construct( WPDKHTMLTagName::INPUT );

    // The content
    $this->content = $content;

    // Set name
    if ( !empty( $name ) ) {
      $this->name = $name;
    }

    // To default, if $name exists and $id not exists, then $id = $name
    if ( !empty( $name ) && empty( $id ) ) {

      // Check if field is an array
      if ( '[]' == substr( $name, -2 ) ) {

        // Sanitize id
        $this->id = substr( $name, 0, strlen( $name ) - 2 );
      }

      else {
        $this->id = $name;
      }
    }

    // This is the case where $name = '' and $id != ''
    elseif ( !empty( $id ) ) {
      $this->id = $id;
    }

    // Setting
    $this->open       = '<input';
    $this->close      = '/>';
    $this->attributes = array(
      'accept',
      'align',
      'alt',
      'autocomplete',
      'autofocus',
      'checked',
      'disabled',
      'form',
      'formaction',
      'formenctype',
      'formmethod',
      'formnovalidate',
      'formtarget',
      'height',
      'list',
      'max',
      'maxlength',
      'min',
      'multiple',
      'name',
      'pattern',
      'placeholder',
      'readonly',
      'required',
      'size',
      'src',
      'step',
      'type',
      'value',
      'width'
    );
  }

}

class WPDKHTMLTagLabel extends WPDKHTMLTag {

  /* Interface. */

  public $for;
  public $form;

  public function __construct( $content = '' ) {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::LABEL );

    /* The content. */
    $this->content = $content;

    /* Setting. */
    $this->open       = '<label';
    $this->close      = '</label>';
    $this->attributes = array(
      'for',
      'form'
    );
  }

}

class WPDKHTMLTagLegend extends WPDKHTMLTag {

  /* Interface. */

  public $align;

  function __construct( $content = '' ) {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::LEGEND );

    /* The content. */
    $this->content = $content;

    /* Setting. */
    $this->open       = '<legend';
    $this->close      = '</legend>';
    $this->attributes = array(
      'align',
    );
  }

}

class WPDKHTMLTagSelect extends WPDKHTMLTag {

  /* Interface. */

  public $autofocus;
  public $disabled;
  public $form;
  public $multiple;
  public $name;
  public $size;
  public $value;

  public $_first_item = '';

  private $_options;

  public function __construct( $options = array(), $name = '', $id = '' )
  {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::SELECT );

    /* Store the options for draw later. */
    $this->_options = $options;

    /* Set name. */
    if ( !empty( $name ) ) {
      $this->name = $name;
    }

    /* To default, if $name exists and $id not exists, then $id = $name. */
    if ( !empty( $name ) && empty( $id ) ) {
      /* Check if field is an array. */
      if ( '[]' == substr( $name, -2 ) ) {
        /* Sanitize id. */
        $this->id = substr( $name, 0, strlen( $name ) - 2 );
      }

      else {
        $this->id = $name;
      }
    }
    /* This is the case where $name = '' and $id != '' */
    elseif ( !empty( $id ) ) {
      $this->id = $id;
    }

    /* Setting. */
    $this->open       = '<select';
    $this->close      = '</select>';
    $this->attributes = array(
      'autofocus',
      'disabled',
      'form',
      'multiple',
      'name',
      'size'
    );
  }

  public function draw()
  {
    $options = array();
    if ( is_callable( $this->_options ) ) {
      $options = call_user_func( $this->_options, $this );
    }
    elseif ( is_array( $this->_options ) ) {
      $options = $this->_options;
    }
    $this->content = $this->options( $options );
    parent::draw();
  }

  public function options( $options )
  {
    ob_start();
    $this->_options( $options );
    $content = ob_get_contents();
    ob_end_clean();
    return $content;
  }

  private function _options( $options )
  {
    if ( !empty( $this->_first_item ) ) : ?>
      <option value=""
              disabled="disabled"
              selected="selected"
              style="display:none"><?php echo $this->_first_item ?></option>
    <?php endif;

    foreach ( $options as $key => $option ) : ?>
      <?php if ( is_array( $option ) ) : ?>
        <optgroup class="wpdk-form-optiongroup" label="<?php echo $key ?>">
        <?php $this->_options( $option ); ?>
      </optgroup>
      <?php else : ?>
        <option class="wpdk-form-option" <?php if ( !empty( $this->value ) ) echo WPDKHTMLTagSelect::selected( $this->value, $key ) ?>
                value="<?php echo $key ?>"><?php echo $option ?></option>
      <?php endif; ?>
    <?php endforeach;
  }

  public static function selected( $haystack, $current )
  {
    if ( is_array( $haystack ) && in_array( $current, $haystack ) ) {
      $current = $haystack = 1;
    }
    return selected( $haystack, $current, false );
  }

}

class WPDKHTMLTagSpan extends WPDKHTMLTag {

  /* Interface. */

  public function __construct( $content = '' ) {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::SPAN );

    /* The content. */
    $this->content = $content;

    /* Setting. */
    $this->open       = '<span';
    $this->close      = '</span>';
    $this->attributes = array();
  }

}

class WPDKHTMLTagTextarea extends WPDKHTMLTag {

  /* Interface. */

  public $autofocus;
  public $cols;
  public $disabled;
  public $form;
  public $maxlength;
  public $name;
  public $placeholder;
  public $readonly;
  public $required;
  public $rows;
  public $wrap;

  public function __construct( $content = '', $name = '', $id = '' ) {

    /* Create an WPDKHTMLTag instance. */
    parent::__construct( WPDKHTMLTagName::TEXTAREA );

    /* The content. */
    $this->content = $content;

    /* Set name. */
    if ( !empty( $name ) ) {
      $this->name = $name;
    }

    /* To default, if $name exists and $id not exists, then $id = $name. */
    if ( !empty( $name ) && empty( $id ) ) {
      /* Check if field is an array. */
      if ( '[]' == substr( $name, -2 ) ) {
        /* Sanitize id. */
        $this->id = substr( $name, 0, strlen( $name ) - 2 );
      }

      else {
        $this->id = $name;
      }
    }
    /* This is the case where $name = '' and $id != '' */
    elseif ( !empty( $id ) ) {
      $this->id = $id;
    }

    /* Setting. */
    $this->open       = '<textarea';
    $this->close      = '</textarea>';
    $this->attributes = array(
      'autofocus',
      'cols',
      'disabled',
      'form',
      'maxlength',
      'name',
      'placeholder',
      'readonly',
      'required',
      'rows',
      'wrap'
    );
  }

}