Search results


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


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.

Read more...


ResourceSpace Plugins

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

Read more...


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.

Read more...


get_active_plugins()

Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 362 to 365 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 29th March 2024 08:35 Europe/London time based on the source file dated 28th March 2024 11:25 Europe/London time.

Read more...


New to ResourceSpace?

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

Read more...


User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Read more...


Knowledge Base structure

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

Read more...


Open source

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

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


Creating featured collections

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

Read more...


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.

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


 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.

Read more...


Admin overview

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

Read more...


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.

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


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.

Read more...


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

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


 Advanced user group options

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

Read more...


 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.

Read more...


Advanced workflow

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

Read more...


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.

Read more...


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.

Read more...


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.

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


 StaticSync - keep your files in situ

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

Read more...


Watermarks

ResourceSpace allows users to enable watermarks on preview images generated for each resource. To enable watermark preview generation, users need to add the following to their config.php: $watermark = "gfx/watermark.

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


Simple SAML

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

Read more...


Facial recognition

Open source digital asset management software, ResourceSpace, has integrated facial recognition technology via OpenCV, an open source computer vision and machine learning software library. The ResourceSpace annotate feature has been used to create the association between a fixed list field and a face.

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


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.

Read more...


Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

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


Migrating free text data to fixed list field options

The article explains how to migrate free text data to fixed list field options when changing a metadata field type from a free text field to a fixed option field type. The fixed option field types include checkbox, radio button, dropdown, and dynamic tag list.

Read more...


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

Read more...


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.

Read more...


 Smart collections

Smart collections are a new feature that can be enabled in a system by using the config option $allow_smart_collections. Once enabled, a new option will appear in the Actions drop-down menu on the Search page, allowing users to save a search as a smart collection.

Read more...


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.

Read more...


 Adobe link

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

Read more...


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.

Read more...


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.

Read more...


Coding standards v1.3

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

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


Context help links

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

Read more...


 Site content

All text strings in ResourceSpace can be customised from the Manage content area.

Read more...


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


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.

Read more...


Checksums

Checksums are a sequence of numbers and letters that are produced by running a file through an algorithm that uses a cryptographic hash to create a unique identifier. Even the slightest change in the original file will produce a different checksum, making them useful for ensuring file integrity and preventing resource duplication.

Read more...


 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.

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


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.

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


Database schema

Database schema for ResourceSpace.

Read more...


Project structure

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

Read more...


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.

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


 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.

Read more...


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.

Read more...


Modals

Calling and using modals

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


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.

Read more...


Signing all database PHP code

From version 10.0, any PHP code stored in the database and manipulated via the user interface must be signed using a command line utility. This is to prevent system compromise by a user that has gained administrator access.

Read more...


 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.

Read more...


 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.

Read more...


What is Digital Asset Management?

Explore the world of Digital Asset Management (DAM) and its pivotal role in organising and securing digital assets. Dive into its benefits, practical applications, and how it streamlines the asset management process.

Read more...


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

Read more...


Setting up scheduled tasks/cron

To ensure that ResourceSpace can send notifications and perform regular tasks, it is necessary to set up scheduled tasks or cron jobs. These tasks should be configured to run at least once daily, but may need to run more frequently depending on certain configuration options.

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

Read more...


Table: resource_alt_files

