Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CS] long form function return types; round 1 #19934

Merged
merged 3 commits into from
Mar 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class AssociationsControllerAssociations extends JControllerAdmin
* @param string $prefix The class prefix. Optional.
* @param array $config The array of possible config values. Optional.
*
* @return JModel|bool
* @return JModel|boolean
*
* @since 3.7.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public static function getItem($extensionName, $typeName, $itemId)
*
* @param string $extensionName The extension name with com_
*
* @return bool
* @return boolean
*
* @since 3.7.0
*/
Expand All @@ -131,7 +131,7 @@ public static function hasSupport($extensionName)
*
* @param string $extensionName The extension name with com_
*
* @return bool
* @return boolean
*
* @since 3.7.0
*/
Expand Down Expand Up @@ -456,7 +456,7 @@ public static function getContentLanguages()
* @param string $typeName The item type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 spaces

Copy link
Contributor Author

@photodude photodude Mar 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is correct, I'm not sure what you're seeing.
It lines up with the other lines

* @param int $itemId The id of item for which we need the associated items
*
* @return bool
* @return boolean
*
* @since 3.7.0
*/
Expand Down Expand Up @@ -636,7 +636,7 @@ public static function getTypeFieldName($extensionName, $typeName, $fieldName)
/**
* Gets the language filter system plugin extension id.
*
* @return int The language filter system plugin extension id.
* @return integer The language filter system plugin extension id.
*
* @since 3.7.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public function __construct($config = array())
*
* @return void
*
* @since 3.7.0
* @since 3.7.0
*/
protected function populateState($ordering = 'ordering', $direction = 'asc')
{
Expand Down Expand Up @@ -144,7 +144,7 @@ protected function getStoreId($id = '')
/**
* Build an SQL query to load the list data.
*
* @return JDatabaseQuery|bool
* @return JDatabaseQuery|boolean
*
* @since 3.7.0
*/
Expand Down Expand Up @@ -395,7 +395,8 @@ protected function getListQuery()
{
$search = $db->quote('%' . str_replace(' ', '%', $db->escape(trim($search), true) . '%'));
$query->where('(' . $db->qn($fields['title']) . ' LIKE ' . $search
. ' OR ' . $db->qn($fields['alias']) . ' LIKE ' . $search . ')');
. ' OR ' . $db->qn($fields['alias']) . ' LIKE ' . $search . ')'
);
}
}

