wpdk-ui-alert.php

Go to the documentation of this file.

<?php

class WPDKUIAlertType {
  const SUCCESS     = 'alert-success';
  const INFORMATION = 'alert-info';
  const WARNING     = 'alert-warning';
  const DANGER      = 'alert-danger';
  const WHITE       = 'alert-white';
}

class WPDKUIAlert extends WPDKHTMLTag {

  // Used to store for each user the dismiss alert
  const USER_META_KEY_PERMANENT_DISMISS = '_wpdk_alert_dismiss';

  public $dismissable = true;

  public $dismissToolTip = '';

  public $title = '';

  public $dismissButton = true;

  public $dismiss_button_glyph = '×';

  public $content = '';

  public $type;

  public $permanent_dismiss = false;

  public $block;

  protected $dismissed = array();

  public function __construct( $id, $content = '', $type = WPDKUIAlertType::INFORMATION, $title = '' )
  {
    $this->id      = sanitize_title( $id );
    $this->content = $content;
    $this->type    = $type;
    $this->title   = $title;

    // @since 1.4.21 permanent dismissed
    if ( is_user_logged_in() ) {
      $user_id         = get_current_user_id();
      $this->dismissed = get_user_meta( $user_id, self::USER_META_KEY_PERMANENT_DISMISS, true );
    }
  }

  private function dismissButton()
  {
    $result = '';

    // Title
    $title = '';

    // Classes
    $classes = array( 'close' );

    // Custom title/tooltip in button close
    if ( !empty( $this->dismissToolTip ) ) {
      $classes[] = 'wpdk-has-tooltip';
      $title     = sprintf( 'title="%s"', $this->dismissToolTip );
    }

    // Permanent dismiss by user logged in
    if( true === $this->permanent_dismiss ) {
      $classes[] = 'wpdk-alert-permanent-dismiss';
    }

    if ( $this->dismissButton ) {
      WPDKHTML::startCompress(); ?>
      <button
        type="button"
        class="<?php echo WPDKHTMLTag::classInline( $classes ) ?>"
        <?php echo $title ?>
        data-dismiss="alert"><?php echo $this->dismiss_button_glyph ?></button>
      <?php
      $result = WPDKHTML::endHTMLCompress();
    }

    return $result;
  }

  private function _content()
  {
    return empty( $this->content ) ? wpautop( $this->content() ) : wpautop( $this->content );
  }

  public function content()
  {
    // You can override this method
    return $this->content;
  }

  private function _title()
  {
    if ( empty( $this->title ) ) {
      $this->title = $this->title();
    }

    return empty( $this->title ) ? '' : sprintf( '<h4>%s</h4>', $this->title );
  }

  public function title()
  {
    // You can override this method
    return $this->title;
  }

  public function html()
  {
    // Permanent dismiss
    if ( !empty( $this->dismissed ) && in_array( $this->id, $this->dismissed ) ) {
      return;
    }

    WPDKHTML::startCompress() ?>
    <div
      <?php echo empty( $this->id ) ? '' : 'id="' . $this->id . '"' ?>
      <?php echo empty( $this->data ) ? '' : self::dataInline( $this->data ) ?>
      class="<?php echo self::classInline( $this->class, array(
        $this->type,
        'wpdk-alert',
        $this->dismissable ? 'alert-dismissable' : '',
        'fade',
        'in',
        'clearfix'
      ) ) ?>">
      <?php echo $this->dismissButton() ?>
      <?php echo $this->_title() ?>
      <?php echo $this->_content() ?>
    </div>

    <?php
    return WPDKHTML::endHTMLCompress();
  }

  public function toControl()
  {
    $item = array(
      'type'           => WPDKUIControlType::ALERT,
      'id'             => $this->id,
      'alert_type'     => $this->type,
      'dismiss_button' => $this->dismissButton,
      'value'          => $this->content,
      'title'          => $this->title,
    );
    return array( $item );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Deprecated
  // -------------------------------------------------------------------------------------------------------------------

  private function alert_block()
  {
    _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '1.3.1 and Bootstrap 3.0.0', '' );
    return $this->block ? 'alert-block' : '';
  }

  function alert( $echo = true )
  {
    if ( $echo ) {
      $this->display();
    }
    else {
      return $this->html();
    }
  }

}