Search results


The Complete Guide to Developing Your Brand Guidelines

Your brand characterises your business. Without it, your products and services become indistinguishable from those offered by competitors.

Read more...


The Complete Guide to Developing Your Brand Guidelines Download

Thank you for downloading the PDF version of our Guide to Developing Your Brand Guidelines.

Read more...


Integrating ResourceSpace with BrandStencil

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

Read more...


is_not_wildcard_only()

Description Helper function to check a string is not just the asterisk. Parameters Column Type Default Description $str string The string to be checked.

Read more...


Customising the header image

The article provides a simple guide on how to customize the header image of an installation. Users can access the option to replace the header image by navigating to the "System Configuration" option under the "System" menu on the admin page.

Read more...


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.

Read more...


ResourceSpace plugin for WordPress

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.

Read more...


Open source

ResourceSpace Digital Asset Management System: Open Source, Open Culture, Free Software, Free Forever

Read more...


 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.

Read more...


Advanced search

The advanced search page in ResourceSpace allows users to access a wider selection of metadata fields, enabling them to create more refined searches. The fields are grouped by resource type, with global fields at the top and resource-specific fields further down.

Read more...


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.

Read more...


 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.

Read more...


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.

Read more...


 Creating dash tiles

Dash tiles are a great way of creating shortcuts to your favourite things in ResourceSpace.

Read more...


Collection and resource promotion

The article discusses ways to promote resources and collections using ResourceSpace. The homepage slideshow is a great way to showcase new and useful content, and careful management of it will keep the system looking fresh and encourage users to check regularly for new content.

Read more...


Deleted resources

The article provides information on how to manage deleted resources in a system. The directory for deleted resources can be found in the Admin section of the system, and it contains all the deleted resources.

Read more...


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.

Read more...


Creating a resource type

This article provides instructions on how to create a new resource type in MODX. To create a new resource type, users need to browse to "Admin > System > Resource types", enter the name of the new resource type, click "Create", fill in the rest of the form as required, and click "Save".

Read more...


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.

Read more...


Ordering metadata fields

Metadata fields can be ordered to determine where they appear on search, edit and upload pages. Global fields are placed first, followed by resource type-specific fields in a collapsible section below.

Read more...


 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.

Read more...


 Smart featured collections

Smart featured collections are an automated way of collating resources with a common theme.

Read more...


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.

Read more...


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

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


Google Vision API

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.

Read more...


 Action dates

The 'action_dates' plugin will automatically perform certain actions based on resource metadata, for example, archiving a resource when an expiry date is reached.

Read more...


Basic metadata field configuration

This article provides an overview of the basic options for metadata field configuration in ResourceSpace. The article covers the following options: Enabled, Required, Index, Display full width on view page, Display field, Enable advanced search, Enable simple search, May contain personal data, Hide when uploading, and Hide when restricted.

Read more...


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.

Read more...


Checkmail

The Checkmail plugin has been developed to expand ResourceSpace's capabilities by enabling the ingestion of resources using email. The plugin allows devices to contribute digital assets to the system, and provides advanced configuration options and the ability to handle a wide range of email types.

Read more...


File integrity checking

ResourceSpace has a tool to verify the file integrity of primary resource files, which notifies users of any corruption and allows them to take remedial action. To configure the system to check file integrity, users need to have full file checksums configured, the ResourceSpace cron script configured to run frequently as a cron task or scheduled task, and the file integrity verify window enabled to set the hours between which the script will run.

Read more...


Data only resource types

Data only resources are metadata-only resources that do not have an associated file. They can be used to store a record or set of data that does not directly relate to a specific asset. Data only resources can be configured to provide a PDF of metadata based on templates that must be set up by the system administrator and placed in the filestore under system/pdf_templates as an HTML file.

Read more...


Exporting data

ResourceSpace allows users to export data and configuration files for testing purposes. This feature requires offline jobs to be configured and the config option $system_download_config to be enabled. Users can navigate to Admin > System > Export data to choose the options for the exported data.

Read more...


Auto login

The auto_login plugin enables automatic authentication of users based on a specified IP pattern. This is useful in situations where a user needs to log in to ResourceSpace but should not have knowledge of account credentials, such as a generic team account.

Read more...


Query caching

Query caching is a technique that can be used to cache the results of selected queries to disk. This is useful where the same query is likely to be called a large number of times, for example, queries that are common across several pages and the same for large groups of users.

Read more...


Metadata templates

Metadata templates are a useful tool for saving time and ensuring consistency when uploading resources with common metadata sets. A metadata template is a data-only resource that inherits all global fields and resource type-specific fields, meaning that each template may contain a complete set of values for every field within ResourceSpace.

Read more...


Resources slow to create previews

The article provides solutions to two common issues that can arise when creating previews for videos. The first issue is that preview creation can take too long, causing the system to time out. To solve this, the article suggests disabling automatic preview creation upon upload and setting up offline preview creation using a crontab entry or scheduled task.

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

Read more...


User IP restriction

ResourceSpace allows users to limit the locations from which their users access the platform by applying an IP restriction to user accounts. This is done on a per-user basis, allowing tighter controls on certain accounts where necessary.

Read more...


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.

Read more...


 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.

Read more...


Integrating ResourceSpace with RightMarket

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

Read more...


The Beginner's Guide to Managing Consent for Charities & non-profits Download

Thank you for downloading the PDF version of The Beginner's Guide to Managing Consent.

Read more...


What is Digital Asset Management?

Digital Asset Management is critical for managing and securing digital assets. Explore the benefits of DAM, its use cases, and how it streamlines asset management.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


A Comprehensive Guide to Digital Curation: Tools and Techniques

Explore the world of digital curation. Learn about the concepts, tools, and techniques used to curate and preserve historical and culturally significant assets.

Read more...


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.

Read more...


Navigating Consent and Digital Asset Management

Consent is not just limited to personal contact information or medical records; it also applies to artwork, photos, and videos where a person is identifiable. Digital asset managers need to have robust consent policies and procedures in place to comply with regulations and protect the privacy of individuals.

Read more...


Table: daily_stat

The article describes the structure of the "daily_stat" table, which is used to store daily statistics grouped by day, user group, and activity type. The table has columns for the year, month, and day when the activity took place, the user group that carried out the activity, the activity type code, the ID of the table in question, the count of how many times the activity was carried out on the object in the day in question by any user, and whether the activity happened via an external share.

