Knowledge Base

Search results

search_get_previews

The article describes the search_get_previews function, which is used to perform a search and return matching resources including URLs for the requested preview sizes. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, recent search day limit, preview sizes, and preview file extension.

get_system_status

The get_system_status API provides system status information, which is configuration-dependent, such as mysql_log_transactions. The API does not require any parameters. The API returns a JSON object that contains the system status information.

get_resource_type_fields

The "get_resource_type_fields" function allows users to retrieve metadata field information for all matching fields. This function is available from version 10.3+ and requires permission "a". Users can filter the results by resource type, fuzzy searching, and field type.

get_processing_message

The article explains a function called "get_processing_message" that retrieves the processing status message for the current user. Upon success, it returns an array containing the current processing messages, while on failure, it returns false.

get_resource_field_data

The article provides information about the function "get_resource_field_data" which returns all field data for a given resource. The function requires the ID of the resource as input and returns a JSON containing the resource metadata.

get_resource_log

The "get_resource_log" function returns the full log for a resource. The function takes two parameters: the ID of the resource and the number of rows to return. The default value for the number of rows is -1, which means that all rows will be returned.

get_resource_path

The get_resource_path function returns a URL or file path for a resource file. It takes several parameters, including the ID of the resource or an array of resource IDs, a flag indicating whether a file path should be returned instead of a URL, the size of the requested file, and whether the path should be generated if it does not yet exist on disk.

get_resource_data

The article provides information about the function get_resource_data() which returns the top-level property data for a resource. The function includes truncated summary metadata, and for full, non-truncated metadata, the function get_resource_field_data() should be used.

get_alternative_files

The article describes a function called "get_alternative_files" that returns a list of alternative files for a given resource. The function takes in three optional parameters: $orderby, $sort, and $type.

get_resource_types

The "get_resource_types" function returns all the configured resource types available to the user. The function does not require any parameters and returns a list of resource types. The list includes the reference number, name, allowed extensions, order by, configuration options, tab name, and push metadata for each resource type.

get_related_resources

The article describes a function called "get_related_resources" which returns a list of resources that are related to a particular resource. The function takes a single parameter, which is the ID of the resource.

get_field_options

The get_field_options function returns all the available tags or selectable options for a given field. The function takes two parameters: $ref, which is the ID or shortname of the field, and $nodeinfo, which provides extended field option information if set to TRUE.

get_user_collections

The "get_user_collections" function returns a list of collections belonging to a user. This function does not require any parameters to be passed.

get_resource_all_image_sizes

The article describes a function called "get_resource_all_image_sizes" which is used to retrieve all available sizes for a specific resource. The function takes in the ID of the resource as an input and returns a JSON object containing all the available sizes for the resource.

get_node_id

The get_node_id function is used to find a node ID in a fixed tag field by providing the name of the node and the ID of the related metadata field. The function returns the ID of the existing node or boolean FALSE if no matching node was found for the specified field.

get_users

The article provides information on the get_users function, which is used to retrieve a list of users. The function honours permissions, so users from other groups to which the user does not have access will be omitted.

get_collection

The article provides information on the "get_collection" function, which is used to retrieve collection details. The function requires administrator access and takes the collection ID as input. The return values include the collection owner's name, description, public/private status, and thumbnail image reference.

get_nodes

The get_nodes function retrieves all nodes from a database for a specific metadata field or parent. The function takes several parameters, including the ID of the metadata field, the ID of the parent node, a boolean flag to indicate whether to retrieve children nodes, an offset value to specify the first row to return, a maximum number of rows to return, a filter by name of node, a flag to show how many resources use a particular node in the node properties, and a flag to order by translated names rather than the order_by column.

get_user_message

The article describes a function called "get_user_message" which retrieves a given message ID. The function only allows access to messages that belong to the user who is requesting them. The function takes a single parameter, which is the message ID, and returns an array with three elements: the message text, the message URL, and the message owner.

get_users_by_permission

The article describes a function called "get_users_by_permission" that retrieves information on all users with the given permissions. The function is available in version 10.1 or later and requires an array of permission strings as input.

get_featured_collections

The "get_featured_collections" function in ResourceSpace allows users to retrieve featured collections (categories) from version 10.3 onwards. The function requires the "parent" parameter, which is the reference of the featured collection's parent.

get_edit_access

The "get_edit_access" function is used to check if the current user has edit access to a resource. It checks both the edit permissions and the group edit filter. The function takes a resource ID as a parameter and returns TRUE if the user has edit access to the resource, and FALSE otherwise.

consentmanager_get_consents

The "consentmanager_get_consents" function is used to retrieve all consent data for a given resource. The function takes a variable called "$resource" which represents the ID of the resource. The data type for this variable is an integer.

licensemanager_get_licenses

The article provides information about the "licensemanager_get_licenses" function, which is used to return all licenses held for a given resource. The function takes a variable called "$resource" as input, which represents the ID of the resource.

get_daily_stat_summary

The "get_daily_stat_summary" function returns a summary of daily statistics by activity type. The function takes one parameter, "$days", which specifies the number of days to include in the summary. The default value for "$days" is 30, but it can be set to a maximum of 365 days.

get_resource_access

The "get_resource_access" function retrieves the access level for the currently logged-in user regarding a specified resource. Access levels can be 0 for Full Access (download all sizes), 1 for Restricted Access (download only allowed sizes), or 2 for Confidential (no access).

consentmanager_get_consent

The "consentmanager_get_consent" function retrieves all data related to a specified consent. It requires the input of the consent ID, which should be an integer. The function returns a JSON object that includes the metadata associated with the consent.

consentmanager_get_all_consents

The function `consentmanager_get_all_consents` retrieves all consent records, with an optional filter based on a search text. The function takes a parameter `$findtext`, which is a search string used to filter results by the name of the person giving consent.

consentmanager_get_all_consents_by_collection

The function `consentmanager_get_all_consents_by_collection` retrieves all consent records associated with resources in a specified collection. It requires the input parameter `$collection`, which is the ID of the collection holding the relevant resources.

get_resource_comments

The article discusses the function "get_resource_comments" which retrieves comments for a specified resource reference. It requires a resource ID as an integer input and can return comments in either tree view or flat view, with the default being tree view.

get_reports

The "get_reports" function allows users to retrieve a list of available reports excluding those based on search results. The returned values consist of an array of reports sorted alphabetically by name, along with their reference IDs.

get_collections_resource_count

The function "get_collections_resource_count" retrieves the total resource count for a list of collections specified by their IDs. The input variable is "$refs," which is a string containing a comma-separated list of collection IDs.

get_dash_search_data

The "get_dash_search_data" function retrieves images and resource count for a search dash tile. It operates on a string due to the absence of the dash tile during creation for performance reasons, limiting the return to a maximum of 4 images.

get_data_by_field

The "get_data_by_field" function retrieves the resource data value for a specific field and resource. The function takes two parameters: $resource, which is the Resource ID, and $field, which is the Metadata field ID or field shortname.

get_profile_image

