Fix typos in lib/public subdirectory

szaimen · come-nc · szaimen · commit d55a7c619d37 · 2023-05-10T11:56:34.000+02:00
Found via `codespell -q 3 -S l10n -L jus ./lib/public`

Signed-off-by: luz paz &lt;luzpaz@github.com&gt;

Update lib/public/Accounts/IAccount.php

Signed-off-by: luz paz &lt;luzpaz@github.com&gt;

Signed-off-by: Simon L &lt;szaimen@e.mail.de&gt;
Co-Authored-By: Côme Chilliet &lt;91878298+come-nc@users.noreply.github.com&gt;
diff --git a/lib/private/Preview/Generator.php b/lib/private/Preview/Generator.php
@@ -446,7 +446,7 @@ private function generatePath($width, $height, $crop, $max, $mimeType, $prefix)
 			$path .= '-max';
 		}
 
-		$ext = $this->getExtention($mimeType);
+		$ext = $this->getExtension($mimeType);
 		$path .= '.' . $ext;
 		return $path;
 	}
@@ -647,7 +647,7 @@ private function getPreviewFolder(File $file) {
 	 * @return null|string
 	 * @throws \InvalidArgumentException
 	 */
-	private function getExtention($mimeType) {
+	private function getExtension($mimeType) {
 		switch ($mimeType) {
 			case 'image/png':
 				return 'png';
diff --git a/lib/public/Accounts/IAccount.php b/lib/public/Accounts/IAccount.php
@@ -134,7 +134,7 @@ public function getAllProperties(): Generator;
 	public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount;
 
 	/**
-	 * Returns the requestes propery collection (multi-value properties)
+	 * Returns the requested property collection (multi-value properties)
 	 *
 	 * @throws PropertyDoesNotExistException against invalid collection name
 	 * @since 22.0.0
diff --git a/lib/public/Accounts/IAccountPropertyCollection.php b/lib/public/Accounts/IAccountPropertyCollection.php
@@ -38,7 +38,7 @@
  */
 interface IAccountPropertyCollection extends JsonSerializable {
 	/**
-	 * retuns the collection name
+	 * returns the collection name
 	 *
 	 * @since 22.0.0
 	 */
diff --git a/lib/public/AppFramework/PublicShareController.php b/lib/public/AppFramework/PublicShareController.php
@@ -36,7 +36,7 @@
  *
  * Use this for example for a controller that is not to be called via a webbrowser
  * directly. For example a PublicPreviewController. As this is not meant to be
- * called by a user direclty.
+ * called by a user directly.
  *
  * To show an auth page extend the AuthPublicShareController
  *
diff --git a/lib/public/BackgroundJob/IJobList.php b/lib/public/BackgroundJob/IJobList.php
@@ -52,7 +52,7 @@ interface IJobList {
 	 * Add a job to the list
 	 *
 	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
+	 * @param mixed $argument The argument to be passed to $job->run() when the job is executed
 	 * @since 7.0.0
 	 */
 	public function add($job, $argument = null): void;
diff --git a/lib/public/Collaboration/AutoComplete/IManager.php b/lib/public/Collaboration/AutoComplete/IManager.php
@@ -35,7 +35,7 @@ interface IManager {
 	public function registerSorter($className);
 
 	/**
-	 * @param array $sorters	list of sorter IDs, seperated by "|"
+	 * @param array $sorters	list of sorter IDs, separated by "|"
 	 * @param array $sortArray	array representation of OCP\Collaboration\Collaborators\ISearchResult
 	 * @param array $context	context info of the search, keys: itemType, itemId
 	 * @since 13.0.0
diff --git a/lib/public/Contacts/IManager.php b/lib/public/Contacts/IManager.php
@@ -95,7 +95,7 @@ interface IManager {
 	 * 	- 'limit' - Set a numeric limit for the search results
 	 * 	- 'offset' - Set the offset for the limited search results
 	 * 	- 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed
-	 * 	- 'fullmatch' - (since 23.0.0) Whether matching on full detail in system addresss book is allowed
+	 * 	- 'fullmatch' - (since 23.0.0) Whether matching on full detail in system address book is allowed
 	 * 	- 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search
 	 * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
 	 * @return array an array of contacts which are arrays of key-value-pairs
diff --git a/lib/public/DB/Exception.php b/lib/public/DB/Exception.php
@@ -110,7 +110,7 @@ class Exception extends BaseException {
 	public const REASON_NON_UNIQUE_FIELD_NAME = 10;
 
 	/**
-	 * A not null contraint was violated
+	 * A not null constraint was violated
 	 *
 	 * @since 21.0.0
 	 */
diff --git a/lib/public/DB/QueryBuilder/IQueryBuilder.php b/lib/public/DB/QueryBuilder/IQueryBuilder.php
@@ -620,7 +620,7 @@ public function set($key, $value);
 	 *         ->from('users', 'u')
 	 *         ->where('u.id = ?');
 	 *
-	 *     // You can optionally programatically build and/or expressions
+	 *     // You can optionally programmatically build and/or expressions
 	 *     $qb = $conn->getQueryBuilder();
 	 *
 	 *     $or = $qb->expr()->orx();
diff --git a/lib/public/DirectEditing/IEditor.php b/lib/public/DirectEditing/IEditor.php
@@ -87,7 +87,7 @@ public function isSecure(): bool;
 	 * Return a template response for displaying the editor
 	 *
 	 * open can only be called once when the client requests the editor with a one-time-use token
-	 * For handling editing and later requests, editors need to impelement their own token handling and take care of invalidation
+	 * For handling editing and later requests, editors need to implement their own token handling and take care of invalidation
 	 *
 	 * This behavior is similar to the current direct editing implementation in collabora where we generate a one-time token and switch over to the regular wopi token for the actual editing/saving process
 	 *
diff --git a/lib/public/Files.php b/lib/public/Files.php
@@ -37,13 +37,13 @@
 
 /**
  * This class provides access to the internal filesystem abstraction layer. Use
- * this class exlusively if you want to access files
+ * this class exclusively if you want to access files
  * @since 5.0.0
  * @deprecated 14.0.0
  */
 class Files {
 	/**
-	 * Recusive deletion of folders
+	 * Recursive deletion of folders
 	 * @return bool
 	 * @since 5.0.0
 	 * @deprecated 14.0.0
diff --git a/lib/public/Files/Cache/ICache.php b/lib/public/Files/Cache/ICache.php
@@ -28,7 +28,7 @@
 /**
  * Metadata cache for a storage
  *
- * The cache stores the metadata for all files and folders in a storage and is kept up to date trough the following mechanisms:
+ * The cache stores the metadata for all files and folders in a storage and is kept up to date through the following mechanisms:
  *
  * - Scanner: scans the storage and updates the cache where needed
  * - Watcher: checks for changes made to the filesystem outside of the Nextcloud instance and rescans files and folder when a change is detected
diff --git a/lib/public/FullTextSearch/Model/ISearchResult.php b/lib/public/FullTextSearch/Model/ISearchResult.php
@@ -38,7 +38,7 @@
  * search and fill the SearchResult object with results.
  *
  * Then, the object will be passed to the targeted Content Provider that will
- * improve the Search Results with detailed informations.
+ * improve the Search Results with detailed information.
  *
  * Finally, the SearchResult is returned to the original search request.
  *
diff --git a/lib/public/HintException.php b/lib/public/HintException.php
@@ -67,7 +67,7 @@ public function __toString(): string {
 
 	/**
 	 * Returns the hint with the intention to be presented to the end user. If
-	 * an empty hint was specified upon instatiation, the message is returned
+	 * an empty hint was specified upon instantiation, the message is returned
 	 * instead.
 	 *
 	 * @since 23.0.0
diff --git a/lib/public/LDAP/ILDAPProvider.php b/lib/public/LDAP/ILDAPProvider.php
@@ -151,7 +151,7 @@ public function getLDAPDisplayNameField($uid);
 	public function getLDAPEmailField($uid);
 
 	/**
-	 * Get the LDAP attribute name for the type of association betweeen users and groups
+	 * Get the LDAP attribute name for the type of association between users and groups
 	 * @param string $gid group id
 	 * @return string the configuration, one of: 'memberUid', 'uniqueMember', 'member', 'gidNumber', ''
 	 * @throws \Exception if group id was not found in LDAP
diff --git a/lib/public/Share_Backend.php b/lib/public/Share_Backend.php
@@ -82,7 +82,7 @@ public function generateTarget($itemSource, $shareWith, $exclude = null);
 	public function formatItems($items, $format, $parameters = null);
 
 	/**
-	 * Check if a given share type is allowd by the back-end
+	 * Check if a given share type is allowed by the back-end
 	 *
 	 * @param int $shareType share type
 	 * @return boolean
diff --git a/lib/public/User/Events/UserLoggedInWithCookieEvent.php b/lib/public/User/Events/UserLoggedInWithCookieEvent.php
@@ -30,7 +30,7 @@
 use OCP\IUser;
 
 /**
- * Emitted when a user has been succesfully logged in via remember-me cookies.
+ * Emitted when a user has been successfully logged in via remember-me cookies.
  *
  * @since 18.0.0
  */
diff --git a/lib/public/Util.php b/lib/public/Util.php
@@ -576,13 +576,13 @@ public static function needUpgrade() {
 	 * Sometimes a string has to be shortened to fit within a certain maximum
 	 * data length in bytes. substr() you may break multibyte characters,
 	 * because it operates on single byte level. mb_substr() operates on
-	 * characters, so does not ensure that the shortend string satisfies the
+	 * characters, so does not ensure that the shortened string satisfies the
 	 * max length in bytes.
 	 *
 	 * For example, json_encode is messing with multibyte characters a lot,
 	 * replacing them with something along "\u1234".
 	 *
-	 * This function shortens the string with by $accurancy (-5) from
+	 * This function shortens the string with by $accuracy (-5) from
 	 * $dataLength characters, until it fits within $dataLength bytes.
 	 *
 	 * @since 23.0.0
diff --git a/lib/public/WorkflowEngine/IEntityEvent.php b/lib/public/WorkflowEngine/IEntityEvent.php
@@ -28,7 +28,7 @@
 /**
  * Interface IEntityEvent
  *
- * represents an entitiy event that is dispatched via EventDispatcher
+ * represents an entity event that is dispatched via EventDispatcher
  *
  *
  * @since 18.0.0

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public function getAllProperties(): Generator;`
`134`	`134`	`public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount;`
`135`	`135`
`136`	`136`	`/**`
`137`		`- * Returns the requestes propery collection (multi-value properties)`
	`137`	`+ * Returns the requested property collection (multi-value properties)`
`138`	`138`	`*`
`139`	`139`	`* @throws PropertyDoesNotExistException against invalid collection name`
`140`	`140`	`* @since 22.0.0`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`*/`
`39`	`39`	`interface IAccountPropertyCollection extends JsonSerializable {`
`40`	`40`	`/**`
`41`		`- * retuns the collection name`
	`41`	`+ * returns the collection name`
`42`	`42`	`*`
`43`	`43`	`* @since 22.0.0`
`44`	`44`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`*`
`37`	`37`	`* Use this for example for a controller that is not to be called via a webbrowser`
`38`	`38`	`* directly. For example a PublicPreviewController. As this is not meant to be`
`39`		`- * called by a user direclty.`
	`39`	`+ * called by a user directly.`
`40`	`40`	`*`
`41`	`41`	`* To show an auth page extend the AuthPublicShareController`
`42`	`42`	`*`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ interface IJobList {`
`52`	`52`	`* Add a job to the list`
`53`	`53`	`*`
`54`	`54`	`* @param IJob\|class-string<IJob> $job`
`55`		`- * @param mixed $argument The argument to be passed to $job->run() when the job is exectured`
	`55`	`+ * @param mixed $argument The argument to be passed to $job->run() when the job is executed`
`56`	`56`	`* @since 7.0.0`
`57`	`57`	`*/`
`58`	`58`	`public function add($job, $argument = null): void;`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ class Exception extends BaseException {`
`110`	`110`	`public const REASON_NON_UNIQUE_FIELD_NAME = 10;`
`111`	`111`
`112`	`112`	`/**`
`113`		`- * A not null contraint was violated`
	`113`	`+ * A not null constraint was violated`
`114`	`114`	`*`
`115`	`115`	`* @since 21.0.0`
`116`	`116`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -620,7 +620,7 @@ public function set($key, $value);`
`620`	`620`	`* ->from('users', 'u')`
`621`	`621`	`* ->where('u.id = ?');`
`622`	`622`	`*`
`623`		`- * // You can optionally programatically build and/or expressions`
	`623`	`+ * // You can optionally programmatically build and/or expressions`
`624`	`624`	`* $qb = $conn->getQueryBuilder();`
`625`	`625`	`*`
`626`	`626`	`* $or = $qb->expr()->orx();`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public function isSecure(): bool;`
`87`	`87`	`* Return a template response for displaying the editor`
`88`	`88`	`*`
`89`	`89`	`* open can only be called once when the client requests the editor with a one-time-use token`
`90`		`- * For handling editing and later requests, editors need to impelement their own token handling and take care of invalidation`
	`90`	`+ * For handling editing and later requests, editors need to implement their own token handling and take care of invalidation`
`91`	`91`	`*`
`92`	`92`	`* This behavior is similar to the current direct editing implementation in collabora where we generate a one-time token and switch over to the regular wopi token for the actual editing/saving process`
`93`	`93`	`*`