diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 49e0717948..3331d57e13 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -91,7 +91,6 @@ return array( 'OCP\\Comments\\NotFoundException' => $baseDir . '/lib/public/Comments/NotFoundException.php', 'OCP\\Console\\ConsoleEvent' => $baseDir . '/lib/public/Console/ConsoleEvent.php', 'OCP\\Constants' => $baseDir . '/lib/public/Constants.php', - 'OCP\\Contacts' => $baseDir . '/lib/public/Contacts.php', 'OCP\\Contacts\\ContactsMenu\\IAction' => $baseDir . '/lib/public/Contacts/ContactsMenu/IAction.php', 'OCP\\Contacts\\ContactsMenu\\IActionFactory' => $baseDir . '/lib/public/Contacts/ContactsMenu/IActionFactory.php', 'OCP\\Contacts\\ContactsMenu\\IContactsStore' => $baseDir . '/lib/public/Contacts/ContactsMenu/IContactsStore.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index d876cf0e23..e35ef7d7a0 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -121,7 +121,6 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Comments\\NotFoundException' => __DIR__ . '/../../..' . '/lib/public/Comments/NotFoundException.php', 'OCP\\Console\\ConsoleEvent' => __DIR__ . '/../../..' . '/lib/public/Console/ConsoleEvent.php', 'OCP\\Constants' => __DIR__ . '/../../..' . '/lib/public/Constants.php', - 'OCP\\Contacts' => __DIR__ . '/../../..' . '/lib/public/Contacts.php', 'OCP\\Contacts\\ContactsMenu\\IAction' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IAction.php', 'OCP\\Contacts\\ContactsMenu\\IActionFactory' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IActionFactory.php', 'OCP\\Contacts\\ContactsMenu\\IContactsStore' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IContactsStore.php', diff --git a/lib/public/Contacts.php b/lib/public/Contacts.php deleted file mode 100644 index 16cd52d19c..0000000000 --- a/lib/public/Contacts.php +++ /dev/null @@ -1,185 +0,0 @@ - - * @author Morris Jobke - * @author Robin McCorkell - * @author Thomas Müller - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * This program 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, version 3, - * along with this program. If not, see - * - */ - -/** - * 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 -namespace OCP { - - /** - * 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. - * - * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - class Contacts { - - /** - * 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) { - * // The API is not active -> nothing to do - * if (!\OCP\Contacts::isEnabled()) { - * return array(); - * } - * - * $result = \OCP\Contacts::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 - for future use. One should always have options! - * @return array an array of contacts which are arrays of key-value-pairs - * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function search($pattern, $searchProperties = array(), $options = array()) { - $cm = \OC::$server->getContactsManager(); - return $cm->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 - * @return bool successful or not - * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function delete($id, $address_book_key) { - $cm = \OC::$server->getContactsManager(); - return $cm->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 - * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function createOrUpdate($properties, $address_book_key) { - $cm = \OC::$server->getContactsManager(); - return $cm->createOrUpdate($properties, $address_book_key); - } - - /** - * Check if contacts are available (e.g. contacts app enabled) - * - * @return bool true if enabled, false if not - * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function isEnabled() { - $cm = \OC::$server->getContactsManager(); - return $cm->isEnabled(); - } - - /** - * @param \OCP\IAddressBook $address_book - * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function registerAddressBook(\OCP\IAddressBook $address_book) { - $cm = \OC::$server->getContactsManager(); - $cm->registerAddressBook($address_book); - } - - /** - * @param \OCP\IAddressBook $address_book - * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function unregisterAddressBook(\OCP\IAddressBook $address_book) { - $cm = \OC::$server->getContactsManager(); - $cm->unregisterAddressBook($address_book); - } - - /** - * @return array - * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function getAddressBooks() { - $cm = \OC::$server->getContactsManager(); - return $cm->getAddressBooks(); - } - - /** - * removes all registered address book instances - * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); - * @since 5.0.0 - */ - public static function clear() { - $cm = \OC::$server->getContactsManager(); - $cm->clear(); - } - } -} diff --git a/tests/lib/PublicNamespace/ContactsTest.php b/tests/lib/PublicNamespace/ContactsTest.php index 8b07c4831b..58e3deea61 100644 --- a/tests/lib/PublicNamespace/ContactsTest.php +++ b/tests/lib/PublicNamespace/ContactsTest.php @@ -21,19 +21,24 @@ namespace Test\PublicNamespace; +use OCP\IAddressBook; + class ContactsTest extends \Test\TestCase { protected function setUp() { parent::setUp(); - \OCP\Contacts::clear(); + \OC::$server->getContactsManager()->clear(); } public function testDisabledIfEmpty() { // pretty simple - $this->assertFalse(\OCP\Contacts::isEnabled()); + $this->assertFalse(\OC::$server->getContactsManager()->isEnabled()); } public function testEnabledAfterRegister() { + $cm = \OC::$server->getContactsManager(); + // create mock for the addressbook + /** @var \PHPUnit_Framework_MockObject_MockObject|IAddressBook $stub */ $stub = $this->getMockForAbstractClass("OCP\IAddressBook", array('getKey')); // we expect getKey to be called twice: @@ -43,23 +48,24 @@ class ContactsTest extends \Test\TestCase { ->method('getKey'); // not enabled before register - $this->assertFalse(\OCP\Contacts::isEnabled()); + $this->assertFalse($cm->isEnabled()); // register the address book - \OCP\Contacts::registerAddressBook($stub); + $cm->registerAddressBook($stub); // contacts api shall be enabled - $this->assertTrue(\OCP\Contacts::isEnabled()); + $this->assertTrue($cm->isEnabled()); // unregister the address book - \OCP\Contacts::unregisterAddressBook($stub); + $cm->unregisterAddressBook($stub); // not enabled after register - $this->assertFalse(\OCP\Contacts::isEnabled()); + $this->assertFalse($cm->isEnabled()); } public function testAddressBookEnumeration() { // create mock for the addressbook + /** @var \PHPUnit_Framework_MockObject_MockObject|IAddressBook $stub */ $stub = $this->getMockForAbstractClass("OCP\IAddressBook", array('getKey', 'getDisplayName')); // setup return for method calls @@ -71,8 +77,9 @@ class ContactsTest extends \Test\TestCase { ->will($this->returnValue('A very simple Addressbook')); // register the address book - \OCP\Contacts::registerAddressBook($stub); - $all_books = \OCP\Contacts::getAddressBooks(); + $cm = \OC::$server->getContactsManager(); + $cm->registerAddressBook($stub); + $all_books = $cm->getAddressBooks(); $this->assertEquals(1, count($all_books)); $this->assertEquals('A very simple Addressbook', $all_books['SIMPLE_ADDRESS_BOOK']); @@ -80,7 +87,9 @@ class ContactsTest extends \Test\TestCase { public function testSearchInAddressBook() { // create mock for the addressbook + /** @var \PHPUnit_Framework_MockObject_MockObject|IAddressBook $stub1 */ $stub1 = $this->getMockForAbstractClass("OCP\IAddressBook", array('getKey', 'getDisplayName', 'search')); + /** @var \PHPUnit_Framework_MockObject_MockObject|IAddressBook $stub2 */ $stub2 = $this->getMockForAbstractClass("OCP\IAddressBook", array('getKey', 'getDisplayName', 'search')); $searchResult1 = array( @@ -103,15 +112,16 @@ class ContactsTest extends \Test\TestCase { $stub2->expects($this->any())->method('search')->will($this->returnValue($searchResult2)); // register the address books - \OCP\Contacts::registerAddressBook($stub1); - \OCP\Contacts::registerAddressBook($stub2); - $all_books = \OCP\Contacts::getAddressBooks(); + $cm = \OC::$server->getContactsManager(); + $cm->registerAddressBook($stub1); + $cm->registerAddressBook($stub2); + $all_books = $cm->getAddressBooks(); // assert the count - doesn't hurt $this->assertEquals(2, count($all_books)); // perform the search - $result = \OCP\Contacts::search('x', array()); + $result = $cm->search('x', array()); // we expect 4 hits $this->assertEquals(4, count($result)); diff --git a/tests/lib/PublicNamespace/UtilTest.php b/tests/lib/PublicNamespace/UtilTest.php index 31d1f9fb0e..7892501aaa 100644 --- a/tests/lib/PublicNamespace/UtilTest.php +++ b/tests/lib/PublicNamespace/UtilTest.php @@ -23,11 +23,6 @@ namespace Test\PublicNamespace; class UtilTest extends \Test\TestCase { - protected function setUp() { - parent::setUp(); - \OCP\Contacts::clear(); - } - /** * @dataProvider channelProvider *