wpdk-listtable-viewcontroller.php

Go to the documentation of this file.

<?php
if ( !class_exists( 'WP_List_Table' ) ) {
  require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
}

class WPDKListTableViewController extends WP_List_Table {

  const GET_STATUS = 'status';

  public $id;

  public $title;

  public $viewController;

  public $getStatusID;

  protected  $args;

  public $model;

  public $column_headers = array();

  public function __construct( $id, $title, $args )
  {
    // Create an instance of WP_List_Table class
    parent::__construct( $args );

    // Set static properties.
    $this->id          = sanitize_key( $id );
    $this->title       = $title;
    $this->args        = $args;
    $this->getStatusID = self::GET_STATUS;

    // Init the internal view controller.
    $this->viewController                = new WPDKViewController( $this->id, $this->title );
    $this->viewController->view->class[] = 'wpdk-list-table-box';

  }

  // -------------------------------------------------------------------------------------------------------------------
  // Ask information to override to custom
  // -------------------------------------------------------------------------------------------------------------------

  public function get_columns()
  {
    return array();
  }

  public function get_statuses()
  {
    return array();
  }

  public function get_status( $status )
  {
    return;
  }

  public function get_actions_with_status( $item, $status )
  {
    return array();
  }

  public function get_bulk_actions_with_status( $status )
  {
    return array();
  }

