docs: document types flag for search options

[kesselb]

Summary

Psalm warning for Mail:

ERROR: InvalidArgument - lib/Service/ContactsIntegration.php:183:59 - Argument 3 of OCP\Contacts\IManager::search expects array{enumeration?: bool, escape_like_param?: bool, fullmatch?: bool, limit?: int, offset?: int, strict_search?: bool}, but array{limit: 1, types: true} with additional array shape fields (types) was provided (see https://psalm.dev/004)

$result = $this->contactsManager->search($uid, ['UID'], ['types' => true, 'limit' => 1]);

server/lib/public/IAddressBook.php

Lines 61 to 80 in 2e0d262

	/**
	* @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 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
	* - 'limit' - Set a numeric limit for the search results
	* - 'offset' - Set the offset for the limited search results
	* - 'wildcard' - (since 23.0.0) Whether the search should use wildcards
	* @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, wildcard?: bool} $options
	* @return array an array of contacts which are arrays of key-value-pairs
	* example result:
	* [
	* ['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']]
	* ]
	* @since 5.0.0
	*/
	public function search($pattern, $searchProperties, $options);

The documentation for IAdressBook is up-to-date.
OCP\Contacts\IManager misses the types search options flag.

TODO

• Make Psalm happy

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)

[PVince81]

/rebase

[ChristophWurst]

Backport?

[kesselb]

/backport to stable25