Read more...


Table: keyword

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 13661 tokens. Please reduce the length of the messages.

Read more...


Table: node

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10911 tokens. Please reduce the length of the messages.

Read more...


Table: resource_type_field

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10794 tokens. Please reduce the length of the messages.

Read more...


Table: user

The "user" table in ResourceSpace stores all user information, including their username, password, full name, email address, user group, and last activity date. It also includes information on whether the user is currently logged in, their browser user agent string, and their IP address.

Read more...


Table: resource_type_field_resource_type

Links resource_type_field records to resource_type. Used when the global column in resource_type_field is set to 0; Column Type Note resource_type_field int(11) See table resource_type_field resource_type int(11) See table resource_type Default contents are as follows.

Read more...


get_user_actions()

Developer reference for function get_user_actions()

Read more...


get_editable_resource_sql()

Developer reference for function get_editable_resource_sql()

Read more...


update_resource_type_field_order()

Developer reference for function update_resource_type_field_order()

Read more...


update_resource_type_order()

Developer reference for function update_resource_type_order()

Read more...


ajax_permission_denied()

Developer reference for function ajax_permission_denied()

Read more...


ajax_unauthorized()

Developer reference for function ajax_unauthorized()

Read more...


getAnnotoriousResourceAnnotations()

Developer reference for function getAnnotoriousResourceAnnotations()

Read more...


annotationEditable()

Developer reference for function annotationEditable()

Read more...


createAnnotation()

Developer reference for function createAnnotation()

Read more...


updateAnnotation()

Developer reference for function updateAnnotation()

Read more...


prepareTags()

Developer reference for function prepareTags()

Read more...


get_api_key()

Developer reference for function get_api_key()

Read more...


execute_api_call()

Developer reference for function execute_api_call()

Read more...


iiif_get_canvases()

Developer reference for function iiif_get_canvases()

Read more...


iiif_get_thumbnail()

Developer reference for function iiif_get_thumbnail()

Read more...


iiif_get_image()

Developer reference for function iiif_get_image()

Read more...


get_user_collections()

Developer reference for function get_user_collections()

Read more...


get_collection()

Developer reference for function get_collection()

Read more...


get_collection_resources()

Developer reference for function get_collection_resources()

Read more...


add_resource_to_collection()

Developer reference for function add_resource_to_collection()

Read more...


remove_resource_from_collection()

Developer reference for function remove_resource_from_collection()

Read more...


collection_writeable()

Developer reference for function collection_writeable()

Read more...


collection_readable()

Developer reference for function collection_readable()

Read more...


set_user_collection()

Developer reference for function set_user_collection()

Read more...


create_collection()

Developer reference for function create_collection()

Read more...


delete_collection()

Developer reference for function delete_collection()

Read more...


refresh_collection_frame()

Developer reference for function refresh_collection_frame()

Read more...


search_public_collections()

Developer reference for function search_public_collections()

Read more...


do_collections_search()

Developer reference for function do_collections_search()

Read more...


add_collection()

Developer reference for function add_collection()

Read more...


index_collection()

Developer reference for function index_collection()

Read more...


save_collection()

Developer reference for function save_collection()

Read more...


get_theme_headers()

Developer reference for function get_theme_headers()

Read more...


get_themes()

Developer reference for function get_themes()

Read more...


email_collection()

Developer reference for function email_collection()

Read more...


generate_collection_access_key()

Developer reference for function generate_collection_access_key()

Read more...


add_smart_collection()

Developer reference for function add_smart_collection()

Read more...


get_search_title()

Developer reference for function get_search_title()

Read more...


add_saved_search_items()

Developer reference for function add_saved_search_items()

Read more...


allow_multi_edit()

Developer reference for function allow_multi_edit()

Read more...


get_theme_image()

Developer reference for function get_theme_image()

Read more...


get_mycollection_name()

Developer reference for function get_mycollection_name()

Read more...


send_collection_feedback()

Developer reference for function send_collection_feedback()

Read more...


add_to_collection_link()

Developer reference for function add_to_collection_link()

Read more...


change_collection_link()

Developer reference for function change_collection_link()

Read more...


get_collection_external_access()

Developer reference for function get_collection_external_access()

Read more...


collection_log()

Developer reference for function collection_log()

Read more...


get_collection_log()

Developer reference for function get_collection_log()

Read more...


get_collection_videocount()

Developer reference for function get_collection_videocount()

Read more...


collection_min_access()

Developer reference for function collection_min_access()

Read more...


collection_set_themes()

Developer reference for function collection_set_themes()

Read more...


get_home_page_promoted_collections()

Developer reference for function get_home_page_promoted_collections()

Read more...


is_collection_approved()

Developer reference for function is_collection_approved()

Read more...


edit_collection_external_access()

Developer reference for function edit_collection_external_access()

Read more...


show_hide_collection()

Developer reference for function show_hide_collection()

Read more...


compile_collection_actions()

Developer reference for function compile_collection_actions()

Read more...


new_featured_collection_form()

Developer reference for function new_featured_collection_form()

Read more...


collection_download_get_archive_file()

Developer reference for function collection_download_get_archive_file()

Read more...


collection_download_use_original_filenames_when_downloading()

Developer reference for function collection_download_use_original_filenames_when_downloading()

Read more...


collection_download_process_text_file()

Developer reference for function collection_download_process_text_file()

Read more...


collection_download_log_resource_ready()

Developer reference for function collection_download_log_resource_ready()

Read more...


update_zip_progress_file()

Developer reference for function update_zip_progress_file()

Read more...


collection_download_process_data_only_types()

Developer reference for function collection_download_process_data_only_types()

Read more...


collection_download_process_summary_notes()

Developer reference for function collection_download_process_summary_notes()

Read more...


collection_download_process_csv_metadata_file()

Developer reference for function collection_download_process_csv_metadata_file()

Read more...


collection_download_process_command_to_file()

Developer reference for function collection_download_process_command_to_file()

Read more...


collection_download_process_collection_download_name()

Developer reference for function collection_download_process_collection_download_name()

Read more...


collection_download_process_archive_command()

