XCube_PageNavigator.class.php

<?php
 
define( 'XCUBE_PAGENAVI_START', 1 );
define( 'XCUBE_PAGENAVI_PERPAGE', 2 );
 
define( 'XCUBE_PAGENAVI_SORT', 1 );
define( 'XCUBE_PAGENAVI_PAGE', 4 );
 
define( 'XCUBE_PAGENAVI_DEFAULT_PERPAGE', 20 );
 
 
class XCube_PageNavigator {
    public $mAttributes = [];

    public $mStart = 0;

    public $mTotalItems = 0;

    public $mPerpage = XCUBE_PAGENAVI_DEFAULT_PERPAGE;

    public $mPerpageFreeze = false;

    public $mSort = [];

    public $mUrl = '';

    public $mPrefix;

    public $mExtra = [];

    public $mFlags = 0;

    public $mFetch;

    public $_mIsSpecifedTotalItems = false;

    public $mGetTotalItems;
    public $_mIsSpecifiedTotal;
    public $mTotal;
 

    public function __construct( $url, $flags = XCUBE_PAGENAVI_START ) {
        $this->mUrl   = $url;
        $this->mFlags = $flags;
 
        $this->mFetch = new XCube_Delegate();
        $this->mFetch->add( [ &$this, 'fetchNaviControl' ] );
 
        $this->mGetTotalItems = new XCube_Delegate();
    }
 
    public function XCube_PageNavigator( $url, $flags = XCUBE_PAGENAVI_START ) {
        return $this->__construct( $url, $flags );
    }

    public function fetch() {
        $this->mFetch->call( new XCube_Ref( $this ) );
    }
 
    public function fetchNaviControl( &$navi ) {
        $root =& XCube_Root::getSingleton();
 
        $startKey   = $navi->getStartKey();
        $perpageKey = $navi->getPerpageKey();
 
        if ( $navi->mFlags & XCUBE_PAGENAVI_START ) {
            $t_start = $root->mContext->mRequest->getRequest( $navi->getStartKey() );
            if ( null !== $t_start && (int) $t_start >= 0 ) {
                $navi->mStart = (int) $t_start;
            }
        }
 
        if ( $navi->mFlags & XCUBE_PAGENAVI_PERPAGE && ! $navi->mPerpageFreeze ) {
            $t_perpage = $root->mContext->mRequest->getRequest( $navi->getPerpageKey() );
            if ( null !== $t_perpage && (int) $t_perpage > 0 ) {
                $navi->mPerpage = (int) $t_perpage;
            }
        }
    }
 
    public function addExtra( $key, $value ) {
        $this->mExtra[ $key ] = $value;
    }
 
    public function removeExtra( $key ) {
        if ( $this->mExtra[ $key ] ) {
            unset( $this->mExtra[ $key ] );
        }
    }
 
 
    protected function _renderExtra( /*** string ***/ $key, /*** mixed ***/ $extra, /*** string[] ***/ &$query ) {
        if ( ! is_array( $extra ) ) {
            $query[] = $key . '=' . urlencode( $extra );
        } else {    //array
            foreach ( $extra as $k => $value ) {
                $this->_renderExtra( $key . '[' . $k . ']', $value, $query );
            }
        }
    }
 
    public function getRenderBaseUrl( $mask = null ) {
        if ( null === $mask ) {
            $mask = [];
        }
        if ( ! is_array( $mask ) ) {
            $mask = [ $mask ];
        }
 
        if ( count( $this->mExtra ) > 0 ) {
            $tarr = [];
 
            foreach ( $this->mExtra as $key => $value ) {
                if ( is_array( $mask ) && ! in_array( $key, $mask, true ) ) {
                    $this->_renderExtra( $key, $value, $tarr );
                }
            }
 
            if ( 0 === (is_countable($tarr) ? count( $tarr ) : 0) ) {
                return $this->mUrl;
            }
            // TODO XCL 2.3.x 'strpos' call can be converted to 'str_contains'
            if ( false !== strpos( $this->mUrl, '?' ) ) {
                return $this->mUrl . '&amp;' . implode( '&amp;', $tarr );
            }
 
            return $this->mUrl . '?' . implode( '&amp;', $tarr );
        }
 
        return $this->mUrl;
    }

