Documentation

get_resource_path()

Get resource path / resource URL / download URL for this resource

Parameters

$ref : int

Resource ID

$getfilepath : bool

Set to TRUE to get the filestore (physical) path

$size : string|null = ''

Specify which size of the resource should be returned. Use '' for original file

$generate : bool = true

Generate folder if not found

$extension : string|null = 'jpg'

Extension of the file we are looking for. For original file, this would be the file extension, otherwise use the preview extension (e.g image preview will have JPG while video preview can have MP4 or others)

$scramble : bool = true

Set to TRUE to get the scrambled folder (requires scramble key for it to work)

$page : int = 1

For documents, use the page number we are trying to get the preview of.

$watermarked : bool = false

Get the watermark version?

$file_modified : string|null = ''

Specify when the file was last modified as a Unix timestamp

$alternative : int = -1

ID of the alternative file

$includemodified : bool = true

Show when the file was last modified

Tags

uses

ps_value()

get_alternative_file()

get_resource_data()

used-by

iiif_get_canvases()

iiif_get_thumbnail()

iiif_get_image()

extract_text()

extract_icc_profile()

get_video_snapshots()

as expected by generateURL()

get_resource_all_image_sizes()

HookFacesViewCustompanels()

get_resource_data()

Parameters

$ref : mixed

$cache : mixed = true

Tags

used-by

extractFitsMetadata()

get_resource_path()

copy_locked_data()

get_resource_all_image_sizes()

get_resource_data_batch()

get_resource_data_batch - get data from resource table for all resource IDs

Parameters

$refs : mixed

• array of resource IDs

put_resource_data()

Updates $resource with the name/value pairs in $data - this relates to the resource table column, not metadata.

Parameters

$resource : int

ID of resource

$data : array<string|int, mixed>

Array of data to be applied to resource

create_resource()

create_resource

Parameters

$resource_type : int

ID of target resource type

$archive : int = 999

ID of target archive state, 999 if archived

$user : int = -1

User ID, -1 for current user

$origin : string = ''

Source of resource, should not be blank

$file_extension : string = ''

If specified

$run_macro : bool = true

Run autocomplete macros, can be disabled if they are run later in process

update_hitcount()

Parameters

$ref : mixed

save_resource_data()

Save resource data

Parameters

$ref : int

$multi : bool

$autosave_field : string|int = ""

set_resource_defaults()

Set resource defaults. Optional, a list of field IDs can be passed on to only update certain fields.

Parameters

$ref : int

Resource ID

$specific_fields : array<string|int, mixed> = array()

Specific field ID(s) to update

save_resource_data_multi()

Batch save resources in a collection

Parameters

$collection : int

$editsearch : array<string|int, mixed> = array()

$postvals : array<string|int, mixed> = []

update_field()

Updates resource field. Works out the previous value, so this is not efficient if we already know what this previous value is (hence it is not used for edit where multiple fields are saved)

Parameters

$resource : int

Resource ID

$field : int

Field ID

$value : string

The new value

$errors : array<string|int, mixed> = array()

Any errors that may occur during update

$log : bool = true

Log this change in the resource log?

$nodevalues : bool = false

Set to TRUE to process the value as a comma separated list of node IDs

Tags

used-by

extract_text()

extractFitsMetadata()

copy_locked_fields()

email_resource()

Parameters

$resource : mixed

$resourcename : mixed

$fromusername : mixed

$userlist : mixed

$message : mixed

$access : mixed = -1

$expires : mixed = ""

$sharepwd : mixed = ""

$useremail : mixed = ""

$from_name : mixed = ""

$cc : mixed = ""

$list_recipients : mixed = false

$open_internal_access : mixed = false

$useraccess : mixed = 2

$group : mixed = ""

delete_resource()

Parameters

$ref : mixed

get_resource_type_field()

Returns field data from resource_type_field for the given field

Parameters

$field : int

Resource type field ID

Tags

uses

ps_query()

used-by

prepareTags()

iiif_get_canvases()

copy_locked_fields()

