joomla/cms
29
0
Fork 0
mirror of https://github.com/joomla/joomla-cms.git synced 2024-06-28 16:13:42 +00:00
Code Packages Releases Activity

[4] Update PHPDoc comment to match method signatures in installation app (#31060)

Browse Source 
* Update PHPDoc comment to match method signatures in installation app

* Update PHPDoc comment to match method signatures in installation app

* code style

* Update installation/src/Application/InstallationApplication.php

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

* Update installation/src/Application/InstallationApplication.php

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

* Update installation/src/Application/InstallationApplication.php

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
This commit is contained in:
Phil Taylor 2020-10-15 17:59:56 +01:00 committed by GitHub
parent c326b480c8
commit bb31ff652e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
installation/src/Application/InstallationApplication.php
View File

@ -42,16 +42,16 @@ final class InstallationApplication extends CMSApplication
/**
* Class constructor.
*
* @param Input $input An optional argument to provide dependency injection for the application's input
* object. If the argument is a JInput object that object will become the
* application's input object, otherwise a default input object is created.
* @param Registry $config An optional argument to provide dependency injection for the application's
* config object. If the argument is a Registry object that object will become
* the application's config object, otherwise a default config object is created.
* @param WebClient $client An optional argument to provide dependency injection for the application's
* client object. If the argument is a WebClient object that object will become the
* application's client object, otherwise a default client object is created.
* @param Container $container Dependency injection container.
* @param Input|null $input An optional argument to provide dependency injection for the application's input
* object. If the argument is a JInput object that object will become the
* application's input object, otherwise a default input object is created.
* @param Registry|null $config An optional argument to provide dependency injection for the application's
* config object. If the argument is a Registry object that object will become
* the application's config object, otherwise a default config object is created.
* @param WebClient|null $client An optional argument to provide dependency injection for the application's
* client object. If the argument is a WebClient object that object will become the
* application's client object, otherwise a default client object is created.
* @param Container|null $container Dependency injection container.
*
* @since 3.1
*/
@ -356,7 +356,7 @@ final class InstallationApplication extends CMSApplication
/**
* Returns the installed language files in the administrative and frontend area.
*
* @param DatabaseInterface $db Database driver.
* @param DatabaseInterface|null $db Database driver.
*
* @return array Array with installed language packs in admin and site area.
*
@ -494,7 +494,7 @@ final class InstallationApplication extends CMSApplication
* but for many applications it will make sense to override this method and create a document,
* if required, based on more specific needs.
*
* @param Document $document An optional document object. If omitted, the factory document is created.
* @param Document|null $document An optional document object. If omitted, the factory document is created.
*
* @return InstallationApplication This method is chainable.
*
@ -582,10 +582,10 @@ final class InstallationApplication extends CMSApplication
/**
* Returns the application \JMenu object.
*
* @param string $name The name of the application/client.
* @param array $options An optional associative array of configuration settings.
* @param string|null $name The name of the application/client.
* @param array $options An optional associative array of configuration settings.
*
* @return AbstractMenu
* @return null
*
* @since 3.2
*/

8
installation/src/Controller/InstallationController.php
View File

@ -27,12 +27,12 @@ class InstallationController extends JSONController
/**
* Constructor.
*
* @param array $config An optional associative array of configuration settings.
* @param array $config An optional associative array of configuration settings.
* Recognized key values include 'name', 'default_task', 'model_path', and
* 'view_path' (this list is not meant to be comprehensive).
* @param MVCFactoryInterface $factory The factory.
* @param CMSApplication $app The JApplication for the dispatcher
* @param \JInput $input Input
* @param MVCFactoryInterface|null $factory The factory.
* @param CMSApplication|null $app The JApplication for the dispatcher
* @param \JInput|null $input Input
*
* @since 3.0
*/

6
installation/src/Form/Field/Installation/LanguageField.php
View File

@ -100,10 +100,10 @@ class LanguageField extends ListField
/**
* Method to sort languages by name.
*
* @param string $a The first value to determine sort
* @param string $b The second value to determine sort
* @param array $a The first value to determine sort
* @param array $b The second value to determine sort
*
* @return string
* @return integer
*
* @since 3.1
*/

6
installation/src/Form/Rule/UsernameRule.php
View File

@ -27,11 +27,11 @@ class UsernameRule extends FormRule
*
* @param \SimpleXMLElement $element The SimpleXMLElement object representing the <field /> tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control value. This acts as an array container for the field.
* @param string|null $group The field name group control value. This acts as an array container for the field.
* For example if the field has name="foo" and the group value is set to "bar" then the
* full field name would end up being "bar[foo]".
* @param Registry $input An optional Registry object with the entire data set to validate against the entire form.
* @param Form $form The form object for which the field is being tested.
* @param Registry|null $input An optional Registry object with the entire data set to validate against the entire form.
* @param Form|null $form The form object for which the field is being tested.
*
* @return boolean True if the value is valid, false otherwise.
*/

4
installation/src/Model/BaseInstallationModel.php
View File

@ -24,8 +24,8 @@ class BaseInstallationModel extends BaseDatabaseModel
/**
* Constructor
*
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
* @param MVCFactoryInterface $factory The factory.
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
* @param MVCFactoryInterface|null $factory The factory.
*
* @since 3.0
* @throws \Exception

2
installation/src/Model/ChecksModel.php
View File

@ -225,7 +225,7 @@ class ChecksModel extends BaseInstallationModel
/**
* Method to get the form.
*
* @param string $view The view being processed.
* @param string|null $view The view being processed.
*
* @return Form|boolean Form object on success, false on failure.
*

2
installation/src/Model/LanguagesModel.php
View File

@ -521,7 +521,7 @@ class LanguagesModel extends BaseInstallationModel
/**
* Get the model form.
*
* @param string $view The view being processed.
* @param string|null $view The view being processed.
*
* @return mixed JForm object on success, false on failure.
*

8
installation/src/Model/SetupModel.php
View File

@ -87,7 +87,7 @@ class SetupModel extends BaseInstallationModel
/**
* Method to get the form.
*
* @param string $view The view being processed.
* @param string|null $view The view being processed.
*
* @return Form|boolean JForm object on success, false on failure.
*
@ -160,7 +160,7 @@ class SetupModel extends BaseInstallationModel
/**
* Generate a panel of language choices for the user to select their language.
*
* @return boolean True if successful.
* @return array
*
* @since 3.1
*/
@ -196,8 +196,8 @@ class SetupModel extends BaseInstallationModel
/**
* Method to validate the form data.
*
* @param array $data The form data.
* @param string $view The view.
* @param array $data The form data.
* @param string|null $view The view.
*
* @return array|boolean Array of filtered data if valid, false otherwise.
*

2
installation/src/View/DefaultView.php
View File

@ -32,7 +32,7 @@ class DefaultView extends BaseHtmlView
/**
* Execute and display a template script.
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
* @param string|null $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise an Error object.
*

2
installation/src/View/Preinstall/HtmlView.php
View File

@ -39,7 +39,7 @@ class HtmlView extends DefaultView
/**
* Execute and display a template script.
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
* @param string|null $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise an Error object.
*

2
installation/src/View/Remove/HtmlView.php
View File

@ -64,7 +64,7 @@ class HtmlView extends DefaultView
/**
* Execute and display a template script.
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
* @param string|null $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise an Error object.
*

6
installation/template/message.php
View File

@ -25,9 +25,9 @@ class JDocumentRendererHtmlMessage extends JDocumentRenderer
/**
* Renders the error stack and returns the results as a string
*
* @param string $name Not used.
* @param array $params Associative array of values
* @param string $content Not used.
* @param string $name Not used.
* @param array $params Associative array of values
* @param string|null $content Not used.
*
* @return string The output of the script
*