SemanticMediaWiki/includes/SMW_PageLister.php

Go to the documentation of this file.

<?php

class SMWPageLister {

        protected $mDiWikiPages;
        protected $mDiProperty;
        protected $mLimit;
        protected $mFrom;
        protected $mUntil;

        public function __construct( array $diWikiPages, $diProperty, $limit, $from = '', $until = '' ) {
                $this->mDiWikiPages = $diWikiPages;
                $this->mDiProperty = $diProperty;
                $this->mLimit = $limit;
                $this->mFrom = $from;
                $this->mUntil = $until;
        }

        public function getNavigationLinks( Title $title, $query = array() ) {
                global $wgLang;

                $limitText = $wgLang->formatNum( $this->mLimit );

                $resultCount = count( $this->mDiWikiPages );
                $beyondLimit = ( $resultCount > $this->mLimit );

                if ( !is_null( $this->mUntil ) && $this->mUntil !== '' ) {
                        if ( $beyondLimit ) {
                                $first = smwfGetStore()->getWikiPageSortKey( $this->mDiWikiPages[1] );
                        } else {
                                $first = '';
                        }

                        $last = $this->mUntil;
                } elseif ( $beyondLimit || ( !is_null( $this->mFrom ) && $this->mFrom !== '' ) ) {
                        $first = $this->mFrom;

                        if ( $beyondLimit ) {
                                $last = smwfGetStore()->getWikiPageSortKey( $this->mDiWikiPages[$resultCount - 1] );
                        } else {
                                $last = '';
                        }
                } else {
                        return '';
                }

                $prevLink = htmlspecialchars( wfMsg( 'prevn', $limitText ) );
                if ( $first !== '' ) {
                        $prevLink = $this->makeSelfLink( $title, $prevLink, $query + array( 'until' => $first ) );
                }

                $nextLink = htmlspecialchars( wfMsg( 'nextn', $limitText ) );
                if ( $last !== '' ) {
                        $nextLink = $this->makeSelfLink( $title, $nextLink, $query + array( 'from' => $last ) );
                }

                return "($prevLink) ($nextLink)";
        }

        protected function makeSelfLink( Title $title, $linkText, array $parameters ) {
                return smwfGetLinker()->link( $title, $linkText, array(), $parameters );
        }

        public static function getRequestOptions( $limit, $from, $until ) {
                $options = new SMWRequestOptions();
                $options->limit = $limit + 1;
                $options->sort = true;

                if ( $from !== '' ) {
                        $options->boundary = $from;
                        $options->ascending = true;
                        $options->include_boundary = true;
                } elseif ( $until !== '' ) {
                        $options->boundary = $until;
                        $options->ascending = false;
                        $options->include_boundary = false;
                }

                return $options;
        }

        public static function getQuery( SMWDescription $description, $limit, $from, $until ) {
                if ( $from !== '' ) {
                        $diWikiPage = new SMWDIWikiPage( $from, NS_MAIN, '' ); // make a dummy wiki page as boundary
                        $fromDescription = new SMWValueDescription( $diWikiPage, null, SMW_CMP_GEQ );
                        $queryDescription = new SMWConjunction( array( $description, $fromDescription ) );
                        $order = 'ASC';
                } elseif ( $until !== '' ) {
                        $diWikiPage = new SMWDIWikiPage( $until, NS_MAIN, '' ); // make a dummy wiki page as boundary
                        $untilDescription = new SMWValueDescription( $diWikiPage, null, SMW_CMP_LESS ); // do not include boundary in this case
                        $queryDescription = new SMWConjunction( array( $description, $untilDescription ) );
                        $order = 'DESC';
                } else {
                        $queryDescription = $description;
                        $order = 'ASC';
                }

                $queryDescription->addPrintRequest( new SMWPrintRequest( SMWPrintRequest::PRINT_THIS, '' ) );

                $query = new SMWQuery( $queryDescription );
                $query->sortkeys[''] = $order;
                $query->setLimit( $limit + 1 );

                return $query;
        }

