Search

Search results

Background information

ResourceSpace is a fully featured Digital Asset Management Solution released under an Open Source License

Collections, public collections and featured collections

Because resources within ResourceSpace may be tagged with many different types and pieces of metadata, there is no need to store them in a traditional hierarchical folder structure in order to know where to find them.

Fixed list metadata

Article in the ResourceSpace Knowledge Base explaining Concepts about Fixed List Metadata.

Exiftool

Exiftool is a useful third party tool that allows data embedded within a file to be automatically extracted on upload into the resource metadata. The fields the embedded data is placed into are configured by an administrator and can accommodate any metadata stored within the file.

Featured & public collections

Public collections are designed for grouping resources which belong as a set, for example a photo shoot or project documentation. Featured collections are intended for promoting selected resources so Administrators can showcase the best or newest materials.

Getting the most from your search

1. Refining your search The ResourceSpace search feature is a very powerful tool and if used effectively can quickly lead you to the resources you want.

Alternative files

Resources are intended to be a single entity, however, sometimes it is necessary to store multiple versions together with a single set of metadata, this is when you need to use alternative files. Unlike related resources which allows you to link resources with a common subject or theme, alternative files allow users to search for one resource and easily access multiple variations of it from a single point.

Creating featured collections

This is the same process as Creating a public collection but with an extra step to turn it into a featured collection (see step 4). Create or Select a private collection Edit the collection Beside 'Access' choose 'Public' from the dropdown menu Select the featured collection category that the collection belongs to.

PDF contact sheet

If you want to have an quick reference overview of what is in a collection, it can be useful to make a PDF contact sheet which can then be printed or downloaded. Simply choose the "Contact Sheet" option in the collection Actions list.

Flickr publishing

Allows you to publish selected resources from selected collections to a Flickr account. Create a Featured Collection or collection that contains Resources you wish to publish.

PDF split

Allows PDF files to be split to multiple pages. One PDF can be split into separate pages, either as separate resources or as alternatives to the original PDF resource. To Split a PDF, do the following: Browse to a PDF resource Click the "PDF Split" in Resource Tools Select a range or ranges of pages you wish to split from the original Choose whether to create new Resources or Alternatives of the original PDF resource from each split.

Refine results

Adds an additional filter bar above the search results to allow further filtering within the result set. Simply type more relevant keywords and extra information into the further results field to keep filtering results.

Useful user permissions

The way users access and interact with resources is easy to control and modify by User Group Permissions. Although configuring user groups is the responsibility of a system administrator, for those managing resources it is important to understand the implications of these user permissions with regard to resource access.

Creating and deleting metadata fields

Resource metadata should be clear and descriptive and storing the right data in the right field type can help you to achieve this. Fixed list metadata fields limit the number of options a contributor has to choose from, ensuring the metadata added is consistent, without interpretation or spelling errors.

Metadata field types

As we've seen, your choice of Metadata Field Type is important to ensure the data captured is in an appropriate form for communicating to your users what it represents. Here is the full list of types of metadata field you will have to choose from: Text box (single Line Text Entry) Text box (multi-line Text Entry) Text box (large Multi-line Text Entry) Text box (formatted/ CKeditor) - This allows you to format text for HTML without needing any HTML knowledge Check box list (select Any Number of options from the list) Drop down list (select One option from a drop down list) Radio buttons (select One from a number of options) Date (date entry) Date and optional time (date entry with time down to second) Expiry date (will notify the user that this resource has expired starting from the set date) Date range (allows for date range searching - requires $daterange_search=true;) Category tree (see Category tree ) Dynamic tag list (text entry with suggestion options, can also dynamically add new options) Warning message (text entry which displays as a caption in bold text on the resource view page)

Configuring category trees

The category tree field type allows the selection of metadata tags from a nested tree. This field type is especially useful where resource subjects follow a hierarchical classification, such as product taxonomy or projects within campaigns.

Modifying field options

Within your fixed list metadata field there may come a time when you need to add, remove or edit some of the options, which you originally created. To do this, simply edit the field and choose the "manage options" link.

Ordering metadata fields

Metadata fields have an order applied which determines where they will appear on the search, edit and upload pages. It is worth giving consideration to this order to make these pages as intuitive as possible for your users.

Advanced metadata field configuration

This page covers the advanced options for metadata field configuration.

Smart featured collections

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

Useful user tools

Managing users is relatively simple in ResourceSpace, the following tools are provided as standard to help with the user configuration process. Resetting passwords Browse to Admin > Users Edit the user using the appropriate filters and user search tools to help find them and then clicking their name or "edit" in tools Enter a password into the password field or click "Suggest" to generate one Click Save Deleting users User accounts can be permanently removed using the "delete user" option.

Search filters

Each user group can have a 'search filter' set (via the user group options in System Setup), which allows for resource visibility restrictions.

Edit filters