Developer reference for function collection_download_process_archive_command()

Read more...


collection_download_clean_temp_files()

Developer reference for function collection_download_clean_temp_files()

Read more...


collection_cleanup_inaccessible_resources()

Developer reference for function collection_cleanup_inaccessible_resources()

Read more...


get_user_selection_collection()

Developer reference for function get_user_selection_collection()

Read more...


comments_submit()

Developer reference for function comments_submit()

Read more...


comments_show()

Developer reference for function comments_show()

Read more...


validate_field()

Developer reference for function validate_field()

Read more...


render_select_option()

Developer reference for function render_select_option()

Read more...


render_bool_option()

Developer reference for function render_bool_option()

Read more...


render_text_option()

Developer reference for function render_text_option()

Read more...


get_config_option()

Developer reference for function get_config_option()

Read more...


get_config_options()

Developer reference for function get_config_options()

Read more...


process_config_options()

Developer reference for function process_config_options()

Read more...


config_text_input()

Developer reference for function config_text_input()

Read more...


config_file_input()

Developer reference for function config_file_input()

Read more...


config_colouroverride_input()

Developer reference for function config_colouroverride_input()

Read more...


config_single_select()

Developer reference for function config_single_select()

Read more...


config_boolean_select()

Developer reference for function config_boolean_select()

Read more...


config_checkbox_select()

Developer reference for function config_checkbox_select()

Read more...


config_single_ftype_select()

Developer reference for function config_single_ftype_select()

Read more...


config_generate_AutoSaveConfigOption_function()

Developer reference for function config_generate_AutoSaveConfigOption_function()

Read more...


config_process_file_input()

Developer reference for function config_process_file_input()

Read more...


config_generate_html()

Developer reference for function config_generate_html()

Read more...


config_merge_non_image_types()

Developer reference for function config_merge_non_image_types()

Read more...


get_header_image()

Developer reference for function get_header_image()

Read more...


config_register_core_fieldvars()

Developer reference for function config_register_core_fieldvars()

Read more...


generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

Read more...


generateNodesExport()

Developer reference for function generateNodesExport()

Read more...


update_dash_tile()

Developer reference for function update_dash_tile()

Read more...


cleanup_dash_tiles()

Developer reference for function cleanup_dash_tiles()

Read more...


checkTileConfig()

Developer reference for function checkTileConfig()

Read more...


checkConfigCustomHomePanels()

Developer reference for function checkConfigCustomHomePanels()

Read more...


get_default_dash()

Developer reference for function get_default_dash()

Read more...


get_managed_dash()

Developer reference for function get_managed_dash()

Read more...


delete_user_dash_tile()

Developer reference for function delete_user_dash_tile()

Read more...


empty_user_dash()

Developer reference for function empty_user_dash()

Read more...


get_user_dash()

Developer reference for function get_user_dash()

Read more...


render_delete_dialog_JS()

Developer reference for function render_delete_dialog_JS()

Read more...


parse_dashtile_link()

Developer reference for function parse_dashtile_link()

Read more...


build_dash_tile_list()

Developer reference for function build_dash_tile_list()

Read more...


allow_tile_colour_change()

Developer reference for function allow_tile_colour_change()

Read more...


render_dash_tile_colour_chooser()

Developer reference for function render_dash_tile_colour_chooser()

Read more...


render_upgrade_available_tile()

Developer reference for function render_upgrade_available_tile()

Read more...


generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

Read more...


db_set_connection_mode()

Developer reference for function db_set_connection_mode()

Read more...


check_debug_log_override()

Developer reference for function check_debug_log_override()

Read more...


debug_function_call()

Developer reference for function debug_function_call()

Read more...


rsEncrypt()

Developer reference for function rsEncrypt()

Read more...


rsDecrypt()

Developer reference for function rsDecrypt()

Read more...


initFacialRecognition()

Developer reference for function initFacialRecognition()

Read more...


generateUserFilenameUID()

Developer reference for function generateUserFilenameUID()

Read more...


get_checksum()

Developer reference for function get_checksum()

Read more...


pager()

Developer reference for function pager()

Read more...


txt2html()

Developer reference for function txt2html()

Read more...


job_queue_add()

Developer reference for function job_queue_add()

Read more...


job_queue_delete()

Developer reference for function job_queue_delete()

Read more...


job_queue_get_jobs()

Developer reference for function job_queue_get_jobs()

Read more...


job_queue_run_job()

Developer reference for function job_queue_run_job()

Read more...


generateSecureKey()

Developer reference for function generateSecureKey()

Read more...


IsModal()

Developer reference for function IsModal()

Read more...


lang_or_i18n_get_translated()

Developer reference for function lang_or_i18n_get_translated()

Read more...


i18n_get_translated()

Developer reference for function i18n_get_translated()

Read more...


i18n_get_collection_name()

Developer reference for function i18n_get_collection_name()

Read more...


i18n_get_translations()

Developer reference for function i18n_get_translations()

Read more...


normalize_keyword()

Developer reference for function normalize_keyword()

Read more...


http_get_preferred_language()

Developer reference for function http_get_preferred_language()

Read more...


setLanguage()

Developer reference for function setLanguage()

Read more...


perform_login()

Developer reference for function perform_login()

Read more...


generate_session_hash()

Developer reference for function generate_session_hash()

Read more...


set_login_cookies()

Developer reference for function set_login_cookies()

Read more...


message_get()

Developer reference for function message_get()

Read more...


message_add()

Developer reference for function message_add()

Read more...


message_send_unread_emails()

Developer reference for function message_send_unread_emails()

Read more...


message_user_remove()

Developer reference for function message_user_remove()

Read more...


system_notification()

Developer reference for function system_notification()

Read more...


runFitsForFile()

Developer reference for function runFitsForFile()

Read more...


getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

Read more...


check_date_format()

Developer reference for function check_date_format()

Read more...


check_date_parts()

Developer reference for function check_date_parts()

Read more...


populate_resource_nodes()

Developer reference for function populate_resource_nodes()

Read more...


migrate_filter()

Developer reference for function migrate_filter()

Read more...


mix_date()

Developer reference for function mix_date()

Read more...


mix_text()

Developer reference for function mix_text()

Read more...


mix_url()

Developer reference for function mix_url()

Read more...


