class-gravityview-widget-page-links.php

Go to the documentation of this file.

<?php

/**
 * Widget to display page links
 *
 * @extends GravityView_Widget
 */
class GravityView_Widget_Page_Links extends \GV\Widget {

    public $icon = 'dashicons-controls-forward';

    protected $show_on_single = false;

    function __construct() {

        $this->widget_description = __('Links to multiple pages of results.', 'gk-gravityview' );

        $default_values = array( 'header' => 1, 'footer' => 1 );
        $settings = array( 'show_all' => array(
            'type' => 'checkbox',
            'label' => __( 'Show each page number', 'gk-gravityview' ),
            'desc' => __('Show every page number instead of summary (eg: 1 2 3 ... 8 »)', 'gk-gravityview'),
            'value' => false
        ));
        parent::__construct( __( 'Page Links', 'gk-gravityview' ) , 'page_links', $default_values, $settings );

    }

    public function render_frontend( $widget_args, $content = '', $context = '') {
        $gravityview_view = GravityView_View::getInstance();

        if( !$this->pre_render_frontend() ) {
            return;
        }

        $atts = shortcode_atts( array(
            'page_size' => \GV\Utils::get( $gravityview_view->paging, 'page_size' ),
            'total' => $gravityview_view->total_entries,
            'show_all' => !empty( $this->settings['show_all']['default'] ),
            'current' => (int) \GV\Utils::_GET( 'pagenum', 1 ),
        ), $widget_args, 'gravityview_widget_page_links' );

        $page_link_args = array(
            'base' => add_query_arg('pagenum','%#%', gv_directory_link() ),
            'format' => '&pagenum=%#%',
            'add_args' => array(), //
            'prev_text' => '&laquo;',
            'next_text' => '&raquo;',
            'type' => 'list',
            'end_size' => 1,
            'mid_size' => 2,
            'total' => empty( $atts['page_size'] ) ? 0 : ceil( $atts['total'] / $atts['page_size'] ),
            'current' => $atts['current'],
            'show_all' => !empty( $atts['show_all'] ), // to be available at backoffice
        );

        /**
         * @filter `gravityview_page_links_args` Filter the pagination options
         * @since 1.1.4
         * @param array  $page_link_args Array of arguments for the `paginate_links()` function. [Read more about `paginate_links()`](http://developer.wordpress.org/reference/functions/paginate_links/)
         */
        $page_link_args = apply_filters('gravityview_page_links_args', $page_link_args );

        $page_links = paginate_links( $page_link_args );

        if( !empty( $page_links )) {
            $class = !empty( $widget_args['custom_class'] ) ? $widget_args['custom_class'] : '';
            $class = gravityview_sanitize_html_class( 'gv-widget-page-links ' . $class );
            echo '<div class="'.$class.'">'. $page_links .'</div>';
        } else {
            gravityview()->log->debug( 'No page links; paginate_links() returned empty response.' );
        }

    }

}

new GravityView_Widget_Page_Links;