145 lines
4.3 KiB
PHP
145 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* ownCloud
|
|
*
|
|
* @author Thomas Müller
|
|
* @copyright 2013 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/>.
|
|
*
|
|
*/
|
|
|
|
namespace OC {
|
|
|
|
class ContactsManager implements \OCP\Contacts\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.
|
|
*
|
|
* @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!
|
|
* @return array of contacts which are arrays of key-value-pairs
|
|
*/
|
|
public function search($pattern, $searchProperties = array(), $options = array()) {
|
|
$result = array();
|
|
foreach($this->address_books as $address_book) {
|
|
$r = $address_book->search($pattern, $searchProperties, $options);
|
|
$result = array_merge($result, $r);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* 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 function delete($id, $address_book_key) {
|
|
if (!array_key_exists($address_book_key, $this->address_books))
|
|
return null;
|
|
|
|
$address_book = $this->address_books[$address_book_key];
|
|
if ($address_book->getPermissions() & \OCP\PERMISSION_DELETE)
|
|
return null;
|
|
|
|
return $address_book->delete($id);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* @return array representing the contact just created or updated
|
|
*/
|
|
public function createOrUpdate($properties, $address_book_key) {
|
|
|
|
if (!array_key_exists($address_book_key, $this->address_books))
|
|
return null;
|
|
|
|
$address_book = $this->address_books[$address_book_key];
|
|
if ($address_book->getPermissions() & \OCP\PERMISSION_CREATE)
|
|
return null;
|
|
|
|
return $address_book->createOrUpdate($properties);
|
|
}
|
|
|
|
/**
|
|
* Check if contacts are available (e.g. contacts app enabled)
|
|
*
|
|
* @return bool true if enabled, false if not
|
|
*/
|
|
public function isEnabled() {
|
|
return !empty($this->address_books);
|
|
}
|
|
|
|
/**
|
|
* @param \OCP\IAddressBook $address_book
|
|
*/
|
|
public function registerAddressBook(\OCP\IAddressBook $address_book) {
|
|
$this->address_books[$address_book->getKey()] = $address_book;
|
|
}
|
|
|
|
/**
|
|
* @param \OCP\IAddressBook $address_book
|
|
*/
|
|
public function unregisterAddressBook(\OCP\IAddressBook $address_book) {
|
|
unset($this->address_books[$address_book->getKey()]);
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getAddressBooks() {
|
|
$result = array();
|
|
foreach($this->address_books as $address_book) {
|
|
$result[$address_book->getKey()] = $address_book->getDisplayName();
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* removes all registered address book instances
|
|
*/
|
|
public function clear() {
|
|
$this->address_books = array();
|
|
}
|
|
|
|
/**
|
|
* @var \OCP\IAddressBook[] which holds all registered address books
|
|
*/
|
|
private $address_books = array();
|
|
|
|
/**
|
|
* In order to improve lazy loading a closure can be registered which will be called in case
|
|
* address books are actually requested
|
|
*
|
|
* @param string $key
|
|
* @param \Closure $callable
|
|
*/
|
|
function register($key, \Closure $callable)
|
|
{
|
|
//
|
|
//TODO: implement me
|
|
//
|
|
}
|
|
}
|
|
}
|