finder_element
| Versions | |
|---|---|
| 6.x-1.x – 7.x-1.x | &finder_element(&$finder, &$finder_element_id) |
Get an element from a finder.
Finder stores it's elements in an indexed array, as well as tracking an array that maps finder element IDs to the index position. This can be awkward to use when dealing with a particular element's settings especially when the element variable needs to be a reference to an element in the finder variable. This function conveniently allows us to pull a finder element into a reference. If called by reference, for example, $element = &finder_element($finder, $finder_element_id); this function will return a reference to a finder element from the supplied finder as identified by the supplied finder element id, if not called by reference it will return a copy of the element.
Parameters
&$finder The finder object from which to get the element.
&$finder_element_id The ID of the finder element required.
Return value
The finder element, or reference to the finder element.
Code
./
<?php
function &finder_element(&$finder, &$finder_element_id) {
$key = &$finder->elements_index[$finder_element_id];
return $finder->elements[$key];
}
?>