Seb35 has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/342762 )
Change subject: Documentation ...................................................................... Documentation Fix phpDoc errors Change-Id: I2142530d4c811b28156f2f331c94a21cf1c1149e --- M bin/mwcomposer.php M bin/mwscript.php M bin/validate-schema.php M src/AbstractMediaWikiFarmScript.php M src/MediaWikiFarm.php M src/MediaWikiFarmComposerAutoloader.php M src/MediaWikiFarmComposerScript.php M src/MediaWikiFarmScript.php M src/Yaml.php M src/main.php M www/api.php M www/img_auth.php M www/index.php M www/load.php M www/opensearch_desc.php 15 files changed, 29 insertions(+), 2 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MediaWikiFarm refs/changes/62/342762/1 diff --git a/bin/mwcomposer.php b/bin/mwcomposer.php index 97dbeca..c1372fc 100644 --- a/bin/mwcomposer.php +++ b/bin/mwcomposer.php @@ -2,6 +2,7 @@ /** * Wrapper around Composer to create as many autoloaders as MediaWiki extensions. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/bin/mwscript.php b/bin/mwscript.php index 14751bf..1767d71 100644 --- a/bin/mwscript.php +++ b/bin/mwscript.php @@ -2,6 +2,7 @@ /** * Entry point for CLI scripts in the context of a MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/bin/validate-schema.php b/bin/validate-schema.php index 758b5a6..b4aa8cc 100644 --- a/bin/validate-schema.php +++ b/bin/validate-schema.php @@ -3,6 +3,8 @@ * Validate the files 'config/farms.[yml|json|php]' against 'docs/farms-schema.json'. * * This files is mostly inspired from the README https://github.com/justinrainbow/json-schema + * + * @package MediaWikiFarm */ // @codeCoverageIgnoreStart diff --git a/src/AbstractMediaWikiFarmScript.php b/src/AbstractMediaWikiFarmScript.php index ea407a4..8ef2bf7 100644 --- a/src/AbstractMediaWikiFarmScript.php +++ b/src/AbstractMediaWikiFarmScript.php @@ -2,6 +2,7 @@ /** * Script class. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/src/MediaWikiFarm.php b/src/MediaWikiFarm.php index 89e60aa..5339e58 100644 --- a/src/MediaWikiFarm.php +++ b/src/MediaWikiFarm.php @@ -2,6 +2,7 @@ /** * Class MediaWikiFarm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure @@ -186,6 +187,7 @@ * @mediawikifarm-const * * @param string|null $key Key of the wanted section or null for the whole array. + * @param string|null $key2 Subkey (specific to each entry) or null for the whole entry. * @return array MediaWiki configuration, either entire, either a part depending on the parameter. */ function getConfiguration( $key = null, $key2 = null ) { @@ -219,6 +221,7 @@ * @param string $entryPoint Name of the entry point, e.g. 'index.php', 'load.php'… * @param string|null $host Host name (string) or null to use the global variables HTTP_HOST or SERVER_NAME. * @param array $state Parameters, see object property $state. + * @param array $environment Environment which determines a given configuration. * @return string $entryPoint Identical entry point as passed in input. */ static function load( $entryPoint = '', $host = null, $state = array(), $environment = array() ) { diff --git a/src/MediaWikiFarmComposerAutoloader.php b/src/MediaWikiFarmComposerAutoloader.php index 41a8752..a6edfda 100644 --- a/src/MediaWikiFarmComposerAutoloader.php +++ b/src/MediaWikiFarmComposerAutoloader.php @@ -1,8 +1,9 @@ <?php +/** + * Composer autoloader @generated by MediaWikiFarm. + */ -// autoload.php @generated by MediaWikiFarm // @codeCoverageIgnoreStart - if( array_key_exists( 'wgMediaWikiFarm', $GLOBALS ) ) { $extensions = $GLOBALS['wgMediaWikiFarm']->getConfiguration( 'composer' ); foreach( $extensions as $extension ) { diff --git a/src/MediaWikiFarmComposerScript.php b/src/MediaWikiFarmComposerScript.php index ae3c9d9..f46e232 100644 --- a/src/MediaWikiFarmComposerScript.php +++ b/src/MediaWikiFarmComposerScript.php @@ -2,6 +2,7 @@ /** * Wrapper around Composer to create as many autoloaders as MediaWiki extensions. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure @@ -264,6 +265,15 @@ self::rmdirr( $tmpDir . '/mediawiki' ); } + /** + * Mapping between a Composer key and a MediaWikiFarm key. + * + * The MediaWikiFarm key is the canonical MediaWiki name prefixed by "Extension" or "Skin". + * + * @param string $name Name of a Composer package. + * @param string $type Composer type. + * @return string MediaWikiFarm key. + */ static function composer2mediawiki( $name, $type ) { $name = explode( '/', $name ); diff --git a/src/MediaWikiFarmScript.php b/src/MediaWikiFarmScript.php index b7f8bdf..6e6fa42 100644 --- a/src/MediaWikiFarmScript.php +++ b/src/MediaWikiFarmScript.php @@ -2,6 +2,7 @@ /** * Wrapper around MediaWiki scripts. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/src/Yaml.php b/src/Yaml.php index 9ee730c..e683f22 100644 --- a/src/Yaml.php +++ b/src/Yaml.php @@ -6,6 +6,7 @@ * It was splitted from the main class MediaWikiFarm to ensure compatibility with * PHP 5.2 (which doesn’t understand namespaces). * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/src/main.php b/src/main.php index 0d87861..a836cf8 100644 --- a/src/main.php +++ b/src/main.php @@ -2,6 +2,7 @@ /** * Main program, creating the MediaWikiFarm object, then loading MediaWiki configuration. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/www/api.php b/www/api.php index 5370c46..fef1650 100644 --- a/www/api.php +++ b/www/api.php @@ -2,6 +2,7 @@ /** * Entry point api.php in the context of a multiversion MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/www/img_auth.php b/www/img_auth.php index 1de2142..04e9c84 100644 --- a/www/img_auth.php +++ b/www/img_auth.php @@ -2,6 +2,7 @@ /** * Entry point img_auth.php in the context of a multiversion MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/www/index.php b/www/index.php index 71e11fa..fc06ae2 100644 --- a/www/index.php +++ b/www/index.php @@ -2,6 +2,7 @@ /** * Entry point index.php in the context of a multiversion MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/www/load.php b/www/load.php index f865696..7d8e265 100644 --- a/www/load.php +++ b/www/load.php @@ -2,6 +2,7 @@ /** * Entry point load.php in the context of a multiversion MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure diff --git a/www/opensearch_desc.php b/www/opensearch_desc.php index b156d4b..97fc02f 100644 --- a/www/opensearch_desc.php +++ b/www/opensearch_desc.php @@ -2,6 +2,7 @@ /** * Entry point opensearch_desc.php in the context of a multiversion MediaWiki farm. * + * @package MediaWikiFarm * @author Sébastien Beyou ~ Seb35 <se...@seb35.fr> * @license GPL-3.0+ GNU General Public License v3.0 ou version ultérieure * @license AGPL-3.0+ GNU Affero General Public License v3.0 ou version ultérieure -- To view, visit https://gerrit.wikimedia.org/r/342762 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I2142530d4c811b28156f2f331c94a21cf1c1149e Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/MediaWikiFarm Gerrit-Branch: master Gerrit-Owner: Seb35 <se...@seb35.fr> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
