nextcloud / server

lib/public/share/ishareprovider.php

Indentation +104 added lines, -104 removed lines

@@ -35,118 +35,118 @@
  */
 interface IShareProvider {
 
-	/**
-	 * Return the identifier of this provider.
-	 *
-	 * @return string Containing only [a-zA-Z0-9]
-	 * @since 9.0.0
-	 */
-	public function identifier();
+    /**
+     * Return the identifier of this provider.
+     *
+     * @return string Containing only [a-zA-Z0-9]
+     * @since 9.0.0
+     */
+    public function identifier();
 
-	/**
-	 * Create a share
-	 * 
-	 * @param \OCP\Share\IShare $share
-	 * @return \OCP\Share\IShare The share object
-	 * @since 9.0.0
-	 */
-	public function create(\OCP\Share\IShare $share);
+    /**
+     * Create a share
+     * 
+     * @param \OCP\Share\IShare $share
+     * @return \OCP\Share\IShare The share object
+     * @since 9.0.0
+     */
+    public function create(\OCP\Share\IShare $share);
 
-	/**
-	 * Update a share
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @return \OCP\Share\IShare The share object
-	 * @since 9.0.0
-	 */
-	public function update(\OCP\Share\IShare $share);
+    /**
+     * Update a share
+     *
+     * @param \OCP\Share\IShare $share
+     * @return \OCP\Share\IShare The share object
+     * @since 9.0.0
+     */
+    public function update(\OCP\Share\IShare $share);
 
-	/**
-	 * Delete a share
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @since 9.0.0
-	 */
-	public function delete(\OCP\Share\IShare $share);
+    /**
+     * Delete a share
+     *
+     * @param \OCP\Share\IShare $share
+     * @since 9.0.0
+     */
+    public function delete(\OCP\Share\IShare $share);
 
-	/**
-	 * Unshare a file from self as recipient.
-	 * This may require special handling. If a user unshares a group
-	 * share from their self then the original group share should still exist.
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @param string $recipient UserId of the recipient
-	 * @since 9.0.0
-	 */
-	public function deleteFromSelf(\OCP\Share\IShare $share, $recipient);
+    /**
+     * Unshare a file from self as recipient.
+     * This may require special handling. If a user unshares a group
+     * share from their self then the original group share should still exist.
+     *
+     * @param \OCP\Share\IShare $share
+     * @param string $recipient UserId of the recipient
+     * @since 9.0.0
+     */
+    public function deleteFromSelf(\OCP\Share\IShare $share, $recipient);
 
-	/**
-	 * Move a share as a recipient.
-	 * This is updating the share target. Thus the mount point of the recipient.
-	 * This may require special handling. If a user moves a group share
-	 * the target should only be changed for them.
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @param string $recipient userId of recipient
-	 * @return \OCP\Share\IShare
-	 * @since 9.0.0
-	 */
-	public function move(\OCP\Share\IShare $share, $recipient);
+    /**
+     * Move a share as a recipient.
+     * This is updating the share target. Thus the mount point of the recipient.
+     * This may require special handling. If a user moves a group share
+     * the target should only be changed for them.
+     *
+     * @param \OCP\Share\IShare $share
+     * @param string $recipient userId of recipient
+     * @return \OCP\Share\IShare
+     * @since 9.0.0
+     */
+    public function move(\OCP\Share\IShare $share, $recipient);
 
-	/**
-	 * Get all shares by the given user
-	 *
-	 * @param string $userId
-	 * @param int $shareType
-	 * @param \OCP\Files\File|\OCP\Files\Folder $node
-	 * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
-	 * @param int $limit The maximum number of shares to be returned, -1 for all shares
-	 * @param int $offset
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset);
+    /**
+     * Get all shares by the given user
+     *
+     * @param string $userId
+     * @param int $shareType
+     * @param \OCP\Files\File|\OCP\Files\Folder $node
+     * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
+     * @param int $limit The maximum number of shares to be returned, -1 for all shares
+     * @param int $offset
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset);
 
-	/**
-	 * Get share by id
-	 *
-	 * @param int $id
-	 * @param string|null $recipientId
-	 * @return \OCP\Share\IShare
-	 * @throws ShareNotFound
-	 * @since 9.0.0
-	 */
-	public function getShareById($id, $recipientId = null);
+    /**
+     * Get share by id
+     *
+     * @param int $id
+     * @param string|null $recipientId
+     * @return \OCP\Share\IShare
+     * @throws ShareNotFound
+     * @since 9.0.0
+     */
+    public function getShareById($id, $recipientId = null);
 
-	/**
-	 * Get shares for a given path
-	 *
-	 * @param \OCP\Files\Node $path
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharesByPath(\OCP\Files\Node $path);
+    /**
+     * Get shares for a given path
+     *
+     * @param \OCP\Files\Node $path
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharesByPath(\OCP\Files\Node $path);
 
-	/**
-	 * Get shared with the given user
-	 *
-	 * @param string $userId get shares where this user is the recipient
-	 * @param int $shareType
-	 * @param Node|null $node
-	 * @param int $limit The max number of entries returned, -1 for all
-	 * @param int $offset
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharedWith($userId, $shareType, $node, $limit, $offset);
+    /**
+     * Get shared with the given user
+     *
+     * @param string $userId get shares where this user is the recipient
+     * @param int $shareType
+     * @param Node|null $node
+     * @param int $limit The max number of entries returned, -1 for all
+     * @param int $offset
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharedWith($userId, $shareType, $node, $limit, $offset);
 
-	/**
-	 * Get a share by token
-	 *
-	 * @param string $token
-	 * @return \OCP\Share\IShare
-	 * @throws ShareNotFound
-	 * @since 9.0.0
-	 */
-	public function getShareByToken($token);
+    /**
+     * Get a share by token
+     *
+     * @param string $token
+     * @return \OCP\Share\IShare
+     * @throws ShareNotFound
+     * @since 9.0.0
+     */
+    public function getShareByToken($token);
 }

