Skip to content
Snippets Groups Projects
Commit b16784b6 authored by catch's avatar catch
Browse files

Issue #2850057 by Munavijayalakshmi, gaurav.kapoor, ankithashetty, Pavan B S,...

Issue #2850057 by Munavijayalakshmi, gaurav.kapoor, ankithashetty, Pavan B S, ritzz, joachim, xjm, amateescu, Vishalghyv: all methods in SelectionInterface() are missing @param docs
parent 1291450a
No related branches found
No related tags found
6 merge requests!7452Issue #1797438. HTML5 validation is preventing form submit and not fully...,!1012Issue #3226887: Hreflang on non-canonical content pages,!789Issue #3210310: Adjust Database API to remove deprecated Drupal 9 code in Drupal 10,!596Issue #3046532: deleting an entity reference field, used in a contextual view, makes the whole site unrecoverable,!496Issue #2463967: Use .user.ini file for PHP settings,!16Draft: Resolve #2081585 "History storage"
...@@ -17,6 +17,15 @@ interface SelectionInterface extends PluginFormInterface { ...@@ -17,6 +17,15 @@ interface SelectionInterface extends PluginFormInterface {
/** /**
* Gets the list of referenceable entities. * Gets the list of referenceable entities.
* *
* @param string|null $match
* (optional) Text to match the label against. Defaults to NULL.
* @param string $match_operator
* (optional) Operator to be used for string matching. Defaults to
* "CONTAINS".
* @param int $limit
* (optional) Limit the query to a given number of items. Defaults to 0,
* which indicates no limiting.
*
* @return array * @return array
* A nested array of entities, the first level is keyed by the * A nested array of entities, the first level is keyed by the
* entity bundle, which contains an array of entity labels (escaped), * entity bundle, which contains an array of entity labels (escaped),
...@@ -27,6 +36,12 @@ public function getReferenceableEntities($match = NULL, $match_operator = 'CONTA ...@@ -27,6 +36,12 @@ public function getReferenceableEntities($match = NULL, $match_operator = 'CONTA
/** /**
* Counts entities that are referenceable. * Counts entities that are referenceable.
* *
* @param string $match
* (optional) Text to match the label against. Defaults to NULL.
* @param string $match_operator
* (optional) Operator to be used for string matching. Defaults to
* "CONTAINS".
*
* @return int * @return int
* The number of referenceable entities. * The number of referenceable entities.
*/ */
...@@ -35,6 +50,9 @@ public function countReferenceableEntities($match = NULL, $match_operator = 'CON ...@@ -35,6 +50,9 @@ public function countReferenceableEntities($match = NULL, $match_operator = 'CON
/** /**
* Validates which existing entities can be referenced. * Validates which existing entities can be referenced.
* *
* @param array $ids
* An array of IDs to validate.
*
* @return array * @return array
* An array of valid entity IDs. * An array of valid entity IDs.
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment