From 77c09252d5333a3665ccd5bf058666d5a26ee3b7 Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Mon, 22 Jul 2019 18:48:47 +0200 Subject: [PATCH] Dont assign $options to $options and cleanup doc Signed-off-by: Daniel Kesselberg --- apps/dav/lib/CardDAV/AddressBookImpl.php | 4 +--- lib/public/IAddressBook.php | 5 +++-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/apps/dav/lib/CardDAV/AddressBookImpl.php b/apps/dav/lib/CardDAV/AddressBookImpl.php index 918b4eb225..21455fc386 100644 --- a/apps/dav/lib/CardDAV/AddressBookImpl.php +++ b/apps/dav/lib/CardDAV/AddressBookImpl.php @@ -107,12 +107,10 @@ class AddressBookImpl implements IAddressBook { * ['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'], * ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']] * ] - * @param array $options = array() 'escape_like_param' - to not escape wildcards _ and % - for future use. One should always have options! - * @return array an array of contacts which are arrays of key-value-pairs * @since 5.0.0 */ public function search($pattern, $searchProperties, $options) { - $results = $this->backend->search($this->getKey(), $pattern, $searchProperties, $options = $options); + $results = $this->backend->search($this->getKey(), $pattern, $searchProperties, $options); $withTypes = \array_key_exists('types', $options) && $options['types'] === true; diff --git a/lib/public/IAddressBook.php b/lib/public/IAddressBook.php index c666311ffb..8d86773e77 100644 --- a/lib/public/IAddressBook.php +++ b/lib/public/IAddressBook.php @@ -62,9 +62,10 @@ namespace OCP { /** * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match - * @param array $options Options to define the output format - * - types boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array + * @param array $options Options to define the output format and 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 * @return array an array of contacts which are arrays of key-value-pairs * example result: * [