@@ -55,6 +55,7 @@ discard block |
||
55 | 55 | |
56 | 56 | /** |
57 | 57 | * @param string a unique identifier for the <parameterMap>. |
58 | + * @param string $value |
|
58 | 59 | */ |
59 | 60 | public function setID($value) |
60 | 61 | { |
@@ -62,7 +63,7 @@ discard block |
||
62 | 63 | } |
63 | 64 | |
64 | 65 | /** |
65 | - * @return TParameterProperty[] list of properties for the parameter map. |
|
66 | + * @return TList list of properties for the parameter map. |
|
66 | 67 | */ |
67 | 68 | public function getProperties() |
68 | 69 | { |
@@ -112,6 +113,7 @@ discard block |
||
112 | 113 | /** |
113 | 114 | * @param int parameter property index |
114 | 115 | * @param TParameterProperty new parameter property. |
116 | + * @param integer $index |
|
115 | 117 | */ |
116 | 118 | public function insertProperty($index, TParameterProperty $property) |
117 | 119 | { |
@@ -103,6 +103,7 @@ discard block |
||
103 | 103 | /** |
104 | 104 | * @param string name of the column in the result set from which the value |
105 | 105 | * will be used to populate the property. |
106 | + * @param string $value |
|
106 | 107 | */ |
107 | 108 | public function setColumn($value) |
108 | 109 | { |
@@ -121,6 +122,7 @@ discard block |
||
121 | 122 | /** |
122 | 123 | * @param int index of the column in the ResultSet from which the value will |
123 | 124 | * be used to populate the object property |
125 | + * @param integer $value |
|
124 | 126 | */ |
125 | 127 | public function setColumnIndex($value) |
126 | 128 | { |
@@ -185,6 +187,7 @@ discard block |
||
185 | 187 | |
186 | 188 | /** |
187 | 189 | * @param string custom type handler class name (may use namespace). |
190 | + * @param string $value |
|
188 | 191 | */ |
189 | 192 | public function setTypeHandler($value) |
190 | 193 | { |
@@ -73,6 +73,7 @@ discard block |
||
73 | 73 | |
74 | 74 | /** |
75 | 75 | * @param string cache implements of TSqlMapCacheTypes, either 'Basic', 'LRU' or 'FIFO'. |
76 | + * @param string $value |
|
76 | 77 | */ |
77 | 78 | public function setImplementation($value) |
78 | 79 | { |
@@ -129,6 +130,7 @@ discard block |
||
129 | 130 | /** |
130 | 131 | * Register a mapped statement that will trigger a cache flush. |
131 | 132 | * @param TMappedStatement mapped statement that may flush the cache. |
133 | + * @param IMappedStatement $mappedStatement |
|
132 | 134 | */ |
133 | 135 | public function registerTriggerStatement($mappedStatement) |
134 | 136 | { |
@@ -174,7 +176,7 @@ discard block |
||
174 | 176 | } |
175 | 177 | |
176 | 178 | /** |
177 | - * @return float cache hit ratio. |
|
179 | + * @return integer cache hit ratio. |
|
178 | 180 | */ |
179 | 181 | public function getHitRatio() |
180 | 182 | { |
@@ -223,7 +225,7 @@ discard block |
||
223 | 225 | } |
224 | 226 | |
225 | 227 | /** |
226 | - * @param string serialized object |
|
228 | + * @param string string object |
|
227 | 229 | * @return string crc32 hash of the serialized object. |
228 | 230 | */ |
229 | 231 | protected function generateKey($string) |
@@ -268,6 +268,7 @@ |
||
268 | 268 | * @param TSqlMapTypeHandlerRegistry type handler registry |
269 | 269 | * @param string result class name. |
270 | 270 | * @param array result data. |
271 | + * @param string $type |
|
271 | 272 | * @return mixed result object. |
272 | 273 | */ |
273 | 274 | protected function createInstanceOf($registry,$type,$row=null) |
@@ -23,7 +23,7 @@ discard block |
||
23 | 23 | * Create an instance of an object give by the attribute named 'class' in the |
24 | 24 | * node and set the properties on the object given by attribute names and values. |
25 | 25 | * @param SimpleXmlNode property node |
26 | - * @return Object new instance of class with class name given by 'class' attribute value. |
|
26 | + * @return TComponent new instance of class with class name given by 'class' attribute value. |
|
27 | 27 | */ |
28 | 28 | protected function createObjectFromNode($node) |
29 | 29 | { |
@@ -44,6 +44,7 @@ discard block |
||
44 | 44 | * @param Object object instance |
45 | 45 | * @param SimpleXmlNode property node |
46 | 46 | * @param array exception property name |
47 | + * @param TComponent $obj |
|
47 | 48 | */ |
48 | 49 | protected function setObjectPropFromNode($obj,$node,$except=array()) |
49 | 50 | { |
@@ -65,6 +66,8 @@ discard block |
||
65 | 66 | * Gets the filename relative to the basefile. |
66 | 67 | * @param string base filename |
67 | 68 | * @param string relative filename |
69 | + * @param string $basefile |
|
70 | + * @param string $resource |
|
68 | 71 | * @return string absolute filename. |
69 | 72 | */ |
70 | 73 | protected function getAbsoluteFilePath($basefile,$resource) |
@@ -98,9 +101,10 @@ discard block |
||
98 | 101 | |
99 | 102 | /** |
100 | 103 | * Get element node by ID value (try for attribute name ID as case insensitive). |
101 | - * @param SimpleXmlDocument $document |
|
104 | + * @param SimpleXMLElement $document |
|
102 | 105 | * @param string tag name. |
103 | 106 | * @param string id value. |
107 | + * @param string $tag |
|
104 | 108 | * @return SimpleXmlElement node if found, null otherwise. |
105 | 109 | */ |
106 | 110 | protected function getElementByIdValue($document, $tag, $value) |
@@ -146,6 +150,7 @@ discard block |
||
146 | 150 | |
147 | 151 | /** |
148 | 152 | * @param TSqlMapManager manager instance. |
153 | + * @param TSqlMapManager $manager |
|
149 | 154 | */ |
150 | 155 | public function __construct($manager) |
151 | 156 | { |
@@ -524,6 +529,7 @@ discard block |
||
524 | 529 | * in the sql text. Extracts inline parameter maps. |
525 | 530 | * @param TSqlMapStatement mapped statement. |
526 | 531 | * @param SimpleXmlElement statement node. |
532 | + * @param TSqlMapStatement $statement |
|
527 | 533 | */ |
528 | 534 | protected function processSqlStatement($statement, $node) |
529 | 535 | { |
@@ -547,6 +553,7 @@ discard block |
||
547 | 553 | * @param TSqlMapStatement statement object. |
548 | 554 | * @param string sql text |
549 | 555 | * @param SimpleXmlElement statement node. |
556 | + * @param string $sqlStatement |
|
550 | 557 | */ |
551 | 558 | protected function applyInlineParameterMap($statement, $sqlStatement, $node) |
552 | 559 | { |
@@ -644,6 +651,7 @@ discard block |
||
644 | 651 | /** |
645 | 652 | * Load the selectKey statement from xml mapping. |
646 | 653 | * @param SimpleXmlElement selectkey node |
654 | + * @param TSqlMapInsert $insert |
|
647 | 655 | */ |
648 | 656 | protected function loadSelectKeyTag($insert, $node) |
649 | 657 | { |
@@ -734,6 +742,7 @@ discard block |
||
734 | 742 | * Load the flush interval |
735 | 743 | * @param TSqlMapCacheModel cache model |
736 | 744 | * @param SimpleXmlElement cache node |
745 | + * @param TSqlMapCacheModel $cacheModel |
|
737 | 746 | */ |
738 | 747 | protected function loadFlushInterval($cacheModel, $node) |
739 | 748 | { |
@@ -769,6 +778,7 @@ discard block |
||
769 | 778 | * @param TSqlMapCacheModel cache model |
770 | 779 | * @param SimpleXmlElement parent node. |
771 | 780 | * @param SimpleXmlElement flush node. |
781 | + * @param TSqlMapCacheModel $cacheModel |
|
772 | 782 | */ |
773 | 783 | protected function loadFlushOnCache($cacheModel,$parent,$node) |
774 | 784 | { |
@@ -116,6 +116,7 @@ |
||
116 | 116 | /** |
117 | 117 | * @param object handler to method calls. |
118 | 118 | * @param object the object to by proxied. |
119 | + * @param TLazyLoadList $handler |
|
119 | 120 | */ |
120 | 121 | public function __construct($handler, $object) |
121 | 122 | { |
@@ -28,6 +28,7 @@ discard block |
||
28 | 28 | /** |
29 | 29 | * Create a new cache with limited cache size. |
30 | 30 | * @param TSqlMapCacheModel $cacheModel. |
31 | + * @param integer $cacheModel |
|
31 | 32 | */ |
32 | 33 | public function __construct($cacheModel=null) |
33 | 34 | { |
@@ -93,6 +94,7 @@ discard block |
||
93 | 94 | class TSqlMapFifoCache extends TSqlMapCache |
94 | 95 | { |
95 | 96 | /** |
97 | + * @param string $key |
|
96 | 98 | * @return mixed Gets a cached object with the specified key. |
97 | 99 | */ |
98 | 100 | public function get($key) |
@@ -105,6 +107,8 @@ discard block |
||
105 | 107 | * The expire and dependency parameters are ignored. |
106 | 108 | * @param string cache key |
107 | 109 | * @param mixed value to cache. |
110 | + * @param string $key |
|
111 | + * @param TComponent $value |
|
108 | 112 | */ |
109 | 113 | public function set($key, $value,$expire=0,$dependency=null) |
110 | 114 | { |
@@ -129,6 +133,7 @@ discard block |
||
129 | 133 | class TSqlMapLruCache extends TSqlMapCache |
130 | 134 | { |
131 | 135 | /** |
136 | + * @param string $key |
|
132 | 137 | * @return mixed Gets a cached object with the specified key. |
133 | 138 | */ |
134 | 139 | public function get($key) |
@@ -146,6 +151,8 @@ discard block |
||
146 | 151 | * The expire and dependency parameters are ignored. |
147 | 152 | * @param string the key identifying the value to be cached |
148 | 153 | * @param mixed the value to be cached |
154 | + * @param string $key |
|
155 | + * @param TComponent $value |
|
149 | 156 | */ |
150 | 157 | public function set($key, $value,$expire=0,$dependency=null) |
151 | 158 | { |
@@ -205,6 +212,9 @@ discard block |
||
205 | 212 | return $keyList; |
206 | 213 | } |
207 | 214 | |
215 | + /** |
|
216 | + * @param TList $keyList |
|
217 | + */ |
|
208 | 218 | protected function setKeyList($keyList) |
209 | 219 | { |
210 | 220 | $this->getCache()->set($this->getKeyListId(), $keyList); |
@@ -40,6 +40,7 @@ discard block |
||
40 | 40 | * @param int page size |
41 | 41 | * @param mixed delegate for each data row retrieved. |
42 | 42 | * @param int number of page to fetch on initialization |
43 | + * @param integer $pageSize |
|
43 | 44 | */ |
44 | 45 | public function __construct(IMappedStatement $statement,$parameter, $pageSize, $delegate=null, $page=0) |
45 | 46 | { |
@@ -55,6 +56,8 @@ discard block |
||
55 | 56 | * @param mixed query parameters |
56 | 57 | * @param int page size. |
57 | 58 | * @param int number of page. |
59 | + * @param IMappedStatement $statement |
|
60 | + * @param integer $page |
|
58 | 61 | */ |
59 | 62 | protected function initialize($statement, $parameter, $pageSize, $page) |
60 | 63 | { |
@@ -40,6 +40,7 @@ discard block |
||
40 | 40 | * @param mixed The object used to set the parameters in the SQL. |
41 | 41 | * @param string The property of the result object to be used as the key. |
42 | 42 | * @param string The property of the result object to be used as the value (or null) |
43 | + * @param TDbConnection $connection |
|
43 | 44 | * @return TMap A map of object containing the rows keyed by <tt>$keyProperty</tt>. |
44 | 45 | */ |
45 | 46 | public function executeQueryForMap($connection, $parameter, $keyProperty, $valueProperty=null); |
@@ -50,6 +51,7 @@ discard block |
||
50 | 51 | * number of row effected. |
51 | 52 | * @param IDbConnection database connection to execute the query |
52 | 53 | * @param mixed The object used to set the parameters in the SQL. |
54 | + * @param TDbConnection $connection |
|
53 | 55 | * @return integer The number of row effected. |
54 | 56 | */ |
55 | 57 | public function executeUpdate($connection, $parameter); |
@@ -62,6 +64,7 @@ discard block |
||
62 | 64 | * @param TList A list to populate the result with. |
63 | 65 | * @param integer The number of rows to skip over. |
64 | 66 | * @param integer The maximum number of rows to return. |
67 | + * @param TDbConnection $connection |
|
65 | 68 | * @return TList A TList of result objects. |
66 | 69 | */ |
67 | 70 | public function executeQueryForList($connection, $parameter, $result=null, $skip=-1, $max=-1); |
@@ -73,6 +76,7 @@ discard block |
||
73 | 76 | * @param IDbConnection database connection to execute the query |
74 | 77 | * @param mixed The object used to set the parameters in the SQL. |
75 | 78 | * @param object The result object. |
79 | + * @param TDbConnection $connection |
|
76 | 80 | * @return object result. |
77 | 81 | */ |
78 | 82 | public function executeQueryForObject($connection,$parameter, $result=null); |