mix_filename()

Developer reference for function mix_filename()

Read more...


mix_email()

Developer reference for function mix_email()

Read more...


get_export_tables()

Developer reference for function get_export_tables()

Read more...


edit_filter_to_restype_permission()

Developer reference for function edit_filter_to_restype_permission()

Read more...


set_node()

Developer reference for function set_node()

Read more...


delete_node()

Developer reference for function delete_node()

Read more...


get_nodes()

Developer reference for function get_nodes()

Read more...


reorder_nodes()

Developer reference for function reorder_nodes()

Read more...


render_new_node_record()

Developer reference for function render_new_node_record()

Read more...


draw_tree_node_table()

Developer reference for function draw_tree_node_table()

Read more...


node_field_options_override()

Developer reference for function node_field_options_override()

Read more...


add_node_keyword()

Developer reference for function add_node_keyword()

Read more...


remove_node_keyword()

Developer reference for function remove_node_keyword()

Read more...


add_node_keyword_mappings()

Developer reference for function add_node_keyword_mappings()

Read more...


add_resource_nodes()

Developer reference for function add_resource_nodes()

Read more...


add_resource_nodes_multi()

Developer reference for function add_resource_nodes_multi()

Read more...


copy_resource_nodes()

Developer reference for function copy_resource_nodes()

Read more...


copy_resource_type_field_nodes()

Developer reference for function copy_resource_type_field_nodes()

Read more...


get_tree_strings()

Developer reference for function get_tree_strings()

Read more...


get_pdf_template_path()

Developer reference for function get_pdf_template_path()

Read more...


generate_pdf()

Developer reference for function generate_pdf()

Read more...


get_template_path()

Developer reference for function get_template_path()

Read more...


process_template()

Developer reference for function process_template()

Read more...


resolve_pdf_language()

Developer reference for function resolve_pdf_language()

Read more...


get_pdf_templates()

Developer reference for function get_pdf_templates()

Read more...


get_plugin_config()

Developer reference for function get_plugin_config()

Read more...


set_plugin_config()

Developer reference for function set_plugin_config()

Read more...


handle_rsc_upload()

Developer reference for function handle_rsc_upload()

Read more...


display_rsc_upload()

Developer reference for function display_rsc_upload()

Read more...


config_gen_setup_post()

Developer reference for function config_gen_setup_post()

Read more...


config_gen_setup_html()

Developer reference for function config_gen_setup_html()

Read more...


config_multi_select()

Developer reference for function config_multi_select()

Read more...


config_single_user_select()

Developer reference for function config_single_user_select()

Read more...


config_multi_user_select()

Developer reference for function config_multi_user_select()

Read more...


config_single_group_select()

Developer reference for function config_single_group_select()

Read more...


config_multi_group_select()

Developer reference for function config_multi_group_select()

Read more...


config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

Read more...


config_single_rtype_select()

Developer reference for function config_single_rtype_select()

Read more...


config_multi_rtype_select()

Developer reference for function config_multi_rtype_select()

Read more...


config_db_single_select()

Developer reference for function config_db_single_select()

Read more...


config_db_multi_select()

Developer reference for function config_db_multi_select()

Read more...


get_plugin_css()

Developer reference for function get_plugin_css()

Read more...


include_plugin_config()

Developer reference for function include_plugin_config()

Read more...


register_plugin_language()

Developer reference for function register_plugin_language()

Read more...


get_plugin_path()

Developer reference for function get_plugin_path()

Read more...


register_plugin()

Developer reference for function register_plugin()

Read more...


render_search_field()

Developer reference for function render_search_field()

Read more...


render_sort_order()

Developer reference for function render_sort_order()

Read more...


render_actions()

Developer reference for function render_actions()

Read more...


render_access_key_tr()

Developer reference for function render_access_key_tr()

Read more...


is_field_displayed()

Developer reference for function is_field_displayed()

Read more...


display_multilingual_text_field()

Developer reference for function display_multilingual_text_field()

Read more...


display_field()

Developer reference for function display_field()

Read more...


render_date_range_field()

Developer reference for function render_date_range_field()

Read more...


renderBreadcrumbs()

Developer reference for function renderBreadcrumbs()

Read more...


renderCallToActionTile()

Developer reference for function renderCallToActionTile()

Read more...


renderSocialMediaShareLinksForUrl()

Developer reference for function renderSocialMediaShareLinksForUrl()

Read more...


renderLockButton()

Developer reference for function renderLockButton()

Read more...


render_resource_image()

Developer reference for function render_resource_image()

Read more...


render_share_options()

Developer reference for function render_share_options()

Read more...


render_field_selector_question()

Developer reference for function render_field_selector_question()

Read more...


render_upload_here_button()

Developer reference for function render_upload_here_button()

Read more...


render_browse_bar()

Developer reference for function render_browse_bar()

Read more...


render_help_link()

Developer reference for function render_help_link()

Read more...


render_custom_fields()

Developer reference for function render_custom_fields()

Read more...


render_selected_resources_counter()

Developer reference for function render_selected_resources_counter()

Read more...


render_edit_selected_btn()

Developer reference for function render_edit_selected_btn()

Read more...


render_clear_selected_btn()

Developer reference for function render_clear_selected_btn()

Read more...


render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

Read more...


render_user_collection_select()

Developer reference for function render_user_collection_select()

Read more...


render_csrf_data_attributes()

Developer reference for function render_csrf_data_attributes()

Read more...


check_display_condition()

Developer reference for function check_display_condition()

Read more...


has_browsebar()

Developer reference for function has_browsebar()

Read more...


display_upload_options()

Developer reference for function display_upload_options()

Read more...


display_field_data()

Developer reference for function display_field_data()

Read more...


render_resource_lock_link()

Developer reference for function render_resource_lock_link()

Read more...


EditNav()

Developer reference for function EditNav()

Read more...


SaveAndClearButtons()

Developer reference for function SaveAndClearButtons()

Read more...


do_report()

Developer reference for function do_report()

Read more...


send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

Read more...


delete_periodic_report()

Developer reference for function delete_periodic_report()

Read more...


get_translated_activity_type()

Developer reference for function get_translated_activity_type()

Read more...


get_user_requests()

Developer reference for function get_user_requests()

Read more...


save_request()