lib/public/ipreview.php

Indentation +49 added lines, -49 removed lines

@@ -38,59 +38,59 @@
  * @since 6.0.0
  */
 interface IPreview {
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be
-	 * called in case preview providers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Preview\IProvider
-	 *
-	 * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 8.1.0
-	 */
-	public function registerProvider($mimeTypeRegex, \Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be
+     * called in case preview providers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Preview\IProvider
+     *
+     * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
+     * @param \Closure $callable
+     * @return void
+     * @since 8.1.0
+     */
+    public function registerProvider($mimeTypeRegex, \Closure $callable);
 
-	/**
-	 * Get all providers
-	 * @return array
-	 * @since 8.1.0
-	 */
-	public function getProviders();
+    /**
+     * Get all providers
+     * @return array
+     * @since 8.1.0
+     */
+    public function getProviders();
 
-	/**
-	 * Does the manager have any providers
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function hasProviders();
+    /**
+     * Does the manager have any providers
+     * @return bool
+     * @since 8.1.0
+     */
+    public function hasProviders();
 
-	/**
-	 * Return a preview of a file
-	 * @param string $file The path to the file where you want a thumbnail from
-	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
-	 * @return \OCP\IImage
-	 * @since 6.0.0
-	 */
-	public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false);
+    /**
+     * Return a preview of a file
+     * @param string $file The path to the file where you want a thumbnail from
+     * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
+     * @return \OCP\IImage
+     * @since 6.0.0
+     */
+    public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false);
 
 
-	/**
-	 * Returns true if the passed mime type is supported
-	 * @param string $mimeType
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function isMimeSupported($mimeType = '*');
+    /**
+     * Returns true if the passed mime type is supported
+     * @param string $mimeType
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function isMimeSupported($mimeType = '*');
 
-	/**
-	 * Check if a preview can be generated for a file
-	 *
-	 * @param \OCP\Files\FileInfo $file
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file);
+    /**
+     * Check if a preview can be generated for a file
+     *
+     * @param \OCP\Files\FileInfo $file
+     * @return bool
+     * @since 8.0.0
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file);
 }

lib/public/share_backend.php

Indentation +57 added lines, -57 removed lines

@@ -33,65 +33,65 @@
  */
 interface Share_Backend {
 
-	/**
-	 * Check if this $itemSource exist for the user
-	 * @param string $itemSource
-	 * @param string $uidOwner Owner of the item
-	 * @return boolean|null Source
-	 *
-	 * Return false if the item does not exist for the user
-	 * @since 5.0.0
-	 */
-	public function isValidSource($itemSource, $uidOwner);
+    /**
+     * Check if this $itemSource exist for the user
+     * @param string $itemSource
+     * @param string $uidOwner Owner of the item
+     * @return boolean|null Source
+     *
+     * Return false if the item does not exist for the user
+     * @since 5.0.0
+     */
+    public function isValidSource($itemSource, $uidOwner);
 
-	/**
-	 * Get a unique name of the item for the specified user
-	 * @param string $itemSource
-	 * @param string|false $shareWith User the item is being shared with
-	 * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
-	 * @return string Target name
-	 *
-	 * This function needs to verify that the user does not already have an item with this name.
-	 * If it does generate a new name e.g. name_#
-	 * @since 5.0.0
-	 */
-	public function generateTarget($itemSource, $shareWith, $exclude = null);
+    /**
+     * Get a unique name of the item for the specified user
+     * @param string $itemSource
+     * @param string|false $shareWith User the item is being shared with
+     * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
+     * @return string Target name
+     *
+     * This function needs to verify that the user does not already have an item with this name.
+     * If it does generate a new name e.g. name_#
+     * @since 5.0.0
+     */
+    public function generateTarget($itemSource, $shareWith, $exclude = null);
 
-	/**
-	 * Converts the shared item sources back into the item in the specified format
-	 * @param array $items Shared items
-	 * @param int $format
-	 * @return array
-	 *
-	 * The items array is a 3-dimensional array with the item_source as the
-	 * first key and the share id as the second key to an array with the share
-	 * info.
-	 *
-	 * The key/value pairs included in the share info depend on the function originally called:
-	 * If called by getItem(s)Shared: id, item_type, item, item_source,
-	 * share_type, share_with, permissions, stime, file_source
-	 *
-	 * If called by getItem(s)SharedWith: id, item_type, item, item_source,
-	 * item_target, share_type, share_with, permissions, stime, file_source,
-	 * file_target
-	 *
-	 * This function allows the backend to control the output of shared items with custom formats.
-	 * It is only called through calls to the public getItem(s)Shared(With) functions.
-	 * @since 5.0.0
-	 */
-	public function formatItems($items, $format, $parameters = null);
+    /**
+     * Converts the shared item sources back into the item in the specified format
+     * @param array $items Shared items
+     * @param int $format
+     * @return array
+     *
+     * The items array is a 3-dimensional array with the item_source as the
+     * first key and the share id as the second key to an array with the share
+     * info.
+     *
+     * The key/value pairs included in the share info depend on the function originally called:
+     * If called by getItem(s)Shared: id, item_type, item, item_source,
+     * share_type, share_with, permissions, stime, file_source
+     *
+     * If called by getItem(s)SharedWith: id, item_type, item, item_source,
+     * item_target, share_type, share_with, permissions, stime, file_source,
+     * file_target
+     *
+     * This function allows the backend to control the output of shared items with custom formats.
+     * It is only called through calls to the public getItem(s)Shared(With) functions.
+     * @since 5.0.0
+     */
+    public function formatItems($items, $format, $parameters = null);
 
-	/**
-	 * Check if a given share type is allowd by the back-end
-	 *
-	 * @param int $shareType share type
-	 * @return boolean
-	 *
-	 * The back-end can enable/disable specific share types. Just return true if
-	 * the back-end doesn't provide any specific settings for it and want to allow
-	 * all share types defined by the share API
-	 * @since 8.0.0
-	 */
-	public function isShareTypeAllowed($shareType);
+    /**
+     * Check if a given share type is allowd by the back-end
+     *
+     * @param int $shareType share type
+     * @return boolean
+     *
+     * The back-end can enable/disable specific share types. Just return true if
+     * the back-end doesn't provide any specific settings for it and want to allow
+     * all share types defined by the share API
+     * @since 8.0.0
+     */
+    public function isShareTypeAllowed($shareType);
 
 }

lib/public/iuser.php

Indentation +166 added lines, -166 removed lines

@@ -33,170 +33,170 @@
  * @since 8.0.0
  */
 interface IUser {
-	/**
-	 * get the user id
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getUID();
-
-	/**
-	 * get the display name for the user, if no specific display name is set it will fallback to the user id
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getDisplayName();
-
-	/**
-	 * set the display name for the user
-	 *
-	 * @param string $displayName
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function setDisplayName($displayName);
-
-	/**
-	 * returns the timestamp of the user's last login or 0 if the user did never
-	 * login
-	 *
-	 * @return int
-	 * @since 8.0.0
-	 */
-	public function getLastLogin();
-
-	/**
-	 * updates the timestamp of the most recent login of this user
-	 * @since 8.0.0
-	 */
-	public function updateLastLoginTimestamp();
-
-	/**
-	 * Delete the user
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function delete();
-
-	/**
-	 * Set the password of the user
-	 *
-	 * @param string $password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function setPassword($password, $recoveryPassword = null);
-
-	/**
-	 * get the users home folder to mount
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getHome();
-
-	/**
-	 * Get the name of the backend class the user is connected with
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getBackendClassName();
-
-	/**
-	 * check if the backend allows the user to change his avatar on Personal page
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangeAvatar();
-
-	/**
-	 * check if the backend supports changing passwords
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangePassword();
-
-	/**
-	 * check if the backend supports changing display names
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangeDisplayName();
-
-	/**
-	 * check if the user is enabled
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function isEnabled();
-
-	/**
-	 * set the enabled status for the user
-	 *
-	 * @param bool $enabled
-	 * @since 8.0.0
-	 */
-	public function setEnabled($enabled);
-
-	/**
-	 * get the users email address
-	 *
-	 * @return string|null
-	 * @since 9.0.0
-	 */
-	public function getEMailAddress();
-
-	/**
-	 * get the avatar image if it exists
-	 *
-	 * @param int $size
-	 * @return IImage|null
-	 * @since 9.0.0
-	 */
-	public function getAvatarImage($size);
-
-	/**
-	 * get the federation cloud id
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getCloudId();
-
-	/**
-	 * set the email address of the user
-	 *
-	 * @param string|null $mailAddress
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setEMailAddress($mailAddress);
-
-	/**
-	 * get the users' quota in human readable form. If a specific quota is not
-	 * set for the user, the default value is returned. If a default setting
-	 * was not set otherwise, it is return as 'none', i.e. quota is not limited.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getQuota();
-
-	/**
-	 * set the users' quota
-	 *
-	 * @param string $quota
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setQuota($quota);
+    /**
+     * get the user id
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getUID();
+
+    /**
+     * get the display name for the user, if no specific display name is set it will fallback to the user id
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getDisplayName();
+
+    /**
+     * set the display name for the user
+     *
+     * @param string $displayName
+     * @return bool
+     * @since 8.0.0
+     */
+    public function setDisplayName($displayName);
+
+    /**
+     * returns the timestamp of the user's last login or 0 if the user did never
+     * login
+     *
+     * @return int
+     * @since 8.0.0
+     */
+    public function getLastLogin();
+
+    /**
+     * updates the timestamp of the most recent login of this user
+     * @since 8.0.0
+     */
+    public function updateLastLoginTimestamp();
+
+    /**
+     * Delete the user
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function delete();
+
+    /**
+     * Set the password of the user
+     *
+     * @param string $password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     * @since 8.0.0
+     */
+    public function setPassword($password, $recoveryPassword = null);
+
+    /**
+     * get the users home folder to mount
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getHome();
+
+    /**
+     * Get the name of the backend class the user is connected with
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getBackendClassName();
+
+    /**
+     * check if the backend allows the user to change his avatar on Personal page
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangeAvatar();
+
+    /**
+     * check if the backend supports changing passwords
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangePassword();
+
+    /**
+     * check if the backend supports changing display names
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangeDisplayName();
+
+    /**
+     * check if the user is enabled
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function isEnabled();
+
+    /**
+     * set the enabled status for the user
+     *
+     * @param bool $enabled
+     * @since 8.0.0
+     */
+    public function setEnabled($enabled);
+
+    /**
+     * get the users email address
+     *
+     * @return string|null
+     * @since 9.0.0
+     */
+    public function getEMailAddress();
+
+    /**
+     * get the avatar image if it exists
+     *
+     * @param int $size
+     * @return IImage|null
+     * @since 9.0.0
+     */
+    public function getAvatarImage($size);
+
+    /**
+     * get the federation cloud id
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getCloudId();
+
+    /**
+     * set the email address of the user
+     *
+     * @param string|null $mailAddress
+     * @return void
+     * @since 9.0.0
+     */
+    public function setEMailAddress($mailAddress);
+
+    /**
+     * get the users' quota in human readable form. If a specific quota is not
+     * set for the user, the default value is returned. If a default setting
+     * was not set otherwise, it is return as 'none', i.e. quota is not limited.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getQuota();
+
+    /**
+     * set the users' quota
+     *
+     * @param string $quota
+     * @return void
+     * @since 9.0.0
+     */
+    public function setQuota($quota);
 }

