Function Resource_fs_base->folder_save

Definitions

sources/resource_fs_base_class.php

  • Save function for resource-fs (for folders).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filename ID_TEXT No No required parameter N/A N/A Filename
$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
$search_label_as ?ID_TEXT No No Null N/A N/A Whether to look for existing records using $filename as a label and this resource type (null: $filename is a strict file name)
$search_path ?ID_TEXT No No Null N/A N/A Search path (null: the same as the path saving at)

Returns

  • The resource ID (false: error, could not create via these properties / here)
  • Type: ~ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Save function for resource-fs (for folders).
 *
 * @param  ID_TEXT $filename Filename
 * @param  string $path The path (blank: root / not applicable)
 * @param  array $properties Properties
 * @param  ?ID_TEXT $search_label_as Whether to look for existing records using $filename as a label and this resource type (null: $filename is a strict file name)
 * @param  ?ID_TEXT $search_path Search path (null: the same as the path saving at)
 * @return ~ID_TEXT The resource ID (false: error, could not create via these properties / here)
 */
public function folder_save(string $filename, string $path, array $properties, ?string $search_label_as = null, ?string $search_path = null)