2012-11-13 02:25:32 +04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ownCloud
|
|
|
|
*
|
|
|
|
* @author Thomas Müller
|
|
|
|
* @copyright 2012 Thomas Müller thomas.mueller@tmit.eu
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 3 of the License, or any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Affero General Public
|
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* Contacts Class
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
// use OCP namespace for all classes that are considered public.
|
|
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
2012-11-23 03:30:11 +04:00
|
|
|
namespace OCP {
|
2012-11-13 02:25:32 +04:00
|
|
|
|
|
|
|
/**
|
2012-11-23 03:30:11 +04:00
|
|
|
* 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.
|
2012-11-13 02:25:32 +04:00
|
|
|
*
|
|
|
|
*/
|
2012-11-23 03:30:11 +04:00
|
|
|
class Contacts {
|
2012-11-13 02:25:32 +04:00
|
|
|
|
2012-11-23 03:30:11 +04:00
|
|
|
/**
|
|
|
|
* This function is used to search and find contacts within the users address books.
|
|
|
|
* In case $pattern is empty all contacts will be returned.
|
|
|
|
*
|
2012-12-02 14:54:30 +04:00
|
|
|
* Example:
|
|
|
|
* Following function shows how to search for contacts for the name and the email address.
|
|
|
|
*
|
2012-12-15 02:16:32 +04:00
|
|
|
* public static function getMatchingRecipient($term) {
|
|
|
|
* // The API is not active -> nothing to do
|
2012-12-02 14:54:30 +04:00
|
|
|
* if (!\OCP\Contacts::isEnabled()) {
|
2012-12-15 02:16:32 +04:00
|
|
|
* return array();
|
2012-12-02 14:54:30 +04:00
|
|
|
* }
|
|
|
|
*
|
|
|
|
* $result = \OCP\Contacts::search($term, array('FN', 'EMAIL'));
|
|
|
|
* $receivers = array();
|
|
|
|
* foreach ($result as $r) {
|
2012-12-15 02:16:32 +04:00
|
|
|
* $id = $r['id'];
|
|
|
|
* $fn = $r['FN'];
|
|
|
|
* $email = $r['EMAIL'];
|
|
|
|
* if (!is_array($email)) {
|
|
|
|
* $email = array($email);
|
|
|
|
* }
|
2012-12-02 14:54:30 +04:00
|
|
|
*
|
2012-12-15 02:16:32 +04:00
|
|
|
* // loop through all email addresses of this contact
|
|
|
|
* foreach ($email as $e) {
|
|
|
|
* $displayName = $fn . " <$e>";
|
|
|
|
* $receivers[] = array(
|
|
|
|
* 'id' => $id,
|
|
|
|
* 'label' => $displayName,
|
|
|
|
* 'value' => $displayName);
|
|
|
|
* }
|
2012-12-02 14:54:30 +04:00
|
|
|
* }
|
|
|
|
*
|
|
|
|
* return $receivers;
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
*
|
2012-11-23 03:30:11 +04:00
|
|
|
* @param string $pattern which should match within the $searchProperties
|
|
|
|
* @param array $searchProperties defines the properties within the query pattern should match
|
|
|
|
* @param array $options - for future use. One should always have options!
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array of contacts which are arrays of key-value-pairs
|
2012-11-23 03:30:11 +04:00
|
|
|
*/
|
|
|
|
public static function search($pattern, $searchProperties = array(), $options = array()) {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->search($pattern, $searchProperties, $options);
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
2012-11-13 02:25:32 +04:00
|
|
|
|
2012-11-23 03:30:11 +04:00
|
|
|
/**
|
|
|
|
* This function can be used to delete the contact identified by the given id
|
|
|
|
*
|
|
|
|
* @param object $id the unique identifier to a contact
|
|
|
|
* @param $address_book_key
|
|
|
|
* @return bool successful or not
|
|
|
|
*/
|
|
|
|
public static function delete($id, $address_book_key) {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->delete($id, $address_book_key);
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 $address_book_key string to identify the address book in which the contact shall be created or updated
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array representing the contact just created or updated
|
2012-11-23 03:30:11 +04:00
|
|
|
*/
|
|
|
|
public static function createOrUpdate($properties, $address_book_key) {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->search($properties, $address_book_key);
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if contacts are available (e.g. contacts app enabled)
|
|
|
|
*
|
|
|
|
* @return bool true if enabled, false if not
|
|
|
|
*/
|
|
|
|
public static function isEnabled() {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->isEnabled();
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-12-11 20:42:09 +04:00
|
|
|
* @param \OCP\IAddressBook $address_book
|
2012-11-23 03:30:11 +04:00
|
|
|
*/
|
2013-02-06 20:37:47 +04:00
|
|
|
public static function registerAddressBook(\OCP\IAddressBook $address_book) {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->registerAddressBook($address_book);
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-12-11 20:42:09 +04:00
|
|
|
* @param \OCP\IAddressBook $address_book
|
2012-11-23 03:30:11 +04:00
|
|
|
*/
|
2013-02-06 20:37:47 +04:00
|
|
|
public static function unregisterAddressBook(\OCP\IAddressBook $address_book) {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->unregisterAddressBook($address_book);
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public static function getAddressBooks() {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
return $cm->getAddressBooks();
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
|
|
|
|
2012-11-24 03:01:58 +04:00
|
|
|
/**
|
|
|
|
* removes all registered address book instances
|
|
|
|
*/
|
|
|
|
public static function clear() {
|
2013-08-27 01:48:18 +04:00
|
|
|
$cm = \OC::$server->getContactsManager();
|
|
|
|
$cm->clear();
|
2012-11-24 03:01:58 +04:00
|
|
|
}
|
2012-11-23 03:30:11 +04:00
|
|
|
}
|
2012-11-24 03:01:58 +04:00
|
|
|
}
|