nextcloud / server

lib/public/LDAP/ILDAPProvider.php

Indentation +139 added lines, -139 removed lines

@@ -35,143 +35,143 @@
  * @since 11.0.0
  */
 interface ILDAPProvider {
-	/**
-	 * Translate a user id to LDAP DN.
-	 * @param string $uid user id
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getUserDN($uid);
-
-	/**
-	 * Translate a group id to LDAP DN.
-	 * @param string $gid group id
-	 * @return string
-	 * @since 13.0.0
-	 */
-	public function getGroupDN($gid);
-
-	/**
-	 * Translate a LDAP DN to an internal user name.
-	 * @param string $dn LDAP DN
-	 * @return string with the internal user name
-	 * @throws \Exception if translation was unsuccessful
-	 * @since 11.0.0
-	 */
-	public function getUserName($dn);
-
-	/**
-	 * Convert a stored DN so it can be used as base parameter for LDAP queries.
-	 * @param string $dn the DN
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function DNasBaseParameter($dn);
-
-	/**
-	 * Sanitize a DN received from the LDAP server.
-	 * @param array $dn the DN in question
-	 * @return array the sanitized DN
-	 * @since 11.0.0
-	 */
-	public function sanitizeDN($dn);
-
-	/**
-	 * Return a new LDAP connection resource for the specified user.
-	 * @param string $uid user id
-	 * @return \LDAP\Connection|resource
-	 * @since 11.0.0
-	 */
-	public function getLDAPConnection($uid);
-
-	/**
-	 * Return a new LDAP connection resource for the specified group.
-	 * @param string $gid group id
-	 * @return \LDAP\Connection|resource
-	 * @since 13.0.0
-	 */
-	public function getGroupLDAPConnection($gid);
-
-	/**
-	 * Get the LDAP base for users.
-	 * @param string $uid user id
-	 * @return string the base for users
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 11.0.0
-	 */
-	public function getLDAPBaseUsers($uid);
-
-	/**
-	 * Get the LDAP base for groups.
-	 * @param string $uid user id
-	 * @return string the base for groups
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 11.0.0
-	 */
-	public function getLDAPBaseGroups($uid);
-
-	/**
-	 * Check whether a LDAP DN exists
-	 * @param string $dn LDAP DN
-	 * @return bool whether the DN exists
-	 * @since 11.0.0
-	 */
-	public function dnExists($dn);
-
-	/**
-	 * Clear the cache if a cache is used, otherwise do nothing.
-	 * @param string $uid user id
-	 * @since 11.0.0
-	 */
-	public function clearCache($uid);
-
-	/**
-	 * Clear the cache if a cache is used, otherwise do nothing.
-	 * @param string $gid group id
-	 * @since 13.0.0
-	 */
-	public function clearGroupCache($gid);
-
-	/**
-	 * Get the LDAP attribute name for the user's display name
-	 * @param string $uid user id
-	 * @return string the display name field
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 12.0.0
-	 */
-	public function getLDAPDisplayNameField($uid);
-
-	/**
-	 * Get the LDAP attribute name for the email
-	 * @param string $uid user id
-	 * @return string the email field
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 12.0.0
-	 */
-	public function getLDAPEmailField($uid);
-
-	/**
-	 * 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
-	 * @since 13.0.0
-	 */
-	public function getLDAPGroupMemberAssoc($gid);
-
-	/**
-	 * Get an LDAP attribute for a nextcloud user
-	 *
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 21.0.0
-	 */
-	public function getUserAttribute(string $uid, string $attribute): ?string;
-
-	/**
-	 * Get a multi-value LDAP attribute for a nextcloud user
-	 *
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 22.0.0
-	 */
-	public function getMultiValueUserAttribute(string $uid, string $attribute): array;
+    /**
+     * Translate a user id to LDAP DN.
+     * @param string $uid user id
+     * @return string
+     * @since 11.0.0
+     */
+    public function getUserDN($uid);
+
+    /**
+     * Translate a group id to LDAP DN.
+     * @param string $gid group id
+     * @return string
+     * @since 13.0.0
+     */
+    public function getGroupDN($gid);
+
+    /**
+     * Translate a LDAP DN to an internal user name.
+     * @param string $dn LDAP DN
+     * @return string with the internal user name
+     * @throws \Exception if translation was unsuccessful
+     * @since 11.0.0
+     */
+    public function getUserName($dn);
+
+    /**
+     * Convert a stored DN so it can be used as base parameter for LDAP queries.
+     * @param string $dn the DN
+     * @return string
+     * @since 11.0.0
+     */
+    public function DNasBaseParameter($dn);
+
+    /**
+     * Sanitize a DN received from the LDAP server.
+     * @param array $dn the DN in question
+     * @return array the sanitized DN
+     * @since 11.0.0
+     */
+    public function sanitizeDN($dn);
+
+    /**
+     * Return a new LDAP connection resource for the specified user.
+     * @param string $uid user id
+     * @return \LDAP\Connection|resource
+     * @since 11.0.0
+     */
+    public function getLDAPConnection($uid);
+
+    /**
+     * Return a new LDAP connection resource for the specified group.
+     * @param string $gid group id
+     * @return \LDAP\Connection|resource
+     * @since 13.0.0
+     */
+    public function getGroupLDAPConnection($gid);
+
+    /**
+     * Get the LDAP base for users.
+     * @param string $uid user id
+     * @return string the base for users
+     * @throws \Exception if user id was not found in LDAP
+     * @since 11.0.0
+     */
+    public function getLDAPBaseUsers($uid);
+
+    /**
+     * Get the LDAP base for groups.
+     * @param string $uid user id
+     * @return string the base for groups
+     * @throws \Exception if user id was not found in LDAP
+     * @since 11.0.0
+     */
+    public function getLDAPBaseGroups($uid);
+
+    /**
+     * Check whether a LDAP DN exists
+     * @param string $dn LDAP DN
+     * @return bool whether the DN exists
+     * @since 11.0.0
+     */
+    public function dnExists($dn);
+
+    /**
+     * Clear the cache if a cache is used, otherwise do nothing.
+     * @param string $uid user id
+     * @since 11.0.0
+     */
+    public function clearCache($uid);
+
+    /**
+     * Clear the cache if a cache is used, otherwise do nothing.
+     * @param string $gid group id
+     * @since 13.0.0
+     */
+    public function clearGroupCache($gid);
+
+    /**
+     * Get the LDAP attribute name for the user's display name
+     * @param string $uid user id
+     * @return string the display name field
+     * @throws \Exception if user id was not found in LDAP
+     * @since 12.0.0
+     */
+    public function getLDAPDisplayNameField($uid);
+
+    /**
+     * Get the LDAP attribute name for the email
+     * @param string $uid user id
+     * @return string the email field
+     * @throws \Exception if user id was not found in LDAP
+     * @since 12.0.0
+     */
+    public function getLDAPEmailField($uid);
+
+    /**
+     * 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
+     * @since 13.0.0
+     */
+    public function getLDAPGroupMemberAssoc($gid);
+
+    /**
+     * Get an LDAP attribute for a nextcloud user
+     *
+     * @throws \Exception if user id was not found in LDAP
+     * @since 21.0.0
+     */
+    public function getUserAttribute(string $uid, string $attribute): ?string;
+
+    /**
+     * Get a multi-value LDAP attribute for a nextcloud user
+     *
+     * @throws \Exception if user id was not found in LDAP
+     * @since 22.0.0
+     */
+    public function getMultiValueUserAttribute(string $uid, string $attribute): array;
 }

lib/public/BackgroundJob/IJobList.php

Indentation +93 added lines, -93 removed lines

@@ -48,110 +48,110 @@
  * @since 7.0.0
  */
 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 executed
-	 * @since 7.0.0
-	 */
-	public function add($job, $argument = null): void;
+    /**
+     * 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 executed
+     * @since 7.0.0
+     */
+    public function add($job, $argument = null): void;
 
-	/**
-	 * Remove a job from the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function remove($job, $argument = null): void;
+    /**
+     * Remove a job from the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function remove($job, $argument = null): void;
 
-	/**
-	 * check if a job is in the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function has($job, $argument): bool;
+    /**
+     * check if a job is in the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function has($job, $argument): bool;
 
-	/**
-	 * Get jobs matching the search
-	 *
-	 * @param IJob|class-string<IJob>|null $job
-	 * @return array<IJob>
-	 * @since 25.0.0
-	 * @deprecated 26.0.0 Use getJobsIterator instead to avoid duplicated job objects
-	 */
-	public function getJobs($job, ?int $limit, int $offset): array;
+    /**
+     * Get jobs matching the search
+     *
+     * @param IJob|class-string<IJob>|null $job
+     * @return array<IJob>
+     * @since 25.0.0
+     * @deprecated 26.0.0 Use getJobsIterator instead to avoid duplicated job objects
+     */
+    public function getJobs($job, ?int $limit, int $offset): array;
 
-	/**
-	 * Get jobs matching the search
-	 *
-	 * @param IJob|class-string<IJob>|null $job
-	 * @return iterable<IJob>
-	 * @since 26.0.0
-	 */
-	public function getJobsIterator($job, ?int $limit, int $offset): iterable;
+    /**
+     * Get jobs matching the search
+     *
+     * @param IJob|class-string<IJob>|null $job
+     * @return iterable<IJob>
+     * @since 26.0.0
+     */
+    public function getJobsIterator($job, ?int $limit, int $offset): iterable;
 
-	/**
-	 * get the next job in the list
-	 *
-	 * @since 7.0.0 - In 24.0.0 parameter $onlyTimeSensitive got added
-	 */
-	public function getNext(bool $onlyTimeSensitive = false): ?IJob;
+    /**
+     * get the next job in the list
+     *
+     * @since 7.0.0 - In 24.0.0 parameter $onlyTimeSensitive got added
+     */
+    public function getNext(bool $onlyTimeSensitive = false): ?IJob;
 
-	/**
-	 * @since 7.0.0
-	 */
-	public function getById(int $id): ?IJob;
+    /**
+     * @since 7.0.0
+     */
+    public function getById(int $id): ?IJob;
 
-	/**
-	 * @since 23.0.0
-	 */
-	public function getDetailsById(int $id): ?array;
+    /**
+     * @since 23.0.0
+     */
+    public function getDetailsById(int $id): ?array;
 
-	/**
-	 * set the job that was last ran to the current time
-	 *
-	 * @since 7.0.0
-	 */
-	public function setLastJob(IJob $job): void;
+    /**
+     * set the job that was last ran to the current time
+     *
+     * @since 7.0.0
+     */
+    public function setLastJob(IJob $job): void;
 
-	/**
-	 * Remove the reservation for a job
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockJob(IJob $job): void;
+    /**
+     * Remove the reservation for a job
+     *
+     * @since 9.1.0
+     */
+    public function unlockJob(IJob $job): void;
 
