nextcloud / server

lib/public/Contacts/IManager.php

Indentation +121 added lines, -121 removed lines

@@ -55,134 +55,134 @@
  */
 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
-	 * 	- '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
-	 * @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
+     * 	- '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
+     * @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 object $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 object $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 display names
-	 *
-	 * @return array
-	 * @since 6.0.0
-	 * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
-	 */
-	public function getAddressBooks();
+    /**
+     * Return a list of the user's addressbooks display names
+     *
+     * @return array
+     * @since 6.0.0
+     * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
+     */
+    public function getAddressBooks();
 
-	/**
-	 * 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();
 }