    public function getRenderUrl( $mask = null ) {
        if ( null !== $mask && ! is_array( $mask ) ) {
            $mask = [ $mask ];
        }
 
        $delimiter = '?';
        $url       = $this->getRenderBaseUrl( $mask );
        // TODO XCL 2.3.x 'strpos' call can be converted to 'str_contains'
        if ( false !== strpos( $url, '?' ) ) {
            $delimiter = '&amp;';
        }
 
        return $url . $delimiter . $this->getStartKey() . '=';
    }
 
    public function renderUrlForSort() {
        if ( count( $this->mExtra ) > 0 ) {
            $tarr = [];
 
            foreach ( $this->mExtra as $key => $value ) {
                //$tarr[]=$key."=".urlencode($value);
                $this->_renderExtra( $key, $value, $tarr );
            }
 
            $tarr[] = $this->getPerpageKey() . '=' . $this->mPerpage;
            // TODO XCL 2.3.x 'strpos' call can be converted to 'str_contains'
            if ( false !== strpos( $this->mUrl, '?' ) ) {
                return $this->mUrl . '&amp;' . implode( '&amp;', $tarr );
            }
 
            return $this->mUrl . '?' . implode( '&amp;', $tarr );
        }
 
        return $this->mUrl;
    }
 
    public function renderUrlForPage( $page = null ) {
        $tarr = [];
 
        foreach ( $this->mExtra as $key => $value ) {
            //$tarr[]=$key."=".urlencode($value);
            $this->_renderExtra( $key, $value, $tarr );
        }
 
        foreach ( $this->mSort as $key => $value ) {
            $tarr[] = $key . '=' . urlencode( $value );
        }
 
        $tarr[] = $this->getPerpageKey() . '=' . $this->getPerpage();
 
        if ( null !== $page ) {
            $tarr[] = $this->getStartKey() . '=' . (int) $page;
        }
        // TODO XCL 2.3.x 'strpos' call can be converted to 'str_contains'
        if ( false !== strpos( $this->mUrl, '?' ) ) {
            return $this->mUrl . '&amp;' . implode( '&amp;', $tarr );
        }
 
        return $this->mUrl . '?' . implode( '&amp;', $tarr );
    }

    public function renderSortUrl( $mask = null ) {
        return $this->renderUrlForSort();
    }
 
    public function setStart( $start ) {
        $this->mStart = (int) $start;
    }
 
    public function getStart() {
        return $this->mStart;
    }
 
    public function setTotalItems( $total ) {
        $this->mTotal             = (int) $total;
        $this->_mIsSpecifiedTotal = true;
    }
 
    public function getTotalItems() {
        if ( false === $this->_mIsSpecifedTotalItems ) {
            $this->mGetTotalItems->call( new XCube_Ref( $this->mTotal ) );
            $this->_mIsSpecifedTotalItems = true;
        }
 
        return $this->mTotal;
    }
 
    public function getTotalPages() {
        if ( $this->getPerpage() > 0 ) {
            return ceil( $this->getTotalItems() / $this->getPerpage() );
        }
 
        return 0;
    }
 
    public function setPerpage( $perpage ) {
        $this->mPerpage = (int) $perpage;
    }
 
    public function freezePerpage() {
        $this->mPerpageFreeze = true;
    }
 
    public function getPerpage() {
        return $this->mPerpage;
    }
 
    public function setPrefix( $prefix ) {
        $this->mPrefix = $prefix;
    }
 
    public function getPrefix() {
        return $this->mPrefix;
    }
 
    public function getStartKey() {
        return $this->mPrefix . 'start';
    }
 
    public function getPerpageKey() {
        return $this->mPrefix . 'perpage';
    }
 
    public function getCurrentPage() {
        return (int) floor( ( $this->getStart() + $this->getPerpage() ) / $this->getPerpage() );
    }
 
    public function hasPrivPage() {
        return ( $this->getStart() - $this->getPerpage() ) >= 0;
    }
 
    public function getPrivStart() {
        $prev = $this->getStart() - $this->getPerpage();
 
        return ( $prev > 0 ) ? $prev : 0;
    }
 
    public function hasNextPage() {
        return $this->getTotalItems() > ( $this->getStart() + $this->getPerpage() );
    }
 
    public function getNextStart() {
        $next = $this->getStart() + $this->getPerpage();
 
        return ( $this->getTotalItems() > $next ) ? $next : 0;
    }
}