Function Resource_fs_base->search

Definitions

sources/resource_fs_base_class.php

  • Find the foldername/subpath to a resource.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$resource_type ID_TEXT No No required parameter N/A N/A The resource type
$resource_id ID_TEXT No No required parameter N/A N/A The resource ID
$full_subpath boolean No No False N/A N/A Whether to include the full subpath

Returns

  • The foldername/subpath (null: not found)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find the foldername/subpath to a resource.
 *
 * @param  ID_TEXT $resource_type The resource type
 * @param  ID_TEXT $resource_id The resource ID
 * @param  boolean $full_subpath Whether to include the full subpath
 * @return ?string The foldername/subpath (null: not found)
 */
public function search(string $resource_type, string $resource_id, bool $full_subpath = false) : ?string