diff --git a/components/com_wrapper/controller.php b/components/com_wrapper/controller.php index 29bf538751232..e390a6760ef88 100644 --- a/components/com_wrapper/controller.php +++ b/components/com_wrapper/controller.php @@ -21,13 +21,14 @@ class WrapperController extends JControllerLegacy /** * Method to display a view. * - * @param boolean If true, the view output will be cached - * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. + * @param boolean $cachable If true, the view output will be cached + * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. * * @return JControllerLegacy This object to support chaining. + * * @since 1.5 */ - public function display($cachable = false, $urlparams = false) + public function display($cachable = false, $urlparams = array()) { $cachable = true; diff --git a/components/com_wrapper/router.php b/components/com_wrapper/router.php index 4e5af20bf5efb..64f5ea57dd2f9 100644 --- a/components/com_wrapper/router.php +++ b/components/com_wrapper/router.php @@ -77,6 +77,10 @@ public function parse(&$segments) * These functions are proxys for the new router interface * for old SEF extensions. * + * @param array &$query An array of URL arguments + * + * @return array The URL arguments to use to assemble the subsequent URL. + * * @deprecated 4.0 Use Class based routers instead */ function WrapperBuildRoute(&$query) @@ -86,6 +90,18 @@ function WrapperBuildRoute(&$query) return $router->build($query); } +/** + * Wrapper router functions + * + * These functions are proxys for the new router interface + * for old SEF extensions. + * + * @param array &$segments The segments of the URL to parse. + * + * @return array The URL attributes to be used by the application. + * + * @deprecated 4.0 Use Class based routers instead + */ function WrapperParseRoute($segments) { $router = new WrapperRouter; diff --git a/components/com_wrapper/views/wrapper/view.html.php b/components/com_wrapper/views/wrapper/view.html.php index 566a5f37ce2f8..e7559e042fd14 100644 --- a/components/com_wrapper/views/wrapper/view.html.php +++ b/components/com_wrapper/views/wrapper/view.html.php @@ -17,14 +17,20 @@ class WrapperViewWrapper extends JViewLegacy { /** - * @since 1.5 + * Execute and display a template script. + * + * @param string $tpl The name of the template file to parse; automatically searches through the template paths. + * + * @return mixed A string if successful, otherwise a Error object. + * + * @since 1.5 */ public function display($tpl = null) { $app = JFactory::getApplication(); $params = $app->getParams(); - // because the application sets a default page title, we need to get it + // Because the application sets a default page title, we need to get it // right from the menu item itself $title = $params->get('page_title', ''); @@ -59,7 +65,8 @@ public function display($tpl = null) } $wrapper = new stdClass; - // auto height control + + // Auto height control if ($params->def('height_auto')) { $wrapper->load = 'onload="iFrameHeight()"'; @@ -73,10 +80,10 @@ public function display($tpl = null) if ($params->def('add_scheme', 1)) { - // adds 'http://' if none is set + // Adds 'http://' if none is set if (substr($url, 0, 1) == '/') { - // relative url in component. use server http_host. + // Relative url in component. Use server http_host. $wrapper->url = 'http://' . $_SERVER['HTTP_HOST'] . $url; } elseif (!strstr($url, 'http') && !strstr($url, 'https')) @@ -93,7 +100,7 @@ public function display($tpl = null) $wrapper->url = $url; } - //Escape strings for HTML output + // Escape strings for HTML output $this->pageclass_sfx = htmlspecialchars($params->get('pageclass_sfx')); $this->params = &$params; $this->wrapper = &$wrapper;