jenkins-bot has submitted this change and it was merged. Change subject: Add typehints & phpdoc in ApiParsoidBatch ......................................................................
Add typehints & phpdoc in ApiParsoidBatch Change-Id: I4781192722582eacd624618e8a79768967da8e92 --- M includes/ApiParsoidBatch.php 1 file changed, 40 insertions(+), 10 deletions(-) Approvals: Legoktm: Looks good to me, approved jenkins-bot: Verified diff --git a/includes/ApiParsoidBatch.php b/includes/ApiParsoidBatch.php index c285034..360fe9a 100644 --- a/includes/ApiParsoidBatch.php +++ b/includes/ApiParsoidBatch.php @@ -99,7 +99,7 @@ ApiResult::NO_VALIDATE ); } - protected function assertScalar( $array, $key ) { + protected function assertScalar( array $array, $key ) { if ( !isset( $array[$key] ) ) { $this->dieUsage( "The $key parameter is required", @@ -112,7 +112,7 @@ } } - protected function assertScalarOrMissing( $array, $key ) { + protected function assertScalarOrMissing( array $array, $key ) { if ( isset( $array[$key] ) && !is_scalar( $array[$key] ) ) { $this->dieUsage( "The $key parameter must be a scalar", @@ -120,7 +120,7 @@ } } - protected function assertArray( $array, $key ) { + protected function assertArray( array $array, $key ) { if ( !isset( $array[$key] ) ) { $this->dieUsage( "The $key parameter is required", @@ -133,7 +133,15 @@ } } - protected function parse( $text, $title ) { + /** + * @param string $text + * @param Title $title + * + * @return array + * @throws MWException + * @throws MWUnknownContentModelException + */ + protected function parse( $text, Title $title ) { global $wgParser; $contentHandler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT ); @@ -149,7 +157,16 @@ ); } - protected function preprocess( $text, $title, $revid ) { + /** + * @param string $text + * @param Title $title + * @param int|bool $revid + * + * @return array + * @throws MWException + * @throws MWUnknownContentModelException + */ + protected function preprocess( $text, Title $title, $revid ) { global $wgParser; $contentHandler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT ); @@ -166,7 +183,7 @@ ); } - protected function formatCategoryLinks( $links ) { + protected function formatCategoryLinks( array $links ) { $result = array(); foreach ( $links as $link => $sortkey ) { $result[] = array( @@ -177,7 +194,7 @@ return $result; } - protected function formatProperties( $props ) { + protected function formatProperties( array $props ) { $result = array(); foreach ( $props as $name => $value ) { $result[] = array( @@ -188,7 +205,14 @@ return $result; } - protected function imageinfo( $filename, $file, $txopts ) { + /** + * @param string $filename + * @param File|null $file + * @param array $txopts + * + * @return array|null + */ + protected function imageinfo( $filename, $file, array $txopts ) { if ( !$file ) { // Short return code for missing images return null; @@ -197,7 +221,7 @@ 'width' => $file->getWidth(), 'height' => $file->getHeight(), 'mediatype' => $file->getMediaType(), - 'url' => wfExpandUrl( $file->getFullURL(), PROTO_CURRENT ), + 'url' => wfExpandUrl( $file->getFullUrl(), PROTO_CURRENT ), 'mustRender' => $file->mustRender() ); @@ -229,7 +253,13 @@ return $result; } - protected function makeTransformOptions( $file, $hp ) { + /** + * @param File $file + * @param array $hp + * + * @return array + */ + protected function makeTransformOptions( $file, array $hp ) { // Validate the input parameters like Parser::makeImage() $handler = $file->getHandler(); if ( !$handler ) { -- To view, visit https://gerrit.wikimedia.org/r/302349 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I4781192722582eacd624618e8a79768967da8e92 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/ParsoidBatchAPI Gerrit-Branch: master Gerrit-Owner: Addshore <addshorew...@gmail.com> Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits