Function __global->load_catalogue_row
Definitions
sources/catalogues.php
- Get a catalogue row.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $catalogue_name | ID_TEXT | No | No | required parameter | N/A | N/A | The catalogue name |
| $fail_ok | boolean | No | No | False | N/A | N/A | Whether to return null if we can't find it (as opposed to a fatal error) |
Returns
- Catalogue row (null: could not find it, and $fail_ok was set to true)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a catalogue row.
*
* @param ID_TEXT $catalogue_name The catalogue name
* @param boolean $fail_ok Whether to return null if we can't find it (as opposed to a fatal error)
* @return ?array Catalogue row (null: could not find it, and $fail_ok was set to true)
*/
function load_catalogue_row(string $catalogue_name, bool $fail_ok = false) : ?array
* Get a catalogue row.
*
* @param ID_TEXT $catalogue_name The catalogue name
* @param boolean $fail_ok Whether to return null if we can't find it (as opposed to a fatal error)
* @return ?array Catalogue row (null: could not find it, and $fail_ok was set to true)
*/
function load_catalogue_row(string $catalogue_name, bool $fail_ok = false) : ?array
