Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Doc block style fixes in the table package.

  • Loading branch information...
commit 537886a73563b852b735e32320c1d7074960aa01 1 parent d3432ab
@elinw elinw authored
View
2  libraries/joomla/table/asset.php
@@ -96,7 +96,7 @@ public function loadByName($name)
*
* @return boolean True if the instance is sane and able to be stored in the database.
*
- * @link http://docs.joomla.org/JTable/check
+ * @link http://docs.joomla.org/JTable/check
* @since 11.1
*/
public function check()
View
2  libraries/joomla/table/category.php
@@ -154,7 +154,7 @@ public function check()
*
* @param array $array named array
* @param string $ignore An optional array or space separated list of properties
- * to ignore while binding.
+ * to ignore while binding.
*
* @return mixed Null if operation was satisfactory, otherwise returns an error
*
View
2  libraries/joomla/table/extension.php
@@ -112,7 +112,7 @@ public function find($options = array())
* to checkin rows that it can after adjustments are made.
*
* @param mixed $pks An optional array of primary key values to update. If not
- * set the instance property value is used.
+ * set the instance property value is used.
* @param integer $state The publishing state. eg. [0 = unpublished, 1 = published]
* @param integer $userId The user id of the user performing the operation.
*
View
2  libraries/joomla/table/nested.php
@@ -1456,7 +1456,7 @@ protected function _getNode($id, $key = null)
* the node as well as the new left and right ids for the node.
*
* @param object $referenceNode A node object with at least a 'lft' and 'rgt' with
- * which to make room in the tree around for a new node.
+ * which to make room in the tree around for a new node.
* @param integer $nodeWidth The width of the node for which to make room in the tree.
* @param string $position The position relative to the reference node where the room
* should be made.
View
25 libraries/joomla/table/table.php
@@ -164,7 +164,7 @@ public function getFields()
*
* @return mixed A JTable object if found or boolean false if one could not be found.
*
- * @link http://docs.joomla.org/JTable/getInstance
+ * @link http://docs.joomla.org/JTable/getInstance
* @since 11.1
*/
public static function getInstance($type, $prefix = 'JTable', $config = array())
@@ -468,7 +468,7 @@ public function bind($src, $ignore = array())
* to the JTable instance properties.
*
* @param mixed $keys 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.
+ * set the instance property value is used.
* @param boolean $reset True to reset the default values before loading the new row.
*
* @return boolean True if successful. False if row not found.
@@ -563,7 +563,7 @@ public function check()
*
* @return boolean True on success.
*
- * @link http://docs.joomla.org/JTable/store
+ * @link http://docs.joomla.org/JTable/store
* @since 11.1
*/
public function store($updateNulls = false)
@@ -670,7 +670,7 @@ public function store($updateNulls = false)
* @param mixed $src An associative array or object to bind to the JTable instance.
* @param string $orderingFilter Filter for the order updating
* @param mixed $ignore An optional array or space separated list of properties
- * to ignore while binding.
+ * to ignore while binding.
*
* @return boolean True on success.
*
@@ -723,7 +723,7 @@ public function save($src, $orderingFilter = '', $ignore = '')
*
* @return boolean True on success.
*
- * @link http://docs.joomla.org/JTable/delete
+ * @link http://docs.joomla.org/JTable/delete
* @since 11.1
* @throws UnexpectedValueException
*/
@@ -785,7 +785,7 @@ public function delete($pk = null)
*
* @param integer $userId The Id of the user checking out the row.
* @param mixed $pk An optional primary key value to check out. If not set
- * the instance property value is used.
+ * the instance property value is used.
*
* @return boolean True on success.
*
@@ -924,9 +924,9 @@ public function hit($pk = null)
* not checked out -- as the user can still edit it.
*
* @param integer $with The userid to preform the match with, if an item is checked
- * out by this user the function will return false.
+ * out by this user the function will return false.
* @param integer $against The userid to perform the match against when the function
- * is used as a static function.
+ * is used as a static function.
*
* @return boolean True if checked out.
*
@@ -997,7 +997,7 @@ public function getNextOrder($where = '')
*
* @param string $where WHERE clause to use for limiting the selection of rows to compact the ordering values.
*
- * @return mixed Boolean true on success.
+ * @return mixed Boolean True on success.
*
* @link http://docs.joomla.org/JTable/reorder
* @since 11.1
@@ -1058,9 +1058,9 @@ public function reorder($where = '')
*
* @param integer $delta The direction and magnitude to move the row in the ordering sequence.
* @param string $where WHERE clause to use for limiting the selection of rows to compact the
- * ordering values.
+ * ordering values.
*
- * @return mixed Boolean true on success.
+ * @return mixed Boolean True on success.
*
* @link http://docs.joomla.org/JTable/move
* @since 11.1
@@ -1153,7 +1153,8 @@ public function move($delta, $where = '')
* 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 $pks An optional array of primary key values to update. If not set the instance property value is used.
+ * @param mixed $pks An optional array of primary key values to update.
+ * If not set the instance property value is used.
* @param integer $state The publishing state. eg. [0 = unpublished, 1 = published]
* @param integer $userId The user id of the user performing the operation.
*
View
2  libraries/joomla/table/update.php
@@ -55,7 +55,7 @@ public function check()
*
* @param array $array Named array
* @param mixed $ignore An optional array or space separated list of properties
- * to ignore while binding.
+ * to ignore while binding.
*
* @return mixed Null if operation was satisfactory, otherwise returns an error
*
View
2  libraries/joomla/table/user.php
@@ -48,7 +48,7 @@ public function __construct($db)
*
* @param integer $userId An optional user id.
* @param boolean $reset False if row not found or on error
- * (internal error state set in that case).
+ * (internal error state set in that case).
*
* @return boolean True on success, false on failure.
*
Please sign in to comment.
Something went wrong with that request. Please try again.