wpdk-pointer.php

Go to the documentation of this file.

<?php

/*
 * [DRAFT]
 *
 * THE FOLLOWING CODE IS A DRAFT. FEEL FREE TO USE IT TO MAKE SOME EXPERIMENTS, BUT DO NOT USE IT IN ANY CASE IN
 * PRODUCTION ENVIRONMENT. ALL CLASSES AND RELATIVE METHODS BELOW CAN CHNAGE IN THE FUTURE RELEASES.
 *
 */

class WPDKPointer {

  public $align;

  public $buttonClose;

  public $buttonPrimary;
  public $content;
  public $edge;
  public $id;
  public $nextPage;
  public $selector;
  public $title;

  public function __construct( $id, $selector, $title, $content, $edge = 'left', $align = 'top' ) {
    $this->id       = sanitize_key( $id );
    $this->selector = $selector;
    $this->title    = $title;
    $this->content  = $content;
    $this->edge     = $edge;
    $this->align    = $align;

    $this->nextPage = '';

    $this->buttonClose = array(
      'id'       => 'wpdk-pointer-button-close',
      'label'    => __( 'Dismiss', WPDK_TEXTDOMAIN ),
      'dismiss'  => true,
      'function' => '',
      'page'     => ''
    );

    $this->buttonPrimary = array(
      'id'    => 'wpdk-button-pointer-next',
      'label' => __( 'Next', WPDK_TEXTDOMAIN ),
      'page'  => ''
    );

    add_action( 'admin_print_footer_scripts', array( $this, 'display' ) );

  }

  public function display() {

    /* Get info pointer. */
    $pointer_id = $this->id;
    $selector   = $this->selector;

    /* Build the pointer content. */
    $args = array(
      'content'  => sprintf( '%s%s', $this->_title(), $this->_content() ),
      'position' => array(
        'edge'  => $this->edge,
        'align' => $this->align
      )
    );

    /* If empty exit. */
    if ( empty( $pointer_id ) || empty( $selector ) || empty( $args ) || empty( $args['content'] ) ) {
      return;
    }

    /* Controllo se l'utente a deciso di dismettere questo pointer, in tal caso non lo visualizzo */
    $id_user = get_current_user_id();

    /* Check if dismiss, see 'action_wpdk_dismiss_wp_pointer' in Ajax for detail. */
    $dismissed = unserialize( get_user_meta( $id_user, 'wpdk_dismissed_wp_pointer', true ) );
    if ( isset( $dismissed[$pointer_id] ) ) {
      return;
    }

    /* Build a standard next button when the property nextPage is not empty. */
    if ( !empty( $this->nextPage ) ) {
      $this->buttonPrimary['page'] = $this->nextPage;
    }

    ?>
    <script type="text/javascript">
      //<![CDATA[
      jQuery( document ).ready( function ( $ ) {
        var options = <?php echo json_encode( $args ); ?>, setup;

        if ( !options ) {
          return;
        }

        options = $.extend( options, {

          buttons : function ( event, t ) {
            var button = jQuery( '<?php echo $this->_buttonClose() ?>' );
            button.bind( 'click.pointer', function () {
              t.element.pointer( 'close' );
            } );
            return button;
          },

          close : function () {
            var button = jQuery( '#<?php echo $this->buttonClose['id'] ?>' );
            <?php if ( empty( $this->buttonClose['function'] ) ) : ?>
            if( button.data('dismiss') ) {
              $.post( ajaxurl, {
                pointer : '<?php echo $pointer_id; ?>',
                action  : 'wpdk_action_dismiss_wp_pointer'
              } );
            }
            <?php else: ?>
            <?php echo $this->buttonClose['function'] ?>
            <?php endif; ?>
          }
        } );

        $( '<?php echo $selector; ?>' ).pointer( options ).pointer( 'open' );

        <?php if ( !empty( $this->buttonPrimary ) && !empty( $this->buttonPrimary['page']) ) : ?>
        $( '#<?php echo $this->buttonClose['id'] ?>' ).after( '<?php echo $this->_buttonPrimary() ?>' );
        $( '#<?php echo $this->buttonPrimary['id'] ?>' ).click( function () {
          <?php
          if ( empty( $this->buttonPrimary['function'] ) && !empty( $this->buttonPrimary['page'] ) ) {
              echo 'window.location="' . admin_url( 'admin.php?page=' . $this->buttonPrimary['page'] ) . '";';
          }
          elseif ( !empty( $this->buttonPrimary['function'] ) ) {
              echo $this->buttonPrimary['function'];
          }
          ?>
        } );
        <?php endif; ?>

      } );
      //]]>
    </script>
  <?php
  }

  private function _title() {
    if ( '<' != substr( $this->title, 0, 1 ) ) {
      return sprintf( '<h3>%s</h3>', $this->title );
    }
    return $this->title;
  }

  private function _content() {
    if ( '<' != substr( $this->content, 0, 1 ) ) {
      return sprintf( '<p>%s</p>', $this->content );
    }
    return $this->content;
  }

  private function _buttonClose() {
    $dismiss = '';
    if( isset( $this->buttonClose['dismiss']) && true ===  $this->buttonClose['dismiss'] ) {
      $dismiss = 'data-dismiss="true"';
    }
    $result = sprintf( '<a id="%s" %s class="button-secondary">%s</a>', $this->buttonClose['id'], $dismiss, $this->buttonClose['label'] );
    return $result;
  }

  private function _buttonPrimary() {
    $result = sprintf( '<a id="%s" style="margin-right:5px" class="button-primary">%s</a>', $this->buttonPrimary['id'], $this->buttonPrimary['label'] );
    return $result;
  }

}

class WPDKPointerButton {

  public $id;
  public $page;
  public $dismiss;

}