VrViewUseVR()

get_resource_field_data()

get_resource_field_data

Parameters

$ref : int

Resource ID

$multi : bool = false

Get all fields? False by default (only fields that apply to the given resource type)

$use_permissions : bool = true

Honour user permissions e.g. field access. TRUE by default

$originalref : int = null

Original resource ID to get data for. NULL by default

$external_access : bool = false

Only get data permitted to view externally. FALSE by default

$ord_by : bool = false

Use field order_by setting. FALSE by default (order is by resource type first)

$forcsv : bool = false

Get data for CSV export (uses \ separator for category tree nodes). FALSE by default

$translate_value : bool = true

Field value will be translated with i18n_get_translated() unless FALSE supplied.

Tags

used-by

copy_locked_fields()

get_resource_field_data_batch()

get_resource_field_data_batch - Get all resource data for the given resources

Parameters

$resources : array<string|int, mixed>

(either an array of resource ids or an array returned from search results)

$use_permissions : bool = true

Honour user permissions e.g. field access. TRUE by default

$external_access : bool = false

Only get data permitted to view externally. FALSE by default

$ord_by : bool = false

Use field order_by setting. FALSE by default (order is by resource type first)

$exportoptions : mixed = array()

Array of options as below "csvexport" (bool) - get data for CSV export (uses \ separator for category tree nodes) "personal" (bool) - include data in fields marked as personal "alldata" (bool) - include data in all fields, including technical metadata

get_resource_types()

Return an array of resource types that this user has access to

Parameters

$types : string = ""

Comma separated list to limit the types that are returned by ref, blank string returns all available types

$translate : bool = true

Flag to translate the resource types before returning

$ignore_access : bool = false

Return all resource types regardless of access?#

$usecache : bool = false

Return cached result?

get_all_resource_types()

Returns all resources types

clear_resource_data()

Parameters

$resource : mixed

copy_resource()

Create a new resource, copying all data from the resource with reference $from.

Parameters

$from : int

ID of resource

$resource_type : int = -1

ID of resource type

$origin : string = ''

Origin of resource when uploading, leave blank if not an upload

resource_log()

Log resource activity

Parameters

$resource : int

• resource ref -- resource_log.resource

$type : string

• log code defined in include/definitions.php -- resource_log.type

$field : int

• resource type field -- resource_log.resource_type_field

$notes : string = ""

• text notes -- resource_log.notes

$fromvalue : mixed = ""

• original value (int or string) -- resource_log.previous_value

$tovalue : mixed = ""

• new value (int or string)

$usage : int = -1

-- resource_log.usageoption

$alt_ref : int = -1

• ref of alt file -- resource_log.alt_ref

Tags

used-by

extract_text()

copy_locked_data()

get_resource_log()

Get resource log records. The standard field titles are translated using $lang. Custom field titles are i18n translated.

Parameters

$resource : int

Resource ID - set to NULL and specify r.ref=>[id] in the $filters array to retrieve a specific log entry by log ref

$fetchrows : int = -1

If $fetchrows is set we don't have to loop through all the returned rows. @see ps_query()

$filters : array<string|int, mixed> = array()

List of filters to include in the where clause. The key of the array is linked to the available columns in the sql statement so they must match!

get_resource_type_name()

Parameters

$type : mixed

get_resource_custom_access()

Parameters

$resource : mixed

get_resource_custom_access_users_usergroups()

Retrieves custom access settings for users and user groups associated with a specific resource.

Parameters

$resource : int

The resource reference ID for which to retrieve custom access settings.

save_resource_custom_access()

Saves custom access settings for a specific resource.

Parameters

$resource : int

The resource reference ID for which custom access is being set.

get_custom_access()

Lookup custom access value for a resource

Parameters

$resource : int

Resource ID.

$usergroup : int

User group ID.

$return_default : bool = true

Return default custom access value RESOURCE_ACCESS_CONFIDENTIAL

get_themes_by_resource()

Determine the featured collections and public collections a resource is associated with.

Parameters