-	/**
-	 * set the lastRun of $job to now
-	 *
-	 * @since 7.0.0
-	 */
-	public function setLastRun(IJob $job): void;
+    /**
+     * set the lastRun of $job to now
+     *
+     * @since 7.0.0
+     */
+    public function setLastRun(IJob $job): void;
 
-	/**
-	 * set the run duration of $job
-	 *
-	 * @since 12.0.0
-	 */
-	public function setExecutionTime(IJob $job, int $timeTaken): void;
+    /**
+     * set the run duration of $job
+     *
+     * @since 12.0.0
+     */
+    public function setExecutionTime(IJob $job, int $timeTaken): void;
 
-	/**
-	 * Reset the $job so it executes on the next trigger
-	 *
-	 * @since 23.0.0
-	 */
-	public function resetBackgroundJob(IJob $job): void;
+    /**
+     * Reset the $job so it executes on the next trigger
+     *
+     * @since 23.0.0
+     */
+    public function resetBackgroundJob(IJob $job): void;
 
-	/**
-	 * Checks whether a job of the passed class is reserved to run
-	 *
-	 * @param string|null $className
-	 * @return bool
-	 * @since 27.0.0
-	 */
-	public function hasReservedJob(?string $className): bool;
+    /**
+     * Checks whether a job of the passed class is reserved to run
+     *
+     * @param string|null $className
+     * @return bool
+     * @since 27.0.0
+     */
+    public function hasReservedJob(?string $className): bool;
 }

lib/public/Share_Backend.php

Indentation +57 added lines, -57 removed lines

@@ -33,64 +33,64 @@
  * @since 5.0.0
  */
 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 allowed 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 allowed 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/Contacts/IManager.php

Indentation +119 added lines, -119 removed lines

@@ -48,131 +48,131 @@
  * @since 6.0.0
  */
 interface IManager {
-	/**
-	 * This function is used to search and find contacts within the users address books.
-	 * In case $pattern is empty all contacts will be returned.
-	 *
-	 * Example:
-	 *  Following function shows how to search for contacts for the name and the email address.
-	 *
-	 *		public static function getMatchingRecipient($term) {
-	 *			$cm = \OC::$server->getContactsManager();
-	 *			// The API is not active -> nothing to do
-	 *			if (!$cm->isEnabled()) {
-	 *				return array();
-	 *			}
-	 *
-	 *			$result = $cm->search($term, array('FN', 'EMAIL'));
-	 *			$receivers = array();
-	 *			foreach ($result as $r) {
-	 *				$id = $r['id'];
-	 *				$fn = $r['FN'];
-	 *				$email = $r['EMAIL'];
-	 *				if (!is_array($email)) {
-	 *					$email = array($email);
-	 *				}
-	 *
-	 *				// loop through all email addresses of this contact
-	 *				foreach ($email as $e) {
-	 *				$displayName = $fn . " <$e>";
-	 *				$receivers[] = array(
-	 *					'id'    => $id,
-	 *					'label' => $displayName,
-	 *					'value' => $displayName);
-	 *				}
-	 *			}
-	 *
-	 *			return $receivers;
-	 *		}
-	 *
-	 *
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 *  - 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
-	 *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-	 * 	- '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 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
-	 * @since 6.0.0
-	 */
-	public function search($pattern, $searchProperties = [], $options = []);
+    /**
+     * This function is used to search and find contacts within the users address books.
+     * In case $pattern is empty all contacts will be returned.
+     *
+     * Example:
+     *  Following function shows how to search for contacts for the name and the email address.
+     *
+     *		public static function getMatchingRecipient($term) {
+     *			$cm = \OC::$server->getContactsManager();
+     *			// The API is not active -> nothing to do
+     *			if (!$cm->isEnabled()) {
+     *				return array();
+     *			}
+     *
+     *			$result = $cm->search($term, array('FN', 'EMAIL'));
+     *			$receivers = array();
+     *			foreach ($result as $r) {
+     *				$id = $r['id'];
+     *				$fn = $r['FN'];
+     *				$email = $r['EMAIL'];
+     *				if (!is_array($email)) {
+     *					$email = array($email);
+     *				}
+     *
+     *				// loop through all email addresses of this contact
+     *				foreach ($email as $e) {
+     *				$displayName = $fn . " <$e>";
+     *				$receivers[] = array(
+     *					'id'    => $id,
+     *					'label' => $displayName,
+     *					'value' => $displayName);
+     *				}
+     *			}
+     *
+     *			return $receivers;
+     *		}
+     *
+     *
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     *  - 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
+     *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+     * 	- '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 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
+     * @since 6.0.0
+     */
+    public function search($pattern, $searchProperties = [], $options = []);
 
-	/**
-	 * This function can be used to delete the contact identified by the given id
-	 *
-	 * @param int $id the unique identifier to a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be deleted
-	 * @return bool successful or not
-	 * @since 6.0.0
-	 */
-	public function delete($id, $address_book_key);
+    /**
+     * This function can be used to delete the contact identified by the given id
+     *
+     * @param int $id the unique identifier to a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be deleted
+     * @return bool successful or not
+     * @since 6.0.0
+     */
+    public function delete($id, $address_book_key);
 
-	/**
-	 * This function is used to create a new contact if 'id' is not given or not present.
-	 * Otherwise the contact will be updated by replacing the entire data set.
-	 *
-	 * @param array $properties this array if key-value-pairs defines a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-	 * @return array an array representing the contact just created or updated
-	 * @since 6.0.0
-	 */
-	public function createOrUpdate($properties, $address_book_key);
+    /**
+     * This function is used to create a new contact if 'id' is not given or not present.
+     * Otherwise the contact will be updated by replacing the entire data set.
+     *
+     * @param array $properties this array if key-value-pairs defines a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+     * @return array an array representing the contact just created or updated
+     * @since 6.0.0
+     */
+    public function createOrUpdate($properties, $address_book_key);
 
-	/**
-	 * Check if contacts are available (e.g. contacts app enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 6.0.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if contacts are available (e.g. contacts app enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 6.0.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Registers an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * Unregisters an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function unregisterAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Unregisters an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function unregisterAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * address books are actually requested
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function register(\Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * address books are actually requested
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 6.0.0
+     */
+    public function register(\Closure $callable);
 
-	/**
-	 * Return a list of the user's addressbooks
-	 *
-	 * @return \OCP\IAddressBook[]
-	 * @since 16.0.0
-	 */
-	public function getUserAddressBooks();
+    /**
+     * Return a list of the user's addressbooks
+     *
+     * @return \OCP\IAddressBook[]
+     * @since 16.0.0
+     */
+    public function getUserAddressBooks();
 
-	/**
-	 * removes all registered address book instances
-	 *
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function clear();
+    /**
+     * removes all registered address book instances
+     *
+     * @return void
+     * @since 6.0.0
+     */
+    public function clear();
 }

lib/public/Util.php

Indentation +562 added lines, -562 removed lines

