From dbf29cdc71ca0fb191fae02b026811c2e9759555 Mon Sep 17 00:00:00 2001 From: Thomas Hunziker Date: Thu, 4 Dec 2014 20:43:05 +0100 Subject: [PATCH] [CS] Codestyle changes done in staging. --- src/com_weblinks/admin/controller.php | 4 +- .../admin/controllers/weblink.php | 4 +- .../admin/controllers/weblinks.php | 4 +- src/com_weblinks/admin/helpers/weblinks.php | 4 +- src/com_weblinks/admin/models/weblink.php | 4 +- src/com_weblinks/admin/models/weblinks.php | 4 +- src/com_weblinks/admin/tables/weblink.php | 4 +- .../admin/views/weblink/view.html.php | 4 +- .../admin/views/weblinks/view.html.php | 4 +- src/com_weblinks/site/controller.php | 4 +- src/com_weblinks/site/controllers/weblink.php | 65 +++++++++++-------- src/com_weblinks/site/helpers/association.php | 4 +- src/com_weblinks/site/helpers/category.php | 7 +- src/com_weblinks/site/helpers/icon.php | 7 +- src/com_weblinks/site/helpers/route.php | 7 +- src/com_weblinks/site/models/categories.php | 11 ++-- src/com_weblinks/site/models/category.php | 4 +- src/com_weblinks/site/models/form.php | 4 +- src/com_weblinks/site/models/weblink.php | 4 +- src/com_weblinks/site/router.php | 6 +- .../site/views/categories/view.html.php | 4 +- .../site/views/category/view.feed.php | 4 +- .../site/views/category/view.html.php | 4 +- .../site/views/form/view.html.php | 7 +- .../site/views/weblink/view.html.php | 4 +- src/com_weblinks/site/weblinks.php | 2 +- src/plg_finder_weblinks/weblinks.php | 4 +- src/plg_search_weblinks/weblinks.php | 4 +- 28 files changed, 76 insertions(+), 116 deletions(-) diff --git a/src/com_weblinks/admin/controller.php b/src/com_weblinks/admin/controller.php index 02d8915..c220595 100644 --- a/src/com_weblinks/admin/controller.php +++ b/src/com_weblinks/admin/controller.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks Weblink Controller * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksController extends JControllerLegacy { diff --git a/src/com_weblinks/admin/controllers/weblink.php b/src/com_weblinks/admin/controllers/weblink.php index 2361894..7c2540e 100644 --- a/src/com_weblinks/admin/controllers/weblink.php +++ b/src/com_weblinks/admin/controllers/weblink.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblink controller class. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksControllerWeblink extends JControllerForm { diff --git a/src/com_weblinks/admin/controllers/weblinks.php b/src/com_weblinks/admin/controllers/weblinks.php index f78b72b..f41136b 100644 --- a/src/com_weblinks/admin/controllers/weblinks.php +++ b/src/com_weblinks/admin/controllers/weblinks.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks list controller class. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksControllerWeblinks extends JControllerAdmin { diff --git a/src/com_weblinks/admin/helpers/weblinks.php b/src/com_weblinks/admin/helpers/weblinks.php index 550a87c..cc765b4 100644 --- a/src/com_weblinks/admin/helpers/weblinks.php +++ b/src/com_weblinks/admin/helpers/weblinks.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks helper. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksHelper extends JHelperContent { diff --git a/src/com_weblinks/admin/models/weblink.php b/src/com_weblinks/admin/models/weblink.php index 5742581..1aea25f 100644 --- a/src/com_weblinks/admin/models/weblink.php +++ b/src/com_weblinks/admin/models/weblink.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks model. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksModelWeblink extends JModelAdmin { diff --git a/src/com_weblinks/admin/models/weblinks.php b/src/com_weblinks/admin/models/weblinks.php index 580a360..8cfe9db 100644 --- a/src/com_weblinks/admin/models/weblinks.php +++ b/src/com_weblinks/admin/models/weblinks.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Methods supporting a list of weblink records. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksModelWeblinks extends JModelList { diff --git a/src/com_weblinks/admin/tables/weblink.php b/src/com_weblinks/admin/tables/weblink.php index a41a7c1..d0cbe86 100644 --- a/src/com_weblinks/admin/tables/weblink.php +++ b/src/com_weblinks/admin/tables/weblink.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblink Table class * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksTableWeblink extends JTable { diff --git a/src/com_weblinks/admin/views/weblink/view.html.php b/src/com_weblinks/admin/views/weblink/view.html.php index 152243d..526176d 100644 --- a/src/com_weblinks/admin/views/weblink/view.html.php +++ b/src/com_weblinks/admin/views/weblink/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * View to edit a weblink. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewWeblink extends JViewLegacy { diff --git a/src/com_weblinks/admin/views/weblinks/view.html.php b/src/com_weblinks/admin/views/weblinks/view.html.php index 45abc86..5fc0890 100644 --- a/src/com_weblinks/admin/views/weblinks/view.html.php +++ b/src/com_weblinks/admin/views/weblinks/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * View class for a list of weblinks. * - * @package Joomla.Administrator - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewWeblinks extends JViewLegacy { diff --git a/src/com_weblinks/site/controller.php b/src/com_weblinks/site/controller.php index b0d0f86..a2baaab 100644 --- a/src/com_weblinks/site/controller.php +++ b/src/com_weblinks/site/controller.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks Component Controller * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksController extends JControllerLegacy { diff --git a/src/com_weblinks/site/controllers/weblink.php b/src/com_weblinks/site/controllers/weblink.php index f41de16..12738fe 100644 --- a/src/com_weblinks/site/controllers/weblink.php +++ b/src/com_weblinks/site/controllers/weblink.php @@ -10,9 +10,9 @@ defined('_JEXEC') or die; /** - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * Weblinks class. + * + * @since 1.5 */ class WeblinksControllerWeblink extends JControllerForm { @@ -42,7 +42,6 @@ class WeblinksControllerWeblink extends JControllerForm */ public function add() { - if (!parent::add()) { // Redirect to the return page. @@ -53,8 +52,10 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method override to check if you can add a new record. * - * @param array $data An array of input data. + * @param array $data An array of input data. + * * @return boolean + * * @since 1.6 */ protected function allowAdd($data = array()) @@ -66,7 +67,7 @@ class WeblinksControllerWeblink extends JControllerForm if ($categoryId) { // If the category has been passed in the URL check it. - $allow = $user->authorise('core.create', $this->option.'.category.'.$categoryId); + $allow = $user->authorise('core.create', $this->option . '.category.' . $categoryId); } if ($allow === null) @@ -83,15 +84,16 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method to check if you can add a new record. * - * @param array $data An array of input data. - * @param string $key The name of the key for the primary key. + * @param array $data An array of input data. + * @param string $key The name of the key for the primary key. * * @return boolean + * * @since 1.6 */ protected function allowEdit($data = array(), $key = 'id') { - $recordId = (int) isset($data[$key]) ? $data[$key] : 0; + $recordId = (int) isset($data[$key]) ? $data[$key] : 0; $categoryId = 0; if ($recordId) @@ -102,7 +104,7 @@ class WeblinksControllerWeblink extends JControllerForm if ($categoryId) { // The category has been set. Check the category permissions. - return JFactory::getUser()->authorise('core.edit', $this->option.'.category.'.$categoryId); + return JFactory::getUser()->authorise('core.edit', $this->option . '.category.' . $categoryId); } else { @@ -114,9 +116,10 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method to cancel an edit. * - * @param string $key The name of the primary key of the URL variable. + * @param string $key The name of the primary key of the URL variable. * - * @return Boolean True if access level checks pass, false otherwise. + * @return boolean True if access level checks pass, false otherwise. + * * @since 1.6 */ public function cancel($key = 'w_id') @@ -130,10 +133,11 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method to edit an existing record. * - * @param string $key The name of the primary key of the URL variable. - * @param string $urlVar The name of the URL variable if different from the primary key (sometimes required to avoid router collisions). + * @param string $key The name of the primary key of the URL variable. + * @param string $urlVar The name of the URL variable if different from the primary key (sometimes required to avoid router collisions). * - * @return Boolean True if access level check and checkout passes, false otherwise. + * @return boolean True if access level check and checkout passes, false otherwise. + * * @since 1.6 */ public function edit($key = null, $urlVar = 'w_id') @@ -146,11 +150,12 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method to get a model object, loading it if required. * - * @param string $name The model name. Optional. - * @param string $prefix The class prefix. Optional. - * @param array $config Configuration array for model. Optional. + * @param string $name The model name. Optional. + * @param string $prefix The class prefix. Optional. + * @param array $config Configuration array for model. Optional. * * @return object The model. + * * @since 1.5 */ public function getModel($name = 'form', $prefix = '', $config = array('ignore_request' => true)) @@ -163,10 +168,11 @@ class WeblinksControllerWeblink extends JControllerForm /** * Gets the URL arguments to append to an item redirect. * - * @param integer $recordId The primary key id for the item. - * @param string $urlVar The name of the URL variable for the id. + * @param integer $recordId The primary key id for the item. + * @param string $urlVar The name of the URL variable for the id. * - * @return string The arguments to append to the redirect URL. + * @return string The arguments to append to the redirect URL. + * * @since 1.6 */ protected function getRedirectToItemAppend($recordId = null, $urlVar = null) @@ -177,12 +183,12 @@ class WeblinksControllerWeblink extends JControllerForm if ($itemId) { - $append .= '&Itemid='.$itemId; + $append .= '&Itemid=' . $itemId; } if ($return) { - $append .= '&return='.base64_encode($return); + $append .= '&return=' . base64_encode($return); } return $append; @@ -193,7 +199,8 @@ class WeblinksControllerWeblink extends JControllerForm * * If a "return" variable has been passed in the request * - * @return string The return URL. + * @return string The return URL. + * * @since 1.6 */ protected function getReturnPage() @@ -227,10 +234,11 @@ class WeblinksControllerWeblink extends JControllerForm /** * Method to save a record. * - * @param string $key The name of the primary key of the URL variable. - * @param string $urlVar The name of the URL variable if different from the primary key (sometimes required to avoid router collisions). + * @param string $key The name of the primary key of the URL variable. + * @param string $urlVar The name of the URL variable if different from the primary key (sometimes required to avoid router collisions). * - * @return Boolean True if successful, false otherwise. + * @return boolean True if successful, false otherwise. + * * @since 1.6 */ public function save($key = null, $urlVar = 'w_id') @@ -250,6 +258,7 @@ class WeblinksControllerWeblink extends JControllerForm * Go to a weblink * * @return void + * * @since 1.6 */ public function go() @@ -299,7 +308,7 @@ class WeblinksControllerWeblink extends JControllerForm } // Redirect to the URL - // TODO: Probably should check for a valid http link + // @todo: Probably should check for a valid http link if ($link->url) { $modelLink->hit($id); diff --git a/src/com_weblinks/site/helpers/association.php b/src/com_weblinks/site/helpers/association.php index 7dd8512..d447f81 100644 --- a/src/com_weblinks/site/helpers/association.php +++ b/src/com_weblinks/site/helpers/association.php @@ -15,9 +15,7 @@ JLoader::register('CategoryHelperAssociation', JPATH_ADMINISTRATOR . '/component /** * Weblinks Component Association Helper * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 3.0 + * @since 3.0 */ abstract class WeblinksHelperAssociation extends CategoryHelperAssociation { diff --git a/src/com_weblinks/site/helpers/category.php b/src/com_weblinks/site/helpers/category.php index 66c1ce6..c102da1 100644 --- a/src/com_weblinks/site/helpers/category.php +++ b/src/com_weblinks/site/helpers/category.php @@ -10,12 +10,9 @@ defined('_JEXEC') or die; /** - * Weblinks Component Category Tree + * Weblinks Component Category Tree. * - * @static - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksCategories extends JCategories { diff --git a/src/com_weblinks/site/helpers/icon.php b/src/com_weblinks/site/helpers/icon.php index e8410b1..8c03184 100644 --- a/src/com_weblinks/site/helpers/icon.php +++ b/src/com_weblinks/site/helpers/icon.php @@ -10,12 +10,9 @@ defined('_JEXEC') or die; /** - * Weblink Component HTML Helper + * Weblink Component HTML Helper. * - * @static - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class JHtmlIcon { diff --git a/src/com_weblinks/site/helpers/route.php b/src/com_weblinks/site/helpers/route.php index 6aecedd..aef5edc 100644 --- a/src/com_weblinks/site/helpers/route.php +++ b/src/com_weblinks/site/helpers/route.php @@ -10,12 +10,9 @@ defined('_JEXEC') or die; /** - * Weblinks Component Route Helper + * Weblinks Component Route Helper. * - * @static - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ abstract class WeblinksHelperRoute { diff --git a/src/com_weblinks/site/models/categories.php b/src/com_weblinks/site/models/categories.php index 34d38de..8f26ed4 100644 --- a/src/com_weblinks/site/models/categories.php +++ b/src/com_weblinks/site/models/categories.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * This models supports retrieving lists of article categories. * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksModelCategories extends JModelList { @@ -94,18 +92,23 @@ class WeblinksModelCategories extends JModelList $menu = $app->getMenu(); $active = $menu->getActive(); $params = new JRegistry; + if ($active) { $params->loadString($active->params); } + $options = array(); $options['countItems'] = $params->get('show_cat_num_links', 1) || !$params->get('show_empty_categories_cat', 0); $categories = JCategories::getInstance('Weblinks', $options); $this->_parent = $categories->get($this->getState('filter.parentId', 'root')); + if (is_object($this->_parent)) { $this->_items = $this->_parent->getChildren(); - } else { + } + else + { $this->_items = false; } } diff --git a/src/com_weblinks/site/models/category.php b/src/com_weblinks/site/models/category.php index 10b0fdf..e2a407a 100644 --- a/src/com_weblinks/site/models/category.php +++ b/src/com_weblinks/site/models/category.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Weblinks Component Weblink Model * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksModelCategory extends JModelList { diff --git a/src/com_weblinks/site/models/form.php b/src/com_weblinks/site/models/form.php index 52a34ed..b145fd2 100644 --- a/src/com_weblinks/site/models/form.php +++ b/src/com_weblinks/site/models/form.php @@ -14,9 +14,7 @@ require_once JPATH_COMPONENT_ADMINISTRATOR.'/models/weblink.php'; /** * Weblinks model. * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.6 + * @since 1.6 */ class WeblinksModelForm extends WeblinksModelWeblink { diff --git a/src/com_weblinks/site/models/weblink.php b/src/com_weblinks/site/models/weblink.php index fdc93ec..348e1a1 100644 --- a/src/com_weblinks/site/models/weblink.php +++ b/src/com_weblinks/site/models/weblink.php @@ -14,9 +14,7 @@ JTable::addIncludePath(JPATH_COMPONENT_ADMINISTRATOR . '/tables'); /** * Weblinks Component Model for a Weblink record * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksModelWeblink extends JModelItem { diff --git a/src/com_weblinks/site/router.php b/src/com_weblinks/site/router.php index d437216..f210f09 100644 --- a/src/com_weblinks/site/router.php +++ b/src/com_weblinks/site/router.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Routing class from com_weblinks * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 3.3 + * @since 3.3 */ class WeblinksRouter extends JComponentRouterBase { @@ -236,7 +234,7 @@ class WeblinksRouter extends JComponentRouterBase ->select($db->quoteName('id')) ->from('#__weblinks') ->where($db->quoteName('catid') . ' = ' . (int) $vars['catid']) - ->where($db->quoteName('alias') . ' = ' . $db->quote($db->quote(str_replace(':', '-', $segment)))); + ->where($db->quoteName('alias') . ' = ' . $db->quote(str_replace(':', '-', $segment))); $db->setQuery($query); $id = $db->loadResult(); } diff --git a/src/com_weblinks/site/views/categories/view.html.php b/src/com_weblinks/site/views/categories/view.html.php index a4d52d7..997c34d 100644 --- a/src/com_weblinks/site/views/categories/view.html.php +++ b/src/com_weblinks/site/views/categories/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * Content categories view. * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewCategories extends JViewCategories { diff --git a/src/com_weblinks/site/views/category/view.feed.php b/src/com_weblinks/site/views/category/view.feed.php index 6a281cc..d1a84b3 100644 --- a/src/com_weblinks/site/views/category/view.feed.php +++ b/src/com_weblinks/site/views/category/view.feed.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * HTML View class for the WebLinks component * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.0 + * @since 1.0 */ class WeblinksViewCategory extends JViewCategoryfeed { diff --git a/src/com_weblinks/site/views/category/view.html.php b/src/com_weblinks/site/views/category/view.html.php index 82058cd..0efc223 100644 --- a/src/com_weblinks/site/views/category/view.html.php +++ b/src/com_weblinks/site/views/category/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * HTML View class for the WebLinks component * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewCategory extends JViewCategory { diff --git a/src/com_weblinks/site/views/form/view.html.php b/src/com_weblinks/site/views/form/view.html.php index 23ba4bb..ccfcf8e 100644 --- a/src/com_weblinks/site/views/form/view.html.php +++ b/src/com_weblinks/site/views/form/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * HTML Article View class for the Weblinks component * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewForm extends JViewLegacy { @@ -48,6 +46,7 @@ class WeblinksViewForm extends JViewLegacy if ($authorised !== true) { JError::raiseError(403, JText::_('JERROR_ALERTNOAUTHOR')); + return false; } @@ -131,7 +130,7 @@ class WeblinksViewForm extends JViewLegacy $this->document->setMetadata('keywords', $this->params->get('menu-meta_keywords')); } - if ($this->params->get('robots')) + if ($this->params->get('robots')) { $this->document->setMetadata('robots', $this->params->get('robots')); } diff --git a/src/com_weblinks/site/views/weblink/view.html.php b/src/com_weblinks/site/views/weblink/view.html.php index e12bf6e..2e75f8b 100644 --- a/src/com_weblinks/site/views/weblink/view.html.php +++ b/src/com_weblinks/site/views/weblink/view.html.php @@ -12,9 +12,7 @@ defined('_JEXEC') or die; /** * HTML View class for the WebLinks component * - * @package Joomla.Site - * @subpackage com_weblinks - * @since 1.5 + * @since 1.5 */ class WeblinksViewWeblink extends JViewLegacy { diff --git a/src/com_weblinks/site/weblinks.php b/src/com_weblinks/site/weblinks.php index 52833bb..00b2209 100644 --- a/src/com_weblinks/site/weblinks.php +++ b/src/com_weblinks/site/weblinks.php @@ -9,7 +9,7 @@ defined('_JEXEC') or die; -require_once JPATH_COMPONENT.'/helpers/route.php'; +require_once JPATH_COMPONENT . '/helpers/route.php'; $controller = JControllerLegacy::getInstance('Weblinks'); $controller->execute(JFactory::getApplication()->input->get('task')); diff --git a/src/plg_finder_weblinks/weblinks.php b/src/plg_finder_weblinks/weblinks.php index d3b66e1..3c17bdc 100644 --- a/src/plg_finder_weblinks/weblinks.php +++ b/src/plg_finder_weblinks/weblinks.php @@ -15,9 +15,7 @@ require_once JPATH_ADMINISTRATOR . '/components/com_finder/helpers/indexer/adapt /** * Smart Search adapter for Joomla Web Links. * - * @package Joomla.Plugin - * @subpackage Finder.Weblinks - * @since 2.5 + * @since 2.5 */ class PlgFinderWeblinks extends FinderIndexerAdapter { diff --git a/src/plg_search_weblinks/weblinks.php b/src/plg_search_weblinks/weblinks.php index 3aa89ce..a939252 100644 --- a/src/plg_search_weblinks/weblinks.php +++ b/src/plg_search_weblinks/weblinks.php @@ -14,9 +14,7 @@ require_once JPATH_SITE . '/components/com_weblinks/helpers/route.php'; /** * Weblinks search plugin. * - * @package Joomla.Plugin - * @subpackage Search.weblinks - * @since 1.6 + * @since 1.6 */ class PlgSearchWeblinks extends JPlugin {