$ref : int

Resource ref

update_resource_type()

Parameters

$ref : mixed

$type : mixed

Tags

used-by

copy_locked_data()

get_exiftool_fields()

Returns a list of exiftool fields, which are basically fields with an 'exiftool field' set.

Parameters

$resource_type : int

$option_separator : string = ","

String to separate the node options returned for fixed list fields

• Recommended NODE_NAME_STRING_SEPARATOR
• Defaults to comma for backwards compatibility

$skip_translation : bool = false

Set to true to return the entire untranslated node value rather than the appropriate translation only.

createTempFile()

Create a temporary copy of the file in the tmp folder (ie. the usual filestore/tmp/)

Parameters

$path : string

File path

$uniqid : string

If a uniqid is provided, create a folder within tmp. See get_temp_dir() for more information.

$filename : string

Filename of the new file

Tags

uses

get_temp_dir()

stripMetadata()

Strips metadata from file

Parameters

$file_path : string

Physical path to file that will have metadata stripped. Use NULL to just get the exiftool command returned instead of running the command on the file

Tags

uses

get_utility_path()

run_command()

write_metadata()

Writes metadata to a specified file using ExifTool.

Parameters

$path : string

The file path where the metadata will be written.

$ref : int

The reference ID of the resource associated with the file.

$uniqid : string = ""

A unique identifier for the temporary file location (optional).

delete_exif_tmpfile()

Delete Exif temp file

Parameters

$tmpfile : string

Exif temp file to be deleted

update_resource()

Updates a resource with a new file and its associated metadata.

Parameters

$r : int

The resource ID to update.

$path : string

The file path of the new resource.

$type : string

The type of the resource.

$title : string

The title for the resource.

$ingest : bool = false

Indicates if the resource is being ingested.

$createPreviews : bool = true

Flag to create previews.

$extension : string = ''

The file extension of the new resource.

$after_upload_processing : bool = false

Indicates if the update is after upload processing.

import_resource()

Imports a resource from the specified path and updates its details.

Parameters

$path : string

The file path of the resource to import.

$type : string

The type of the resource being imported.

$title : string

The title for the imported resource.

$ingest : bool = false

Indicates if the resource is being ingested (default is false).

$extension : string = ''

The file extension of the resource (optional).

get_alternative_files()

Retrieves alternative files associated with a specified resource.

Parameters

$resource : int

The resource ID for which to fetch alternative files.

$order_by : string = ""

The field to order the results by (optional).

$sort : string = ""

The sorting direction (ASC or DESC) for the order_by field (optional).

$type : string = ""

The type of alternative file to filter by (optional).

get_alternative_files_by_filename()

Search the alternative file records for matching filenames Alternative files can be optionally filtered by the Resource ID or by collection

Parameters

$filename : string

Filename of the alternative file(s) to search for

$collection : int

Collection ID to filter resources, use 0 to ignore

$min : int

Minimum Resource ID to consider, use 0 to ignore

$max : int

Maximum Resource ID to consider, use 0 to ignore

add_alternative_file()

Add alternative file

Parameters

$resource : int

$name : string

$description : string = ""

$file_name : string = ""

$file_extension : string = ""

$file_size : int = 0

$alt_type : string = ''

delete_alternative_file()

delete_alternative_file

Parameters

$resource : int

Resource id.

$ref : int

Alternative file id.

get_alternative_file()

Retrieves a specific alternative file associated with a given resource.

Parameters

$resource : int

The resource ID associated with the alternative file.

$ref : int

The reference ID of the alternative file to retrieve.

Tags

used-by

get_resource_path()

save_alternative_file()

Updates the details of an alternative file in the database.

Parameters

$resource : int

The resource ID associated with the alternative file.

$ref : int

The reference ID of the alternative file to update.

$data : array<string|int, mixed> = []

Array of data in name=>value format, where name is the resource_alt_files column name. If a column is to be left as is then it must not be included in the array

user_rating_save()

Saves a user rating for a given resource.

Parameters

$userref : int