The "get_profile_image" function retrieves the URL of a user's profile image based on either the user's ID or the profile image filename. The function takes two parameters: $user_ref (an integer representing the user's ID) and $by_image (a string representing the profile image filename).

get_resource_collections

The "get_resource_collections" function retrieves a list of collections that a specified resource is used in. It requires a resource ID as input and returns an array of collections with their IDs, names, and descriptions.

get_user_actions()

Developer reference for function get_user_actions()

get_editable_resource_sql()

Developer reference for function get_editable_resource_sql()

getAnnotationTags()

Developer reference for function getAnnotationTags()

get_collection()

Developer reference for function get_collection()

get_theme_image()

Developer reference for function get_theme_image()

get_home_page_promoted_collections()

Developer reference for function get_home_page_promoted_collections()

get_default_dash()

Developer reference for function get_default_dash()

get_user_dash()

Developer reference for function get_user_dash()

job_queue_get_jobs()

Developer reference for function job_queue_get_jobs()

lang_or_i18n_get_translated()

Developer reference for function lang_or_i18n_get_translated()

i18n_get_indexable()

Developer reference for function i18n_get_indexable()

get_nodes()

Developer reference for function get_nodes()

get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

get_research_requests()

Developer reference for function get_research_requests()

get_resource_type_field()

Developer reference for function get_resource_type_field()

get_resource_field_data()

Developer reference for function get_resource_field_data()

get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

get_resource_types()

Developer reference for function get_resource_types()

get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

get_exiftool_fields()

Developer reference for function get_exiftool_fields()

get_alternative_files()

Developer reference for function get_alternative_files()

get_field_options_with_stats()

Developer reference for function get_field_options_with_stats()

get_keyword_from_option()

Developer reference for function get_keyword_from_option()

get_fields()

Developer reference for function get_fields()

get_resource_type_fields()

Developer reference for function get_resource_type_fields()

get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

get_advanced_search_collection_fields()

Developer reference for function get_advanced_search_collection_fields()

search_get_previews()

Developer reference for function search_get_previews()

getThemePathPerms()

Developer reference for function getThemePathPerms()

get_search_default_restypes()

Developer reference for function get_search_default_restypes()

get_featured_collection_categ_sub_fcs()

Developer reference for function get_featured_collection_categ_sub_fcs()

get_all_resource_types()

The get_all_resource_types() function returns an array of all resource types ordered by 'order_by' then 'ref'. This function does not check or apply any permissions, so it should not be exposed to the API.

get_resource_type_field_resource_types()

Description Get all resource_type->resource-type_field associations Parameters Column Type Default Description $fields array [] Optional array of resource_type_field data returned by get_resource_type_fields() Return array Array with resource_type_field ID as keys and arrays of resource_type IDs as values Location include/config_functions.

get_user_actions_recent()

Description Get recent user actions, optionally for all users. For use by action notifications cron job. the 'a' permission and the current script is not running from CLI then only the currently logged on user's actions will be returned Included columns are as per get_user_actions() - resourcerequest - array of resource requests - userrequest - array of user requests - resourcereview - array of resources to reviewdescription) Parameters Column Type Default Description $minutes int Return actions that were created in the last $minutes minutes $allusers: bool $userref; []; // Find all resources that have changed archive state in the given number of minutes if is_int_loose$view_title_field $allusers bool Return actions for all users? If false, or if the current user does not have Return array An array with the user id as the index and the following arrays of sub elements.

get_all_parents_by_leaf()

Description Build a row consisting of all parents of a given leaf node Example: 1 2 2.3 2.7 2.8.4 2.8.5 2.8.6 2.9 3 Passing in node 5 will return nodes 8,2 in one row Parameters Column Type Default Description $ref integer Node ID of tree leaf $level integer Node depth level (as returned by get_tree_node_level()) Return integer|boolean Location include/node_functions.

get_all_ancestors_for_node()

Description Return a row consisting of all ancestor nodes of a given node Example: 1 2 2.3 2.7 2.8.4 2.8.5 2.8.6 2.9 3 Passing in node 5 will return nodes 8,2 in one row Parameters Column Type Default Description $ref integer A tree node $level integer Node depth level (as returned by get_tree_node_level()) Return array|boolean Location include/node_functions.

getAnnotation()

Developer reference for function getAnnotation()

getAnnotations()

Developer reference for function getAnnotations()

getResourceAnnotationsCount()

Developer reference for function getResourceAnnotationsCount()

getResourceAnnotations()

Developer reference for function getResourceAnnotations()

getAnnotoriousResourceAnnotations()

Developer reference for function getAnnotoriousResourceAnnotations()

get_api_key()

Developer reference for function get_api_key()

iiif_get_canvases()

Developer reference for function iiif_get_canvases()

iiif_get_thumbnail()

Developer reference for function iiif_get_thumbnail()

iiif_get_image()

Developer reference for function iiif_get_image()

get_user_collections()

Developer reference for function get_user_collections()

get_collection_resources()

Developer reference for function get_collection_resources()

get_collection_resources_with_data()

Developer reference for function get_collection_resources_with_data()

get_max_theme_levels()

Developer reference for function get_max_theme_levels()

get_theme_headers()

Developer reference for function get_theme_headers()

get_themes()

Developer reference for function get_themes()

get_smart_theme_headers()

Developer reference for function get_smart_theme_headers()

get_smart_themes_nodes()

Developer reference for function get_smart_themes_nodes()

get_saved_searches()

Developer reference for function get_saved_searches()

get_search_title()

Developer reference for function get_search_title()

get_collection_resource_comment()

Developer reference for function get_collection_resource_comment()

get_mycollection_name()

Developer reference for function get_mycollection_name()

get_collection_comments()

Developer reference for function get_collection_comments()

get_collection_external_access()

Developer reference for function get_collection_external_access()

get_collection_log()

Developer reference for function get_collection_log()

get_collection_videocount()

Developer reference for function get_collection_videocount()

get_session_collections()

Developer reference for function get_session_collections()

get_last_resource_edit()

Developer reference for function get_last_resource_edit()

GetThemesFromRequest()

Developer reference for function GetThemesFromRequest()

collection_download_get_archive_file()

Developer reference for function collection_download_get_archive_file()

get_user_selection_collection()

Developer reference for function get_user_selection_collection()

get_config_option()

Developer reference for function get_config_option()

get_config_option_users()

Developer reference for function get_config_option_users()

get_config_options()

Developer reference for function get_config_options()

get_header_image()

Developer reference for function get_header_image()

get_tile()

Developer reference for function get_tile()

get_alluser_available_tiles()

Developer reference for function get_alluser_available_tiles()

get_managed_dash()

Developer reference for function get_managed_dash()

get_tile_user_groups()

Developer reference for function get_tile_user_groups()

get_usergroup_available_tiles()

Developer reference for function get_usergroup_available_tiles()

get_usergroup_tile()

Developer reference for function get_usergroup_tile()

get_user_tile()

Developer reference for function get_user_tile()

get_user_available_tiles()

Developer reference for function get_user_available_tiles()

get_tile_custom_style()

Developer reference for function get_tile_custom_style()

db_get_connection_mode()

Developer reference for function db_get_connection_mode()

get_query_cache_location()

Developer reference for function get_query_cache_location()

get_checksum()

Developer reference for function get_checksum()

getval()

Developer reference for function getval()

getuid()

Developer reference for function getuid()

get_stats_activity_types()

Developer reference for function get_stats_activity_types()

get_stats_years()

Developer reference for function get_stats_years()

get_all_site_text()

Developer reference for function get_all_site_text()

get_site_text()

Developer reference for function get_site_text()

get_mime_type()

Developer reference for function get_mime_type()

get_allowed_extensions()

Developer reference for function get_allowed_extensions()

get_allowed_extensions_by_type()

Developer reference for function get_allowed_extensions_by_type()

getAbsolutePath()

Developer reference for function getAbsolutePath()

getFolderContents()

Developer reference for function getFolderContents()

get_temp_dir()

Developer reference for function get_temp_dir()

get_xml_entity_at_index_0()

Developer reference for function get_xml_entity_at_index_0()

get_imagemagick_path()

Developer reference for function get_imagemagick_path()

get_utility_path()

Developer reference for function get_utility_path()

get_executable_path()

Developer reference for function get_executable_path()

get_editable_states()

Developer reference for function get_editable_states()

get_slideshow_files_data()

Developer reference for function get_slideshow_files_data()

get_recent_users()

Developer reference for function get_recent_users()

get_sysvar()

Developer reference for function get_sysvar()

show_pagetime()

Developer reference for function show_pagetime()

get_debug_log_dir()

Developer reference for function get_debug_log_dir()

get_section_list()

Developer reference for function get_section_list()

get_ip()

Developer reference for function get_ip()

i18n_get_translated()

Developer reference for function i18n_get_translated()

i18n_get_collection_name()

Developer reference for function i18n_get_collection_name()

i18n_get_translations()

Developer reference for function i18n_get_translations()

http_get_preferred_language()

Developer reference for function http_get_preferred_language()

get_activity_log()

Developer reference for function get_activity_log()

get_user_downloads()

Developer reference for function get_user_downloads()

message_get()

Developer reference for function message_get()

getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

get_export_tables()

Developer reference for function get_export_tables()

get_node()

Developer reference for function get_node()

get_tree_node_level()

Developer reference for function get_tree_node_level()

get_root_node_by_leaf()

Developer reference for function get_root_node_by_leaf()

get_node_order_by()

Developer reference for function get_node_order_by()

get_resource_nodes()

Developer reference for function get_resource_nodes()

get_nodes_from_keywords()

Developer reference for function get_nodes_from_keywords()

get_parent_nodes()

Developer reference for function get_parent_nodes()

get_nodes_count()

Developer reference for function get_nodes_count()

get_node_by_name()

Developer reference for function get_node_by_name()

get_node_id()

Developer reference for function get_node_id()

get_node_elements()

Developer reference for function get_node_elements()

get_node_tree()

Developer reference for function get_node_tree()

get_tree_strings()

Developer reference for function get_tree_strings()

get_pdf_template_path()

Developer reference for function get_pdf_template_path()

get_template_path()

Developer reference for function get_template_path()

get_pdf_templates()

Developer reference for function get_pdf_templates()

get_plugin_yaml()

Developer reference for function get_plugin_yaml()

get_plugin_config()

Developer reference for function get_plugin_config()

get_plugin_css()

Developer reference for function get_plugin_css()

get_plugin_path()

Developer reference for function get_plugin_path()

get_report_name()

Developer reference for function get_report_name()

get_reports()

Developer reference for function get_reports()

get_translated_activity_type()

Developer reference for function get_translated_activity_type()

get_request()

Developer reference for function get_request()

get_user_requests()

Developer reference for function get_user_requests()

get_requests()

Developer reference for function get_requests()

get_research_request()

Developer reference for function get_research_request()

get_research_request_collection()

Developer reference for function get_research_request_collection()

get_resource_path()

Developer reference for function get_resource_path()

get_resource_data()

Developer reference for function get_resource_data()

get_max_resource_ref()

Developer reference for function get_max_resource_ref()

get_resource_ref_range()

Developer reference for function get_resource_ref_range()

get_resource_log()

Developer reference for function get_resource_log()

get_resource_type_name()

Developer reference for function get_resource_type_name()

get_resource_custom_access()

Developer reference for function get_resource_custom_access()

get_resource_custom_access_users_usergroups()

Developer reference for function get_resource_custom_access_users_usergroups()

get_custom_access()

Developer reference for function get_custom_access()

get_themes_by_resource()

Developer reference for function get_themes_by_resource()

get_alternative_file()

Developer reference for function get_alternative_file()

get_field()

Developer reference for function get_field()

get_resources_matching_keyword()

Developer reference for function get_resources_matching_keyword()

get_resource_access()

Developer reference for function get_resource_access()

get_custom_access_user()

Developer reference for function get_custom_access_user()

get_edit_access()

Developer reference for function get_edit_access()

get_metadata_templates()

Developer reference for function get_metadata_templates()

get_resource_collections()

Developer reference for function get_resource_collections()

get_resource_files()

Developer reference for function get_resource_files()

get_page_count()

Developer reference for function get_page_count()

get_total_disk_usage()

Developer reference for function get_total_disk_usage()

get_original_imagesize()

Developer reference for function get_original_imagesize()

get_resource_external_access()

Developer reference for function get_resource_external_access()

get_video_snapshots()

Developer reference for function get_video_snapshots()

get_video_info()

Developer reference for function get_video_info()

get_extension()

Developer reference for function get_extension()

get_last_resource_edit_array()

Developer reference for function get_last_resource_edit_array()

get_default_archive_state()

Developer reference for function get_default_archive_state()

get_resource_all_image_sizes()

Developer reference for function get_resource_all_image_sizes()

get_image_sizes()

Developer reference for function get_image_sizes()

get_preview_quality()

Developer reference for function get_preview_quality()

get_related_resources()

Developer reference for function get_related_resources()

get_field_options()

Developer reference for function get_field_options()

get_data_by_field()

Developer reference for function get_data_by_field()

get_resources_by_resource_data_value()

Developer reference for function get_resources_by_resource_data_value()

get_all_image_sizes()

Developer reference for function get_all_image_sizes()

get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

get_category_tree_fields()

Developer reference for function get_category_tree_fields()

get_OR_fields()

Developer reference for function get_OR_fields()

get_nopreview_icon()

Developer reference for function get_nopreview_icon()

get_indexed_resource_type_fields()

Developer reference for function get_indexed_resource_type_fields()

get_download_filename()

Developer reference for function get_download_filename()

get_resource_type_from_extension()

Developer reference for function get_resource_type_from_extension()

get_workflow_states()

Developer reference for function get_workflow_states()

get_resource_table_joins()

Developer reference for function get_resource_table_joins()

get_resource_lock_message()

Developer reference for function get_resource_lock_message()

get_upload_here_selected_nodes()

Developer reference for function get_upload_here_selected_nodes()

get_default_search_states()

Developer reference for function get_default_search_states()

get_filter_sql()

Developer reference for function get_filter_sql()

get_suggested_keywords()

Developer reference for function get_suggested_keywords()

get_related_keywords()

Developer reference for function get_related_keywords()

get_grouped_related_keywords()

Developer reference for function get_grouped_related_keywords()

get_simple_search_fields()

Developer reference for function get_simple_search_fields()

get_fields_for_search_display()

Developer reference for function get_fields_for_search_display()

get_filters()

Developer reference for function get_filters()

get_filter()

Developer reference for function get_filter()

get_filter_rules()

Developer reference for function get_filter_rules()

get_filter_rule()

Developer reference for function get_filter_rule()

get_slideshow_image_file_path()

Developer reference for function get_slideshow_image_file_path()

get_users()

Developer reference for function get_users()

get_users_with_permission()

Developer reference for function get_users_with_permission()

get_user_by_email()

Developer reference for function get_user_by_email()

get_user_by_username()

Developer reference for function get_user_by_username()

get_usergroups()

Developer reference for function get_usergroups()

get_usergroup()

Developer reference for function get_usergroup()

get_user()

Developer reference for function get_user()

get_active_users()

Developer reference for function get_active_users()

get_user_log()

Developer reference for function get_user_log()

get_registration_selectable_usergroups()

Developer reference for function get_registration_selectable_usergroups()

get_rs_session_id()

Developer reference for function get_rs_session_id()

get_notification_users()

Developer reference for function get_notification_users()

get_users_from_permission_lookup()

Developer reference for function get_users_from_permission_lookup()

get_video_resolution()

Developer reference for function get_video_resolution()

get_selectedtypes()

Developer reference for function get_selectedtypes()

job_queue_get_job()

Developer reference for function job_queue_get_job()

get_featured_collection_resources()

Developer reference for function get_featured_collection_resources()

get_featured_collections()

Developer reference for function get_featured_collections()

get_featured_collection_categories()

Developer reference for function get_featured_collection_categories()

get_featured_collection_category_branch_by_leaf()

Developer reference for function get_featured_collection_category_branch_by_leaf()

get_featured_collection_ref_by_name()

Developer reference for function get_featured_collection_ref_by_name()

get_featured_collections_by_resources()

Developer reference for function get_featured_collections_by_resources()

dash_tile_featured_collection_get_resources()

Developer reference for function dash_tile_featured_collection_get_resources()

get_inner_html_from_tag()

Developer reference for function get_inner_html_from_tag()

get_all_featured_collections()

Developer reference for function get_all_featured_collections()

get_resource_nodes_batch()

Developer reference for function get_resource_nodes_batch()

get_resource_data_batch()

Developer reference for function get_resource_data_batch()

get_nodes_by_refs()

Description Find and return node details for a list of node IDs. Parameters Column Type Default Description $refs array List of node IDs Return array Location include/node_functions.

get_session_api_key()

Description Return the session specific key for the given user. Parameters Column Type Default Description $user integer The user ID Return string Location include/api_functions.

get_profile_image()

Description Generate the url to the user's profile image. Fetch the url by the user's id or by the profile image filename. Parameters Column Type Default Description $user_ref int "" User id of the user who's profile image is requested.

get_profile_text()

Description Return user profile for a defined user. Parameters Column Type Default Description $user_ref int User id to fetch profile details for.

get_languages_notify_users()

Description load language files for all users that need to be notified into an array - use for message and email notification load in default language strings first and then overwrite with preferred language strings Parameters Column Type Default Description $languages array array - array of language strings Return array $language_strings_all This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 8th May 2026 11:00 Europe/London time.

get_collections_resource_count()

Description Get collection total resource count for a list of collections note that the returned array might NOT contain keys for all the input IDs (e.g validation failed).

get_external_shares()

Description Get details of external shares "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 Parameters Column Type Default Description $filteropts array Array of options to filter shares returned Return array Location include/resource_functions.

get_upload_url()

Description Generate upload URL - alters based on $upload_then_edit setting and external uploads Parameters Column Type Default Description $collection string "" - optional collection $k "" $accesskey string - used for external users Return string This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 8th May 2026 11:00 Europe/London time.

get_search_params()

Description Get all search request parameters. Note that this does not escape the parameters which must be sanitised using e.g. htmlspecialchars() or urlencode() before rendering on page Parameters This function accepts no parameters.

get_geolibraries()

Description Checks the current page and includes necessary geolocation libraries for Leaflet maps. This function loads the Leaflet Control Geocoder plugin and checks if the current page requires geolocation capabilities.

get_geo_maps_scripts()

Description Outputs the script tag for including additional Leaflet plugins. This function loads the necessary JavaScript for the Leaflet Marker Cluster library, which helps in managing large sets of markers on Leaflet maps by clustering them for better visualization.

get_tracked_vars()

Description Get all tracked variables (for debug) for user. If user invalid, it will get all the variables currently being tracked by all users. Parameters Column Type Default Description $user int User ID Return array List of variable names Location include/debug_functions.

radio_get_layout()

Parameters Column Type Default Description $options Location include/render_functions.

get_password_hash_info()

Description Helper function to get the password hash information (algorithm and options) from the global scope. Parameters This function accepts no parameters. Return array Location include/login_functions.

message_get_conversation()

Description Get all messages between the given user IDs "msgfind" - (string) Text to find "sort_desc" - (bool) Sort by message ID in descending order? False = Ascending "limit" - (int) Maximum number of messages to return Parameters Column Type Default Description $user int $msgusers array array Array of other user IDs $filteropts array array: array { array_map"is_int_loose" Array of extra options to filter and sort messages returned $msgusers; $users int User ID Return array Array of messages Location include/message_functions.

message_getrefs()

Description Get all message refs for a given user Parameters Column Type Default Description $user string User ID Return void Location include/message_functions.

get_video_duration()

Description Get video duration Parameters Column Type Default Description $file_path string Path to video file Return float Location include/resource_functions.

get_job_type_priority()

Description Get the default priority for a given job type Parameters Column Type Default Description $type string "" Name of job type e.

get_system_status()

Description Get system status information Parameters Column Type Default Description $basic bool false Optional, set to true to perform a quick "system up" check only.

get_active_plugins()

Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 363 to 366 Definition function get_active_plugins () { return ps_query ( 'SELECT name, enabled_groups, config, config_json FROM plugins WHERE inst_version >= 0 ORDER BY priority, name' , array(), 'plugins' ); } This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 15th January 2026 12:05 Europe/London time.

get_default_user_collection()

Description Get the user's default collection, creating one if necessary Parameters Column Type Default Description $setactive bool false Set the collection as the user's active collection? Return int collection ID Location include/collections_functions.

get_approver_usergroups()

Description Returns an array of the user groups the supplied user group acts as an approver for. Uses config $usergroup_approval_mappings. Parameters Column Type Default Description $usergroup int "" Approving user group Return array Array of subordinate user group ids.

get_usergroup_approvers()

Description Returns an array of user groups who act as user request approvers to the user group supplied. Uses config $usergroup_approval_mappings. Parameters Column Type Default Description $usergroup int "" Subordinate user group who's approval user group we need to find.

get_dash_search_data()

Description Get images and resource count for search dash tile. This has to work on a string because the dash tile does not yet exist when on dash creation page For performance this function will return a maximum of 4 images Parameters Column Type Default Description $link string '' Tile link URL $promimg int 0 Promoted image ref Return array $searchdata Array containing the count of resources and details of preview images.

get_nodes_use_count()

The get_nodes_use_count() function is a PHP function in ResourceSpace that returns an array of node references as keys and the number of resources using them as values. The function takes an array of node references as input and filters out any non-integer values.

get_tabs_by_refs()

The get_tabs_by_refs() function is a PHP function that retrieves entire tab records for a list of IDs. The function takes an array of tab refs as a parameter and returns an array of tab records. The function first filters the array of tab refs to remove any non-integer values.

get_tabs_with_usage_count()

The get_tabs_with_usage_count() function is used to retrieve tabs based on certain criteria, such as order by and limit. The function takes an array of criteria information as a parameter, including the order by and limit values.

get_all_tabs()

The get_all_tabs() function is a PHP function that retrieves all tab records sorted by the order_by column. This function does not accept any parameters and returns an array. The function is located in the tab_functions.

get_tab_name_options()

The article describes a function called `get_tab_name_options()` that returns a list of all tabs sorted based on the current configuration. The function takes no parameters and returns an array where the key is the tab's ID and the value is its translated name.

get_notification_users_by_owner_field()

The get_notification_users_by_owner_field() function is used to retrieve users to notify for requested resources owned by particular groups. The function takes two parameters: an array of notification users and an array of resource IDs.

get_cattree_nodes_ordered()

get_cattree_nodes_ordered()

get_cattree_node_strings()

get_cattree_node_strings()

get_resources_nodes_by_rtf()

The get_resources_nodes_by_rtf() function is a PHP function that retrieves all resource nodes associated with a specific resource type field. The function takes a single parameter, which is the resource type field ID.

get_user_message()

The get_user_message() function retrieves the user message for the given reference. It takes two parameters: $ref, which is the message ID, and $checkaccess, which is a boolean value that checks if the user can see the given message.

get_node_strings()

The get_node_strings() function is a PHP function that returns an array of strings representing the full paths to each tree node passed. The function takes three parameters: $resource_nodes, $allnodes, and $translate.

get_users_by_permission()

The "get_users_by_permission()" function retrieves all user records in groups with or without the specified permissions. It takes an array of permission strings to check as a parameter and returns a subset of columns for matching user records.

rs_get_resource_type()

Description Get resource_type data Parameters Column Type Default Description $ref int Return array * Location include/config_functions.

get_resource_type_field_columns()

Description Get the definitions for resource_type_field columns, including properties and display configurations. Parameters This function accepts no parameters. Return array An associative array of resource type field column definitions.

try_getimagesize()

Parameters Column Type Default Description $filename string &$image_info null This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 11th May 2026 12:25 Europe/London time.

get_users_by_preference()

Description Retrieve all user records with the user preference specified Parameters Column Type Default Description $preference string Preference to check $value string Preference value to check for "s" $params; []; // Add action for users who can submit 'pending submission' resources for review ifcheckperm"e-2" && checkperm"e-1" && checkperm'd' Return array Array of user refs with the preference set as specified This article was last updated 8th February 2024 12:05 Europe/London time based on the source file dated 8th February 2024 08:35 Europe/London time.

i18n_get_all_translations()

Description Return an array of all available language strings for the given id, with the language code as the key Parameters Column Type Default Description $langid: string $langid string The identifier of the lang string Return array * Location include/language_functions.

api_get_daily_stat_summary()

Description Return a summary of daily statistics Parameters Column Type Default Description $days int 30 The number of days - note max 365 days as only the current and previous year's data is accessed.

get_resource_preview()

Description Get the largest available preview URL for the given resource and the given array of sizes Parameters Column Type Default Description $resource array Array of resource data from get_resource_data() or search results $sizes array [] Array of size IDs to look through, in order of size.

get_total_approved_users()

Description Return the total number of approved Parameters Column Type Default Description int { : 1" [] * 0; } /** by filtered []; Return integer The number of approved users This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 11th May 2026 12:25 Europe/London time.

get_total_resources()

Description Return the number of resources in the system with optional filter by archive state Parameters Column Type Default Description $status int|bool false Archive state to filter by if required Return int Number of resources in the system, filtered by status if provided This article was last updated 26th April 2024 15:35 Europe/London time based on the source file dated 25th April 2024 17:25 Europe/London time.

get_resources_to_validate()

Description Get an array of all resources that require files to be validated Parameters Column Type Default Description $days int Return only resources not validated in the last X number of days $GLOBALS["file_integrity_ignore_resource_types"] Location include/resource_functions.

get_nopreview_html()

Description Returns the HTML necessary to represent a resource with the given extension when no image preview exists. Parameters Column Type Default Description $extension string File extension $resource_type int 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_display_language()

Description Get the name of a language in your own language plus its native name. Used for language selection dropdowns. Parameters Column Type Default Description $language_key string Key of $languages array, e.

getCertificateExpiry()

Description Get expiration date of a given PEM certificate Parameters Column Type Default Description $cert string Certificate text Return string|bool Expiry date.

get_usage_options()

Description Get usage options stored in the database, replaces the $download_usage_options config option Parameters Column Type Default Description $all bool false Return all options if true and only enabled options if false $detailed bool Returns all columns if true and an associative array in the format of ref => usage option Return array with $detailed set to false returns an associative array i.

get_usergroup_parent_for_inherit_flag()

Description Check if the usergroup has a parent and the specified inherit flag is in use e.g. user group inherits permissions from parent. Parameters Column Type Default Description $usergroup_id int User group of the current user / user group to test.

get_mime_types_by_extension()

Description Find matching MIME type(s) for a file extension. Parameters Column Type Default Description $extension: string * $banned_extensions_mimes; } /** array_flip$GLOBALS['banned_extensions']; > array $v $extension string Return list<string> This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 11th May 2026 12:25 Europe/London time.

get_annotate_fields()

Description Get (viewable) "annotate_fields" config. The configs' value is validated (e.g. view access, supported type, active RTF, excluded RT, etc.). Parameters Column Type Default Description array { : SORT_NUMERIC metadata_field_view_access.

get_annotorious_lang()

Description Get all translations relevant to the Annotorious (RSTagging) plugin. Parameters Column Type Default Description $map: array $annotateid; getval"annotateid" 'annotorious_type_to_search_field' > 1 'annotate_public_view' > 1 'annotate_show_author' > 1 can't annotations * FIELD_TYPE_CHECK_BOX_LIST]; } /** $getfilepath string { $extension: $scramble_key $baseurl //or $annotateid; string> array

get_required_fields()

Description Return array containing data for all required fields that apply to the given resource type. Parameters Column Type Default Description $resource_type: int $resource_type int Resource type reference.

get_workflow_state_names()

Parameters Column Type Default Description array { : $additional_archive_states; Location include/resource_functions.

get_per_page_cookie()

Description Retrieve the pager cookie for the current page. This function also clears the per_page and per_page_list cookies Parameters Column Type Default Description int { : -1; '' 2 * 10" 7 3-5 empty an input empty asterisk an for 10-* when false empty otherwise $max_val int 0 $optional bool false $allow_wildcard bool This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 11th May 2026 12:25 Europe/London time.

get_job_queue_log_path()

Description Build and ensure a writable log file path for a queued job Parameters Column Type Default Description $type string "" Job category or queue type used as a subdirectory name $job_code string "" Job identifier used in the log filename $job_ref string Job reference value used in the log filename Return string|false Full path to the log file on success, or false on failure Location include/job_functions.

get_job_queue_log_path_by_ref()

Description Resolve a queued job reference to its corresponding log file path Parameters Column Type Default Description $job_ref int Job reference Return string|false Full path to the job log file on success, or false on failure Location include/job_functions.

get_job_progress_from_log_file()

Description Scan a log file from the end and return the most recent line matching a pattern. The file is read in fixed-size blocks starting from EOF and scanned backwards line-by-line for the first line that matches the supplied regular expression (by default, lines containing "[PROGRESS]").

get_comments_by_ref()

Description Return comments for a resource or collection. There are two options for the output: 1. A flat list of comments ordered by creation date, newest first. Config $comments_flat_view = true 2.

get_alternative_files_by_filename()

Description Search the alternative file records for matching filenames Alternative files can be optionally filtered by the Resource ID or by collection resource ID, filename, file size, extension, name, and description Parameters Column Type Default Description $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 new PreparedStatementQuery "SELECT ref Maximum Resource ID to consider, use 0 to ignore resource file_name file_size file_extension name FROM description ?" ["s" $filename] Return array All matching alternative file records with corresponding: Location include/resource_functions.

User research requests

Research requests enable users to ask admins for help in sourcing resources. Users can fill out a form detailing what they need, and administrators can then help them to find suitable resources. This can be done by either providing them with a list of resources or by sending them links to searches or collections to help them get their search started.

Adding resources to a collection

This article explains the different ways to add resources to a collection in a learning management system. Resources can be added to multiple collections at any given time. The first way to add resources is during upload, where the resources can be added to an existing or new collection.

API

ResourceSpace implements a RESTful API that returns JSON. All requests must be signed using a shared private key specific to each user. This can be performed via GET or POST.

LibreOffice integration for Microsoft Office previews

The article provides instructions on how to install and use Unoconv, a utility that allows conversion between different document formats in Open Office. The article explains that in order to preview files in common office document formats such as .

StaticSync - keep your files in situ

StaticSync is a tool that allows users to keep their files in situ, meaning that they can remain in their existing folder structure. It is not intended to be used as a way to store resources externally to increase storage capability.

Translations

The article provides a guide on how to create an official standard translation and a custom translation for a system. Before starting an official translation, it is important to verify that no other translator is already working with the language.

Simple SAML

This plugin allows users to log on to ResourceSpace using a SAML compliant single sign-on (SSO) Identity Provider (IdP)

Metadata read/write mapping

ResourceSpace can map between embedded metadata stored in original files and the metadata fields in ResourceSpace itself. This synchronisation can be two-way, so that imported metadata can be automatically extracted into a configured field, but also that metadata added to the resource after import is written back to the file at download.

Installing on Windows Server

The article provides a step-by-step guide to installing ResourceSpace on Windows Server. The instructions include setting up the IIS Web Server role, installing Web Platform Installer to help with PHP and MySQL install, configuring php.

IIIF

IIIF is an API specification that aims to improve interoperability between digital image repositories. ResourceSpace provides basic support for the IIIF presentation API, which was originally created to link with the TMS plugin to enable publishing of resources related to a specified TMS object as a IIIF manifest.

Coding standards v2.1

The article provides coding standards for developers working on the ResourceSpace project. The standards cover various aspects of coding, including security, documentation, functionality, PHP version, MySQL strict mode, backward compatibility, file format, coding style, indentation, line length, control structures, function calls, function definitions, MySQL statements, readability of code blocks, returning early, and avoiding cross-site scripting vulnerabilities.

Database schema

Database schema for ResourceSpace.

Client side API calls

The article discusses the use of the new api() JavaScript function to make calls to the ResourceSpace API using native browser authentication. Instead of creating new AJAX calls to custom endpoints, the api() function is recommended.

Offline archive

The Offline Archive plugin allows users to relocate archived files to an offline location. Once enabled, users can configure the plugin to specify how the relocation will occur. There are four configuration options available: selecting the metadata field that will hold the archive reference code, entering the location that the archives will be created in, specifying a subfolder of the StaticSync folder that restored files will be placed in, and determining whether to carry across the timestamp of the original file.

Sending user notifications

The article provides guidance on sending user notifications in ResourceSpace. Before version 10, developers had to make several checks before calling send_mail() or message_add() whenever required, resulting in duplicated code and inconsistency.

Prepared statements

ResourceSpace, an open-source digital asset management software, has announced that all new code must use prepared statements for any SQL execution. The new functions ps_query(), ps_array() and ps_value() replace functions sql_query(), sql_array() and sql_value() respectively.

OpenAI GPT

OpenAI's GPT language model has been integrated into ResourceSpace, a digital asset management system, to automate metadata processing tasks. The plugin allows users to use GPT to populate metadata fields based on data stored in another field.

create_resource_type_field

The article provides information about the "create_resource_type_field" function. This function allows users to retrieve metadata field information for all matching fields. It is available from version 10.

Configuring the download filename format

ResourceSpace version 10.3 introduces a new system-wide configuration that allows administrators to format the final download filename. This configuration applies to resources and their alternatives, including preview sizes.

CSP frame-ancestors

The article discusses the use of CSP frame-ancestors to specify which sites can embed a ResourceSpace page using certain HTML tags. To enable this feature, the configuration option $csp_frame_ancestors needs to be set as an array of valid parent URLs.

new_user

The article provides instructions on creating a user record by first obtaining the user ID and then calling `save_user()` with the user details. It includes a table detailing the variable `$username`, its description as the user's username, data type as a string, and default value as N/A.

Welcome to ResourceSpace

The ResourceSpace Knowledge Base provides a library of guides and information to help individuals and businesses with their Digital Asset Management System.

New to ResourceSpace?

Find out from the Knowledge Base how to get started with the ResourceSpace Digital Asset Management System.

User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Knowledge Base structure

Article to explain how the ResourceSpace Knowledge Base is structured to assist with finding content specific for the reader

Resources and structure

Article to explain the concept of Resources and how they are structured with ResourceSpace Digital Asset Manager

Collections, public collections and featured collections

ResourceSpace allows resources to be tagged with various metadata, eliminating the need for a traditional hierarchical folder structure. This means that a resource can exist in multiple collections and can be found through metadata searches.

Language options

ResourceSpace is a platform that supports multiple languages and allows users to change their language preferences. The platform can detect and suggest the default language based on the user's browser.

Uploading

Uploading files into ResourceSpace is a very simple process, however it is at this stage that you will be adding the metadata that ensures your resources can found and used effectively. It is key that you put as much relevant metadata into the resource fields as possible now to make your contributions as valuable as they can be.

Simple search

The article discusses the simple search panel in ResourceSpace, a system that allows for easy searching within the platform. The basic panel includes a general search box for quick text searching across all indexed fields, as well as options to search by resource type and date.

Searching in ResourceSpace

The ResourceSpace search feature is a powerful tool that allows users to quickly find the resources they need. Users can start with a broad search and then refine the results to find the most relevant content.

Alternative files

Alternative files are a feature in ResourceSpace that allows users to store multiple versions of a resource together with a single set of metadata. This is useful when there are different variations of a resource that need to be easily accessible from a single point.

Related resources

The article explains how resources can be related to each other in order to group similar or mutually relevant resources. There are three ways to relate resources: relating all resources in a collection, manually relating resources by editing each resource individually, and relating resources on upload.

Creating collections

The article explains how to create collections in ResourceSpace, a digital asset management system. Collections can be created in three ways: when uploading resources, from the collection bar, or from the "manage my collections" section.

Creating featured collections

This article explains how to create a featured collection in ResourceSpace, which is a collection of resources that is highlighted on the platform's homepage. The process is similar to creating a public collection, but with an additional step to turn it into a featured collection.

Special search terms

Special search terms help users to find content in a much more specific and controlled manner, either through giving them extra tools or using a prebuilt search.

Flickr publishing

The Flickr publishing plugin allows users to publish selected resources from selected collections to a Flickr account. To use the plugin, users must create a featured collection or collection that contains resources they wish to publish.

License manager

Adds the capability to manage resource licensing via the resource view page.

Video splice

The video splice plugin allows users to trim and merge videos within ResourceSpace to create new, separate files. The trim tool allows users to select portions of a video to be recreated as a new video file, which can then be added as a new resource or attached as an alternative to the original.

Youtube publish

The YouTube Publish plugin allows users to publish video resources to a configured YouTube account. The plugin uploads data and has configurable mapped fields to automatically add descriptions, titles, and tags.

Homepage slideshow

ResourceSpace, a digital asset management software, has highlighted the importance of updating the homepage slideshow regularly to keep users engaged and the system looking appealing. The "big slideshow" provides a full-screen background image or slideshow for the homepage, while the "small slideshow" moves the slideshow window to the upper left side of the screen, leaving white space on the homepage for displaying dash tiles.

Resource types

Resource types are a key way to organise metadata in ResourceSpace, allowing users to record different metadata for different types of assets. Resource types can be created as needed, and separating resources into types allows users to apply certain media-specific fields only where they will be useful, saving time and effort.

Managing metadata

The article discusses the importance of managing metadata in a system to make searching for resources faster, easier and more intuitive. The article suggests that metadata should be descriptive, clear and complete to ensure that users can search effectively and get the best out of using the system.

Understanding resource metadata

Metadata is essential for describing resources and forms the basis of search. When a resource is uploaded into ResourceSpace, it is tagged with words or phrases that best describe the asset. These tags form the resource metadata and are how users search for the resources they need.

Creating and deleting metadata fields

The article provides guidance on creating and deleting metadata fields in ResourceSpace. Metadata fields should be clear and descriptive, and the right data should be stored in the right field type to achieve this.

Configuring category trees

The category tree field type is useful for selecting metadata tags from a nested tree, particularly where resource subjects follow a hierarchical classification, such as product taxonomy or projects within campaigns.

Advanced metadata field configuration

This page covers the advanced options for metadata field configuration including display templates, smart featured collections, display conditions, autocomplete options and additional settings for ExifTool and IPTC metadata.

Related keywords

The article explains how to manage related keywords in a website's admin panel. This feature allows creating relationships between search terms so that a search for one will also return resources that have the other keyword present in their metadata.

Edit & upload tabs

This article provides guidance on how to set up and manage tabs in ResourceSpace, a digital asset management system. Tabs can be used to group related metadata fields together, making it easier for users to navigate and edit metadata.

User account requests

ResourceSpace offers the option for users to request accounts, which can be enabled or disabled in the system config file. There are four ways in which account requests can work, depending on how the installation is configured.

Advanced user group options

The article explains the advanced user group options available in ResourceSpace. These options are hidden by default to make the user group page easier to use, but they can be accessed by clicking on the "Advanced options" header above the save button.

Writing your own plugins

A plugin in ResourceSpace is a collection of PHP code, language files, graphics, CSS files and other related files that are structured to conform to the ResourceSpace plugin architecture. For deployment, the files that constitute a plugin are packaged together into a self-contained file called a ResourceSpace Plugin (.

CSV upload

The CSV upload plugin for ResourceSpace allows users to edit existing resource metadata and create new resources by uploading a CSV file. The plugin is recommended for administrators and users with elevated permissions due to the risk of inserting incorrect data into ResourceSpace.

Advanced workflow

workflow, process, publish, embargo, archive, review,state, status

Video tracks

The Video Tracks plugin for ResourceSpace enables users to create custom video files in alternative formats/codecs, including subtitle and audio track files that have been uploaded as alternative files for a video resource.

Version control

The article explains how to use version control functions from the resource log. Users can click on a log entry to bring up a page showing the full log entry, and a revert link will be displayed where it is relevant.

KE EMu database integration

KE EMu is a multi-user and object-oriented database management system that uses a Texpress database engine. The Texpress kernel has features that allow for easy creation and use of applications, accessed via a range of applications.

do_search

The article provides a description of the do_search function, which is used to perform a search and return matching resources. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, and offset.

update_field

The article provides information on the update_field function, which is used to set the value of a metadata field. The function requires the ID of the resource, the numeric ID or shortname of the field, and the value to set the field to.

Installation overview

The article provides an overview of the installation process for ResourceSpace, a standard PHP/MySQL application. The installation process is similar to other PHP/MySQL applications, and most issues encountered relate to the default php.

Installing on Ubuntu Linux

The article provides a step-by-step guide to install ResourceSpace on Ubuntu Linux. The installation process involves installing programs and dependencies, configuring PHP, creating a database, checking out ResourceSpace, finishing installation via a web browser, setting up the cron job for relevance matching and periodic emails, setting the file and folder permissions, and setting up Apache correctly.

Installing on CentOS Linux

The article provides a guide for installing ResourceSpace on CentOS Linux. The installation process involves updating the system, installing MySQL Community Repo, and then installing mysql-server. Other packages that need to be installed include httpd, php, php-dev, php-gd, php-mysql, php-mbstring, subversion, vim, nano, ghostscript, ImageMagick, poppler, ExifTool, and FFmpeg.

Installing on SuSE

The article provides a guide for installing ResourceSpace on SuSE. It directs users to a guide for setting up a LAMP stack with a virtual host for ResourceSpace. The article then lists the packages required for installation and provides a command for installing them.

Installing on macOS

The article provides a step-by-step guide to install ResourceSpace on macOS. The installation process involves installing Homebrew, programs, and dependencies, PHP extensions using pecl, enabling PHP in Apache, configuring PHP, creating a database, checking out ResourceSpace, and finishing the installation via a web browser.

Configuring php.ini

This article provides guidance on how to configure the php.ini file to handle larger files. The php.ini file location can be found on the PHP Info page in the row "Loaded Configuration File", available by running the function phpinfo() on an empty PHP page.

Upgrading

The article provides instructions for upgrading ResourceSpace, a digital asset management system, using Subversion (SVN). Before upgrading, users should ensure that their system meets the general installation requirements.

Configuring for multi-client use

The article provides a method for setting up ResourceSpace as an environment where multiple users can use the system, but their resources remain private from each other. The method involves creating a new global field called 'client' that can be attached to all types of resources.

Google Vision

The Google Vision API plugin sends images to Google's Cloud Vision API on upload and sets appropriate metadata in pre-configured fields based on what has been recognised in the image. The plugin can be found under the 'Asset processing' category.

Antivirus

The antivirus plugin for ResourceSpace allows the platform to check every file uploaded to see if it is a known virus. The plugin can be configured to work with any antivirus that has a command line interface, and has been tested with ClamAV and Sophos.

Google VR View

Google VR View is a plugin that displays previews of 360-degree images and videos using the Google VR View browser API. The plugin is supported on modern versions of Chrome, Opera, Safari, Firefox, IE 11 and Edge on Windows, macOS, Linux, Android and iOS.

CSV user import

The CSV user import plugin allows administrators to create user accounts in bulk based on information stored in a CSV file. The CSV file must be encoded in UTF-8 format and without BOM, and should have text cells quoted in case they contain commas or other special characters.

Falcon link

The Falcon Link plugin allows users to publish resources as templates in Falcon.io. However, users must have an account with Falcon.io to use this plugin. The plugin creates a share link with no expiration date instead of copying the file itself when a resource is published to Falcon.

Alternative installation

ResourceSpace offers alternative installation options for users who are unfamiliar with installing applications or unable to install ResourceSpace on their server. One-click installers are available for Windows, Linux, and OS X, which are self-contained packages with everything needed to run ResourceSpace.

Image banks

The Image Banks plugin allows users to search external image banks for photos without having to navigate manually to the external system. Users can run searches in the external image bank using the simple search box and the dropdown selector called "Search external image banks".

General installation requirements

ResourceSpace requires a MySQL compliant database, a web server, and PHP to operate on the LAMP stack. The supported versions of PHP are 7.4, 8.0, and 8.1, and the following PHP extensions are required: php-mysqli, php-curl, php-dom, php-gd, php-intl, php-mbstring, php-xml, php-zip, php-ldap, php-imap, php-json, php-apcu, and php-cli.

Emails

ResourceSpace uses emails to notify users of relevant activity such as resource submissions, user account requests, or resource download requests. However, most email notifications have been replaced by system messages, but users can still opt to receive emails by modifying their user preferences.

CSV export

ResourceSpace allows users to extract metadata from its database as a CSV file, which can be opened in most standard spreadsheet or database programs. The metadata fields included in the CSV file can be customised by editing metadata fields and enabling the "Include in CSV export" option.

Upload here

ResourceSpace has introduced a new feature called "Upload here" that helps users create new resources based on a recent advanced search. The feature directs users to the upload page where the options will have been automatically selected, meaning they can easily add more resources that this metadata set describes.

Offline job queues

ResourceSpace has developed an offline jobs function to delegate slow processes, such as creating a preview for a video file, to another script/process to be run asynchronously. The upload process focuses on getting files into the filestore, later working from a queue for further processing.

Resource commenting

Resource commenting can be enabled in ResourceSpace by using the config option $comments_resource_enable. This feature adds a new area below the resource metadata, allowing users to add and respond to comments about the resource.

Google Analytics

ResourceSpace has added support for Google Analytics in its version 10.1, allowing users to track website activity such as session duration, pages visited per session, bounce rate, exit rate, and the source of traffic.

MuseumPlus

MuseumPlus is a web-based museum management system that provides real-time museum management and fully documents any type of collection and all related workflow. The system can be integrated with ResourceSpace, a digital asset management system, through its API.

Contributing to the base code

ResourceSpace welcomes contributions to its base code. The process involves completing a Contributor License Agreement and ensuring familiarity with the Coding Standards. After this, diff patches should be manually submitted via email for review and addition to the base.

Context help links

Context Help links can be added to pages to link to a relevant Knowledge Base page. These links open Knowledge Base in a modal or new page and are enabled by default on a ResourceSpace system but can be disabled by setting $contextual_help_links=false.

Complete Guide to Crafting Effective Brand Guidelines

Discover the importance of brand guidelines to differentiate your business and ensure your products stand out from competitors.

Debugging ResourceSpace

The article provides three methods for debugging ResourceSpace, an open-source digital asset management system. The first method is to use the internal function called debug(), which writes debug text to a file specified in the config file.

Injection

Injection attacks are a type of attack vector that occur when an attacker can send hostile data to an interpreter as part of a command or query, which alters the execution of that program. The most common injection flaws are cross-site scripting (XSS), SQL injections (SQLi), command injections which can lead to remote code execution (RCE) vulnerabilities, and LDAP injections.

Vimeo publish

The Vimeo Publish plugin allows users to publish video resources to a configured Vimeo account. The plugin uploads data and has configurable mapped fields to automatically add descriptions, titles, and tags.

Usage history

ResourceSpace, the open source digital asset management software, is logging every time a user downloads a resource from the system, even one of its available sizes. By default, this is not shown on the view page of a resource, but there are configuration options which can change this behaviour.

put_resource_data

The put_resource_data API endpoint allows users with edit access to update the properties of a resource. The endpoint requires the ID of the resource and an associative array of columns and values in JSON format.

Removing resources from collections

The article provides three methods to remove resources from a collection. The first method involves clicking and dragging the resource to be removed from the collection and dropping it onto the trash icon that appears at the top of the screen.

Fixed list fields

ResourceSpace has various metadata field types, including text boxes, check box lists, dropdown lists, date fields, category trees, and radio button lists. Some of these fields can have their options defined by an administrator of the system, and these fields are called fixed list fields.

Downloading multiple resources

Users can download multiple resources in one go by adding the resources to a collection or selecting a number of resources from the search results page and clicking on 'Download' from the 'Actions' dropdown box.

Wordpress integration

A new WordPress plugin has been developed that allows users to embed resource files from ResourceSpace in their posts. The plugin was funded by ADRA International and developed by Codecide. To install the plugin, users should download the WordPress plugin zip file, navigate to Plugins->Add plugins from the WordPress Admin menu and click 'Upload plugin', or manually upload the zip file to the wp-content/plugins directory of the WordPress installation.

Managing offline jobs

The My Jobs page is a tool used to check the status of jobs, such as collection downloads and preview creation. Administrators can also use this page to check on the status of jobs systemwide. The page displays information about jobs in the queue, including job priority, job reference, job type, user that created the job (admins only), job status, and the earliest job start date.

Sharing upload links

ResourceSpace has introduced a new feature that allows users to share upload links externally. This feature enables external media creators to upload files into ResourceSpace without requiring an account.

RSS Feed

The RSS Feed plugin generates RSS URLs for a resource search in ResourceSpace using the API. After enabling the plugin, a new link appears at the bottom of the Simple Search area, which takes the user to the RSS feed for the 50 most recently uploaded resources.

save_collection

The "save_collection" API binding allows users to save collection data. The API requires a POST request to avoid URL limits being reached. The API requires two variables: "$ref" and "$coldata". "$ref" is the ID of the collection, and "$coldata" is the JSON encoded collection data.

Configuring Leaflet Maps

This article provides a guide to configuring Leaflet maps in ResourceSpace. The article lists several configuration options that can be used to add tile sources and customize how geolocation data is displayed.

Geographic search

The geographic search function allows users to search for resources that have embedded location data. To use the function, users can drag the map and zoom to an area of interest or search for a location using the search button.

Further videos

The article provides a list of videos that cover various topics related to using the ResourceSpace digital asset management system. The videos cover topics such as creating users, customizing the homepage slideshow, search filters, sharing resources, and more.

Image tools

The Image Tools plugin enables users to edit images by rotating, cropping or scaling them. The plugin also allows users to modify the home slideshow image using resources that have previously been uploaded to ResourceSpace.

Image preview zoom

The article discusses the image preview zoom feature in ResourceSpace, a digital asset management system. If the system is configured with zoomable previews, users can enable the OpenSeadragon viewer on the view page by toggling the image preview zoom tool available in the image preview toolbar.

User preferences

The article provides instructions on how to access user preferences on a website. Users can click on the user profile icon at the top right of the screen and select "Preferences" to make changes to the functionality and interface available to them.

Consent manager

Adds the capability to manage resource consents via the resource view page.

The Digital Asset Management Buyer's Guide

In this guide we look at what DAM software actually is, the problems it solves and some questions to ask a vendor before making a buying decision.

Integrating with BrandStencil

Instantly create marketing materials from templates using your DAM images thanks to ResourceSpace's integration with BrandStencil.

Integrating ResourceSpace with RightMarket

Create branded marketing materials, including posters, social graphics or point of sale materials, with ResourceSpace's RightMarket integration.

Upgrading PHP versions

ResourceSpace has updated its PHP requirement to version 7.4 for its version 10.0 to maintain compatibility with the third-party file uploader library (Uppy) and to maintain security. The company has warned that PHP 7.

API Webhooks

API Webhooks is a plugin that allows developers to synchronise data between ResourceSpace and third-party systems. The plugin enables remote scripts to be called from within ResourceSpace, allowing users to drive the timing of the synchronisation between the two systems.

Integrating with Uppy Companion

Uppy Companion is an open-source server application that can be linked to the Uppy uploader used by ResourceSpace. It allows users to select files directly from sources such as Google Drive, Dropbox and OneDrive without having to download the files locally first.

The Beginner's Guide to Managing Consent for Charities & Non-Profits

The article provides a beginner's guide to managing consent for charities and non-profits. It covers different types of consent and how they can be obtained, as well as looking at the intricacies of specific use cases and best practices when consent is in place.

What is Digital Asset Management?

A Digital Asset Management system is critical component of your organisation's tech stack. Explore the benefits of DAM, its use cases, and how it streamlines asset management.

Do you need a Digital Asset Management system? Find out here.

A Digital Asset Management (DAM) system can help organizations overcome various challenges related to managing digital assets. These challenges may include difficulties in finding specific files, using outdated assets, licensing and copyright issues, and sharing large files with external contacts.

upload_multipart

The "upload_multipart" function allows users to upload files using HTTP multipart to an existing resource. This function is available from version 10.2+ of the software. The function requires several variables to be provided, including the ID of the resource, a boolean value to indicate whether to process embedded metadata, a boolean value to indicate whether to re-process the existing file, and the file to be uploaded.

A Comprehensive Guide to Digital Curation: Tools and Techniques

Explore digital curation: key tools and techniques for preserving significant cultural assets.

I'm receiving too many notifications - help!

The article provides instructions on how to control and manage notifications in a system. It explains that notifications can be customized through the personal menu and preferences settings. Users can enable or disable options for receiving notifications via emails, in-system messages, and in-system actions.

The Complete Guide to Metadata

Metadata is data that provides information about other data, without describing the content of that data. It is crucial for digital assets and is used to categorize and describe various types of files, such as documents, videos, and audio files.

Configuring image alternatives

The article discusses configuring image alternatives using the "$image_alternatives" configuration option, similar to video file alternatives. This setting controls the options for ImageMagick utility to create alternative image formats/sizes.

toggle_active_state_for_nodes

The article discusses the function "toggle_active_state_for_nodes," available from version 10.4+ and requiring permission "k." It involves toggling nodes' active state, with a list of node IDs as input.

Managing files with Microsoft SharePoint? You could do more with DAM

Is your organisation still using Microsoft SharePoint for digital asset management? You could do so much more with a dedicated DAM system.

Drupal integration

Selected resources in ResourceSpace can be synchronised automatically with the media library in Drupal 11.

Creating controlled vocabularies in ResourceSpace

Controlled vocabularies in ResourceSpace standardize terminology for improved searchability. They are predefined lists of terms for metadata fields like Dublin Core elements. Benefits include consistency, search accuracy, error reduction, and interoperability.

Joomla integration

The article discusses the integration of ResourceSpace with Joomla 5.x to synchronize selected resources automatically. To set up the integration, users need to create a Joomla user in ResourceSpace with limited access, ensuring that only desired resources are synchronized.

Installing via Docker

The article discusses the process of installing software using Docker, a popular platform for containerization. It explains how Docker simplifies the installation process by packaging applications and their dependencies into containers, ensuring consistency across different environments.

Annotating resources

The article discusses the importance of annotating resources to enhance learning and research. It highlights how annotations can help in better understanding, organizing, and retaining information. The process involves adding notes, comments, and highlights to texts, documents, or other resources.

Whisper

Whisper is an open-source automatic speech recognition (ASR) system by OpenAI that transcribes audio and video files into text using deep learning models, all locally on your server for privacy. It ensures data security, compliance with regulations like GDPR, and can be used offline.

save_user

The article provides a function to save a user record with specific parameters. The function requires the user ID ($ref) and a JSON array ($data) containing information like fullname, password, email, and more.

Integrating with MONA

The integration between ResourceSpace and MONA, CultureTech's rights management software, allows for seamless management of IP licensing and related data. By connecting the two platforms, users can import assets and metadata from ResourceSpace into MONA, automating the licensing process and ensuring data accuracy.

Tesseract OCR

Tesseract OCR is an open-source utility for extracting text from images and scanned documents. It runs locally on servers, ensuring data privacy and compliance with data protection policies. Installation on Ubuntu/Debian involves updating packages and verifying installation.

OpenAPI documentation

The article discusses OpenAPI documentation, specifically focusing on the endpoint /api/openapi.php. OpenAPI is a specification for building APIs, and /api/openapi.php is likely a specific endpoint for accessing OpenAPI documentation.

Table: node_keyword

Table: node_keyword

Table: resource

The article provides a table of the resource, which is the central record within ResourceSpace mapping to a single asset/file. The table includes various columns such as ref, title, resource_type, has_image, is_transcoding, hit_count, new_hit_count, creation_date, rating, user_rating, user_rating_count, user_rating_total, country, file_extension, preview_extension, image_red, image_green, image_blue, thumb_width, thumb_height, archive, access, colour_key, created_by, file_path, file_modified, file_checksum, request_count, expiry_notification_sent, preview_tweaks, geo_lat, geo_long, mapzoom, disk_usage, disk_usage_last_updated, file_size, preview_attempts, modified, last_verified, integrity_fail, and lock_user.

Table: resource_type_field

Table: resource_type_field

Cross-Site Request Forgery (CSRF)

Cross-Site Request Forgery (CSRF) is an attack that forces an authenticated user to execute unwanted actions on a web application. The attack targets state-changing requests, not data theft, as the attacker has no way to see the response to the forged request.

Custom fields ("user" defined)

ResourceSpace, a digital asset management system, allows users to configure custom fields. These fields can be used to add additional metadata to assets, such as images or documents, and can be used to filter and search for specific assets.

create_collection()

Developer reference for function create_collection()

search_public_collections()

Developer reference for function search_public_collections()

save_collection()

Developer reference for function save_collection()

email_collection()

Developer reference for function email_collection()

send_collection_feedback()

Developer reference for function send_collection_feedback()

show_hide_collection()

Developer reference for function show_hide_collection()

comments_submit()

Developer reference for function comments_submit()

comments_show()

Developer reference for function comments_show()

config_file_input()

Developer reference for function config_file_input()

config_single_select()

Developer reference for function config_single_select()

config_boolean_select()

Developer reference for function config_boolean_select()

config_checkbox_select()

Developer reference for function config_checkbox_select()

generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

debug_function_call()

Developer reference for function debug_function_call()

message_send_unread_emails()

Developer reference for function message_send_unread_emails()

check_view_display_condition()

Developer reference for function check_view_display_condition()

mix_text()

Developer reference for function mix_text()

edit_filter_to_restype_permission()

Developer reference for function edit_filter_to_restype_permission()

add_node_keyword()

Developer reference for function add_node_keyword()

delete_resource_nodes()

Developer reference for function delete_resource_nodes()

config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

render_search_field()

Developer reference for function render_search_field()

render_actions()

Developer reference for function render_actions()

display_field()

Developer reference for function display_field()

render_date_range_field()

Developer reference for function render_date_range_field()

check_display_condition()

Developer reference for function check_display_condition()

display_field_data()

Developer reference for function display_field_data()

render_resource_lock_link()

Developer reference for function render_resource_lock_link()

do_report()

Developer reference for function do_report()

email_collection_request()

Developer reference for function email_collection_request()

managed_collection_request()

Developer reference for function managed_collection_request()

email_resource_request()

Developer reference for function email_resource_request()

process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

send_research_request()

Developer reference for function send_research_request()

put_resource_data()

Developer reference for function put_resource_data()

save_resource_data()

Developer reference for function save_resource_data()

save_resource_data_multi()

Developer reference for function save_resource_data_multi()

add_keyword_to_resource()

Developer reference for function add_keyword_to_resource()

update_field()

Developer reference for function update_field()

email_resource()

Developer reference for function email_resource()

clear_resource_data()

Developer reference for function clear_resource_data()

write_metadata()

Developer reference for function write_metadata()

save_field_options()

Developer reference for function save_field_options()

autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

reindex_resource()

Developer reference for function reindex_resource()

copyAllDataToResource()

Developer reference for function copyAllDataToResource()

copy_locked_fields()

Developer reference for function copy_locked_fields()

replace_resource_file()

Developer reference for function replace_resource_file()

delete_resource_type_field()

Developer reference for function delete_resource_type_field()

search_form_to_search_query()

Developer reference for function search_form_to_search_query()

refine_searchstring()

Developer reference for function refine_searchstring()

search_filter()

Developer reference for function search_filter()

search_special()

Developer reference for function search_special()

split_keywords()

Developer reference for function split_keywords()

save_related_keywords()

Developer reference for function save_related_keywords()

update_search_from_request()

Developer reference for function update_search_from_request()

create_upload_link()

Description Creates an upload link for a collection that can be shared 'usergroup' Usergroup id to share as (must be in $upload_link_usergroups array) 'expires' Expiration date in 'YYYY-MM-DD' format 'password' Optional password for share access 'emails' Optional array of email addresses to generate keys for Parameters Column Type Default Description $collection int Collection ID $shareoptions array - values to set Return string Share access key Location include/collections_functions.

render_share_password_question()

Description Renders a question field for setting a share password. This function generates an HTML input field where users can set or change the password for shared access to a resource.

header_add_map_providers()

Description Adds map providers for Leaflet maps. This function generates a JavaScript snippet that defines various tile layer providers for use in Leaflet maps. It supports OpenStreetMap and ESRI basemaps, as well as custom providers defined in the global variable `$geo_leaflet_sources`.

send_user_message()

Description Send a user to user(s) message Parameters Column Type Default Description $users array Array of user IDs or usernames/groupnames from user select $text string Message text Return bool|string True if sent ok or error message Location include/message_functions.

send_collection_to_admin()

Description Send collection to administrators - used if $send_collection_to_admin is enabled Parameters Column Type Default Description $collection int Collection ID Return boolean Location include/collections_functions.

collection_add_resources()

Description Add resource(s) $resources to collection $collection Parameters Column Type Default Description $collection mixed $resources mixed '' $search '' $selected false Return boolean | string Location include/collections_functions.

collection_remove_resources()

Description collection_remove_resources Parameters Column Type Default Description $collection mixed $resources mixed '' $removeall mixed false $selected false Return boolean | string Location include/collections_functions.

render_fa_icon_selector()

render_fa_icon_selector()

add_sql_node_language()

add_sql_node_language()

save_resource_type_field()

Description Save resource type field - used on pages/admin/admin_resource_type_field_edit.php Parameters Column Type Default Description $ref int Field ID $columns array Array of column data bool { $postdata: $migrate_data $onload_message $lang true; []; foreach $resource_types as $resource_type true false $postdata mixed POST'd data Return bool * Location include/config_functions.

admin_resource_type_field_option()

Parameters Column Type Default Description $propertyname string $propertytitle string $helptext string $type $currentvalue $fieldtype int $system_date_field bool $resource_type_array; $lang $baseurl_short $FIXED_LIST_FIELD_TYPES $daterange_edtf_support $allfields $newfield $resource_type_array $existingrestypes $regexp_slash_replace Location include/render_functions.

actions_filter_by_user()

Description Filter actions in the provided array to return only those applicable to the given user Parameters Column Type Default Description $actionuser int User ref to get actions for $actions: array $actions_approve_hide_groups; $usergroup $actions_resource_requests $actions_account_requests $actions array Array of actions as returned by get_user_actions_recent() Return array Subset of actions for the given user as would be provided by get_user_actions() Location include/action_functions.

render_pie_graph()

Description Output the Javascript to build a pie chart in the canvas denoted by $id $data must be in the following format $data = array( "slice_a label" => "slice_a value", "slice_b label" => "slice_b value", ); a string can be used to denote the total value to pad the data to Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart $total string|null null null will mean that the data is complete and an extra field is not required Return void Location include/reporting_functions.

render_resource_view_image()

Description Render image on view.php "access" - Resource access "edit_access" - Resource edit access Parameters Column Type Default Description $resource array Resource data $context array Array with following named elements Return void * Location include/render_functions.

set_search_order_by()

Description Validate and set the order_by for the current search from the requested values passed to do_search() Parameters Column Type Default Description $search string $order_by string $sort: string $sort string Return string * Location include/search_functions.

i18n_merge_translations()

Description Merge values for across multiple translation strings. Where a value is missing for a language used elsewhere i18n_get_translated will be used. If no value is provided and no English (en) string is found then blank will be returned.

validate_resource_files()

Description Validate the files on disk that are associated with the given resources array of resource data e.g, from search results required return values in order to pass the check e.

register_group_access_plugins()

Description Load group specific plugins and reorder plugins list Parameters Column Type Default Description $usergroup int -1 Usergroup reference $plugins array Enabled Plugins enabled_groups config config_json FROM disable_group_select 0 ORDER BY priority" array "plugins"; Return array Location include/plugin_functions.

RenderPlugin()

Description Render the plugin in the Plugin Manager with options to activate and configure. Parameters Column Type Default Description $plugin array An array containing the plugin data, loaded from the plugin table $active boolean true If true, display options to deactivate and allow group configuration Return void Location include/plugin_functions.

config_filter_by_search()

Description Process values from config search fields, see render_config_filter_by_search() Filter $page_def elements to show only those searched for. array() - empty array for system config array('user' => 1) - key 'user' and int representing user ref to check user preferences array('usergroup' => 2) - key 'usergroup' and int representing usergroup ref to check user group preferences Parameters Column Type Default Description $page_def array Array containing page definition, from functions config_add_ .

AI Faces (InsightFace)

The AI Faces plugin allows ResourceSpace to automatically detect and recognise people featured in images. This allows for quick and efficient automated tagging on upload.

render_lucide_icon_selector()

Description Renders a Lucide icon selector question Requires lib/lucide/icon_classes.php to be included in the page using the function Parameters Column Type Default Description $label string "" $name string "icon" Input name $current string "" Current value Return void Location include/render_functions.

OpenCV (facial recognition) - deprecated

OpenCV is a library used by ResourceSpace for facial recognition capability. The article provides instructions on how to install OpenCV on Ubuntu and how to check the Python and OpenCV versions. The facial recognition feature in ResourceSpace can be configured by setting the path to Python, the field used to store the name of the person suggested/detected, the location for the face recognizer model state(s) and data, and enabling facial recognition.

Configuring Cross-Site Request Forgery (CSRF)

The article explains how to configure Cross-Site Request Forgery (CSRF) and Cross-Origin Resource Sharing (CORS) to protect web applications from attacks. CSRF is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated.

YT2RS (Youtube embed)

The Youtube to ResourceSpace plugin allows users to embed a YouTube video into the Resource view page. Users can enter the ID of a metadata field that stores the URL of the Youtube video on the options page for the plugin.

VM2RS (Vimeo embed)

The VM2RS plugin is a Vimeo to ResourceSpace plugin that allows users to embed Vimeo videos on the Resource view page. Users can enter the ID of a metadata field that stores the URL of the Vimeo video on the options page for the plugin.

ResourceSpace file storage (filestore)

ResourceSpace stores resource files in obfuscated folder paths on the server and not in the database. The folders are not meaningful to an administrator browsing the folders on the server because they are derived from the unique resource ID and are not related in any way to metadata or collections that the resources belong to.

ajax_send_response()

Developer reference for function ajax_send_response()

ajax_send_text_response()

Developer reference for function ajax_send_text_response()

ajax_response_ok()

Developer reference for function ajax_response_ok()

annotationEditable()

Developer reference for function annotationEditable()

deleteAnnotation()

Developer reference for function deleteAnnotation()

updateAnnotation()

Developer reference for function updateAnnotation()

addAnnotationNodes()

Developer reference for function addAnnotationNodes()

prepareTags()

Developer reference for function prepareTags()

check_api_key()

Developer reference for function check_api_key()

execute_api_call()

Developer reference for function execute_api_call()

add_resource_to_collection()

Developer reference for function add_resource_to_collection()

collection_writeable()

Developer reference for function collection_writeable()

collection_readable()

Developer reference for function collection_readable()

delete_collection()

Developer reference for function delete_collection()

refresh_collection_frame()

Developer reference for function refresh_collection_frame()

do_collections_search()

Developer reference for function do_collections_search()

index_collection()

Developer reference for function index_collection()

themes_comparator()

Developer reference for function themes_comparator()

collections_comparator()

Developer reference for function collections_comparator()

collections_comparator_desc()

Developer reference for function collections_comparator_desc()

generate_collection_access_key()

Developer reference for function generate_collection_access_key()

add_saved_search()

Developer reference for function add_saved_search()

add_smart_collection()

Developer reference for function add_smart_collection()

add_saved_search_items()

Developer reference for function add_saved_search_items()

allow_multi_edit()

Developer reference for function allow_multi_edit()

swap_collection_order()

Developer reference for function swap_collection_order()

update_collection_order()

Developer reference for function update_collection_order()

save_collection_resource_comment()

Developer reference for function save_collection_resource_comment()

relate_to_collection()

Developer reference for function relate_to_collection()

copy_collection()

Developer reference for function copy_collection()

delete_collection_access_key()

Developer reference for function delete_collection_access_key()

collection_max_access()

Developer reference for function collection_max_access()

collection_min_access()

Developer reference for function collection_min_access()

collection_set_themes()

Developer reference for function collection_set_themes()

edit_collection_external_access()

Developer reference for function edit_collection_external_access()

compile_collection_actions()

Developer reference for function compile_collection_actions()

collection_download_use_original_filenames_when_downloading()

Developer reference for function collection_download_use_original_filenames_when_downloading()

collection_download_process_text_file()

Developer reference for function collection_download_process_text_file()

collection_download_process_data_only_types()

Developer reference for function collection_download_process_data_only_types()

collection_download_process_summary_notes()

Developer reference for function collection_download_process_summary_notes()

collection_download_process_csv_metadata_file()

Developer reference for function collection_download_process_csv_metadata_file()

collection_download_process_command_to_file()

Developer reference for function collection_download_process_command_to_file()

collection_download_process_collection_download_name()

Developer reference for function collection_download_process_collection_download_name()

collection_download_process_archive_command()

Developer reference for function collection_download_process_archive_command()

collection_cleanup_inaccessible_resources()

Developer reference for function collection_cleanup_inaccessible_resources()

relate_all_collection()

Developer reference for function relate_all_collection()

update_collection_type()

Developer reference for function update_collection_type()

validate_field()

Developer reference for function validate_field()

set_config_option()

Developer reference for function set_config_option()

process_config_options()

Developer reference for function process_config_options()

config_text_input()

Developer reference for function config_text_input()

config_add_single_ftype_select()

Developer reference for function config_add_single_ftype_select()

config_single_ftype_select()

Developer reference for function config_single_ftype_select()

config_generate_AutoSaveConfigOption_function()

Developer reference for function config_generate_AutoSaveConfigOption_function()

config_process_file_input()

Developer reference for function config_process_file_input()

generateNodesExport()

Developer reference for function generateNodesExport()

update_dash_tile()

Developer reference for function update_dash_tile()

delete_user_dash_tile()

Developer reference for function delete_user_dash_tile()

build_dash_tile_list()

Developer reference for function build_dash_tile_list()

render_upgrade_available_tile()

Developer reference for function render_upgrade_available_tile()

generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

db_begin_transaction()

Developer reference for function db_begin_transaction()

check_debug_log_override()

Developer reference for function check_debug_log_override()

rsEncrypt()

Developer reference for function rsEncrypt()

rsDecrypt()

Developer reference for function rsDecrypt()

prepareFaceImage()

Developer reference for function prepareFaceImage()

faceRecognizerPredict()

Developer reference for function faceRecognizerPredict()

send_statistics()

Developer reference for function send_statistics()

escape_command_args()

Developer reference for function escape_command_args()

run_command()

Developer reference for function run_command()

generateURL()

Developer reference for function generateURL()

job_queue_add()

Developer reference for function job_queue_add()

job_queue_update()

Developer reference for function job_queue_update()

job_queue_delete()

Developer reference for function job_queue_delete()

job_queue_run_job()

Developer reference for function job_queue_run_job()

bypass_permissions()

Developer reference for function bypass_permissions()

str_replace_formatted_placeholder()

Developer reference for function str_replace_formatted_placeholder()

setLanguage()

Developer reference for function setLanguage()

perform_login()

Developer reference for function perform_login()

set_login_cookies()

Developer reference for function set_login_cookies()

message_add()

Developer reference for function message_add()

message_seen_all()

Developer reference for function message_seen_all()

system_notification()

Developer reference for function system_notification()

runFitsForFile()

Developer reference for function runFitsForFile()

extractFitsMetadata()

Developer reference for function extractFitsMetadata()

check_date_parts()

Developer reference for function check_date_parts()

migrate_resource_type_field_check()

Developer reference for function migrate_resource_type_field_check()

populate_resource_nodes()

Developer reference for function populate_resource_nodes()

migrate_filter()

Developer reference for function migrate_filter()

set_node()

Developer reference for function set_node()

delete_node()

Developer reference for function delete_node()

reorder_nodes()

Developer reference for function reorder_nodes()

draw_tree_node_table()

Developer reference for function draw_tree_node_table()

node_field_options_override()

Developer reference for function node_field_options_override()

check_node_indexed()

Developer reference for function check_node_indexed()

add_node_keyword_mappings()

Developer reference for function add_node_keyword_mappings()

remove_node_keyword_mappings()

Developer reference for function remove_node_keyword_mappings()

add_resource_nodes()

Developer reference for function add_resource_nodes()

add_resource_nodes_multi()

Developer reference for function add_resource_nodes_multi()

copy_resource_type_field_nodes()

Developer reference for function copy_resource_type_field_nodes()

extract_node_options()

Developer reference for function extract_node_options()

generate_pdf()

Developer reference for function generate_pdf()

process_template()

Developer reference for function process_template()

resolve_pdf_language()

Developer reference for function resolve_pdf_language()

activate_plugin()

Developer reference for function activate_plugin()

set_plugin_config()

Developer reference for function set_plugin_config()

handle_rsc_upload()

Developer reference for function handle_rsc_upload()

display_rsc_upload()

Developer reference for function display_rsc_upload()

config_gen_setup_post()

Developer reference for function config_gen_setup_post()

config_gen_setup_html()

Developer reference for function config_gen_setup_html()

config_single_user_select()

Developer reference for function config_single_user_select()

config_multi_user_select()

Developer reference for function config_multi_user_select()

config_single_group_select()

Developer reference for function config_single_group_select()

config_multi_group_select()

Developer reference for function config_multi_group_select()

config_single_rtype_select()

Developer reference for function config_single_rtype_select()

config_multi_rtype_select()

Developer reference for function config_multi_rtype_select()

config_db_multi_select()

Developer reference for function config_db_multi_select()

plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

include_plugin_config()

Developer reference for function include_plugin_config()

register_plugin_language()

Developer reference for function register_plugin_language()

register_plugin()

Developer reference for function register_plugin()

render_sort_order()

Developer reference for function render_sort_order()

render_user_group_multi_select()

Developer reference for function render_user_group_multi_select()

render_user_group_select()

Developer reference for function render_user_group_select()

render_user_group_checkbox_select()

Developer reference for function render_user_group_checkbox_select()

render_access_key_tr()

Developer reference for function render_access_key_tr()

display_multilingual_text_field()

Developer reference for function display_multilingual_text_field()

renderBreadcrumbs()

Developer reference for function renderBreadcrumbs()

renderSocialMediaShareLinksForUrl()

Developer reference for function renderSocialMediaShareLinksForUrl()

render_resource_image()

Developer reference for function render_resource_image()

calculate_image_display()

Developer reference for function calculate_image_display()

render_share_options()

Developer reference for function render_share_options()

render_field_selector_question()

Developer reference for function render_field_selector_question()

render_upload_here_button()

Developer reference for function render_upload_here_button()

render_help_link()

Developer reference for function render_help_link()

render_custom_fields()

Developer reference for function render_custom_fields()

render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

render_user_collection_select()

Developer reference for function render_user_collection_select()

create_periodic_email()

Developer reference for function create_periodic_email()

send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

save_request()

Developer reference for function save_request()

gen_custom_fields_html_props()

Developer reference for function gen_custom_fields_html_props()

save_research_request()

Developer reference for function save_research_request()

create_resource()

Developer reference for function create_resource()

append_field_value()

Developer reference for function append_field_value()

delete_resource()

Developer reference for function delete_resource()

copy_resource()

Developer reference for function copy_resource()

save_resource_custom_access()

Developer reference for function save_resource_custom_access()

update_resource_type()

Developer reference for function update_resource_type()

relate_to_array()

Developer reference for function relate_to_array()

createTempFile()

Developer reference for function createTempFile()

stripMetadata()

Developer reference for function stripMetadata()

delete_exif_tmpfile()

Developer reference for function delete_exif_tmpfile()

update_resource()

Developer reference for function update_resource()

add_alternative_file()

Developer reference for function add_alternative_file()

delete_alternative_file()

Developer reference for function delete_alternative_file()

user_rating_save()

Developer reference for function user_rating_save()

process_notify_user_contributed_submitted()

Developer reference for function process_notify_user_contributed_submitted()

notify_user_contributed_submitted()

Developer reference for function notify_user_contributed_submitted()

notify_user_contributed_unsubmitted()

Developer reference for function notify_user_contributed_unsubmitted()

resource_download_allowed()

Developer reference for function resource_download_allowed()

filter_match()

Developer reference for function filter_match()

log_diff()

Developer reference for function log_diff()

check_use_watermark()

Developer reference for function check_use_watermark()

update_disk_usage()

Developer reference for function update_disk_usage()

update_disk_usage_cron()

Developer reference for function update_disk_usage_cron()

overquota()

Developer reference for function overquota()

notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

generate_resource_access_key()

Developer reference for function generate_resource_access_key()

resource_type_config_override()

Developer reference for function resource_type_config_override()

update_archive_status()

Developer reference for function update_archive_status()

update_related_resource()

Developer reference for function update_related_resource()

can_share_resource()

Developer reference for function can_share_resource()

copy_locked_data()

Developer reference for function copy_locked_data()

process_edit_form()

Developer reference for function process_edit_form()

save_original_file_as_alternative()

Developer reference for function save_original_file_as_alternative()

sanitize_date_field_input()

Developer reference for function sanitize_date_field_input()

download_link_generate_key()

Developer reference for function download_link_generate_key()

filter_check()

Developer reference for function filter_check()

update_resource_keyword_hitcount()

Developer reference for function update_resource_keyword_hitcount()

add_verbatim_keywords()

Developer reference for function add_verbatim_keywords()

alt_is_ffmpeg_alternative()

Developer reference for function alt_is_ffmpeg_alternative()

tab_names()

Developer reference for function tab_names()

update_resource_lock()

Developer reference for function update_resource_lock()

compile_search_actions()

Developer reference for function compile_search_actions()

rebuild_specific_field_search_from_node()

Developer reference for function rebuild_specific_field_search_from_node()

cleanse_string()

Developer reference for function cleanse_string()

resolve_keyword()

Developer reference for function resolve_keyword()

highlightkeywords()

Developer reference for function highlightkeywords()

str_highlight()

Developer reference for function str_highlight()

delete_slideshow()

Developer reference for function delete_slideshow()

validate_user()

Developer reference for function validate_user()

save_themename()

Developer reference for function save_themename()

check_order_by_in_table_joins()

Developer reference for function check_order_by_in_table_joins()

show_upgrade_in_progress()

Developer reference for function show_upgrade_in_progress()

render_audio_download_link()

Developer reference for function render_audio_download_link()

job_queue_purge()

Developer reference for function job_queue_purge()

render_table()

Developer reference for function render_table()

generate_featured_collection_image_urls()

Developer reference for function generate_featured_collection_image_urls()

featured_collection_check_access_control()

Developer reference for function featured_collection_check_access_control()

is_featured_collection_category()

Developer reference for function is_featured_collection_category()

validate_collection_parent()

Developer reference for function validate_collection_parent()

process_posted_featured_collection_categories()

Developer reference for function process_posted_featured_collection_categories()

allow_collection_share()

Developer reference for function allow_collection_share()

allow_featured_collection_share()

Developer reference for function allow_featured_collection_share()

filter_featured_collections_by_root()

Developer reference for function filter_featured_collections_by_root()

render_featured_collection_category_selector()

Developer reference for function render_featured_collection_category_selector()

render_featured_collections()

Developer reference for function render_featured_collections()

render_featured_collection()

Developer reference for function render_featured_collection()

DrawOption()

Developer reference for function DrawOption()

render_featured_collections_category_permissions()

Developer reference for function render_featured_collections_category_permissions()

compute_node_branch_path()

Developer reference for function compute_node_branch_path()

cleanup_anonymous_collections()

Description Remove all old anonymous collections Parameters Column Type Default Description $limit int 100 Maximum number of collections to delete - if run from browser this is kept low to avoid delays Return void Location include/collections_functions.

update_fieldx()

Description updates the value of fieldx field further to a metadata field value update Parameters Column Type Default Description $metadata_field_ref: int get_resource_table_joins $metadata_field_ref integer - metadata field ref Location include/metadata_functions.

process_node_search_syntax_to_names()

Description Process one of the columns whose value is a search string containing nodes (e.g @@228@229, @@555) and mutate input array by adding a new column (named $column + '_node_name') which will hold the nodes found in the search string and their translated names Parameters Column Type Default Description $R array Generic type for array (e.

api_login()

Description API login function Parameters Column Type Default Description $username string Username $password string Password to validate Return string|false FALSE if invalid, session API key if valid Location include/api_functions.

comments_notify_tagged()

Description Notify anyone tagged when a new comment is posted Parameters Column Type Default Description $comment string The comment body $from_user integer Who posted the comment $resource integer null If commenting on a resource, the resource ID $collection integer null If commenting on a collection, the collection ID Return void Location include/comment_functions.

Frequently Asked Questions (FAQs)

The most frequently asked questions about ResourceSpace, the free and open source Digital Asset Management system.

can_share_upload_link()

Description Check if user is permitted to create an external upload link for the given collection Parameters Column Type Default Description $collection_data array Array of collection data Return boolean Location include/collections_functions.

can_edit_upload_share()

Description Check if user can edit an existing upload share Parameters Column Type Default Description $collection int Collection ID of share $uploadkey string External upload key Return bool Location include/collections_functions.

generate_share_key()

Description Generates an external share key based on provided string Parameters Column Type Default Description $string string Return string Generated key Location include/collections_functions.

upload_share_active()

Description Check if an external upload link is being used Parameters This function accepts no parameters. Return mixed false|int ID of upload collection, or false if not active Location include/collections_functions.

upload_share_setup()

Description Set up external upload share "collection" - (int) collection ID "user" - (int) user ID of share creator "usergroup" - (int) usergroup ID used for share Parameters Column Type Default Description $key string access key $shareopts array array Array of share options Return void Location include/collections_functions.

external_upload_notify()

Description Notify the creator of an external upload share that resources have been uploaded Parameters Column Type Default Description $collection int Ref of external shared collection $k string External upload access key $tempcollection int Ref of temporay upload collection Return void Location include/collections_functions.

leaflet_markers_legend()

Description Creates a map color markers legend for Leaflet maps. This function generates HTML for a legend that displays markers with colors corresponding to resource types or custom metadata field values.

set_geo_map_centerview()

Description Set bounds for default map view (geo_search.php and geo_edit.php) Parameters This function accepts no parameters. Return void Location include/map_functions.

is_tracking_vars_active()

Description Check if ResourceSpace is still tracking variables for debug purposes. Parameters Column Type Default Description $user int User ID for which we check if tracking vars is active Return boolean Location include/debug_functions.

debug_track_vars()

Description Debug log tracked variables (as configured in System > System console). IMPORTANT: the debug log will contain the JSON encoded version of the tracked variable. For further analysis, just copy the value (ie.

render_radio_buttons_question()

Description render_radio_buttons_question - Used to display a question with radio buttons Parameters Column Type Default Description $label string Label of question $inputname string Name of input field $options array array Array of options (value and text pairs) (eg.

rs_password_hash()

Description ResourceSpace password hashing Parameters Column Type Default Description $password string Password Return string|false Password hash or false on failure Location include/login_functions.

rs_password_verify()

Description ResourceSpace verify password value is the actual value for that variable. Parameters Column Type Default Description $password string Password $hash string Password hash $data array Extra data required for matching hash expectations (e.

render_message()

Parameters Column Type Default Description $message "" Location include/render_functions.

can_delete_collection()

Description Check if user has the appropriate access to delete a collection. Parameters Column Type Default Description $collection_data array Array of collection details, typically from get_collection() $userref int Id of user $k int "" External access key value Return boolean Returns true is the collection can be deleted or false if it cannot.

render_antispam_question()

Description Render the antispam Question form section Parameters This function accepts no parameters. Location include/render_functions.php lines 6077 to 6135 Definition function render_antispam_question () { global $scramble_key , $lang ; $rndword = array_merge ( range ( '0' , '9' ), range ( 'A' , 'Z' )); shuffle ( $rndword ); $timestamp = time (); $rndwordarray = array_slice ( $rndword , 0 , 6 ); $rndcode = hash ( "SHA256" , implode ( "" , $rndwordarray ) .

search_title_node_processing()

Description Convert node searches into a friendly syntax. Used by search_title_processing.php Parameters Column Type Default Description $string string Search string Return string Location include/search_functions.

exiftool_resolution_calc()

Description Extract and store dimensions, resolution, and unit (if available) from exif data Exiftool output format (tab delimited): widthxheight resolution unit (e.g., 1440x1080 300 inches) Parameters Column Type Default Description $file_path string Path to the original file.

tltype_srch_generate_js_for_background_and_count()

Description Generate client side logic for doing expensive computation async for retrieving the tile background and total results count. Parameters Column Type Default Description $tile array Tile information {@see pages/ajax/dash_tile.

ps_query()

Description Execute a prepared statement and return the results as an array. Parameters Column Type Default Description $sql string The SQL to execute $parameters array array An array of parameters used in the SQL in the order: type, value, type, value.

temp_local_download_remote_file()

Description Download remote file to the temp filestore location. Parameters Column Type Default Description $url string Source URL $key string "" Optional key to use - to prevent conflicts when simultaneous calls use same file name Return string|bool Returns the new temp filestore location or false otherwise.

display_video_subtitles()

Description Generate HTML to display subtitles in playback of a video resource. Parameters Column Type Default Description $ref int Resource ID $access int Resource access level - e.

allow_in_browser()

Description Check if file can be rendered in browser via download.php Parameters Column Type Default Description bool { $path: $path string Path to file Location include/resource_functions.

resign_all_code()

Description Returns a signature for a given block of code. Parameters Column Type Default Description $confirm bool true Require user to approve code changes when resigning from the server side.

send_user_notification()

Description Send system notifications to specified users, checking the user preferences first if specified This will contain two arrays:- "emails" array of emails sent, with the following elements:- "email" => Email address "subject" => Email subject "body" => Body text "messages" Array of system messages sent with the following elements :- "user" => User ID "message" => message text "url" => url Parameters Column Type Default Description $users array Array of user IDs or array of user details from get_users() $notifymessage ResourceSpaceUserNotification An instance of a ResourceSpaceUserNotification object holding message properties $forcemail bool false Force system to send email instead of notification? Return array Array containing resulting messages - can be used for testing when emails are not being sent Location include/message_functions.

check_delete_nodes()

The check_delete_nodes() function is used to check an array of node IDs and delete any that relate to non-fixed list fields and are unused. The function takes an array of node IDs as a parameter and checks each node to see if it is related to a non-fixed list field.

can_use_owner_field()

The can_use_owner_field() function is used for initialization and system checks to ensure that the configuration is correctly enabled to use the owner field and mappings logic. The function accepts no parameters and returns a boolean value.

override_rs_variables_by_eval()

The `override_rs_variables_by_eval()` function is a PHP code that runs on an array of variables, which is used for modifying `$GLOBALS`. The function takes two parameters: `$variables`, which is an array of variables to apply the override on, and `$code`, which is a signed string containing the PHP code to run.

update_smart_collection()

update_smart_collection()

data_joins_field_value_translate_and_csv()

The function `data_joins_field_value_translate_and_csv()` is used to convert `$data_joins` value to a user-friendly version. The text value is split by the configured separator and all parts are translated.

can_edit_tile()

The can_edit_tile() function checks whether the current user can edit a dashboard tile. If the tile is only visible to the user, the function checks whether the user is the owner of the tile. If the tile is visible to all users, the function checks whether the user has dashboard admin permissions.

order_tree_nodes()

order_tree_nodes()

process_resource_data_joins_values()

The function "process_resource_data_joins_values()" is used to process resource data_joins array and update the values in the returned resource. The function takes two parameters, the first being the resource table record, and the second being the list of refs for the resource table data_joins.

check_upload_terms()

The check_upload_terms() function is used to verify if the terms have been accepted for a given upload. The terms only need to be accepted when uploading through an upload share link, and if so, the accepted terms are stored in $_COOKIE["acceptedterms"].

display_related_resources()

Description Render all related resources on view page Parameters Column Type Default Description $context array Array with all required info from the view page Return void * Location include/render_functions.

migrate_fixed_to_text()

Description Migrate fixed list field data to text field data for a given resource reference. Useful when changing resource type field from a data type that can contain multiple values such as a dynamic keywords field.

update_resource_type_field_resource_types()

Description Update the resource_type_field - resource_type mappings Parameters Column Type Default Description $ref int Resource type field ref $resource_types array Array of resource type refs Return void * Location include/config_functions.

save_resource_type()

Description Save updated resource_type data Parameters Column Type Default Description $ref int Ref of resource type $savedata array Array of column values Return bool * Location include/config_functions.

cleanup_invalid_nodes()

Description Remove invalid field data from resources, optionally just for the specified resource types and/or fields Parameters Column Type Default Description $fields array [] $restypes array [] $dryrun bool false Don't delete, just return count of rows that will be affected $fields=[] array Array of resource_type_field refs $restypes=[] array Array of resource_type refs Return int Count of rows deleted/to delete Location include/node_functions.

render_resource_type_selector_question()

Parameters Column Type Default Description $label string $name string $class string "stdwidth" $hidden bool false $current true false true; Location include/render_functions.

is_valid_upload_path()

Description Confirm upload path is one of valid paths. Parameters Column Type Default Description $file_path string Upload path.

resource_random_jpg()

Description Generates a random JPEG image for a given resource with random background color and text. This function creates an image of specified dimensions with a random background color and text indicating the resource reference.

assert_post_request()

Description Assert API request is using POST method. Parameters Column Type Default Description $force: bool $force bool Force the assertion Return array Returns JSend data back {@see ajax_functions.

apply_resource_default()

Description 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.

delete_config_option()

Description Delete entry from the user_preferences table completely (instead of setting to blank via set_config_option). Used by system preferences page when deleting a file to allow fallback to value (if set) in config.

generate_temp_download_key()

Description Generate a temporary download key for user. Used to enable temporary resource access to a file via download.php so that API can access resources after calling get_resource_path() Parameters Column Type Default Description $user int User ID $resource int Resource ID $size: string array'col' 'thm' && 'pre' $size string Download size to access.

render_bar_graph()

Description Output the Javascript to build a bar chart in the canvas denoted by $id $data must be in the following format $data = array( "point_a x value" => "point_a y value", "point_b x value" => "point_b y value", Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart Return void Location include/reporting_functions.

create_random_image()

Description Generate a random image which can be used during testing (e.g to upload, or create previews for) - text -> Image content text - filename (default: random) - width (default: 150) - height (default: 50) - bg[red|green|blue] -> Background colour (RGB), e.

create_random_video()

Description Generate a random video which can be used during testing (e.g to upload, or create previews for) - duration (default: 5 seconds) - width (default: 300) - height (default: 300) - filename (default: random) - extension (default: mp4) - text -> Video content text (optional) Parameters Column Type Default Description $info: array $info array Set video parameters: Return array Returns an "error" key if something went wrong, otherwise provides some useful info (e.

skip_scr_size_preview()

Description Determine if the scr size should be used for previews. When $resource_view_use_pre is true the scr size shouldn't be used. Where access is restricted and restricted access users can't access the scr size, the scr size shouldn't be used.

add_download_column()

Description Render the Download info for the resource tool (on view page) Parameters Column Type Default Description $ref int Resource ref $size_info array Preview size information $downloadthissize bool Should the size be downloadable or requested? $view_in_browser bool false Allow the size to be viewed directly in the browser Location include/render_functions.

related_resource_pull()

Description Get a related resource to pull images from Parameters Column Type Default Description $resource array Array of resource data from do_search() Return array|bool $resdata Array of alternative resource data to use, or false if not configured or no resource image found Location include/resource_functions.

toggle_active_state_for_nodes()

Description Toggle nodes' active state Parameters Column Type Default Description $refs: array 'ref' 'asc' '' [FIELD_TYPE_CATEGORY_TREE] 'ref'; $refs list Node IDs Return array<int, 0|1> Location include/node_functions.

toggle_category_tree_nodes_active_state()

Description Toggle category tree nodes' active state Parameters Column Type Default Description $rtf int Resource type field ID $node_refs: array null array_flip$node_refs; $node_refs list Return array<int, 0|1> Location include/node_functions.

send_integrity_failure_notices()

Description Send notifications about file integrity failures Parameters Column Type Default Description $failures: array get_sysvar'last_integrity_check_notify' '1970-01-01'; $failures array Array of resources that have failed integrity check Location include/message_functions.

check_resources()

Description Check integrity of primary resource files then file checksums will be checked Parameters Column Type Default Description $resources array [] Array of resource data e.

reorder_all_featured_collections_with_parent()

Description Re-order all featured collections at a particular tree depth. Parameters Column Type Default Description $parent: ?int ['i' $sql_where_parent->parameters c.

validate_temp_path()

Description Block path traversal by ensuring download is only possible from the temp folder. Generates path to temp folder and checks it matches the supplied path. Parameters Column Type Default Description $test_path string Potentially unsafe path to check.

is_valid_rs_path()

Description Check if a given file path is from a valid RS accessible location Parameters Column Type Default Description $path string $override_paths array []: bool { debug_function_call__FUNCTION__ Override checking of the default RS paths to check a specific location only.

render_resource_tools_size_download_options()

Description Render the resource tools for preview sizes Parameters Column Type Default Description $resource array Resource data - {@see get_resource_data()} $ctx: array false $resource['file_extension'] false; bool, array{'download_multisize': "sizes"?: array, 'urlparams': array} $ctx Contextual information.

clear_restype_cache()

Description Force clear of restype_cache after editing resource type where get_resource_types() needs to pick up the new value. Parameters Column Type Default Description void { : Location include/config_functions.

Brand Guidelines (v10.5+)

The article outlines the brand guidelines for version 10.5 and above. It covers essential information such as logo usage, color palette, typography, and design elements to maintain brand consistency. The guidelines emphasize the correct application of the logo in various formats and backgrounds, specifying clear space requirements and prohibited alterations.

leaflet_esri_basemaps()

Description Generates ESRI basemaps for use in a Leaflet map. This function defines various tile layers from ESRI, setting properties such as caching, retina display support, maximum zoom levels, and attribution for each layer.

checkperm_login_as_user()

Description Check if the current user has sufficient permissions to log in as the specified user The regex used is to check if the a permission is present in the permission string of the target user Parameters Column Type Default Description bool { $user: $user mixed Either a user reference or user array Return bool This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 8th May 2026 11:00 Europe/London time.

File management (uploads)

The article emphasizes the importance of following OWASP best practices for file management, particularly during uploads. It introduces functions in ResourceSpace that aid in handling file processing, such as process_file_upload for moving files to desired destinations, parse_filename_extension for extracting file extensions, and functions like is_banned_extension and check_valid_file_extension to control the types of files that can be uploaded.

parse_filename_extension()

Description Parse file name (can include path, although it's unnecessary) to prevent known security bypasses associated with extensions, such as: - Double extensions, e.g. .jpg.php - Null bytes, e.

register_all_group_access_plugins()

Description Load ALL group specific plugins and reorder plugins list This will bypass any group access controls for use with CLI scripts Parameters Column Type Default Description $plugins: array ps_query"SELECT name enabled_groups config config_json FROM disable_group_select 0 ORDER BY priority" array "plugins"; $plugins array Enabled Plugins Return array Location include/plugin_functions.

process_collection_download()

Description Generate a collection download ZIP file and the download filename This array will be updated and passed to subsidiary functions to keep track of processed file, generate text etc.

delete_temp_files()

Description Delete old files and folders from tempo directory based on the configured $purge_temp_folder_age value Affects filestore/tmp, $storagedir/tmp or the configured $tempdir directory Parameters Column Type Default Description void { : Location include/file_functions.

config_percent_range()

Description Generate a percentage range input Parameters Column Type Default Description $name string The name of the configuration variable to be added.

set_usergroup_config_option()

Description Save or update config option for user group. Parameters Column Type Default Description $usergroup_id int User group id $param_name string Config parameter name $param_value: ?string $param_value string Config parameter value Location include/config_functions.

node_translated_name_comparator()

Description Comparator function for uasort to allow sorting of node array by translated name <0 means $n1 less than $n2 >0 means $n1 greater than $n2 Parameters Column Type Default Description $n1 array Node one to compare $n2 string Node two to compare Return 0 means $n1 equals $n2 Location include/node_functions.

create_annotated_pdf()

Description Create annotations PDF (old annotate plugin logic) Parameters Column Type Default Description $ref int $is_collection bool false $size string "letter" $cleanup bool false $preview bool false Location include/annotation_functions.

annotation_pdf_class()

Description Utility function to generate a one-off TCPDF variant (with multiRow method) Parameters This function accepts no parameters. Location include/annotation_functions.

missing_fields_check()

Description For a given resource, return an array of data for required metadata field references which have not been completed. Required fields shown by a display condition will only be considered required if the display condition is met.

update_archive_required_fields_check()

Description Considers if checking of missed required fields is required when a resource changes archive state. We'll always allow moving to the $resource_deletion_state and Pending Submission state (-2).

pluginname()

Parameters Column Type Default Description string { : safe_file_namegetval'pluginname' ''; This article was last updated 13th May 2026 15:05 Europe/London time based on the source file dated 11th May 2026 12:25 Europe/London time.

Managing (PHP) code dependencies

The article discusses the management of code dependencies in ResourceSpace, starting from version 10.7, using Composer for PHP dependencies. It emphasizes the importance of regular development tasks like running automated tests and static code analysis.

job_trigger_permission_check()

Description Determine whether the current user is allowed to manually trigger background jobs. The system must have config $offline_job_queue set to true and the user must have 'a', 'f', 't' and 'v' permissions as well as edit access to all workflow states.

can_view_collection_log()

Description Determines whether the current user has permission to view the collection log. Parameters Column Type Default Description $collection_data: array $k $sql_where_parent->parameters the in ['i' c.

Managing (JS) code dependencies

ResourceSpace has officially switched to managing its JavaScript dependencies using pnpm starting from version 11. To install pnpm, users are directed to follow the instructions provided on the pnpm website, ensuring compatibility with their setup.

config_integer_input()

Description Generate an HTML form element for input of integer only values. Field will include validation for supplied value being of type int and between supplied min and max values. While this function can handle client side validation, config_check_valid_option() must be used on save to allow for server side checking of the value.

hide_delete_comment()

Description Hide or delete a comment or annotation. Comments will be hidden where they have comments below them. If the comment has no comments below it will be deleted. Trees with all hidden comments will also be deleted.

This site uses cookies for interactivity and analytics Reject cookies Accept cookies

Sign up for free or check out the Service Pricing