Function __global->get_catalogue_entry_map
Definitions
sources/catalogues.php
- Get a map of the fields for the given entry.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $entry | array | No | No | required parameter | N/A | N/A | A database row of the entry we are working with |
| $catalogue | ?array | No | No | Null | N/A | N/A | A database row of the catalogue we are working with (null: read it in here) |
| $view_type | ID_TEXT | No | No | PAGE | PAGE SEARCH CATEGORY | N/A | The view type we're doing |
| $tpl_set | ID_TEXT | No | No | DEFAULT | N/A | N/A | The template set we are rendering this category using |
| $root | ?AUTO_LINK | No | No | Null | N/A | N/A | The virtual root for display of this category (null: none) |
| $fields | ?array | No | No | Null | N/A | N/A | The database rows for the fields for this catalogue (null: find them) |
| $only_fields | ?array | No | No | Null | N/A | N/A | A list of fields (sequence numbers) that we are limiting ourselves to (null: get ALL fields) |
| $feedback_details | boolean | No | No | False | N/A | N/A | Whether to grab the feedback details |
| $breadcrumbs_details | boolean | No | No | False | N/A | N/A | Whether to grab the breadcrumbs details |
| $order_by | ?integer | No | No | Null | N/A | N/A | Field index to order by (null: none) |
| &$_breadcrumbs | ?array | Yes | No | Null | N/A | N/A | Write breadcrumbs into here (null: don't bother) |
| $force_view_all | boolean | No | No | False | N/A | N/A | Whether to render everything |
| $zone | ID_TEXT | No | No | _SEARCH | N/A | N/A | The zone to display in |
Returns
- A map of information relating to the entry. The map contains 'FIELDS' (Tempcode for all accumulated fields), 'FIELD_x' (for each field x applying to the entry), STAFF_DETAILS, COMMENT_DETAILS, RATING_DETAILS, VIEW_URL, BREADCRUMBS
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a map of the fields for the given entry.
*
* @param array $entry A database row of the entry we are working with
* @param ?array $catalogue A database row of the catalogue we are working with (null: read it in here)
* @param ID_TEXT $view_type The view type we're doing
* @set PAGE SEARCH CATEGORY
* @param ID_TEXT $tpl_set The template set we are rendering this category using
* @param ?AUTO_LINK $root The virtual root for display of this category (null: none)
* @param ?array $fields The database rows for the fields for this catalogue (null: find them)
* @param ?array $only_fields A list of fields (sequence numbers) that we are limiting ourselves to (null: get ALL fields)
* @param boolean $feedback_details Whether to grab the feedback details
* @param boolean $breadcrumbs_details Whether to grab the breadcrumbs details
* @param ?integer $order_by Field index to order by (null: none)
* @param ?array $_breadcrumbs Write breadcrumbs into here (null: don't bother)
* @param boolean $force_view_all Whether to render everything
* @param ID_TEXT $zone The zone to display in
* @return array A map of information relating to the entry. The map contains 'FIELDS' (Tempcode for all accumulated fields), 'FIELD_x' (for each field x applying to the entry), STAFF_DETAILS, COMMENT_DETAILS, RATING_DETAILS, VIEW_URL, BREADCRUMBS
*/
function get_catalogue_entry_map(array $entry, ?array $catalogue = null, string $view_type = 'PAGE', string $tpl_set = 'DEFAULT', ?int $root = null, ?array $fields = null, ?array $only_fields = null, bool $feedback_details = false, bool $breadcrumbs_details = false, ?int $order_by = null, ?array &$_breadcrumbs = null, bool $force_view_all = false, string $zone = '_SEARCH') : array
* Get a map of the fields for the given entry.
*
* @param array $entry A database row of the entry we are working with
* @param ?array $catalogue A database row of the catalogue we are working with (null: read it in here)
* @param ID_TEXT $view_type The view type we're doing
* @set PAGE SEARCH CATEGORY
* @param ID_TEXT $tpl_set The template set we are rendering this category using
* @param ?AUTO_LINK $root The virtual root for display of this category (null: none)
* @param ?array $fields The database rows for the fields for this catalogue (null: find them)
* @param ?array $only_fields A list of fields (sequence numbers) that we are limiting ourselves to (null: get ALL fields)
* @param boolean $feedback_details Whether to grab the feedback details
* @param boolean $breadcrumbs_details Whether to grab the breadcrumbs details
* @param ?integer $order_by Field index to order by (null: none)
* @param ?array $_breadcrumbs Write breadcrumbs into here (null: don't bother)
* @param boolean $force_view_all Whether to render everything
* @param ID_TEXT $zone The zone to display in
* @return array A map of information relating to the entry. The map contains 'FIELDS' (Tempcode for all accumulated fields), 'FIELD_x' (for each field x applying to the entry), STAFF_DETAILS, COMMENT_DETAILS, RATING_DETAILS, VIEW_URL, BREADCRUMBS
*/
function get_catalogue_entry_map(array $entry, ?array $catalogue = null, string $view_type = 'PAGE', string $tpl_set = 'DEFAULT', ?int $root = null, ?array $fields = null, ?array $only_fields = null, bool $feedback_details = false, bool $breadcrumbs_details = false, ?int $order_by = null, ?array &$_breadcrumbs = null, bool $force_view_all = false, string $zone = '_SEARCH') : array
