Function Hook_commandr_fs_cpfs->file_edit
Definitions
sources/hooks/systems/commandr_fs/cpfs.php
- Standard Commandr-fs edit function for resource-fs hooks. Edits the resource to the given properties.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $filename | ID_TEXT | required parameter | N/A | N/A | The filename |
| $path | string | required parameter | N/A | N/A | The path (blank: root / not applicable) |
| $properties | array | 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) |
| $explicit_move | boolean | False | N/A | N/A | Whether we are definitely moving (as opposed to possible having it in multiple positions) |
Return
- The resource ID (false: error, could not create via these properties / here)
- Type: ~ID_TEXT
- Set: N/A
- Range: N/A