Developer reference for function save_request()

Read more...


get_requests()

Developer reference for function get_requests()

Read more...


email_collection_request()

Developer reference for function email_collection_request()

Read more...


managed_collection_request()

Developer reference for function managed_collection_request()

Read more...


email_resource_request()

Developer reference for function email_resource_request()

Read more...


get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

Read more...


process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

Read more...


send_research_request()

Developer reference for function send_research_request()

Read more...


save_research_request()

Developer reference for function save_research_request()

Read more...


get_resource_path()

Developer reference for function get_resource_path()

Read more...


get_resource_data()

Developer reference for function get_resource_data()

Read more...


put_resource_data()

Developer reference for function put_resource_data()

Read more...


create_resource()

Developer reference for function create_resource()

Read more...


update_hitcount()

Developer reference for function update_hitcount()

Read more...


save_resource_data()

Developer reference for function save_resource_data()

Read more...


set_resource_defaults()

Developer reference for function set_resource_defaults()

Read more...


save_resource_data_multi()

Developer reference for function save_resource_data_multi()

Read more...


append_field_value()

Developer reference for function append_field_value()

Read more...


remove_keyword_from_resource()

Developer reference for function remove_keyword_from_resource()

Read more...


add_keyword_to_resource()

Developer reference for function add_keyword_to_resource()

Read more...


update_field()

Developer reference for function update_field()

Read more...


email_resource()

Developer reference for function email_resource()

Read more...


delete_resource()

Developer reference for function delete_resource()

Read more...


get_resource_field_data()

Developer reference for function get_resource_field_data()

Read more...


get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

Read more...


get_resource_types()

Developer reference for function get_resource_types()

Read more...


get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

Read more...


copy_resource()

Developer reference for function copy_resource()

Read more...


resource_log()

Developer reference for function resource_log()

Read more...


get_resource_type_name()

Developer reference for function get_resource_type_name()

Read more...


get_resource_custom_access()

Developer reference for function get_resource_custom_access()

Read more...


get_custom_access()

Developer reference for function get_custom_access()

Read more...


get_themes_by_resource()

Developer reference for function get_themes_by_resource()

Read more...


update_resource_type()

Developer reference for function update_resource_type()

Read more...


get_exiftool_fields()

Developer reference for function get_exiftool_fields()

Read more...


write_metadata()

Developer reference for function write_metadata()

Read more...


update_resource()

Developer reference for function update_resource()

Read more...


import_resource()

Developer reference for function import_resource()

Read more...


delete_alternative_file()

Developer reference for function delete_alternative_file()

Read more...


user_rating_save()

Developer reference for function user_rating_save()

Read more...


process_notify_user_contributed_submitted()

Developer reference for function process_notify_user_contributed_submitted()

Read more...


notify_user_contributed_submitted()

Developer reference for function notify_user_contributed_submitted()

Read more...


notify_user_contributed_unsubmitted()

Developer reference for function notify_user_contributed_unsubmitted()

Read more...


save_field_options()

Developer reference for function save_field_options()

Read more...


get_keyword_from_option()

Developer reference for function get_keyword_from_option()

Read more...


get_resource_access()

Developer reference for function get_resource_access()

Read more...


edit_resource_external_access()

Developer reference for function edit_resource_external_access()

Read more...


resource_download_allowed()

Developer reference for function resource_download_allowed()

Read more...


get_edit_access()

Developer reference for function get_edit_access()

Read more...


get_metadata_templates()

Developer reference for function get_metadata_templates()

Read more...


get_resource_collections()

Developer reference for function get_resource_collections()

Read more...


check_use_watermark()

Developer reference for function check_use_watermark()

Read more...


autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

Read more...


get_resource_files()

Developer reference for function get_resource_files()

Read more...


reindex_resource()

Developer reference for function reindex_resource()

Read more...


update_disk_usage_cron()

Developer reference for function update_disk_usage_cron()

Read more...


get_total_disk_usage()

Developer reference for function get_total_disk_usage()

Read more...


overquota()

Developer reference for function overquota()

Read more...


notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

Read more...


get_original_imagesize()

Developer reference for function get_original_imagesize()

Read more...


generate_resource_access_key()

Developer reference for function generate_resource_access_key()

Read more...


get_resource_external_access()

Developer reference for function get_resource_external_access()

Read more...


delete_resource_access_key()

Developer reference for function delete_resource_access_key()

Read more...


resource_type_config_override()

Developer reference for function resource_type_config_override()

Read more...


delete_resources_in_collection()

Developer reference for function delete_resources_in_collection()

Read more...


can_share_resource()

Developer reference for function can_share_resource()

Read more...


truncate_join_field_value()

Developer reference for function truncate_join_field_value()

Read more...


get_video_snapshots()

Developer reference for function get_video_snapshots()

Read more...


resource_file_readonly()

Developer reference for function resource_file_readonly()

Read more...


copyAllDataToResource()

Developer reference for function copyAllDataToResource()

Read more...


copyResourceDataValues()

Developer reference for function copyResourceDataValues()

Read more...


copy_locked_data()

Developer reference for function copy_locked_data()

Read more...


copy_locked_fields()

Developer reference for function copy_locked_fields()

Read more...


process_edit_form()

Developer reference for function process_edit_form()

Read more...


get_extension()

Developer reference for function get_extension()

Read more...


get_default_archive_state()

Developer reference for function get_default_archive_state()

Read more...


save_original_file_as_alternative()

Developer reference for function save_original_file_as_alternative()

Read more...


replace_resource_file()

Developer reference for function replace_resource_file()

Read more...


download_link_generate_key()

Developer reference for function download_link_generate_key()

Read more...


get_image_sizes()

Developer reference for function get_image_sizes()

Read more...


get_preview_quality()

Developer reference for function get_preview_quality()

Read more...


get_field_options()

Developer reference for function get_field_options()

Read more...


get_data_by_field()

Developer reference for function get_data_by_field()

Read more...


get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

Read more...


get_category_tree_fields()

Developer reference for function get_category_tree_fields()

Read more...


get_OR_fields()

Developer reference for function get_OR_fields()

Read more...


get_nopreview_icon()

Developer reference for function get_nopreview_icon()

Read more...


get_resource_type_fields()