@@ -56,566 +56,566 @@
  * @since 4.0.0
  */
 class Util {
-	/** @var \OCP\Share\IManager */
-	private static $shareManager;
-
-	/** @var array */
-	private static $scripts = [];
-
-	/** @var array */
-	private static $scriptDeps = [];
-
-	/** @var array */
-	private static $sortedScriptDeps = [];
-
-	/**
-	 * get the current installed version of Nextcloud
-	 * @return array
-	 * @since 4.0.0
-	 */
-	public static function getVersion() {
-		return \OC_Util::getVersion();
-	}
-
-	/**
-	 * @since 17.0.0
-	 */
-	public static function hasExtendedSupport(): bool {
-		try {
-			/** @var \OCP\Support\Subscription\IRegistry */
-			$subscriptionRegistry = \OC::$server->query(\OCP\Support\Subscription\IRegistry::class);
-			return $subscriptionRegistry->delegateHasExtendedSupport();
-		} catch (AppFramework\QueryException $e) {
-		}
-		return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
-	}
-
-	/**
-	 * Set current update channel
-	 * @param string $channel
-	 * @since 8.1.0
-	 */
-	public static function setChannel($channel) {
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
-	}
-
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public static function getChannel() {
-		return \OC_Util::getChannel();
-	}
-
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 * @since 4.0.0
-	 * @deprecated 13.0.0 use log of \OCP\ILogger
-	 */
-	public static function writeLog($app, $message, $level) {
-		$context = ['app' => $app];
-		\OC::$server->getLogger()->log($level, $message, $context);
-	}
-
-	/**
-	 * check if sharing is disabled for the current user
-	 *
-	 * @return boolean
-	 * @since 7.0.0
-	 * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
-	 */
-	public static function isSharingDisabledForUser() {
-		if (self::$shareManager === null) {
-			self::$shareManager = \OC::$server->getShareManager();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user !== null) {
-			$user = $user->getUID();
-		}
-
-		return self::$shareManager->sharingDisabledForUser($user);
-	}
-
-	/**
-	 * get l10n object
-	 * @param string $application
-	 * @param string|null $language
-	 * @return \OCP\IL10N
-	 * @since 6.0.0 - parameter $language was added in 8.0.0
-	 */
-	public static function getL10N($application, $language = null) {
-		return \OC::$server->getL10N($application, $language);
-	}
-
-	/**
-	 * add a css file
-	 * @param string $application
-	 * @param string $file
-	 * @since 4.0.0
-	 */
-	public static function addStyle($application, $file = null) {
-		\OC_Util::addStyle($application, $file);
-	}
-
-	/**
-	 * add a javascript file
-	 *
-	 * @param string $application
-	 * @param string|null $file
-	 * @param string $afterAppId
-	 * @since 4.0.0
-	 */
-	public static function addScript(string $application, string $file = null, string $afterAppId = 'core'): void {
-		if (!empty($application)) {
-			$path = "$application/js/$file";
-		} else {
-			$path = "js/$file";
-		}
-
-		// Inject js translations if we load a script for
-		// a specific app that is not core, as those js files
-		// need separate handling
-		if ($application !== 'core'
-			&& $file !== null
-			&& strpos($file, 'l10n') === false) {
-			self::addTranslations($application);
-		}
-
-		// store app in dependency list
-		if (!array_key_exists($application, self::$scriptDeps)) {
-			self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
-		} else {
-			self::$scriptDeps[$application]->addDep($afterAppId);
-		}
-
-		self::$scripts[$application][] = $path;
-	}
-
-	/**
-	 * Return the list of scripts injected to the page
-	 *
-	 * @return array
-	 * @since 24.0.0
-	 */
-	public static function getScripts(): array {
-		// Sort scriptDeps into sortedScriptDeps
-		$scriptSort = \OC::$server->get(AppScriptSort::class);
-		$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
-
-		// Flatten array and remove duplicates
-		$sortedScripts = $sortedScripts ? array_merge(...array_values(($sortedScripts))) : [];
-
-		// Override core-common and core-main order
-		array_unshift($sortedScripts, 'core/js/common', 'core/js/main');
-
-		return array_unique($sortedScripts);
-	}
-
-	/**
-	 * Add a translation JS file
-	 * @param string $application application id
-	 * @param string $languageCode language code, defaults to the current locale
-	 * @since 8.0.0
-	 */
-	public static function addTranslations($application, $languageCode = null) {
-		if (is_null($languageCode)) {
-			$languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
-		}
-		if (!empty($application)) {
-			$path = "$application/l10n/$languageCode";
-		} else {
-			$path = "l10n/$languageCode";
-		}
-		self::$scripts[$application][] = $path;
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text = null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute($app, $file, $args = []) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		return $urlGenerator->getAbsoluteURL(
-			$urlGenerator->linkTo($app, $file, $args)
-		);
-	}
-
-	/**
-	 * Creates an absolute url for remote use.
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.0.0
-	 */
-	public static function linkToRemote($service) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
-		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
-		);
-	}
-
-	/**
-	 * Creates an absolute url for public use
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.5.0
-	 * @deprecated 15.0.0 - use OCP\IURLGenerator
-	 */
-	public static function linkToPublic($service) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		if ($service === 'files') {
-			return $urlGenerator->getAbsoluteURL('/s');
-		}
-		return $urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'public.php').'?service='.$service);
-	}
-
-	/**
-	 * Returns the server host name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = \OC::$server->getRequest()->getServerHost();
-		// strip away port number (if existing)
-		$colon_pos = strpos($host_name, ':');
-		if ($colon_pos != false) {
-			$host_name = substr($host_name, 0, $colon_pos);
-		}
-		return $host_name;
-	}
-
-	/**
-	 * Returns the default email address
-	 * @param string $user_part the user part of the address
-	 * @return string the default email address
-	 *
-	 * Assembles a default email address (using the server hostname
-	 * and the given user part, and returns it
-	 * Example: when given lostpassword-noreply as $user_part param,
-	 *     and is currently accessed via http(s)://example.com/,
-	 *     it would return 'lostpassword-noreply@example.com'
-	 *
-	 * If the configuration value 'mail_from_address' is set in
-	 * config.php, this value will override the $user_part that
-	 * is passed to this function
-	 * @since 5.0.0
-	 */
-	public static function getDefaultEmailAddress(string $user_part): string {
-		$config = \OC::$server->getConfig();
-		$user_part = $config->getSystemValueString('mail_from_address', $user_part);
-		$host_name = self::getServerHostName();
-		$host_name = $config->getSystemValueString('mail_domain', $host_name);
-		$defaultEmailAddress = $user_part.'@'.$host_name;
-
-		$mailer = \OC::$server->getMailer();
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
-			return $defaultEmailAddress;
-		}
-
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
-		return $user_part.'@localhost.localdomain';
-	}
-
-	/**
-	 * Converts string to int of float depending if it fits an int
-	 * @param numeric-string|float|int $number numeric string
-	 * @return int|float int if it fits, float if it is too big
-	 * @since 26.0.0
-	 */
-	public static function numericToNumber(string|float|int $number): int|float {
-		/* This is a hack to cast to (int|float) */
-		return 0 + (string)$number;
-	}
-
-	/**
-	 * Make a human file size (2048 to 2 kB)
-	 * @param int|float $bytes file size in bytes
-	 * @return string a human readable file size
-	 * @since 4.0.0
-	 */
-	public static function humanFileSize(int|float $bytes): string {
-		return \OC_Helper::humanFileSize($bytes);
-	}
-
-	/**
-	 * Make a computer file size (2 kB to 2048)
-	 * @param string $str file size in a fancy format
-	 * @return false|int|float a file size in bytes
-	 *
-	 * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
-	 * @since 4.0.0
-	 */
-	public static function computerFileSize(string $str): false|int|float {
-		return \OC_Helper::computerFileSize($str);
-	}
-
-	/**
-	 * connects a function to a hook
-	 *
-	 * @param string $signalClass class name of emitter
-	 * @param string $signalName name of signal
-	 * @param string|object $slotClass class name of slot
-	 * @param string $slotName name of slot
-	 * @return bool
-	 *
-	 * This function makes it very easy to connect to use hooks.
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
-	 */
-	public static function connectHook($signalClass, $signalName, $slotClass, $slotName) {
-		return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
-	}
-
-	/**
-	 * Emits a signal. To get data from the slot use references!
-	 * @param string $signalclass class name of emitter
-	 * @param string $signalname name of signal
-	 * @param array $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
-	 */
-	public static function emitHook($signalclass, $signalname, $params = []) {
-		return \OC_Hook::emit($signalclass, $signalname, $params);
-	}
-
-	/**
-	 * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
-	 * multiple OC_Template elements which invoke `callRegister`. If the value
-	 * would not be cached these unit-tests would fail.
-	 * @var string
-	 */
-	private static $token = '';
-
-	/**
-	 * Register an get/post call. This is important to prevent CSRF attacks
-	 * @since 4.5.0
-	 */
-	public static function callRegister() {
-		if (self::$token === '') {
-			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
-		}
-		return self::$token;
-	}
-
-	/**
-	 * Used to sanitize HTML
-	 *
-	 * This function is used to sanitize HTML and should be applied on any
-	 * string or array of strings before displaying it on a web page.
-	 *
-	 * @param string|string[] $value
-	 * @return string|string[] an array of sanitized strings or a single sanitized string, depends on the input parameter.
-	 * @since 4.5.0
-	 */
-	public static function sanitizeHTML($value) {
-		return \OC_Util::sanitizeHTML($value);
-	}
-
-	/**
-	 * Public function to encode url parameters
-	 *
-	 * This function is used to encode path to file before output.
-	 * Encoding is done according to RFC 3986 with one exception:
-	 * Character '/' is preserved as is.
-	 *
-	 * @param string $component part of URI to encode
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public static function encodePath($component) {
-		return \OC_Util::encodePath($component);
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 * @since 4.5.0
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
-	}
-
-	/**
-	 * performs a search in a nested array
-	 *
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 * @since 4.5.0
-	 * @deprecated 15.0.0
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int|float|null $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int|float number of bytes representing
-	 * @since 5.0.0
-	 */
-	public static function maxUploadFilesize(string $dir, int|float|null $free = null): int|float {
-		return \OC_Helper::maxUploadFilesize($dir, $free);
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int|float number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function freeSpace(string $dir): int|float {
-		return \OC_Helper::freeSpace($dir);
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int|float number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function uploadLimit(): int|float {
-		return \OC_Helper::uploadLimit();
-	}
-
-	/**
-	 * Returns whether the given file name is valid
-	 * @param string $file file name to check
-	 * @return bool true if the file name is valid, false otherwise
-	 * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
-	 * @since 7.0.0
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isValidFileName($file) {
-		return \OC_Util::isValidFileName($file);
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
-	 * or 0 if the strings are identical
-	 * @since 7.0.0
-	 */
-	public static function naturalSortCompare($a, $b) {
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
-	}
-
-	/**
-	 * Check if a password is required for each public link
-	 *
-	 * @param bool $checkGroupMembership Check group membership exclusion
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
-		return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
-		}
-		return self::$needUpgradeCache;
-	}
-
-	/**
-	 * 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 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 $accuracy (-5) from
-	 * $dataLength characters, until it fits within $dataLength bytes.
-	 *
-	 * @since 23.0.0
-	 */
-	public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
-		$temp = mb_substr($subject, 0, $dataLength);
-		// json encodes encapsulates the string in double quotes, they need to be substracted
-		while ((strlen(json_encode($temp)) - 2) > $dataLength) {
-			$temp = mb_substr($temp, 0, -$accuracy);
-		}
-		return $temp;
-	}
-
-	/**
-	 * Check if a function is enabled in the php configuration
-	 *
-	 * @since 25.0.0
-	 */
-	public static function isFunctionEnabled(string $functionName): bool {
-		if (!function_exists($functionName)) {
-			return false;
-		}
-		$ini = \OCP\Server::get(IniGetWrapper::class);
-		$disabled = explode(',', $ini->get('disable_functions') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($functionName, $disabled)) {
-			return false;
-		}
-		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($functionName, $disabled)) {
-			return false;
-		}
-		return true;
-	}
+    /** @var \OCP\Share\IManager */
+    private static $shareManager;
+
+    /** @var array */
+    private static $scripts = [];
+
+    /** @var array */
+    private static $scriptDeps = [];
+
+    /** @var array */
+    private static $sortedScriptDeps = [];
+
+    /**
+     * get the current installed version of Nextcloud
+     * @return array
+     * @since 4.0.0
+     */
+    public static function getVersion() {
+        return \OC_Util::getVersion();
+    }
+
+    /**
+     * @since 17.0.0
+     */
+    public static function hasExtendedSupport(): bool {
+        try {
+            /** @var \OCP\Support\Subscription\IRegistry */
+            $subscriptionRegistry = \OC::$server->query(\OCP\Support\Subscription\IRegistry::class);
+            return $subscriptionRegistry->delegateHasExtendedSupport();
+        } catch (AppFramework\QueryException $e) {
+        }
+        return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
+    }
+
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
+    }
+
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     */
+    public static function getChannel() {
+        return \OC_Util::getChannel();
+    }
+
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     * @since 4.0.0
+     * @deprecated 13.0.0 use log of \OCP\ILogger
+     */
+    public static function writeLog($app, $message, $level) {
+        $context = ['app' => $app];
+        \OC::$server->getLogger()->log($level, $message, $context);
+    }
+
+    /**
+     * check if sharing is disabled for the current user
+     *
+     * @return boolean
+     * @since 7.0.0
+     * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
+     */
+    public static function isSharingDisabledForUser() {
+        if (self::$shareManager === null) {
+            self::$shareManager = \OC::$server->getShareManager();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user !== null) {
+            $user = $user->getUID();
+        }
+
+        return self::$shareManager->sharingDisabledForUser($user);
+    }
+
+    /**
+     * get l10n object
+     * @param string $application
+     * @param string|null $language
+     * @return \OCP\IL10N
+     * @since 6.0.0 - parameter $language was added in 8.0.0
+     */
+    public static function getL10N($application, $language = null) {
+        return \OC::$server->getL10N($application, $language);
+    }
+
+    /**
+     * add a css file
+     * @param string $application
+     * @param string $file
+     * @since 4.0.0
+     */
+    public static function addStyle($application, $file = null) {
+        \OC_Util::addStyle($application, $file);
+    }
+
+    /**
+     * add a javascript file
+     *
+     * @param string $application
+     * @param string|null $file
+     * @param string $afterAppId
+     * @since 4.0.0
+     */
+    public static function addScript(string $application, string $file = null, string $afterAppId = 'core'): void {
+        if (!empty($application)) {
+            $path = "$application/js/$file";
+        } else {
+            $path = "js/$file";
+        }
+
+        // Inject js translations if we load a script for
+        // a specific app that is not core, as those js files
+        // need separate handling
+        if ($application !== 'core'
+            && $file !== null
+            && strpos($file, 'l10n') === false) {
+            self::addTranslations($application);
+        }
+
+        // store app in dependency list
+        if (!array_key_exists($application, self::$scriptDeps)) {
+            self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
+        } else {
+            self::$scriptDeps[$application]->addDep($afterAppId);
+        }
+
+        self::$scripts[$application][] = $path;
+    }
+
+    /**
+     * Return the list of scripts injected to the page
+     *
+     * @return array
+     * @since 24.0.0
+     */
+    public static function getScripts(): array {
+        // Sort scriptDeps into sortedScriptDeps
+        $scriptSort = \OC::$server->get(AppScriptSort::class);
+        $sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
+
+        // Flatten array and remove duplicates
+        $sortedScripts = $sortedScripts ? array_merge(...array_values(($sortedScripts))) : [];
+
+        // Override core-common and core-main order
+        array_unshift($sortedScripts, 'core/js/common', 'core/js/main');
+
+        return array_unique($sortedScripts);
+    }
+
+    /**
+     * Add a translation JS file
+     * @param string $application application id
+     * @param string $languageCode language code, defaults to the current locale
+     * @since 8.0.0
+     */
+    public static function addTranslations($application, $languageCode = null) {
+        if (is_null($languageCode)) {
+            $languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
+        }
+        if (!empty($application)) {
+            $path = "$application/l10n/$languageCode";
+        } else {
+            $path = "l10n/$languageCode";
+        }
+        self::$scripts[$application][] = $path;
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text = null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute($app, $file, $args = []) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        return $urlGenerator->getAbsoluteURL(
+            $urlGenerator->linkTo($app, $file, $args)
+        );
+    }
+
+    /**
+     * Creates an absolute url for remote use.
+     * @param string $service id
+     * @return string the url
+     * @since 4.0.0
+     */
+    public static function linkToRemote($service) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+        return $urlGenerator->getAbsoluteURL(
+            $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+        );
+    }
+
+    /**
+     * Creates an absolute url for public use
+     * @param string $service id
+     * @return string the url
+     * @since 4.5.0
+     * @deprecated 15.0.0 - use OCP\IURLGenerator
+     */
+    public static function linkToPublic($service) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        if ($service === 'files') {
+            return $urlGenerator->getAbsoluteURL('/s');
+        }
+        return $urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'public.php').'?service='.$service);
+    }
+
+    /**
+     * Returns the server host name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = \OC::$server->getRequest()->getServerHost();
+        // strip away port number (if existing)
+        $colon_pos = strpos($host_name, ':');
+        if ($colon_pos != false) {
+            $host_name = substr($host_name, 0, $colon_pos);
+        }
+        return $host_name;
+    }
+
+    /**
+     * Returns the default email address
+     * @param string $user_part the user part of the address
+     * @return string the default email address
+     *
+     * Assembles a default email address (using the server hostname
+     * and the given user part, and returns it
+     * Example: when given lostpassword-noreply as $user_part param,
+     *     and is currently accessed via http(s)://example.com/,
+     *     it would return 'lostpassword-noreply@example.com'
+     *
+     * If the configuration value 'mail_from_address' is set in
+     * config.php, this value will override the $user_part that
+     * is passed to this function
+     * @since 5.0.0
+     */
+    public static function getDefaultEmailAddress(string $user_part): string {
+        $config = \OC::$server->getConfig();
+        $user_part = $config->getSystemValueString('mail_from_address', $user_part);
+        $host_name = self::getServerHostName();
+        $host_name = $config->getSystemValueString('mail_domain', $host_name);
+        $defaultEmailAddress = $user_part.'@'.$host_name;
+
+        $mailer = \OC::$server->getMailer();
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
+            return $defaultEmailAddress;
+        }
+
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
+        return $user_part.'@localhost.localdomain';
+    }
+
+    /**
+     * Converts string to int of float depending if it fits an int
+     * @param numeric-string|float|int $number numeric string
+     * @return int|float int if it fits, float if it is too big
+     * @since 26.0.0
+     */
+    public static function numericToNumber(string|float|int $number): int|float {
+        /* This is a hack to cast to (int|float) */
+        return 0 + (string)$number;
+    }
+
+    /**
+     * Make a human file size (2048 to 2 kB)
+     * @param int|float $bytes file size in bytes
+     * @return string a human readable file size
+     * @since 4.0.0
+     */
+    public static function humanFileSize(int|float $bytes): string {
+        return \OC_Helper::humanFileSize($bytes);
+    }
+
+    /**
+     * Make a computer file size (2 kB to 2048)
+     * @param string $str file size in a fancy format
+     * @return false|int|float a file size in bytes
+     *
+     * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
+     * @since 4.0.0
+     */
+    public static function computerFileSize(string $str): false|int|float {
+        return \OC_Helper::computerFileSize($str);
+    }
+
+    /**
+     * connects a function to a hook
+     *
+     * @param string $signalClass class name of emitter
+     * @param string $signalName name of signal
+     * @param string|object $slotClass class name of slot
+     * @param string $slotName name of slot
+     * @return bool
+     *
+     * This function makes it very easy to connect to use hooks.
+     *
+     * TODO: write example
+     * @since 4.0.0
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
+     */
+    public static function connectHook($signalClass, $signalName, $slotClass, $slotName) {
+        return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
+    }
+
+    /**
+     * Emits a signal. To get data from the slot use references!
+     * @param string $signalclass class name of emitter
+     * @param string $signalname name of signal
+     * @param array $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     *
+     * TODO: write example
+     * @since 4.0.0
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
+     */
+    public static function emitHook($signalclass, $signalname, $params = []) {
+        return \OC_Hook::emit($signalclass, $signalname, $params);
+    }
+
+    /**
+     * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
+     * multiple OC_Template elements which invoke `callRegister`. If the value
+     * would not be cached these unit-tests would fail.
+     * @var string
+     */
+    private static $token = '';
+
+    /**
+     * Register an get/post call. This is important to prevent CSRF attacks
+     * @since 4.5.0
+     */
+    public static function callRegister() {
+        if (self::$token === '') {
+            self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
+        }
+        return self::$token;
+    }
+
+    /**
+     * Used to sanitize HTML
+     *
+     * This function is used to sanitize HTML and should be applied on any
+     * string or array of strings before displaying it on a web page.
+     *
+     * @param string|string[] $value
+     * @return string|string[] an array of sanitized strings or a single sanitized string, depends on the input parameter.
+     * @since 4.5.0
+     */
+    public static function sanitizeHTML($value) {
+        return \OC_Util::sanitizeHTML($value);
+    }
+
+    /**
+     * Public function to encode url parameters
+     *
+     * This function is used to encode path to file before output.
+     * Encoding is done according to RFC 3986 with one exception:
+     * Character '/' is preserved as is.
+     *
+     * @param string $component part of URI to encode
+     * @return string
+     * @since 6.0.0
+     */
+    public static function encodePath($component) {
+        return \OC_Util::encodePath($component);
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     * @since 4.5.0
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
+    }
+
+    /**
+     * performs a search in a nested array
+     *
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     * @since 4.5.0
+     * @deprecated 15.0.0
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int|float|null $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int|float number of bytes representing
+     * @since 5.0.0
+     */
+    public static function maxUploadFilesize(string $dir, int|float|null $free = null): int|float {
+        return \OC_Helper::maxUploadFilesize($dir, $free);
+    }
+
+    /**
+     * Calculate free space left within user quota
+     * @param string $dir the current folder where the user currently operates
+     * @return int|float number of bytes representing
+     * @since 7.0.0
+     */
+    public static function freeSpace(string $dir): int|float {
+        return \OC_Helper::freeSpace($dir);
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int|float number of bytes representing
+     * @since 7.0.0
+     */
+    public static function uploadLimit(): int|float {
+        return \OC_Helper::uploadLimit();
+    }
+
+    /**
+     * Returns whether the given file name is valid
+     * @param string $file file name to check
+     * @return bool true if the file name is valid, false otherwise
+     * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
+     * @since 7.0.0
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isValidFileName($file) {
+        return \OC_Util::isValidFileName($file);
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
+     * or 0 if the strings are identical
+     * @since 7.0.0
+     */
+    public static function naturalSortCompare($a, $b) {
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
+    }
+
+    /**
+     * Check if a password is required for each public link
+     *
+     * @param bool $checkGroupMembership Check group membership exclusion
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
+        return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+        }
+        return self::$needUpgradeCache;
+    }
+
+    /**
+     * 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 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 $accuracy (-5) from
+     * $dataLength characters, until it fits within $dataLength bytes.
+     *
+     * @since 23.0.0
+     */
+    public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
+        $temp = mb_substr($subject, 0, $dataLength);
+        // json encodes encapsulates the string in double quotes, they need to be substracted
+        while ((strlen(json_encode($temp)) - 2) > $dataLength) {
+            $temp = mb_substr($temp, 0, -$accuracy);
+        }
+        return $temp;
+    }
+
+    /**
+     * Check if a function is enabled in the php configuration
+     *
+     * @since 25.0.0
+     */
+    public static function isFunctionEnabled(string $functionName): bool {
+        if (!function_exists($functionName)) {
+            return false;
+        }
+        $ini = \OCP\Server::get(IniGetWrapper::class);
+        $disabled = explode(',', $ini->get('disable_functions') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($functionName, $disabled)) {
+            return false;
+        }
+        $disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($functionName, $disabled)) {
+            return false;
+        }
+        return true;
+    }
 }

