@@ -35,6 +35,9 @@ discard block |
||
35 | 35 | private $_relation; //data from an entry of TActiveRecord::$RELATION |
36 | 36 | private $_fkeys; |
37 | 37 | |
38 | + /** |
|
39 | + * @param TActiveRecord $record |
|
40 | + */ |
|
38 | 41 | public function __construct($record, $property=null, $relation=null) |
39 | 42 | { |
40 | 43 | $this->_record=$record; |
@@ -168,6 +171,7 @@ discard block |
||
168 | 171 | * An instance of TActiveRecordHasOne, TActiveRecordBelongsTo, TActiveRecordHasMany, |
169 | 172 | * or TActiveRecordHasManyAssocation will be returned. |
170 | 173 | * @param TActiveRecordCriteria search criteria |
174 | + * @param \Prado\Data\DataGateway\TSqlCriteria $criteria |
|
171 | 175 | * @return TActiveRecordRelation record relationship handler instnace. |
172 | 176 | * @throws TActiveRecordException if property is not defined or missing. |
173 | 177 | */ |
@@ -196,7 +200,7 @@ discard block |
||
196 | 200 | } |
197 | 201 | |
198 | 202 | /** |
199 | - * @return TActiveRecordRelationCommand |
|
203 | + * @return boolean |
|
200 | 204 | */ |
201 | 205 | public function updateAssociatedRecords($updateBelongsTo=false) |
202 | 206 | { |
@@ -52,6 +52,10 @@ discard block |
||
52 | 52 | } |
53 | 53 | } |
54 | 54 | |
55 | + /** |
|
56 | + * @param \Prado\Data\ActiveRecord\Scaffold\TScaffoldEditView $parent |
|
57 | + * @param \Prado\Data\ActiveRecord\TActiveRecord $record |
|
58 | + */ |
|
55 | 59 | public function createScaffoldInput($parent, $item, $column, $record) |
56 | 60 | { |
57 | 61 | $this->_parent=$parent; |
@@ -68,6 +72,10 @@ discard block |
||
68 | 72 | $label->setForControl(self::DEFAULT_ID); |
69 | 73 | } |
70 | 74 | |
75 | + /** |
|
76 | + * @param \Prado\Data\ActiveRecord\Scaffold\TScaffoldEditView $parent |
|
77 | + * @param \Prado\Data\ActiveRecord\TActiveRecord $record |
|
78 | + */ |
|
71 | 79 | public function loadScaffoldInput($parent, $item, $column, $record) |
72 | 80 | { |
73 | 81 | $this->_parent=$parent; |
@@ -28,6 +28,7 @@ |
||
28 | 28 | /** |
29 | 29 | * This method should update the record with the user input data. |
30 | 30 | * @param TActiveRecord record to be saved. |
31 | + * @param \Prado\Data\ActiveRecord\TActiveRecord $record |
|
31 | 32 | */ |
32 | 33 | public function updateRecord($record); |
33 | 34 | } |
34 | 35 | \ No newline at end of file |
@@ -91,6 +91,7 @@ discard block |
||
91 | 91 | /** |
92 | 92 | * Name of the Active Record class to be viewed or scaffolded. |
93 | 93 | * @param string Active Record class name. |
94 | + * @param string $value |
|
94 | 95 | */ |
95 | 96 | public function setRecordClass($value) |
96 | 97 | { |
@@ -190,6 +191,7 @@ discard block |
||
190 | 191 | |
191 | 192 | /** |
192 | 193 | * @param boolean enable default stylesheet, default is true. |
194 | + * @param boolean $value |
|
193 | 195 | */ |
194 | 196 | public function setEnableDefaultStyle($value) |
195 | 197 | { |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | } |
104 | 104 | |
105 | 105 | /** |
106 | - * @return TActiveRecord current Active Record instance |
|
106 | + * @return \Prado\Data\ActiveRecord\TActiveRecord current Active Record instance |
|
107 | 107 | */ |
108 | 108 | protected function getCurrentRecord() |
109 | 109 | { |
@@ -136,6 +136,8 @@ discard block |
||
136 | 136 | * Instantiate the external edit renderer. |
137 | 137 | * @param TActiveRecord record to be edited |
138 | 138 | * @param string external edit renderer class name. |
139 | + * @param \Prado\Data\ActiveRecord\TActiveRecord $record |
|
140 | + * @param string $classPath |
|
139 | 141 | * @throws TConfigurationException raised when renderer is not an |
140 | 142 | * instance of IScaffoldEditRenderer. |
141 | 143 | */ |
@@ -267,6 +269,7 @@ discard block |
||
267 | 269 | /** |
268 | 270 | * Create the default scaffold editor control factory. |
269 | 271 | * @param TActiveRecord record instance. |
272 | + * @param \Prado\Data\ActiveRecord\TActiveRecord $record |
|
270 | 273 | * @return TScaffoldInputBase scaffold editor control factory. |
271 | 274 | */ |
272 | 275 | protected function getScaffoldInputBuilder($record) |
@@ -113,6 +113,7 @@ |
||
113 | 113 | |
114 | 114 | /** |
115 | 115 | * @param string button caption |
116 | + * @param string $value |
|
116 | 117 | */ |
117 | 118 | public function setButtonText($value) |
118 | 119 | { |
@@ -324,7 +324,7 @@ discard block |
||
324 | 324 | /** |
325 | 325 | * Gets the current Db connection, the connection object is obtained from |
326 | 326 | * the TActiveRecordManager if connection is currently null. |
327 | - * @return TDbConnection current db connection for this object. |
|
327 | + * @return \Prado\Data\TDbConnection current db connection for this object. |
|
328 | 328 | */ |
329 | 329 | public function getDbConnection() |
330 | 330 | { |
@@ -511,6 +511,7 @@ discard block |
||
511 | 511 | * Delete multiple records using a criteria. |
512 | 512 | * @param string|TActiveRecordCriteria SQL condition or criteria object. |
513 | 513 | * @param mixed parameter values. |
514 | + * @param TSqlCriteria $criteria |
|
514 | 515 | * @return int number of records deleted. |
515 | 516 | */ |
516 | 517 | public function deleteAll($criteria=null, $parameters=array()) |
@@ -577,6 +578,7 @@ discard block |
||
577 | 578 | * |
578 | 579 | * @param string|TActiveRecordCriteria SQL condition or criteria object. |
579 | 580 | * @param mixed parameter values. |
581 | + * @param TSqlCriteria $criteria |
|
580 | 582 | * @return TActiveRecord matching record object. Null if no result is found. |
581 | 583 | */ |
582 | 584 | public function find($criteria,$parameters=array()) |
@@ -593,6 +595,7 @@ discard block |
||
593 | 595 | * |
594 | 596 | * @param string|TActiveRecordCriteria SQL condition or criteria object. |
595 | 597 | * @param mixed parameter values. |
598 | + * @param TSqlCriteria $criteria |
|
596 | 599 | * @return array matching record objects. Empty array if no result is found. |
597 | 600 | */ |
598 | 601 | public function findAll($criteria=null,$parameters=array()) |
@@ -706,6 +709,7 @@ discard block |
||
706 | 709 | * Find the number of records. |
707 | 710 | * @param string|TActiveRecordCriteria SQL condition or criteria object. |
708 | 711 | * @param mixed parameter values. |
712 | + * @param TActiveRecordCriteria $criteria |
|
709 | 713 | * @return int number of records. |
710 | 714 | */ |
711 | 715 | public function count($criteria=null,$parameters=array()) |
@@ -721,6 +725,7 @@ discard block |
||
721 | 725 | * value equal to the $property value. |
722 | 726 | * @param string relationship/property name corresponding to keys in $RELATION array. |
723 | 727 | * @param array method call arguments. |
728 | + * @param string $name |
|
724 | 729 | * @return TActiveRecordRelation, null if the context or the handler doesn't exist |
725 | 730 | */ |
726 | 731 | protected function getRelationHandler($name,$args=array()) |
@@ -945,6 +950,7 @@ discard block |
||
945 | 950 | * Raised before the record attempt to insert its data into the database. |
946 | 951 | * To prevent the insert operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false. |
947 | 952 | * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers |
953 | + * @param TActiveRecordChangeEventParameter $param |
|
948 | 954 | */ |
949 | 955 | public function onInsert($param) |
950 | 956 | { |
@@ -955,6 +961,7 @@ discard block |
||
955 | 961 | * Raised before the record attempt to delete its data from the database. |
956 | 962 | * To prevent the delete operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false. |
957 | 963 | * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers |
964 | + * @param TActiveRecordChangeEventParameter $param |
|
958 | 965 | */ |
959 | 966 | public function onDelete($param) |
960 | 967 | { |
@@ -965,6 +972,7 @@ discard block |
||
965 | 972 | * Raised before the record attempt to update its data in the database. |
966 | 973 | * To prevent the update operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false. |
967 | 974 | * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers |
975 | + * @param TActiveRecordChangeEventParameter $param |
|
968 | 976 | */ |
969 | 977 | public function onUpdate($param) |
970 | 978 | { |
@@ -1048,7 +1056,7 @@ discard block |
||
1048 | 1056 | |
1049 | 1057 | /** |
1050 | 1058 | * Return record data as JSON |
1051 | - * @return JSON |
|
1059 | + * @return string |
|
1052 | 1060 | * @since 3.2.4 |
1053 | 1061 | */ |
1054 | 1062 | public function toJSON(){ |
@@ -236,6 +236,7 @@ discard block |
||
236 | 236 | * Return record data from sql query. |
237 | 237 | * @param TActiveRecord active record finder instance. |
238 | 238 | * @param TActiveRecordCriteria sql query |
239 | + * @param TSqlCriteria $criteria |
|
239 | 240 | * @return array result. |
240 | 241 | */ |
241 | 242 | public function findRecordBySql(TActiveRecord $record, $criteria) |
@@ -247,6 +248,7 @@ discard block |
||
247 | 248 | * Return record data from sql query. |
248 | 249 | * @param TActiveRecord active record finder instance. |
249 | 250 | * @param TActiveRecordCriteria sql query |
251 | + * @param TSqlCriteria $criteria |
|
250 | 252 | * @return TDbDataReader result iterator. |
251 | 253 | */ |
252 | 254 | public function findRecordsBySql(TActiveRecord $record, $criteria) |
@@ -288,6 +290,7 @@ discard block |
||
288 | 290 | /** |
289 | 291 | * Sets the last insert ID to the corresponding property of the record if available. |
290 | 292 | * @param TActiveRecord record for insertion |
293 | + * @param TActiveRecord $record |
|
291 | 294 | */ |
292 | 295 | protected function updatePostInsert($record) |
293 | 296 | { |
@@ -405,6 +408,7 @@ discard block |
||
405 | 408 | * Delete multiple records by criteria. |
406 | 409 | * @param TActiveRecord active record finder instance. |
407 | 410 | * @param TActiveRecordCriteria search criteria |
411 | + * @param TSqlCriteria $criteria |
|
408 | 412 | * @return int number of records. |
409 | 413 | */ |
410 | 414 | public function deleteRecordsByCriteria(TActiveRecord $record, $criteria) |
@@ -76,6 +76,7 @@ discard block |
||
76 | 76 | |
77 | 77 | /** |
78 | 78 | * @param TDbConnection default database connection |
79 | + * @param \Prado\Data\TDbConnection $conn |
|
79 | 80 | */ |
80 | 81 | public function setDbConnection($conn) |
81 | 82 | { |
@@ -91,6 +92,7 @@ discard block |
||
91 | 92 | } |
92 | 93 | |
93 | 94 | /** |
95 | + * @param \Prado\TComponent $self |
|
94 | 96 | * @return TActiveRecordManager static instance of record manager. |
95 | 97 | */ |
96 | 98 | public static function getInstance($self=null) |
@@ -153,6 +155,7 @@ discard block |
||
153 | 155 | /** |
154 | 156 | * Define the way an active record finder react if an invalid magic-finder invoked |
155 | 157 | * @param TActiveRecordInvalidFinderResult |
158 | + * @param TActiveRecordInvalidFinderResult $value |
|
156 | 159 | * @since 3.1.5 |
157 | 160 | * @see getInvalidFinderResult |
158 | 161 | */ |