The reference ID of the user rating the resource.

$ref : int

The reference ID of the resource being rated.

$rating : int

The rating value to be saved (0 to remove rating).

get_field()

A standard field title is translated using $lang. A custom field title is i18n translated.

Parameters

$field : int

Resource type field ID

get_keyword_from_option()

Retrieves the keyword that will be indexed for a given field option.

Parameters

$option : string

The field option to process.

get_resource_access()

Retrieves the access level for the currently logged-in user for a specified resource.

Parameters

$resource : int|array<string|int, mixed>

The reference ID of the resource or a resource data array.

Tags

used-by

get_resource_all_image_sizes()

get_custom_access_user()

Retrieves the custom access level for a specific user on a given resource.

Parameters

$resource : int

The resource ID to check access for.

$user : int

The user ID to check for custom access.

edit_resource_external_access()

Edits the external access settings for a given resource.

Parameters

$key : string

The external access key to edit.

$access : int = -1

The new access level; defaults to -1 for no change.

$expires : string = ""

The expiration date for the access key; optional.

$group : string = ""

The user group to share with; defaults to the current user group if not specified.

$sharepwd : string = ""

The password for accessing the resource; "(unchanged)" means no change.

resource_download_allowed()

For the given resource and size, can the current user download it? resource type and access may already be available in the case of search, so pass them along to get_resource_access to avoid extra queries $resource can be a resource-specific search result array.

Parameters

$resource : int

ID of resource

$size : string

ID of size

$resource_type : int

ID of resource type

$alternative : int = -1

Use alternative?

$usecache : bool = false

Use cached result if available?

get_edit_access()

Check if current user has edit access to a resource. Checks the edit permissions (e0, e-1 etc.) and also the group edit filter which filters edit access based on resource metadata.

Parameters

$resource : int

Resource ID

$status : int = -999

Archive status ID. Use -999 to use the one from resourcedata argument

$resourcedata : array<string|int, mixed> = []

filter_match()

In the given filter string, does name/value match? Returns: 0 = no match for name 1 = matched name but value was not present 2 = matched name and value was correct

Parameters

$filter : string

Sring to for which filtering is to be applied

$name : string

Name to match

$value : string

Value to match

log_diff()

Check changes made to a metadata field and create a nice user friendly summary

Parameters

$fromvalue : string

• if nodes then values will be separated by NODE_NAME_STRING_SEPARATOR

$tovalue : string

• if nodes then values will be separated by NODE_NAME_STRING_SEPARATOR

Tags

uses

Diff::compare()

Diff::toString()

get_metadata_templates()

Retrieves a list of all metadata templates for a specified resource type.

get_resource_collections()

Retrieves a list of collections that a resource is used in for the specified resource reference.

Parameters

$ref : int

The resource reference for which to retrieve associated collections.

download_summary()

Retrieves a summary of downloads for a given resource, categorized by usage type.

Parameters

$resource : int

The resource reference for which to retrieve the download summary.

check_use_watermark()

Parameters

$download_key : mixed = ""

$resource : mixed = ""

autocomplete_blank_fields()

Fill in any blank fields for the resource.

Parameters

$resource : int

Resource ID

$force_run : bool

Allow code to force running this function and update the fields even if there is data.

$return_changes : bool = false

When true an array of fields changed by autocomplete is returned. For example:

• when creating a resource, autocomplete_blank_fields() should always be triggered regardless if user has data in its user template.
• when copying resource/ extracting embedded metadata, autocomplete_blank_fields() should not overwrite if there is data for that field as at this point you probably have the expected data for your field.

$field_ref : int = 0

Optional parameter to specify which metadata field should be processed. Left blank, all fields will be processed (default behaviour).

get_page_count()

Parameters

$resource : mixed

$alternative : mixed = -1

Tags

used-by

get_resource_all_image_sizes()

update_disk_usage()

Updates the disk usage for a specified resource by calculating the total size of the files in the resource's directory and storing the result in the resource table.

Parameters

$resource : int

The resource reference whose disk usage is to be updated.