lib/public/security/icontentsecuritypolicymanager.php

Indentation +18 added lines, -18 removed lines

@@ -30,22 +30,22 @@
  * @since 9.0.0
  */
 interface IContentSecurityPolicyManager {
-	/**
-	 * Allows to inject something into the default content policy. This is for
-	 * example useful when you're injecting Javascript code into a view belonging
-	 * to another controller and cannot modify its Content-Security-Policy itself.
-	 * Note that the adjustment is only applied to applications that use AppFramework
-	 * controllers.
-	 *
-	 * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
-	 * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
-	 *
-	 * WARNING: Using this API incorrectly may make the instance more insecure.
-	 * Do think twice before adding whitelisting resources. Please do also note
-	 * that it is not possible to use the `disallowXYZ` functions.
-	 *
-	 * @param EmptyContentSecurityPolicy $policy
-	 * @since 9.0.0
-	 */
-	public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
+    /**
+     * Allows to inject something into the default content policy. This is for
+     * example useful when you're injecting Javascript code into a view belonging
+     * to another controller and cannot modify its Content-Security-Policy itself.
+     * Note that the adjustment is only applied to applications that use AppFramework
+     * controllers.
+     *
+     * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
+     * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
+     *
+     * WARNING: Using this API incorrectly may make the instance more insecure.
+     * Do think twice before adding whitelisting resources. Please do also note
+     * that it is not possible to use the `disallowXYZ` functions.
+     *
+     * @param EmptyContentSecurityPolicy $policy
+     * @since 9.0.0
+     */
+    public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
 }

