Reception123 has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/374971 )
Change subject: Convert SupageFun to use extension registration
......................................................................
Convert SupageFun to use extension registration
Bug: T174663
Change-Id: I6b4502a28b7ab7743b69d997cd613398c05286c5
---
A SubpageFun.hooks.php
M SubpageFun.php
A extension.json
3 files changed, 448 insertions(+), 442 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SubpageFun
refs/changes/71/374971/1
diff --git a/SubpageFun.hooks.php b/SubpageFun.hooks.php
new file mode 100644
index 0000000..04ad69d
--- /dev/null
+++ b/SubpageFun.hooks.php
@@ -0,0 +1,414 @@
+<?php
+class ExtSubpageFun {
+
+ const VERSION = '0.6.0';
+
+ const MAG_SUBPAGETITLE = 'subpagetitle';
+ const MAG_SUBPAGES = 'subpages';
+ const MAG_PARENTPAGES = 'parentpages';
+ const MAG_SIBLINGPAGES = 'siblingpages';
+ const MAG_SUBPAGELEVEL = 'subpagelevel';
+ const MAG_NUMBEROFSUBPAGES = 'numberofsubpages';
+ const MAG_TOPLEVELPAGE = 'toplevelpage';
+
+ static function init( Parser &$parser ) {
+ // optional Parser::SFH_NO_HASH to omit the hash '#' from
function names
+ $parser->setFunctionHook( self::MAG_SUBPAGETITLE, array(
__CLASS__, 'pf_subpagetitle' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_SUBPAGES, array(
__CLASS__, 'pf_subpages' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_PARENTPAGES, array(
__CLASS__, 'pf_parentpages' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_SIBLINGPAGES, array(
__CLASS__, 'pf_siblingpages' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_SUBPAGELEVEL, array(
__CLASS__, 'pf_subpagelevel' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_NUMBEROFSUBPAGES, array(
__CLASS__, 'pf_numberofsubpages' ), Parser::SFH_NO_HASH );
+ $parser->setFunctionHook( self::MAG_TOPLEVELPAGE, array(
__CLASS__, 'pf_toplevelpage' ), Parser::SFH_NO_HASH );
+
+ return true;
+ }
+
+ /**
+ * Returns the extensions base installation directory.
+ *
+ * @since 0.5
+ *
+ * @return boolean
+ */
+ public static function getDir() {
+ static $dir = null;
+
+ if( $dir === null ) {
+ $dir = dirname( __FILE__ );
+ }
+ return $dir;
+ }
+
+ /*** private helper functions: ***/
+
+ /**
+ * Helper function for seperating n arguments of a MW parser function
+ * @return array
+ */
+ private static function getFunctionArgsArray( $args )
+ {
+ # Populate $argv with both named and numeric parameters
+ $argv = array();
+ $numargs = 0;
+
+ foreach ($args as $arg) if( ! is_object( $arg ) )
+ {
+ if( preg_match(
+ '/^([^\\n\\r]+?)\\s*=\\s*(.*)$/s', // s
- include newline. Parameter name is not supposed to have linebreaks
+ $arg,
+ $match
+ )
+ ) {
+ $argv[ trim( $match[1] ) ] = trim( $match[2] );
+ } else {
+ $numargs++;
+ $argv[ $numargs ] = trim( $arg );
+ }
+ }
+ return $argv;
+ }
+
+ /**
+ * Helper to get a new title from user input. Returns null if invalid
title is given.
+ *
+ * @param Parser $parser
+ * @param string $title
+ *
+ * @return Title|null
+ */
+ private static function newTitleObject ( Parser &$parser, $title = null
) {
+
+ if( is_array( $title ) ) {
+ /*
+ * Instead of one Title, all arguments given to the
parser function are given.
+ * This is because it makes things more generic to deal
with extension 'Parser Fun' support
+ * especially for functions only requiring an option
title.
+ */
+ // get all possible arguments:
+ $args = ExtSubpageFun::getFunctionArgsArray( $title );
+ $title = isset( $args[1] ) ? $args[1] : null;
+ }
+
+ if( $title !== null && $title !== '' ) {
+ return Title::newFromText( $title );
+ }
+ //returns object of current page if nothing else is requested:
+ return $parser->getTitle();
+ }
+
+ /**
+ * Create a list with page titles as final output of a SubpageFun
function.
+ * The output ist un-parsed wiki markup, no HTML.
+ *
+ * @param array $pages array of Title elements
+ * @param bool $link whether or not to link the pages in the list
+ * @param string $sep glue between the pages
+ *
+ * @return string
+ */
+ protected static function createSiteList( $pages, $link = false, $sep =
', ' ) {
+ $out = array();
+ foreach( $pages as $page ) {
+ $text = $page->getPrefixedText();
+ if( $link ) {
+ $out[] = "[[:{$text}]]";
+ } else {
+ $text = wfEscapeWikiText( $text );
+ $out[] = $text;
+ }
+ }
+ return implode( $sep, $out );
+ }
+
+ /**
+ * Filters a list of title elements by a word or a regular expression.
+ * The titles name without prefix is taken for comparision.
+ *
+ * @param array $list
+ * @param string $filter
+ *
+ * @return array
+ */
+ protected static function filterSiteList( array $list, $filter = null )
{
+ // return all if no filter set:
+ if( $filter === null ) {
+ return $list;
+ }
+ if ( ! self::isValidRegEx( $filter ) ) {
+ // no regex given, create one returning everything
having the $filter words in it
+ $filters = explode( '|', $filter );
+ foreach( $filters as &$part ) {
+ $part = preg_quote( trim( $part ), '/' );
+ }
+ $filter = '/^.*(?:' . implode( '|', $filters ) .
').*$/i';
+ }
+
+ // create new array from all matches:
+ $newList = array();
+
+ foreach( $list as $t ) {
+ if ( preg_match( $filter, $t->getText() ) ) {
+ $newList[] = $t;
+ }
+ }
+ return $newList;
+ }
+
+ /**
+ * Decides for the given $pattern whether its a valid regular
expression acceptable for
+ * the 'filter' parameter or not.
+ *
+ * @param string $pattern regular expression including delimiters and
optional flags
+ *
+ * @return boolean
+ */
+ public static function isValidRegEx( $pattern ) {
+ // validate first for allowd delimiters '/%|' and flags
+ if( ! preg_match( '/^([\\/\\|%]).*\\1[imsSuUx]*$/', $pattern )
) {
+ return false;
+ }
+ wfSuppressWarnings(); // instead of using the evil @ operator!
+ $isValid = false !== preg_match( $pattern, ' ' ); // preg_match
returns false on error
+ wfRestoreWarnings();
+ return $isValid;
+ }
+
+ /**
+ * Function to validate the paraameter depth required by some functions
+ * returns null if no value or invalid value is given, an integer if
+ * a number, including negative value, is given
+ *
+ * @param $depth Mixed
+ *
+ * @return Mixed null or integer
+ */
+ protected static function valDepth( $depth ) {
+ if( $depth === null || $depth === false || trim( $depth ) ===
'' ) {
+ return null;
+ }
+ // if it is '0'
+ if( $depth == 0 ) {
+ return 0;
+ }
+ // if it is a number:
+ if( $depth < 0 || (string)(int)$depth === $depth ) {
+ return $depth;
+ }
+ // invalid value like text:
+ else
+ return null;
+ }
+
+
+ /*** 'Subpage Fun' parser functions: ***/
+
+ static function pf_subpagetitle( &$parser /* , $title = null */ ) {
+ $t = self::newTitleObject( $parser, func_get_args() );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+ return wfEscapeWikiText( SubpageInfo::getSubpageTitle( $t ) );
+ }
+
+ static function pf_subpages( &$parser ) {
+ // get all possible arguments:
+ $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
+
+ $title = isset( $args[1] ) ? $args[1] : null;
+ $linked = isset( $args['linked'] ) ? true : false;
+ $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
+ $filter = isset( $args['filter'] ) ? $args['filter'] : null;
+ $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
+
+ // function logic:
+ $t = self::newTitleObject( $parser, $title );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+
+ // get subpages:
+ $subpages = SubpageInfo::getSubpages( $t, $depth );
+
+ // filter by filter criterion:
+ $subpages = self::filterSiteList( $subpages, $filter );
+
+ return self::createSiteList( $subpages, $linked, $sep );
+ }
+
+ static function pf_parentpages( &$parser ) {
+ // get all possible arguments:
+ $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
+
+ $title = isset( $args[1] ) ? $args[1] : null;
+ $linked = isset( $args['linked'] ) ? true : false;
+ $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
+ $filter = isset( $args['filter'] ) ? $args['filter'] : null;
+ $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
+
+ // function logic:
+ $t = self::newTitleObject( $parser, $title );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+
+ // get parent pages:
+ $parentpages = SubpageInfo::getAncestorPages( $t, $depth );
+
+ // filter by filter criterion:
+ $parentpages = self::filterSiteList( $parentpages, $filter );
+
+ return self::createSiteList( $parentpages, $linked, $sep );
+ }
+
+ static function pf_siblingpages( &$parser ) {
+ //get all possible arguments:
+ $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
+
+ $title = isset( $args[1] ) ? $args[1] : null;
+ $linked = isset( $args['linked'] ) ? true : false;
+ $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
+ $filter = isset( $args['filter'] ) ? $args['filter'] : null;
+
+ //function logic:
+ $t = self::newTitleObject( $parser, $title );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+
+ // get siblings:
+ $siblingpages = SubpageInfo::getSiblingPages( $t );
+
+ // filter by filter criterion:
+ $siblingpages = self::filterSiteList( $siblingpages, $filter );
+
+ return self::createSiteList( $siblingpages, $linked, $sep );
+ }
+
+ static function pf_subpagelevel( &$parser /* , $title = null */ ) {
+ $t = self::newTitleObject( $parser, func_get_args() );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+ return SubpageInfo::getSubpageLevel( $t );
+ }
+
+ static function pf_numberofsubpages( &$parser ) {
+ //get all possible arguments:
+ $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
+
+ $title = isset($args[1]) ? $args[1]
: null;
+ $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
+ $filter = isset( $args['filter'] ) ? $args['filter']
: null;
+
+ // function logic:
+ $t = self::newTitleObject( $parser, $title );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+
+ // get subpages:
+ $subpages = SubpageInfo::getSubpages( $t, $depth );
+
+ // filter by filter criterion:
+ $subpages = self::filterSiteList( $subpages, $filter );
+
+ return count( $subpages );
+ }
+
+ static function pf_toplevelpage( &$parser /* , $title = null */ ) {
+ $t = self::newTitleObject( $parser, func_get_args() );
+ if( $t === null ) {
+ return ''; // invalid title given
+ }
+
+ //get all parents because the toplevel is the highest existing
parent:
+ $parentpages = SubpageInfo::getAncestorPages( $t );
+
+ if( ! empty( $parentpages ) ) {
+ return wfEscapeWikiText(
$parentpages[0]->getPrefixedText() );
+ }
+ else {
+ ////no parent! The page itself is the top level:
+ return wfEscapeWikiText( $t->getPrefixedText() );
+ }
+ }
+
+
+ /**** All the SubpageFunctions for use with MW Variables on the current
page ****/
+
+ static function onParserGetVariableValueSwitch( Parser &$parser,
&$cache, &$magicWordId, &$ret, $frame = null ) {
+ return self::variableValueSwitch( $parser, $magicWordId, $ret );
+ }
+
+ /**
+ * Make 'Parser Fun' extensions 'THIS' function work with our
variables/functions
+ */
+ static function onGetThisVariableValueSwitch( Parser &$parser, Title
$title, &$magicWordId, &$ret, PPFrame $frame, array $args ) {
+ $expArgs = array();
+ foreach( $args as $arg ) {
+ $expArgs[] = trim( $frame->expand( $arg ) );
+ }
+ $expArgs[] = '1=' . $title->getPrefixedText();
+
+ return self::variableValueSwitch( $parser, $magicWordId, $ret,
$expArgs );
+ }
+
+ /**
+ * Where value assigning for normal variables and 'Parser Fun'
extensions 'THIS' come together
+ */
+ private static function variableValueSwitch( Parser &$parser,
$magicWordId, &$ret, $args = array() ) {
+ // function to call
+ $func = null;
+
+ switch( $magicWordId ) {
+ /** SUBPAGETITLE **/
+ case self::MAG_SUBPAGETITLE:
+ $func = 'pf_subpagetitle';
+ break;
+ /** SUBPAGES **/
+ case self::MAG_SUBPAGES:
+ $func = 'pf_subpages';
+ break;
+ /** PARENTPAGES **/
+ case self::MAG_PARENTPAGES:
+ $func = 'pf_parentpages';
+ break;
+ /** SIBLINGPAGES **/
+ case self::MAG_SIBLINGPAGES:
+ $func = 'pf_siblingpages';
+ break;
+ /** SUBPAGELEVEL **/
+ case self::MAG_SUBPAGELEVEL:
+ $func = 'pf_subpagelevel';
+ break;
+ /** NUMBEROFSUBPAGES **/
+ case self::MAG_NUMBEROFSUBPAGES:
+ $func = 'pf_numberofsubpages';
+ break;
+ /** TOPLEVELPAGE **/
+ case self::MAG_TOPLEVELPAGE:
+ $func = 'pf_toplevelpage';
+ break;
+ }
+ if( $func !== null ) {
+ $args = array_merge( array( &$parser ), $args ); //
$parser as first argument!
+ $ret = call_user_func_array( array( __CLASS__, $func ),
$args );
+ }
+
+ return true;
+ }
+
+ static function onMagicWordwgVariableIDs( &$customVariableIds ) {
+ // register variable ids:
+ $customVariableIds[] = self::MAG_SUBPAGETITLE;
+ $customVariableIds[] = self::MAG_SUBPAGES;
+ $customVariableIds[] = self::MAG_PARENTPAGES;
+ $customVariableIds[] = self::MAG_SIBLINGPAGES;
+ $customVariableIds[] = self::MAG_SUBPAGELEVEL;
+ $customVariableIds[] = self::MAG_NUMBEROFSUBPAGES;
+ $customVariableIds[] = self::MAG_TOPLEVELPAGE;
+
+ return true;
+ }
+}
\ No newline at end of file
diff --git a/SubpageFun.php b/SubpageFun.php
index c19e207..8201db7 100644
--- a/SubpageFun.php
+++ b/SubpageFun.php
@@ -14,446 +14,13 @@
* @ingroup SubpageFun
*/
-if ( ! defined( 'MEDIAWIKI' ) ) { die( ); }
-
-$wgExtensionCredits['parserhook'][] = array(
- 'path' => __FILE__,
- 'name' => 'Subpage Fun',
- 'descriptionmsg' => 'subpagefun-desc',
- 'version' => ExtSubpageFun::VERSION,
- 'author' => '[http://www.mediawiki.org/wiki/User:Danwe Daniel
Werner]',
- 'url' =>
'https://www.mediawiki.org/wiki/Extension:Subpage_Fun',
-);
-
-// language files:
-$wgMessagesDirs['SubpageFun'] = __DIR__ . '/i18n';
-$wgExtensionMessagesFiles['SubpageFun' ] = ExtSubpageFun::getDir() .
'/SubpageFun.i18n.php';
-$wgExtensionMessagesFiles['SubpageFunMagic'] = ExtSubpageFun::getDir() .
'/SubpageFun.i18n.magic.php';
-
-// Load member classes:
-$wgAutoloadClasses['SubpageInfo'] = ExtSubpageFun::getDir() .
'/SFun_SubpageInfo.php';
-
-// Register magic words:
-$wgHooks['ParserFirstCallInit'][] = 'ExtSubpageFun::init';
-
-// register plain variables:
-$wgHooks['MagicWordwgVariableIDs' ][] =
'ExtSubpageFun::onMagicWordwgVariableIDs';
-$wgHooks['ParserGetVariableValueSwitch'][] =
'ExtSubpageFun::onParserGetVariableValueSwitch';
-
-// hook up for use with 'Parser Fun' extensions 'THIS' function:
-$wgHooks['GetThisVariableValueSwitch'][] =
'ExtSubpageFun::onGetThisVariableValueSwitch';
-
-class ExtSubpageFun {
-
- const VERSION = '0.6.0';
-
- const MAG_SUBPAGETITLE = 'subpagetitle';
- const MAG_SUBPAGES = 'subpages';
- const MAG_PARENTPAGES = 'parentpages';
- const MAG_SIBLINGPAGES = 'siblingpages';
- const MAG_SUBPAGELEVEL = 'subpagelevel';
- const MAG_NUMBEROFSUBPAGES = 'numberofsubpages';
- const MAG_TOPLEVELPAGE = 'toplevelpage';
-
- static function init( Parser &$parser ) {
- // optional Parser::SFH_NO_HASH to omit the hash '#' from
function names
- $parser->setFunctionHook( self::MAG_SUBPAGETITLE, array(
__CLASS__, 'pf_subpagetitle' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_SUBPAGES, array(
__CLASS__, 'pf_subpages' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_PARENTPAGES, array(
__CLASS__, 'pf_parentpages' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_SIBLINGPAGES, array(
__CLASS__, 'pf_siblingpages' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_SUBPAGELEVEL, array(
__CLASS__, 'pf_subpagelevel' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_NUMBEROFSUBPAGES, array(
__CLASS__, 'pf_numberofsubpages' ), Parser::SFH_NO_HASH );
- $parser->setFunctionHook( self::MAG_TOPLEVELPAGE, array(
__CLASS__, 'pf_toplevelpage' ), Parser::SFH_NO_HASH );
-
- return true;
- }
-
- /**
- * Returns the extensions base installation directory.
- *
- * @since 0.5
- *
- * @return boolean
- */
- public static function getDir() {
- static $dir = null;
-
- if( $dir === null ) {
- $dir = dirname( __FILE__ );
- }
- return $dir;
- }
-
- /*** private helper functions: ***/
-
- /**
- * Helper function for seperating n arguments of a MW parser function
- * @return array
- */
- private static function getFunctionArgsArray( $args )
- {
- # Populate $argv with both named and numeric parameters
- $argv = array();
- $numargs = 0;
-
- foreach ($args as $arg) if( ! is_object( $arg ) )
- {
- if( preg_match(
- '/^([^\\n\\r]+?)\\s*=\\s*(.*)$/s', // s
- include newline. Parameter name is not supposed to have linebreaks
- $arg,
- $match
- )
- ) {
- $argv[ trim( $match[1] ) ] = trim( $match[2] );
- } else {
- $numargs++;
- $argv[ $numargs ] = trim( $arg );
- }
- }
- return $argv;
- }
-
- /**
- * Helper to get a new title from user input. Returns null if invalid
title is given.
- *
- * @param Parser $parser
- * @param string $title
- *
- * @return Title|null
- */
- private static function newTitleObject ( Parser &$parser, $title = null
) {
-
- if( is_array( $title ) ) {
- /*
- * Instead of one Title, all arguments given to the
parser function are given.
- * This is because it makes things more generic to deal
with extension 'Parser Fun' support
- * especially for functions only requiring an option
title.
- */
- // get all possible arguments:
- $args = ExtSubpageFun::getFunctionArgsArray( $title );
- $title = isset( $args[1] ) ? $args[1] : null;
- }
-
- if( $title !== null && $title !== '' ) {
- return Title::newFromText( $title );
- }
- //returns object of current page if nothing else is requested:
- return $parser->getTitle();
- }
-
- /**
- * Create a list with page titles as final output of a SubpageFun
function.
- * The output ist un-parsed wiki markup, no HTML.
- *
- * @param array $pages array of Title elements
- * @param bool $link whether or not to link the pages in the list
- * @param string $sep glue between the pages
- *
- * @return string
- */
- protected static function createSiteList( $pages, $link = false, $sep =
', ' ) {
- $out = array();
- foreach( $pages as $page ) {
- $text = $page->getPrefixedText();
- if( $link ) {
- $out[] = "[[:{$text}]]";
- } else {
- $text = wfEscapeWikiText( $text );
- $out[] = $text;
- }
- }
- return implode( $sep, $out );
- }
-
- /**
- * Filters a list of title elements by a word or a regular expression.
- * The titles name without prefix is taken for comparision.
- *
- * @param array $list
- * @param string $filter
- *
- * @return array
- */
- protected static function filterSiteList( array $list, $filter = null )
{
- // return all if no filter set:
- if( $filter === null ) {
- return $list;
- }
- if ( ! self::isValidRegEx( $filter ) ) {
- // no regex given, create one returning everything
having the $filter words in it
- $filters = explode( '|', $filter );
- foreach( $filters as &$part ) {
- $part = preg_quote( trim( $part ), '/' );
- }
- $filter = '/^.*(?:' . implode( '|', $filters ) .
').*$/i';
- }
-
- // create new array from all matches:
- $newList = array();
-
- foreach( $list as $t ) {
- if ( preg_match( $filter, $t->getText() ) ) {
- $newList[] = $t;
- }
- }
- return $newList;
- }
-
- /**
- * Decides for the given $pattern whether its a valid regular
expression acceptable for
- * the 'filter' parameter or not.
- *
- * @param string $pattern regular expression including delimiters and
optional flags
- *
- * @return boolean
- */
- public static function isValidRegEx( $pattern ) {
- // validate first for allowd delimiters '/%|' and flags
- if( ! preg_match( '/^([\\/\\|%]).*\\1[imsSuUx]*$/', $pattern )
) {
- return false;
- }
- wfSuppressWarnings(); // instead of using the evil @ operator!
- $isValid = false !== preg_match( $pattern, ' ' ); // preg_match
returns false on error
- wfRestoreWarnings();
- return $isValid;
- }
-
- /**
- * Function to validate the paraameter depth required by some functions
- * returns null if no value or invalid value is given, an integer if
- * a number, including negative value, is given
- *
- * @param $depth Mixed
- *
- * @return Mixed null or integer
- */
- protected static function valDepth( $depth ) {
- if( $depth === null || $depth === false || trim( $depth ) ===
'' ) {
- return null;
- }
- // if it is '0'
- if( $depth == 0 ) {
- return 0;
- }
- // if it is a number:
- if( $depth < 0 || (string)(int)$depth === $depth ) {
- return $depth;
- }
- // invalid value like text:
- else
- return null;
- }
-
-
- /*** 'Subpage Fun' parser functions: ***/
-
- static function pf_subpagetitle( &$parser /* , $title = null */ ) {
- $t = self::newTitleObject( $parser, func_get_args() );
- if( $t === null ) {
- return ''; // invalid title given
- }
- return wfEscapeWikiText( SubpageInfo::getSubpageTitle( $t ) );
- }
-
- static function pf_subpages( &$parser ) {
- // get all possible arguments:
- $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
-
- $title = isset( $args[1] ) ? $args[1] : null;
- $linked = isset( $args['linked'] ) ? true : false;
- $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
- $filter = isset( $args['filter'] ) ? $args['filter'] : null;
- $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
-
- // function logic:
- $t = self::newTitleObject( $parser, $title );
- if( $t === null ) {
- return ''; // invalid title given
- }
-
- // get subpages:
- $subpages = SubpageInfo::getSubpages( $t, $depth );
-
- // filter by filter criterion:
- $subpages = self::filterSiteList( $subpages, $filter );
-
- return self::createSiteList( $subpages, $linked, $sep );
- }
-
- static function pf_parentpages( &$parser ) {
- // get all possible arguments:
- $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
-
- $title = isset( $args[1] ) ? $args[1] : null;
- $linked = isset( $args['linked'] ) ? true : false;
- $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
- $filter = isset( $args['filter'] ) ? $args['filter'] : null;
- $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
-
- // function logic:
- $t = self::newTitleObject( $parser, $title );
- if( $t === null ) {
- return ''; // invalid title given
- }
-
- // get parent pages:
- $parentpages = SubpageInfo::getAncestorPages( $t, $depth );
-
- // filter by filter criterion:
- $parentpages = self::filterSiteList( $parentpages, $filter );
-
- return self::createSiteList( $parentpages, $linked, $sep );
- }
-
- static function pf_siblingpages( &$parser ) {
- //get all possible arguments:
- $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
-
- $title = isset( $args[1] ) ? $args[1] : null;
- $linked = isset( $args['linked'] ) ? true : false;
- $sep = isset( $args['sep'] ) ? $args['sep'] : ', ';
- $filter = isset( $args['filter'] ) ? $args['filter'] : null;
-
- //function logic:
- $t = self::newTitleObject( $parser, $title );
- if( $t === null ) {
- return ''; // invalid title given
- }
-
- // get siblings:
- $siblingpages = SubpageInfo::getSiblingPages( $t );
-
- // filter by filter criterion:
- $siblingpages = self::filterSiteList( $siblingpages, $filter );
-
- return self::createSiteList( $siblingpages, $linked, $sep );
- }
-
- static function pf_subpagelevel( &$parser /* , $title = null */ ) {
- $t = self::newTitleObject( $parser, func_get_args() );
- if( $t === null ) {
- return ''; // invalid title given
- }
- return SubpageInfo::getSubpageLevel( $t );
- }
-
- static function pf_numberofsubpages( &$parser ) {
- //get all possible arguments:
- $args = ExtSubpageFun::getFunctionArgsArray( func_get_args() );
-
- $title = isset($args[1]) ? $args[1]
: null;
- $depth = isset( $args['depth'] ) ? self::valDepth(
$args['depth'] ) : null;
- $filter = isset( $args['filter'] ) ? $args['filter']
: null;
-
- // function logic:
- $t = self::newTitleObject( $parser, $title );
- if( $t === null ) {
- return ''; // invalid title given
- }
-
- // get subpages:
- $subpages = SubpageInfo::getSubpages( $t, $depth );
-
- // filter by filter criterion:
- $subpages = self::filterSiteList( $subpages, $filter );
-
- return count( $subpages );
- }
-
- static function pf_toplevelpage( &$parser /* , $title = null */ ) {
- $t = self::newTitleObject( $parser, func_get_args() );
- if( $t === null ) {
- return ''; // invalid title given
- }
-
- //get all parents because the toplevel is the highest existing
parent:
- $parentpages = SubpageInfo::getAncestorPages( $t );
-
- if( ! empty( $parentpages ) ) {
- return wfEscapeWikiText(
$parentpages[0]->getPrefixedText() );
- }
- else {
- ////no parent! The page itself is the top level:
- return wfEscapeWikiText( $t->getPrefixedText() );
- }
- }
-
-
- /**** All the SubpageFunctions for use with MW Variables on the current
page ****/
-
- static function onParserGetVariableValueSwitch( Parser &$parser,
&$cache, &$magicWordId, &$ret, $frame = null ) {
- return self::variableValueSwitch( $parser, $magicWordId, $ret );
- }
-
- /**
- * Make 'Parser Fun' extensions 'THIS' function work with our
variables/functions
- */
- static function onGetThisVariableValueSwitch( Parser &$parser, Title
$title, &$magicWordId, &$ret, PPFrame $frame, array $args ) {
- $expArgs = array();
- foreach( $args as $arg ) {
- $expArgs[] = trim( $frame->expand( $arg ) );
- }
- $expArgs[] = '1=' . $title->getPrefixedText();
-
- return self::variableValueSwitch( $parser, $magicWordId, $ret,
$expArgs );
- }
-
- /**
- * Where value assigning for normal variables and 'Parser Fun'
extensions 'THIS' come together
- */
- private static function variableValueSwitch( Parser &$parser,
$magicWordId, &$ret, $args = array() ) {
- // function to call
- $func = null;
-
- switch( $magicWordId ) {
- /** SUBPAGETITLE **/
- case self::MAG_SUBPAGETITLE:
- $func = 'pf_subpagetitle';
- break;
- /** SUBPAGES **/
- case self::MAG_SUBPAGES:
- $func = 'pf_subpages';
- break;
- /** PARENTPAGES **/
- case self::MAG_PARENTPAGES:
- $func = 'pf_parentpages';
- break;
- /** SIBLINGPAGES **/
- case self::MAG_SIBLINGPAGES:
- $func = 'pf_siblingpages';
- break;
- /** SUBPAGELEVEL **/
- case self::MAG_SUBPAGELEVEL:
- $func = 'pf_subpagelevel';
- break;
- /** NUMBEROFSUBPAGES **/
- case self::MAG_NUMBEROFSUBPAGES:
- $func = 'pf_numberofsubpages';
- break;
- /** TOPLEVELPAGE **/
- case self::MAG_TOPLEVELPAGE:
- $func = 'pf_toplevelpage';
- break;
- }
- if( $func !== null ) {
- $args = array_merge( array( &$parser ), $args ); //
$parser as first argument!
- $ret = call_user_func_array( array( __CLASS__, $func ),
$args );
- }
-
- return true;
- }
-
- static function onMagicWordwgVariableIDs( &$customVariableIds ) {
- // register variable ids:
- $customVariableIds[] = self::MAG_SUBPAGETITLE;
- $customVariableIds[] = self::MAG_SUBPAGES;
- $customVariableIds[] = self::MAG_PARENTPAGES;
- $customVariableIds[] = self::MAG_SIBLINGPAGES;
- $customVariableIds[] = self::MAG_SUBPAGELEVEL;
- $customVariableIds[] = self::MAG_NUMBEROFSUBPAGES;
- $customVariableIds[] = self::MAG_TOPLEVELPAGE;
-
- return true;
- }
-
+if ( function_exists( 'wfLoadExtension' ) ) {
+ wfLoadExtension( 'SubpageFun' );
+ wfWarn(
+ 'Deprecated PHP entry point used for SubpageFun extension. ' .
+ 'Please use wfLoadExtension instead, ' .
+ 'see https://www.mediawiki.org/wiki/Extension_registration for
more details.'
+ );
+} else {
+ die( 'This version of the SubpageFun extension requires MediaWiki
1.29+' );
}
diff --git a/extension.json b/extension.json
new file mode 100644
index 0000000..720ae52
--- /dev/null
+++ b/extension.json
@@ -0,0 +1,25 @@
+{
+ "name": "SubpageFun",
+ "version": "0.6.0",
+ "author": [
+ "[http://www.mediawiki.org/wiki/User:Danwe Daniel Werner]"
+ ],
+ "type": "parserhook",
+ "url": "https://www.mediawiki.org/wiki/Extension:SubpageFun";,
+ "descriptionmsg": "subpagefun-desc",
+ "license-name": "GPL-2.0+",
+ "AutoloadClasses": {
+ "SubpageInfo": "SFun_SubpageInfo.php",
+ "SubpageFunHooks": "SubPageFun.hooks.php"
+ },
+ "MessagesDirs": {
+ "SubpageFun": [
+ "i18n"
+ ]
+ },
+ "ExtensionMessagesFiles": {
+ "SubpageFun": "SubpageFun.i18n.php",
+ "SubpageFunAlias": "SubpageFun.i18n.php"
+ },
+ "manifest_version": 2
+}
--
To view, visit https://gerrit.wikimedia.org/r/374971
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I6b4502a28b7ab7743b69d997cd613398c05286c5
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/SubpageFun
Gerrit-Branch: master
Gerrit-Owner: Reception123 <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
