Dont assign $options to $options and cleanup doc

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
This commit is contained in:
Daniel Kesselberg 2019-07-22 18:48:47 +02:00
parent 3a6d8174a9
commit 77c09252d5
No known key found for this signature in database
GPG key ID: 36E3664E099D0614
2 changed files with 4 additions and 5 deletions

View file

@ -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;

View file

@ -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:
* [