The article provides information about the "resource_alt_files" table in ResourceSpace, which is used to store alternative files for a resource. The table contains columns such as "ref" (an auto-incrementing index), "resource" (a reference to the main resource), "name" (the name of the alternative file), "description" (a description of the alternative file), "file_name" (the name of the file), "file_extension" (the file extension), "file_size" (the size of the file), "creation_date" (the date the file was created), "unoconv" (a flag indicating whether the file has been processed by ResourceSpace's unoconv extension), "alt_type" (the type of alternative file), and "page_count" (the total number of pages in a multi-page document).

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

This article provides information about the "tab" table, which is used for organising metadata fields on the edit and view pages. The table has three columns: "ref", which is an auto-incrementing index; "name", which is a varchar(255) type; and "order_by", which is an integer type.

Read more...


OpenCV (facial recognition)

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

Read more...


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.

Read more...


getResourceAnnotationsCount()

Developer reference for function getResourceAnnotationsCount()

Read more...


iiif_get_canvases()

Developer reference for function iiif_get_canvases()

Read more...


refresh_collection_frame()

Developer reference for function refresh_collection_frame()

Read more...


email_collection()

Developer reference for function email_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...


comments_show()

Developer reference for function comments_show()

Read more...


config_text_input()

Developer reference for function config_text_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_single_ftype_select()

Developer reference for function config_single_ftype_select()

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


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


generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

Read more...


pager()

Developer reference for function pager()

Read more...


job_queue_run_job()

Developer reference for function job_queue_run_job()

Read more...


pagename()

Developer reference for function pagename()

Read more...


setLanguage()

Developer reference for function setLanguage()

Read more...


set_login_cookies()

Developer reference for function set_login_cookies()

Read more...


message_send_unread_emails()

Developer reference for function message_send_unread_emails()

Read more...


mix_url()

Developer reference for function mix_url()

Read more...


get_export_tables()

Developer reference for function get_export_tables()

Read more...


draw_tree_node_table()

Developer reference for function draw_tree_node_table()

Read more...


activate_plugin()

Developer reference for function activate_plugin()

Read more...


deactivate_plugin()

Developer reference for function deactivate_plugin()

Read more...


purge_plugin_config()

Developer reference for function purge_plugin_config()

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


is_plugin_activated()

Developer reference for function is_plugin_activated()

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


plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

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


display_field()

Developer reference for function display_field()

Read more...


render_date_range_field()

Developer reference for function render_date_range_field()

Read more...


render_upload_here_button()

Developer reference for function render_upload_here_button()

Read more...


render_help_link()

Developer reference for function render_help_link()

Read more...


render_edit_selected_btn()

Developer reference for function render_edit_selected_btn()

Read more...


has_browsebar()

Developer reference for function has_browsebar()

Read more...


EditNav()

Developer reference for function EditNav()

Read more...


send_research_request()

Developer reference for function send_research_request()

Read more...


get_research_requests()

Developer reference for function get_research_requests()

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


save_resource_data()

Developer reference for function save_resource_data()

Read more...


save_resource_data_multi()

Developer reference for function save_resource_data_multi()

Read more...


update_field()

Developer reference for function update_field()

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


get_resource_access()

Developer reference for function get_resource_access()

Read more...


get_edit_access()

Developer reference for function get_edit_access()

Read more...


get_resource_files()

Developer reference for function get_resource_files()

Read more...


get_page_count()

Developer reference for function get_page_count()

Read more...


notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

Read more...


get_resource_all_image_sizes()

Developer reference for function get_resource_all_image_sizes()

Read more...


get_download_filename()

Developer reference for function get_download_filename()

Read more...


delete_resource_type_field()

Developer reference for function delete_resource_type_field()

Read more...


compile_search_actions()

Developer reference for function compile_search_actions()

Read more...


search_special()

Developer reference for function search_special()

Read more...


update_search_from_request()

Developer reference for function update_search_from_request()

Read more...


save_themename()

Developer reference for function save_themename()

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


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


set_user_profile()

Description Set user's profile image and profile description (bio). Used by ../pages/user/user_profile_edit.php to setup user's profile. Parameters Column Type Default Description $user_ref int User id of user who's profile is being set.

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


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


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.

Read more...


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.

Read more...


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.

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

Description Definition of providers. see http://leafletjs.com/reference.html#tilelayer for options in the options map. L.TileLayer.Provider.providers = { <?php foreach($geo_leaflet_sources as $leaflet_source) { echo escape($leaflet_source["code"]) .

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


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


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


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.

Read more...


command_line_only()

Description Check we're running on the command line, exit otherwise. Security feature for the scripts in /pages/tools/ Parameters This function accepts no parameters. Return void This article was last updated 29th March 2024 08:35 Europe/London time based on the source file dated 28th March 2024 10:40 Europe/London time.

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


setup_search_chunks()

The function `setup_search_chunks()` allows `$fetchrows` to support an integer or array. If an integer is supplied, the search will receive the number of rows with no offset. If an array is supplied, the search will receive the number of rows to return and an offset, allowing for chunking of results.

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


migrate_fixed_to_text()

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

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


admin_resource_type_field_option()

Description Render metadata field option input on admin_resource_type_field_edit.php Parameters Column Type Default Description $propertyname string Field property/column name $propertytitle string Title $helptext string Help text $type mixed Input type (0=text,1=boolean,2=text area) $currentvalue mixed Current field setting $fieldtype int Field type.

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


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


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