@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | } |
| 85 | 85 | |
| 86 | 86 | /** |
| 87 | - * @return TSqlMapper The SqlMap used by this MappedStatement |
|
| 87 | + * @return TSqlMapManager The SqlMap used by this MappedStatement |
|
| 88 | 88 | */ |
| 89 | 89 | public function getManager() |
| 90 | 90 | { |
@@ -469,6 +469,7 @@ discard block |
||
| 469 | 469 | * @param IDbConnection database connection |
| 470 | 470 | * @param mixed insert statement parameter |
| 471 | 471 | * @param TSqlMapSelectKey select key statement |
| 472 | + * @param TSqlMapSelectKey $selectKey |
|
| 472 | 473 | * @return string last insert ID. |
| 473 | 474 | */ |
| 474 | 475 | protected function executeSelectKey($connection, $parameter, $selectKey) |
@@ -569,6 +570,7 @@ discard block |
||
| 569 | 570 | * @param string result object class name |
| 570 | 571 | * @param array a result set row retrieved from the database |
| 571 | 572 | * @param object the result object, will create if necessary. |
| 573 | + * @param string $resultClass |
|
| 572 | 574 | * @return object result object filled with data |
| 573 | 575 | */ |
| 574 | 576 | protected function fillResultClass($resultClass, $row, $resultObject) |
@@ -591,6 +593,7 @@ discard block |
||
| 591 | 593 | * Apply the result to a TList or an array. |
| 592 | 594 | * @param array a result set row retrieved from the database |
| 593 | 595 | * @param object result object, array or list |
| 596 | + * @param ArrayAccess $resultObject |
|
| 594 | 597 | * @return object result filled with data. |
| 595 | 598 | */ |
| 596 | 599 | protected function fillResultArrayList($row, $resultObject) |
@@ -633,6 +636,7 @@ discard block |
||
| 633 | 636 | * @param string result map name. |
| 634 | 637 | * @param array a result set row retrieved from the database |
| 635 | 638 | * @param object result object to fill, will create new instances if required. |
| 639 | + * @param string $parentGroup |
|
| 636 | 640 | * @return object result object filled with data. |
| 637 | 641 | */ |
| 638 | 642 | protected function fillResultMap($resultMapName, $row, $parentGroup=null, &$resultObject=null) |
@@ -772,6 +776,7 @@ discard block |
||
| 772 | 776 | * Converts the first array value to scalar value of given type. |
| 773 | 777 | * @param array list of results |
| 774 | 778 | * @param string scalar type. |
| 779 | + * @param string $type |
|
| 775 | 780 | * @return mixed scalar value. |
| 776 | 781 | */ |
| 777 | 782 | protected function getScalarResult($result, $type) |
@@ -961,6 +966,10 @@ discard block |
||
| 961 | 966 | public function setKeys($value){ $this->_keys = $value; } |
| 962 | 967 | |
| 963 | 968 | public function getMethod(){ return $this->_method; } |
| 969 | + |
|
| 970 | + /** |
|
| 971 | + * @param integer $value |
|
| 972 | + */ |
|
| 964 | 973 | public function setMethod($value){ $this->_method = $value; } |
| 965 | 974 | } |
| 966 | 975 | |
@@ -1003,6 +1012,7 @@ discard block |
||
| 1003 | 1012 | * @param string parent node id |
| 1004 | 1013 | * @param string new node id |
| 1005 | 1014 | * @param mixed node value |
| 1015 | + * @param string $node |
|
| 1006 | 1016 | */ |
| 1007 | 1017 | public function add($parent, $node, $object='') |
| 1008 | 1018 | { |
@@ -1168,6 +1178,9 @@ discard block |
||
| 1168 | 1178 | private $_parameterObject; |
| 1169 | 1179 | private $_list; |
| 1170 | 1180 | |
| 1181 | + /** |
|
| 1182 | + * @param ArrayAccess $list |
|
| 1183 | + */ |
|
| 1171 | 1184 | public function __construct($result, $parameter, &$list) |
| 1172 | 1185 | { |
| 1173 | 1186 | $this->_resultObject = $result; |
@@ -21,6 +21,9 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class TPreparedCommand |
| 23 | 23 | { |
| 24 | + /** |
|
| 25 | + * @param TSqlMapStatement $statement |
|
| 26 | + */ |
|
| 24 | 27 | public function create(TSqlMapManager $manager, $connection, $statement, $parameterObject,$skip=null,$max=null) |
| 25 | 28 | { |
| 26 | 29 | $sqlText = $statement->getSQLText(); |
@@ -43,6 +46,9 @@ discard block |
||
| 43 | 46 | return $command; |
| 44 | 47 | } |
| 45 | 48 | |
| 49 | + /** |
|
| 50 | + * @param TSqlMapManager $manager |
|
| 51 | + */ |
|
| 46 | 52 | protected function applyParameterMap($manager,$command,$prepared, $statement, $parameterObject) |
| 47 | 53 | { |
| 48 | 54 | $properties = $prepared->getParameterNames(false); |
@@ -77,6 +77,7 @@ |
||
| 77 | 77 | |
| 78 | 78 | /** |
| 79 | 79 | * Saves the current SqlMap manager to cache. |
| 80 | + * @param TSqlMapManager $manager |
|
| 80 | 81 | * @return boolean true if SqlMap manager was cached, false otherwise. |
| 81 | 82 | */ |
| 82 | 83 | protected function cacheSqlMapManager($manager) |
@@ -32,6 +32,9 @@ discard block |
||
| 32 | 32 | */ |
| 33 | 33 | private $_manager; |
| 34 | 34 | |
| 35 | + /** |
|
| 36 | + * @param TSqlMapManager|null $manager |
|
| 37 | + */ |
|
| 35 | 38 | public function __construct($manager) |
| 36 | 39 | { |
| 37 | 40 | $this->_manager=$manager; |
@@ -63,6 +66,8 @@ discard block |
||
| 63 | 66 | * @param string The name of the sql statement to execute. |
| 64 | 67 | * @param mixed The object used to set the parameters in the SQL. |
| 65 | 68 | * @param mixed An object of the type to be returned. |
| 69 | + * @param string $statementName |
|
| 70 | + * @param Account $result |
|
| 66 | 71 | * @return object A single result object populated with the result set data. |
| 67 | 72 | */ |
| 68 | 73 | public function queryForObject($statementName, $parameter=null, $result=null) |
@@ -84,6 +89,8 @@ discard block |
||
| 84 | 89 | * pass in null if want to return a list instead. |
| 85 | 90 | * @param int The number of rows to skip over. |
| 86 | 91 | * @param int The maximum number of rows to return. |
| 92 | + * @param string $statementName |
|
| 93 | + * @param AccountCollection $result |
|
| 87 | 94 | * @return TList A List of result objects. |
| 88 | 95 | */ |
| 89 | 96 | public function queryForList($statementName, $parameter=null, $result=null, $skip=-1, $max=-1) |
@@ -105,6 +112,7 @@ discard block |
||
| 105 | 112 | * pass in null if want to return a list instead. |
| 106 | 113 | * @param int The number of rows to skip over. |
| 107 | 114 | * @param int The maximum number of rows to return. |
| 115 | + * @param string $statementName |
|
| 108 | 116 | * @return TList A List of result objects. |
| 109 | 117 | */ |
| 110 | 118 | public function queryWithRowDelegate($statementName, $delegate, $parameter=null, $result=null, $skip=-1, $max=-1) |
@@ -121,6 +129,7 @@ discard block |
||
| 121 | 129 | * @param mixed The object used to set the parameters in the SQL. |
| 122 | 130 | * @param integer The maximum number of objects to store in each page. |
| 123 | 131 | * @param integer The number of the page to initially load into the list. |
| 132 | + * @param string $statementName |
|
| 124 | 133 | * @return TPagedList A PaginatedList of beans containing the rows. |
| 125 | 134 | */ |
| 126 | 135 | public function queryForPagedList($statementName, $parameter=null, $pageSize=10, $page=0) |
@@ -161,6 +170,9 @@ discard block |
||
| 161 | 170 | * @param mixed The object used to set the parameters in the SQL. |
| 162 | 171 | * @param string The property of the result object to be used as the key. |
| 163 | 172 | * @param string The property of the result object to be used as the value. |
| 173 | + * @param string $statementName |
|
| 174 | + * @param string $keyProperty |
|
| 175 | + * @param string $valueProperty |
|
| 164 | 176 | * @return TMap Array object containing the rows keyed by keyProperty. |
| 165 | 177 | */ |
| 166 | 178 | public function queryForMap($statementName, $parameter=null, $keyProperty=null, $valueProperty=null, $skip=-1, $max=-1) |
@@ -180,6 +192,8 @@ discard block |
||
| 180 | 192 | * @param mixed The object used to set the parameters in the SQL. |
| 181 | 193 | * @param string The property of the result object to be used as the key. |
| 182 | 194 | * @param string The property of the result object to be used as the value. |
| 195 | + * @param string $statementName |
|
| 196 | + * @param string $keyProperty |
|
| 183 | 197 | * @return TMap Array object containing the rows keyed by keyProperty. |
| 184 | 198 | */ |
| 185 | 199 | public function queryForMapWithRowDelegate($statementName, $delegate, $parameter=null, $keyProperty=null, $valueProperty=null, $skip=-1, $max=-1) |
@@ -200,6 +214,7 @@ discard block |
||
| 200 | 214 | * |
| 201 | 215 | * @param string The name of the statement to execute. |
| 202 | 216 | * @param string The parameter object. |
| 217 | + * @param string $statementName |
|
| 203 | 218 | * @return mixed The primary key of the newly inserted row. |
| 204 | 219 | * This might be automatically generated by the RDBMS, |
| 205 | 220 | * or selected from a sequence table or other source. |
@@ -233,6 +248,7 @@ discard block |
||
| 233 | 248 | * Executes a Sql DELETE statement. Delete returns the number of rows effected. |
| 234 | 249 | * @param string The name of the statement to execute. |
| 235 | 250 | * @param mixed The parameter object. |
| 251 | + * @param string $statementName |
|
| 236 | 252 | * @return integer The number of rows effected. |
| 237 | 253 | */ |
| 238 | 254 | public function delete($statementName, $parameter=null) |
@@ -55,6 +55,7 @@ discard block |
||
| 55 | 55 | * Constructor, create a new SqlMap manager. |
| 56 | 56 | * @param TDbConnection database connection |
| 57 | 57 | * @param string configuration file. |
| 58 | + * @param TDbConnection $connection |
|
| 58 | 59 | */ |
| 59 | 60 | public function __construct($connection=null) |
| 60 | 61 | { |
@@ -68,6 +69,7 @@ discard block |
||
| 68 | 69 | |
| 69 | 70 | /** |
| 70 | 71 | * @param TDbConnection default database connection |
| 72 | + * @param TComponent $conn |
|
| 71 | 73 | */ |
| 72 | 74 | public function setDbConnection($conn) |
| 73 | 75 | { |
@@ -105,6 +107,7 @@ discard block |
||
| 105 | 107 | /** |
| 106 | 108 | * Loads and parses the SqlMap configuration file. |
| 107 | 109 | * @param string xml configuration file. |
| 110 | + * @param string $file |
|
| 108 | 111 | */ |
| 109 | 112 | public function configureXml($file) |
| 110 | 113 | { |
@@ -180,6 +183,7 @@ discard block |
||
| 180 | 183 | /** |
| 181 | 184 | * Gets a named result map |
| 182 | 185 | * @param string result name. |
| 186 | + * @param string $name |
|
| 183 | 187 | * @return TResultMap the result map. |
| 184 | 188 | * @throws TSqlMapUndefinedException |
| 185 | 189 | */ |
@@ -212,6 +216,7 @@ discard block |
||
| 212 | 216 | |
| 213 | 217 | /** |
| 214 | 218 | * @param string parameter map ID name. |
| 219 | + * @param string $name |
|
| 215 | 220 | * @return TParameterMap the parameter with given ID. |
| 216 | 221 | * @throws TSqlMapUndefinedException |
| 217 | 222 | */ |
@@ -149,6 +149,7 @@ |
||
| 149 | 149 | /** |
| 150 | 150 | * Finds the database connection instance from the Application modules. |
| 151 | 151 | * @param string Database connection module ID. |
| 152 | + * @param string $id |
|
| 152 | 153 | * @return TDbConnection database connection. |
| 153 | 154 | * @throws TConfigurationException when module is not of TDbConnection or TDataSourceConfig. |
| 154 | 155 | */ |
@@ -136,6 +136,7 @@ |
||
| 136 | 136 | * @param mixed Name of the PHP variable to bind to the SQL statement parameter |
| 137 | 137 | * @param int SQL data type of the parameter |
| 138 | 138 | * @param int length of the data type |
| 139 | + * @param string $name |
|
| 139 | 140 | * @see http://www.php.net/manual/en/function.PDOStatement-bindParam.php |
| 140 | 141 | */ |
| 141 | 142 | public function bindParameter($name, &$value, $dataType=null, $length=null) |
@@ -157,6 +157,7 @@ discard block |
||
| 157 | 157 | /** |
| 158 | 158 | * Open or close the DB connection. |
| 159 | 159 | * @param boolean whether to open or close DB connection |
| 160 | + * @param boolean $value |
|
| 160 | 161 | * @throws TDbException if connection fails |
| 161 | 162 | */ |
| 162 | 163 | public function setActive($value) |
@@ -241,6 +242,7 @@ discard block |
||
| 241 | 242 | |
| 242 | 243 | /** |
| 243 | 244 | * @param string The Data Source Name, or DSN, contains the information required to connect to the database. |
| 245 | + * @param string $value |
|
| 244 | 246 | * @see http://www.php.net/manual/en/function.PDO-construct.php |
| 245 | 247 | */ |
| 246 | 248 | public function setConnectionString($value) |
@@ -258,6 +260,7 @@ discard block |
||
| 258 | 260 | |
| 259 | 261 | /** |
| 260 | 262 | * @param string the username for establishing DB connection |
| 263 | + * @param string $value |
|
| 261 | 264 | */ |
| 262 | 265 | public function setUsername($value) |
| 263 | 266 | { |
@@ -274,6 +277,7 @@ discard block |
||
| 274 | 277 | |
| 275 | 278 | /** |
| 276 | 279 | * @param string the password for establishing DB connection |
| 280 | + * @param string $value |
|
| 277 | 281 | */ |
| 278 | 282 | public function setPassword($value) |
| 279 | 283 | { |
@@ -58,6 +58,7 @@ discard block |
||
| 58 | 58 | * should match the case of the column, as returned by the driver. |
| 59 | 59 | * @param mixed Name of the PHP variable to which the column will be bound. |
| 60 | 60 | * @param int Data type of the parameter |
| 61 | + * @param integer $column |
|
| 61 | 62 | * @see http://www.php.net/manual/en/function.PDOStatement-bindColumn.php |
| 62 | 63 | */ |
| 63 | 64 | public function bindColumn($column, &$value, $dataType=null) |
@@ -89,6 +90,7 @@ discard block |
||
| 89 | 90 | /** |
| 90 | 91 | * Returns a single column from the next row of a result set. |
| 91 | 92 | * @param int zero-based column index |
| 93 | + * @param integer $columnIndex |
|
| 92 | 94 | * @return mixed|false the column of the current row, false if no more row available |
| 93 | 95 | */ |
| 94 | 96 | public function readColumn($columnIndex) |
@@ -100,6 +102,8 @@ discard block |
||
| 100 | 102 | * Returns a single column from the next row of a result set. |
| 101 | 103 | * @param string class name of the object to be created and populated |
| 102 | 104 | * @param array list of column names whose values are to be passed as parameters in the constructor of the class being created |
| 105 | + * @param string $className |
|
| 106 | + * @param string[] $fields |
|
| 103 | 107 | * @return mixed|false the populated object, false if no more row of data available |
| 104 | 108 | */ |
| 105 | 109 | public function readObject($className,$fields) |