lib/public/security/ihasher.php

Indentation +18 added lines, -18 removed lines

@@ -44,23 +44,23 @@
  * @since 8.0.0
  */
 interface IHasher {
-	/**
-	 * Hashes a message using PHP's `password_hash` functionality.
-	 * Please note that the size of the returned string is not guaranteed
-	 * and can be up to 255 characters.
-	 *
-	 * @param string $message Message to generate hash from
-	 * @return string Hash of the message with appended version parameter
-	 * @since 8.0.0
-	 */
-	public function hash($message);
+    /**
+     * Hashes a message using PHP's `password_hash` functionality.
+     * Please note that the size of the returned string is not guaranteed
+     * and can be up to 255 characters.
+     *
+     * @param string $message Message to generate hash from
+     * @return string Hash of the message with appended version parameter
+     * @since 8.0.0
+     */
+    public function hash($message);
 
-	/**
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
-	 * @return bool Whether $hash is a valid hash of $message
-	 * @since 8.0.0
-	 */
-	public function verify($message, $hash, &$newHash = null);
+    /**
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
+     * @return bool Whether $hash is a valid hash of $message
+     * @since 8.0.0
+     */
+    public function verify($message, $hash, &$newHash = null);
 }

lib/public/security/icrypto.php

Indentation +24 added lines, -24 removed lines