An edit filter works like the search filters , but is used instead to determine if users in the group can edit resources based on the metadata in the resource. The existing 'e0' (or e1, e2 etc.

Derestrict filters

The derestrict filter allows users to access resources that would normally be restricted to them. This would be useful if you need some users to only be able to access a few resources within the system, whilst being completely restricted from all others.

Advanced workflow

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

get_resource_field_data

Return all field data for a given resource Variable Description Data type $resource * The ID of the resource.

update_field

Set the value of a metadata field. Variable Description Data type Default value $resource * The ID of the resource. integer $field * The numeric ID or shortname of the field.

get_alternative_files

Returns a list of alternative files for the given resource. Variable Description Data type Default $resource * The ID of the resource.

add_alternative_file

Adds a new alternative file. Variable Description Data type Default $resource * The ID of the resource. integer $name * A short descriptive name for the new alternative file.

delete_alternative_file

Deletes an alternative file. Variable Description Data type $resource * The ID of the resource.

upload_file

Uploads a new local file to an existing resource, replacing any file that is already attached. Variable Description Data type Default $ref * The ID of the resource.

upload_file_by_url

Uploads a new remote file to an existing resource, replacing any file that is already attached. Variable Description Data type Default $ref * The ID of the resource, which must already exist (see create_resource()).

get_field_options

For a given field, return all the available tags (nodes) or selectable options. Variable Description Data type Default value $ref * The ID or shortname of the field integer $nodeinfo Provides extended field option information if set to TRUE.

remove_resource_from_collection

Remove a resource from a collection. Variable Description Data type $resource * The ID of the resource.

Configuring php.ini

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: < ?php phpinfo(); ?> Increasing the following variables allows for handling much larger files, the default values are set quite low which can cause issues when uploading large media files: memory_limit This should be set to suit your expected usage.

OpenOffice / LibreOffice

If you require preview files to be created for common office document formats such as .docx and .pptx you will need to install a utility called Unoconv which allows conversion between different document formats in Open Office.

Configuring for multi-client use

If you are interested in setting up ResourceSpace as an environment where you may have multiple users whose resources should remain private from each other, here is one method of doing so. This would suit a scenario such as if you are a designer who manages multiple clients resources, yet need them to remain exclusive from each other.

StaticSync - keep your files in situ

StaticSync is intended for the case where there is an operational reason why you still need your existing resources to remain in a standard folder structure. Via the ingest mode it is also an alternative import mechanism, sometimes referred to as hot folders .

Facial recognition

ResourceSpace incorporates facial recognition capability via integration with OpenCV, an open source computer vision and machine learning software library. The ResourceSpace annotate feature has also been used in order to create the association between a fixed list field and a face.

Falcon link

This plugin allows users to publish resources as templates in Falcon.io Important information You need to have an account with Falcon.io in order to use this plugin Falcon.io has no connection to, and is in no way affiliated with ResourceSpace.

Basic metadata field configuration

This page covers the basic options for metadata field configuration beyond what is covered in Creating metadata fields and Indexing . Enabled Specifies that the field will be used for resource display, editing and searching.

IIIF

IIIF is an API specification designed to improve interoperability between digital image repositories. For more information on IIIF please refer to http://iiif.io/ Please note that IIIF support requires additional web server configuration ResourceSpace provides basic support for the IIIF presentation API and was originally created to link with the TMS plugin to enable publishing of resources related to a specified TMS object as a IIIF manifest, however TMS is not a requirement to enable the IIIF interface.

Migrating 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 (for example checkbox, radio button, dropdown or dynamic tag list), you will be prompted to migrate existing data to create the fixed list options.

Customising the interface colours, logo and favicon

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video Navigate to Admin -> System -> System configuration and open the User interface section.

Resources not showing for a given user group

There may be occasions when a resource is visible by some users (such as super admins) while it is not visible for other users (such as general users). This can be caused by a variety of factors, here are some possible causes: Permissions Does the user have access to the workflow state the resource is in? These permissions start with the letter 'z', e.

Cookies notification

Activated under Plugins via the System menu, the cookies_notification plugin creates a header on the login page to notify users that their activity will be tracked via cookies. The plugin may be configured to force users to accept cookies before proceeding to access ResourceSpace.

What file formats can be uploaded to ResourceSpace?

Any type of file can be uploaded to ResourceSpace as long as it is not in the list of banned extensions which by default is: php, cgi, pl, exe, asp, jsp, sh, bash This can be changed using the config option $banned_extensions.

Configuring email and messaging

You can configure the default behaviour of ResourceSpace with the following configuration options System settings To change the email address that system emails are sent from, navigate to Admin > System > System configuration and change the 'Email from address'.

The config file

ResourceSpace can be configured with various PHP variables that can be found in the config.default.php file in the 'include' folder. When changing these values you should always copy them to the config.

Offline job queues

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

Format chooser

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

QuickTime reporting corrupt file when using H264 encoding

When generating previews using H264 encoding (automated alternatives or just normal previews) sometimes, depending on options used to generate the preview, QuickTime can complain that the downloaded mp4 file is corrupt.

Coding standards v1.3

Coding standards are important in any development project, but particularly when multiple developers are working on the same project. Having coding standards helps ensure that the code is of high quality, has fewer bugs, and is easily maintained.

1. Finding your way around

An overview of the ResourceSpace user interface.

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.

File integrity checking

ResourceSpace includes a tool to verify the file integrity of primary resource files, allowing you to be notified should any corruption occur and take remedial action as necessary. Configuring the file integrity check To configure the system to check file integrity you need to have the following configured Full file checksums (set the following options) $file_checksums = true; $file_checksums_50k = false; $file_checksums_offline = false;* * If $file_checksums_offline is true then /pages/tools/update_checksums.

Feedback

Adds a general user feedback function to the header for all users. After enabling the plugin, users will be prompted to answer a configurable feedback form. Responses to these forms are stored in a csv inside the feedback plugin folder on the server.

Search notifications

Allows users to receive notifications when the results to a specified search changes. Configuration The notification can be adjusted to show a specified number of thumbnails

replace_resource_file

Replaces the primary resource file for a given resource Variable Description Data type Default $resource * The ID of the resource to replace the file for.

Track field history

The track field history plugin makes it easy to see the history of the metadata of a resource by breaking it down by field. Plugin options allow you to select which fields should be tracked and a History link will then be placed next to those fields on the resource details panel of the resource view page.

Configuring the database

Create a new database CREATE DATABASE your_db_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; ResourceSpace will automatically create database tables, indexes and so on. Database users It is a good security practice to create dedicated users for ResourceSpace.

Creating and editing filters

Creating and editing filters. Filters can be set to control access to resources

Configuring geolocation settings

Leaflet Maps ResourceSpace can be configured to use a new open source mapping library called Leaflet Maps . The current system based on OpenLayers will soon be discontinued. Please refer to Configuring Leaflet Maps for more information.

Digital object identifier

A DOI, or Digital Object Identifier, is a unique alphanumeric string used to permanently identify an object. The object is then tied to its metadata and digital location. The DOI plugin allows you to create DOIs for your resources on an individual basis, or in bulk as a collection action.

Excluding terms from your search

Sometimes users may want to exclude specific terms from a search. You can do this by entering the search term into the simple search bar, followed by a space, followed by a minus symbol and the term you'd like to exclude.

Edit access for contributors

System administrators can configure ResourceSpace to grant contributors edit access to the resources they have uploaded. To enable this, set the following configuration option: $edit_access_for_contributor = true; If administrators find that certain user groups need to have edit access to Active state but they don't want those users to be able to edit resources they haven't contributed, ResourceSpace can be configured to force edit access only to contributors, regardless of what edit access is granted via general permissions (e.

Removing resources from collections

It is very simple to remove resources from a collection using any of the below methods: If viewing the collection resources, simply click and drag the resource you wish to remove. A trash icon will show at the top of the screen, just drop the resource onto the bin and confirm removal from the collection.

Fixed list fields

Overview ResourceSpace has multiple metadata field types such as: Text box (single or multi line) Check box lists Dropdown lists Date fields Category trees Radio button lists And many more Some of these fields can have their options defined by an administrator of the system.

ResourceSpace plugin for WordPress

Please note that this is a WordPress plugin that needs to be installed and runs on WordPress, not on ResourceSpace A WordPress plugin that allows you to embed resource files from ResourceSpace in your posts is now available.

ResourceSpace software design principles

When developing ResourceSpace core and plugins please always consider the below principals. The existing codebase doesn't always adhere to these principals - the contributions from many different developers over the years have meant a mix of coding styles - but the important thing is that we're always moving in the right direction by refactoring as we see fit and peer reviewing new code.

Managing offline jobs

The My Jobs page is used to check on the status of your jobs e.g. collection downloads, preview creation etc. System administrators can also use this page to check on the status of jobs systemwide To view your jobs click on the user preferences icon and click 'My jobs' The page shows you the following information about jobs in the queue:- The job priority* The job reference The job type The user that created the job (admins only) The job status The earliest job start date The tools column has the following options:- Delete the job (e.

My Profile

Managing your ResourceSpace Profile To help collaborate more effectively with team members and other users of ResourceSpace, in the My Profile page you can configure your user profile. Two fields are available, Profile / Bio and Profile image.

RSS Feed

With the RSS Feed plugin you can generate RSS URLs for a resource search in ResourceSpace. This is done using the API. Recent resources feed After enabling the plugin you will immediately see a new link at the bottom of the Simple Search area - "New content RSS feed", clicking this will take you to the RSS feed for the 50 most recently uploaded resources.

Configuring Leaflet Maps

To enable leaflet maps you will need to set the following configuration option:- $leaflet_maps_enable=true; Leaflet maps configuration options The following options can be configured to add tile sources and customise how gelocation data is displayed.

Further videos

h2 { margin-top:21px;margin-bottom:13px; } Action dates Adobe link Annotate Auto assign Creating users CSV user import Customising the homepage slideshow Display conditions Embed video Format chooser License manager Related resources Search filters Sharing resources Site content Smart featured collections Special search terms Transform

User preferences

To access your user preferences, click the user profile icon at the top right of the screen and select "Preferences". The options on this page allow you to make changes to some of the functionality and interface that are available to you.

Offline archive

Offline archive The offline archive plugin allows you to relocate achived files to an offline location After enabling the plugin, there are a number of configuration options which specify how the relocation will occur.

Create Alternative Video Files

ResourceSpace can be configured to automatically generate a video file in a different size or format from the uploaded original. This may be particularly useful where a smaller size is required for uploading to the web.

Configuring Expiry date field

The expiry date field type enables a visual aid to help users know when a particular resource has expired and should no longer be used (e.g the download options are no longer immediately available - but they can be by clicking on the link).

Ordering featured collections

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video From version 9.

Subtitles for Video Preview

Subtitles can be included when previewing video resources. Once configured, on playing a video resource preview, an option will be available in the player controls to select the subtitle track. Multiple tracks can be added as required.

Sending user notifications

Sending User Notifications When sending a user notification the following settings should be checked:- Has the user chosen to receive these types of notifications? Has the user chosen to receive emails instead of system messages? Has the user chosen to receive emails in addition to system messages? What language preference does the user have? Before version 10 these checks had to be made before calling send_mail() or message_add() whenever required, resulting in duplicated code and inconsistency.

Configuring Apache

Apache configuration Ensure the filestore is not browseable by disabling indexing This can be done by either disabling the autoindex module: sudo a2dismod --force autoindex systemctl restart apache2 Or by setting the directory's options directive sudo nano /etc/apache2/apache2.

Customising the font

Navigate to Admin -> System -> System configuration and expand the User interface section. Here there are two options: A preset font can be chosen from the Font drop down. From version 10: A custom font file (extension woff2, woff, ttf or otf) can be uploaded with the Custom font file option.

Managing resource requests notifications

From v10+ resource requests notifications to the reponsible administrators can be managed using a metadata field value. Configuration /* Metadata field designated to hold information which the system can use to determine the user group responsible for that resource.

Table: filter

Filter definition. Used for search, edit and derestrict filters on usergroups Column Type Note ref int(11) Auto incrementing index name varchar(200) Name of filter filter_condition int(11) Defines which rules must be met to satisfy the filter (RS_FILTER_ALL|RS_FILTER_NONE|RS_FILTER_ANY) This table is empty by default.

Table: filter_rule

Defines the rules that make up a filter. Column Type Note ref int(11) Auto incrementing index filter int(11) See table filter This table is empty by default. Please see the schema overview for context.

Table: filter_rule_node

Defines the nodes and conditions that make up a filter rule. Column Type Note filter_rule int(11) See table filter_rule node_condition int(11) (boolean) Whether the given node is required to be present or absent to satisfy the rule node int(11) See table node This table is empty by default.

Table: resource_alt_files

Alternative files for a resource, definited separately to the main resource. Column Type Note ref int(11) Auto incrementing index resource int(11) See table resource name varchar(100) Name of the alternative file.

Table: resource_type_field

Metadata fields. Column Type Note ref int(11) Auto incrementing index name varchar(50) Metadata field short name identifier title varchar(400) Metadata field name field_constraint int(11) Apply constraints to field (e.

Table: user_preferences

Stores all user preferences, and also system configuration. Column Type Note ref int(11) Auto incrementing index user int(11) See table user parameter varchar(150) Name of preference (variable name) - normally default settings are set in config value varchar(255) Preference value This table is empty by default.

OpenCV (facial recognition)

OpenCV is the library ResourceSpace uses for facial recognition capability. You can install OpenCV from the system's repository ( how to install on Ubuntu) : sudo apt install python3-opencv # You may also need to install separately (for virtual environments or because they're missing) the following: pip install -U opencv-python opencv-contrib-python numpy matplotlib Advanced To install OpenCV from source, on either Linux or Windows please check OpenCV's documentation.

Configuring Cross-Site Request Forgery (CSRF)

Cross-Site Request Forgery ( CSRF ) is an attack that forces an end user to execute unwanted actions on a web application in which they're currently authenticated. CSRF attacks specifically target state-changing requests, not theft of data, since the attacker has no way to see the response to the forged request.

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.

Cross-Site Request Forgery (CSRF)

Overview CSRF is an attack that forces an end user to execute unwanted actions on a web application in which they're currently authenticated. CSRF attacks specifically target state-changing requests , not theft of data, since the attacker has no way to see the response to the forged request.

Custom fields ("user" defined)

ResourceSpace can be configured with custom fields. An example of this feature already being used using this system can be seen on Research Request . A custom field structure looks like below: array( "id" => 1, "title" => "~en:Roles~fr:Rôles", "type" => FIELD_TYPE_CHECK_BOX_LIST, "required" => true, "options" => array("IT", "~en:Customer Success~fr:Succès Client", "Sales", "Support", "Admin") ) A field is considered valid as long as it has the following keys/properties: id - a numeric and unique number.

update_resource_type_field_order()

Developer reference for function update_resource_type_field_order()

ajax_response_fail()

Developer reference for function ajax_response_fail()

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

iiif_error()

Developer reference for function iiif_error()

remove_resource_from_collection()

Developer reference for function remove_resource_from_collection()

refresh_collection_frame()

Developer reference for function refresh_collection_frame()

send_collection_feedback()

Developer reference for function send_collection_feedback()

remove_from_collection_link()

Developer reference for function remove_from_collection_link()

remove_all_resources_from_collection()

Developer reference for function remove_all_resources_from_collection()

makeFilenameUnique()

Developer reference for function makeFilenameUnique()

new_featured_collection_form()

Developer reference for function new_featured_collection_form()

GetThemesFromRequest()

Developer reference for function GetThemesFromRequest()

collection_download_get_archive_file()

Developer reference for function collection_download_get_archive_file()

collection_download_use_original_filenames_when_downloading()

Developer reference for function collection_download_use_original_filenames_when_downloading()

collection_download_process_text_file()

Developer reference for function collection_download_process_text_file()

update_zip_progress_file()

Developer reference for function update_zip_progress_file()

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

Developer reference for function collection_download_clean_temp_files()

validateAnonymousFlag()

Developer reference for function validateAnonymousFlag()

validateFlag()

Developer reference for function validateFlag()

submitForm()

Developer reference for function submitForm()

validate_field()

Developer reference for function validate_field()

set_config_option()

Developer reference for function set_config_option()

get_config_option()

Developer reference for function get_config_option()

get_config_option_users()

Developer reference for function get_config_option_users()

get_config_options()

Developer reference for function get_config_options()

process_config_options()

Developer reference for function process_config_options()

config_clean()

Developer reference for function config_clean()

config_html()

Developer reference for function config_html()

config_add_html()

Developer reference for function config_add_html()

config_text_input()

Developer reference for function config_text_input()

config_add_text_input()

Developer reference for function config_add_text_input()

config_file_input()

Developer reference for function config_file_input()

config_colouroverride_input()

Developer reference for function config_colouroverride_input()

config_add_file_input()

Developer reference for function config_add_file_input()

config_single_select()

Developer reference for function config_single_select()

config_add_single_select()

Developer reference for function config_add_single_select()

config_boolean_select()

Developer reference for function config_boolean_select()

config_add_boolean_select()

Developer reference for function config_add_boolean_select()

config_checkbox_select()

Developer reference for function config_checkbox_select()

config_add_checkbox_select()

Developer reference for function config_add_checkbox_select()

config_add_colouroverride_input()

Developer reference for function config_add_colouroverride_input()

config_add_single_ftype_select()

Developer reference for function config_add_single_ftype_select()

config_single_ftype_select()

Developer reference for function config_single_ftype_select()

config_generate_AutoSaveConfigOption_function()

Developer reference for function config_generate_AutoSaveConfigOption_function()

config_process_file_input()

Developer reference for function config_process_file_input()

config_generate_html()

Developer reference for function config_generate_html()

config_merge_non_image_types()

Developer reference for function config_merge_non_image_types()

config_register_core_fieldvars()

Developer reference for function config_register_core_fieldvars()

revoke_all_users_flag_cascade_delete()

Developer reference for function revoke_all_users_flag_cascade_delete()

append_default_position()

Developer reference for function append_default_position()

reorder_default_dash()

Developer reference for function reorder_default_dash()

update_default_dash_tile_order()

Developer reference for function update_default_dash_tile_order()

checkTileConfig()

Developer reference for function checkTileConfig()

checkConfigCustomHomePanels()

Developer reference for function checkConfigCustomHomePanels()

get_default_dash()

Developer reference for function get_default_dash()

deleteDefaultDashTile()

Developer reference for function deleteDefaultDashTile()

render_delete_dialog_JS()

Developer reference for function render_delete_dialog_JS()

debug_function_call()

Developer reference for function debug_function_call()

initFacialRecognition()

Developer reference for function initFacialRecognition()

prepareFaceImage()

Developer reference for function prepareFaceImage()

faceRecognizerPredict()

Developer reference for function faceRecognizerPredict()

safe_file_name()

Developer reference for function safe_file_name()

generateUserFilenameUID()

Developer reference for function generateUserFilenameUID()

formatfilesize()

Developer reference for function formatfilesize()

filesize2bytes()

Developer reference for function filesize2bytes()

verify_extension()

Developer reference for function verify_extension()

getFolderContents()

Developer reference for function getFolderContents()

filesize_unlimited()

Developer reference for function filesize_unlimited()

format_display_field()

Developer reference for function format_display_field()

format_string_more_link()

Developer reference for function format_string_more_link()

draw_performance_footer()

Developer reference for function draw_performance_footer()

sql_affected_rows()

Developer reference for function sql_affected_rows()

get_slideshow_files_data()

Developer reference for function get_slideshow_files_data()

form_value_display()

Developer reference for function form_value_display()

generateCSRFToken()

Developer reference for function generateCSRFToken()

isValidCSRFToken()

Developer reference for function isValidCSRFToken()

generateFormToken()

Developer reference for function generateFormToken()

enforcePostRequest()

Developer reference for function enforcePostRequest()

findDuplicates()

Developer reference for function findDuplicates()

str_replace_formatted_placeholder()

Developer reference for function str_replace_formatted_placeholder()

ucfirstletter()

Developer reference for function ucfirstletter()

ucfirstletter_callback()

Developer reference for function ucfirstletter_callback()

seems_utf8()

Developer reference for function seems_utf8()

http_get_preferred_language()

Developer reference for function http_get_preferred_language()

perform_login()

Developer reference for function perform_login()

system_notification()

Developer reference for function system_notification()

runFitsForFile()

Developer reference for function runFitsForFile()

getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

extractFitsMetadata()

Developer reference for function extractFitsMetadata()

check_date_format()

Developer reference for function check_date_format()

migrate_resource_type_field_check()

Developer reference for function migrate_resource_type_field_check()

migrate_filter()

Developer reference for function migrate_filter()

mix_filename()

Developer reference for function mix_filename()

safe_export()

Developer reference for function safe_export()

edit_filter_to_restype_permission()

Developer reference for function edit_filter_to_restype_permission()

delete_nodes_for_resource_type_field()

Developer reference for function delete_nodes_for_resource_type_field()

get_root_node_by_leaf()

Developer reference for function get_root_node_by_leaf()

node_field_options_override()

Developer reference for function node_field_options_override()

get_nodes_from_keywords()

Developer reference for function get_nodes_from_keywords()

copy_resource_type_field_nodes()

Developer reference for function copy_resource_type_field_nodes()

get_pdf_template_path()

Developer reference for function get_pdf_template_path()

generate_pdf()

Developer reference for function generate_pdf()

process_if_statements()

Developer reference for function process_if_statements()

resolve_pdf_language()

Developer reference for function resolve_pdf_language()

get_pdf_templates()

Developer reference for function get_pdf_templates()

purge_plugin_config()

Developer reference for function purge_plugin_config()

config_json_encode()

Developer reference for function config_json_encode()

config_encode()

Developer reference for function config_encode()

get_plugin_config()

Developer reference for function get_plugin_config()

set_plugin_config()

Developer reference for function set_plugin_config()

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

plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

include_plugin_config()

Developer reference for function include_plugin_config()

render_search_field()

Developer reference for function render_search_field()

is_field_displayed()

Developer reference for function is_field_displayed()

display_multilingual_text_field()

Developer reference for function display_multilingual_text_field()

display_field()

Developer reference for function display_field()

render_date_range_field()

Developer reference for function render_date_range_field()

renderSocialMediaShareLinksForUrl()

Developer reference for function renderSocialMediaShareLinksForUrl()

render_field_selector_question()

Developer reference for function render_field_selector_question()

render_filter_bar_button()

Developer reference for function render_filter_bar_button()

render_custom_fields()

Developer reference for function render_custom_fields()

render_csrf_data_attributes()

Developer reference for function render_csrf_data_attributes()

display_field_data()

Developer reference for function display_field_data()

unsubscribe_user_from_periodic_report()

Developer reference for function unsubscribe_user_from_periodic_report()

get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

gen_custom_fields_html_props()

Developer reference for function gen_custom_fields_html_props()

process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

set_resource_defaults()

Developer reference for function set_resource_defaults()

append_field_value()

Developer reference for function append_field_value()

remove_keyword_from_resource()

Developer reference for function remove_keyword_from_resource()

remove_all_keyword_mappings_for_field()

Developer reference for function remove_all_keyword_mappings_for_field()

update_field()

Developer reference for function update_field()

get_resource_type_field()

Developer reference for function get_resource_type_field()

get_resource_field_data()

Developer reference for function get_resource_field_data()

get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

get_max_resource_ref()

Developer reference for function get_max_resource_ref()

get_resource_ref_range()

Developer reference for function get_resource_ref_range()

get_exiftool_fields()

Developer reference for function get_exiftool_fields()

createTempFile()

Developer reference for function createTempFile()

delete_exif_tmpfile()

Developer reference for function delete_exif_tmpfile()

get_alternative_files()

Developer reference for function get_alternative_files()

add_alternative_file()

Developer reference for function add_alternative_file()

delete_alternative_file()

Developer reference for function delete_alternative_file()

get_alternative_file()

Developer reference for function get_alternative_file()

save_alternative_file()

Developer reference for function save_alternative_file()

process_notify_user_contributed_submitted()

Developer reference for function process_notify_user_contributed_submitted()

notify_user_contributed_submitted()

Developer reference for function notify_user_contributed_submitted()

notify_user_contributed_unsubmitted()

Developer reference for function notify_user_contributed_unsubmitted()

get_field()

Developer reference for function get_field()

get_field_options_with_stats()

Developer reference for function get_field_options_with_stats()

save_field_options()

Developer reference for function save_field_options()

get_keyword_from_option()

Developer reference for function get_keyword_from_option()

add_field_option()

Developer reference for function add_field_option()

filter_match()

Developer reference for function filter_match()

log_diff()

Developer reference for function log_diff()

autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

get_resource_files()

Developer reference for function get_resource_files()

notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

resource_type_config_override()

Developer reference for function resource_type_config_override()

truncate_join_field_value()

Developer reference for function truncate_join_field_value()

resource_file_readonly()

Developer reference for function resource_file_readonly()

get_video_info()

Developer reference for function get_video_info()

copy_locked_fields()

Developer reference for function copy_locked_fields()

process_edit_form()

Developer reference for function process_edit_form()

get_default_archive_state()

Developer reference for function get_default_archive_state()

save_original_file_as_alternative()

Developer reference for function save_original_file_as_alternative()

replace_resource_file()

Developer reference for function replace_resource_file()

sanitize_date_field_input()

Developer reference for function sanitize_date_field_input()

filter_check()

Developer reference for function filter_check()

get_field_options()

Developer reference for function get_field_options()

get_data_by_field()

Developer reference for function get_data_by_field()

get_fields()

Developer reference for function get_fields()

get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

get_category_tree_fields()

Developer reference for function get_category_tree_fields()

get_OR_fields()

Developer reference for function get_OR_fields()

get_indexed_resource_type_fields()

Developer reference for function get_indexed_resource_type_fields()

get_resource_type_fields()

Developer reference for function get_resource_type_fields()

notify_resource_change()

Developer reference for function notify_resource_change()

metadata_field_edit_access()

Developer reference for function metadata_field_edit_access()

get_download_filename()

Developer reference for function get_download_filename()

get_resource_type_from_extension()

Developer reference for function get_resource_type_from_extension()

alt_is_ffmpeg_alternative()

Developer reference for function alt_is_ffmpeg_alternative()

create_resource_type_field()

Developer reference for function create_resource_type_field()

metadata_field_view_access()

Developer reference for function metadata_field_view_access()

get_workflow_states()

Developer reference for function get_workflow_states()

delete_resource_type_field()

Developer reference for function delete_resource_type_field()

suggest_refinement()

Developer reference for function suggest_refinement()

get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

get_advanced_search_collection_fields()

Developer reference for function get_advanced_search_collection_fields()

search_form_to_search_query()

Developer reference for function search_form_to_search_query()

refine_searchstring()

Developer reference for function refine_searchstring()

search_filter()

Developer reference for function search_filter()

resolve_nodes_from_string()

Developer reference for function resolve_nodes_from_string()

rebuild_specific_field_search_from_node()

Developer reference for function rebuild_specific_field_search_from_node()

get_default_search_states()

Developer reference for function get_default_search_states()

get_filter_sql()

Developer reference for function get_filter_sql()

get_simple_search_fields()

Developer reference for function get_simple_search_fields()

get_fields_for_search_display()

Developer reference for function get_fields_for_search_display()

get_filters()

Developer reference for function get_filters()

get_filter()

Developer reference for function get_filter()

get_filter_rules()

Developer reference for function get_filter_rules()

get_filter_rule()

Developer reference for function get_filter_rule()

save_filter()

Developer reference for function save_filter()

save_filter_rule()

Developer reference for function save_filter_rule()

delete_filter()

Developer reference for function delete_filter()

delete_filter_rule()

Developer reference for function delete_filter_rule()

copy_filter()

Developer reference for function copy_filter()

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

remove_groups_smart_from_userlist()

Developer reference for function remove_groups_smart_from_userlist()

get_notification_users()

Developer reference for function get_notification_users()

verify_antispam()

Developer reference for function verify_antispam()

get_users_from_permission_lookup()

Developer reference for function get_users_from_permission_lookup()

offset_user_local_timezone()

Developer reference for function offset_user_local_timezone()

get_search_default_restypes()

Developer reference for function get_search_default_restypes()

trim_filename()

Developer reference for function trim_filename()

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

get_featured_collection_resources()

Developer reference for function get_featured_collection_resources()

get_featured_collection_categ_sub_fcs()

Developer reference for function get_featured_collection_categ_sub_fcs()

generate_featured_collection_image_urls()

Developer reference for function generate_featured_collection_image_urls()

get_featured_collections()

Developer reference for function get_featured_collections()

featured_collections_permissions_filter_sql()

Developer reference for function featured_collections_permissions_filter_sql()

featured_collection_check_access_control()

Developer reference for function featured_collection_check_access_control()

order_featured_collections_by_hasresources()

Developer reference for function order_featured_collections_by_hasresources()

get_featured_collection_categories()

Developer reference for function get_featured_collection_categories()

is_featured_collection_category()

Developer reference for function is_featured_collection_category()

is_featured_collection_category_by_children()

Developer reference for function is_featured_collection_category_by_children()

get_featured_collection_category_branch_by_leaf()

Developer reference for function get_featured_collection_category_branch_by_leaf()

process_posted_featured_collection_categories()

Developer reference for function process_posted_featured_collection_categories()

get_featured_collection_ref_by_name()

Developer reference for function get_featured_collection_ref_by_name()

allow_featured_collection_share()

Developer reference for function allow_featured_collection_share()

filter_featured_collections_by_root()

Developer reference for function filter_featured_collections_by_root()

get_featured_collections_by_resources()

Developer reference for function get_featured_collections_by_resources()

can_delete_featured_collection()

Developer reference for function can_delete_featured_collection()

render_new_featured_collection_cta()

Developer reference for function render_new_featured_collection_cta()

render_featured_collection_category_selector()

Developer reference for function render_featured_collection_category_selector()

render_featured_collections()

Developer reference for function render_featured_collections()

render_featured_collection()

Developer reference for function render_featured_collection()

render_featured_collections_category_permissions()

Developer reference for function render_featured_collections_category_permissions()

dash_tile_featured_collection_get_resources()

Developer reference for function dash_tile_featured_collection_get_resources()

order_featured_collections()

Developer reference for function order_featured_collections()

strip_prefix_chars()

Developer reference for function strip_prefix_chars()

get_inner_html_from_tag()

Developer reference for function get_inner_html_from_tag()

get_all_featured_collections()

Developer reference for function get_all_featured_collections()

compute_featured_collections_acess_control()

Developer reference for function compute_featured_collections_acess_control()

array_flip_by_value_key()

Developer reference for function array_flip_by_value_key()

cleanup_files()

Description Delete temporary files Parameters Column Type Default Description $files array array of file paths Return void This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

compute_featured_collections_access_control()

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

update_fieldx()

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

get_nodes_by_refs()

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

comments_notify_tagged()

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

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.

delete_profile_image()

Description Delete a user's profile image. This will first remove the file and then update the db to clear the existing value. Parameters Column Type Default Description $user_ref mixed User id of the user who's profile image is to be deleted.

get_profile_image()

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

get_profile_text()

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

get_languages_notify_users()

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

external_upload_notify()

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

render_workflow_state_question()

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

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.

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.

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.

set_unique_filename()

Description Ensures filename is unique in $filenames array and adds resulting filename to the array Parameters Column Type Default Description &$filename &$filenames $filename string Requested filename to be added.

leaflet_osm_basemaps()

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

leaflet_polygon_parsing()

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

leaflet_coordinate_check()

Parameters Column Type Default Description $coordinate $type Location include/map_functions.

leaflet_markers_legend()

Parameters This function accepts no parameters. Location include/map_functions.php lines 514 to 544 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 $lang [ 'legend_text' ] ?>  </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='.

clear_tracking_vars_info()

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

debug_stringify()

Description Stringify variables for use in the debug log. This is used more as fallback to json_encode() failing to maintain quick readability of the logs. Parameters Column Type Default Description $value mixed Any value that needs stringified Return string Location include/debug_functions.

rs_password_verify()

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

get_password_hash_info()

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

message_getrefs()

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

move_featured_collection_branch_path_root()

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

render_fixed_text_question()

Description Renders a 'fixed' text question - not an input but to display information or values that cannot be changed Parameters Column Type Default Description $label string $text string Return void Location include/render_functions.

exiftool_resolution_calc()

Description Set resource dimensions using data from exiftool. Parameters Column Type Default Description $file_path string Path to the original file.

tltype_srch_generate_js_for_background_and_count()

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

get_default_user_collection()

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

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.

ps_param_fill()

Description When constructing prepared statements and using e.g. ref in (some list of values), assists in preparing the parameter array. Parameters Column Type Default Description $array array The input array, to prepare for output.

temp_local_download_remote_file()

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

can_reorder_featured_collections()

Description Check if user is allowed to re-order featured collections Parameters This function accepts no parameters. Return boolean Location include/collections_functions.

check_valid_file_extension()

Description Basic check of uploaded file against list of allowed extensions Parameters Column Type Default Description $uploadedfile array - an element from the $_FILES PHP reserved variable $validextensions array Array of valid extension strings Return bool Location include/file_functions.

check_filestore_browseability()

Description Check filestore folder browseability. For security reasons (e.g data breach) the filestore location shouldn't be indexed by the web server (in Apache2 - disable autoindex module) - status: An end user status of OK/FAIL - info: Any extra relevant information (aimed at end users) - filestore_url: ResourceSpace URL to the filestore location - index_disabled: PHP bool (used by code).

find_root_comment()

Description Find the root of a comment tree that the ref provided is a part of Parameters Column Type Default Description $ref int ref of a comment Return int|null ref of the root comment or null if the comment tree has been completely removed / the comment being checked has already been deleted.

check_imagemagick_cli_version_found()

Description Check CLI version found for ImageMagick is as expected. - utility - New utility value for its display name - found - PHP bool representing whether we've found what we were expecting in the version output.

check_numeric_cli_version_found()

Description Check CLI numeric version found for a utility is as expected. - utility - not used - found - PHP bool representing whether we've found what we were expecting in the version output.

check_utility_cli_version_found_by_name()

Description Check CLI version found for a utility is as expected by looking up for its name. - utility - not used - found - PHP bool representing whether we've found what we were expecting in the version output.

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.

delete_unused_non_fixed_list_nodes()

Description Delete unused non-fixed list field nodes with a 1:1 resource association Parameters Column Type Default Description $resource_type_field integer Resource type field (metadata field) ID Location include/node_functions.

remove_field_keywords()

Description Delete all keywords for all nodes associated with the specified field Parameters Column Type Default Description $field integer Field ID Return bool Location include/node_functions.

update_node_hitcount_from_search()

Parameters Column Type Default Description $resource $search Location include/resource_functions.

update_resource_field_column()

Description Update the value of the fieldXX field on resource table Parameters Column Type Default Description $resource integer - Resource ID $field integer - Metadata field ID $value string - Value Return boolean Location include/resource_functions.

render_fa_icon_selector()

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

filterIcons()

get_tabs_by_refs()

Description Get entire tab records for a list of IDs Parameters Column Type Default Description $refs array List of tab refs Return array Location include/tab_functions.

sort_tabs_as_configured()

Description Sort list of tab names (preserving their key ID) Parameters Column Type Default Description $tabs array List of tab ID and tab translated name pairs Return array Location include/tab_functions.

can_use_owner_field()

Description Initialisation and system check if configuration is correctly enabled to use the owner field and mappings logic. IMPORTANT: during init the globals $owner_field & $owner_field_mappings values will be updated for validation purposes Parameters This function accepts no parameters.

get_notification_users_by_owner_field()

Description Get users to notify for requested resources "owned" by particular groups. Configurable using a metadata field ($owner_field) and a defined map ($owner_field_mappings).

cattree_node_flatten()

Description Helper function which adds child nodes after each flattened parent node Parameters Column Type Default Description $node array Array of nodes each with a child node array Return array Array of nodes with child nodes flattened out after their respective parents Location include/node_functions.

get_resources_nodes_by_rtf()

Description Get all resource nodes associated for a specific resource type field. Parameters Column Type Default Description $ref integer Resource type field ID Return Generator Location include/node_functions.

Open source

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

Pending review and submission

Some users will have restricted permissions within ResourceSpace, affecting how they upload assets to the library. With a standard configuration, members of the General Users group will first upload into the 'Pending Submission' state.

Simple search

The simple search panel sits to the right of every page within ResourceSpace, making it easy to search from anywhere within the system. The basic panel features a general search box for quick, free text searching across all indexed fields, along with resource type and date.

User research requests

Research requests allow users to ask administrators for help in sourcing resources. Users will be instructed to fill out a form detailing what they need, administrators can then help them to find suitable resources.

Managing metadata

Getting the best possible Metadata into your system will make searching for resources faster, easier and more intuitive. Things to consider when deciding how to configure your metadata fields and options are: Is it descriptive - Does your metadata give relevant information about your resources? You will need to keep your metadata under review to ensure new options are added as your system evolves.

Watched searches

This functionality is provided by the 'rse_search_notifications' plugin which is enabled by default Watched searches allow users to 'subscribe' to any search result or other set of resources, such as a collection.

Google Vision API

This plugin sends your 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 Plugin Configuration If this plugin is enabled at initial setup then only the API key is required and default metadata fileds are used to store suggested tags, location information and extracted text.

Simple SAML

WARNING: This plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace. This plugin allows users to log on to ResourceSpace using a SAML compliant single sign-on (SSO) Identity Provider (IdP) Important information Please note that use of this plugin is dependent on your organisation having implemented a SAML 2.

Google VR View

This plugin displays previews of 360° images and videos using the Google VR View browser API For more information on VR View visit https://developers.google.com/vr/concepts/vrview-web As per the Google specifications, the plugin is supported on the following:- Modern versions of Chrome and Opera on Windows, macOS, Linux, Android, and iOS.

Metadata read/write mapping

ResourceSpace is able to map between embedded metadata stored in your 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.

ResourceSpace messages

Messages are used by ResourceSpace to ensure notifications are prominently displayed so important messages are not overlooked. As new messages are received, a counter next to the user's profile will increase to indicate the activity.

Emails

Emails are used in ResourceSpace to notify users of ResourceSpace activity that they may be interested in, such as resources submitted for review, user account requests or resource download requests. By default most email notifications have now been replaced by system messages, however you can still opt to receive emails by modifying your user preferences.

Data only resource types

Data only resources are resources which do not have an associated file. These resources contain metadata only and can be used to store a record or set of data that does not directly relate to a specific asset.

Project structure

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

Client side API calls

Client side API requests Instead of creating new AJAX calls to custom endpoints it is recommended to instead use the new api() JavaScript function. This makes calls to the ResourceSpace API using native browser authentication.

Image tools

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video Enables simple editing to produce rotated, cropped or scaled images.

Messaging

Viewing your messages To view messages, click the user profile icon at the top right of the screen and select "Messages". Messages are listed in date order, newest first. Click on the text in the message column to see the full message if it is not all visible.

User actions

User Actions From version 10 user actions are enabled for all users by default, unless explicitly disabled by a system administrator. Actions allow users to be alerted to resources or activities that require their attention.

get_user_message

Retrieve the given message ID Permissions are always honoured so messsges to other users will not be accessible. Variable Description Data type $ref * Message ID integer Return values An array with three elements: 'message' => message text,'url'=> message URL and 'owner' => message owner.

Welcome to ResourceSpace

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

New to ResourceSpace?

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

User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Knowledge Base structure

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

Resources and structure

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

Metadata

ResourceSpace Digital Asset Management System uses embedded and user inserted metadata to describe and track your resources

Accounts & access

A ResourceSpace Knowledge Base article explaining user accounts and access within ResourceSpace for users.

Language options

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video ResourceSpace has built a large international community with a wide range of supported languages.

Resource administrators

Knowledge Base Section introduction for Resource Administers to learn and understand how to work within ResourceSpace

System Administrators

ResourceSpace Knowledge Base article to introduce the System Administrators role within ResourceSpace

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.

Advanced search

The advanced search page provides access to a wider selection of metadata fields, making it possible to create very refined searches. These fields are grouped by resource type, with global fields (those which may apply to any resource) coming at the top of the page, and fields that are specific to a selected resource type further down.

Resource tools

Resource tools provide options and controls for managing each resource. The options you see will depend on your user group permissions but the view here is what you would see if you have full access to the resource and all system actions.

Editing resources

Metadata should be added when the resource is uploaded to ensure it is useful and easily found, however, it is also important to monitor your resources and to keep your metadata relevant and up to date.

Editing multiple resources

As well as editing individual resources , you can also edit multiple resources using a batch edit. This allows you to easily apply the same change to any number of resources in one action which can help with continuity.

Editing resource previews

Resource previews are an important aspect of ResourceSpace as this is the first contact users will have with your resources and is likely to be how they will decide which assests to use. Missing previews are the first thing that should be remedied after upload.

Resource status & access

Resource status and access are central to controlling how ResourceSpace users interact with resources. The Status determines whether the resource can be found or edited by users, the Access controls which users can download the resource.

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.

Deleting resources

There are two ways to delete resources within ResourceSpace: Delete individually Find the resource you wish to delete. Under Resource tools , click Delete Depending on system configuration, you may then have to do one of the following: Confirm your deletion via a pop-up window confirmation Enter your password on the next page to confirm deletion Batch delete Add the resources you wish to delete to a collection.

Related resources

Resources can be linked by relating them in order to help find and group sets of similar, or mutually relevant resources, not to be confused with Alternative files . To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video How to relate resources Relate all resources in a collection Add resources to your selected collection, see Adding to a collection From the collection actions list select "Relate all resources in this collection" You will see a confirmation message to say all resources are now related.

Creating collections

How to create collections within ResourceSpace.

Deleting collections

Users cannot delete their default "My Collection", however it is very simple to delete any other collection. To delete a collection do the following: Go to the "Manage My Collections Page" Click Delete against the collection you wish to delete Confirm deletion of this collection Your collection will now be permanently deleted .

Collection options

There is a list of options available to you from the collection actions dropdown menu. This menu is present in the collection bar and from the "Manage My Collections" page, as well as on the search page when viewing resources in a collection.

Editing a collection

Having Created a collection , making changes to your collection allows you to extend the use of it beyond just a reference holder. The following options are available from the edit screen: Name - Customise the name of your Collection by changing this value.

Keyboard controls

Advanced users may choose to take advantage of keyboard controls to help speed up their use of ResourceSpace. These may be customised system wide but currently are not available as 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.

Annotate

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video Allows annotations to be added to a resource and connected to part of the resource preview.

Embed document

Allows you to embed Document Resource Previews on another website using a short HTML script. The script is generated by doing the following: Browse to the Resource with the configured resource type (Ask your administrator if you are not sure) that you wish to embed on another site.

Embed slideshow

Provides a function to generate HTML for embeddable collection slideshows on remote sites. This allows you to display your gallery externally to your installation. Generate the HTML by doing the following: Create a Collection that you wish to use in your slideshow, this a dynamic collection so any changes to resources within it will also show on the external website.

Embed video

Provides Functionality to embed video in an external site using an HTML script. Generate the HTML: Browse to the Configured Resource Type (Ask your administrator if you are not sure which one that is) Select Embed next to the video resource Copy the HTML and paste into the other site's source Subtitle tracks will also be included if available for the resource.

Image stream

Enables upload of multiple image files as a single zipped resource, with video preview and download. This allows collections of images to be kept together within the system, such as animation frames or sequenced shots.

License manager

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

News

Adds a news segment to the site structure. This allows updates to be posted to the website, allowing further advertising or information to users. If you have permission to add news you can do the following: Browse to Related tools in Admin > Manage News Items Click Create news items Give them a date Give them a headline Body Content You can then Edit and Delete and delete them from the "Manage News Items" page These news items will then be displayed on your website for all to see.

Propose changes

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video This allows users who cannot edit a resource to propose changes to its metadata to administrators.

Video splice

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video The video splice plugin allows users to trim individual videos and to merge videos together within ResourceSpace to create new, separate files.

Youtube publish

Allows publishing of video resources to a configured YouTube account. This plugin will upload data and has configurable mapped fields to automatically add descriptions, titles and tags. Once uploaded a url to the video will be stored against the resource.

Creating dash tiles

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

Managing dash tiles

For some user groups who do not have the permission to manage their own dash, they will not be able to add, remove or rearrange the tiles given to them by the system Administrators. In this case the Admin user will be able to decide exactly how these users see their homepage and will be able to order their tiles for them.

Admin overview

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

Reports

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video ResourceSpace tracks information about downloads, uploads and views and the reports area allows you to gain access to this information.

User resource requests

When users have restricted access to a resource they must place a request before they are able to download it, what happens with the request depends on the 'request mode' setting on the user group.

Collection and resource promotion

Promoting resources and collections is a great way to showcase new and useful content. ResourceSpace offers simple, yet effective ways to do this, meaning your users will always have easy access to the best resources your system has to offer.

Homepage slideshow

As one of the most prominent methods for Promoting resources , updating the homepage slideshow regularly is an important job to keep your users seeing fresh content as well as making your ResourceSpace system look appealing.

User contributions

The way in which your users contribute resources is managed by user group upload permissions. Trusted uploaders (such as administrators) may be granted permission to add resources without the need for review.

Batch replace

This functionality can be useful if you wish to update a number of resources within ResourceSpace. It will replace the original file and regenerate the previews of any number of resources. This can be found by going to the admin menu (top right) then choosing "Resources" then "Replace resource batch".

Deleted resources

Found in Admin > Resources > View deleted resources , this directory contains all of the deleted resources in the system. You can permanently delete or recover resources from this location, either in batches or individually using the normal resource or collection tools.

Resource types

As you will have seen in the Concepts section, well organised metadata is central to working with ResourceSpace, and a key way to arrange your metadata for maximum relevance is through resource types.

Creating a resource type

To create a new resource type: Browse to Admin > System > Resource types Enter the name of your new resource type Click "Create" Fill in the rest of the form as required. See the help text for more information Click "Save" and your new resource type will be available for use Adding an icon You can add an icon to a resource type by clicking the down chevron button at the end of the text input for the "Icon" field.

Understanding resource metadata

Metadata is not only what describes your resources but also what forms the basis of your search. When a resource is uploaded into ResourceSpace it is tagged with words or phrases that best describe the asset.

Indexing metadata

Newly created fields are automatically indexed and available for searching, however there may be times that it isn't desirable to index a field, such as for large text fields where searching fo a word or term within them slows down your search.

Related keywords

Related keywords are managed under Admin > Resources > Related keywords This allows you to create relationships between search terms so that a search for one will also return resources that have the other keyword present in their metadata.

Edit & upload tabs

From v10 You can set a tab name on individual fields in system setup and the fields will then be arranged on tabs. If using the tab feature check out what is the expected behaviour . Before v10 You can set a tab name on individual fields in system setup and the fields will then be arranged on tabs by matching name.

Creating user groups

The default user groups are: Administrators : almost everything, except System Setup (aimed at your internal resources team) Archivist : can edit resources in the 'waiting to be archived' and 'archived' states only.

Creating users

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video User accounts require User groups to create.

User account requests

ResourceSpace has the ability to allow users to request accounts, this is enabled by default but can be turned off in the system config file. Account requests can work in several ways depending how you configure your installation: Manual creation - User submits a form which is then emailed to the administrators email account so that you can set up the user account by following Creating users Automatic creation - requires approval - Requests for accounts are automatically created with the information filled in but you must approve the user from the user page before they can log in Automatic creation - no approval required - Account requests generate an account that is automatically approved and active Automatic creation - no approval for emails ending in a specified domain - Account requests generate an account and if the email matches configuration specified domains, the account is automaticlaly approved.

Advanced user group options

Advanced options are ordinarily hidden from view to make the user group page easier to use. To view these options, click the " > Advanced options" header above the save button. The following is a list of the advanced options available and what they are intended to do: Parent and child arrangements If you have a complex user group arrangement, it can help to organise them under each other.

Writing your own plugins

Nearly all modications for ResourceSpace should be done within your own plugin. You can access portions of code through hooks and you can add styling, configuration, language strings and all manner of content.

Customising the header image

This is an easy way to make your installation your own. From the top "admin" menu choose "System" then "System Configuration". There is an option to replace the header image by simply uploading a new file.

Customising the homepage slideshow

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video Slideshow images can be selected via "Admin" -> "System" -> "Slideshow".

Adding resources to a collection

Resources can be used in as many collections as necessary at any given time. There are several ways to add resources to a collection but in almost all cases you must have that collection active in the collection bar.

CSV upload

This plugin is better suited for administrators and users with elevated permissions in order to obtain the correct information and due to the risk of inserting incorrect data into ResourceSpace. The plugin allows you to edit existing resource metadata as well as to create new resources by uploading a CSV file.

Video tracks

This plugin allows users to create custom video files in alternative formats/codecs. Optionally the user can select subtitle and audio track files that have been uploaded as alternative files for a video resource, thus producing multiliingual variants of videos from within ResourceSpace with no further post-production efforts.

Analytics

The analytics function allows detailed reporting on a variety of system actions which can be broken down by user group and filtered by a number of options.

Version control

Version control functions are available from the resource log. 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. The revert link allows you to undo each edit made to the resource metadata individually.

KE EMu database integration

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

API

ResourceSpace implements a RESTful API that returns JSON. All requests must be signed using a shared private key specific to each user. This can be performed via GET or POST. To make an API call simply access the /api/ URL of your ResourceSpace installation with the following parameters: user The alphanumeric ID of the user to access the system as, for example "admin".

do_search

Perform a search and return the matching resources. Variable Description Data type Default value $search * The search string in the standard ResourceSpace format, see also special search terms .

create_resource

Create a new resource. Variable Description Data type Default value $resource_type * The ID of the resource type for the new resource (e.g. 1=Photo).

copy_resource

Copy a resource. Note that the attached file(s) are not copied - this is a metadata and property copy only. Variable Description Data type Default value $from * The ID of the resource to copy.

get_resource_log

Returns the full log for the resource. Variable Description Data type Default value $resource * The ID of the resource.

update_resource_type

Changes the resource type of a resource (e.g. photo to video). Variable Description Data type $resource * The ID of the resource.

get_resource_path

Returns a URL or file path for a resource file. Variable Description Data type Default value $ref * The ID of the resource or an array of resource IDs.

get_resource_data

Returns the top level property data for the resource. This will include truncated summary metadata. For the full, non truncated metadata, use get_resource_field_data(). Variable Description Data type $resource * The ID of the resource.

get_resource_types

Returns all configured resource types available to this user. No parameters. Return values The configured resource types. [{"ref":"1","name":"Photo","allowed_extensions":"","order_by":"","config_options":"","tab_name":"","push_metadata":""},{"ref":"2","name":"Document","allowed_extensions":"","order_by":"","config_options":"","tab_name":"","push_metadata":""},{"ref":"3","name":"Video","allowed_extensions":"","order_by":"","config_options":"","tab_name":"","push_metadata":""},{"ref":"4","name":"Audio","allowed_extensions":"","order_by":"","config_options":"","tab_name":"","push_metadata":""}

delete_resource

Delete a resource. Variable Description Data type $resource * The ID of the resource.

get_related_resources

Returns a list of resources that are related to a resource. Variable Description Data type $ref * The ID of the resource.

get_user_collections

Returns a list of the user's collections. There are no parameters.

add_resource_to_collection

Add a resource to a collection. Variable Description Data type $resource * The ID of the resource.

create_collection

Create a new collection for the user. Variable Description Data type Default value $name * The name of the collection.

delete_collection

Deletes a collection. The user must have write access to this collection. Variable Description Data type $collection * The ID of the collection.

search_public_collections

Search public and featured collections. Variable Description Data type Default value $search The search terms. Leave blank to return all collections.

Installation overview

ResourceSpace is a standard PHP/MySQL application and the process should be familiar if you've installed other PHP/MySQL applications before. Most issues encountered relate to the default php.ini settings.

Installing on Ubuntu Linux

Be sure to follow the onscreen instructions during installation, accepting default or relevant options including any additional prompts regarding MySQL and Postfix configuration which arise during the installation process (Use Tab, Enter and Arrow Keys for Postfix Controls).

Installing on CentOS Linux

NOTE: The ResourceSpace team does not actively monitor this guide and this article may be out of date. Install from the command line: yum update To install the mysql-server you must include the MySQL Community Repo first.

Installing on SuSE

NOTE: The ResourceSpace team does not actively monitor this guide and this article may be out of date. See the following guide for getting your LAMP stack up and running with a virtual host for resourcespace: http://en.

Installing on Mac OS X

NOTE: The ResourceSpace team does not actively monitor this guide and this article may be out of date. The below instructions will work on earlier versions of OS X with some small alterations. With Snow Leopard there is no need to replace PHP (unlike Leopard) as the provided PHP comes bundled with the GD library.

Upgrading

Upgrading Upgrading ResourceSpace requires Subversion (SVN) to be installed on your server. Before upgrading you should ensure that your system meets the General installation requirements . Navigate to the web root Open a Terminal/Command Prompt and change to the web root where ResourceSpace is installed (i.

Customising the top level navigation

To add additional top navigation links: in the config.php file, or in "Config Override" if setting this on a per-group basis, enter: You can add as many links as you like. They must be numbered sequentially starting from zero (0,1,2,3 etc.

Managing plugins

Plugins are packages that extend or modify ResourceSpace's function and presentation. Plugins have a managed structure which 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.

Creating custom reports

New reports can be created in Admin > System > Reports. A ResourceSpace report is simply an SQL query - those with knowledge of SQL should be able to write new reports given an understanding of the ResourceSpace database.

Watermarks

Watermarks can be enabled in ResourceSpace, by default this will place the watermark image in a tiling pattern over any preview images generated for each resource. To enable watermark preview generation add the following to your config.

Translations

This document describes how to create an official standard translation and how to create a custom translation for your own system. Workflow Before you start working on an official translation you should verify that no other translator is already working with your language - contact the project managers via the contact form on this site in the first instance.

Simple LDAP

WARNING: This plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace. This plugin allows users to log on to ResourceSpace using the same credentials that they use to log on to computers on your organisations network.

search_get_previews

Perform a search and return matching resources including URLs for the requested preview sizes. Variable Description Data type Default value $search * The search string in the standard ResourceSpace format.

Google OAuth

IMPORTANT: In most cases it is better to use SimpleSAML for Google authentication. As of version 10.0 this plugin has been removed. Before you can use the google_oauth plugin you will need to create a Google API Console project.

Antivirus

The plugin allows ResourceSpace to check every file uploaded if it is a known virus. It can be configured to work with any antivirus which has a command line interface. Antivirus plugin has been tested with ClamAV and Sophos .

How to back up your ResourceSpace installation

Ensure that your ResourceSpace open source Digital Asset Management system has appropriate backups in place.

Lockable metadata

Lockable metadata fields can be used to speed up the 'refine metadata process' after uploading new resources. This is intended for use when the default upload sequence is set to 'Upload first, then set metadata'.

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

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video This plugin allows administrators to create user accounts in bulk based on information stored in a CSV file Requirements The format of the CSV is important and must be created according to set rules: The CSV must have a header row The CSV file must be encoded in UTF-8 format and without BOM The CSV should have text cells quoted in case they contain commas or other special characters Make sure the header names match the columns exactly The required column headers are:- username email The optional columns are:-- password fullname account_expires comments ip_restrict lang - the language set for the user will default back to the one set using "$defaultlanguage" config option if the lang column is not found or doesn't have a value For more information on the fields available please refer to Creating users Passwords Please note: If either no password is given to specific users in the CSV or the CSV does not contain a password column, a password will be generated for those users followed by a password reset email sent out to the provided corresponding email address.

Installing on Windows Server

IMPORTANT: Follow the below instructions but keep in mind you may need to adjust to be suitable for your own version of Windows Server OR preferences (name wise). Please make sure the machine has a static IP and that you are using a user who is a member of the local administrators' group.

Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

Video bookend

This allows you to add opening and closing image slides to a video stored in ResourceSpace. You will need to upload your slides as alternative files for the video resource. Under Resource Tools you will see the Bookend option.

ResourceConnect

This plugin allows different ResourceSpace systems to connect to each other to allow searching between installations. ResourceConnect has several advantages over other methods of centralising content: No need to issue a new URL to users.

Troubleshooting

This section of the Knowledge Base should help to diagnose any common issues with using ResourceSpace. Troubleshooting generic issues If you are experiencing problems using ResourceSpace such as files not uploading then a good place to start is the following: Visit the Installation Check page at Admin menu -> System -> Installation check.

Username/password not accepted

Be sure to type out your username while being mindful of case sensitivity. By default in ResourceSpace, 'user123' will be different to 'User123'.

Geolocation

A location can be added to a resource from the resource view page by scrolling down to the section 'Location data' and clicking on the button 'Add location'. Note, this cannot be added from the Resource Edit page.

set_node

Create a new node (option for a fixed list field) Variable Description Data type Default value $ref * The ID of the node to update.

Alternative installation

If you are unfamiliar with installing applications, or are unable to install ResourceSpace on your server, there are simple one-click installers available for Windows, Linux and OS X. These are self-contained packages with everything that is needed to run ResourceSpace and can be quickly installed on your operating system without interfering with your existing software.

resource_log_last_rows

adding information on the log codes recorded in the type field

add_resource_nodes

Add all node IDs (field options) in the list to a resource. Variable Description Data type $resourceid * The ID of the resource to add nodes to integer $nodes * List of node IDs to add (comma separated) string Return values True or false depending on operation success.

add_resource_nodes_multi

Add all node IDs (field options) in the list to the resources specified. Variable Description Data type $resourceid * List of resource IDs to add nodes to (comma separated) string $nodes * List of node IDs to add (comma separated) string Return values True or false depending on operation success.

User opt-in consent

Certain data protection regulations such as the General Data Protection Regulation (GDPR) may require user consent for a system to process their personal data. Configuration option $user_registration_opt_in is enabled by default.

Image banks

The image banks plugin provides the ability to search external image banks for photos without navigating manually to their system. How to use it Searches are run in the external image bank using the simple search box and using the dropdown selector called "Search external image banks".

Security settings

The security settings of your user accounts may be customised within ResourceSpace under System Configuration. The length, complexity and frequency of expiry of your users' passwords can be configured, as can a failed login protocol, determining when a ban is placed upon a user account or IP address.

General installation requirements

ResourceSpace normally operates on the LAMP stack and requires the following core programs: MySQL compliant database MySQL version 5.6+ MariaDB version 10.0.1+ Web server Apache Version 2.

Smart collections

Smart collections can be enabled with the config option $allow_smart_collections which is disabled by default. This will add a new option to the Actions drop-down at the top of the Search page - "Save search as smart collection" which when clicked will create a new Collection for your user.

All user permissions

One of the central features of ResourceSpace is the ability to control which resources users are permitted to see and how they are able to interact with them. Setting user group permissions may grant access as limited as resource viewing only or as open as full edit and download rights.

E-commerce

E-commerce functions are available in ResourceSpace to allow users to purchase different sizes of your Resources at set prices. Payments are processed via PayPal. Enabling e-commerce functionality is done on a per user group basis, the user group should have restricted access to the resource they will be buying (either tick permission 'g' to restrict all resources or use one of the 'X' permissions to restrict access to a specific resource type).

TMS link

Help for setting up the tms_link plugin.

Manage image sizes

When files are uploaded into ResourceSpace they are stored in their original form but derivative files in other resolutions are also created and stored alongside the resource. The default sizes of these derivative files are appropriate for most uses, however you may require a specific size to be available, new sizes can therefore be configured in Admin -> System -> Image Sizes.

CSV export

Metadata can be extracted from the ResourceSpace database as a CSV file, which may then be opened in most standard spreadsheet or database programs. A CSV file may be created for any size collection or number of search results, simply select the CSV Export option from the actions list.

Logs

ResourceSpace maintains a record of the actions of each user, saved as a log which is accessible in the Users section of the Admin area. These 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.

Upload here

Upload here is designed to help users create new resources based on a recent advanced search . In this example, a user has searched for 'photo' type resources in the Active state which are tagged 'Product' and 'United Kingdom'.

Browse bar

While metadata searching is a very powerful tool, for some users, especially those new to ResourceSpace, it can be an unfamiliar way of working. The browse bar, accessed at the left of the screen, can therefore be a great place for people to start finding resources.

Adobe link

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

Resource commenting

Resource commenting can be enabled with the config option $comments_resource_enable . This adds a new area below the resource metadata allowing users to add and respond to comments about the resource.

Search tiles

For use when ResourceSpace is configured to include collections in search results, the Search Tiles plugin displays collection results in a dash tile style with a single collection image. Plugin options allow the tile to be styled with the addition of a collection resource count and shadows on the search tile text.

Accessibility

The accessibility plugin is designed to make ResourceSpace easier to use for those with limited vision by increasing the size and boldness of key text and icons throughout the interface. Group access options allow this to be enabled for users who need it the most.

Image text

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video The Image Text plugin allows the contents of a selected metadata field to be included as a caption when a resource is downloaded.

Grant edit

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video The Grant Edit plugin allows Administrators to permit a user, or user group, edit access to the metadata of a resource they would not normally have permission to edit.

Discount code

This plugin is for E-commerce ResourceSpace installations which allow users to buy resources. The plugin attaches a discount facility for prospective purchasers of resources. Discount codes are setup as follows: Setup an E-commerce usergroup which will define the users capable of purchasing resources from the website.

Checkmail

The Checkmail plugin expands ResourceSpace capability with support for ingestion of resources using email. It enables devices to contribute digital assets to the system. The plugin provides advanced configuration options and the ability to handle a wide range of email types.

Google Analytics

The Google Analytics plugin enables ResourceSpace to track its users' website activity. The plugin triggers the Google Analytics to track activity such as session duration, pages visited per session, bounce rate, exit rate etc.

MuseumPlus

MuseumPlus is a Web-based Museum Management system providing real-time museum management and fully documents any type of collection and all related workflow. API details ResourceSpace will use the API details to successfully communicate with the MuseumPlus service through its API .

Version control

Activated by default via config.php, the rse_version plugin enables the version control functionality, making it possible to revert both individual and batch edits from the resource log page. The rse_version plugin has the ability to revert collection states for adding/removing resources.

Conditional terms

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video With this plugin enabled acceptance of terms and conditions can be made necessary prior to the download of certain resources based on their metadata.

Meta append

Enabling the meta append plugin automatically applies a user definable timestamp and daily upload number to each resource contributed by every user. The field to which the timestamp and upload number should be appended is selected in plugin settings.

Resource bot

The resource bot plugin integrates the familiar Chat Bot functionality from the main ResourceSpace website with your ResourceSpace installation to provide on-hand assistance for your users. With group access options it offers support for those who are less confident but can be disabled for more advanced users.

Resource usage

The Resource usage plugin allows users to keep a log of how a resource has been used, along with the usage medium such as Print or TV. Enabling the plugin adds a new section to the bottom of the resource view page where you can click "New usage" to create a new record of where the resource was used.

Developers

ResourceSpace is an open source project written in PHP and Javascript with the code freely available to browse via SVN: https://www.resourcespace.com/svn For a breakdown of folders within the project please see project structure .

Contributing to the base code

We welcome contributions to the ResourceSpace base code. The process is as follows: Complete the Contributor License Agreement and send it to us . Make sure you're familiar with the Coding Standards .

Auto assign

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video The autoassign_mrequests plugin allows managed resource requests to be automatically assigned to a specific user for approval, based on a metadata field value mapping.

2. Uploading and editing

We can simply drag and drop the files or an entire folder directly from our computer on to the upload queue.

4. Sharing and collections

Sharing single resources is very straightforward. We can send the resource to other users of the system, but we can also enter e-mail addresses and share with people that are not users of the system. They receive a special link that allows them to access only the resource you've shared with them.

5. Working with collections

There are various actions that can be performed that will affect the items in the collection, available from an actions menu on the collection bar.

6. Dash tiles

Collections can be published as dash tiles. The dash is an area on the home page to which users can add their own custom tiles.

7. Reporting

ResourceSpace include comprehensive reporting and analytics capabilities.

Context help links

Context Help links can be added to pages to link to a relevant Knowledge Base page. Help links open Knowledge Base in a modal or new page and look like this: The help links are enabled by default on a ResourceSpace system but can be disabled by setting $contextual_help_links=false; Adding a help link to a page To add a help link to a page use the render_help_link function.

Site content

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

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.

Wordpress_SSO

WARNING: This plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace. This plugin allows users to log on to ResourceSpace using Wordpress single sign-on (SSO) Identity Provider (IdP) Important information Please note that use of this plugin is dependent on your organisation having implemented a SAML compliant single sign-on solution.

get_resource_all_image_sizes

Get all sizes available for a specific resource. Multi page resources should have each page size included as well in the response. Variable Description Data type $resource * The ID of the resource.

Debugging ResourceSpace

debug() function ResourceSpace has an internal function called debug() which is defined in include/db.php For simple or quick debugging of the system, you can pass in the debug text. The debug() function will try and write to the file specified by $debug_log_location in the config file (disabled by default) and constant debugging can be enabled by changing $debug_log to true.

get_node_id

Find a node ID (entry in a fixed tag field) given the name of the node Variable Description Data type $value * The node name string $resource_type_field * The ID of the related metadata field.

Checksums

Checksums are a sequence of numbers and letters produced by running a file through an algorithm which uses a cryptographic hash to produce a unique identifier. Even the slightest change in the original file will produce a different checksum, thus they can be employed to ensure file integrity but also to prevent resource duplication.

Remote assist

This plugin will extend the home page welcome text area to display various help links for using ResourceSpace.

Exporting data

You can export data and the configuration file from ResourceSpace for testing purposes This functionality requires offline jobs to be configured and the config option $system_download_config to be enabled first.

Access control

Overview Access control enforces policy such that users cannot act outside of their intended permissions. Failures typically lead to unauthorized information disclosure, modification or destruction of all data, or performing a business function outside of the limits of the user.

Injection

Overview Injection attacks refer to a broad class of attack vectors. Injection flaws occur when an attacker can send hostile data to an interpreter as part of a command or query. In turn, this alters the execution of that program.

Plugins | ResourceSpace

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

Auto login

The auto_login plugin allows users to be automatically authenticated based on a specified IP pattern. This can be useful where it is necessary that a user be able to login to ResourceSpace but should not have knowledge of account credentials, for example a generic team account.

Vimeo publish

Allows publishing of video resources to a configured Vimeo account. This plugin will upload data and has configurable mapped fields to automatically add descriptions, titles and tags. Once uploaded a url to the video will be stored against the resource.

Creating public collections

Public Collections are an easy way to share groups of resources with other users in the system. They are simple to set up and are a good way for users to highlight the best of their uploads so that administrators can then promote them as Featured collections .

Usage history

ResourceSpace is logging every time a user is downloading a resource from the system, even one of its available sizes. By default this is not shown on the view page of a resource. There are a few configuration options which can change this behaviour as you will see in the Requirements section.

How to restore your ResourceSpace installation

Restoring ResourceSpace If you have followed the guidance on backing up ResourceSpace as per How to backup your ResourceSpace installation , then restoring ResourceSpace to a replacement server in the event of server failure or for migration is straightforward.

Resource locking

Resources can be locked by users with edit access to prevent other users from editing them and potentially causing metadata conflicts. A resource that has been locked cannot have metadata changed, be deleted or be replaced using batch replace.

put_resource_data

Updates the resource properties (not metadata). The API user must have edit access to the resource. Variable Description Data type $resource * The ID of the resource.

Query caching

Overview The results of selected queries can be cached to disk. This is only really useful where it's likely the same query will be called a very large number of times, for example, queries that are common across several pages and the same for large groups of users.

Database schema

Database schema for ResourceSpace.

Intellectual property

All code, images, libraries, and other digital content (hereafter 'material') included in ResourceSpace must meet the following criteria: For material created by yourself, you or your employer must have signed the Contributor License Agreement .

Downloading multiple resources

To download multiple resources in one go you need to either add the resources you want to a collection or select a number of resources from the search results page, then click on 'Download' from the 'Actions' dropdown box.

Sensitive image blurring

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video The sensitive image blurring plugin blurs selected images from users both in the results and on the resource view page.

Extracted text

When uploading document files, ResourceSpace can detect and extract the text contained within the document and use it to populate a configured metadata field. This field can then be indexed, making it possible to search within the system for resource contents, as well as by applied metadata tags.

Metadata templates

If you regularly upload resources with common metadata sets, metadata templates are a good way to save time and ensure consistency. A metadata template is a data only resource that inherits all global fields, as well as all resource type specific fields.

Anonymous access

Useful if you frequently work with third party agencies and don't want to create new user accounts, or if you want to make selected resources available to the public, anonymous access allows non-registered users to access your ResourceSpace system without requiring a login.

Sharing upload links

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video External upload shares Users can have the ability to share upload links externally.

Managing external shares

Managing external shares You can manage your external shares by clicking on the user menu and selecting 'My shares'. Administrators can manage all existing shares via the 'External shares' link under the admin menu The page shows the following information Delete Collection ID (collection shares) Resource ID (individual resource shares) Shared as (the usergroup used for the share) Email - the email the link was sent to (when emailing directly from ResourceSpace), Created by - the user that created the job (admins only) Expires Created Last used Access key - this links directly to the share Share type (view/upload) The delete column has a checkbox for selecting shares to be deleted The tools column has the following options Delete the share Edit share Filtering the shares viewable The page allows you to filter the shares by collection, user group and share type.

update_related_resource

Add or remove resource relationships. Variable Description Data type Default $ref * The ID of the resource. integer $related * Comma separated list of resource IDs to relate or unrelate string $add Set to 1 to add the relationships (default).

Resources slow to create previews

If preview creation takes too long and the system is timing out when creating previews it is usually preferable to set up offline preview creation using the config value below to diable automatic preview creation upon upload: $enable_thumbnail_creation_on_upload = false; and then creating a crontab entry/scheduled task to run the script below: /batch/create_previews.

login

Login with user name and password to retrieve a session API key This key can be used to generate the sign value for subsequent API calls with the 'authmode' parameter set to 'sessionkey'. Refer to the main API documentation for an example Variable Description Data type $username * The username string $password * The current password string Return values A session API key in string form if the login succeeds, FALSE if the credentials are invalid

Modals

Calling and using modals

get_users

Retrieve a list of users Permissions are always honoured so users from other groups to which this user does not have access will be omitted. Variable Description Data type Default value $find A search string, for a partial match on username string "" $exact_username_match Denotes $find must be an exact username boolean false Return values An array of matching user records include ID ("ref"), username, full name and user group ID.

save_collection

Save collection data. Please note that due to the nature of how the web works, it is best to POST the request for this API binding to avoid URL limits being reached. Variable Description Data type $ref * The ID of the collection integer $coldata * JSON encoded collection data.

Geographic search

You can search for resources that have embedded location data by using the geographic search function. To search, drag the map and and zoom to an area of interest (or search for a location using the upper right search button*), then draw a box on the map by dragging to select a search area.

get_collection

Get collection details. This requires administrator access ("a" permission). Variable Description Data type $ref * The collection ID integer Return values The collection details including owner name, description, public/private status, thumbnail image reference.

Image preview zoom

If ResourceSpace is configured with zoomable previews then the user will get to enable the OpenSeadragon viewer on the view page by toggling the image preview zoom tool ( ) available in the image preview toolbar.

Recently added resources

Recently added resources can be viewed by clicking the 'Recent' link in the header. All the latest resources will be displayed here but, of course, users will only see those they have permission to view.

Consent manager

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

User IP restriction

It's possible to limit the locations from which your users access ResourceSpace by applying an IP restriction to user accounts. This is done on a per-user basis, allowing you to maintain tighter controls on certain accounts where necessary.

Mobile responsive mode

ResourceSpace isn't just available from your desktop computer - you can also access it via your smartphone or tablet. The functionality stays exactly the same but the interface automatically adjusts to account for the smaller screen.

Speed tagging

If enabled by the system administrators, speed tagging places a link in the top navigation bar which directs to all resources which do not yet have an entry in a nominated metadata field. Clicking the link will display these resources one at a time, allowing users to add tags into the configured field without requiring edit access to the resource.

get_system_status

Get system status - healthcheck information No parameters. Return values Returns back system status information (configuration dependant - e.g mysql_log_transactions). { "results": { "quota_limit": { "status": "OK", "info": "1% used.

E-commerce and PayPal

E-commerce and PayPal Register Regular PayPal Account For testing within ResourceSpace, register an account using a valid e-mail address. You can use an e-mail address created in addition to your regular business email address if you wish.

System reset

The system reset plugin will completely reset your ResourceSpace installation, deleting all files and data. First, activate the plugin by selecting System then Plugins from the top right menu. Now, from the System menu select the System Reset option.

relate_all_resources

Relate all the provided resources with each other. Used at upload to support $relate_on_upload config option Variable Description Data type $related * Comma separated list of resource IDs.

show_hide_collection

Shows or hides a collection from the user's drop-down list. Variable Description Data type $collection * The ID of the collection integer $show * 1 to show (default), 0 to hide bit (0 or 1) $user * User ref integer Return values True or false depending on operation success.

send_collection_to_admin

Sends a copy of the collection for admin review. Variable Description Data type $collection * The ID of the collection integer Return values True or false depending on operation success.

get_nodes

Get all nodes (fixed keywords) from database for a specific metadata field or parent. Column Type Default Description $resource_type_field * integer ID of the metadata field $parent integer NULL ID of parent node $recursive boolean FALSE Set to true to get children nodes as well.

The Digital Asset Management Buyer's Guide

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

Integrating ResourceSpace with BrandStencil

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

Signing all database PHP code

From version 10.0, for security purposes any PHP code that is stored in the database and can be 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.

Integrating ResourceSpace with RightMarket

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

Prepared statements

All new code must use prepared statements for any SQL execution. As of version 10.0 all SQL queries use prepared statements in the existing codebase after an extensive effort to port all queries.

mark_email_as_invalid

(10.0+) Mark a specified email address as invalid Email addresses marked as invalid will be blocked before send_mail() tries to dispatch any emails, this will be applied to any users with this email address.

Upgrading PHP versions

PHP upgrades As ResourceSpace evolves its dependencies also change over time to ensure code security and to enable improved functionality. Version 10.0 change For ResourceSpace version 10.

Table: activity_log

A log of all user activity across the system. Column Type Note ref int(11) Auto incrementing index logged datetime The date and time of the activity user int(11) See table user log_code char(1) A single character code defining the activity type note text Further information relating to the activity value_old text If the activity involved a change - the old value value_new text If the activity involved a change - the new value value_diff text The difference between the old and new values remote_table varchar(100) The table the activity related to remote_column varchar(100) The column the activity related to remote_ref varchar(100) The row the activity related to This table is empty by default.

Table: annotation

Resource annotations. Column Type Note ref int(11) Auto incrementing index resource int(11) See table resource resource_type_field int(11) See table resource_type_field user int(11) See table user x decimal(17) The coordinates of the annotation.

Table: annotation_node

A join table connecting resource annotations to keyword nodes for annotating resources with fixed list metadata. Column Type Note annotation int(11) See table annotation node int(11) See table node This table is empty by default.

Table: collection

Collections are groups of resources. Column Type Note ref int(11) Auto incrementing index name varchar(100) The collection display name. user int(11) User ID created datetime public int(11) Set to '1' for public collections and featured collections (deprecated - use type instead).

Table: collection_keyword

A join table connecting collections with keywords, for indexing of collections to enable rapid collection searching. Column Type Note collection int(11) See table collection keyword int(11) See table keyword This table is empty by default.

Table: collection_log

A log of all activity relating to a collection. Column Type Note ref int(11) Auto incrementing index date datetime user int(11) See table user collection int(11) See table collection type char(1) Activity type - see include/definitions.

Table: collection_resource

Defines the contents of a collection. Column Type Note collection int(11) See table collection resource int(11) See table resource date_added timestamp Date resource added to collection comment text Used if $collection_commenting=true rating int(11) Used if $collection_commenting=true use_as_theme_thumbnail int(11) (boolean) Use resource as featured collection thumbnail image (if manual selection is set for collection) purchase_size varchar(10) Used if user is an ecommerce user (usergroup request method is 'payment - immediate' or 'payment - invoice') purchase_complete int(11) (boolean) Ecommerce - user has paid purchase_price decimal Price sortorder int(11) Sort order This table is empty by default.

Table: collection_savedsearch

A list of saved searches which can exist within collections. Column Type Note ref int(11) Auto incrementing index collection int(11) See table collection search text The search string restypes text The resource types used when searching starsearch int(11) archive varchar(50) Workflow states (comma separated) created timestamp Date created result_limit int(11) Maximum number of results to return This table is empty by default.

Table: comment

Resource comments. Column Type Note ref int(11) Auto incrementing index ref_parent int(11) Parent comment reference created timestamp hide int(1) (boolean) Hide comment? collection_ref int(11) See table collection resource_ref int(11) See table resource user_ref int(11) See table user fullname varchar(100) External commenter's full name (anonymous access) email varchar(100) Commenter's email (anonymous access) website_url text Commenter's website link (anonymous access) body text Comment text This table is empty by default.

Table: daily_stat

Daily statistics, grouped by day, usergroup and activity type, for easy summaries used by analytics. Column Type Note year int(11) Year the activity took place month int(11) Month the activity took place day int(11) Day the activity took place usergroup int(11) See table usergroup activity_type varchar(50) The activity type code object_ref int(11) The ID of the table in question, such as the resource ID in the case of a resource activity count int(11) How many times this activity was carried out on the object in the day in question by any user external tinyint(1) Did this activity happen via an external share? This table is empty by default.

Table: dash_tile

Dash tiles, displayed on the home page. Column Type Note ref int(11) Auto incrementing index title varchar(255) Title text txt text Tile text all_users int(1) (boolean) Is tile published to all users? default_order_by int(11) Default order url text Anchor link href URL link text Link text reload_interval_secs int(11) resource_count int(1) Number of resources (if search/collection tile) allow_delete int(1) (boolean) Can tile be deleted? This table is empty by default.

Table: dynamic_tree_node

A list of nodes used for category trees. Column Type Note ref int(11) Auto incrementing index resource_type_field int(11) See table resource_type_field parent int(11) The parent node.

Table: external_access_keys

When externally sharing there will be one row here for each resource shared. Column Type Note resource int(11) See table resource access_key char(10) External access key user int(11) See table user usergroup int(11) See table usergroup collection int(11) See table collection request_feedback int(11) (boolean) When emailing external contacts, allow recipients to select resources and add feedback when accessing share email varchar(100) Email address share was created for date datetime Date share created lastused datetime Date share was last accessed access int(11) Access level 0 = open, 1 = restricted expires datetime Share expiration date password_hash varchar(100) Hash of share password (NULL if not set) upload int(11) Set to 0 for standard external view access share, 1 for an external upload share for a collection This table is empty by default.

Table: ip_lockout

IP address lockout - for denying access after a number of invalid login attempts. Column Type Note ip varchar(40) Client IP address tries int(11) Number of login attempts last_try datetime Time and date of last attempt This table is empty by default.

Table: job_queue

The job queue - a list of active offline jobs such as preview processing. Column Type Note ref int(11) Auto incrementing index type varchar(100) Job type e.g. collection_download that matches the name of handler files in include/job_handlers.

Table: keyword

A list of keywords used when indexing. With stemming enabled (the default) the stems are stored as well as the full keywords. Column Type Note ref int(11) Auto incrementing index keyword varchar(100) An individual word, used for indexing/searching.

Table: keyword_related

Defines related keywords. When a keyword is searched for, related keywords are also searched for. Column Type Note keyword int(11) See table keyword related int(11) The ID of the related keyword.

Table: mail_log

A log storing all e-mails sent, mainly for diagnosis purposes. Column Type Note ref int(11) Auto incrementing index date datetime Date and time the e-mail was sent. mail_to varchar(100) Recipient's e-mail address.

Table: message

User messages. Use for system and user to user messaging Column Type Note ref int(11) Auto incrementing index created DATETIME owner int(11) User reference message MEDIUMTEXT Message text url text Message URL.

Table: node

Node keyword list (fixed metadata). Used for the fixed list types such as drop down boxes and category trees. Column Type Note ref int(11) Auto incrementing index resource_type_field int(11) Which metadata field this belongs to.

Table: node_keyword

Keyword nodes are indexed - broken down into single word keywords. Column Type Note node int(11) See table node keyword int(11) See table keyword position int(11) The position within the node string, e.

Table: plugins

Lists all plugins active on the system and stores plugin configuration. Column Type Note name varchar(50) The folder name containing the plugin descrip text A textual description of the plugin loaded from the .

Table: preview_size

Defines preview sizes used for resource preview and thumbnail generation. Column Type Note ref int(11) Auto incrementing index id char(3) Short code e.g. 'scr', 'lpr' width int(11) Width in pixels height int(11) Height in pixels padtosize int(11) (boolean) Add padding to make image required size.

Table: report

Reports as listed in the admin area. Column Type Note ref int(11) Auto incrementing index name varchar(100) Report name. query text SQL defining the report. support_non_correlated_sql tinyint(1) Can this report run on search results? 1 - yes, 0 - no.

Table: report_periodic_emails

Users that have subscribed to receive a report regularly. Column Type Note ref int(11) Auto incrementing index user int(11) See table user send_all_users int(11) Send to all users is deprecated.

Table: report_periodic_emails_unsubscribe

A list of users that have unsubscribed from a periodic email. Column Type Note id int(11) user_id int(11) See table user periodic_email_id int(11) This table is empty by default.

Table: request

Resource requests made by users and fulfilled by admin users, where they users have only 'restricted' access. Column Type Note ref int(11) Auto incrementing index user int(11) See table user collection int(11) See table collection created datetime Date request was recorded.

Table: research_request

Research requests - requests for appropriate resources for a project (for example) Column Type Note ref int(11) Auto incrementing index name text Research (project) name. description text Research description.

Table: resource

A resource is the central record within ResourceSpace mapping to a single asset / file. Column Type Note ref int(11) Auto incrementing index title varchar(200) The resource title, synchronised with the configured title metadata field resource_type int(11) See table resource_type has_image int(11) Does the resource have a preview image? is_transcoding int(11) Is there a transcoding process underway for this resource? hit_count int(11) How many times this resource has been viewed.

Table: resource_custom_access

Defines custom access for a resource - for example that a specific user group has restricted access to a resource. Column Type Note resource int(11) See table resource usergroup int(11) User group ID user int(11) See table user access int(11) Custom access level.

Table: resource_data

Stores free text metadata for a resource. Column Type Note resource int(11) See table resource resource_type_field int(11) See table resource_type_field value MEDIUMTEXT This table is empty by default.

Table: resource_dimensions

Additional metrics for a resource. Column Type Note resource int(11) See table resource width int(11) Resource width height int(11) Resource height file_size bigint(20) File size resolution int(11) Resolution - requires $exiftool_resolution_calc unit varchar(11) Unit information - requires $exiftool_resolution_calc.

Table: resource_keyword

For free text metadata, stores the indexed keywords. Fixed list indexing is stored separately via resource_node and node_keyword. Column Type Note resource int(11) See table resource keyword int(11) See table keyword hit_count int(11) The live hitcount.

Table: resource_log

Logs all activity relating to a resource. Column Type Note ref int(11) Auto incrementing index date datetime Date the log was recorded user int(11) See table user resource int(11) See table resource type char(1) Log type.

Table: resource_node

Links fixed metadata nodes with resources, to store metadata for fixed metadata types such as dropdowns. Column Type Note resource int(11) See table resource node int(11) See table node hit_count int(11) The live hitcount.

Table: resource_related

Defines related resources. Column Type Note resource int(11) See table resource related int(11) List (CSV) of resource IDs related to the resource. This table is empty by default.

Table: resource_type

Resource types, such as photo / video / case study. The choice of resource type will determine the metadata fields a resource has. Column Type Note ref int(11) Auto incrementing index name varchar(200) Resource type name.

Table: site_text

Stores any custom site text the user has entered replacing that stored in the language folder. Column Type Note page varchar(50) Page that text relates to (excludes .php extension) name varchar(200) Name of text string text text The text itself ref int(11) Auto incrementing index language varchar(10) Language code of text e.

Table: slideshow

Stores the home page slideshow images. Column Type Note ref int(11) Auto incrementing index resource_ref int(11) See table resource homepage_show tinyint(1) Include in home page slideshow? featured_collections_show tinyint(1) include in featured collections page? login_show tinyint(1) include in login page sequence? This table is empty by default.

Table: sysvars

System variables, used by upgrade scripts and other non-user functions. Column Type Note name varchar(50) Variable name value text This table is empty by default. Please see the schema overview for context.

Table: user

Stores all ResourceSpace users. Column Type Note ref int(11) Auto incrementing index username varchar(50) Username - users use this to log in password varchar(64) One way encrypted password, using hash chaining to support/upgrade old hash algorithms.

Table: user_collection

Determines which internal users a collection has been shared with. Column Type Note user int(11) See table user collection int(11) See table collection request_feedback int(11) Request feedback when emailing collection? Default contents are as follows.

Table: user_dash_tile

Defines which of the dash tiles are available to a user. Column Type Note ref int(11) Auto incrementing index user int(11) See table user dash_tile int(11) See table dash_tile order_by int(11) Defines dash tile order for user This table is empty by default.

Table: user_message

For multi-user messages defines which users will see the message, and which have seen it. Column Type Note ref int(11) Auto incrementing index user int(11) See table user message int(11) See table message seen int(11) Has user seen message? This table is empty by default.

Table: user_rating

The user ratings for a given resource. Column Type Note user int(11) See table user rating int(11) Rating (out of 5) ref int(11) Resource ID This table is empty by default.

Table: user_report

User specific report parameters. Column Type Note ref int(11) Auto incrementing index name varchar(100) Report name user int(11) See table user params text Report parameters This table is empty by default.

Table: user_userlist

Used for creating custom lists of users if $sharing_userlists is enabled Column Type Note ref int(11) Auto incrementing index user int(11) User ref of list owner userlist_name varchar(50) Name of user list userlist_string text Comma separated list of usernames This table is empty by default.

Table: usergroup

Defines user groups. Column Type Note ref int(11) Auto incrementing index name varchar(100) permissions text A list of permissions that this user group has - see /documentation/permissions.

Table: usergroup_collection

Stored collections shared with user groups. Column Type Note usergroup int(11) See table usergroup collection int(11) See table collection request_feedback int(11) (Deprecated) Request feedback is still used in user_collection and external_access_keys This table is empty by default.

Table: usergroup_dash_tile

Dash tiles configured for user groups. Column Type Note ref int(11) Auto incrementing index usergroup int(11) See table usergroup dash_tile int(11) See table dash_tile default_order_by int(11) Default position of dash tile - ignored if user has reordered their dash order_by int(11) Used to define position of dash tile in relation to others This table is empty by default.

Table: search_log

Search log. Log every search made by the system. Column Type Note ref int(11) Auto incrementing index search_string mediumtext Actual search string resource_types mediumtext Resource types filter archive_states mediumtext Archive states filter logged datetime Date and time of search user int(11) User executing the search result_count int(11) Result count This table is empty by default.

YT2RS (Youtube embed)

The Youtube to ResourceSpace plugin hooks into the resource View page to embed a YouTube video. On the options page for this plugin you can enter the ID of a metadata field that is used to store the URL of the Youtube video.

VM2RS (Vimeo embed)

The Vimeo to ResourceSpace plugin hooks in to the resource view page to embed a Vimeo video. On the options page for this plugin you can enter the ID of a metadata field that is used to store the URL of the Vimeo video.

get_user_actions()

Developer reference for function get_user_actions()

get_editable_resource_sql()

Developer reference for function get_editable_resource_sql()

update_resource_type_order()

Developer reference for function update_resource_type_order()

ajax_permission_denied()

Developer reference for function ajax_permission_denied()

ajax_send_response()

Developer reference for function ajax_send_response()

ajax_send_text_response()

Developer reference for function ajax_send_text_response()

ajax_response_ok()

Developer reference for function ajax_response_ok()

ajax_response_ok_no_data()

Developer reference for function ajax_response_ok_no_data()

ajax_unauthorized()

Developer reference for function ajax_unauthorized()

ajax_build_message()

Developer reference for function ajax_build_message()

getAnnotation()

Developer reference for function getAnnotation()

getAnnotations()

Developer reference for function getAnnotations()

getResourceAnnotationsCount()

Developer reference for function getResourceAnnotationsCount()

getResourceAnnotations()

Developer reference for function getResourceAnnotations()

getAnnotoriousResourceAnnotations()

Developer reference for function getAnnotoriousResourceAnnotations()

annotationEditable()

Developer reference for function annotationEditable()

getAnnotationTags()

Developer reference for function getAnnotationTags()

deleteAnnotation()

Developer reference for function deleteAnnotation()

createAnnotation()

Developer reference for function createAnnotation()

updateAnnotation()

Developer reference for function updateAnnotation()

addAnnotationNodes()

Developer reference for function addAnnotationNodes()

prepareTags()

Developer reference for function prepareTags()

get_api_key()

Developer reference for function get_api_key()

check_api_key()

Developer reference for function check_api_key()

execute_api_call()

Developer reference for function execute_api_call()

get_user_collections()

Developer reference for function get_user_collections()

get_collection()

Developer reference for function get_collection()

get_collection_resources()

Developer reference for function get_collection_resources()

get_collection_resources_with_data()

Developer reference for function get_collection_resources_with_data()

add_resource_to_collection()

Developer reference for function add_resource_to_collection()

collection_writeable()

Developer reference for function collection_writeable()

collection_readable()

Developer reference for function collection_readable()

set_user_collection()

Developer reference for function set_user_collection()

create_collection()

Developer reference for function create_collection()

delete_collection()

Developer reference for function delete_collection()

search_public_collections()

Developer reference for function search_public_collections()

do_collections_search()

Developer reference for function do_collections_search()

add_collection()

Developer reference for function add_collection()

remove_collection()

Developer reference for function remove_collection()

index_collection()

Developer reference for function index_collection()

save_collection()

Developer reference for function save_collection()

get_max_theme_levels()

Developer reference for function get_max_theme_levels()

get_theme_headers()

Developer reference for function get_theme_headers()

themes_comparator()

Developer reference for function themes_comparator()

collections_comparator()

Developer reference for function collections_comparator()

collections_comparator_desc()

Developer reference for function collections_comparator_desc()

get_themes()

Developer reference for function get_themes()

get_smart_theme_headers()

Developer reference for function get_smart_theme_headers()

get_smart_themes_nodes()

Developer reference for function get_smart_themes_nodes()

email_collection()

Developer reference for function email_collection()

generate_collection_access_key()

Developer reference for function generate_collection_access_key()

get_saved_searches()

Developer reference for function get_saved_searches()

add_saved_search()

Developer reference for function add_saved_search()

remove_saved_search()

Developer reference for function remove_saved_search()

add_smart_collection()

Developer reference for function add_smart_collection()

get_search_title()

Developer reference for function get_search_title()

add_saved_search_items()

Developer reference for function add_saved_search_items()

allow_multi_edit()

Developer reference for function allow_multi_edit()

get_theme_image()

Developer reference for function get_theme_image()

swap_collection_order()

Developer reference for function swap_collection_order()

update_collection_order()

Developer reference for function update_collection_order()

get_collection_resource_comment()

Developer reference for function get_collection_resource_comment()

save_collection_resource_comment()

Developer reference for function save_collection_resource_comment()

relate_to_collection()

Developer reference for function relate_to_collection()

get_mycollection_name()

Developer reference for function get_mycollection_name()

get_collection_comments()

Developer reference for function get_collection_comments()

copy_collection()

Developer reference for function copy_collection()

collection_is_research_request()

Developer reference for function collection_is_research_request()

add_to_collection_link()

Developer reference for function add_to_collection_link()

change_collection_link()

Developer reference for function change_collection_link()

get_collection_external_access()

Developer reference for function get_collection_external_access()

delete_collection_access_key()

Developer reference for function delete_collection_access_key()

collection_log()

Developer reference for function collection_log()

get_collection_log()

Developer reference for function get_collection_log()

get_collection_videocount()

Developer reference for function get_collection_videocount()

collection_max_access()

Developer reference for function collection_max_access()

collection_min_access()

Developer reference for function collection_min_access()

collection_set_public()

Developer reference for function collection_set_public()

collection_set_private()

Developer reference for function collection_set_private()

collection_set_themes()

Developer reference for function collection_set_themes()

get_home_page_promoted_collections()

Developer reference for function get_home_page_promoted_collections()

is_collection_approved()

Developer reference for function is_collection_approved()

edit_collection_external_access()

Developer reference for function edit_collection_external_access()

show_hide_collection()

Developer reference for function show_hide_collection()

get_session_collections()

Developer reference for function get_session_collections()

update_collection_user()

Developer reference for function update_collection_user()

compile_collection_actions()

Developer reference for function compile_collection_actions()

get_last_resource_edit()

Developer reference for function get_last_resource_edit()

collection_download_log_resource_ready()

Developer reference for function collection_download_log_resource_ready()

collection_download_process_data_only_types()

Developer reference for function collection_download_process_data_only_types()

collection_download_process_summary_notes()

Developer reference for function collection_download_process_summary_notes()

collection_download_process_collection_download_name()

Developer reference for function collection_download_process_collection_download_name()

collection_download_process_archive_command()

Developer reference for function collection_download_process_archive_command()

collection_cleanup_inaccessible_resources()

Developer reference for function collection_cleanup_inaccessible_resources()

relate_all_collection()

Developer reference for function relate_all_collection()

update_collection_type()

Developer reference for function update_collection_type()

get_user_selection_collection()

Developer reference for function get_user_selection_collection()

delete_old_collections()

Developer reference for function delete_old_collections()

comments_submit()

Developer reference for function comments_submit()

comments_show()

Developer reference for function comments_show()

render_select_option()

Developer reference for function render_select_option()

render_bool_option()

Developer reference for function render_bool_option()

render_text_option()

Developer reference for function render_text_option()

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

delete_dash_tile()

Developer reference for function delete_dash_tile()

get_tile()

Developer reference for function get_tile()

all_user_dash_tile_active()

Developer reference for function all_user_dash_tile_active()

existing_tile()

Developer reference for function existing_tile()

cleanup_dash_tiles()

Developer reference for function cleanup_dash_tiles()

get_alluser_available_tiles()

Developer reference for function get_alluser_available_tiles()

get_managed_dash()

Developer reference for function get_managed_dash()

add_usergroup_dash_tile()

Developer reference for function add_usergroup_dash_tile()

append_usergroup_position()

Developer reference for function append_usergroup_position()

reorder_usergroup_dash()

Developer reference for function reorder_usergroup_dash()

update_usergroup_dash_tile_order()

Developer reference for function update_usergroup_dash_tile_order()

build_usergroup_dash()

Developer reference for function build_usergroup_dash()

get_tile_user_groups()

Developer reference for function get_tile_user_groups()

get_usergroup_available_tiles()

Developer reference for function get_usergroup_available_tiles()

get_usergroup_tile()

Developer reference for function get_usergroup_tile()

add_user_dash_tile()

Developer reference for function add_user_dash_tile()

get_user_tile()

Developer reference for function get_user_tile()

create_new_user_dash()

Developer reference for function create_new_user_dash()

update_user_dash_tile_order()

Developer reference for function update_user_dash_tile_order()

delete_user_dash_tile()

Developer reference for function delete_user_dash_tile()

empty_user_dash()

Developer reference for function empty_user_dash()

reorder_user_dash()

Developer reference for function reorder_user_dash()

append_user_position()

Developer reference for function append_user_position()

get_user_available_tiles()

Developer reference for function get_user_available_tiles()

get_user_dash()

Developer reference for function get_user_dash()

parse_dashtile_link()

Developer reference for function parse_dashtile_link()

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

get_tile_custom_style()

Developer reference for function get_tile_custom_style()

delete_usergroup_dash_tile()

Developer reference for function delete_usergroup_dash_tile()

allowPromotedResources()

Developer reference for function allowPromotedResources()

render_upgrade_available_tile()

Developer reference for function render_upgrade_available_tile()

generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

errorhandler()

Developer reference for function errorhandler()

db_use_multiple_connection_modes()

Developer reference for function db_use_multiple_connection_modes()

db_set_connection_mode()

Developer reference for function db_set_connection_mode()

db_get_connection_mode()

Developer reference for function db_get_connection_mode()

db_clear_connection_mode()

Developer reference for function db_clear_connection_mode()

sql_connect()

Developer reference for function sql_connect()

db_begin_transaction()

Developer reference for function db_begin_transaction()

sql_query_prepared()

Developer reference for function sql_query_prepared()

db_end_transaction()

Developer reference for function db_end_transaction()

db_rollback_transaction()

Developer reference for function db_rollback_transaction()

sql_query()

Developer reference for function sql_query()

sql_value()

Developer reference for function sql_value()

sql_array()

Developer reference for function sql_array()

sql_insert_id()

Developer reference for function sql_insert_id()

get_query_cache_location()

Developer reference for function get_query_cache_location()

clear_query_cache()

Developer reference for function clear_query_cache()

check_db_structs()

Developer reference for function check_db_structs()

CheckDBStruct()

Developer reference for function CheckDBStruct()

sql_limit()

Developer reference for function sql_limit()

check_debug_log_override()

Developer reference for function check_debug_log_override()

create_debug_log_override()

Developer reference for function create_debug_log_override()

rsEncrypt()

Developer reference for function rsEncrypt()

rsDecrypt()

Developer reference for function rsDecrypt()

isPathWhitelisted()

Developer reference for function isPathWhitelisted()

get_checksum()

Developer reference for function get_checksum()

getval()

Developer reference for function getval()

getvalescaped()

Developer reference for function getvalescaped()

getuid()

Developer reference for function getuid()

escape_check()

Developer reference for function escape_check()

unescape()

Developer reference for function unescape()

escape_check_array_values()

Developer reference for function escape_check_array_values()

nicedate()

Developer reference for function nicedate()

redirect()

Developer reference for function redirect()

trim_spaces()

Developer reference for function trim_spaces()

trim_array()

Developer reference for function trim_array()

tidylist()

Developer reference for function tidylist()

tidy_trim()

Developer reference for function tidy_trim()

average_length()

Developer reference for function average_length()

get_stats_activity_types()

Developer reference for function get_stats_activity_types()

get_stats_years()

Developer reference for function get_stats_years()

newlines()

Developer reference for function newlines()

get_all_site_text()

Developer reference for function get_all_site_text()

get_site_text()

Developer reference for function get_site_text()

check_site_text_custom()

Developer reference for function check_site_text_custom()

save_site_text()

Developer reference for function save_site_text()

string_similar()

Developer reference for function string_similar()

get_mime_type()

Developer reference for function get_mime_type()

send_mail()

Developer reference for function send_mail()

send_mail_phpmailer()

Developer reference for function send_mail_phpmailer()

log_mail()

Developer reference for function log_mail()

rs_quoted_printable_encode()

Developer reference for function rs_quoted_printable_encode()

rs_quoted_printable_encode_subject()

Developer reference for function rs_quoted_printable_encode_subject()

pager()

Developer reference for function pager()

send_statistics()

Developer reference for function send_statistics()

remove_extension()

Developer reference for function remove_extension()

get_allowed_extensions()

Developer reference for function get_allowed_extensions()

get_allowed_extensions_by_type()

Developer reference for function get_allowed_extensions_by_type()

getAbsolutePath()

Developer reference for function getAbsolutePath()

mb_basename()

Developer reference for function mb_basename()

strip_extension()

Developer reference for function strip_extension()

is_process_lock()

Developer reference for function is_process_lock()

set_process_lock()

Developer reference for function set_process_lock()

clear_process_lock()

Developer reference for function clear_process_lock()

strip_leading_comma()

Developer reference for function strip_leading_comma()

convert()

Developer reference for function convert()

get_temp_dir()

Developer reference for function get_temp_dir()

convert_path_to_url()

Developer reference for function convert_path_to_url()

escape_command_args()

Developer reference for function escape_command_args()

run_command()

Developer reference for function run_command()

run_external()

Developer reference for function run_external()

error_alert()

Developer reference for function error_alert()

xml_entities()

Developer reference for function xml_entities()

get_xml_entity_at_index_0()

Developer reference for function get_xml_entity_at_index_0()

sanitize_char()

Developer reference for function sanitize_char()

sortmulti()

Developer reference for function sortmulti()

get_imagemagick_path()

Developer reference for function get_imagemagick_path()

get_utility_path()

Developer reference for function get_utility_path()

get_executable_path()

Developer reference for function get_executable_path()

truncate_cache_arrays()

Developer reference for function truncate_cache_arrays()

txt2html()

Developer reference for function txt2html()

is_html()

Developer reference for function is_html()

rs_setcookie()

Developer reference for function rs_setcookie()

get_editable_states()

Developer reference for function get_editable_states()

validate_html()

Developer reference for function validate_html()

generateURL()

Developer reference for function generateURL()

tail()

Developer reference for function tail()

move_array_element()

Developer reference for function move_array_element()

emptyiszero()

Developer reference for function emptyiszero()

array_column()

Developer reference for function array_column()

job_queue_add()

Developer reference for function job_queue_add()

job_queue_update()

Developer reference for function job_queue_update()

job_queue_delete()

Developer reference for function job_queue_delete()

job_queue_get_jobs()

Developer reference for function job_queue_get_jobs()

job_queue_run_job()

Developer reference for function job_queue_run_job()

user_set_usergroup()

Developer reference for function user_set_usergroup()

generateSecureKey()

Developer reference for function generateSecureKey()

IsModal()

Developer reference for function IsModal()

generateAjaxToken()

Developer reference for function generateAjaxToken()

is_resourcespace_upgrade_available()

Developer reference for function is_resourcespace_upgrade_available()

get_recent_users()

Developer reference for function get_recent_users()

check_script_last_ran()

Developer reference for function check_script_last_ran()

count_errors()

Developer reference for function count_errors()

search_array_by_keyvalue()

Developer reference for function search_array_by_keyvalue()

bypass_permissions()

Developer reference for function bypass_permissions()

set_sysvar()

Developer reference for function set_sysvar()

get_sysvar()

Developer reference for function get_sysvar()

hook()

Developer reference for function hook()

strip_tags_and_attributes()

Developer reference for function strip_tags_and_attributes()

show_pagetime()

Developer reference for function show_pagetime()

get_debug_log_dir()

Developer reference for function get_debug_log_dir()

debug()

Developer reference for function debug()

rcRmdir()

Developer reference for function rcRmdir()

daily_stat()

Developer reference for function daily_stat()

pagename()

Developer reference for function pagename()

text()

Developer reference for function text()

get_section_list()

Developer reference for function get_section_list()

resolve_user_agent()

Developer reference for function resolve_user_agent()

get_ip()

Developer reference for function get_ip()

nanoSha2()

Developer reference for function nanoSha2()

char_pad()

Developer reference for function char_pad()

addmod2n()

Developer reference for function addmod2n()

SHR()

Developer reference for function SHR()

ROTR()

Developer reference for function ROTR()

Ch()

Developer reference for function Ch()

Maj()

Developer reference for function Maj()

Sigma0()

Developer reference for function Sigma0()

Sigma1()

Developer reference for function Sigma1()

sigma_0()

Developer reference for function sigma_0()

sigma_1()

Developer reference for function sigma_1()

int_split()

Developer reference for function int_split()

hash()

Developer reference for function hash()

str_split()

Developer reference for function str_split()

sha256()

Developer reference for function sha256()

_nano_sha256()

Developer reference for function _nano_sha256()

lang_or_i18n_get_translated()

Developer reference for function lang_or_i18n_get_translated()

i18n_get_translated()

Developer reference for function i18n_get_translated()

i18n_get_collection_name()

Developer reference for function i18n_get_collection_name()

i18n_get_indexable()

Developer reference for function i18n_get_indexable()

i18n_get_translations()

Developer reference for function i18n_get_translations()

normalize_keyword()

Developer reference for function normalize_keyword()

remove_accents()

Developer reference for function remove_accents()

setLanguage()

Developer reference for function setLanguage()

log_activity()

Developer reference for function log_activity()

logScript()

Developer reference for function logScript()

resource_log_last_rows()

Developer reference for function resource_log_last_rows()

get_activity_log()

Developer reference for function get_activity_log()

get_user_downloads()

Developer reference for function get_user_downloads()

log_node_changes()

Developer reference for function log_node_changes()

generate_session_hash()

Developer reference for function generate_session_hash()

set_login_cookies()

Developer reference for function set_login_cookies()

message_get()

Developer reference for function message_get()

message_add()

Developer reference for function message_add()

message_remove()

Developer reference for function message_remove()

message_seen()

Developer reference for function message_seen()

message_unseen()

Developer reference for function message_unseen()

message_seen_all()

Developer reference for function message_seen_all()

message_purge()

Developer reference for function message_purge()

message_send_unread_emails()

Developer reference for function message_send_unread_emails()

message_remove_related()

Developer reference for function message_remove_related()

message_user_remove()

Developer reference for function message_user_remove()

check_date_parts()

Developer reference for function check_date_parts()

check_view_display_condition()

Developer reference for function check_view_display_condition()

migrate_category_tree_to_nodes()

Developer reference for function migrate_category_tree_to_nodes()

populate_resource_nodes()

Developer reference for function populate_resource_nodes()

random_char()

Developer reference for function random_char()

validateDatetime()

Developer reference for function validateDatetime()

mix_date()

Developer reference for function mix_date()

mix_text()

Developer reference for function mix_text()

alter_data()

Developer reference for function alter_data()

mix_url()

Developer reference for function mix_url()

mix_email()

Developer reference for function mix_email()

get_export_tables()

Developer reference for function get_export_tables()

set_node()

Developer reference for function set_node()

delete_node()

Developer reference for function delete_node()

get_node()

Developer reference for function get_node()

get_nodes()

Developer reference for function get_nodes()

is_parent_node()

Developer reference for function is_parent_node()

get_tree_node_level()

Developer reference for function get_tree_node_level()

reorder_node()

Developer reference for function reorder_node()

reorder_nodes()

Developer reference for function reorder_nodes()

render_new_node_record()

Developer reference for function render_new_node_record()

get_node_order_by()

Developer reference for function get_node_order_by()

draw_tree_node_table()

Developer reference for function draw_tree_node_table()

add_node_keyword()

Developer reference for function add_node_keyword()

remove_node_keyword()

Developer reference for function remove_node_keyword()

remove_all_node_keyword_mappings()

Developer reference for function remove_all_node_keyword_mappings()

check_node_indexed()

Developer reference for function check_node_indexed()

add_node_keyword_mappings()

Developer reference for function add_node_keyword_mappings()

remove_node_keyword_mappings()

Developer reference for function remove_node_keyword_mappings()

add_resource_nodes()

Developer reference for function add_resource_nodes()

add_resource_nodes_multi()

Developer reference for function add_resource_nodes_multi()

get_resource_nodes()

Developer reference for function get_resource_nodes()

delete_resource_nodes()

Developer reference for function delete_resource_nodes()

delete_resource_nodes_multi()

Developer reference for function delete_resource_nodes_multi()

delete_all_resource_nodes()

Developer reference for function delete_all_resource_nodes()

copy_resource_nodes()

Developer reference for function copy_resource_nodes()

update_resource_node_hitcount()

Developer reference for function update_resource_node_hitcount()

get_parent_nodes()

Developer reference for function get_parent_nodes()

get_nodes_count()

Developer reference for function get_nodes_count()

extract_node_options()

Developer reference for function extract_node_options()

get_node_by_name()

Developer reference for function get_node_by_name()

get_node_id()

Developer reference for function get_node_id()

node_name_comparator()

Developer reference for function node_name_comparator()

node_orderby_comparator()

Developer reference for function node_orderby_comparator()

get_node_elements()

Developer reference for function get_node_elements()

get_node_tree()

Developer reference for function get_node_tree()

get_tree_strings()

Developer reference for function get_tree_strings()

get_template_path()

Developer reference for function get_template_path()

process_template()

Developer reference for function process_template()

activate_plugin()

Developer reference for function activate_plugin()

deactivate_plugin()

Developer reference for function deactivate_plugin()

get_plugin_yaml()

Developer reference for function get_plugin_yaml()

is_plugin_activated()

Developer reference for function is_plugin_activated()

handle_rsc_upload()

Developer reference for function handle_rsc_upload()

display_rsc_upload()

Developer reference for function display_rsc_upload()

get_plugin_css()

Developer reference for function get_plugin_css()

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

render_sort_order()

Developer reference for function render_sort_order()

render_dropdown_option()

Developer reference for function render_dropdown_option()

render_actions()

Developer reference for function render_actions()

render_user_group_multi_select()

Developer reference for function render_user_group_multi_select()

render_user_group_select()

Developer reference for function render_user_group_select()

render_user_group_checkbox_select()

Developer reference for function render_user_group_checkbox_select()

render_text_question()

Developer reference for function render_text_question()

render_split_text_question()

Developer reference for function render_split_text_question()

render_dropdown_question()

Developer reference for function render_dropdown_question()

render_access_key_tr()

Developer reference for function render_access_key_tr()

renderBreadcrumbs()

Developer reference for function renderBreadcrumbs()

renderCallToActionTile()

Developer reference for function renderCallToActionTile()

renderLockButton()

Developer reference for function renderLockButton()

render_resource_image()

Developer reference for function render_resource_image()

calculate_image_display()

Developer reference for function calculate_image_display()

render_share_options()

Developer reference for function render_share_options()

render_upload_here_button()

Developer reference for function render_upload_here_button()

render_trash()

Developer reference for function render_trash()

render_browse_bar()

Developer reference for function render_browse_bar()

generate_browse_bar_item()

Developer reference for function generate_browse_bar_item()

render_help_link()

Developer reference for function render_help_link()

render_question_div()

Developer reference for function render_question_div()

render_selected_resources_counter()

Developer reference for function render_selected_resources_counter()

render_edit_selected_btn()

Developer reference for function render_edit_selected_btn()

render_clear_selected_btn()

Developer reference for function render_clear_selected_btn()

render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

render_user_collection_select()

Developer reference for function render_user_collection_select()

check_display_condition()

Developer reference for function check_display_condition()

has_browsebar()

Developer reference for function has_browsebar()

display_upload_options()

Developer reference for function display_upload_options()

render_resource_lock_link()

Developer reference for function render_resource_lock_link()

EditNav()

Developer reference for function EditNav()

SaveAndClearButtons()

Developer reference for function SaveAndClearButtons()

get_report_name()

Developer reference for function get_report_name()

get_reports()

Developer reference for function get_reports()

do_report()

Developer reference for function do_report()

create_periodic_email()

Developer reference for function create_periodic_email()

send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

delete_periodic_report()

Developer reference for function delete_periodic_report()

get_translated_activity_type()

Developer reference for function get_translated_activity_type()

get_request()

Developer reference for function get_request()

get_user_requests()

Developer reference for function get_user_requests()

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

Developer reference for function get_research_requests()

get_research_request()

Developer reference for function get_research_request()

save_research_request()

Developer reference for function save_research_request()

get_research_request_collection()

Developer reference for function get_research_request_collection()

set_research_collection()

Developer reference for function set_research_collection()

get_resource_path()

Developer reference for function get_resource_path()

get_resource_data()

Developer reference for function get_resource_data()

put_resource_data()

Developer reference for function put_resource_data()

create_resource()

Developer reference for function create_resource()

update_hitcount()

Developer reference for function update_hitcount()

save_resource_data()

Developer reference for function save_resource_data()

save_resource_data_multi()

Developer reference for function save_resource_data_multi()

remove_keyword_mappings()

Developer reference for function remove_keyword_mappings()

add_keyword_mappings()

Developer reference for function add_keyword_mappings()

add_keyword_to_resource()

Developer reference for function add_keyword_to_resource()

email_resource()

Developer reference for function email_resource()

delete_resource()

Developer reference for function delete_resource()

get_resource_types()

Developer reference for function get_resource_types()

get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

clear_resource_data()

Developer reference for function clear_resource_data()

copy_resource()

Developer reference for function copy_resource()

resource_log()

Developer reference for function resource_log()

get_resource_log()

Developer reference for function get_resource_log()

get_resource_type_name()

Developer reference for function get_resource_type_name()

get_resource_custom_access()

Developer reference for function get_resource_custom_access()

get_resource_custom_access_users_usergroups()

Developer reference for function get_resource_custom_access_users_usergroups()

save_resource_custom_access()

Developer reference for function save_resource_custom_access()

get_custom_access()

Developer reference for function get_custom_access()

get_themes_by_resource()

Developer reference for function get_themes_by_resource()

update_resource_type()

Developer reference for function update_resource_type()

relate_to_array()

Developer reference for function relate_to_array()

stripMetadata()

Developer reference for function stripMetadata()

write_metadata()

Developer reference for function write_metadata()

update_resource()

Developer reference for function update_resource()

import_resource()

Developer reference for function import_resource()

user_rating_save()

Developer reference for function user_rating_save()

get_resources_matching_keyword()

Developer reference for function get_resources_matching_keyword()

get_resource_access()

Developer reference for function get_resource_access()

get_custom_access_user()

Developer reference for function get_custom_access_user()

edit_resource_external_access()

Developer reference for function edit_resource_external_access()

resource_download_allowed()

Developer reference for function resource_download_allowed()

get_edit_access()

Developer reference for function get_edit_access()

get_metadata_templates()

Developer reference for function get_metadata_templates()

get_resource_collections()

Developer reference for function get_resource_collections()

download_summary()

Developer reference for function download_summary()

check_use_watermark()

Developer reference for function check_use_watermark()

reindex_resource()

Developer reference for function reindex_resource()

get_page_count()

Developer reference for function get_page_count()

update_disk_usage()

Developer reference for function update_disk_usage()

update_disk_usage_cron()

Developer reference for function update_disk_usage_cron()

get_total_disk_usage()

Developer reference for function get_total_disk_usage()

overquota()

Developer reference for function overquota()

get_original_imagesize()

Developer reference for function get_original_imagesize()

generate_resource_access_key()

Developer reference for function generate_resource_access_key()

get_resource_external_access()

Developer reference for function get_resource_external_access()

delete_resource_access_key()

Developer reference for function delete_resource_access_key()

update_archive_status()

Developer reference for function update_archive_status()

delete_resources_in_collection()

Developer reference for function delete_resources_in_collection()

update_related_resource()

Developer reference for function update_related_resource()

can_share_resource()

Developer reference for function can_share_resource()

delete_resource_custom_access_usergroups()

Developer reference for function delete_resource_custom_access_usergroups()

get_video_snapshots()

Developer reference for function get_video_snapshots()

delete_resource_custom_user_access()

Developer reference for function delete_resource_custom_user_access()

copyAllDataToResource()

Developer reference for function copyAllDataToResource()

copyResourceDataValues()

Developer reference for function copyResourceDataValues()

copy_locked_data()

Developer reference for function copy_locked_data()

copyRelatedResources()

Developer reference for function copyRelatedResources()

update_timestamp()

Developer reference for function update_timestamp()

get_extension()

Developer reference for function get_extension()

get_last_resource_edit_array()

Developer reference for function get_last_resource_edit_array()

get_resource_all_image_sizes()

Developer reference for function get_resource_all_image_sizes()

download_link_generate_key()

Developer reference for function download_link_generate_key()

download_link_check_key()

Developer reference for function download_link_check_key()

update_resource_keyword_hitcount()

Developer reference for function update_resource_keyword_hitcount()

copy_hitcount_to_live()

Developer reference for function copy_hitcount_to_live()

get_image_sizes()

Developer reference for function get_image_sizes()

get_preview_quality()

Developer reference for function get_preview_quality()

get_related_resources()

Developer reference for function get_related_resources()

get_resources_by_resource_data_value()

Developer reference for function get_resources_by_resource_data_value()

get_all_image_sizes()

Developer reference for function get_all_image_sizes()

image_size_restricted_access()

Developer reference for function image_size_restricted_access()

get_nopreview_icon()

Developer reference for function get_nopreview_icon()

purchase_set_size()

Developer reference for function purchase_set_size()

payment_set_complete()

Developer reference for function payment_set_complete()

add_verbatim_keywords()

Developer reference for function add_verbatim_keywords()

canSeePreviewTools()

Developer reference for function canSeePreviewTools()

checkPreviewToolsOptionUniqueness()

Developer reference for function checkPreviewToolsOptionUniqueness()

tab_names()

Developer reference for function tab_names()

get_resource_table_joins()

Developer reference for function get_resource_table_joins()

update_resource_lock()

Developer reference for function update_resource_lock()

get_resource_lock_message()

Developer reference for function get_resource_lock_message()

resolve_soundex()

Developer reference for function resolve_soundex()

compile_search_actions()

Developer reference for function compile_search_actions()

search_special()

Developer reference for function search_special()

search_get_previews()

Developer reference for function search_get_previews()

get_upload_here_selected_nodes()

Developer reference for function get_upload_here_selected_nodes()

split_keywords()

Developer reference for function split_keywords()

cleanse_string()

Developer reference for function cleanse_string()

resolve_keyword()

Developer reference for function resolve_keyword()

add_partial_index()

Developer reference for function add_partial_index()

highlightkeywords()

Developer reference for function highlightkeywords()

str_highlight()

Developer reference for function str_highlight()

sorthighlights()

Developer reference for function sorthighlights()

get_suggested_keywords()

Developer reference for function get_suggested_keywords()

get_related_keywords()

Developer reference for function get_related_keywords()

get_grouped_related_keywords()

Developer reference for function get_grouped_related_keywords()

save_related_keywords()

Developer reference for function save_related_keywords()

set_slideshow()

Developer reference for function set_slideshow()

delete_slideshow()

Developer reference for function delete_slideshow()

reorder_slideshow_images()

Developer reference for function reorder_slideshow_images()

getThemePathPerms()

Developer reference for function getThemePathPerms()

validate_user()

Developer reference for function validate_user()

setup_user()

Developer reference for function setup_user()

get_users()

Developer reference for function get_users()

get_users_with_permission()

Developer reference for function get_users_with_permission()

get_user_by_email()

Developer reference for function get_user_by_email()

get_user_by_username()

Developer reference for function get_user_by_username()

get_usergroups()

Developer reference for function get_usergroups()

get_usergroup()

Developer reference for function get_usergroup()

get_user()

Developer reference for function get_user()

save_user()

Developer reference for function save_user()

email_user_welcome()

Developer reference for function email_user_welcome()

email_reset_link()

Developer reference for function email_reset_link()

auto_create_user_account()

Developer reference for function auto_create_user_account()

email_user_request()

Developer reference for function email_user_request()

new_user()

Developer reference for function new_user()

get_active_users()

Developer reference for function get_active_users()

change_password()

Developer reference for function change_password()

make_password()

Developer reference for function make_password()

bulk_mail()

Developer reference for function bulk_mail()

get_user_log()

Developer reference for function get_user_log()

resolve_userlist_groups()

Developer reference for function resolve_userlist_groups()

resolve_userlist_groups_smart()

Developer reference for function resolve_userlist_groups_smart()

check_password()

Developer reference for function check_password()

resolve_users()

Developer reference for function resolve_users()

check_access_key()

Developer reference for function check_access_key()

check_access_key_collection()

Developer reference for function check_access_key_collection()

make_username()

Developer reference for function make_username()

get_registration_selectable_usergroups()

Developer reference for function get_registration_selectable_usergroups()

open_access_to_user()

Developer reference for function open_access_to_user()

open_access_to_group()

Developer reference for function open_access_to_group()

resolve_open_access()

Developer reference for function resolve_open_access()

remove_access_to_user()

Developer reference for function remove_access_to_user()

user_email_exists()

Developer reference for function user_email_exists()

resolve_user_emails()

Developer reference for function resolve_user_emails()

create_password_reset_key()

Developer reference for function create_password_reset_key()

get_rs_session_id()

Developer reference for function get_rs_session_id()

check_share_password()

Developer reference for function check_share_password()

checkPermission_anonymoususer()

Developer reference for function checkPermission_anonymoususer()

checkPermission_dashadmin()

Developer reference for function checkPermission_dashadmin()

checkPermission_dashuser()

Developer reference for function checkPermission_dashuser()

checkPermission_dashmanage()

Developer reference for function checkPermission_dashmanage()

checkPermission_dashcreate()

Developer reference for function checkPermission_dashcreate()

checkperm()

Developer reference for function checkperm()

checkperm_user_edit()

Developer reference for function checkperm_user_edit()

get_video_resolution()

Developer reference for function get_video_resolution()

save_themename()

Developer reference for function save_themename()

ResolveKB()

Developer reference for function ResolveKB()

display_size_option()

Developer reference for function display_size_option()

get_selectedtypes()

Developer reference for function get_selectedtypes()

render_advanced_search_buttons()

Developer reference for function render_advanced_search_buttons()

check_order_by_in_table_joins()

Developer reference for function check_order_by_in_table_joins()

existing_dash_tile()

Developer reference for function existing_dash_tile()

show_upgrade_in_progress()

Developer reference for function show_upgrade_in_progress()

render_audio_download_link()

Developer reference for function render_audio_download_link()

job_queue_get_job()

Developer reference for function job_queue_get_job()

job_queue_purge()

Developer reference for function job_queue_purge()

render_table()

Developer reference for function render_table()

render_array_in_table_cells()

Developer reference for function render_array_in_table_cells()

update_collection_parent()

Developer reference for function update_collection_parent()

validate_collection_parent()

Developer reference for function validate_collection_parent()

allow_collection_share()

Developer reference for function allow_collection_share()

sql_is_null_or_eq_val()

Developer reference for function sql_is_null_or_eq_val()

sql_null_or_val()

Developer reference for function sql_null_or_val()

DrawOption()

Developer reference for function DrawOption()

internal_share_access()

Developer reference for function internal_share_access()

allow_upload_to_collection()

Developer reference for function allow_upload_to_collection()

render_top_page_error_style()

Developer reference for function render_top_page_error_style()

reshape_array_by_value_keys()

Developer reference for function reshape_array_by_value_keys()

permission_j()

Developer reference for function permission_j()

permission_negative_j()

Developer reference for function permission_negative_j()

compute_node_branch_path()

Developer reference for function compute_node_branch_path()

compute_nodes_by_parent()

Developer reference for function compute_nodes_by_parent()

get_resource_nodes_batch()

Developer reference for function get_resource_nodes_batch()

get_resource_data_batch()

Developer reference for function get_resource_data_batch()

is_int_loose()

Description Validate if value is integer or string integer Parameters Column Type Default Description $var mixed - variable to check Return boolean true if variable resolves to integer value This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

cleanup_anonymous_collections()

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

ip_matches()

Description Does the provided $ip match the string $ip_restrict? Used for restricting user access by IP address. Parameters Column Type Default Description $ip string $ip_restrict string Return boolean|integer This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

log_search_event()

Description Log search events Parameters Column Type Default Description $search string Actual search string {@see do_search()} $resource_types array Resource types filter $archive_states array Archive states filter $result_count integer Search result count Return void This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 31st August 2022 15:20 Europe/London time.

process_node_search_syntax_to_names()

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

save_usergroup()

Description Save or create usergroup Parameters Column Type Default Description $ref int Group ref.

get_session_api_key()

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

api_login()

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

get_collections_resource_count()

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

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 $text string The input text e.

can_share_upload_link()

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

can_edit_upload_share()

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

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.

generate_share_key()

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

upload_share_active()

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

upload_share_setup()

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

purge_expired_shares()

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

render_share_password_question()

Parameters Column Type Default Description $blank true Location include/render_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.

get_upload_url()

Description Generate upload URL - alters based on $upload_then_edit setting and external uploads Parameters Column Type Default Description $collection string "" - optional collection $k "" $accesskey string - used for external users Return string This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

emulate_user()

Description Used to emulate system users when accessing system anonymously or via external shares Sets global array such as $userpermissions, $username and sets any relevant config options Parameters Column Type Default Description $user int User ID $usergroup int "" usergroup ID Return void This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

is_authenticated()

Parameters This function accepts no parameters. This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

get_search_params()

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

sql_truncate_text_val()

Description Query helper to ensure code honours the database schema constraints on text columns. IMPORTANT: please use where appropriate! In some cases, truncating may mean losing useful information (e.

render_hidden_input()

Description Render an HTML hidden input Parameters Column Type Default Description $name string Input name $value string Input value Location include/render_functions.

header_add_map_providers()

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

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 htmlspecialchars($leaflet_source["code"]) .

set_geo_map_centerview()

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

get_geo_maps_scripts()

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

is_ecommerce_user()

Description Determine whether the user is setup as an e-commerce user Parameters This function accepts no parameters. Return boolean This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

build_permission()

Description Build a specific permission closure which can be applied to a list of items. Parameters Column Type Default Description $perm string Permission string to build (e.

is_tracking_vars_active()

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

get_tracked_vars()

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

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.

radio_get_layout()

Description Get required rows and columns for use when displaying radio buttons in a table Parameters Column Type Default Description $options array Array of text options Return array (Number of rows, number of columns) Location include/render_functions.

render_radio_buttons_question()

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

rs_password_hash()

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

message_get_conversation()

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

send_user_message()

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

render_message()

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

message_deleteselusrmsg()

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

message_selectedseen()

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

message_selectedunseen()

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

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.

is_not_wildcard_only()

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

can_delete_collection()

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

validate_tile_style()

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

render_antispam_question()

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

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.

search_title_node_processing()

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

get_job_type_priority()

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

validate_remote_code()

Description Attempt to validate remote code. IMPORTANT: Never use this function or eval() on any code received externally from a source that can't be trusted! Parameters Column Type Default Description $code string Remote code to validate Return boolean This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

get_system_status()

Description Get system status information Parameters This function accepts no parameters. Return array This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

get_active_plugins()

Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 374 to 377 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 31st October 2022 11:35 Europe/London time based on the source file dated 2nd September 2022 14:25 Europe/London time.

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.

allowed_type_mime()

Description Convert the permitted resource type extension to MIME type. Used by upload_batch.php Parameters Column Type Default Description $allowedtype $extension string File extension Return string MIME type e.

relate_all_resources()

Description Relate all resources in the passed array with each other Parameters Column Type Default Description $related array [] Array of resource IDs Return boolean Location include/resource_functions.

collection_add_resources()

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

collection_remove_resources()

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

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 string array An array of parameters used in the SQL in the order: type, value, type, value.

copy_value()

Description Copy value as value (flatten / no references) Parameters Column Type Default Description $v This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 19th October 2022 09:20 Europe/London time.

ps_value()

Parameters Column Type Default Description $query $parameters $default $cache "" This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 19th October 2022 09:20 Europe/London time.

ps_array()

Description Like ps_value() but returns an array of all values found NOTE: The value returned must have the column name aliased to 'value' Parameters Column Type Default Description $query string SQL query $parameters array array SQL parameters with types, as for ps_query() $cache string "" Cache category (optional) Return array This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 19th October 2022 09:20 Europe/London time.

ps_param_insert()

Description When constructing prepared statements and using e.g. ref in (some list of values), assists in outputting the correct number of parameters. Parameters Column Type Default Description $count integer How many parameters to insert, e.

display_video_subtitles()

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

report_has_date()

Description Checks for the presence of date placeholders in a report's SQL query. Parameters Column Type Default Description $query string The report's SQL query.

report_has_date_by_id()

Description Checks for the presence of date placeholders in a report's sql query using the report's id. Parameters Column Type Default Description $report int Report id of the report to retrieve the query data from the report table.

reorder_collections()

Description Re-order collections Parameters Column Type Default Description $refs array List of collection IDs in the new order Return void Location include/collections_functions.

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 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

get_approver_usergroups()

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

get_usergroup_approvers()

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

get_dash_search_data()

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

copy_usergroup_permissions()

Description Copy the permissions string from another usergroup Parameters Column Type Default Description $src_id int The group ID to copy from $dst_id int The group ID to copy to Return mixed bool|int True to indicate existing group has been updated or ID of newly created group This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

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.

rrmdir()

Description Recursively remove a folder and its contents. Paths to ignore can be specified. Parameters Column Type Default Description $dir string The folder to delete.

clean_comment_tree()

Description Check all comments that are children of the comment ref provided. If there is a branch made up entirely of hidden comments then remove the branch. Parameters Column Type Default Description $ref int Ref of the comment that is being deleted.

eval_check_signed()

Description Prior to eval() checks to make sure the code has been signed first, by the offline script / migration script. Parameters Column Type Default Description $code string The code to check Return string The code, if correctly signed, or an empty string if not.

sign_code()

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

resign_all_code()

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

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 31st October 2022 11:35 Europe/London time based on the source file dated 5th October 2022 15:05 Europe/London time.

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.

Manage (system) tabs

Applicable version: 10+ Tabs can be used by both metadata fields and resource types. To manage tabs, go to Admin > System > Tabs Please note there will always be a Default (ref #1) tab.

remove_invalid_node_keyword_mappings()

Description Delete invalid node_keyword associations. Note, by invalid, it's meant where the node is missing. Parameters This function accepts no parameters. Location include/node_functions.

get_nodes_use_count()

Description Get a count of how many resources are using the specified nodes Parameters Column Type Default Description $nodes array Array of node refs Return array Array of node ref as keys and number of resources using them as the values Location include/node_functions.

check_delete_nodes()

Description Check array of nodes and delete any that relate to non-fixed list fields and are unused Parameters Column Type Default Description $nodes array Array of node IDs Location include/node_functions.

columns_in()

Description Returns a comma separated list of table columns from the given table. Optionally, will use an alias instead of the table name to prefix the columns. For inclusion in SQL to replace "select " which is not supported when using prepared statements.

sql_limit_with_total_count()

Description Utility function to obtain the total found rows while paginating the results. IMPORTANT: the input query MUST have a deterministic order so it can help with performance and not have an undefined behaviour configuration option (e.

sql_reorder_records()

Description Re-order rows in the table Parameters Column Type Default Description $table string Table name.

escape_quoted_data()

Description Output encoding for HTML & JS within a quoted context when unsafe input is rendered inside it Parameters Column Type Default Description $unsafe string Return string Location include/render_functions.

acl_can_manage_tabs()

Parameters This function accepts no parameters. Location include/tab_functions.php lines 7 to 10 Definition function acl_can_manage_tabs () { return checkperm ( 'a' ); } This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 21st October 2022 16:35 Europe/London time.

get_tabs_with_usage_count()

Description Get tabs (paged) based on some criteria (currently only order by and limit). Parameters Column Type Default Description $criteria array Array holding criteria information (order_by and limit).

get_all_tabs()

Description Get all tab records, sorted by the order_by column Parameters This function accepts no parameters. Return array Location include/tab_functions.php lines 76 to 79 Definition function get_all_tabs () { return ps_query ( 'SELECT ref, `name`, order_by FROM tab ORDER BY order_by' ); } This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 21st October 2022 16:35 Europe/London time.

get_tab_name_options()

Description Get list of all tabs sorted based on current configuration. This always adds a fake record (ref #0) to indicate no assignment. Parameters This function accepts no parameters.

create_tab()

Description Create a new system tab record NOTE: order_by should only be set when re-ordering the set by the user. {@see sql_reorder_records('tab', $refs)} Parameters Column Type Default Description $tab array Return bool|int Return new tab record ID or FALSE otherwise Location include/tab_functions.

delete_tabs()

Description Delete system tabs. IMPORTANT: never allow the "Default" tab (ref #1) to be deleted because this is the fallback location for information that has no association with other tabs.

save_tab()

Description Update an existing tab. NOTE: order_by should only be set when re-ordering the set by the user. {@see sql_reorder_records('tab', $refs)} Parameters Column Type Default Description $tab array A tab record (type) Return bool Returns TRUE if it executed the query, FALSE otherwise Location include/tab_functions.

mark_email_as_invalid()

Description Finds all users with matching email and marks them as having an invalid email Parameters Column Type Default Description $email string Return boolean This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

check_email_invalid()

Description Checks if the email entered is marked as invalid for any users Parameters Column Type Default Description $email string Return boolean true if email is marked invalid for any users with matching email address This article was last updated 31st October 2022 11:35 Europe/London time based on the source file dated 28th October 2022 09:00 Europe/London time.

override_rs_variables_by_eval()

Description Run PHP code on array of variables. Used for modifying $GLOBALS. Parameters Column Type Default Description $variables array Array of variables to apply override on.

get_cattree_nodes_ordered()

Description This function returns an array of category tree nodes in the hierarchical sequence defined in manage options Parameters Column Type Default Description $treefield array - the category tree field to be processed $resource integer null - the resource against which to check for selected nodes - optional $allnodes array false - is true if all nodes in the structure are returned, false if only selected nodes are returned Return array $flatnodes - the array of nodes returned in correct hierarchical order Location include/node_functions.

get_cattree_node_strings()

Description This function returns an array of category tree node strings in the hierarchical sequence defined in manage options The returned strings are i18 translated True (default) strings are paths to nodes; False strings are the individual node names Parameters Column Type Default Description $nodesordered array - the array of nodes in correct hierarchical order $strings_are_paths array true - governs the format of the name returned Return array $strings - the returned array of node paths or node names Location include/node_functions.

cattree_node_creator()

Description Helper function for building node entry arrays for ordering Parameters Column Type Default Description $ref int Node id $resource_type_field int Category tree field id $name string Node name $parent int Parent node id $order_by int Node order by $resource int Resource id $children array Array of child node ids Return array Location include/node_functions.

get_user_message()

Description Gets the user message for the given ref False if user has no access or the requested message doesn't exist, Parameters Column Type Default Description $ref int Message ID $checkaccess bool true Check if user can see the given message? Return array|bool Array with two elements: 'message' => message text,'url'=> message URL and 'owner' => message owner Location include/message_functions.

get_node_strings()

Description This function returns an array of strings that represent the full paths to each tree node passed Parameters Column Type Default Description $resource_nodes array - node tree to parse $allnodes array false - include paths to all nodes -if false will just include the paths to the end leaf nodes Return array $nodestrings - array of strings for all nodes passed in correct hierarchical order Location include/node_functions.

remove_empty_temp_directory()

Description Remove empty folder from path to file. Helpful to remove a temp directory once the file it was created to hold no longer exists. This function should be called only once the directory to be removed is empty.