Function __global->get_matching_closed_captions_file
Definitions
sources/images.php
- Get the path to a matching closed captions file, so long as the URL is under a given scope.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $url | URLPATH | No | No | required parameter | N/A | N/A | URL to the video |
| $scope_limit | string | No | No | uploads/ | N/A | N/A | Only operate under this file path (relative to the base directory) |
Returns
- Path to the closed captions URL file (null: did not find a file)
- Type: ?URLPATH
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the path to a matching closed captions file, so long as the URL is under a given scope.
*
* @param URLPATH $url URL to the video
* @param string $scope_limit Only operate under this file path (relative to the base directory)
* @return ?URLPATH Path to the closed captions URL file (null: did not find a file)
*/
function get_matching_closed_captions_file(string $url, string $scope_limit = 'uploads/') : ?string
* Get the path to a matching closed captions file, so long as the URL is under a given scope.
*
* @param URLPATH $url URL to the video
* @param string $scope_limit Only operate under this file path (relative to the base directory)
* @return ?URLPATH Path to the closed captions URL file (null: did not find a file)
*/
function get_matching_closed_captions_file(string $url, string $scope_limit = 'uploads/') : ?string