@@ -36,30 +36,30 @@
  */
 interface ICrypto {
 
-	/**
-	 * @param string $message The message to authenticate
-	 * @param string $password Password to use (defaults to `secret` in config.php)
-	 * @return string Calculated HMAC
-	 * @since 8.0.0
-	 */
-	public function calculateHMAC($message, $password = '');
+    /**
+     * @param string $message The message to authenticate
+     * @param string $password Password to use (defaults to `secret` in config.php)
+     * @return string Calculated HMAC
+     * @since 8.0.0
+     */
+    public function calculateHMAC($message, $password = '');
 
-	/**
-	 * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
-	 * @param string $plaintext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string Authenticated ciphertext
-	 * @since 8.0.0
-	 */
-	public function encrypt($plaintext, $password = '');
+    /**
+     * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
+     * @param string $plaintext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string Authenticated ciphertext
+     * @since 8.0.0
+     */
+    public function encrypt($plaintext, $password = '');
 
-	/**
-	 * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
-	 * @param string $authenticatedCiphertext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string plaintext
-	 * @throws \Exception If the HMAC does not match
-	 * @since 8.0.0
-	 */
-	public function decrypt($authenticatedCiphertext, $password = '');
+    /**
+     * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
+     * @param string $authenticatedCiphertext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string plaintext
+     * @throws \Exception If the HMAC does not match
+     * @since 8.0.0
+     */
+    public function decrypt($authenticatedCiphertext, $password = '');
 }

lib/public/security/stringutils.php

Indentation +14 added lines, -14 removed lines

@@ -31,18 +31,18 @@
  * @since 8.0.0
  */
 class StringUtils {
-	/**
-	 * Compares whether two strings are equal. To prevent guessing of the string
-	 * length this is done by comparing two hashes against each other and afterwards
-	 * a comparison of the real string to prevent against the unlikely chance of
-	 * collisions.
-	 * @param string $expected The expected value
-	 * @param string $input The input to compare against
-	 * @return bool True if the two strings are equal, otherwise false.
-	 * @since 8.0.0
-	 * @deprecated 9.0.0 Use hash_equals
-	 */
-	public static function equals($expected, $input) {
-		return hash_equals($expected, $input);
-	}
+    /**
+     * Compares whether two strings are equal. To prevent guessing of the string
+     * length this is done by comparing two hashes against each other and afterwards
+     * a comparison of the real string to prevent against the unlikely chance of
+     * collisions.
+     * @param string $expected The expected value
+     * @param string $input The input to compare against
+     * @return bool True if the two strings are equal, otherwise false.
+     * @since 8.0.0
+     * @deprecated 9.0.0 Use hash_equals
+     */
+    public static function equals($expected, $input) {
+        return hash_equals($expected, $input);
+    }
 }

lib/public/security/icredentialsmanager.php

Indentation +35 added lines, -35 removed lines

@@ -30,43 +30,43 @@
  */
 interface ICredentialsManager {
 
-	/**
-	 * Store a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @param mixed $credentials
-	 * @since 8.2.0
-	 */
-	public function store($userId, $identifier, $credentials);
+    /**
+     * Store a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @param mixed $credentials
+     * @since 8.2.0
+     */
+    public function store($userId, $identifier, $credentials);
 
-	/**
-	 * Retrieve a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function retrieve($userId, $identifier);
+    /**
+     * Retrieve a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function retrieve($userId, $identifier);
 
-	/**
-	 * Delete a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function delete($userId, $identifier);
+    /**
+     * Delete a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function delete($userId, $identifier);
 
-	/**
-	 * Erase all credentials stored for a user
-	 *
-	 * @param string $userId
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function erase($userId);
+    /**
+     * Erase all credentials stored for a user
+     *
+     * @param string $userId
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function erase($userId);
 
 }