Search

Search results

ResourceSpace Plugins

Explore the range of plugins that are available to expand ResourceSpace's base functionality, including integrations with third party software and systems.

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

Managing plugins

ResourceSpace is a digital asset management system that can be extended or modified using plugins. Plugins have a managed structure that makes it easy for third parties to write and for site administrators to maintain, even as function and bug fixes are applied to the base code.

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.

Table: plugins

The article provides a table named "plugins" that lists all active plugins on the system and stores their configuration. The table has several columns, including name, descrip, author, update_url, info_url, inst_version, config, config_json, config_url, enabled_groups, priority, disable_group_select, title, and icon.

activate_plugin()

Developer reference for function activate_plugin()

deactivate_plugin()

Developer reference for function deactivate_plugin()

purge_plugin_config()

Developer reference for function purge_plugin_config()

get_plugin_yaml()

Developer reference for function get_plugin_yaml()

get_plugin_config()

Developer reference for function get_plugin_config()

set_plugin_config()

Developer reference for function set_plugin_config()

is_plugin_activated()

Developer reference for function is_plugin_activated()

get_plugin_css()

Developer reference for function get_plugin_css()

plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

include_plugin_config()

Developer reference for function include_plugin_config()

register_plugin_language()

Developer reference for function register_plugin_language()

get_plugin_path()

Developer reference for function get_plugin_path()

register_plugin()

Developer reference for function register_plugin()

plugin_encode_complex_configs()

