@@ -41,9 +41,9 @@ discard block |
||
41 | 41 | |
42 | 42 | /** |
43 | 43 | * |
44 | - * @param array $files Data table containing the name of data files |
|
45 | 44 | * @param array $datas Data table containing picked datas |
46 | 45 | * @param string $context_datas Will be written in the log files. |
46 | + * @param string $storage_directory |
|
47 | 47 | * @throws Exception Both arrays must have the same size. |
48 | 48 | */ |
49 | 49 | public function __construct($storage_directory, $datas, $context_datas) { |
@@ -93,6 +93,10 @@ discard block |
||
93 | 93 | } |
94 | 94 | } |
95 | 95 | |
96 | + /** |
|
97 | + * @param string $separator |
|
98 | + * @param integer $column |
|
99 | + */ |
|
96 | 100 | private function extractDatasFromFormattedFile($file, /* & $array, */ $separator, $column = null) { |
97 | 101 | $returned_array = array(); |
98 | 102 | foreach (file($file, FILE_IGNORE_NEW_LINES) as $line) { |
@@ -102,6 +106,10 @@ discard block |
||
102 | 106 | return $returned_array; |
103 | 107 | } |
104 | 108 | |
109 | + /** |
|
110 | + * @param string $file_name |
|
111 | + * @param string $mode |
|
112 | + */ |
|
105 | 113 | private function writeArrayToFile($file_name, $mode, $array) { |
106 | 114 | $file = fopen($file_name, $mode); |
107 | 115 | foreach ($array as $line) { |
@@ -110,6 +118,10 @@ discard block |
||
110 | 118 | fclose($file); |
111 | 119 | } |
112 | 120 | |
121 | + /** |
|
122 | + * @param string $file_name |
|
123 | + * @param string $documentation |
|
124 | + */ |
|
113 | 125 | private function writeDocumentationtoFile($file_name, $documentation) { |
114 | 126 | $file = fopen($file_name, 'a'); |
115 | 127 | fwrite($file, $documentation); |
@@ -150,6 +162,9 @@ discard block |
||
150 | 162 | fclose($output_file); |
151 | 163 | } |
152 | 164 | |
165 | + /** |
|
166 | + * @return string |
|
167 | + */ |
|
153 | 168 | private function formatCell($index, $array, $cell_content) { |
154 | 169 | if ($index != count($array) - 1) { |
155 | 170 | $cell_content .= ","; |
@@ -166,6 +181,9 @@ discard block |
||
166 | 181 | return $column; |
167 | 182 | } |
168 | 183 | |
184 | + /** |
|
185 | + * @param string[] $file_extensions |
|
186 | + */ |
|
169 | 187 | private function removeFilesWithExtensions($file_extensions) { |
170 | 188 | foreach ($file_extensions as $file_extension) { |
171 | 189 | $files_list = glob('*' . $file_extension); |
@@ -160,7 +160,6 @@ |
||
160 | 160 | |
161 | 161 | /** |
162 | 162 | * for hook administration :display an URL to access Boomerang statistics.. |
163 | - * @param array $params:contains the data which comes from the envent listened. |
|
164 | 163 | */ |
165 | 164 | function siteAdminHooks($params) { |
166 | 165 | global $Language; |
@@ -21,6 +21,9 @@ |
||
21 | 21 | |
22 | 22 | class BoomerangPluginInfo extends PluginFileInfo { |
23 | 23 | |
24 | + /** |
|
25 | + * @param BoomerangPlugin $plugin |
|
26 | + */ |
|
24 | 27 | public function __construct($plugin) { |
25 | 28 | parent::__construct($plugin, 'config'); |
26 | 29 | $this->setPluginDescriptor(new BoomerangPluginDescriptor()); |
@@ -71,6 +71,9 @@ |
||
71 | 71 | } |
72 | 72 | } |
73 | 73 | |
74 | + /** |
|
75 | + * @param integer $array_size |
|
76 | + */ |
|
74 | 77 | private function getQuartilesIndexes($array_size) { |
75 | 78 | $array_size--; |
76 | 79 | return array( |
@@ -36,6 +36,10 @@ |
||
36 | 36 | $this->addCardField('impediment', 2); |
37 | 37 | } |
38 | 38 | |
39 | + /** |
|
40 | + * @param string $name |
|
41 | + * @param integer $rank |
|
42 | + */ |
|
39 | 43 | private function addCardField($name, $rank) { |
40 | 44 | $sql = "INSERT INTO plugin_cardwall_semantic_cardfields(tracker_id, field_id, rank) |
41 | 45 | SELECT tracker_id, id, $rank |
@@ -59,10 +59,16 @@ |
||
59 | 59 | $GLOBALS['Response']->sendJSON($json_format); |
60 | 60 | } |
61 | 61 | |
62 | + /** |
|
63 | + * @param Tracker_FormElement_Field $field |
|
64 | + */ |
|
62 | 65 | private function addJsonFieldValues(&$json_format, $field) { |
63 | 66 | $json_format['fields'][$field->getName()] = $this->single_card->getFieldJsonValue($this->request->getCurrentUser(), $field); |
64 | 67 | } |
65 | 68 | |
69 | + /** |
|
70 | + * @param Tracker_FormElement_Field $field |
|
71 | + */ |
|
66 | 72 | private function addHTMLFieldValues(&$json_format, $field) { |
67 | 73 | $json_format['html_fields'][$field->getName()] = $this->single_card->getFieldHTMLValue($this->request->getCurrentUser(), $field); |
68 | 74 | } |
@@ -69,6 +69,9 @@ |
||
69 | 69 | return $presenters; |
70 | 70 | } |
71 | 71 | |
72 | + /** |
|
73 | + * @param integer $swimline_id |
|
74 | + */ |
|
72 | 75 | private function getCardPresenter(Tracker_Artifact $artifact, $swimline_id) { |
73 | 76 | $color = $artifact->getCardAccentColor($this->user); |
74 | 77 |
@@ -43,6 +43,9 @@ |
||
43 | 43 | |
44 | 44 | private $swimline_id; |
45 | 45 | |
46 | + /** |
|
47 | + * @param string $accent_color |
|
48 | + */ |
|
46 | 49 | public function __construct(Tracker_Artifact $artifact, Cardwall_CardFields $card_fields, $accent_color, Cardwall_UserPreferences_UserPreferencesDisplayUser $display_preferences, $swimline_id, array $allowed_children, Tracker_Artifact $parent = null) { |
47 | 50 | $this->artifact = $artifact; |
48 | 51 | $this->parent = $parent; |
@@ -101,6 +101,9 @@ |
||
101 | 101 | return $this->fetchCards($matching_ids, $user, $form); |
102 | 102 | } |
103 | 103 | |
104 | + /** |
|
105 | + * @param Cardwall_Form $form |
|
106 | + */ |
|
104 | 107 | private function fetchCards($matching_ids, PFUser $user, $form = null) { |
105 | 108 | $total_rows = $matching_ids['id'] ? substr_count($matching_ids['id'], ',') + 1 : 0; |
106 | 109 | if (!$total_rows) { |