lib/public/DB/Exception.php

Indentation +106 added lines, -106 removed lines

@@ -39,110 +39,110 @@
  * @since 21.0.0
  */
 class Exception extends BaseException {
-	/**
-	 * Nextcloud lost connection to the database
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_CONNECTION_LOST = 1;
-
-	/**
-	 * A database constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_CONSTRAINT_VIOLATION = 2;
-
-	/**
-	 * A database object (table, column, index) already exists
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DATABASE_OBJECT_EXISTS = 3;
-
-	/**
-	 * A database object (table, column, index) can't be found
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DATABASE_OBJECT_NOT_FOUND = 4;
-
-	/**
-	 * The database ran into a deadlock
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DEADLOCK = 5;
-
-	/**
-	 * The database driver encountered an issue
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DRIVER = 6;
-
-	/**
-	 * A foreign key constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_FOREIGN_KEY_VIOLATION = 7;
-
-	/**
-	 * An invalid argument was passed to the database abstraction
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_INVALID_ARGUMENT = 8;
-
-	/**
-	 * A field name was invalid
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_INVALID_FIELD_NAME = 9;
-
-	/**
-	 * A name in the query was ambiguous
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_NON_UNIQUE_FIELD_NAME = 10;
-
-	/**
-	 * A not null constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_NOT_NULL_CONSTRAINT_VIOLATION = 11;
-
-	/**
-	 * A generic server error was encountered
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_SERVER = 12;
-
-	/**
-	 * A syntax error was reported by the server
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_SYNTAX_ERROR = 13;
-
-	/**
-	 * A unique constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_UNIQUE_CONSTRAINT_VIOLATION = 14;
-
-	/**
-	 * @return int|null
-	 * @psalm-return Exception::REASON_*
-	 * @since 21.0.0
-	 */
-	public function getReason(): ?int {
-		return null;
-	}
+    /**
+     * Nextcloud lost connection to the database
+     *
+     * @since 21.0.0
+     */
+    public const REASON_CONNECTION_LOST = 1;
+
+    /**
+     * A database constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_CONSTRAINT_VIOLATION = 2;
+
+    /**
+     * A database object (table, column, index) already exists
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DATABASE_OBJECT_EXISTS = 3;
+
+    /**
+     * A database object (table, column, index) can't be found
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DATABASE_OBJECT_NOT_FOUND = 4;
+
+    /**
+     * The database ran into a deadlock
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DEADLOCK = 5;
+
+    /**
+     * The database driver encountered an issue
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DRIVER = 6;
+
+    /**
+     * A foreign key constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_FOREIGN_KEY_VIOLATION = 7;
+
+    /**
+     * An invalid argument was passed to the database abstraction
+     *
+     * @since 21.0.0
+     */
+    public const REASON_INVALID_ARGUMENT = 8;
+
+    /**
+     * A field name was invalid
+     *
+     * @since 21.0.0
+     */
+    public const REASON_INVALID_FIELD_NAME = 9;
+
+    /**
+     * A name in the query was ambiguous
+     *
+     * @since 21.0.0
+     */
+    public const REASON_NON_UNIQUE_FIELD_NAME = 10;
+
+    /**
+     * A not null constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_NOT_NULL_CONSTRAINT_VIOLATION = 11;
+
+    /**
+     * A generic server error was encountered
+     *
+     * @since 21.0.0
+     */
+    public const REASON_SERVER = 12;
+
+    /**
+     * A syntax error was reported by the server
+     *
+     * @since 21.0.0
+     */
+    public const REASON_SYNTAX_ERROR = 13;
+
+    /**
+     * A unique constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_UNIQUE_CONSTRAINT_VIOLATION = 14;
+
+    /**
+     * @return int|null
+     * @psalm-return Exception::REASON_*
+     * @since 21.0.0
+     */
+    public function getReason(): ?int {
+        return null;
+    }
 }

lib/public/DB/QueryBuilder/IQueryBuilder.php

Indentation +980 added lines, -980 removed lines

@@ -38,984 +38,984 @@
  * @psalm-taint-specialize
  */
 interface IQueryBuilder {
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_NULL = \PDO::PARAM_NULL;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_BOOL = \PDO::PARAM_BOOL;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_INT = \PDO::PARAM_INT;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_STR = \PDO::PARAM_STR;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_LOB = \PDO::PARAM_LOB;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_DATE = 'datetime';
-
-	/**
-	 * @since 24.0.0
-	 */
-	public const PARAM_JSON = 'json';
-
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
-
-	/**
-	 * @since 24.0.0 Indicates how many rows can be deleted at once with MySQL
-	 * database server.
-	 */
-	public const MAX_ROW_DELETION = 100000;
-
-	/**
-	 * Enable/disable automatic prefixing of table names with the oc_ prefix
-	 *
-	 * @param bool $enabled If set to true table names will be prefixed with the
-	 * owncloud database prefix automatically.
-	 * @since 8.2.0
-	 */
-	public function automaticTablePrefix($enabled);
-
-	/**
-	 * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->expr()->eq('u.id', 1));
-	 * </code>
-	 *
-	 * For more complex expression construction, consider storing the expression
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IExpressionBuilder
-	 * @since 8.2.0
-	 */
-	public function expr();
-
-	/**
-	 * Gets an FunctionBuilder used for object-oriented construction of query functions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->fun()->md5('u.id'));
-	 * </code>
-	 *
-	 * For more complex function construction, consider storing the function
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IFunctionBuilder
-	 * @since 12.0.0
-	 */
-	public function func();
-
-	/**
-	 * Gets the type of the currently built query.
-	 *
-	 * @return integer
-	 * @since 8.2.0
-	 */
-	public function getType();
-
-	/**
-	 * Gets the associated DBAL Connection for this query builder.
-	 *
-	 * @return \OCP\IDBConnection
-	 * @since 8.2.0
-	 */
-	public function getConnection();
-
-	/**
-	 * Gets the state of this query builder instance.
-	 *
-	 * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
-	 * @since 8.2.0
-	 */
-	public function getState();
-
-	/**
-	 * Executes this query using the bound parameters and their types.
-	 *
-	 * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeStatement}
-	 * for insert, update and delete statements.
-	 *
-	 * Warning: until Nextcloud 20, this method could return a \Doctrine\DBAL\Driver\Statement but since
-	 *          that interface changed in a breaking way the adapter \OCP\DB\QueryBuilder\IStatement is returned
-	 *          to bridge old code to the new API
-	 *
-	 * @return IResult|int
-	 * @throws Exception since 21.0.0
-	 * @since 8.2.0
-	 * @deprecated 22.0.0 Use executeQuery or executeStatement
-	 */
-	public function execute();
-
-	/**
-	 * Execute for select statements
-	 *
-	 * @return IResult
-	 * @since 22.0.0
-	 *
-	 * @throws Exception
-	 * @throws \RuntimeException in case of usage with non select query
-	 */
-	public function executeQuery(): IResult;
-
-	/**
-	 * Execute insert, update and delete statements
-	 *
-	 * @return int the number of affected rows
-	 * @since 22.0.0
-	 *
-	 * @throws Exception
-	 * @throws \RuntimeException in case of usage with select query
-	 */
-	public function executeStatement(): int;
-
-	/**
-	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('User', 'u')
-	 *     echo $qb->getSQL(); // SELECT u FROM User u
-	 * </code>
-	 *
-	 * @return string The SQL query string.
-	 * @since 8.2.0
-	 */
-	public function getSQL();
-
-	/**
-	 * Sets a query parameter for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id')
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string|integer $key The parameter position or name.
-	 * @param mixed $value The parameter value.
-	 * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameter($key, $value, $type = null);
-
-	/**
-	 * Sets a collection of query parameters for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id1 OR u.id = :user_id2')
-	 *         ->setParameters(array(
-	 *             ':user_id1' => 1,
-	 *             ':user_id2' => 2
-	 *         ));
-	 * </code>
-	 *
-	 * @param array $params The query parameters to set.
-	 * @param array $types The query parameters types to set.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameters(array $params, array $types = []);
-
-	/**
-	 * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameters indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameters();
-
-	/**
-	 * Gets a (previously set) query parameter of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter.
-	 *
-	 * @return mixed The value of the bound parameter.
-	 * @since 8.2.0
-	 */
-	public function getParameter($key);
-
-	/**
-	 * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameter types indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameterTypes();
-
-	/**
-	 * Gets a (previously set) query parameter type of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter type.
-	 *
-	 * @return mixed The value of the bound parameter type.
-	 * @since 8.2.0
-	 */
-	public function getParameterType($key);
-
-	/**
-	 * Sets the position of the first result to retrieve (the "offset").
-	 *
-	 * @param int $firstResult The first result to return.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setFirstResult($firstResult);
-
-	/**
-	 * Gets the position of the first result the query object was set to retrieve (the "offset").
-	 * Returns 0 if {@link setFirstResult} was not applied to this QueryBuilder.
-	 *
-	 * @return int The position of the first result.
-	 * @since 8.2.0
-	 */
-	public function getFirstResult();
-
-	/**
-	 * Sets the maximum number of results to retrieve (the "limit").
-	 *
-	 * @param int|null $maxResults The maximum number of results to retrieve.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setMaxResults($maxResults);
-
-	/**
-	 * Gets the maximum number of results the query object was set to retrieve (the "limit").
-	 * Returns NULL if {@link setMaxResults} was not applied to this query builder.
-	 *
-	 * @return int|null The maximum number of results.
-	 * @since 8.2.0
-	 */
-	public function getMaxResults();
-
-	/**
-	 * Specifies an item that is to be returned in the query result.
-	 * Replaces any previously specified selections, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id', 'p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$selects The selection expressions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $selects
-	 */
-	public function select(...$selects);
-
-	/**
-	 * Specifies an item that is to be returned with a different name in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectAlias('u.id', 'user_id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 * @param string $alias The column alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.1
-	 *
-	 * @psalm-taint-sink sql $select
-	 * @psalm-taint-sink sql $alias
-	 */
-	public function selectAlias($select, $alias);
-
-	/**
-	 * Specifies an item that is to be returned uniquely in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectDistinct('type')
-	 *         ->from('users');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 9.0.0
-	 *
-	 * @psalm-taint-sink sql $select
-	 */
-	public function selectDistinct($select);
-
-	/**
-	 * Adds an item that is to be returned in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->addSelect('p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$select The selection expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $select
-	 */
-	public function addSelect(...$select);
-
-	/**
-	 * Turns the query being built into a bulk delete query that ranges over
-	 * a certain table.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->delete('users', 'u')
-	 *         ->where('u.id = :user_id');
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string $delete The table whose rows are subject to the deletion.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $delete
-	 */
-	public function delete($delete = null, $alias = null);
-
-	/**
-	 * Turns the query being built into a bulk update query that ranges over
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $update The table whose rows are subject to the update.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $update
-	 */
-	public function update($update = null, $alias = null);
-
-	/**
-	 * Turns the query being built into an insert query that inserts into
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param string $insert The table into which the rows should be inserted.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $insert
-	 */
-	public function insert($insert = null);
-
-	/**
-	 * Creates and adds a query root corresponding to the table identified by the
-	 * given alias, forming a cartesian product with any existing query roots.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->from('users', 'u')
-	 * </code>
-	 *
-	 * @param string|IQueryFunction $from The table.
-	 * @param string|null $alias The alias of the table.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $from
-	 */
-	public function from($from, $alias = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $fromAlias
-	 * @psalm-taint-sink sql $join
-	 * @psalm-taint-sink sql $alias
-	 * @psalm-taint-sink sql $condition
-	 */
-	public function join($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $fromAlias
-	 * @psalm-taint-sink sql $join
-	 * @psalm-taint-sink sql $alias
-	 * @psalm-taint-sink sql $condition
-	 */
-	public function innerJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a left join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $fromAlias
-	 * @psalm-taint-sink sql $join
-	 * @psalm-taint-sink sql $alias
-	 * @psalm-taint-sink sql $condition
-	 */
-	public function leftJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a right join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $fromAlias
-	 * @psalm-taint-sink sql $join
-	 * @psalm-taint-sink sql $alias
-	 * @psalm-taint-sink sql $condition
-	 */
-	public function rightJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Sets a new value for a column in a bulk update query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $key The column to set.
-	 * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $key
-	 * @psalm-taint-sink sql $value
-	 */
-	public function set($key, $value);
-
-	/**
-	 * Specifies one or more restrictions to the query result.
-	 * Replaces any previously specified restrictions, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = ?');
-	 *
-	 *     // You can optionally programmatically build and/or expressions
-	 *     $qb = $conn->getQueryBuilder();
-	 *
-	 *     $or = $qb->expr()->orx();
-	 *     $or->add($qb->expr()->eq('u.id', 1));
-	 *     $or->add($qb->expr()->eq('u.id', 2));
-	 *
-	 *     $qb->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where($or);
-	 * </code>
-	 *
-	 * @param mixed $predicates The restriction predicates.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $predicates
-	 */
-	public function where(...$predicates);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * conjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.username LIKE ?')
-	 *         ->andWhere('u.is_active = 1');
-	 * </code>
-	 *
-	 * @param mixed ...$where The query restrictions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $where
-	 */
-	public function andWhere(...$where);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * disjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = 1')
-	 *         ->orWhere('u.id = 2');
-	 * </code>
-	 *
-	 * @param mixed ...$where The WHERE statement.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $where
-	 */
-	public function orWhere(...$where);
-
-	/**
-	 * Specifies a grouping over the results of the query.
-	 * Replaces any previously specified groupings, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.id');
-	 * </code>
-	 *
-	 * @param mixed ...$groupBys The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $groupBys
-	 */
-	public function groupBy(...$groupBys);
-
-	/**
-	 * Adds a grouping expression to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.lastLogin');
-	 *         ->addGroupBy('u.createdAt')
-	 * </code>
-	 *
-	 * @param mixed ...$groupBy The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $groupby
-	 */
-	public function addGroupBy(...$groupBy);
-
-	/**
-	 * Sets a value for a column in an insert query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?'
-	 *             )
-	 *         )
-	 *         ->setValue('password', '?');
-	 * </code>
-	 *
-	 * @param string $column The column into which the value should be inserted.
-	 * @param IParameter|string $value The value that should be inserted into the column.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $column
-	 * @psalm-taint-sink sql $value
-	 */
-	public function setValue($column, $value);
-
-	/**
-	 * Specifies values for an insert query indexed by column names.
-	 * Replaces any previous values, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param array $values The values to specify for the insert query indexed by column names.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $values
-	 */
-	public function values(array $values);
-
-	/**
-	 * Specifies a restriction over the groups of the query.
-	 * Replaces any previous having restrictions, if any.
-	 *
-	 * @param mixed ...$having The restriction over the groups.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $having
-	 */
-	public function having(...$having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * conjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to append.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $andHaving
-	 */
-	public function andHaving(...$having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * disjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to add.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $having
-	 */
-	public function orHaving(...$having);
-
-	/**
-	 * Specifies an ordering for the query results.
-	 * Replaces any previously specified orderings, if any.
-	 *
-	 * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $sort
-	 * @psalm-taint-sink sql $order
-	 */
-	public function orderBy($sort, $order = null);
-
-	/**
-	 * Adds an ordering to the query results.
-	 *
-	 * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql $sort
-	 * @psalm-taint-sink sql $order
-	 */
-	public function addOrderBy($sort, $order = null);
-
-	/**
-	 * Gets a query part by its name.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function getQueryPart($queryPartName);
-
-	/**
-	 * Gets all query parts.
-	 *
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getQueryParts();
-
-	/**
-	 * Resets SQL parts.
-	 *
-	 * @param array|null $queryPartNames
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryParts($queryPartNames = null);
-
-	/**
-	 * Resets a single SQL part.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryPart($queryPartName);
-
-	/**
-	 * Creates a new named parameter and bind the value $value to it.
-	 *
-	 * This method provides a shortcut for PDOStatement::bindValue
-	 * when using prepared statements.
-	 *
-	 * The parameter $value specifies the value that you want to bind. If
-	 * $placeholder is not provided bindValue() will automatically create a
-	 * placeholder for you. An automatic placeholder will be of the name
-	 * ':dcValue1', ':dcValue2' etc.
-	 *
-	 * For more information see {@link https://www.php.net/pdostatement-bindparam}
-	 *
-	 * Example:
-	 * <code>
-	 * $value = 2;
-	 * $q->eq( 'id', $q->bindValue( $value ) );
-	 * $stmt = $q->executeQuery(); // executed with 'id = 2'
-	 * </code>
-	 *
-	 * @license New BSD License
-	 * @link http://www.zetacomponents.org
-	 *
-	 * @param mixed $value
-	 * @param mixed $type
-	 * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-escape sql
-	 */
-	public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
-
-	/**
-	 * Creates a new positional parameter and bind the given value to it.
-	 *
-	 * Attention: If you are using positional parameters with the query builder you have
-	 * to be very careful to bind all parameters in the order they appear in the SQL
-	 * statement , otherwise they get bound in the wrong order which can lead to serious
-	 * bugs in your code.
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
-	 *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param mixed $value
-	 * @param integer $type
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-escape sql
-	 */
-	public function createPositionalParameter($value, $type = self::PARAM_STR);
-
-	/**
-	 * Creates a new parameter
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createParameter('name'))
-	 *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param string $name
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-escape sql
-	 */
-	public function createParameter($name);
-
-	/**
-	 * Creates a new function
-	 *
-	 * Attention: Column names inside the call have to be quoted before hand
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(*)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
-	 * </code>
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(`column`)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
-	 * </code>
-	 *
-	 * @param string $call
-	 *
-	 * @return IQueryFunction
-	 * @since 8.2.0
-	 *
-	 * @psalm-taint-sink sql
-	 */
-	public function createFunction($call);
-
-	/**
-	 * Used to get the id of the last inserted element
-	 * @return int
-	 * @throws \BadMethodCallException When being called before an insert query has been run.
-	 * @since 9.0.0
-	 */
-	public function getLastInsertId(): int;
-
-	/**
-	 * Returns the table name quoted and with database prefix as needed by the implementation
-	 *
-	 * @param string|IQueryFunction $table
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTableName($table);
-
-	/**
-	 * Returns the column name quoted and with table alias prefix as needed by the implementation
-	 *
-	 * @param string $column
-	 * @param string $tableAlias
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getColumnName($column, $tableAlias = '');
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_NULL = \PDO::PARAM_NULL;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_BOOL = \PDO::PARAM_BOOL;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_INT = \PDO::PARAM_INT;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_STR = \PDO::PARAM_STR;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_LOB = \PDO::PARAM_LOB;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_DATE = 'datetime';
+
+    /**
+     * @since 24.0.0
+     */
+    public const PARAM_JSON = 'json';
+
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
+
+    /**
+     * @since 24.0.0 Indicates how many rows can be deleted at once with MySQL
+     * database server.
+     */
+    public const MAX_ROW_DELETION = 100000;
+
+    /**
+     * Enable/disable automatic prefixing of table names with the oc_ prefix
+     *
+     * @param bool $enabled If set to true table names will be prefixed with the
+     * owncloud database prefix automatically.
+     * @since 8.2.0
+     */
+    public function automaticTablePrefix($enabled);
+
+    /**
+     * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->expr()->eq('u.id', 1));
+     * </code>
+     *
+     * For more complex expression construction, consider storing the expression
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IExpressionBuilder
+     * @since 8.2.0
+     */
+    public function expr();
+
+    /**
+     * Gets an FunctionBuilder used for object-oriented construction of query functions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->fun()->md5('u.id'));
+     * </code>
+     *
+     * For more complex function construction, consider storing the function
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IFunctionBuilder
+     * @since 12.0.0
+     */
+    public function func();
+
+    /**
+     * Gets the type of the currently built query.
+     *
+     * @return integer
+     * @since 8.2.0
+     */
+    public function getType();
+
+    /**
+     * Gets the associated DBAL Connection for this query builder.
+     *
+     * @return \OCP\IDBConnection
+     * @since 8.2.0
+     */
+    public function getConnection();
+
+    /**
+     * Gets the state of this query builder instance.
+     *
+     * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+     * @since 8.2.0
+     */
+    public function getState();
+
+    /**
+     * Executes this query using the bound parameters and their types.
+     *
+     * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeStatement}
+     * for insert, update and delete statements.
+     *
+     * Warning: until Nextcloud 20, this method could return a \Doctrine\DBAL\Driver\Statement but since
+     *          that interface changed in a breaking way the adapter \OCP\DB\QueryBuilder\IStatement is returned
+     *          to bridge old code to the new API
+     *
+     * @return IResult|int
+     * @throws Exception since 21.0.0
+     * @since 8.2.0
+     * @deprecated 22.0.0 Use executeQuery or executeStatement
+     */
+    public function execute();
+
+    /**
+     * Execute for select statements
+     *
+     * @return IResult
+     * @since 22.0.0
+     *
+     * @throws Exception
+     * @throws \RuntimeException in case of usage with non select query
+     */
+    public function executeQuery(): IResult;
+
+    /**
+     * Execute insert, update and delete statements
+     *
+     * @return int the number of affected rows
+     * @since 22.0.0
+     *
+     * @throws Exception
+     * @throws \RuntimeException in case of usage with select query
+     */
+    public function executeStatement(): int;
+
+    /**
+     * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('User', 'u')
+     *     echo $qb->getSQL(); // SELECT u FROM User u
+     * </code>
+     *
+     * @return string The SQL query string.
+     * @since 8.2.0
+     */
+    public function getSQL();
+
+    /**
+     * Sets a query parameter for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id')
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string|integer $key The parameter position or name.
+     * @param mixed $value The parameter value.
+     * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameter($key, $value, $type = null);
+
+    /**
+     * Sets a collection of query parameters for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id1 OR u.id = :user_id2')
+     *         ->setParameters(array(
+     *             ':user_id1' => 1,
+     *             ':user_id2' => 2
+     *         ));
+     * </code>
+     *
+     * @param array $params The query parameters to set.
+     * @param array $types The query parameters types to set.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameters(array $params, array $types = []);
+
+    /**
+     * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameters indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameters();
+
+    /**
+     * Gets a (previously set) query parameter of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter.
+     *
+     * @return mixed The value of the bound parameter.
+     * @since 8.2.0
+     */
+    public function getParameter($key);
+
+    /**
+     * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameter types indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameterTypes();
+
+    /**
+     * Gets a (previously set) query parameter type of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter type.
+     *
+     * @return mixed The value of the bound parameter type.
+     * @since 8.2.0
+     */
+    public function getParameterType($key);
+
+    /**
+     * Sets the position of the first result to retrieve (the "offset").
+     *
+     * @param int $firstResult The first result to return.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setFirstResult($firstResult);
+
+    /**
+     * Gets the position of the first result the query object was set to retrieve (the "offset").
+     * Returns 0 if {@link setFirstResult} was not applied to this QueryBuilder.
+     *
+     * @return int The position of the first result.
+     * @since 8.2.0
+     */
+    public function getFirstResult();
+
+    /**
+     * Sets the maximum number of results to retrieve (the "limit").
+     *
+     * @param int|null $maxResults The maximum number of results to retrieve.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setMaxResults($maxResults);
+
+    /**
+     * Gets the maximum number of results the query object was set to retrieve (the "limit").
+     * Returns NULL if {@link setMaxResults} was not applied to this query builder.
+     *
+     * @return int|null The maximum number of results.
+     * @since 8.2.0
+     */
+    public function getMaxResults();
+
+    /**
+     * Specifies an item that is to be returned in the query result.
+     * Replaces any previously specified selections, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id', 'p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$selects The selection expressions.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $selects
+     */
+    public function select(...$selects);
+
+    /**
+     * Specifies an item that is to be returned with a different name in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectAlias('u.id', 'user_id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     * @param string $alias The column alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.1
+     *
+     * @psalm-taint-sink sql $select
+     * @psalm-taint-sink sql $alias
+     */
+    public function selectAlias($select, $alias);
+
+    /**
+     * Specifies an item that is to be returned uniquely in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectDistinct('type')
+     *         ->from('users');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 9.0.0
+     *
+     * @psalm-taint-sink sql $select
+     */
+    public function selectDistinct($select);
+
+    /**
+     * Adds an item that is to be returned in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->addSelect('p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$select The selection expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $select
+     */
+    public function addSelect(...$select);
+
+    /**
+     * Turns the query being built into a bulk delete query that ranges over
+     * a certain table.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->delete('users', 'u')
+     *         ->where('u.id = :user_id');
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string $delete The table whose rows are subject to the deletion.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $delete
+     */
+    public function delete($delete = null, $alias = null);
+
+    /**
+     * Turns the query being built into a bulk update query that ranges over
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $update The table whose rows are subject to the update.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $update
+     */
+    public function update($update = null, $alias = null);
+
+    /**
+     * Turns the query being built into an insert query that inserts into
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param string $insert The table into which the rows should be inserted.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $insert
+     */
+    public function insert($insert = null);
+
+    /**
+     * Creates and adds a query root corresponding to the table identified by the
+     * given alias, forming a cartesian product with any existing query roots.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->from('users', 'u')
+     * </code>
+     *
+     * @param string|IQueryFunction $from The table.
+     * @param string|null $alias The alias of the table.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $from
+     */
+    public function from($from, $alias = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $fromAlias
+     * @psalm-taint-sink sql $join
+     * @psalm-taint-sink sql $alias
+     * @psalm-taint-sink sql $condition
+     */
+    public function join($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $fromAlias
+     * @psalm-taint-sink sql $join
+     * @psalm-taint-sink sql $alias
+     * @psalm-taint-sink sql $condition
+     */
+    public function innerJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a left join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $fromAlias
+     * @psalm-taint-sink sql $join
+     * @psalm-taint-sink sql $alias
+     * @psalm-taint-sink sql $condition
+     */
+    public function leftJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a right join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $fromAlias
+     * @psalm-taint-sink sql $join
+     * @psalm-taint-sink sql $alias
+     * @psalm-taint-sink sql $condition
+     */
+    public function rightJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Sets a new value for a column in a bulk update query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $key The column to set.
+     * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $key
+     * @psalm-taint-sink sql $value
+     */
+    public function set($key, $value);
+
+    /**
+     * Specifies one or more restrictions to the query result.
+     * Replaces any previously specified restrictions, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = ?');
+     *
+     *     // You can optionally programmatically build and/or expressions
+     *     $qb = $conn->getQueryBuilder();
+     *
+     *     $or = $qb->expr()->orx();
+     *     $or->add($qb->expr()->eq('u.id', 1));
+     *     $or->add($qb->expr()->eq('u.id', 2));
+     *
+     *     $qb->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where($or);
+     * </code>
+     *
+     * @param mixed $predicates The restriction predicates.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $predicates
+     */
+    public function where(...$predicates);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * conjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.username LIKE ?')
+     *         ->andWhere('u.is_active = 1');
+     * </code>
+     *
+     * @param mixed ...$where The query restrictions.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $where
+     */
+    public function andWhere(...$where);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * disjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = 1')
+     *         ->orWhere('u.id = 2');
+     * </code>
+     *
+     * @param mixed ...$where The WHERE statement.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $where
+     */
+    public function orWhere(...$where);
+
+    /**
+     * Specifies a grouping over the results of the query.
+     * Replaces any previously specified groupings, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.id');
+     * </code>
+     *
+     * @param mixed ...$groupBys The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $groupBys
+     */
+    public function groupBy(...$groupBys);
+
+    /**
+     * Adds a grouping expression to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.lastLogin');
+     *         ->addGroupBy('u.createdAt')
+     * </code>
+     *
+     * @param mixed ...$groupBy The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $groupby
+     */
+    public function addGroupBy(...$groupBy);
+
+    /**
+     * Sets a value for a column in an insert query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?'
+     *             )
+     *         )
+     *         ->setValue('password', '?');
+     * </code>
+     *
+     * @param string $column The column into which the value should be inserted.
+     * @param IParameter|string $value The value that should be inserted into the column.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $column
+     * @psalm-taint-sink sql $value
+     */
+    public function setValue($column, $value);
+
+    /**
+     * Specifies values for an insert query indexed by column names.
+     * Replaces any previous values, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param array $values The values to specify for the insert query indexed by column names.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $values
+     */
+    public function values(array $values);
+
+    /**
+     * Specifies a restriction over the groups of the query.
+     * Replaces any previous having restrictions, if any.
+     *
+     * @param mixed ...$having The restriction over the groups.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $having
+     */
+    public function having(...$having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * conjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to append.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $andHaving
+     */
+    public function andHaving(...$having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * disjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to add.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $having
+     */
+    public function orHaving(...$having);
+
+    /**
+     * Specifies an ordering for the query results.
+     * Replaces any previously specified orderings, if any.
+     *
+     * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $sort
+     * @psalm-taint-sink sql $order
+     */
+    public function orderBy($sort, $order = null);
+
+    /**
+     * Adds an ordering to the query results.
+     *
+     * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql $sort
+     * @psalm-taint-sink sql $order
+     */
+    public function addOrderBy($sort, $order = null);
+
+    /**
+     * Gets a query part by its name.
+     *
+     * @param string $queryPartName
+     *
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function getQueryPart($queryPartName);
+
+    /**
+     * Gets all query parts.
+     *
+     * @return array
+     * @since 8.2.0
+     */
+    public function getQueryParts();
+
+    /**
+     * Resets SQL parts.
+     *
+     * @param array|null $queryPartNames
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryParts($queryPartNames = null);
+
+    /**
+     * Resets a single SQL part.
+     *
+     * @param string $queryPartName
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryPart($queryPartName);
+
+    /**
+     * Creates a new named parameter and bind the value $value to it.
+     *
+     * This method provides a shortcut for PDOStatement::bindValue
+     * when using prepared statements.
+     *
+     * The parameter $value specifies the value that you want to bind. If
+     * $placeholder is not provided bindValue() will automatically create a
+     * placeholder for you. An automatic placeholder will be of the name
+     * ':dcValue1', ':dcValue2' etc.
+     *
+     * For more information see {@link https://www.php.net/pdostatement-bindparam}
+     *
+     * Example:
+     * <code>
+     * $value = 2;
+     * $q->eq( 'id', $q->bindValue( $value ) );
+     * $stmt = $q->executeQuery(); // executed with 'id = 2'
+     * </code>
+     *
+     * @license New BSD License
+     * @link http://www.zetacomponents.org
+     *
+     * @param mixed $value
+     * @param mixed $type
+     * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
+     *
+     * @return IParameter
+     * @since 8.2.0
+     *
+     * @psalm-taint-escape sql
+     */
+    public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
+
+    /**
+     * Creates a new positional parameter and bind the given value to it.
+     *
+     * Attention: If you are using positional parameters with the query builder you have
+     * to be very careful to bind all parameters in the order they appear in the SQL
+     * statement , otherwise they get bound in the wrong order which can lead to serious
+     * bugs in your code.
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
+     *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param mixed $value
+     * @param integer $type
+     *
+     * @return IParameter
+     * @since 8.2.0
+     *
+     * @psalm-taint-escape sql
+     */
+    public function createPositionalParameter($value, $type = self::PARAM_STR);
+
+    /**
+     * Creates a new parameter
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createParameter('name'))
+     *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param string $name
+     *
+     * @return IParameter
+     * @since 8.2.0
+     *
+     * @psalm-taint-escape sql
+     */
+    public function createParameter($name);
+
+    /**
+     * Creates a new function
+     *
+     * Attention: Column names inside the call have to be quoted before hand
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(*)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
+     * </code>
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(`column`)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
+     * </code>
+     *
+     * @param string $call
+     *
+     * @return IQueryFunction
+     * @since 8.2.0
+     *
+     * @psalm-taint-sink sql
+     */
+    public function createFunction($call);
+
+    /**
+     * Used to get the id of the last inserted element
+     * @return int
+     * @throws \BadMethodCallException When being called before an insert query has been run.
+     * @since 9.0.0
+     */
+    public function getLastInsertId(): int;
+
+    /**
+     * Returns the table name quoted and with database prefix as needed by the implementation
+     *
+     * @param string|IQueryFunction $table
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTableName($table);
+
+    /**
+     * Returns the column name quoted and with table alias prefix as needed by the implementation
+     *
+     * @param string $column
+     * @param string $tableAlias
+     * @return string
+     * @since 9.0.0
+     */
+    public function getColumnName($column, $tableAlias = '');
 }

lib/public/Accounts/IAccount.php

Indentation +121 added lines, -121 removed lines

@@ -35,133 +35,133 @@
  * @since 15.0.0
  */
 interface IAccount extends \JsonSerializable {
-	/**
-	 * Set a property with data
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $property  Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
-	 * @param string $value
-	 * @param string $scope Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
-	 * @param string $verified \OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED
-	 * @param string $verificationData Optional, defaults to empty string. Since @22.0.0.
-	 * @return IAccount
-	 */
-	public function setProperty(string $property, string $value, string $scope, string $verified, string $verificationData = ''): IAccount;
+    /**
+     * Set a property with data
+     *
+     * @since 15.0.0
+     *
+     * @param string $property  Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
+     * @param string $value
+     * @param string $scope Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
+     * @param string $verified \OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED
+     * @param string $verificationData Optional, defaults to empty string. Since @22.0.0.
+     * @return IAccount
+     */
+    public function setProperty(string $property, string $value, string $scope, string $verified, string $verificationData = ''): IAccount;
 
-	/**
-	 * Get a property by its key
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $property Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
-	 * @return IAccountProperty
-	 * @throws PropertyDoesNotExistException
-	 */
-	public function getProperty(string $property): IAccountProperty;
+    /**
+     * Get a property by its key
+     *
+     * @since 15.0.0
+     *
+     * @param string $property Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
+     * @return IAccountProperty
+     * @throws PropertyDoesNotExistException
+     */
+    public function getProperty(string $property): IAccountProperty;
 
-	/**
-	 * Get all properties of an account. Array indices are property names.
-	 * Values from IAccountPropertyCollections are not included in the return
-	 * array.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 22.0.0 use getAllProperties()
-	 */
-	public function getProperties(): array;
+    /**
+     * Get all properties of an account. Array indices are property names.
+     * Values from IAccountPropertyCollections are not included in the return
+     * array.
+     *
+     * @since 15.0.0
+     * @deprecated 22.0.0 use getAllProperties()
+     */
+    public function getProperties(): array;
 
-	/**
-	 * Set all properties of an account
-	 *
-	 * @param array<string, array<string, string>>|array<string, array<int, array<string, string>>> $properties
-	 *
-	 * e.g. `[
-	 *   'displayname' => [
-	 *     'name' => 'displayname',
-	 *     'value' => 'Jonathan Smith',
-	 *     'scope' => 'v2-federated',
-	 *     'verified' => '0',
-	 *     'verificationData' => '',
-	 *   ],
-	 *   'email' => [
-	 *     'name' => 'email',
-	 *     'value' => 'jonathan@example.org',
-	 *     'scope' => 'v2-federated',
-	 *     'verified' => '0',
-	 *     'verificationData' => '',
-	 *   ],
-	 *   // ...
-	 *   'additional_mail' => [
-	 *     [
-	 *       'name' => 'additional_mail',
-	 *       'value' => 'jon@example.org',
-	 *       'scope' => 'v2-local',
-	 *       'verified' => '0',
-	 *       'verificationData' => '',
-	 *     ],
-	 *     [
-	 *       'name' => 'additional_mail',
-	 *       'value' => 'jon@earth.org',
-	 *       'scope' => 'v2-local',
-	 *       'verified' => '0',
-	 *       'verificationData' => '',
-	 *     ],
-	 *   ],
-	 * ]`
-	 *
-	 * @since 24.0.0
-	 */
-	public function setAllPropertiesFromJson(array $properties): IAccount;
+    /**
+     * Set all properties of an account
+     *
+     * @param array<string, array<string, string>>|array<string, array<int, array<string, string>>> $properties
+     *
+     * e.g. `[
+     *   'displayname' => [
+     *     'name' => 'displayname',
+     *     'value' => 'Jonathan Smith',
+     *     'scope' => 'v2-federated',
+     *     'verified' => '0',
+     *     'verificationData' => '',
+     *   ],
+     *   'email' => [
+     *     'name' => 'email',
+     *     'value' => 'jonathan@example.org',
+     *     'scope' => 'v2-federated',
+     *     'verified' => '0',
+     *     'verificationData' => '',
+     *   ],
+     *   // ...
+     *   'additional_mail' => [
+     *     [
+     *       'name' => 'additional_mail',
+     *       'value' => 'jon@example.org',
+     *       'scope' => 'v2-local',
+     *       'verified' => '0',
+     *       'verificationData' => '',
+     *     ],
+     *     [
+     *       'name' => 'additional_mail',
+     *       'value' => 'jon@earth.org',
+     *       'scope' => 'v2-local',
+     *       'verified' => '0',
+     *       'verificationData' => '',
+     *     ],
+     *   ],
+     * ]`
+     *
+     * @since 24.0.0
+     */
+    public function setAllPropertiesFromJson(array $properties): IAccount;
 
-	/**
-	 * Get all properties of an account. Array indices are numeric. To get
-	 * the property name, call getName() against the value.
-	 *
-	 * IAccountPropertyCollections are being flattened into an IAccountProperty
-	 * for each value.
-	 *
-	 * @since 22.0.0
-	 *
-	 * @return Generator<int, IAccountProperty>
-	 */
-	public function getAllProperties(): Generator;
+    /**
+     * Get all properties of an account. Array indices are numeric. To get
+     * the property name, call getName() against the value.
+     *
+     * IAccountPropertyCollections are being flattened into an IAccountProperty
+     * for each value.
+     *
+     * @since 22.0.0
+     *
+     * @return Generator<int, IAccountProperty>
+     */
+    public function getAllProperties(): Generator;
 
-	/**
-	 * Set a property collection (multi-value properties)
-	 *
-	 * @since 22.0.0
-	 */
-	public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount;
+    /**
+     * Set a property collection (multi-value properties)
+     *
+     * @since 22.0.0
+     */
+    public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount;
 
-	/**
-	 * Returns the requested property collection (multi-value properties)
-	 *
-	 * @throws PropertyDoesNotExistException against invalid collection name
-	 * @since 22.0.0
-	 */
-	public function getPropertyCollection(string $propertyCollectionName): IAccountPropertyCollection;
+    /**
+     * Returns the requested property collection (multi-value properties)
+     *
+     * @throws PropertyDoesNotExistException against invalid collection name
+     * @since 22.0.0
+     */
+    public function getPropertyCollection(string $propertyCollectionName): IAccountPropertyCollection;
 
-	/**
-	 * Get all properties that match the provided filters for scope and verification status
-	 *
-	 * Since 22.0.0 values from IAccountPropertyCollection are included, but also
-	 * as IAccountProperty instances. They for properties of IAccountPropertyCollection are
-	 * suffixed incrementally, i.e. #0, #1 ... #n – the numbers have no further meaning.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $scope Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
-	 * @param string $verified \OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED
-	 * @return IAccountProperty[]
-	 */
-	public function getFilteredProperties(string $scope = null, string $verified = null): array;
+    /**
+     * Get all properties that match the provided filters for scope and verification status
+     *
+     * Since 22.0.0 values from IAccountPropertyCollection are included, but also
+     * as IAccountProperty instances. They for properties of IAccountPropertyCollection are
+     * suffixed incrementally, i.e. #0, #1 ... #n – the numbers have no further meaning.
+     *
+     * @since 15.0.0
+     *
+     * @param string $scope Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
+     * @param string $verified \OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED
+     * @return IAccountProperty[]
+     */
+    public function getFilteredProperties(string $scope = null, string $verified = null): array;
 
-	/**
-	 * Get the related user for the account data
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IUser
-	 */
-	public function getUser(): IUser;
+    /**
+     * Get the related user for the account data
+     *
+     * @since 15.0.0
+     *
+     * @return IUser
+     */
+    public function getUser(): IUser;
 }

lib/public/Accounts/IAccountPropertyCollection.php

Indentation +53 added lines, -53 removed lines

@@ -37,64 +37,64 @@
  * @since 22.0.0
  */
 interface IAccountPropertyCollection extends JsonSerializable {
-	/**
-	 * returns the collection name
-	 *
-	 * @since 22.0.0
-	 */
-	public function getName(): string;
+    /**
+     * returns the collection name
+     *
+     * @since 22.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * set properties of this collection
-	 *
-	 * @param IAccountProperty[] $properties
-	 * @throws InvalidArgumentException
-	 * @since 22.0.0
-	 */
-	public function setProperties(array $properties): IAccountPropertyCollection;
+    /**
+     * set properties of this collection
+     *
+     * @param IAccountProperty[] $properties
+     * @throws InvalidArgumentException
+     * @since 22.0.0
+     */
+    public function setProperties(array $properties): IAccountPropertyCollection;
 
-	/**
-	 * @return IAccountProperty[]
-	 * @since 22.0.0
-	 */
-	public function getProperties(): array;
+    /**
+     * @return IAccountProperty[]
+     * @since 22.0.0
+     */
+    public function getProperties(): array;
 
-	/**
-	 * adds a property to this collection
-	 *
-	 * @throws InvalidArgumentException
-	 * @since 22.0.0
-	 */
-	public function addProperty(IAccountProperty $property): IAccountPropertyCollection;
+    /**
+     * adds a property to this collection
+     *
+     * @throws InvalidArgumentException
+     * @since 22.0.0
+     */
+    public function addProperty(IAccountProperty $property): IAccountPropertyCollection;
 
-	/**
-	 * adds a property to this collection with only specifying the value
-	 *
-	 * @throws InvalidArgumentException
-	 * @since 22.0.0
-	 */
-	public function addPropertyWithDefaults(string $value): IAccountPropertyCollection;
+    /**
+     * adds a property to this collection with only specifying the value
+     *
+     * @throws InvalidArgumentException
+     * @since 22.0.0
+     */
+    public function addPropertyWithDefaults(string $value): IAccountPropertyCollection;
 
-	/**
-	 * removes a property of this collection
-	 *
-	 * @since 22.0.0
-	 */
-	public function removeProperty(IAccountProperty $property): IAccountPropertyCollection;
+    /**
+     * removes a property of this collection
+     *
+     * @since 22.0.0
+     */
+    public function removeProperty(IAccountProperty $property): IAccountPropertyCollection;
 
-	/**
-	 * removes a property identified by its value
-	 *
-	 * @since 22.0.0
-	 */
-	public function removePropertyByValue(string $value): IAccountPropertyCollection;
+    /**
+     * removes a property identified by its value
+     *
+     * @since 22.0.0
+     */
+    public function removePropertyByValue(string $value): IAccountPropertyCollection;
 
-	/**
-	 * retrieves a property identified by its value. null, if none was found.
-	 *
-	 * Returns only the first property if there are more with the same value.
-	 *
-	 * @since 23.0.0
-	 */
-	public function getPropertyByValue(string $value): ?IAccountProperty;
+    /**
+     * retrieves a property identified by its value. null, if none was found.
+     *
+     * Returns only the first property if there are more with the same value.
+     *
+     * @since 23.0.0
+     */
+    public function getPropertyByValue(string $value): ?IAccountProperty;
 }