Description Encode complex plugin configuration (e.g mappings defined by users on plugins' setup page) Parameters Column Type Default Description $c mixed Configuration requiring encoding Return string Location include/plugin_functions.

plugin_decode_complex_configs()

Description Decode complex plugin configuration (e.g mappings defined by users on plugins' setup page) Parameters Column Type Default Description $b64sc string Configuration encoded prior with {@see plugin_encode_complex_configs()} Return mixed Location include/plugin_functions.

get_active_plugins()

Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 388 to 391 Definition function get_active_plugins () { return ps_query ( 'SELECT name, enabled_groups, config, config_json FROM plugins WHERE inst_version >= 0 ORDER BY priority' , array(), 'plugins' ); } This article was last updated 21st December 2024 14:35 Europe/London time based on the source file dated 16th December 2024 16:10 Europe/London time.

register_group_access_plugins()

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

RenderPlugin()

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

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.

Editing resource previews

Resource previews are an important aspect of ResourceSpace as they are the first contact users have with resources and help them decide which assets to use. If previews are missing, they should be remedied after upload.

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.

Homepage slideshow

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

Further videos

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

Image tools

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

get_system_status

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

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.

Integrating with Uppy Companion

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

New to ResourceSpace?

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

User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Knowledge Base structure

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

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.

Featured & public collections

Featured Collections are a way to showcase the best and most in-demand content. They can contain a select number of resources and encourage users to browse content by directing them to relevant tags or ideas.

Editing multiple resources

The article explains how to edit multiple resources in ResourceSpace using batch editing. Batch editing allows users to apply the same change to multiple resources at once, ensuring continuity. To perform a batch edit, users need to add the selected resources to a collection and then choose "Edit all resources" from the collection actions list.

Annotate

The article discusses the Annotate feature that allows users to add annotations to a resource and connect them to a part of the resource preview. The annotations could include names or features of note within an image.

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.

PDF split

This article describes a tool that allows users to split PDF files into multiple pages. The tool can be used to create separate resources or alternatives to the original PDF resource. To use the tool, users must browse to a PDF resource and click on "PDF Split" in Resource Tools.

Propose changes

The article explains how users who cannot edit a resource can propose changes to its metadata to administrators. The administrators can then approve or reject these changes. To submit a change, the user must navigate to a resource page and click "Propose Changes" in Resource Tools.

Refine results

The article discusses the addition of a filter bar above search results to allow for further filtering within the result set. This feature allows users to type in more relevant keywords and extra information into the "further results" field to keep filtering results.

Video splice

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

Youtube publish

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

Admin overview

Accessible from the top navigation bar, the Admin menu provides a whole range of tools to help manage ResourceSpace and its contents.

Batch replace

ResourceSpace has a batch replace functionality that allows users to update multiple resources at once. This feature is useful for replacing original files and regenerating previews of any number of resources.

Creating and deleting metadata fields

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

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

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.

CSV upload

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

Advanced workflow

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

Watched searches

The 'rse_search_notifications' plugin enables the functionality of watched searches, which allows users to subscribe to any search result or set of resources, such as a collection. The system will then notify the user when resources are added or edited to match the result set.

Video tracks

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

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.

Configuring php.ini

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

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

Simple SAML

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

Antivirus

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

Google VR View

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

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.

Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

Falcon link

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

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.

resource_log_last_rows

adding information on the log codes recorded in the type field

Image banks

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

Cookies notification

The cookies_notification plugin is a tool that can be activated under Plugins via the System menu. It creates a header on the login page to notify users that their activity will be tracked via cookies.

TMS link

Help for setting up the tms_link plugin.

Logs

ResourceSpace has a log that records the actions of each user, which is accessible in the Users section of the Admin area. The logs record the date and time of user logins, resources they have created, deleted and downloaded, and edits they have made to resources, showing both the previous and new values.

Offline job queues

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

Adobe link

This plugin allows you to import files from ResourceSpace directly into Adobe InDesign and Photoshop.

Format chooser

This plugin allows you to choose different formats when downloading files which are generated on the fly.

Image text

The Image Text plugin enables metadata fields to be included as captions when a resource is downloaded. The plugin can be configured to apply captions to specific resource types and file extensions, and to extract text from a chosen field, such as the title.

Grant edit

The Grant Edit plugin allows administrators to grant edit access to a user or user group for the metadata of a resource they would not normally have permission to edit. Plugin settings determine which user group has the ability to grant edit access to the resource and to remove access previously granted.

Google Analytics

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

MuseumPlus

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

Version control

The rse_version plugin is a version control tool that can be activated by default via config.php. It enables the functionality to revert both individual and batch edits from the resource log page. The plugin can also revert collection states for adding or removing resources, which is useful when a user accidentally removes all resources from a collection.

Conditional terms

Montala has launched a plugin that enables users to make acceptance of terms and conditions necessary prior to downloading certain resources based on their metadata. The plugin configuration allows users to select a metadata field value which, when met, will require the terms to be accepted.

Meta append

The Meta Append plugin allows users to add a timestamp and daily upload number to each resource they contribute. The plugin automatically applies the user-defined timestamp and upload number to the selected field, which can be configured in the plugin settings.

Resource bot

The Resource Bot plugin is a new feature that integrates Chat Bot functionality from the main ResourceSpace website with your ResourceSpace installation. This plugin provides on-hand assistance for your users and offers support for those who are less confident.

Resource usage

The Resource Usage plugin enables users to keep a log of how a resource has been used, along with the usage medium, such as print or TV. Once enabled, a new section is added to the bottom of the resource view page, where users can click "New usage" to create a new record of where the resource was used.

Auto assign

The autoassign_mrequests plugin enables managed resource requests to be automatically assigned to a specific user for approval, based on a metadata field value mapping. The user to which the request is assigned must be in a user group able to access the admin area and with the permissions to manage requests and to be assigned resource requests.

3. File sizes and formats

When we click on a resource we are shown all the available metadata for that resource, and also a list of available versions.

Feedback

The Feedback plugin adds a user feedback function to the header for all users. Once enabled, users will be prompted to answer a configurable feedback form, and responses to these forms are stored in a CSV file inside the feedback plugin folder on the server.

Wordpress_SSO

The Wordpress_SSO plugin enables users to log in to ResourceSpace using Wordpress single sign-on (SSO) Identity Provider (IdP). However, the plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace.

replace_resource_file

The article describes the function 'replace_resource_file' which replaces the primary resource file for a given resource. The function requires the ID of the resource to replace the file for and the file path or URL of the file to use as the replacement.

Track field history

The track field history plugin is a tool that allows users to easily view the history of metadata for a resource by breaking it down by field. Users can select which fields to track and a History link will be placed next to those fields on the resource details panel of the resource view page.

Remote assist

The article discusses a new plugin that has been developed to extend the home page welcome text area of ResourceSpace. The plugin is called Remote Assist and it displays various help links for using ResourceSpace.

Injection

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

Vimeo publish

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

Database schema

Database schema for ResourceSpace.

Project structure

A breakdown of the folders used within ResourceSpace, and their typical contents and function.

Fixed list fields

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

Sensitive image blurring

The sensitive image blurring plugin can blur selected images from users both in the results and on the resource view page. The plugin can be configured by enabling it and choosing a desired field for the "sensitive message" in the plugin's options page.

ResourceSpace software design principles

ResourceSpace, an open-source digital asset management software, has outlined its design principles for developers. The principles include the KISS (Keep It Simple Stupid) principle, which advises against implementing complex solutions when a simple one will suffice, and avoiding introducing new technology when existing technology will suffice.

RSS Feed

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

Configuring Leaflet Maps

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

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.

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.

System reset

The article describes the use of the System Reset plugin in ResourceSpace, which allows users to completely reset their installation by deleting all files and data. To activate the plugin, users must select System then Plugins from the top right menu, and then select the System Reset option from the System menu.

User actions

User actions are now enabled for all users by default, unless disabled by a system administrator. Actions alert users to resources or activities that require their attention, and the actions visible to a user will vary depending on system configuration and user permissions.

Subtitles for Video Preview

ResourceSpace has added a new feature that allows subtitles to be included when previewing video resources. Once configured, users can select the subtitle track from the player controls when playing a video resource preview.

Managing resource requests notifications

Resource requests notifications in ResourceSpace v10+ can now be managed using a metadata field value. The metadata field is designated to hold information that the system can use to determine the user group responsible for a resource.

API Webhooks

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

Video timestamp links

The article discusses a plugin that enables the use of timestamp links on videos in ResourceSpace. The plugin allows users to bookmark specific points in a video and add them to an appropriate metadata field, such as a caption or long description field.

OpenAI GPT

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

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

A Comprehensive Guide to Digital Curation: Tools and Techniques

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

Navigating Consent and Digital Asset Management

Discover how your organisation can navigate consent and Digital Asset Management (DAM), including ensuring legal compliance and protecting user privacy.

LinkrUI for Adobe

LinkrUI for Adobe is a Connector plugin that integrates ResourceSpace with Adobe software such as Photoshop, Illustrator, InDesign, Premiere Pro, and After Effects. This integration allows users to easily search, open, and place assets stored in ResourceSpace directly into their Adobe applications.

StencilVG

StencilVG is a plugin that allows users to generate new documents using SVG template files with placeholder values. Users can create template SVG files by adding text placeholders surrounded by square brackets.

OpenAI Image Editing

The OpenAI image editing plugin is integrated with DALL-E 2 to enable AI image editing within ResourceSpace. Users can access the editing option in the resource tools on the resource view page. The plugin requires the OpenAI GPT plugin to be enabled with a valid key.

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

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.

config_register_core_fieldvars()

Developer reference for function config_register_core_fieldvars()

Frequently Asked Questions (FAQs)

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

YT2RS (Youtube embed)

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

VM2RS (Vimeo embed)

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

get_collection_resources()

Developer reference for function get_collection_resources()

get_theme_image()

Developer reference for function get_theme_image()

compile_collection_actions()

Developer reference for function compile_collection_actions()

get_last_resource_edit()

Developer reference for function get_last_resource_edit()

config_text_input()

Developer reference for function config_text_input()

config_colouroverride_input()

Developer reference for function config_colouroverride_input()

config_single_select()

Developer reference for function config_single_select()

config_boolean_select()

Developer reference for function config_boolean_select()

config_single_ftype_select()

Developer reference for function config_single_ftype_select()

check_db_structs()

Developer reference for function check_db_structs()

txt2html()

Developer reference for function txt2html()

job_queue_run_job()

Developer reference for function job_queue_run_job()

hook()

Developer reference for function hook()

debug()

Developer reference for function debug()

sha256()

Developer reference for function sha256()

get_export_tables()

Developer reference for function get_export_tables()

config_json_encode()

Developer reference for function config_json_encode()

config_encode()

Developer reference for function config_encode()

handle_rsc_upload()

Developer reference for function handle_rsc_upload()

display_rsc_upload()

Developer reference for function display_rsc_upload()

config_gen_setup_post()

Developer reference for function config_gen_setup_post()

config_gen_setup_html()

Developer reference for function config_gen_setup_html()

config_section_header()

Developer reference for function config_section_header()

config_add_section_header()

Developer reference for function config_add_section_header()

config_add_text_list_input()

Developer reference for function config_add_text_list_input()

config_multi_select()

Developer reference for function config_multi_select()

config_add_multi_select()

Developer reference for function config_add_multi_select()

config_single_user_select()

Developer reference for function config_single_user_select()

config_add_single_user_select()

Developer reference for function config_add_single_user_select()

config_multi_user_select()

Developer reference for function config_multi_user_select()

config_add_multi_user_select()

Developer reference for function config_add_multi_user_select()

config_single_group_select()

Developer reference for function config_single_group_select()

config_add_single_group_select()

Developer reference for function config_add_single_group_select()

config_multi_group_select()

Developer reference for function config_multi_group_select()

config_add_multi_group_select()

Developer reference for function config_add_multi_group_select()

config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

config_add_multi_ftype_select()

Developer reference for function config_add_multi_ftype_select()

config_single_rtype_select()

Developer reference for function config_single_rtype_select()

config_add_single_rtype_select()

Developer reference for function config_add_single_rtype_select()

config_multi_rtype_select()

Developer reference for function config_multi_rtype_select()

config_add_multi_rtype_select()

Developer reference for function config_add_multi_rtype_select()

config_db_single_select()

Developer reference for function config_db_single_select()

config_add_db_single_select()

Developer reference for function config_add_db_single_select()

config_db_multi_select()

Developer reference for function config_db_multi_select()

config_add_db_multi_select()

Developer reference for function config_add_db_multi_select()

config_add_hidden()

Developer reference for function config_add_hidden()

config_text_field()

Developer reference for function config_text_field()

config_userselect_field()

Developer reference for function config_userselect_field()

config_field_select()

Developer reference for function config_field_select()

config_boolean_field()

Developer reference for function config_boolean_field()

config_custom_select_multi()

Developer reference for function config_custom_select_multi()

config_custom_select()

Developer reference for function config_custom_select()

render_actions()

Developer reference for function render_actions()

render_custom_fields()

Developer reference for function render_custom_fields()

managed_collection_request()

Developer reference for function managed_collection_request()

process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

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

resource_log()

Developer reference for function resource_log()

get_edit_access()

Developer reference for function get_edit_access()

get_last_resource_edit_array()

Developer reference for function get_last_resource_edit_array()

get_nopreview_icon()

Developer reference for function get_nopreview_icon()

get_download_filename()

Developer reference for function get_download_filename()

delete_resource_type_field()

Developer reference for function delete_resource_type_field()

compile_search_actions()

Developer reference for function compile_search_actions()

search_filter()

Developer reference for function search_filter()

search_special()

Developer reference for function search_special()

get_default_search_states()

Developer reference for function get_default_search_states()

config_multi_archive_select()

Developer reference for function config_multi_archive_select()

config_add_multi_archive_select()

Developer reference for function config_add_multi_archive_select()

render_featured_collection()

Developer reference for function render_featured_collection()

DrawOption()

Developer reference for function DrawOption()

config_add_hidden_input()

Description Generate a data structure to instruct the configuration page generator to add a hidden input Parameters Column Type Default Description $cf_var_name string Plugins' configuration variable name $cf_var_value string '' Value Return array Location include/config_functions.

config_register_core_field_refs()

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

leaflet_markers_legend()

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

get_geolibraries()

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

get_geo_maps_scripts()

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

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.

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.

allow_in_browser()

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

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.

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.

columns_in()

The `columns_in()` function is a PHP function used in ResourceSpace, a digital asset management system. It returns a comma-separated list of table columns from a given table, with the option to use an alias instead of the table name to prefix the columns.

process_resource_data_joins_values()

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

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.

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.

generate_videojs_options()

Description Generate JSON array of VideoJS options to be used in the data-setup attribute Parameters Column Type Default Description $view_as_gif bool True if the video is a GIF file $play_on_hover bool True if playing video on hover $video_preview_sources array Array of preview sources, including URL, type and label Return string|false Location include/video_functions.

render_resource_tools_size_download_options()

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

Brand Guidelines (v10.5+)

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

generateConsistentColour()

Description Generate a consistent HSL-based colour with a fixed brightness and saturation, but a random hue. This function hashes the input key (e.g., plugin name) to determine the hue, while keeping the saturation and brightness fixed.