jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/394752 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Depends-On: Icc8c9c934758c8d7101f93762288ba894f1cf015
Change-Id: I4d9c3495f3620d3c19fdde12ffd5ef7fd2604fbc
---
M .phpcs.xml
M includes/PF_AutoeditAPI.php
M includes/PF_FormEditAction.php
M includes/PF_FormField.php
M includes/PF_FormLinker.php
M includes/PF_FormPrinter.php
M includes/PF_FormUtils.php
M includes/PF_HelperFormAction.php
M includes/PF_Hooks.php
M includes/PF_PageSchemas.php
M includes/PF_ParserFunctions.php
M includes/PF_Template.php
M includes/PF_TemplateField.php
M includes/PF_TemplateInForm.php
M includes/PF_Utils.php
M includes/PF_ValuesUtils.php
M includes/forminputs/PF_CheckboxInput.php
M includes/forminputs/PF_CheckboxesInput.php
M includes/forminputs/PF_ComboBoxInput.php
M includes/forminputs/PF_DateInput.php
M includes/forminputs/PF_DatePickerInput.php
M includes/forminputs/PF_DateTimeInput.php
M includes/forminputs/PF_DateTimePicker.php
M includes/forminputs/PF_DropdownInput.php
M includes/forminputs/PF_FormInput.php
M includes/forminputs/PF_GoogleMapsInput.php
M includes/forminputs/PF_LeafletInput.php
M includes/forminputs/PF_ListBoxInput.php
M includes/forminputs/PF_OpenLayersInput.php
M includes/forminputs/PF_RadioButtonInput.php
M includes/forminputs/PF_RatingInput.php
M includes/forminputs/PF_RegExpInput.php
M includes/forminputs/PF_TextAreaInput.php
M includes/forminputs/PF_TextInput.php
M includes/forminputs/PF_TextWithAutocompleteInput.php
M includes/forminputs/PF_TimePickerInput.php
M includes/forminputs/PF_TokensInput.php
M includes/forminputs/PF_Tree.php
M includes/forminputs/PF_TreeInput.php
M includes/forminputs/PF_YearInput.php
M specials/PF_CreateForm.php
M specials/PF_FormStart.php
M specials/PF_UploadWindow.php
43 files changed, 351 insertions(+), 90 deletions(-)
Approvals:
jenkins-bot: Verified
Thiemo Kreuz (WMDE): Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index ca7cba2..76446a7 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -17,10 +17,7 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
</rule>
<rule ref="MediaWiki.NamingConventions.PrefixedGlobalFunctions">
diff --git a/includes/PF_AutoeditAPI.php b/includes/PF_AutoeditAPI.php
index 5e47b9c..09ec5ec 100644
--- a/includes/PF_AutoeditAPI.php
+++ b/includes/PF_AutoeditAPI.php
@@ -54,7 +54,7 @@
}
/**
- * Returns the options array
+ * @return array
*/
function getOptions() {
return $this->mOptions;
@@ -73,14 +73,15 @@
}
/**
- * Sets the options array
+ * @param array $options
*/
function setOptions( $options ) {
$this->mOptions = $options;
}
/**
- * Sets an option in the options array
+ * @param string $option
+ * @param mixed $value
*/
function setOption( $option, $value ) {
$this->mOptions[$option] = $value;
@@ -727,6 +728,8 @@
/**
* Helper function..
+ * @param Title $title
+ * @return string
*/
function getTextForPage( $title ) {
$wikiPage = WikiPage::factory( $title );
@@ -1076,11 +1079,11 @@
/**
* This function recursively inserts the value into a tree.
*
- * @param $array is root
- * @param $key identifies path to position in tree.
+ * @param array &$array is root
+ * @param string $key identifies path to position in tree.
* Format: 1stLevelName[2ndLevel][3rdLevel][...], i.e. normal array
notation
- * @param $value: the value to insert
- * @param $toplevel: if this is a toplevel value.
+ * @param mixed $value the value to insert
+ * @param bool $toplevel if this is a toplevel value.
*/
public static function addToArray( &$array, $key, $value, $toplevel =
true ) {
$matches = array();
@@ -1174,7 +1177,7 @@
/**
* Returns the description string for this module
*
- * @return mixed string or array of strings
+ * @return string|string[]
*/
function getDescription() {
return <<<END
@@ -1191,7 +1194,7 @@
/**
* Returns usage examples for this module.
*
- * @return mixed string or array of strings
+ * @return string|string[]
*/
protected function getExamples() {
return array(
diff --git a/includes/PF_FormEditAction.php b/includes/PF_FormEditAction.php
index f5f365a..5e93b16 100644
--- a/includes/PF_FormEditAction.php
+++ b/includes/PF_FormEditAction.php
@@ -26,6 +26,7 @@
* output. Do not use globals $wgOut, $wgRequest, etc, in
implementations; use
* $this->getOutput(), etc.
* @throws ErrorPageError
+ * @return false
*/
public function show() {
return self::displayForm( $this, $this->page );
@@ -33,7 +34,7 @@
/**
* Execute the action in a silent fashion: do not display anything or
release any errors.
- * @return Bool whether execution was successful
+ * @return bool whether execution was successful
*/
public function execute() {
return true;
@@ -42,6 +43,9 @@
/**
* Adds an "action" (i.e., a tab) to edit the current article with
* a form
+ * @param Title $obj
+ * @param array &$content_actions
+ * @return true
*/
static function displayTab( $obj, &$content_actions ) {
if ( method_exists( $obj, 'getTitle' ) ) {
@@ -142,6 +146,9 @@
/**
* Like displayTab(), but called with a different hook - this one is
* called for the 'Vector' skin, and some others.
+ * @param Title $obj
+ * @param array &$links
+ * @return true
*/
static function displayTab2( $obj, &$links ) {
// the old '$content_actions' array is thankfully just a
@@ -223,6 +230,7 @@
* creating a page in a namespace that has a form, this interface
probably won't
* get called anyway; and #default_form calls for individual pages are
* (hopefully) pretty rare.
+ * @return int[]
*/
static function getNumPagesPerForm() {
$dbr = wfGetDB( DB_SLAVE );
@@ -276,6 +284,9 @@
/**
* The function called if we're in index.php (as opposed to one of the
* special pages)
+ * @param Action $action
+ * @param Article $article
+ * @return true
*/
static function displayForm( $action, $article ) {
$output = $action->getOutput();
diff --git a/includes/PF_FormField.php b/includes/PF_FormField.php
index 535655b..6a2c093 100644
--- a/includes/PF_FormField.php
+++ b/includes/PF_FormField.php
@@ -606,6 +606,8 @@
/**
* Map a label back to a value.
+ * @param string $label
+ * @return string
*/
function labelToValue( $label ) {
$value = array_search( $label, $this->mPossibleValues );
@@ -618,6 +620,9 @@
/**
* Map a template field value into labels.
+ * @param string $valueString
+ * @param string $delimiter
+ * @return string|string[]
*/
public function valueStringToLabels( $valueString, $delimiter ) {
if ( strlen( trim( $valueString ) ) === 0 ||
@@ -837,6 +842,8 @@
* create HTML inputs, most arguments are contained in the "$other_args"
* array - create this array, using the attributes of this form
* field and the template field it corresponds to, if any.
+ * @param array|null $default_args
+ * @return array
*/
function getArgumentsForInputCall( $default_args = null ) {
// start with the arguments array already defined
diff --git a/includes/PF_FormLinker.php b/includes/PF_FormLinker.php
index f6d6d95..4f09809 100644
--- a/includes/PF_FormLinker.php
+++ b/includes/PF_FormLinker.php
@@ -75,6 +75,13 @@
/**
* Sets the URL for form-based creation of a nonexistent (broken-linked,
* AKA red-linked) page
+ * @param Linker $linker
+ * @param Title $target
+ * @param array $options
+ * @param string $text
+ * @param array &$attribs
+ * @param bool &$ret
+ * @return true
*/
static function setBrokenLink( $linker, $target, $options, $text,
&$attribs, &$ret ) {
// If it's not a broken (red) link, exit.
@@ -103,6 +110,8 @@
* - the default form(s) for a category that this article belongs to,
* if there are any; or
* - the default form(s) for the article's namespace, if there are any.
+ * @param Title $title
+ * @return array
*/
static function getDefaultFormsForPage( $title ) {
// See if the page itself has a default form (or forms), and
diff --git a/includes/PF_FormPrinter.php b/includes/PF_FormPrinter.php
index a2044af..d1db04f 100644
--- a/includes/PF_FormPrinter.php
+++ b/includes/PF_FormPrinter.php
@@ -245,6 +245,8 @@
/**
* Show the set of previous deletions for the page being edited.
+ * @param OutputPage $out
+ * @return true
*/
function showDeletionLog( $out ) {
LogEventsList::showLogExtract( $out, 'delete',
$this->mPageTitle->getPrefixedText(),
@@ -263,6 +265,10 @@
* http://www.php.net/manual/en/function.str-replace.php#86177
* - this might make sense in the PFUtils class, if it's useful in
* other places.
+ * @param string $search
+ * @param string $replace
+ * @param string $subject
+ * @return string
*/
function strReplaceFirst( $search, $replace, $subject ) {
$firstChar = strpos( $subject, $search );
@@ -303,6 +309,9 @@
/**
* Creates the HTML for the inner table for every instance of a
* multiple-instance template in the form.
+ * @param bool $form_is_disabled
+ * @param string $mainText
+ * @return string
*/
function multipleTemplateInstanceTableHTML( $form_is_disabled,
$mainText ) {
if ( $form_is_disabled ) {
@@ -329,6 +338,10 @@
/**
* Creates the HTML for a single instance of a multiple-instance
* template.
+ * @param PFTemplateInForm $template_in_form
+ * @param bool $form_is_disabled
+ * @param string &$section
+ * @return string
*/
function multipleTemplateInstanceHTML( $template_in_form,
$form_is_disabled, &$section ) {
// Add the character "a" onto the instance number of this input
@@ -364,6 +377,10 @@
/**
* Creates the end of the HTML for a multiple-instance template -
* including the sections necessary for adding additional instances.
+ * @param PFTemplateInForm $template_in_form
+ * @param bool $form_is_disabled
+ * @param string $section
+ * @return string
*/
function multipleTemplateEndHTML( $template_in_form, $form_is_disabled,
$section ) {
global $wgPageFormsTabIndex;
@@ -508,6 +525,9 @@
/**
* Get a string representing the current time, for the time zone
* specified in the wiki.
+ * @param string $includeTime
+ * @param string $includeTimezone
+ * @return string
*/
function getStringForCurrentTime( $includeTime, $includeTimezone ) {
global $wgLocaltimezone, $wgAmericanDates,
$wgPageForms24HourTime;
@@ -560,6 +580,9 @@
* If the value passed in for a certain field, when a form is
* submitted, is an array, then it might be from a checkbox
* or date input - in that case, convert it into a string.
+ * @param string $value
+ * @param string $delimiter
+ * @return string
*/
static function getStringFromPassedInArray( $value, $delimiter ) {
// If it's just a regular list, concatenate it.
@@ -665,6 +688,16 @@
*
* It also does some related tasks, like figuring out the page name (if
* only a page formula exists).
+ * @param string $form_def
+ * @param bool $form_submitted
+ * @param bool $source_is_page
+ * @param string|null $form_id
+ * @param string|null $existing_page_content
+ * @param string|null $page_name
+ * @param string|null $page_name_formula
+ * @param bool $is_query
+ * @param bool $is_embedded
+ * @return array
*/
function formHTML(
$form_def,
@@ -1587,6 +1620,9 @@
/**
* Create the HTML to display this field within a form.
+ * @param PFFormField $form_field
+ * @param string $cur_value
+ * @return string
*/
function formFieldHTML( $form_field, $cur_value ) {
global $wgPageFormsFieldNum;
diff --git a/includes/PF_FormUtils.php b/includes/PF_FormUtils.php
index af90559..80ac3df 100644
--- a/includes/PF_FormUtils.php
+++ b/includes/PF_FormUtils.php
@@ -18,6 +18,8 @@
/**
* Add a hidden input for each field in the template call that's
* not handled by the form itself
+ * @param PFTemplateInForm|null $template_in_form
+ * @return string
*/
static function unhandledFieldsHTML( $template_in_form ) {
// This shouldn't happen, but sometimes this value is null.
@@ -135,6 +137,11 @@
/**
* Helper function to display a simple button
+ * @param string $name
+ * @param string $value
+ * @param string $type
+ * @param array $attrs
+ * @return string
*/
static function buttonHTML( $name, $value, $type, $attrs ) {
return "\t\t" . Html::input( $name, $value, $type, $attrs ) .
"\n";
@@ -327,6 +334,7 @@
/**
* Used by 'RunQuery' page
+ * @return string
*/
static function queryFormBottom() {
return self::runQueryButtonHTML( false );
@@ -352,6 +360,10 @@
/**
* Parse the form definition and return it
+ * @param Parser $parser
+ * @param string|null $form_def
+ * @param string|null $form_id
+ * @return string
*/
public static function getFormDefinition( Parser $parser, $form_def =
null, $form_id = null ) {
if ( $form_id !== null ) {
@@ -435,6 +447,9 @@
/**
* Get a form definition from cache
+ * @param string $form_id
+ * @param Parser $parser
+ * @return string|null
*/
protected static function getFormDefinitionFromCache( $form_id, Parser
$parser ) {
global $wgPageFormsCacheFormDefinitions;
@@ -465,6 +480,9 @@
/**
* Store a form definition in cache
+ * @param string $form_id
+ * @param string $form_def
+ * @param Parser $parser
*/
protected static function cacheFormDefinition( $form_id, $form_def,
Parser $parser ) {
global $wgPageFormsCacheFormDefinitions;
@@ -537,6 +555,7 @@
/**
* Get the cache object used by the form cache
+ * @return BagOStuff
*/
public static function getFormCache() {
global $wgPageFormsFormCacheType, $wgParserCacheType;
@@ -562,6 +581,9 @@
/**
* Get section header HTML
+ * @param string $header_name
+ * @param int $header_level
+ * @return string
*/
static function headerHTML( $header_name , $header_level = 2 ) {
global $wgPageFormsTabIndex;
@@ -583,6 +605,10 @@
/**
* Get the changed index if a new template or section was
* inserted before the end, or one was deleted in the form
+ * @param int $i
+ * @param int|null $new_item_loc
+ * @param int|null $deleted_item_loc
+ * @return int
*/
static function getChangedIndex( $i, $new_item_loc, $deleted_item_loc )
{
$old_i = $i;
diff --git a/includes/PF_HelperFormAction.php b/includes/PF_HelperFormAction.php
index 7995191..7541229 100644
--- a/includes/PF_HelperFormAction.php
+++ b/includes/PF_HelperFormAction.php
@@ -23,6 +23,7 @@
* output. Do not use globals $wgOut, $wgRequest, etc, in
implementations; use
* $this->getOutput(), etc.
* @throws ErrorPageError
+ * @return false
*/
public function show() {
return self::displayForm( $this, $this->page );
@@ -39,6 +40,9 @@
/**
* Adds an "action" (i.e., a tab) to edit the current article with
* a form
+ * @param Title $obj
+ * @param array &$content_actions
+ * @return bool
*/
static function displayTab( $obj, &$content_actions ) {
if ( method_exists( $obj, 'getTitle' ) ) {
@@ -126,6 +130,9 @@
/**
* Like displayTab(), but called with a different hook - this one is
* called for the 'Vector' skin, and others.
+ * @param Title $obj
+ * @param array &$links
+ * @return bool
*/
static function displayTab2( $obj, &$links ) {
// the old '$content_actions' array is thankfully just a
@@ -136,6 +143,9 @@
/**
* The function called if we're in index.php (as opposed to one of the
* special pages).
+ * @param string $action
+ * @param Article $article
+ * @return false
*/
static function displayForm( $action, $article ) {
$title = $article->getTitle();
diff --git a/includes/PF_Hooks.php b/includes/PF_Hooks.php
index 7cf1f99..1ca3ca2 100644
--- a/includes/PF_Hooks.php
+++ b/includes/PF_Hooks.php
@@ -270,6 +270,7 @@
* Hook to add PHPUnit test cases.
* From
https://www.mediawiki.org/wiki/Manual:PHP_unit_testing/Writing_unit_tests_for_extensions
*
+ * @param string[] &$files
* @return bool
*/
public static function onUnitTestsList( &$files ) {
diff --git a/includes/PF_PageSchemas.php b/includes/PF_PageSchemas.php
index db903c7..d581d1d 100644
--- a/includes/PF_PageSchemas.php
+++ b/includes/PF_PageSchemas.php
@@ -19,6 +19,9 @@
/**
* Creates an object to hold form-wide information, based on an XML
* object from the Page Schemas extension.
+ * @param string $tagName
+ * @param string $xml
+ * @return string[]|null
*/
public static function createPageSchemasObject( $tagName, $xml ) {
$pfarray = array();
@@ -81,6 +84,7 @@
/**
* Creates Page Schemas XML for form-wide information.
+ * @return string
*/
public static function createSchemaXMLFromForm() {
global $wgRequest;
@@ -163,6 +167,7 @@
/**
* Creates Page Schemas XML from form information on templates.
+ * @return string[]
*/
public static function createTemplateXMLFromForm() {
global $wgRequest;
@@ -190,6 +195,7 @@
/**
* Creates Page Schemas XML for form fields.
+ * @return string[]
*/
public static function createFieldXMLFromForm() {
global $wgRequest;
@@ -229,6 +235,7 @@
/**
* Creates Page Schemas XML for page sections
+ * @return string[]
*/
public static function createPageSectionXMLFromForm() {
global $wgRequest;
@@ -404,6 +411,8 @@
/**
* Returns the HTML for inputs to define a single form field,
* within the Page Schemas 'edit schema' page.
+ * @param PFField $psField
+ * @return array
*/
public static function getFieldEditingHTML( $psField ) {
$fieldValues = array();
@@ -589,6 +598,8 @@
/**
* Return the list of pages that Page Forms could generate from
* the current Page Schemas schema.
+ * @param PFPageSchemas $pageSchemaObj
+ * @return Title[]
*/
public static function getPagesToGenerate( $pageSchemaObj ) {
$psTemplates = $pageSchemaObj->getTemplates();
@@ -608,6 +619,8 @@
/**
* Returns an array of PFTemplateField objects, representing the fields
* of a template, based on the contents of a <PageSchema> tag.
+ * @param PFTemplate $psTemplate
+ * @return PFTemplateField[]
*/
public static function getFieldsFromTemplateSchema( $psTemplate ) {
$psFields = $psTemplate->getFields();
@@ -655,6 +668,11 @@
/**
* Creates a form page, when called from the 'generatepages' page
* of Page Schemas.
+ * @param string $formName
+ * @param string $formTitle
+ * @param array $formItems
+ * @param array $formDataFromSchema
+ * @param string $categoryName
*/
public static function generateForm( $formName, $formTitle,
$formItems, $formDataFromSchema, $categoryName ) {
@@ -714,6 +732,8 @@
/**
* Generate pages (form and templates) specified in the list.
+ * @param PageSchemas $pageSchemaObj
+ * @param array $selectedPages
*/
public static function generatePages( $pageSchemaObj, $selectedPages ) {
global $wgUser;
@@ -881,6 +901,8 @@
/**
* Displays form details for one template in the Page Schemas XML.
+ * @param string $templateXML
+ * @return null|array
*/
public static function getTemplateDisplayValues( $templateXML ) {
$templateValues = self::getTemplateValues( $templateXML );
@@ -910,6 +932,8 @@
/**
* Displays data on a single form input in the Page Schemas XML.
+ * @param Node $fieldXML
+ * @return array|null
*/
public static function getFieldDisplayValues( $fieldXML ) {
foreach ( $fieldXML->children() as $tag => $child ) {
diff --git a/includes/PF_ParserFunctions.php b/includes/PF_ParserFunctions.php
index 5ffc216..50ffd29 100644
--- a/includes/PF_ParserFunctions.php
+++ b/includes/PF_ParserFunctions.php
@@ -381,6 +381,10 @@
/**
* {{#arraymap:value|delimiter|var|formula|new_delimiter}}
+ * @param Parser &$parser
+ * @param PPFrame $frame
+ * @param array $args
+ * @return string
*/
public static function renderArrayMap( &$parser, $frame, $args ) {
// Set variables.
@@ -423,6 +427,10 @@
/**
* {{#arraymaptemplate:value|template|delimiter|new_delimiter}}
+ * @param Parser &$parser
+ * @param PPFrame $frame
+ * @param array $args
+ * @return string
*/
public static function renderArrayMapTemplate( &$parser, $frame, $args
) {
// Set variables.
diff --git a/includes/PF_Template.php b/includes/PF_Template.php
index a8859d5..6de0603 100644
--- a/includes/PF_Template.php
+++ b/includes/PF_Template.php
@@ -177,6 +177,9 @@
* For a field name and its attached property name located in the
* template text, create an PFTemplateField object out of it, and
* add it to $this->mTemplateFields.
+ * @param string $fieldName
+ * @param string $propertyName
+ * @param bool $isList
*/
function loadPropertySettingInTemplate( $fieldName, $propertyName,
$isList ) {
global $wgContLang;
@@ -362,6 +365,7 @@
* Creates the text of a template, when called from
* Special:CreateTemplate, Special:CreateClass or the Page Schemas
* extension.
+ * @return string
*/
public function createText() {
// Avoid PHP 7.1 warning from passing $this by reference
diff --git a/includes/PF_TemplateField.php b/includes/PF_TemplateField.php
index 5f2dab3..f51ceb6 100644
--- a/includes/PF_TemplateField.php
+++ b/includes/PF_TemplateField.php
@@ -91,6 +91,7 @@
/**
* Called if a matching property is found for a template field when
* a template is parsed during the creation of a form.
+ * @param string $semantic_property
*/
function setSemanticProperty( $semantic_property ) {
$this->mSemanticProperty = str_replace( '\\', '',
$semantic_property );
@@ -102,6 +103,9 @@
/**
* Equivalent to setSemanticProperty(), but called when using Cargo
* instead of SMW.
+ * @param string $tableName
+ * @param string $fieldName
+ * @param string|null $fieldDescription
*/
function setCargoFieldData( $tableName, $fieldName, $fieldDescription =
null ) {
$this->mCargoTable = $tableName;
diff --git a/includes/PF_TemplateInForm.php b/includes/PF_TemplateInForm.php
index 77284f0..d0bc1fa 100644
--- a/includes/PF_TemplateInForm.php
+++ b/includes/PF_TemplateInForm.php
@@ -347,6 +347,7 @@
* Set some vars based on the current contents of the page being
* edited - or at least vars that only need to be set if there's
* an existing page.
+ * @param string $existing_page_content
*/
function setPageRelatedInfo( $existing_page_content ) {
// Replace underlines with spaces in template name, to allow for
diff --git a/includes/PF_Utils.php b/includes/PF_Utils.php
index 360cc15..35118eb 100644
--- a/includes/PF_Utils.php
+++ b/includes/PF_Utils.php
@@ -11,6 +11,12 @@
/**
* Helper function for backward compatibility.
+ * @param LinkRenderer $linkRenderer
+ * @param string $title
+ * @param string|null $msg
+ * @param array $attrs
+ * @param array $params
+ * @return string
*/
public static function makeLink( $linkRenderer, $title, $msg = null,
$attrs = array(), $params = array() ) {
if ( !is_null( $linkRenderer ) ) {
@@ -25,6 +31,9 @@
/**
* Creates a link to a special page, using that page's top-level
description as the link text.
+ * @param LinkRenderer $linkRenderer
+ * @param string $specialPageName
+ * @return string
*/
public static function linkForSpecialPage( $linkRenderer,
$specialPageName ) {
$specialPage = SpecialPageFactory::getPage( $specialPageName );
@@ -36,6 +45,8 @@
* Creates the name of the page that appears in the URL;
* this method is necessary because Title::getPartialURL(), for
* some reason, doesn't include the namespace
+ * @param Title $title
+ * @return string
*/
public static function titleURLString( $title ) {
$namespace = $title->getNsText();
@@ -53,6 +64,8 @@
/**
* A very similar function to titleURLString(), to get the
* non-URL-encoded title string
+ * @param Title $title
+ * @return string
*/
public static function titleString( $title ) {
$namespace = $title->getNsText();
@@ -69,6 +82,8 @@
/**
* Gets the text contents of a page with the passed-in Title object.
+ * @param Title $title
+ * @return string|null
*/
public static function getPageText( $title ) {
$wikiPage = new WikiPage( $title );
@@ -83,6 +98,7 @@
/**
* Helper function to get the SMW data store for different versions
* of SMW.
+ * @return Store|null
*/
public static function getSMWStore() {
if ( class_exists( '\SMW\StoreFactory' ) ) {
@@ -97,6 +113,10 @@
/**
* Creates wiki-text for a link to a wiki page
+ * @param int $namespace
+ * @param string $name
+ * @param string|null $text
+ * @return string
*/
public static function linkText( $namespace, $name, $text = null ) {
$title = Title::makeTitleSafe( $namespace, $name );
@@ -114,6 +134,17 @@
* Prints the mini-form contained at the bottom of various pages, that
* allows pages to spoof a normal edit page, that can preview, save,
* etc.
+ * @param string $title
+ * @param string $page_contents
+ * @param string $edit_summary
+ * @param bool $is_save
+ * @param bool $is_preview
+ * @param bool $is_diff
+ * @param bool $is_minor_edit
+ * @param bool $watch_this
+ * @param string $start_time
+ * @param string $edit_time
+ * @return string
*/
public static function printRedirectForm(
$title,
@@ -183,6 +214,7 @@
* to display and work correctly.
*
* Accepts an optional Parser instance, or uses $wgOut if omitted.
+ * @param Parser $parser
*/
public static function addFormRLModules( $parser = null ) {
global $wgOut, $wgPageFormsSimpleUpload;
@@ -232,6 +264,7 @@
/**
* Returns an array of all form names on this wiki.
+ * @return string[]
*/
public static function getAllForms() {
$dbr = wfGetDB( DB_SLAVE );
@@ -251,6 +284,7 @@
/**
* Creates a dropdown of possible form names.
+ * @return string
*/
public static function formDropdownHTML() {
global $wgContLang;
@@ -266,6 +300,8 @@
/**
* A helper function, used by getFormTagComponents().
+ * @param string $s
+ * @return string
*/
public static function convertBackToPipes( $s ) {
return str_replace( "\1", '|', $s );
@@ -276,6 +312,8 @@
* but does not split on pipes that are contained within additional
* curly brackets, in case the tag contains any calls to parser
* functions or templates.
+ * @param string $string
+ * @return string[]
*/
static function smartSplitFormTag( $string ) {
if ( $string == '' ) {
@@ -312,6 +350,8 @@
* explode( '|', $str ), except that it doesn't split on pipes
* that are within parser function calls - i.e., pipes within
* double curly brackets.
+ * @param string $str
+ * @return string[]
*/
public static function getFormTagComponents( $str ) {
// Turn each pipe within double curly brackets into another,
@@ -327,6 +367,8 @@
/**
* Gets the word in the wiki's language for either the value 'yes' or
* 'no'.
+ * @param bool $isYes
+ * @return string
*/
public static function getWordForYesOrNo( $isYes ) {
// @TODO - should Page Forms define these messages itself?
diff --git a/includes/PF_ValuesUtils.php b/includes/PF_ValuesUtils.php
index e10ca7f..9ec6ac9 100644
--- a/includes/PF_ValuesUtils.php
+++ b/includes/PF_ValuesUtils.php
@@ -11,6 +11,11 @@
/**
* Helper function to handle getPropertyValues().
+ * @param Store $store
+ * @param Title $subject
+ * @param string $propID
+ * @param array $requestOptions
+ * @return array
*/
public static function getSMWPropertyValues( $store, $subject, $propID,
$requestOptions = null ) {
// If SMW is not installed, exit out.
@@ -48,6 +53,8 @@
* based on Title::getParentCategories(), but simpler
* - this function doubles as a function to get all categories on
* the site, if no article is specified
+ * @param Title $title
+ * @return array
*/
public static function getCategoriesForPage( $title = null ) {
$categories = array();
@@ -81,6 +88,8 @@
* because it uses the SMW data store, which can't perform
* case-insensitive queries; for queries with a substring, the
* function PFAutocompleteAPI::getAllValuesForProperty() exists.
+ * @param string $property_name
+ * @return array
*/
public static function getAllValuesForProperty( $property_name ) {
global $wgPageFormsMaxAutocompleteValues;
@@ -98,6 +107,9 @@
/**
* Used with the Cargo extension
+ * @param string $tableName
+ * @param string $fieldName
+ * @return array
*/
public static function getAllValuesForCargoField( $tableName,
$fieldName ) {
return self::getValuesForCargoField( $tableName, $fieldName );
@@ -105,6 +117,10 @@
/**
* Used with the Cargo extension
+ * @param string $tableName
+ * @param string $fieldName
+ * @param string|null $whereStr
+ * @return array
*/
public static function getValuesForCargoField( $tableName, $fieldName,
$whereStr = null ) {
global $wgPageFormsMaxLocalAutocompleteValues;
@@ -142,6 +158,10 @@
* Get all the pages that belong to a category and all its
* subcategories, down a certain number of levels - heavily based on
* SMW's SMWInlineQuery::includeSubcategories()
+ * @param string $top_category
+ * @param int $num_levels
+ * @param string|null $substring
+ * @return string
*/
public static function getAllPagesForCategory( $top_category,
$num_levels, $substring = null ) {
if ( 0 == $num_levels ) {
@@ -464,6 +484,9 @@
/**
* Creates an array of values that match the specified source name and
* type, for use by both Javascript autocompletion and comboboxes.
+ * @param string|null $source_name
+ * @param string $source_type
+ * @return string|null
*/
public static function getAutocompleteValues( $source_name,
$source_type ) {
if ( $source_name == null ) {
@@ -492,6 +515,9 @@
/**
* Helper function to get an array of values out of what may be either
* an array or a delimited string
+ * @param string[]|string $value
+ * @param string $delimiter
+ * @return string[]
*/
public static function getValuesArray( $value, $delimiter ) {
if ( is_array( $value ) ) {
@@ -533,9 +559,10 @@
/**
* Returns a SQL condition for autocompletion substring value in a
column.
*
- * @param string $value_column Value column name
+ * @param string $column Value column name
* @param string $substring Substring to look for
- * @return SQL condition for use in WHERE clause
+ * @param bool $replaceSpaces
+ * @return string SQL condition for use in WHERE clause
*/
public static function getSQLConditionForAutocompleteInColumn( $column,
$substring, $replaceSpaces = true ) {
global $wgDBtype, $wgPageFormsAutocompleteOnAllChars;
@@ -567,8 +594,8 @@
/**
* returns an array of pages that are result of the semantic query
- * @param $rawQueryString string - the query string like
[[Category:Trees]][[age::>1000]]
- * @return array of SMWDIWikiPage objects representing the result
+ * @param string $rawQuery the query string like
[[Category:Trees]][[age::>1000]]
+ * @return SMWDIWikiPage[] SMWDIWikiPage objects representing the result
*/
public static function getAllPagesForQuery( $rawQuery ) {
$rawQueryArray = array( $rawQuery );
diff --git a/includes/forminputs/PF_CheckboxInput.php
b/includes/forminputs/PF_CheckboxInput.php
index 27a2d99..c5e10b9 100644
--- a/includes/forminputs/PF_CheckboxInput.php
+++ b/includes/forminputs/PF_CheckboxInput.php
@@ -103,6 +103,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_CheckboxesInput.php
b/includes/forminputs/PF_CheckboxesInput.php
index 308b8e8..3435e9e 100644
--- a/includes/forminputs/PF_CheckboxesInput.php
+++ b/includes/forminputs/PF_CheckboxesInput.php
@@ -137,6 +137,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_ComboBoxInput.php
b/includes/forminputs/PF_ComboBoxInput.php
index 427c2a4..2db3a6d 100644
--- a/includes/forminputs/PF_ComboBoxInput.php
+++ b/includes/forminputs/PF_ComboBoxInput.php
@@ -193,6 +193,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_DateInput.php
b/includes/forminputs/PF_DateInput.php
index c45cbd4..8daf2ba 100644
--- a/includes/forminputs/PF_DateInput.php
+++ b/includes/forminputs/PF_DateInput.php
@@ -138,6 +138,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_DatePickerInput.php
b/includes/forminputs/PF_DatePickerInput.php
index 4e3405d..d24af48 100644
--- a/includes/forminputs/PF_DatePickerInput.php
+++ b/includes/forminputs/PF_DatePickerInput.php
@@ -16,13 +16,11 @@
class PFDatePickerInput extends PFFormInput {
/**
- * Constructor.
- *
- * @param String $input_number The number of the input in the form.
- * @param String $cur_value The current value of the input field.
- * @param String $input_name The name of the input.
- * @param String $disabled Is this input disabled?
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param string $input_number The number of the input in the form.
+ * @param string $cur_value The current value of the input field.
+ * @param string $input_name The name of the input.
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -432,8 +430,8 @@
* Returns an array of arrays with the date ranges sorted and
* overlapping ranges merged.
*
- * @param array $ranges array of arrays of DateTimes
- * @return array of arrays of DateTimes
+ * @param array[] $ranges array of arrays of DateTimes
+ * @return array[] array of arrays of DateTimes
*/
private static function sortAndMergeRanges( $ranges ) {
// sort ranges, earliest date first
@@ -496,8 +494,8 @@
* The result array will contain null values for unparseable date
* strings.
*
- * @param array $rangesAsStrings array of strings with dates and date
ranges
- * @return array of arrays of DateTimes
+ * @param string[] $rangesAsStrings dates and date ranges
+ * @return array[] array of arrays of DateTimes
*/
private static function createRangesArray( $rangesAsStrings ) {
// transform array of strings into array of array of dates
@@ -522,8 +520,8 @@
* lost in the process, of course, as they do not delimit a gap. This
* means, after repeated inversions the result will eventually be empty.
*
- * @param array $ranges of arrays of DateTimes
- * @return array of arrays of DateTimes
+ * @param DateTime[] $ranges
+ * @return array[] array of arrays of DateTimes
*/
private static function invertRangesArray( $ranges ) {
// the result (initially empty)
@@ -550,6 +548,7 @@
* Returns the set of parameters for this form input.
*
* TODO: Add missing parameters
+ * @return array[]
*/
public static function getParameters() {
$params = parent::getParameters();
@@ -603,7 +602,7 @@
* Ideally this HTML code should provide a basic functionality even if
* the browser is not JavaScript capable, i.e. even without JavaScript
* the user should be able to input values.
- *
+ * @return string
*/
public function getHtmlText() {
// Assemble HTML code.
@@ -622,7 +621,7 @@
* Returns the set of SMW property types which this input can
* handle, but for which it isn't the default input.
*
- * @return Array of strings
+ * @return string[]
*/
public static function getOtherPropTypesHandled() {
return array( '_str', '_dat' );
diff --git a/includes/forminputs/PF_DateTimeInput.php
b/includes/forminputs/PF_DateTimeInput.php
index 5241333..07bfc58 100644
--- a/includes/forminputs/PF_DateTimeInput.php
+++ b/includes/forminputs/PF_DateTimeInput.php
@@ -140,6 +140,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_DateTimePicker.php
b/includes/forminputs/PF_DateTimePicker.php
index 8618909..7539d54 100644
--- a/includes/forminputs/PF_DateTimePicker.php
+++ b/includes/forminputs/PF_DateTimePicker.php
@@ -19,13 +19,11 @@
protected $mTimePicker;
/**
- * Constructor.
- *
- * @param String $input_number The number of the input in the form.
- * @param String $cur_value The current value of the input field.
- * @param String $input_name The name of the input.
- * @param String $disabled Is this input disabled?
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param string $input_number The number of the input in the form.
+ * @param string $cur_value The current value of the input field.
+ * @param string $input_name The name of the input.
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -115,7 +113,7 @@
* Ideally this HTML code should provide a basic functionality even if
the
* browser is not JavaScript capable. I.e. even without JavaScript the
user
* should be able to input values.
- *
+ * @return string
*/
public function getHtmlText() {
$html = '<span class="inputSpan' . ( array_key_exists(
'mandatory', $this->mOtherArgs ) ? ' mandatoryFieldSpan' : '' ) . '">' .
@@ -128,6 +126,7 @@
/**
* Returns the set of SMW property types which this input can
* handle, but for which it isn't the default input.
+ * @return string[]
*/
public static function getOtherPropTypesHandled() {
return array( '_str', '_dat' );
@@ -135,6 +134,7 @@
/**
* Returns the set of parameters for this form input.
+ * @return array[]
*/
public static function getParameters() {
$params = array_merge(
@@ -166,6 +166,7 @@
/**
* Returns the name and parameters for the validation JavaScript
* functions for this input type, if any.
+ * @return array
*/
public function getJsValidationFunctionData() {
return array_merge(
diff --git a/includes/forminputs/PF_DropdownInput.php
b/includes/forminputs/PF_DropdownInput.php
index b47a6a2..6d22961 100644
--- a/includes/forminputs/PF_DropdownInput.php
+++ b/includes/forminputs/PF_DropdownInput.php
@@ -118,6 +118,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_FormInput.php
b/includes/forminputs/PF_FormInput.php
index 02fc401..fb449c3 100644
--- a/includes/forminputs/PF_FormInput.php
+++ b/includes/forminputs/PF_FormInput.php
@@ -33,15 +33,14 @@
protected $mJsValidationFunctionData = array();
/**
- * Constructor for the PFFormInput class.
- *
- * @param String $input_number The number of the input in the form. For
a simple HTML input
+ * @param string $input_number The number of the input in the form. For
a simple HTML input
* element this should end up in the id attribute in the format
'input_<number>'.
- * @param String $cur_value The current value of the input field. For a
simple HTML input
+ * @param string $cur_value The current value of the input field. For a
simple HTML input
* element this should end up in the value attribute.
- * @param String $input_name The name of the input. For a simple HTML
input element this should
+ * @param string $input_name The name of the input. For a simple HTML
input element this should
* end up in the name attribute.
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -72,7 +71,7 @@
* Returns the set of SMW property types which this input can
* handle. See SMW's SMW_DataValueFactory.php
*
- * @return Array of Strings
+ * @return string[]
*/
public static function getHandledPropertyTypes() {
return null;
@@ -80,6 +79,7 @@
/**
* Returns the set of parameters for this form input.
+ * @return array[]
*/
public static function getParameters() {
$params = array();
@@ -114,10 +114,10 @@
}
/**
- * @param $key
- * @param $configVars
- * @param $functionData
- * @param $input_id
+ * @param string $key
+ * @param array &$configVars
+ * @param array $functionData
+ * @param string $input_id
* @return array
*/
private static function updateFormInputJsFunctionData( $key,
&$configVars, $functionData, $input_id ) {
@@ -134,7 +134,7 @@
* Return an array of the default parameters for this input where the
* parameter name is the key while the parameter value is the value.
*
- * @return Array of Strings
+ * @return string[]
*/
public function getDefaultParameters() {
return null;
@@ -146,6 +146,7 @@
* Ideally this HTML code should provide a basic functionality even if
the
* browser is not JavaScript capable. I.e. even without JavaScript the
user
* should be able to input values.
+ * @return null
*/
public function getHtmlText() {
return null;
@@ -153,7 +154,7 @@
/**
*
- * @return Boolean True, if this input type can handle lists
+ * @return bool True, if this input type can handle lists
*/
public static function canHandleLists() {
return false;
@@ -164,6 +165,7 @@
* function for this input type, if any.
*
* This function is not used yet.
+ * @return array[]
*/
public function getJsInitFunctionData() {
return $this->mJsInitFunctionData;
@@ -174,6 +176,7 @@
* functions for this input type, if any.
*
* This function is not used yet.
+ * @return array[]
*/
public function getJsValidationFunctionData() {
return $this->mJsValidationFunctionData;
@@ -212,8 +215,8 @@
* Adding initFoo like this: <code>addJsInitFunctionData( "initFoo",
"array('bar', 'baz'" );</code> will result in this JavaScript call:
<code>initFoo( inputID, array('bar', 'baz') );</code>.
*
*
- * @param String $name The name of the initialization function.
- * @param String $param The parameter passed to the initialization
function.
+ * @param string $name The name of the initialization function.
+ * @param string $param The parameter passed to the initialization
function.
*/
public function addJsInitFunctionData( $name, $param = null ) {
if ( is_string( $param ) ) {
@@ -243,8 +246,8 @@
* Adding validateFoo like this: <code>addJsValidationFunctionData(
"initFoo", "array('bar', 'baz'" );</code> will result in this JavaScript call:
<code>validateFoo( inputID, array('bar', 'baz') );</code>.
*
*
- * @param String $name The name of the initialization function.
- * @param String $param The parameter passed to the initialization
function.
+ * @param string $name The name of the initialization function.
+ * @param string $param The parameter passed to the initialization
function.
*/
public function addJsValidationFunctionData( $name, $param = 'null' ) {
$this->mJsValidationFunctionData[] = array( 'name' => $name,
'param' => $param );
@@ -256,8 +259,8 @@
* should declare itself the default for any specific type.
*
* @deprecated
- * @return Array of arrays (key is the property type, value is an array
of
- * default args to be used for this input)
+ * @return array[] key is the property type, value is an array of
+ * default args to be used for this input
*/
public static function getDefaultPropTypes() {
return array();
@@ -269,8 +272,8 @@
* should declare itself the default for any specific type.
*
* @deprecated
- * @return Array of arrays (key is the property type, value is an array
of
- * default args to be used for this input)
+ * @return array[] key is the property type, value is an array of
+ * default args to be used for this input
*/
public static function getDefaultPropTypeLists() {
return array();
@@ -281,7 +284,7 @@
* handle, but for which it isn't the default input.
*
* @deprecated
- * @return Array of strings
+ * @return string[]
*/
public static function getOtherPropTypesHandled() {
return array();
@@ -292,7 +295,7 @@
* handle, but for which it isn't the default input.
*
* @deprecated
- * @return Array of strings
+ * @return string[]
*/
public static function getOtherPropTypeListsHandled() {
return array();
diff --git a/includes/forminputs/PF_GoogleMapsInput.php
b/includes/forminputs/PF_GoogleMapsInput.php
index 009f33c..f88886c 100644
--- a/includes/forminputs/PF_GoogleMapsInput.php
+++ b/includes/forminputs/PF_GoogleMapsInput.php
@@ -77,6 +77,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_LeafletInput.php
b/includes/forminputs/PF_LeafletInput.php
index f943cf5..a0266e3 100644
--- a/includes/forminputs/PF_LeafletInput.php
+++ b/includes/forminputs/PF_LeafletInput.php
@@ -75,6 +75,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_ListBoxInput.php
b/includes/forminputs/PF_ListBoxInput.php
index 6a82a4f..5ab9f90 100644
--- a/includes/forminputs/PF_ListBoxInput.php
+++ b/includes/forminputs/PF_ListBoxInput.php
@@ -29,6 +29,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
global $wgPageFormsTabIndex, $wgPageFormsFieldNum,
$wgPageFormsShowOnSelect;
diff --git a/includes/forminputs/PF_OpenLayersInput.php
b/includes/forminputs/PF_OpenLayersInput.php
index 5b9a11d..99b836d 100644
--- a/includes/forminputs/PF_OpenLayersInput.php
+++ b/includes/forminputs/PF_OpenLayersInput.php
@@ -126,6 +126,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
@@ -142,6 +143,9 @@
*
* Copied from CargoStore::coordinatePartToNumber() in the Cargo
* extension.
+ * @param string $coordinateStr
+ * @return int
+ * @throws MWException
*/
public static function coordinatePartToNumber( $coordinateStr ) {
$degreesSymbols = array( "\x{00B0}", "d" );
@@ -197,6 +201,7 @@
*
* Copied from CargoStore::parseCoordinateString() in the Cargo
* extension.
+ * @param string $coordinatesString
*/
public static function parseCoordinatesString( $coordinatesString ) {
$coordinatesString = trim( $coordinatesString );
diff --git a/includes/forminputs/PF_RadioButtonInput.php
b/includes/forminputs/PF_RadioButtonInput.php
index 32e01f5..3c2c984 100644
--- a/includes/forminputs/PF_RadioButtonInput.php
+++ b/includes/forminputs/PF_RadioButtonInput.php
@@ -140,6 +140,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_RatingInput.php
b/includes/forminputs/PF_RatingInput.php
index 895315a..2afd6e7 100644
--- a/includes/forminputs/PF_RatingInput.php
+++ b/includes/forminputs/PF_RatingInput.php
@@ -50,6 +50,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
global $wgPageFormsFieldNum;
diff --git a/includes/forminputs/PF_RegExpInput.php
b/includes/forminputs/PF_RegExpInput.php
index 386154f..256ae29 100644
--- a/includes/forminputs/PF_RegExpInput.php
+++ b/includes/forminputs/PF_RegExpInput.php
@@ -19,13 +19,11 @@
protected $mBaseInput;
/**
- * Constructor.
- *
- * @param String $input_number The number of the input in the form.
- * @param String $cur_value The current value of the input field.
- * @param String $input_name The name of the input.
- * @param String $disabled Is this input disabled?
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param string $input_number The number of the input in the form.
+ * @param string $cur_value The current value of the input field.
+ * @param string $input_name The name of the input.
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -151,6 +149,7 @@
/**
* Returns the set of parameters for this form input.
+ * @return array[]
*/
public static function getParameters() {
$params = parent::getParameters();
@@ -194,7 +193,7 @@
* Ideally this HTML code should provide a basic functionality even if
the
* browser is not JavaScript capable. I.e. even without JavaScript the
user
* should be able to input values.
- *
+ * @return string
*/
public function getHtmlText() {
return $this->mBaseInput->getHtmlText();
@@ -205,7 +204,7 @@
* handle, but for which it isn't the default input.
*
* @deprecated
- * @return Array of strings
+ * @return string[]
*/
public static function getOtherPropTypesHandled() {
return array( '_str', '_num', '_dat', '_geo', '_ema', '_tel',
'_wpg', '_tem', '_qty' );
@@ -214,6 +213,7 @@
/**
* Returns the name and parameters for the initialization JavaScript
* function for this input type, if any.
+ * @return array[]
*/
public function getJsInitFunctionData() {
return array_merge( $this->mJsInitFunctionData,
$this->mBaseInput->getJsInitFunctionData() );
@@ -222,6 +222,7 @@
/**
* Returns the name and parameters for the validation JavaScript
* functions for this input type, if any.
+ * @return array[]
*/
public function getJsValidationFunctionData() {
return array_merge( $this->mJsValidationFunctionData,
$this->mBaseInput->getJsValidationFunctionData() );
diff --git a/includes/forminputs/PF_TextAreaInput.php
b/includes/forminputs/PF_TextAreaInput.php
index b510bba..d732f91 100644
--- a/includes/forminputs/PF_TextAreaInput.php
+++ b/includes/forminputs/PF_TextAreaInput.php
@@ -27,15 +27,14 @@
}
/**
- * Constructor for the PFTextAreaInput class.
- *
- * @param String $input_number The number of the input in the form. For
a simple HTML input
+ * @param string $input_number The number of the input in the form. For
a simple HTML input
* element this should end up in the id attribute in the format
'input_<number>'.
- * @param String $cur_value The current value of the input field. For a
simple HTML input
+ * @param string $cur_value The current value of the input field. For a
simple HTML input
* element this should end up in the value attribute.
- * @param String $input_name The name of the input. For a simple HTML
input element this should
+ * @param string $input_name The name of the input. For a simple HTML
input element this should
* end up in the name attribute.
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -241,6 +240,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
$textarea_attrs = $this->getTextAreaAttributes();
diff --git a/includes/forminputs/PF_TextInput.php
b/includes/forminputs/PF_TextInput.php
index dea7db3..f9917da 100644
--- a/includes/forminputs/PF_TextInput.php
+++ b/includes/forminputs/PF_TextInput.php
@@ -346,6 +346,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_TextWithAutocompleteInput.php
b/includes/forminputs/PF_TextWithAutocompleteInput.php
index f7e94c5..52ae584 100644
--- a/includes/forminputs/PF_TextWithAutocompleteInput.php
+++ b/includes/forminputs/PF_TextWithAutocompleteInput.php
@@ -251,6 +251,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_TimePickerInput.php
b/includes/forminputs/PF_TimePickerInput.php
index 38881bf..5c78aa4 100644
--- a/includes/forminputs/PF_TimePickerInput.php
+++ b/includes/forminputs/PF_TimePickerInput.php
@@ -16,13 +16,11 @@
class PFTimePickerInput extends PFFormInput {
/**
- * Constructor.
- *
- * @param String $input_number The number of the input in the form.
- * @param String $cur_value The current value of the input field.
- * @param String $input_name The name of the input.
- * @param String $disabled Is this input disabled?
- * @param Array $other_args An associative array of other parameters
that were present in the
+ * @param string $input_number The number of the input in the form.
+ * @param string $cur_value The current value of the input field.
+ * @param string $input_name The name of the input.
+ * @param bool $disabled Is this input disabled?
+ * @param array $other_args An associative array of other parameters
that were present in the
* input definition.
*/
public function __construct( $input_number, $cur_value, $input_name,
$disabled, $other_args ) {
@@ -110,7 +108,7 @@
* Ideally this HTML code should provide a basic functionality even if
the
* browser is not Javascript capable. I.e. even without Javascript the
user
* should be able to input values.
- *
+ * @return string
*/
public function getHtmlText() {
// create visible input field (for display) and invisible field
(for data)
@@ -127,6 +125,7 @@
/**
* Returns the set of SMW property types which this input can
* handle, but for which it isn't the default input.
+ * @return string[]
*/
public static function getOtherPropTypesHandled() {
return array( '_str', '_dat' );
@@ -136,6 +135,7 @@
* Returns the set of parameters for this form input.
*
* TODO: Specify parameters specific for menuselect.
+ * @return array[]
*/
public static function getParameters() {
$params = parent::getParameters();
diff --git a/includes/forminputs/PF_TokensInput.php
b/includes/forminputs/PF_TokensInput.php
index ab1b869..98d1d30 100644
--- a/includes/forminputs/PF_TokensInput.php
+++ b/includes/forminputs/PF_TokensInput.php
@@ -214,6 +214,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/includes/forminputs/PF_Tree.php b/includes/forminputs/PF_Tree.php
index 5b86244..bdd0778 100644
--- a/includes/forminputs/PF_Tree.php
+++ b/includes/forminputs/PF_Tree.php
@@ -26,6 +26,8 @@
* by the "menuselect" input type in the Semantic Forms Inputs
* extension - the difference here is that the text is manually
* parsed, instead of being run through the MediaWiki parser.
+ * @param string $wikitext
+ * @return self
*/
public static function newFromWikiText( $wikitext ) {
// The top node, called "Top", will be ignored, because
@@ -56,7 +58,7 @@
}
/**
- * @param $top_category String
+ * @param string $top_category
* @return mixed
*/
public static function newFromTopCategory( $top_category ) {
diff --git a/includes/forminputs/PF_TreeInput.php
b/includes/forminputs/PF_TreeInput.php
index 355e4ce..617b49e 100644
--- a/includes/forminputs/PF_TreeInput.php
+++ b/includes/forminputs/PF_TreeInput.php
@@ -259,6 +259,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
@@ -272,7 +273,7 @@
/**
* Creates a Title object from a user-provided (and thus unsafe) string
- * @param $title string
+ * @param string $title
* @return null|Title
*/
static function makeTitle( $title ) {
diff --git a/includes/forminputs/PF_YearInput.php
b/includes/forminputs/PF_YearInput.php
index 50457f8..45e7efe 100644
--- a/includes/forminputs/PF_YearInput.php
+++ b/includes/forminputs/PF_YearInput.php
@@ -85,6 +85,7 @@
/**
* Returns the HTML code to be included in the output page for this
input.
+ * @return string
*/
public function getHtmlText() {
return self::getHTML(
diff --git a/specials/PF_CreateForm.php b/specials/PF_CreateForm.php
index 5880a7e..9600f56 100644
--- a/specials/PF_CreateForm.php
+++ b/specials/PF_CreateForm.php
@@ -604,6 +604,13 @@
* Prints an input for a form-field parameter.
* Code borrowed from Semantic MediaWiki's
* SMWAskPage::addOptionInput().
+ * @param string $type
+ * @param string $paramName
+ * @param string $cur_value
+ * @param array $param
+ * @param array $paramValues
+ * @param string $fieldFormText
+ * @return string
*/
public static function inputTypeParamInput( $type, $paramName,
$cur_value, array $param, array $paramValues, $fieldFormText ) {
if ( $type == 'int' ) {
@@ -659,7 +666,8 @@
* Display a form section showing the options for a given format,
* based on the getParameters() value for that format's query printer.
*
- * @param string $format
+ * @param string $inputType
+ * @param string $fieldFormText
* @param array $paramValues
*
* @return string
@@ -716,6 +724,8 @@
/**
* Display other parameters for a page section
*
+ * @param int $section_count
+ * @param array $paramValues
* @return string
*/
function showSectionParameters( $section_count, $paramValues ) {
diff --git a/specials/PF_FormStart.php b/specials/PF_FormStart.php
index ee4a824..70fb310 100644
--- a/specials/PF_FormStart.php
+++ b/specials/PF_FormStart.php
@@ -117,6 +117,9 @@
/**
* Helper function - returns a URL that includes Special:FormEdit.
+ * @param string $formName
+ * @param string $targetName
+ * @return string
*/
static function getFormEditURL( $formName, $targetName ) {
$fe = SpecialPageFactory::getPage( 'FormEdit' );
diff --git a/specials/PF_UploadWindow.php b/specials/PF_UploadWindow.php
index d44aa09..a0bf8f6 100644
--- a/specials/PF_UploadWindow.php
+++ b/specials/PF_UploadWindow.php
@@ -105,6 +105,7 @@
/**
* Special page entry point
+ * @param string|null $par
*/
public function execute( $par ) {
// Only output the body of the page.
@@ -186,6 +187,7 @@
*
* @param string $message HTML string to add to the form
* @param string $sessionKey Session key in case this is a stashed
upload
+ * @param bool $hideIgnoreWarning
* @return UploadForm
*/
protected function getUploadForm( $message = '', $sessionKey = '',
$hideIgnoreWarning = false ) {
@@ -321,6 +323,7 @@
/**
* Do the upload.
* Checks are made in SpecialUpload::execute()
+ * @return array|bool
*/
protected function processUpload() {
// Verify permissions
@@ -448,6 +451,11 @@
/**
* Get the initial image page text based on a comment and optional file
status information
+ * @param string $comment
+ * @param string $license
+ * @param string $copyStatus
+ * @param string $source
+ * @return string
*/
public static function getInitialPageText( $comment = '', $license =
'', $copyStatus = '', $source = '' ) {
global $wgUseCopyrightUpload;
@@ -482,6 +490,7 @@
*
* Note that the page target can be changed *on the form*, so our check
* state can get out of sync.
+ * @return bool
*/
protected function watchCheck() {
if ( $this->getUser()->getOption( 'watchdefault' ) ) {
@@ -642,7 +651,7 @@
/**
* Get a list of warnings
*
- * @param string local filename, e.g. 'file exists', 'non-descriptive
filename'
+ * @param string $filename local filename, e.g. 'file exists',
'non-descriptive filename'
* @return array list of warning messages
*/
public static function ajaxGetExistsWarning( $filename ) {
@@ -684,6 +693,8 @@
/**
* Construct a warning and a gallery from an array of duplicate files.
+ * @param File[] $dupes
+ * @return string
*/
public static function getDupeWarning( $dupes ) {
if ( $dupes ) {
--
To view, visit https://gerrit.wikimedia.org/r/394752
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4d9c3495f3620d3c19fdde12ffd5ef7fd2604fbc
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/extensions/PageForms
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
Gerrit-Reviewer: Thiemo Kreuz (WMDE) <[email protected]>
Gerrit-Reviewer: Umherirrender <[email protected]>
Gerrit-Reviewer: Yaron Koren <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
