Function Hook_commandr_fs_catalogues->__file_read_in_properties
Definitions
sources/hooks/systems/commandr_fs/catalogues.php
- Convert properties to variables for adding/editing catalogue entries.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $path | string | No | No | required parameter | N/A | N/A | The path (blank: root / not applicable) |
| $properties | array | No | No | required parameter | N/A | N/A | Properties (may be empty, properties given are open to interpretation by the hook but generally correspond to database fields) |
| $category | SHORT_TEXT | No | No | required parameter | N/A | N/A | Category |
| $label | SHORT_TEXT | No | No | required parameter | N/A | N/A | Label |
Returns
- Properties
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Convert properties to variables for adding/editing catalogue entries.
*
* @param string $path The path (blank: root / not applicable)
* @param array $properties Properties (may be empty, properties given are open to interpretation by the hook but generally correspond to database fields)
* @param SHORT_TEXT $category Category
* @param SHORT_TEXT $label Label
* @return array Properties
*/
protected function __file_read_in_properties(string $path, array $properties, string $category, string $label) : array
* Convert properties to variables for adding/editing catalogue entries.
*
* @param string $path The path (blank: root / not applicable)
* @param array $properties Properties (may be empty, properties given are open to interpretation by the hook but generally correspond to database fields)
* @param SHORT_TEXT $category Category
* @param SHORT_TEXT $label Label
* @return array Properties
*/
protected function __file_read_in_properties(string $path, array $properties, string $category, string $label) : array