update_disk_usage_cron()

Update disk usage for all resources that have not yet been updated or have not been updated in the past 30 days.

get_total_disk_usage()

Returns the total disk space used by all resources on the system

overquota()

Calculate if the quota set by $disksize in the configuration has been exceeded.

get_original_imagesize()

Get size of specified image file

Parameters

$ref : int = ""

Resource ID

$path : string = ""

File path

$extension : string = "jpg"

File extension

$forcefromfile : bool = false

Get info from file instead of database cache

Tags

used-by

iiif_get_canvases()

iiif_get_image()

generate_resource_access_key()

Generates an external access key for a resource, allowing specified access to a user or group.

Parameters

$resource : int

The resource reference for which the access key is being generated.

$userref : int

The user reference for the user to whom access is granted.

$access : int

The level of access granted (e.g., full access, restricted).

$expires : string|null

The expiration date of the access key, formatted as 'Y-m-d'.

$email : string

The email address associated with the user receiving the access key.

$group : string = ""

The user group associated with the access, defaults to the current user group if not specified.

$sharepwd : string = ""

The share password, if any, used to secure access.

get_resource_external_access()

Retrieves all external access keys granted for a specific resource.

Parameters

$resource : int

The reference ID of the resource for which external access is being retrieved.

delete_resource_access_key()

Parameters

$resource : mixed

$access_key : mixed

resource_type_config_override()

Parameters

$resource_type : mixed

$only_onchange : mixed = true

update_archive_status()

Update the archive state of resource(s) and log this

Parameters

$resource : mixed

$archive : int

• Destination archive state

$existingstates : int|array<string|int, mixed> = array()

• existing archive state or array of corresponding existing archive states

$collection : int = 0

• optional id of collection containing resources

$more_notes : mixed = ""

Tags

used-by

copy_locked_data()

delete_resources_in_collection()

Parameters

$collection : mixed

update_related_resource()

Update related resources - add new related resource(s) or delete existing

Parameters

$ref : int

ID of primary resource

$related : mixed

$add : bool = true

Add relationship? If false this will delete the specified relationships

can_share_resource()

Check if sharing of resource is permitted

Parameters

$ref : int

ID of resource

$access : int = ""

Level of resource access (0 - Open 1 - Restricted 2 - Confidential)

delete_resource_custom_access_usergroups()

Delete all usergroup specific access to resource $ref

Parameters

$ref : int

ID of resource

truncate_join_field_value()

Truncate the field for insertion into the main resource table field

Parameters

$value : string

get_video_snapshots()

Check whether a resource (of a video type) has any snapshots created.

Parameters

$resource_id : int

Resource unique ref

$file_path : bool = false

Specify whether the return value should be the file path. Default is FALSE

$count_only : bool = false

Set to true if we are only interested in how many snapshots we have. Default is FALSE

$includemodified : mixed = false

Tags

uses

get_resource_path()

as expected by generateURL()

resource_file_readonly()

Check if resource file is read-only because it's part of the filestore template threshold

Parameters

$ref : int|numeric-string

Resource ID

delete_resource_custom_user_access()

Parameters

$resource : mixed

$user : mixed

get_video_info()

Parameters

$file : mixed

Tags

used-by

get_video_resolution()

copyAllDataToResource()

Provides the ability to copy any metadata field data from one resource to another.

Parameters

$from : int

Resource we are copying data from

$to : int

The Resource ID that needs updating

$resourcedata : mixed = false

copy_locked_data()

Update resource data for 'locked' fields from last edited resource. Used for upload_then_edit

Parameters

$resource : array<string|int, mixed>

• existing resource data

$locked_fields : array<string|int, mixed>

• array of locked data columns (may also include field ids which are handled by copy_locked_fields)

$lastedited : int

• last edited resource to copy data from

$save : bool = false

• if true, save data to database (as opposed to just updating the $resource array e.g. for edit page)

Tags

uses

get_resource_data()

update_resource_type()

update_archive_status()

resource_log()

checkperm()