Developer reference for function get_resource_type_fields()

Read more...


notify_resource_change()

Developer reference for function notify_resource_change()

Read more...


add_verbatim_keywords()

Developer reference for function add_verbatim_keywords()

Read more...


get_download_filename()

Developer reference for function get_download_filename()

Read more...


canSeePreviewTools()

Developer reference for function canSeePreviewTools()

Read more...


checkPreviewToolsOptionUniqueness()

Developer reference for function checkPreviewToolsOptionUniqueness()

Read more...


alt_is_ffmpeg_alternative()

Developer reference for function alt_is_ffmpeg_alternative()

Read more...


create_resource_type_field()

Developer reference for function create_resource_type_field()

Read more...


get_workflow_states()

Developer reference for function get_workflow_states()

Read more...


delete_resource_type_field()

Developer reference for function delete_resource_type_field()

Read more...


tab_names()

Developer reference for function tab_names()

Read more...


get_resource_table_joins()

Developer reference for function get_resource_table_joins()

Read more...


update_resource_lock()

Developer reference for function update_resource_lock()

Read more...


get_resource_lock_message()

Developer reference for function get_resource_lock_message()

Read more...


resolve_soundex()

Developer reference for function resolve_soundex()

Read more...


get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

Read more...


get_advanced_search_collection_fields()

Developer reference for function get_advanced_search_collection_fields()

Read more...


search_form_to_search_query()

Developer reference for function search_form_to_search_query()

Read more...


refine_searchstring()

Developer reference for function refine_searchstring()

Read more...


compile_search_actions()

Developer reference for function compile_search_actions()

Read more...


search_filter()

Developer reference for function search_filter()

Read more...


search_special()

Developer reference for function search_special()

Read more...


search_get_previews()

Developer reference for function search_get_previews()

Read more...


get_default_search_states()

Developer reference for function get_default_search_states()

Read more...


get_filter_sql()

Developer reference for function get_filter_sql()

Read more...


split_keywords()

Developer reference for function split_keywords()

Read more...


cleanse_string()

Developer reference for function cleanse_string()

Read more...


resolve_keyword()

Developer reference for function resolve_keyword()

Read more...


add_partial_index()

Developer reference for function add_partial_index()

Read more...


highlightkeywords()

Developer reference for function highlightkeywords()

Read more...


get_suggested_keywords()

Developer reference for function get_suggested_keywords()

Read more...


get_related_keywords()

Developer reference for function get_related_keywords()

Read more...


get_simple_search_fields()

Developer reference for function get_simple_search_fields()

Read more...


update_search_from_request()

Developer reference for function update_search_from_request()

Read more...


get_slideshow_image_file_path()

Developer reference for function get_slideshow_image_file_path()

Read more...


getThemePathPerms()

Developer reference for function getThemePathPerms()

Read more...


setup_user()

Developer reference for function setup_user()

Read more...


save_themename()

Developer reference for function save_themename()

Read more...


display_size_option()

Developer reference for function display_size_option()

Read more...


get_search_default_restypes()

Developer reference for function get_search_default_restypes()

Read more...


get_selectedtypes()

Developer reference for function get_selectedtypes()

Read more...


render_advanced_search_buttons()

Developer reference for function render_advanced_search_buttons()

Read more...


check_order_by_in_table_joins()

Developer reference for function check_order_by_in_table_joins()

Read more...


show_upgrade_in_progress()

Developer reference for function show_upgrade_in_progress()

Read more...


config_multi_archive_select()

Developer reference for function config_multi_archive_select()

Read more...


render_table()

Developer reference for function render_table()

Read more...


get_featured_collection_resources()

Developer reference for function get_featured_collection_resources()

Read more...


get_featured_collection_categ_sub_fcs()

Developer reference for function get_featured_collection_categ_sub_fcs()

Read more...


generate_featured_collection_image_urls()

Developer reference for function generate_featured_collection_image_urls()

Read more...


featured_collections_permissions_filter_sql()

Developer reference for function featured_collections_permissions_filter_sql()

Read more...


process_posted_featured_collection_categories()

Developer reference for function process_posted_featured_collection_categories()

Read more...


allow_collection_share()

Developer reference for function allow_collection_share()

Read more...


allow_featured_collection_share()

Developer reference for function allow_featured_collection_share()

Read more...


filter_featured_collections_by_root()

Developer reference for function filter_featured_collections_by_root()

Read more...


render_featured_collection_category_selector()

Developer reference for function render_featured_collection_category_selector()

Read more...


render_featured_collections()

Developer reference for function render_featured_collections()

Read more...


render_featured_collection()

Developer reference for function render_featured_collection()

Read more...


DrawOption()

Developer reference for function DrawOption()

Read more...


render_featured_collections_category_permissions()

Developer reference for function render_featured_collections_category_permissions()

Read more...


dash_tile_featured_collection_get_resources()

Developer reference for function dash_tile_featured_collection_get_resources()

Read more...


order_featured_collections()

Developer reference for function order_featured_collections()

Read more...


allow_upload_to_collection()

Developer reference for function allow_upload_to_collection()

Read more...


compute_featured_collections_acess_control()

Developer reference for function compute_featured_collections_acess_control()

Read more...


compute_node_branch_path()

Developer reference for function compute_node_branch_path()

Read more...


get_resource_data_batch()

Developer reference for function get_resource_data_batch()

Read more...


compute_featured_collections_access_control()

Description Compute the featured collections allowed based on current access control TRUE if user has access to all featured collections. If some access control is in place, then the return will be an array with all the allowed featured collections Parameters This function accepts no parameters.

Read more...


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.

Read more...


update_fieldx()

Parameters Column Type Default Description $metadata_field_ref: int get_resource_table_joins Location include/metadata_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


comments_tags_to_links()

Description Parse a comment and replace and add links to any user, resource and collection tags Parameters Column Type Default Description string $text: preg_replace'/@\S+/s' href '

Read more...


Frequently Asked Questions (FAQs)

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

Read more...


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.

Read more...


can_edit_upload_share()

Parameters Column Type Default Description $collection $uploadkey Location include/collections_functions.

Read more...


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.

Read more...


upload_share_active()

