@@ -32,31 +32,31 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class LockedException extends \Exception { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Locked path |
|
| 37 | - * |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 40 | - private $path; |
|
| 35 | + /** |
|
| 36 | + * Locked path |
|
| 37 | + * |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | + private $path; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * LockedException constructor. |
|
| 44 | - * |
|
| 45 | - * @param string $path locked path |
|
| 46 | - * @param \Exception $previous previous exception for cascading |
|
| 47 | - * |
|
| 48 | - * @since 8.1.0 |
|
| 49 | - */ |
|
| 50 | - public function __construct($path, \Exception $previous = null) { |
|
| 51 | - parent::__construct('"' . $path . '" is locked', 0, $previous); |
|
| 52 | - $this->path = $path; |
|
| 53 | - } |
|
| 42 | + /** |
|
| 43 | + * LockedException constructor. |
|
| 44 | + * |
|
| 45 | + * @param string $path locked path |
|
| 46 | + * @param \Exception $previous previous exception for cascading |
|
| 47 | + * |
|
| 48 | + * @since 8.1.0 |
|
| 49 | + */ |
|
| 50 | + public function __construct($path, \Exception $previous = null) { |
|
| 51 | + parent::__construct('"' . $path . '" is locked', 0, $previous); |
|
| 52 | + $this->path = $path; |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @return string |
|
| 57 | - * @since 8.1.0 |
|
| 58 | - */ |
|
| 59 | - public function getPath() { |
|
| 60 | - return $this->path; |
|
| 61 | - } |
|
| 55 | + /** |
|
| 56 | + * @return string |
|
| 57 | + * @since 8.1.0 |
|
| 58 | + */ |
|
| 59 | + public function getPath() { |
|
| 60 | + return $this->path; |
|
| 61 | + } |
|
| 62 | 62 | } |
@@ -48,7 +48,7 @@ |
||
| 48 | 48 | * @since 8.1.0 |
| 49 | 49 | */ |
| 50 | 50 | public function __construct($path, \Exception $previous = null) { |
| 51 | - parent::__construct('"' . $path . '" is locked', 0, $previous); |
|
| 51 | + parent::__construct('"'.$path.'" is locked', 0, $previous); |
|
| 52 | 52 | $this->path = $path; |
| 53 | 53 | } |
| 54 | 54 | |
@@ -40,158 +40,158 @@ |
||
| 40 | 40 | * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
| 41 | 41 | */ |
| 42 | 42 | class JSON { |
| 43 | - /** |
|
| 44 | - * Encode and print $data in JSON format |
|
| 45 | - * @param array $data The data to use |
|
| 46 | - * @param bool $setContentType the optional content type |
|
| 47 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 48 | - */ |
|
| 49 | - public static function encodedPrint( $data, $setContentType=true ) { |
|
| 50 | - \OC_JSON::encodedPrint($data, $setContentType); |
|
| 51 | - } |
|
| 43 | + /** |
|
| 44 | + * Encode and print $data in JSON format |
|
| 45 | + * @param array $data The data to use |
|
| 46 | + * @param bool $setContentType the optional content type |
|
| 47 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 48 | + */ |
|
| 49 | + public static function encodedPrint( $data, $setContentType=true ) { |
|
| 50 | + \OC_JSON::encodedPrint($data, $setContentType); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Check if the user is logged in, send json error msg if not. |
|
| 55 | - * |
|
| 56 | - * This method checks if a user is logged in. If not, a json error |
|
| 57 | - * response will be return and the method will exit from execution |
|
| 58 | - * of the script. |
|
| 59 | - * The returned json will be in the format: |
|
| 60 | - * |
|
| 61 | - * {"status":"error","data":{"message":"Authentication error."}} |
|
| 62 | - * |
|
| 63 | - * Add this call to the start of all ajax method files that requires |
|
| 64 | - * an authenticated user. |
|
| 65 | - * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead |
|
| 66 | - */ |
|
| 67 | - public static function checkLoggedIn() { |
|
| 68 | - \OC_JSON::checkLoggedIn(); |
|
| 69 | - } |
|
| 53 | + /** |
|
| 54 | + * Check if the user is logged in, send json error msg if not. |
|
| 55 | + * |
|
| 56 | + * This method checks if a user is logged in. If not, a json error |
|
| 57 | + * response will be return and the method will exit from execution |
|
| 58 | + * of the script. |
|
| 59 | + * The returned json will be in the format: |
|
| 60 | + * |
|
| 61 | + * {"status":"error","data":{"message":"Authentication error."}} |
|
| 62 | + * |
|
| 63 | + * Add this call to the start of all ajax method files that requires |
|
| 64 | + * an authenticated user. |
|
| 65 | + * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead |
|
| 66 | + */ |
|
| 67 | + public static function checkLoggedIn() { |
|
| 68 | + \OC_JSON::checkLoggedIn(); |
|
| 69 | + } |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Check an ajax get/post call if the request token is valid. |
|
| 73 | - * |
|
| 74 | - * This method checks for a valid variable 'requesttoken' in $_GET, |
|
| 75 | - * $_POST and $_SERVER. If a valid token is not found, a json error |
|
| 76 | - * response will be return and the method will exit from execution |
|
| 77 | - * of the script. |
|
| 78 | - * The returned json will be in the format: |
|
| 79 | - * |
|
| 80 | - * {"status":"error","data":{"message":"Token expired. Please reload page."}} |
|
| 81 | - * |
|
| 82 | - * Add this call to the start of all ajax method files that creates, |
|
| 83 | - * updates or deletes anything. |
|
| 84 | - * In cases where you e.g. use an ajax call to load a dialog containing |
|
| 85 | - * a submittable form, you will need to add the requesttoken first as a |
|
| 86 | - * parameter to the ajax call, then assign it to the template and finally |
|
| 87 | - * add a hidden input field also named 'requesttoken' containing the value. |
|
| 88 | - * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead |
|
| 89 | - */ |
|
| 90 | - public static function callCheck() { |
|
| 91 | - \OC_JSON::callCheck(); |
|
| 92 | - } |
|
| 71 | + /** |
|
| 72 | + * Check an ajax get/post call if the request token is valid. |
|
| 73 | + * |
|
| 74 | + * This method checks for a valid variable 'requesttoken' in $_GET, |
|
| 75 | + * $_POST and $_SERVER. If a valid token is not found, a json error |
|
| 76 | + * response will be return and the method will exit from execution |
|
| 77 | + * of the script. |
|
| 78 | + * The returned json will be in the format: |
|
| 79 | + * |
|
| 80 | + * {"status":"error","data":{"message":"Token expired. Please reload page."}} |
|
| 81 | + * |
|
| 82 | + * Add this call to the start of all ajax method files that creates, |
|
| 83 | + * updates or deletes anything. |
|
| 84 | + * In cases where you e.g. use an ajax call to load a dialog containing |
|
| 85 | + * a submittable form, you will need to add the requesttoken first as a |
|
| 86 | + * parameter to the ajax call, then assign it to the template and finally |
|
| 87 | + * add a hidden input field also named 'requesttoken' containing the value. |
|
| 88 | + * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead |
|
| 89 | + */ |
|
| 90 | + public static function callCheck() { |
|
| 91 | + \OC_JSON::callCheck(); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Send json success msg |
|
| 96 | - * |
|
| 97 | - * Return a json success message with optional extra data. |
|
| 98 | - * @see OCP\JSON::error() for the format to use. |
|
| 99 | - * |
|
| 100 | - * @param array $data The data to use |
|
| 101 | - * @return string json formatted string. |
|
| 102 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 103 | - */ |
|
| 104 | - public static function success( $data = array() ) { |
|
| 105 | - \OC_JSON::success($data); |
|
| 106 | - } |
|
| 94 | + /** |
|
| 95 | + * Send json success msg |
|
| 96 | + * |
|
| 97 | + * Return a json success message with optional extra data. |
|
| 98 | + * @see OCP\JSON::error() for the format to use. |
|
| 99 | + * |
|
| 100 | + * @param array $data The data to use |
|
| 101 | + * @return string json formatted string. |
|
| 102 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 103 | + */ |
|
| 104 | + public static function success( $data = array() ) { |
|
| 105 | + \OC_JSON::success($data); |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Send json error msg |
|
| 110 | - * |
|
| 111 | - * Return a json error message with optional extra data for |
|
| 112 | - * error message or app specific data. |
|
| 113 | - * |
|
| 114 | - * Example use: |
|
| 115 | - * |
|
| 116 | - * $id = [some value] |
|
| 117 | - * OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id))); |
|
| 118 | - * |
|
| 119 | - * Will return the json formatted string: |
|
| 120 | - * |
|
| 121 | - * {"status":"error","data":{"message":"An error happened", "id":[some value]}} |
|
| 122 | - * |
|
| 123 | - * @param array $data The data to use |
|
| 124 | - * @return string json formatted error string. |
|
| 125 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 126 | - */ |
|
| 127 | - public static function error( $data = array() ) { |
|
| 128 | - \OC_JSON::error( $data ); |
|
| 129 | - } |
|
| 108 | + /** |
|
| 109 | + * Send json error msg |
|
| 110 | + * |
|
| 111 | + * Return a json error message with optional extra data for |
|
| 112 | + * error message or app specific data. |
|
| 113 | + * |
|
| 114 | + * Example use: |
|
| 115 | + * |
|
| 116 | + * $id = [some value] |
|
| 117 | + * OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id))); |
|
| 118 | + * |
|
| 119 | + * Will return the json formatted string: |
|
| 120 | + * |
|
| 121 | + * {"status":"error","data":{"message":"An error happened", "id":[some value]}} |
|
| 122 | + * |
|
| 123 | + * @param array $data The data to use |
|
| 124 | + * @return string json formatted error string. |
|
| 125 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 126 | + */ |
|
| 127 | + public static function error( $data = array() ) { |
|
| 128 | + \OC_JSON::error( $data ); |
|
| 129 | + } |
|
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Set Content-Type header to jsonrequest |
|
| 133 | - * @param string $type The content type header |
|
| 134 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 135 | - */ |
|
| 136 | - public static function setContentTypeHeader( $type='application/json' ) { |
|
| 137 | - \OC_JSON::setContentTypeHeader($type); |
|
| 138 | - } |
|
| 131 | + /** |
|
| 132 | + * Set Content-Type header to jsonrequest |
|
| 133 | + * @param string $type The content type header |
|
| 134 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 135 | + */ |
|
| 136 | + public static function setContentTypeHeader( $type='application/json' ) { |
|
| 137 | + \OC_JSON::setContentTypeHeader($type); |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * Check if the App is enabled and send JSON error message instead |
|
| 142 | - * |
|
| 143 | - * This method checks if a specific app is enabled. If not, a json error |
|
| 144 | - * response will be return and the method will exit from execution |
|
| 145 | - * of the script. |
|
| 146 | - * The returned json will be in the format: |
|
| 147 | - * |
|
| 148 | - * {"status":"error","data":{"message":"Application is not enabled."}} |
|
| 149 | - * |
|
| 150 | - * Add this call to the start of all ajax method files that requires |
|
| 151 | - * a specific app to be enabled. |
|
| 152 | - * |
|
| 153 | - * @param string $app The app to check |
|
| 154 | - * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled. |
|
| 155 | - */ |
|
| 156 | - public static function checkAppEnabled( $app ) { |
|
| 157 | - \OC_JSON::checkAppEnabled($app); |
|
| 158 | - } |
|
| 140 | + /** |
|
| 141 | + * Check if the App is enabled and send JSON error message instead |
|
| 142 | + * |
|
| 143 | + * This method checks if a specific app is enabled. If not, a json error |
|
| 144 | + * response will be return and the method will exit from execution |
|
| 145 | + * of the script. |
|
| 146 | + * The returned json will be in the format: |
|
| 147 | + * |
|
| 148 | + * {"status":"error","data":{"message":"Application is not enabled."}} |
|
| 149 | + * |
|
| 150 | + * Add this call to the start of all ajax method files that requires |
|
| 151 | + * a specific app to be enabled. |
|
| 152 | + * |
|
| 153 | + * @param string $app The app to check |
|
| 154 | + * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled. |
|
| 155 | + */ |
|
| 156 | + public static function checkAppEnabled( $app ) { |
|
| 157 | + \OC_JSON::checkAppEnabled($app); |
|
| 158 | + } |
|
| 159 | 159 | |
| 160 | - /** |
|
| 161 | - * Check if the user is a admin, send json error msg if not |
|
| 162 | - * |
|
| 163 | - * This method checks if the current user has admin rights. If not, a json error |
|
| 164 | - * response will be return and the method will exit from execution |
|
| 165 | - * of the script. |
|
| 166 | - * The returned json will be in the format: |
|
| 167 | - * |
|
| 168 | - * {"status":"error","data":{"message":"Authentication error."}} |
|
| 169 | - * |
|
| 170 | - * Add this call to the start of all ajax method files that requires |
|
| 171 | - * administrative rights. |
|
| 172 | - * |
|
| 173 | - * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead |
|
| 174 | - */ |
|
| 175 | - public static function checkAdminUser() { |
|
| 176 | - \OC_JSON::checkAdminUser(); |
|
| 177 | - } |
|
| 160 | + /** |
|
| 161 | + * Check if the user is a admin, send json error msg if not |
|
| 162 | + * |
|
| 163 | + * This method checks if the current user has admin rights. If not, a json error |
|
| 164 | + * response will be return and the method will exit from execution |
|
| 165 | + * of the script. |
|
| 166 | + * The returned json will be in the format: |
|
| 167 | + * |
|
| 168 | + * {"status":"error","data":{"message":"Authentication error."}} |
|
| 169 | + * |
|
| 170 | + * Add this call to the start of all ajax method files that requires |
|
| 171 | + * administrative rights. |
|
| 172 | + * |
|
| 173 | + * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead |
|
| 174 | + */ |
|
| 175 | + public static function checkAdminUser() { |
|
| 176 | + \OC_JSON::checkAdminUser(); |
|
| 177 | + } |
|
| 178 | 178 | |
| 179 | - /** |
|
| 180 | - * Encode JSON |
|
| 181 | - * @param array $data |
|
| 182 | - * @return string |
|
| 183 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 184 | - */ |
|
| 185 | - public static function encode($data) { |
|
| 186 | - return \OC_JSON::encode($data); |
|
| 187 | - } |
|
| 179 | + /** |
|
| 180 | + * Encode JSON |
|
| 181 | + * @param array $data |
|
| 182 | + * @return string |
|
| 183 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 184 | + */ |
|
| 185 | + public static function encode($data) { |
|
| 186 | + return \OC_JSON::encode($data); |
|
| 187 | + } |
|
| 188 | 188 | |
| 189 | - /** |
|
| 190 | - * Check is a given user exists - send json error msg if not |
|
| 191 | - * @param string $user |
|
| 192 | - * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 193 | - */ |
|
| 194 | - public static function checkUserExists($user) { |
|
| 195 | - \OC_JSON::checkUserExists($user); |
|
| 196 | - } |
|
| 189 | + /** |
|
| 190 | + * Check is a given user exists - send json error msg if not |
|
| 191 | + * @param string $user |
|
| 192 | + * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
|
| 193 | + */ |
|
| 194 | + public static function checkUserExists($user) { |
|
| 195 | + \OC_JSON::checkUserExists($user); |
|
| 196 | + } |
|
| 197 | 197 | } |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | * @param bool $setContentType the optional content type |
| 47 | 47 | * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
| 48 | 48 | */ |
| 49 | - public static function encodedPrint( $data, $setContentType=true ) { |
|
| 49 | + public static function encodedPrint($data, $setContentType = true) { |
|
| 50 | 50 | \OC_JSON::encodedPrint($data, $setContentType); |
| 51 | 51 | } |
| 52 | 52 | |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | * @return string json formatted string. |
| 102 | 102 | * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
| 103 | 103 | */ |
| 104 | - public static function success( $data = array() ) { |
|
| 104 | + public static function success($data = array()) { |
|
| 105 | 105 | \OC_JSON::success($data); |
| 106 | 106 | } |
| 107 | 107 | |
@@ -124,8 +124,8 @@ discard block |
||
| 124 | 124 | * @return string json formatted error string. |
| 125 | 125 | * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
| 126 | 126 | */ |
| 127 | - public static function error( $data = array() ) { |
|
| 128 | - \OC_JSON::error( $data ); |
|
| 127 | + public static function error($data = array()) { |
|
| 128 | + \OC_JSON::error($data); |
|
| 129 | 129 | } |
| 130 | 130 | |
| 131 | 131 | /** |
@@ -133,7 +133,7 @@ discard block |
||
| 133 | 133 | * @param string $type The content type header |
| 134 | 134 | * @deprecated 8.1.0 Use a AppFramework JSONResponse instead |
| 135 | 135 | */ |
| 136 | - public static function setContentTypeHeader( $type='application/json' ) { |
|
| 136 | + public static function setContentTypeHeader($type = 'application/json') { |
|
| 137 | 137 | \OC_JSON::setContentTypeHeader($type); |
| 138 | 138 | } |
| 139 | 139 | |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | * @param string $app The app to check |
| 154 | 154 | * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled. |
| 155 | 155 | */ |
| 156 | - public static function checkAppEnabled( $app ) { |
|
| 156 | + public static function checkAppEnabled($app) { |
|
| 157 | 157 | \OC_JSON::checkAppEnabled($app); |
| 158 | 158 | } |
| 159 | 159 | |
@@ -31,64 +31,64 @@ |
||
| 31 | 31 | // use OCP namespace for all classes that are considered public. |
| 32 | 32 | // This means that they should be used by apps instead of the internal ownCloud classes |
| 33 | 33 | namespace OCP { |
| 34 | - /** |
|
| 35 | - * Interface IAddressBook |
|
| 36 | - * |
|
| 37 | - * @package OCP |
|
| 38 | - * @since 5.0.0 |
|
| 39 | - */ |
|
| 40 | - interface IAddressBook { |
|
| 34 | + /** |
|
| 35 | + * Interface IAddressBook |
|
| 36 | + * |
|
| 37 | + * @package OCP |
|
| 38 | + * @since 5.0.0 |
|
| 39 | + */ |
|
| 40 | + interface IAddressBook { |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @return string defining the technical unique key |
|
| 44 | - * @since 5.0.0 |
|
| 45 | - */ |
|
| 46 | - public function getKey(); |
|
| 42 | + /** |
|
| 43 | + * @return string defining the technical unique key |
|
| 44 | + * @since 5.0.0 |
|
| 45 | + */ |
|
| 46 | + public function getKey(); |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
| 50 | - * @return mixed |
|
| 51 | - * @since 5.0.0 |
|
| 52 | - */ |
|
| 53 | - public function getDisplayName(); |
|
| 48 | + /** |
|
| 49 | + * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
| 50 | + * @return mixed |
|
| 51 | + * @since 5.0.0 |
|
| 52 | + */ |
|
| 53 | + public function getDisplayName(); |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @param string $pattern which should match within the $searchProperties |
|
| 57 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
| 58 | - * @param array $options - for future use. One should always have options! |
|
| 59 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
| 60 | - * @since 5.0.0 |
|
| 61 | - */ |
|
| 62 | - public function search($pattern, $searchProperties, $options); |
|
| 63 | - // // dummy results |
|
| 64 | - // return array( |
|
| 65 | - // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', 'GEO' => '37.386013;-122.082932'), |
|
| 66 | - // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('[email protected]', '[email protected]')), |
|
| 67 | - // ); |
|
| 55 | + /** |
|
| 56 | + * @param string $pattern which should match within the $searchProperties |
|
| 57 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
| 58 | + * @param array $options - for future use. One should always have options! |
|
| 59 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
| 60 | + * @since 5.0.0 |
|
| 61 | + */ |
|
| 62 | + public function search($pattern, $searchProperties, $options); |
|
| 63 | + // // dummy results |
|
| 64 | + // return array( |
|
| 65 | + // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', 'GEO' => '37.386013;-122.082932'), |
|
| 66 | + // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('[email protected]', '[email protected]')), |
|
| 67 | + // ); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @param array $properties this array if key-value-pairs defines a contact |
|
| 71 | - * @return array an array representing the contact just created or updated |
|
| 72 | - * @since 5.0.0 |
|
| 73 | - */ |
|
| 74 | - public function createOrUpdate($properties); |
|
| 75 | - // // dummy |
|
| 76 | - // return array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', |
|
| 77 | - // 'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif', |
|
| 78 | - // 'ADR' => ';;123 Main Street;Any Town;CA;91921-1234' |
|
| 79 | - // ); |
|
| 69 | + /** |
|
| 70 | + * @param array $properties this array if key-value-pairs defines a contact |
|
| 71 | + * @return array an array representing the contact just created or updated |
|
| 72 | + * @since 5.0.0 |
|
| 73 | + */ |
|
| 74 | + public function createOrUpdate($properties); |
|
| 75 | + // // dummy |
|
| 76 | + // return array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => '[email protected]', |
|
| 77 | + // 'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif', |
|
| 78 | + // 'ADR' => ';;123 Main Street;Any Town;CA;91921-1234' |
|
| 79 | + // ); |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @return mixed |
|
| 83 | - * @since 5.0.0 |
|
| 84 | - */ |
|
| 85 | - public function getPermissions(); |
|
| 81 | + /** |
|
| 82 | + * @return mixed |
|
| 83 | + * @since 5.0.0 |
|
| 84 | + */ |
|
| 85 | + public function getPermissions(); |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * @param object $id the unique identifier to a contact |
|
| 89 | - * @return bool successful or not |
|
| 90 | - * @since 5.0.0 |
|
| 91 | - */ |
|
| 92 | - public function delete($id); |
|
| 93 | - } |
|
| 87 | + /** |
|
| 88 | + * @param object $id the unique identifier to a contact |
|
| 89 | + * @return bool successful or not |
|
| 90 | + * @since 5.0.0 |
|
| 91 | + */ |
|
| 92 | + public function delete($id); |
|
| 93 | + } |
|
| 94 | 94 | } |
@@ -39,46 +39,46 @@ |
||
| 39 | 39 | */ |
| 40 | 40 | interface ICache { |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Get a value from the user cache |
|
| 44 | - * @param string $key |
|
| 45 | - * @return mixed |
|
| 46 | - * @since 6.0.0 |
|
| 47 | - */ |
|
| 48 | - public function get($key); |
|
| 42 | + /** |
|
| 43 | + * Get a value from the user cache |
|
| 44 | + * @param string $key |
|
| 45 | + * @return mixed |
|
| 46 | + * @since 6.0.0 |
|
| 47 | + */ |
|
| 48 | + public function get($key); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Set a value in the user cache |
|
| 52 | - * @param string $key |
|
| 53 | - * @param mixed $value |
|
| 54 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 55 | - * @return bool |
|
| 56 | - * @since 6.0.0 |
|
| 57 | - */ |
|
| 58 | - public function set($key, $value, $ttl = 0); |
|
| 50 | + /** |
|
| 51 | + * Set a value in the user cache |
|
| 52 | + * @param string $key |
|
| 53 | + * @param mixed $value |
|
| 54 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 55 | + * @return bool |
|
| 56 | + * @since 6.0.0 |
|
| 57 | + */ |
|
| 58 | + public function set($key, $value, $ttl = 0); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Check if a value is set in the user cache |
|
| 62 | - * @param string $key |
|
| 63 | - * @return bool |
|
| 64 | - * @since 6.0.0 |
|
| 65 | - * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
| 66 | - */ |
|
| 67 | - public function hasKey($key); |
|
| 60 | + /** |
|
| 61 | + * Check if a value is set in the user cache |
|
| 62 | + * @param string $key |
|
| 63 | + * @return bool |
|
| 64 | + * @since 6.0.0 |
|
| 65 | + * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
| 66 | + */ |
|
| 67 | + public function hasKey($key); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Remove an item from the user cache |
|
| 71 | - * @param string $key |
|
| 72 | - * @return bool |
|
| 73 | - * @since 6.0.0 |
|
| 74 | - */ |
|
| 75 | - public function remove($key); |
|
| 69 | + /** |
|
| 70 | + * Remove an item from the user cache |
|
| 71 | + * @param string $key |
|
| 72 | + * @return bool |
|
| 73 | + * @since 6.0.0 |
|
| 74 | + */ |
|
| 75 | + public function remove($key); |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Clear the user cache of all entries starting with a prefix |
|
| 79 | - * @param string $prefix (optional) |
|
| 80 | - * @return bool |
|
| 81 | - * @since 6.0.0 |
|
| 82 | - */ |
|
| 83 | - public function clear($prefix = ''); |
|
| 77 | + /** |
|
| 78 | + * Clear the user cache of all entries starting with a prefix |
|
| 79 | + * @param string $prefix (optional) |
|
| 80 | + * @return bool |
|
| 81 | + * @since 6.0.0 |
|
| 82 | + */ |
|
| 83 | + public function clear($prefix = ''); |
|
| 84 | 84 | } |
@@ -27,12 +27,12 @@ |
||
| 27 | 27 | * @since 8.2.0 |
| 28 | 28 | */ |
| 29 | 29 | class AutoloadNotAllowedException extends \DomainException { |
| 30 | - /** |
|
| 31 | - * @param string $path |
|
| 32 | - * @since 8.2.0 |
|
| 33 | - */ |
|
| 34 | - public function __construct($path) { |
|
| 35 | - parent::__construct('Autoload path not allowed: '.$path); |
|
| 36 | - } |
|
| 30 | + /** |
|
| 31 | + * @param string $path |
|
| 32 | + * @since 8.2.0 |
|
| 33 | + */ |
|
| 34 | + public function __construct($path) { |
|
| 35 | + parent::__construct('Autoload path not allowed: '.$path); |
|
| 36 | + } |
|
| 37 | 37 | } |
| 38 | 38 | |
@@ -32,60 +32,60 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | abstract class Provider { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @since 8.0.0 |
|
| 37 | - */ |
|
| 38 | - const OPTION_APPS = 'apps'; |
|
| 35 | + /** |
|
| 36 | + * @since 8.0.0 |
|
| 37 | + */ |
|
| 38 | + const OPTION_APPS = 'apps'; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * List of options |
|
| 42 | - * @var array |
|
| 43 | - * @since 7.0.0 |
|
| 44 | - */ |
|
| 45 | - protected $options; |
|
| 40 | + /** |
|
| 41 | + * List of options |
|
| 42 | + * @var array |
|
| 43 | + * @since 7.0.0 |
|
| 44 | + */ |
|
| 45 | + protected $options; |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Constructor |
|
| 49 | - * @param array $options as key => value |
|
| 50 | - * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
| 51 | - */ |
|
| 52 | - public function __construct($options = array()) { |
|
| 53 | - $this->options = $options; |
|
| 54 | - } |
|
| 47 | + /** |
|
| 48 | + * Constructor |
|
| 49 | + * @param array $options as key => value |
|
| 50 | + * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
| 51 | + */ |
|
| 52 | + public function __construct($options = array()) { |
|
| 53 | + $this->options = $options; |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * get a value from the options array or null |
|
| 58 | - * @param string $key |
|
| 59 | - * @return mixed |
|
| 60 | - * @since 8.0.0 |
|
| 61 | - */ |
|
| 62 | - public function getOption($key) { |
|
| 63 | - if (is_array($this->options) && isset($this->options[$key])) { |
|
| 64 | - return $this->options[$key]; |
|
| 65 | - } else { |
|
| 66 | - return null; |
|
| 67 | - } |
|
| 68 | - } |
|
| 56 | + /** |
|
| 57 | + * get a value from the options array or null |
|
| 58 | + * @param string $key |
|
| 59 | + * @return mixed |
|
| 60 | + * @since 8.0.0 |
|
| 61 | + */ |
|
| 62 | + public function getOption($key) { |
|
| 63 | + if (is_array($this->options) && isset($this->options[$key])) { |
|
| 64 | + return $this->options[$key]; |
|
| 65 | + } else { |
|
| 66 | + return null; |
|
| 67 | + } |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * checks if the given apps and the apps this provider has results for intersect |
|
| 72 | - * returns true if the given array is empty (all apps) |
|
| 73 | - * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
| 74 | - * or if the two above arrays have elements in common (intersect) |
|
| 75 | - * @param string[] $apps |
|
| 76 | - * @return bool |
|
| 77 | - * @since 8.0.0 |
|
| 78 | - */ |
|
| 79 | - public function providesResultsFor(array $apps = array()) { |
|
| 80 | - $forApps = $this->getOption(self::OPTION_APPS); |
|
| 81 | - return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
| 82 | - } |
|
| 70 | + /** |
|
| 71 | + * checks if the given apps and the apps this provider has results for intersect |
|
| 72 | + * returns true if the given array is empty (all apps) |
|
| 73 | + * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
| 74 | + * or if the two above arrays have elements in common (intersect) |
|
| 75 | + * @param string[] $apps |
|
| 76 | + * @return bool |
|
| 77 | + * @since 8.0.0 |
|
| 78 | + */ |
|
| 79 | + public function providesResultsFor(array $apps = array()) { |
|
| 80 | + $forApps = $this->getOption(self::OPTION_APPS); |
|
| 81 | + return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Search for $query |
|
| 86 | - * @param string $query |
|
| 87 | - * @return array An array of OCP\Search\Result's |
|
| 88 | - * @since 7.0.0 |
|
| 89 | - */ |
|
| 90 | - abstract public function search($query); |
|
| 84 | + /** |
|
| 85 | + * Search for $query |
|
| 86 | + * @param string $query |
|
| 87 | + * @return array An array of OCP\Search\Result's |
|
| 88 | + * @since 7.0.0 |
|
| 89 | + */ |
|
| 90 | + abstract public function search($query); |
|
| 91 | 91 | } |
@@ -31,47 +31,47 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class Result { |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * A unique identifier for the result, usually given as the item ID in its |
|
| 36 | - * corresponding application. |
|
| 37 | - * @var string |
|
| 38 | - * @since 7.0.0 |
|
| 39 | - */ |
|
| 40 | - public $id; |
|
| 34 | + /** |
|
| 35 | + * A unique identifier for the result, usually given as the item ID in its |
|
| 36 | + * corresponding application. |
|
| 37 | + * @var string |
|
| 38 | + * @since 7.0.0 |
|
| 39 | + */ |
|
| 40 | + public $id; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * The name of the item returned; this will be displayed in the search |
|
| 44 | - * results. |
|
| 45 | - * @var string |
|
| 46 | - * @since 7.0.0 |
|
| 47 | - */ |
|
| 48 | - public $name; |
|
| 42 | + /** |
|
| 43 | + * The name of the item returned; this will be displayed in the search |
|
| 44 | + * results. |
|
| 45 | + * @var string |
|
| 46 | + * @since 7.0.0 |
|
| 47 | + */ |
|
| 48 | + public $name; |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * URL to the application item. |
|
| 52 | - * @var string |
|
| 53 | - * @since 7.0.0 |
|
| 54 | - */ |
|
| 55 | - public $link; |
|
| 50 | + /** |
|
| 51 | + * URL to the application item. |
|
| 52 | + * @var string |
|
| 53 | + * @since 7.0.0 |
|
| 54 | + */ |
|
| 55 | + public $link; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * The type of search result returned; for consistency, name this the same |
|
| 59 | - * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. |
|
| 60 | - * @var string |
|
| 61 | - * @since 7.0.0 |
|
| 62 | - */ |
|
| 63 | - public $type = 'generic'; |
|
| 57 | + /** |
|
| 58 | + * The type of search result returned; for consistency, name this the same |
|
| 59 | + * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. |
|
| 60 | + * @var string |
|
| 61 | + * @since 7.0.0 |
|
| 62 | + */ |
|
| 63 | + public $type = 'generic'; |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Create a new search result |
|
| 67 | - * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]' |
|
| 68 | - * @param string $name displayed text of result |
|
| 69 | - * @param string $link URL to the result within its app |
|
| 70 | - * @since 7.0.0 |
|
| 71 | - */ |
|
| 72 | - public function __construct($id = null, $name = null, $link = null) { |
|
| 73 | - $this->id = $id; |
|
| 74 | - $this->name = $name; |
|
| 75 | - $this->link = $link; |
|
| 76 | - } |
|
| 65 | + /** |
|
| 66 | + * Create a new search result |
|
| 67 | + * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]' |
|
| 68 | + * @param string $name displayed text of result |
|
| 69 | + * @param string $link URL to the result within its app |
|
| 70 | + * @since 7.0.0 |
|
| 71 | + */ |
|
| 72 | + public function __construct($id = null, $name = null, $link = null) { |
|
| 73 | + $this->id = $id; |
|
| 74 | + $this->name = $name; |
|
| 75 | + $this->link = $link; |
|
| 76 | + } |
|
| 77 | 77 | } |
@@ -30,39 +30,39 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | abstract class PagedProvider extends Provider { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * show all results |
|
| 35 | - * @since 8.0.0 |
|
| 36 | - */ |
|
| 37 | - const SIZE_ALL = 0; |
|
| 33 | + /** |
|
| 34 | + * show all results |
|
| 35 | + * @since 8.0.0 |
|
| 36 | + */ |
|
| 37 | + const SIZE_ALL = 0; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Constructor |
|
| 41 | - * @param array $options |
|
| 42 | - * @since 8.0.0 |
|
| 43 | - */ |
|
| 44 | - public function __construct($options) { |
|
| 45 | - $this->options = $options; |
|
| 46 | - } |
|
| 39 | + /** |
|
| 40 | + * Constructor |
|
| 41 | + * @param array $options |
|
| 42 | + * @since 8.0.0 |
|
| 43 | + */ |
|
| 44 | + public function __construct($options) { |
|
| 45 | + $this->options = $options; |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Search for $query |
|
| 50 | - * @param string $query |
|
| 51 | - * @return array An array of OCP\Search\Result's |
|
| 52 | - * @since 8.0.0 |
|
| 53 | - */ |
|
| 54 | - public function search($query) { |
|
| 55 | - // old apps might assume they get all results, so we use SIZE_ALL |
|
| 56 | - $this->searchPaged($query, 1, self::SIZE_ALL); |
|
| 57 | - } |
|
| 48 | + /** |
|
| 49 | + * Search for $query |
|
| 50 | + * @param string $query |
|
| 51 | + * @return array An array of OCP\Search\Result's |
|
| 52 | + * @since 8.0.0 |
|
| 53 | + */ |
|
| 54 | + public function search($query) { |
|
| 55 | + // old apps might assume they get all results, so we use SIZE_ALL |
|
| 56 | + $this->searchPaged($query, 1, self::SIZE_ALL); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Search for $query |
|
| 61 | - * @param string $query |
|
| 62 | - * @param int $page pages start at page 1 |
|
| 63 | - * @param int $size 0 = SIZE_ALL |
|
| 64 | - * @return array An array of OCP\Search\Result's |
|
| 65 | - * @since 8.0.0 |
|
| 66 | - */ |
|
| 67 | - abstract public function searchPaged($query, $page, $size); |
|
| 59 | + /** |
|
| 60 | + * Search for $query |
|
| 61 | + * @param string $query |
|
| 62 | + * @param int $page pages start at page 1 |
|
| 63 | + * @param int $size 0 = SIZE_ALL |
|
| 64 | + * @return array An array of OCP\Search\Result's |
|
| 65 | + * @since 8.0.0 |
|
| 66 | + */ |
|
| 67 | + abstract public function searchPaged($query, $page, $size); |
|
| 68 | 68 | } |
@@ -31,11 +31,11 @@ |
||
| 31 | 31 | * @since 5.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface Share_Backend_Collection extends Share_Backend { |
| 34 | - /** |
|
| 35 | - * Get the sources of the children of the item |
|
| 36 | - * @param string $itemSource |
|
| 37 | - * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
| 38 | - * @since 5.0.0 |
|
| 39 | - */ |
|
| 40 | - public function getChildren($itemSource); |
|
| 34 | + /** |
|
| 35 | + * Get the sources of the children of the item |
|
| 36 | + * @param string $itemSource |
|
| 37 | + * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
| 38 | + * @since 5.0.0 |
|
| 39 | + */ |
|
| 40 | + public function getChildren($itemSource); |
|
| 41 | 41 | } |