[Joomla-commits] r21305 - in development/branches/platform/libraries/joomla: . access application application/cli application/component application/input application/module base cache cache/controller cache/storage cache/storage/helpers client database database/database database/table document document/error document/feed document/feed/renderer document/html document/html/renderer document/json document/raw document/xml environment error event filesystem filesystem/archive filesystem/streams filesystem/support filter form form/fields form/rules html html/html html/parameter html/parameter/element html/toolbar html/toolbar/button installer installer/adapters language log log/loggers mail plugin registry registry/format session session/storage updater updater/adapters user utilities
eddi...@jcode001.directrouter.com
Date: 2011-05-09 19:53:59 -0500 (Mon, 09 May 2011)
New Revision: 21305
Modified:
development/branches/platform/libraries/joomla/access/access.php
development/branches/platform/libraries/joomla/access/rule.php
development/branches/platform/libraries/joomla/access/rules.php
development/branches/platform/libraries/joomla/application/application.php
development/branches/platform/libraries/joomla/application/categories.php
development/branches/platform/libraries/joomla/application/cli.php
development/branches/platform/libraries/joomla/application/cli/daemon.php
development/branches/platform/libraries/joomla/application/component/controller.php
development/branches/platform/libraries/joomla/application/component/controlleradmin.php
development/branches/platform/libraries/joomla/application/component/controllerform.php
development/branches/platform/libraries/joomla/application/component/helper.php
development/branches/platform/libraries/joomla/application/component/model.php
development/branches/platform/libraries/joomla/application/component/modeladmin.php
development/branches/platform/libraries/joomla/application/component/modelform.php
development/branches/platform/libraries/joomla/application/component/modelitem.php
development/branches/platform/libraries/joomla/application/component/modellist.php
development/branches/platform/libraries/joomla/application/component/view.php
development/branches/platform/libraries/joomla/application/helper.php
development/branches/platform/libraries/joomla/application/input.php
development/branches/platform/libraries/joomla/application/input/cli.php
development/branches/platform/libraries/joomla/application/menu.php
development/branches/platform/libraries/joomla/application/module/helper.php
development/branches/platform/libraries/joomla/application/pathway.php
development/branches/platform/libraries/joomla/application/router.php
development/branches/platform/libraries/joomla/base/adapter.php
development/branches/platform/libraries/joomla/base/adapterinstance.php
development/branches/platform/libraries/joomla/base/node.php
development/branches/platform/libraries/joomla/base/object.php
development/branches/platform/libraries/joomla/base/observable.php
development/branches/platform/libraries/joomla/base/observer.php
development/branches/platform/libraries/joomla/base/tree.php
development/branches/platform/libraries/joomla/cache/cache.php
development/branches/platform/libraries/joomla/cache/controller.php
development/branches/platform/libraries/joomla/cache/controller/callback.php
development/branches/platform/libraries/joomla/cache/controller/output.php
development/branches/platform/libraries/joomla/cache/controller/page.php
development/branches/platform/libraries/joomla/cache/controller/view.php
development/branches/platform/libraries/joomla/cache/storage.php
development/branches/platform/libraries/joomla/cache/storage/apc.php
development/branches/platform/libraries/joomla/cache/storage/cachelite.php
development/branches/platform/libraries/joomla/cache/storage/eaccelerator.php
development/branches/platform/libraries/joomla/cache/storage/file.php
development/branches/platform/libraries/joomla/cache/storage/helpers/helper.php
development/branches/platform/libraries/joomla/cache/storage/memcache.php
development/branches/platform/libraries/joomla/cache/storage/wincache.php
development/branches/platform/libraries/joomla/cache/storage/xcache.php
development/branches/platform/libraries/joomla/client/ftp.php
development/branches/platform/libraries/joomla/client/helper.php
development/branches/platform/libraries/joomla/client/http.php
development/branches/platform/libraries/joomla/client/ldap.php
development/branches/platform/libraries/joomla/database/database.php
development/branches/platform/libraries/joomla/database/database/mysql.php
development/branches/platform/libraries/joomla/database/database/mysqli.php
development/branches/platform/libraries/joomla/database/database/sqlazure.php
development/branches/platform/libraries/joomla/database/database/sqlazurequery.php
development/branches/platform/libraries/joomla/database/database/sqlsrv.php
development/branches/platform/libraries/joomla/database/database/sqlsrvquery.php
development/branches/platform/libraries/joomla/database/databasequery.php
development/branches/platform/libraries/joomla/database/table.php
development/branches/platform/libraries/joomla/database/table/asset.php
development/branches/platform/libraries/joomla/database/table/category.php
development/branches/platform/libraries/joomla/database/table/content.php
development/branches/platform/libraries/joomla/database/table/extension.php
development/branches/platform/libraries/joomla/database/table/language.php
development/branches/platform/libraries/joomla/database/table/menu.php
development/branches/platform/libraries/joomla/database/table/menutype.php
development/branches/platform/libraries/joomla/database/table/module.php
development/branches/platform/libraries/joomla/database/table/session.php
development/branches/platform/libraries/joomla/database/table/update.php
development/branches/platform/libraries/joomla/database/table/user.php
development/branches/platform/libraries/joomla/database/table/usergroup.php
development/branches/platform/libraries/joomla/database/table/viewlevel.php
development/branches/platform/libraries/joomla/database/tablenested.php
development/branches/platform/libraries/joomla/document/document.php
development/branches/platform/libraries/joomla/document/error/error.php
development/branches/platform/libraries/joomla/document/feed/feed.php
development/branches/platform/libraries/joomla/document/feed/renderer/atom.php
development/branches/platform/libraries/joomla/document/feed/renderer/rss.php
development/branches/platform/libraries/joomla/document/html/html.php
development/branches/platform/libraries/joomla/document/html/renderer/component.php
development/branches/platform/libraries/joomla/document/html/renderer/head.php
development/branches/platform/libraries/joomla/document/html/renderer/message.php
development/branches/platform/libraries/joomla/document/html/renderer/module.php
development/branches/platform/libraries/joomla/document/html/renderer/modules.php
development/branches/platform/libraries/joomla/document/json/json.php
development/branches/platform/libraries/joomla/document/raw/raw.php
development/branches/platform/libraries/joomla/document/renderer.php
development/branches/platform/libraries/joomla/document/xml/xml.php
development/branches/platform/libraries/joomla/environment/browser.php
development/branches/platform/libraries/joomla/environment/request.php
development/branches/platform/libraries/joomla/environment/response.php
development/branches/platform/libraries/joomla/environment/uri.php
development/branches/platform/libraries/joomla/error/error.php
development/branches/platform/libraries/joomla/error/exception.php
development/branches/platform/libraries/joomla/error/profiler.php
development/branches/platform/libraries/joomla/event/dispatcher.php
development/branches/platform/libraries/joomla/event/event.php
development/branches/platform/libraries/joomla/factory.php
development/branches/platform/libraries/joomla/filesystem/archive.php
development/branches/platform/libraries/joomla/filesystem/archive/bzip2.php
development/branches/platform/libraries/joomla/filesystem/archive/gzip.php
development/branches/platform/libraries/joomla/filesystem/archive/tar.php
development/branches/platform/libraries/joomla/filesystem/archive/zip.php
development/branches/platform/libraries/joomla/filesystem/file.php
development/branches/platform/libraries/joomla/filesystem/folder.php
development/branches/platform/libraries/joomla/filesystem/helper.php
development/branches/platform/libraries/joomla/filesystem/path.php
development/branches/platform/libraries/joomla/filesystem/stream.php
development/branches/platform/libraries/joomla/filesystem/streams/string.php
development/branches/platform/libraries/joomla/filesystem/support/stringcontroller.php
development/branches/platform/libraries/joomla/filter/filterinput.php
development/branches/platform/libraries/joomla/filter/filteroutput.php
development/branches/platform/libraries/joomla/form/fields/accesslevel.php
development/branches/platform/libraries/joomla/form/fields/cachehandler.php
development/branches/platform/libraries/joomla/form/fields/calendar.php
development/branches/platform/libraries/joomla/form/fields/category.php
development/branches/platform/libraries/joomla/form/fields/checkbox.php
development/branches/platform/libraries/joomla/form/fields/checkboxes.php
development/branches/platform/libraries/joomla/form/fields/combo.php
development/branches/platform/libraries/joomla/form/fields/componentlayout.php
development/branches/platform/libraries/joomla/form/fields/contentlanguage.php
development/branches/platform/libraries/joomla/form/fields/editor.php
development/branches/platform/libraries/joomla/form/fields/editors.php
development/branches/platform/libraries/joomla/form/fields/email.php
development/branches/platform/libraries/joomla/form/fields/file.php
development/branches/platform/libraries/joomla/form/fields/filelist.php
development/branches/platform/libraries/joomla/form/fields/folderlist.php
development/branches/platform/libraries/joomla/form/fields/groupedlist.php
development/branches/platform/libraries/joomla/form/fields/helpsite.php
development/branches/platform/libraries/joomla/form/fields/hidden.php
development/branches/platform/libraries/joomla/form/fields/imagelist.php
development/branches/platform/libraries/joomla/form/fields/integer.php
development/branches/platform/libraries/joomla/form/fields/language.php
development/branches/platform/libraries/joomla/form/fields/list.php
development/branches/platform/libraries/joomla/form/fields/media.php
development/branches/platform/libraries/joomla/form/fields/menu.php
development/branches/platform/libraries/joomla/form/fields/menuitem.php
development/branches/platform/libraries/joomla/form/fields/modulelayout.php
development/branches/platform/libraries/joomla/form/fields/password.php
development/branches/platform/libraries/joomla/form/fields/radio.php
development/branches/platform/libraries/joomla/form/fields/rules.php
development/branches/platform/libraries/joomla/form/fields/sessionhandler.php
development/branches/platform/libraries/joomla/form/fields/spacer.php
development/branches/platform/libraries/joomla/form/fields/sql.php
development/branches/platform/libraries/joomla/form/fields/tel.php
development/branches/platform/libraries/joomla/form/fields/templatestyle.php
development/branches/platform/libraries/joomla/form/fields/text.php
development/branches/platform/libraries/joomla/form/fields/textarea.php
development/branches/platform/libraries/joomla/form/fields/timezone.php
development/branches/platform/libraries/joomla/form/fields/url.php
development/branches/platform/libraries/joomla/form/fields/user.php
development/branches/platform/libraries/joomla/form/fields/usergroup.php
development/branches/platform/libraries/joomla/form/form.php
development/branches/platform/libraries/joomla/form/formfield.php
development/branches/platform/libraries/joomla/form/formrule.php
development/branches/platform/libraries/joomla/form/helper.php
development/branches/platform/libraries/joomla/form/rules/boolean.php
development/branches/platform/libraries/joomla/form/rules/email.php
development/branches/platform/libraries/joomla/form/rules/equals.php
development/branches/platform/libraries/joomla/form/rules/rules.php
development/branches/platform/libraries/joomla/form/rules/tel.php
development/branches/platform/libraries/joomla/form/rules/username.php
development/branches/platform/libraries/joomla/html/editor.php
development/branches/platform/libraries/joomla/html/html.php
development/branches/platform/libraries/joomla/html/html/access.php
development/branches/platform/libraries/joomla/html/html/behavior.php
development/branches/platform/libraries/joomla/html/html/category.php
development/branches/platform/libraries/joomla/html/html/content.php
development/branches/platform/libraries/joomla/html/html/contentlanguage.php
development/branches/platform/libraries/joomla/html/html/form.php
development/branches/platform/libraries/joomla/html/html/grid.php
development/branches/platform/libraries/joomla/html/html/image.php
development/branches/platform/libraries/joomla/html/html/jgrid.php
development/branches/platform/libraries/joomla/html/html/list.php
development/branches/platform/libraries/joomla/html/html/menu.php
development/branches/platform/libraries/joomla/html/html/number.php
development/branches/platform/libraries/joomla/html/html/rules.php
development/branches/platform/libraries/joomla/html/html/select.php
development/branches/platform/libraries/joomla/html/html/sliders.php
development/branches/platform/libraries/joomla/html/html/string.php
development/branches/platform/libraries/joomla/html/html/tabs.php
development/branches/platform/libraries/joomla/html/html/tel.php
development/branches/platform/libraries/joomla/html/pagination.php
development/branches/platform/libraries/joomla/html/pane.php
development/branches/platform/libraries/joomla/html/parameter.php
development/branches/platform/libraries/joomla/html/parameter/element.php
development/branches/platform/libraries/joomla/html/parameter/element/contentlanguages.php
development/branches/platform/libraries/joomla/html/parameter/element/folderlist.php
development/branches/platform/libraries/joomla/html/parameter/element/hidden.php
development/branches/platform/libraries/joomla/html/parameter/element/list.php
development/branches/platform/libraries/joomla/html/parameter/element/password.php
development/branches/platform/libraries/joomla/html/parameter/element/sql.php
development/branches/platform/libraries/joomla/html/parameter/element/timezones.php
development/branches/platform/libraries/joomla/html/toolbar.php
development/branches/platform/libraries/joomla/html/toolbar/button.php
development/branches/platform/libraries/joomla/html/toolbar/button/confirm.php
development/branches/platform/libraries/joomla/html/toolbar/button/custom.php
development/branches/platform/libraries/joomla/html/toolbar/button/help.php
development/branches/platform/libraries/joomla/html/toolbar/button/link.php
development/branches/platform/libraries/joomla/html/toolbar/button/popup.php
development/branches/platform/libraries/joomla/html/toolbar/button/separator.php
development/branches/platform/libraries/joomla/html/toolbar/button/standard.php
development/branches/platform/libraries/joomla/installer/adapters/component.php
development/branches/platform/libraries/joomla/installer/adapters/file.php
development/branches/platform/libraries/joomla/installer/adapters/language.php
development/branches/platform/libraries/joomla/installer/adapters/library.php
development/branches/platform/libraries/joomla/installer/adapters/module.php
development/branches/platform/libraries/joomla/installer/adapters/package.php
development/branches/platform/libraries/joomla/installer/adapters/plugin.php
development/branches/platform/libraries/joomla/installer/adapters/template.php
development/branches/platform/libraries/joomla/installer/helper.php
development/branches/platform/libraries/joomla/installer/installer.php
development/branches/platform/libraries/joomla/installer/librarymanifest.php
development/branches/platform/libraries/joomla/installer/packagemanifest.php
development/branches/platform/libraries/joomla/language/help.php
development/branches/platform/libraries/joomla/language/helper.php
development/branches/platform/libraries/joomla/language/language.php
development/branches/platform/libraries/joomla/language/latin_transliterate.php
development/branches/platform/libraries/joomla/log/log.php
development/branches/platform/libraries/joomla/log/logger.php
development/branches/platform/libraries/joomla/log/loggers/database.php
development/branches/platform/libraries/joomla/log/loggers/echo.php
development/branches/platform/libraries/joomla/log/loggers/formattedtext.php
development/branches/platform/libraries/joomla/log/loggers/syslog.php
development/branches/platform/libraries/joomla/log/loggers/w3c.php
development/branches/platform/libraries/joomla/mail/helper.php
development/branches/platform/libraries/joomla/mail/mail.php
development/branches/platform/libraries/joomla/methods.php
development/branches/platform/libraries/joomla/plugin/helper.php
development/branches/platform/libraries/joomla/plugin/plugin.php
development/branches/platform/libraries/joomla/registry/format.php
development/branches/platform/libraries/joomla/registry/format/ini.php
development/branches/platform/libraries/joomla/registry/format/json.php
development/branches/platform/libraries/joomla/registry/format/php.php
development/branches/platform/libraries/joomla/registry/format/xml.php
development/branches/platform/libraries/joomla/registry/registry.php
development/branches/platform/libraries/joomla/session/session.php
development/branches/platform/libraries/joomla/session/storage.php
development/branches/platform/libraries/joomla/session/storage/apc.php
development/branches/platform/libraries/joomla/session/storage/database.php
development/branches/platform/libraries/joomla/session/storage/eaccelerator.php
development/branches/platform/libraries/joomla/session/storage/memcache.php
development/branches/platform/libraries/joomla/session/storage/none.php
development/branches/platform/libraries/joomla/session/storage/wincache.php
development/branches/platform/libraries/joomla/session/storage/xcache.php
development/branches/platform/libraries/joomla/updater/adapters/collection.php
development/branches/platform/libraries/joomla/updater/update.php
development/branches/platform/libraries/joomla/updater/updateadapter.php
development/branches/platform/libraries/joomla/updater/updater.php
development/branches/platform/libraries/joomla/user/authentication.php
development/branches/platform/libraries/joomla/user/helper.php
development/branches/platform/libraries/joomla/user/user.php
development/branches/platform/libraries/joomla/utilities/arrayhelper.php
development/branches/platform/libraries/joomla/utilities/date.php
development/branches/platform/libraries/joomla/utilities/simplecrypt.php
development/branches/platform/libraries/joomla/utilities/simplexml.php
development/branches/platform/libraries/joomla/utilities/string.php
development/branches/platform/libraries/joomla/utilities/utility.php
development/branches/platform/libraries/joomla/utilities/xmlelement.php
Log:
Code cleaning.
Modified: development/branches/platform/libraries/joomla/access/access.php
===================================================================
--- development/branches/platform/libraries/joomla/access/access.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/access/access.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,7 +28,7 @@
protected static $viewLevels = array();
/**
- * @var array Array of rules for the asset
+ * @var array Array of rules for the asset
* @since 11.1
*/
protected static $assetRules = array();
@@ -36,12 +36,12 @@
/**
* Method to check if a user is authorised to perform an action, optionally on an asset.
*
- * @param integer $userId Id of the user for which to check authorisation.
- * @param string $action The name of the action to authorise.
- * @param mixed $asset Integer asset id or the name of the asset as a string. Defaults to the global asset node.
+ * @param integer $userId Id of the user for which to check authorisation.
+ * @param string $action The name of the action to authorise.
+ * @param mixed $asset Integer asset id or the name of the asset as a string. Defaults to the global asset node.
*
- * @return boolean True if authorised.
- * @since 11.1
+ * @return boolean True if authorised.
+ * @since 11.1
*/
public static function check($userId, $action, $asset = null)
{
@@ -71,12 +71,12 @@
/**
* Method to check if a group is authorised to perform an action, optionally on an asset.
*
- * @param integer $groupId The path to the group for which to check authorisation.
- * @param string $action The name of the action to authorise.
- * @param mixed $asset Integer asset id or the name of the asset as a string. Defaults to the global asset node.
+ * @param integer $groupId The path to the group for which to check authorisation.
+ * @param string $action The name of the action to authorise.
+ * @param mixed $asset Integer asset id or the name of the asset as a string. Defaults to the global asset node.
*
- * @return boolean True if authorised.
- * @since 11.1
+ * @return boolean True if authorised.
+ * @since 11.1
*/
public static function checkGroup($groupId, $action, $asset = null)
{
@@ -105,10 +105,10 @@
* Gets the parent groups that a leaf group belongs to in its branch back to the root of the tree
* (including the leaf group id).
*
- * @param mixed $groupId An integer or array of integers representing the identities to check.
+ * @param mixed $groupId An integer or array of integers representing the identities to check.
*
- * @return mixed True if allowed, false for an explicit deny, null for an implicit deny.
- * @since 11.1
+ * @return mixed True if allowed, false for an explicit deny, null for an implicit deny.
+ * @since 11.1
*/
protected static function getGroupPath($groupId)
{
@@ -149,11 +149,11 @@
* only the rules explicitly set for the asset or the summation of all inherited rules from
* parent assets and explicit rules.
*
- * @param mixed $asset Integer asset id or the name of the asset as a string.
- * @param boolean $recursive True to return the rules object with inherited rules.
+ * @param mixed $asset Integer asset id or the name of the asset as a string.
+ * @param boolean $recursive True to return the rules object with inherited rules.
*
- * @return JRules JRules object for the asset.
- * @since 11.1
+ * @return JRules JRules object for the asset.
+ * @since 11.1
*/
public static function getAssetRules($asset, $recursive = false)
{
@@ -205,11 +205,11 @@
* only the groups explicitly mapped to the user or all groups both explicitly mapped and inherited
* by the user.
*
- * @param integer $userId Id of the user for which to get the list of groups.
- * @param boolean $recursive True to include inherited user groups.
+ * @param integer $userId Id of the user for which to get the list of groups.
+ * @param boolean $recursive True to include inherited user groups.
*
- * @return array List of user group ids to which the user is mapped.
- * @since 11.1
+ * @return array List of user group ids to which the user is mapped.
+ * @since 11.1
*/
public static function getGroupsByUser($userId, $recursive = true)
{
@@ -266,12 +266,12 @@
/**
* Method to return a list of user Ids contained in a Group
*
- * @param integer $groupId The group Id
- * @param boolean $recursive Recursively include all child groups (optional)
+ * @param integer $groupId The group Id
+ * @param boolean $recursive Recursively include all child groups (optional)
*
- * @return array
- * @since 11.1
- *
+ * @return array
+ * @since 11.1
+ *
* @todo This method should move somewhere else?
*/
public static function getUsersByGroup($groupId, $recursive = false)
@@ -302,10 +302,10 @@
/**
* Method to return a list of view levels for which the user is authorised.
*
- * @param integer $userId Id of the user for which to get the list of authorised view levels.
+ * @param integer $userId Id of the user for which to get the list of authorised view levels.
*
- * @return array List of view levels for which the user is authorised.
- * @since 11.1
+ * @return array List of view levels for which the user is authorised.
+ * @since 11.1
*/
public static function getAuthorisedViewLevels($userId)
{
@@ -357,11 +357,11 @@
/**
* Method to return a list of actions for which permissions can be set given a component and section.
*
- * @param string $component The component from which to retrieve the actions.
- * @param string $section The name of the section within the component from which to retrieve the actions.
+ * @param string $component The component from which to retrieve the actions.
+ * @param string $section The name of the section within the component from which to retrieve the actions.
*
- * @return array List of actions available for the given component and section.
- * @since 11.1
+ * @return array List of actions available for the given component and section.
+ * @since 11.1
*/
public static function getActions($component, $section = 'component')
{
Modified: development/branches/platform/libraries/joomla/access/rule.php
===================================================================
--- development/branches/platform/libraries/joomla/access/rule.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/access/rule.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,7 +28,11 @@
* The input array must be in the form: array(-42 => true, 3 => true, 4 => false)
* or an equivalent JSON encoded string.
*
- * @param mixed A JSON format string (probably from the database), or a named array.
+ * @param mixed A JSON format string (probably from the database), or a named array.
+ *
+ * @return JRule
+ *
+ * @since 11.1
*/
public function __construct($identities)
{
@@ -43,7 +47,9 @@
/**
* Get the data for the action.
*
- * @return array A named array
+ * @return array A named array
+ *
+ * @since 11.1
*/
public function getData()
{
@@ -52,9 +58,12 @@
/**
* Merges the identities
- *
- * @param mixed An integer or array of integers representing the identities to check.
- *
+ *
+ * @param mixed $identities An integer or array of integers representing the identities to check.
+ *
+ * @return void
+ *
+ * @since 11.1
*/
public function mergeIdentities($identities)
{
@@ -73,9 +82,12 @@
/**
* Merges the values for an identity.
*
- * @param integer The identity.
- * @param boolean The value for the identity (true == allow, false == deny).
- *
+ * @param integer $identity The identity.
+ * @param boolean $allow The value for the identity (true == allow, false == deny).
+ *
+ * @return void
+ *
+ * @since 11.1
*/
public function mergeIdentity($identity, $allow)
{
@@ -101,9 +113,11 @@
* The identity is an integer where +ve represents a user group,
* and -ve represents a user.
*
- * @param mixed An integer or array of integers representing the identities to check.
+ * @param mixed $identities An integer or array of integers representing the identities to check.
*
- * @return mixed True if allowed, false for an explicit deny, null for an implicit deny.
+ * @return mixed True if allowed, false for an explicit deny, null for an implicit deny.
+ *
+ * @since 11.1
*/
public function allow($identities)
{
@@ -142,7 +156,9 @@
/**
* Convert this object into a JSON encoded string.
*
- * @return string JSON encoded string
+ * @return string JSON encoded string
+ *
+ * @since 11.1
*/
public function __toString()
{
Modified: development/branches/platform/libraries/joomla/access/rules.php
===================================================================
--- development/branches/platform/libraries/joomla/access/rules.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/access/rules.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,7 +19,7 @@
class JRules
{
/**
- * @var array A named array
+ * @var array A named array.
* @since 11.1
*/
protected $_data = array();
@@ -30,7 +30,11 @@
* The input array must be in the form: array('action' => array(-42 => true, 3 => true, 4 => false))
* or an equivalent JSON encoded string, or an object where properties are arrays.
*
- * @param mixed A JSON format string (probably from the database) or a nested array.
+ * @param mixed A JSON format string (probably from the database) or a nested array.
+ *
+ * @return JRules
+ *
+ * @since 11.1
*/
public function __construct($input = '')
{
@@ -54,7 +58,9 @@
/**
* Get the data for the action.
*
- * @return array A named array of JRule objects.
+ * @return array A named array of JRule objects.
+ *
+ * @since 11.1
*/
public function getData()
{
@@ -64,7 +70,7 @@
/**
* Method to merge a collection of JRules.
*
- * @param mixed
+ * @param mixed
*/
public function mergeCollection($input)
{
@@ -80,7 +86,7 @@
/**
* Method to merge actions with this object.
*
- * @param mixed
+ * @param mixed
*/
public function merge($actions)
{
@@ -105,8 +111,12 @@
}
/**
- * @param string The name of the action.
- * @param array An array of identities
+ * @param string $action The name of the action.
+ * @param array $identities An array of identities
+ *
+ * @return void
+ *
+ * @since 11.1
*/
public function mergeAction($action, $identities)
{
@@ -128,10 +138,12 @@
* The identity is an integer where +ve represents a user group,
* and -ve represents a user.
*
- * @param string The name of the action.
- * @param mixed An integer representing the identity, or an array of identities
+ * @param string $action The name of the action.
+ * @param mixed $identity An integer representing the identity, or an array of identities
*
- * @return mixed
+ * @return mixed
+ *
+ * @since 11.1
*/
public function allow($action, $identity)
{
@@ -139,15 +151,18 @@
if (isset($this->_data[$action])) {
return $this->_data[$action]->allow($identity);
}
+
return null;
}
/**
* Get the allowed actions for an identity.
*
- * @param mixed An integer representing the identity, or an array of identities
- *
- * @return object Allowed actions for the identity or identities
+ * @param mixed $identity An integer representing the identity, or an array of identities
+ *
+ * @return object Allowed actions for the identity or identities
+ *
+ * @since 11.1
*/
function getAllowed($identity)
{
@@ -165,7 +180,9 @@
/**
* Magic method to convert the object to JSON string representation.
*
- * @return string JSON representation of the actions array
+ * @return string JSON representation of the actions array
+ *
+ * @since 11.1
*/
public function __toString()
{
Modified: development/branches/platform/libraries/joomla/application/application.php
===================================================================
--- development/branches/platform/libraries/joomla/application/application.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/application.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -78,10 +78,10 @@
/**
* Class constructor.
*
- * @param array $config A configuration array including optional elements such as session
+ * @param array $config A configuration array including optional elements such as session
* session_name, clientId and others. This is not exhaustive.
*
- * @since 11.1
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -125,12 +125,12 @@
* Returns the global JApplication object, only creating it if it
* doesn't already exist.
*
- * @param mixed $client A client identifier or name.
- * @param array $config An optional associative array of configuration settings.
- * @param strong $prefx A prefix for class names
- *
- * @return JApplication A JApplication object.
- * @since 11.1
+ * @param mixed $client A client identifier or name.
+ * @param array $config An optional associative array of configuration settings.
+ * @param strong $prefx A prefix for class names
+ *
+ * @return JApplication A JApplication object.
+ * @since 11.1
*/
public static function getInstance($client, $config = array(), $prefix = 'J')
{
@@ -167,9 +167,9 @@
/**
* Initialise the application.
*
- * @param array $options An optional associative array of configuration settings.
- *
- * @since 11.1
+ * @param array $options An optional associative array of configuration settings.
+ *
+ * @since 11.1
*/
public function initialise($options = array())
{
@@ -207,9 +207,9 @@
* component should receive the request. The component optional parameters
* are then set in the request object to be processed when the application is being
* dispatched.
- *
- * @return void;
- * @since 11.1
+ *
+ * @return void;
+ * @since 11.1
*/
public function route()
{
@@ -233,10 +233,10 @@
* mapping them to a component. If the component does not exist, it handles
* determining a default component to dispatch.
*
- * @param string $component The component to dispatch.
+ * @param string $component The component to dispatch.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function dispatch($component = null)
{
@@ -260,8 +260,8 @@
* placeholders, retrieving data from the document and pushing it into
* the JResponse buffer.
*
- * @return void;
- * @since 11.1
+ * @return void;
+ * @since 11.1
*/
public function render()
{
@@ -291,9 +291,9 @@
/**
* Exit the application.
*
- * @param integer $code Exit code
- *
- * @return void Exits the application.
+ * @param integer $code Exit code
+ *
+ * @return void Exits the application.
* @since 11.1
*/
public function close($code = 0)
@@ -310,16 +310,17 @@
* code in the header pointing to the new location. If the headers have already been
* sent this will be accomplished using a JavaScript statement.
*
- * @param string $url The URL to redirect to. Can only be http/https URL
- * @param string $msg An optional message to display on redirect.
- * @param string $msgType An optional message type. Defaults to message.
- * @param boolean $moved True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
- *
+ * @param string $url The URL to redirect to. Can only be http/https URL
+ * @param string $msg An optional message to display on redirect.
+ * @param string $msgType An optional message type. Defaults to message.
+ * @param boolean $moved True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
+ *
* @see JApplication::enqueueMessage()
*
- * @return void calls exit().
- * @since 11.1
-
+ * @return void Calls exit().
+ *
+ * @see JApplication::enqueueMessage()
+ * @since 11.1
*/
public function redirect($url, $msg='', $msgType='message', $moved = false)
{
@@ -394,11 +395,11 @@
/**
* Enqueue a system message.
*
- * @param string $msg The message to enqueue.
- * @param string $type The message type. Default is message.
- *
- * @return void
- * @since 11.1
+ * @param string $msg The message to enqueue.
+ * @param string $type The message type. Default is message.
+ *
+ * @return void
+ * @since 11.1
*/
public function enqueueMessage($msg, $type = 'message')
{
@@ -419,8 +420,8 @@
/**
* Get the system message queue.
*
- * @return ?? The system message queue.
- * @since 11.1
+ * @return ?? The system message queue.
+ * @since 11.1
*/
public function getMessageQueue()
{
@@ -439,14 +440,15 @@
/**
* Gets a configuration value.
- *
+ *
* An example is in application/japplication-getcfg.php Getting a configuration
*
- * @param string The name of the value to get.
- * @param string Default value to return
- *
- * @return mixed The user state.
- * @since 11.1
+ * @param string The name of the value to get.
+ * @param string Default value to return
+ *
+ * @return mixed The user state.
+ *
+ * @since 11.1
*/
public function getCfg($varname, $default=null)
{
@@ -460,8 +462,8 @@
* The dispatcher name is by default parsed using the classname, or it can be set
* by passing a $config['name'] in the class constructor.
*
- * @return string The name of the dispatcher.
- * @since 11.1
+ * @return string The name of the dispatcher.
+ * @since 11.1
*/
public function getName()
{
@@ -481,10 +483,10 @@
/**
* Gets a user state.
*
- * @param string The path of the state.
- *
- * @return mixed The user state or null.
- * @since 11.1
+ * @param string The path of the state.
+ *
+ * @return mixed The user state or null.
+ * @since 11.1
*/
public function getUserState($key)
{
@@ -501,11 +503,11 @@
/**
* Sets the value of a user state variable.
*
- * @param string The path of the state.
- * @param string The value of the variable.
- *
- * @return mixed The previous state, if one existed.
- * @since 11.1
+ * @param string The path of the state.
+ * @param string The value of the variable.
+ *
+ * @return mixed The previous state, if one existed.
+ * @since 11.1
*/
public function setUserState($key, $value)
{
@@ -522,13 +524,13 @@
/**
* Gets the value of a user state variable.
*
- * @param string $key The key of the user state variable.
- * @param string $request The name of the variable passed in a request.
- * @param string $default The default value for the variable if not found. Optional.
- * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
- *
- * @return The request user state.
- * @since 11.1
+ * @param string $key The key of the user state variable.
+ * @param string $request The name of the variable passed in a request.
+ * @param string $default The default value for the variable if not found. Optional.
+ * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
+ *
+ * @return The request user state.
+ * @since 11.1
*/
public function getUserStateFromRequest($key, $request, $default = null, $type = 'none')
{
@@ -550,11 +552,11 @@
/**
* Registers a handler to a particular event group.
*
- * @param string $event The event name.
- * @param mixed $handler The handler, a function or an instance of a event object.
- *
- * @return void
- * @since 11.1
+ * @param string $event The event name.
+ * @param mixed $handler The handler, a function or an instance of a event object.
+ *
+ * @return void
+ * @since 11.1
*/
public static function registerEvent($event, $handler)
{
@@ -565,11 +567,11 @@
/**
* Calls all handlers associated with an event group.
*
- * @param string $event The event name.
- * @param array $args An array of arguments.
- *
- * @return array An array of results from each function call.
- * @since 11.1
+ * @param string $event The event name.
+ * @param array $args An array of arguments.
+ *
+ * @return array An array of results from each function call.
+ * @since 11.1
*/
function triggerEvent($event, $args=null)
{
@@ -590,11 +592,11 @@
* validation. Successful validation will update the current session with
* the user details.
*
- * @param array $credentials Array('username' => string, 'password' => string)
- * @param array $options Array('remember' => boolean)
+ * @param array $credentials Array('username' => string, 'password' => string)
+ * @param array $options Array('remember' => boolean)
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function login($credentials, $options = array())
{
@@ -664,11 +666,11 @@
* should be done in the plugin as this provides the ability to give
* much more information about why the routine may have failed.
*
- * @param integer $userid The user to load - Can be an integer or string - If string, it is converted to ID automatically
- * @param array $options Array('clientid' => array of client id's)
- *
- * @return boolean True on success
- * @since 11.1
+ * @param integer $userid The user to load - Can be an integer or string - If string, it is converted to ID automatically
+ * @param array $options Array('clientid' => array of client id's)
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function logout($userid = null, $options = array())
{
@@ -712,11 +714,11 @@
/**
* Gets the name of the current template.
- *
- * @param array $params An optional associative array of configuration settings
*
- * @return string System is the fallback.
- * @since 11.1
+ * @param array $params An optional associative array of configuration settings
+ *
+ * @return string System is the fallback.
+ * @since 11.1
*/
public function getTemplate($params = false)
{
@@ -726,11 +728,11 @@
/**
* Returns the application JRouter object.
*
- * @param string $name The name of the application.
- * @param array $options An optional associative array of configuration settings.
+ * @param string $name The name of the application.
+ * @param array $options An optional associative array of configuration settings.
*
- * @return JRouter A JRouter object
- * @since 11.1
+ * @return JRouter A JRouter object
+ * @since 11.1
*/
static public function getRouter($name = null, array $options = array())
{
@@ -754,10 +756,10 @@
* safe string or returns a URL safe UTF-8 string
* based on the global configuration
*
- * @param string $string String to process
- *
- * @return string Processed string
- * @since 11.1
+ * @param string $string String to process
+ *
+ * @return string Processed string
+ * @since 11.1
*/
static public function stringURLSafe($string)
{
@@ -776,11 +778,11 @@
/**
* Returns the application JPathway object.
*
- * @param string $name The name of the application.
- * @param array $options An optional associative array of configuration settings.
+ * @param string $name The name of the application.
+ * @param array $options An optional associative array of configuration settings.
*
- * @return JPathway. A JPathway object
- * @since 11.1
+ * @return JPathway A JPathway object
+ * @since 11.1
*/
public function getPathway($name = null, $options = array())
{
@@ -801,11 +803,11 @@
/**
* Returns the application JPathway object.
*
- * @param string $name The name of the application/client.
- * @param array $options An optional associative array of configuration settings.
+ * @param string $name The name of the application/client.
+ * @param array $options An optional associative array of configuration settings.
*
- * @return JMenu JMenu object.
- * @since 11.1
+ * @return JMenu JMenu object.
+ * @since 11.1
*/
public function getMenu($name = null, $options = array())
{
@@ -826,10 +828,10 @@
/**
* Provides a secure hash based on a seed
*
- * @param string $seed Seed string.
- *
- * @return string A secure hash
- * @since 11.1
+ * @param string $seed Seed string.
+ *
+ * @return string A secure hash
+ * @since 11.1
*/
public static function getHash($seed)
{
@@ -841,10 +843,10 @@
/**
* Create the configuration registry.
*
- * @param string $file The path to the configuration file
- * .
- * return object A JConfig object
- * @since 11.1
+ * @param string $file The path to the configuration file
+ *
+ * return object A JConfig object
+ * @since 11.1
*/
protected function _createConfiguration($file)
{
@@ -872,10 +874,10 @@
* If a new session, a session id is generated and a record is created in
* the #__sessions table.
*
- * @param string $name The sessions name.
- *
- * @return JSession JSession on success. May call exit() on database error.
- * @since 11.1
+ * @param string $name The sessions name.
+ *
+ * @return JSession JSession on success. May call exit() on database error.
+ * @since 11.1
*/
protected function _createSession($name)
{
@@ -933,8 +935,8 @@
* If the session record doesn't exist, initialise it.
* If session is new, create session variables
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function checkSession()
{
@@ -980,8 +982,8 @@
/**
* Gets the client id of the current running application.
*
- * @return integer A client identifier.
- * @since 11.1
+ * @return integer A client identifier.
+ * @since 11.1
*/
public function getClientId()
{
@@ -991,44 +993,41 @@
/**
* Is admin interface?
*
- * @return boolean True if this application is administrator.
- * @since 11.1
+ * @return boolean True if this application is administrator.
+ * @since 11.1
*/
public function isAdmin()
{
-
return ($this->_clientId == 1);
}
/**
* Is site interface?
*
- * @return boolean True if this application is site.
- * @since 11.1
+ * @return boolean True if this application is site.
+ * @since 11.1
*/
public function isSite()
{
-
return ($this->_clientId == 0);
}
/**
* Method to determine if the host OS is Windows
*
- * @return boolean True if Windows OS
- * @since 11.1
+ * @return boolean True if Windows OS
+ * @since 11.1
*/
static function isWinOS()
{
-
return strtoupper(substr(PHP_OS, 0, 3)) === 'WIN';
}
/**
- * Returns the response as a string
+ * Returns the response as a string.
*
- * @return string The response
- * @since 11.1
+ * @return string The response
+ * @since 11.1
*/
public function __toString()
{
Modified: development/branches/platform/libraries/joomla/application/categories.php
===================================================================
--- development/branches/platform/libraries/joomla/application/categories.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/categories.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,7 +21,7 @@
/**
* Array to hold the object instances
*
- * @var array
+ * @var array
* @since 11.1
*/
static $instances = array();
@@ -29,7 +29,7 @@
/**
* Array of category nodes
*
- * @var mixed
+ * @var mixed
* @since 11.1
*/
protected $_nodes;
@@ -76,7 +76,7 @@
/**
* Name of the items state field
- *
+ *
* @var string
* @since 11.1
*/
@@ -93,10 +93,10 @@
/**
* Class constructor
*
- * @param array $options Array of options
+ * @param array $options Array of options
*
- * @return JCategories JCategories object
- * @since 11.1
+ * @return JCategories JCategories object
+ * @since 11.1
*/
public function __construct($options)
{
@@ -115,11 +115,11 @@
/**
* Returns a reference to a JCategories object
*
- * @param string $extension Name of the categories extension
- * @param array $options An array of options
+ * @param string $extension Name of the categories extension
+ * @param array $options An array of options
*
- * @return Jcategories Jcategories object
- * @since 11.1
+ * @return Jcategories Jcategories object
+ * @since 11.1
*/
public static function getInstance($extension, $options = array())
{
@@ -152,11 +152,11 @@
/**
* Loads a specific category and all its children in a JCategoryNode object
*
- * @param mixed $id an optional id integer or equal to 'root'
- * @param boolean $forceload
+ * @param mixed $id an optional id integer or equal to 'root'
+ * @param boolean $forceload
*
- * @return JCategoryNode|null
- * @since 11.1
+ * @return JCategoryNode|null
+ * @since 11.1
*/
public function get($id = 'root', $forceload = false)
{
@@ -187,10 +187,10 @@
/**
* Load
*
- * @param integer $id
+ * @param integer $id
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function _load($id)
{
@@ -333,67 +333,95 @@
class JCategoryNode extends JObject
{
/**
- * @var int Primary key
+ * @var int Primary key
* @since 11.1
*/
public $id = null;
+
public $asset_id = null;
+
public $parent_id = null;
+
public $lft = null;
+
public $rgt = null;
+
public $level = null;
+
public $extension = null;
- /**
+
+ /**
* @var string The menu title for the category (a short name)
* @since 11.1
*/
public $title = null;
- /**
+
+ /**
* @var string The the alias for the category
* @since 11.1
*/
public $alias = null;
+
/**
- * @var string
+ * @var string
*/
public $description = null;
- /**
- * @var boolean
+
+ /**
+ * @var boolean
* @since 11.1
*/
public $published = null;
- /**
- * @var boolean
+
+ /**
+ * @var boolean
* @since 11.1
*/
public $checked_out = 0;
- /**
- * @var time
+
+ /**
+ * @var time
* @since 11.1
*/
public $checked_out_time = 0;
- /**
- * @var int
+
+ /**
+ * @var int
* @since 11.1
*/
public $access = null;
- /**
- * @var string
+
+ /**
+ * @var string
* @since 11.1
*/
+
public $params = null;
+
public $metadesc = null;
+
public $metakey = null;
+
public $metadata = null;
+
public $created_user_id = null;
+
public $created_time = null;
+
public $modified_user_id = null;
+
public $modified_time = null;
+
public $hits = null;
+
public $language = null;
+
public $numitems = null;
+
public $childrennumitems = null;
+
public $slug = null;
+
public $assets = null;
/**
@@ -441,10 +469,10 @@
/**
* Class constructor
*
- * @param $category
+ * @param $category
*
- * @return JCategoryNode
- * @since 11.1
+ * @return JCategoryNode
+ * @since 11.1
*/
public function __construct($category = null, &$constructor = null)
{
@@ -465,10 +493,10 @@
*
* If the category already has a parent, the link is unset
*
- * @param JCategoryNode|null $parent The parent to be setted
+ * @param JCategoryNode|null $parent The parent to be setted
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
function setParent(&$parent)
{
@@ -502,10 +530,10 @@
*
* If the child already has a parent, the link is unset
*
- * @param JNode $child The child to be added.
+ * @param JNode $child The child to be added.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
function addChild(&$child)
{
@@ -517,10 +545,10 @@
/**
* Remove a specific child
*
- * @param integer $id ID of a category
+ * @param integer $id ID of a category
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
function removeChild($id)
{
@@ -531,10 +559,10 @@
/**
* Get the children of this node
*
- * @param boolean $recursive
+ * @param boolean $recursive
*
- * @return array the children
- * @since 11.1
+ * @return array the children
+ * @since 11.1
*/
function &getChildren($recursive = false)
{
@@ -562,8 +590,8 @@
/**
* Get the parent of this node
*
- * @return JNode|null the parent
- * @since 11.1
+ * @return JNode|null the parent
+ * @since 11.1
*/
function &getParent()
{
@@ -573,8 +601,8 @@
/**
* Test if this node has children
*
- * @return bool
- * @since 11.1
+ * @return bool
+ * @since 11.1
*/
function hasChildren()
{
@@ -584,8 +612,8 @@
/**
* Test if this node has a parent
*
- * @return boolean True if there is a parent
- * @since 11.1
+ * @return boolean True if there is a parent
+ * @since 11.1
*/
function hasParent()
{
@@ -595,8 +623,8 @@
/**
* Function to set the left or right sibling of a category
*
- * @param object $sibling JCategoryNode object for the sibling
- * @param boolean $right if set to false, the sibling is the left one
+ * @param object $sibling JCategoryNode object for the sibling
+ * @param boolean $right if set to false, the sibling is the left one
* @return void
*/
function setSibling($sibling, $right = true)
@@ -612,9 +640,9 @@
/**
* Returns the right or left sibling of a category
*
- * @param boolean $right If set to false, returns the left sibling
- *
- * @return JCategoryNode or null JCategoryNode object with the sibling information or
+ * @param boolean $right If set to false, returns the left sibling
+ *
+ * @return JCategoryNode or null JCategoryNode object with the sibling information or
* null if there is no sibling on that side.
*/
function getSibling($right = true)
@@ -638,8 +666,8 @@
/**
* Returns the category parameters
*
- * @return JRegistry
- * @since 11.1
+ * @return JRegistry
+ * @since 11.1
*/
function getParams()
{
@@ -655,8 +683,8 @@
/**
* Returns the category metadata
*
- * @return JRegistry A JRegistry object containing the metadata
- * @since 11.1
+ * @return JRegistry A JRegistry object containing the metadata
+ * @since 11.1
*/
function getMetadata()
{
@@ -672,7 +700,7 @@
/**
* Returns the category path to the root category
*
- * @return array
+ * @return array
*/
function getPath()
{
@@ -682,9 +710,9 @@
/**
* Returns the user that authored the category
*
- * @param boolean $modified_user Returns the modified_user when set to true
- *
- * @return JUser A JUser object containing a userid
+ * @param boolean $modified_user Returns the modified_user when set to true
+ *
+ * @return JUser A JUser object containing a userid
*/
function getAuthor($modified_user = false)
{
Modified: development/branches/platform/libraries/joomla/application/cli/daemon.php
===================================================================
--- development/branches/platform/libraries/joomla/application/cli/daemon.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/cli/daemon.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -35,7 +35,7 @@
);
/**
- * @var boolean True if the daemon is in the process of exiting.
+ * @var bool True if the daemon is in the process of exiting.
* @since 11.1
*/
protected $exiting = false;
@@ -47,7 +47,7 @@
protected $processId = 0;
/**
- * @var boolean True if the daemon is currently running.
+ * @var bool True if the daemon is currently running.
* @since 11.1
*/
protected $running = false;
@@ -144,7 +144,7 @@
* Check to see if the daemon is active. This does not assume that $this daemon is active, but
* only if an instance of the application is active as a daemon.
*
- * @return boolean .True if daemon is active.
+ * @return bool True if daemon is active.
*
* @since 11.1
*/
@@ -188,6 +188,7 @@
* @param mixed $data Either an array or object to be loaded into the configuration object.
*
* @return void
+ *
* @since 11.1
*/
public function loadConfiguration($data)
@@ -291,7 +292,7 @@
/**
* Spawn daemon process.
*
- * @return boolean True if successfully spawned
+ * @return bool True if successfully spawned
*
* @since 11.1
*/
@@ -330,6 +331,7 @@
* Stop daemon process.
*
* @return void
+ *
* @since 11.1
*/
public function stop()
@@ -341,7 +343,7 @@
/**
* Method to change the identity of the daemon process and resources.
*
- * @return boolean True if identitye successfully changed
+ * @return bool True if identitye successfully changed
*
* @since 11.1
* @see posix_setuid()
@@ -397,7 +399,7 @@
/**
* Method to put the application into the background.
*
- * @return boolean
+ * @return bool
*
* @since 11.1
* @throws ApplicationException
@@ -507,6 +509,7 @@
* stat cache. We will probably call this method pretty regularly in our main loop.
*
* @return void
+ *
* @since 11.1
*/
protected function gc()
Modified: development/branches/platform/libraries/joomla/application/cli.php
===================================================================
--- development/branches/platform/libraries/joomla/application/cli.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/cli.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,39 +25,28 @@
class JCli
{
/**
- * The application input object.
- *
- * @var object
+ * @var JInput The application input object.
* @since 11.1
*/
public $input;
/**
- * The application configuration object.
- *
- * @var object
+ * @var JRegistry The application configuration object.
* @since 11.1
*/
protected $config;
/**
- * The name of the program.
- *
* @var JCli The application instance.
* @since 11.1
*/
protected static $instance;
/**
- * The instantiated CLI objects by name.
- *
- * @var array
- * @since 11.1
- */
-
- /**
* Class constructor.
*
+ * @return void
+ *
* @since 11.1
*/
protected function __construct()
@@ -90,7 +79,7 @@
*
* This method must be invoked as: $cli = JCli::getInstance();
*
- * @return JCli A JCli object
+ * @return JCli A JCli object
* @since 11.1
*/
public static function & getInstance()
@@ -107,6 +96,7 @@
* Execute the application.
*
* @return void
+ *
* @since 11.1
*/
public function execute()
@@ -120,6 +110,7 @@
* @param integer $code Exit code.
*
* @return void
+ *
* @since 11.1
*/
public function close($code = 0)
@@ -133,6 +124,7 @@
* @param mixed $data Either an array or object to be loaded into the configuration object.
*
* @return void
+ *
* @since 11.1
*/
public function loadConfiguration($data)
@@ -149,10 +141,11 @@
/**
* Write a string to standard output.
*
- * @param string $text The text to display.
- * @param boolean $nl True to append a new line at the end of the output string.
+ * @param string $text The text to display.
+ * @param bool $nl True to append a new line at the end of the output string.
*
* @return void
+ *
* @since 11.1
*/
public function out($text = '', $nl = true)
@@ -164,6 +157,7 @@
* Get a value from standard input.
*
* @return string The input string from standard input.
+ *
* @since 11.1
*/
public function in()
@@ -178,6 +172,7 @@
* @param callback $handler The handler, a function or an instance of a event object.
*
* @return void
+ *
* @since 11.1
*/
function registerEvent($event, $handler)
@@ -192,6 +187,7 @@
* @param array $args An array of arguments.
*
* @return array An array of results from each function call.
+ *
* @since 11.1
*/
function triggerEvent($event, $args = null)
@@ -206,6 +202,7 @@
* @param mixed $default The default value if none is set.
*
* @return mixed The value of the configuration.
+ *
* @since 11.1
*/
public function get($key, $default = null)
@@ -220,6 +217,7 @@
* @param mixed $value The value of the property to set
*
* @return mixed Previous value of the property
+ *
* @since 11.1
*/
public function set($key, $value = null)
@@ -235,6 +233,7 @@
* for your specific application.
*
* @return mixed Either an array or object to be loaded into the configuration object.
+ *
* @since 11.1
*/
protected function fetchConfigurationData()
Modified: development/branches/platform/libraries/joomla/application/component/controller.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/controller.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/controller.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,8 +25,8 @@
* ACO Section for the controller.
*
* @var string
+ * @since 11.1
* @deprecated
- * @since 11.1
*/
protected $_acoSection;
@@ -34,8 +34,8 @@
* Default ACO Section value for the controller.
*
* @var string
+ * @since 11.1
* @deprecated
- * @since 11.1
*/
protected $_acoSectionValue;
@@ -44,12 +44,12 @@
*
* @var string
* @since 11.1
- * @note Replaces _basePath.
+ * @note Replaces _basePath.
*/
protected $basePath;
/**
- * @var string The default view for the display method.
+ * @var string The default view for the display method.
* @since 11.1
*/
protected $default_view;
@@ -146,10 +146,10 @@
/**
* Adds to the stack of model paths in LIFO order.
*
- * @param mixed $path The directory (string), or list of directories (array) to add.
- * @param string $prefix A prefix for models
+ * @param mixed $path The directory (string), or list of directories (array) to add.
+ * @param string $prefix A prefix for models
*
- * @return void
+ * @return void
*/
public static function addModelPath($path, $prefix='')
{
@@ -160,12 +160,12 @@
/**
* Create the filename for a resource.
*
- * @param string $type The resource type to create the filename for.
- * @param array $parts An associative array of filename information. Optional.
+ * @param string $type The resource type to create the filename for.
+ * @param array $parts An associative array of filename information. Optional.
*
- * @return string The filename.
- * @since 11.1
- * @note Replaced _createFileName.
+ * @return string The filename.
+ * @since 11.1
+ * @note Replaced _createFileName.
*/
protected static function createFileName($type, $parts = array())
{
@@ -201,11 +201,11 @@
/**
* Method to get a singleton controller instance.
*
- * @param string $prefix The prefix for the controller.
- * @param array $config An array of optional constructor options.
+ * @param string $prefix The prefix for the controller.
+ * @param array $config An array of optional constructor options.
*
- * @return mixed JController derivative class or JException on error.
- * @since 11.1
+ * @return mixed JController derivative class or JException on error.
+ * @since 11.1
*/
public static function getInstance($prefix, $config = array())
{
@@ -280,12 +280,12 @@
/**
* 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).
*
- * @return JController
- * @since 11.1
+ * @return JController
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -386,12 +386,12 @@
/**
* Adds to the search path for templates and resources.
*
- * @param string $type The path type (e.g. 'model', 'view').
- * @param mixed $path The directory string or stream array to search.
+ * @param string $type The path type (e.g. 'model', 'view').
+ * @param mixed $path The directory string or stream array to search.
*
- * @return JController A JController object to support chaining.
- * @since 11.1
- * @note Replaces _addPath.
+ * @return JController A JController object to support chaining.
+ * @since 11.1
+ * @note Replaces _addPath.
*/
protected function addPath($type, $path)
{
@@ -418,9 +418,9 @@
/**
* Add one or more view paths to the controller's stack, in LIFO order.
*
- * @param string|array $path The directory (string) or list of directories (array) to add.
+ * @param string|array $path The directory (string) or list of directories (array) to add.
*
- * @return JController This object to support chaining
+ * @return JController This object to support chaining.
*/
public function addViewPath($path)
{
@@ -432,10 +432,10 @@
/**
* Authorisation check
*
- * @param string $task The ACO Section Value to check access on
+ * @param string $task The ACO Section Value to check access on
*
- * @return boolean True if authorised
- * @since 11.1
+ * @return bool True if authorised
+ * @since 11.1
* @deprecated
*/
public function authorize($task)
@@ -446,10 +446,10 @@
/**
* Authorisation check
*
- * @param string $task The ACO Section Value to check access on.
+ * @param string $task The ACO Section Value to check access on.
*
- * @return boolean True if authorised
- * @since 11.1
+ * @return bool True if authorised
+ * @since 11.1
*/
public function authorise($task)
{
@@ -474,11 +474,11 @@
/**
* Method to check whether an ID is in the edit list.
*
- * @param string $context The context for the session storage.
- * @param integer $id The ID of the record to add to the edit list.
+ * @param string $context The context for the session storage.
+ * @param integer $id The ID of the record to add to the edit list.
*
- * @return boolean True if the ID is in the edit list.
- * @since 11.1
+ * @return boolean True if the ID is in the edit list.
+ * @since 11.1
*/
protected function checkEditId($context, $id)
{
@@ -506,13 +506,13 @@
/**
* Method to load and return a model object.
*
- * @param string $name The name of the model.
- * @param string $prefix Optional model prefix.
- * @param array $config Configuration array for the model. Optional.
+ * @param string $name The name of the model.
+ * @param string $prefix Optional model prefix.
+ * @param array $config Configuration array for the model. Optional.
*
- * @return mixed Model object on success; otherwise null failure.
- * @since 11.1
- * @note Replaces _createModel.
+ * @return mixed Model object on success; otherwise null failure.
+ * @since 11.1
+ * @note Replaces _createModel.
*/
protected function createModel($name, $prefix = '', $config = array())
{
@@ -533,14 +533,14 @@
* Note the "name, prefix, type" order of parameters, which differs from the
* "name, type, prefix" order used in related public methods.
*
- * @param string $name The name of the view.
- * @param string $prefix Optional prefix for the view class name.
- * @param string $type The type of view.
- * @param array $config Configuration array for the view. Optional.
+ * @param string $name The name of the view.
+ * @param string $prefix Optional prefix for the view class name.
+ * @param string $type The type of view.
+ * @param array $config Configuration array for the view. Optional.
*
- * @return mixed View object on success; null or error result on failure.
- * @since 11.1
- * @note Replaces _createView.
+ * @return mixed View object on success; null or error result on failure.
+ * @since 11.1
+ * @note Replaces _createView.
*/
protected function createView($name, $prefix = '', $type = '', $config = array())
{
@@ -585,11 +585,11 @@
* This function is provide as a default implementation, in most cases
* you will need to override it in your own controllers.
*
- * @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()}.
+ * @param bool $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 JController A JController object to support chaining.
- * @since 11.1
+ * @return JController A JController object to support chaining.
+ * @since 11.1
*/
public function display($cachable = false, $urlparams = false)
{
@@ -649,10 +649,10 @@
/**
* Execute a task by triggering a method in the derived class.
*
- * @param string $task The task to perform. If no matching task is found, the '__default' task is executed, if defined.
+ * @param string $task The task to perform. If no matching task is found, the '__default' task is executed, if defined.
*
- * @return mixed false The value returned by the called method, false in error case.
- * @since 11.1
+ * @return mixed The value returned by the called method, false in error case.
+ * @since 11.1
*/
public function execute($task)
{
@@ -685,12 +685,12 @@
/**
* 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 11.1
+ * @return object The model.
+ * @since 11.1
*/
public function getModel($name = '', $prefix = '', $config = array())
{
@@ -727,8 +727,8 @@
* The dispatcher name is set by default parsed using the classname, or it can be set
* by passing a $config['name'] in the class constructor
*
- * @return string The name of the dispatcher
- * @since 11.1
+ * @return string The name of the dispatcher
+ * @since 11.1
*/
public function getName()
{
@@ -748,8 +748,8 @@
/**
* Get the last task that is being performed or was most recently performed.
*
- * @return string The task that is being performed or was most recently performed.
- * @since 11.1
+ * @return string The task that is being performed or was most recently performed.
+ * @since 11.1
*/
public function getTask()
{
@@ -759,8 +759,8 @@
/**
* Gets the available tasks in the controller.
*
- * @return array Array[i] of task names.
- * @since 11.1
+ * @return array Array[i] of task names.
+ * @since 11.1
*/
public function getTasks()
{
@@ -770,13 +770,13 @@
/**
* Method to get a reference to the current view and load it if necessary.
*
- * @param string $name The view name. Optional, defaults to the controller name.
- * @param string $type The view type. Optional.
- * @param string $prefix The class prefix. Optional.
- * @param array $config Configuration array for view. Optional.
+ * @param string $name The view name. Optional, defaults to the controller name.
+ * @param string $type The view type. Optional.
+ * @param string $prefix The class prefix. Optional.
+ * @param array $config Configuration array for view. Optional.
*
- * @return object Reference to the view or an error.
- * @since 11.1
+ * @return object Reference to the view or an error.
+ * @since 11.1
*/
public function getView($name = '', $type = '', $prefix = '', $config = array())
{
@@ -817,8 +817,8 @@
* @param string $context The context for the session storage.
* @param integer $id The ID of the record to add to the edit list.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function holdEditId($context, $id)
{
@@ -844,8 +844,8 @@
/**
* Redirects the browser or returns false if no redirect is set.
*
- * @return boolean False if no redirect exists.
- * @since 11.1
+ * @return boolean False if no redirect exists.
+ * @since 11.1
*/
public function redirect()
{
@@ -860,10 +860,10 @@
/**
* Register the default task to perform if a mapping is not found.
*
- * @param string $method The name of the method in the derived class to perform if a named task is not found.
+ * @param string $method The name of the method in the derived class to perform if a named task is not found.
*
- * @return JController A JController object to support chaining.
- * @since 11.1
+ * @return JController A JController object to support chaining.
+ * @since 11.1
*/
public function registerDefaultTask($method)
{
@@ -875,11 +875,11 @@
/**
* Register (map) a task to a method in the class.
*
- * @param string $task The task.
- * @param string $method The name of the method in the derived class to perform for this task.
+ * @param string $task The task.
+ * @param string $method The name of the method in the derived class to perform for this task.
*
- * @return JController A JController object to support chaining.
- * @since 11.1
+ * @return JController A JController object to support chaining.
+ * @since 11.1
*/
public function registerTask($task, $method)
{
@@ -893,9 +893,10 @@
/**
* Unregister (unmap) a task in the class.
*
- * @param string The task.
- * @return JController This object to support chaining.
- * @since 1.6
+ * @param string $task The task.
+ *
+ * @return JController This object to support chaining.
+ * @since 11.1
*/
public function unregisterTask($task)
{
@@ -907,11 +908,11 @@
/**
* Method to check whether an ID is in the edit list.
*
- * @param string $context The context for the session storage.
- * @param integer $id The ID of the record to add to the edit list.
+ * @param string $context The context for the session storage.
+ * @param integer $id The ID of the record to add to the edit list.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function releaseEditId($context, $id)
{
@@ -937,13 +938,14 @@
/**
* Sets the access control levels.
*
- * @param string $section The ACO section (eg, the component).
- * @param string $value The ACO section value (if using a constant value).
+ * @param string $section The ACO section (eg, the component).
+ * @param string $value The ACO section value (if using a constant value).
*
- * @return void
- * @since 11.1
+ * @return void
+ *
* @deprecated
- * @see Jaccess
+ * @see Jaccess
+ * @since 11.1
*/
public function setAccessControl($section, $value = null)
{
@@ -954,11 +956,11 @@
/**
* Sets the internal message that is passed with a redirect
*
- * @param string $text Message to display on redirect.
- * @param string $type Message type (since 11.1). Optional, defaults to 'message'.
+ * @param string $text Message to display on redirect.
+ * @param string $type Message type (since 11.1). Optional, defaults to 'message'.
*
- * @return string Previous message
- * @since 11.1
+ * @return string Previous message
+ * @since 11.1
*/
public function setMessage($text, $type = 'message')
{
@@ -972,12 +974,13 @@
/**
* Sets an entire array of search paths for resources.
*
- * @param string $type The type of path to set, typically 'view' or 'model'.
- * @param string array $path The new set of search paths. If null or false, resets to the current directory only.
+ * @param string $type The type of path to set, typically 'view' or 'model'.
+ * @param string $path The new set of search paths. If null or false, resets to the current directory only.
*
- * @return void
- * @since 11.1
- * Replaces _setPath.
+ * @return void
+ *
+ * @note Replaces _setPath.
+ * @since 11.1
*/
protected function setPath($type, $path)
{
Modified: development/branches/platform/libraries/joomla/application/component/controlleradmin.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/controlleradmin.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/controlleradmin.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,28 +25,28 @@
{
/**
* @var string The URL option for the component.
- * @since 11.1
+ * @since 11.1
*/
protected $option;
/**
* @var string The prefix to use with controller messages.
- * @since 11.1
+ * @since 11.1
*/
protected $text_prefix;
/**
* @var string The URL view list variable.
- * @since 11.1
+ * @since 11.1
*/
protected $view_list;
/**
* Constructor.
*
- * @param array An optional associative array of configuration settings.
+ * @param array An optional associative array of configuration settings.
* @see JController
- * @since 11.1
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -83,7 +83,9 @@
/**
* Removes an item.
*
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
function delete()
{
@@ -117,11 +119,11 @@
/**
* Display is not supported by this controller.
*
- * @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()}.
+ * @param bool $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 JController A JController object to support chaining.
- * @since 11.1
+ * @return JController A JController object to support chaining.
+ * @since 11.1
*/
public function display($cachable = false, $urlparams = false)
{
@@ -131,7 +133,9 @@
/**
* Method to publish a list of taxa
*
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
function publish()
{
@@ -185,7 +189,9 @@
/**
* Changes the order of one or more records.
*
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
public function reorder()
{
@@ -215,7 +221,9 @@
/**
* Method to save the submitted ordering values for records.
*
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
public function saveorder()
{
@@ -254,7 +262,9 @@
/**
* Check in of one or more records.
*
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
public function checkin()
{
@@ -279,5 +289,4 @@
return true;
}
}
-
}
Modified: development/branches/platform/libraries/joomla/application/component/controllerform.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/controllerform.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/controllerform.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,42 +24,43 @@
{
/**
* @var string The context for storing internal data, e.g. record.
- * @since 11.1
+ * @since 11.1
*/
protected $context;
/**
* @var string The URL option for the component.
- * @since 11.1
+ * @since 11.1
*/
protected $option;
/**
* @var string The URL view item variable.
- * @since 11.1
+ * @since 11.1
*/
protected $view_item;
/**
* @var string The URL view list variable.
- * @since 11.1
+ * @since 11.1
*/
protected $view_list;
/**
* @var string The prefix to use with controller messages.
- * @since 11.1
+ * @since 11.1
*/
protected $text_prefix;
/**
* Constructor.
*
- * @param array $config An optional associative array of configuration settings.
+ * @param array $config An optional associative array of configuration settings.
*
- * @return JControllerForm A JControllerForm object
- * @see JController
- * @since 11.1
+ * @return JControllerForm A JControllerForm object
+ *
+ * @see JController
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -124,8 +125,8 @@
/**
* Method to add a new record.
*
- * @return mixed True if the record can be added, a JError object if not.
- * @since 11.1
+ * @return mixed True if the record can be added, a JError object if not.
+ * @since 11.1
*/
public function add()
{
@@ -157,10 +158,10 @@
*
* Extended classes can override this if necessary.
*
- * @param array An array of input data.
+ * @param array $data An array of input data.
*
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
protected function allowAdd($data = array())
{
@@ -174,11 +175,11 @@
*
* Extended classes can override this if necessary.
*
- * @param array An array of input data.
- * @param string 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 11.1
+ * @return boolean
+ * @since 11.1
*/
protected function allowEdit($data = array(), $key = 'id')
{
@@ -190,11 +191,11 @@
*
* Extended classes can override this if necessary.
*
- * @param array An array of input data.
- * @param string 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 11.1
+ * @return boolean
+ * @since 11.1
*/
protected function allowSave($data, $key = 'id')
{
@@ -211,10 +212,10 @@
/**
* 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.
- * @since 11.1
+ * @return bool True if access level checks pass, false otherwise.
+ * @since 11.1
*/
public function cancel($key = null)
{
@@ -268,11 +269,11 @@
/**
* 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.
- * @since 11.1
+ * @return boolean True if access level check and checkout passes, false otherwise.
+ * @since 11.1
*/
public function edit($key = null, $urlVar = null)
{
@@ -329,12 +330,12 @@
/**
* 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 11.1
+ * @return object The model.
+ * @since 11.1
*/
public function getModel($name = '', $prefix = '', $config = array('ignore_request' => true))
{
@@ -348,11 +349,11 @@
/**
* 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.
- * @since 11.1
+ * @return string The arguments to append to the redirect URL.
+ * @since 11.1
*/
protected function getRedirectToItemAppend($recordId = null, $urlVar = 'id')
{
@@ -379,8 +380,8 @@
/**
* Gets the URL arguments to append to a list redirect.
*
- * @return string The arguments to append to the redirect URL.
- * @since 11.1
+ * @return string The arguments to append to the redirect URL.
+ * @since 11.1
*/
protected function getRedirectToListAppend()
{
@@ -398,22 +399,24 @@
/**
* Function that allows child controller access to model data after the data has been saved.
*
- * @param JModel $model The data model object.
- * @param array $validData The validated data.
+ * @param JModel $model The data model object.
+ * @param array $validData The validated data.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
- protected function postSaveHook(JModel &$model, $validData = array());
+ protected function postSaveHook(JModel &$model, $validData = array())
+ {
+ }
/**
* 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.
- * @since 11.1
+ * @return boolean True if successful, false otherwise.
+ * @since 11.1
*/
public function save($key = null, $urlVar = null)
{
Modified: development/branches/platform/libraries/joomla/application/component/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,11 +29,11 @@
/**
* Get the component information.
*
- * @param string $option The component option.
- * @param boolean $string If set and the component does not exist, the enabled attribue will be set to false
+ * @param string $option The component option.
+ * @param boolean $string If set and the component does not exist, the enabled attribue will be set to false
*
- * @return object An object with the information for the component.
- * @since 11.1
+ * @return object An object with the information for the component.
+ * @since 11.1
*/
public static function getComponent($option, $strict = false)
{
@@ -55,11 +55,11 @@
/**
* Checks if the component is enabled
*
- * @param string $option The component option.
- * @param boolean $string If set and the component does not exist, false will be returned
+ * @param string $option The component option.
+ * @param boolean $string If set and the component does not exist, false will be returned
*
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
public static function isEnabled($option, $strict = false)
{
@@ -71,12 +71,13 @@
/**
* Gets the parameter object for the component
*
- * @param string $option The option for the component.
- * @param boolean $strict If set and the component does not exist, false will be returned
- * @see JRegistry
- *
- * @return JRegistry A JRegistry object.
- * @since 11.1
+ * @param string $option The option for the component.
+ * @param boolean $strict If set and the component does not exist, false will be returned
+ *
+ * @return JRegistry A JRegistry object.
+ *
+ * @see JRegistry
+ * @since 11.1
*/
public static function getParams($option, $strict = false)
{
@@ -88,11 +89,11 @@
/**
* Render the component.
*
- * @param string The component option.
- * @param array The component parameters
+ * @param string $option The component option.
+ * @param array $params The component parameters
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function renderComponent($option, $params = array())
{
@@ -175,11 +176,11 @@
/**
* Load the installed components into the _components property.
- *
- * @param string The element value for the extension
*
- * @return boolean True on success
- * @since 11.1
+ * @param string $option The element value for the extension
+ *
+ * @return bool True on success
+ * @since 11.1
*/
protected static function _load($option)
{
Modified: development/branches/platform/libraries/joomla/application/component/model.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/model.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/model.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* Indicates if the internal state has been set
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $__state_set = null;
@@ -33,39 +33,39 @@
* Database Connector
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $_db;
/**
* The model (base) name
- * Replaces _name variable in 11.1
*
* @var string
- * @since 11.1
+ * @note Replaces _name variable in 11.1
+ * @since 11.1
*/
protected $name;
/**
* The option for the component
- *
+ *
* @var string The URL option for the component.
- * @since 11.1
+ * @since 11.1
*/
protected $option = null;
/**
* A state object
- * Replaces _state variable in 11.1
*
- * @var string
- * @since 11.1
+ * @var string
+ * @note Replaces _state variable in 11.1
+ * @since 11.1
*/
protected $state;
/**
* @var string The event to trigger when cleaning cache.
- * @since 1.6.2
+ * @since 11.1
*/
protected $event_clean_cache = null;
@@ -73,11 +73,11 @@
* Add a directory where JModel should search for models. You may
* either pass a string or an array of directories.
*
- * @param string $path A path to search.
- * @param string $prefix A prefix for models.
+ * @param string $path A path to search.
+ * @param string $prefix A prefix for models.
*
- * @return array An array with directory elements. If prefix is equal to '', all directories are returned.
- * @since 11.1
+ * @return array An array with directory elements. If prefix is equal to '', all directories are returned.
+ * @since 11.1
*/
public static function addIncludePath($path = '', $prefix = '')
{
@@ -113,10 +113,10 @@
/**
* Adds to the stack of model table paths in LIFO order.
*
- * @param mixed $path The directory as a string or directories as an array to add.
+ * @param mixed $path The directory as a string or directories as an array to add.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function addTablePath($path)
{
@@ -149,12 +149,12 @@
/**
* Returns a Model object, always creating it
*
- * @param string $type The model type to instantiate
- * @param string $prefix Prefix for the model class name. Optional.
- * @param array $config Configuration array for model. Optional.
+ * @param string $type The model type to instantiate
+ * @param string $prefix Prefix for the model class name. Optional.
+ * @param array $config Configuration array for model. Optional.
*
- * @return mixed A model object or false on failure
- * @since 11.1
+ * @return mixed A model object or false on failure
+ * @since 11.1
*/
public static function getInstance($type, $prefix = '', $config = array())
{
@@ -192,10 +192,10 @@
/**
* Constructor
*
- * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
+ * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
*
- * @return JModel A JModel object
- * @since 11.1
+ * @return JModel A JModel object
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -261,12 +261,12 @@
/**
* Gets an array of objects from the results of database query.
*
- * @param string $query The query.
- * @param integer $limitstart Offset.
- * @param integer $limit The number of records.
+ * @param string $query The query.
+ * @param integer $limitstart Offset.
+ * @param integer $limit The number of records.
*
- * @return array An array of results.
- * @since 11.1
+ * @return array An array of results.
+ * @since 11.1
*/
protected function _getList($query, $limitstart=0, $limit=0)
{
@@ -279,7 +279,7 @@
/**
* Returns a record count for the query
*
- * @param string $query The query.
+ * @param string $query The query.
*
* @return integer Number of rows for query
* @since 11.1
@@ -320,7 +320,7 @@
/**
* Method to get the database connector object
*
- * @return JDatabase JDatabase connector object
+ * @return JDatabase JDatabase connector object
*/
public function getDbo()
{
@@ -333,8 +333,8 @@
* The model name. By default parsed using the classname or it can be set
* by passing a $config['name'] in the class constructor
*
- * @return string The name of the model
- * @since 11.1
+ * @return string The name of the model
+ * @since 11.1
*/
public function getName()
{
@@ -354,11 +354,11 @@
/**
* Method to get model state variables
*
- * @param string $property Optional parameter name
- * @param mixed $default Optional default value
+ * @param string $property Optional parameter name
+ * @param mixed $default Optional default value
*
- * @return object The property where specified, the state object where omitted
- * @since 11.1
+ * @return object The property where specified, the state object where omitted
+ * @since 11.1
*/
public function getState($property = null, $default = null)
{
@@ -376,12 +376,12 @@
/**
* Method to get a table object, load it if necessary.
*
- * @param string $name The table name. Optional.
- * @param string $prefix The class prefix. Optional.
- * @param array $options Configuration array for model. Optional.
+ * @param string $name The table name. Optional.
+ * @param string $prefix The class prefix. Optional.
+ * @param array $options Configuration array for model. Optional.
*
- * @return JTable A JTable object
- * @since 11.1
+ * @return JTable A JTable object
+ * @since 11.1
*/
public function getTable($name = '', $prefix = 'Table', $options = array())
{
@@ -407,21 +407,20 @@
*
* Note. Calling getState in this method will result in recursion.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function populateState()
{
-
}
/**
* Method to set the database connector object
*
- * @param object &$db A JDatabase based object
+ * @param object &$db A JDatabase based object
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function setDbo(&$db)
{
@@ -431,11 +430,11 @@
/**
* Method to set model state variables
*
- * @param string $property The name of the property
- * @param mixed $value The value of the property to set
+ * @param string $property The name of the property
+ * @param mixed $value The value of the property to set
*
- * @return mixed The previous value of the property
- * @since 11.1
+ * @return mixed The previous value of the property
+ * @since 11.1
*/
public function setState($property, $value = null)
{
Modified: development/branches/platform/libraries/joomla/application/component/modeladmin.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/modeladmin.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/modeladmin.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,47 +22,47 @@
{
/**
* @var string The prefix to use with controller messages.
- * @since 11.1
+ * @since 11.1
*/
protected $text_prefix = null;
/**
* @var string The event to trigger after deleting the data.
- * @since 11.1
+ * @since 11.1
*/
protected $event_after_delete = null;
/**
* @var string The event to trigger after saving the data.
- * @since 11.1
+ * @since 11.1
*/
protected $event_after_save = null;
/**
* @var string The event to trigger before deleting the data.
- * @since 11.1
+ * @since 11.1
*/
protected $event_before_delete = null;
/**
* @var string The event to trigger before saving the data.
- * @since 11.1
+ * @since 11.1
*/
protected $event_before_save = null;
/**
* @var string The event to trigger after changing the published state of the data.
- * @since 11.1
+ * @since 11.1
*/
protected $event_change_state = null;
/**
* Constructor.
*
- * @param array $config An optional associative array of configuration settings.
+ * @param array $config An optional associative array of configuration settings.
*
* @see JController
- * @since 11.1
+ * @since 11.1
*/
public function __construct($config = array())
{
@@ -109,10 +109,10 @@
/**
* Method to test whether a record can be deleted.
*
- * @param object $record A record object.
+ * @param object $record A record object.
*
- * @return boolean True if allowed to delete the record. Defaults to the permission for the component.
- * @since 11.1
+ * @return boolean True if allowed to delete the record. Defaults to the permission for the component.
+ * @since 11.1
*/
protected function canDelete($record)
{
@@ -123,10 +123,10 @@
/**
* Method to test whether a record can be deleted.
*
- * @param object $record A record object.
+ * @param object $record A record object.
*
- * @return boolean True if allowed to change the state of the record. Defaults to the permission for the component.
- * @since 11.1
+ * @return boolean True if allowed to change the state of the record. Defaults to the permission for the component.
+ * @since 11.1
*/
protected function canEditState($record)
{
@@ -137,10 +137,10 @@
/**
* Method override to check-in a record or an array of record
*
- * @param integer|array $pks The ID of the primary key or an array of IDs
+ * @param integer|array $pks The ID of the primary key or an array of IDs
*
- * @return mixed Boolean false if there is an error, otherwise the count of records checked in.
- * @since 11.1
+ * @return mixed Boolean false if there is an error, otherwise the count of records checked in.
+ * @since 11.1
*/
public function checkin($pks = array())
{
@@ -179,10 +179,10 @@
/**
* Method override to check-out a record.
*
- * @param integer $pk The ID of the primary key.
+ * @param integer $pk The ID of the primary key.
*
- * @return boolean True if successful, false if an error occurs.
- * @since 11.1
+ * @return boolean True if successful, false if an error occurs.
+ * @since 11.1
*/
public function checkout($pk = null)
{
@@ -195,10 +195,10 @@
/**
* Method to delete one or more records.
*
- * @param array $pks An array of record primary keys.
+ * @param array $pks An array of record primary keys.
*
- * @return boolean True if successful, false if an error occurs.
- * @since 11.1
+ * @return boolean True if successful, false if an error occurs.
+ * @since 11.1
*/
public function delete(&$pks)
{
@@ -263,10 +263,10 @@
/**
* Method to get a single record.
*
- * @param integer $pk The id of the primary key.
+ * @param integer $pk The id of the primary key.
*
- * @return mixed Object on success, false on failure.
- * @since 11.1
+ * @return mixed Object on success, false on failure.
+ * @since 11.1
*/
public function getItem($pk = null)
{
@@ -301,10 +301,10 @@
/**
* A protected method to get a set of ordering conditions.
*
- * @param object $table A JTable object.
+ * @param object $table A JTable object.
*
- * @return array An array of conditions to add to ordering queries.
- * @since 11.1
+ * @return array An array of conditions to add to ordering queries.
+ * @since 11.1
*/
protected function getReorderConditions($table)
{
@@ -314,8 +314,8 @@
/**
* Stock method to auto-populate the model state.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function populateState()
{
@@ -336,10 +336,10 @@
/**
* Prepare and sanitise the table data prior to saving.
*
- * @param JTable $table A reference to a JTable object.
+ * @param JTable $table A reference to a JTable object.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function prepareTable(&$table)
{
@@ -349,11 +349,11 @@
/**
* Method to change the published state of one or more records.
*
- * @param array $pks A list of the primary keys to change.
- * @param integer $value The value of the published state.
+ * @param array $pks A list of the primary keys to change.
+ * @param integer $value The value of the published state.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
function publish(&$pks, $value = 1)
{
@@ -408,11 +408,11 @@
* Returns NULL if the user did not have edit
* privileges for any of the selected primary keys.
*
- * @param integer $pks The ID of the primary key to move.
- * @param integer $delta Increment, usually +1 or -1
+ * @param integer $pks The ID of the primary key to move.
+ * @param integer $delta Increment, usually +1 or -1
*
- * @return boolean|null False on failure or error, true on success.
- * @since 11.1
+ * @return boolean|null False on failure or error, true on success.
+ * @since 11.1
*/
public function reorder($pks, $delta = 0)
{
@@ -470,10 +470,10 @@
/**
* Method to save the form data.
*
- * @param array $data The form data.
+ * @param array $data The form data.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function save($data)
{
@@ -550,11 +550,11 @@
/**
* Saves the manually set order of records.
*
- * @param array $pks An array of primary key ids.
- * @param integer $order +/-1
+ * @param array $pks An array of primary key ids.
+ * @param integer $order +/-1
*
- * @return mixed
- * @since 11.1
+ * @return mixed
+ * @since 11.1
*/
function saveorder($pks = null, $order = null)
{
Modified: development/branches/platform/libraries/joomla/application/component/modelform.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/modelform.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/modelform.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,9 +29,9 @@
/**
* Method to checkin a row.
*
- * @param integer $pk The numeric id of the primary key.
+ * @param integer $pk The numeric id of the primary key.
*
- * @return boolean False on failure or error, true otherwise.
+ * @return boolean False on failure or error, true otherwise.
*/
public function checkin($pk = null)
{
@@ -65,9 +65,9 @@
/**
* Method to check-out a row for editing.
*
- * @param integer $pk The numeric id of the primary key.
+ * @param integer $pk The numeric id of the primary key.
*
- * @return boolean False on failure or error, true otherwise.
+ * @return boolean False on failure or error, true otherwise.
*/
public function checkout($pk = null)
{
@@ -101,22 +101,23 @@
/**
* Abstract method for getting the form from the model.
*
- * @param array $data Data for the form.
- * @param boolean $loadData True if the form is to load its own data (default case), false if not.
- * @return mixed A JForm object on success, false on failure
- * @since 11.1
+ * @param array $data Data for the form.
+ * @param boolean $loadData True if the form is to load its own data (default case), false if not.
+ * @return mixed A JForm object on success, false on failure
+ * @since 11.1
*/
abstract public function getForm($data = array(), $loadData = true);
/**
* Method to get a form object.
*
- * @param string $name The name of the form.
- * @param string $source The form source. Can be XML string if file flag is set to false.
- * @param array $options Optional array of options for the form creation.
- * @param boolean $clear Optional argument to force load a new form.
- * @param string $xpath An optional xpath to search for the fields.
- * @return mixed JForm object on success, False on error.
+ * @param string $name The name of the form.
+ * @param string $source The form source. Can be XML string if file flag is set to false.
+ * @param array $options Optional array of options for the form creation.
+ * @param boolean $clear Optional argument to force load a new form.
+ * @param string $xpath An optional xpath to search for the fields.
+ *
+ * @return mixed JForm object on success, False on error.
*/
protected function loadForm($name, $source = null, $options = array(), $clear = false, $xpath = false)
{
@@ -166,8 +167,8 @@
/**
* Method to get the data that should be injected in the form.
*
- * @return array The default data is an empty array.
- * @since 11.1
+ * @return array The default data is an empty array.
+ * @since 11.1
*/
protected function loadFormData()
{
@@ -177,11 +178,11 @@
/**
* Method to allow derived classes to preprocess the form.
*
- * @param object A form object.
- * @param mixed The data expected for the form.
- * @param string The name of the plugin group to import (defaults to "content").
+ * @param object A form object.
+ * @param mixed The data expected for the form.
+ * @param string The name of the plugin group to import (defaults to "content").
* @throws Exception if there is an error in the form event.
- * @since 11.1
+ * @since 11.1
*/
protected function preprocessForm(JForm $form, $data, $group = 'content')
{
@@ -209,9 +210,9 @@
/**
* Method to validate the form data.
*
- * @param object $form The form to validate against.
- * @param array $data The data to validate.
- * @return mixed Array of filtered data if valid, false otherwise.
+ * @param object $form The form to validate against.
+ * @param array $data The data to validate.
+ * @return mixed Array of filtered data if valid, false otherwise.
* @since 1.1
*/
function validate($form, $data)
Modified: development/branches/platform/libraries/joomla/application/component/modelitem.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/modelitem.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/modelitem.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -41,8 +41,8 @@
* different modules that might need different sets of data or different
* ordering requirements.
*
- * @param string $context A prefix for the store id.
- * @return string A store id.
+ * @param string $context A prefix for the store id.
+ * @return string A store id.
*/
protected function getStoreId($id = '')
{
Modified: development/branches/platform/libraries/joomla/application/component/modellist.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/modellist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/modellist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,7 @@
* Internal memory based cache array of data.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $cache = array();
@@ -33,7 +33,7 @@
* when dealing with the getStoreId() method and caching data structures.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $context = null;
@@ -41,7 +41,7 @@
* Valid filter fields or ordering.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $filter_fields = array();
@@ -49,14 +49,14 @@
* An internal cache for the last query used.
*
* @var JDatabaseQuery
- * @since 11.1
+ * @since 11.1
*/
protected $query = array();
/**
* Constructor.
*
- * @param array An optional associative array of configuration settings.
+ * @param array An optional associative array of configuration settings.
* @see JController
*/
public function __construct($config = array())
@@ -79,8 +79,8 @@
*
* This method ensures that the query is contructed only once for a given state of the model.
*
- * @return JDatabaseQuery A JDatabaseQuery object
- * @since 11.1
+ * @return JDatabaseQuery A JDatabaseQuery object
+ * @since 11.1
*/
protected function _getListQuery()
{
@@ -102,8 +102,8 @@
/**
* Method to get an array of data items.
*
- * @return mixed An array of data items on success, false on failure.
- * @since 11.1
+ * @return mixed An array of data items on success, false on failure.
+ * @since 11.1
*/
public function getItems()
{
@@ -134,8 +134,8 @@
/**
* Method to get a JDatabaseQuery object for retrieving the data set from a database.
*
- * @return JDatabaseQuery A JDatabaseQuery object to retrieve the data set.
- * @since 11.1
+ * @return JDatabaseQuery A JDatabaseQuery object to retrieve the data set.
+ * @since 11.1
*/
protected function getListQuery()
{
@@ -148,8 +148,8 @@
/**
* Method to get a JPagination object for the data set.
*
- * @return JPagination A JPagination object for the data set.
- * @since 11.1
+ * @return JPagination A JPagination object for the data set.
+ * @since 11.1
*/
public function getPagination()
{
@@ -179,9 +179,9 @@
* different modules that might need different sets of data or different
* ordering requirements.
*
- * @param string An identifier string to generate the store id.
- * @return string A store id.
- * @since 11.1
+ * @param string An identifier string to generate the store id.
+ * @return string A store id.
+ * @since 11.1
*/
protected function getStoreId($id = '')
{
@@ -197,8 +197,8 @@
/**
* Method to get the total number of items for the data set.
*
- * @return integer The total number of items available in the data set.
- * @since 11.1
+ * @return integer The total number of items available in the data set.
+ * @since 11.1
*/
public function getTotal()
{
@@ -229,8 +229,8 @@
/**
* Method to get the starting number of items for the data set.
*
- * @return integer The starting number of items available in the data set.
- * @since 11.1
+ * @return integer The starting number of items available in the data set.
+ * @since 11.1
*/
public function getstart()
{
@@ -263,9 +263,9 @@
*
* Note. Calling getState in this method will result in recursion.
*
- * @param string An optional ordering field.
- * @param string An optional direction (asc|desc).
- * @since 11.1
+ * @param string An optional ordering field.
+ * @param string An optional direction (asc|desc).
+ * @since 11.1
*/
protected function populateState($ordering = null, $direction = null)
{
@@ -308,13 +308,13 @@
* This is the same as the method in JApplication except that this also can optionally
* force you back to the first page when a filter has changed
*
- * @param string The key of the user state variable.
- * @param string The name of the variable passed in a request.
- * @param string The default value for the variable if not found. Optional.
- * @param string Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
- * @param boolean If true, the limitstart in request is set to zero
- * @return The request user state.
- * @since 11.1
+ * @param string The key of the user state variable.
+ * @param string The name of the variable passed in a request.
+ * @param string The default value for the variable if not found. Optional.
+ * @param string Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
+ * @param boolean If true, the limitstart in request is set to zero
+ * @return The request user state.
+ * @since 11.1
*/
public function getUserStateFromRequest($key, $request, $default = null, $type = 'none', $resetPage = true)
{
Modified: development/branches/platform/libraries/joomla/application/component/view.php
===================================================================
--- development/branches/platform/libraries/joomla/application/component/view.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/component/view.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -16,7 +16,7 @@
*
* @package Joomla.Platform
* @subpackage Application
- * @since 11.1
+ * @since 11.1
*/
class JView extends JObject
{
@@ -169,7 +169,7 @@
/**
* Execute and display a template script.
*
- * @param string The name of the template file to parse;
+ * @param string The name of the template file to parse;
* automatically searches through the template paths.
*
* @throws object An JError object.
@@ -284,8 +284,8 @@
* </code>
*
*
- * @param string The name for the reference in the view.
- * @param mixed The referenced variable.
+ * @param string The name for the reference in the view.
+ * @param mixed The referenced variable.
*
* @return bool True on success, false on failure.
*/
@@ -306,8 +306,8 @@
* If escaping mechanism is either htmlspecialchars or htmlentities, uses
* {@link $_encoding} setting.
*
- * @param mixed The output to escape.
- * @return mixed The escaped value.
+ * @param mixed The output to escape.
+ * @return mixed The escaped value.
*/
function escape($var)
{
@@ -321,9 +321,9 @@
/**
* Method to get data from a registered model or a property of the view
*
- * @param string The name of the method to call on the model or the property to get
- * @param string The name of the model to reference or the default value [optional]
- * @return mixed The return value of the method
+ * @param string The name of the method to call on the model or the property to get
+ * @param string The name of the model to reference or the default value [optional]
+ * @return mixed The return value of the method
*/
public function get($property, $default = null)
{
@@ -360,8 +360,8 @@
/**
* Method to get the model object
*
- * @param string The name of the model (optional)
- * @return mixed JModel object
+ * @param string The name of the model (optional)
+ * @return mixed JModel object
*/
public function getModel($name = null)
{
@@ -374,7 +374,7 @@
/**
* Get the layout.
*
- * @return string The layout name
+ * @return string The layout name
*/
public function getLayout()
{
@@ -384,7 +384,7 @@
/**
* Get the layout template.
*
- * @return string The layout template name
+ * @return string The layout template name
*/
public function getLayoutTemplate()
{
@@ -397,8 +397,8 @@
* The model name by default parsed using the classname, or it can be set
* by passing a $config['name'] in the class constructor
*
- * @return string The name of the model
- * @since 11.1
+ * @return string The name of the model
+ * @since 11.1
*/
public function getName()
{
@@ -427,10 +427,10 @@
* referenced by the name without JModel, eg. JModelCategory is just
* Category.
*
- * @param object $model The model to add to the view.
- * @param boolean $default Is this the default model?
- *
- * @return object The added model
+ * @param object $model The model to add to the view.
+ * @param boolean $default Is this the default model?
+ *
+ * @return object The added model
*/
public function setModel(&$model, $default = false)
{
@@ -446,9 +446,9 @@
/**
* Sets the layout name to use
*
- * @param string The layout name or a string in format <template>:<layout file>
- * @return string Previous value
- * @since 11.1
+ * @param string The layout name or a string in format <template>:<layout file>
+ * @return string Previous value
+ * @since 11.1
*/
public function setLayout($layout)
@@ -472,9 +472,9 @@
/**
* Allows a different extension for the layout files to be used
*
- * @param string The extension
- * @return string Previous value
- * @since 11.1
+ * @param string The extension
+ * @return string Previous value
+ * @since 11.1
*/
public function setLayoutExt($value)
{
@@ -488,7 +488,7 @@
/**
* Sets the _escape() callback.
*
- * @param mixed The callback for _escape() to use.
+ * @param mixed The callback for _escape() to use.
*/
function setEscape($spec)
{
@@ -498,7 +498,7 @@
/**
* Adds to the stack of view script paths in LIFO order.
*
- * @param string|array The directory (-ies) to add.
+ * @param string|array The directory (-ies) to add.
* @return void
*/
function addTemplatePath($path)
@@ -509,7 +509,7 @@
/**
* Adds to the stack of helper script paths in LIFO order.
*
- * @param string|array The directory (-ies) to add.
+ * @param string|array The directory (-ies) to add.
* @return void
*/
function addHelperPath($path)
@@ -520,9 +520,9 @@
/**
* Load a template file -- first look in the templates folder for an override
*
- * @param string The name of the template source file ...
+ * @param string The name of the template source file ...
* automatically searches the template paths and compiles as needed.
- * @return string The output of the the template script.
+ * @return string The output of the the template script.
*/
public function loadTemplate($tpl = null)
{
@@ -596,7 +596,7 @@
/**
* Load a helper file
*
- * @param string The name of the helper source file ...
+ * @param string The name of the helper source file ...
* automatically searches the helper paths and compiles as needed.
* @return boolean Returns true if the file was loaded
*/
@@ -619,8 +619,8 @@
/**
* Sets an entire array of search paths for templates or resources.
*
- * @param string The type of path to set, typically 'template'.
- * @param string|array The new set of search paths. If null or false, resets to the current directory only.
+ * @param string The type of path to set, typically 'template'.
+ * @param string|array The new set of search paths. If null or false, resets to the current directory only.
*/
protected function _setPath($type, $path)
{
@@ -652,7 +652,7 @@
/**
* Adds to the search path for templates and resources.
*
- * @param string|array The directory or stream to search.
+ * @param string|array The directory or stream to search.
*/
protected function _addPath($type, $path)
{
Modified: development/branches/platform/libraries/joomla/application/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/application/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -26,9 +26,9 @@
/**
* Return the name of the request component [main component]
*
- * @param string $default The default option
- * @return string Option
- * @since 11.1
+ * @param string $default The default option
+ * @return string Option
+ * @since 11.1
*/
public static function getComponentName($default = NULL)
{
@@ -55,11 +55,11 @@
* This method will return a client information array if called
* with no arguments which can be used to add custom application information.
*
- * @param integer $id A client identifier
- * @param boolean $byName If True, find the client by its name
- *
- * @return mixed Object describing the client or false if not known
- * @since 11.1
+ * @param integer $id A client identifier
+ * @param boolean $byName If True, find the client by its name
+ *
+ * @return mixed Object describing the client or false if not known
+ * @since 11.1
*/
public static function getClientInfo($id = null, $byName = false)
{
@@ -115,10 +115,10 @@
/**
* Adds information for a client.
*
- * @param mixed A client identifier either an array or object
- *
- * @return boolean True if the information is added. False on error
- * @since 11.1
+ * @param mixed A client identifier either an array or object
+ *
+ * @return boolean True if the information is added. False on error
+ * @since 11.1
*/
public static function addClientInfo($client)
{
@@ -144,11 +144,11 @@
/**
* Get a path
*
- * @param string $varname
- * @param string $user_option
- *
- * @return string The requested path
- * @since 11.1
+ * @param string $varname
+ * @param string $user_option
+ *
+ * @return string The requested path
+ * @since 11.1
*/
public static function getPath($varname, $user_option=null)
{
@@ -257,12 +257,12 @@
/**
* Parse a XML install manifest file.
- *
- * XML Root tag should be 'install' except for languages which use meta file.
*
- * @param string $path Full path to XML file.
- *
- * @return array XML metadata.
+ * XML Root tag should be 'install' except for languages which use meta file.
+ *
+ * @param string $path Full path to XML file.
+ *
+ * @return array XML metadata.
*/
public static function parseXMLInstallFile($path)
{
@@ -272,11 +272,11 @@
return false;
}
- // Check for a valid XML root tag.
-
- // Should be 'install', but for backward compatability we will accept 'extension'.
- // Languages use 'metafile' instead
+ // Check for a valid XML root tag.
+ // Should be 'install', but for backward compatability we will accept 'extension'.
+ // Languages use 'metafile' instead
+
if($xml->getName() != 'install'
&& $xml->getName() != 'extension'
&& $xml->getName() != 'metafile')
@@ -309,12 +309,12 @@
/**
* Parse a XML language meta file.
- *
- * XML Root tag for languages which is meta file.
*
- * @param string $path Full path to XML file.
- *
- * @return array XML metadata.
+ * XML Root tag for languages which is meta file.
+ *
+ * @param string $path Full path to XML file.
+ *
+ * @return array XML metadata.
*/
public static function parseXMLLangMetaFile($path)
{
@@ -357,11 +357,11 @@
/**
* Tries to find a file in the administrator or site areas
*
- * @param string A file name
- * @param integer 0 to check site only, 1 to check site and admin, -1 to check admin only
- *
- * @return string File name or null
- * @since 11.1
+ * @param string A file name
+ * @param integer 0 to check site only, 1 to check site and admin, -1 to check admin only
+ *
+ * @return string File name or null
+ * @since 11.1
*/
protected static function _checkPath($path, $checkAdmin=1)
{
Modified: development/branches/platform/libraries/joomla/application/input/cli.php
===================================================================
--- development/branches/platform/libraries/joomla/application/input/cli.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/input/cli.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,14 +22,14 @@
{
/**
* @var string The executable that was called to urn the CLI script.
- * @since 11.1
+ * @since 11.1
*/
public $executable;
/**
* @var array The additional arguments passed to the script that are not associated
* with a specific argument name.
- * @since 11.1
+ * @since 11.1
*/
public $args = array();
Modified: development/branches/platform/libraries/joomla/application/input.php
===================================================================
--- development/branches/platform/libraries/joomla/application/input.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/input.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -54,6 +54,8 @@
* @param array $source Source data (Optional, default is $_REQUEST)
* @param array $options Array of configuration parameters (Optional)
*
+ * @return JInput
+ *
* @since 11.1
*/
public function __construct($source = null, $options = array())
@@ -80,6 +82,7 @@
* @param mixed $name Name of the input object to retrieve.
*
* @return JInput The request input object
+ *
* @since 11.1
*/
public function __get($name)
@@ -111,6 +114,7 @@
* @param string $filter Filter to apply to the value.
*
* @return mixed The filtered input value.
+ *
* @since 11.1
*/
public function get($name, $default = null, $filter = 'cmd')
@@ -125,10 +129,11 @@
/**
* Gets an array of values from the request.
*
- * @param array $vars Associative array of keys and filter types to apply.
- * @param mixed $datasource Array to retrieve data from, or null
+ * @param array $vars Associative array of keys and filter types to apply.
+ * @param mixed $datasource Array to retrieve data from, or null
*
- * @return mixed The filtered input data.
+ * @return mixed The filtered input data.
+ *
* @since 11.1
*/
public function getArray($vars, $datasource = null)
@@ -161,6 +166,7 @@
* @param mixed $value Value to assign to the input.
*
* @return void
+ *
* @since 11.1
*/
public function set($name, $value)
@@ -174,7 +180,8 @@
* @param mixed $name Name of the value to get.
* @param string $default Default value to return if variable does not exist.
*
- * @return boolean The filtered boolean input value.
+ * @return bool The filtered boolean input value.
+ *
* @since 11.1
*/
public function __call($name, $arguments)
@@ -196,6 +203,7 @@
* Gets the request method.
*
* @return string The request method.
+ *
* @since 11.1
*/
public function getMethod($name, $arguments)
Modified: development/branches/platform/libraries/joomla/application/menu.php
===================================================================
--- development/branches/platform/libraries/joomla/application/menu.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/menu.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,7 +21,7 @@
/**
* Array to hold the menu items
*
- * @var array
+ * @var array
* @since 11.1
*/
protected $_items = array ();
@@ -29,7 +29,7 @@
/**
* Identifier of the default menu item
*
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_default = array();
@@ -37,7 +37,7 @@
/**
* Identifier of the active menu item
*
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_active = 0;
@@ -45,10 +45,10 @@
/**
* Class constructor
*
- * @param array $options An array of configuration options.
+ * @param array $options An array of configuration options.
*
- * @return JMenu A JMenu object
- * @since 11.1
+ * @return JMenu A JMenu object
+ * @since 11.1
*/
public function __construct($options = array())
{
@@ -71,11 +71,11 @@
/**
* Returns a JMenu object
*
- * @param string $client The name of the client
- * @param array $options An associative array of options
+ * @param string $client The name of the client
+ * @param array $options An associative array of options
*
- * @return JMenu A menu object.
- * @since 11.1
+ * @return JMenu A menu object.
+ * @since 11.1
*/
public static function getInstance($client, $options = array())
{
@@ -113,10 +113,10 @@
/**
* Get menu item by id
*
- * @param integer $id The item id
+ * @param integer $id The item id
*
- * @return mixed The item object, or null if not found
- * @since 11.1
+ * @return mixed The item object, or null if not found
+ * @since 11.1
*/
public function getItem($id)
{
@@ -131,11 +131,11 @@
/**
* Set the default item by id and language code.
*
- * @param integer $id The menu item id.
- * @param string $language The language cod (since 1.6).
+ * @param integer $id The menu item id.
+ * @param string $language The language cod (since 1.6).
*
- * @return boolean True, if succesfull
- * @since 11.1
+ * @return boolean True, if succesfull
+ * @since 11.1
*/
public function setDefault($id, $language='')
{
@@ -150,10 +150,10 @@
/**
* Get the default item by language code.
*
- * @param string $language The language code, default * meaning all.
+ * @param string $language The language code, default * meaning all.
*
- * @return object The item object
- * @since 11.1
+ * @return object The item object
+ * @since 11.1
*/
function getDefault($language='*')
{
@@ -171,9 +171,9 @@
/**
* Set the default item by id
*
- * @param integer $id The item id
+ * @param integer $id The item id
*
- * @return mixed If successfull the active item, otherwise null
+ * @return mixed If successfull the active item, otherwise null
*/
public function setActive($id)
{
@@ -189,7 +189,7 @@
/**
* Get menu item by id.
*
- * @return object The item object.
+ * @return object The item object.
*/
public function getActive()
{
@@ -204,11 +204,11 @@
/**
* Gets menu items by attribute
*
- * @param string $attributes The field name
- * @param string $values The value of the field
- * @param boolean $firstonly If true, only returns the first item found
+ * @param string $attributes The field name
+ * @param string $values The value of the field
+ * @param boolean $firstonly If true, only returns the first item found
*
- * @return array
+ * @return array
*/
public function getItems($attributes, $values, $firstonly = false)
{
@@ -254,9 +254,9 @@
/**
* Gets the parameter object for a certain menu item
*
- * @param integer $id The item id
+ * @param integer $id The item id
*
- * @return JRegistry A JRegistry object
+ * @return JRegistry A JRegistry object
*/
public function getParams($id)
{
@@ -271,7 +271,7 @@
/**
* Getter for the menu array
*
- * @return array
+ * @return array
*/
public function getMenu()
{
@@ -282,10 +282,10 @@
* Method to check JMenu object authorization against an access control
* object and optionally an access extension object
*
- * @param integer $id The menu id
- *
- * @return boolean True if authorised
- * @since 11.1
+ * @param integer $id The menu id
+ *
+ * @return boolean True if authorised
+ * @since 11.1
*/
public function authorise($id)
{
@@ -303,8 +303,8 @@
/**
* Loads the menu items
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public function load()
{
Modified: development/branches/platform/libraries/joomla/application/module/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/application/module/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/module/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -15,7 +15,6 @@
/**
* Module helper class
*
- * @static
* @package Joomla.Platform
* @subpackage Application
* @since 11.1
@@ -25,10 +24,10 @@
/**
* Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')
*
- * @param string The name of the module
- * @param string The title of the module, optional
+ * @param string The name of the module
+ * @param string The title of the module, optional
*
- * @return object The Module object
+ * @return object The Module object
*/
public static function &getModule($name, $title = null)
{
@@ -70,9 +69,9 @@
/**
* Get modules by position
*
- * @param string $position The position of the module
+ * @param string $position The position of the module
*
- * @return array An array of module objects
+ * @return array An array of module objects
*/
public static function &getModules($position)
{
@@ -106,9 +105,9 @@
/**
* Checks if a module is enabled
*
- * @param string The module name
+ * @param string The module name
*
- * @return boolean
+ * @return boolean
*/
public static function isEnabled($module)
{
@@ -119,10 +118,10 @@
/**
* Render the module.
*
- * @param object A module object.
- * @param array An array of attributes for the module (probably from the XML).
+ * @param object A module object.
+ * @param array An array of attributes for the module (probably from the XML).
*
- * @return string The HTML content of the module output.
+ * @return string The HTML content of the module output.
*/
public static function renderModule($module, $attribs = array())
{
@@ -214,10 +213,10 @@
/**
* Get the path to a layout for a module
*
- * @param string $module The name of the module
- * @param string $layout The name of the module layout. If alternative layout, in the form template:filename.
- * @return string The path to the module layout
- * @since 11.1
+ * @param string $module The name of the module
+ * @param string $layout The name of the module layout. If alternative layout, in the form template:filename.
+ * @return string The path to the module layout
+ * @since 11.1
*/
public static function getLayoutPath($module, $layout = 'default')
{
@@ -248,7 +247,7 @@
/**
* Load published modules
*
- * @return array
+ * @return array
*/
protected static function &_load()
{
@@ -363,14 +362,13 @@
* 'safeuri' id created from $cacheparams->modeparams array,
* 'id' module sets own cache id's
*
- * @static
- * @param object $module Module object
- * @param object $moduleparams module parameters
- * @param object $cacheparams module cache parameters - id or url parameters, depending on the module cache mode
- * @param array $params - parameters for given mode - calculated id or an array of safe url parameters and their
+ * @param object $module Module object
+ * @param object $moduleparams module parameters
+ * @param object $cacheparams module cache parameters - id or url parameters, depending on the module cache mode
+ * @param array $params - parameters for given mode - calculated id or an array of safe url parameters and their
* variable types, for valid values see {@link JFilterInput::clean()}.
*
- * @since 11.1
+ * @since 11.1
*/
public static function moduleCache($module, $moduleparams, $cacheparams)
{
Modified: development/branches/platform/libraries/joomla/application/pathway.php
===================================================================
--- development/branches/platform/libraries/joomla/application/pathway.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/pathway.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,16 +21,14 @@
class JPathway extends JObject
{
/**
- * Array to hold the pathway item objects
- * @var array
- * @since 11.1
+ * @var array Array to hold the pathway item objects
+ * @since 11.1
*/
protected $_pathway = null;
/**
- * Integer number of items in the pathway
- * @var integer
- * @since 11.1
+ * @var integer Integer number of items in the pathway
+ * @since 11.1
*/
protected $_count = 0;
@@ -46,11 +44,11 @@
/**
* Returns a JPathway object
*
- * @param string $client The name of the client
- * @param array $options An associative array of options
- *
- * @return JPathway A JPathway object.
- * @since 11.1
+ * @param string $client The name of the client
+ * @param array $options An associative array of options
+ *
+ * @return JPathway A JPathway object.
+ * @since 11.1
*/
public static function getInstance($client, $options = array())
{
@@ -89,7 +87,7 @@
/**
* Return the JPathWay items array
*
- * @return array Array of pathway items
+ * @return array Array of pathway items
* @since 11.1
*/
public function getPathway()
@@ -103,10 +101,10 @@
/**
* Set the JPathway items array.
*
- * @param array $pathway An array of pathway objects.
- *
- * @return array The previous pathway data.
- * @since 11.1
+ * @param array $pathway An array of pathway objects.
+ *
+ * @return array The previous pathway data.
+ * @since 11.1
*/
public function setPathway($pathway)
{
@@ -122,7 +120,7 @@
/**
* Create and return an array of the pathway names.
*
- * @return array Array of names of pathway items
+ * @return array Array of names of pathway items
* @since 11.1
*/
public function getPathwayNames()
@@ -142,10 +140,10 @@
/**
* Create and add an item to the pathway.
*
- * @param string $name
- * @param string $link
- *
- * @return boolean True on success
+ * @param string $name
+ * @param string $link
+ *
+ * @return boolean True on success
* @since 11.1
*/
public function addItem($name, $link='')
@@ -164,10 +162,10 @@
/**
* Set item name.
*
- * @param integer $id
- * @param string $name
- *
- * @return boolean True on success
+ * @param integer $id
+ * @param string $name
+ *
+ * @return boolean True on success
* @since 11.1
*/
public function setItemName($id, $name)
@@ -186,10 +184,10 @@
/**
* Create and return a new pathway object.
*
- * @param string $name Name of the item
- * @param string $link Link to the item
- *
- * @return JPathway Pathway item object
+ * @param string $name Name of the item
+ * @param string $link Link to the item
+ *
+ * @return JPathway Pathway item object
* @since 11.1
*/
protected function _makeItem($name, $link)
Modified: development/branches/platform/libraries/joomla/application/router.php
===================================================================
--- development/branches/platform/libraries/joomla/application/router.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/application/router.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -64,11 +64,11 @@
* Returns the global JRouter object, only creating it if it
* doesn't already exist.
*
- * @param string $client The name of the client
- * @param array $options An associative array of options
- *
- * @return JRouter A JRouter object.
- * @since 11.1
+ * @param string $client The name of the client
+ * @param array $options An associative array of options
+ *
+ * @return JRouter A JRouter object.
+ * @since 11.1
*/
public static function getInstance($client, $options = array())
{
@@ -102,11 +102,11 @@
/**
* Function to convert a route to an internal URI
- *
- * @param string $uri
- *
- * @return array
- * @since 11.1
+ *
+ * @param string $uri
+ *
+ * @return array
+ * @since 11.1
*/
public function parse(&$uri)
{
@@ -131,10 +131,10 @@
/**
* Function to convert an internal URI to a route
*
- * @param string The internal URL
- *
- * @return string The absolute search engine friendly URL
- * @since 11.1
+ * @param string The internal URL
+ *
+ * @return string The absolute search engine friendly URL
+ * @since 11.1
*/
public function build($url)
{
@@ -159,9 +159,9 @@
/**
* Get the router mode
- *
- * @return
- * @since 11.1
+ *
+ * @return
+ * @since 11.1
*/
public function getMode()
{
@@ -170,8 +170,8 @@
/**
* Get the router mode
- * @return
- * @since 11.1
+ * @return
+ * @since 11.1
*/
public function setMode($mode)
{
@@ -181,12 +181,12 @@
/**
* Set a router variable, creating it if it doesn't exist
*
- * @param string $key The name of the variable
- * @param mixed $value The value of the variable
- * @param boolean $create If True, the variable will be created if it doesn't exist yet
- *
- * @return
- * @since 11.1
+ * @param string $key The name of the variable
+ * @param mixed $value The value of the variable
+ * @param boolean $create If True, the variable will be created if it doesn't exist yet
+ *
+ * @return
+ * @since 11.1
*/
public function setVar($key, $value, $create = true)
{
@@ -200,11 +200,11 @@
/**
* Set the router variable array
*
- * @param array $vars An associative array with variables
- * @param boolean $merge If True, the array will be merged instead of overwritten
- *
- * @return
- * @since 11.1
+ * @param array $vars An associative array with variables
+ * @param boolean $merge If True, the array will be merged instead of overwritten
+ *
+ * @return
+ * @since 11.1
*/
public function setVars($vars = array(), $merge = true)
{
@@ -218,10 +218,10 @@
/**
* Get a router variable
*
- * @param string The name of the variable
- *
- * @return mixed Value of the variable
- * @since 11.1
+ * @param string The name of the variable
+ *
+ * @return mixed Value of the variable
+ * @since 11.1
*/
public function getVar($key)
{
@@ -235,8 +235,8 @@
/**
* Get the router variable array
*
- * @return array An associative array of router variables
- * @since 11.1
+ * @return array An associative array of router variables
+ * @since 11.1
*/
public function getVars()
{
@@ -247,9 +247,9 @@
* Attach a build rule
*
* @param string callback The function to be called
- *
+ *
* @return
- * @since 11.1.
+ * @since 11.1.
*/
public function attachBuildRule($callback)
{
@@ -259,10 +259,10 @@
/**
* Attach a parse rule
*
- * @param string $callback The function to be called.
- *
+ * @param string $callback The function to be called.
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
public function attachParseRule($callback)
{
@@ -271,11 +271,11 @@
/**
* Function to convert a raw route to an internal URI
- *
- * @param string The raw route
- *
+ *
+ * @param string The raw route
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
protected function _parseRawRoute(&$uri)
{
@@ -284,11 +284,11 @@
/**
* Function to convert a sef route to an internal URI
- *
- * @param string The sef URI
- *
- * @return string Internal URI
- * @since 11.1
+ *
+ * @param string The sef URI
+ *
+ * @return string Internal URI
+ * @since 11.1
*/
protected function _parseSefRoute(&$uri)
{
@@ -297,11 +297,11 @@
/**
* Function to build a raw route
- *
- * @param string The internal URL
- *
- * @return Raw Route
- * @since 11.1
+ *
+ * @param string The internal URL
+ *
+ * @return Raw Route
+ * @since 11.1
*/
protected function _buildRawRoute(&$uri)
{
@@ -309,24 +309,23 @@
/**
* Function to build a sef route
- *
- * @param string The uri
- *
- * @return string The SEF route
+ *
+ * @param string The uri
+ *
+ * @return string The SEF route
* @since 11.1
*/
protected function _buildSefRoute(&$uri)
{
-
}
-
+
/**
* Process the parsed router variables based on custom defined rules
- *
- * @param string The URI to parse
- *
- * @return array The array of processed URI variables
- * @since 11.1
+ *
+ * @param string The URI to parse
+ *
+ * @return array The array of processed URI variables
+ * @since 11.1
*/
protected function _processParseRules(&$uri)
{
@@ -341,11 +340,11 @@
/**
* Process the build uri query data based on custom defined rules
- *
- * @param string The URI
+ *
+ * @param string The URI
* @return
- *
- * @since 11.1
+ *
+ * @since 11.1
*/
protected function _processBuildRules(&$uri)
{
@@ -356,11 +355,11 @@
/**
* Create a uri based on a full or partial url string
- *
- * @param string $url The URI
- *
- * @return JURI A JURI object
- * @since 11.1
+ *
+ * @param string $url The URI
+ *
+ * @return JURI A JURI object
+ * @since 11.1
*/
protected function _createURI($url)
{
@@ -391,10 +390,10 @@
/**
* Encode route segments
*
- * @param array An array of route segments
- *
- * @return array Array of encoded route segments
- * @since 11.1
+ * @param array An array of route segments
+ *
+ * @return array Array of encoded route segments
+ * @since 11.1
*/
protected function _encodeSegments($segments)
{
@@ -409,9 +408,9 @@
/**
* Decode route segments
*
- * @param array $segments An array of route segments
- *
- * @return array Array of decoded route segments
+ * @param array $segments An array of route segments
+ *
+ * @return array Array of decoded route segments
* @since 11,1
*/
protected function _decodeSegments($segments)
Modified: development/branches/platform/libraries/joomla/base/adapter.php
===================================================================
--- development/branches/platform/libraries/joomla/base/adapter.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/adapter.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -56,12 +56,12 @@
/**
* Constructor
*
- * @param string $basepath Base Path of the adapters
- * @param string $classprefix Class prefix of adapters
- * @param string $adapterfolder Name of folder to append to base path
+ * @param string $basepath Base Path of the adapters
+ * @param string $classprefix Class prefix of adapters
+ * @param string $adapterfolder Name of folder to append to base path
*
- * @return JAdapter JAdapter object
- * @since 11.1
+ * @return JAdapter JAdapter object
+ * @since 11.1
*/
public function __construct($basepath, $classprefix = null, $adapterfolder = null)
{
@@ -75,8 +75,8 @@
/**
* Get the database connector object
*
- * @return object Database connector object
- * @since 11.1
+ * @return object Database connector object
+ * @since 11.1
*/
public function getDBO()
{
@@ -86,12 +86,12 @@
/**
* Set an adapter by name
*
- * @param string $name Adapter name
- * @param object $adapter Adapter object
- * @param array $options Adapter options
+ * @param string $name Adapter name
+ * @param object $adapter Adapter object
+ * @param array $options Adapter options
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
public function setAdapter($name, &$adapter = null, $options = Array())
{
@@ -121,11 +121,11 @@
/**
* Return an adapter.
*
- * @param string $name Name of adapter to return
- * @param array $options Adapter options
+ * @param string $name Name of adapter to return
+ * @param array $options Adapter options
*
- * @return object Adapter of type 'name' or false
- * @since 11.1
+ * @return object Adapter of type 'name' or false
+ * @since 11.1
*/
public function getAdapter($name, $options = Array())
{
@@ -143,10 +143,10 @@
/**
* Loads all adapters.
*
- * @param array $options Adapter options
+ * @param array $options Adapter options
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function loadAllAdapters($options = array())
{
Modified: development/branches/platform/libraries/joomla/base/adapterinstance.php
===================================================================
--- development/branches/platform/libraries/joomla/base/adapterinstance.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/adapterinstance.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,16 +19,13 @@
class JAdapterInstance extends JObject {
/**
- * Parent
- * @var object
+ * @var object Parent
* @since 11.1
*/
protected $parent = null;
/**
- * Database
- *
- * @var object
+ * @var object Database
* @since 11.1
*/
protected $db = null;
@@ -36,11 +33,13 @@
/**
* Constructor
*
- * @param object $parent Parent object [JAdapter instance]
- * @param object $db Database object [JDatabase instance]
- * @param array $options Configuration Options
+ * @param object $parent Parent object [JAdapter instance]
+ * @param object $db Database object [JDatabase instance]
+ * @param array $options Configuration Options
*
- * @since 11.1
+ * @return JAdapterInstance
+ *
+ * @since 11.1
*/
public function __construct(&$parent, &$db, $options = Array())
{
@@ -56,8 +55,8 @@
/**
* Retrieves the parent object
*
- * @return object parent
- * @since 11.1
+ * @return object parent
+ * @since 11.1
*/
public function getParent()
{
Modified: development/branches/platform/libraries/joomla/base/node.php
===================================================================
--- development/branches/platform/libraries/joomla/base/node.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/node.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -20,22 +20,20 @@
{
/**
- * Parent node
- * @var
+ * @var object Parent node.
* @since 11.1
*/
protected $_parent = null;
/**
- * Array of Children
- * @var array
+ * @var array Array of Children
* @since 11.1
*/
protected $_children = array();
/**
* Constructor
- *
+ *
* @since 11.1
*/
function __construct()
@@ -49,7 +47,7 @@
* If the child already has a parent, the link is unset
*
* @param JNode the child to be added
- *
+ *
* @return
* @since 11.1
*/
@@ -66,10 +64,10 @@
*
* If the node already has a parent, the link is unset
*
- * @param JNode|null The parent to be set
- *
+ * @param JNode|null The parent to be set
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
function setParent(&$parent)
{
@@ -91,8 +89,8 @@
/**
* Get the children of this node
*
- * @return array The children
- * @since 11.1
+ * @return array The children
+ * @since 11.1
*/
function &getChildren()
{
@@ -113,7 +111,7 @@
/**
* Test if this node has children
*
- * @return boolean
+ * @return bool
* @since 11.1
*/
function hasChildren()
@@ -124,7 +122,7 @@
/**
* Test if this node has a parent
*
- * @return boolean
+ * @return bool
* @since 11.1
*/
function hasParent()
Modified: development/branches/platform/libraries/joomla/base/object.php
===================================================================
--- development/branches/platform/libraries/joomla/base/object.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/object.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,9 +32,12 @@
/**
* Class constructor, overridden in descendant classes.
*
- * @param mixed $properties Either and associative array or another
- * object to set the initial properties of the object.
- * @since 11.1
+ * @param mixed $properties Either and associative array or another
+ * object to set the initial properties of the object.
+ *
+ * @return JObject
+ *
+ * @since 11.1
*/
public function __construct($properties = null)
{
@@ -46,8 +49,8 @@
/**
* Magic method to convert the object to a string gracefully.
*
- * @return string The classname.
- * @since 11.1
+ * @return string The classname.
+ * @since 11.1
*/
public function __toString()
{
@@ -57,11 +60,11 @@
/**
* Sets a default value if not alreay assigned
*
- * @param string $property The name of the property.
- * @param mixed $default The default value.
- *
- * @return mixed
- * @since 11.1
+ * @param string $property The name of the property.
+ * @param mixed $default The default value.
+ *
+ * @return mixed
+ * @since 11.1
*/
public function def($property, $default=null)
{
@@ -72,13 +75,13 @@
/**
* Returns a property of the object or the default value if the property is not set.
*
- * @param string $property The name of the property.
- * @param mixed $default The default value.
- *
- * @see getProperties()
- *
- * @return mixed The value of the property.
- * @since 11.1
+ * @param string $property The name of the property.
+ * @param mixed $default The default value.
+ *
+ * @return mixed The value of the property.
+ *
+ * @see getProperties()
+ * @since 11.1
*/
public function get($property, $default=null)
{
@@ -91,12 +94,12 @@
/**
* Returns an associative array of object properties.
*
- * @param boolean $public If true, returns only the public properties.
+ * @param boolean $public If true, returns only the public properties.
*
+ * @return array
+ *
* @see get()
- *
- * @return array
- * @since 11.1
+ * @since 11.1
*/
public function getProperties($public = true)
{
@@ -117,11 +120,11 @@
/**
* Get the most recent error message.
*
- * @param integer $i Option error index.
- * @param boolean $toString Indicates if JError objects should return their error message.
- *
- * @return string Error message
- * @since 11.1
+ * @param integer $i Option error index.
+ * @param boolean $toString Indicates if JError objects should return their error message.
+ *
+ * @return string Error message
+ * @since 11.1
*/
public function getError($i = null, $toString = true)
{
@@ -151,8 +154,8 @@
/**
* Return all errors, if any.
*
- * @return array Array of error messages or JErrors.
- * @since 11.1
+ * @return array Array of error messages or JErrors.
+ * @since 11.1
*/
public function getErrors()
{
@@ -162,11 +165,11 @@
/**
* Modifies a property of the object, creating it if it does not already exist.
*
- * @param string $property The name of the property.
- * @param mixed $value The value of the property to set.
+ * @param string $property The name of the property.
+ * @param mixed $value The value of the property to set.
*
- * @return mixed Previous value of the property.
- * @since 11.1
+ * @return mixed Previous value of the property.
+ * @since 11.1
*/
public function set($property, $value = null)
{
@@ -178,12 +181,12 @@
/**
* Set the object properties based on a named array/hash.
*
- * @param mixed $properties Either an associative array or another object.
- * @@see set()
- *
- * return boolean
- *
- * @since 11.1
+ * @param mixed $properties Either an associative array or another object.
+ *
+ * @return boolean
+ *
+ * @see set()
+ * @since 11.1
*/
public function setProperties($properties)
{
@@ -203,10 +206,10 @@
/**
* Add an error message.
*
- * @param string $error Error message.
- *
- * @return array updated array or errors
- * @since 11.1
+ * @param string $error Error message.
+ *
+ * @return array updated array or errors
+ * @since 11.1
*/
public function setError($error)
{
@@ -214,10 +217,12 @@
}
/**
- * @see __toString()
- *
- * @since 11.1
- * @deprecated Use __toString()
+ * @return string
+ *
+ * @deprecated
+ * @note Use magic method __toString()
+ * @see __toString()
+ * @since 11.1
*/
function toString()
{
Modified: development/branches/platform/libraries/joomla/base/observable.php
===================================================================
--- development/branches/platform/libraries/joomla/base/observable.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/observable.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -55,8 +55,8 @@
/**
* Get the state of the JObservable object
*
- * @return mixed The state of the object.
- * @since 11.1
+ * @return mixed The state of the object.
+ * @since 11.1
*/
public function getState()
{
@@ -66,8 +66,8 @@
/**
* Update each attached observer object and return an array of their return values
*
- * @return array Array of return values from the observers
- * @since 11.1
+ * @return array Array of return values from the observers
+ * @since 11.1
*/
public function notify()
{
@@ -83,10 +83,10 @@
/**
* Attach an observer object
*
- * @param object $observer An observer object to attach
+ * @param object $observer An observer object to attach
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function attach($observer)
{
@@ -143,9 +143,9 @@
/**
* Detach an observer object
*
- * @param object $observer An observer object to detach.
+ * @param object $observer An observer object to detach.
*
- * @return boolean True if the observer object was detached.
+ * @return bool True if the observer object was detached.
* @since 11.1
*/
public function detach($observer)
Modified: development/branches/platform/libraries/joomla/base/observer.php
===================================================================
--- development/branches/platform/libraries/joomla/base/observer.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/observer.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,9 +29,11 @@
/**
* Constructor
*
- * @param object $subject The object to observe.
- *
- * @since 11.1
+ * @param object $subject The object to observe.
+ *
+ * @return JObserver
+ *
+ * @since 11.1
*/
public function __construct(&$subject)
{
@@ -45,10 +47,10 @@
/**
* Method to update the state of observable objects
*
- * @param array $args An array of arguments to pass to the listener.
- *
- * @return mixed
- * @since 11.1
+ * @param array $args An array of arguments to pass to the listener.
+ *
+ * @return mixed
+ * @since 11.1
*/
public abstract function update(&$args);
}
\ No newline at end of file
Modified: development/branches/platform/libraries/joomla/base/tree.php
===================================================================
--- development/branches/platform/libraries/joomla/base/tree.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/base/tree.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -37,21 +37,24 @@
/**
* Constructor
*
- * @since 11.1
+ * @return JTree
+ *
+ * @since 11.1
*/
function __construct()
{
$this->_root = new JNode('ROOT');
$this->_current = & $this->_root;
}
+
/**
* Method to add a child
*
- * @param array $node.
- * @param boolean $setCurrent
- *
- * @return mixed
- * @since 11.1
+ * @param array $node.
+ * @param boolean $setCurrent
+ *
+ * @return mixed
+ * @since 11.1
*/
function addChild(&$node, $setCurrent = false)
{
@@ -63,9 +66,9 @@
/**
* Method to get the parent
- *
- * @return
- * @since 11.1
+ *
+ * @return
+ * @since 11.1
*/
function getParent()
{
@@ -74,13 +77,12 @@
/**
* Method to get the parent
- *
- * @return
- * @since 11.1
+ *
+ * @return
+ * @since 11.1
*/
function reset()
{
$this->_current = &$this->_root;
}
}
-
Modified: development/branches/platform/libraries/joomla/cache/cache.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/cache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/cache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,17 +28,13 @@
class JCache extends JObject
{
/**
- * Storage handler
- *
- * @var object
+ * @var object Storage handler
* @since 11.1
*/
public static $_handler = array();
/**
- * Options
- *
- * @var
+ * @var Options
* @since 11.1
*/
public $_options;
@@ -46,9 +42,9 @@
/**
* Constructor
*
- * @param array $options options
- *
- * @since 11.1
+ * @param array $options options
+ *
+ * @since 11.1
*/
public function __construct($options)
{
@@ -81,11 +77,11 @@
/**
* Returns a reference to a cache adapter object, always creating it
*
- * @param string $type The cache object type to instantiate
- * @param array $options The array of options
- *
- * @return JCache A JCache object
- * @since 11.1
+ * @param string $type The cache object type to instantiate
+ * @param array $options The array of options
+ *
+ * @return JCache A JCache object
+ * @since 11.1
*/
public static function getInstance($type = 'output', $options = array())
{
@@ -95,8 +91,8 @@
/**
* Get the storage handlers
*
- * @return array An array of available storage handlers
- * @since 11.1
+ * @return array An array of available storage handlers
+ * @since 11.1
*/
public static function getStores()
{
@@ -123,10 +119,10 @@
/**
* Set caching enabled state
*
- * @param boolean $enabled True to enable caching
- *
- * @return void
- * @since 11.1
+ * @param boolean $enabled True to enable caching
+ *
+ * @return void
+ * @since 11.1
*/
public function setCaching($enabled)
{
@@ -136,8 +132,8 @@
/**
* Get caching state
*
- * @return boolean Caching state
- * @since 11.1
+ * @return boolean Caching state
+ * @since 11.1
*/
public function getCaching()
{
@@ -147,10 +143,10 @@
/**
* Set cache lifetime
*
- * @param integer $lt Cache lifetime
- *
- * @return void
- * @since 11.1
+ * @param integer $lt Cache lifetime
+ *
+ * @return void
+ * @since 11.1
*/
public function setLifeTime($lt)
{
@@ -160,11 +156,11 @@
/**
* Get cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return mixed boolean False on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return mixed boolean False on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group=null)
{
@@ -182,8 +178,8 @@
/**
* Get a list of all cached data
*
- * @return mixed Boolean false on failure or an object with a list of cache groups and data
- * @since 11.1
+ * @return mixed Boolean false on failure or an object with a list of cache groups and data
+ * @since 11.1
*/
public function getAll()
{
@@ -198,12 +194,12 @@
/**
* Store the cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param mixed $data The data to store
- *
- * @return boolean True if cache stored
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param mixed $data The data to store
+ *
+ * @return boolean True if cache stored
+ * @since 11.1
*/
public function store($data, $id, $group=null)
{
@@ -222,11 +218,11 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group=null)
{
@@ -247,11 +243,11 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- *
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ *
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group=null, $mode='group')
{
@@ -269,8 +265,8 @@
/**
* Garbage collect expired cache data
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function gc()
{
@@ -285,12 +281,12 @@
/**
* Set lock flag on cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param $locktime
- *
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param $locktime
+ *
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function lock($id,$group=null,$locktime=null)
{
@@ -359,11 +355,11 @@
/**
* Unset lock flag on cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function unlock($id,$group=null)
{
@@ -389,8 +385,8 @@
/**
* Get the cache storage handler
*
- * @return JCacheStorage A JCacheStorage object
- * @since 11.1
+ * @return JCacheStorage A JCacheStorage object
+ * @since 11.1
*/
public function &_getStorage()
{
@@ -403,11 +399,11 @@
/**
* Perform workarounds on retrieved cached data
*
- * @param string Cached data
- * @param array Array of options
- *
- * @return string Body of cached data
- * @since 11.1
+ * @param string Cached data
+ * @param array Array of options
+ *
+ * @return string Body of cached data
+ * @since 11.1
*/
public static function getWorkarounds($data,$options=array()) {
@@ -456,11 +452,11 @@
/**
* Create workarounded data to be cached
*
- * @param string $data Cached data
- * @param array $options Array of options
- *
- * @return string Data to be cached
- * @since 11.1
+ * @param string $data Cached data
+ * @param array $options Array of options
+ *
+ * @return string Data to be cached
+ * @since 11.1
*/
public static function setWorkarounds($data,$options=array())
{
@@ -539,8 +535,8 @@
/**
* Create safe id for cached data from url parameters set by plugins and framework
*
- * @return string md5 encoded cacheid
- * @since 11.1
+ * @return string md5 encoded cacheid
+ * @since 11.1
*/
public static function makeId()
{
@@ -579,10 +575,10 @@
* Add a directory where JCache should search for handlers. You may
* either pass a string or an array of directories.
*
- * @param string A path to search.
- *
- * @return array An array with directory elements
- * @since 11.1
+ * @param string A path to search.
+ *
+ * @return array An array with directory elements
+ * @since 11.1
*/
public static function addIncludePath($path='')
{
Modified: development/branches/platform/libraries/joomla/cache/controller/callback.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/controller/callback.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/controller/callback.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -31,8 +31,9 @@
* - Function name as a string eg. 'foo' for function foo()
* - Static method name as a string eg. 'MyClass::myMethod' for method myMethod() of class MyClass
*
- * @return mixed Result of the callback
- * @since 11.1
+ * @return mixed Result of the callback
+ *
+ * @since 11.1
*/
public function call()
{
@@ -46,14 +47,15 @@
/**
* Executes a cacheable callback if not found in cache else returns cached output and result
*
- * @param mixed Callback or string shorthand for a callback
- * @param array Callback arguments
- * @param string Cache id
- * @param boolean Perform workarounds on data?
- * @param array Workaround options
- *
- * @return mixed Result of the callback
- * @since 11.1
+ * @param mixed Callback or string shorthand for a callback
+ * @param array Callback arguments
+ * @param string Cache id
+ * @param boolean Perform workarounds on data?
+ * @param array Workaround options
+ *
+ * @return mixed Result of the callback
+ *
+ * @since 11.1
*/
public function get($callback, $args=array(), $id=false, $wrkarounds=false, $woptions=array())
{
@@ -148,11 +150,12 @@
/**
* Generate a callback cache id
*
- * @param callback $callback Callback to cache
- * @param array $args Arguments to the callback method to cache
- *
- * @return string MD5 Hash : function cache id
- * @since 11.1
+ * @param callback $callback Callback to cache
+ * @param array $args Arguments to the callback method to cache
+ *
+ * @return string MD5 Hash : function cache id
+ *
+ * @since 11.1
*/
protected function _makeId($callback, $args)
{
Modified: development/branches/platform/libraries/joomla/cache/controller/output.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/controller/output.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/controller/output.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,28 +19,28 @@
class JCacheControllerOutput extends JCacheController
{
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_id;
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_group;
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_locktest = null;
/**
* Start the cache
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True if the cache is hit (false else)
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True if the cache is hit (false else)
+ * @since 11.1
*/
public function start($id, $group=null)
{
@@ -84,8 +84,8 @@
/**
* Stop the cache buffer and store the cached data
*
- * @return boolean True if cache stored
- * @since 11.1
+ * @return boolean True if cache stored
+ * @since 11.1
*/
public function end()
{
Modified: development/branches/platform/libraries/joomla/cache/controller/page.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/controller/page.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/controller/page.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
* ID property for the cache page object.
*
* @var integer
- * @since 11.1
+ * @since 11.1
*/
protected $_id;
@@ -30,7 +30,7 @@
* Cache group
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_group;
@@ -38,18 +38,19 @@
* Cache lock test
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $_locktest = null;
/**
* Get the cached page data
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True if the cache is hit (false else)
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True if the cache is hit (false else)
+ *
+ * @since 11.1
*/
public function get($id=false, $group='page', $wrkarounds=true)
{
@@ -108,8 +109,9 @@
/**
* Stop the cache buffer and store the cached data
*
- * @return boolean True if cache stored
- * @since 11.1
+ * @return boolean True if cache stored
+ *
+ * @since 11.1
*/
public function store($wrkarounds=true)
{
@@ -147,8 +149,9 @@
* @todo TODO: Discuss whether this should be coupled to a data hash or a request
* hash ... perhaps hashed with a serialized request
*
- * @return string MD5 Hash : page cache id
- * @since 11.1
+ * @return string MD5 Hash : page cache id
+ *
+ * @since 11.1
*/
protected function _makeId()
{
@@ -159,8 +162,9 @@
/**
* There is no change in page data so send a not modified header and die gracefully
*
- * @return void
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
protected function _noChange()
{
@@ -174,8 +178,9 @@
/**
* Set the ETag header in the response
*
- * @return void
- * @since 11.1
+ * @return void
+ *
+ * @since 11.1
*/
protected function _setEtag($etag)
{
Modified: development/branches/platform/libraries/joomla/cache/controller/view.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/controller/view.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/controller/view.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,13 +21,14 @@
/**
* Get the cached view data
*
- * @param object $view The view object to cache output for
- * @param string $method The method name of the view method to cache output for
- * @param string $group The cache data group
- * @param string $id The cache data id
- *
- * @return boolean True if the cache is hit (false else)
- * @since 11.1
+ * @param object $view The view object to cache output for
+ * @param string $method The method name of the view method to cache output for
+ * @param string $group The cache data group
+ * @param string $id The cache data id
+ *
+ * @return boolean True if the cache is hit (false else)
+ *
+ * @since 11.1
*/
public function get(&$view, $method, $id=false, $wrkarounds=true)
{
@@ -111,11 +112,12 @@
/**
* Generate a view cache id.
*
- * @param object $view The view object to cache output for
- * @param string $method The method name to cache for the view object
- *
- * @return string MD5 Hash : view cache id
- * @since 11.1
+ * @param object $view The view object to cache output for
+ * @param string $method The method name to cache for the view object
+ *
+ * @return string MD5 Hash : view cache id
+ *
+ * @since 11.1
*/
protected function _makeId(&$view, $method)
{
Modified: development/branches/platform/libraries/joomla/cache/controller.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/controller.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/controller.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,24 +19,22 @@
class JCacheController
{
/**
- *
* @var
- * @since 11.1
+ * @since 11.1
*/
public $cache;
/**
- * Array of options
- * @var array
- * @since 11.1
+ * @var array Array of options
+ * @since 11.1
*/
public $options;
/**
* Constructor
*
- * @param array $options Array of options
- * @since 11.1
+ * @param array $options Array of options
+ * @since 11.1
*/
public function __construct($options)
{
@@ -52,10 +50,10 @@
}
/**
- *
- * @param ......$name
- * @param ......$arguments
- * @since 11.1
+ *
+ * @param $name
+ * @param $arguments
+ * @since 11.1
*/
public function __call ($name, $arguments)
{
@@ -66,11 +64,11 @@
/**
* Returns a reference to a cache adapter object, always creating it
*
- * @param string $type The cache object type to instantiate; default is output.
- * @param array $options Array of options
- *
- * @return JCache A JCache object
- * @since 11.1
+ * @param string $type The cache object type to instantiate; default is output.
+ * @param array $options Array of options
+ *
+ * @return JCache A JCache object
+ * @since 11.1
*/
public static function getInstance($type = 'output', $options = array())
{
@@ -97,10 +95,10 @@
/**
* Set caching enabled state
*
- * @param boolean $enabled True to enable caching
- *
- * @return void
- * @since 11.1
+ * @param boolean $enabled True to enable caching
+ *
+ * @return void
+ * @since 11.1
*/
public function setCaching($enabled)
{
@@ -110,10 +108,10 @@
/**
* Set cache lifetime
*
- * @param integer $lt Cache lifetime
- *
- * @return void
- * @since 11.1
+ * @param integer $lt Cache lifetime
+ *
+ * @return void
+ * @since 11.1
*/
public function setLifeTime($lt)
{
@@ -124,10 +122,10 @@
* Add a directory where JCache should search for controllers. You may
* either pass a string or an array of directories.
*
- * @param string A path to search.
- *
- * @return array An array with directory elements
- * @since 11.1
+ * @param string A path to search.
+ *
+ * @return array An array with directory elements
+ * @since 11.1
*/
public static function addIncludePath($path='')
{
@@ -146,11 +144,11 @@
/**
* Get stored cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return mixed False on no result, cached object otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return mixed False on no result, cached object otherwise
+ * @since 11.1
*/
public function get($id, $group=null)
{
@@ -178,12 +176,12 @@
/**
* Store data to cache by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param mixed $data The data to store
- *
- * @return boolean True if cache was stored
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param mixed $data The data to store
+ *
+ * @return boolean True if cache was stored
+ * @since 11.1
*/
public function store($data, $id, $group=null)
{
Modified: development/branches/platform/libraries/joomla/cache/storage/apc.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/apc.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/apc.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,11 +21,13 @@
/**
* Get cached data from APC by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ *
+ * @return mixed Boolean false on failure or a cached data string
+ *
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -36,8 +38,9 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ *
+ * @since 11.1
*/
public function getAll()
{
@@ -75,11 +78,13 @@
/**
* Store the data to APC by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ *
+ * @return boolean True on success, false otherwise
+ *
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -90,10 +95,12 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True on success, false otherwise
+ *
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -107,10 +114,12 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ *
+ * @return boolean True on success, false otherwise
+ *
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -130,8 +139,9 @@
/**
* Force garbage collect expired cache data as items are removed only on fetch!
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ *
+ * @since 11.1
*/
public function gc()
{
@@ -160,11 +170,13 @@
/**
* Lock cached item - override parent as this is more efficient
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ *
+ * @return boolean True on success, false otherwise.
+ *
+ * @since 11.1
*/
public function lock($id,$group,$locktime)
{
@@ -204,11 +216,13 @@
/**
* Unlock cached item - override parent for cacheid compatibility with lock
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ *
+ * @return boolean True on success, false otherwise.
+ *
+ * @since 11.1
*/
public function unlock($id,$group=null)
{
Modified: development/branches/platform/libraries/joomla/cache/storage/cachelite.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/cachelite.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/cachelite.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,20 +19,20 @@
class JCacheStorageCachelite extends JCacheStorage
{
/**
- * @since 11.1
+ * @since 11.1
*/
protected static $CacheLiteInstance = null;
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_root;
/**
* Constructor
*
- * @param array $options optional parameters
- * @since 11.1
+ * @param array $options optional parameters
+ * @since 11.1
*/
public function __construct($options = array())
{
@@ -59,7 +59,7 @@
* Instantiates the appropriate CacheLite object.
* Only initializes the engine if it does not already exist.
* Note this is a protected method
- * @param array $options optional parameters
+ * @param array $options optional parameters
* @since 11.1
*/
protected function initCache($cloptions)
@@ -72,11 +72,11 @@
/**
* Get cached data from a file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -91,8 +91,8 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
@@ -120,11 +120,11 @@
/**
* Store the data to a file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -156,10 +156,10 @@
/**
* Remove a cached data file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -179,10 +179,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -227,7 +227,7 @@
* Garbage collect expired cache data
*
* @return boolean True on success, false otherwise.
- * @since 11.1
+ * @since 11.1
*/
public function gc()
{
@@ -257,8 +257,8 @@
/**
* Test to see if the cache storage is available.
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public static function test()
{
Modified: development/branches/platform/libraries/joomla/cache/storage/eaccelerator.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/eaccelerator.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/eaccelerator.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,7 +21,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct($options = array())
{
@@ -31,11 +31,11 @@
/**
* Get cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -50,8 +50,8 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
{
@@ -89,11 +89,11 @@
/**
* Store the data to by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -104,10 +104,10 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
function remove($id, $group)
{
@@ -121,10 +121,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -149,7 +149,7 @@
* Garbage collect expired cache data
*
* @return boolean True on success, false otherwise.
- * @since 11.1
+ * @since 11.1
*/
public function gc()
{
@@ -169,11 +169,11 @@
/**
* Lock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function lock($id,$group,$locktime)
{
@@ -213,10 +213,10 @@
/**
* Unlock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function unlock($id, $group = null)
{
Modified: development/branches/platform/libraries/joomla/cache/storage/file.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/file.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/file.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,15 +19,15 @@
class JCacheStorageFile extends JCacheStorage
{
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_root;
/**
* Constructor
*
- * @param array $options optional parameters
- * @since 11.1
+ * @param array $options optional parameters
+ * @since 11.1
*/
public function __construct($options = array())
{
@@ -40,11 +40,11 @@
/**
* Get cached data from a file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -70,8 +70,8 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
{
@@ -98,11 +98,11 @@
/**
* Store the data to a file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -132,10 +132,10 @@
/**
* Remove a cached data file by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -152,10 +152,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -188,8 +188,8 @@
/**
* Garbage collect expired cache data
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function gc()
{
@@ -208,8 +208,8 @@
/**
* Test to see if the cache storage is available.
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public static function test()
{
@@ -220,11 +220,11 @@
/**
* Lock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function lock($id,$group,$locktime)
{
@@ -269,10 +269,10 @@
/**
* Unlock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function unlock($id, $group = null)
{
@@ -293,9 +293,9 @@
/**
* Check to make sure cache is still valid, if not, delete it.
*
- * @param string $id Cache key to expire.
- * @param string $group The cache data group.
- * @since 11.1
+ * @param string $id Cache key to expire.
+ * @param string $group The cache data group.
+ * @since 11.1
*/
protected function _checkExpire($id, $group)
{
@@ -316,10 +316,10 @@
/**
* Get a cache file path from an id/group pair
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return string The cache file path
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return string The cache file path
+ * @since 11.1
*/
protected function _getFilePath($id, $group)
{
@@ -344,9 +344,9 @@
/**
* Quickly delete a folder of files
*
- * @param string The path to the folder to delete.
- * @return boolean True on success.
- * @since 11.1
+ * @param string The path to the folder to delete.
+ * @return boolean True on success.
+ * @since 11.1
*/
protected function _deleteFolder($path)
{
@@ -424,10 +424,10 @@
/**
* Function to strip additional / or \ in a path name
*
- * @param string The path to clean
- * @param string Directory separator (optional)
- * @return string The cleaned path
- * @since 11.1
+ * @param string The path to clean
+ * @param string Directory separator (optional)
+ * @return string The cleaned path
+ * @since 11.1
*/
protected function _cleanPath($path, $ds = DS)
{
@@ -447,15 +447,15 @@
/**
* Utility function to quickly read the files in a folder.
*
- * @param string The path of the folder to read.
- * @param string A filter for file names.
- * @param mixed True to recursively search into sub-folders, or an
+ * @param string The path of the folder to read.
+ * @param string A filter for file names.
+ * @param mixed True to recursively search into sub-folders, or an
* integer to specify the maximum depth.
- * @param boolean True to return the full path to the file.
- * @param array Array with names of files which should not be shown in
+ * @param boolean True to return the full path to the file.
+ * @param array Array with names of files which should not be shown in
* the result.
- * @return array Files in the given folder.
- * @since 11.1
+ * @return array Files in the given folder.
+ * @since 11.1
*/
protected function _filesInFolder($path, $filter = '.', $recurse = false, $fullpath = false, $exclude = array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter = array('^\..*','.*~'))
{
@@ -512,17 +512,17 @@
/**
* Utility function to read the folders in a folder.
*
- * @param string The path of the folder to read.
- * @param string A filter for folder names.
- * @param mixed True to recursively search into sub-folders, or an
+ * @param string The path of the folder to read.
+ * @param string A filter for folder names.
+ * @param mixed True to recursively search into sub-folders, or an
* integer to specify the maximum depth.
- * @param boolean True to return the full path to the folders.
- * @param array Array with names of folders which should not be shown in
+ * @param boolean True to return the full path to the folders.
+ * @param array Array with names of folders which should not be shown in
* the result.
- * @param array Array with regular expressions matching folders which
+ * @param array Array with regular expressions matching folders which
* should not be shown in the result.
- * @return array Folders in the given folder.
- * @since 11.1
+ * @return array Folders in the given folder.
+ * @since 11.1
*/
protected function _folders($path, $filter = '.', $recurse = false, $fullpath = false, $exclude = array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter = array('^\..*'))
{
Modified: development/branches/platform/libraries/joomla/cache/storage/helpers/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/helpers/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/helpers/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,6 @@
/**
* Cache storage helper functions.
*
- * @static
* @package Joomla.Platform
* @subpackage Cache
* @since 11.1
@@ -20,24 +19,24 @@
class JCacheStorageHelper
{
/**
- * @since 11.1
+ * @since 11.1
*/
public $group = '';
/**
- * @since 11.1
+ * @since 11.1
*/
public $size = 0;
/**
- * @since 11.1
+ * @since 11.1
*/
public $count = 0;
/**
* Constructor
*
- * @param array $options options
+ * @param array $options options
*/
public function __construct($group)
{
@@ -47,9 +46,9 @@
/**
* Increase cache items count.
*
- * @param string $size Cached item size
- * @param string $group The cache data group
- * @since 11.1
+ * @param string $size Cached item size
+ * @param string $group The cache data group
+ * @since 11.1
*/
public function updateSize($size)
{
Modified: development/branches/platform/libraries/joomla/cache/storage/memcache.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/memcache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/memcache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,25 +19,25 @@
class JCacheStorageMemcache extends JCacheStorage
{
/**
- * @since 11.1
+ * @since 11.1
*/
protected static $_db = null;
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_persistent = false;
/**
- * @since 11.1
+ * @since 11.1
*/
protected $_compress = 0;
/**
* Constructor
*
- * @param array $options optional parameters
- * @since 11.1
+ * @param array $options optional parameters
+ * @since 11.1
*/
public function __construct($options = array())
{
@@ -50,8 +50,8 @@
/**
* return memcache connection object
*
- * @return object memcache connection object
- * @since 11.1
+ * @return object memcache connection object
+ * @since 11.1
*/
protected function getConnection()
{
@@ -90,11 +90,11 @@
/**
* Get cached data from memcache by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -106,8 +106,8 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
{
@@ -148,11 +148,11 @@
/**
* Store the data to memcache by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -185,10 +185,10 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -219,10 +219,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -251,7 +251,7 @@
/**
* Test to see if the cache storage is available.
*
- * @return boolean True on success, false otherwise.
+ * @return boolean True on success, false otherwise.
*/
public static function test()
{
@@ -276,11 +276,11 @@
/**
* Lock cached item - override parent as this is more efficient
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function lock($id,$group,$locktime)
{
@@ -336,10 +336,10 @@
/**
* Unlock cached item - override parent for cacheid compatibility with lock
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ * @since 11.1
* @return boolean True on success, false otherwise.
*/
public function unlock($id,$group=null)
@@ -399,8 +399,8 @@
/**
* Unlock cache index
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
protected function unlockindex()
{
Modified: development/branches/platform/libraries/joomla/cache/storage/wincache.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/wincache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/wincache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,7 +21,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct( $options = array() )
{
@@ -31,11 +31,11 @@
/**
* Get cached data from WINCACHE by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -47,8 +47,8 @@
/**
* Get all cached data
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
{
@@ -85,11 +85,11 @@
/**
* Store the data to WINCACHE by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -100,10 +100,10 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -117,10 +117,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -139,8 +139,8 @@
/**
* Force garbage collect expired cache data as items are removed only on get/add/delete/info etc
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function gc()
{
Modified: development/branches/platform/libraries/joomla/cache/storage/xcache.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage/xcache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage/xcache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,11 +21,11 @@
/**
* Get cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- * @return mixed Boolean false on failure or a cached data string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ * @return mixed Boolean false on failure or a cached data string
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -44,8 +44,8 @@
*
* requires the php.ini setting xcache.admin.enable_auth = Off
*
- * @return array data
- * @since 11.1
+ * @return array data
+ * @since 11.1
*/
public function getAll()
{
@@ -82,11 +82,11 @@
/**
* Store the data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -98,10 +98,10 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -122,10 +122,10 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -145,7 +145,7 @@
* Garbage collect expired cache data
*
* @return boolean True on success, false otherwise.
- * @since 11.1
+ * @since 11.1
*/
public function gc()
{
Modified: development/branches/platform/libraries/joomla/cache/storage.php
===================================================================
--- development/branches/platform/libraries/joomla/cache/storage.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/cache/storage.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,50 +19,43 @@
class JCacheStorage
{
/**
- * Rawname
- * @var string
- * @since 11.1
+ * @var string Rawname
+ * @since 11.1
*/
protected $rawname;
/**
- * Now
- * @var
- * @since 11.1
+ * @var Now
+ * @since 11.1
*/
public $_now;
/**
- * Liftime
- * @var
- * @since 11.1
+ * @var Lifetime
+ * @since 11.1
*/
public $_lifetime;
/**
- * Locking
- * @var
- * @since 11.1
+ * @var Locking
+ * @since 11.1
*/
public $_locking;
/**
- * Language
- * @var
- * @since 11.1
+ * @var Language
+ * @since 11.1
*/
public $_language;
/**
- * Application
- * @var
- * @since 11.1
+ * @var Application
+ * @since 11.1
*/
public $_application;
/**
- * Hash
- * @var string
+ * @var string Hash
* @since 11.1
*/
public $_hash;
@@ -70,8 +63,9 @@
/**
* Constructor
*
- * @param array $options optional parameters
- * @since 11.1
+ * @param array $options optional parameters
+ *
+ * @since 11.1
*/
public function __construct($options = array())
{
@@ -98,11 +92,12 @@
* Returns a cache storage handler object, only creating it
* if it doesn't already exist.
*
- * @param string $handler The cache storage handler to instantiate
- * @param array $options
- *
- * @return JCacheStorageHandler A JCacheStorageHandler object
- * @since 11.1
+ * @param string $handler The cache storage handler to instantiate
+ * @param array $options
+ *
+ * @return JCacheStorageHandler A JCacheStorageHandler object
+ *
+ * @since 11.1
*/
public static function getInstance($handler=null, $options = array())
{
@@ -143,12 +138,13 @@
/**
* Get cached data by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param boolean $checkTime True to verify cache time expiration threshold
- *
- * @return mixed Boolean false on failure or a cached data object
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param boolean $checkTime True to verify cache time expiration threshold
+ *
+ * @return mixed Boolean false on failure or a cached data object
+ *
+ * @since 11.1
*/
public function get($id, $group, $checkTime = true)
{
@@ -158,8 +154,8 @@
/**
* Get all cached data
*
- * @return mixed Boolean false on failure or a cached data object
- * @since 11.1
+ * @return mixed Boolean false on failure or a cached data object
+ * @since 11.1
*/
public function getAll()
{
@@ -172,12 +168,12 @@
/**
* Store the data to cache by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param string $data The data to store in cache
- *
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param string $data The data to store in cache
+ *
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function store($id, $group, $data)
{
@@ -187,11 +183,11 @@
/**
* Remove a cached data entry by id and group
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function remove($id, $group)
{
@@ -204,11 +200,11 @@
* group mode : cleans all cache in the group
* notgroup mode : cleans all cache not in the group
*
- * @param string $group The cache data group
- * @param string $mode The mode for cleaning cache [group|notgroup]
- *
- * @return boolean True on success, false otherwise
- * @since 11.1
+ * @param string $group The cache data group
+ * @param string $mode The mode for cleaning cache [group|notgroup]
+ *
+ * @return boolean True on success, false otherwise
+ * @since 11.1
*/
public function clean($group, $mode = null)
{
@@ -219,7 +215,7 @@
* Garbage collect expired cache data
*
* @return boolean True on success, false otherwise.
- * @since 11.1
+ * @since 11.1
*/
public function gc()
{
@@ -240,11 +236,11 @@
/**
* Lock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- * @param integer $locktime Cached item max lock time
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ * @param integer $locktime Cached item max lock time
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function lock($id,$group,$locktime)
{
@@ -254,11 +250,11 @@
/**
* Unlock cached item
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function unlock($id, $group = null)
{
@@ -268,11 +264,11 @@
/**
* Get a cache_id string from an id/group pair
*
- * @param string $id The cache data id
- * @param string $group The cache data group
- *
- * @return string The cache_id string
- * @since 11.1
+ * @param string $id The cache data id
+ * @param string $group The cache data group
+ *
+ * @return string The cache_id string
+ * @since 11.1
*/
protected function _getCacheId($id, $group)
{
@@ -285,10 +281,10 @@
* Add a directory where JCacheStorage should search for handlers. You may
* either pass a string or an array of directories.
*
- * @param string A path to search.
- *
- * @return array An array with directory elements
- * @since 11.1
+ * @param string A path to search.
+ *
+ * @return array An array with directory elements
+ * @since 11.1
*/
public static function addIncludePath($path='')
{
Modified: development/branches/platform/libraries/joomla/client/ftp.php
===================================================================
--- development/branches/platform/libraries/joomla/client/ftp.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/client/ftp.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -57,67 +57,49 @@
{
/**
- * Server connection resource
- * Socket resource
- *
- * @var
- * @since 11.1
+ * @var resource Socket resource
+ * @since 11.1
*/
var $_conn = null;
/**
- * Data port connection resource
- * Socket resource
- *
- * @var
- * @since 11.1
+ * @var resource Data port connection resource
+ * @since 11.1
*/
var $_dataconn = null;
/**
- * Passive connection information
- *
- * @var array
- * @since 11.1
+ * @var array Passive connection information
+ * @since 11.1
*/
var $_pasv = null;
/**
- * Response Message
- *
- * @var string
- * @since 11.1
+ * @var string Response Message
+ * @since 11.1
*/
var $_response = null;
/**
- * Timeout limit
- *
- * @var integer
- * @since 11.1
+ * @var integer Timeout limit
+ * @since 11.1
*/
var $_timeout = 15;
/**
- * Transfer Type
- *
- * @var integer
- * @since 11.1
+ * @var integer Transfer Type
+ * @since 11.1
*/
var $_type = null;
/**
- * Native OS Type
- *
- * @var string
- * @since 11.1
+ * @var string Native OS Type
+ * @since 11.1
*/
var $_OS = null;
/**
- * Array to hold ascii format file extensions
- *
- * @var array
+ * @var array Array to hold ascii format file extensions
* @since 11.1
*/
var $_autoAscii = array ("asp", "bat", "c", "cpp", "csv", "h", "htm", "html", "shtml", "ini", "inc", "log", "php", "php3", "pl", "perl", "sh", "sql", "txt", "xhtml", "xml");
@@ -125,18 +107,18 @@
/**
* Array to hold native line ending characters
*
- * @var array
- * @since 11.1
+ * @var array
+ * @since 11.1
*/
var $_lineEndings = array ('UNIX' => "\n", 'MAC' => "\r", 'WIN' => "\r\n");
/**
* JFTP object constructor
*
- * @param array $options Associative array of options to set
- *
- * @return
- * @since 11.1
+ * @param array $options Associative array of options to set
+ *
+ * @return
+ * @since 11.1
*/
function __construct($options=array()) {
@@ -173,7 +155,8 @@
*
* Closes an existing connection, if we have one
*
- * @return
+ * @return void
+ *
* @since 11.1
*/
function __destruct() {
@@ -191,14 +174,14 @@
* If you do not use this option, you must quit() the current connection when you
* are done, to free it for use by others.
*
- * @param string $host Host to connect to
- * @param string $port Port to connect to
- * @param array $options Array with any of these options: type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY], timeout=>(int)
- * @param string $user Username to use for a connection
- * @param string $pass Password to use for a connection
- *
- * @return JFTP The FTP Client object.
- * @since 11.1
+ * @param string $host Host to connect to
+ * @param string $port Port to connect to
+ * @param array $options Array with any of these options: type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY], timeout=>(int)
+ * @param string $user Username to use for a connection
+ * @param string $pass Password to use for a connection
+ *
+ * @return JFTP The FTP Client object.
+ * @since 11.1
*/
function getInstance($host = '127.0.0.1', $port = '21', $options = null, $user = null, $pass = null)
{
@@ -227,10 +210,10 @@
/**
* Set client options
*
- * @param array $options Associative array of options to set
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param array $options Associative array of options to set
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function setOptions($options) {
@@ -246,11 +229,11 @@
/**
* Method to connect to a FTP server
*
- * @param string $host Host to connect to [Default: 127.0.0.1]
- * @param string $port Port to connect on [Default: port 21]
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $host Host to connect to [Default: 127.0.0.1]
+ * @param string $port Port to connect on [Default: port 21]
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function connect($host = '127.0.0.1', $port = 21) {
@@ -297,8 +280,8 @@
/**
* Method to determine if the object is connected to an FTP server
*
- * @return boolean True if connected
- * @since 11.1
+ * @return boolean True if connected
+ * @since 11.1
*/
function isConnected()
{
@@ -308,11 +291,11 @@
/**
* Method to login to a server once connected
*
- * @param string $user Username to login to the server
- * @param string $pass Password to login to the server
+ * @param string $user Username to login to the server
+ * @param string $pass Password to login to the server
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function login($user = 'anonymous', $pass = 'jf...@joomla.org') {
@@ -348,8 +331,8 @@
/**
* Method to quit and close the connection
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function quit() {
@@ -369,8 +352,8 @@
/**
* Method to retrieve the current working directory on the FTP server
*
- * @return string Current working directory
- * @since 11.1
+ * @return string Current working directory
+ * @since 11.1
*/
function pwd() {
@@ -402,8 +385,8 @@
/**
* Method to system string from the FTP server
*
- * @return string System identifier string
- * @since 11.1
+ * @return string System identifier string
+ * @since 11.1
*/
function syst() {
@@ -438,10 +421,10 @@
/**
* Method to change the current working directory on the FTP server
*
- * @param string $path Path to change into on the server
+ * @param string $path Path to change into on the server
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function chdir($path) {
@@ -468,8 +451,8 @@
*
* NOTE: This command not available on all servers
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function reinit() {
@@ -494,11 +477,11 @@
/**
* Method to rename a file/folder on the FTP server
*
- * @param string $from Path to change file/folder from
- * @param string $to Path to change file/folder to
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $from Path to change file/folder from
+ * @param string $to Path to change file/folder to
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function rename($from, $to) {
@@ -529,11 +512,11 @@
/**
* Method to change mode for a path on the FTP server
*
- * @param string $path Path to change mode on
- * @param mixed $mode Octal value to change mode to, e.g. '0777', 0777 or 511 (string or integer)
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Path to change mode on
+ * @param mixed $mode Octal value to change mode to, e.g. '0777', 0777 or 511 (string or integer)
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function chmod($path, $mode) {
@@ -571,10 +554,10 @@
/**
* Method to delete a path [file/folder] on the FTP server
*
- * @param string $path Path to delete
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Path to delete
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function delete($path) {
@@ -602,10 +585,10 @@
/**
* Method to create a directory on the FTP server
*
- * @param string $path Directory to create
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Directory to create
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function mkdir($path) {
@@ -629,10 +612,10 @@
/**
* Method to restart data transfer at a given byte
*
- * @param integer $point Byte to restart transfer at
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param integer $point Byte to restart transfer at
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function restart($point) {
@@ -657,10 +640,10 @@
/**
* Method to create an empty file on the FTP server
*
- * @param string $path Path local file to store on the FTP server
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Path local file to store on the FTP server
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function create($path) {
@@ -708,11 +691,11 @@
/**
* Method to read a file from the FTP server's contents into a buffer
*
- * @param string $remote Path to remote file to read on the FTP server
- * @param string $buffer Buffer variable to read file contents into
+ * @param string $remote Path to remote file to read on the FTP server
+ * @param string $buffer Buffer variable to read file contents into
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function read($remote, &$buffer) {
@@ -782,11 +765,11 @@
/**
* Method to get a file from the FTP server and save it to a local file
*
- * @param string $local Local path to save remote file to
- * @param string $remote Path to remote file to get on the FTP server
+ * @param string $local Local path to save remote file to
+ * @param string $remote Path to remote file to get on the FTP server
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function get($local, $remote) {
@@ -936,11 +919,11 @@
/**
* Method to write a string to the FTP server
*
- * @param string $remote FTP path to file to write to
- * @param string $buffer Contents to write to the FTP server
+ * @param string $remote FTP path to file to write to
+ * @param string $buffer Contents to write to the FTP server
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function write($remote, $buffer) {
@@ -1010,10 +993,10 @@
* Note: Some servers also return folder names. However, to be sure to list folders on all
* servers, you should use listDetails() instead if you also need to deal with folders
*
- * @param string $path Path local file to store on the FTP server
+ * @param string $path Path local file to store on the FTP server
*
- * @return string Directory listing
- * @since 11.1
+ * @return string Directory listing
+ * @since 11.1
*/
function listNames($path = null) {
@@ -1315,9 +1298,9 @@
/**
* Verify the response code from the server and log response if flag is set
*
- * @param mixed $expected Integer response code or array of integer response codes
+ * @param mixed $expected Integer response code or array of integer response codes
*
- * @return boolean True if response code from the server is expected
+ * @return boolean True if response code from the server is expected
*/
function _verifyResponse($expected) {
@@ -1361,8 +1344,8 @@
/**
* Set server to passive mode and open a data port connection
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function _passive() {
@@ -1429,10 +1412,10 @@
/**
* Method to find out the correct transfer mode for a specific file
*
- * @param string $fileName Name of the file
+ * @param string $fileName Name of the file
*
- * @return integer Transfer-mode for this filetype [FTP_ASCII|FTP_BINARY]
- * @since 11.1
+ * @return integer Transfer-mode for this filetype [FTP_ASCII|FTP_BINARY]
+ * @since 11.1
*/
function _findMode($fileName) {
if ($this->_type == FTP_AUTOASCII) {
@@ -1458,8 +1441,8 @@
* @param integer $mode Integer representation of data transfer mode [1:Binary|0:Ascii]
* Defined constants can also be used [FTP_BINARY|FTP_ASCII]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
function _mode($mode) {
if ($mode == FTP_BINARY) {
Modified: development/branches/platform/libraries/joomla/client/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/client/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/client/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,13 +21,13 @@
/**
* Method to return the array of client layer configuration options
*
- * @param string $client Client name, currently only 'ftp' is supported
- * @param boolean $force Forces re-creation of the login credentials. Set this to
+ * @param string $client Client name, currently only 'ftp' is supported
+ * @param boolean $force Forces re-creation of the login credentials. Set this to
* true if login credentials in the session storage have changed
*
- * @return array Client layer configuration options, consisting of at least
+ * @return array Client layer configuration options, consisting of at least
* these fields: enabled, host, port, user, pass, root
- * @since 11.1
+ * @since 11.1
*/
public static function getCredentials($client, $force=false)
{
@@ -86,12 +86,12 @@
/**
* Method to set client login credentials
*
- * @param string $client Client name, currently only 'ftp' is supported
- * @param string $user Username
- * @param string $pass Password
+ * @param string $client Client name, currently only 'ftp' is supported
+ * @param string $user Username
+ * @param string $pass Password
*
- * @return boolean True if the given login credentials have been set and are valid
- * @since 11.1
+ * @return boolean True if the given login credentials have been set and are valid
+ * @since 11.1
*/
public static function setCredentials($client, $user, $pass)
{
@@ -142,10 +142,10 @@
/**
* Method to determine if client login credentials are present
*
- * @param string Client name, currently only 'ftp' is supported
- *
- * @return boolean True if login credentials are available
- * @since 11.1
+ * @param string Client name, currently only 'ftp' is supported
+ *
+ * @return boolean True if login credentials are available
+ * @since 11.1
*/
public static function hasCredentials($client)
{
@@ -197,11 +197,11 @@
* If valid credentials were passed along with the request, they are saved to the session.
* This functions returns an exception if invalid credentials have been given or if the
* connection to the server failed for some other reason.
- *
+ *
* @param string $client
- *
+ *
* @return mixed True, if FTP settings should be shown or an exception
- * @since 11.1
+ * @since 11.1
*/
public static function setCredentialsFromRequest($client)
{
Modified: development/branches/platform/libraries/joomla/client/http.php
===================================================================
--- development/branches/platform/libraries/joomla/client/http.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/client/http.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,7 @@
* Server connection resources array.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $_connections = array();
@@ -32,7 +32,7 @@
* Timeout limit in seconds for the server connection.
*
* @var int
- * @since 11.1
+ * @since 11.1
*/
protected $_timeout = 5;
@@ -40,7 +40,7 @@
* Server response string.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_response;
@@ -174,7 +174,7 @@
* @param string Command to send to the server.
* @param mixed Valid response code or array of response codes.
*
- * @return bool True on success.
+ * @return bool True on success.
*
* @since 11.1
* @throws JException
@@ -242,9 +242,10 @@
/**
* Method to get a response object from a server response.
*
- * @return JHttpResponse
- * @since 11.1
- * @throws JException
+ * @return JHttpResponse
+ *
+ * @since 11.1
+ * @throws JException
*/
protected function _getResponseObject()
{
@@ -346,7 +347,7 @@
* The server response code.
*
* @var int
- * @since 11.1
+ * @since 11.1
*/
public $code;
@@ -354,7 +355,7 @@
* Response headers.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
public $headers = array();
@@ -362,7 +363,7 @@
* Server response body.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $body;
}
\ No newline at end of file
Modified: development/branches/platform/libraries/joomla/client/ldap.php
===================================================================
--- development/branches/platform/libraries/joomla/client/ldap.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/client/ldap.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -18,83 +18,81 @@
*/
class JLDAP extends JObject
{
- /**
- * Hostname of LDAP server
- * @var string
+ /**
+ * @var string Hostname of LDAP server
* @since 11.1
*/
var $host = null;
- /**
- * Authorization Method to use
- * @var bool
+
+ /**
+ * @var bool Authorization Method to use
* @since 11.1
*/
var $auth_method = null;
- /**
- * Port of LDAP server
- * @var int
+
+ /**
+ * @var int Port of LDAP server
* @since 11.1
*/
var $port = null;
- /**
- * Base DN (e.g. o=MyDir)
- * @var string
+
+ /**
+ * @var string Base DN (e.g. o=MyDir)
* @since 11.1
*/
var $base_dn = null;
- /**
- * User DN (e.g. cn=Users,o=MyDir)
- * @var string
+
+ /**
+ * @var string User DN (e.g. cn=Users,o=MyDir)
* @since 11.1
*/
var $users_dn = null;
- /**
- * Search String
- * @var string
+
+ /**
+ * @var string Search String
* @since 11.1
*/
var $search_string = null;
- /**
- * Use LDAP Version 3
- * @var boolean
+
+ /**
+ * @var boolean Use LDAP Version 3
* @since 11.1
*/
var $use_ldapV3 = null;
- /**
- * No referrals (server transfers)
- * @var boolean
+
+ /**
+ * @var boolean No referrals (server transfers)
* @since 11.1
*/
var $no_referrals = null;
- /**
- * Negotiate TLS (encrypted communications)
- * @var boolean
+
+ /**
+ * @var boolean Negotiate TLS (encrypted communications)
* @since 11.1
*/
var $negotiate_tls = null;
- /**
- * Username to connect to server
- * @var string
+ /**
+ * @var string Username to connect to server
* @since 11.1
*/
var $username = null;
+
/**
- * Password to connect to server
- * @var string
- * @since 11.1
+ *
+ * @var string Password to connect to server
+ * @since 11.1
*/
var $password = null;
- /**
- * LDAP Resource Identifier
- * @var mixed
+ /**
+ * @var mixed LDAP Resource Identifier
* @since 11.1
*/
var $_resource = null;
- /**
- * Current DN
- * @var string
+ /**
+ *
+ * @var string Current DN
* @since 11.1
*/
var $_dn = null;
@@ -102,9 +100,9 @@
/**
* Constructor
*
- * @param object An object of configuration variables
- *
- * @since 11.1
+ * @param object An object of configuration variables
+ *
+ * @since 11.1
*/
function __construct($configObj = null)
{
@@ -124,9 +122,9 @@
/**
* Connect to server
- *
- * @return boolean True if successful
- * @since 11.1
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
function connect()
{
@@ -157,7 +155,7 @@
/**
* Close the connection
- *
+ *
* @return
* @since 11.1
*/
@@ -168,9 +166,9 @@
/**
* Sets the DN with some template replacements
*
- * @param string $username The username
- * @param $nosub
- *
+ * @param string $username The username
+ * @param $nosub
+ *
* @return
* @since 11.1
*/
@@ -187,8 +185,8 @@
/**
* Get the DN
- *
- * @return string The current dn
+ *
+ * @return string The current dn
* @since 11.1
*/
function getDN() {
@@ -197,7 +195,7 @@
/**
* Anonymously binds to LDAP directory
- *
+ *
* @return
* @since 11.1
*/
@@ -232,9 +230,9 @@
/**
* Perform an LDAP search using comma seperated search strings
*
- * @param string $search search string of search values
- *
- * @return Search results
+ * @param string $search search string of search values
+ *
+ * @return Search results
* @since 11.1
*/
function simple_search($search)
@@ -250,10 +248,10 @@
/**
* Perform an LDAP search
*
- * @param array Search Filters (array of strings)
- * @param string DN Override
- *
- * @return array Multidimensional array of results
+ * @param array Search Filters (array of strings)
+ * @param string DN Override
+ *
+ * @return array Multidimensional array of results
*/
function search($filters, $dnoverride = null)
{
@@ -329,11 +327,11 @@
/**
* Removes attribute value from given dn and return a true or false result
*
- * @param string dn The DN which contains the attribute you want to remove
- * @param string attribute The attribute values you want to remove
- *
- * @return mixed result of comparison (true, false, -1 on error)
- * @since 11.1
+ * @param string dn The DN which contains the attribute you want to remove
+ * @param string attribute The attribute values you want to remove
+ *
+ * @return mixed result of comparison (true, false, -1 on error)
+ * @since 11.1
*/
function remove($dn, $attribute)
{
@@ -344,12 +342,12 @@
/**
* Compare an entry and return a true or false result
*
- * @param string dn The DN which contains the attribute you want to compare
- * @param string attribute The attribute whose value you want to compare
- * @param string value The value you want to check against the LDAP attribute
- *
- * @return mixed result of comparison (true, false, -1 on error)
- * @since 11.1
+ * @param string dn The DN which contains the attribute you want to compare
+ * @param string attribute The attribute whose value you want to compare
+ * @param string value The value you want to check against the LDAP attribute
+ *
+ * @return mixed result of comparison (true, false, -1 on error)
+ * @since 11.1
*/
function compare($dn, $attribute, $value) {
return @ldap_compare($this->_resource, $dn, $attribute, $value);
@@ -403,10 +401,10 @@
* Add an attribute to the given DN
* Note: DN has to exist already
*
- * @param string $dn The DN of the entry to add the attribute
- * @param array $entry An array of arrays with attributes to add
- *
- * @return boolean Result of operation
+ * @param string $dn The DN of the entry to add the attribute
+ * @param array $entry An array of arrays with attributes to add
+ *
+ * @return boolean Result of operation
*/
function add($dn, $entry) {
return @ldap_mod_add($this->_resource, $dn, $entry);
@@ -415,13 +413,13 @@
/**
* Rename the entry
*
- * @param string $dn The DN of the entry at the moment
- * @param string $newdn The DN of the entry should be (only cn=newvalue)
- * @param string $newparent The full DN of the parent (null by default)
- * @param boolean $deleteolddn Delete the old values (default)
- *
- * @return boolean Result of operation
- * @since 11.1
+ * @param string $dn The DN of the entry at the moment
+ * @param string $newdn The DN of the entry should be (only cn=newvalue)
+ * @param string $newparent The full DN of the parent (null by default)
+ * @param boolean $deleteolddn Delete the old values (default)
+ *
+ * @return boolean Result of operation
+ * @since 11.1
*/
function rename($dn, $newdn, $newparent, $deleteolddn) {
return @ldap_rename($this->_resource, $dn, $newdn, $newparent, $deleteolddn);
@@ -430,8 +428,8 @@
/**
* Returns the error message
*
- * @return string error message
- * @since 11.1
+ * @return string error message
+ * @since 11.1
*/
function getErrorMsg() {
return @ldap_error($this->_resource);
@@ -440,10 +438,10 @@
/**
* Converts a dot notation IP address to net address (e.g. for Netware, etc)
*
- * @param string $ip IP Address (e.g. xxx.xxx.xxx.xxx)
- *
- * @return string Net address
- * @since 11.1
+ * @param string $ip IP Address (e.g. xxx.xxx.xxx.xxx)
+ *
+ * @return string Net address
+ * @since 11.1
*/
function ipToNetAddress($ip)
{
@@ -528,11 +526,11 @@
/**
* Generates a LDAP compatible password
*
- * @param string $password Clear text password to encrypt
- * @param string $type Type of password hash, either md5 or SHA
- *
- * @return string Encrypted password
- * @since 11.1
+ * @param string $password Clear text password to encrypt
+ * @param string $type Type of password hash, either md5 or SHA
+ *
+ * @return string Encrypted password
+ * @since 11.1
*/
function generatePassword($password, $type='md5') {
$userpassword = '';
Modified: development/branches/platform/libraries/joomla/database/database/mysql.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/mysql.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/mysql.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -643,7 +643,7 @@
/**
* Diagnostic method to return explain information for a query.
*
- * @return string The explain output.
+ * @return string The explain output.
*
* @since 11.1
* @deprecated 11.2
@@ -700,7 +700,7 @@
/**
* Execute a query batch.
*
- * @return mixed A database resource if successful, false if not.
+ * @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 11.2
Modified: development/branches/platform/libraries/joomla/database/database/mysqli.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/mysqli.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/mysqli.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,7 +27,7 @@
* @since 11.1
*/
public $name = 'mysqli';
-
+
/**
* @var string The character(s) used to quote SQL statement names such as table names or field names,
* etc. The child classes should define this as necessary. If a single character string the
@@ -36,7 +36,7 @@
* @since 11.1
*/
protected $nameQuote = '`';
-
+
/**
* @var string The null or zero representation of a timestamp for the database driver. This should be
* defined in child classes to hold the appropriate value for the engine.
@@ -663,7 +663,7 @@
/**
* Diagnostic method to return explain information for a query.
*
- * @return string The explain output.
+ * @return string The explain output.
*
* @since 11.1
* @deprecated 11.2
@@ -720,7 +720,7 @@
/**
* Execute a query batch.
*
- * @return mixed A database resource if successful, false if not.
+ * @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 11.2
Modified: development/branches/platform/libraries/joomla/database/database/sqlazure.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/sqlazure.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/sqlazure.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -685,7 +685,7 @@
/**
* Diagnostic method to return explain information for a query.
*
- * @return string The explain output.
+ * @return string The explain output.
*
* @since 11.1
* @deprecated 11.2
@@ -749,7 +749,7 @@
/**
* Execute a query batch.
*
- * @return mixed A database resource if successful, false if not.
+ * @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 11.2
Modified: development/branches/platform/libraries/joomla/database/database/sqlazurequery.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/sqlazurequery.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/sqlazurequery.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -14,7 +14,7 @@
/**
* Query Building Class.
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Database
* @since 11.1
*/
Modified: development/branches/platform/libraries/joomla/database/database/sqlsrv.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/sqlsrv.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/sqlsrv.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -685,7 +685,7 @@
/**
* Diagnostic method to return explain information for a query.
*
- * @return string The explain output.
+ * @return string The explain output.
*
* @since 11.1
* @deprecated 11.2
@@ -749,7 +749,7 @@
/**
* Execute a query batch.
*
- * @return mixed A database resource if successful, false if not.
+ * @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 11.2
Modified: development/branches/platform/libraries/joomla/database/database/sqlsrvquery.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database/sqlsrvquery.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database/sqlsrvquery.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -14,7 +14,7 @@
/**
* Query Building Class.
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Database
* @since 11.1
*/
Modified: development/branches/platform/libraries/joomla/database/database.php
===================================================================
--- development/branches/platform/libraries/joomla/database/database.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/database.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -68,7 +68,7 @@
* etc. The child classes should define this as necessary. If a single character string the
* same character is used for both sides of the quoted name, else the first character will be
* used for the opening quote and the second for the closing quote.
- * @since 11.1
+ * @since 11.1
* @deprecated 12.1
*/
protected $nameQuote;
@@ -76,7 +76,7 @@
/**
* @var string The null or zero representation of a timestamp for the database driver. This should be
* defined in child classes to hold the appropriate value for the engine.
- * @since 11.1
+ * @since 11.1
* @deprecated 12.1
*/
protected $nullDate;
@@ -106,28 +106,28 @@
protected $utf = false;
/**
- * @var integer The database error number
+ * @var integer The database error number
* @since 11.1
* @deprecated 11.2
*/
protected $errorNum = 0;
/**
- * @var string The database error message
+ * @var string The database error message
* @since 11.1
* @deprecated 11.2
*/
protected $errorMsg;
/**
- * @var bool If true then there are fields to be quoted for the query.
+ * @var bool If true then there are fields to be quoted for the query.
* @since 11.1
* @deprecated 11.2
*/
protected $hasQuoted = false;
/**
- * @var array The fields that are to be quoted.
+ * @var array The fields that are to be quoted.
* @since 11.1
* @deprecated 11.2
*/
@@ -858,7 +858,7 @@
*
* @return string The quote wrapped name.
*
- * @since 11.1
+ * @since 11.1
* @deprecate 12.1
*/
public function nameQuote($name)
@@ -888,7 +888,7 @@
*
* @return string The quoted input string.
*
- * @since 11.1
+ * @since 11.1
* @depracted 12.1
*/
public function quote($text, $escape = true)
@@ -1328,9 +1328,9 @@
/**
* Adds a field or array of field names to the list that are to be quoted.
*
- * @param mixed $quoted Field name or array of names.
+ * @param mixed $quoted Field name or array of names.
*
- * @return void
+ * @return void
*
* @since 11.1
* @deprecated 11.2
@@ -1353,9 +1353,9 @@
/**
* Sets the debug level on or off
*
- * @param integer $level 0 to disable debugging and 1 to enable it.
+ * @param integer $level 0 to disable debugging and 1 to enable it.
*
- * @return void
+ * @return void
*
* @since 11.1
* @deprecated 11.2
@@ -1371,9 +1371,9 @@
/**
* Gets the error message from the database connection.
*
- * @param bool $escaped True to escape the message string for use in JavaScript.
+ * @param bool $escaped True to escape the message string for use in JavaScript.
*
- * @return string The error message for the most recent query.
+ * @return string The error message for the most recent query.
*
* @since 11.1
* @deprecated 11.2
@@ -1393,7 +1393,7 @@
/**
* Gets the error number from the database connection.
*
- * @return integer The error number for the most recent query.
+ * @return integer The error number for the most recent query.
*
* @since 11.1
* @deprecated 11.2
@@ -1444,7 +1444,7 @@
/**
* Get the total number of SQL statements executed by the database driver.
*
- * @return integer
+ * @return integer
*
* @since 11.1
* @deprecated 11.2
@@ -1460,9 +1460,9 @@
/**
* Checks if field name needs to be quoted.
*
- * @param string $field The field name to be checked.
+ * @param string $field The field name to be checked.
*
- * @return bool
+ * @return bool
*
* @since 11.1
* @deprecated 11.2
@@ -1483,9 +1483,9 @@
/**
* Return the most recent error message for the database connector.
*
- * @param bool True to display the SQL statement sent to the database as well as the error.
+ * @param bool True to display the SQL statement sent to the database as well as the error.
*
- * @return string The error message for the most recent query.
+ * @return string The error message for the most recent query.
*
* @since 11.1
* @deprecated 11.2
@@ -1507,7 +1507,7 @@
/**
* Diagnostic method to return explain information for a query.
*
- * @return string The explain output.
+ * @return string The explain output.
*
* @since 11.1
* @deprecated 11.2
@@ -1566,7 +1566,7 @@
/**
* Execute a query batch.
*
- * @return mixed A database resource if successful, false if not.
+ * @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 11.2
Modified: development/branches/platform/libraries/joomla/database/databasequery.php
===================================================================
--- development/branches/platform/libraries/joomla/database/databasequery.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/databasequery.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -39,12 +39,12 @@
/**
* Constructor.
*
- * @param string $name The name of the element.
- * @param mixed $elements String or array.
- * @param string $glue The glue for elements.
+ * @param string $name The name of the element.
+ * @param mixed $elements String or array.
+ * @param string $glue The glue for elements.
*
- * @return object JDatabaseQueryElement
- * @since 11.1
+ * @return object JDatabaseQueryElement
+ * @since 11.1
*/
public function __construct($name, $elements, $glue = ',')
{
@@ -58,8 +58,8 @@
/**
* Magic function to convert the query element to a string.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public function __toString()
{
@@ -74,10 +74,10 @@
/**
* Appends element parts to the internal list.
*
- * @param mixed String or array.
+ * @param mixed String or array.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function append($elements)
{
Modified: development/branches/platform/libraries/joomla/database/table/asset.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/asset.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/asset.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -58,9 +58,9 @@
/**
* Method to load an asset by it's name.
*
- * @param string The name of the asset.
+ * @param string The name of the asset.
*
- * @return integer
+ * @return integer
*/
public function loadByName($name)
{
@@ -86,9 +86,10 @@
/**
* Asset that the nested set data is valid.
*
- * @return boolean True if the instance is sane and able to be stored in the database.
- * @since 11.1
+ * @return bool True if the instance is sane and able to be stored in the database.
+ *
* @link http://docs.joomla.org/JTable/check
+ * @since 11.1
*/
public function check()
{
Modified: development/branches/platform/libraries/joomla/database/table/category.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/category.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/category.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -35,7 +35,7 @@
* The default name is in the form `table_name.id`
* where id is the value of the primary key of the table.
*
- * @return string
+ * @return string
*/
protected function _getAssetName()
{
@@ -46,8 +46,8 @@
/**
* Method to return the title to use for the asset table.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
protected function _getAssetTitle()
{
@@ -57,7 +57,7 @@
/**
* Get the parent asset id for the record
*
- * @return integer
+ * @return integer
*/
protected function _getAssetParentId($table = null, $id = null)
{
@@ -105,9 +105,10 @@
/**
* Override check function
*
- * @return boolean
+ * @return bool
+ *
* @see JTable::check
- * @since 11.1
+ * @since 11.1
*/
public function check()
{
@@ -131,10 +132,12 @@
/**
* Overloaded bind function.
*
- * @param array named array
- * @return null|string null is operation was satisfactory, otherwise returns an error
+ * @param array named array
+ *
+ * @return null|string null is operation was satisfactory, otherwise returns an error
+ *
* @see JTable:bind
- * @since 11.1
+ * @since 11.1
*/
public function bind($array, $ignore = '')
{
@@ -162,10 +165,11 @@
/**
* Overriden JTable::store to set created/modified and user id.
*
- * @param boolean True to update fields even if they are null.
+ * @param boolean True to update fields even if they are null.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ *
+ * @since 11.1
*/
public function store($updateNulls = false)
{
Modified: development/branches/platform/libraries/joomla/database/table/content.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/content.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/content.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,8 +21,8 @@
class JTableContent extends JTable
{
/**
- * @param database A database connector object
- * @since 11.1
+ * @param database A database connector object
+ * @since 11.1
*/
function __construct(&$db)
{
@@ -34,8 +34,8 @@
* The default name is in the form `table_name.id`
* where id is the value of the primary key of the table.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
protected function _getAssetName()
{
@@ -46,8 +46,8 @@
/**
* Method to return the title to use for the asset table.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
protected function _getAssetTitle()
{
@@ -57,8 +57,8 @@
/**
* Get the parent asset id for the record
*
- * @return integer
- * @since 11.1
+ * @return integer
+ * @since 11.1
*/
protected function _getAssetParentId($table = null, $id = null)
{
@@ -92,11 +92,11 @@
/**
* Overloaded bind function
*
- * @param array $hash named array
+ * @param array $hash named array
*
- * @return null|string null is operation was satisfactory, otherwise returns an error
+ * @return null|string null is operation was satisfactory, otherwise returns an error
* @see JTable:bind
- * @since 11.1
+ * @since 11.1
*/
public function bind($array, $ignore = '')
{
@@ -137,9 +137,9 @@
/**
* Overloaded check function
*
- * @return boolean
+ * @return boolean
* @see JTable::check
- * @since 11.1
+ * @since 11.1
*/
public function check()
{
@@ -199,10 +199,11 @@
/**
* Overriden JTable::store to set modified data and user id.
*
- * @param boolean True to update fields even if they are null.
+ * @param boolean True to update fields even if they are null.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ *
+ * @since 11.1
*/
public function store($updateNulls = false)
{
@@ -238,13 +239,13 @@
* table. The method respects checked out rows by other users and will attempt
* to checkin rows that it can after adjustments are made.
*
- * @param mixed An optional array of primary key values to update. If not
- * set the instance property value is used.
- * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
- * @param integer The user id of the user performing the operation.
+ * @param mixed An optional array of primary key values to update. If not
+ * set the instance property value is used.
+ * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
+ * @param integer The user id of the user performing the operation.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return bool True on success.
+ * @since 11.1
*/
public function publish($pks = null, $state = 1, $userId = 0)
{
@@ -314,8 +315,8 @@
/**
* Converts record to XML
*
- * @param boolean Map foreign keys to text values
- * @since 11.1
+ * @param bool Map foreign keys to text values
+ * @since 11.1
*/
function toXML($mapKeysToText=false)
{
Modified: development/branches/platform/libraries/joomla/database/table/extension.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/extension.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/extension.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -15,14 +15,13 @@
*
* @package Joomla.Platform
* @subpackage Table
- * @since 11.1
+ * @since 11.1
*/
class JTableExtension extends JTable
{
/**
* Contructor
*
- * @access var
* @param database A database connector object
*/
function __construct(&$db) {
@@ -32,9 +31,10 @@
/**
* Overloaded check function
*
- * @access public
- * @return boolean True if the object is ok
- * @see JTable:bind
+ * @return boolean True if the object is ok
+ *
+ * @see JTable:bind
+ * @since 11.1
*/
function check()
{
@@ -49,11 +49,12 @@
/**
* Overloaded bind function
*
- * @access public
- * @param array $hash named array
- * @return null|string null is operation was satisfactory, otherwise returns an error
- * @see JTable:bind
- * @since 11.1
+ * @param array $hash Named array
+ *
+ * @return null|string null is operation was satisfactory, otherwise returns an error
+ *
+ * @see JTable:bind
+ * @since 11.1
*/
function bind($array, $ignore = '')
{
@@ -91,11 +92,14 @@
* table. The method respects checked out rows by other users and will attempt
* to checkin rows that it can after adjustments are made.
*
- * @param mixed An optional array of primary key values to update. If not
- * set the instance property value is used.
- * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
- * @param integer The user id of the user performing the operation.
- * @return boolean True on success.
+ * @param mixed An optional array of primary key values to update. If not
+ * set the instance property value is used.
+ * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
+ * @param integer The user id of the user performing the operation.
+ *
+ * @return bool True on success.
+ *
+ * @since 11.1
*/
public function publish($pks = null, $state = 1, $userId = 0)
{
Modified: development/branches/platform/libraries/joomla/database/table/language.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/language.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/language.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,7 +23,11 @@
/**
* Constructor
*
- * @param JDatabase
+ * @param JDatabase
+ *
+ * @return JTableLanguage
+ *
+ * @since 11.1
*/
public function __construct(&$db)
{
@@ -33,7 +37,9 @@
/**
* Overloaded check method to ensure data integrity
*
- * @return boolean True on success
+ * @return boolean True on success
+ *
+ * @since 11.1
*/
public function check()
{
Modified: development/branches/platform/libraries/joomla/database/table/menu.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/menu.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/menu.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -36,10 +36,12 @@
/**
* Overloaded bind function
*
- * @param array $hash named array
- * @return mixed null is operation was satisfactory, otherwise returns an error
+ * @param array $hash named array
+ *
+ * @return mixed null is operation was satisfactory, otherwise returns an error
+ *
* @see JTable:bind
- * @since 11.1
+ * @since 11.1
*/
public function bind($array, $ignore = '')
{
@@ -73,9 +75,9 @@
/**
* Overloaded check function
*
- * @return boolean
+ * @return boolean
* @see JTable::check
- * @since 11.1
+ * @since 11.1
*/
public function check()
{
@@ -118,9 +120,9 @@
/**
* Overloaded store function
*
- * @return boolean
+ * @return boolean
* @see JTable::store
- * @since 11.1
+ * @since 11.1
*/
public function store($updateNulls = false)
{
Modified: development/branches/platform/libraries/joomla/database/table/menutype.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/menutype.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/menutype.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -69,9 +69,9 @@
* a new row will be inserted into the database with the properties from the
* JTable instance.
*
- * @param boolean True to update fields even if they are null.
- * @return boolean True on success.
- * @since 11.1
+ * @param boolean True to update fields even if they are null.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/store
*/
public function store($updateNulls = false)
@@ -139,10 +139,10 @@
/**
* Method to delete a row from the database table by primary key value.
*
- * @param mixed An optional primary key value to delete. If not set the
+ * @param mixed An optional primary key value to delete. If not set the
* instance property value is used.
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/delete
*/
public function delete($pk = null)
Modified: development/branches/platform/libraries/joomla/database/table/module.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/module.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/module.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -36,7 +36,7 @@
/**
* Overloaded check function.
*
- * @return boolean True if the object is ok
+ * @return boolean True if the object is ok
*/
public function check()
{
@@ -60,10 +60,12 @@
/**
* Overloaded bind function.
*
- * @param array named array
- * @return null|string null is operation was satisfactory, otherwise returns an error
+ * @param array named array
+ *
+ * @return null|string null is operation was satisfactory, otherwise returns an error
+ *
* @see JTable:bind
- * @since 11.1
+ * @since 11.1
*/
public function bind($array, $ignore = '')
{
Modified: development/branches/platform/libraries/joomla/database/table/session.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/session.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/session.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -83,8 +83,9 @@
/**
* Purge old sessions
*
- * @param integer Session age in seconds
- * @return mixed Resource on success, null on fail
+ * @param integer Session age in seconds
+ *
+ * @return mixed Resource on success, null on fail
*/
function purge($maxLifetime = 1440)
{
@@ -98,8 +99,11 @@
/**
* Find out if a user has a one or more active sessions
*
- * @param integer $userid The identifier of the user
- * @return boolean True if a session for this user exists
+ * @param integer $userid The identifier of the user
+ *
+ * @return boolean True if a session for this user exists
+ *
+ * @since 11.1
*/
function exists($userid)
{
@@ -120,7 +124,6 @@
*
* We must override it because of the non-integer primary key
*
- * @access public
* @return true if successful otherwise returns and error message
*/
function delete($oid=null)
Modified: development/branches/platform/libraries/joomla/database/table/update.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/update.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/update.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,6 @@
/**
* Contructor
*
- * @access protected
* @param database A database connector object
*/
function __construct( &$db ) {
@@ -34,11 +33,11 @@
/**
* Overloaded check function
*
- * @access public
- * @return boolean True if the object is ok
- * @see JTable:bind
+ * @return boolean True if the object is ok
+ *
+ * @see JTable:bind
*/
- function check()
+ public function check()
{
// check for valid name
if (trim( $this->name ) == '' || trim( $this->element ) == '') {
@@ -51,13 +50,14 @@
/**
* Overloaded bind function
*
- * @access public
- * @param array $hash named array
- * @return null|string null is operation was satisfactory, otherwise returns an error
- * @see JTable:bind
- * @since 11.1
+ * @param array $hash named array
+ *
+ * @return null|string null is operation was satisfactory, otherwise returns an error
+ *
+ * @see JTable:bind
+ * @since 11.1
*/
- function bind($array, $ignore = '')
+ public function bind($array, $ignore = '')
{
if (isset( $array['params'] ) && is_array($array['params']))
{
Modified: development/branches/platform/libraries/joomla/database/table/user.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/user.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/user.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,8 +21,7 @@
/**
* Associative array of user names => group ids
*
- * @access public
- * @since 11.1
+ * @since 11.1
* @var array
*/
var $groups;
@@ -43,10 +42,11 @@
* Method to load a user, user groups, and any other necessary data
* from the database so that it can be bound to the user object.
*
- * @access public
- * @param integer $userId An optional user id.
- * @return boolean True on success, false on failure.
- * @since 11.1
+ * @param integer $userId An optional user id.
+ *
+ * @return bool True on success, false on failure.
+ *
+ * @since 11.1
*/
function load($userId = null, $reset = true)
{
@@ -111,11 +111,12 @@
/**
* Method to bind the user, user groups, and any other necessary data.
*
- * @access public
- * @param array $array The data to bind.
- * @param mixed $ignore An array or space separated list of fields to ignore.
- * @return boolean True on success, false on failure.
- * @since 11.1
+ * @param array $array The data to bind.
+ * @param mixed $ignore An array or space separated list of fields to ignore.
+ *
+ * @return boolean True on success, false on failure.
+ *
+ * @since 11.1
*/
function bind($array, $ignore = '')
{
@@ -156,7 +157,7 @@
/**
* Validation and filtering
*
- * @return boolean True is satisfactory
+ * @return boolean True is satisfactory
*/
function check()
{
@@ -305,10 +306,11 @@
* Method to delete a user, user groups, and any other necessary
* data from the database.
*
- * @access public
- * @param integer $userId An optional user id.
- * @return boolean True on success, false on failure.
- * @since 11.1
+ * @param integer $userId An optional user id.
+ *
+ * @return bool True on success, false on failure.
+ *
+ * @since 11.1
*/
function delete($userId = null)
{
@@ -378,8 +380,9 @@
/**
* Updates last visit time of user
*
- * @param integer The timestamp, defaults to 'now'
- * @return boolean False if an error occurs
+ * @param integer The timestamp, defaults to 'now'
+ *
+ * @return bool False if an error occurs
*/
function setLastVisit($timeStamp = null, $userId = null)
{
Modified: development/branches/platform/libraries/joomla/database/table/usergroup.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/usergroup.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/usergroup.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,9 +23,11 @@
/**
* Constructor
*
- * @param object Database object
- * @return void
- * @since 11.1
+ * @param object Database object
+ *
+ * @return JTableUsergroup
+ *
+ * @since 11.1
*/
public function __construct(&$db)
{
@@ -35,8 +37,9 @@
/**
* Method to check the current record to save
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ *
+ * @since 11.1
*/
public function check()
{
@@ -68,11 +71,12 @@
/**
* Method to recursively rebuild the nested set tree.
*
- * @param integer The root of the tree to rebuild.
- * @param integer The left id to start with in building the tree.
+ * @param integer The root of the tree to rebuild.
+ * @param integer The left id to start with in building the tree.
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ *
+ * @since 11.1
*/
public function rebuild($parent_id = 0, $left = 0)
{
@@ -121,10 +125,11 @@
/**
* Inserts a new row if id is zero or updates an existing row in the database table
*
- * @param boolean $updateNulls If false, null object variables are not updated
+ * @param bool $updateNulls If false, null object variables are not updated
*
- * @return boolean True successful, false otherwise and an internal error message is set
- * @since 11.1
+ * @return bool True successful, false otherwise and an internal error message is set
+ *
+ * @since 11.1
*/
function store($updateNulls = false)
{
@@ -139,10 +144,11 @@
/**
* Delete this object and it's dependancies
*
- * @param integer $oid The primary key of the user group to delete.
+ * @param integer $oid The primary key of the user group to delete.
*
- * @return mixed Boolean or Exception.
- * @since 11.1
+ * @return mixed Boolean or Exception.
+ *
+ * @since 11.1
*/
function delete($oid = null)
{
Modified: development/branches/platform/libraries/joomla/database/table/viewlevel.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table/viewlevel.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table/viewlevel.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,9 +23,11 @@
/**
* Constructor
*
- * @param object Database object
- * @return void
- * @since 11.1
+ * @param object Database object
+ *
+ * @return JTableViewlevel
+ *
+ * @since 11.1
*/
public function __construct(&$db)
{
@@ -35,10 +37,12 @@
/**
* Method to bind the data.
*
- * @param array $array The data to bind.
- * @param mixed $ignore An array or space separated list of fields to ignore.
- * @return boolean True on success, false on failure.
- * @since 11.1
+ * @param array $array The data to bind.
+ * @param mixed $ignore An array or space separated list of fields to ignore.
+ *
+ * @return bool True on success, false on failure.
+ *
+ * @since 11.1
*/
public function bind($array, $ignore = '')
{
@@ -55,8 +59,9 @@
/**
* Method to check the current record to save
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ *
+ * @since 11.1
*/
public function check()
{
Modified: development/branches/platform/libraries/joomla/database/table.php
===================================================================
--- development/branches/platform/libraries/joomla/database/table.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/table.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -26,7 +26,7 @@
* Name of the database table to model.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_tbl = '';
@@ -34,7 +34,7 @@
* Name of the primary key field in the table.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_tbl_key = '';
@@ -42,7 +42,7 @@
* JDatabase connector object.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $_db;
@@ -50,7 +50,7 @@
* Should rows be tracked as ACL assets?
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $_trackAssets = false;
@@ -65,7 +65,7 @@
* Indicator that the tables have been locked.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $_locked = false;
@@ -74,11 +74,11 @@
* be overridden by child classes to explicitly set the table and key fields
* for a particular database table.
*
- * @param string Name of the table to model.
- * @param string Name of the primary key field in the table.
- * @param object JDatabase connector object.
- *
- * @since 11.1
+ * @param string Name of the table to model.
+ * @param string Name of the primary key field in the table.
+ * @param object JDatabase connector object.
+ *
+ * @since 11.1
*/
function __construct($table, $key, &$db)
{
@@ -113,7 +113,7 @@
/**
* Get the columns from database table.
*
- * @return mixed An array of the field names, or false if an error occurs.
+ * @return mixed An array of the field names, or false if an error occurs.
*/
public function getFields()
{
@@ -140,11 +140,11 @@
* the table include paths. To add include paths for searching for JTable
* classes @see JTable::addIncludePath().
*
- * @param string The type (name) of the JTable class to get an instance of.
- * @param string An optional prefix for the table class name.
- * @param array An optional array of configuration values for the JTable object.
- * @return mixed A JTable object if found or boolean false if one could not be found.
- * @since 11.1
+ * @param string The type (name) of the JTable class to get an instance of.
+ * @param string An optional prefix for the table class name.
+ * @param array An optional array of configuration values for the JTable object.
+ * @return mixed A JTable object if found or boolean false if one could not be found.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/getInstance
*/
public static function getInstance($type, $prefix = 'JTable', $config = array())
@@ -186,9 +186,9 @@
* Add a filesystem path where JTable should search for table class files.
* You may either pass a string or an array of paths.
*
- * @param mixed A filesystem path or array of filesystem paths to add.
- * @return array An array of filesystem paths to find JTable classes in.
- * @since 11.1
+ * @param mixed A filesystem path or array of filesystem paths to add.
+ * @return array An array of filesystem paths to find JTable classes in.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/addIncludePath
*/
public static function addIncludePath($path = null)
@@ -225,7 +225,7 @@
* The default name is in the form `table_name.id`
* where id is the value of the primary key of the table.
*
- * @return string
+ * @return string
*/
protected function _getAssetName()
{
@@ -240,8 +240,8 @@
* return $this->title or $this->name or whatever is being used for the
* primary name of the row. If this method is not overriden, the asset name is used.
*
- * @return string The string to use as the title in the asset table.
- * @since 11.1
+ * @return string The string to use as the title in the asset table.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/getAssetTitle
*/
protected function _getAssetTitle()
@@ -255,9 +255,9 @@
* The extended class can define a table and id to lookup. If the
* asset does not exist it will be created.
*
- * @param JTable A JTable object for the asset parent.
+ * @param JTable A JTable object for the asset parent.
*
- * @return integer
+ * @return integer
*/
protected function _getAssetParentId($table = null, $id = null)
{
@@ -272,8 +272,8 @@
/**
* Method to get the database table name for the class.
*
- * @return string The name of the database table being modeled.
- * @since 11.1
+ * @return string The name of the database table being modeled.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/getTableName
*/
public function getTableName()
@@ -284,8 +284,8 @@
/**
* Method to get the primary key field name for the table.
*
- * @return string The name of the primary key for the table.
- * @since 11.1
+ * @return string The name of the primary key for the table.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/getKeyName
*/
public function getKeyName()
@@ -296,7 +296,7 @@
/**
* Method to get the JDatabase connector object.
*
- * @return object The internal database connector object.
+ * @return object The internal database connector object.
* @link http://docs.joomla.org/JTable/getDBO
*/
public function getDbo()
@@ -307,8 +307,8 @@
/**
* Method to set the JDatabase connector object.
*
- * @param object A JDatabase connector object to be used by the table object.
- * @return boolean True on success.
+ * @param object A JDatabase connector object to be used by the table object.
+ * @return boolean True on success.
* @link http://docs.joomla.org/JTable/setDBO
*/
public function setDBO(&$db)
@@ -326,7 +326,7 @@
/**
* Method to set rules for the record.
*
- * @param mixed A JRules object, JSON string, or array.
+ * @param mixed A JRules object, JSON string, or array.
*/
function setRules($input)
{
@@ -341,7 +341,7 @@
/**
* Method to get the rules for the record.
*
- * @return object JRules
+ * @return object JRules
*/
public function getRules()
{
@@ -353,8 +353,8 @@
* definition. It will ignore the primary key as well as any private class
* properties.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
* @link http://docs.joomla.org/JTable/reset
*/
public function reset()
@@ -374,11 +374,13 @@
* method only binds properties that are publicly accessible and optionally
* takes an array of properties to ignore when binding.
*
- * @param mixed An associative array or object to bind to the JTable instance.
- * @param mixed An optional array or space separated list of properties
- * to ignore while binding.
- * @return boolean True on success.
- * @since 11.1
+ * @param mixed An associative array or object to bind to the JTable instance.
+ * @param mixed An optional array or space separated list of properties
+ * to ignore while binding.
+ *
+ * @return boolean True on success.
+ *
+ * @since 11.1
* @link http://docs.joomla.org/JTable/bind
*/
public function bind($src, $ignore = array())
@@ -418,11 +420,13 @@
* Method to load a row from the database by primary key and bind the fields
* to the JTable instance properties.
*
- * @param mixed An optional primary key value to load the row by, or an array of fields to match. If not
- * set the instance property value is used.
- * @param boolean True to reset the default values before loading the new row.
- * @return boolean True if successful. False if row not found or on error (internal error state set in that case).
- * @since 11.1
+ * @param mixed An optional primary key value to load the row by, or an array of fields to match. If not
+ * set the instance property value is used.
+ * @param bool True to reset the default values before loading the new row.
+ *
+ * @return bool True if successful. False if row not found or on error (internal error state set in that case).
+ *
+ * @since 11.1
* @link http://docs.joomla.org/JTable/load
*/
public function load($keys = null, $reset = true)
@@ -493,8 +497,8 @@
* method to make sure the data they are storing in the database is safe and
* as expected before storage.
*
- * @return boolean True if the instance is sane and able to be stored in the database.
- * @since 11.1
+ * @return boolean True if the instance is sane and able to be stored in the database.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/check
*/
public function check()
@@ -509,10 +513,12 @@
* a new row will be inserted into the database with the properties from the
* JTable instance.
*
- * @param boolean True to update fields even if they are null.
- * @return boolean True on success.
- * @since 11.1
+ * @param boolean True to update fields even if they are null.
+ *
+ * @return boolean True on success.
+ *
* @link http://docs.joomla.org/JTable/store
+ * @since 11.1
*/
public function store($updateNulls = false)
{
@@ -615,13 +621,15 @@
* property name. The rows that will be reordered are those whose value matches
* the JTable instance for the property specified.
*
- * @param mixed An associative array or object to bind to the JTable instance.
- * @param string Filter for the order updating
- * @param mixed An optional array or space separated list of properties
+ * @param mixed An associative array or object to bind to the JTable instance.
+ * @param string Filter for the order updating
+ * @param mixed An optional array or space separated list of properties
* to ignore while binding.
- * @return boolean True on success.
- * @since 11.1
+ *
+ * @return boolean True on success.
+ *
* @link http://docs.joomla.org/JTable/save
+ * @since 11.1
*/
public function save($src, $orderingFilter = '', $ignore = '')
{
@@ -660,10 +668,10 @@
/**
* Method to delete a row from the database table by primary key value.
*
- * @param mixed An optional primary key value to delete. If not set the
+ * @param mixed An optional primary key value to delete. If not set the
* instance property value is used.
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/delete
*/
public function delete($pk = null)
@@ -723,11 +731,11 @@
* than the one who checked the row out should be held until the row is checked
* in again.
*
- * @param integer The Id of the user checking out the row.
- * @param mixed An optional primary key value to check out. If not set
+ * @param integer The Id of the user checking out the row.
+ * @param mixed An optional primary key value to check out. If not set
* the instance property value is used.
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/checkOut
*/
public function checkOut($userId, $pk = null)
@@ -776,10 +784,10 @@
* Method to check a row in if the necessary properties/fields exist. Checking
* a row in will allow other users the ability to edit the row.
*
- * @param mixed An optional primary key value to check out. If not set
+ * @param mixed An optional primary key value to check out. If not set
* the instance property value is used.
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/checkIn
*/
public function checkIn($pk = null)
@@ -825,10 +833,10 @@
/**
* Method to increment the hits for a row if the necessary property/field exists.
*
- * @param mixed An optional primary key value to increment. If not set
+ * @param mixed An optional primary key value to increment. If not set
* the instance property value is used.
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/hit
*/
public function hit($pk = null)
@@ -874,12 +882,12 @@
* a user. If the row is checked out by the same user, then it is considered
* not checked out -- as the user can still edit it.
*
- * @param integer The userid to preform the match with, if an item is checked
+ * @param integer The userid to preform the match with, if an item is checked
* out by this user the function will return false.
- * @param integer The userid to perform the match against when the function
+ * @param integer The userid to perform the match against when the function
* is used as a static function.
- * @return boolean True if checked out.
- * @since 11.1
+ * @return boolean True if checked out.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/isCheckedOut
*/
public function isCheckedOut($with = 0, $against = null)
@@ -910,9 +918,9 @@
* Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.
* This is useful for placing a new item last in a group of items in the table.
*
- * @param string WHERE clause to use for selecting the MAX(ordering) for the table.
- * @return mixed Boolean false an failure or the next ordering value as an integer.
- * @since 11.1
+ * @param string WHERE clause to use for selecting the MAX(ordering) for the table.
+ * @return mixed Boolean false an failure or the next ordering value as an integer.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/getNextOrder
*/
public function getNextOrder($where = '')
@@ -954,10 +962,10 @@
* Method to compact the ordering values of rows in a group of rows
* defined by an SQL WHERE clause.
*
- * @param string WHERE clause to use for limiting the selection of rows to
+ * @param string WHERE clause to use for limiting the selection of rows to
* compact the ordering values.
- * @return mixed Boolean true on success.
- * @since 11.1
+ * @return mixed Boolean true on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/reorder
*/
public function reorder($where = '')
@@ -1031,11 +1039,11 @@
* Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
* Negative numbers move the row up in the sequence and positive numbers move it down.
*
- * @param integer The direction and magnitude to move the row in the ordering sequence.
- * @param string WHERE clause to use for limiting the selection of rows to compact the
+ * @param integer The direction and magnitude to move the row in the ordering sequence.
+ * @param string WHERE clause to use for limiting the selection of rows to compact the
* ordering values.
- * @return mixed Boolean true on success.
- * @since 11.1
+ * @return mixed Boolean true on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/move
*/
public function move($delta, $where = '')
@@ -1141,12 +1149,12 @@
* table. The method respects checked out rows by other users and will attempt
* to checkin rows that it can after adjustments are made.
*
- * @param mixed An optional array of primary key values to update. If not
+ * @param mixed An optional array of primary key values to update. If not
* set the instance property value is used.
- * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
- * @param integer The user id of the user performing the operation.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
+ * @param integer The user id of the user performing the operation.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/publish
*/
public function publish($pks = null, $state = 1, $userId = 0)
@@ -1224,12 +1232,12 @@
* Can be overloaded/supplemented by the child class
*
* @deprecated
- * @param mixed An optional primary key value check the row for. If not
+ * @param mixed An optional primary key value check the row for. If not
* set the instance property value is used.
- * @param array An optional array to compiles standard joins formatted like:
+ * @param array An optional array to compiles standard joins formatted like:
* [label => 'Label', name => 'table name' , idfield => 'field', joinfield => 'field']
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/canDelete
*/
public function canDelete($pk = null, $joins = null)
@@ -1301,9 +1309,9 @@
* Method to export the JTable instance properties to an XML string.
*
* @deprecated
- * @param boolean True to map foreign keys to text values.
- * @return string XML string representation of the instance.
- * @since 11.1
+ * @param boolean True to map foreign keys to text values.
+ * @return string XML string representation of the instance.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/toXML
*/
public function toXML($mapKeysToText=false)
@@ -1336,8 +1344,8 @@
/**
* Method to lock the database table for writing.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
protected function _lock()
{
@@ -1360,8 +1368,8 @@
/**
* Method to unlock the database table for writing.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
protected function _unlock()
{
Modified: development/branches/platform/libraries/joomla/database/tablenested.php
===================================================================
--- development/branches/platform/libraries/joomla/database/tablenested.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/database/tablenested.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -78,7 +78,7 @@
protected $_location_id;
/**
- * @var array An array to cache values in recursive processes.
+ * @var array An array to cache values in recursive processes.
*/
protected $_cache = array();
@@ -87,7 +87,7 @@
/**
* Sets the debug level on or off
*
- * @param integer 0 = off, 1 = on
+ * @param integer 0 = off, 1 = on
*/
public function debug($level)
{
@@ -97,10 +97,10 @@
/**
* Method to get an array of nodes from a given node to its root.
*
- * @param integer Primary key of the node for which to get the path.
- * @param boolean Only select diagnostic data for the nested sets.
- * @return mixed Boolean false on failure or array of node objects on success.
- * @since 11.1
+ * @param integer Primary key of the node for which to get the path.
+ * @param boolean Only select diagnostic data for the nested sets.
+ * @return mixed Boolean false on failure or array of node objects on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/getPath
*/
public function getPath($pk = null, $diagnostic = false)
@@ -135,10 +135,10 @@
/**
* Method to get a node and all its child nodes.
*
- * @param integer Primary key of the node for which to get the tree.
- * @param boolean Only select diagnostic data for the nested sets.
- * @return mixed Boolean false on failure or array of node objects on success.
- * @since 11.1
+ * @param integer Primary key of the node for which to get the tree.
+ * @param boolean Only select diagnostic data for the nested sets.
+ * @return mixed Boolean false on failure or array of node objects on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/getTree
*/
public function getTree($pk = null, $diagnostic = false)
@@ -172,9 +172,9 @@
/**
* Method to determine if a node is a leaf node in the tree (has no children).
*
- * @param integer Primary key of the node to check.
- * @return boolean True if a leaf node.
- * @since 11.1
+ * @param integer Primary key of the node to check.
+ * @return boolean True if a leaf node.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/isLeaf
*/
public function isLeaf($pk = null)
@@ -198,10 +198,10 @@
* save the new location to the database, but will set it in the object so
* that when the node is stored it will be stored in the new location.
*
- * @param integer The primary key of the node to reference new location by.
- * @param string Location type string. ['before', 'after', 'first-child', 'last-child']
- * @return boolean True on success.
- * @since 11.1
+ * @param integer The primary key of the node to reference new location by.
+ * @param string Location type string. ['before', 'after', 'first-child', 'last-child']
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/setLocation
*/
public function setLocation($referenceId, $position = 'after')
@@ -225,11 +225,11 @@
* Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
* Negative numbers move the row up in the sequence and positive numbers move it down.
*
- * @param integer The direction and magnitude to move the row in the ordering sequence.
- * @param string WHERE clause to use for limiting the selection of rows to compact the
+ * @param integer The direction and magnitude to move the row in the ordering sequence.
+ * @param string WHERE clause to use for limiting the selection of rows to compact the
* ordering values.
- * @return mixed Boolean true on success.
- * @since 11.1
+ * @return mixed Boolean true on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/move
*/
public function move($delta, $where = '')
@@ -271,11 +271,11 @@
/**
* Method to move a node and its children to a new location in the tree.
*
- * @param integer The primary key of the node to reference new location by.
- * @param string Location type string. ['before', 'after', 'first-child', 'last-child']
- * @param integer The primary key of the node to move.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer The primary key of the node to reference new location by.
+ * @param string Location type string. ['before', 'after', 'first-child', 'last-child']
+ * @param integer The primary key of the node to move.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/moveByReference
*/
@@ -487,10 +487,10 @@
/**
* Method to delete a node, and optionally its child nodes, from the table.
*
- * @param integer The primary key of the node to delete.
- * @param boolean True to delete child nodes, false to move them up a level.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer The primary key of the node to delete.
+ * @param boolean True to delete child nodes, false to move them up a level.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/delete
*/
public function delete($pk = null, $children = true)
@@ -616,8 +616,8 @@
/**
* Asset that the nested set data is valid.
*
- * @return boolean True if the instance is sane and able to be stored in the database.
- * @since 11.1
+ * @return boolean True if the instance is sane and able to be stored in the database.
+ * @since 11.1
* @link http://docs.joomla.org/JTable/check
*/
public function check()
@@ -660,9 +660,9 @@
/**
* Method to store a node in the database table.
*
- * @param boolean True to update null values as well.
- * @return boolean True on success.
- * @since 11.1
+ * @param boolean True to update null values as well.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/store
*/
public function store($updateNulls = false)
@@ -813,12 +813,12 @@
* allow you to set a publishing state higher than any ancestor node and will
* not allow you to set a publishing state on a node with a checked out child.
*
- * @param mixed An optional array of primary key values to update. If not
+ * @param mixed An optional array of primary key values to update. If not
* set the instance property value is used.
- * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
- * @param integer The user id of the user performing the operation.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer The publishing state. eg. [0 = unpublished, 1 = published]
+ * @param integer The user id of the user performing the operation.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/publish
*/
public function publish($pks = null, $state = 1, $userId = 0)
@@ -948,9 +948,9 @@
/**
* Method to move a node one position to the left in the same level.
*
- * @param integer Primary key of the node to move.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer Primary key of the node to move.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/orderUp
*/
public function orderUp($pk)
@@ -1042,9 +1042,9 @@
/**
* Method to move a node one position to the right in the same level.
*
- * @param integer Primary key of the node to move.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer Primary key of the node to move.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/orderDown
*/
public function orderDown($pk)
@@ -1137,7 +1137,7 @@
/**
* Gets the ID of the root item in the tree
*
- * @return mixed The ID of the root row, or false and the internal error is set.
+ * @return mixed The ID of the root row, or false and the internal error is set.
*/
public function getRootId()
{
@@ -1224,12 +1224,12 @@
/**
* Method to recursively rebuild the whole nested set tree.
*
- * @param integer The root of the tree to rebuild.
- * @param integer The left id to start with in building the tree.
- * @param integer The level to assign to the current nodes.
- * @param string The path to the current nodes.
- * @return integer 1 + value of root rgt on success, false on failure
- * @since 11.1
+ * @param integer The root of the tree to rebuild.
+ * @param integer The left id to start with in building the tree.
+ * @param integer The level to assign to the current nodes.
+ * @param string The path to the current nodes.
+ * @return integer 1 + value of root rgt on success, false on failure
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/rebuild
*/
public function rebuild($parentId = null, $leftId = 0, $level = 0, $path = '')
@@ -1308,9 +1308,9 @@
* Method to rebuild the node's path field from the alias values of the
* nodes from the current node to the root node of the tree.
*
- * @param integer Primary key of the node for which to get the path.
- * @return boolean True on success.
- * @since 11.1
+ * @param integer Primary key of the node for which to get the path.
+ * @return boolean True on success.
+ * @since 11.1
* @link http://docs.joomla.org/JTableNested/rebuildPath
*/
public function rebuildPath($pk = null)
@@ -1367,11 +1367,11 @@
/**
* Method to update order of table rows
*
- * @param array id's of rows to be reordered
- * @param array lft values of rows to be reordered
+ * @param array id's of rows to be reordered
+ * @param array lft values of rows to be reordered
*
- * @return integer 1 + value of root rgt on success, false on failure
- * @since 11.1
+ * @return integer 1 + value of root rgt on success, false on failure
+ * @since 11.1
*/
public function saveorder($idArray = null, $lft_array = null)
{
@@ -1412,10 +1412,10 @@
/**
* Method to get nested set properties for a node in the tree.
*
- * @param integer Value to look up the node by.
- * @param string Key to look up the node by.
- * @return mixed Boolean false on failure or node object on success.
- * @since 11.1
+ * @param integer Value to look up the node by.
+ * @param string Key to look up the node by.
+ * @return mixed Boolean false on failure or node object on success.
+ * @since 11.1
*/
protected function _getNode($id, $key = null)
{
@@ -1466,13 +1466,13 @@
* for SQL WHERE clauses for updating left and right id values to make room for
* the node as well as the new left and right ids for the node.
*
- * @param object A node object with at least a 'lft' and 'rgt' with
+ * @param object A node object with at least a 'lft' and 'rgt' with
* which to make room in the tree around for a new node.
- * @param integer The width of the node for which to make room in the tree.
- * @param string The position relative to the reference node where the room
+ * @param integer The width of the node for which to make room in the tree.
+ * @param string The position relative to the reference node where the room
* should be made.
- * @return mixed Boolean false on failure or data object on success.
- * @since 11.1
+ * @return mixed Boolean false on failure or data object on success.
+ * @since 11.1
*/
protected function _getTreeRepositionData($referenceNode, $nodeWidth, $position = 'before')
{
Modified: development/branches/platform/libraries/joomla/document/document.php
===================================================================
--- development/branches/platform/libraries/joomla/document/document.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/document.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
/**
* Document title
*
- * @var string
+ * @var string
* @since 11.1
*/
public $title = '';
@@ -33,7 +33,7 @@
/**
* Document description
*
- * @var string
+ * @var string
* @since 11.1
*/
public $description = '';
@@ -41,7 +41,7 @@
/**
* Document full URL
*
- * @var string
+ * @var string
* @since 11.1
*/
public $link = '';
@@ -49,7 +49,7 @@
/**
* Document base URL
*
- * @var string
+ * @var string
* @since 11.1
*/
public $base = '';
@@ -57,7 +57,7 @@
/**
* Contains the document language setting
*
- * @var string
+ * @var string
* @since 11.1
*/
public $language = 'en-gb';
@@ -65,7 +65,7 @@
/**
* Contains the document direction setting
*
- * @var string
+ * @var string
* @since 11.1
*/
public $direction = 'ltr';
@@ -80,7 +80,7 @@
/**
* Document modified date
*
- * @var string
+ * @var string
* @since 11.1
*/
public $_mdate = '';
@@ -172,7 +172,7 @@
/**
* The document type
*
- * @var string
+ * @var string
* @since 11.1
*/
public $_type = null;
@@ -230,11 +230,11 @@
* Returns the global JDocument object, only creating it
* if it doesn't already exist.
*
- * @param string $type The document type to instantiate
- * @param array $attribues Array of attributes
- *
- * @return object The document object.
- * @since 11.1
+ * @param string $type The document type to instantiate
+ * @param array $attribues Array of attributes
+ *
+ * @return object The document object.
+ * @since 11.1
*/
public static function getInstance($type = 'html', $attributes = array())
{
@@ -285,9 +285,9 @@
/**
* Set the document type
*
- * @param string $type
- *
- * @return
+ * @param string $type
+ *
+ * @return
* @since 11.1
*/
public function setType($type)
@@ -298,8 +298,8 @@
/**
* Returns the document type
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public function getType()
{
@@ -309,7 +309,7 @@
/**
* Get the document head data
*
- * @return array The document head data in array form
+ * @return array The document head data in array form
* @since 11.1
*/
public function getHeadData()
@@ -320,10 +320,10 @@
/**
* Set the document head data
*
- * @param array $data The document head data in array form
- *
- * @return void
- * @since 11.1
+ * @param array $data The document head data in array form
+ *
+ * @return void
+ * @since 11.1
*/
public function setHeadData($data)
{
@@ -333,10 +333,10 @@
/**
* Set the document head data
*
- * @param array $data The document head data in array form
- *
- * @return
- * @since 11.1
+ * @param array $data The document head data in array form
+ *
+ * @return
+ * @since 11.1
*/
public function mergeHeadData($data)
{
@@ -346,8 +346,8 @@
/**
* Get the contents of the document buffer
*
- * @return The contents of the document buffer
- * @since 11.1
+ * @return The contents of the document buffer
+ * @since 11.1
*/
public function getBuffer()
{
@@ -357,10 +357,10 @@
/**
* Set the contents of the document buffer
*
- * @param string $content The content to be set in the buffer.
- * @param array $options Array of optional elements.
- *
- * @return void
+ * @param string $content The content to be set in the buffer.
+ * @param array $options Array of optional elements.
+ *
+ * @return void
* @@since 11.1
*/
public function setBuffer($content, $options = array())
@@ -371,11 +371,11 @@
/**
* Gets a meta tag.
*
- * @param string $name Value of name or http-equiv tag
- * @param bool $http_equiv META type "http-equiv" defaults to null
- *
- * @return string
- * @@since 11.1
+ * @param string $name Value of name or http-equiv tag
+ * @param bool $http_equiv META type "http-equiv" defaults to null
+ *
+ * @return string
+ * @@since 11.1
*/
public function getMetaData($name, $http_equiv = false)
{
@@ -402,12 +402,12 @@
/**
* Sets or alters a meta tag.
*
- * @param string $name Value of name or http-equiv tag
- * @param string $content Value of the content tag
- * @param boolean $http_equiv META type "http-equiv" defaults to null
- * @param boolean $sync Should http-equiv="content-type" by synced with HTTP-header?
+ * @param string $name Value of name or http-equiv tag
+ * @param string $content Value of the content tag
+ * @param boolean $http_equiv META type "http-equiv" defaults to null
+ * @param boolean $sync Should http-equiv="content-type" by synced with HTTP-header?
*
- * @return void
+ * @return void
* @@since 11.1
*/
public function setMetaData($name, $content, $http_equiv = false, $sync = true)
@@ -438,12 +438,12 @@
/**
* Adds a linked script to the page
*
- * @param string $url URL to the linked script
- * @param string $type Type of script. Defaults to 'text/javascript'
- * @param boolean $defer Adds the defer attribute.
- * @param boolean $async Adds the async attribute.
+ * @param string $url URL to the linked script
+ * @param string $type Type of script. Defaults to 'text/javascript'
+ * @param boolean $defer Adds the defer attribute.
+ * @param boolean $async Adds the async attribute.
* @return
- * @since 11.1
+ * @since 11.1
*/
public function addScript($url, $type = "text/javascript", $defer = false, $async = false)
{
@@ -455,10 +455,10 @@
/**
* Adds a script to the page
*
- * @param string $content Script
- * @param string $type Scripting mime (defaults to 'text/javascript')
- *
- * @return void
+ * @param string $content Script
+ * @param string $type Scripting mime (defaults to 'text/javascript')
+ *
+ * @return void
* @@since 11.1
*/
public function addScriptDeclaration($content, $type = 'text/javascript')
@@ -474,12 +474,12 @@
/**
* Adds a linked stylesheet to the page
*
- * @param string $url URL to the linked style sheet
- * @param string $type Mime encoding type
- * @param string $media Media type that this stylesheet applies to
- * @param array $attribs Array of attributes
- *
- * @return void
+ * @param string $url URL to the linked style sheet
+ * @param string $type Mime encoding type
+ * @param string $media Media type that this stylesheet applies to
+ * @param array $attribs Array of attributes
+ *
+ * @return void
* @@since 11.1
*/
public function addStyleSheet($url, $type = 'text/css', $media = null, $attribs = array())
@@ -792,10 +792,10 @@
/**
* Load a renderer
*
- * @param string The renderer type
- *
- * @return mixed Object or null if class does not exist
- * @since 11.1
+ * @param string The renderer type
+ *
+ * @return mixed Object or null if class does not exist
+ * @since 11.1
*/
public function loadRenderer($type)
{
Modified: development/branches/platform/libraries/joomla/document/error/error.php
===================================================================
--- development/branches/platform/libraries/joomla/document/error/error.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/error/error.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,8 +30,8 @@
/**
* Class constructor
*
- * @param string $type (either HTML or text)
- * @param array $attributes Associative array of attributes
+ * @param string $type (either HTML or text)
+ * @param array $attributes Associative array of attributes
*/
public function __construct($options = array())
{
@@ -47,10 +47,10 @@
/**
* Set error object
*
- * @param object $error Error object to set
- *
- * @return boolean True on success
- * @since 11.1
+ * @param object $error Error object to set
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function setError($error)
{
@@ -65,8 +65,8 @@
/**
* Render the document
*
- * @param boolean $cache If true, cache the output
- * @param array $params Associative array of attributes
+ * @param boolean $cache If true, cache the output
+ * @param array $params Associative array of attributes
*/
public function render($cache = false, $params = array())
{
@@ -103,10 +103,10 @@
/**
* Load a template file
*
- * @param string $template The name of the template
- * @param string $filename The actual filename
- *
- * @return string The contents of the template
+ * @param string $template The name of the template
+ * @param string $filename The actual filename
+ *
+ * @return string The contents of the template
*/
function _loadTemplate($directory, $filename)
{
Modified: development/branches/platform/libraries/joomla/document/feed/feed.php
===================================================================
--- development/branches/platform/libraries/joomla/document/feed/feed.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/feed/feed.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -155,7 +155,7 @@
/**
* Class constructor
*
- * @param array $options Associative array of options
+ * @param array $options Associative array of options
*/
protected function __construct($options = array())
{
@@ -168,9 +168,9 @@
/**
* Render the document
*
- * @param boolean $cache If true, cache the output
- * @param array $params Associative array of attributes
- * @return The rendered data
+ * @param boolean $cache If true, cache the output
+ * @param array $params Associative array of attributes
+ * @return The rendered data
*/
public function render($cache = false, $params = array())
{
@@ -218,7 +218,7 @@
/**
* Adds an JFeedItem to the feed.
*
- * @param object JFeedItem $item The feeditem to add to the feed.
+ * @param object JFeedItem $item The feeditem to add to the feed.
*/
public function addItem(&$item)
{
@@ -232,7 +232,7 @@
*
* @package Joomla.Platform
* @subpackage Document
- * @since 11.1
+ * @since 11.1
*/
class JFeedItem extends JObject
{
@@ -350,7 +350,7 @@
/**
* Set the JFeedEnclosure for this item
*
- * @param object $enclosure The JFeedItem to add to the feed.
+ * @param object $enclosure The JFeedItem to add to the feed.
*/
public function setEnclosure($enclosure) {
$this->enclosure = $enclosure;
Modified: development/branches/platform/libraries/joomla/document/feed/renderer/atom.php
===================================================================
--- development/branches/platform/libraries/joomla/document/feed/renderer/atom.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/feed/renderer/atom.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,7 +19,7 @@
* @package Joomla.Platform
* @subpackage Document
* @see http://www.atomenabled.org/developers/syndication/atom-format-spec.php
- * @since 11.1
+ * @since 11.1
*/
class JDocumentRendererAtom extends JDocumentRenderer
@@ -34,7 +34,7 @@
/**
* Render the feed
*
- * @return string
+ * @return string
*/
public function render()
{
Modified: development/branches/platform/libraries/joomla/document/feed/renderer/rss.php
===================================================================
--- development/branches/platform/libraries/joomla/document/feed/renderer/rss.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/feed/renderer/rss.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,7 +29,7 @@
/**
* Render the feed
*
- * @return string
+ * @return string
*/
public function render()
{
@@ -182,7 +182,7 @@
/**
* Convert links in a text from relative to absolute
*
- * @return string
+ * @return string
*/
public function _relToAbs($text)
{
Modified: development/branches/platform/libraries/joomla/document/html/html.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/html.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/html.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -60,7 +60,7 @@
/**
* Class constructor
*
- * @param array $options Associative array of options
+ * @param array $options Associative array of options
*/
public function __construct($options = array())
{
@@ -77,7 +77,7 @@
/**
* Get the HTML document head data
*
- * @return array The document head data in array form
+ * @return array The document head data in array form
*/
public function getHeadData()
{
@@ -98,7 +98,7 @@
/**
* Set the HTML document head data
*
- * @param array $data The document head data in array form
+ * @param array $data The document head data in array form
*/
public function setHeadData($data)
{
@@ -121,7 +121,7 @@
/**
* Merge the HTML document head data
*
- * @param array $data The document head data in array form
+ * @param array $data The document head data in array form
*/
public function mergeHeadData($data)
{
@@ -179,12 +179,12 @@
* ('rev' refers to reverse relation, 'rel' indicates normal, forward relation.)
* Typical tag: <link href="index.php" rel="Start">
*
- * @param string $href The link that is being related.
- * @param string $relation Relation of link.
- * @param string $relType Relation type attribute. Either rel or rev (default: 'rel').
- * @param array $attributes Associative array of remaining attributes.
- *
- * @return void
+ * @param string $href The link that is being related.
+ * @param string $relation Relation of link.
+ * @param string $relType Relation type attribute. Either rel or rev (default: 'rel').
+ * @param array $attributes Associative array of remaining attributes.
+ *
+ * @return void
*/
public function addHeadLink($href, $relation, $relType = 'rel', $attribs = array())
{
@@ -200,9 +200,9 @@
* the left of the url in the address bar. Some browsers display
* it on the tab, as well.
*
- * @param string $href The link that is being related.
- * @param string $type File type
- * @param string $relation Relation of link
+ * @param string $href The link that is being related.
+ * @param string $type File type
+ * @param string $relation Relation of link
*/
public function addFavicon($href, $type = 'image/vnd.microsoft.icon', $relation = 'shortcut icon')
{
@@ -213,8 +213,8 @@
/**
* Adds a custom HTML string to the head block
*
- * @param string The HTML to add to the head
- * @return void
+ * @param string The HTML to add to the head
+ * @return void
*/
public function addCustomTag($html)
@@ -225,11 +225,11 @@
/**
* Get the contents of a document include
*
- * @param string $type The type of renderer
- * @param string $name The name of the element to render
- * @param array $attribs Associative array of remaining attributes.
- *
- * @return The output of the renderer
+ * @param string $type The type of renderer
+ * @param string $name The name of the element to render
+ * @param array $attribs Associative array of remaining attributes.
+ *
+ * @return The output of the renderer
*/
public function getBuffer($type = null, $name = null, $attribs = array())
{
@@ -284,8 +284,8 @@
/**
* Set the contents a document includes
*
- * @param string $content The content to be set in the buffer.
- * @param array $options Array of optional elements.
+ * @param string $content The content to be set in the buffer.
+ * @param array $options Array of optional elements.
*/
public function setBuffer($content, $options = array())
{
@@ -302,7 +302,7 @@
/**
* Parses the template and populates the buffer
*
- * @param array parameters for fetching the template
+ * @param array parameters for fetching the template
*/
public function parse($params = array()) {
$this->_fetchTemplate($params);
@@ -312,9 +312,9 @@
/**
* Outputs the template to the browser.
*
- * @param boolean $cache If true, cache the output
- * @param array $params Associative array of attributes
- * @return The rendered data
+ * @param boolean $cache If true, cache the output
+ * @param array $params Associative array of attributes
+ * @return The rendered data
*/
public function render($caching = false, $params = array())
{
@@ -335,7 +335,7 @@
* Count the modules based on the given condition
*
* @param string $condition The condition to use
- * @return integer Number of modules found
+ * @return integer Number of modules found
*/
public function countModules($condition)
{
@@ -358,7 +358,7 @@
/**
* Count the number of child menu items
*
- * @return integer Number of child menu items
+ * @return integer Number of child menu items
*/
public function countMenuChildren()
{
@@ -430,7 +430,7 @@
/**
* Fetch the template, and initialise the params
*
- * @param array parameters to determine the template
+ * @param array parameters to determine the template
*/
protected function _fetchTemplate($params = array())
{
Modified: development/branches/platform/libraries/joomla/document/html/renderer/component.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/renderer/component.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/renderer/component.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,10 +21,10 @@
/**
* Renders a component script and returns the results as a string
*
- * @param string $component The name of the component to render
- * @param array $params Associative array of values
- *
- * @return string The output of the script
+ * @param string $component The name of the component to render
+ * @param array $params Associative array of values
+ *
+ * @return string The output of the script
*/
public function render($component = null, $params = array(), $content = null)
{
Modified: development/branches/platform/libraries/joomla/document/html/renderer/head.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/renderer/head.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/renderer/head.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,9 +21,9 @@
/**
* Renders the document head and returns the results as a string
*
- * @param string $name (unused)
- * @param array $params Associative array of values
- * @return string The output of the script
+ * @param string $name (unused)
+ * @param array $params Associative array of values
+ * @return string The output of the script
*/
public function render($head, $params = array(), $content = null)
{
@@ -38,7 +38,7 @@
/**
* Generates the head HTML and return the results as a string
*
- * @return string
+ * @return string
*/
public function fetchHead(&$document)
{
Modified: development/branches/platform/libraries/joomla/document/html/renderer/message.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/renderer/message.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/renderer/message.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,10 +21,10 @@
/**
* Renders the error stack and returns the results as a string
*
- * @param string $name (unused)
- * @param array $params Associative array of values
- *
- * @return string The output of the script
+ * @param string $name (unused)
+ * @param array $params Associative array of values
+ *
+ * @return string The output of the script
*/
public function render($name, $params = array (), $content = null)
{
Modified: development/branches/platform/libraries/joomla/document/html/renderer/module.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/renderer/module.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/renderer/module.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,10 +21,10 @@
/**
* Renders a module script and returns the results as a string
*
- * @param string $name The name of the module to render
- * @param array $attribs Associative array of values
- *
- * @return string The output of the script
+ * @param string $name The name of the module to render
+ * @param array $attribs Associative array of values
+ *
+ * @return string The output of the script
*/
public function render($module, $attribs = array(), $content = null)
{
Modified: development/branches/platform/libraries/joomla/document/html/renderer/modules.php
===================================================================
--- development/branches/platform/libraries/joomla/document/html/renderer/modules.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/html/renderer/modules.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,9 +21,9 @@
/**
* Renders multiple modules script and returns the results as a string
*
- * @param string $name The position of the modules to render
- * @param array $params Associative array of values
- * @return string The output of the script
+ * @param string $name The position of the modules to render
+ * @param array $params Associative array of values
+ * @return string The output of the script
*/
public function render($position, $params = array(), $content = null)
{
Modified: development/branches/platform/libraries/joomla/document/json/json.php
===================================================================
--- development/branches/platform/libraries/joomla/document/json/json.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/json/json.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -31,7 +31,7 @@
/**
* Class constructor
*
- * @param array $options Associative array of options
+ * @param array $options Associative array of options
*/
public function __construct($options = array())
{
@@ -47,9 +47,9 @@
/**
* Render the document.
*
- * @param boolean $cache If true, cache the output
- * @param array $params Associative array of attributes
- * @return The rendered data
+ * @param boolean $cache If true, cache the output
+ * @param array $params Associative array of attributes
+ * @return The rendered data
*/
public function render($cache = false, $params = array())
{
@@ -64,7 +64,7 @@
/**
* Get the document head data
*
- * @return array The document head data in array form
+ * @return array The document head data in array form
*/
public function getHeadData()
{
@@ -73,7 +73,7 @@
/**
* Set the document head data
*
- * @param array $data The document head data in array form
+ * @param array $data The document head data in array form
*/
public function setHeadData($data)
{
@@ -82,7 +82,7 @@
/**
* Returns the document name
*
- * @return string
+ * @return string
*/
public function getName() {
return $this->_name;
@@ -91,7 +91,7 @@
/**
* Sets the document name
*
- * @param string $name Document name
+ * @param string $name Document name
* @return void
*/
public function setName($name = 'joomla') {
Modified: development/branches/platform/libraries/joomla/document/raw/raw.php
===================================================================
--- development/branches/platform/libraries/joomla/document/raw/raw.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/raw/raw.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
/**
* Class constructor
*
- * @param array $options Associative array of options
+ * @param array $options Associative array of options
*/
protected function __construct($options = array())
{
Modified: development/branches/platform/libraries/joomla/document/renderer.php
===================================================================
--- development/branches/platform/libraries/joomla/document/renderer.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/renderer.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -37,9 +37,9 @@
/**
* Class constructor
*
- * @param object $doc A reference to the JDocument object that instantiated the renderer
- *
- * @since 11.1
+ * @param object $doc A reference to the JDocument object that instantiated the renderer
+ *
+ * @since 11.1
*/
public function __construct(&$doc)
{
@@ -49,12 +49,12 @@
/**
* Renders a script and returns the results as a string
*
- * @param string $name The name of the element to render
- * @param array $array Array of values
- * @param string $content Override the output of the renderer
- *
- * @return string The output of the script
- * @since 11.1
+ * @param string $name The name of the element to render
+ * @param array $array Array of values
+ * @param string $content Override the output of the renderer
+ *
+ * @return string The output of the script
+ * @since 11.1
*/
public function render($name, $params = null, $content = null)
{
@@ -63,8 +63,8 @@
/**
* Return the content type of the renderer
*
- * @return string The contentType
- * @since 11.1
+ * @return string The contentType
+ * @since 11.1
*/
function getContentType() {
return $this->_mime;
Modified: development/branches/platform/libraries/joomla/document/xml/xml.php
===================================================================
--- development/branches/platform/libraries/joomla/document/xml/xml.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/document/xml/xml.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -31,7 +31,7 @@
/**
* Class constructor
*
- * @param array $options Associative array of options
+ * @param array $options Associative array of options
*/
public function __construct($options = array())
{
@@ -47,9 +47,9 @@
/**
* Render the document.
*
- * @param boolean $cache If true, cache the output
- * @param array $params Associative array of attributes
- * @return The rendered data
+ * @param boolean $cache If true, cache the output
+ * @param array $params Associative array of attributes
+ * @return The rendered data
*/
public function render($cache = false, $params = array())
{
@@ -62,7 +62,7 @@
/**
* Get the document head data
*
- * @return array The document head data in array form
+ * @return array The document head data in array form
*/
public function getHeadData()
{
@@ -71,7 +71,7 @@
/**
* Set the document head data
*
- * @param array $data The document head data in array form
+ * @param array $data The document head data in array form
*/
public function setHeadData($data)
{
@@ -80,7 +80,7 @@
/**
* Returns the document name
*
- * @return string
+ * @return string
*/
public function getName() {
return $this->_name;
@@ -89,7 +89,7 @@
/**
* Sets the document name
*
- * @param string $name Document name
+ * @param string $name Document name
* @return void
*/
public function setName($name = 'joomla') {
Modified: development/branches/platform/libraries/joomla/environment/browser.php
===================================================================
--- development/branches/platform/libraries/joomla/environment/browser.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/environment/browser.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,37 +27,37 @@
{
/**
* Major version number.
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_majorVersion = 0;
/**
* Minor version number
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_minorVersion = 0;
/**
* Browser name.
- * @var string
- * @since 11.1
+ * @var string
+ * @since 11.1
*/
protected $_browser = '';
- /**
+ /**
* Full user agent string.
- * @var string
- * @since 11.1
+ * @var string
+ * @since 11.1
*/
protected $_agent = '';
/**
* Lower-case user agent string.
- *
- * @var string
- * @since 11.1
+ *
+ * @var string
+ * @since 11.1
*/
protected $_lowerAgent = '';
@@ -67,24 +67,24 @@
*/
protected $_accept = '';
- /**
+ /**
* Parsed HTTP_ACCEPT string
- * @var array
+ * @var array
* @since 11.1
*/
protected $_accept_parsed = array();
- /**
+ /**
* Platform the browser is running on.
- *
- * @var string
+ *
+ * @var string
* @since 11.1
*/
protected $_platform = '';
- /**
+ /**
* Known robots.
- * @var array
+ * @var array
* @since 11.1
*/
protected $_robots = array(
@@ -142,9 +142,9 @@
*/
protected $_mobile = false;
- /**
+ /**
* Features.
- * @var array
+ * @var array
* @since 11.1
*/
protected $_features = array(
@@ -167,9 +167,9 @@
'svg' => false
);
- /**
+ /**
* Quirks.
- * @var array
+ * @var array
* @since 11.1
*/
protected $_quirks = array(
@@ -204,10 +204,10 @@
/**
* Create a browser instance (constructor).
*
- * @param string $userAgent The browser string to parse.
- * @param string $accept The HTTP_ACCEPT settings to use.
- *
- * @since 11.1
+ * @param string $userAgent The browser string to parse.
+ * @param string $accept The HTTP_ACCEPT settings to use.
+ *
+ * @since 11.1
*/
public function __construct($userAgent = null, $accept = null)
{
@@ -218,9 +218,9 @@
* Returns the global Browser object, only creating it
* if it doesn't already exist.
*
- * @param string $userAgent The browser string to parse.
- * @param string $accept The HTTP_ACCEPT settings to use.
- *
+ * @param string $userAgent The browser string to parse.
+ * @param string $accept The HTTP_ACCEPT settings to use.
+ *
* @return JBrowser The Browser object.
* @since 11.1
*/
@@ -258,11 +258,11 @@
* Parses the user agent string and inititializes the object with
* all the known features and quirks for the given browser.
*
- * @param string $userAgent The browser string to parse.
- * @param string $accept The HTTP_ACCEPT settings to use.
- *
- * @return
- * @since 11.1
+ * @param string $userAgent The browser string to parse.
+ * @param string $accept The HTTP_ACCEPT settings to use.
+ *
+ * @return
+ * @since 11.1
*/
public function match($userAgent = null, $accept = null)
{
@@ -646,9 +646,9 @@
* This is a pretty simplistic implementation, but it's intended
* to let us tell what line breaks to send, so it's good enough
* for its purpose.
- *
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
protected function _setPlatform()
{
@@ -664,34 +664,34 @@
/**
* Return the currently matched platform.
*
- * @return string The user's platform.
- * @since 11.1
+ * @return string The user's platform.
+ * @since 11.1
*/
public function getPlatform()
{
-
+
return $this->_platform;
}
/**
* Sets the current browser.
*
- * @param string $browser The browser to set as current.
- *
+ * @param string $browser The browser to set as current.
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
public function setBrowser($browser)
{
-
+
$this->_browser = $browser;
}
/**
* Retrieve the current browser.
*
- * @return string The current browser.
- * @since 11.1
+ * @return string The current browser.
+ * @since 11.1
*/
public function getBrowser()
{
@@ -701,8 +701,8 @@
/**
* Retrieve the current browser's major version.
*
- * @return integer The current browser's major version
- * @since 11.1.
+ * @return integer The current browser's major version
+ * @since 11.1.
*/
public function getMajor()
{
@@ -711,9 +711,9 @@
/**
* Retrieve the current browser's minor version.
- *
- * @return integer The current browser's minor version.
- * @since 11.1
+ *
+ * @return integer The current browser's minor version.
+ * @since 11.1
*/
public function getMinor()
{
@@ -722,9 +722,9 @@
/**
* Retrieve the current browser's version.
- *
- * @return string The current browser's version.
- * @since 11.1
+ *
+ * @return string The current browser's version.
+ * @since 11.1
*/
public function getVersion()
{
@@ -734,8 +734,8 @@
/**
* Return the full browser agent string.
*
- * @return string The browser agent string
- * @since 11.1
+ * @return string The browser agent string
+ * @since 11.1
*/
public function getAgentString()
{
@@ -745,8 +745,8 @@
/**
* Returns the server protocol in use on the current server.
*
- * @return string The HTTP server protocol version.
- * @since 11.1
+ * @return string The HTTP server protocol version.
+ * @since 11.1
*/
public function getHTTPProtocol()
{
@@ -761,11 +761,11 @@
/**
* Set unique behavior for the current browser.
*
- * @param string $quirk The behavior to set.
- * @param string $value Special behavior parameter.
- *
+ * @param string $quirk The behavior to set.
+ * @param string $value Special behavior parameter.
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
public function setQuirk($quirk, $value = true)
{
@@ -775,10 +775,10 @@
/**
* Check unique behavior for the current browser.
*
- * @param string $quirk The behavior to check.
- *
- * @return boolean Does the browser have the behavior set?
- * @since 11.1
+ * @param string $quirk The behavior to check.
+ *
+ * @return boolean Does the browser have the behavior set?
+ * @since 11.1
*/
public function hasQuirk($quirk)
{
@@ -788,10 +788,10 @@
/**
* Retrieve unique behavior for the current browser.
*
- * @param string $quirk The behavior to retrieve.
- *
- * @return string The value for the requested behavior.
- * @since 11.1
+ * @param string $quirk The behavior to retrieve.
+ *
+ * @return string The value for the requested behavior.
+ * @since 11.1
*/
public function getQuirk($quirk)
{
@@ -803,11 +803,11 @@
/**
* Set capabilities for the current browser.
*
- * @param string $feature The capability to set.
- * @param string $value Special capability parameter.
- *
+ * @param string $feature The capability to set.
+ * @param string $value Special capability parameter.
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
public function setFeature($feature, $value = true)
{
@@ -818,10 +818,10 @@
/**
* Check the current browser capabilities.
*
- * @param string $feature The capability to check.
- *
- * @return boolean Does the browser have the capability set?
- * @since 11.1
+ * @param string $feature The capability to check.
+ *
+ * @return boolean Does the browser have the capability set?
+ * @since 11.1
*/
public function hasFeature($feature)
{
@@ -831,10 +831,10 @@
/**
* Retrieve the current browser capability.
*
- * @param string $feature The capability to retrieve.
- *
- * @return string The value of the requested capability.
- * @since 11.1
+ * @param string $feature The capability to retrieve.
+ *
+ * @return string The value of the requested capability.
+ * @since 11.1
*/
public function getFeature($feature)
{
@@ -845,15 +845,15 @@
/**
* Determines if a browser can display a given MIME type.
- *
+ *
* Note that image/jpeg and image/pjpeg *appear* to be the same
- * entity, but Mozilla doesn't seem to want to accept the latter.
+ * entity, but Mozilla doesn't seem to want to accept the latter.
* For our purposes, we will treat them the same.
*
- * @param string $mimetype The MIME type to check.
- *
- * @return boolean True if the browser can display the MIME type.
- * @since 11.1
+ * @param string $mimetype The MIME type to check.
+ *
+ * @return boolean True if the browser can display the MIME type.
+ * @since 11.1
*/
public function isViewable($mimetype)
{
@@ -896,10 +896,10 @@
/**
* Determine if the given browser is the same as the current.
*
- * @param string $browser The browser to check.
- *
- * @return boolean Is the given browser the same as the current?
- * @since 11.1
+ * @param string $browser The browser to check.
+ *
+ * @return boolean Is the given browser the same as the current?
+ * @since 11.1
*/
public function isBrowser($browser)
{
@@ -909,8 +909,8 @@
/**
* Determines if the browser is a robot or not.
*
- * @return boolean True if browser is a known robot.
- * @since 11.1
+ * @return boolean True if browser is a known robot.
+ * @since 11.1
*/
public function isRobot()
{
@@ -926,7 +926,7 @@
* Determines if the browser is mobile version or not.
*
* @return boolean True if browser is a known mobile version.
- * @since 11.1
+ * @since 11.1
*/
public function isMobile()
{
@@ -936,8 +936,8 @@
/**
* Determine if we are using a secure (SSL) connection.
*
- * @return boolean True if using SSL, false if not.
- * @since 11.1
+ * @return boolean True if using SSL, false if not.
+ * @since 11.1
*/
public function isSSLConnection()
{
Modified: development/branches/platform/libraries/joomla/environment/request.php
===================================================================
--- development/branches/platform/libraries/joomla/environment/request.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/environment/request.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -40,7 +40,7 @@
/**
* Gets the full request path.
*
- * @return string
+ * @return string
*/
public static function getURI()
{
@@ -51,7 +51,7 @@
/**
* Gets the request method.
*
- * @return string
+ * @return string
*/
public static function getMethod()
{
@@ -78,14 +78,14 @@
* method via current $_SERVER['REQUEST_METHOD']
* default $_REQUEST
*
- * @param string $name Variable name.
- * @param string $default Default value if the variable does not exist.
- * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
- * @param string $type Return type for the variable, for valid values see {@link JFilterInput::clean()}.
- * @param integer $mask Filter mask for the variable.
- *
- * @return mixed Requested variable.
- * @since 11.1
+ * @param string $name Variable name.
+ * @param string $default Default value if the variable does not exist.
+ * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
+ * @param string $type Return type for the variable, for valid values see {@link JFilterInput::clean()}.
+ * @param integer $mask Filter mask for the variable.
+ *
+ * @return mixed Requested variable.
+ * @since 11.1
*/
public static function getVar($name, $default = null, $hash = 'default', $type = 'none', $mask = 0)
{
@@ -234,19 +234,19 @@
/**
* Cmd (Word and Integer0 filter
- *
+ *
* Fetches and returns a given filtered variable. The cmd
* filter only allows the characters [A-Za-z0-9.-_]. This is
* currently only a proxy function for getVar().
*
* See getVar() for more in-depth documentation on the parameters.
*
- * @param string $name Variable name
- * @param string $default Default value if the variable does not exist
- * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
+ * @param string $name Variable name
+ * @param string $default Default value if the variable does not exist
+ * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
*
- * @return string Requested variable
- * @since 11.1
+ * @return string Requested variable
+ * @since 11.1
*/
public static function getCmd($name, $default = '', $hash = 'default')
{
@@ -260,13 +260,13 @@
*
* See getVar() for more in-depth documentation on the parameters.
*
- * @param string $name Variable name
- * @param string $default Default value if the variable does not exist
- * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
- * @param integer $mask Filter mask for the variable
+ * @param string $name Variable name
+ * @param string $default Default value if the variable does not exist
+ * @param string $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
+ * @param integer $mask Filter mask for the variable
*
- * @return string Requested variable
- * @since 11.1
+ * @return string Requested variable
+ * @since 11.1
*/
public static function getString($name, $default = '', $hash = 'default', $mask = 0)
{
@@ -277,13 +277,13 @@
/**
* Set a variabe in one of the request variables.
*
- * @param string $name Name
- * @param string $value Value
- * @param string $hash Hash
- * @param boolean $overwrite Boolean
+ * @param string $name Name
+ * @param string $value Value
+ * @param string $hash Hash
+ * @param boolean $overwrite Boolean
*
- * @return string Previous value
- * @since 11.1
+ * @return string Previous value
+ * @since 11.1
*/
public static function setVar($name, $value = null, $hash = 'method', $overwrite = true)
{
@@ -353,11 +353,11 @@
* method via current $_SERVER['REQUEST_METHOD']
* default $_REQUEST
*
- * @param string $hash to get (POST, GET, FILES, METHOD).
- * @param integer $mask Filter mask for the variable.
- *
- * @return mixed Request hash.
- * @since 11.1
+ * @param string $hash to get (POST, GET, FILES, METHOD).
+ * @param integer $mask Filter mask for the variable.
+ *
+ * @return mixed Request hash.
+ * @since 11.1
*/
public static function get($hash = 'default', $mask = 0)
{
@@ -411,11 +411,11 @@
/**
* Sets a request variable.
*
- * @param array An associative array of key-value pairs.
- * @param string The request variable to set (POST, GET, FILES, METHOD).
- *
- * @param boolean If true and an existing key is found, the value is overwritten, otherwise it is ignored.
- * @since 11.1
+ * @param array An associative array of key-value pairs.
+ * @param string The request variable to set (POST, GET, FILES, METHOD).
+ *
+ * @param boolean If true and an existing key is found, the value is overwritten, otherwise it is ignored.
+ * @since 11.1
*/
public static function set($array, $hash = 'default', $overwrite = true)
{
@@ -429,8 +429,8 @@
*
* Use in conjuction with JHtml::_('form.token').
*
- * @param string The request method in which to look for the token key.
- * @return boolean True if found and valid, false otherwise.
+ * @param string The request method in which to look for the token key.
+ * @return boolean True if found and valid, false otherwise.
*/
public static function checkToken($method = 'post')
{
@@ -455,8 +455,8 @@
/**
* Cleans the request from script injection.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function clean()
{
@@ -508,11 +508,11 @@
/**
* Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked.
*
- * @param array $array Array to clean.
- * @param boolean True if the array is to be added to the GLOBALS.
- *
+ * @param array $array Array to clean.
+ * @param boolean True if the array is to be added to the GLOBALS.
+ *
* @return
- * @since 11.1
+ * @since 11.1
*/
static function _cleanArray(&$array, $globalise=false)
{
@@ -537,20 +537,20 @@
/**
* Clean up an input variable.
*
- * @param mixed $var The input variable.
- * @param integer $mask Filter bit mask.
+ * @param mixed $var The input variable.
+ * @param integer $mask Filter bit mask.
* 1=no trim: If this flag is cleared and the
* input is a string, the string will have leading and trailing whitespace
- * trimmed.
+ * trimmed.
* 2=allow_raw: If set, no more filtering is performed, higher bits
- * are ignored.
+ * are ignored.
* 4=allow_html: HTML is allowed, but passed through a safe
* HTML filter first. If set, no more filtering is performed. If no bits
* other than the 1 bit is set, a strict filter is applied.
- * @param string $type The variable type {@see JFilterInput::clean()}.
- *
- * @return mixed Same as $var
- * @since 11.1
+ * @param string $type The variable type {@see JFilterInput::clean()}.
+ *
+ * @return mixed Same as $var
+ * @since 11.1
*/
static function _cleanVar($var, $mask = 0, $type=null)
{
@@ -592,10 +592,10 @@
/**
* Strips slashes recursively on an array.
*
- * @param array $value Array or (nested arrays) of strings.
- *
- * @return array The input array with stripshlashes applied to it.
- * @since 11.1
+ * @param array $value Array or (nested arrays) of strings.
+ *
+ * @return array The input array with stripshlashes applied to it.
+ * @since 11.1
*/
protected static function _stripSlashesRecursive($value)
{
Modified: development/branches/platform/libraries/joomla/environment/response.php
===================================================================
--- development/branches/platform/libraries/joomla/environment/response.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/environment/response.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -47,10 +47,10 @@
*
* If $allow is set, sets the cachable state of the response. Always returns current state.
*
- * @param boolean $allow
+ * @param boolean $allow
*
- * @return boolean True of browser caching should be allowed
- * @since 11.1
+ * @return boolean True of browser caching should be allowed
+ * @since 11.1
*/
public static function allowCache($allow = null)
{
@@ -66,12 +66,12 @@
*
* If $replace is true, replaces any headers already defined with that $name.
*
- * @param string $name
- * @param string $value
- * @param boolean $replace
+ * @param string $name
+ * @param string $value
+ * @param boolean $replace
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function setHeader($name, $value, $replace = false)
{
@@ -96,8 +96,8 @@
/**
* Return array of headers.
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public static function getHeaders()
{
@@ -107,8 +107,8 @@
/**
* Clear headers.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function clearHeaders()
{
@@ -118,8 +118,8 @@
/**
* Send all headers.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function sendHeaders()
{
@@ -142,10 +142,10 @@
*
* If body content already defined, this will replace it.
*
- * @param string $content
+ * @param string $content
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function setBody($content)
{
@@ -155,10 +155,10 @@
/**
* Prepend content to the body content
*
- * @param string $content
+ * @param string $content
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function prependBody($content)
{
@@ -168,10 +168,10 @@
/**
* Append content to the body content
*
- * @param string $content
+ * @param string $content
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function appendBody($content)
{
@@ -181,10 +181,10 @@
/**
* Return the body content
*
- * @param boolean $toArray Whether or not to return the body content as an array of strings or as a single string; defaults to false.
+ * @param boolean $toArray Whether or not to return the body content as an array of strings or as a single string; defaults to false.
*
- * @return string array
- * @since 11.1
+ * @return string array
+ * @since 11.1
*/
public static function getBody($toArray = false)
{
@@ -204,10 +204,10 @@
/**
* Sends all headers prior to returning the string
*
- * @param boolean $compress If true, compress the data
+ * @param boolean $compress If true, compress the data
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function toString($compress = false)
{
@@ -235,10 +235,10 @@
* Checks the accept encoding of the browser and compresses the data before
* sending it to the client.
*
- * @param string $data data
+ * @param string $data data
*
- * @return string compressed data
- * @since 11.1 Replaces _compress method in 11.1
+ * @return string compressed data
+ * @since 11.1 Replaces _compress method in 11.1
*/
protected static function compress($data)
{
@@ -261,7 +261,7 @@
}
// Ideal level
- $level = 4;
+ $level = 4;
/*
$size = strlen($data);
@@ -285,8 +285,8 @@
/**
* Check, whether client supports compressed data
*
- * @return boolean
- * @since 11.1 Replaces _clientEncoding method from 11.1
+ * @return boolean
+ * @since 11.1 Replaces _clientEncoding method from 11.1
*/
protected static function clientEncoding()
{
Modified: development/branches/platform/libraries/joomla/environment/uri.php
===================================================================
--- development/branches/platform/libraries/joomla/environment/uri.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/environment/uri.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -40,42 +40,42 @@
/**
* Host
- * @var string
+ * @var string
* @since 11.1
*/
protected $_host = null;
/**
* Port
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_port = null;
/**
* Username
- * @var string
+ * @var string
* @since 11.1
*/
protected $_user = null;
/**
* Password
- * @var string
+ * @var string
* @since 11.1
*/
protected $_pass = null;
/**
* Path
- * @var string
+ * @var string
* @since 11.1
*/
protected $_path = null;
/**
* Query
- * @var string
+ * @var string
* @since 11.1
*/
protected $_query = null;
@@ -83,7 +83,7 @@
/**
* Anchor
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_fragment = null;
@@ -98,9 +98,9 @@
* Constructor.
* You can pass a URI string to the constructor to initialise a specific URI.
*
- * @param string $uri The optional URI string
- *
- * @since 11.1
+ * @param string $uri The optional URI string
+ *
+ * @since 11.1
*/
public function __construct($uri = null)
{
@@ -112,8 +112,8 @@
/**
* Magic method to get the string representation of the URI object.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public function __toString()
{
@@ -124,10 +124,10 @@
* Returns the global JURI object, only creating it
* if it doesn't already exist.
*
- * @param string $uri The URI to parse. [optional: if null uses script URI]
- *
- * @return JURI The URI object.
- * @since 11.1
+ * @param string $uri The URI to parse. [optional: if null uses script URI]
+ *
+ * @return JURI The URI object.
+ * @since 11.1
*/
public static function getInstance($uri = 'SERVER')
{
@@ -147,7 +147,7 @@
}
-
+
// Since we are assigning the URI from the server variables, we first need
// to determine if we are running on apache or IIS. If PHP_SELF and REQUEST_URI
// are present, we will assume we are running on apache.
@@ -192,10 +192,10 @@
/**
* Returns the base URI for the request.
*
- * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false.
- *
- * @return string The base URI string
- * @since 11.1
+ * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false.
+ *
+ * @return string The base URI string
+ * @since 11.1
*/
public static function base($pathonly = false)
{
@@ -245,10 +245,10 @@
/**
* Returns the root URI for the request.
*
- * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false..
- *
- * @return string The root URI string.
- * @since 11.1
+ * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false..
+ *
+ * @return string The root URI string.
+ * @since 11.1
*/
public static function root($pathonly = false, $path = null)
{
@@ -273,8 +273,8 @@
/**
* Returns the URL for the request, minus the query.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function current()
{
@@ -293,10 +293,10 @@
/**
* Parse a given URI and populate the class fields.
*
- * @param string $uri The URI string to parse.
- *
- * @return boolean True on success.
- * @since 11.1
+ * @param string $uri The URI string to parse.
+ *
+ * @return boolean True on success.
+ * @since 11.1
*/
public function parse($uri)
{
@@ -306,7 +306,7 @@
// Set the original URI to fall back on
$this->_uri = $uri;
-
+
// Parse the URI and populate the object fields. If URI is parsed properly,
// set method return value to true.
if ($_parts = JString::parse_url($uri)) {
@@ -338,10 +338,10 @@
/**
* Returns full uri string.
*
- * @param array $parts An array specifying the parts to render.
- *
- * @return string The rendered URI string.
- * @since 11.1
+ * @param array $parts An array specifying the parts to render.
+ *
+ * @return string The rendered URI string.
+ * @since 11.1
*/
public function toString($parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))
{
@@ -365,10 +365,10 @@
* Adds a query variable and value, replacing the value if it
* already exists and returning the old value.
*
- * @param string $name Name of the query variable to set.
- * @param string $value Value of the query variable.
- * @return string Previous value for the query variable.
- * @since 11.1
+ * @param string $name Name of the query variable to set.
+ * @param string $value Value of the query variable.
+ * @return string Previous value for the query variable.
+ * @since 11.1
*/
public function setVar($name, $value)
{
@@ -384,9 +384,9 @@
/**
* Checks if variable exists.
*
- * @param string $name Name of the query variable to check.
- * @return bool exists.
- * @since 11.1
+ * @param string $name Name of the query variable to check.
+ * @return bool exists.
+ * @since 11.1
*/
public function hasVar($name)
{
@@ -396,9 +396,9 @@
/**
* Returns a query variable by name.
*
- * @param string $name Name of the query variable to get.
- * @return array Query variables.
- * @since 11.1
+ * @param string $name Name of the query variable to get.
+ * @return array Query variables.
+ * @since 11.1
*/
public function getVar($name, $default=null)
{
@@ -411,8 +411,8 @@
/**
* Removes an item from the query string variables if it exists.
*
- * @param string $name Name of variable to remove.
- * @since 11.1
+ * @param string $name Name of variable to remove.
+ * @since 11.1
*/
public function delVar($name)
{
@@ -429,8 +429,8 @@
* Sets the query to a supplied string in format:
* foo=bar&x=y
*
- * @param mixed (array|string) $query The query string.
- * @since 11.1
+ * @param mixed (array|string) $query The query string.
+ * @since 11.1
*/
public function setQuery($query)
{
@@ -452,8 +452,8 @@
/**
* Returns flat query string.
*
- * @return string Query string.
- * @since 11.1
+ * @return string Query string.
+ * @since 11.1
*/
public function getQuery($toArray = false)
{
@@ -472,8 +472,8 @@
/**
* Build a query from a array (reverse of the PHP parse_str()).
*
- * @return string The resulting query string.
- * @since 11.1
+ * @return string The resulting query string.
+ * @since 11.1
* @see parse_str()
*/
public static function buildQuery($params, $akey = null)
@@ -489,8 +489,8 @@
* Get URI scheme (protocol)
* ie. http, https, ftp, etc...
*
- * @return string The URI scheme.
- * @since 11.1
+ * @return string The URI scheme.
+ * @since 11.1
*/
public function getScheme()
{
@@ -501,8 +501,8 @@
* Set URI scheme (protocol)
* ie. http, https, ftp, etc...
*
- * @param string $scheme The URI scheme.
- * @since 11.1
+ * @param string $scheme The URI scheme.
+ * @since 11.1
*/
public function setScheme($scheme)
{
@@ -513,8 +513,8 @@
* Get URI username
* Returns the username, or null if no username was specified.
*
- * @return string The URI username.
- * @since 11.1
+ * @return string The URI username.
+ * @since 11.1
*/
public function getUser()
{
@@ -524,8 +524,8 @@
/**
* Set URI username.
*
- * @param string $user The URI username.
- * @since 11.1
+ * @param string $user The URI username.
+ * @since 11.1
*/
public function setUser($user)
{
@@ -536,8 +536,8 @@
* Get URI password
* Returns the password, or null if no password was specified.
*
- * @return string The URI password.
- * @since 11.1
+ * @return string The URI password.
+ * @since 11.1
*/
public function getPass()
{
@@ -547,8 +547,8 @@
/**
* Set URI password.
*
- * @param string $pass The URI password.
- * @since 11.1
+ * @param string $pass The URI password.
+ * @since 11.1
*/
public function setPass($pass)
{
@@ -559,8 +559,8 @@
* Get URI host
* Returns the hostname/ip or null if no hostname/ip was specified.
*
- * @return string The URI host.
- * @since 11.1
+ * @return string The URI host.
+ * @since 11.1
*/
public function getHost()
{
@@ -570,8 +570,8 @@
/**
* Set URI host.
*
- * @param string $host The URI host.
- * @since 11.1
+ * @param string $host The URI host.
+ * @since 11.1
*/
public function setHost($host)
{
@@ -582,7 +582,7 @@
* Get URI port
* Returns the port number, or null if no port was specified.
*
- * @return integer The URI port number.
+ * @return integer The URI port number.
*/
public function getPort()
{
@@ -592,8 +592,8 @@
/**
* Set URI port.
*
- * @param integer $port The URI port number.
- * @since 11.1
+ * @param integer $port The URI port number.
+ * @since 11.1
*/
public function setPort($port)
{
@@ -603,8 +603,8 @@
/**
* Gets the URI path string.
*
- * @return string The URI path string.
- * @since 11.1
+ * @return string The URI path string.
+ * @since 11.1
*/
public function getPath()
{
@@ -614,8 +614,8 @@
/**
* Set the URI path string.
*
- * @param string $path The URI path string.
- * @since 11.1
+ * @param string $path The URI path string.
+ * @since 11.1
*/
public function setPath($path)
{
@@ -626,8 +626,8 @@
* Get the URI archor string
* Everything after the "#".
*
- * @return string The URI anchor string.
- * @since 11.1
+ * @return string The URI anchor string.
+ * @since 11.1
*/
public function getFragment()
{
@@ -638,8 +638,8 @@
* Set the URI anchor string
* everything after the "#".
*
- * @param string $anchor The URI anchor string.
- * @since 11.1
+ * @param string $anchor The URI anchor string.
+ * @since 11.1
*/
public function setFragment($anchor)
{
@@ -649,8 +649,8 @@
/**
* Checks whether the current URI is using HTTPS.
*
- * @return boolean True if using SSL via HTTPS.
- * @since 11.1
+ * @return boolean True if using SSL via HTTPS.
+ * @since 11.1
*/
public function isSSL()
{
@@ -660,9 +660,9 @@
/**
* Checks if the supplied URL is internal
*
- * @param string $url The URL to check.
- * @return boolean True if Internal.
- * @since 11.1
+ * @param string $url The URL to check.
+ * @return boolean True if Internal.
+ * @since 11.1
*/
public static function isInternal($url)
{
Modified: development/branches/platform/libraries/joomla/error/error.php
===================================================================
--- development/branches/platform/libraries/joomla/error/error.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/error/error.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -60,10 +60,10 @@
* Method to determine if a value is an exception object. This check supports
* both JException and PHP5 Exception objects
*
- * @param mixed &$object Object to check
- *
- * @return boolean True if argument is an exception, false otherwise.
- * @since 11.1
+ * @param mixed &$object Object to check
+ *
+ * @return boolean True if argument is an exception, false otherwise.
+ * @since 11.1
*/
public static function isError(& $object)
{
@@ -75,8 +75,8 @@
* Method for retrieving the last exception object in the error stack
* @params boolean $unset
*
- * @return mixed Last exception object in the error stack or boolean false if none exist
- * @since 11.1
+ * @return mixed Last exception object in the error stack or boolean false if none exist
+ * @since 11.1
*/
public static function getError($unset = false)
{
@@ -96,8 +96,8 @@
/**
* Method for retrieving the exception stack
*
- * @return array Chronological array of errors that have been stored during script execution
- * @since 11.1
+ * @return array Chronological array of errors that have been stored during script execution
+ * @since 11.1
*/
public static function getErrors()
{
@@ -107,10 +107,10 @@
/**
* Method to add non-JError thrown JExceptions to the JError stack for debugging purposes
*
- * @param object JException
+ * @param object JException
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function addToStack(JException &$e) {
JError::$stack[] = &$e;
@@ -119,14 +119,14 @@
/**
* Create a new JException object given the passed arguments
*
- * @param integer $level The error level - use any of PHP's own error levels for this: E_ERROR, E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE.
- * @param string $code The application-internal error code for this error
- * @param string $msg The error message, which may also be shown the user if need be.
- * @param mixed $info Optional: Additional error information (usually only developer-relevant information that the user should never see, like a database DSN).
- * @param boolean $backtrace
+ * @param integer $level The error level - use any of PHP's own error levels for this: E_ERROR, E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE.
+ * @param string $code The application-internal error code for this error
+ * @param string $msg The error message, which may also be shown the user if need be.
+ * @param mixed $info Optional: Additional error information (usually only developer-relevant information that the user should never see, like a database DSN).
+ * @param boolean $backtrace
*
- * @return mixed The JException object
- * @since 11.1
+ * @return mixed The JException object
+ * @since 11.1
*
* @see JException
*/
@@ -141,12 +141,12 @@
/**
* Throw an error
- *
- * @param oject &$exception
- *
- * @return reference
- * @since 11.1
*
+ * @param oject &$exception
+ *
+ * @return reference
+ * @since 11.1
+ *
* @see JException
*/
public static function throwError(&$exception)
@@ -188,14 +188,14 @@
/**
* Wrapper method for the raise() method with predefined error level of E_ERROR and backtrace set to true.
*
- * @param string $code The application-internal error code for this error
- * @param string $msg The error message, which may also be shown the user if need be.
- * @param mixed $info Optional: Additional error information (usually only developer-relevant information that
+ * @param string $code The application-internal error code for this error
+ * @param string $msg The error message, which may also be shown the user if need be.
+ * @param mixed $info Optional: Additional error information (usually only developer-relevant information that
* the user should never see, like a database DSN).
* @see raise()
*
- * @return object $error The configured JError object
- * @since 11.1
+ * @return object $error The configured JError object
+ * @since 11.1
*/
public static function raiseError($code, $msg, $info = null)
{
@@ -205,13 +205,13 @@
/**
* Wrapper method for the {@link raise()} method with predefined error level of E_WARNING and backtrace set to false.
*
- * @param string $code The application-internal error code for this error
- * @param string $msg The error message, which may also be shown the user if need be.
- * @param mixed $info Optional: Additional error information (usually only developer-relevant information that
+ * @param string $code The application-internal error code for this error
+ * @param string $msg The error message, which may also be shown the user if need be.
+ * @param mixed $info Optional: Additional error information (usually only developer-relevant information that
* the user should never see, like a database DSN).
*
- * @return object $error The configured JError object
- * @since 11.1
+ * @return object $error The configured JError object
+ * @since 11.1
*/
public static function raiseWarning($code, $msg, $info = null)
{
@@ -221,15 +221,15 @@
/**
* Wrapper method for the {@link raise()} method with predefined error level of E_NOTICE and backtrace set to false.
*
- * @param string $code The application-internal error code for this error
- * @param string $msg The error message, which may also be shown the user if need be.
- * @param mixed $info Optional: Additional error information (usually only developer-relevant information
+ * @param string $code The application-internal error code for this error
+ * @param string $msg The error message, which may also be shown the user if need be.
+ * @param mixed $info Optional: Additional error information (usually only developer-relevant information
* that the user should never see, like a database DSN).
*
* @see raise()
*
- * @return object $error The configured JError object
- * @since 11.1
+ * @return object $error The configured JError object
+ * @since 11.1
*/
public static function raiseNotice($code, $msg, $info = null)
{
@@ -239,10 +239,10 @@
/**
* Method to get the current error handler settings for a specified error level.
*
- * @param integer $level The error level to retrieve. This can be any of PHP's own error levels, e.g. E_ALL, E_NOTICE...
+ * @param integer $level The error level to retrieve. This can be any of PHP's own error levels, e.g. E_ALL, E_NOTICE...
*
- * @return array All error handling details
- * @since 11.1
+ * @return array All error handling details
+ * @since 11.1
*/
public static function getErrorHandling($level)
{
@@ -267,12 +267,12 @@
* - E_ERROR | E_WARNING = Set the handling for errors and warnings
* - E_ALL ^ E_ERROR = Set the handling for all levels except errors
*
- * @param integer $level The error level for which to set the error handling
- * @param string $mode The mode to use for the error handling.
- * @param mixed $options Optional: Any options needed for the given mode.
+ * @param integer $level The error level for which to set the error handling
+ * @param string $mode The mode to use for the error handling.
+ * @param mixed $options Optional: Any options needed for the given mode.
*
- * @return mixed True on success or a JException object if failed.
- * @since 11.1
+ * @return mixed True on success or a JException object if failed.
+ * @since 11.1
*/
public static function setErrorHandling($level, $mode, $options = null)
{
@@ -324,8 +324,8 @@
* Method that attaches the error handler to JError
*
* @see set_error_handler
- *
- * @return
+ *
+ * @return
* @since 11.1
*/
public static function attachHandler()
@@ -337,8 +337,8 @@
* Method that detaches the error handler from JError
*
* @see restore_error_handler
- *
- * @return
+ *
+ * @return
* @since 11.1
*/
public static function detachHandler()
@@ -354,12 +354,12 @@
* - E_WARNING
* - E_NOTICE
*
- * @param integer $level Error level to register
- * @param string $name Human readable name for the error level
- * @param string $handler Error handler to set for the new error level [optional]
+ * @param integer $level Error level to register
+ * @param string $name Human readable name for the error level
+ * @param string $handler Error handler to set for the new error level [optional]
*
- * @return boolean True on success; false if the level already has been registered
- * @since 11.1
+ * @return boolean True on success; false if the level already has been registered
+ * @since 11.1
*/
public static function registerErrorLevel($level, $name, $handler = 'ignore')
{
@@ -377,10 +377,10 @@
* Translate an error level integer to a human readable string
* e.g. E_ERROR will be translated to 'Error'
*
- * @param integer $level Error level to translate
+ * @param integer $level Error level to translate
*
- * @return mixed Human readable error level name or boolean false if it doesn't exist
- * @since 11.1
+ * @return mixed Human readable error level name or boolean false if it doesn't exist
+ * @since 11.1
*/
public static function translateErrorLevel($level)
{
@@ -395,13 +395,13 @@
* Ignore error handler
* - Ignores the error
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
*
* @see raise()
*
- * @return object The exception object
- * @since 11.1
+ * @return object The exception object
+ * @since 11.1
*/
public static function handleIgnore(&$error, $options)
{
@@ -412,13 +412,13 @@
* Echo error handler
* - Echos the error message to output
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
- *
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
+ *
* @see raise()
- *
- * @return object The exception object
- * @since 11.1
+ *
+ * @return object The exception object
+ * @since 11.1
*/
public static function handleEcho(&$error, $options)
{
@@ -445,11 +445,11 @@
* Verbose error handler
* - Echos the error message to output as well as related info
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
*
- * @return object The exception object
- * @since 11.1
+ * @return object The exception object
+ * @since 11.1
*
* @see raise()
*/
@@ -484,12 +484,12 @@
* Die error handler
* - Echos the error message to output and then dies
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
- *
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
+ *
* @see raise()
- *
- * @return object The exception object
+ *
+ * @return object The exception object
*/
public static function handleDie(& $error, $options)
{
@@ -517,11 +517,11 @@
* Message error handler
* Enqueues the error message into the system queue
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
*
- * @return object The exception object
- * @since 11.1
+ * @return object The exception object
+ * @since 11.1
*
* @see raise()
*/
@@ -538,11 +538,11 @@
* Log error handler
* Logs the error message to a system log file
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
*
- * @return object The exception object
- * @since 11.1
+ * @return object The exception object
+ * @since 11.1
*
* @see raise()
*/
@@ -569,11 +569,11 @@
* Callback error handler
* - Send the error object to a callback method for error handling
*
- * @param object $error Exception object to handle
- * @param array $options Handler options
+ * @param object $error Exception object to handle
+ * @param array $options Handler options
*
- * @return object The exception object
- * @since 11.1
+ * @return object The exception object
+ * @since 11.1
*
* @see raise()
*/
@@ -585,10 +585,10 @@
/**
* Display a custom error page and exit gracefully
*
- * @param object $error Exception object
- *
- * @return void
- * @since 11.1
+ * @param object $error Exception object
+ *
+ * @return void
+ * @since 11.1
*/
public static function customErrorPage(& $error)
{
@@ -623,11 +623,11 @@
/**
* Display a custom error page and exit gracefully
*
- * @param integer $level The error level - use any of PHP's own error levels for this: E_ERROR, E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE.
- * @param string $msg Error message, shown to user if need be.
- *
- * @return void
- * @since 11.1
+ * @param integer $level The error level - use any of PHP's own error levels for this: E_ERROR, E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE.
+ * @param string $msg Error message, shown to user if need be.
+ *
+ * @return void
+ * @since 11.1
*/
public static function customErrorHandler($level, $msg)
{
@@ -637,10 +637,10 @@
/**
* Render the backtrace
*
- * @param integer $error The error
- *
- * @return string Contents of the backtrace
- * @since 11.1
+ * @param integer $error The error
+ *
+ * @return string Contents of the backtrace
+ * @since 11.1
*/
public static function renderBacktrace($error)
{
Modified: development/branches/platform/libraries/joomla/error/exception.php
===================================================================
--- development/branches/platform/libraries/joomla/error/exception.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/error/exception.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -101,13 +101,13 @@
* - used to set up the error with all needed error details.
*
* @access protected
- * @param string $msg The error message
- * @param string $code The error code from the application
- * @param integer $level The error level (use the PHP constants E_ALL, E_NOTICE etc.).
- * @param string $info Optional: The additional error information.
- * @param boolean $backtrace True if backtrace information is to be collected
- *
- * @since 11.1
+ * @param string $msg The error message
+ * @param string $code The error code from the application
+ * @param integer $level The error level (use the PHP constants E_ALL, E_NOTICE etc.).
+ * @param string $info Optional: The additional error information.
+ * @param boolean $backtrace True if backtrace information is to be collected
+ *
+ * @since 11.1
*/
public function __construct($msg, $code = 0, $level = null, $info = null, $backtrace = false)
{
@@ -159,8 +159,8 @@
/**
* Returns to error message
*
- * @return string Error message
- * @since 11.1
+ * @return string Error message
+ * @since 11.1
*/
public function __toString()
{
@@ -170,8 +170,8 @@
/**
* Returns to error message
*
- * @return string Error message
- * @since 11.1
+ * @return string Error message
+ * @since 11.1
* @deprecated
*/
public function toString()
@@ -182,13 +182,13 @@
/**
* Returns a property of the object or the default value if the property is not set.
*
- * @param string $property The name of the property
- * @param mixed $default The default value
- *
+ * @param string $property The name of the property
+ * @param mixed $default The default value
+ *
* @see getProperties()
- *
- * @return mixed The value of the property or null
- * @since 11.1
+ *
+ * @return mixed The value of the property or null
+ * @since 11.1
*/
public function get($property, $default=null)
{
@@ -201,11 +201,11 @@
/**
* Returns an associative array of object properties
*
- * @param boolean $public If true, returns only the public properties
+ * @param boolean $public If true, returns only the public properties
* @see get()
- *
- * @return array Object properties
- * @since 11.1
+ *
+ * @return array Object properties
+ * @since 11.1
*/
public function getProperties($public = true)
{
@@ -225,11 +225,11 @@
/**
* Get the most recent error message
*
- * @param integer $i Option error index
- * @param boolean $toString Indicates if JError objects should return their error message
+ * @param integer $i Option error index
+ * @param boolean $toString Indicates if JError objects should return their error message
*
- * @return string Error message
- * @since 11.1
+ * @return string Error message
+ * @since 11.1
*/
public function getError($i = null, $toString = true)
{
@@ -258,8 +258,8 @@
/**
* Return all errors, if any
*
- * @return array Array of error messages or JErrors
- * @since 11.1
+ * @return array Array of error messages or JErrors
+ * @since 11.1
*/
public function getErrors()
{
@@ -270,13 +270,13 @@
/**
* Modifies a property of the object, creating it if it does not already exist.
*
- * @param string $property The name of the property
- * @param mixed $value The value of the property to set
- *
+ * @param string $property The name of the property
+ * @param mixed $value The value of the property to set
+ *
* @see setProperties()
- *
- * @return mixed Previous value of the property
- * @since 11.1
+ *
+ * @return mixed Previous value of the property
+ * @since 11.1
*/
public function set($property, $value = null)
{
@@ -289,11 +289,11 @@
* Set the object properties based on a named array/hash
*
* @access protected
- * @param $array mixed Either and associative array or another object
+ * @param $array mixed Either and associative array or another object
* @see set()
- *
- * @return boolean
- * @since 11.1
+ *
+ * @return boolean
+ * @since 11.1
*/
public function setProperties($properties)
{
@@ -315,10 +315,10 @@
/**
* Add an error message
*
- * @param string $error Error message
- *
- * @return void
- * @since 11.1
+ * @param string $error Error message
+ *
+ * @return void
+ * @since 11.1
*/
public function setError($error)
{
Modified: development/branches/platform/libraries/joomla/error/profiler.php
===================================================================
--- development/branches/platform/libraries/joomla/error/profiler.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/error/profiler.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* The start time.
*
- * @var integer
+ * @var integer
* @since 11.1
*/
protected $_start = 0;
@@ -37,7 +37,7 @@
/**
* The buffer of profiling messages.
*
- * @var array
+ * @var array
* @since 11.1
*/
protected $_buffer= null;
@@ -65,7 +65,7 @@
/**
* Constructor
*
- * @param string Prefix for mark messages
+ * @param string Prefix for mark messages
*/
public function __construct($prefix = '')
{
@@ -79,10 +79,10 @@
* Returns the global Profiler object, only creating it
* if it doesn't already exist.
*
- * @param string Prefix used to distinguish profiler objects.
- *
- * @return object JProfiler The Profiler object.
- * @since 11.1
+ * @param string Prefix used to distinguish profiler objects.
+ *
+ * @return object JProfiler The Profiler object.
+ * @since 11.1
*/
public static function getInstance($prefix = '')
{
@@ -105,10 +105,10 @@
* The mark is returned as text enclosed in <div> tags
* with a CSS class of 'profiler'.
*
- * @param string $label A label for the time mark
- *
- * @return string Mark enclosed in <div> tags
- * @since 11.1
+ * @param string $label A label for the time mark
+ *
+ * @return string Mark enclosed in <div> tags
+ * @since 11.1
*/
public function mark($label)
{
@@ -159,8 +159,8 @@
* Get information about current memory usage.
*
* @link PHP_MANUAL#memory_get_usage
- *
- * @return integer The memory usage
+ *
+ * @return integer The memory usage
* @since 11.1
*/
public function getMemory()
@@ -194,7 +194,7 @@
* Returns an array of all marks created since the Profiler object
* was instantiated. Marks are strings as per {@link JProfiler::mark()}.
*
- * @return array Array of profiler marks
+ * @return array Array of profiler marks
*/
public function getBuffer()
{
Modified: development/branches/platform/libraries/joomla/event/dispatcher.php
===================================================================
--- development/branches/platform/libraries/joomla/event/dispatcher.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/event/dispatcher.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -20,7 +20,7 @@
* @package Joomla.Platform
* @subpackage Event
* @since 11.1
- *
+ *
* @see JPlugin
* @link http://docs.joomla.org/Tutorial:Plugins Plugin tutorials
*/
@@ -30,8 +30,8 @@
* Returns the global Event Dispatcher object, only creating it
* if it doesn't already exist.
*
- * @return object JDispatcher The EventDispatcher object.
- * @since 11.1
+ * @return object JDispatcher The EventDispatcher object.
+ * @since 11.1
*/
public static function getInstance()
{
@@ -47,11 +47,11 @@
/**
* Registers an event handler to the event dispatcher
*
- * @param string $event Name of the event to register handler for
- * @param string $handler Name of the event handler
- *
- * @return void
- * @since 11.1
+ * @param string $event Name of the event to register handler for
+ * @param string $handler Name of the event handler
+ *
+ * @return void
+ * @since 11.1
*/
public function register($event, $handler)
{
@@ -77,11 +77,11 @@
* Triggers an event by dispatching arguments to all observers that handle
* the event and returning their return values.
*
- * @param string $event The event to trigger.
- * @param array $args An array of arguments.
- *
- * @return array An array of results from each function call.
- * @since 11.1
+ * @param string $event The event to trigger.
+ * @param array $args An array of arguments.
+ *
+ * @return array An array of results from each function call.
+ * @since 11.1
*/
public function trigger($event, $args = array())
{
Modified: development/branches/platform/libraries/joomla/event/event.php
===================================================================
--- development/branches/platform/libraries/joomla/event/event.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/event/event.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,14 +23,14 @@
/**
* Method to trigger events.
* The method first generates the even from the argument array. Then it unsets the argument
- * since the argument has no bearing on the event handler.
- * If the method exists it is called and returns its return value. If it does not exist it
+ * since the argument has no bearing on the event handler.
+ * If the method exists it is called and returns its return value. If it does not exist it
* returns null.
*
- * @param array &$args Arguments
- *
- * @return mixed Routine return value
- * @since 11.1
+ * @param array &$args Arguments
+ *
+ * @return mixed Routine return value
+ * @since 11.1
*/
public function update(&$args)
{
@@ -45,10 +45,10 @@
*/
if (method_exists($this, $event)) {
return call_user_func_array(array($this, $event), $args);
-
+
} else {
return null;
-
+
}
}
}
\ No newline at end of file
Modified: development/branches/platform/libraries/joomla/factory.php
===================================================================
--- development/branches/platform/libraries/joomla/factory.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/factory.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,10 +32,10 @@
* Returns the global {@link JApplication} object, only creating it
* if it doesn't already exist.
*
- * @param mixed $id A client identifier or name.
- * @param array $config An optional associative array of configuration settings.
- * @param string $prefix application prefix
- *
+ * @param mixed $id A client identifier or name.
+ * @param array $config An optional associative array of configuration settings.
+ * @param string $prefix application prefix
+ *
* @see JApplication
*
* @return JApplication object
@@ -87,8 +87,8 @@
* Returns the global {@link JSession} object, only creating it
* if it doesn't already exist.
*
- * @param array $options An array containing session options
- *
+ * @param array $options An array containing session options
+ *
* @see JSession
*
* @return JSession object
@@ -144,7 +144,7 @@
* Returns the global {@link JUser} object, only creating it
* if it doesn't already exist.
*
- * @param integer $id The user to load - Can be an integer or string - If string, it is converted to ID automatically.
+ * @param integer $id The user to load - Can be an integer or string - If string, it is converted to ID automatically.
*
* @see JUser
* @return JUser object
@@ -171,10 +171,10 @@
*
* Returns the global {@link JCache} object
*
- * @param string $group The cache group name
- * @param string $handler The handler to use
- * @param string $storage The storage method
- *
+ * @param string $group The cache group name
+ * @param string $handler The handler to use
+ * @param string $storage The storage method
+ *
* @see JCache
*
* @return JCache object
@@ -267,10 +267,10 @@
/**
* Get a parsed XML Feed Source
*
- * @param string $url url for feed source
- * @param integer $cache_time time to cache feed for (using internal cache mechanism)
+ * @param string $url url for feed source
+ * @param integer $cache_time time to cache feed for (using internal cache mechanism)
*
- * @return mixed SimplePie parsed object on success, false on failure
+ * @return mixed SimplePie parsed object on success, false on failure
* @since 11.1
*/
public static function getFeedParser($url, $cache_time = 0)
@@ -304,10 +304,10 @@
/**
* Get an XML document
*
- * @param string $type The type of XML parser needed 'DOM', 'RSS' or 'Simple'
- * @param array $options ['rssUrl'] the rss url to parse when using "RSS", ['cache_time'] with 'RSS' - feed cache time. If not defined defaults to 3600 sec
+ * @param string $type The type of XML parser needed 'DOM', 'RSS' or 'Simple'
+ * @param array $options ['rssUrl'] the rss url to parse when using "RSS", ['cache_time'] with 'RSS' - feed cache time. If not defined defaults to 3600 sec
*
- * @return object Parsed XML document object
+ * @return object Parsed XML document object
* @deprecated
*/
public static function getXMLParser($type = '', $options = array())
@@ -343,10 +343,10 @@
/**
* Reads a XML file.
*
- * @param string $data Full path and file name.
- * @param boolean $isFile true to load a file | false to load a string.
+ * @param string $data Full path and file name.
+ * @param boolean $isFile true to load a file | false to load a string.
*
- * @return mixed JXMLElement on success | false on error.
+ * @return mixed JXMLElement on success | false on error.
* @todo This may go in a separate class - error reporting may be improved.
*/
public static function getXML($data, $isFile = true)
@@ -385,7 +385,7 @@
/**
* Get an editor object
*
- * @param string $editor The editor to load, depends on the editor plugins that are installed
+ * @param string $editor The editor to load, depends on the editor plugins that are installed
*
* @return JEditor object
*/
@@ -405,8 +405,8 @@
/**
* Return a reference to the {@link JURI} object
*
- * @param string $uri uri name
- *
+ * @param string $uri uri name
+ *
* @see JURI
*
* @return JURI object
@@ -422,9 +422,9 @@
/**
* Return the {@link JDate} object
*
- * @param mixed $time The initial time for the JDate object
- * @param mixed $tzOffset The timezone offset.
- *
+ * @param mixed $time The initial time for the JDate object
+ * @param mixed $tzOffset The timezone offset.
+ *
* @see JDate
*
* @return JDate object
@@ -520,7 +520,7 @@
/**
* Create a session object
*
- * @param array $options An array containing session options
+ * @param array $options An array containing session options
*
* @return JSession object
* @since 11.1
@@ -685,15 +685,15 @@
/**
* Creates a new stream object with appropriate prefix
*
- * @param boolean $use_prefix Prefix the connections for writing
- * @param boolean $use_network Use network if available for writing; use false to disable (e.g. FTP, SCP)
- * @param string $ua UA User agent to use
- * @param boolean $uamask User agent masking (prefix Mozilla)
+ * @param boolean $use_prefix Prefix the connections for writing
+ * @param boolean $use_network Use network if available for writing; use false to disable (e.g. FTP, SCP)
+ * @param string $ua UA User agent to use
+ * @param boolean $uamask User agent masking (prefix Mozilla)
*
* @see JStream
*
- * @return JStream
- * @since 11.1
+ * @return JStream
+ * @since 11.1
*/
public static function getStream($use_prefix=true, $use_network=true,$ua=null, $uamask=false)
{
Modified: development/branches/platform/libraries/joomla/filesystem/archive/bzip2.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/archive/bzip2.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/archive/bzip2.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,8 +29,8 @@
/**
* Constructor tries to load the bz2 extension if not loaded
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function __construct()
{
@@ -48,12 +48,12 @@
/**
* Extract a Bzip2 compressed file to a given path
*
- * @param string $archive Path to Bzip2 archive to extract
- * @param string $destination Path to extract archive to
- * @param array $options Extraction options [unused]
+ * @param string $archive Path to Bzip2 archive to extract
+ * @param string $destination Path to extract archive to
+ * @param array $options Extraction options [unused]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
public function extract($archive, $destination, $options = array ())
{
Modified: development/branches/platform/libraries/joomla/filesystem/archive/gzip.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/archive/gzip.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/archive/gzip.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -45,12 +45,12 @@
/**
* Extract a Gzip compressed file to a given path
*
- * @param string $archive Path to ZIP archive to extract
- * @param string $destination Path to extract archive to
- * @param array $options Extraction options [unused]
+ * @param string $archive Path to ZIP archive to extract
+ * @param string $destination Path to extract archive to
+ * @param array $options Extraction options [unused]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
public function extract($archive, $destination, $options = array ())
{
@@ -126,8 +126,8 @@
/**
* Get file data offset for archive
*
- * @return integer Data position marker for archive
- * @since 11.1
+ * @return integer Data position marker for archive
+ * @since 11.1
*/
function _getFilePosition()
{
Modified: development/branches/platform/libraries/joomla/filesystem/archive/tar.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/archive/tar.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/archive/tar.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -67,12 +67,12 @@
/**
* Extract a ZIP compressed file to a given path
*
- * @param string $archive Path to ZIP archive to extract
- * @param string $destination Path to extract archive into
- * @param array $options Extraction options [unused]
+ * @param string $archive Path to ZIP archive to extract
+ * @param string $destination Path to extract archive into
+ * @param array $options Extraction options [unused]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
public function extract($archive, $destination, $options = array ())
{
Modified: development/branches/platform/libraries/joomla/filesystem/archive/zip.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/archive/zip.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/archive/zip.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -83,12 +83,12 @@
/**
* Create a ZIP compressed file from an array of file data.
*
- * @param string $archive Path to save archive.
- * @param array $files Array of files to add to archive.
- * @param array $options Compression options (unused).
+ * @param string $archive Path to save archive.
+ * @param array $files Array of files to add to archive.
+ * @param array $options Compression options (unused).
*
- * @return boolean True if successful.
- * @since 11.1
+ * @return boolean True if successful.
+ * @since 11.1
* @todo Finish Implementation
*/
public function create($archive, $files, $options = array ())
@@ -108,12 +108,12 @@
/**
* Extract a ZIP compressed file to a given path
*
- * @param string $archive Path to ZIP archive to extract
- * @param string $destination Path to extract archive into
- * @param array $options Extraction options [unused]
+ * @param string $archive Path to ZIP archive to extract
+ * @param string $destination Path to extract archive into
+ * @param array $options Extraction options [unused]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
public function extract($archive, $destination, $options = array ())
{
@@ -134,8 +134,8 @@
/**
* Method to determine if the server has native zip support for faster handling
*
- * @return boolean True if php has native ZIP support
- * @since 11.1
+ * @return boolean True if php has native ZIP support
+ * @since 11.1
*/
public function hasNativeSupport()
{
@@ -145,10 +145,10 @@
/**
* Checks to see if the data is a valid ZIP file.
*
- * @param string &$data ZIP archive data buffer.
+ * @param string &$data ZIP archive data buffer.
*
- * @return boolean True if valid, false if invalid.
- * @since 11.1
+ * @return boolean True if valid, false if invalid.
+ * @since 11.1
*/
public function checkZipData(&$data)
{
@@ -163,12 +163,12 @@
/**
* Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support
*
- * @param string $archive Path to ZIP archive to extract.
- * @param string $destination Path to extract archive into.
- * @param array $options Extraction options [unused].
+ * @param string $archive Path to ZIP archive to extract.
+ * @param string $destination Path to extract archive into.
+ * @param array $options Extraction options [unused].
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
protected function _extract($archive, $destination, $options)
{
@@ -223,12 +223,12 @@
/**
* Extract a ZIP compressed file to a given path using native php api calls for speed
*
- * @param string $archive Path to ZIP archive to extract
- * @param string $destination Path to extract archive into
- * @param array $options Extraction options [unused]
+ * @param string $archive Path to ZIP archive to extract
+ * @param string $destination Path to extract archive into
+ * @param array $options Extraction options [unused]
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
protected function _extractNative($archive, $destination, $options)
{
@@ -289,10 +289,10 @@
* 'type' -- File type
* </pre>
*
- * @param string &$data The ZIP archive buffer.
+ * @param string &$data The ZIP archive buffer.
*
- * @return array Archive metadata array.
- * @since 11.1
+ * @return array Archive metadata array.
+ * @since 11.1
*/
protected function _getZipInfo(&$data)
{
@@ -372,10 +372,10 @@
/**
* Returns the file data for a file by offsest in the ZIP archive
*
- * @param integer $key The position of the file in the archive.
+ * @param integer $key The position of the file in the archive.
*
- * @return string Uncompressed file data buffer.
- * @since 11.1
+ * @return string Uncompressed file data buffer.
+ * @since 11.1
*/
protected function _getFileData($key)
{
@@ -413,8 +413,8 @@
*
* @param integer $unixtime The current UNIX timestamp.
*
- * @return integer The current date in a 4-byte DOS format.
- * @since 11.1
+ * @return integer The current date in a 4-byte DOS format.
+ * @since 11.1
*/
protected function _unix2DOSTime($unixtime = null)
{
@@ -435,12 +435,12 @@
/**
* Adds a "file" to the ZIP archive.
*
- * @param array &$file File data array to add
- * @param array &$contents An array of existing zipped files.
- * @param array &$ctrldir An array of central directory information.
+ * @param array &$file File data array to add
+ * @param array &$contents An array of existing zipped files.
+ * @param array &$ctrldir An array of central directory information.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
* @todo Review and finish implementation
*/
protected function _addToZIPFile(&$file, &$contents, &$ctrldir)
@@ -544,12 +544,12 @@
*
* Official ZIP file format: http://www.pkware.com/appnote.txt
*
- * @param array &$contents An array of existing zipped files.
- * @param array &$ctrlDir An array of central directory information.
- * @param string $path The path to store the archive.
+ * @param array &$contents An array of existing zipped files.
+ * @param array &$ctrlDir An array of central directory information.
+ * @param string $path The path to store the archive.
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
* @todo Review and finish implementation
*/
protected function _createZIPFile(&$contents, &$ctrlDir, $path)
Modified: development/branches/platform/libraries/joomla/filesystem/archive.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/archive.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/archive.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,11 +22,11 @@
/**
* Extract an archive file to a directory.
*
- * @param string $archivename The name of the archive file
- * @param string $extractdir Directory to unpack into
+ * @param string $archivename The name of the archive file
+ * @param string $extractdir Directory to unpack into
*
- * @return boolean True for success
- * @since 11.1
+ * @return boolean True for success
+ * @since 11.1
*/
public static function extract($archivename, $extractdir)
{
@@ -158,10 +158,10 @@
/**
* Get a file compression adapter.
*
- * @param string $type The type of adapter (bzip2|gzip|tar|zip).
+ * @param string $type The type of adapter (bzip2|gzip|tar|zip).
*
- * @return object JObject
- * @since 11.1
+ * @return object JObject
+ * @since 11.1
*/
public static function getAdapter($type)
{
Modified: development/branches/platform/libraries/joomla/filesystem/file.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/file.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/file.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,9 +23,9 @@
/**
* Gets the extension of a file name
*
- * @param string $file The file name
+ * @param string $file The file name
*
- * @return string The file extension
+ * @return string The file extension
* @since 11.1
*/
public static function getExt($file)
@@ -38,9 +38,9 @@
/**
* Strips the last extension off of a file name
*
- * @param string $file The file name
+ * @param string $file The file name
*
- * @return string The file name without the extension
+ * @return string The file name without the extension
* @since 11.1
*/
public static function stripExt($file)
@@ -51,10 +51,10 @@
/**
* Makes file name safe to use
*
- * @param string $file The name of the file [not full path]
+ * @param string $file The name of the file [not full path]
*
- * @return string The sanitised string
- * @since 11.1
+ * @return string The sanitised string
+ * @since 11.1
*/
public static function makeSafe($file)
{
@@ -66,12 +66,12 @@
/**
* Copies a file
*
- * @param string $src The path to the source file
- * @param string $dest The path to the destination file
- * @param string $path An optional base path to prefix to the file names
+ * @param string $src The path to the source file
+ * @param string $dest The path to the destination file
+ * @param string $path An optional base path to prefix to the file names
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public static function copy($src, $dest, $path = null, $use_streams=false)
{
@@ -138,10 +138,10 @@
/**
* Delete a file or array of files
*
- * @param mixed $file The file name or an array of file names
+ * @param mixed $file The file name or an array of file names
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public static function delete($file)
{
@@ -194,12 +194,12 @@
/**
* Moves a file
*
- * @param string $src The path to the source file
- * @param string $dest The path to the destination file
- * @param string $path An optional base path to prefix to the file names
+ * @param string $src The path to the source file
+ * @param string $dest The path to the destination file
+ * @param string $path An optional base path to prefix to the file names
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public static function move($src, $dest, $path = '', $use_streams=false)
{
@@ -259,14 +259,14 @@
/**
* Read the contents of a file
*
- * @param string $filename The full file path
- * @param boolean $incpath Use include path
- * @param integer $amount Amount of file to read
- * @param integer $chunksize Size of chunks to read
- * @param integer $offset Offset of the file
+ * @param string $filename The full file path
+ * @param boolean $incpath Use include path
+ * @param integer $amount Amount of file to read
+ * @param integer $chunksize Size of chunks to read
+ * @param integer $offset Offset of the file
*
- * @return mixed Returns file contents or boolean False if failed
- * @since 11.1
+ * @return mixed Returns file contents or boolean False if failed
+ * @since 11.1
*/
public static function read($filename, $incpath = false, $amount = 0, $chunksize = 8192, $offset = 0)
{
@@ -313,11 +313,11 @@
/**
* Write contents to a file
*
- * @param string $file The full file path
- * @param string $buffer The buffer to write
+ * @param string $file The full file path
+ * @param string $buffer The buffer to write
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public static function write($file, &$buffer, $use_streams=false)
{
@@ -364,10 +364,10 @@
/**
* Moves an uploaded file to a destination folder
*
- * @param string $src The name of the php (temporary) uploaded file
- * @param string $dest The path (including filename) to move the uploaded file to
+ * @param string $src The name of the php (temporary) uploaded file
+ * @param string $dest The path (including filename) to move the uploaded file to
*
- * @return boolean True on success
+ * @return boolean True on success
* @since 11.1
*/
public static function upload($src, $dest, $use_streams=false)
@@ -432,10 +432,10 @@
/**
* Wrapper for the standard file_exists function
*
- * @param string $file File path
+ * @param string $file File path
*
- * @return boolean True if path is a file
- * @since 11.1
+ * @return boolean True if path is a file
+ * @since 11.1
*/
public static function exists($file)
{
@@ -445,10 +445,10 @@
/**
* Returns the name, without any path.
*
- * @param string $file File path
- *
- * @return string filename
- * @since 11.1
+ * @param string $file File path
+ *
+ * @return string filename
+ * @since 11.1
*/
public static function getName($file)
{
Modified: development/branches/platform/libraries/joomla/filesystem/folder.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/folder.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/folder.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,13 +24,13 @@
/**
* Copy a folder.
*
- * @param string $src The path to the source folder.
- * @param string $dest The path to the destination folder.
- * @param string $path An optional base path to prefix to the file names.
- * @param boolean $use_streams Optionally force folder/file overwrites.
- *
- * @return mixed JError object on failure or boolean True on success.
- * @since 11.1
+ * @param string $src The path to the source folder.
+ * @param string $dest The path to the destination folder.
+ * @param string $path An optional base path to prefix to the file names.
+ * @param boolean $use_streams Optionally force folder/file overwrites.
+ *
+ * @return mixed JError object on failure or boolean True on success.
+ * @since 11.1
*/
public static function copy($src, $dest, $path = '', $force = false, $use_streams=false)
{
@@ -117,7 +117,7 @@
{
$ret = self::copy($sfid, $dfid, null, $force, $use_streams);
if ($ret !== true) {
-
+
return $ret;
}
}
@@ -128,14 +128,14 @@
{
$stream = JFactory::getStream();
if(!$stream->copy($sfid, $dfid)) {
-
+
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_COPY_FAILED').': '. $stream->getError());
}
}
else
{
if (!@copy($sfid, $dfid)) {
-
+
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_COPY_FAILED'));
}
}
@@ -149,10 +149,10 @@
/**
* Create a folder -- and all necessary parent folders.
*
- * @param string $path A path to create from the base path.
- * @param integer $mode Directory permissions to set for folders created. 0755 by default.
- *
- * @return boolean True if successful.
+ * @param string $path A path to create from the base path.
+ * @param integer $mode Directory permissions to set for folders created. 0755 by default.
+ *
+ * @return boolean True if successful.
* @since 11.1
*/
public static function create($path = '', $mode = 0755)
@@ -275,9 +275,9 @@
/**
* Delete a folder.
*
- * @param string $path The path to the folder to delete.
- *
- * @return boolean True on success.
+ * @param string $path The path to the folder to delete.
+ *
+ * @return boolean True on success.
* @since 11.1
*/
public static function delete($path)
@@ -368,12 +368,12 @@
/**
* Moves a folder.
*
- * @param string $src The path to the source folder.
- * @param string $dest The path to the destination folder.
- * @param string $path An optional base path to prefix to the file names.
- * @param boolean $use_streams
- *
- * @return mixed Error message on false or boolean true on success.
+ * @param string $src The path to the source folder.
+ * @param string $dest The path to the destination folder.
+ * @param string $path An optional base path to prefix to the file names.
+ * @param boolean $use_streams
+ *
+ * @return mixed Error message on false or boolean true on success.
* @since 11.1
*/
public static function move($src, $dest, $path = '', $use_streams=false)
@@ -438,7 +438,7 @@
* Wrapper for the standard file_exists function
*
* @param string $path Folder name relative to installation dir
- *
+ *
* @return boolean True if path is a folder
* @since 11.1
*/
@@ -450,16 +450,16 @@
/**
* Utility function to read the files in a folder.
*
- * @param string The path of the folder to read.
- * @param string A filter for file names.
- * @param mixed True to recursively search into sub-folders, or an
+ * @param string The path of the folder to read.
+ * @param string A filter for file names.
+ * @param mixed True to recursively search into sub-folders, or an
* integer to specify the maximum depth.
- * @param boolean True to return the full path to the file.
- * @param array Array with names of files which should not be shown in
+ * @param boolean True to return the full path to the file.
+ * @param array Array with names of files which should not be shown in
* the result.
- * @param array Array of filter to exclude
- *
- * @return array Files in the given folder.
+ * @param array Array of filter to exclude
+ *
+ * @return array Files in the given folder.
* @since 11.1
*/
public static function files($path, $filter = '.', $recurse = false, $full = false, $exclude = array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter = array('^\..*','.*~'))
@@ -493,17 +493,17 @@
/**
* Utility function to read the folders in a folder.
*
- * @param string $path The path of the folder to read.
- * @param string $filter A filter for folder names.
- * @param mixed $recurse True to recursively search into sub-folders, or an
+ * @param string $path The path of the folder to read.
+ * @param string $filter A filter for folder names.
+ * @param mixed $recurse True to recursively search into sub-folders, or an
* integer to specify the maximum depth.
- * @param boolean $full True to return the full path to the folders.
- * @param array $exclude Array with names of folders which should not be shown in
+ * @param boolean $full True to return the full path to the folders.
+ * @param array $exclude Array with names of folders which should not be shown in
* the result.
- * @param array $excludefilter Array with regular expressions matching folders which
+ * @param array $excludefilter Array with regular expressions matching folders which
* should not be shown in the result.
- *
- * @return array Folders in the given folder.
+ *
+ * @return array Folders in the given folder.
* @since 11.1
*/
public static function folders($path, $filter = '.', $recurse = false, $full = false, $exclude = array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter = array('^\..*'))
@@ -537,17 +537,17 @@
/**
* Function to read the files/folders in a folder.
*
- * @param string $path The path of the folder to read.
- * @param string $filter A filter for file names.
- * @param mixed $recurse True to recursively search into sub-folders, or an
+ * @param string $path The path of the folder to read.
+ * @param string $filter A filter for file names.
+ * @param mixed $recurse True to recursively search into sub-folders, or an
* integer to specify the maximum depth.
- * @param boolean $full True to return the full path to the file.
- * @param array $exclude Array with names of files which should not be shown in
+ * @param boolean $full True to return the full path to the file.
+ * @param array $exclude Array with names of files which should not be shown in
* the result.
- * @param string $excludefilter_string Regexp of files to exclude
- * @param boolean $fndfiles True to read the files, false to read the folders
- *
- * @return array Files.
+ * @param string $excludefilter_string Regexp of files to exclude
+ * @param boolean $fndfiles True to read the files, false to read the folders
+ *
+ * @return array Files.
* @since 11.1
*/
protected static function _items($path, $filter, $recurse, $full, $exclude, $excludefilter_string, $findfiles)
@@ -599,15 +599,15 @@
/**
* Lists folder in format suitable for tree display.
*
- * @param string $path The path of the folder to read.
- * @param string $filter A filter for folder names.
- * @param integer $maxLevel The maximum number of levels to recursively read,
+ * @param string $path The path of the folder to read.
+ * @param string $filter A filter for folder names.
+ * @param integer $maxLevel The maximum number of levels to recursively read,
* defaults to three.
- * @param integer $level The current level, optional.
- * @param integer $parent Unique identifier of the parent folder, if any.
- *
- * @return array Folders in the given folder.
- * @since 11.1
+ * @param integer $level The current level, optional.
+ * @param integer $parent Unique identifier of the parent folder, if any.
+ *
+ * @return array Folders in the given folder.
+ * @since 11.1
*/
public static function listFolderTree($path, $filter, $maxLevel = 3, $level = 0, $parent = 0)
{
@@ -640,10 +640,10 @@
/**
* Makes path name safe to use.
*
- * @param string The full path to sanitise.
- *
- * @return string The sanitised string.
- * @since 11.1
+ * @param string The full path to sanitise.
+ *
+ * @return string The sanitised string.
+ * @since 11.1
*/
public static function makeSafe($path)
{
Modified: development/branches/platform/libraries/joomla/filesystem/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,11 +30,11 @@
/**
* Remote file size function for streams that don't support it
*
- * @param string $url TODO Add text
+ * @param string $url TODO Add text
* @see http://www.php.net/manual/en/function.filesize.php#71098
- *
- * @return mixed
- * @since 11.1
+ *
+ * @return mixed
+ * @since 11.1
*/
function remotefsize($url)
{
@@ -112,12 +112,12 @@
/**
* Quick FTP chmod
*
- * @param string $url TODO Add text
- * @param integer $mode The new permissions, given as an octal value.
+ * @param string $url TODO Add text
+ * @param integer $mode The new permissions, given as an octal value.
* @see http://www.php.net/manual/en/function.ftp-chmod.php
*
- * @return mixed
- * @since 11.1
+ * @return mixed
+ * @since 11.1
*/
function ftpChmod($url, $mode)
@@ -180,8 +180,8 @@
/**
* Modes that require a write operation
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
static function getWriteModes()
{
@@ -194,8 +194,8 @@
* Returns the supported streams, in addition to direct file access
* Also includes Joomla! streams as well as PHP streams
*
- * @return array Streams
- * @since 11.1
+ * @return array Streams
+ * @since 11.1
*/
function getSupported()
{
@@ -215,8 +215,8 @@
/**
* Returns a list of transports
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
function getTransports()
{
@@ -227,8 +227,8 @@
/**
* Returns a list of filters
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
function getFilters()
{
@@ -240,8 +240,8 @@
/**
* Returns a list of J! streams
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
function getJStreams()
{
@@ -260,10 +260,10 @@
/**
* Determine if a stream is a Joomla stream.
*
- * @param string $streamname The name of a stream
+ * @param string $streamname The name of a stream
*
- * @return boolean True for a Joomla Stream
- * @since 11.1
+ * @return boolean True for a Joomla Stream
+ * @since 11.1
*/
function isJoomlaStream($streamname)
{
Modified: development/branches/platform/libraries/joomla/filesystem/path.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/path.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/path.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -9,14 +9,14 @@
defined('JPATH_PLATFORM') or die;
-// True for Windows based hosts
+// True for Windows based hosts
define('JPATH_ISWIN', (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN'));
// True for Mac based hosts
define('JPATH_ISMAC', (strtoupper(substr(PHP_OS, 0, 3)) === 'MAC'));
if (!defined('DS')) {
- // String Shortcut for the DIRECTORY_SEPARATOR define
+ // String Shortcut for the DIRECTORY_SEPARATOR define
define('DS', DIRECTORY_SEPARATOR);
}
@@ -37,10 +37,10 @@
/**
* Checks if a path's permissions can be changed
*
- * @param string Path to check
- *
- * @return boolean True if path can have mode changed
- * @since 11.1
+ * @param string Path to check
+ *
+ * @return boolean True if path can have mode changed
+ * @since 11.1
*/
public static function canChmod($path)
{
@@ -58,12 +58,12 @@
/**
* Chmods files and directories recursivly to given permissions
*
- * @param string $path Root path to begin changing mode [without trailing slash]
- * @param string $filemode Octal representation of the value to change file mode to [null = no change]
- * @param string $foldermode Octal representation of the value to change folder mode to [null = no change]
- *
- * @return boolean True if successful [one fail means the whole operation failed]
- * @since 11.1
+ * @param string $path Root path to begin changing mode [without trailing slash]
+ * @param string $filemode Octal representation of the value to change file mode to [null = no change]
+ * @param string $foldermode Octal representation of the value to change folder mode to [null = no change]
+ *
+ * @return boolean True if successful [one fail means the whole operation failed]
+ * @since 11.1
*/
public static function setPermissions($path, $filemode = '0644', $foldermode = '0755')
{
@@ -107,10 +107,10 @@
/**
* Get the permissions of the file/folder at a give path
*
- * @param string $path The path of a file/folder
- *
- * @return string Filesystem permissions
- * @since 11.1
+ * @param string $path The path of a file/folder
+ *
+ * @return string Filesystem permissions
+ * @since 11.1
*/
public static function getPermissions($path)
{
@@ -137,24 +137,24 @@
/**
* Checks for snooping outside of the file system root
*
- * @param string A file system path to check
- * @param string Directory separator (optional)
- *
- * @return string A cleaned version of the path or exit on error
- * @since 11.1
+ * @param string A file system path to check
+ * @param string Directory separator (optional)
+ *
+ * @return string A cleaned version of the path or exit on error
+ * @since 11.1
*/
public static function check($path, $ds = DIRECTORY_SEPARATOR)
{
if (strpos($path, '..') !== false) {
// Don't translate
- JError::raiseError(20, 'JPath::check Use of relative paths not permitted');
+ JError::raiseError(20, 'JPath::check Use of relative paths not permitted');
jexit();
}
$path = JPath::clean($path);
if (strpos($path, JPath::clean(JPATH_ROOT)) !== 0) {
// Don't translate
- JError::raiseError(20, 'JPath::check Snooping out of bounds @ '.$path);
+ JError::raiseError(20, 'JPath::check Snooping out of bounds @ '.$path);
jexit();
}
@@ -164,10 +164,10 @@
/**
* Function to strip additional / or \ in a path name
*
- * @param string The path to clean
- * @param string Directory separator (optional)
- * @return string The cleaned path
- * @since 11.1
+ * @param string The path to clean
+ * @param string Directory separator (optional)
+ * @return string The cleaned path
+ * @since 11.1
*/
public static function clean($path, $ds = DIRECTORY_SEPARATOR)
{
@@ -186,10 +186,10 @@
/**
* Method to determine if script owns the path
*
- * @param string Path to check ownership
- *
- * @return boolean True if the php script owns the path passed
- * @since 11.1
+ * @param string Path to check ownership
+ *
+ * @return boolean True if the php script owns the path passed
+ * @since 11.1
*/
public static function isOwner($path)
{
@@ -227,11 +227,11 @@
/**
* Searches the directory paths for a given file.
*
- * @param mixed An path string or array of path strings to search in
- * @param string The file name to look for.
- *
- * @return mixed The full path and file name for the target file, or boolean false if the file is not found in any of the paths.
- * @since 11.1
+ * @param mixed An path string or array of path strings to search in
+ * @param string The file name to look for.
+ *
+ * @return mixed The full path and file name for the target file, or boolean false if the file is not found in any of the paths.
+ * @since 11.1
*/
public static function find($paths, $file)
{
@@ -255,7 +255,7 @@
// Non-registered directores are not accessible via directory
// Traversal attempts.
if (file_exists($fullname) && substr($fullname, 0, strlen($path)) == $path) {
-
+
return $fullname;
}
}
Modified: development/branches/platform/libraries/joomla/filesystem/stream.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/stream.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/stream.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,94 +30,94 @@
class JStream extends JObject
{
// Publicly settable vars (protected to let our parent read them)
- /**
+ /**
* File Mode
- * @var integer
+ * @var integer
* @since 11.1
* */
protected $filemode = 0644;
- /**
+ /**
* Directory Mode
* @var integer
- * @since 11.1
+ * @since 11.1
* */
protected $dirmode = 0755;
- /**
+ /**
* Default Chunk Size
* @var integer
* @since 11.1
*/
protected $chunksize = 8192;
- /**
- * Filename
+ /**
+ * Filename
* @var string
* @since 11.1
* */
protected $filename;
- /**
+ /**
* Prefix of the connection for writing
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $writeprefix;
- /**
- * Prefix of the connection for reading
+ /**
+ * Prefix of the connection for reading
* @var string
* @since 11.1
*/
protected $readprefix;
- /**
+ /**
* Read Processing method: gz, bz, f
- *
+ *
* If a scheme is detected, fopen will be defaulted
* To use compression with a network stream use a filter
- * @var string
+ * @var string
* @since 11.1
*/
protected $processingmethod = 'f';
- /**
+ /**
* Filters applied to the current stream
- * @var array
+ * @var array
* @since 11.1
*/
protected $filters = Array();
- /**
+ /**
* File Handle
* @var array
* @since 11.1
*/
protected $_fh;
- /**
+ /**
* File size
* @var integer
* @since 11.1
*/
protected $_filesize;
- /**
+ /**
* Context to use when opening the connection
- * @var
+ * @var
* @since 11.1
*/
protected $_context = null;
- /**
- * @var Context options; used to rebuild the context
+ /**
+ * @var Context options; used to rebuild the context
* @since 11.1
*/
protected $_contextOptions;
- /**
- * @var The mode under which the file was opened
+ /**
+ * @var The mode under which the file was opened
* @since 11.1
*/
protected $_openmode;
@@ -125,13 +125,13 @@
/**
* Constructor
*
- * @param string $writeprefix Prefix of the stream; Note: unlike the JPATH_*, this has a final path seperator!
- * @param string $readprefix
- * @param string $context
+ * @param string $writeprefix Prefix of the stream; Note: unlike the JPATH_*, this has a final path seperator!
+ * @param string $readprefix
+ * @param string $context
*
- * @return JStream
+ * @return JStream
*
- * @since 11.1
+ * @since 11.1
*/
function __construct($writeprefix = '', $readprefix = '', $context = array())
{
@@ -144,9 +144,9 @@
/**
* Destructor
*
- * @return void
+ * @return void
*
- * @since 11.1
+ * @since 11.1
*/
function __destruct()
{
@@ -160,17 +160,17 @@
* Generic File Operations
*
* Open a stream with some lazy loading smarts
- * @param string $filename Filename
- * @param string $mode Mode string to use
- * @param bool $use_include_path Use the PHP include path
- * @param resource $context Context to use when opening
- * @param bool $use_prefix Use a prefix to open the file
- * @param bool $relative Filename is a relative path (if false, strips JPATH_ROOT to make it relative)
- * @param bool $detectprocessingmode Detect the processing method for the file and use the appropriate function to handle output automatically
+ * @param string $filename Filename
+ * @param string $mode Mode string to use
+ * @param bool $use_include_path Use the PHP include path
+ * @param resource $context Context to use when opening
+ * @param bool $use_prefix Use a prefix to open the file
+ * @param bool $relative Filename is a relative path (if false, strips JPATH_ROOT to make it relative)
+ * @param bool $detectprocessingmode Detect the processing method for the file and use the appropriate function to handle output automatically
*
- * @return boolean
+ * @return boolean
*
- * @since 11.1
+ * @since 11.1
*/
function open($filename, $mode='r', $use_include_path=false, $context=null, $use_prefix=false, $relative=false, $detectprocessingmode=false)
{
@@ -228,17 +228,17 @@
switch($this->processingmethod)
{
// Gzip doesn't support contexts or streams
- case 'gz':
+ case 'gz':
$this->_fh = gzopen($filename, $mode, $use_include_path);
break;
// Bzip2 is much like gzip except it doesn't use the include path
- case 'bz':
+ case 'bz':
$this->_fh = bzopen($filename, $mode);
break;
// Fopen can handle streams
- case 'f':
+ case 'f':
default:
// One supplied at open; overrides everything
if ($context) {
@@ -249,7 +249,7 @@
$this->_fh = fopen($filename, $mode, $use_include_path, $this->_context);
}
// No context; all defaults
- else {
+ else {
$this->_fh = fopen($filename, $mode, $use_include_path);
}
break;
@@ -276,9 +276,9 @@
* @note: If the file is not open the system will return true
* @note: this function destroys the file handle as well
*
- * @return boolean
+ * @return boolean
*
- * @since 11.1
+ * @since 11.1
*/
function close()
{
@@ -333,9 +333,9 @@
/**
* Work out if we're at the end of the file for a stream
*
- * @return boolean
+ * @return boolean
*
- * @since 11.1
+ * @since 11.1
*/
function eof()
{
@@ -378,9 +378,9 @@
/**
* Retrieve the file size of the path
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function filesize()
{
@@ -436,11 +436,11 @@
}
/**
- * @param integer $length
+ * @param integer $length
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function gets($length=0)
{
@@ -488,12 +488,12 @@
*
* Handles user space streams appropriately otherwise any read will return 8192
*
- * @param integer $length Length of data to read
+ * @param integer $length Length of data to read
*
- * @return mixed
+ * @return mixed
*
* @see http://php.net/manual/en/function.fread.php
- * @since 11.1
+ * @since 11.1
*/
function read($length=0)
{
@@ -578,13 +578,13 @@
*
* Note: the return value is different to that of fseek
*
- * @param integer $offset Offset to use when seeking
- * @param integer $whence Seek mode to use
+ * @param integer $offset Offset to use when seeking
+ * @param integer $whence Seek mode to use
*
- * @return boolean True on success, false on failure
+ * @return boolean True on success, false on failure
*
* @see http://php.net/manual/en/function.fseek.php
- * @since 11.1
+ * @since 11.1
*/
function seek($offset, $whence=SEEK_SET)
{
@@ -629,9 +629,9 @@
}
/**
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function tell()
{
@@ -683,13 +683,13 @@
* JStream::set('chunksize', newsize);)
* Note: This doesn't support gzip/bzip2 writing like reading does
*
- * @param string $string Reference to the string to write
- * @param integer $length Length of the string to write
- * @param integer $chunk Size of chunks to write in
+ * @param string $string Reference to the string to write
+ * @param integer $length Length of the string to write
+ * @param integer $chunk Size of chunks to write in
* @see http://php.net/manual/en/function.fwrite.php
- *
- * @return boolean
- * @since 11.1
+ *
+ * @return boolean
+ * @since 11.1
*/
function write(&$string, $length=0, $chunk=0)
{
@@ -751,12 +751,12 @@
/**
* Chmod wrapper
*
- * @param string $filename File name
- * @param mixed $mode Mode to use
+ * @param string $filename File name
+ * @param mixed $mode Mode to use
*
- * @return boolean
+ * @return boolean
*
- * @since 11.1
+ * @since 11.1
*/
function chmod($filename='', $mode=0)
{
@@ -814,9 +814,9 @@
* Get the stream metadata
*
* @see http://php.net/manual/en/function.stream-get-meta-data.php
- *
- * @return array header/metadata
- * @since 11.1
+ *
+ * @return array header/metadata
+ * @since 11.1
*/
function get_meta_data()
{
@@ -833,9 +833,9 @@
* Stream contexts
* Builds the context from the array
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function _buildContext()
{
@@ -853,12 +853,12 @@
*
* Format is the same as the options for stream_context_create
*
- * @param array $context Options to create the context with
- *
+ * @param array $context Options to create the context with
+ *
* @see http://php.net/stream_context_create
- *
- * @return void
- * @since 11.1
+ *
+ * @return void
+ * @since 11.1
*/
function setContextOptions($context)
{
@@ -869,16 +869,16 @@
/**
* Adds a particular options to the context
*
- * @param string $wrapper The wrapper to use
- * @param string $name The option to set
- * @param string $value The value of the option
- *
+ * @param string $wrapper The wrapper to use
+ * @param string $name The option to set
+ * @param string $value The value of the option
+ *
* @see http://php.net/stream_context_create Stream Context Creation
* @see http://php.net/manual/en/context.php Context Options for various streams
*
- * @return void
+ * @return void
*
- * @since 11.1
+ * @since 11.1
*/
function addContextEntry($wrapper, $name, $value)
{
@@ -889,13 +889,13 @@
/**
* Deletes a particular setting from a context
*
- * @param string $wrapper The wrapper to use
- * @param string $name The option to unset
+ * @param string $wrapper The wrapper to use
+ * @param string $name The option to unset
*
- * @return void
+ * @return void
*
* @see http://php.net/stream_context_create
- * @since 11.1
+ * @since 11.1
*/
function deleteContextEntry($wrapper, $name)
{
@@ -923,9 +923,9 @@
*
* Use this to change the values of the context after you've opened a stream
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function applyContextToStream()
{
@@ -953,14 +953,14 @@
* Stream filters
* Append a filter to the chain
*
- * @param $filtername
- * @param $read_write
- * @param $params
+ * @param $filtername
+ * @param $read_write
+ * @param $params
*
- * @return mixed
+ * @return mixed
*
* @see http://php.net/manual/en/function.stream-filter-append.php
- * @since 11.1
+ * @since 11.1
*/
function appendFilter($filtername, $read_write = STREAM_FILTER_READ, $params = array() )
{
@@ -991,14 +991,14 @@
/**
* Prepend a filter to the chain
*
- * @param $filtername
- * @param $read_write
- * @param $params
+ * @param $filtername
+ * @param $read_write
+ * @param $params
*
- * @return mixed
+ * @return mixed
*
* @see http://php.net/manual/en/function.stream-filter-prepend.php
- * @since 11.1
+ * @since 11.1
*/
function prependFilter($filtername, $read_write = STREAM_FILTER_READ, $params = array() )
{
@@ -1031,12 +1031,12 @@
* append or prepend function) or via getting the
* filter list)
*
- * @param resource $resource
- * @param boolean $byindex
+ * @param resource $resource
+ * @param boolean $byindex
*
- * @return boolean Result of operation
+ * @return boolean Result of operation
*
- * @since 11.1
+ * @since 11.1
*/
function removeFilter(&$resource, $byindex=false)
{
@@ -1159,15 +1159,15 @@
/**
* Moves a file
*
- * @param string $src
- * @param string $dest
- * @param $context
- * @param boolean $user_prefix
- * @param boolean $relative
+ * @param string $src
+ * @param string $dest
+ * @param $context
+ * @param boolean $user_prefix
+ * @param boolean $relative
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function move($src, $dest, $context=null, $use_prefix=true, $relative=false)
{
@@ -1209,14 +1209,14 @@
/**
* Delete a file
*
- * @param string $filename
- * @param $context
- * @param boolean $user_prefix
- * @param boolean $relative
+ * @param string $filename
+ * @param $context
+ * @param boolean $user_prefix
+ * @param boolean $relative
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function delete($filename, $context=null, $use_prefix=true, $relative=false)
{
@@ -1255,15 +1255,15 @@
/**
* Upload a file
*
- * @param string $src
- * @param string $dest
- * @param $context
- * @param boolean $user_prefix
- * @param boolean $relative
+ * @param string $src
+ * @param string $dest
+ * @param $context
+ * @param boolean $user_prefix
+ * @param boolean $relative
*
- * @return mixed
+ * @return mixed
*
- * @since 11.1
+ * @since 11.1
*/
function upload($src, $dest, $context=null, $use_prefix=true, $relative=false)
{
@@ -1281,12 +1281,12 @@
* All in one
* Writes a chunk of data to a file
*
- * @param $filename
- * @param $buffer
+ * @param $filename
+ * @param $buffer
*
* @return boolean
*
- * @since 11.1
+ * @since 11.1
*/
function writeFile($filename, &$buffer)
{
@@ -1304,13 +1304,13 @@
/**
* Determine the appropriate 'filename' of a file
*
- * @param string $filename Original filename of the file
- * @param string $mode Mode string to retrieve the filename
- * @param boolean $use_prefix Controls the use of a prefix
- * @param boolean $relative Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.
+ * @param string $filename Original filename of the file
+ * @param string $mode Mode string to retrieve the filename
+ * @param boolean $use_prefix Controls the use of a prefix
+ * @param boolean $relative Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
function _getFilename($filename, $mode, $use_prefix, $relative)
{
@@ -1342,8 +1342,8 @@
/**
* Return the internal file handle
*
- * @return File handler
- * @since 11.1
+ * @return File handler
+ * @since 11.1
*/
function getFileHandle()
{
Modified: development/branches/platform/libraries/joomla/filesystem/streams/string.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/streams/string.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/streams/string.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -40,13 +40,13 @@
protected $_stat;
/**
- * @param $path
- * @param $mode
- * @param $options
- * @param $opened_path
+ * @param $path
+ * @param $mode
+ * @param $options
+ * @param $opened_path
*
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
function stream_open($path, $mode, $options, &$opened_path)
{
@@ -67,7 +67,7 @@
/**
* @return
- * @since 11.1
+ * @since 11.1
*/
function stream_stat()
{
@@ -75,11 +75,11 @@
}
/**
- * @param $path
- * @param $flags
+ * @param $path
+ * @param $flags
*
* @return
- * @since 11.1
+ * @since 11.1
*/
function url_stat($path, $flags = 0)
{
@@ -105,10 +105,10 @@
}
/**
- * @param $count
+ * @param $count
*
* @return
- * @since 11.1
+ * @since 11.1
*/
function stream_read($count)
{
@@ -119,8 +119,8 @@
}
/**
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
function stream_write($data)
{
@@ -130,7 +130,7 @@
/**
* @return
- * @since 11.1
+ * @since 11.1
*/
function stream_tell()
{
@@ -138,8 +138,8 @@
}
/**
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
function stream_eof()
{
@@ -151,11 +151,11 @@
}
/**
- * @param $offset
- * @param $whence
+ * @param $offset
+ * @param $whence
*
* @return
- * @since 11.1
+ * @since 11.1
*/
function stream_seek($offset, $whence)
{
@@ -189,8 +189,8 @@
}
/**
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
function stream_flush()
{
Modified: development/branches/platform/libraries/joomla/filesystem/support/stringcontroller.php
===================================================================
--- development/branches/platform/libraries/joomla/filesystem/support/stringcontroller.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filesystem/support/stringcontroller.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -20,8 +20,8 @@
/**
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
function _getArray() {
static $strings = Array();
Modified: development/branches/platform/libraries/joomla/filter/filterinput.php
===================================================================
--- development/branches/platform/libraries/joomla/filter/filterinput.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filter/filterinput.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,43 +23,43 @@
{
/**
* @var array An array of permitted tags.
- * @since 11.1
+ * @since 11.1
*/
var $tagsArray;
/**
* @var array An array of permitted tag attributes.
- * @since 11.1
+ * @since 11.1
*/
var $attrArray;
/**
* @var int WhiteList method = 0 (default), BlackList method = 1
- * @since 11.1
+ * @since 11.1
*/
var $tagsMethod;
/**
* @var int WhiteList method = 0 (default), BlackList method = 1
- * @since 11.1
+ * @since 11.1
*/
var $attrMethod;
/**
* @var int Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1
- * @since 11.1
+ * @since 11.1
*/
var $xssAuto;
/**
* @var array A list of the default blacklisted tags.
- * @since 11.1
+ * @since 11.1
*/
var $tagBlacklist = array ('applet', 'body', 'bgsound', 'base', 'basefont', 'embed', 'frame', 'frameset', 'head', 'html', 'id', 'iframe', 'ilayer', 'layer', 'link', 'meta', 'name', 'object', 'script', 'style', 'title', 'xml');
/**
* @var array A list of the default blacklisted tag attributes.
- * @since 11.1
+ * @since 11.1
*/
var $attrBlacklist = array ('action', 'background', 'codebase', 'dynsrc', 'lowsrc'); // also will strip ALL event handlers
@@ -67,13 +67,13 @@
* Constructor for inputFilter class. Only first parameter is required.
*
* @access protected
- * @param array $tagsArray List of user-defined tags
- * @param array $attrArray List of user-defined attributes
- * @param integer $tagsMethod WhiteList method = 0, BlackList method = 1
- * @param integer $attrMethod WhiteList method = 0, BlackList method = 1
- * @param integer $xssAuto Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1
- *
- * @since 11.1
+ * @param array $tagsArray List of user-defined tags
+ * @param array $attrArray List of user-defined attributes
+ * @param integer $tagsMethod WhiteList method = 0, BlackList method = 1
+ * @param integer $attrMethod WhiteList method = 0, BlackList method = 1
+ * @param integer $xssAuto Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1
+ *
+ * @since 11.1
*/
public function __construct($tagsArray = array(), $attrArray = array(), $tagsMethod = 0, $attrMethod = 0, $xssAuto = 1)
{
@@ -92,13 +92,13 @@
/**
* Returns an input filter object, only creating it if it doesn't already exist.
*
- * @param array $tagsArray List of user-defined tags
- * @param array $attrArray List of user-defined attributes
- * @param integer $tagsMethod WhiteList method = 0, BlackList method = 1
- * @param integer $attrMethod WhiteList method = 0, BlackList method = 1
- * @param integer $xssAuto Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1
- * @return object The JFilterInput object.
- * @since 11.1
+ * @param array $tagsArray List of user-defined tags
+ * @param array $attrArray List of user-defined attributes
+ * @param integer $tagsMethod WhiteList method = 0, BlackList method = 1
+ * @param integer $attrMethod WhiteList method = 0, BlackList method = 1
+ * @param integer $xssAuto Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1
+ * @return object The JFilterInput object.
+ * @since 11.1
*/
public static function &getInstance($tagsArray = array(), $attrArray = array(), $tagsMethod = 0, $attrMethod = 0, $xssAuto = 1)
{
@@ -121,10 +121,10 @@
* Method to be called by another php script. Processes for XSS and
* specified bad code.
*
- * @param mixed $source Input string/array-of-string to be 'cleaned'
- * @param string $type Return type for the variable (INT, FLOAT, BOOLEAN, WORD, ALNUM, CMD, BASE64, STRING, ARRAY, PATH, NONE)
- * @return mixed 'Cleaned' version of input parameter
- * @since 11.1
+ * @param mixed $source Input string/array-of-string to be 'cleaned'
+ * @param string $type Return type for the variable (INT, FLOAT, BOOLEAN, WORD, ALNUM, CMD, BASE64, STRING, ARRAY, PATH, NONE)
+ * @return mixed 'Cleaned' version of input parameter
+ * @since 11.1
* @static
*/
public function clean($source, $type='string')
@@ -271,10 +271,10 @@
/**
* Function to determine if contents of an attribute are safe
*
- * @param array $attrSubSet A 2 element array for attribute's name, value
- *
- * @return boolean True if bad code is detected
- * @since 11.1
+ * @param array $attrSubSet A 2 element array for attribute's name, value
+ *
+ * @return boolean True if bad code is detected
+ * @since 11.1
*/
public static function checkAttribute($attrSubSet)
{
@@ -287,10 +287,10 @@
/**
* Internal method to iteratively remove all unwanted tags and attributes
*
- * @param string $source Input string to be 'cleaned'
- *
- * @return string 'Cleaned' version of input parameter
- * @since 11.1
+ * @param string $source Input string to be 'cleaned'
+ *
+ * @return string 'Cleaned' version of input parameter
+ * @since 11.1
*/
protected function _remove($source)
{
@@ -308,9 +308,9 @@
/**
* Internal method to strip a string of certain tags
*
- * @param string Input string to be 'cleaned'
- * @return string 'Cleaned' version of input parameter
- * @since 11.1
+ * @param string Input string to be 'cleaned'
+ * @return string 'Cleaned' version of input parameter
+ * @since 11.1
*/
protected function _cleanTags($source)
{
@@ -508,9 +508,9 @@
/**
* Internal method to strip a tag of certain attributes
*
- * @param array $attrSet Array of attribute pairs to filter
- * @return array Filtered array of attribute pairs
- * @since 11.1
+ * @param array $attrSet Array of attribute pairs to filter
+ * @return array Filtered array of attribute pairs
+ * @since 11.1
*/
protected function _cleanAttributes($attrSet)
{
@@ -587,9 +587,9 @@
/**
* Try to convert to plaintext
*
- * @param string $source The source string.
- * @return string Plaintext string
- * @since 11.1
+ * @param string $source The source string.
+ * @return string Plaintext string
+ * @since 11.1
*/
protected function _decode($source)
{
Modified: development/branches/platform/libraries/joomla/filter/filteroutput.php
===================================================================
--- development/branches/platform/libraries/joomla/filter/filteroutput.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/filter/filteroutput.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,9 +25,9 @@
* Object parameters that are non-string, array, object or start with underscore
* will be converted
*
- * @param object An object to be parsed
- * @param integer The optional quote style for the htmlspecialchars function
- * @param string|array An optional single field name or array of field names not
+ * @param object An object to be parsed
+ * @param integer The optional quote style for the htmlspecialchars function
+ * @param string|array An optional single field name or array of field names not
* to be parsed (eg, for a textarea)
* @since 11.1
*/
@@ -55,10 +55,10 @@
/**
* This method processes a string and replaces all instances of & with & in links only.
*
- * @param string $input String to process
- *
- * @return string Processed string
- * @since 11.1
+ * @param string $input String to process
+ *
+ * @return string Processed string
+ * @since 11.1
*/
public static function linkXHTMLSafe($input)
{
@@ -70,9 +70,9 @@
* This method processes a string and replaces all accented UTF-8 characters by unaccented
* ASCII-7 "equivalents", whitespaces are replaced by hyphens and the string is lowercased.
*
- * @param string $input String to process
- * @return string Processed string
- * @since 11.1
+ * @param string $input String to process
+ * @return string Processed string
+ * @since 11.1
*/
public static function stringURLSafe($string)
{
@@ -97,9 +97,9 @@
/**
* This method implements unicode slugs instead of transliteration.
*
- * @param string $input String to process
- * @return string Processed string
- * @since 11.1
+ * @param string $input String to process
+ * @return string Processed string
+ * @since 11.1
*/
public static function stringURLUnicodeSlug($string)
{
@@ -149,10 +149,10 @@
/**
* Callback method for replacing & with & in a string
*
- * @param string $m String to process
- *
- * @return string Replaced string
- * @since 11.1
+ * @param string $m String to process
+ *
+ * @return string Replaced string
+ * @since 11.1
*/
public static function _ampReplaceCallback($m)
{
Modified: development/branches/platform/libraries/joomla/form/fields/accesslevel.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/accesslevel.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/accesslevel.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'AccessLevel';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/cachehandler.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/cachehandler.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/cachehandler.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'CacheHandler';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/calendar.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/calendar.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/calendar.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Calendar';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/category.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/category.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/category.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
{
/**
* @var string The form field type.
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Category';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/checkbox.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/checkbox.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/checkbox.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Checkbox';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/checkboxes.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/checkboxes.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/checkboxes.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Checkboxes';
@@ -33,15 +33,15 @@
* Flag to tell the field to always be in multiple values mode.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $forceMultiple = true;
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -88,8 +88,8 @@
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/combo.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/combo.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/combo.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Combo';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/componentlayout.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/componentlayout.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/componentlayout.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'ComponentLayout';
/**
* Method to get the field input.
*
- * @return string The field input.
- * @since 11.1
+ * @return string The field input.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/contentlanguage.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/contentlanguage.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/contentlanguage.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'ContentLanguage';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/editor.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/editor.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/editor.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Editor';
@@ -33,15 +33,15 @@
* The JEditor object.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $editor;
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -78,8 +78,8 @@
/**
* Method to get a JEditor object based on the form field.
*
- * @return object The JEditor object.
- * @since 11.1
+ * @return object The JEditor object.
+ * @since 11.1
*/
protected function &getEditor()
{
@@ -130,8 +130,8 @@
/**
* Method to get the JEditor output for an onSave event.
*
- * @return string The JEditor object output.
- * @since 11.1
+ * @return string The JEditor object output.
+ * @since 11.1
*/
public function save()
{
Modified: development/branches/platform/libraries/joomla/form/fields/editors.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/editors.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/editors.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Editors';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/email.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/email.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/email.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Email';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/file.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/file.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/file.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'File';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/filelist.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/filelist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/filelist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,15 +29,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'FileList';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/folderlist.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/folderlist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/folderlist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'FolderList';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/groupedlist.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/groupedlist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/groupedlist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'GroupedList';
/**
* Method to get the field option groups.
*
- * @return array The field option objects as a nested array in groups.
- * @since 11.1
+ * @return array The field option objects as a nested array in groups.
+ * @since 11.1
*/
protected function getGroups()
{
@@ -126,8 +126,8 @@
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/helpsite.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/helpsite.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/helpsite.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Helpsite';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/hidden.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/hidden.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/hidden.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Hidden';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/imagelist.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/imagelist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/imagelist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'ImageList';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/integer.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/integer.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/integer.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Integer';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/language.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/language.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/language.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Language';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/list.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/list.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/list.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'List';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -74,8 +74,8 @@
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/media.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/media.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/media.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Media';
@@ -32,15 +32,15 @@
* The initialised state of the document object.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected static $initialised = false;
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/menu.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/menu.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/menu.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,15 +30,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Menu';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/menuitem.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/menuitem.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/menuitem.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,15 +30,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'MenuItem';
/**
* Method to get the field option groups.
*
- * @return array The field option objects as a nested array in groups.
- * @since 11.1
+ * @return array The field option objects as a nested array in groups.
+ * @since 11.1
*/
protected function getGroups()
{
Modified: development/branches/platform/libraries/joomla/form/fields/modulelayout.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/modulelayout.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/modulelayout.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'ModuleLayout';
/**
* Method to get the field input.
*
- * @return string The field input.
- * @since 11.1
+ * @return string The field input.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/password.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/password.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/password.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Password';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/radio.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/radio.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/radio.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Radio';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -76,8 +76,8 @@
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/rules.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/rules.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/rules.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'Rules';
@@ -34,8 +34,8 @@
*
* TODO: Add access check.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -267,8 +267,8 @@
/**
* Get a list of the user groups.
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
protected function getUserGroups()
{
Modified: development/branches/platform/libraries/joomla/form/fields/sessionhandler.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/sessionhandler.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/sessionhandler.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,15 +28,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'SessionHandler';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
Modified: development/branches/platform/libraries/joomla/form/fields/spacer.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/spacer.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/spacer.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Spacer';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -42,8 +42,8 @@
/**
* Method to get the field label markup.
*
- * @return string The field label markup.
- * @since 11.1
+ * @return string The field label markup.
+ * @since 11.1
*/
protected function getLabel()
{
@@ -87,8 +87,8 @@
/**
* Method to get the field title.
*
- * @return string The field title.
- * @since 11.1
+ * @return string The field title.
+ * @since 11.1
*/
protected function getTitle()
{
Modified: development/branches/platform/libraries/joomla/form/fields/sql.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/sql.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/sql.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'SQL';
/**
* Method to get the field options.
*
- * @return array The field option objects.
- * @since 11.1
+ * @return array The field option objects.
+ * @since 11.1
*/
protected function getOptions()
{
@@ -66,7 +66,7 @@
foreach($items as $item) {
if ($translate == true) {
$options[] = JHtml::_('select.option', $item->$key, JText::_($item->$value));
- }
+ }
else {
$options[] = JHtml::_('select.option', $item->$key, $item->$value);
}
Modified: development/branches/platform/libraries/joomla/form/fields/tel.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/tel.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/tel.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Tel';
}
Modified: development/branches/platform/libraries/joomla/form/fields/templatestyle.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/templatestyle.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/templatestyle.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,15 +27,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'TemplateStyle';
/**
* Method to get the field option groups.
*
- * @return array The field option objects as a nested array in groups.
- * @since 11.1
+ * @return array The field option objects as a nested array in groups.
+ * @since 11.1
*/
protected function getGroups()
{
Modified: development/branches/platform/libraries/joomla/form/fields/text.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/text.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/text.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Text';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/textarea.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/textarea.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/textarea.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Textarea';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/fields/timezone.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/timezone.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/timezone.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,7 +27,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Timezone';
@@ -35,7 +35,7 @@
* The list of available timezone groups to use.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected static $zones = array(
'Africa', 'America', 'Antarctica', 'Arctic', 'Asia',
@@ -45,8 +45,8 @@
/**
* Method to get the field option groups.
*
- * @return array The field option objects as a nested array in groups.
- * @since 11.1
+ * @return array The field option objects as a nested array in groups.
+ * @since 11.1
*/
protected function getGroups()
{
Modified: development/branches/platform/libraries/joomla/form/fields/url.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/url.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/url.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Url';
}
Modified: development/branches/platform/libraries/joomla/form/fields/user.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/user.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/user.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,15 +24,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public $type = 'User';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
@@ -103,8 +103,8 @@
/**
* Method to get the filtering groups (null means no filtering)
*
- * @return array null array of filtering groups or null.
- * @since 11.1
+ * @return array null array of filtering groups or null.
+ * @since 11.1
*/
protected function getGroups()
{
@@ -114,8 +114,8 @@
/**
* Method to get the users to exclude from the list of users
*
- * @return array null array of users to exclude or null to to not exclude them
- * @since 11.1
+ * @return array null array of users to exclude or null to to not exclude them
+ * @since 11.1
*/
protected function getExcluded()
{
Modified: development/branches/platform/libraries/joomla/form/fields/usergroup.php
===================================================================
--- development/branches/platform/libraries/joomla/form/fields/usergroup.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/fields/usergroup.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,15 +25,15 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type = 'Usergroup';
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
protected function getInput()
{
Modified: development/branches/platform/libraries/joomla/form/form.php
===================================================================
--- development/branches/platform/libraries/joomla/form/form.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/form.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,7 +32,7 @@
* The JRegistry data store for form fields during display.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $data;
@@ -40,7 +40,7 @@
* The form object errors array.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $errors = array();
@@ -48,7 +48,7 @@
* The name of the form instance.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $name;
@@ -56,7 +56,7 @@
* The form object options for use in rendering and validation.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $options = array();
@@ -64,7 +64,7 @@
* The form XML definition.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $xml;
@@ -72,18 +72,18 @@
* Form instances.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected static $forms = array();
/**
* Method to instantiate the form object.
*
- * @param string $name The name of the form.
- * @param array $options An array of form options.
+ * @param string $name The name of the form.
+ * @param array $options An array of form options.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function __construct($name, array $options = array())
{
@@ -100,10 +100,10 @@
/**
* Method to bind data to the form.
*
- * @param mixed $data An array or object of data to bind to the form.
+ * @param mixed $data An array or object of data to bind to the form.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function bind($data)
{
@@ -152,11 +152,11 @@
/**
* Method to bind data to the form for the group level.
*
- * @param string $group The dot-separated form group path on which to bind the data.
- * @param mixed $data An array or object of data to bind to the form for the group level.
+ * @param string $group The dot-separated form group path on which to bind the data.
+ * @param mixed $data An array or object of data to bind to the form for the group level.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function bindLevel($group, $data)
{
@@ -180,11 +180,11 @@
/**
* Method to filter the form data.
*
- * @param array $data An array of field values to filter.
- * @param string $group The dot-separated form group path on which to filter the fields.
+ * @param array $data An array of field values to filter.
+ * @param string $group The dot-separated form group path on which to filter the fields.
*
- * @return mixed boolean True on sucess.
- * @since 11.1
+ * @return mixed boolean True on sucess.
+ * @since 11.1
*/
public function filter($data, $group = null)
{
@@ -236,8 +236,8 @@
/**
* Return all errors, if any.
*
- * @return array Array of error messages or JException objects.
- * @since 11.1
+ * @return array Array of error messages or JException objects.
+ * @since 11.1
*/
public function getErrors()
{
@@ -247,12 +247,12 @@
/**
* Method to get a form field represented as a JFormField object.
*
- * @param string $name The name of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
- * @param mixed $value The optional value to use as the default for the field.
+ * @param string $name The name of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param mixed $value The optional value to use as the default for the field.
*
- * @return mixed The JFormField object for the field or boolean false on error.
- * @since 11.1
+ * @return mixed The JFormField object for the field or boolean false on error.
+ * @since 11.1
*/
public function getField($name, $group = null, $value = null)
{
@@ -276,13 +276,13 @@
* Method to get an attribute value from a field XML element. If the attribute doesn't exist or
* is null then the optional default value will be used.
*
- * @param string $name The name of the form field for which to get the attribute value.
- * @param string $attribute The name of the attribute for which to get a value.
- * @param mixed $default The optional default value to use if no attribute value exists.
- * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param string $name The name of the form field for which to get the attribute value.
+ * @param string $attribute The name of the attribute for which to get a value.
+ * @param mixed $default The optional default value to use if no attribute value exists.
+ * @param string $group The optional dot-separated form group path on which to find the field.
*
- * @return mixed The attribute value for the field.
- * @since 11.1
+ * @return mixed The attribute value for the field.
+ * @since 11.1
*/
public function getFieldAttribute($name, $attribute, $default = null, $group = null)
{
@@ -310,10 +310,10 @@
* Method to get an array of JFormField objects in a given fieldset by name. If no name is
* given then all fields are returned.
*
- * @param string $set The optional name of the fieldset.
+ * @param string $set The optional name of the fieldset.
*
- * @return array The array of JFormField objects in the fieldset.
- * @since 11.1
+ * @return array The array of JFormField objects in the fieldset.
+ * @since 11.1
*/
public function getFieldset($set = null)
{
@@ -354,10 +354,10 @@
/**
* Method to get an array of fieldset objects optionally filtered over a given field group.
*
- * @param string $group The dot-separated form group path on which to filter the fieldsets.
+ * @param string $group The dot-separated form group path on which to filter the fieldsets.
*
- * @return array The array of fieldset objects.
- * @since 11.1
+ * @return array The array of fieldset objects.
+ * @since 11.1
*/
public function getFieldsets($group = null)
{
@@ -451,8 +451,8 @@
* the form control is set to 'joomla' however, the fields would be rendered like:
* <input name="joomla[foo]" /> and <input name="joomla[bar]" />.
*
- * @return string The form control string.
- * @since 11.1
+ * @return string The form control string.
+ * @since 11.1
*/
public function getFormControl()
{
@@ -462,12 +462,12 @@
/**
* Method to get an array of JFormField objects in a given field group by name.
*
- * @param string $group The dot-separated form group path for which to get the form fields.
- * @param boolean $nested True to also include fields in nested groups that are inside of the
+ * @param string $group The dot-separated form group path for which to get the form fields.
+ * @param boolean $nested True to also include fields in nested groups that are inside of the
* group for which to find fields.
*
- * @return array The array of JFormField objects in the field group.
- * @since 11.1
+ * @return array The array of JFormField objects in the field group.
+ * @since 11.1
*/
public function getGroup($group, $nested = false)
{
@@ -497,12 +497,12 @@
/**
* Method to get a form field markup for the field input.
*
- * @param string $name The name of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
- * @param mixed $value The optional value to use as the default for the field.
+ * @param string $name The name of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param mixed $value The optional value to use as the default for the field.
*
- * @return string The form field markup.
- * @since 11.1
+ * @return string The form field markup.
+ * @since 11.1
*/
public function getInput($name, $group = null, $value = null)
{
@@ -517,11 +517,11 @@
/**
* Method to get a form field markup for the field input.
*
- * @param string $name The name of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param string $name The name of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
*
- * @return string The form field markup.
- * @since 11.1
+ * @return string The form field markup.
+ * @since 11.1
*/
public function getLabel($name, $group = null)
{
@@ -536,8 +536,8 @@
/**
* Method to get the form name.
*
- * @return string The name of the form.
- * @since 11.1
+ * @return string The name of the form.
+ * @since 11.1
*/
public function getName()
{
@@ -547,12 +547,12 @@
/**
* Method to get the value of a field.
*
- * @param string $name The name of the field for which to get the value.
- * @param string $group The optional dot-separated form group path on which to get the value.
- * @param mixed $default The optional default value of the field value is empty.
+ * @param string $name The name of the field for which to get the value.
+ * @param string $group The optional dot-separated form group path on which to get the value.
+ * @param mixed $default The optional default value of the field value is empty.
*
- * @return mixed The value of the field or the default value if empty.
- * @since 11.1
+ * @return mixed The value of the field or the default value if empty.
+ * @since 11.1
*/
public function getValue($name, $group = null, $default = null)
{
@@ -576,13 +576,13 @@
* field being loaded. If it is false, then the new field being loaded will be ignored and the
* method will move on to the next field to load.
*
- * @param string $data The name of an XML string or object.
- * @param string $replace Flag to toggle whether form fields should be replaced if a field
+ * @param string $data The name of an XML string or object.
+ * @param string $replace Flag to toggle whether form fields should be replaced if a field
* already exists with the same group/name.
- * @param string $xpath An optional xpath to search for the fields.
+ * @param string $xpath An optional xpath to search for the fields.
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function load($data, $replace = true, $xpath = false)
{
@@ -678,13 +678,13 @@
* fields in the new XML file unless the $reset parameter has been set
* to false.
*
- * @param string $file The filesystem path of an XML file.
- * @param string $replace Flag to toggle whether form fields should be replaced if a field
+ * @param string $file The filesystem path of an XML file.
+ * @param string $replace Flag to toggle whether form fields should be replaced if a field
* already exists with the same group/name.
- * @param string $xpath An optional xpath to search for the fields.
+ * @param string $xpath An optional xpath to search for the fields.
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function loadFile($file, $reset = true, $xpath = false)
{
@@ -708,11 +708,11 @@
/**
* Method to remove a field from the form definition.
*
- * @param string $name The name of the form field for which remove.
- * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param string $name The name of the form field for which remove.
+ * @param string $group The optional dot-separated form group path on which to find the field.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function removeField($name, $group = null)
{
@@ -737,10 +737,10 @@
/**
* Method to remove a group from the form definition.
*
- * @param string $group The dot-separated form group path for the group to remove.
+ * @param string $group The dot-separated form group path for the group to remove.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function removeGroup($group)
{
@@ -764,10 +764,10 @@
/**
* Method to reset the form data store and optionally the form XML definition.
*
- * @param boolean $xml True to also reset the XML form definition.
+ * @param boolean $xml True to also reset the XML form definition.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function reset($xml = false)
{
@@ -787,12 +787,12 @@
* the field will be set whether it already exists or not. If it isn't set, then the field
* will not be replaced if it already exists.
*
- * @param object $element The XML element object representation of the form field.
- * @param string $group The optional dot-separated form group path on which to set the field.
- * @param boolean $replace True to replace an existing field if one already exists.
+ * @param object $element The XML element object representation of the form field.
+ * @param string $group The optional dot-separated form group path on which to set the field.
+ * @param boolean $replace True to replace an existing field if one already exists.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setField(& $element, $group = null, $replace = true)
{
@@ -851,13 +851,13 @@
/**
* Method to set an attribute value for a field XML element.
*
- * @param string $name The name of the form field for which to set the attribute value.
- * @param string $attribute The name of the attribute for which to set a value.
- * @param mixed $value The value to set for the attribute.
- * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param string $name The name of the form field for which to set the attribute value.
+ * @param string $attribute The name of the attribute for which to set a value.
+ * @param mixed $value The value to set for the attribute.
+ * @param string $group The optional dot-separated form group path on which to find the field.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setFieldAttribute($name, $attribute, $value, $group = null)
{
@@ -892,12 +892,12 @@
* the fields will be set whether they already exists or not. If it isn't set, then the fields
* will not be replaced if they already exist.
*
- * @param object $elements The array of XML element object representations of the form fields.
- * @param string $group The optional dot-separated form group path on which to set the fields.
- * @param boolean $replace True to replace existing fields if they already exist.
+ * @param object $elements The array of XML element object representations of the form fields.
+ * @param string $group The optional dot-separated form group path on which to set the fields.
+ * @param boolean $replace True to replace existing fields if they already exist.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setFields(& $elements, $group = null, $replace = true)
{
@@ -938,12 +938,12 @@
* Method to set the value of a field. If the field does not exist in the form then the method
* will return false.
*
- * @param string $name The name of the field for which to set the value.
- * @param string $group The optional dot-separated form group path on which to find the field.
- * @param mixed $value The value to set for the field.
+ * @param string $name The name of the field for which to set the value.
+ * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param mixed $value The value to set for the field.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setValue($name, $group = null, $value = null)
{
@@ -969,12 +969,12 @@
* Validation warnings will be pushed into JForm::errors and should be
* retrieved with JForm::getErrors() when validate returns boolean false.
*
- * @param array $data An array of field values to validate.
- * @param string $group The optional dot-separated form group path on which to filter the
+ * @param array $data An array of field values to validate.
+ * @param string $group The optional dot-separated form group path on which to filter the
* fields to be validated.
*
- * @return mixed boolean True on sucess.
- * @since 11.1
+ * @return mixed boolean True on sucess.
+ * @since 11.1
*/
public function validate($data, $group = null)
{
@@ -1042,11 +1042,11 @@
/**
* Method to apply an input filter to a value based on field data.
*
- * @param string $element The XML element object representation of the form field.
- * @param mixed $value The value to filter for the field.
+ * @param string $element The XML element object representation of the form field.
+ * @param mixed $value The value to filter for the field.
*
- * @return mixed The filtered value.
- * @since 11.1
+ * @return mixed The filtered value.
+ * @since 11.1
*/
protected function filterField($element, $value)
{
@@ -1155,11 +1155,11 @@
/**
* Method to get a form field represented as an XML element object.
*
- * @param string $name The name of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param string $name The name of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
*
- * @return mixed The XML element object for the field or boolean false on error.
- * @since 11.1
+ * @return mixed The XML element object for the field or boolean false on error.
+ * @since 11.1
*/
protected function findField($name, $group = null)
{
@@ -1238,10 +1238,10 @@
* Method to get an array of <field /> elements from the form XML document which are
* in a specified fieldset by name.
*
- * @param string $name The name of the fieldset.
+ * @param string $name The name of the fieldset.
*
- * @return mixed Boolean false on error or array of JXMLElement objects.
- * @since 11.1
+ * @return mixed Boolean false on error or array of JXMLElement objects.
+ * @since 11.1
*/
protected function & findFieldsByFieldset($name)
{
@@ -1267,13 +1267,13 @@
* Method to get an array of <field /> elements from the form XML document which are
* in a control group by name.
*
- * @param mixed $group The optional dot-separated form group path on which to find the fields.
+ * @param mixed $group The optional dot-separated form group path on which to find the fields.
* Null will return all fields. False will return fields not in a group.
- * @param boolean $nested True to also include fields in nested groups that are inside of the
+ * @param boolean $nested True to also include fields in nested groups that are inside of the
* group for which to find fields.
*
- * @return mixed Boolean false on error or array of JXMLElement objects.
- * @since 11.1
+ * @return mixed Boolean false on error or array of JXMLElement objects.
+ * @since 11.1
*/
protected function & findFieldsByGroup($group = null, $nested = false)
{
@@ -1336,10 +1336,10 @@
/**
* Method to get a form field group represented as an XML element object.
*
- * @param string $group The dot-separated form group path on which to find the group.
+ * @param string $group The dot-separated form group path on which to find the group.
*
- * @return mixed An array of XML element objects for the group or boolean false on error.
- * @since 11.1
+ * @return mixed An array of XML element objects for the group or boolean false on error.
+ * @since 11.1
*/
protected function &findGroup($group)
{
@@ -1413,12 +1413,12 @@
/**
* Method to load, setup and return a JFormField object based on field data.
*
- * @param string $element The XML element object representation of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
- * @param mixed $value The optional value to use as the default for the field.
+ * @param string $element The XML element object representation of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param mixed $value The optional value to use as the default for the field.
*
- * @return mixed The JFormField object for the field or boolean false on error.
- * @since 11.1
+ * @return mixed The JFormField object for the field or boolean false on error.
+ * @since 11.1
*/
protected function loadField($element, $group = null, $value = null)
{
@@ -1475,11 +1475,11 @@
/**
* Proxy for {@link JFormHelper::loadFieldType()}.
*
- * @param string $type The field type.
- * @param boolean $new Flag to toggle whether we should get a new instance of the object.
+ * @param string $type The field type.
+ * @param boolean $new Flag to toggle whether we should get a new instance of the object.
*
- * @return mixed JFormField object on success, false otherwise.
- * @since 11.1
+ * @return mixed JFormField object on success, false otherwise.
+ * @since 11.1
*/
protected function loadFieldType($type, $new = true)
{
@@ -1489,11 +1489,11 @@
/**
* Proxy for {@link JFormHelper::loadRuleType()}.
*
- * @param string $type The rule type.
- * @param boolean $new Flag to toggle whether we should get a new instance of the object.
+ * @param string $type The rule type.
+ * @param boolean $new Flag to toggle whether we should get a new instance of the object.
*
- * @return mixed JFormRule object on success, false otherwise.
- * @since 11.1
+ * @return mixed JFormRule object on success, false otherwise.
+ * @since 11.1
*/
protected function loadRuleType($type, $new = true)
{
@@ -1504,8 +1504,8 @@
* Method to synchronize any field, form or rule paths contained in the XML document.
*
* TODO: Maybe we should receive all addXXXpaths attributes at once?
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
protected function syncPaths()
{
@@ -1553,14 +1553,14 @@
/**
* Method to validate a JFormField object based on field data.
*
- * @param string $element The XML element object representation of the form field.
- * @param string $group The optional dot-separated form group path on which to find the field.
- * @param mixed $value The optional value to use as the default for the field.
- * @param object $input An optional JRegistry object with the entire data set to validate
+ * @param string $element The XML element object representation of the form field.
+ * @param string $group The optional dot-separated form group path on which to find the field.
+ * @param mixed $value The optional value to use as the default for the field.
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
*
- * @return mixed Boolean true if field value is valid, JException on failure.
- * @since 11.1
+ * @return mixed Boolean true if field value is valid, JException on failure.
+ * @since 11.1
*/
protected function validateField($element, $group = null, $value = null, $input = null)
{
@@ -1635,10 +1635,10 @@
/**
* Proxy for {@link JFormHelper::addFieldPath()}.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addFieldPath($new = null)
{
@@ -1648,10 +1648,10 @@
/**
* Proxy for {@link JFormHelper::addFormPath()}.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addFormPath($new = null)
{
@@ -1661,10 +1661,10 @@
/**
* Proxy for {@link JFormHelper::addRulePath()}.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addRulePath($new = null)
{
@@ -1674,16 +1674,16 @@
/**
* Method to get an instance of a form.
*
- * @param string $name The name of the form.
- * @param string $data The name of an XML file or string to load as the form definition.
- * @param array $options An array of form options.
- * @param string $replace Flag to toggle whether form fields should be replaced if a field
+ * @param string $name The name of the form.
+ * @param string $data The name of an XML file or string to load as the form definition.
+ * @param array $options An array of form options.
+ * @param string $replace Flag to toggle whether form fields should be replaced if a field
* already exists with the same group/name.
- * @param string $xpath An optional xpath to search for the fields.
+ * @param string $xpath An optional xpath to search for the fields.
*
- * @return object JForm instance.
+ * @return object JForm instance.
* @throws Exception if an error occurs.
- * @since 11.1
+ * @since 11.1
*/
public static function getInstance($name, $data = null, $options = array(), $replace = true, $xpath = false)
{
@@ -1725,8 +1725,8 @@
/**
* Adds a new child SimpleXMLElement node to the source.
*
- * @param SimpleXMLElement The source element on which to append.
- * @param SimpleXMLElement The new element to append.
+ * @param SimpleXMLElement The source element on which to append.
+ * @param SimpleXMLElement The new element to append.
*/
protected static function addNode(SimpleXMLElement $source, SimpleXMLElement $new)
{
@@ -1765,11 +1765,11 @@
/**
* Merges new elements into a source <fields> element.
*
- * @param SimpleXMLElement The source element.
- * @param SimpleXMLElement The new element to merge.
+ * @param SimpleXMLElement The source element.
+ * @param SimpleXMLElement The new element to merge.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected static function mergeNodes(SimpleXMLElement $source, SimpleXMLElement $new)
{
Modified: development/branches/platform/libraries/joomla/form/formfield.php
===================================================================
--- development/branches/platform/libraries/joomla/form/formfield.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/formfield.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
* The description text for the form field. Usually used in tooltips.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $description;
@@ -30,7 +30,7 @@
* The JXMLElement object of the <field /> XML element that describes the form field.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $element;
@@ -38,7 +38,7 @@
* The JForm object of the form attached to the form field.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $form;
@@ -46,7 +46,7 @@
* The form control prefix for field names from the JForm object attached to the form field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $formControl;
@@ -54,7 +54,7 @@
* The hidden state for the form field.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $hidden = false;
@@ -62,7 +62,7 @@
* True to translate the field label string.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $translateLabel = true;
@@ -70,7 +70,7 @@
* True to translate the field description string.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $translateDescription = true;
@@ -78,7 +78,7 @@
* The document id for the form field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $id;
@@ -86,7 +86,7 @@
* The input for the form field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $input;
@@ -94,7 +94,7 @@
* The label for the form field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $label;
@@ -103,7 +103,7 @@
* field. Most often used for list field types.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $multiple = false;
@@ -111,7 +111,7 @@
* The name of the form field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $name;
@@ -119,7 +119,7 @@
* The name of the field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $fieldname;
@@ -127,7 +127,7 @@
* The group of the field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $group;
@@ -136,7 +136,7 @@
* be considered valid.
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $required = false;
@@ -144,7 +144,7 @@
* The form field type.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $type;
@@ -153,7 +153,7 @@
* to validate the value for a field.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $validate;
@@ -161,7 +161,7 @@
* The value of the form field.
*
* @var mixed
- * @since 11.1
+ * @since 11.1
*/
protected $value;
@@ -169,7 +169,7 @@
* The count value for generated name field
*
* @var int
- * @since 11.1
+ * @since 11.1
*/
static protected $count = 0;
@@ -177,17 +177,17 @@
* The string used for generated fields names
*
* @var int
- * @since 11.1
+ * @since 11.1
*/
static protected $generated_fieldname = '__field';
/**
* Method to instantiate the form field object.
*
- * @param object $form The form to attach to the form field object.
+ * @param object $form The form to attach to the form field object.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function __construct($form = null)
{
@@ -201,10 +201,10 @@
/**
* Method to get certain otherwise inaccessible properties from the form field object.
*
- * @param string $name The property name for which to the the value.
+ * @param string $name The property name for which to the the value.
*
- * @return mixed The property value or null.
- * @since 11.1
+ * @return mixed The property value or null.
+ * @since 11.1
*/
public function __get($name)
{
@@ -253,10 +253,10 @@
/**
* Method to attach a JForm object to the field.
*
- * @param object $form The JForm object to attach to the form field.
+ * @param object $form The JForm object to attach to the form field.
*
- * @return object The form field object so that the method can be used in a chain.
- * @since 11.1
+ * @return object The form field object so that the method can be used in a chain.
+ * @since 11.1
*/
public function setForm(JForm $form)
{
@@ -269,16 +269,16 @@
/**
* Method to attach a JForm object to the field.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement object representing the <field /> tag for the
* form field object.
- * @param mixed $value The form field default value for display.
- * @param string $group The field name group control value. This acts as as an array
+ * @param mixed $value The form field default value for display.
+ * @param string $group The field name group control value. This acts as 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]".
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setup(& $element, $value, $group = null)
{
@@ -351,11 +351,11 @@
/**
* Method to get the id used for the field input tag.
*
- * @param string $fieldId The field element id.
- * @param string $fieldName The field element name.
+ * @param string $fieldId The field element id.
+ * @param string $fieldName The field element name.
*
- * @return string The id to be used for the field input tag.
- * @since 11.1
+ * @return string The id to be used for the field input tag.
+ * @since 11.1
*/
protected function getId($fieldId, $fieldName)
{
@@ -395,16 +395,16 @@
/**
* Method to get the field input markup.
*
- * @return string The field input markup.
- * @since 11.1
+ * @return string The field input markup.
+ * @since 11.1
*/
abstract protected function getInput();
/**
* Method to get the field title.
*
- * @return string The field title.
- * @since 11.1
+ * @return string The field title.
+ * @since 11.1
*/
protected function getTitle()
{
@@ -426,8 +426,8 @@
/**
* Method to get the field label markup.
*
- * @return string The field label markup.
- * @since 11.1
+ * @return string The field label markup.
+ * @since 11.1
*/
protected function getLabel()
{
@@ -468,10 +468,10 @@
/**
* Method to get the name used for the field input tag.
*
- * @param string $fieldName The field element name.
+ * @param string $fieldName The field element name.
*
- * @return string The name to be used for the field input tag.
- * @since 11.1
+ * @return string The name to be used for the field input tag.
+ * @since 11.1
*/
protected function getName($fieldName)
{
@@ -518,10 +518,10 @@
/**
* Method to get the field name used.
*
- * @param string $name The field element name.
+ * @param string $name The field element name.
*
- * @return string The field name
- * @since 11.1
+ * @return string The field name
+ * @since 11.1
*/
protected function getFieldName($fieldName)
{
Modified: development/branches/platform/libraries/joomla/form/formrule.php
===================================================================
--- development/branches/platform/libraries/joomla/form/formrule.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/formrule.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,7 +27,7 @@
* The regular expression to use in testing a form field value.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $regex;
@@ -35,26 +35,26 @@
* The regular expression modifiers to use when testing a form field value.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $modifiers;
/**
* Method to test the value.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
Modified: development/branches/platform/libraries/joomla/form/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/form/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -34,7 +34,7 @@
* </code>
*
* @var array
- * @since 11.1
+ * @since 11.1
*
*/
protected static $paths;
@@ -51,18 +51,18 @@
* </code>
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected static $entities = array();
/**
* Method to load a form field object given a type.
*
- * @param string $type The field type.
- * @param boolean $new Flag to toggle whether we should get a new instance of the object.
+ * @param string $type The field type.
+ * @param boolean $new Flag to toggle whether we should get a new instance of the object.
*
- * @return mixed JFormField object on success, false otherwise.
- * @since 11.1
+ * @return mixed JFormField object on success, false otherwise.
+ * @since 11.1
*/
public static function loadFieldType($type, $new = true)
{
@@ -72,11 +72,11 @@
/**
* Method to load a form rule object given a type.
*
- * @param string $type The rule type.
- * @param boolean $new Flag to toggle whether we should get a new instance of the object.
+ * @param string $type The rule type.
+ * @param boolean $new Flag to toggle whether we should get a new instance of the object.
*
- * @return mixed JFormRule object on success, false otherwise.
- * @since 11.1
+ * @return mixed JFormRule object on success, false otherwise.
+ * @since 11.1
*/
public static function loadRuleType($type, $new = true)
{
@@ -88,11 +88,11 @@
* Each type is loaded only once and then used as a prototype for other objects of same type.
* Please, use this method only with those entities which support types (forms don't support them).
*
- * @param string $type The entity type.
- * @param boolean $new Flag to toggle whether we should get a new instance of the object.
+ * @param string $type The entity type.
+ * @param boolean $new Flag to toggle whether we should get a new instance of the object.
*
- * @return mixed Entity object on success, false otherwise.
- * @since 11.1
+ * @return mixed Entity object on success, false otherwise.
+ * @since 11.1
*/
protected static function loadType($entity, $type, $new = true)
{
@@ -122,9 +122,9 @@
* Attempt to import the JFormField class file if it isn't already imported.
* You can use this method outside of JForm for loading a field for inheritance or composition.
*
- * @param string Type of a field whose class should be loaded.
- * @return mixed Class name on success or false otherwise.
- * @since 11.1
+ * @param string Type of a field whose class should be loaded.
+ * @return mixed Class name on success or false otherwise.
+ * @since 11.1
*/
public static function loadFieldClass($type)
{
@@ -135,9 +135,9 @@
* Attempt to import the JFormRule class file if it isn't already imported.
* You can use this method outside of JForm for loading a rule for inheritance or composition.
*
- * @param string Type of a rule whose class should be loaded.
- * @return mixed Class name on success or false otherwise.
- * @since 11.1
+ * @param string Type of a rule whose class should be loaded.
+ * @return mixed Class name on success or false otherwise.
+ * @since 11.1
*/
public static function loadRuleClass($type)
{
@@ -149,10 +149,10 @@
* Currently, it makes sense to use this method for the "field" and "rule" entities
* (but you can support more entities in your subclass).
*
- * @param string One of the form entities (field or rule).
- * @param string Type of an entity.
+ * @param string One of the form entities (field or rule).
+ * @param string Type of an entity.
*
- * @return mixed Class name on success or false otherwise.
+ * @return mixed Class name on success or false otherwise.
*/
protected static function loadClass($entity, $type)
{
@@ -191,10 +191,10 @@
/**
* Method to add a path to the list of field include paths.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addFieldPath($new = null)
{
@@ -204,10 +204,10 @@
/**
* Method to add a path to the list of form include paths.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addFormPath($new = null)
{
@@ -217,10 +217,10 @@
/**
* Method to add a path to the list of rule include paths.
*
- * @param mixed $new A path or array of paths to add.
+ * @param mixed $new A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
public static function addRulePath($new = null)
{
@@ -231,11 +231,11 @@
* Method to add a path to the list of include paths for one of the form's entities.
* Currently supported entities: field, rule and form. You are free to support your own in a subclass.
*
- * @param string Form's entity name for which paths will be added.
- * @param mixed A path or array of paths to add.
+ * @param string Form's entity name for which paths will be added.
+ * @param mixed A path or array of paths to add.
*
- * @return array The list of paths that have been added.
- * @since 11.1
+ * @return array The list of paths that have been added.
+ * @since 11.1
*/
protected static function addPath($entity, $new = null)
{
Modified: development/branches/platform/libraries/joomla/form/rules/boolean.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/boolean.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/boolean.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,7 @@
* The regular expression to use in testing a form field value.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $regex = '^(?:[01]|true|false)$';
@@ -32,7 +32,7 @@
* The regular expression modifiers to use when testing a form field value.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $modifiers = 'i';
}
\ No newline at end of file
Modified: development/branches/platform/libraries/joomla/form/rules/email.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/email.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/email.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,26 +24,26 @@
* The regular expression to use in testing a form field value.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $regex = '^[\w.-]+(\+[\w.-]+)*@\w+[\w.-]*?\.\w{2,4}$';
/**
* Method to test the email address and optionally check for uniqueness.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
Modified: development/branches/platform/libraries/joomla/form/rules/equals.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/equals.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/equals.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,19 +25,19 @@
* XML needs a validate attribute of equals and a field attribute
* that is equal to the field to test against.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
Modified: development/branches/platform/libraries/joomla/form/rules/rules.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/rules.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/rules.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,19 +23,19 @@
/**
* Method to test the value.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
@@ -58,10 +58,10 @@
/**
* Method to get the list of permission action names from the form field value.
*
- * @param mixed $value The form field value to validate.
+ * @param mixed $value The form field value to validate.
*
- * @return array A list of permission action names from the form field value.
- * @since 11.1
+ * @return array A list of permission action names from the form field value.
+ * @since 11.1
*/
protected function getValueActions($value)
{
@@ -80,11 +80,11 @@
/**
* Method to get the list of possible permission action names for the form field.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement object representing the <field /> tag for the
* form field object.
*
- * @return array A list of permission action names from the form field element definition.
- * @since 11.1
+ * @return array A list of permission action names from the form field element definition.
+ * @since 11.1
*/
protected function getFieldActions($element)
{
Modified: development/branches/platform/libraries/joomla/form/rules/tel.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/tel.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/tel.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,19 +24,19 @@
/**
* Method to test the url for a valid parts.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
Modified: development/branches/platform/libraries/joomla/form/rules/username.php
===================================================================
--- development/branches/platform/libraries/joomla/form/rules/username.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/form/rules/username.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,19 +23,19 @@
/**
* Method to test the username for uniqueness.
*
- * @param object $element The JXMLElement object representing the <field /> tag for the
+ * @param object $element The JXMLElement 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 as an array
+ * @param mixed $value The form field value to validate.
+ * @param string $group The field name group control value. This acts as 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 object $input An optional JRegistry object with the entire data set to validate
+ * @param object $input An optional JRegistry object with the entire data set to validate
* against the entire form.
- * @param object $form The form object for which the field is being tested.
+ * @param object $form The form object for which the field is being tested.
*
- * @return boolean True if the value is valid, false otherwise.
- * @since 11.1
+ * @return boolean True if the value is valid, false otherwise.
+ * @since 11.1
* @throws JException on invalid rule.
*/
public function test(& $element, $value, $group = null, & $input = null, & $form = null)
Modified: development/branches/platform/libraries/joomla/html/editor.php
===================================================================
--- development/branches/platform/libraries/joomla/html/editor.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/editor.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -51,7 +51,7 @@
/**
* Constructor
*
- * @param string The editor name
+ * @param string The editor name
*/
public function __construct($editor = 'none')
{
@@ -62,8 +62,8 @@
* Returns the global Editor object, only creating it
* if it doesn't already exist.
*
- * @param string $editor The editor to use.
- * @return object JEditor The Editor object.
+ * @param string $editor The editor to use.
+ * @return object JEditor The Editor object.
*/
public static function getInstance($editor = 'none')
{
@@ -112,17 +112,17 @@
/**
* Display the editor area.
*
- * @param string $name The control name.
- * @param string $html The contents of the text area.
- * @param string $width The width of the text area (px or %).
- * @param string $height The height of the text area (px or %).
- * @param integer $col The number of columns for the textarea.
- * @param integer $row The number of rows for the textarea.
- * @param boolean $buttons True and the editor buttons will be displayed.
- * @param string $id An optional ID for the textarea (note: since 1.6). If not supplied the name is used.
- * @param string $asset
- * @param object $author
- * @param array $params Associative array of editor parameters.
+ * @param string $name The control name.
+ * @param string $html The contents of the text area.
+ * @param string $width The width of the text area (px or %).
+ * @param string $height The height of the text area (px or %).
+ * @param integer $col The number of columns for the textarea.
+ * @param integer $row The number of rows for the textarea.
+ * @param boolean $buttons True and the editor buttons will be displayed.
+ * @param string $id An optional ID for the textarea (note: since 1.6). If not supplied the name is used.
+ * @param string $asset
+ * @param object $author
+ * @param array $params Associative array of editor parameters.
*/
public function display($name, $html, $width, $height, $col, $row, $buttons = true, $id = null, $asset = null, $author = null, $params = array())
{
@@ -167,7 +167,7 @@
/**
* Save the editor content
*
- * @param string The name of the editor control
+ * @param string The name of the editor control
*/
public function save($editor)
{
@@ -197,9 +197,9 @@
/**
* Get the editor contents
*
- * @param string $editor The name of the editor control
+ * @param string $editor The name of the editor control
*
- * @return string
+ * @return string
*/
public function getContent($editor)
{
@@ -224,10 +224,10 @@
/**
* Set the editor contents
*
- * @param string $editor The name of the editor control
- * @param string $html The contents of the text area
+ * @param string $editor The name of the editor control
+ * @param string $html The contents of the text area
*
- * @return string
+ * @return string
*/
public function setContent($editor, $html)
{
@@ -253,8 +253,8 @@
/**
* Get the editor buttons
*
- * @param string $editor The name of the editor.
- * @param mixed $buttons Can be boolean or array, if boolean defines if the buttons are
+ * @param string $editor The name of the editor.
+ * @param mixed $buttons Can be boolean or array, if boolean defines if the buttons are
* displayed, if array defines a list of buttons not to show.
*
* @since 11.1
@@ -295,10 +295,10 @@
/**
* Load the editor
*
- * @param array $config Associative array of editor config paramaters
+ * @param array $config Associative array of editor config paramaters
*
- * @return mixed
- * @since 11.1
+ * @return mixed
+ * @since 11.1
*/
protected function _loadEditor($config = array())
{
Modified: development/branches/platform/libraries/joomla/html/html/access.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/access.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/access.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,13 +27,13 @@
/**
* Displays a list of the available access view levels
*
- * @param string The form field name.
- * @param string The name of the selected section.
- * @param string Additional attributes to add to the select field.
- * @param mixed True to add "All Sections" option or and array of options
- * @param string The form field id
+ * @param string The form field name.
+ * @param string The name of the selected section.
+ * @param string Additional attributes to add to the select field.
+ * @param mixed True to add "All Sections" option or and array of options
+ * @param string The form field id
*
- * @return string The required HTML for the SELECT tag.
+ * @return string The required HTML for the SELECT tag.
*/
public static function level($name, $selected, $attribs = '', $params = true, $id = false)
{
@@ -77,11 +77,11 @@
/**
* Displays a list of the available user groups.
*
- * @param string The form field name.
- * @param string The name of the selected section.
- * @param string Additional attributes to add to the select field.
- * @param boolean True to add "All Groups" option.
- * @return string The required HTML for the SELECT tag.
+ * @param string The form field name.
+ * @param string The name of the selected section.
+ * @param string Additional attributes to add to the select field.
+ * @param boolean True to add "All Groups" option.
+ * @return string The required HTML for the SELECT tag.
*/
public static function usergroup($name, $selected, $attribs = '', $allowAll = true)
{
@@ -121,10 +121,10 @@
/**
* Returns a UL list of user groups with check boxes
*
- * @param string $name The name of the checkbox controls array
- * @param array $selected An array of the checked boxes
+ * @param string $name The name of the checkbox controls array
+ * @param array $selected An array of the checked boxes
*
- * @return string
+ * @return string
*/
public static function usergroups($name, $selected, $checkSuperAdmin = false)
{
@@ -187,10 +187,10 @@
/**
* Returns a UL list of user groups with check boxes
*
- * @param string $name The name of the checkbox controls array
- * @param array $selected An array of the checked boxes
+ * @param string $name The name of the checkbox controls array
+ * @param array $selected An array of the checked boxes
*
- * @return string
+ * @return string
*/
public static function actions($name, $selected, $component, $section = 'global')
{
@@ -227,9 +227,9 @@
/**
* Gets a list of the asset groups as an array of JHtml compatible options.
*
- * @param array $config An array of options for the options
+ * @param array $config An array of options for the options
*
- * @return mixed An array or false if an error occurs
+ * @return mixed An array or false if an error occurs
*/
public static function assetgroups($config = array())
{
@@ -258,12 +258,12 @@
/**
* Displays a Select list of the available asset groups
*
- * @param string $name The name of the select element
- * @param mixed $selected The selected asset group id
- * @param string $attribs Optional attributes for the select field
- * @param array $config An array of options for the control
+ * @param string $name The name of the select element
+ * @param mixed $selected The selected asset group id
+ * @param string $attribs Optional attributes for the select field
+ * @param array $config An array of options for the control
*
- * @return mixed An HTML string or null if an error occurs
+ * @return mixed An HTML string or null if an error occurs
*/
public static function assetgrouplist($name, $selected, $attribs = null, $config = array())
{
Modified: development/branches/platform/libraries/joomla/html/html/behavior.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/behavior.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/behavior.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,11 +23,11 @@
*
* If debugging mode is on an uncompressed version of MooTools is included for easier debugging.
*
- * @param string $extras MooTools file to load
- * @param boolean $debug Is debugging mode on? [optional]
+ * @param string $extras MooTools file to load
+ * @param boolean $debug Is debugging mode on? [optional]
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function framework($extras = false, $debug = null)
{
@@ -63,10 +63,10 @@
/**
* Deprecated. Use JHtmlBehavior::framework() instead.
*
- * @param boolean $debug Is debugging mode on? [optional]
+ * @param boolean $debug Is debugging mode on? [optional]
* @deprecated
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function mootools($debug = null)
{
@@ -76,8 +76,8 @@
/**
* Add unobtrusive javascript support for image captions.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function caption()
{
@@ -104,8 +104,8 @@
* Additional handlers can be added to the handler for username, password,
* numeric and email. To use these add class="validate-email" and so on.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function formvalidation()
{
@@ -128,8 +128,8 @@
* Add unobtrusive javascript support for submenu switcher support in
* Global Configuration and System Information.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function switcher()
{
@@ -166,8 +166,8 @@
* Note that this control is only reliable in absolutely positioned elements.
* Avoid using a combobox in a slider or dynamic pane.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function combobox()
{
@@ -204,11 +204,11 @@
*
* Uses the core Tips class in MooTools.
*
- * @param string $selector The class selector for the tooltip.
- * @param array $params An array of options for the tooltip.
+ * @param string $selector The class selector for the tooltip.
+ * @param array $params An array of options for the tooltip.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function tooltip($selector='.hasTip', $params = array())
{
@@ -274,11 +274,11 @@
* - onShow
* - onHide
*
- * @param string $selector The class selector for which a modal behaviour is to be applied.
- * @param array $params An array of parameters for the modal behaviour.
+ * @param string $selector The class selector for which a modal behaviour is to be applied.
+ * @param array $params An array of parameters for the modal behaviour.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function modal($selector = 'a.modal', $params = array())
{
@@ -349,12 +349,12 @@
/**
* Add unobtrusive javascript support for the advanced uploader.
*
- * @param string $id
- * @param array $params An array of options for the uploader.
- * @param string $upload_queue
+ * @param string $id
+ * @param array $params An array of options for the uploader.
+ * @param string $upload_queue
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function uploader($id='file-upload', $params = array(), $upload_queue='upload-queue')
{
@@ -507,12 +507,12 @@
/**
* Add unobtrusive javascript support for a collapsible tree.
*
- * @param $id string
- * @param $params array An array of options.
- * @param $root array
+ * @param $id string
+ * @param $params array An array of options.
+ * @param $root array
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function tree($id, $params = array(), $root = array())
{
@@ -574,8 +574,8 @@
/**
* Add unobtrusive javascript support for a calendar control.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function calendar()
{
@@ -605,8 +605,8 @@
/**
* Keep session alive, for example, while editing or creating an article.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function keepalive()
{
@@ -648,8 +648,8 @@
/**
* Break us out of any containing iframes
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function noframes($location='top.location.href')
{
@@ -676,10 +676,10 @@
/**
* Internal method to get a JavaScript object notation string from an array
*
- * @param array $array The array to convert to JavaScript object notation
+ * @param array $array The array to convert to JavaScript object notation
*
- * @return string JavaScript object notation representation of the array
- * @since 11.1
+ * @return string JavaScript object notation representation of the array
+ * @since 11.1
*/
protected static function _getJSObject($array=array())
{
@@ -732,8 +732,8 @@
/**
* Internal method to translate the JavaScript Calendar
*
- * @return string JavaScript that translates the object
- * @since 11.1
+ * @return string JavaScript that translates the object
+ * @since 11.1
*/
protected static function _calendartranslation()
{
Modified: development/branches/platform/libraries/joomla/html/html/category.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/category.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/category.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,10 +27,10 @@
/**
* Returns an array of categories for the given extension.
*
- * @param string The extension option.
- * @param array An array of configuration options. By default, only published and unpulbished categories are returned.
+ * @param string The extension option.
+ * @param array An array of configuration options. By default, only published and unpulbished categories are returned.
*
- * @return array
+ * @return array
*/
public static function options($extension, $config = array('filter.published' => array(0,1)))
{
@@ -79,10 +79,10 @@
/**
* Returns an array of categories for the given extension.
*
- * @param string The extension option.
- * @param array An array of configuration options. By default, only published and unpulbished categories are returned.
+ * @param string The extension option.
+ * @param array An array of configuration options. By default, only published and unpulbished categories are returned.
*
- * @return array
+ * @return array
*/
public static function categories($extension, $config = array('filter.published' => array(0,1)))
{
Modified: development/branches/platform/libraries/joomla/html/html/content.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/content.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/content.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,9 +21,9 @@
/**
* Fire onContentPrepare for content that isn't part of an article.
*
- * @param string The content to be transformed.
- * @param array The content params.
- * @return string The content after transformation.
+ * @param string The content to be transformed.
+ * @param array The content params.
+ * @return string The content after transformation.
*/
public static function prepare($text, $params = null)
{
Modified: development/branches/platform/libraries/joomla/html/html/contentlanguage.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/contentlanguage.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/contentlanguage.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,8 +27,8 @@
/**
* Get a list of the available content language items.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function existing($all = false, $translate=false)
{
Modified: development/branches/platform/libraries/joomla/html/html/form.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/form.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/form.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,8 +23,8 @@
*
* Use in conjuction with JRequest::checkToken
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public static function token()
{
Modified: development/branches/platform/libraries/joomla/html/html/grid.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/grid.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/grid.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,12 +22,12 @@
/**
* Display a boolean setting widget.
*
- * @param integer The row index.
- * @param integer The value of the boolean field.
- * @param string Task to turn the boolean setting on.
- * @param string Task to turn the boolean setting off.
+ * @param integer The row index.
+ * @param integer The value of the boolean field.
+ * @param string Task to turn the boolean setting on.
+ * @param string Task to turn the boolean setting off.
*
- * @return string The boolean setting widget.
+ * @return string The boolean setting widget.
* @since 1.0
*/
static function boolean($i, $value, $taskOn = null, $taskOff = null)
@@ -55,14 +55,14 @@
}
/**
- * @param string The link title
- * @param string The order field for the column
- * @param string The current direction
- * @param string The selected ordering
- * @param string An optional task override
- * @param string An optional direction for the new column
+ * @param string The link title
+ * @param string The order field for the column
+ * @param string The current direction
+ * @param string The selected ordering
+ * @param string An optional task override
+ * @param string An optional direction for the new column
*
- * @return string
+ * @return string
*/
public static function sort($title, $order, $direction = 'asc', $selected = 0, $task=NULL, $new_direction='asc')
{
@@ -89,12 +89,12 @@
}
/**
- * @param integer The row index
- * @param integer The record id
- * @param boolean
- * @param string The name of the form element
+ * @param integer The row index
+ * @param integer The record id
+ * @param boolean
+ * @param string The name of the form element
*
- * @return string
+ * @return string
*/
public static function id($rowNum, $recId, $checkedOut=false, $name='cid')
{
@@ -168,13 +168,13 @@
}
/**
- * @param mixed $value Either the scalar value, or an object (for backward compatibility, deprecated)
- * @param integer $i
- * @param string $img1 Image for a positive or on value
- * @param string $img0 Image for the empty or off value
- * @param string $prefix An optional prefix for the task
+ * @param mixed $value Either the scalar value, or an object (for backward compatibility, deprecated)
+ * @param integer $i
+ * @param string $img1 Image for a positive or on value
+ * @param string $img0 Image for the empty or off value
+ * @param string $prefix An optional prefix for the task
*
- * @return string
+ * @return string
*/
public static function published($value, $i, $img1 = 'tick.png', $img0 = 'publish_x.png', $prefix='')
{
Modified: development/branches/platform/libraries/joomla/html/html/image.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/image.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/image.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,13 +24,13 @@
* Also can be used in conjunction with the menulist param to create the chosen image
* load the default or use no image.
*
- * @param string $file The file name, eg foobar.png.
- * @param string $folder The path to the image.
- * @param integer $altFile Empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder.
- * @param string $altFolder Another path. Only used for the contact us form based on the value of the imagelist param.
- * @param string $alt Alternative text.
- * @param array $attribs An associative array of attributes to add.
- * @param bool $asTag True (default) to display full tag, false to return just the path.
+ * @param string $file The file name, eg foobar.png.
+ * @param string $folder The path to the image.
+ * @param integer $altFile Empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder.
+ * @param string $altFolder Another path. Only used for the contact us form based on the value of the imagelist param.
+ * @param string $alt Alternative text.
+ * @param array $attribs An associative array of attributes to add.
+ * @param bool $asTag True (default) to display full tag, false to return just the path.
* @deprecated since 1.6
*/
public static function site($file, $folder = '/images/system/', $altFile = null, $altFolder = '/images/system/', $alt = null, $attribs = null, $asTag = true)
@@ -95,13 +95,13 @@
* Also can be used in conjunction with the menulist param to create the chosen image
* load the default or use no image
*
- * @param string $file The file name, eg foobar.png.
- * @param string $folder The path to the image.
- * @param integer $altFile Empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder.
- * @param string $altFolder Another path. Only used for the contact us form based on the value of the imagelist param.
- * @param string $alt Alternative text.
- * @param array $attribs An associative array of attributes to add.
- * @param bool $asTag True (default) to display full tag, false to return just the path.
+ * @param string $file The file name, eg foobar.png.
+ * @param string $folder The path to the image.
+ * @param integer $altFile Empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder.
+ * @param string $altFolder Another path. Only used for the contact us form based on the value of the imagelist param.
+ * @param string $alt Alternative text.
+ * @param array $attribs An associative array of attributes to add.
+ * @param bool $asTag True (default) to display full tag, false to return just the path.
* @deprecated since 1.6
*/
public static function administrator($file, $folder = '/images/', $altFile = null, $altFolder = '/images/', $alt = null, $attribs = null, $asTag = true)
Modified: development/branches/platform/libraries/joomla/html/html/jgrid.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/jgrid.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/jgrid.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,22 +21,22 @@
/**
* Returns an action on a grid
*
- * @param integer $i The row index
- * @param string $task The task to fire
- * @param string|array $prefix An optional task prefix or an array of options
- * @param string $text An optional text to display
- * @param string $active_title An optional active tooltip to display if $enable is true
- * @param string $inactive_title An optional inactive tooltip to display if $enable is true
- * @param boolean $tip An optional setting for tooltip
- * @param string $active_class An optional active HTML class
- * @param string $inactive_class An optional inactive HTML class
- * @param boolean $enabled An optional setting for access control on the action.
- * @param boolean $translate An optional setting for translation.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $i The row index
+ * @param string $task The task to fire
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param string $text An optional text to display
+ * @param string $active_title An optional active tooltip to display if $enable is true
+ * @param string $inactive_title An optional inactive tooltip to display if $enable is true
+ * @param boolean $tip An optional setting for tooltip
+ * @param string $active_class An optional active HTML class
+ * @param string $inactive_class An optional inactive HTML class
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param boolean $translate An optional setting for translation.
+ * @param string $checkbox An optional prefix for checkboxes.
*
* @return The Html code
*
- * @since 11.1
+ * @since 11.1
*/
public static function action($i, $task, $prefix='', $text='', $active_title='', $inactive_title='', $tip=false, $active_class='', $inactive_class='', $enabled = true, $translate=true, $checkbox='cb')
{
@@ -67,14 +67,14 @@
/**
* Returns a state on a grid
*
- * @param array $states array of value/state. Each state is an array of the form (task, text, title,html active class, HTML inactive class)
+ * @param array $states array of value/state. Each state is an array of the form (task, text, title,html active class, HTML inactive class)
* or ('task'=>task, 'text'=>text, 'active_title'=>active title, 'inactive_title'=>inactive title, 'tip'=>boolean, 'active_class'=>html active class, 'inactive_class'=>html inactive class)
- * @param integer $value The state value.
- * @param integer $i The row index
- * @param string|array $prefix An optional task prefix or an array of options
- * @param boolean $enabled An optional setting for access control on the action.
- * @param boolean $translate An optional setting for translation.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $value The state value.
+ * @param integer $i The row index
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param boolean $translate An optional setting for translation.
+ * @param string $checkbox An optional prefix for checkboxes.
*
* @return The Html code
*
@@ -104,19 +104,19 @@
/**
* Returns a published state on a grid
*
- * @param integer $value The state value.
- * @param integer $i The row index
- * @param string|array $prefix An optional task prefix or an array of options
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
- * @param string $publish_up An optional start publishing date.
- * @param string $publish_down An optional finish publishing date.
+ * @param integer $value The state value.
+ * @param integer $i The row index
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
+ * @param string $publish_up An optional start publishing date.
+ * @param string $publish_down An optional finish publishing date.
*
* @return The Html code
*
* @see JHtmlJGrid::state
*
- * @since 11.1
+ * @since 11.1
*/
public static function published($value, $i, $prefix = '', $enabled = true, $checkbox = 'cb', $publish_up = null, $publish_down = null)
{
@@ -186,17 +186,17 @@
/**
* Returns a isDefault state on a grid
*
- * @param integer $value The state value.
- * @param integer $i The row index
- * @param string|array $prefix An optional task prefix or an array of options
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $value The state value.
+ * @param integer $i The row index
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
*
* @return The Html code
*
* @see JHtmlJGrid::state
*
- * @since 11.1
+ * @since 11.1
*/
public static function isdefault($value, $i, $prefix = '', $enabled = true, $checkbox='cb')
{
@@ -216,13 +216,13 @@
/**
* Returns an array of standard published state filter options.
*
- * @param array An array of configuration options.
+ * @param array An array of configuration options.
* This array can contain a list of key/value pairs where values are boolean
* and keys can be taken from 'published', 'unpublished', 'archived', 'trash', 'all'.
* These pairs determine which values are displayed.
- * @return string The HTML code for the select tag
+ * @return string The HTML code for the select tag
*
- * @since 11.1
+ * @since 11.1
*/
public static function publishedOptions($config = array())
{
@@ -249,16 +249,16 @@
/**
* Returns a checked-out icon
*
- * @param integer $i The row index.
- * @param string $editorName The name of the editor.
- * @param string $time The time that the object was checked out.
- * @param string|array $prefix An optional task prefix or an array of options
- * @param string $text The text to display
- * @param boolean $enabled True to enable the action.
+ * @param integer $i The row index.
+ * @param string $editorName The name of the editor.
+ * @param string $time The time that the object was checked out.
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param string $text The text to display
+ * @param boolean $enabled True to enable the action.
*
- * @return string The required HTML.
+ * @return string The required HTML.
*
- * @since 11.1
+ * @since 11.1
*/
public static function checkedout($i, $editorName, $time, $prefix='', $enabled=false, $checkbox='cb')
{
@@ -280,16 +280,16 @@
/**
* Creates a order-up action icon.
*
- * @param integer $i The row index.
- * @param string $task An optional task to fire.
- * @param string|array $prefix An optional task prefix or an array of options
- * @param string $text An optional text to display
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $i The row index.
+ * @param string $task An optional task to fire.
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param string $text An optional text to display
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
*
- * @return string The required HTML.
+ * @return string The required HTML.
*
- * @since 11.1
+ * @since 11.1
*/
public static function orderUp($i, $task='orderup', $prefix='', $text = 'JLIB_HTML_MOVE_UP', $enabled = true, $checkbox='cb')
{
@@ -306,16 +306,16 @@
/**
* Creates a order-down action icon.
*
- * @param integer $i The row index.
- * @param string $task An optional task to fire.
- * @param string|array $prefix An optional task prefix or an array of options
- * @param string $text An optional text to display
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $i The row index.
+ * @param string $task An optional task to fire.
+ * @param string|array $prefix An optional task prefix or an array of options
+ * @param string $text An optional text to display
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
*
- * @return string The required HTML.
+ * @return string The required HTML.
*
- * @since 11.1
+ * @since 11.1
*/
public static function orderDown($i, $task='orderdown', $prefix='', $text = 'JLIB_HTML_MOVE_DOWN', $enabled = true, $checkbox='cb')
{
Modified: development/branches/platform/libraries/joomla/html/html/list.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/list.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/list.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -64,11 +64,11 @@
/**
* Returns an array of options
*
- * @param string $sql SQL with ordering As value and 'name field' AS text
- * @param integer $chop The length of the truncated headline
+ * @param string $sql SQL with ordering As value and 'name field' AS text
+ * @param integer $chop The length of the truncated headline
*
- * @return array An array of objects formatted for JHtml list processing
- * @since 11.1
+ * @return array An array of objects formatted for JHtml list processing
+ * @since 11.1
*/
public static function genericordering($sql, $chop = '30')
{
@@ -130,14 +130,14 @@
/**
* Build the select list for Ordering derived from a query
*
- * @param integer $value The scalar value
- * @param string $query
- * @param string $attribs HTML tag attributes
- * @param integer $neworder 1 if new and first, -1 if new and last, 0 or null if existing item
- * @param string $prefix An optional prefix for the task
+ * @param integer $value The scalar value
+ * @param string $query
+ * @param string $attribs HTML tag attributes
+ * @param integer $neworder 1 if new and first, -1 if new and last, 0 or null if existing item
+ * @param string $prefix An optional prefix for the task
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function ordering($name, $query, $attribs = null, $selected = null, $neworder = null, $chop = null)
{
Modified: development/branches/platform/libraries/joomla/html/html/menu.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/menu.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/menu.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,8 +32,8 @@
/**
* Get a list of the available menus.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function menus()
{
@@ -54,9 +54,9 @@
/**
* Returns an array of menu items groups by menu.
*
- * @param array An array of configuration options.
+ * @param array An array of configuration options.
*
- * @return array
+ * @return array
*/
public static function menuitems($config = array())
{
@@ -128,12 +128,12 @@
/**
* Displays an HTML select list of menu items.
*
- * @param string The name of the control.
- * @param string The value of the selected option.
- * @param string Attributes for the control.
- * @param array An array of options for the control.
+ * @param string The name of the control.
+ * @param string The value of the selected option.
+ * @param string Attributes for the control.
+ * @param array An array of options for the control.
*
- * @return string
+ * @return string
*/
public static function menuitemlist($name, $selected = null, $attribs = null, $config = array())
{
Modified: development/branches/platform/libraries/joomla/html/html/number.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/number.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/number.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,12 +25,12 @@
* By default, the proper format will automatically be chosen.
* However, one of the allowed unit types may also be used instead.
*
- * @param integer $bytes The number of bytes.
- * @param string $unit The type of unit to return.
- * @param integer $precision The number of digits to be used after the decimal place.
+ * @param integer $bytes The number of bytes.
+ * @param string $unit The type of unit to return.
+ * @param integer $precision The number of digits to be used after the decimal place.
*
- * @return string The number of bytes in the proper units.
- * @since 11.1
+ * @return string The number of bytes in the proper units.
+ * @since 11.1
*/
public static function bytes($bytes, $unit = 'auto', $precision = 2)
{
Modified: development/branches/platform/libraries/joomla/html/html/rules.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/rules.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/rules.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,12 +22,12 @@
/**
* Displays a list of the available access sections
*
- * @param string The form field name.
- * @param string The name of the selected section.
- * @param string Additional attributes to add to the select field.
- * @param boolean True to add "All Sections" option.
+ * @param string The form field name.
+ * @param string The name of the selected section.
+ * @param string Additional attributes to add to the select field.
+ * @param boolean True to add "All Sections" option.
*
- * @return string The required HTML for the SELECT tag.
+ * @return string The required HTML for the SELECT tag.
*/
public static function assetFormWidget($actions, $assetId = null, $parent = null, $control = 'jform[rules]', $idPrefix = 'jform_rules')
{
Modified: development/branches/platform/libraries/joomla/html/html/select.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/select.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/select.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -41,10 +41,10 @@
/**
* Generates a yes/no radio list.
*
- * @param string The value of the HTML name attribute
- * @param string Additional HTML attributes for the <select> tag
- * @param mixed The key that is selected
- * @return string HTML for the radio list
+ * @param string The value of the HTML name attribute
+ * @param string Additional HTML attributes for the <select> tag
+ * @param mixed The key that is selected
+ * @return string HTML for the radio list
*/
public static function booleanlist(
$name, $attribs = null, $selected = null, $yes = 'JYES', $no = 'JNO', $id = false
@@ -59,9 +59,9 @@
/**
* Generates an HTML selection list.
*
- * @param array An array of objects, arrays, or scalars.
- * @param string The value of the HTML name attribute.
- * @param mixed Additional HTML attributes for the <select> tag. This
+ * @param array An array of objects, arrays, or scalars.
+ * @param string The value of the HTML name attribute.
+ * @param mixed Additional HTML attributes for the <select> tag. This
* can be an array of attributes, or an array of options. Treated as options
* if it is the last argument passed. Valid options are:
* Format options, see {@see JHtml::$formatOptions}.
@@ -134,10 +134,10 @@
/**
* Generates a grouped HTML selection list from nested arrays.
*
- * @param array An array of groups, each of which is an array of
+ * @param array An array of groups, each of which is an array of
* options.
- * @param string The value of the HTML name attribute
- * @param array Options, an array of key/value pairs. Valid options are:
+ * @param string The value of the HTML name attribute
+ * @param array Options, an array of key/value pairs. Valid options are:
* Format options, {@see JHtml::$formatOptions}.
* Selection options. See {@see JTtmlSelect::options()}.
* group.id: The property in each group to use as the group id
@@ -335,14 +335,14 @@
/**
* Create a placeholder for an option group.
*
- * @param string $text The text for the option
- * @param string $optkey The returned object property name for the value
- * @param string $optText The returned object property name for the text
- *
+ * @param string $text The text for the option
+ * @param string $optkey The returned object property name for the value
+ * @param string $optText The returned object property name for the text
+ *
* @see JHtmlSelect::groupedList()
- *
- * @return object
- * @since 11.1
+ *
+ * @return object
+ * @since 11.1
* @deprecated Use JHtmlSelect::groupedList()
*/
public static function optgroup($text, $optKey = 'value', $optText = 'text')
Modified: development/branches/platform/libraries/joomla/html/html/sliders.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/sliders.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/sliders.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,10 +23,10 @@
/**
* Creates a panes and loads the javascript behavior for it.
*
- * @param string The pane identifier.
- * @param array An array of options.
- * @return string
- * @since 11.1
+ * @param string The pane identifier.
+ * @param array An array of options.
+ * @return string
+ * @since 11.1
*/
public static function start($group = 'sliders', $params = array())
{
@@ -37,8 +37,8 @@
/**
* Close the current pane.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function end()
{
@@ -48,10 +48,10 @@
/**
* Begins the display of a new panel.
*
- * @param string Text to display.
- * @param string Identifier of the panel.
- * @return string
- * @since 11.1
+ * @param string Text to display.
+ * @param string Identifier of the panel.
+ * @return string
+ * @since 11.1
*/
public static function panel($text, $id)
{
@@ -61,10 +61,10 @@
/**
* Load the JavaScript behavior.
*
- * @param string The pane identifier.
- * @param array Array of options.
- * @return void
- * @since 11.1
+ * @param string The pane identifier.
+ * @param array Array of options.
+ * @return void
+ * @since 11.1
*/
protected static function _loadBehavior($group, $params = array())
{
Modified: development/branches/platform/libraries/joomla/html/html/string.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/string.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/string.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,9 +24,9 @@
* word, it will find the first space that is within the limit and
* truncate at that point. This method is UTF-8 safe.
*
- * @param string $text The text to truncate.
- * @param integer $length The maximum length of the text.
- * @return string The truncated text.
+ * @param string $text The text to truncate.
+ * @param integer $length The maximum length of the text.
+ * @return string The truncated text.
*/
public static function truncate($text, $length = 0)
{
@@ -87,11 +87,11 @@
*
* eg. Transform "Really long title" to "Really...title"
*
- * @param string $text The text to abridge.
- * @param integer $length The maximum length of the text.
- * @param integer $intro The maximum length of the intro text.
- *
- * @return string The abridged text.
+ * @param string $text The text to abridge.
+ * @param integer $length The maximum length of the text.
+ * @param integer $intro The maximum length of the intro text.
+ *
+ * @return string The abridged text.
*/
public static function abridge($text, $length = 50, $intro = 30)
{
Modified: development/branches/platform/libraries/joomla/html/html/tabs.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/tabs.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/tabs.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,10 +22,10 @@
/**
* Creates a panes and creates the JavaScript object for it.
*
- * @param string The pane identifier
- * @param array An array of option.
- * @return string
- * @since 11.1
+ * @param string The pane identifier
+ * @param array An array of option.
+ * @return string
+ * @since 11.1
*/
public static function start($group='tabs', $params=array())
{
@@ -37,8 +37,8 @@
/**
* Close the current pane
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function end()
{
@@ -48,10 +48,10 @@
/**
* Begins the display of a new panel.
*
- * @param string Text to display.
- * @param string Identifier of the panel.
- * @return string
- * @since 11.1
+ * @param string Text to display.
+ * @param string Identifier of the panel.
+ * @return string
+ * @since 11.1
*/
public static function panel($text, $id)
{
@@ -61,10 +61,10 @@
/**
* Load the JavaScript behavior.
*
- * @param string The pane identifier.
- * @param array Array of options.
- * @return void
- * @since 11.1
+ * @param string The pane identifier.
+ * @param array Array of options.
+ * @return void
+ * @since 11.1
*/
protected static function _loadBehavior($group, $params = array())
{
Modified: development/branches/platform/libraries/joomla/html/html/tel.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html/tel.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html/tel.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,13 +23,13 @@
* By default, the ITU-T format will automatically be used.
* However, one of the allowed unit types may also be used instead.
*
- * @param integer $number The integers in a phone number with dot separated country code
- * ccc.nnnnnnn where ccc represents country code and nnn represents the local number.
- * @param string $displayplanThe numbering plan used to display the numbers.
- * @param string $layout Optional user defined layout to be used.
+ * @param integer $number The integers in a phone number with dot separated country code
+ * ccc.nnnnnnn where ccc represents country code and nnn represents the local number.
+ * @param string $displayplanThe numbering plan used to display the numbers.
+ * @param string $layout Optional user defined layout to be used.
*
- * @return string $display The formatted telephone number.
- * @since 11.1
+ * @return string $display The formatted telephone number.
+ * @since 11.1
*/
public static function tel($number, $displayplan)
{
Modified: development/branches/platform/libraries/joomla/html/html.php
===================================================================
--- development/branches/platform/libraries/joomla/html/html.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/html.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -69,7 +69,7 @@
* Additional arguments may be supplied and are passed to the sub-class.
* Additional include paths are also able to be specified for third-party use
*
- * @param string The name of helper method to load, (prefix).(class).function
+ * @param string The name of helper method to load, (prefix).(class).function
* prefix and class are optional and can be used to load custom
* html helpers.
*/
@@ -126,8 +126,8 @@
/**
* Registers a function to be called with a specific key
*
- * @param string The name of the key
- * @param string Function or method
+ * @param string The name of the key
+ * @param string Function or method
*/
public static function register($key, $function)
{
@@ -143,7 +143,7 @@
/**
* Removes a key for a method from registry.
*
- * @param string The name of the key
+ * @param string The name of the key
*/
public static function unregister($key)
{
@@ -159,7 +159,7 @@
/**
* Test if the key is registered.
*
- * @param string The name of the key
+ * @param string The name of the key
*/
public static function isRegistered($key)
{
@@ -170,8 +170,8 @@
/**
* Function caller method
*
- * @param string Function or method to call
- * @param array Arguments to be passed to function
+ * @param string Function or method to call
+ * @param array Arguments to be passed to function
*/
protected static function call($function, $args)
{
@@ -193,12 +193,12 @@
/**
* Write a <a></a> element
*
- * @param string The relative URL to use for the href attribute
- * @param string The target attribute to use
- * @param array An associative array of attributes to add
- *
- * @return string <a></a> string
- * @since 11.1
+ * @param string The relative URL to use for the href attribute
+ * @param string The target attribute to use
+ * @param array An associative array of attributes to add
+ *
+ * @return string <a></a> string
+ * @since 11.1
*/
public static function link($url, $text, $attribs = null)
{
@@ -212,13 +212,13 @@
/**
* Write a <iframe></iframe> element
*
- * @param string The relative URL to use for the src attribute
- * @param string The target attribute to use
- * @param array An associative array of attributes to add
- * @param string The message to display if the iframe tag is not supported
- *
- * @return string <iframe></iframe> element or message if not supported
- * @since 11.1
+ * @param string The relative URL to use for the src attribute
+ * @param string The target attribute to use
+ * @param array An associative array of attributes to add
+ * @param string The message to display if the iframe tag is not supported
+ *
+ * @return string <iframe></iframe> element or message if not supported
+ * @since 11.1
*/
public static function iframe($url, $name, $attribs = null, $noFrames = '')
{
@@ -231,14 +231,14 @@
/**
* Compute the files to be include
- * @param string path to file
- * @param boolean path to file is relative to /media folder
- * @param boolean detect browser to include specific browser js files
- * @param folder folder name to search into (images, css, js, ...)
+ * @param string path to file
+ * @param boolean path to file is relative to /media folder
+ * @param boolean detect browser to include specific browser js files
+ * @param folder folder name to search into (images, css, js, ...)
* @see JBrowser
- *
- * @return array files to be included
- * @since 11.1
+ *
+ * @return array files to be included
+ * @since 11.1
*/
protected static function _includeRelativeFiles($file, $relative, $detect_browser, $folder)
{
@@ -360,13 +360,13 @@
/**
* Write a <img></img> element
*
- * @param string The relative or absolute URL to use for the src attribute
- * @param string The target attribute to use
- * @param array An associative array of attributes to add
- * @param boolean If set to true, it tries to find an override for the file in the template
- *
- * @return string
- * @since 11.1
+ * @param string The relative or absolute URL to use for the src attribute
+ * @param string The target attribute to use
+ * @param array An associative array of attributes to add
+ * @param boolean If set to true, it tries to find an override for the file in the template
+ *
+ * @return string
+ * @since 11.1
*/
public static function image($file, $alt, $attribs = null, $relative = false, $path_only = false)
{
@@ -394,11 +394,11 @@
/**
* Write a <link rel="stylesheet" style="text/css" /> element
*
- * @param string path to file
- * @param array attributes to be added to the stylesheet
- * @param boolean path to file is relative to /media folder
- * @param boolean return the path to the file only
- * @param boolean detect browser to include specific browser css files
+ * @param string path to file
+ * @param array attributes to be added to the stylesheet
+ * @param boolean path to file is relative to /media folder
+ * @param boolean return the path to the file only
+ * @param boolean detect browser to include specific browser css files
* will try to include file, file_*browser*, file_*browser*_*major*, file_*browser*_*major*_*minor*
* <table>
* <tr><th>Navigator</th> <th>browser</th> <th>major.minor</th></tr>
@@ -425,8 +425,8 @@
* a lot of others
* @see JBrowser
*
- * @return mixed nothing if $path_only is false, null, path or array of path if specific css browser files were detected
- * @since 11.1
+ * @return mixed nothing if $path_only is false, null, path or array of path if specific css browser files were detected
+ * @since 11.1
*/
public static function stylesheet($file, $attribs = array(), $relative = false, $path_only = false, $detect_browser = true)
{
@@ -469,15 +469,15 @@
/**
* Write a <script></script> element
- * @param string path to file
- * @param boolean load the JS framework
- * @param boolean path to file is relative to /media folder
- * @param boolean return the path to the file only
- * @param boolean detect browser to include specific browser js files
- *
- * @return mixed nothing if $path_only is false, null, path or array of path if specific js browser files were detected
+ * @param string path to file
+ * @param boolean load the JS framework
+ * @param boolean path to file is relative to /media folder
+ * @param boolean return the path to the file only
+ * @param boolean detect browser to include specific browser js files
+ *
+ * @return mixed nothing if $path_only is false, null, path or array of path if specific js browser files were detected
* @see JHtml::stylesheet
- * @since 11.1
+ * @since 11.1
*/
public static function script($file, $framework = false, $relative = false, $path_only = false, $detect_browser = true)
{
@@ -539,7 +539,7 @@
* Updates the formatOptions array with all valid values in the passed
* array. See {@see JHtml::$formatOptions} for details.
*
- * @param array Option key/value pairs.
+ * @param array Option key/value pairs.
*/
public static function setFormatOptions($options)
{
@@ -555,13 +555,13 @@
/**
* Returns formated date according to a given format and time zone.
*
- * @param string String in a format accepted by date(), defaults to "now".
- * @param string format optional format for strftime
- * @param mixed Time zone to be used for the date. Special cases: boolean true for user
+ * @param string String in a format accepted by date(), defaults to "now".
+ * @param string format optional format for strftime
+ * @param mixed Time zone to be used for the date. Special cases: boolean true for user
* setting, boolean false for server setting.
- * @return string A date translated by the given format and time zone.
+ * @return string A date translated by the given format and time zone.
* @see strftime
- * @since 11.1
+ * @since 11.1
*/
public static function date($input = 'now', $format = null, $tz = true, $gregorian=false)
{
@@ -618,16 +618,16 @@
/**
* Creates a tooltip with an image as button
*
- * @param string $tooltip The tip string
- * @param string|array $title The title of the tooltip or an associative array with keys contained in {'title','image','text','href','alt'} and values
+ * @param string $tooltip The tip string
+ * @param string|array $title The title of the tooltip or an associative array with keys contained in {'title','image','text','href','alt'} and values
* corresponding to parameters of the same name.
- * @param string $image The image for the tip, if no text is provided
- * @param string $text The text for the tip
- * @param string $href An URL that will be used to create the link
- * @param string $alt The alt attribute for img tag
+ * @param string $image The image for the tip, if no text is provided
+ * @param string $text The text for the tip
+ * @param string $href An URL that will be used to create the link
+ * @param string $alt The alt attribute for img tag
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public static function tooltip($tooltip, $title = '', $image = 'tooltip.png', $text = '', $href = '', $alt = 'Tooltip', $class='hasTip')
{
@@ -679,11 +679,11 @@
/**
* Displays a calendar control field
*
- * @param string The date value
- * @param string The name of the text field
- * @param string The id of the text field
- * @param string The date format
- * @param array Additional HTML attributes
+ * @param string The date value
+ * @param string The name of the text field
+ * @param string The id of the text field
+ * @param string The date format
+ * @param array Additional HTML attributes
*/
public static function calendar($value, $name, $id, $format = '%Y-%m-%d', $attribs = null)
{
@@ -732,10 +732,10 @@
* Add a directory where JHtml should search for helpers. You may
* either pass a string or an array of directories.
*
- * @param string A path to search.
- *
- * @return array An array with directory elements
- * @since 11.1
+ * @param string A path to search.
+ *
+ * @return array An array with directory elements
+ * @since 11.1
*/
public static function addIncludePath($path = '')
{
Modified: development/branches/platform/libraries/joomla/html/pagination.php
===================================================================
--- development/branches/platform/libraries/joomla/html/pagination.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/pagination.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -59,17 +59,17 @@
* may be useful for filters and extra values when dealing with lists and GET requests.
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $_additionalUrlParams = array();
/**
* Constructor.
*
- * @param integer The total number of items.
- * @param integer The offset of the item to start at.
- * @param integer The number of items to display per page.
- * @param string The prefix used for request variables.
+ * @param integer The total number of items.
+ * @param integer The offset of the item to start at.
+ * @param integer The number of items to display per page.
+ * @param string The prefix used for request variables.
*/
function __construct($total, $limitstart, $limit, $prefix = '')
{
@@ -131,12 +131,12 @@
* Method to set an additional URL parameter to be added to all pagination class generated
* links.
*
- * @param string $key The name of the URL parameter for which to set a value.
- * @param mixed $value The value to set for the URL parameter.
+ * @param string $key The name of the URL parameter for which to set a value.
+ * @param mixed $value The value to set for the URL parameter.
*
- * @return mixed The old value for the parameter.
+ * @return mixed The old value for the parameter.
*
- * @since 11.1
+ * @since 11.1
*/
public function setAdditionalUrlParam($key, $value)
{
@@ -158,11 +158,11 @@
* Method to get an additional URL parameter (if it exists) to be added to
* all pagination class generated links.
*
- * @param string $key The name of the URL parameter for which to get the value.
+ * @param string $key The name of the URL parameter for which to get the value.
*
- * @return mixed The value if it exists or null if it does not.
+ * @return mixed The value if it exists or null if it does not.
*
- * @since 11.1
+ * @since 11.1
*/
public function getAdditionalUrlParam($key)
{
@@ -174,9 +174,9 @@
/**
* Return the rationalised offset for a row with a given index.
*
- * @param integer $index The row index
- * @return integer Rationalised offset for a row with a given index.
- * @since 11.1
+ * @param integer $index The row index
+ * @return integer Rationalised offset for a row with a given index.
+ * @since 11.1
*/
public function getRowOffset($index)
{
@@ -186,8 +186,8 @@
/**
* Return the pagination data object, only creating it if it doesn't already exist.
*
- * @return object Pagination data object.
- * @since 11.1
+ * @return object Pagination data object.
+ * @since 11.1
*/
public function getData()
{
@@ -201,8 +201,8 @@
/**
* Create and return the pagination pages counter string, ie. Page 2 of 4.
*
- * @return string Pagination pages counter string.
- * @since 11.1
+ * @return string Pagination pages counter string.
+ * @since 11.1
*/
public function getPagesCounter()
{
@@ -217,8 +217,8 @@
/**
* Create and return the pagination result set counter string, ie. Results 1-10 of 42
*
- * @return string Pagination result set counter string.
- * @since 11.1
+ * @return string Pagination result set counter string.
+ * @since 11.1
*/
public function getResultsCounter()
{
@@ -249,7 +249,7 @@
/**
* Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
*
- * @return string Pagination page list string.
+ * @return string Pagination page list string.
* @since 1.0
*/
public function getPagesLinks()
@@ -343,7 +343,7 @@
/**
* Return the pagination footer.
*
- * @return string Pagination footer.
+ * @return string Pagination footer.
* @since 1.0
*/
public function getListFooter()
@@ -373,7 +373,7 @@
/**
* Creates a dropdown box for selecting how many records to show per page.
*
- * @return string The HTML for the limit # input box.
+ * @return string The HTML for the limit # input box.
* @since 1.0
*/
public function getLimitBox()
@@ -406,14 +406,14 @@
/**
* Return the icon to move an item UP.
*
- * @param integer $i The row index.
- * @param boolean $condition True to show the icon.
- * @param string $task The task to fire.
- * @param string $alt The image alternative text string.
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $i The row index.
+ * @param boolean $condition True to show the icon.
+ * @param string $task The task to fire.
+ * @param string $alt The image alternative text string.
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
*
- * @return string Either the icon to move an item up or a space.
+ * @return string Either the icon to move an item up or a space.
* @since 1.0
*/
public function orderUpIcon($i, $condition = true, $task = 'orderup', $alt = 'JLIB_HTML_MOVE_UP', $enabled = true, $checkbox='cb')
@@ -429,15 +429,15 @@
/**
* Return the icon to move an item DOWN.
*
- * @param integer $i The row index.
- * @param integer $n The number of items in the list.
- * @param boolean $condition True to show the icon.
- * @param string $task The task to fire.
- * @param string $alt The image alternative text string.
- * @param boolean $enabled An optional setting for access control on the action.
- * @param string $checkbox An optional prefix for checkboxes.
+ * @param integer $i The row index.
+ * @param integer $n The number of items in the list.
+ * @param boolean $condition True to show the icon.
+ * @param string $task The task to fire.
+ * @param string $alt The image alternative text string.
+ * @param boolean $enabled An optional setting for access control on the action.
+ * @param string $checkbox An optional prefix for checkboxes.
*
- * @return string Either the icon to move an item down or a space.
+ * @return string Either the icon to move an item down or a space.
* @since 1.0
*/
public function orderDownIcon($i, $n, $condition = true, $task = 'orderdown', $alt = 'JLIB_HTML_MOVE_DOWN', $enabled = true, $checkbox='cb')
@@ -511,8 +511,8 @@
/**
* Create and return the pagination data object.
*
- * @return object Pagination data object.
- * @since 11.1
+ * @return object Pagination data object.
+ * @since 11.1
*/
protected function _buildDataObject()
{
Modified: development/branches/platform/libraries/joomla/html/pane.php
===================================================================
--- development/branches/platform/libraries/joomla/html/pane.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/pane.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,11 +25,11 @@
/**
* Returns a JPanel object.
*
- * @param string $behavior The behavior to use.
- * @param boolean $useCookies Use cookies to remember the state of the panel.
- * @param array $params Associative array of values.
- *
- * @return object
+ * @param string $behavior The behavior to use.
+ * @param boolean $useCookies Use cookies to remember the state of the panel.
+ * @param array $params Associative array of values.
+ *
+ * @return object
*/
public static function getInstance($behavior = 'Tabs', $params = array())
{
@@ -42,7 +42,7 @@
/**
* Creates a pane and creates the javascript object for it.
*
- * @param string The pane identifier.
+ * @param string The pane identifier.
*/
abstract public function startPane($id);
@@ -55,8 +55,8 @@
/**
* Creates a panel with title text and starts that panel.
*
- * @param string $text The panel name and/or title.
- * @param string $id The panel identifer.
+ * @param string $text The panel name and/or title.
+ * @param string $id The panel identifer.
*/
abstract public function startPanel($text, $id);
@@ -85,7 +85,7 @@
/**
* Constructor.
*
- * @param array $params Associative array of values.
+ * @param array $params Associative array of values.
*/
function __construct($params = array())
{
@@ -102,7 +102,7 @@
/**
* Creates a pane and creates the javascript object for it.
*
- * @param string The pane identifier.
+ * @param string The pane identifier.
*/
public function startPane($id)
{
@@ -120,8 +120,8 @@
/**
* Creates a tab panel with title text and starts that panel.
*
- * @param string $text The name of the tab
- * @param string $id The tab identifier
+ * @param string $text The name of the tab
+ * @param string $id The tab identifier
*/
public function startPanel($text, $id)
{
@@ -139,7 +139,7 @@
/**
* Load the javascript behavior and attach it to the document.
*
- * @param array $params Associative array of values
+ * @param array $params Associative array of values
*/
protected function _loadBehavior($params = array())
{
@@ -182,7 +182,7 @@
/**
* Constructor.
*
- * @param array $params Associative array of values.
+ * @param array $params Associative array of values.
*/
function __construct($params = array())
{
@@ -199,7 +199,7 @@
/**
* Creates a pane and creates the javascript object for it.
*
- * @param string The pane identifier.
+ * @param string The pane identifier.
*/
public function startPane($id)
{
@@ -217,8 +217,8 @@
/**
* Creates a tab panel with title text and starts that panel.
*
- * @param string $text The name of the tab.
- * @param string $id The tab identifier.
+ * @param string $text The name of the tab.
+ * @param string $id The tab identifier.
*/
public function startPanel($text, $id)
{
@@ -238,7 +238,7 @@
/**
* Load the javascript behavior and attach it to the document.
*
- * @param array $params Associative array of values.
+ * @param array $params Associative array of values.
*/
protected function _loadBehavior($params = array())
{
Modified: development/branches/platform/libraries/joomla/html/parameter/element/contentlanguages.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/contentlanguages.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/contentlanguages.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -31,8 +31,8 @@
/**
* Get the options for the element
*
- * @param object $node
- * @return array
+ * @param object $node
+ * @return array
*/
protected function _getOptions(&$node)
{
Modified: development/branches/platform/libraries/joomla/html/parameter/element/folderlist.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/folderlist.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/folderlist.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* Renders a filelist element
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Parameter
* @since 11.1
* @deprecated JParameter is deprecated and will be removed in a future version. Use JForm instead.
Modified: development/branches/platform/libraries/joomla/html/parameter/element/hidden.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/hidden.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/hidden.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* Renders a hidden element
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Parameter
* @since 11.1
* @deprecated JParameter is deprecated and will be removed in a future version. Use JForm instead.
Modified: development/branches/platform/libraries/joomla/html/parameter/element/list.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/list.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/list.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,9 +30,9 @@
/**
* Get the options for the element
*
- * @param object The current XML node.
- * @return array
- * @since 11.1
+ * @param object The current XML node.
+ * @return array
+ * @since 11.1
*/
protected function _getOptions(&$node)
{
@@ -49,10 +49,10 @@
/**
* Fetch the HTML code for the parameter element.
*
- * @param string The field name.
- * @param mixed The value of the field.
- * @param object The current XML node.
- * @param string The name of the HTML control.
+ * @param string The field name.
+ * @param mixed The value of the field.
+ * @param object The current XML node.
+ * @param string The name of the HTML control.
*/
public function fetchElement($name, $value, &$node, $control_name)
{
Modified: development/branches/platform/libraries/joomla/html/parameter/element/password.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/password.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/password.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* Renders a password element
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Parameter
* @since 11.1
* @deprecated JParameter is deprecated and will be removed in a future version. Use JForm instead.
Modified: development/branches/platform/libraries/joomla/html/parameter/element/sql.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/sql.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/sql.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* Renders a SQL element
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Parameter
* @since 11.1
* @deprecated JParameter is deprecated and will be removed in a future version. Use JForm instead.
Modified: development/branches/platform/libraries/joomla/html/parameter/element/timezones.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element/timezones.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element/timezones.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* Renders a timezones element
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Parameter
* @since 11.1
* @deprecated JParameter is deprecated and will be removed in a future version. Use JForm instead.
@@ -23,7 +23,7 @@
/**
* Element name
*
- * @var string
+ * @var string
*/
protected $_name = 'Timezones';
Modified: development/branches/platform/libraries/joomla/html/parameter/element.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter/element.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter/element.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -51,7 +51,7 @@
/**
* Get the element name
*
- * @return string type of the parameter
+ * @return string type of the parameter
*/
public function getName() {
return $this->_name;
Modified: development/branches/platform/libraries/joomla/html/parameter.php
===================================================================
--- development/branches/platform/libraries/joomla/html/parameter.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/parameter.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,7 +28,7 @@
* The raw params string
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $_raw = null;
@@ -36,7 +36,7 @@
* The XML params element
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $_xml = null;
@@ -44,7 +44,7 @@
* Loaded elements
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $_elements = array();
@@ -52,16 +52,16 @@
* Directories, where element types can be stored
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $_elementPath = array();
/**
* Constructor
*
- * @param string The raw parms text.
- * @param string Path to the XML setup file.
- * @since 11.1
+ * @param string The raw parms text.
+ * @param string Path to the XML setup file.
+ * @since 11.1
*/
public function __construct($data = '', $path = '')
{
@@ -88,12 +88,12 @@
/**
* Sets a default value if not alreay assigned.
*
- * @param string The name of the parameter.
- * @param string An optional value for the parameter.
- * @param string An optional group for the parameter.
- *
- * @return string The value set, or the default if the value was not previously set (or null).
- * @since 11.1
+ * @param string The name of the parameter.
+ * @param string An optional value for the parameter.
+ * @param string An optional group for the parameter.
+ *
+ * @return string The value set, or the default if the value was not previously set (or null).
+ * @since 11.1
*/
public function def($key, $default = '', $group = '_default')
{
@@ -105,8 +105,8 @@
/**
* Sets the XML object from custom XML files.
*
- * @param JSimpleXMLElement An XML object.
- * @since 11.1
+ * @param JSimpleXMLElement An XML object.
+ * @since 11.1
*/
public function setXML(&$xml)
{
@@ -126,10 +126,10 @@
/**
* Bind data to the parameter.
*
- * @param mixed An array or object.
- * @param string An optional group that the data should bind to. The default group is used if not supplied.
- * @return boolean True if the data was successfully bound, false otherwise.
- * @since 11.1
+ * @param mixed An array or object.
+ * @param string An optional group that the data should bind to. The default group is used if not supplied.
+ * @return boolean True if the data was successfully bound, false otherwise.
+ * @since 11.1
*/
public function bind($data, $group = '_default')
{
@@ -145,11 +145,11 @@
/**
* Render the form control.
*
- * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
- * @param string An optional group to render. The default group is used if not supplied.
- *
- * @return string HTML
- * @since 11.1
+ * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
+ * @param string An optional group to render. The default group is used if not supplied.
+ *
+ * @return string HTML
+ * @since 11.1
*/
public function render($name = 'params', $group = '_default')
{
@@ -185,11 +185,11 @@
/**
* Render all parameters to an array.
*
- * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
- * @param string An optional group to render. The default group is used if not supplied.
- *
- * @return array
- * @since 11.1
+ * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
+ * @param string An optional group to render. The default group is used if not supplied.
+ *
+ * @return array
+ * @since 11.1
*/
public function renderToArray($name = 'params', $group = '_default')
{
@@ -207,10 +207,10 @@
/**
* Return the number of parameters in a group.
*
- * @param string An optional group. The default group is used if not supplied.
- *
- * @return mixed False if no params exist or integer number of parameters that exist.
- * @since 11.1
+ * @param string An optional group. The default group is used if not supplied.
+ *
+ * @return mixed False if no params exist or integer number of parameters that exist.
+ * @since 11.1
*/
public function getNumParams($group = '_default')
{
@@ -224,8 +224,8 @@
/**
* Get the number of params in each group.
*
- * @return array Array of all group names as key and parameters count as value.
- * @since 11.1
+ * @return array Array of all group names as key and parameters count as value.
+ * @since 11.1
*/
public function getGroups()
{
@@ -243,11 +243,11 @@
/**
* Render all parameters.
*
- * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
- * @param string An optional group to render. The default group is used if not supplied.
- *
- * @return array An array of all parameters, each as array of the label, the form element and the tooltip.
- * @since 11.1
+ * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
+ * @param string An optional group to render. The default group is used if not supplied.
+ *
+ * @return array An array of all parameters, each as array of the label, the form element and the tooltip.
+ * @since 11.1
*/
public function getParams($name = 'params', $group = '_default')
{
@@ -265,12 +265,12 @@
/**
* Render a parameter type.
*
- * @param object A parameter XML element.
- * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
- * @param string An optional group to render. The default group is used if not supplied.
- *
- * @return array Any array of the label, the form element and the tooltip.
- * @since 11.1
+ * @param object A parameter XML element.
+ * @param string An optional name of the HTML form control. The default is 'params' if not supplied.
+ * @param string An optional group to render. The default group is used if not supplied.
+ *
+ * @return array Any array of the label, the form element and the tooltip.
+ * @since 11.1
*/
public function getParam(&$node, $control_name = 'params', $group = '_default')
{
@@ -297,9 +297,9 @@
/**
* Loads an XML setup file and parses it.
*
- * @param string A path to the XML setup file.
- * @return object
- * @since 11.1
+ * @param string A path to the XML setup file.
+ * @return object
+ * @since 11.1
*/
public function loadSetupFile($path)
{
@@ -326,11 +326,11 @@
/**
* Loads an element type.
*
- * @param string The element type.
- * @param boolean False (default) to reuse parameter elements; true to load the parameter element type again.
- *
- * @return object
- * @since 11.1
+ * @param string The element type.
+ * @param boolean False (default) to reuse parameter elements; true to load the parameter element type again.
+ *
+ * @return object
+ * @since 11.1
*/
public function loadElement($type, $new = false)
{
@@ -379,8 +379,8 @@
* the custom folders, it will look in
* JParameter/types.
*
- * @param string|array Directory or directories to search.
- * @since 11.1
+ * @param string|array Directory or directories to search.
+ * @since 11.1
*/
public function addElementPath($path)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/confirm.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/confirm.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/confirm.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -44,8 +44,8 @@
/**
* Get the button CSS Id
*
- * @return string Button CSS Id
- * @since 11.1
+ * @return string Button CSS Id
+ * @since 11.1
*/
public function fetchId($type='Confirm', $name = '', $text = '', $task = '', $list = true, $hideMenu = false)
{
@@ -55,10 +55,10 @@
/**
* Get the JavaScript command for the button
*
- * @param object $definition Button definition
- *
- * @return string JavaScript command string
- * @since 11.1
+ * @param object $definition Button definition
+ *
+ * @return string JavaScript command string
+ * @since 11.1
*/
protected function _getCommand($msg, $name, $task, $list)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/custom.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/custom.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/custom.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -33,8 +33,8 @@
/**
* Get the button CSS Id
*
- * @return string Button CSS Id
- * @since 11.1
+ * @return string Button CSS Id
+ * @since 11.1
*/
public function fetchId($type='Custom', $html = '', $id = 'custom')
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/help.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/help.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/help.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,14 +24,14 @@
protected $_name = 'Help';
/**
- * @param string $type Unused string.
- * @param string $ref The name of the help screen (its key reference).
- * @param boolean $com Use the help file in the component directory.
- * @param string $override Use this URL instead of any other.
- * @param string $component Name of component to get Help (null for current component)
+ * @param string $type Unused string.
+ * @param string $ref The name of the help screen (its key reference).
+ * @param boolean $com Use the help file in the component directory.
+ * @param string $override Use this URL instead of any other.
+ * @param string $component Name of component to get Help (null for current component)
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public function fetchButton($type = 'Help', $ref = '', $com = false, $override = null, $component = null)
{
@@ -53,7 +53,7 @@
*
* Redefined from JButton class
*
- * @return string Button CSS Id
+ * @return string Button CSS Id
* @since 11.1
*/
public function fetchId()
@@ -64,13 +64,13 @@
/**
* Get the JavaScript command for the button
*
- * @param string $ref The name of the help screen (its key reference).
- * @param boolean $com Use the help file in the component directory.
- * @param string $override Use this URL instead of any other.
- * @param string $component Name of component to get Help (null for current component)
+ * @param string $ref The name of the help screen (its key reference).
+ * @param boolean $com Use the help file in the component directory.
+ * @param string $override Use this URL instead of any other.
+ * @param string $component Name of component to get Help (null for current component)
*
- * @return string JavaScript command string
- * @since 11.1
+ * @return string JavaScript command string
+ * @since 11.1
*/
protected function _getCommand($ref, $com, $override, $component)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/link.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/link.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/link.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -42,11 +42,11 @@
/**
* Get the button CSS Id
*
- * @param string $type The button type.
- * @param string $name The name of the button.
+ * @param string $type The button type.
+ * @param string $name The name of the button.
*
- * @return string Button CSS Id
- * @since 11.1
+ * @return string Button CSS Id
+ * @since 11.1
*/
public function fetchId($type = 'Link', $name = '')
{
@@ -56,10 +56,10 @@
/**
* Get the JavaScript command for the button
*
- * @param object $definition Button definition
+ * @param object $definition Button definition
*
- * @return string JavaScript command string
- * @since 11.1
+ * @return string JavaScript command string
+ * @since 11.1
*/
protected function _getCommand($url)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/popup.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/popup.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/popup.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -47,8 +47,8 @@
*
* Redefined from JButton class
*
- * @param string $name Button name
- * @return string Button CSS Id
+ * @param string $name Button name
+ * @return string Button CSS Id
* @since 11.1
*/
public function fetchId($type, $name)
@@ -59,9 +59,9 @@
/**
* Get the JavaScript command for the button
*
- * @param object $definition Button definition
- * @return string JavaScript command string
- * @since 11.1
+ * @param object $definition Button definition
+ * @return string JavaScript command string
+ * @since 11.1
*/
protected function _getCommand($name, $url, $width, $height, $top, $left)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/separator.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/separator.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/separator.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,7 +21,7 @@
/**
* Button type
*
- * @var string
+ * @var string
*/
protected $_name = 'Separator';
Modified: development/branches/platform/libraries/joomla/html/toolbar/button/standard.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button/standard.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button/standard.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -43,8 +43,8 @@
/**
* Get the button CSS Id
*
- * @return string Button CSS Id
- * @since 11.1
+ * @return string Button CSS Id
+ * @since 11.1
*/
public function fetchId($type='Standard', $name = '', $text = '', $task = '', $list = true, $hideMenu = false)
{
@@ -55,12 +55,12 @@
* Get the JavaScript command for the button
*
* @access private
- * @param string $name The task name as seen by the user
- * @param string $task The task used by the application
- * @param ??? $list
- *
- * @return string JavaScript command string
- * @since 11.1
+ * @param string $name The task name as seen by the user
+ * @param string $task The task used by the application
+ * @param ??? $list
+ *
+ * @return string JavaScript command string
+ * @since 11.1
*/
protected function _getCommand($name, $task, $list)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar/button.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar/button.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar/button.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -49,7 +49,7 @@
/**
* Get the element name
*
- * @return string type of the parameter
+ * @return string type of the parameter
*/
public function getName()
{
@@ -83,9 +83,9 @@
*
* Can be redefined in the final class
*
- * @param string $identifier Icon identification string
- * @return string CSS class name
- * @since 11.1
+ * @param string $identifier Icon identification string
+ * @return string CSS class name
+ * @since 11.1
*/
public function fetchIconClass($identifier)
{
Modified: development/branches/platform/libraries/joomla/html/toolbar.php
===================================================================
--- development/branches/platform/libraries/joomla/html/toolbar.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/html/toolbar.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -52,7 +52,7 @@
/**
* Constructor
*
- * @param string The toolbar name.
+ * @param string The toolbar name.
*/
public function __construct($name = 'toolbar')
{
@@ -67,9 +67,9 @@
* Returns the global JToolBar object, only creating it if it
* doesn't already exist.
*
- * @param string $name The name of the toolbar.
- *
- * @return JToolBar The JToolBar object.
+ * @param string $name The name of the toolbar.
+ *
+ * @return JToolBar The JToolBar object.
*/
public static function getInstance($name = 'toolbar')
{
@@ -89,10 +89,10 @@
/**
* Set a value
*
- * @param string The name of the parameter.
- * @param string The value of the parameter.
- *
- * @return string The set value.
+ * @param string The name of the parameter.
+ * @param string The value of the parameter.
+ *
+ * @return string The set value.
*/
public function appendButton()
{
@@ -105,8 +105,8 @@
/**
* Get the list of toolbar links.
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public function getItems()
{
@@ -116,8 +116,8 @@
/**
* Get the name of the toolbar.
*
- * @return string
- * @since 11.1
+ * @return string
+ * @since 11.1
*/
public function getName()
{
@@ -127,10 +127,10 @@
/**
* Get a value.
*
- * @param string The name of the parameter.
- * @param mixed The default value if not found.
- *
- * @return string
+ * @param string The name of the parameter.
+ * @param mixed The default value if not found.
+ *
+ * @return string
*/
public function prependButton()
{
@@ -143,9 +143,9 @@
/**
* Render.
*
- * @param string The name of the control, or the default text area if a setup file is not found.
- *
- * @return string HTML
+ * @param string The name of the control, or the default text area if a setup file is not found.
+ *
+ * @return string HTML
*/
public function render()
{
@@ -171,10 +171,10 @@
/**
* Render a parameter type.
*
- * @param object A param tag node.
- * @param string The control name.
- *
- * @return array Any array of the label, the form element and the tooltip.
+ * @param object A param tag node.
+ * @param string The control name.
+ *
+ * @return array Any array of the label, the form element and the tooltip.
*/
public function renderButton(&$node)
{
@@ -193,10 +193,10 @@
/**
* Loads a button type.
*
- * @param string buttonType
- *
- * @return object
- * @since 11.1
+ * @param string buttonType
+ *
+ * @return object
+ * @since 11.1
*/
public function loadButtonType($type, $new = false)
{
@@ -250,8 +250,8 @@
* added them. If the parameter type cannot be found in the custom folders,
* it will look in libraries/joomla/html/toolbar/button.
*
- * @param string|array directory or directories to search.
- * @since 11.1
+ * @param string|array directory or directories to search.
+ * @since 11.1
*/
public function addButtonPath($path)
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/component.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/component.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/component.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -31,10 +31,10 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
+ * @param string $path the path where to find language files
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function loadLanguage($path=null)
{
@@ -82,8 +82,8 @@
/**
* Custom install method for components
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -483,8 +483,8 @@
/**
* Custom update method for components
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function update()
{
@@ -904,9 +904,9 @@
/**
* Custom uninstall method for components
*
- * @param integer $id The unique extension id of the component to uninstall
+ * @param integer $id The unique extension id of the component to uninstall
*
- * @return mixed Return value for uninstall method in component uninstall file
+ * @return mixed Return value for uninstall method in component uninstall file
* @since 1.0
*/
public function uninstall($id)
@@ -1151,8 +1151,8 @@
/**
* Method to build menu database entries for a component
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
protected function _buildAdminMenus()
{
@@ -1336,10 +1336,10 @@
/**
* Method to remove admin menu references to a component
*
- * @param object $component Component table object
+ * @param object $component Component table object
*
- * @return boolean True if successful
- * @since 11.1
+ * @return boolean True if successful
+ * @since 11.1
*/
protected function _removeAdminMenus(&$row)
{
@@ -1388,10 +1388,10 @@
* Custom rollback method
* - Roll back the component menu item
*
- * @param array $arg Installation step to rollback
+ * @param array $arg Installation step to rollback
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
protected function _rollback_menu()
{
@@ -1401,8 +1401,8 @@
/**
* Discover unregistered extensions.
*
- * @return array A list of extensions.
- * @since 11.1
+ * @return array A list of extensions.
+ * @since 11.1
*/
public function discover()
{
@@ -1443,8 +1443,8 @@
/**
* Install unregistered extensions that have been discovered.
*
- * @return mixed
- * @since 11.1
+ * @return mixed
+ * @since 11.1
*/
public function discover_install()
{
@@ -1703,7 +1703,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/file.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/file.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/file.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -26,8 +26,8 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
- * @since 11.1
+ * @param string $path the path where to find language files
+ * @since 11.1
*/
public function loadLanguage($path)
{
@@ -44,8 +44,8 @@
/**
* Custom install method
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -230,9 +230,9 @@
/**
* Custom update method
- *
- * @return boolean True on success
- * @since 11.1
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function update()
{
@@ -248,10 +248,10 @@
/**
* Custom uninstall method
*
- * @param string $id The id of the file to uninstall
- *
- * @return boolean True on success
- * @since 11.1
+ * @param string $id The id of the file to uninstall
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function uninstall($id)
{
@@ -354,10 +354,10 @@
/**
* Function used to check if extension is already installed
*
- * @param string $element The element name of the extension to install
- *
- * @return boolean True if extension exists
- * @since 11.1
+ * @param string $element The element name of the extension to install
+ *
+ * @return boolean True if extension exists
+ * @since 11.1
*/
protected function extensionExistsInSystem($extension = null)
@@ -391,9 +391,9 @@
/**
* Function used to populate files and folder list
- *
- * @return boolean none
- * @since 11.1
+ *
+ * @return boolean none
+ * @since 11.1
*/
protected function populateFilesAndFolderList()
{
@@ -478,7 +478,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/language.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/language.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/language.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,8 +32,8 @@
* the ability to install multiple distinct packs in one install. The
* preferred method is to use a package to install multiple language packs.
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -248,8 +248,8 @@
/**
* Custom update method
*
- * @return boolean True on success, false on failure
- * @since 11.1
+ * @return boolean True on success, false on failure
+ * @since 11.1
*/
public function update()
{
@@ -400,10 +400,10 @@
/**
* Custom uninstall method
*
- * @param string $tag The tag of the language to uninstall
- * @param integer $clientId The id of the client (unused)
- * @return mixed Return value for uninstall method in component uninstall file
- * @since 11.1
+ * @param string $tag The tag of the language to uninstall
+ * @param integer $clientId The id of the client (unused)
+ * @return mixed Return value for uninstall method in component uninstall file
+ * @since 11.1
*/
public function uninstall($eid)
{
@@ -575,9 +575,9 @@
/**
* Refreshes the extension table cache
- *
+ *
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/library.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/library.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/library.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,8 +24,8 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
- * @since 11.1
+ * @param string $path the path where to find language files
+ * @since 11.1
*/
public function loadLanguage($path=null)
{
@@ -46,9 +46,9 @@
/**
* Custom install method
- *
- * @return boolean True on success
- * @since 11.1
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -174,9 +174,9 @@
/**
* Custom update method
- *
- * @return boolean True on success
- * @since 11.1
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function update()
{
@@ -207,10 +207,10 @@
/**
* Custom uninstall method
*
- * @param string $id The id of the library to uninstall
- *
- * @return boolean True on success
- * @since 11.1
+ * @param string $id The id of the library to uninstall
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function uninstall($id)
{
@@ -299,8 +299,8 @@
/**
* Custom discover method
*
- * @return array JExtension) list of extensions available
- * @since 11.1
+ * @return array JExtension) list of extensions available
+ * @since 11.1
*/
public function discover()
{
@@ -325,10 +325,10 @@
/**
* Custom discover_install method
*
- * @param integer $id The id of the extension to install
- *
+ * @param integer $id The id of the extension to install
+ *
* @return void
- * @since 11.1
+ * @since 11.1
*/
public function discover_install()
{
@@ -365,7 +365,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/module.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/module.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/module.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -33,9 +33,9 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
+ * @param string $path the path where to find language files
*
- * @since 11.1
+ * @since 11.1
*/
public function loadLanguage($path=null)
{
@@ -82,9 +82,9 @@
/**
* Custom install method
*
- * @return boolean True on success
+ * @return boolean True on success
*
- * @since 11.1
+ * @since 11.1
*/
public function install()
{
@@ -444,8 +444,8 @@
* Custom update method
* This is really a shell for the install system
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
function update()
{
@@ -462,8 +462,8 @@
/**
* Custom discover method
*
- * @return array JExtension list of extensions available
- * @since 11.1
+ * @return array JExtension list of extensions available
+ * @since 11.1
*/
public function discover()
{
@@ -503,10 +503,10 @@
/**
* Custom discover_install method
*
- * @param integer $id The id of the extension to install
+ * @param integer $id The id of the extension to install
*
* @return void
- * @since 11.1
+ * @since 11.1
*/
function discover_install()
{
@@ -545,7 +545,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
@@ -570,10 +570,10 @@
/**
* Custom uninstall method
*
- * @param integer $id The id of the module to uninstall
+ * @param integer $id The id of the module to uninstall
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function uninstall($id)
{
@@ -772,10 +772,10 @@
* Custom rollback method
* - Roll back the menu item
*
- * @param array $arg Installation step to rollback
+ * @param array $arg Installation step to rollback
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
protected function _rollback_menu($arg)
{
@@ -802,10 +802,10 @@
* Custom rollback method
* - Roll back the module item
*
- * @param array $arg Installation step to rollback
+ * @param array $arg Installation step to rollback
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
protected function _rollback_module($arg)
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/package.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/package.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/package.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -42,8 +42,8 @@
/**
* Custom install method
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -320,7 +320,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/plugin.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/plugin.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/plugin.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -34,8 +34,8 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
- * @since 11.1
+ * @param string $path the path where to find language files
+ * @since 11.1
*/
public function loadLanguage($path=null)
{
@@ -80,8 +80,8 @@
/**
* Custom install method
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -434,10 +434,10 @@
/**
* Custom uninstall method
- * @param integer $id The id of the plugin to uninstall
+ * @param integer $id The id of the plugin to uninstall
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function uninstall($id)
{
@@ -616,8 +616,8 @@
/**
* Custom discover method
*
- * @return array JExtension) list of extensions available
- * @since 11.1
+ * @return array JExtension) list of extensions available
+ * @since 11.1
*/
function discover()
{
@@ -670,10 +670,10 @@
/**
* Custom discover_install method
*
- * @param integer $id The id of the extension to install
- *
- * @return mixed
- * @since 11.1
+ * @param integer $id The id of the extension to install
+ *
+ * @return mixed
+ * @since 11.1
*/
public function discover_install()
{
@@ -715,7 +715,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/adapters/template.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/adapters/template.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/adapters/template.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,9 +28,9 @@
/**
* Custom loadLanguage method
*
- * @param string $path the path where to find language files
+ * @param string $path the path where to find language files
*
- * @since 11.1
+ * @since 11.1
*/
public function loadLanguage($path=null)
{
@@ -62,8 +62,8 @@
/**
* Custom install method
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function install()
{
@@ -245,8 +245,8 @@
/**
* Custom update method for components
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function update()
{
@@ -256,10 +256,10 @@
/**
* Custom uninstall method
*
- * @param integer $id The extension ID
+ * @param integer $id The extension ID
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function uninstall($id)
{
@@ -366,7 +366,7 @@
/**
* Discover existing but uninstalled templates
*
- * @return array JExtensionTable list
+ * @return array JExtensionTable list
*/
function discover()
{
@@ -479,7 +479,7 @@
/**
* Refreshes the extension table cache
* @return boolean result of operation, true if updated, false on failure
- * @since 11.1
+ * @since 11.1
*/
public function refreshManifestCache()
{
Modified: development/branches/platform/libraries/joomla/installer/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,10 +27,10 @@
/**
* Downloads a package
*
- * @param string URL of file to download
- * @param string Download target filename [optional]
- *
- * @return mixed Path to downloaded package or boolean false on failure
+ * @param string URL of file to download
+ * @param string Download target filename [optional]
+ *
+ * @return mixed Path to downloaded package or boolean false on failure
* @since 11.1
*/
public static function downloadPackage($url, $target = false)
@@ -103,9 +103,9 @@
* Unpacks a file and verifies it as a Joomla element package
* Supports .gz .tar .tar.gz and .zip
*
- * @param string $p_filename The uploaded package filename or install directory
- *
- * @return array Two elements - extractdir and packagefile
+ * @param string $p_filename The uploaded package filename or install directory
+ *
+ * @return array Two elements - extractdir and packagefile
* @since 11.1
*/
public static function unpack($p_filename)
@@ -173,9 +173,9 @@
/**
* Method to detect the extension type from a package directory
*
- * @param string $p_dir Path to package directory
- *
- * @return mixed Extension type string or boolean false on fail
+ * @param string $p_dir Path to package directory
+ *
+ * @return mixed Extension type string or boolean false on fail
* @since 11.1
*/
public static function detectType($p_dir)
@@ -217,9 +217,9 @@
/**
* Gets a file name out of a url
*
- * @param string $url URL to get name from
- *
- * @return mixed String filename or boolean false if failed
+ * @param string $url URL to get name from
+ *
+ * @return mixed String filename or boolean false if failed
* @since 11.1
*/
public static function getFilenameFromURL($url)
@@ -235,10 +235,10 @@
/**
* Clean up temporary uploaded package and unpacked extension
*
- * @param string $package Path to the uploaded package file
- * @param string $resultdir Path to the unpacked extension
- *
- * @return boolean True on success
+ * @param string $package Path to the uploaded package file
+ * @param string $resultdir Path to the unpacked extension
+ *
+ * @return boolean True on success
* @since 11.1
*/
public static function cleanupInstall($package, $resultdir)
@@ -266,9 +266,9 @@
*
* Splits contents of a sql file into array of discreet queries
* queries need to be delimited with end of statement marker ';'
- * @param string
- *
- * @return array
+ * @param string
+ *
+ * @return array
*/
public static function splitSql($sql)
{
Modified: development/branches/platform/libraries/joomla/installer/installer.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/installer.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/installer.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -99,7 +99,7 @@
* Returns the global Installer object, only creating it
* if it doesn't already exist.
*
- * @return object An installer object
+ * @return object An installer object
* @since 11.1
*/
public static function getInstance()
@@ -114,9 +114,9 @@
/**
* Get the allow overwrite switch
- *
- * @return boolean Allow overwrite switch
- * @since 11.1
+ *
+ * @return boolean Allow overwrite switch
+ * @since 11.1
*/
public function getOverwrite()
{
@@ -126,10 +126,10 @@
/**
* Set the allow overwrite switch
*
- * @param boolean $state Overwrite switch state
- *
- * @return boolean Previous value
- * @since 11.1
+ * @param boolean $state Overwrite switch state
+ *
+ * @return boolean Previous value
+ * @since 11.1
*/
public function setOverwrite($state=false)
{
@@ -146,8 +146,8 @@
/**
* Get the redirect location
*
- * @return string Redirect location (or null)
- * @since 11.1
+ * @return string Redirect location (or null)
+ * @since 11.1
*/
public function getRedirectURL()
{
@@ -158,7 +158,7 @@
* Set the redirct location
*
* @param string New redirect location
- * @since 11.1
+ * @since 11.1
*/
public function setRedirectURL($newurl) {
$this->redirect_url = $newurl;
@@ -167,8 +167,8 @@
/**
* Get the allow overwrite switch
*
- * @return boolean Allow overwrite switch
- * @since 11.1
+ * @return boolean Allow overwrite switch
+ * @since 11.1
*/
public function getUpgrade()
{
@@ -178,9 +178,9 @@
/**
* Set the allow overwrite switch
*
- * @param boolean $state Overwrite switch state
- * @return boolean Previous value
- * @since 11.1
+ * @param boolean $state Overwrite switch state
+ * @return boolean Previous value
+ * @since 11.1
*/
public function setUpgrade($state=false)
{
@@ -197,8 +197,8 @@
/**
* Get the installation manifest object
*
- * @return object Manifest object
- * @since 11.1
+ * @return object Manifest object
+ * @since 11.1
*/
public function getManifest()
{
@@ -211,11 +211,11 @@
/**
* Get an installer path by name
*
- * @param string $name Path name
- * @param string $default Default value
- *
- * @return string Path
- * @since 11.1
+ * @param string $name Path name
+ * @param string $default Default value
+ *
+ * @return string Path
+ * @since 11.1
*/
public function getPath($name, $default=null)
{
@@ -225,11 +225,11 @@
/**
* Sets an installer path by name
*
- * @param string $name Path name
- * @param string $value Path
- *
- * @return void
- * @since 11.1
+ * @param string $name Path name
+ * @param string $value Path
+ *
+ * @return void
+ * @since 11.1
*/
public function setPath($name, $value)
{
@@ -239,10 +239,10 @@
/**
* Pushes a step onto the installer stack for rolling back steps
*
- * @param array $step Installer step
- * @return void
- *
- * @since 11.1
+ * @param array $step Installer step
+ * @return void
+ *
+ * @since 11.1
*/
public function pushStep($step)
{
@@ -252,11 +252,11 @@
/**
* Installation abort method
*
- * @param string $msg Abort message from the installer
- * @param string $type Package type if defined
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $msg Abort message from the installer
+ * @param string $type Package type if defined
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
public function abort($msg=null, $type=null)
{
@@ -340,10 +340,10 @@
/**
* Package installation method
*
- * @param string $path Path to package source folder
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Path to package source folder
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
public function install($path=null)
{
@@ -395,9 +395,9 @@
/*
* Discovered package installation method
*
- * @param integer $eid Extension ID
- * @return boolean True if successful
- * @since 11.1
+ * @param integer $eid Extension ID
+ * @return boolean True if successful
+ * @since 11.1
*/
public function discover_install($eid=null)
{
@@ -463,7 +463,7 @@
* Extension discover method
* Asks each adapter to find extensions
*
- * @return array JExtension
+ * @return array JExtension
*/
public function discover()
{
@@ -489,10 +489,10 @@
/**
* Package update method
*
- * @param string $path Path to package source folder
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $path Path to package source folder
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
public function update($path=null)
{
@@ -541,12 +541,12 @@
/**
* Package uninstallation method
*
- * @param string $type Package type
- * @param mixed $identifier Package identifier for adapter
- * @param integer $cid Application ID; deprecated in 1.6
- *
- * @return boolean True if successful
- * @since 11.1
+ * @param string $type Package type
+ * @param mixed $identifier Package identifier for adapter
+ * @param integer $cid Application ID; deprecated in 1.6
+ *
+ * @return boolean True if successful
+ * @since 11.1
*/
public function uninstall($type, $identifier, $cid=0)
{
@@ -575,9 +575,9 @@
/**
* Refreshes the manifest cache stored in #__extensions
*
- * @param integer $eid Extension ID
- *
- * @return mixed void on success | false on error @todo missing return value ?
+ * @param integer $eid Extension ID
+ *
+ * @return mixed void on success | false on error @todo missing return value ?
*/
function refreshManifestCache($eid)
{
@@ -634,9 +634,9 @@
/**
* Prepare for installation: this method sets the installation directory, finds
* and checks the installation file and verifies the installation type.
- *
- * @return boolean True on success
- * @since 11.1
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function setupInstall()
{
@@ -663,10 +663,10 @@
* Backward compatible method to parse through a queries element of the
* installation manifest file and take appropriate action.
*
- * @param JXMLElement $element The XML node to process
- *
- * @return mixed Number of queries processed or False on error
- * @since 11.1
+ * @param JXMLElement $element The XML node to process
+ *
+ * @return mixed Number of queries processed or False on error
+ * @since 11.1
*/
public function parseQueries($element)
{
@@ -703,10 +703,10 @@
/**
* Method to extract the name of a discreet installation sql file from the installation manifest file.
*
- * @param object $element The XML node to process
- *
- * @return mixed Number of queries processed or False on error
- * @since 11.1
+ * @param object $element The XML node to process
+ *
+ * @return mixed Number of queries processed or False on error
+ * @since 11.1
*/
public function parseSQLFiles($element)
{
@@ -784,8 +784,8 @@
/**
* Set the schema version for an extension by looking at its latest update
* @param JXMLElement $schema Schema Tag
- * @param integer $eid Extension ID
- *
+ * @param integer $eid Extension ID
+ *
* @return void
*/
public function setSchemaVersion($schema, $eid)
@@ -838,11 +838,11 @@
/**
* Method to process the updates for an item
*
- * @param JXMLElement $schema The XML node to process
- * @param integer $eid Extension Identifier
- *
- * @return boolean Result of the operations
- * @since 11.1
+ * @param JXMLElement $schema The XML node to process
+ * @param integer $eid Extension Identifier
+ *
+ * @return boolean Result of the operations
+ * @since 11.1
*/
public function parseSchemaUpdates($schema, $eid)
{
@@ -953,13 +953,13 @@
* Method to parse through a files element of the installation manifest and take appropriate
* action.
*
- * @param JXMLElement $element The XML node to process
- * @param integer $cid Application ID of application to install to
- * @param array $oldFiles List of old files (JXMLElement's)
- * @param array $oldMD5 List of old MD5 sums (indexed by filename with value as MD5)
- *
- * @return boolean True on success
- * @since 11.1
+ * @param JXMLElement $element The XML node to process
+ * @param integer $cid Application ID of application to install to
+ * @param array $oldFiles List of old files (JXMLElement's)
+ * @param array $oldMD5 List of old MD5 sums (indexed by filename with value as MD5)
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public function parseFiles($element, $cid=0, $oldFiles=null, $oldMD5=null)
{
@@ -991,7 +991,7 @@
$destination = $this->getPath($pathname);
}
-
+
// Here we set the folder we are going to copy the files from.
// Does the element have a folder attribute?
@@ -1575,7 +1575,7 @@
/**
* Tries to find the package manifest file
*
- * @return boolean True on success, False on error
+ * @return boolean True on success, False on error
* @since 1.0
*/
public function findManifest()
@@ -1671,10 +1671,10 @@
/**
* Cleans up discovered extensions if they're being installed somehow else
- * @param string $type The type of extension (component, etc)
- * @param string $element Unique element identifier (e.g. com_content)
- * @param string $folder The folder of the extension (plugins; e.g. system)
- * @param integer $client The client application (administrator or site)
+ * @param string $type The type of extension (component, etc)
+ * @param string $element Unique element identifier (e.g. com_content)
+ * @param string $folder The folder of the extension (plugins; e.g. system)
+ * @param integer $client The client application (administrator or site)
*
* @return result of query
*/
@@ -1769,8 +1769,8 @@
/**
* Loads an MD5SUMS file into an associative array
- * @param string Filename to load
- * @return array Associative array with filenames as the index and the MD5 as the value
+ * @param string Filename to load
+ * @return array Associative array with filenames as the index and the MD5 as the value
*/
function loadMD5Sum($filename)
{
Modified: development/branches/platform/libraries/joomla/installer/librarymanifest.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/librarymanifest.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/librarymanifest.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -83,7 +83,7 @@
/**
* Constructor
- * @param string $xmlpath Path to an XML file to load the manifest from
+ * @param string $xmlpath Path to an XML file to load the manifest from
*/
function __construct($xmlpath='')
{
@@ -92,7 +92,7 @@
/**
* Load a manifest from a file
- * @param string $xmlfile Path to file to load
+ * @param string $xmlfile Path to file to load
*/
function loadManifestFromXML($xmlfile)
{
Modified: development/branches/platform/libraries/joomla/installer/packagemanifest.php
===================================================================
--- development/branches/platform/libraries/joomla/installer/packagemanifest.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/installer/packagemanifest.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -75,9 +75,9 @@
/**
* Constructor
*
- * @param string $xmlpath Path to XML manifest file.
+ * @param string $xmlpath Path to XML manifest file.
*
- * @return object JPackageManifest
+ * @return object JPackageManifest
* @since
*/
function __construct($xmlpath='')
@@ -90,10 +90,10 @@
/**
* Load a manifest from an XML file
*
- * @param string $xmlpath Path to XML manifest file
+ * @param string $xmlpath Path to XML manifest file
*
- * @return boolean Result of load
- * @since 11.1
+ * @return boolean Result of load
+ * @since 11.1
*/
function loadManifestFromXML($xmlfile)
{
Modified: development/branches/platform/libraries/joomla/language/help.php
===================================================================
--- development/branches/platform/libraries/joomla/language/help.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/language/help.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,12 +21,12 @@
/**
* Create a URL for a given help key reference
*
- * @param string $ref The name of the help screen (its key reference)
- * @param boolean $useComponent Use the help file in the component directory
- * @param string $override Use this URL instead of any other
- * @param string $component Name of component (or null for current component)
+ * @param string $ref The name of the help screen (its key reference)
+ * @param boolean $useComponent Use the help file in the component directory
+ * @param string $override Use this URL instead of any other
+ * @param string $component Name of component (or null for current component)
*
- * @return string
+ * @return string
* @sicne 1.5
*/
static function createURL($ref, $useComponent = false, $override = null, $component = null)
@@ -139,11 +139,11 @@
/**
* Builds a list of the help sites which can be used in a select option.
*
- * @param string $pathToXml Path to an XML file.
- * @param string $selected Language tag to select (if exists).
+ * @param string $pathToXml Path to an XML file.
+ * @param string $selected Language tag to select (if exists).
*
- * @return array An array of arrays (text, value, selected).
- * @since 11.1
+ * @return array An array of arrays (text, value, selected).
+ * @since 11.1
*/
static function createSiteList($pathToXml, $selected = null)
{
Modified: development/branches/platform/libraries/joomla/language/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/language/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/language/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -20,12 +20,12 @@
/**
* Builds a list of the system languages which can be used in a select option
*
- * @param string Client key for the area
- * @param string Base path to use
- * @param array An array of arrays (text, value, selected)
- *
- * @return array List of system languages
- * @since 11.1
+ * @param string Client key for the area
+ * @param string Base path to use
+ * @param array An array of arrays (text, value, selected)
+ *
+ * @return array List of system languages
+ * @since 11.1
*/
public static function createLanguageList($actualLanguage, $basePath = JPATH_BASE, $caching = false, $installed = false)
{
@@ -68,8 +68,8 @@
/**
* Tries to detect the language.
*
- * @return string locale or null if not found
- * @since 11.1
+ * @return string locale or null if not found
+ * @since 11.1
*/
public static function detectLanguage()
{
@@ -110,10 +110,10 @@
/**
* Get available languages
*
- * @param string array key
- *
- * @return array of published languages
- * @since 11.1
+ * @param string array key
+ *
+ * @return array of published languages
+ * @since 11.1
*/
public static function getLanguages($key='default')
{
Modified: development/branches/platform/libraries/joomla/language/language.php
===================================================================
--- development/branches/platform/libraries/joomla/language/language.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/language/language.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -32,7 +32,7 @@
* Debug language, If true, highlights if string isn't found
*
* @var boolean
- * @since 11.1
+ * @since 11.1
*/
protected $debug = false;
@@ -42,7 +42,7 @@
* The default language is used when a language file in the requested language does not exist.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $default = 'en-GB';
@@ -50,7 +50,7 @@
* An array of orphaned text
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $orphans = array();
@@ -58,7 +58,7 @@
* Array holding the language metadata
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $metadata = null;
@@ -66,7 +66,7 @@
* Array|boolean holding the language locale
*
* @var array|boolean
- * @since 11.1
+ * @since 11.1
*/
protected $locale = null;
@@ -74,7 +74,7 @@
* The language to load
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $lang = null;
@@ -82,7 +82,7 @@
* List of language files that have been loaded
*
* @var array of arrays
- * @since 11.1
+ * @since 11.1
*/
protected $paths = array();
@@ -90,7 +90,7 @@
* List of language files that are in error state
*
* @var array of string
- * @since 11.1
+ * @since 11.1
*/
protected $errorfiles = array();
@@ -98,7 +98,7 @@
* Translations
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $strings = null;
@@ -106,7 +106,7 @@
* An array of used text, used during debugging
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $used = array();
@@ -114,7 +114,7 @@
* Counter for number of loads
*
* @var integer
- * @since 11.1
+ * @since 11.1
*/
protected $counter = 0;
@@ -122,7 +122,7 @@
* An array used to store overrides
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected $override = array();
@@ -130,7 +130,7 @@
* Name of the transliterator function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $transliterator = null;
@@ -138,7 +138,7 @@
* Name of the pluralSuffixesCallback function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $pluralSuffixesCallback = null;
@@ -146,7 +146,7 @@
* Name of the ignoredSearchWordsCallback function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $ignoredSearchWordsCallback = null;
@@ -154,7 +154,7 @@
* Name of the lowerLimitSearchWordCallback function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $lowerLimitSearchWordCallback = null;
@@ -162,7 +162,7 @@
* Name of the uppperLimitSearchWordCallback function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $upperLimitSearchWordCallback = null;
@@ -170,7 +170,7 @@
* Name of the searchDisplayedCharactersNumberCallback function for this language
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
protected $searchDisplayedCharactersNumberCallback = null;
@@ -249,10 +249,10 @@
/**
* Returns a language object
*
- * @param string $lang The language to use.
- * @param boolean $debug The debug mode
- * @return object JLanguage The Language object.
- * @since 11.1
+ * @param string $lang The language to use.
+ * @param boolean $debug The debug mode
+ * @return object JLanguage The Language object.
+ * @since 11.1
*/
public static function getInstance($lang, $debug=false)
{
@@ -265,12 +265,12 @@
/**
* Translate function, mimics the php gettext (alias _) function
*
- * @param string $string The string to translate
- * @param boolean $jsSafe Make the result javascript safe
- * @param boolean $interpretBackslashes Interpret \t and \n
- * @return string The translation of the string
+ * @param string $string The string to translate
+ * @param boolean $jsSafe Make the result javascript safe
+ * @param boolean $interpretBackslashes Interpret \t and \n
+ * @return string The translation of the string
* @note The function checks if $jsSafe is true then if $interpretBackslashes is true
- * @since 11.1
+ * @since 11.1
*/
public function _($string, $jsSafe = false, $interpretBackSlashes = true)
{
@@ -321,9 +321,9 @@
* This method processes a string and replaces all accented UTF-8 characters by unaccented
* ASCII-7 "equivalents"
*
- * @param string $string The string to transliterate
- * @return string The transliteration of the string
- * @since 11.1
+ * @param string $string The string to transliterate
+ * @return string The transliteration of the string
+ * @since 11.1
*/
public function transliterate($string)
{
@@ -342,8 +342,8 @@
/**
* Getter for transliteration function
*
- * @return string function Function name or the actual function for PHP 5.3
- * @since 11.1
+ * @return string function Function name or the actual function for PHP 5.3
+ * @since 11.1
*/
public function getTransliterator()
{
@@ -353,8 +353,8 @@
/**
* Set the transliteration function
*
- * @return string function Function name or the actual function for PHP 5.3
- * @since 11.1
+ * @return string function Function name or the actual function for PHP 5.3
+ * @since 11.1
*/
public function setTransliterator($function)
{
@@ -369,8 +369,8 @@
* This method return an array of suffixes for plural rules
*
* @param integer $count The count number
- * @return array The array of suffixes
- * @since 11.1
+ * @return array The array of suffixes
+ * @since 11.1
*/
public function getPluralSuffixes($count) {
if ($this->pluralSuffixesCallback !== null) {
@@ -384,7 +384,7 @@
/**
* Getter for pluralSuffixesCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
* @deprecated
*/
@@ -394,7 +394,7 @@
/**
* Getter for pluralSuffixesCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*
*/
@@ -405,7 +405,7 @@
/**
* Set the pluralSuffixes function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function setPluralSuffixesCallback($function) {
@@ -419,8 +419,8 @@
*
* This method returns an array of ignored search words
*
- * @return array The array of ignored search words
- * @since 11.1
+ * @return array The array of ignored search words
+ * @since 11.1
*/
public function getIgnoredSearchWords() {
if ($this->ignoredSearchWordsCallback !== null) {
@@ -434,7 +434,7 @@
/**
* Getter for ignoredSearchWordsCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function getIgnoredSearchWordsCallback() {
@@ -444,7 +444,7 @@
/**
* Setter for the ignoredSearchWordsCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function setIgnoredSearchWordsCallback($function) {
@@ -458,8 +458,8 @@
*
* This method returns a lower limit integer for length of search words
*
- * @return integer The lower limit integer for length of search words (3 if no value was set for a specific language)
- * @since 11.1
+ * @return integer The lower limit integer for length of search words (3 if no value was set for a specific language)
+ * @since 11.1
*/
public function getLowerLimitSearchWord() {
if ($this->lowerLimitSearchWordCallback !== null) {
@@ -473,7 +473,7 @@
/**
* Getter for lowerLimitSearchWordCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function getLowerLimitSearchWordCallback() {
@@ -483,7 +483,7 @@
/**
* Setter for the lowerLimitSearchWordCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function setLowerLimitSearchWordCallback($function) {
@@ -497,8 +497,8 @@
*
* This method returns an upper limit integer for length of search words
*
- * @return integer The upper limit integer for length of search words (20 if no value was set for a specific language)
- * @since 11.1
+ * @return integer The upper limit integer for length of search words (20 if no value was set for a specific language)
+ * @since 11.1
*/
public function getUpperLimitSearchWord() {
if ($this->upperLimitSearchWordCallback !== null) {
@@ -512,7 +512,7 @@
/**
* Getter for upperLimitSearchWordCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function getUpperLimitSearchWordCallback() {
@@ -522,7 +522,7 @@
/**
* Setter for the upperLimitSearchWordCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function setUpperLimitSearchWordCallback($function) {
@@ -536,8 +536,8 @@
*
* This method returns the number of characters displayed during research
*
- * @return integer The number of characters displayed during research (200 if no value was set for a specific language)
- * @since 11.1
+ * @return integer The number of characters displayed during research (200 if no value was set for a specific language)
+ * @since 11.1
*/
public function getSearchDisplayedCharactersNumber() {
if ($this->searchDisplayedCharactersNumberCallback !== null) {
@@ -551,7 +551,7 @@
/**
* Getter for searchDisplayedCharactersNumberCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function getSearchDisplayedCharactersNumberCallback() {
@@ -561,7 +561,7 @@
/**
* Setter for the searchDisplayedCharactersNumberCallback function
*
- * @return string|function Function name or the actual function for PHP 5.3
+ * @return string|function Function name or the actual function for PHP 5.3
* @since 11.1
*/
public function setSearchDisplayedCharactersNumberCallback($function) {
@@ -704,10 +704,10 @@
/**
* Parses a language file
*
- * @param string $filename The name of the file.
+ * @param string $filename The name of the file.
*
- * @return array The array of parsed strings.
- * @since 11.1
+ * @return array The array of parsed strings.
+ * @since 11.1
*/
protected function parse($filename)
{
@@ -805,8 +805,8 @@
/**
* Determine who called JLanguage or JText
*
- * @return array Caller information
- * @since 11.1
+ * @return array Caller information
+ * @since 11.1
*/
protected function getCallerInfo()
{
@@ -844,8 +844,8 @@
/**
* Getter for Name
*
- * @return string Official name element of the language
- * @since 11.1
+ * @return string Official name element of the language
+ * @since 11.1
*/
public function getName() {
return $this->metadata['name'];
@@ -875,8 +875,8 @@
/**
* Get a list of language files that are in error state
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public function getErrorFiles()
{
@@ -886,8 +886,8 @@
/**
* Getter for the language tag (as defined in RFC 3066)
*
- * @return string The language tag
- * @since 11.1
+ * @return string The language tag
+ * @since 11.1
*/
public function getTag() {
return $this->metadata['tag'];
@@ -896,8 +896,8 @@
/**
* Get the RTL property
*
- * @return boolean True is it an RTL language
- * @since 11.1
+ * @return boolean True is it an RTL language
+ * @since 11.1
*/
public function isRTL()
{
@@ -907,8 +907,8 @@
/**
* Set the Debug property
*
- * @return boolean Previous value
- * @since 11.1
+ * @return boolean Previous value
+ * @since 11.1
*/
public function setDebug($debug)
{
@@ -920,8 +920,8 @@
/**
* Get the Debug property
*
- * @return boolean True is in debug mode
- * @since 11.1
+ * @return boolean True is in debug mode
+ * @since 11.1
*/
public function getDebug()
{
@@ -931,8 +931,8 @@
/**
* Get the default language code
*
- * @return string Language code
- * @since 11.1
+ * @return string Language code
+ * @since 11.1
*/
public function getDefault()
{
@@ -942,8 +942,8 @@
/**
* Set the default language code
*
- * @return string Previous value
- * @since 11.1
+ * @return string Previous value
+ * @since 11.1
*/
public function setDefault($lang)
{
@@ -955,8 +955,8 @@
/**
* Get the list of orphaned strings if being tracked
*
- * @return array Orphaned text
- * @since 11.1
+ * @return array Orphaned text
+ * @since 11.1
*/
public function getOrphans()
{
@@ -968,8 +968,8 @@
*
* Used strings are those strings requested and found either as a string or a constant
*
- * @return array Used strings
- * @since 11.1
+ * @return array Used strings
+ * @since 11.1
*/
public function getUsed()
{
@@ -979,9 +979,9 @@
/**
* Determines is a key exists
*
- * @param key $key The key to check
- * @return boolean True, if the key exists
- * @since 11.1
+ * @param key $key The key to check
+ * @return boolean True, if the key exists
+ * @since 11.1
*/
function hasKey($string)
{
@@ -992,10 +992,10 @@
/**
* Returns a associative array holding the metadata
*
- * @param string The name of the language
- * @return mixed If $lang exists return key/value pair with the language metadata,
+ * @param string The name of the language
+ * @return mixed If $lang exists return key/value pair with the language metadata,
* otherwise return NULL
- * @since 11.1
+ * @since 11.1
*/
public static function getMetadata($lang)
{
@@ -1029,11 +1029,11 @@
/**
* Get the path to a language
*
- * @param string $basePath The basepath to use
- * @param string $language The language tag
- *
- * @return string language related path or null
- * @since 11.1
+ * @param string $basePath The basepath to use
+ * @param string $language The language tag
+ *
+ * @return string language related path or null
+ * @since 11.1
*/
public static function getLanguagePath($basePath = JPATH_BASE, $language = null)
{
@@ -1049,10 +1049,10 @@
*
* Once called, the language still needs to be loaded using JLanguage::load()
*
- * @param string $lang Language code
- *
- * @return string Previous value
- * @since 11.1
+ * @param string $lang Language code
+ *
+ * @return string Previous value
+ * @since 11.1
*/
public function setLanguage($lang)
{
@@ -1066,8 +1066,8 @@
/**
* Get the language locale based on current language
*
- * @return array false The locale according to the language
- * @since 11.1
+ * @return array false The locale according to the language
+ * @since 11.1
*/
public function getLocale()
{
@@ -1089,8 +1089,8 @@
/**
* Get the first day of the week for this language
*
- * @return integer The first day of the week according to the language
- * @since 11.1
+ * @return integer The first day of the week according to the language
+ * @since 11.1
*/
public function getFirstDay()
{
@@ -1100,10 +1100,10 @@
/**
* Searches for language directories within a certain base dir
*
- * @param string $dir directory of files
- * @return array Array holding the found languages as filename => real name pairs
+ * @param string $dir directory of files
+ * @return array Array holding the found languages as filename => real name pairs
* @deprecated use parseLanguageFiles instead
- * @since 11.1
+ * @since 11.1
*/
public static function _parseLanguageFiles($dir = null)
{
@@ -1113,10 +1113,10 @@
/**
* Searches for language directories within a certain base dir
*
- * @param string $dir directory of files
- *
- * @return array Array holding the found languages as filename => real name pairs
- * @since 11.1
+ * @param string $dir directory of files
+ *
+ * @return array Array holding the found languages as filename => real name pairs
+ * @since 11.1
*/
public static function parseLanguageFiles($dir = null)
{
@@ -1136,10 +1136,10 @@
/**
* Parses XML files for language information
*
- * @param string $dir Directory of files
- * @return array Array holding the found languages as filename => metadata array
+ * @param string $dir Directory of files
+ * @return array Array holding the found languages as filename => metadata array
* @deprecated use parseXMLLanguageFiles instead
- * @since 11.1
+ * @since 11.1
*/
public static function _parseXMLLanguageFiles($dir = null)
{
@@ -1149,9 +1149,9 @@
/**
* Parses XML files for language information
*
- * @param string $dir Directory of files
- * @return array Array holding the found languages as filename => metadata array
- * @since 11.1
+ * @param string $dir Directory of files
+ * @return array Array holding the found languages as filename => metadata array
+ * @since 11.1
*/
public static function parseXMLLanguageFiles($dir = null)
{
@@ -1176,11 +1176,11 @@
/**
* Parse XML file for language information.
*
- * @param string $path Path to the XML files
- *
- * @return array Array holding the found metadata as a key => value pair
+ * @param string $path Path to the XML files
+ *
+ * @return array Array holding the found metadata as a key => value pair
* @deprecated use parseXMLLanguageFile instead
- * @since 11.1
+ * @since 11.1
*/
public static function _parseXMLLanguageFile($path)
{
@@ -1190,10 +1190,10 @@
/**
* Parse XML file for language information.
*
- * @param string $path Path to the XML files
- *
- * @return array Array holding the found metadata as a key => value pair
- * @since 11.1
+ * @param string $path Path to the XML files
+ *
+ * @return array Array holding the found metadata as a key => value pair
+ * @since 11.1
*/
public static function parseXMLLanguageFile($path)
{
Modified: development/branches/platform/libraries/joomla/language/latin_transliterate.php
===================================================================
--- development/branches/platform/libraries/joomla/language/latin_transliterate.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/language/latin_transliterate.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,10 +28,10 @@
/**
* Returns strings transliterated from UTF-8 to Latin
*
- * @param string $string
- * @param boolean $case Optionally specify upper or lower case. Default to null.
- *
- * @return string transliterated string
+ * @param string $string
+ * @param boolean $case Optionally specify upper or lower case. Default to null.
+ *
+ * @return string transliterated string
*/
static function utf8_latin_to_ascii( $string, $case=0 ){
Modified: development/branches/platform/libraries/joomla/log/log.php
===================================================================
--- development/branches/platform/libraries/joomla/log/log.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/log.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -94,7 +94,7 @@
protected static $instance;
/**
- * @var array The array of instances created through the deprecated getInstance method.
+ * @var array The array of instances created through the deprecated getInstance method.
* @since 11.1
* @see JLog::getInstance()
* @deprecated 11.2
@@ -199,14 +199,14 @@
* This method must be invoked as:
* <pre>$log = JLog::getInstance($file, $options, $path);</pre>
*
- * @param string $file The filename of the log file.
- * @param array $options The object configuration array.
- * @param string $path The base path for the log file.
+ * @param string $file The filename of the log file.
+ * @param array $options The object configuration array.
+ * @param string $path The base path for the log file.
*
- * @return JLog
+ * @return JLog
*
- * @deprecated 11.2
- * @since 11.1
+ * @deprecated
+ * @since 11.1
*/
public static function getInstance($file = 'error.php', $options = null, $path = null)
{
@@ -269,11 +269,11 @@
/**
* Method to add an entry to the log file.
*
- * @param array Array of values to map to the format string for the log file.
+ * @param array $entry Array of values to map to the format string for the log file.
*
- * @return boolean True on success.
+ * @return boolean True on success.
*
- * @deprecated 11.2
+ * @deprecated
* @since 11.1
*/
public function addEntry($entry)
Modified: development/branches/platform/libraries/joomla/log/logger.php
===================================================================
--- development/branches/platform/libraries/joomla/log/logger.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/logger.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,7 +25,7 @@
{
/**
* @var array Options array for the JLog instance.
- * @since 11.1
+ * @since 11.1
*/
protected $options = array();
Modified: development/branches/platform/libraries/joomla/log/loggers/database.php
===================================================================
--- development/branches/platform/libraries/joomla/log/loggers/database.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/loggers/database.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,43 +28,43 @@
{
/**
* @var string The name of the database driver to use for connecting to the database.
- * @since 11.1
+ * @since 11.1
*/
protected $driver = 'mysql';
/**
* @var string The host name (or IP) of the server with which to connect for the logger.
- * @since 11.1
+ * @since 11.1
*/
protected $host = '127.0.0.1';
/**
* @var string The database server user to connect as for the logger.
- * @since 11.1
+ * @since 11.1
*/
protected $user = 'root';
/**
* @var string The password to use for connecting to the database server.
- * @since 11.1
+ * @since 11.1
*/
protected $password = '';
/**
* @var string The name of the database table to use for the logger.
- * @since 11.1
+ * @since 11.1
*/
protected $database = 'logging';
/**
* @var string The database table to use for logging entries.
- * @since 11.1
+ * @since 11.1
*/
protected $table = 'jos_';
/**
* @var JDatabase The database connection object for the logger.
- * @since 11.1
+ * @since 11.1
*/
protected $dbo;
Modified: development/branches/platform/libraries/joomla/log/loggers/echo.php
===================================================================
--- development/branches/platform/libraries/joomla/log/loggers/echo.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/loggers/echo.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,7 +23,7 @@
{
/**
* @var array Translation array for JLogEntry priorities to text strings.
- * @since 11.1
+ * @since 11.1
*/
protected $priorities = array(
JLog::EMERGENCY => 'EMERGENCY',
Modified: development/branches/platform/libraries/joomla/log/loggers/formattedtext.php
===================================================================
--- development/branches/platform/libraries/joomla/log/loggers/formattedtext.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/loggers/formattedtext.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -27,32 +27,32 @@
{
/**
* @var resource The file pointer for the log file.
- * @since 11.1
+ * @since 11.1
*/
protected $file;
/**
* @var string The format for which each entry follows in the log file. All fields must be named
* in all caps and be within curly brackets eg. {FOOBAR}.
- * @since 11.1
+ * @since 11.1
*/
protected $format = '{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}';
/**
* @var array The parsed fields from the format string.
- * @since 11.1
+ * @since 11.1
*/
protected $fields = array();
/**
* @var string The full filesystem path for the log file.
- * @since 11.1
+ * @since 11.1
*/
protected $path;
/**
* @var array Translation array for JLogEntry priorities to text strings.
- * @since 11.1
+ * @since 11.1
*/
protected $priorities = array(
JLog::EMERGENCY => 'EMERGENCY',
Modified: development/branches/platform/libraries/joomla/log/loggers/syslog.php
===================================================================
--- development/branches/platform/libraries/joomla/log/loggers/syslog.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/loggers/syslog.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,7 +28,7 @@
{
/**
* @var array Translation array for JLogEntry priorities to SysLog priority names.
- * @since 11.1
+ * @since 11.1
*/
protected $priorities = array(
JLog::EMERGENCY => 'EMERG',
Modified: development/branches/platform/libraries/joomla/log/loggers/w3c.php
===================================================================
--- development/branches/platform/libraries/joomla/log/loggers/w3c.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/log/loggers/w3c.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,7 +30,7 @@
/**
* @var string The format which each entry follows in the log file. All fields must be
* named in all caps and be within curly brackets eg. {FOOBAR}.
- * @since 11.1
+ * @since 11.1
*/
protected $format = '{DATE} {TIME} {PRIORITY} {CLIENTIP} {CATEGORY} {MESSAGE}';
Modified: development/branches/platform/libraries/joomla/mail/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/mail/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/mail/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,8 +25,8 @@
/**
* Cleans single line inputs.
*
- * @param string $value String to be cleaned.
- * @return string Cleaned string.
+ * @param string $value String to be cleaned.
+ * @return string Cleaned string.
*/
public static function cleanLine($value)
{
@@ -36,8 +36,8 @@
/**
* Cleans multi-line inputs.
*
- * @param string $value Multi-line string to be cleaned.
- * @return string Cleaned multi-line string.
+ * @param string $value Multi-line string to be cleaned.
+ * @return string Cleaned multi-line string.
*/
public static function cleanText($value)
{
@@ -47,9 +47,9 @@
/**
* Cleans any injected headers from the email body.
*
- * @param string $body email body string.
- * @return string Cleaned email body string.
- * @since 11.1
+ * @param string $body email body string.
+ * @return string Cleaned email body string.
+ * @since 11.1
*/
public static function cleanBody($body)
{
@@ -60,9 +60,9 @@
/**
* Cleans any injected headers from the subject string.
*
- * @param string $subject email subject string.
- * @return string Cleaned email subject string.
- * @since 11.1
+ * @param string $subject email subject string.
+ * @return string Cleaned email subject string.
+ * @since 11.1
*/
public static function cleanSubject($subject)
{
@@ -72,9 +72,9 @@
/**
* Verifies that an email address does not have any extra headers injected into it.
*
- * @param string $address email address.
- * @return string false email address string or boolean false if injected headers are present.
- * @since 11.1
+ * @param string $address email address.
+ * @return string false email address string or boolean false if injected headers are present.
+ * @since 11.1
*/
public static function cleanAddress($address)
{
@@ -87,9 +87,9 @@
/**
* Verifies that the string is in a proper email address format.
*
- * @param string $email String to be verified.
- * @return boolean True if string has the correct format; false otherwise.
- * @since 11.1
+ * @param string $email String to be verified.
+ * @return boolean True if string has the correct format; false otherwise.
+ * @since 11.1
*/
public static function isEmailAddress($email)
{
Modified: development/branches/platform/libraries/joomla/mail/mail.php
===================================================================
--- development/branches/platform/libraries/joomla/mail/mail.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/mail/mail.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -37,10 +37,10 @@
* NOTE: If you need an instance to use that does not have the global configuration
* values, use an id string that is not 'Joomla'.
*
- * @param string $id The id string for the JMail instance [optional]
+ * @param string $id The id string for the JMail instance [optional]
*
- * @return object The global JMail object
- * @since 11.1
+ * @return object The global JMail object
+ * @since 11.1
*/
public static function getInstance($id = 'Joomla')
{
@@ -60,8 +60,8 @@
/**
* Send the mail
*
- * @return mixed True if successful, a JError object otherwise
- * @since 11.1
+ * @return mixed True if successful, a JError object otherwise
+ * @since 11.1
*/
public function Send()
{
@@ -82,13 +82,13 @@
/**
* Set the email sender
*
- * @param array email address and Name of sender
+ * @param array email address and Name of sender
* <pre>
* array([0] => email Address [1] => Name)
* </pre>
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function setSender($from)
{
@@ -114,10 +114,10 @@
/**
* Set the email subject
*
- * @param string $subject Subject of the email
+ * @param string $subject Subject of the email
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function setSubject($subject)
{
@@ -129,10 +129,10 @@
/**
* Set the email body
*
- * @param string $content Body of the email
+ * @param string $content Body of the email
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function setBody($content)
{
@@ -148,10 +148,10 @@
/**
* Add recipients to the email
*
- * @param mixed $recipient Either a string or array of strings [email address(es)]
+ * @param mixed $recipient Either a string or array of strings [email address(es)]
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function addRecipient($recipient)
{
@@ -174,10 +174,10 @@
/**
* Add carbon copy recipients to the email
*
- * @param mixed $cc Either a string or array of strings [email address(es)]
+ * @param mixed $cc Either a string or array of strings [email address(es)]
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function addCC($cc)
{
@@ -202,10 +202,10 @@
/**
* Add blind carbon copy recipients to the email
*
- * @param mixed $bcc Either a string or array of strings [email address(es)]
+ * @param mixed $bcc Either a string or array of strings [email address(es)]
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function addBCC($bcc)
{
@@ -230,10 +230,10 @@
/**
* Add file attachments to the email
*
- * @param mixed $attachment Either a string or array of strings [filenames]
+ * @param mixed $attachment Either a string or array of strings [filenames]
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function addAttachment($attachment)
{
@@ -256,13 +256,13 @@
/**
* Add Reply to email address(es) to the email
*
- * @param array $replyto Either an array or multi-array of form
+ * @param array $replyto Either an array or multi-array of form
* <pre>
* array([0] => email Address [1] => Name)
* </pre>
*
- * @return object JMail Returns this object for chaining.
- * @since 11.1
+ * @return object JMail Returns this object for chaining.
+ * @since 11.1
*/
public function addReplyTo($replyto)
{
@@ -287,9 +287,9 @@
/**
* Use sendmail for sending the email
*
- * @param string $sendmail Path to sendmail [optional]
- * @return boolean True on success
- * @since 11.1
+ * @param string $sendmail Path to sendmail [optional]
+ * @return boolean True on success
+ * @since 11.1
*/
public function useSendmail($sendmail = null)
{
@@ -310,15 +310,15 @@
/**
* Use SMTP for sending the email
*
- * @param string $auth SMTP Authentication [optional]
- * @param string $host SMTP Host [optional]
- * @param string $user SMTP Username [optional]
- * @param string $pass SMTP Password [optional]
- * @param string $secure
- * @param integer $port
+ * @param string $auth SMTP Authentication [optional]
+ * @param string $host SMTP Host [optional]
+ * @param string $user SMTP Username [optional]
+ * @param string $pass SMTP Password [optional]
+ * @param string $secure
+ * @param integer $port
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function useSMTP($auth = null, $host = null, $user = null, $pass = null, $secure = null, $port = 25)
{
@@ -348,20 +348,20 @@
/**
* Function to send an email
*
- * @param string $from From email address
- * @param string $fromName From name
- * @param mixed $recipient Recipient email address(es)
- * @param string $subject email subject
- * @param string $body Message body
- * @param boolean $mode false = plain text, true = HTML
- * @param mixed $cc CC email address(es)
- * @param mixed $bcc BCC email address(es)
- * @param mixed $attachment Attachment file name(s)
- * @param mixed $replyTo Reply to email address(es)
- * @param mixed $replyToName Reply to name(s)
+ * @param string $from From email address
+ * @param string $fromName From name
+ * @param mixed $recipient Recipient email address(es)
+ * @param string $subject email subject
+ * @param string $body Message body
+ * @param boolean $mode false = plain text, true = HTML
+ * @param mixed $cc CC email address(es)
+ * @param mixed $bcc BCC email address(es)
+ * @param mixed $attachment Attachment file name(s)
+ * @param mixed $replyTo Reply to email address(es)
+ * @param mixed $replyToName Reply to name(s)
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function sendMail($from, $fromName, $recipient, $subject, $body, $mode=0,
$cc=null, $bcc=null, $attachment=null, $replyTo=null, $replyToName=null)
@@ -399,16 +399,16 @@
/**
* Sends mail to administrator for approval of a user submission
*
- * @param string $adminName Name of administrator
- * @param string $adminEmail Email address of administrator
- * @param string $email [NOT USED TODO: Deprecate?]
- * @param string $type Type of item to approve
- * @param string $title Title of item to approve
- * @param string $author Author of item to approve
- * @param string $url
+ * @param string $adminName Name of administrator
+ * @param string $adminEmail Email address of administrator
+ * @param string $email [NOT USED TODO: Deprecate?]
+ * @param string $type Type of item to approve
+ * @param string $title Title of item to approve
+ * @param string $author Author of item to approve
+ * @param string $url
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function sendAdminMail($adminName, $adminEmail, $email, $type, $title, $author, $url = null)
{
Modified: development/branches/platform/libraries/joomla/methods.php
===================================================================
--- development/branches/platform/libraries/joomla/methods.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/methods.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -20,13 +20,13 @@
/**
* Translates an internal Joomla URL to a humanly readible URL.
*
- * @param string Absolute or Relative URI to Joomla resource.
- * @param boolean Replace & by & for XML compilance.
- * @param integer Secure state for the resolved URI.
+ * @param string Absolute or Relative URI to Joomla resource.
+ * @param boolean Replace & by & for XML compilance.
+ * @param integer Secure state for the resolved URI.
* 1: Make URI secure using global secure site URI.
* 0: Leave URI in the same secure state as it was passed to the function.
* -1: Make URI unsecure using the global unsecure site URI.
- * @return The translated humanly readible URL.
+ * @return The translated humanly readible URL.
*/
public static function _($url, $xhtml = true, $ssl = null)
{
@@ -104,15 +104,15 @@
/**
* Translates a string into the current language.
*
- * @param string The string to translate.
- * @param boolean|array boolean: Make the result javascript safe. array an array of option as described in the JText::sprintf function
- * @param boolean To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
- * @param boolean To indicate that the string will be push in the javascript language store
- *
- * @return string The translated string or the key is $script is true
+ * @param string The string to translate.
+ * @param boolean|array boolean: Make the result javascript safe. array an array of option as described in the JText::sprintf function
+ * @param boolean To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
+ * @param boolean To indicate that the string will be push in the javascript language store
+ *
+ * @return string The translated string or the key is $script is true
* @example <script>alert(Joomla.JText._('<?php echo JText::_("JDEFAULT", array("script"=>true));?>'));</script> will generate an alert message containing 'Default'
* @example <?php echo JText::_("JDEFAULT");?> it will generate a 'Default' string
- * @since 11.1
+ * @since 11.1
*
*/
public static function _($string, $jsSafe = false, $interpretBackSlashes = true, $script = false)
@@ -144,16 +144,16 @@
/**
* Translates a string into the current language.
*
- * @param string The string to translate.
- * @param string The alternate option for global string
- * @param boolean|array boolean: Make the result javascript safe. array an array of option as described in the JText::sprintf function
- * @param boolean To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
- * @param boolean To indicate that the string will be pushed in the javascript language store
- *
- * @return string The translated string or the key if $script is true
+ * @param string The string to translate.
+ * @param string The alternate option for global string
+ * @param boolean|array boolean: Make the result javascript safe. array an array of option as described in the JText::sprintf function
+ * @param boolean To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
+ * @param boolean To indicate that the string will be pushed in the javascript language store
+ *
+ * @return string The translated string or the key if $script is true
* @example <?php echo JText::alt("JALL","language");?> it will generate a 'All' string in English but a "Toutes" string in French
* @example <?php echo JText::alt("JALL","module");?> it will generate a 'All' string in English but a "Tous" string in French
- * @since 11.1
+ * @since 11.1
*
*/
public static function alt($string, $alt, $jsSafe = false, $interpretBackSlashes = true, $script = false)
@@ -169,17 +169,17 @@
/**
* Like JText::sprintf but tries to pluralise the string.
*
- * @param string The format string.
- * @param integer The number of items
- * @param mixed Mixed number of arguments for the sprintf function. The first should be an integer.
- * @param array optional Array of option array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean) where
+ * @param string The format string.
+ * @param integer The number of items
+ * @param mixed Mixed number of arguments for the sprintf function. The first should be an integer.
+ * @param array optional Array of option array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean) where
* -jsSafe is a boolean to generate a javascript safe string
* -interpretBackSlashes is a boolean to interpret backslashes \\->\, \n->new line, \t->tabulation
* -script is a boolean to indicate that the string will be push in the javascript language store
- * @return string The translated strings or the key if 'script' is true in the array of options
+ * @return string The translated strings or the key if 'script' is true in the array of options
* @example <script>alert(Joomla.JText._('<?php echo JText::plural("COM_PLUGINS_N_ITEMS_UNPUBLISHED", 1, array("script"=>true));?>'));</script> will generate an alert message containing '1 plugin successfully disabled'
* @example <?php echo JText::plural("COM_PLUGINS_N_ITEMS_UNPUBLISHED", 1);?> it will generate a '1 plugin successfully disabled' string
- * @since 11.1
+ * @since 11.1
*/
public static function plural($string, $n)
@@ -228,15 +228,15 @@
/**
* Passes a string thru a sprintf.
*
- * @param string The format string.
- * @param mixed Mixed number of arguments for the sprintf function.
- * @param array optional Array of option array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean) where
+ * @param string The format string.
+ * @param mixed Mixed number of arguments for the sprintf function.
+ * @param array optional Array of option array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean) where
* -jsSafe is a boolean to generate a javascript safe strings
* -interpretBackSlashes is a boolean to interpret backslashes \\->\, \n->new line, \t->tabulation
* -script is a boolean to indicate that the string will be push in the javascript language store
- *
- * @return string The translated strings or the key if 'script' is true in the array of options
- * @since 11.1
+ *
+ * @return string The translated strings or the key if 'script' is true in the array of options
+ * @since 11.1
*/
public static function sprintf($string)
{
@@ -262,11 +262,11 @@
/**
* Passes a string thru an printf.
*
- * @param format The format string.
- * @param mixed Mixed number of arguments for the sprintf function.
- *
- * @return mixed
- * @since 11.1
+ * @param format The format string.
+ * @param mixed Mixed number of arguments for the sprintf function.
+ *
+ * @return mixed
+ * @since 11.1
*/
public static function printf($string)
{
@@ -288,8 +288,8 @@
/**
* Translate a string into the current language and stores it in the JavaScript language store.
*
- * @param string The JText key.
- * @since 11.1
+ * @param string The JText key.
+ * @since 11.1
*/
public static function script($string = null, $jsSafe = false, $interpretBackSlashes = true)
{
Modified: development/branches/platform/libraries/joomla/plugin/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/plugin/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/plugin/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,11 +22,11 @@
* Get the plugin data of a specific type if no specific plugin is specified
* otherwise only the specific plugin data is returned.
*
- * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
- * @param string $plugin The plugin name.
+ * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
+ * @param string $plugin The plugin name.
*
- * @return mixed An array of plugin data objects, or a plugin data object.
- * @since 11.1
+ * @return mixed An array of plugin data objects, or a plugin data object.
+ * @since 11.1
*/
public static function getPlugin($type, $plugin = null)
{
@@ -57,11 +57,11 @@
/**
* Checks if a plugin is enabled.
*
- * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
- * @param string $plugin The plugin name.
+ * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
+ * @param string $plugin The plugin name.
*
- * @return boolean
- * @since 11.1
+ * @return boolean
+ * @since 11.1
*/
public static function isEnabled($type, $plugin = null)
{
@@ -73,13 +73,13 @@
* Loads all the plugin files for a particular type if no specific plugin is specified
* otherwise only the specific pugin is loaded.
*
- * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
- * @param string $plugin The plugin name.
- * @param boolean $autocreate
- * @param JDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
+ * @param string $type The plugin type, relates to the sub-directory in the plugins directory.
+ * @param string $plugin The plugin name.
+ * @param boolean $autocreate
+ * @param JDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public static function importPlugin($type, $plugin = null, $autocreate = true, $dispatcher = null)
{
@@ -118,12 +118,12 @@
/**
* Loads the plugin file.
*
- * @param JPlugin $plugin The plugin.
- * @param boolean $autocreate
- * @param JDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
+ * @param JPlugin $plugin The plugin.
+ * @param boolean $autocreate
+ * @param JDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
protected static function _import(&$plugin, $autocreate = true, $dispatcher = null)
{
@@ -170,8 +170,8 @@
/**
* Loads the published plugins.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected static function _load()
{
Modified: development/branches/platform/libraries/joomla/plugin/plugin.php
===================================================================
--- development/branches/platform/libraries/joomla/plugin/plugin.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/plugin/plugin.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,7 +24,7 @@
* A JRegistry object holding the parameters for the plugin
*
* @var A JRegistry object
- * @since 11.1
+ * @since 11.1
*/
public $params = null;
@@ -45,8 +45,8 @@
/**
* Constructor
*
- * @param object $subject The object to observe
- * @param array $config An optional associative array of configuration settings.
+ * @param object $subject The object to observe
+ * @param array $config An optional associative array of configuration settings.
* Recognized key values include 'name', 'group', 'params', 'language'
* (this list is not meant to be comprehensive).
* @since 11.1
@@ -80,11 +80,11 @@
/**
* Loads the plugin language file
*
- * @param string $extension The extension for which a language file should be loaded
- * @param string $basePath The basepath to use
- *
- * @return boolean True, if the file has successfully loaded.
- * @since 11.1
+ * @param string $extension The extension for which a language file should be loaded
+ * @param string $basePath The basepath to use
+ *
+ * @return boolean True, if the file has successfully loaded.
+ * @since 11.1
*/
public function loadLanguage($extension = '', $basePath = JPATH_ADMINISTRATOR)
{
Modified: development/branches/platform/libraries/joomla/registry/format/ini.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/format/ini.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/format/ini.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -26,10 +26,10 @@
* levels deep. Therefore we will only go through the first two levels of
* the object.
*
- * @param object Data source object.
- * @param array Options used by the formatter.
- * @return string INI formatted string.
- * @since 11.1
+ * @param object Data source object.
+ * @param array Options used by the formatter.
+ * @return string INI formatted string.
+ * @since 11.1
*/
public function objectToString($object, $options = array())
{
@@ -61,12 +61,12 @@
/**
* Parse an INI formatted string and convert it into an object.
*
- * @param string INI formatted string to convert.
- * @param mixed An array of options used by the formatter, or a boolean setting to process sections.
- *
- * @return object Data object.
- * @since 11.1
+ * @param string INI formatted string to convert.
+ * @param mixed An array of options used by the formatter, or a boolean setting to process sections.
*
+ * @return object Data object.
+ * @since 11.1
+ *
*/
public function stringToObject($data, $options = array())
{
@@ -179,9 +179,9 @@
/**
* Method to get a value in an INI format.
*
- * @param mixed The value to convert to INI format.
- * @return string The value in INI format.
- * @since 11.1
+ * @param mixed The value to convert to INI format.
+ * @return string The value in INI format.
+ * @since 11.1
*/
protected function _getValueAsINI($value)
{
Modified: development/branches/platform/libraries/joomla/registry/format/json.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/format/json.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/format/json.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,10 +21,10 @@
/**
* Converts an object into a JSON formatted string.
*
- * @param object Data source object.
- * @param array Options used by the formatter.
- * @return string JSON formatted string.
- * @since 11.1
+ * @param object Data source object.
+ * @param array Options used by the formatter.
+ * @return string JSON formatted string.
+ * @since 11.1
*/
public function objectToString($object, $options = array())
{
@@ -36,9 +36,9 @@
*
* If the string is not in JSON format, this method will attempt to parse it as INI format.
*
- * @param string JSON formatted string to convert.
- * @param array Options used by the formatter.
- * @return object Data object.
+ * @param string JSON formatted string to convert.
+ * @param array Options used by the formatter.
+ * @return object Data object.
*/
public function stringToObject($data, $process_sections = false)
{
Modified: development/branches/platform/libraries/joomla/registry/format/php.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/format/php.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/format/php.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,9 +22,9 @@
* Converts an object into a php class string.
* - NOTE: Only one depth level is supported.
*
- * @param object Data Source Object
- * @param array Parameters used by the formatter
- * @return string Config class formatted string
+ * @param object Data Source Object
+ * @param array Parameters used by the formatter
+ * @return string Config class formatted string
*/
public function objectToString($object, $params = array())
{
@@ -53,7 +53,7 @@
/**
* Placeholder method
*
- * @return boolean True
+ * @return boolean True
*/
function stringToObject($data, $namespace='')
{
Modified: development/branches/platform/libraries/joomla/registry/format/xml.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/format/xml.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/format/xml.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,10 +23,10 @@
* - If more than two levels of nested groups are necessary, since INI is not
* useful, XML or another format should be used.
*
- * @param object Data source object.
- * @param array Options used by the formatter.
- * @return string XML formatted string.
- * @since 11.1
+ * @param object Data source object.
+ * @param array Options used by the formatter.
+ * @return string XML formatted string.
+ * @since 11.1
*/
public function objectToString($object, $options = array())
{
@@ -59,10 +59,10 @@
/**
* Parse a XML formatted string and convert it into an object.
*
- * @param string XML formatted string to convert.
- * @param array Options used by the formatter.
- * @return object Data object.
- * @since 11.1
+ * @param string XML formatted string to convert.
+ * @param array Options used by the formatter.
+ * @return object Data object.
+ * @since 11.1
*/
public function stringToObject($data, $options = array())
{
@@ -82,8 +82,8 @@
/**
* Method to get a PHP native value for a SimpleXMLElement object. -- called recursively
*
- * @param object SimpleXMLElement object for which to get the native value.
- * @return mixed Native value of the SimpleXMLElement object.
+ * @param object SimpleXMLElement object for which to get the native value.
+ * @return mixed Native value of the SimpleXMLElement object.
* @since 2.0
*/
protected function _getValueFromNode($node)
@@ -124,10 +124,10 @@
/**
* Method to build a level of the XML string -- called recursively
*
- * @param object SimpleXMLElement object to attach children.
- * @param object Object that represents a node of the XML document.
- * @param string The name to use for node elements.
- * @return void
+ * @param object SimpleXMLElement object to attach children.
+ * @param object Object that represents a node of the XML document.
+ * @param string The name to use for node elements.
+ * @return void
* @since 2.0
*/
protected function _getXmlChildren(& $node, $var, $nodeName)
Modified: development/branches/platform/libraries/joomla/registry/format.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/format.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/format.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,10 +22,10 @@
* Returns a reference to a Format object, only creating it
* if it doesn't already exist.
*
- * @param string The format to load
- * @return object Registry format handler
+ * @param string The format to load
+ * @return object Registry format handler
* @throws JException
- * @since 11.1
+ * @since 11.1
*/
public static function getInstance($type)
{
@@ -59,20 +59,20 @@
/**
* Converts an object into a formatted string.
*
- * @param object Data Source Object.
- * @param array An array of options for the formatter.
- * @return string Formatted string.
- * @since 11.1
+ * @param object Data Source Object.
+ * @param array An array of options for the formatter.
+ * @return string Formatted string.
+ * @since 11.1
*/
abstract public function objectToString($object, $options = null);
/**
* Converts a formatted string into an object.
*
- * @param string Formatted string
- * @param array An array of options for the formatter.
- * @return object Data Object
- * @since 11.1
+ * @param string Formatted string
+ * @param array An array of options for the formatter.
+ * @return object Data Object
+ * @since 11.1
*/
abstract public function stringToObject($data, $options = null);
}
\ No newline at end of file
Modified: development/branches/platform/libraries/joomla/registry/registry.php
===================================================================
--- development/branches/platform/libraries/joomla/registry/registry.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/registry/registry.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -30,8 +30,8 @@
/**
* Constructor
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function __construct($data = null)
{
@@ -66,11 +66,11 @@
/**
* Sets a default value if not alreay assigned.
*
- * @param string The name of the parameter.
- * @param string An optional value for the parameter.
- * @param string An optional group for the parameter.
- * @return string The value set, or the default if the value was not previously set (or null).
- * @since 11.1
+ * @param string The name of the parameter.
+ * @param string An optional value for the parameter.
+ * @param string An optional group for the parameter.
+ * @return string The value set, or the default if the value was not previously set (or null).
+ * @since 11.1
*/
public function def($key, $default = '')
{
@@ -82,9 +82,9 @@
/**
* Check if a registry path exists.
*
- * @param string Registry path (e.g. joomla.content.showauthor)
- * @return boolean
- * @since 11.1
+ * @param string Registry path (e.g. joomla.content.showauthor)
+ * @return boolean
+ * @since 11.1
*/
public function exists($path)
{
@@ -113,10 +113,10 @@
/**
* Get a registry value.
*
- * @param string Registry path (e.g. joomla.content.showauthor)
- * @param mixed Optional default value, returned if the internal value is null.
- * @return mixed Value of entry or null
- * @since 11.1
+ * @param string Registry path (e.g. joomla.content.showauthor)
+ * @param mixed Optional default value, returned if the internal value is null.
+ * @return mixed Value of entry or null
+ * @since 11.1
*/
public function get($path, $default = null)
{
@@ -157,9 +157,9 @@
* This method must be invoked as:
* <pre>$registry = JRegistry::getInstance($id);</pre>
*
- * @param string An ID for the registry instance
- * @return object The JRegistry object.
- * @since 11.1
+ * @param string An ID for the registry instance
+ * @return object The JRegistry object.
+ * @since 11.1
*/
public static function getInstance($id)
{
@@ -179,10 +179,10 @@
/**
* Load a associative array of values into the default namespace
*
- * @param array Associative array of value to load
- * @param string The name of the namespace
- * @return boolean True on success
- * @since 11.1
+ * @param array Associative array of value to load
+ * @param string The name of the namespace
+ * @return boolean True on success
+ * @since 11.1
*/
public function loadArray($array)
{
@@ -194,10 +194,10 @@
/**
* Load the public variables of the object into the default namespace.
*
- * @param object The object holding the publics to load
- * @param string Namespace to load the INI string into [optional]
- * @return boolean True on success
- * @since 11.1
+ * @param object The object holding the publics to load
+ * @param string Namespace to load the INI string into [optional]
+ * @return boolean True on success
+ * @since 11.1
*/
public function loadObject($object)
{
@@ -209,11 +209,11 @@
/**
* Load the contents of a file into the registry
*
- * @param string Path to file to load
- * @param string Format of the file [optional: defaults to JSON]
- * @param mixed Options used by the formatter
- * @return boolean True on success
- * @since 11.1
+ * @param string Path to file to load
+ * @param string Format of the file [optional: defaults to JSON]
+ * @param mixed Options used by the formatter
+ * @return boolean True on success
+ * @since 11.1
*/
public function loadFile($file, $format = 'JSON', $options = array())
{
@@ -227,11 +227,11 @@
/**
* Load a string into the registry
*
- * @param string string to load into the registry
- * @param string format of the string
- * @param mixed Options used by the formatter
- * @return boolean True on success
- * @since 11.1
+ * @param string string to load into the registry
+ * @param string format of the string
+ * @param mixed Options used by the formatter
+ * @return boolean True on success
+ * @since 11.1
*/
public function loadString($data, $format = 'JSON', $options = array())
{
@@ -247,9 +247,9 @@
/**
* Merge a JRegistry object into this one
*
- * @param object Source JRegistry object ot merge
- * @return boolean True on success
- * @since 11.1
+ * @param object Source JRegistry object ot merge
+ * @return boolean True on success
+ * @since 11.1
*/
public function merge(&$source)
{
@@ -268,10 +268,10 @@
/**
* Set a registry value.
*
- * @param string Registry Path (e.g. joomla.content.showauthor)
- * @param mixed Value of entry
- * @return mixed The value of the that has been set.
- * @since 11.1
+ * @param string Registry Path (e.g. joomla.content.showauthor)
+ * @param mixed Value of entry
+ * @return mixed The value of the that has been set.
+ * @since 11.1
*/
public function set($path, $value)
{
@@ -300,9 +300,9 @@
/**
* Transforms a namespace to an array
*
- * @param string Namespace to return [optional: null returns the default namespace]
- * @return array An associative array holding the namespace data
- * @since 11.1
+ * @param string Namespace to return [optional: null returns the default namespace]
+ * @return array An associative array holding the namespace data
+ * @since 11.1
*/
public function toArray()
{
@@ -312,9 +312,9 @@
/**
* Transforms a namespace to an object
*
- * @param string Namespace to return [optional: null returns the default namespace]
- * @return object An an object holding the namespace data
- * @since 11.1
+ * @param string Namespace to return [optional: null returns the default namespace]
+ * @return object An an object holding the namespace data
+ * @since 11.1
*/
public function toObject()
{
@@ -324,10 +324,10 @@
/**
* Get a namespace in a given string format
*
- * @param string Format to return the string in
- * @param mixed Parameters used by the formatter, see formatters for more info
- * @return string Namespace in string format
- * @since 11.1
+ * @param string Format to return the string in
+ * @param mixed Parameters used by the formatter, see formatters for more info
+ * @return string Namespace in string format
+ * @since 11.1
*/
public function toString($format = 'JSON', $options = array())
{
@@ -340,11 +340,11 @@
/**
* Method to recursively bind data to a parent object.
*
- * @param object $parent The parent object on which to attach the data values.
- * @param mixed $data An array or object of data to bind to the parent object.
+ * @param object $parent The parent object on which to attach the data values.
+ * @param mixed $data An array or object of data to bind to the parent object.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
protected function bindData(& $parent, $data)
{
@@ -368,10 +368,10 @@
/**
* Method to recursively convert an object of data to an array.
*
- * @param object $data An object of data to return as an array.
+ * @param object $data An object of data to return as an array.
*
- * @return array Array representation of the input object.
- * @since 11.1
+ * @return array Array representation of the input object.
+ * @since 11.1
*/
protected function asArray($data)
{
@@ -395,10 +395,10 @@
/**
* Load an XML string into the registry into the given namespace [or default if a namespace is not given]
*
- * @param string XML formatted string to load into the registry
- * @param string Namespace to load the XML string into [optional]
- * @return boolean True on success
- * @since 11.1
+ * @param string XML formatted string to load into the registry
+ * @param string Namespace to load the XML string into [optional]
+ * @return boolean True on success
+ * @since 11.1
* @deprecated 1.6 - Oct 25, 2010
*/
public function loadXML($data, $namespace = null)
@@ -409,11 +409,11 @@
/**
* Load an INI string into the registry into the given namespace [or default if a namespace is not given]
*
- * @param string INI formatted string to load into the registry
- * @param string Namespace to load the INI string into [optional]
- * @param mixed An array of options for the formatter, or boolean to process sections.
- * @return boolean True on success
- * @since 11.1
+ * @param string INI formatted string to load into the registry
+ * @param string Namespace to load the INI string into [optional]
+ * @param mixed An array of options for the formatter, or boolean to process sections.
+ * @return boolean True on success
+ * @since 11.1
* @deprecated 1.6 - Oct 25, 2010
*/
public function loadINI($data, $namespace = null, $options = array())
@@ -424,9 +424,9 @@
/**
* Load an JSON string into the registry into the given namespace [or default if a namespace is not given]
*
- * @param string JSON formatted string to load into the registry
- * @return boolean True on success
- * @since 11.1
+ * @param string JSON formatted string to load into the registry
+ * @return boolean True on success
+ * @since 11.1
* @deprecated 1.6 - Oct 25, 2010
*/
public function loadJSON($data)
@@ -437,9 +437,9 @@
/**
* Create a namespace
*
- * @param string Name of the namespace to create
- * @return boolean True on success
- * @since 11.1
+ * @param string Name of the namespace to create
+ * @return boolean True on success
+ * @since 11.1
* @deprecated 1.6 - Jan 19, 2010
*/
public function makeNameSpace($namespace)
@@ -451,7 +451,7 @@
/**
* Get the list of namespaces
*
- * @return array List of namespaces
+ * @return array List of namespaces
* @deprecated 1.6 - Jan 19, 2010
*/
public function getNameSpaces()
@@ -463,9 +463,9 @@
/**
* Get a registry value
*
- * @param string Registry path (e.g. joomla.content.showauthor)
- * @param mixed Optional default value
- * @return mixed Value of entry or null
+ * @param string Registry path (e.g. joomla.content.showauthor)
+ * @param mixed Optional default value
+ * @return mixed Value of entry or null
* @deprecated 1.6 - Jan 19, 2010
*/
public function getValue($path, $default=null)
@@ -481,9 +481,9 @@
/**
* Set a registry value
*
- * @param string Registry Path (e.g. joomla.content.showauthor)
- * @param mixed Value of entry
- * @return mixed The value after setting.
+ * @param string Registry Path (e.g. joomla.content.showauthor)
+ * @param mixed Value of entry
+ * @return mixed The value after setting.
* @deprecated 1.6 - Jan 19, 2010
*/
public function setValue($path, $value)
@@ -501,7 +501,7 @@
* object where in 1.5 a JParameter object existed. Because many extensions may call this method
* we add it here as a means of "pain relief" until the 1.7 release.
*
- * @return boolean True.
+ * @return boolean True.
*
* @deprecated 1.6 - Jun 17, 2010
* @todo Remove this method for the 1.7 release.
Modified: development/branches/platform/libraries/joomla/session/session.php
===================================================================
--- development/branches/platform/libraries/joomla/session/session.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/session.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -70,8 +70,8 @@
/**
* Constructor
*
- * @param string $storage
- * @param array $options optional parameters
+ * @param string $storage
+ * @param array $options optional parameters
*/
public function __construct($store = 'none', $options = array())
{
@@ -122,8 +122,8 @@
* Returns the global Session object, only creating it
* if it doesn't already exist.
*
- * @return object JSession The Session object.
- * @since 11.1
+ * @return object JSession The Session object.
+ * @since 11.1
*/
public static function getInstance($handler, $options)
{
@@ -139,7 +139,7 @@
/**
* Get current state of session
*
- * @return string The session state
+ * @return string The session state
*/
public function getState()
{
@@ -149,7 +149,7 @@
/**
* Get expiration time in minutes
*
- * @return integer The session expiration time in minutes
+ * @return integer The session expiration time in minutes
*/
public function getExpire()
{
@@ -163,8 +163,8 @@
* has been generated the system will check the post request to see if
* it is present, if not it will invalidate the session.
*
- * @param boolean If true, force a new token to be created
- *
+ * @param boolean If true, force a new token to be created
+ *
* @return string The session token
*/
public function getToken($forceNew = false)
@@ -186,7 +186,7 @@
*
* @param string Hashed token to be verified
* @param boolean If true, expires the session
- *
+ *
* @return boolean
* @since 11.1
*/
@@ -209,7 +209,7 @@
/**
* Method to determine a hash for anti-spoofing variable names
*
- * @return string Hashed var name
+ * @return string Hashed var name
* @since 11.1
*/
public static function getFormToken($forceNew = false)
@@ -224,7 +224,7 @@
/**
* Get session name
*
- * @return string The session name
+ * @return string The session name
*/
public function getName()
{
@@ -238,7 +238,7 @@
/**
* Get session id
*
- * @return string The session name
+ * @return string The session name
*/
public function getId()
{
@@ -252,7 +252,7 @@
/**
* Get the session handlers
*
- * @return array An array of available session handlers
+ * @return array An array of available session handlers
*/
public static function getStores()
{
@@ -294,10 +294,10 @@
/**
* Get data from the session store
*
- * @param string Name of a variable
- * @param mixed Default value of a variable if not set
- * @param string Namespace to use, default to 'default'
- *
+ * @param string Name of a variable
+ * @param mixed Default value of a variable if not set
+ * @param string Namespace to use, default to 'default'
+ *
* @return mixed Value of a variable
*/
public function get($name, $default = null, $namespace = 'default')
@@ -319,10 +319,10 @@
/**
* Set data into the session store.
*
- * @param string Name of a variable.
- * @param mixed Value of a variable.
- * @param string Namespace to use, default to 'default'.
- *
+ * @param string Name of a variable.
+ * @param mixed Value of a variable.
+ * @param string Namespace to use, default to 'default'.
+ *
* @return mixed Old value of a variable.
*/
public function set($name, $value = null, $namespace = 'default')
@@ -348,8 +348,8 @@
/**
* Check whether data exists in the session store
*
- * @param string Name of variable
- * @param string Namespace to use, default to 'default'
+ * @param string Name of variable
+ * @param string Namespace to use, default to 'default'
* @return boolean True if the variable exists
*/
public function has($name, $namespace = 'default')
@@ -369,7 +369,7 @@
*
* @param string Name of variable
* @param string Namespace to use, default to 'default'
- * @return mixed The value from session or NULL if not set
+ * @return mixed The value from session or NULL if not set
*/
public function clear($name, $namespace = 'default')
{
@@ -546,7 +546,7 @@
/**
* Create a session id
*
- * @return string Session ID
+ * @return string Session ID
*/
protected function _createId()
{
@@ -585,7 +585,7 @@
* Create a token-string
*
* @param integer length of string
- *
+ *
* @return string generated token
*/
protected function _createToken($length = 32)
@@ -639,8 +639,8 @@
/**
* Set additional session options
*
- * @param array list of parameter
- *
+ * @param array list of parameter
+ *
* @return boolean true on success
*/
protected function _setOptions(&$options)
@@ -684,8 +684,8 @@
*
* If one check failed, session data has to be cleaned.
*
- * @param boolean reactivate session
- *
+ * @param boolean reactivate session
+ *
* @return boolean true on success
* @see http://shiflett.org/articles/the-truth-about-sessions
*/
Modified: development/branches/platform/libraries/joomla/session/storage/apc.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/apc.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/apc.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct($options = array())
{
@@ -36,9 +36,9 @@
/**
* Open the SessionHandler backend.
*
- * @param string $save_path The path to the session object.
- * @param string $session_name The name of the session.
- *
+ * @param string $save_path The path to the session object.
+ * @param string $session_name The name of the session.
+ *
* @return boolean True on success, false otherwise.
*/
public function open($save_path, $session_name)
@@ -60,9 +60,9 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
- * @return string The session data.
+ * @param string $id The session identifier.
+ *
+ * @return string The session data.
*/
public function read($id)
{
@@ -73,9 +73,9 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string $id The session identifier.
- * @param string $session_data The session data.
- *
+ * @param string $id The session identifier.
+ * @param string $session_data The session data.
+ *
* @return boolean True on success, false otherwise.
*/
public function write($id, $session_data)
@@ -88,7 +88,7 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string $id The session identifier.
+ * @param string $id The session identifier.
* @return boolean True on success, false otherwise.
*/
public function destroy($id)
@@ -100,8 +100,8 @@
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
- * @param integer $maxlifetime The maximum age of a session.
- *
+ * @param integer $maxlifetime The maximum age of a session.
+ *
* @return boolean True on success, false otherwise.
*/
public function gc($maxlifetime = null)
Modified: development/branches/platform/libraries/joomla/session/storage/database.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/database.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/database.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -24,10 +24,10 @@
/**
* Open the SessionHandler backend.
*
- * @param string The path to the session object.
- * @param string The name of the session.
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string The path to the session object.
+ * @param string The name of the session.
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function open($save_path, $session_name)
{
@@ -37,8 +37,8 @@
/**
* Close the SessionHandler backend.
*
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function close()
{
@@ -49,9 +49,9 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string The session identifier.
- * @return string The session data.
- * @since 11.1
+ * @param string The session identifier.
+ * @return string The session data.
+ * @since 11.1
*/
public function read($id)
{
@@ -73,11 +73,11 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string The session identifier.
- * @param string The session data.
- *
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string The session identifier.
+ * @param string The session data.
+ *
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function write($id, $data)
{
@@ -114,10 +114,10 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string The session identifier.
- *
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param string The session identifier.
+ *
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
public function destroy($id)
{
@@ -138,9 +138,9 @@
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
- * @param integer The maximum age of a session.
- * @return boolean True on success, false otherwise.
- * @since 11.1
+ * @param integer The maximum age of a session.
+ * @return boolean True on success, false otherwise.
+ * @since 11.1
*/
function gc($lifetime = 1440)
{
Modified: development/branches/platform/libraries/joomla/session/storage/eaccelerator.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/eaccelerator.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/eaccelerator.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct($options = array())
{
@@ -36,9 +36,9 @@
/**
* Open the SessionHandler backend.
*
- * @param string $save_path The path to the session object.
- * @param string $session_name The name of the session.
- *
+ * @param string $save_path The path to the session object.
+ * @param string $session_name The name of the session.
+ *
* @return boolean True on success, false otherwise.
*/
public function open($save_path, $session_name)
@@ -48,7 +48,7 @@
/**
* Close the SessionHandler backend.
- *
+ *
* @return boolean True on success, false otherwise.
*/
public function close()
@@ -60,9 +60,9 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
- * @return string The session data.
+ * @param string $id The session identifier.
+ *
+ * @return string The session data.
*/
public function read($id)
{
@@ -73,9 +73,9 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string $id The session identifier.
- * @param string $session_data The session data.
- *
+ * @param string $id The session identifier.
+ * @param string $session_data The session data.
+ *
* @return boolean True on success, false otherwise.
*/
public function write($id, $session_data)
@@ -88,7 +88,7 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string $id The session identifier.
+ * @param string $id The session identifier.
* @return boolean True on success, false otherwise.
*/
public function destroy($id)
@@ -100,8 +100,8 @@
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
- * @param integer $maxlifetime The maximum age of a session.
- *
+ * @param integer $maxlifetime The maximum age of a session.
+ *
* @return boolean True on success, false otherwise.
*/
public function gc($maxlifetime = null)
Modified: development/branches/platform/libraries/joomla/session/storage/memcache.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/memcache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/memcache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -45,7 +45,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct($options = array())
{
@@ -77,9 +77,9 @@
/**
* Open the SessionHandler backend.
*
- * @param string $save_path The path to the session object.
- * @param string $session_name The name of the session.
- *
+ * @param string $save_path The path to the session object.
+ * @param string $session_name The name of the session.
+ *
* @return boolean True on success, false otherwise.
*/
public function open($save_path, $session_name)
@@ -107,9 +107,9 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
- * @return string The session data.
+ * @param string $id The session identifier.
+ *
+ * @return string The session data.
*/
public function read($id)
{
@@ -121,9 +121,9 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string $id The session identifier.
- * @param string $session_data The session data.
- *
+ * @param string $id The session identifier.
+ * @param string $session_data The session data.
+ *
* @return boolean True on success, false otherwise.
*/
public function write($id, $session_data)
@@ -146,8 +146,8 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
+ * @param string $id The session identifier.
+ *
* @return boolean True on success, false otherwise.
*/
public function destroy($id)
@@ -162,7 +162,7 @@
*
* -- Not Applicable in memcache --
*
- * @param integer $maxlifetime The maximum age of a session.
+ * @param integer $maxlifetime The maximum age of a session.
* @return boolean True on success, false otherwise.
*/
public function gc($maxlifetime = null)
@@ -183,8 +183,8 @@
/**
* Set expire time on each call since memcache sets it on cache creation.
*
- * @param string $key Cache key to expire.
- * @param integer $lifetime Lifetime of the data in seconds.
+ * @param string $key Cache key to expire.
+ * @param integer $lifetime Lifetime of the data in seconds.
*/
protected function _setExpire($key)
{
Modified: development/branches/platform/libraries/joomla/session/storage/none.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/none.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/none.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* Register the functions of this class with PHP's session handler
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function register($options = array())
{
Modified: development/branches/platform/libraries/joomla/session/storage/wincache.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/wincache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/wincache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* Constructor
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function __construct( $options = array() )
{
@@ -36,9 +36,9 @@
/**
* Open the SessionHandler backend.
*
- * @param string $save_path The path to the session object.
- * @param string $session_name The name of the session.
- *
+ * @param string $save_path The path to the session object.
+ * @param string $session_name The name of the session.
+ *
* @return boolean True on success, false otherwise.
*/
public function open($save_path, $session_name)
@@ -60,9 +60,9 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
- * @return string The session data.
+ * @param string $id The session identifier.
+ *
+ * @return string The session data.
*/
public function read($id)
{
@@ -73,9 +73,9 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string $id The session identifier.
- * @param string $session_data The session data.
- *
+ * @param string $id The session identifier.
+ * @param string $session_data The session data.
+ *
* @return boolean True on success, false otherwise.
*/
public function write($id, $session_data)
@@ -88,8 +88,8 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- *
+ * @param string $id The session identifier.
+ *
* @return boolean True on success, false otherwise.
*/
public function destroy($id)
@@ -101,8 +101,8 @@
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
- * @param integer $maxlifetime The maximum age of a session.
- *
+ * @param integer $maxlifetime The maximum age of a session.
+ *
* @return boolean True on success, false otherwise.
*/
public function gc($maxlifetime = null)
Modified: development/branches/platform/libraries/joomla/session/storage/xcache.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage/xcache.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage/xcache.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -12,7 +12,7 @@
/**
* XCache session storage handler
*
- * @package Joomla.Platform
+ * @package Joomla.Platform
* @subpackage Cache
* @since 11.1
*/
Modified: development/branches/platform/libraries/joomla/session/storage.php
===================================================================
--- development/branches/platform/libraries/joomla/session/storage.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/session/storage.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,7 +22,7 @@
/**
* Constructor
*
- * @param array $options Optional parameters.
+ * @param array $options Optional parameters.
*/
public function __construct($options = array())
{
@@ -33,9 +33,9 @@
* Returns a session storage handler object, only creating it
* if it doesn't already exist.
*
- * @param name $name The session store to instantiate
+ * @param name $name The session store to instantiate
*
- * @return database A JSessionStorage object
+ * @return database A JSessionStorage object
* @since 11.1
*/
public static function getInstance($name = 'none', $options = array())
@@ -71,7 +71,7 @@
/**
* Register the functions of this class with PHP's session handler
*
- * @param array $options optional parameters
+ * @param array $options optional parameters
*/
public function register($options = array())
{
@@ -89,9 +89,9 @@
/**
* Open the SessionHandler backend.
*
- * @param string $save_path The path to the session object.
- * @param string $session_name The name of the session.
- *
+ * @param string $save_path The path to the session object.
+ * @param string $session_name The name of the session.
+ *
* @return boolean True on success, false otherwise.
*/
public function open($save_path, $session_name)
@@ -113,8 +113,8 @@
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
- * @param string $id The session identifier.
- * @return string The session data.
+ * @param string $id The session identifier.
+ * @return string The session data.
*/
public function read($id)
{
@@ -124,9 +124,9 @@
/**
* Write session data to the SessionHandler backend.
*
- * @param string $id The session identifier.
- * @param string $session_data The session data.
- * @return boolean True on success, false otherwise.
+ * @param string $id The session identifier.
+ * @param string $session_data The session data.
+ * @return boolean True on success, false otherwise.
*/
public function write($id, $session_data)
{
@@ -137,9 +137,9 @@
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
- * @param string $id The session identifier.
+ * @param string $id The session identifier.
*
- * @return boolean True on success, false otherwise.
+ * @return boolean True on success, false otherwise.
*/
public function destroy($id)
{
@@ -149,8 +149,8 @@
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
- * @param integer $maxlifetime The maximum age of a session.
- * @return boolean True on success, false otherwise.
+ * @param integer $maxlifetime The maximum age of a session.
+ * @return boolean True on success, false otherwise.
*/
public function gc($maxlifetime = null)
{
Modified: development/branches/platform/libraries/joomla/updater/adapters/collection.php
===================================================================
--- development/branches/platform/libraries/joomla/updater/adapters/collection.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/updater/adapters/collection.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -13,7 +13,7 @@
/**
* Collection Update Adapter Class
- * @since 11.1
+ * @since 11.1
*/
class JUpdaterCollection extends JUpdateAdapter {
/**
@@ -44,8 +44,8 @@
/**
* Gets the reference to the current direct parent
*
- * @return object
- * @since 11.1
+ * @return object
+ * @since 11.1
*/
protected function _getStackLocation()
{
@@ -55,7 +55,7 @@
/**
* Get the parent tag
- * @return string parent
+ * @return string parent
*/
protected function _getParent()
{
@@ -64,10 +64,10 @@
/**
* Opening an XML element
- * @param object parser object
- * @param string name of element that is opened
- * @param array array of attributes for the element
- *
+ * @param object parser object
+ * @param string name of element that is opened
+ * @param array array of attributes for the element
+ *
*/
public function _startElement($parser, $name, $attrs = Array())
{
@@ -134,8 +134,8 @@
/**
* Closing an XML element
* Note: This is a protected function though has to be exposed externally as a callback
- * @param object parser object
- * @param string name of the element closing
+ * @param object parser object
+ * @param string name of the element closing
*/
protected function _endElement($parser, $name)
{
@@ -157,9 +157,9 @@
/*
* Find an update
- * @param array options to use; update_site_id: the unique ID of the update site to look at
- *
- * @return array update_sites and updates discovered
+ * @param array options to use; update_site_id: the unique ID of the update site to look at
+ *
+ * @return array update_sites and updates discovered
*/
public function findUpdate($options)
{
Modified: development/branches/platform/libraries/joomla/updater/update.php
===================================================================
--- development/branches/platform/libraries/joomla/updater/update.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/updater/update.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -41,8 +41,8 @@
/**
* Gets the reference to the current direct parent
*
- * @return object
- * @since 11.1
+ * @return object
+ * @since 11.1
*/
protected function _getStackLocation()
{
@@ -52,7 +52,7 @@
/**
* Get the last position in stack count
*
- * @return string
+ * @return string
*/
protected function _getLastTag()
{
Modified: development/branches/platform/libraries/joomla/updater/updateadapter.php
===================================================================
--- development/branches/platform/libraries/joomla/updater/updateadapter.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/updater/updateadapter.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,8 +28,8 @@
/**
* Gets the reference to the current direct parent
*
- * @return object
- * @since 11.1
+ * @return object
+ * @since 11.1
*/
protected function _getStackLocation()
{
@@ -39,8 +39,8 @@
/**
* Gets the reference to the last tag
*
- * @return object
- * @since 11.1
+ * @return object
+ * @since 11.1
*/
protected function _getLastTag() {
return $this->_stack[count($this->_stack) - 1];
Modified: development/branches/platform/libraries/joomla/updater/updater.php
===================================================================
--- development/branches/platform/libraries/joomla/updater/updater.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/updater/updater.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -19,7 +19,7 @@
* Updater Class
* @package Joomla.Platform
* @subpackage Update
- * @since 11.1
+ * @since 11.1
*/
class JUpdater extends JAdapter {
@@ -35,8 +35,7 @@
* Returns a reference to the global Installer object, only creating it
* if it doesn't already exist.
*
- * @return object An installer object
- *
+ * @return object An installer object
*/
public static function &getInstance()
{
Modified: development/branches/platform/libraries/joomla/user/authentication.php
===================================================================
--- development/branches/platform/libraries/joomla/user/authentication.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/user/authentication.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -52,7 +52,7 @@
* Returns the global authentication object, only creating it
* if it doesn't already exist.
*
- * @return object The global JAuthentication object
+ * @return object The global JAuthentication object
* @since 11.1
*/
public static function getInstance()
@@ -74,8 +74,8 @@
* Finds out if a set of login credentials are valid by asking all obvserving
* objects to run their respective authentication routines.
*
- * @param array Array holding the user credentials
- * @return mixed Integer userid for valid user if credentials are valid or
+ * @param array Array holding the user credentials
+ * @return mixed Integer userid for valid user if credentials are valid or
* boolean false if they are not
* @since 11.1
*/
@@ -192,7 +192,7 @@
* UTF-8 string free text representation of the End User's full name.
*
* @var fullname string
- *
+ *
*/
public $fullname = '';
@@ -248,7 +248,7 @@
/**
* Constructor
*
- * @param string $name The type of the response
+ * @param string $name The type of the response
* @since 11.1
*/
function __construct() { }
Modified: development/branches/platform/libraries/joomla/user/helper.php
===================================================================
--- development/branches/platform/libraries/joomla/user/helper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/user/helper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -25,11 +25,11 @@
/**
* Method to add a user to a group.
*
- * @param integer $userId The id of the user.
- * @param integer $groupId The id of the group.
- *
- * @return mixed Boolean true on success, JException on error.
- * @since 11.1
+ * @param integer $userId The id of the user.
+ * @param integer $groupId The id of the group.
+ *
+ * @return mixed Boolean true on success, JException on error.
+ * @since 11.1
*/
public static function addUserToGroup($userId, $groupId)
{
@@ -83,9 +83,9 @@
/**
* Method to get a list of groups a user is in.
*
- * @param integer $userId The id of the user.
- * @return mixed Array on success, JException on error.
- * @since 11.1
+ * @param integer $userId The id of the user.
+ * @return mixed Array on success, JException on error.
+ * @since 11.1
*/
public static function getUserGroups($userId)
{
@@ -98,10 +98,10 @@
/**
* Method to remove a user from a group.
*
- * @param integer $userId The id of the user.
- * @param integer $groupId The id of the group.
- * @return mixed Boolean true on success, JException on error.
- * @since 11.1
+ * @param integer $userId The id of the user.
+ * @param integer $groupId The id of the group.
+ * @return mixed Boolean true on success, JException on error.
+ * @since 11.1
*/
public static function removeUserFromGroup($userId, $groupId)
{
@@ -136,11 +136,11 @@
/**
* Method to set the groups for a user.
*
- * @param integer $userId The id of the user.
- * @param array $groups An array of group ids to put the user in.
- *
- * @return mixed Boolean true on success, JException on error.
- * @since 11.1
+ * @param integer $userId The id of the user.
+ * @param array $groups An array of group ids to put the user in.
+ *
+ * @return mixed Boolean true on success, JException on error.
+ * @since 11.1
*/
public static function setUserGroups($userId, $groups)
{
@@ -216,10 +216,10 @@
/**
* Method to activate a user
*
- * @param string $activation Activation string
- *
- * @return boolean True on success
- * @since 11.1
+ * @param string $activation Activation string
+ *
+ * @return boolean True on success
+ * @since 11.1
*/
public static function activateUser($activation)
{
@@ -263,9 +263,9 @@
/**
* Returns userid if a user exists
*
- * @param string The username to search on
- *
- * @return integer The user id or 0 if not found
+ * @param string The username to search on
+ *
+ * @return integer The user id or 0 if not found
*/
public static function getUserId($username)
{
@@ -280,17 +280,17 @@
/**
* Formats a password using the current encryption.
*
- * @param string $plaintext The plaintext password to encrypt.
- * @param string $salt The salt to use to encrypt the password. []
+ * @param string $plaintext The plaintext password to encrypt.
+ * @param string $salt The salt to use to encrypt the password. []
* If not present, a new salt will be
* generated.
- * @param string $encryption The kind of pasword encryption to use.
+ * @param string $encryption The kind of pasword encryption to use.
* Defaults to md5-hex.
- * @param boolean $show_encrypt Some password systems prepend the kind of
+ * @param boolean $show_encrypt Some password systems prepend the kind of
* encryption to the crypted password ({SHA},
* etc). Defaults to false.
*
- * @return string The encrypted password.
+ * @return string The encrypted password.
*/
public static function getCryptedPassword($plaintext, $salt = '', $encryption = 'md5-hex', $show_encrypt = false)
{
@@ -376,15 +376,15 @@
* of an existing password, or for encryption types that use the plaintext
* in the generation of the salt.
*
- * @param string $encryption The kind of pasword encryption to use.
+ * @param string $encryption The kind of pasword encryption to use.
* Defaults to md5-hex.
- * @param string $seed The seed to get the salt from (probably a
+ * @param string $seed The seed to get the salt from (probably a
* previously generated password). Defaults to
* generating a new seed.
- * @param string $plaintext The plaintext password that we're generating
+ * @param string $plaintext The plaintext password that we're generating
* a salt for. Defaults to none.
*
- * @return string The generated or extracted salt.
+ * @return string The generated or extracted salt.
*/
public static function getSalt($encryption = 'md5-hex', $seed = '', $plaintext = '')
{
@@ -462,9 +462,9 @@
/**
* Generate a random password
*
- * @param integer $length Length of the password to generate
- * @return string Random Password
- * @since 11.1
+ * @param integer $length Length of the password to generate
+ * @return string Random Password
+ * @since 11.1
*/
public static function genRandomPassword($length = 8)
{
@@ -487,10 +487,10 @@
/**
* Converts to allowed 64 characters for APRMD5 passwords.
*
- * @param string $value
- * @param integer $count
- *
- * @return string $value converted to the 64 MD5 characters.
+ * @param string $value
+ * @param integer $count
+ *
+ * @return string $value converted to the 64 MD5 characters.
* @since 11.1
*/
protected static function _toAPRMD5($value, $count)
@@ -510,9 +510,9 @@
/**
* Converts hexadecimal string to binary data.
*
- * @param string $hex Hex data.
- *
- * @return string Binary data.
+ * @param string $hex Hex data.
+ *
+ * @return string Binary data.
* @since 11.1
*/
private static function _bin($hex)
Modified: development/branches/platform/libraries/joomla/user/user.php
===================================================================
--- development/branches/platform/libraries/joomla/user/user.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/user/user.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -108,7 +108,7 @@
/**
* Associative array of user names => group ids
*
- * @since 11.1
+ * @since 11.1
* @var array
*/
public $groups = array();
@@ -152,10 +152,10 @@
/**
* Constructor activating the default information of the language
*
- * @param integer $identifier The primary key of the user to load (optional).
+ * @param integer $identifier The primary key of the user to load (optional).
*
- * @return object JUser
- * @since 11.1
+ * @return object JUser
+ * @since 11.1
*/
public function __construct($identifier = 0)
{
@@ -179,10 +179,10 @@
* Returns the global User object, only creating it if it
* doesn't already exist.
*
- * @param integer $identifier The user to load - Can be an integer or string - If string, it is converted to ID automatically.
+ * @param integer $identifier The user to load - Can be an integer or string - If string, it is converted to ID automatically.
*
- * @return object JUser The User object.
- * @since 11.1
+ * @return object JUser The User object.
+ * @since 11.1
*/
public static function getInstance($identifier = 0)
{
@@ -216,11 +216,11 @@
/**
* Method to get a parameter value
*
- * @param string $key Parameter key
- * @param mixed $default Parameter default value
+ * @param string $key Parameter key
+ * @param mixed $default Parameter default value
*
- * @return mixed The value or the default if it did not exist
- * @since 11.1
+ * @return mixed The value or the default if it did not exist
+ * @since 11.1
*/
public function getParam($key, $default = null)
{
@@ -230,11 +230,11 @@
/**
* Method to set a parameter
*
- * @param string $key Parameter key
- * @param mixed $value Parameter value
+ * @param string $key Parameter key
+ * @param mixed $value Parameter value
*
- * @return mixed Set parameter value
- * @since 11.1
+ * @return mixed Set parameter value
+ * @since 11.1
*/
public function setParam($key, $value)
{
@@ -244,11 +244,11 @@
/**
* Method to set a default parameter if it does not exist
*
- * @param string $key Parameter key
- * @param mixed $value Parameter value
+ * @param string $key Parameter key
+ * @param mixed $value Parameter value
*
- * @return mixed Set parameter value
- * @since 11.1
+ * @return mixed Set parameter value
+ * @since 11.1
*/
public function defParam($key, $value)
{
@@ -267,11 +267,11 @@
* Method to check JUser object authorisation against an access control
* object and optionally an access extension object
*
- * @param string $action The name of the action to check for permission.
- * @param string $assetname The name of the asset on which to perform the action.
+ * @param string $action The name of the action to check for permission.
+ * @param string $assetname The name of the asset on which to perform the action.
*
- * @return boolean True if authorised
- * @since 11.1
+ * @return boolean True if authorised
+ * @since 11.1
*/
public function authorise($action, $assetname = null)
{
@@ -316,11 +316,11 @@
/**
* Method to return a list of all categories that a user has permission for a given action
*
- * @param string $component The component from which to retrieve the categories
- * @param string $action The name of the section within the component from which to retrieve the actions.
+ * @param string $component The component from which to retrieve the categories
+ * @param string $action The name of the section within the component from which to retrieve the actions.
*
- * @return array List of categories that this group can do this action to (empty array if none). Categories must be published.
- * @since 11.1
+ * @return array List of categories that this group can do this action to (empty array if none). Categories must be published.
+ * @since 11.1
*/
public function getAuthorisedCategories($component, $action) {
// Brute force method: get all published category rows for the component and check each one
@@ -346,8 +346,8 @@
/**
* Gets an array of the authorised access levels for the user
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public function getAuthorisedViewLevels()
{
@@ -364,8 +364,8 @@
/**
* Gets an array of the authorised user groups
*
- * @return array
- * @since 11.1
+ * @return array
+ * @since 11.1
*/
public function getAuthorisedGroups()
{
@@ -382,10 +382,10 @@
/**
* Pass through method to the table for setting the last visit date
*
- * @param integer $timestamp The timestamp, defaults to 'now'.
+ * @param integer $timestamp The timestamp, defaults to 'now'.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
*/
public function setLastVisit($timestamp = null)
{
@@ -403,11 +403,11 @@
* file is the same as the usertype. The functionals has a static variable to store the parameters
* setup file base path. You can call this function statically to set the base path if needed.
*
- * @param boolean $loadsetupfile If true, loads the parameters setup file. Default is false.
- * @param path $path Set the parameters setup file base path to be used to load the user parameters.
+ * @param boolean $loadsetupfile If true, loads the parameters setup file. Default is false.
+ * @param path $path Set the parameters setup file base path to be used to load the user parameters.
*
- * @return object The user parameters object.
- * @since 11.1
+ * @return object The user parameters object.
+ * @since 11.1
*/
public function getParameters($loadsetupfile = false, $path = null)
{
@@ -440,10 +440,10 @@
/**
* Method to get the user parameters
*
- * @param object $params The user parameters object
+ * @param object $params The user parameters object
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*/
public function setParameters($params)
{
@@ -457,11 +457,11 @@
* it instantiates. You can call this function statically to set the table name if
* needed.
*
- * @param string $type The user table name to be used
- * @param string $prefix The user table prefix to be used
+ * @param string $type The user table name to be used
+ * @param string $prefix The user table prefix to be used
*
- * @return object The user table object
- * @since 11.1
+ * @return object The user table object
+ * @since 11.1
*/
public static function getTable($type = null, $prefix = 'JTable')
{
@@ -486,10 +486,10 @@
/**
* Method to bind an associative array of data to a user object
*
- * @param array $array The associative array to bind to the object
+ * @param array $array The associative array to bind to the object
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function bind(& $array)
{
@@ -586,10 +586,10 @@
/**
* Method to save the JUser object to the database
*
- * @param boolean $updateOnly Save the object only if not a new user
+ * @param boolean $updateOnly Save the object only if not a new user
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function save($updateOnly = false)
{
@@ -706,8 +706,8 @@
/**
* Method to delete the JUser object from the database
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function delete()
{
@@ -734,10 +734,10 @@
/**
* Method to load a JUser object by user id number
*
- * @param mixed $id The user id of the user to load
+ * @param mixed $id The user id of the user to load
*
- * @return boolean True on success
- * @since 11.1
+ * @return boolean True on success
+ * @since 11.1
*/
public function load($id)
{
@@ -749,7 +749,7 @@
JError::raiseWarning('SOME_ERROR_CODE', JText::sprintf('JLIB_USER_ERROR_UNABLE_TO_LOAD_USER', $id));
return false;
}
-
+
// Set the user parameters using the default XML file. We might want to
// extend this in the future to allow for the ability to have custom
// user parameters, but for right now we'll leave it how it is.
Modified: development/branches/platform/libraries/joomla/utilities/arrayhelper.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/arrayhelper.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/arrayhelper.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -22,9 +22,9 @@
/**
* Function to convert array to integer values
*
- * @param array $array The source array to convert
- * @param mixed $default A default value (int|array) to assign if $array is not an array
- * @since 11.1
+ * @param array $array The source array to convert
+ * @param mixed $default A default value (int|array) to assign if $array is not an array
+ * @since 11.1
*/
public static function toInteger(&$array, $default = null)
{
@@ -47,11 +47,11 @@
/**
* Utility function to map an array to a stdClass object.
*
- * @param array $array The array to map.
- * @param string $class Name of the class to create
- *
- * @return object The object mapped from the given array
- * @since 11.1
+ * @param array $array The array to map.
+ * @param string $class Name of the class to create
+ *
+ * @return object The object mapped from the given array
+ * @since 11.1
*/
public static function toObject(&$array, $class = 'stdClass')
{
@@ -93,12 +93,12 @@
/**
* Utility function to map an object to an array
*
- * @param object The source object
- * @param boolean True to recurve through multi-level objects
- * @param string An optional regular expression to match on field names
- *
- * @return array The array mapped from the given object
- * @since 11.1
+ * @param object The source object
+ * @param boolean True to recurve through multi-level objects
+ * @param string An optional regular expression to match on field names
+ *
+ * @return array The array mapped from the given object
+ * @since 11.1
*/
public static function fromObject($p_obj, $recurse = true, $regex = null)
{
@@ -113,12 +113,12 @@
/**
* Utility function to map an object|array to an array
*
- * @param array|object The source object|array
- * @param boolean True to recurve through multi-level objects
- * @param string An optional regular expression to match on field names
- *
- * @return array The array mapped from the given object
- * @since 11.1
+ * @param array|object The source object|array
+ * @param boolean True to recurve through multi-level objects
+ * @param string An optional regular expression to match on field names
+ *
+ * @return array The array mapped from the given object
+ * @since 11.1
*/
protected static function _fromObject($item, $recurse, $regex)
{
@@ -161,11 +161,11 @@
/**
* Extracts a column from an array of arrays or objects
*
- * @param array $array The source array
- * @param string $index The index of the column or name of object property
- *
- * @return array Column of values from the source array
- * @since 11.1
+ * @param array $array The source array
+ * @param string $index The index of the column or name of object property
+ *
+ * @return array Column of values from the source array
+ * @since 11.1
*/
public static function getColumn(&$array, $index)
{
@@ -191,13 +191,13 @@
/**
* Utility function to return a value from a named array or a specified default
*
- * @param array $array A named array
- * @param string $name The key to search for
- * @param mixed $default The default value to give if no key found
- * @param string $type Return type for the variable (INT, FLOAT, STRING, WORD, BOOLEAN, ARRAY)
- *
- * @return mixed The value from the source array
- * @since 11.1
+ * @param array $array A named array
+ * @param string $name The key to search for
+ * @param mixed $default The default value to give if no key found
+ * @param string $type Return type for the variable (INT, FLOAT, STRING, WORD, BOOLEAN, ARRAY)
+ *
+ * @return mixed The value from the source array
+ * @since 11.1
*/
public static function getValue(&$array, $name, $default=null, $type='')
{
@@ -259,10 +259,10 @@
/**
* Method to determine if an array is an associative array.
*
- * @param array An array to test.
- *
- * @return boolean True if the array is an associative array.
- * @since 11.1
+ * @param array An array to test.
+ *
+ * @return boolean True if the array is an associative array.
+ * @since 11.1
*/
public static function isAssociative($array)
{
@@ -280,14 +280,14 @@
/**
* Utility function to sort an array of objects on a given field
*
- * @param array $arr An array of objects
- * @param string|array $k The key or a array of key to sort on
+ * @param array $arr An array of objects
+ * @param string|array $k The key or a array of key to sort on
* @param integer array $direction Direction or an array of direction to sort in [1 = Ascending] [-1 = Descending]
- * @param bool|array $casesensitive Let sort occur case sensitive or insensitive
- * @param bool|array $locale Let sort occur using the locale language or not
+ * @param bool|array $casesensitive Let sort occur case sensitive or insensitive
+ * @param bool|array $locale Let sort occur using the locale language or not
*
- * @return array The sorted array of objects
- * @since 11.1
+ * @return array The sorted array of objects
+ * @since 11.1
*/
public static function sortObjects(&$a, $k, $direction=1, $casesensitive = true, $locale = false)
{
@@ -310,11 +310,11 @@
/**
* Callback function for sorting an array of objects on a key
*
- * @param array $a An array of objects
- * @param array $b An array of objects
- *
- * @return integer Comparison status
- * @since 11.1
+ * @param array $a An array of objects
+ * @param array $b An array of objects
+ *
+ * @return integer Comparison status
+ * @since 11.1
* @see JArrayHelper::sortObjects()
*/
protected static function _sortObjects(&$a, &$b)
Modified: development/branches/platform/libraries/joomla/utilities/date.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/date.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/date.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -28,7 +28,7 @@
* The format string to be applied when using the __toString() magic method.
*
* @var string
- * @since 11.1
+ * @since 11.1
*/
public static $format = 'Y-m-d H:i:s';
@@ -36,7 +36,7 @@
* Placeholder for a DateTimeZone object with GMT as the time zone.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected static $gmt;
@@ -45,7 +45,7 @@
* time zone as the time zone.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected static $stz;
@@ -56,7 +56,7 @@
* @deprecated Deprecated since 1.6
*
* @var array
- * @since 11.1
+ * @since 11.1
*/
protected static $offsets = array(
'-12' => 'Etc/GMT-12',
@@ -105,18 +105,18 @@
* The DateTimeZone object for usage in rending dates as strings.
*
* @var object
- * @since 11.1
+ * @since 11.1
*/
protected $_tz;
/**
* Constructor.
*
- * @param string $date String in a format accepted by strtotime(), defaults to "now".
- * @param mixed $tz Time zone to be used for the date.
+ * @param string $date String in a format accepted by strtotime(), defaults to "now".
+ * @param mixed $tz Time zone to be used for the date.
*
- * @return void
- * @since 11.1
+ * @return void
+ * @since 11.1
*
* @throws JException
*/
@@ -155,10 +155,10 @@
/**
* Magic method to access properties of the date given by class to the format method.
*
- * @param string $name The name of the property.
+ * @param string $name The name of the property.
*
- * @return mixed A value if the property name is valid, null otherwise.
- * @since 11.1
+ * @return mixed A value if the property name is valid, null otherwise.
+ * @since 11.1
*/
public function __get($name)
{
@@ -234,8 +234,8 @@
* Magic method to render the date object in the format specified in the public
* static member JDate::$format.
*
- * @return string The date as a formatted string.
- * @since 11.1
+ * @return string The date as a formatted string.
+ * @since 11.1
*/
public function __toString()
{
@@ -245,11 +245,11 @@
/**
* Translates day of week number to a string.
*
- * @param integer $day The numeric day of the week.
- * @param boolean $abbr Return the abreviated day string?
+ * @param integer $day The numeric day of the week.
+ * @param boolean $abbr Return the abreviated day string?
*
- * @return string The day of the week.
- * @since 11.1
+ * @return string The day of the week.
+ * @since 11.1
*/
protected function dayToString($day, $abbr = false)
{
@@ -267,11 +267,11 @@
/**
* Gets the date as a formatted string in a local calendar.
*
- * @param string $format The date format specification string (see {@link PHP_MANUAL#date})
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param string $format The date format specification string (see {@link PHP_MANUAL#date})
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date string in the specified format format.
- * @since 11.1
+ * @return string The date string in the specified format format.
+ * @since 11.1
*/
public function calendar($format, $local = false)
{
@@ -281,11 +281,11 @@
/**
* Gets the date as a formatted string.
*
- * @param string $format The date format specification string (see {@link PHP_MANUAL#date})
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param string $format The date format specification string (see {@link PHP_MANUAL#date})
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date string in the specified format format.
- * @since 11.1
+ * @return string The date string in the specified format format.
+ * @since 11.1
*/
public function format($format, $local = false)
{
@@ -327,10 +327,10 @@
/**
* Get the time offset from GMT in hours or seconds.
*
- * @param boolean $hours True to return the value in hours.
+ * @param boolean $hours True to return the value in hours.
*
- * @return float The time offset from GMT either in hours in seconds.
- * @since 11.1
+ * @return float The time offset from GMT either in hours in seconds.
+ * @since 11.1
*/
public function getOffsetFromGMT($hours = false)
{
@@ -340,11 +340,11 @@
/**
* Translates month number to a string.
*
- * @param integer $month The numeric month of the year.
- * @param boolean $abbr Return the abreviated month string?
+ * @param integer $month The numeric month of the year.
+ * @param boolean $abbr Return the abreviated month string?
*
- * @return string The month of the year.
- * @since 11.1
+ * @return string The month of the year.
+ * @since 11.1
*/
protected function monthToString($month, $abbr = false)
{
@@ -367,10 +367,10 @@
/**
* Set the date offset (in hours).
*
- * @param float $offset The offset in hours.
+ * @param float $offset The offset in hours.
*
- * @return boolean True on success.
- * @since 11.1
+ * @return boolean True on success.
+ * @since 11.1
* @deprecated Deprecated since 1.6
*/
public function setOffset($offset)
@@ -389,10 +389,10 @@
* Method to wrap the setTimezone() function and set the internal
* time zone object.
*
- * @param object $tz The new DateTimeZone object.
+ * @param object $tz The new DateTimeZone object.
*
- * @return DateTimeZone The old DateTimeZone object.
- * @since 11.1
+ * @return DateTimeZone The old DateTimeZone object.
+ * @since 11.1
*/
public function setTimezone(DateTimeZone $tz)
{
@@ -406,11 +406,11 @@
* Returns a string formatted according to the given format. Month and weekday names and
* other language dependent strings respect the current locale
*
- * @param string $format The date format specification string (see {@link PHP_MANUAL#strftime})
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param string $format The date format specification string (see {@link PHP_MANUAL#strftime})
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date as a formatted string.
- * @since 11.1
+ * @return string The date as a formatted string.
+ * @since 11.1
* @deprecated Deprecated since 1.6, use JDate::format() instead.
*/
public function toFormat($format = '%Y-%m-%d %H:%M:%S', $local = false)
@@ -450,10 +450,10 @@
* Gets the date as an ISO 8601 string. IETF RFC 3339 defines the ISO 8601 format
* and it can be found at the IETF Web site.
*
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date string in ISO 8601 format.
- * @since 11.1
+ * @return string The date string in ISO 8601 format.
+ * @since 11.1
* @link http://www.ietf.org/rfc/rfc3339.txt
*/
public function toISO8601($local = false)
@@ -465,10 +465,10 @@
/**
* Gets the date as an MySQL datetime string.
*
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date string in MySQL datetime format.
- * @since 11.1
+ * @return string The date string in MySQL datetime format.
+ * @since 11.1
* @link http://dev.mysql.com/doc/refman/5.0/en/datetime.html
*/
public function toMySQL($local = false)
@@ -481,10 +481,10 @@
* Gets the date as an RFC 822 string. IETF RFC 2822 supercedes RFC 822 and its definition
* can be found at the IETF Web site.
*
- * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
+ * @param boolean $local True to return the date string in the local time zone, false to return it in GMT.
*
- * @return string The date string in RFC 822 format.
- * @since 11.1
+ * @return string The date string in RFC 822 format.
+ * @since 11.1
* @link http://www.ietf.org/rfc/rfc2822.txt
*/
public function toRFC822($local = false)
@@ -495,8 +495,8 @@
/**
* Gets the date as UNIX time stamp.
*
- * @return integer The date as a UNIX timestamp.
- * @since 11.1
+ * @return integer The date as a UNIX timestamp.
+ * @since 11.1
*/
public function toUnix()
{
Modified: development/branches/platform/libraries/joomla/utilities/simplecrypt.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/simplecrypt.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/simplecrypt.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -29,10 +29,10 @@
* Object Constructor takes an optional key to be used for encryption/decryption. If no key is given then the
* secret word from the configuration object is used.
*
- * @param string $key Optional encryption key
- *
- * @return void
- * @since 11.1
+ * @param string $key Optional encryption key
+ *
+ * @return void
+ * @since 11.1
*/
public function __construct($key = null)
{
@@ -45,11 +45,11 @@
}
/**
* Decrypt
- *
- * @param string $s
- *
- * @return string
- * @since 11.1
+ *
+ * @param string $s
+ *
+ * @return string
+ * @since 11.1
*/
public function decrypt($s)
{
@@ -59,11 +59,11 @@
}
/**
* Encrypt
- *
- * @param string $s
- *
- * @return string
- * @since 11.1
+ *
+ * @param string $s
+ *
+ * @return string
+ * @since 11.1
*/
public function encrypt($s)
{
@@ -75,12 +75,12 @@
}
/**
* HextoInt
- *
- * @param string $s
- * @param integer $i
- *
- * @return integer
- * @since 11.1
+ *
+ * @param string $s
+ * @param integer $i
+ *
+ * @return integer
+ * @since 11.1
*/
protected function _hexToInt($s, $i)
{
@@ -150,11 +150,11 @@
}
/**
* HexToIntArray
- *
- * @param string $s
- *
- * @return array
- * @since 11.1
+ *
+ * @param string $s
+ *
+ * @return array
+ * @since 11.1
*/
protected function _hexToIntArray($s)
{
@@ -170,11 +170,11 @@
}
/**
* CharToInt
- *
- * @param string $c
- *
- * @return integer ger
- * @since 11.1
+ *
+ * @param string $c
+ *
+ * @return integer ger
+ * @since 11.1
*/
protected function _charToInt($c)
{
@@ -183,11 +183,11 @@
}
/**
* XorString
- *
- * @param string $ai
- *
- * @return string
- * @since 11.1
+ *
+ * @param string $ai
+ *
+ * @return string
+ * @since 11.1
*/
protected function _xorString($ai)
{
@@ -208,11 +208,11 @@
}
/**
* inToHex
- *
- * @param integer $i
- *
- * @return string
- * @since 11.1
+ *
+ * @param integer $i
+ *
+ * @return string
+ * @since 11.1
*/
protected function _intToHex($i)
{
@@ -229,11 +229,11 @@
}
/**
* Decrypt
- *
- * @param string $s
- *
- * @return
- * @since 11.1
+ *
+ * @param string $s
+ *
+ * @return
+ * @since 11.1
*/
protected function _xorCharString($s)
{
Modified: development/branches/platform/libraries/joomla/utilities/simplexml.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/simplexml.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/simplexml.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -139,10 +139,10 @@
* JSimpleXMLElement with properties containing the data held within the XML document.
* If any errors occur, it returns FALSE.
*
- * @param string Well-formed XML string data
- * @param string currently ignored
- *
- * @return object JSimpleXMLElement
+ * @param string Well-formed XML string data
+ * @param string currently ignored
+ *
+ * @return object JSimpleXMLElement
*/
function loadString($string, $classname = null) {
$this->_parse($string);
@@ -156,9 +156,9 @@
* to an object of class JSimpleXMLElement. If any errors occur during file access or
* interpretation, the function returns FALSE.
*
- * @param string Path to XML file containing a well-formed XML document
- * @param string currently ignored
- * @return boolean True if successful, false if file empty
+ * @param string Path to XML file containing a well-formed XML document
+ * @param string currently ignored
+ * @return boolean True if successful, false if file empty
*/
function loadFile($path, $classname = null)
{
@@ -187,9 +187,9 @@
* This new object can then be used as a native JSimpleXML element. If any errors occur,
* it returns FALSE.
*
- * @param string DOM document
- * @param string currently ignored
- * @return object JSimpleXMLElement
+ * @param string DOM document
+ * @param string currently ignored
+ * @return object JSimpleXMLElement
*/
function importDOM($node, $classname = null) {
return false;
@@ -238,9 +238,9 @@
/**
* Handles an XML parsing error
*
- * @param integer $code XML Error Code
- * @param integer $line Line on which the error happened
- * @param integer $col Column on which the error happened
+ * @param integer $code XML Error Code
+ * @param integer $line Line on which the error happened
+ * @param integer $col Column on which the error happened
*/
protected function _handleError($code, $line, $col)
{
@@ -250,8 +250,8 @@
/**
* Gets the reference to the current direct parent
*
- * @return object
- * @since 11.1
+ * @return object
+ * @since 11.1
*/
protected function _getStackLocation()
{
@@ -267,8 +267,8 @@
* Handler function for the start of a tag
*
* @param resource $parser
- * @param string $name
- * @param array $attrs
+ * @param string $name
+ * @param array $attrs
*/
protected function _startElement($parser, $name, $attrs = array())
{
@@ -301,7 +301,7 @@
* Handler function for the end of a tag
*
* @param resource $parser
- * @param string $name
+ * @param string $name
*/
protected function _endElement($parser, $name)
{
@@ -313,7 +313,7 @@
* Handler function for the character data within a tag
*
* @param resource $parser
- * @param string $data
+ * @param string $data
*/
protected function _characterData($parser, $data)
{
@@ -384,10 +384,10 @@
/**
* Constructor, sets up all the default values
*
- * @param string $name
- * @param array $attrs
- * @param integer $parents
- *
+ * @param string $name
+ * @param array $attrs
+ * @param integer $parents
+ *
* @return JSimpleXMLElement
*/
function __construct($name, $attrs = array(), $level = 0)
@@ -405,7 +405,7 @@
/**
* Get the name of the element
*
- * @return string
+ * @return string
*/
public function name() {
return $this->_name;
@@ -414,9 +414,9 @@
/**
* Get the an attribute of the element
*
- * @param string $attribute The name of the attribute
+ * @param string $attribute The name of the attribute
*
- * @return mixed If an attribute is given will return the attribute if it exist.
+ * @return mixed If an attribute is given will return the attribute if it exist.
* If no attribute is given will return the complete attributes array
*/
public function attributes($attribute = null)
@@ -431,7 +431,7 @@
/**
* Get the data of the element
*
- * @return string
+ * @return string
*/
public function data() {
return $this->_data;
@@ -440,8 +440,8 @@
/**
* Set the data of the element
*
- * @param string $data
- * @return string
+ * @param string $data
+ * @return string
*/
public function setData($data) {
$this->_data = $data;
@@ -450,7 +450,7 @@
/**
* Get the children of the element
*
- * @return array
+ * @return array
*/
public function children() {
return $this->_children;
@@ -468,8 +468,8 @@
/**
* Adds an attribute to the element
*
- * @param string $name
- * @param array $attrs
+ * @param string $name
+ * @param array $attrs
*/
function addAttribute($name, $value)
{
@@ -480,7 +480,7 @@
/**
* Removes an attribute from the element
*
- * @param string $name
+ * @param string $name
*/
function removeAttribute($name)
{
@@ -490,10 +490,10 @@
/**
* Adds a direct child to the element
*
- * @param string $name
- * @param array $attrs
- * @param integer $level
- *
+ * @param string $name
+ * @param array $attrs
+ * @param integer $level
+ *
* @return JSimpleXMLElement The added child object
*/
function addChild($name, $attrs = array(), $level = null)
@@ -546,8 +546,8 @@
/**
* Get an element in the document by / separated path
*
- * @param string $path The / separated path to the element
- * @return object JSimpleXMLElement
+ * @param string $path The / separated path to the element
+ * @return object JSimpleXMLElement
*/
function getElementByPath($path)
{
@@ -582,8 +582,8 @@
* Traverses the tree calling the $callback(JSimpleXMLElement
* $this, mixed $args=array()) function with each JSimpleXMLElement.
*
- * @param string $callback function name
- * @param array $args
+ * @param string $callback function name
+ * @param array $args
*/
function map($callback, $args=array())
{
@@ -600,8 +600,8 @@
/**
* Return a well-formed XML string based on SimpleXML element
*
- * @return string
- */
+ * @return string
+ */
function toString($whitespace=true)
{
// Start a new line, indent by the number indicated in $this->level, add a <, and add the name of the tag
Modified: development/branches/platform/libraries/joomla/utilities/string.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/string.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/string.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -72,7 +72,7 @@
*
* @param $str - string String being examined
* @param $search - string String being searced for
- * @return mixed Number of characters before the last match or FALSE on failure
+ * @return mixed Number of characters before the last match or FALSE on failure
* @see http://www.php.net/strrpos
*/
public static function strrpos($str, $search, $offset = false)
@@ -151,10 +151,10 @@
* UTF-8 aware alternative to str_ireplace
* Case-insensitive version of str_replace
*
- * @param string string to search
- * @param string existing string to replace
- * @param string new string to replace with
- * @param integer optional count value to be passed by referene
+ * @param string string to search
+ * @param string existing string to replace
+ * @param string new string to replace with
+ * @param integer optional count value to be passed by referene
* @see http://www.php.net/str_ireplace
*/
public static function str_ireplace($search, $replace, $str, $count = NULL)
@@ -282,12 +282,12 @@
* UTF-8 aware alternative to strcspn
* Find length of initial segment not matching mask
*
- * @param string
- * @param string the mask
- * @param integer Optional starting character position (in characters)
- * @param integer Optional length
+ * @param string
+ * @param string the mask
+ * @param integer Optional starting character position (in characters)
+ * @param integer Optional length
*
- * @return integer the length of the initial segment of str1 which does not contain any of the characters in str2
+ * @return integer the length of the initial segment of str1 which does not contain any of the characters in str2
* @see http://www.php.net/strcspn
*/
public static function strcspn($str, $mask, $start = NULL, $length = NULL)
@@ -324,8 +324,8 @@
* UTF-8 aware alternative to strrev
* Reverse a string
*
- * @param string String to be reversed
- * @return string The string in reverse character order
+ * @param string String to be reversed
+ * @return string The string in reverse character order
* @see http://www.php.net/strrev
*/
public static function strrev($str)
@@ -466,8 +466,8 @@
* UTF-8 aware alternative to ucfirst
* Make a string's first character uppercase
*
- * @param string
- * @return string with first character as upper case (if applicable)
+ * @param string
+ * @return string with first character as upper case (if applicable)
* @see http://www.php.net/ucfirst
*/
public static function ucfirst($str)
@@ -480,8 +480,8 @@
* UTF-8 aware alternative to ucwords
* Uppercase the first character of each word in a string
*
- * @param string
- * @return string with first char of each word uppercase
+ * @param string
+ * @return string with first char of each word uppercase
* @see http://www.php.net/ucwords
*/
public static function ucwords($str)
Modified: development/branches/platform/libraries/joomla/utilities/utility.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/utility.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/utility.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -21,20 +21,20 @@
/**
* Mail function (uses phpMailer)
*
- * @param string $from From email address
- * @param string $fromname From name
- * @param mixed $recipient Recipient email address(es)
- * @param string $subject Email subject
- * @param string $body Message body
- * @param boolean $mode false = plain text, true = HTML
- * @param mixed $cc CC email address(es)
- * @param mixed $bcc BCC email address(es)
- * @param mixed $attachment Attachment file name(s)
- * @param mixed $replyto Reply to email address(es)
- * @param mixed $replytoname Reply to name(s)
- *
- * @return boolean True on success
+ * @param string $from From email address
+ * @param string $fromname From name
+ * @param mixed $recipient Recipient email address(es)
+ * @param string $subject Email subject
+ * @param string $body Message body
+ * @param boolean $mode false = plain text, true = HTML
+ * @param mixed $cc CC email address(es)
+ * @param mixed $bcc BCC email address(es)
+ * @param mixed $attachment Attachment file name(s)
+ * @param mixed $replyto Reply to email address(es)
+ * @param mixed $replytoname Reply to name(s)
*
+ * @return boolean True on success
+ *
* @since 11.1
* @deprecated 1.6
* @see JMail::sendMail()
@@ -53,14 +53,14 @@
/**
* Sends mail to administrator for approval of a user submission
*
- * @param string $adminName Name of administrator
- * @param string $adminEmail Email address of administrator
- * @param string $email [NOT USED TODO: Deprecate?]
- * @param string $type Type of item to approve
- * @param string $title Title of item to approve
- * @param string $author Author of item to approve
+ * @param string $adminName Name of administrator
+ * @param string $adminEmail Email address of administrator
+ * @param string $email [NOT USED TODO: Deprecate?]
+ * @param string $type Type of item to approve
+ * @param string $title Title of item to approve
+ * @param string $author Author of item to approve
*
- * @return boolean True on success
+ * @return boolean True on success
*
* @deprecated 1.6
* @see JMail::sendAdminMail()
@@ -78,9 +78,9 @@
/**
* Provides a secure hash based on a seed
*
- * @param string $seed Seed string.
+ * @param string $seed Seed string.
*
- * @return string
+ * @return string
*
* @deprecated 1.6
* @see JApplication:getHash()
@@ -95,7 +95,7 @@
/**
* Method to determine a hash for anti-spoofing variable names
*
- * @return string Hashed var name
+ * @return string Hashed var name
*
* @since 11.1
* @deprecated 1.6
@@ -111,9 +111,9 @@
/**
* Method to extract key/value pairs out of a string with XML style attributes
*
- * @param string $string String containing XML style attributes
+ * @param string $string String containing XML style attributes
*
- * @return array Key/Value pairs for the attributes
+ * @return array Key/Value pairs for the attributes
*
* @since 11.1
*/
@@ -140,7 +140,7 @@
/**
* Method to determine if the host OS is Windows
*
- * @return boolean True if Windows OS.
+ * @return boolean True if Windows OS.
*
* @since 11.1
* @deprecated 1.6
@@ -156,10 +156,10 @@
/**
* Method to dump the structure of a variable for debugging purposes
*
- * @param mixed $var A variable
- * @param boolean $htmlSafe True to ensure all characters are htmlsafe
+ * @param mixed $var A variable
+ * @param boolean $htmlSafe True to ensure all characters are htmlsafe
*
- * @return string
+ * @return string
*
* @since 11.1
* @deprecated 1.6
@@ -175,10 +175,10 @@
* Prepend a reference to an element to the beginning of an array.
* Renumbers numeric keys, so $value is always inserted to $array[0]
*
- * @param $array array
- * @param $value mixed
+ * @param $array array
+ * @param $value mixed
*
- * @return integer
+ * @return integer
*
* @since 11.1
* @deprecated 1.6
@@ -195,9 +195,9 @@
/**
* Return the byte value of a particular string
*
- * @param string $val String optionally with G, M or K suffix
+ * @param string $val String optionally with G, M or K suffix
*
- * @return integer size in bytes
+ * @return integer size in bytes
*
* @since 11.1
* @deprecated 1.6
Modified: development/branches/platform/libraries/joomla/utilities/xmlelement.php
===================================================================
--- development/branches/platform/libraries/joomla/utilities/xmlelement.php 2011-05-09 23:52:30 UTC (rev 21304)
+++ development/branches/platform/libraries/joomla/utilities/xmlelement.php 2011-05-10 00:53:59 UTC (rev 21305)
@@ -23,7 +23,7 @@
*
* Warning: don't use getName() as it's broken up to php 5.2.3
*
- * @return string
+ * @return string
*/
public function name()
{
@@ -38,7 +38,7 @@
/**
* Legacy method to get the element data.
*
- * @return string
+ * @return string
* @deprecated 1.6 - Feb 5, 2010
*/
public function data()
@@ -49,9 +49,9 @@
/**
* Legacy method gets an elements attribute by name.
*
- * @param string
- *
- * @return string
+ * @param string
+ *
+ * @return string
* @deprecated 1.6 - Feb 5, 2010
*/
public function getAttribute($name)
@@ -62,10 +62,10 @@
/**
* Return a well-formed XML string based on SimpleXML element
*
- * @param boolean Should we use indentation and newlines ?
- * @param integer Indentaion level.
- *
- * @return string
+ * @param boolean Should we use indentation and newlines ?
+ * @param integer Indentaion level.
+ *
+ * @return string
*/
public function asFormattedXML($compressed = false, $indent = "\t", $level = 0)
{
_______________________________________________
Joomla-commits mailing list
Joomla-...@joomlacode.org
http://joomlacode.org/mailman/listinfo/joomla-commits