Expand Down
4 changes: 2 additions & 2 deletions administrator/components/com_banners/models/banner.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ protected function batchClient($value, $pks, $contexts)
*
* @return mixed An array of new IDs on success, boolean false on failure.
*
* @since 2.5
* @since 2.5
*/
protected function batchCopy($value, $pks, $contexts)
{
Expand Down Expand Up @@ -562,7 +562,7 @@ public function save($data)
/**
* Is the user allowed to create an on the fly category?
*
* @return bool
* @return boolean
*
* @since 3.6.1
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public function getModel($name = 'Category', $prefix = 'CategoriesModel', $confi
/**
* Rebuild the nested set tree.
*
* @return bool False on failure or error, true on success.
* @return boolean False on failure or error, true on success.
*
* @since 1.6
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ public static function getAssociations($pk, $extension = 'com_content')
* @param mixed $catid Name or ID of category.
* @param string $extension Extension that triggers this function
*
* @return int $catid Category ID.
* @return integer $catid Category ID.
*/
public static function validateCategoryId($catid, $extension)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct($config = array())
/**
* Method to save the configuration.
*
* @return bool True on success, false on failure.
* @return boolean True on success, false on failure.
*
* @since 1.5
* @deprecated 4.0 Use ConfigControllerApplicationSave instead.
Expand Down Expand Up @@ -91,7 +91,7 @@ public function cancel()
/**
* Method to remove the root property from the configuration.
*
* @return bool True on success, false on failure.
* @return boolean True on success, false on failure.
*
* @since 1.5
* @deprecated 4.0 Use ConfigControllerApplicationRemoveroot instead.
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_fields/helpers/fields.php
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,7 @@ public static function getAssignedCategoriesTitles($fieldId)
/**
* Gets the fields system plugin extension id.
*
* @return int The fields system plugin extension id.
* @return integer The fields system plugin extension id.
*
* @since 3.7.0
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_finder/helpers/finder.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public static function addSubmenu($vName)
/**
* Gets the finder system plugin extension id.
*
* @return int The finder system plugin extension id.
* @return integer The finder system plugin extension id.
*
* @since 3.6.0
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_finder/models/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ protected function getStoreId($id = '')
/**
* Gets the total of indexed items.
*
* @return int The total of indexed items.
* @return integer The total of indexed items.
*
* @since 3.6.0
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_installer/models/discover.php
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public function discover_install()
/**
* Cleans out the list of discovered extensions.
*
* @return bool True on success
* @return boolean True on success
*
* @since 1.6
*/
Expand Down
14 changes: 7 additions & 7 deletions administrator/components/com_languages/models/overrides.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class LanguagesModelOverrides extends JModelList
*
* @param array $config An optional associative array of configuration settings.
*
* @since 2.5
* @since 2.5
*/
public function __construct($config = array())
{
Expand Down Expand Up @@ -112,9 +112,9 @@ public function getOverrides($all = false)
/**
* Method to get the total number of overrides.
*
* @return int The total number of overrides.
* @return integer The total number of overrides.
*
* @since 2.5
* @since 2.5
*/
public function getTotal()
{
Expand Down Expand Up @@ -190,7 +190,7 @@ protected function populateState($ordering = 'key', $direction = 'asc')
*
* @return array Sorted associative array of languages.
*
* @since 2.5
* @since 2.5
*/
public function getLanguages()
{
Expand Down Expand Up @@ -230,9 +230,9 @@ public function getLanguages()
*
* @param array $cids Array of keys to delete.
*
* @return integer Number of successfully deleted overrides, boolean false if an error occurred.
* @return integer Number of successfully deleted overrides, boolean false if an error occurred.
*
* @since 2.5
* @since 2.5
*/
public function delete($cids)
{
Expand Down Expand Up @@ -277,7 +277,7 @@ public function delete($cids)
/**
* Removes all of the cached strings from the table.
*
* @return boolean result of operation
* @return boolean result of operation
*
* @since 3.4.2
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_menus/controllers/items.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function getModel($name = 'Item', $prefix = 'MenusModel', $config = array
/**
* Rebuild the nested set tree.
*
* @return bool False on failure or error, true on success.
* @return boolean False on failure or error, true on success.
*
* @since 1.6
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_menus/controllers/menus.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public function delete()
/**
* Rebuild the menu tree.
*
* @return bool False on failure or error, true on success.
* @return boolean False on failure or error, true on success.
*
* @since 1.6
*/
Expand Down
30 changes: 15 additions & 15 deletions administrator/components/com_menus/models/item.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,55 +26,55 @@ class MenusModelItem extends JModelAdmin
/**
* The type alias for this content type.
*
* @var string
* @since 3.4
* @var string
* @since 3.4
*/
public $typeAlias = 'com_menus.item';

/**
* The context used for the associations table
*
* @var string
* @since 3.4.4
* @var string
* @since 3.4.4
*/
protected $associationsContext = 'com_menus.item';

/**
* @var string The prefix to use with controller messages.
* @since 1.6
* @var string The prefix to use with controller messages.
* @since 1.6
*/
protected $text_prefix = 'COM_MENUS_ITEM';

/**
* @var string The help screen key for the menu item.
* @since 1.6
* @var string The help screen key for the menu item.
* @since 1.6
*/
protected $helpKey = 'JHELP_MENUS_MENU_ITEM_MANAGER_EDIT';

/**
* @var string The help screen base URL for the menu item.
* @since 1.6
* @var string The help screen base URL for the menu item.
* @since 1.6
*/
protected $helpURL;

/**
* @var boolean True to use local lookup for the help screen.
* @since 1.6
* @var boolean True to use local lookup for the help screen.
* @since 1.6
*/
protected $helpLocal = false;

/**
* Batch copy/move command. If set to false,
* the batch copy/move command is not supported
*
* @var string
* @var string
*/
protected $batch_copymove = 'menu_id';

/**
* Allowed batch commands
*
* @var array
* @var array
*/
protected $batch_commands = array(
'assetgroup_id' => 'batchAccess',
Expand Down Expand Up @@ -864,7 +864,7 @@ public function getModules()
/**
* Get the list of all view levels
*
* @return array|bool An array of all view levels (id, title).
* @return array|boolean An array of all view levels (id, title).
*
* @since 3.4
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_modules/models/positions.php
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public function getItems()
/**
* Method to get the total number of items.
*
* @return int The total number of items.
* @return integer The total number of items.
*
* @since 1.6
*/
Expand Down
2 changes: 1 addition & 1 deletion administrator/components/com_redirect/helpers/redirect.php
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public static function publishedOptions()
/**
* Gets the redirect system plugin extension id.
*
* @return int The redirect system plugin extension id.
* @return integer The redirect system plugin extension id.
*
* @since 3.6.0
*/
Expand Down
14 changes: 7 additions & 7 deletions administrator/modules/mod_menu/menu.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,27 @@ class JAdminCssMenu
/**
* The Menu tree object
*
* @var Tree
* @var Tree
*
* @since 3.8.0
* @since 3.8.0
*/
protected $tree;

/**
* The module options
*
* @var Registry
* @var Registry
*
* @since 3.8.0
* @since 3.8.0
*/
protected $params;

/**
* The menu bar state
*
* @var bool
* @var bool
*
* @since 3.8.0
* @since 3.8.0
*/
protected $enabled;

Expand Down Expand Up @@ -157,7 +157,7 @@ public function renderSubmenu($layoutFile)
* @param array $items The menu items array
* @param Registry $params Module options
*
* @return bool Whether to show recovery menu
* @return boolean Whether to show recovery menu
*
* @since 3.8.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* Checks if hathor is the default backend template or currently used as default style.
* If yes we want to show a message and action button.
*
* @return bool
* @return boolean
*
* @since 3.7
*/
Expand Down