Search results
Full text searching
ResourceSpace has changed the way it handles long text stored in metadata fields. From version 10.1, keywords (tags) will only be processed for the first 500 characters of any text. To search the full text, there is a new option on the advanced search page that will utilise native database full-text indexing.
txt2html()
Developer reference for function txt2html()
Background information
ResourceSpace is a fully featured Digital Asset Management Solution released under an Open Source License
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.
Resource tools
The article discusses the various resource tools available in the resource downloads area of the resource view page. These tools allow users to download, view, and request resource files, as well as perform actions such as adding to a collection or sharing.
Sharing resources
Resources and Resource Collections each offer a 'Share' option which allows them to be shared with other users, as well as with non-users of the system, to allow greater flexibility of use.
Keyboard controls
ResourceSpace offers keyboard controls to help advanced users speed up their use of the platform. These controls can be customised system-wide but are not currently available for per-user customisation.
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.
Reports
ResourceSpace offers a reporting section that allows users to access information about downloads, uploads, and views. The reporting section provides a detailed table structure that can be downloaded as a CSV file for spreadsheet software or viewed directly in the browser.
User resource requests
ResourceSpace allows users to request access to restricted resources. The request mode setting on the user group determines what happens with the request. If the request mode is set to email only, an email is sent to the administration notification address containing the request details.
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.
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.
Metadata field types
This article provides a list of metadata field types that can be used to capture data in an appropriate form for communicating to users what it represents. The list includes text boxes for single-line, multi-line, large multi-line, and formatted text, as well as check box lists, drop-down lists, radio buttons, and date fields.
Modifying field options
The article explains how to modify field options in fixed list metadata fields in ResourceSpace. Users can add, remove or edit options by editing the field and selecting the "manage options" link. To add a new option, users can enter the name of the tag and click "Add".
Indexing metadata
ResourceSpace has announced that from version 10.1, indexing of text fields will be limited to the first 500 characters of text. This change is being made to enable ResourceSpace to quickly search resource metadata, rather than the full file contents.
Creating users
This article provides a step-by-step guide on how to create a user account in a system. It explains that user accounts require user groups to be created first, as user permissions and configuration settings are managed in the groups.
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.
Useful user tools
ResourceSpace provides several user management tools to help with the user configuration process. The first tool is resetting passwords, which can be done by browsing to Admin > Users, editing the user, entering a password into the password field or clicking "Suggest" to generate one, and clicking Save.
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.
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.
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_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.
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.
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.
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 .
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 LDAP
The Simple LDAP plugin enables consistent sign-on (CSO) for ResourceSpace users, allowing them to log in using the same credentials they use to log in to their organisation's network. The plugin has been tested with Microsoft Active Directory and Oracle Directory servers.
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.
Simple SAML
This plugin allows users to log on to ResourceSpace using a SAML compliant single sign-on (SSO) Identity Provider (IdP)
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.
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.
How to back up your ResourceSpace installation
Ensure that your ResourceSpace open source Digital Asset Management system has appropriate backups in place.
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.
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.
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.
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.
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.
All user permissions
ResourceSpace is a digital asset management system that allows users to control which resources other users can see and how they can interact with them. The system offers a range of permission options, including search, metadata fields, resource types, resource creation, featured collections, restrictive permissions, and administration.
TMS link
Help for setting up the tms_link plugin.
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.
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.
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.
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.
How to restore your ResourceSpace installation
This article provides guidance on how to restore a ResourceSpace installation to a replacement server in the event of server failure or migration. The steps described in the article restore the existing ResourceSpace configuration, but do not cover custom ResourceSpace code, external directories used by ResourceSpace, DNS changes, or web or proxy server configuration.
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.
Extracted text
ResourceSpace, a digital asset management software, can extract text from document files and use it to populate metadata fields. This feature enables users to search for resource contents within the system and by applied metadata tags.
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.
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.
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.
Messaging
The article provides instructions on how to view and send messages on a website. To view messages, users need to click on the user profile icon and select "Messages". Messages are listed in date order, newest first, and users can mark them as read, delete them, or reply to them.
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.
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.
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.
Integrating ResourceSpace with RightMarket
Create branded marketing materials, including posters, social graphics or point of sale materials, with ResourceSpace's RightMarket integration.
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.
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.
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.
User rating of resources
ResourceSpace has a star rating feature that allows each user to give resources a rating of between one and five stars. User rating of resources can be enabled by super admins in the configuration area via admin, system, configuration, user accounts and enabling "user rating of resources".
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.
A Comprehensive Guide to Digital Curation: Tools and Techniques
Explore digital curation: key tools and techniques for preserving significant cultural assets.
How do I change the welcome message?
The article discusses how to change the welcome message on a website or application. It explains that the welcome message is the first thing users see when they visit a website or open an app, and it sets the tone for their experience.
Is it the same process to make a batch upload as it is to add a single resource?
The article explains that the process for uploading resources in batches is the same as uploading them individually. Users can click on the "Upload" button to start uploading resources. Additionally, users have the option to upload one or more resources directly into a collection by selecting the collection in the lightbox area and choosing "Upload to this collection" from the Actions menu.
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.
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).
Metadata report
The article discusses the importance of metadata in ResourceSpace for efficient resource management. It highlights the use of the metadata report to review embedded metadata in resources and map them into ResourceSpace metadata templates.
Supported file formats
Supported file formats
consentmanager_batch_link_unlink
The "consentmanager_batch_link_unlink" function allows for linking or unlinking all resources in a collection with a consent record. It requires the ID of the consent record ($consent), the ID of the collection containing the resources to process ($collection), and a parameter ($unlink) to specify whether to unlink or link the resources.
consentmanager_link_consent
The article discusses the function consentmanager_link_consent, which is used to link a consent record with a resource. It requires two variables: $consent, which is the ID of the consent record to be linked, and $resource, which is the ID of the resource to which the consent is being linked.
consentmanager_unlink_consent
The article describes the function `consentmanager_unlink_consent`, which is used to unlink a consent record from a specific resource. The function requires two parameters: `$consent` (the ID of the consent record to unlink) and `$resource` (the ID of the resource from which to unlink the consent).
consentmanager_update_consent
The article provides information on the function `consentmanager_update_consent`, which is used to update a consent record. It outlines the variables required for this function, including `$consent` (ID of the consent record), `$name` (name of the individual giving consent), `$email` (email address of the individual), `$telephone` (telephone number of the individual), `$consent_usage` (description of intended usage for consent), `$notes` (additional notes related to the consent record), and `$expires` (expiry date of the consent).
CLIP AI Smart Search
The CLIP Visual Search plugin integrates OpenAI's CLIP model into ResourceSpace, enabling powerful visual similarity and natural language image searches based on image content rather than metadata. Features include natural language description searches, finding visually similar images by uploading examples, and detecting duplicates based on visual similarity scores.
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.
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.
delete_comment
The "delete_comment" function allows for the removal of resource comments by specifying the comment reference. If the comment is part of a hierarchical structure with comments below it, it will be hidden and marked as "Deleted" until lower level items are removed.
Table: comment
This article provides a table schema for the ResourceSpace software's comment feature. The table is called "comment" and contains columns such as "ref" (an auto-incrementing index), "ref_parent" (the reference of the parent comment), "created" (the timestamp of when the comment was created), "hide" (a boolean value indicating whether the comment should be hidden), "collection_ref" (the reference of the collection the comment is associated with), "resource_ref" (the reference of the resource the comment is associated with), "user_ref" (the reference of the user who created the comment), "fullname" (the full name of an external commenter), "email" (the email of an external commenter), "website_url" (the website URL of an external commenter), and "body" (the text of the comment).
Table: dash_tile
The article provides a table schema for the "dash_tile" table, which is used to display dash tiles on the home page. The table contains columns such as "ref" for an auto-incrementing index, "title" for the title text, "txt" for the tile text, "all_users" to indicate if the tile is published to all users, "default_order_by" for the default order, "url" for the anchor link href URL, "link" for the link text, "reload_interval_secs" for the reload interval in seconds, "resource_count" to indicate the number of resources if the tile is a search/collection tile, and "allow_delete" to indicate if the tile can be deleted.
Table: job_queue
The job_queue table is a list of active offline jobs such as preview processing. It contains several columns, including ref, which is an auto-incrementing index, type, which is the job type, job_data, which is the JSON-encoded job data, start_date, which is the earliest time to start the job, user, which is the user ID, status, which is the job status code, success_text, which is the text to include in the message if the job completes successfully, failure_text, which is the text to include in the message if the job fails, job_code, which is a unique hash used to prevent duplicate jobs, and priority, which is the job priority.
Table: keyword
Table: keyword
Table: report
Table: report
Table: request
The "request" table is a database table in ResourceSpace that tracks resource requests made by users with restricted access and fulfilled by admin users. The table has several columns, including "ref," which is an auto-incrementing index, "user," which refers to the user who made the request, and "collection," which refers to the collection the requested resource belongs to.
Table: resource_log
The resource_log table is used to log all activity related to a resource in ResourceSpace. It contains an auto-incrementing index, the date the log was recorded, the user who performed the action, the resource that was affected, the type of log, and any notes related to the log.
Table: resource_type_field
Table: resource_type_field
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.
Table: usergroup
The article provides a table called "usergroup" that defines user groups. The table contains several columns, including "ref," which is an auto-incrementing index, "name," which is the name of the user group, and "permissions," which is a list of permissions that the user group has.
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.
get_user_actions()
Developer reference for function get_user_actions()
getAnnotoriousResourceAnnotations()
Developer reference for function getAnnotoriousResourceAnnotations()
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()
Developer reference for function get_collection()
search_public_collections()
Developer reference for function search_public_collections()
index_collection()
Developer reference for function index_collection()
save_collection()
Developer reference for function save_collection()
get_search_title()
Developer reference for function get_search_title()
send_collection_feedback()
Developer reference for function send_collection_feedback()
get_collection_log()
Developer reference for function get_collection_log()
compile_collection_actions()
Developer reference for function compile_collection_actions()
get_last_resource_edit()
Developer reference for function get_last_resource_edit()
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_archive_command()
Developer reference for function collection_download_process_archive_command()
comments_submit()
Developer reference for function comments_submit()
comments_show()
Developer reference for function comments_show()
config_process_file_input()
Developer reference for function config_process_file_input()
get_header_image()
Developer reference for function get_header_image()
generateResourcesMetadataCSV()
Developer reference for function generateResourcesMetadataCSV()
generateNodesExport()
Developer reference for function generateNodesExport()
create_dash_tile()
Developer reference for function create_dash_tile()
update_dash_tile()
Developer reference for function update_dash_tile()
get_tile()
Developer reference for function get_tile()
existing_tile()
Developer reference for function existing_tile()
cleanup_dash_tiles()
Developer reference for function cleanup_dash_tiles()
checkConfigCustomHomePanels()
Developer reference for function checkConfigCustomHomePanels()
get_alluser_available_tiles()
Developer reference for function get_alluser_available_tiles()
get_usergroup_available_tiles()
Developer reference for function get_usergroup_available_tiles()
get_user_available_tiles()
Developer reference for function get_user_available_tiles()
build_dash_tile_list()
Developer reference for function build_dash_tile_list()
allow_tile_colour_change()
Developer reference for function allow_tile_colour_change()
render_dash_tile_colour_chooser()
Developer reference for function render_dash_tile_colour_chooser()
prepareFaceImage()
Developer reference for function prepareFaceImage()
faceRecognizerPredict()
Developer reference for function faceRecognizerPredict()
get_checksum()
Developer reference for function get_checksum()
nicedate()
Developer reference for function nicedate()
tidy_trim()
Developer reference for function tidy_trim()
send_mail()
Developer reference for function send_mail()
send_mail_phpmailer()
Developer reference for function send_mail_phpmailer()
get_temp_dir()
Developer reference for function get_temp_dir()
get_utility_path()
Developer reference for function get_utility_path()
get_executable_path()
Developer reference for function get_executable_path()
job_queue_get_jobs()
Developer reference for function job_queue_get_jobs()
strip_tags_and_attributes()
Developer reference for function strip_tags_and_attributes()
remove_accents()
Developer reference for function remove_accents()
message_get()
Developer reference for function message_get()
message_add()
Developer reference for function message_add()
message_send_unread_emails()
Developer reference for function message_send_unread_emails()
get_export_tables()
Developer reference for function get_export_tables()
delete_node()
Developer reference for function delete_node()
get_resource_nodes()
Developer reference for function get_resource_nodes()
get_node_by_name()
Developer reference for function get_node_by_name()
get_tree_strings()
Developer reference for function get_tree_strings()
generate_pdf()
Developer reference for function generate_pdf()
process_template()
Developer reference for function process_template()
process_if_statements()
Developer reference for function process_if_statements()
activate_plugin()
Developer reference for function activate_plugin()
get_plugin_yaml()
Developer reference for function get_plugin_yaml()
config_single_user_select()
Developer reference for function config_single_user_select()
config_multi_user_select()
Developer reference for function config_multi_user_select()
display_field()
Developer reference for function display_field()
renderBreadcrumbs()
Developer reference for function renderBreadcrumbs()
display_field_data()
Developer reference for function display_field_data()
get_request()
Developer reference for function get_request()
get_user_requests()
Developer reference for function get_user_requests()
save_request()
Developer reference for function save_request()
get_requests()
Developer reference for function get_requests()
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()
send_research_request()
Developer reference for function send_research_request()
get_resource_path()
Developer reference for function get_resource_path()
save_resource_data()
Developer reference for function save_resource_data()
save_resource_data_multi()
Developer reference for function save_resource_data_multi()
update_field()
Developer reference for function update_field()
get_resource_log()
Developer reference for function get_resource_log()
get_themes_by_resource()
Developer reference for function get_themes_by_resource()
stripMetadata()
Developer reference for function stripMetadata()
write_metadata()
Developer reference for function write_metadata()
update_resource()
Developer reference for function update_resource()
process_notify_user_contributed_submitted()
Developer reference for function process_notify_user_contributed_submitted()
get_resource_access()
Developer reference for function get_resource_access()
resource_download_allowed()
Developer reference for function resource_download_allowed()
get_edit_access()
Developer reference for function get_edit_access()
get_resource_collections()
Developer reference for function get_resource_collections()
reindex_resource()
Developer reference for function reindex_resource()
get_page_count()
Developer reference for function get_page_count()
get_original_imagesize()
Developer reference for function get_original_imagesize()
generate_resource_access_key()
Developer reference for function generate_resource_access_key()
get_video_info()
Developer reference for function get_video_info()
get_last_resource_edit_array()
Developer reference for function get_last_resource_edit_array()
filter_check()
Developer reference for function filter_check()
get_field_options()
Developer reference for function get_field_options()
add_verbatim_keywords()
Developer reference for function add_verbatim_keywords()
get_resource_lock_message()
Developer reference for function get_resource_lock_message()
search_form_to_search_query()
Developer reference for function search_form_to_search_query()
search_special()
Developer reference for function search_special()
cleanse_string()
Developer reference for function cleanse_string()
update_search_from_request()
Developer reference for function update_search_from_request()
get_slideshow_image_file_path()
Developer reference for function get_slideshow_image_file_path()
get_usergroups()
Developer reference for function get_usergroups()
resolve_userlist_groups()
Developer reference for function resolve_userlist_groups()
resolve_userlist_groups_smart()
Developer reference for function resolve_userlist_groups_smart()
make_username()
Developer reference for function make_username()
open_access_to_user()
Developer reference for function open_access_to_user()
open_access_to_group()
Developer reference for function open_access_to_group()
verify_antispam()
Developer reference for function verify_antispam()
existing_dash_tile()
Developer reference for function existing_dash_tile()
show_upgrade_in_progress()
Developer reference for function show_upgrade_in_progress()
job_queue_get_job()
Developer reference for function job_queue_get_job()
get_featured_collection_resources()
Developer reference for function get_featured_collection_resources()
process_posted_featured_collection_categories()
Developer reference for function process_posted_featured_collection_categories()
render_featured_collection_category_selector()
Developer reference for function render_featured_collection_category_selector()
get_inner_html_from_tag()
Developer reference for function get_inner_html_from_tag()
get_resource_nodes_batch()
Developer reference for function get_resource_nodes_batch()
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.
Frequently Asked Questions (FAQs)
The most frequently asked questions about ResourceSpace, the free and open source Digital Asset Management system.
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.
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.
render_question_form_helper()
Description Render a FormHelper. These are used in forms, to provide extra information to the user to a question. Parameters Column Type Default Description $txt string Help text $id string Div ID $ctx array Contextual data Location include/render_functions.
render_message()
Parameters Column Type Default Description $message "" Location include/render_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.
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.
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.
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.
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.
fetch_assoc_stmt()
Description Fetches the results of a prepared statement as an array of associative arrays such that each stored array is keyed by the result's column names. Parameters Column Type Default Description $stmt \mysqli_stmt $buffer true $fetchrows -1 Must stmt have been successfully prepared and executed prior to calling this function Whether buffer to buffer the result set; if true, results are freed at end of function The fetchrows maximum numbers of rows to return; results will be truncated if necessary Return An array, possibly empty, containing one associative array per result row OR true if there was no result set.
try_unlink()
Description Try and delete a file without triggering a fatal error Parameters Column Type Default Description $deletefile string Full path to file Return bool|string Returns TRUE on success or a string containing error This article was last updated 28th July 2026 13:35 Europe/London time based on the source file dated 27th July 2026 10:20 Europe/London time.
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.
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.
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_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.
remove_empty_temp_directory()
The remove_empty_temp_directory() function is used to remove an empty folder from the path to a file. It is particularly useful for removing temporary directories that are no longer needed once the file they were created to hold no longer exists.
order_tree_nodes()
order_tree_nodes()
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`.
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.
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.
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.
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_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.
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.
TOTP (MFA via Google Authenticator)
The article introduces TOTP (Time-Based One-Time Password) as a plugin for enabling two-factor authentication (2FA) for selected user groups, adding an extra layer of security by requiring a temporary code along with the user's password.
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.
build_range_where_condition()
Description Build a SQL WHERE fragment and bound parameters from a list of integers and ranges. Parses a comma-separated input string containing single integers and/or ranges and can take optional wildcards (e.
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_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.
convert_search_form_date_to_search_query()
Description Utility converter between sumitted date input and ResourceSpace search query Parameters Column Type Default Description $field array $ctx array []: string { if !in_array$field['type'] $GLOBALS['DATE_FIELD_TYPES'] int, array{ref: name: string, type: int} $field Field information relevant for the submitted data string} array{html_field_name?: $ctx Return string The constructed search query string (based on the input/submitted data).
get_smart_fc_branch_trail()
Description Helper function for smart featured collections to update $branch_trail with all parent nodes of the selected node Parameters Column Type Default Description $node int Node selected $tree_node_level int Current level of node in tree $field_data array Array of the smart featured collections field data $general_url_params array URL parameters to use with generated href links $branch_trail array get_all_ancestors_for_node$node Partial array of links to use for renderBreadcrumbs(), only includes the highest level link $tree_node_level; array; if is_array$all_node_parents Return array $branch_trail Full array of parent nodes and field links Location include/render_functions.