ps_query()

checkperm()

copy_locked_fields()

Update resource metadata for 'locked' fields from last edited resource.

Parameters

$ref : int

• resource id being updated

$fields : array<string|int, mixed>

• resource $fields array

$all_selected_nodes : array<string|int, mixed>

• array of existing resource nodes

$locked_fields : array<string|int, mixed>

• array of locked data columns (may also include resource table columns - handled by copy_locked_data)

$lastedited : int

• last edited resource to copy data from

$save : bool = false

• save data to database (as opposed to just updating the $fields array e.g. for edit page)

Tags

uses

get_resource_type_field()

get_resource_nodes()

add_resource_nodes()

delete_resource_nodes()*

get_resource_field_data()

update_field()

ps_query()

copyRelatedResources()

Copy related resources from one resource to another

Parameters

$from : int

Resource we are copying related resources from

$to : mixed

Tags

uses

ps_query()

process_edit_form()

Parameters

$ref : mixed

$resource : mixed

update_timestamp()

Parameters

$resource : mixed

get_extension()

Get resource file extension from the database or use JPG, for download

Parameters

$resource : array<string|int, mixed>

$size : string

Preview size as defined in the system

Tags

uses

hook()

get_last_resource_edit_array()

Obtain details of the last resource edited in the given array of resource ids

Parameters

$resources : array<string|int, mixed> = array()

Array of resource IDs

get_default_archive_state()

Get the default archive state for new resources

Parameters

$requestedstate : int = ""

(optional) ID of requested archive state

save_original_file_as_alternative()

Save the original file being replaced, as an alternative file

Parameters

$ref : int

(required) ID of original resource

replace_resource_file()

Replace the primary resource file with the file located at the path specified

Parameters

$ref : int

Resource ID to replace

$file_location : mixed

$no_exif : mixed = false

$autorotate : mixed = false

$keep_original : mixed = true

get_resource_all_image_sizes()

Return all sizes available for a specific resource. Multi page resources should have each page size included as well in the output.

Parameters

$ref : int

Resource ID

Tags

uses

get_resource_access()

get_resource_data()

get_image_sizes()

get_page_count()

get_resource_path()

sanitize_date_field_input()

Parameters

$date : mixed

$validate : mixed = false

download_link_generate_key()

Create a temporary download key for a specific user or key and resource combination Used when both $watermark_open and $terms_download are enabled

Parameters

$id : string

Key identifier e.g. user ID or external access key

$resource : int

Resource ID

download_link_check_key()

Check the download key for a specific user/resource combination

Parameters

$download_key : string

Download key

$resource : int

Resource ID

filter_check()

Check if a given set of nodes meets the conditions set for the provided filter NOte that all resource_nodes for a resource should be passed to check if a filter is matched

Parameters

$filterid : mixed

$nodes : array<string|int, mixed>

Array of nodes

update_node_hitcount_from_search()

Parameters

$resource : mixed

$search : mixed

copy_hitcount_to_live()

get_image_sizes()

Returns a table of available image sizes for resource $ref. The standard image sizes are translated using $lang. Custom image sizes are i18n translated.

Parameters

$ref : int

ID of resource

$internal : bool = false

$extension : string = "jpg"

File extension of image

$onlyifexists : bool = true

Tags

used-by

get_resource_all_image_sizes()

get_related_resources()

Return an array of resource references that are related to resource $ref

Parameters

$ref : int

ID of resource

get_field_options()

Get available options for fixed list field types

Parameters

$ref : int

Metadata field ref

$nodeinfo : bool = false

Get full node details?

$skip_translation : bool = false

Do not translate node name. Only relevant if $nodeinfo=false

get_data_by_field()

Get the resource data value for a field and a specific resource or get the specified field for all resources in the system

Parameters

$resource : int

Resource ID. Use NULL to retrieve all resources records for the specified field

$field : int|string

Resource type field ID. Can also be a shortname.

$flatten : bool = true

Should a fixed list field value be flatten to a simple string? Set to FALSE to get the list of nodes

