@@ -261,7 +261,7 @@ |
||
| 261 | 261 | * |
| 262 | 262 | * @param string $app name of the app |
| 263 | 263 | * @param string $image filename of the image |
| 264 | - * @return bool|string false if image should not replaced, otherwise the location of the image |
|
| 264 | + * @return string|false false if image should not replaced, otherwise the location of the image |
|
| 265 | 265 | */ |
| 266 | 266 | public function replaceImagePath($app, $image) { |
| 267 | 267 | if($app==='') { |
@@ -166,7 +166,7 @@ |
||
| 166 | 166 | * @param array $parameters |
| 167 | 167 | * @param bool $silence whether to suppress warnings |
| 168 | 168 | * @throws \ErrorException via trapError |
| 169 | - * @return mixed |
|
| 169 | + * @return string |
|
| 170 | 170 | */ |
| 171 | 171 | private function invoke(string $functionName, array $parameters = [], bool $silence = false) { |
| 172 | 172 | try { |
@@ -506,7 +506,7 @@ discard block |
||
| 506 | 506 | |
| 507 | 507 | /** |
| 508 | 508 | * returns the internal Nextcloud name for the given LDAP DN of the user, false on DN outside of search DN or failure |
| 509 | - * @param string $dn the dn of the user object |
|
| 509 | + * @param string $fdn the dn of the user object |
|
| 510 | 510 | * @param string $ldapName optional, the display name of the object |
| 511 | 511 | * @return string|false with with the name to use in Nextcloud |
| 512 | 512 | */ |
@@ -805,7 +805,7 @@ discard block |
||
| 805 | 805 | * the login filter. |
| 806 | 806 | * |
| 807 | 807 | * @param string $loginName |
| 808 | - * @param array $attributes optional, list of attributes to read |
|
| 808 | + * @param string[] $attributes optional, list of attributes to read |
|
| 809 | 809 | * @return array |
| 810 | 810 | */ |
| 811 | 811 | public function fetchUsersByLoginName($loginName, $attributes = array('dn')) { |
@@ -889,7 +889,7 @@ discard block |
||
| 889 | 889 | |
| 890 | 890 | /** |
| 891 | 891 | * @param string $filter |
| 892 | - * @param string|string[] $attr |
|
| 892 | + * @param string[] $attr |
|
| 893 | 893 | * @param int $limit |
| 894 | 894 | * @param int $offset |
| 895 | 895 | * @return array |
@@ -937,7 +937,7 @@ discard block |
||
| 937 | 937 | |
| 938 | 938 | /** |
| 939 | 939 | * @param string $filter |
| 940 | - * @param string|string[] $attr |
|
| 940 | + * @param string[] $attr |
|
| 941 | 941 | * @param int $limit |
| 942 | 942 | * @param int $offset |
| 943 | 943 | * @return false|int |
@@ -1036,7 +1036,7 @@ discard block |
||
| 1036 | 1036 | /** |
| 1037 | 1037 | * retrieved. Results will according to the order in the array. |
| 1038 | 1038 | * |
| 1039 | - * @param $filter |
|
| 1039 | + * @param string $filter |
|
| 1040 | 1040 | * @param $base |
| 1041 | 1041 | * @param string[]|string|null $attr |
| 1042 | 1042 | * @param int $limit optional, maximum results to be counted |
@@ -1331,6 +1331,7 @@ discard block |
||
| 1331 | 1331 | * escapes (user provided) parts for LDAP filter |
| 1332 | 1332 | * @param string $input, the provided value |
| 1333 | 1333 | * @param bool $allowAsterisk whether in * at the beginning should be preserved |
| 1334 | + * @param string $input |
|
| 1334 | 1335 | * @return string the escaped string |
| 1335 | 1336 | */ |
| 1336 | 1337 | public function escapeFilterPart($input, $allowAsterisk = false) { |
@@ -62,6 +62,7 @@ discard block |
||
| 62 | 62 | * @param string $subject |
| 63 | 63 | * |
| 64 | 64 | * @since 13.0.0 |
| 65 | + * @return void |
|
| 65 | 66 | */ |
| 66 | 67 | public function setSubject(string $subject); |
| 67 | 68 | |
@@ -69,6 +70,7 @@ discard block |
||
| 69 | 70 | * Adds a header to the email |
| 70 | 71 | * |
| 71 | 72 | * @since 12.0.0 |
| 73 | + * @return void |
|
| 72 | 74 | */ |
| 73 | 75 | public function addHeader(); |
| 74 | 76 | |
@@ -80,6 +82,7 @@ discard block |
||
| 80 | 82 | * if empty the $title is used, if false none will be used |
| 81 | 83 | * |
| 82 | 84 | * @since 12.0.0 |
| 85 | + * @return void |
|
| 83 | 86 | */ |
| 84 | 87 | public function addHeading(string $title, $plainTitle = ''); |
| 85 | 88 | |
@@ -91,6 +94,7 @@ discard block |
||
| 91 | 94 | * if empty the $text is used, if false none will be used |
| 92 | 95 | * |
| 93 | 96 | * @since 12.0.0 |
| 97 | + * @return void |
|
| 94 | 98 | */ |
| 95 | 99 | public function addBodyText(string $text, $plainText = ''); |
| 96 | 100 | |
@@ -105,6 +109,7 @@ discard block |
||
| 105 | 109 | * @param string|bool $plainMetaInfo Meta info that is used in the plain text email |
| 106 | 110 | * if empty the $metaInfo is used, if false none will be used |
| 107 | 111 | * @since 12.0.0 |
| 112 | + * @return void |
|
| 108 | 113 | */ |
| 109 | 114 | public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = ''); |
| 110 | 115 | |
@@ -119,6 +124,7 @@ discard block |
||
| 119 | 124 | * @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used |
| 120 | 125 | * |
| 121 | 126 | * @since 12.0.0 |
| 127 | + * @return void |
|
| 122 | 128 | */ |
| 123 | 129 | public function addBodyButtonGroup(string $textLeft, string $urlLeft, string $textRight, string $urlRight, string $plainTextLeft = '', string $plainTextRight = ''); |
| 124 | 130 | |
@@ -131,6 +137,7 @@ discard block |
||
| 131 | 137 | * if empty the $text is used, if false none will be used |
| 132 | 138 | * |
| 133 | 139 | * @since 12.0.0 |
| 140 | + * @return void |
|
| 134 | 141 | */ |
| 135 | 142 | public function addBodyButton(string $text, string $url, $plainText = ''); |
| 136 | 143 | |
@@ -140,6 +147,7 @@ discard block |
||
| 140 | 147 | * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used |
| 141 | 148 | * |
| 142 | 149 | * @since 12.0.0 |
| 150 | + * @return void |
|
| 143 | 151 | */ |
| 144 | 152 | public function addFooter(string $text = ''); |
| 145 | 153 | |
@@ -56,6 +56,9 @@ discard block |
||
| 56 | 56 | ]; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | + /** |
|
| 60 | + * @param string $type |
|
| 61 | + */ |
|
| 59 | 62 | protected function formatSections($sections, $currentSection, $type, $currentType) { |
| 60 | 63 | $templateParameters = []; |
| 61 | 64 | /** @var \OCP\Settings\ISection[] $prioritizedSections */ |
@@ -89,6 +92,9 @@ discard block |
||
| 89 | 92 | return $templateParameters; |
| 90 | 93 | } |
| 91 | 94 | |
| 95 | + /** |
|
| 96 | + * @param string $currentSections |
|
| 97 | + */ |
|
| 92 | 98 | protected function formatPersonalSections($currentType, $currentSections) { |
| 93 | 99 | $sections = $this->settingsManager->getPersonalSections(); |
| 94 | 100 | $templateParameters = $this->formatSections($sections, $currentSections, 'personal', $currentType); |
@@ -96,6 +102,9 @@ discard block |
||
| 96 | 102 | return $templateParameters; |
| 97 | 103 | } |
| 98 | 104 | |
| 105 | + /** |
|
| 106 | + * @param string $currentSections |
|
| 107 | + */ |
|
| 99 | 108 | protected function formatAdminSections($currentType, $currentSections) { |
| 100 | 109 | $sections = $this->settingsManager->getAdminSections(); |
| 101 | 110 | $templateParameters = $this->formatSections($sections, $currentSections, 'admin', $currentType); |
@@ -119,6 +128,10 @@ discard block |
||
| 119 | 128 | return ['content' => $html]; |
| 120 | 129 | } |
| 121 | 130 | |
| 131 | + /** |
|
| 132 | + * @param string $type |
|
| 133 | + * @param string $section |
|
| 134 | + */ |
|
| 122 | 135 | private function getIndexResponse($type, $section) { |
| 123 | 136 | $this->navigationManager->setActiveEntry('settings'); |
| 124 | 137 | $templateParams = []; |
@@ -218,7 +218,7 @@ |
||
| 218 | 218 | /** |
| 219 | 219 | * Gives the relative past time of the timestamp |
| 220 | 220 | * |
| 221 | - * @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object |
|
| 221 | + * @param integer $timestamp Either a Unix timestamp or DateTime object |
|
| 222 | 222 | * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
| 223 | 223 | * @return string Dates returned are: |
| 224 | 224 | * < 60 sec => seconds ago |
@@ -49,6 +49,7 @@ discard block |
||
| 49 | 49 | class Files { |
| 50 | 50 | /** |
| 51 | 51 | * Recusive deletion of folders |
| 52 | + * @param string $dir |
|
| 52 | 53 | * @return bool |
| 53 | 54 | * @since 5.0.0 |
| 54 | 55 | * @deprecated 14.0.0 |
@@ -72,7 +73,7 @@ discard block |
||
| 72 | 73 | /** |
| 73 | 74 | * Search for files by mimetype |
| 74 | 75 | * @param string $mimetype |
| 75 | - * @return array |
|
| 76 | + * @return \OC\Files\FileInfo[] |
|
| 76 | 77 | * @since 6.0.0 |
| 77 | 78 | * @deprecated 14.0.0 |
| 78 | 79 | */ |
@@ -31,7 +31,6 @@ |
||
| 31 | 31 | /** |
| 32 | 32 | * @since 14.0.0 |
| 33 | 33 | * |
| 34 | - * @param string $uid The username |
|
| 35 | 34 | * @param string $password The password |
| 36 | 35 | * @return string|bool The uid on success false on failure |
| 37 | 36 | */ |
@@ -311,7 +311,7 @@ |
||
| 311 | 311 | * get the display name of the user currently logged in. |
| 312 | 312 | * |
| 313 | 313 | * @param string $uid |
| 314 | - * @return string|bool uid or false |
|
| 314 | + * @return string|false uid or false |
|
| 315 | 315 | * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method |
| 316 | 316 | * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
| 317 | 317 | */ |