Parameters This function accepts no parameters. Location include/collections_functions.php lines 6575 to 6587 Definition   function  upload_share_active ()     {     global  $upload_share_active ;     if(isset( $upload_share_active ))         {         return  $upload_share_active ;         }     elseif(isset( $_COOKIE [ "upload_share_active" ]) &&  getval ( "k" , "" ) !=  "" )         {         return (int)  $_COOKIE [ "upload_share_active" ];         }     return  false ;     } This article was last updated 29th May 2024 13:05 Europe/London time based on the source file dated 16th May 2024 18:10 Europe/London time.

Read more...


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.

Read more...


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.

Read more...


purge_expired_shares()

Description Purge all expired shares "share_group" - (int) Usergroup ref 'shared as' "share_user" - (int) user ID of share creator "share_type" - (int) 0=view, 1=upload "share_collection" - (int) Collection ID Parameters Column Type Default Description $filteropts array Array of options to filter shares purged Return string|int Location include/collections_functions.

Read more...


render_workflow_state_question()

Parameters Column Type Default Description $current null $checkaccess true Location include/render_functions.

Read more...


render_share_password_question()

Parameters Column Type Default Description $blank true Location include/render_functions.

Read more...


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.

Read more...


emulate_user()

Description Used to emulate system users when accessing system anonymously or via external shares Sets global array such as $userpermissions, $username and sets any relevant config options Parameters Column Type Default Description $user int User ID $usergroup int "" usergroup ID Return void This article was last updated 29th May 2024 13:05 Europe/London time based on the source file dated 24th May 2024 12:50 Europe/London time.

Read more...


config_register_core_field_refs()