Tags

used-by

iiif_get_canvases()

VrViewUseVR()

get_all_image_sizes()

Parameters

$internal : mixed = false

$restricted : mixed = false

image_size_restricted_access()

Parameters

$id : mixed

get_fields()

Returns a list of fields with refs matching the supplied field refs.

Parameters

$field_refs : array<string|int, mixed>

Array of field refs

$order_by_passed_refs : bool = false

get_hidden_indexed_fields()

get_OR_fields()

get_nopreview_html()

Returns the HTML necessary to represent a resource with the given extension when no image preview exists.

Parameters

$extension : string

File extension

$resource_type : int = null

Optional, the resource type of the resource, used to find an icon at the resource type level if an icon for this extension is not defined.

get_resource_type_fields()

Gets all metadata fields, optionally for a specified array of resource types

Parameters

$restypes : array<string|int, mixed> = ""

Optional array of resource types to check

$field_order_by : string = "ref"

Order by column

$field_sort : string = "asc"

Sort order

$find : string = ""

Parameter value to search for

$fieldtypes : array<string|int, mixed> = array()

List of field types to include

$include_inactive : bool = false

Should inactive resources be checked, default is false

notify_resource_change()

Parameters

$resource : mixed

add_verbatim_keywords()

Parameters

$keywords : mixed

$string : mixed

$resource_type_field : mixed

$called_from_search : mixed = false

Tags

used-by

do_search()

metadata_field_edit_access()

Check the current user's edit access to given metadata field ID

Parameters

$field : int

get_download_filename()

Work out the filename to use, based on the download_filename_format configuration option, when downloading the specified resource file with the given settings

Parameters

$ref : int

Resource ID

$size : string

size code

$alternative : int

Alternative file ID

$ext : string

File extension

get_resource_type_from_extension()

Get resource type ID based on extension $mappings = array(resource_type_id => array(allowed_extensions));

Parameters

$extension : string

Extension we search by (ie. "mp4")

$resource_type_extension_mapping : array<string|int, mixed>

Maps between resource types and extensions

$default : int

The default value to use in case we can't find it the mappings

canSeePreviewTools()

Helper function for Preview tools feature. Checks all necessary permissions or options in order to tell the system whether PreviewTools panel should be displayed

Parameters

$resource : array<string|int, mixed>

Resource data structure

canSeeAnnotationsFields()

Helper function to determine if annotations are to be displayed.

alt_is_ffmpeg_alternative()

Determine if a video alternative was created from $ffmpeg_alternatives settings.

Parameters

$alternative : array<string|int, mixed>

Record line from resource_alt_files

create_resource_type_field()

Create a new resource type field with the specified name of the required type

Parameters

$name : string

• name of new field

$restype : int|array<string|int, mixed> = 0

• resource type - resource type(s) that field applies to (0 = global, single value = one type, array = multiple types)

$type : int = FIELD_TYPE_TEXT_BOX_SINGLE_LINE

• field type - refer to include/definitions.php

$shortname : string = ""

• shortname of new field

$index : bool = false

• should new field be indexed?

metadata_field_view_access()

Check if user has view access to metadata field

Parameters

$field : int

Field ref

Tags

uses

checkperm()

get_workflow_states()

Utility to get all workflow states available in the system.

Tags

uses

global

additional_archive_states

get_workflow_state_names()

delete_resource_type_field()

Delete the specified metadata field. Also delets any node or resource_data rows associated with that field

Parameters

$ref : int

Metadata field id (ref from resource_type_field)

get_resource_table_joins()

update_resource_lock()

Parameters

$ref : mixed

$lockaction : mixed

$newlockuser : mixed = null

$accesschecked : mixed = false

get_resource_lock_message()

Parameters

$lockuser : mixed

get_external_shares()

Get details of external shares

Parameters

$filteropts : array<string|int, mixed>

