docs: document types flag for search options

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>

diff --git a/lib/private/ContactsManager.php b/lib/private/ContactsManager.php
index 9853701a2ebad199cbea4b08842adaa03ff60c4a..cc8111774d1854cffe5b75fd55a7e42cdd890be8 100644 (file)
--- a/lib/private/ContactsManager.php
+++ b/lib/private/ContactsManager.php
@@ -40,13 +40,15 @@ class ContactsManager implements IManager {
         * @param string $pattern which should match within the $searchProperties
         * @param array $searchProperties defines the properties within the query pattern should match
         * @param array $options = array() to define the 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
         *      - 'limit' - Set a numeric limit for the search results
         *      - 'offset' - Set the offset for the limited search results
         *      - 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed
         *      - 'fullmatch' - (since 23.0.0) Whether matching on full detail in system address book is allowed
         *      - 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search
-        * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
+        * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         */
        public function search($pattern, $searchProperties = [], $options = []) {

diff --git a/lib/public/Contacts/IManager.php b/lib/public/Contacts/IManager.php
index ce50f8d5b329b871ff95c6afa502239ff93dff6d..2e87f6c8afc1165dddbfd2d0d6f33524eb788b42 100644 (file)
--- a/lib/public/Contacts/IManager.php
+++ b/lib/public/Contacts/IManager.php
@@ -90,13 +90,15 @@ interface IManager {
         * @param string $pattern which should match within the $searchProperties
         * @param array $searchProperties defines the properties within the query pattern should match
         * @param array $options = array() to define the 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
         *      - 'limit' - Set a numeric limit for the search results
         *      - 'offset' - Set the offset for the limited search results
         *      - 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed
         *      - 'fullmatch' - (since 23.0.0) Whether matching on full detail in system addresss book is allowed
         *      - 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search
-        * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
+        * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         * @since 6.0.0
         */