Merge pull request #383 from owncloud/contacts_api

Proposal for a public contacts api
2012-11-19 05:42:01 -08:00 · 2012-11-19 05:42:01 -08:00 · d91c841f73
parent 5b2aeebaf0 33a4dfa087
commit d91c841f73
1 changed files with 103 additions and 0 deletions
--- a/lib/public/contacts.php
+++ b/lib/public/contacts.php
@ -0,0 +1,103 @@
+<?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
+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.
+ *
+ */
+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.
+	 *
+	 * @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 static function search($pattern, $searchProperties = array(), $options = array()) {
+
+		// dummy results
+		return array(
+			array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'),
+			array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')),
+		);
+	}
+
+	/**
+	 * This function can be used to delete the contact identified by the given id
+	 *
+	 * @param object $id the unique identifier to a contact
+	 * @return bool successful or not
+	 */
+	public static function delete($id) {
+		return false;
+	}
+
+	/**
+	 * 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
+	 * @return array representing the contact just created or updated
+	 */
+	public static function createOrUpdate($properties) {
+
+		// dummy
+		return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
+		             'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
+		             'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
+		);
+	}
+
+	/**
+	 * Check if contacts are available (e.g. contacts app enabled)
+	 *
+	 * @return bool true if enabled, false if not
+	 */
+	public static function isEnabled() {
+		return false;
+	}
+
+}