Commit 338bd78e authored by jackbravo's avatar jackbravo

Added a description to the Doctrine_Record::cleanData() method

parent 9f20184f
...@@ -424,10 +424,11 @@ abstract class Doctrine_Record extends Doctrine_Record_Abstract implements Count ...@@ -424,10 +424,11 @@ abstract class Doctrine_Record extends Doctrine_Record_Abstract implements Count
/** /**
* cleanData * cleanData
* leaves the $data array only with values whose key is a field inside this
* record and returns the values that where removed from $data.
* *
* @param array $data data array to be cleaned * @param array $data data array to be cleaned
* @return integer * @return array $tmp values cleaned from data
* @todo Better description. What exactly does this "cleaning" involve?
*/ */
public function cleanData(&$data) public function cleanData(&$data)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment