nextcloud-server/lib/public/Contacts/IManager.php

<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal Nextcloud classes

namespace OCP\Contacts;

/**
 * This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
 *
 * Contacts in general will be expressed as an array of key-value-pairs.
 * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1
 *
 * Proposed workflow for working with contacts:
 *  - search for the contacts
 *  - manipulate the results array
 *  - createOrUpdate will save the given contacts overwriting the existing data
 *
 * For updating it is mandatory to keep the id.
 * Without an id a new contact will be created.
 *
 * @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 = \OCP\Server::get(\OCP\Contacts\IManager::class);
	 *			// 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 $addressBookKey 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, $addressBookKey);

	/**
	 * 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 $addressBookKey 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, $addressBookKey);

	/**
	 * 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
	 *
	 * @return void
	 * @since 6.0.0
	 */
	public function registerAddressBook(\OCP\IAddressBook $addressBook);

	/**
	 * Unregisters an address book
	 *
	 * @param \OCP\IAddressBook $addressBook
	 * @return void
	 * @since 6.0.0
	 */
	public function unregisterAddressBook(\OCP\IAddressBook $addressBook);

	/**
	 * 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();

	/**
	 * removes all registered address book instances
	 *
	 * @return void
	 * @since 6.0.0
	 */
	public function clear();
}