Description Used to block deletion of 'core' fields. Parameters Column Type Default Description $source string What part (e.

Read more...


leaflet_osm_basemaps()

Parameters Column Type Default Description OpenStreetMap // { '" detectRetina: 19 maxZoom: osm_attribute attribution: 18 maxZoom: 20 maxZoom: osm_fr_attribute attribution: L.

Read more...


leaflet_polygon_parsing()

Parameters Column Type Default Description $fields $minmax true Location include/map_functions.

Read more...


leaflet_markers_legend()

Parameters This function accepts no parameters. Location include/map_functions.php lines 502 to 532 Definition   function  leaflet_markers_legend ()     {     global  $lang ,  $marker_metadata_field ,  $marker_metadata_array ,  $MARKER_COLORS ;     if (!isset( $marker_metadata_field ) ||  $lang [ 'custom_metadata_markers' ] ==  '' )         {  ?>         <b>    echo  escape ( $lang [ 'legend_text' ]);  ?> &nbsp;</b>                  $restypes  =  get_resource_types ();         foreach( $restypes  as  $restype )             {              $markercolour  = (isset( $restype [ "colour" ]) &&  $restype [ "colour" ] >  0 ) ? (int) $restype [ "colour" ] : ( $restype [ 'ref' ] %  count ( $MARKER_COLORS ));             echo  "<img src='.

Read more...


header_add_map_providers()

Parameters This function accepts no parameters. Location include/map_functions.php lines 534 to 683 Definition   function  header_add_map_providers ()     {     global  $geo_leaflet_sources ,  $baseurl ,  $geo_tile_caching ;      ?>     <script>     // Copied from leaflet-providers.

Read more...


get_geolibraries()

Parameters This function accepts no parameters. Location include/map_functions.php lines 685 to 708 Definition   function  get_geolibraries ()     {     global  $baseurl ,  $pagename ,  $map_default_cache ,  $map_layer_cache ,  $geo_leaflet_maps_sources ,      $map_zoomnavbar ,  $map_kml ;      $map_pages  = array(          "geo_edit" ,          "geo_search" ,          "search" ,          "view" ,          "edit" ,         );     if(! in_array ( $pagename , $map_pages ))         {         return  false ;         } ?>     <!--Leaflet Control Geocoder 1.

Read more...


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.

Read more...


get_geo_maps_scripts()

Parameters This function accepts no parameters. Location include/map_functions.php lines 723 to 729 Definition   function  get_geo_maps_scripts ()     {     global  $baseurl ;      ?>     <script src="   echo  $baseurl?> /lib/leaflet_plugins/leaflet-markercluster-1.

Read more...


clear_tracking_vars_info()

Description Clear sysvar entries used for tracking variables in ResourceSpace Parameters Column Type Default Description $users array List of user IDs Location include/debug_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


render_message()

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

Read more...


message_deleteselusrmsg()

Description Delete all selected messages Parameters Column Type Default Description $messages List $messages of message refs in JSON list format Return void Location include/message_functions.

Read more...


message_selectedseen()

Description Mark all selected messages as seen Parameters Column Type Default Description $messages List $messages of message refs in JSON list format Return void Location include/message_functions.

Read more...


message_selectedunseen()

Description Mark all selected messages as unseen Parameters Column Type Default Description $messages List $messages of message refs in JSON list format Return void Location include/message_functions.

Read more...


validate_tile_style()

Description Validate the type of dash tile and check that the style provided is valid for it. Parameters Column Type Default Description $type string Tile type name.

Read more...


render_antispam_question()

Description Render the antispam Question form section Parameters This function accepts no parameters. Location include/render_functions.php lines 5739 to 5794 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 ) .

Read more...


move_featured_collection_branch_path_root()

Description Move a featured collection branch paths' root to the node determined by the global configuration option $featured_collections_root_collection. This temporarily moves the root of the featured collection branch, removing any nodes on the branch from the real root up to the new root.

Read more...


validate_build_url()

Description Sanitise the url provided when saving a dash tile. This function will take the value obtained by the form and pass it through if valid. If the url supplied is invalid, a blank value will be returned allowing the default standard tile type to be used.

Read more...


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.

Read more...


collection_add_resources()

Parameters Column Type Default Description $collection $resources '' $search '' $selected false Location include/collections_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


sign_code()

Description Returns a signature for a given block of code. Parameters Column Type Default Description $code string The code to sign Return string The signature Location include/encryption_functions.

Read more...


lang_load_site_text()

Description Load all site text for the given page and language into the global $lang array Parameters Column Type Default Description &$lang $pagename string Pagename $language string "" Language $lang array Passed by reference Return void Location include/language_functions.

Read more...


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.

Read more...


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.

Read more...


render_fa_icon_selector()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4732 tokens. Please reduce the length of the messages.

Read more...


sql_limit_with_total_count()

The article describes a utility function called `sql_limit_with_total_count()` that is used to obtain the total number of rows found while paginating the results. The function requires a deterministic order in the input query to help with performance and avoid undefined behavior.

Read more...


sort_tabs_as_configured()

The article describes a PHP function called "sort_tabs_as_configured()" that sorts a list of tab names while preserving their key ID. The function takes an array of tab ID and translated name pairs as input and returns the sorted array.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


get_cattree_nodes_ordered()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4684 tokens. Please reduce the length of the messages.

Read more...


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.

Read more...


update_smart_collection()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 7957 tokens. Please reduce the length of the messages.

Read more...


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.

Read more...


report_process_query_placeholders()

The report_process_query_placeholders() function is used to find and replace a report's query placeholders with their values. It takes two parameters: $query, which is the report's SQL query, and $placeholders, which is an array that maps between a placeholder and its actual value.

Read more...


add_sql_node_language()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, you requested 5106 tokens (4082 in the messages, 1024 in the completion). Please reduce the length of the messages or completion.

Read more...


api_validate_upload_url()

The article describes the function `api_validate_upload_url()` which is used to validate the URL supplied in APIs create resource or upload by URL. The function requires the URL hostname to be added in config `$api_upload_urls`.

Read more...


canSeeAnnotationsFields()

The canSeeAnnotationsFields() function is a helper function that determines whether annotations are to be displayed. It takes an array of annotation fields as a parameter and returns an array of annotation fields that can be viewed.

Read more...


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.

Read more...


api_assert_post_request()

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

Read more...


generate_csrf_js_object()

Description Create a CSRF token as a JS object Parameters Column Type Default Description $name: string > generateCSRFToken$GLOBALS['usersession'] ?? null escapegenerate_csrf_js_object$fct_name $name string The name of the token identifier (e.

Read more...


is_banned_extension()

Description Is the given extension in the list of blocked extensions? Also ensures extension is no longer than 10 characters due to resource.file_extension database column limit Parameters Column Type Default Description $extension: string 10}$/' $extension string - file extension to check array_map'mb_strtolower' $GLOBALS['banned_extensions'] "" Location include/file_functions.

Read more...


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.

Read more...


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.

Read more...


create_resource_type()

Description Create a new resource type with the specified name Parameters Column Type Default Description $name Name $name of new resouce type Return int| bool ref of new resource type or false if invalid data passed Location include/config_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


admin_resource_type_field_constraint()

Description Display appropriate field constraint for use on admin_resource_type_field_edit.php e.g. single select/Number Parameters Column Type Default Description $ref int $currentvalue: int array"i" 0 "schema"; Metadata int field ID Current int field type Return void * Location include/render_functions.

Read more...


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.

Read more...


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.

Read more...


is_valid_upload_path()

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

Read more...


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.

Read more...


get_resource_type_field_columns()

Parameters This function accepts no parameters. Location include/config_functions.php lines 1833 to 1885 Definition   function  get_resource_type_field_columns ()     {     global  $lang ;      $resource_type_field_column_definitions  =  execution_lockout_remove_resource_type_field_props ([          'active'                    => [ $lang [ 'property-field_active' ], '' , 1 , 1 ],          'global'                    => [ $lang [ 'property-resource_type' ], '' , 1 , 0 ],          'title'                     => [ $lang [ 'property-title' ], '' , 0 , 1 ],          'type'                      => [ $lang [ 'property-field_type' ], '' , 0 , 1 ],          'linked_data_field'         => [ $lang [ 'property-field_raw_edtf' ], '' , 0 , 1 ],          'name'                      => [ $lang [ 'property-shorthand_name' ], $lang [ 'information-shorthand_name' ], 0 , 1 ],          'required'                  => [ $lang [ 'property-required' ], '' , 1 , 1 ],          'order_by'                  => [ $lang [ 'property-order_by' ], '' , 0 , 0 ],          'keywords_index'            => [ $lang [ 'property-index_this_field' ], $lang [ "information_index_warning" ] .

Read more...


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.

Read more...


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 Return actions for all users? If false, or if the current user does not have $userref; []; // Find all resources that have changed archive state in the given number of minutes ifis_int_loose$view_title_field Return array An array with the user id as the index and the following arrays of sub elements.

Read more...


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 Array of actions as returned by get_user_actions_recent() func_get_args; $actions_resource_requests $actions_account_requests $actions_approve_hide_groups; Return array Subset of actions for the given user as would be provided by get_user_actions() Location include/action_functions.

Read more...


resource_request_visible()

Description Can the logged in user see the request specified? Parameters Column Type Default Description $request array Array of request details Return bool * Location include/request_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


compute_megapixel()

Description MP calculation Parameters Column Type Default Description $width int $height: int $ffmpeg_supported_extensions; $originalSize ?array null: string { global $lang This article was last updated 29th May 2024 13:05 Europe/London time based on the source file dated 22nd May 2024 22:15 Europe/London time.

Read more...


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.

Read more...


set_maxNumberOfFiles()

Parameters This function accepts no parameters. Location include/config_functions.php lines 1830 to 1833 Definition   function  set_maxNumberOfFiles ()     {     return  is_int_loose ( $GLOBALS [ 'upload_max_number_files' ]?? "" )? $GLOBALS [ 'upload_max_number_files' ]: 'null' ;     } This article was last updated 17th January 2024 11:05 Europe/London time based on the source file dated 2nd January 2024 18:00 Europe/London time.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


update_node_active_state()

Description Batch update nodes' active state to the database. The same state will apply to all nodes in the list. For logic on which nodes to toggle {@see toggle_active_state_for_nodes()} Parameters Column Type Default Description $refs list Node IDs $active: bool $active bool Should nodes be active or not? Location include/node_functions.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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"] Return array * Location include/resource_functions.

Read more...


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.

Read more...


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 $extra_paths array Array of additional valid source paths to check pathinfo$path && PATHINFO_DIRNAME Location include/file_functions.

Read more...


build_specialsearch_list_urls()

Description Limit the length of !list special search url by adding a maximum of 650 characters of resource references per link including separators. Mail servers may break very long text strings into multiple lines and this will cause the special search to fail.

Read more...