        public function formatList( $cutoff = 6 ) {
                $end = count( $this->mDiWikiPages );
                $start = 0;
                if ( $end > $this->mLimit ) {
                        if ( $this->mFrom !== '' ) {
                                $end -= 1;
                        } else {
                                $start += 1;
                        }
                }

                if ( count ( $this->mDiWikiPages ) > $cutoff ) {
                        return self::getColumnList( $start, $end, $this->mDiWikiPages, $this->mDiProperty );
                } elseif ( count( $this->mDiWikiPages ) > 0 ) {
                        return self::getShortList( $start, $end, $this->mDiWikiPages, $this->mDiProperty );
                } else {
                        return '';
                }
        }

        public static function getColumnList( $start, $end, array $diWikiPages, $diProperty ) {
                global $wgContLang;
                
                // Divide list into three equal chunks.
                $chunk = (int) ( ( $end - $start + 1 ) / 3 );

                // Get and display header.
                $r = '<table width="100%"><tr valign="top">';

                $prevStartChar = 'none';

                // Loop through the chunks.
                for ( $startChunk = $start, $endChunk = $chunk, $chunkIndex = 0;
                        $chunkIndex < 3;
                        ++$chunkIndex, $startChunk = $endChunk, $endChunk += $chunk + 1 ) {
                        $r .= "<td>\n";
                        $atColumnTop = true;

                        // output all diWikiPages
                        for ( $index = $startChunk ; $index < $endChunk && $index < $end; ++$index ) {
                                $dataValue = SMWDataValueFactory::newDataItemValue( $diWikiPages[$index], $diProperty );
                                // check for change of starting letter or begining of chunk
                                $sortkey = smwfGetStore()->getWikiPageSortKey( $diWikiPages[$index] );
                                $startChar = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );

                                if ( ( $index == $startChunk ) ||
                                         ( $startChar != $prevStartChar ) ) {
                                        if ( $atColumnTop ) {
                                                $atColumnTop = false;
                                        } else {
                                                $r .= "</ul>\n";
                                        }

                                        if ( $startChar == $prevStartChar ) {
                                                $cont_msg = ' ' . wfMsgHtml( 'listingcontinuesabbrev' );
                                        } else {
                                                $cont_msg = '';
                                        }

                                        $r .= "<h3>" . htmlspecialchars( $startChar ) . $cont_msg . "</h3>\n<ul>";

                                        $prevStartChar = $startChar;
                                }

                                $r .= "<li>" . $dataValue->getLongHTMLText( smwfGetLinker() ) . "</li>\n";
                        }

                        if ( !$atColumnTop ) {
                                $r .= "</ul>\n";
                        }

                        $r .= "</td>\n";
                }

                $r .= '</tr></table>';

                return $r;
        }

        public static function getShortList( $start, $end, array $diWikiPages, $diProperty ) {
                global $wgContLang;

                $startDv = SMWDataValueFactory::newDataItemValue( $diWikiPages[$start], $diProperty );
                $sortkey = smwfGetStore()->getWikiPageSortKey( $diWikiPages[$start] );
                $startChar = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );
                $r = '<h3>' . htmlspecialchars( $startChar ) . "</h3>\n" .
                     '<ul><li>' . $startDv->getLongHTMLText( smwfGetLinker() ) . '</li>';

                $prevStartChar = $startChar;
                for ( $index = $start + 1; $index < $end; $index++ ) {
                        $dataValue = SMWDataValueFactory::newDataItemValue( $diWikiPages[$index], $diProperty );
                        $sortkey = smwfGetStore()->getWikiPageSortKey( $diWikiPages[$index] );
                        $startChar = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );

                        if ( $startChar != $prevStartChar ) {
                                $r .= "</ul><h3>" . htmlspecialchars( $startChar ) . "</h3>\n<ul>";
                                $prevStartChar = $startChar;
                        }

                        $r .= '<li>' . $dataValue->getLongHTMLText( smwfGetLinker() ) . '</li>';
                }

                $r .= '</ul>';

                return $r;
        }

}

---