mirror of
https://github.com/Universal-Omega/DynamicPageList3
synced 2024-12-03 12:16:33 +00:00
412 lines
10 KiB
PHP
412 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* DynamicPageList3
|
|
* DPL List Class
|
|
*
|
|
* @license GPL-2.0-or-later
|
|
* @package DynamicPageList3
|
|
*
|
|
*/
|
|
namespace DPL\Heading;
|
|
|
|
use DPL\Article;
|
|
use DPL\Lister\Lister;
|
|
use DPL\Parameters;
|
|
|
|
class Heading {
|
|
/**
|
|
* Listing style for this class.
|
|
*
|
|
* @var constant
|
|
*/
|
|
public $style = null;
|
|
|
|
/**
|
|
* List(Section) Start
|
|
* Use %s for attribute placement. Example: <div%s>
|
|
*
|
|
* @var string
|
|
*/
|
|
public $listStart = '';
|
|
|
|
/**
|
|
* List(Section) End
|
|
*
|
|
* @var string
|
|
*/
|
|
public $listEnd = '';
|
|
|
|
/**
|
|
* Item Start
|
|
* Use %s for attribute placement. Example: <div%s>
|
|
*
|
|
* @var string
|
|
*/
|
|
public $itemStart = '';
|
|
|
|
/**
|
|
* Item End
|
|
*
|
|
* @var string
|
|
*/
|
|
public $itemEnd = '';
|
|
|
|
/**
|
|
* Extra list HTML attributes.
|
|
*
|
|
* @var array
|
|
*/
|
|
public $listAttributes = '';
|
|
|
|
/**
|
|
* Extra item HTML attributes.
|
|
*
|
|
* @var array
|
|
*/
|
|
public $itemAttributes = '';
|
|
|
|
/**
|
|
* If the article count per heading should be shown.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $showHeadingCount = false;
|
|
|
|
/**
|
|
* \DPL\Parameters
|
|
*
|
|
* @var object
|
|
*/
|
|
protected $parameters = null;
|
|
|
|
/**
|
|
* Main Constructor
|
|
*
|
|
* @access public
|
|
* @param object \DPL\Parameters
|
|
* @return void
|
|
*/
|
|
public function __construct( Parameters $parameters ) {
|
|
$this->setListAttributes( $parameters->getParameter( 'hlistattr' ) );
|
|
$this->setItemAttributes( $parameters->getParameter( 'hitemattr' ) );
|
|
$this->setShowHeadingCount( $parameters->getParameter( 'headingcount' ) );
|
|
$this->parameters = $parameters;
|
|
}
|
|
|
|
/**
|
|
* Get a new List subclass based on user selection.
|
|
*
|
|
* @access public
|
|
* @param string Heading style.
|
|
* @param object \DPL\Parameters
|
|
* @param object MediaWiki \Parser
|
|
* @return mixed Heading subclass or null for a bad style.
|
|
*/
|
|
public static function newFromStyle( $style, \DPL\Parameters $parameters ) {
|
|
$style = strtolower( $style );
|
|
switch ( $style ) {
|
|
case 'definition':
|
|
$class = 'DefinitionHeading';
|
|
break;
|
|
case 'h1':
|
|
case 'h2':
|
|
case 'h3':
|
|
case 'h4':
|
|
case 'h5':
|
|
case 'h6':
|
|
case 'header':
|
|
$class = 'TieredHeading';
|
|
break;
|
|
case 'ordered':
|
|
$class = 'OrderedHeading';
|
|
break;
|
|
case 'unordered':
|
|
$class = 'UnorderedHeading';
|
|
break;
|
|
default:
|
|
return null;
|
|
break;
|
|
}
|
|
$class = '\DPL\Heading\\' . $class;
|
|
|
|
return new $class( $parameters );
|
|
}
|
|
|
|
/**
|
|
* Get the \DPL\Parameters object this object was constructed with.
|
|
*
|
|
* @access public
|
|
* @return object \DPL\Parameters
|
|
*/
|
|
public function getParameters() {
|
|
return $this->parameters;
|
|
}
|
|
|
|
/**
|
|
* Set extra list attributes.
|
|
*
|
|
* @access public
|
|
* @param string Tag soup attributes, example: this="that" thing="no"
|
|
* @return void
|
|
*/
|
|
public function setListAttributes( $attributes ) {
|
|
$this->listAttributes = \Sanitizer::fixTagAttributes( $attributes, 'ul' );
|
|
}
|
|
|
|
/**
|
|
* Set extra item attributes.
|
|
*
|
|
* @access public
|
|
* @param string Tag soup attributes, example: this="that" thing="no"
|
|
* @return void
|
|
*/
|
|
public function setItemAttributes( $attributes ) {
|
|
$this->itemAttributes = \Sanitizer::fixTagAttributes( $attributes, 'li' );
|
|
}
|
|
|
|
/**
|
|
* Set if the article count per heading should be shown.
|
|
*
|
|
* @access public
|
|
* @param boolean [Optional] Show Heading Count
|
|
* @return void
|
|
*/
|
|
public function setShowHeadingCount( $show = false ) {
|
|
$this->showHeadingCount = boolval( $show );
|
|
}
|
|
|
|
/**
|
|
* Return the list style.
|
|
*
|
|
* @access public
|
|
* @return integer List style constant.
|
|
*/
|
|
public function getStyle() {
|
|
return $this->style;
|
|
}
|
|
|
|
/**
|
|
* Format a list of articles into all lists with headings as needed.
|
|
*
|
|
* @access public
|
|
* @param array List of \DPL\Article
|
|
* @param object List of \DPL\Lister\Lister
|
|
* @return string Formatted list.
|
|
*/
|
|
public function format( $articles, Lister $lister ) {
|
|
$columns = $this->getParameters()->getParameter( 'columns' );
|
|
$rows = $this->getParameters()->getParameter( 'rows' );
|
|
$rowSize = $this->getParameters()->getParameter( 'rowsize' );
|
|
$rowColFormat = $this->getParameters()->getParameter( 'rowcolformat' );
|
|
|
|
$start = 0;
|
|
$count = 0;
|
|
|
|
$headings = Article::getHeadings();
|
|
$output = '';
|
|
if ( !empty( $headings ) ) {
|
|
if ( $columns != 1 || $rows != 1 ) {
|
|
$hspace = 2; // the extra space for headings
|
|
// repeat outer tags for each of the specified columns / rows in the output
|
|
// we assume that a heading roughly takes the space of two articles
|
|
$count = count( $articles ) + $hspace * count( $headings );
|
|
if ( $columns != 1 ) {
|
|
$iGroup = $columns;
|
|
} else {
|
|
$iGroup = $rows;
|
|
}
|
|
$nsize = floor( $count / $iGroup );
|
|
$rest = $count - ( floor( $nsize ) * floor( $iGroup ) );
|
|
if ( $rest > 0 ) {
|
|
$nsize += 1;
|
|
}
|
|
$output .= "{|" . $rowColFormat . "\n|\n";
|
|
if ( $nsize < $hspace + 1 ) {
|
|
$nsize = $hspace + 1; // correction for result sets with one entry
|
|
}
|
|
$output .= $this->getListStart();
|
|
$nstart = 0;
|
|
$greml = $nsize; // remaining lines in current group
|
|
$g = 0;
|
|
$offset = 0;
|
|
foreach ( $headings as $headingCount ) {
|
|
$headingStart = $nstart - $offset;
|
|
$headingLink = $articles[$headingStart]->mParentHLink;
|
|
$output .= $this->getItemStart() . $headingLink . $this->getItemEnd();
|
|
if ( $this->showHeadingCount ) {
|
|
$output .= $this->articleCountMessage( $headingCount );
|
|
}
|
|
$offset += $hspace;
|
|
$nstart += $hspace;
|
|
$portion = $headingCount;
|
|
$greml -= $hspace;
|
|
$listOutput = '';
|
|
do {
|
|
$greml -= $portion;
|
|
// $output .= "nsize=$nsize, portion=$portion, greml=$greml";
|
|
if ( $greml > 0 ) {
|
|
$output .= $lister->formatList( $articles, $nstart - $offset, $portion );
|
|
$nstart += $portion;
|
|
$portion = 0;
|
|
break;
|
|
} else {
|
|
$output .= $lister->formatList( $articles, $nstart - $offset, $portion + $greml );
|
|
$nstart += ( $portion + $greml );
|
|
$portion = ( -$greml );
|
|
if ( $columns != 1 ) {
|
|
$output .= "\n|valign=top|\n";
|
|
} else {
|
|
$output .= "\n|-\n|\n";
|
|
}
|
|
++$g;
|
|
// if ($rest != 0 && $g==$rest) $nsize -= 1;
|
|
if ( $nstart + $nsize > $count ) {
|
|
$nsize = $count - $nstart;
|
|
}
|
|
$greml = $nsize;
|
|
if ( $greml <= 0 ) {
|
|
break;
|
|
}
|
|
}
|
|
} while ( $portion > 0 );
|
|
$output .= $this->getItemEnd();
|
|
}
|
|
$output .= $this->listEnd;
|
|
$output .= "\n|}\n";
|
|
} else {
|
|
$output .= $this->getListStart();
|
|
$headingStart = 0;
|
|
foreach ( $headings as $headingCount ) {
|
|
$headingLink = $articles[$headingStart]->mParentHLink;
|
|
$output .= $this->formatItem( $headingStart, $headingCount, $headingLink, $articles, $lister );
|
|
$headingStart += $headingCount;
|
|
}
|
|
$output .= $this->listEnd;
|
|
}
|
|
} elseif ( $columns != 1 || $rows != 1 ) {
|
|
// repeat outer tags for each of the specified columns / rows in the output
|
|
$nstart = 0;
|
|
$count = count( $articles );
|
|
if ( $columns != 1 ) {
|
|
$iGroup = $columns;
|
|
} else {
|
|
$iGroup = $rows;
|
|
}
|
|
$nsize = floor( $count / $iGroup );
|
|
$rest = $count - ( floor( $nsize ) * floor( $iGroup ) );
|
|
if ( $rest > 0 ) {
|
|
$nsize += 1;
|
|
}
|
|
$output .= "{|" . $rowColFormat . "\n|\n";
|
|
for ( $g = 0; $g < $iGroup; $g++ ) {
|
|
$output .= $lister->formatList( $articles, $nstart, $nsize );
|
|
if ( $columns != 1 ) {
|
|
$output .= "\n|valign=top|\n";
|
|
} else {
|
|
$output .= "\n|-\n|\n";
|
|
}
|
|
$nstart = $nstart + $nsize;
|
|
// if ($rest != 0 && $g+1==$rest) $nsize -= 1;
|
|
if ( $nstart + $nsize > $count ) {
|
|
$nsize = $count - $nstart;
|
|
}
|
|
}
|
|
$output .= "\n|}\n";
|
|
} elseif ( $rowSize > 0 ) {
|
|
// repeat row header after n lines of output
|
|
$nstart = 0;
|
|
$nsize = $rowSize;
|
|
$count = count( $articles );
|
|
$output .= '{|' . $rowColFormat . "\n|\n";
|
|
do {
|
|
if ( $nstart + $nsize > $count ) {
|
|
$nsize = $count - $nstart;
|
|
}
|
|
$output .= $lister->formatList( $articles, $nstart, $nsize );
|
|
$output .= "\n|-\n|\n";
|
|
$nstart = $nstart + $nsize;
|
|
if ( $nstart >= $count ) {
|
|
break;
|
|
}
|
|
} while ( true );
|
|
$output .= "\n|}\n";
|
|
} else {
|
|
//Even though the headingmode is not none there were no headings, but still results. Output them anyway.
|
|
$output .= $lister->formatList( $articles, 0, count( $articles ) );
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Format a heading group.
|
|
*
|
|
* @access public
|
|
* @param integer Article start index for this heading.
|
|
* @param integer Article count for this heading.
|
|
* @param string Heading link/text display.
|
|
* @param array List of \DPL\Article.
|
|
* @param object List of \DPL\Lister\Lister
|
|
* @return string Heading HTML
|
|
*/
|
|
public function formatItem( $headingStart, $headingCount, $headingLink, $articles, Lister $lister ) {
|
|
$item = '';
|
|
|
|
$item .= $this->getItemStart() . $headingLink;
|
|
if ( $this->showHeadingCount ) {
|
|
$item .= $this->articleCountMessage( $headingCount );
|
|
}
|
|
$item .= $lister->formatList( $articles, $headingStart, $headingCount );
|
|
$item .= $this->getItemEnd();
|
|
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* Return $this->listStart with attributes replaced.
|
|
*
|
|
* @access public
|
|
* @return string List Start
|
|
*/
|
|
public function getListStart() {
|
|
return sprintf( $this->listStart, $this->listAttributes );
|
|
}
|
|
|
|
/**
|
|
* Return $this->itemStart with attributes replaced.
|
|
*
|
|
* @access public
|
|
* @return string Item Start
|
|
*/
|
|
public function getItemStart() {
|
|
return sprintf( $this->itemStart, $this->itemAttributes );
|
|
}
|
|
|
|
/**
|
|
* Return $this->itemEnd with attributes replaced.
|
|
*
|
|
* @access public
|
|
* @return string Item End
|
|
*/
|
|
public function getItemEnd() {
|
|
return $this->itemEnd;
|
|
}
|
|
|
|
/**
|
|
* Get the article count message appropriate for this list.
|
|
*
|
|
* @access public
|
|
* @param integer Count
|
|
* @return string Message
|
|
*/
|
|
protected function articleCountMessage( $count ) {
|
|
$orderMethods = $this->getParameters()->getParameter( 'ordermethods' );
|
|
if ( isset( $orderMethods[0] ) && $orderMethods[0] === 'category' ) {
|
|
$message = 'categoryarticlecount';
|
|
} else {
|
|
$message = 'dpl_articlecount';
|
|
}
|
|
return '<p>' . wfMessage( $message, $count )->escaped() . '</p>';
|
|
}
|
|
}
|