Documentation

tms_link_functions.php

Table of Contents

Functions

unistr_to_ords()  : mixed
getEncodingOrder()  : mixed
tms_convert_value()  : mixed
tms_link_get_tms_data()  : mixed
tms_link_get_tms_resources()  : mixed
tms_link_test()  : mixed
tms_add_mediaxref()  : mixed
tms_link_create_tms_thumbnail()  : mixed
tms_get_mediamasterid()  : bool|string
tms_get_mediamasterid Retrieve a list of unused Media Master IDs from the TMS database and return the first available.
tms_get_renditionid()  : mixed
tms_get_mediapathid()  : mixed
tms_update_media_rendition()  : mixed
tms_check_thumb()  : mixed
tms_update_media_rendition_thumb()  : mixed
tms_add_mediafile()  : mixed
tms_show_data()  : mixed
tms_link_check_preview()  : mixed
tms_link_save_module_mappings_config()  : void
Save plugins' module saved mappings configuration on an ad-hoc basis
tms_link_get_modules_mappings()  : mixed
tms_link_encode_modules_mappings()  : mixed
tms_link_is_rs_uid_field()  : mixed
tms_link_split_identifiers()  : array<string|int, mixed>
Split string identifier values on commas with optional whitespace for multiple tms object IDs

Functions

unistr_to_ords()

unistr_to_ords(mixed $str[, mixed $encoding = 'UTF-8' ]) : mixed
Parameters
$str : mixed
$encoding : mixed = 'UTF-8'

tms_convert_value()

tms_convert_value(mixed $value, mixed $key, array<string|int, mixed> $module) : mixed
Parameters
$value : mixed
$key : mixed
$module : array<string|int, mixed>

tms_link_get_tms_data()

tms_link_get_tms_data(mixed $resource[, mixed $tms_object_id = "" ][, mixed $resourcechecksum = "" ][, mixed $onlymodule = "" ]) : mixed
Parameters
$resource : mixed
$tms_object_id : mixed = ""
$resourcechecksum : mixed = ""
$onlymodule : mixed = ""

tms_link_get_tms_resources()

tms_link_get_tms_resources(array<string|int, mixed> $module) : mixed
Parameters
$module : array<string|int, mixed>

tms_add_mediaxref()

tms_add_mediaxref(mixed $mediamasterid, mixed $tms_object_id[, mixed $create = true ]) : mixed
Parameters
$mediamasterid : mixed
$tms_object_id : mixed
$create : mixed = true

tms_link_create_tms_thumbnail()

tms_link_create_tms_thumbnail(mixed $resource[, mixed $alternative = -1 ]) : mixed
Parameters
$resource : mixed
$alternative : mixed = -1

tms_get_mediamasterid()

tms_get_mediamasterid Retrieve a list of unused Media Master IDs from the TMS database and return the first available.

tms_get_mediamasterid([bool $create = true ][, int $resource = null ]) : bool|string

If no IDs are found then create a new one and then retry To avoid Media Master IDs being used by multiple resources $tms_link_mediapaths_resource_reference_column can be set. This will store the resource ID in the MediaMaster table when creating the new ID so that it is not used by another Resource

Parameters
$create : bool = true

flag to create a new ID if none found

$resource : int = null

ResourceSpace resource ID

Return values
bool|string —

False if no ID found, otherwise the Media Master ID is returned

tms_get_renditionid()

tms_get_renditionid(mixed $mediamasterid, mixed $resourceid[, mixed $create = true ]) : mixed
Parameters
$mediamasterid : mixed
$resourceid : mixed
$create : mixed = true

tms_get_mediapathid()

tms_get_mediapathid(mixed $path[, mixed $create = true ]) : mixed
Parameters
$path : mixed
$create : mixed = true

tms_update_media_rendition()

tms_update_media_rendition(mixed $mediamasterid, mixed $mediafileid) : mixed
Parameters
$mediamasterid : mixed
$mediafileid : mixed

tms_check_thumb()

tms_check_thumb(mixed $pathid, mixed $filepath, mixed $filename) : mixed
Parameters
$pathid : mixed
$filepath : mixed
$filename : mixed

tms_update_media_rendition_thumb()

tms_update_media_rendition_thumb(mixed $mediamasterid, mixed $mediafileid, mixed $pathid, mixed $filepath, mixed $filename) : mixed
Parameters
$mediamasterid : mixed
$mediafileid : mixed
$pathid : mixed
$filepath : mixed
$filename : mixed

tms_add_mediafile()

tms_add_mediafile(mixed $renditionid, mixed $pathid, mixed $filepath, mixed $relfilepath[, mixed $create = true ]) : mixed
Parameters
$renditionid : mixed
$pathid : mixed
$filepath : mixed
$relfilepath : mixed
$create : mixed = true

tms_show_data()

tms_show_data(mixed $table, mixed $columns, mixed $utf16_columns, mixed $conditionsql[, mixed $limit = 10 ]) : mixed
Parameters
$table : mixed
$columns : mixed
$utf16_columns : mixed
$conditionsql : mixed
$limit : mixed = 10

tms_link_check_preview()

tms_link_check_preview(mixed $ref[, mixed $alternative = -1 ]) : mixed
Parameters
$ref : mixed
$alternative : mixed = -1

tms_link_save_module_mappings_config()

Save plugins' module saved mappings configuration on an ad-hoc basis

tms_link_save_module_mappings_config(mixed $value) : void
Parameters
$value : mixed

Configuration option new value

Tags
uses
get_plugin_config()
set_plugin_config()

tms_link_is_rs_uid_field()

tms_link_is_rs_uid_field(mixed $field_ref) : mixed
Parameters
$field_ref : mixed

tms_link_split_identifiers()

Split string identifier values on commas with optional whitespace for multiple tms object IDs

tms_link_split_identifiers(string|array<string|int, mixed> $tms_object_id) : array<string|int, mixed>
Parameters
$tms_object_id : string|array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results