Array of options to filter shares returned "share_group" - (int) Usergroup ref 'shared as' "share_user" - (int) user ID of share creator "share_order_by" - (string) order by column "share_sort" - (string) sortorder (ASC or DESC) "share_type" - (int) 0=view, 1=upload "share_collection" - (int) Collection ID "share_resource" - (int) Resource ID "access_key" - (string) Access key "ignore_permissions"- (bool) Show all shares, irrespective of permissions

get_video_duration()

Get video duration

Parameters

$file_path : string

Path to video file

Tags

uses

run_command()

relate_all_resources()

Relate all resources in the passed array with each other

Parameters

$related : array<string|int, mixed> = []

Array of resource IDs

update_resource_type_field_order()

Apply new order to metadata fields

Parameters

$neworder : array<string|int, mixed>

Field IDs in new order

update_resource_type_order()

Apply a new order to resource types

Parameters

$neworder : array<string|int, mixed>

Resource type IDs in new order

allow_in_browser()

Check if file can be rendered in browser via download.php

Parameters

$path : string

Path to file

update_resource_field_column()

Update the value of the fieldXX field on resource table

Parameters

$resource : int

• Resource ID

$field : int

• Metadata field ID

$value : string

• Value

data_joins_field_value_translate_and_csv()

Convert $data_joins (ie fieldX column) value to a user friendly version.

Parameters

$value : string|null

Text to be processed

process_resource_data_joins_values()

Process resource data_joins (ie fieldX columns) values

Parameters

$resource : array<string|int, mixed>

A resource table record

$resource_table_joins : array<string|int, mixed>

List of refs for the resource table data_joins. get_resource_table_joins()

resource_has_access_denied_by_RT_size()

Check if resource has access denied by its type and for a size.

Parameters

$resource_type : int

Resource type ref

$size : string

Preview size ID (not ref).

revert_resource_file()

Revert primary resource file based on log entry data

Parameters

$resource : int

Resource ID

$logentry : array<string|int, mixed>

Log data from get_resource_log(). Requires rse_version plugin to be enabled

$createpreviews : bool = true

Create previews?

apply_resource_default()

When changing resource type, new resource type specific fields may become available. This function will apply any resource default values for resource type specific fields that were not previously available (i.e. not containing user data). This is used by upload then edit mode after switching resource types and also when locking the resource type with save and next.

Parameters

$old_resource_type : int

Original resource type.

$new_resource_type : int

Resource type being switched to.

$resource : int

Resource id.

related_resource_pull()

Get a related resource to pull images from

Parameters

$resource : array<string|int, mixed>

Array of resource data from do_search()

get_resource_preview()

Get the largest available preview URL for the given resource and the given array of sizes

Parameters

$resource : array<string|int, mixed>

Array of resource data from get_resource_data() or search results

$sizes : array<string|int, mixed> = []

Array of size IDs to look through, in order of size. If not provided will use all sizes

$access : int = -1

Resource access

$watermark : bool = false

Look for watermarked versions?

$page : int = 1

Page to look for

$try_pulled_resource : bool = true

Should we try to use an image from a pulled resource if the current resource doesn't have a usable preview

$alt : int = -1

Int ref of alternative file

check_resources()

Check integrity of primary resource files

Parameters

$resources : array<string|int, mixed> = []

Array of resource data e.g. from search results

$presenceonly : bool = false

Check for file presence only? If false (and if $file_checksums is enabled) then file checksums will be checked

get_resources_to_validate()

Get an array of all resources that require files to be validated

Parameters

$days : int = 0

Return only resources not validated in the last X number of days

acl_can_edit_resource_of_type()

Access control check that user can edit (a resource) of a particular Resource Type (RT). Main use is to hide inapplicable RTs.

Parameters

$ref : int

Resource type ID

can_upload_preview_image()

Check if current user can upload a preview image

Parameters

$ref : int

Resource ID

resource_has_preview_source()

Check if a resource has a file to derive previews from.

Parameters

$ref : int

Resource ID

$extension : string

Resource file extension

$alternative : int = -1

Alternative file record ID

acl_can_edit_contributed_by()

Access control check that user can edit a resources 'Contributed by' field