  public static function action()
  {
    if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] ) {
      return $_REQUEST['action'];
    }

    if ( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] ) {
      return $_REQUEST['action2'];
    }

    return false;
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Private Utility
  // -------------------------------------------------------------------------------------------------------------------

  private function _defaultStatus()
  {
    $default_status = '';
    $statuses       = $this->get_statuses();
    foreach ( $statuses as $status ) {
      if ( is_array( $status ) && true === $status[1] ) {
        $default_status = $status[0];
        break;
      }
      elseif ( empty( $default_status ) ) {
        $default_status = $status;
        break;
      }
    }
    return $default_status;
  }

  private function _defaultSortableColumn()
  {
    $sortable_columns = $this->get_sortable_columns();
    if ( !empty( $sortable_columns ) ) {
      foreach ( $sortable_columns as $column_name => $value ) {
        if ( true === $value[1] ) {
          return $column_name;
        }
      }
    }
    return false;
  }

  private function _currentViewStatus()
  {
    $current_status = isset( $_REQUEST[$this->getStatusID] ) ? $_REQUEST[$this->getStatusID] : $this->_defaultStatus();
    return $current_status;
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Utility for select
  // -------------------------------------------------------------------------------------------------------------------

  private function _SQLDefaultOrder( $default_order = 'ASC' )
  {
    $column_name = $this->_defaultSortableColumn();
    $order_by    = isset( $_GET['order_by'] ) ? $_GET['order_by'] : $column_name;
    $order       = isset( $_GET['order'] ) ? $_GET['order'] : $default_order;
    return sprintf( '%s %s', $order_by, $order );
  }

  private function _SQLStatus()
  {
    $status_field   = $this->getStatusID;
    $current_status = $this->_currentViewStatus();

    return sprintf( ' AND %s = "%s"', $status_field, $current_status );
  }


  // -------------------------------------------------------------------------------------------------------------------
  // WPDKViewController Interface
  // -------------------------------------------------------------------------------------------------------------------

  public function load()
  {
  }

  public function admin_head()
  {
  }

  public function _admin_head()
  {
  }

  public static function willLoad()
  {
  }

  public static function didHeadLoad()
  {
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Display
  // -------------------------------------------------------------------------------------------------------------------

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

  public function html()
  {
    /* Buffering... */
    ob_start();

    /* Fetch, prepare, sort, and filter our data... */
    if ( !$this->prepare_items() ) :
      $this->views(); ?>

      <form id="<?php echo $this->id ?>" class="wpdk-list-table-form" method="get" action="">

      <?php if ( isset( $_REQUEST['page'] ) ) : ?>
        <input type="hidden" name="page" value="<?php echo $_REQUEST['page'] ?>" />
      <?php endif; ?>

      <?php if ( isset( $_REQUEST['post_type'] ) ) : ?>
        <input type="hidden" name="post_type" value="<?php echo $_REQUEST['post_type'] ?>" />
      <?php endif; ?>

      <?php if ( isset( $_REQUEST['orderby'] ) ) : ?>
        <input type="hidden" name="orderby" value="<?php echo $_REQUEST['orderby'] ?>" />
      <?php endif; ?>

      <?php if ( isset( $_REQUEST['order'] ) ) : ?>
        <input type="hidden" name="order" value="<?php echo $_REQUEST['order'] ?>" />
      <?php endif; ?>

      <?php do_action( 'wpdk_list_table_form', $this ); ?>
      <?php unset( $_REQUEST['action'] ); ?>
      <?php $_SERVER['REQUEST_URI'] = remove_query_arg( array( 'action', '_wp_http_referer', '_wp_nonce' ), $_SERVER['REQUEST_URI']); ?>

      <?php parent::display() ?>

    </form>
    <?php endif; ?>
    <?php
    $content = ob_get_contents();
    ob_end_clean();

    $this->viewController->viewHead->content = $content;

    add_action( 'wpdk_header_view_title_did_appear', array( $this, 'wpdk_header_view_title_did_appear' ) );

    return $this->viewController->html();
  }

  public function wpdk_header_view_title_did_appear( $view )
  {
    if ( 'new' != $this->current_action() ) {
      $add_new = sprintf( '<a class="wpdk-add-new button button-primary" href="%s">%s</a>', $this->urlAddNew(), __( 'Add New', WPDK_TEXTDOMAIN ) );
      $add_new = apply_filters( 'wpdk_listtable_viewcontroller_add_new', $add_new, $this );
      if ( !empty( $add_new ) ) {
        echo $add_new;
      }
    }
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Override standard WP_List_Table
  // -------------------------------------------------------------------------------------------------------------------

  public function no_items()
  {
    /* Default message. */
    printf( __( 'No %s found.', WPDK_TEXTDOMAIN ), $this->title );

    /* If in search mode. */
    /* @todo Find a way to determine if we are in 'search' mode or not */
    echo '<br/>';
    _e( 'Please, check again your search parameters.', WPDK_TEXTDOMAIN );
  }

  public function get_views()
  {
    // Prepare return
    $views         = array();

    // Status
    $get_status_id = $this->getStatusID;
    $filter_status = isset( $_GET[$get_status_id] ) ? $_GET[$get_status_id] : $this->_defaultStatus();

    // URI
    $uri = ( isset( $_SERVER['HTTP_REFERER'] ) && wpdk_is_ajax() ) ? $_SERVER['HTTP_REFERER'] : false;

    foreach ( $this->get_statuses() as $key => $status ) {

      // See _defaultStatus() for detail for this array.
      $status = is_array( $status ) ? $status[0] : $status;

      // Recompute!
      $count = $this->get_status( $key );
      if ( !empty( $count ) ) {

        $current = ( $filter_status == $key ) ? 'class="current"' : '';
        $args    = array(
          'status'                 => $key,
          'paged'                  => false,
          'action'                 => false,
          $this->_args['singular'] => false
        );
        $href = add_query_arg( $args, $uri );

        $views[$key] = sprintf( '<a %s href="%s">%s <span class="count">(%s)</span></a>', $current, $href, $status, $count );
      }
    }
    return $views;
  }

  public function statuses( $statuses )
  {
    return $statuses;
  }

  public function prepare_items()
  {
    if ( $this->process_bulk_action() ) {
      return true;
    }

    // First, lets decide how many records per page to show.
    $id_user = get_current_user_id();

    $screen = get_current_screen();

    $option = $screen->get_option( 'per_page', 'option' );
    if( !empty( $option ) ) {
      $per_page = get_user_meta( $id_user, $option, true );
    }

    if ( empty ( $per_page ) || $per_page < 1 ) {
      $per_page = $screen->get_option( 'per_page', 'default' );
      if( empty( $per_page ) ) {
        $per_page = 10;
      }
    }

    // Columns Header
    $this->column_headers = $this->get_column_info();

    // This is required because some GET params keep in the url
    $remove  = array( 'action' );
    $_SERVER['REQUEST_URI'] = remove_query_arg( $remove, stripslashes( $_SERVER['REQUEST_URI'] ) );

    // Get data.
    $data = $this->data();

    $current_page = $this->get_pagenum();

    $total_items = apply_filters( 'wpdk_listtable_total_items_' . $this->id, count( $data ) );

    $slice_data = array_slice( $data, ( ( $current_page - 1 ) * $per_page ), $per_page );

    $this->items = apply_filters( 'wpdk_listtable_items_' . $this->id, $slice_data, $data );

    $args = array(
      'total_items' => $total_items,
      'per_page'    => $per_page,
      'total_pages' => ceil( $total_items / $per_page )
    );
    $this->set_pagination_args( $args );
    return false;
  }

  // -------------------------------------------------------------------------------------------------------------------
  // To override
  // -------------------------------------------------------------------------------------------------------------------

  public function data()
  {
    if( !empty( $this->model ) && method_exists( $this->model, 'select' ) ) {
      return $this->model->select( $_REQUEST );
    }
    return array();
  }

  public function column_default( $item, $column_name )
  {
    switch ( $column_name ) {
      default:
        return print_r( $item, true );
    }
  }

  public function actions_column( $item, $column_name = 'description', $item_status = '', $custom_content = '' )
  {
    /* Get the current view status. */
    $status = $this->_currentViewStatus();

    if ( !empty( $item_status ) ) {
      $status = $item_status;
    }

    $stack = array();
    foreach ( $this->get_actions_with_status( $item, $status ) as $action => $label ) {
      if ( !empty( $action ) ) {
        $args           = array(
          'action'                => $action,
          $this->args['singular'] => $item[$this->args['singular']]
        );
        $href           = apply_filters( 'wpdk_listtable_action_' . $action, add_query_arg( $args ), $args );
        $stack[$action] = sprintf( '<a href="%s">%s</a>', $href, $label );
      }
    }

    $description = empty( $custom_content ) ? sprintf( '<strong>%s</strong>', $item[$column_name] ) : $custom_content;
    return sprintf( '%s %s', $description, $this->row_actions( $stack ) );
  }

  public function column_cb( $item )
  {
    $name  = $this->args['singular'];
    $value = $item[$name];
    return sprintf( '<input type="checkbox" name="%s[]" value="%s" />', $name, $value );
  }

  public function get_bulk_actions()
  {
    /* Get the current status, could be empty. */
    $current_status = isset( $_REQUEST[$this->getStatusID] ) ? $_REQUEST[$this->getStatusID] : $this->_defaultStatus();
    return $this->get_bulk_actions_with_status( $current_status );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Bulk and single actions
  // -------------------------------------------------------------------------------------------------------------------

  public function process_bulk_action()
  {
    die( __METHOD__ . ' must be over-ridden in a sub-class.' );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Utility for Bulk actions
  // -------------------------------------------------------------------------------------------------------------------

  public static function actions( $args, $status )
  {

    $id       = key( $args );
    $id_value = $args[$id];
    $actions  = array();

    foreach ( $args['actions'] as $key => $label ) {
      $args          = array(
        'action' => $key,
        $id      => $id_value
      );
      $href          = add_query_arg( $args );
      $actions[$key] = sprintf( '<a href="%s">%s</a>', $href, $label );
    }

    if ( empty( $status ) || $status != 'trash' ) {
      unset( $actions['untrash'] );
      unset( $actions['delete'] );
    }
    else if ( $status == 'trash' ) {
      unset( $actions['edit'] );
      unset( $actions['trash'] );
    }

    return $actions;
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Utility for build url
  // -------------------------------------------------------------------------------------------------------------------

  public function urlRemveAction()
  {
    $remove = array(
      'action',
      $this->_args['singular']
    );
    $url    = remove_query_arg( $remove, stripslashes( $_SERVER['REQUEST_URI'] ) );
    return $url;
  }

  public function urlRemoveNonce()
  {
    $remove = array(
      '_wp_http_referer',
      '_wpnonce',
      $this->_args['singular']
    );
    $url    = remove_query_arg( $remove, stripslashes( $_SERVER['REQUEST_URI'] ) );
    return $url;
  }

  public function urlAddNew()
  {
    $add = array(
      'action' => 'new',
      'page'   => $_REQUEST['page']
    );
    $url = add_query_arg( $add, $this->urlRemoveNonce() );
    return $url;
  }

  public function redirect()
  {
    $url = $this->urlRemveAction();
    wp_redirect( $url );
    exit;
  }

}

class WPDKListTableModel {

  public function __construct()
  {
  }

  public function select()
  {
    die( __METHOD__ . ' must be override in your subclass' );
  }

  public function process_action()
  {
    // Override when you need to process actions before wp is loaded
  }

}