Search results
get_tile_custom_style()
Developer reference for function get_tile_custom_style()
get_plugin_css()
Developer reference for function get_plugin_css()
render_top_page_error_style()
Developer reference for function render_top_page_error_style()
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.
The Complete Guide to Metadata
Metadata is data that provides information about other data, without describing the content of that data. It is crucial for digital assets and is used to categorize and describe various types of files, such as documents, videos, and audio files.
ResourceSpace plugin for WordPress
A new WordPress plugin has been developed that allows users to embed resource files from ResourceSpace in their posts. The plugin was funded by ADRA International and developed by Codecide. To install the plugin, users should download the WordPress plugin zip file, navigate to Plugins->Add plugins from the WordPress Admin menu and click 'Upload plugin', or manually upload the zip file to the wp-content/plugins directory of the WordPress installation.
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
Open source
ResourceSpace Digital Asset Management System: Open Source, Open Culture, Free Software, Free Forever
Exiftool
Exiftool is a third-party tool that allows for the extraction of embedded data within a file and automatically adds it to the resource metadata upon upload. Administrators can configure the fields where the extracted data is placed, allowing for the inclusion of any metadata stored within the file.
Resource tools
The article discusses the various resource tools available in the resource downloads area of the resource view page. These tools allow users to download, view, and request resource files, as well as perform actions such as adding to a collection or sharing.
Editing resource previews
Resource previews are an important aspect of ResourceSpace as they are the first contact users have with resources and help them decide which assets to use. If previews are missing, they should be remedied after upload.
PDF contact sheet
The article explains how to create a PDF contact sheet for a collection in ResourceSpace. A contact sheet is a quick reference overview of what is in a collection, which can be printed or downloaded. To create a contact sheet, users need to choose the "Contact Sheet" option in the collection Actions list.
Annotate
The article discusses the Annotate feature that allows users to add annotations to a resource and connect them to a part of the resource preview. The annotations could include names or features of note within an image.
Creating dash tiles
Dash tiles are a great way of creating shortcuts to your favourite things in ResourceSpace.
Reports
ResourceSpace offers a reporting section that allows users to access information about downloads, uploads, and views. The reporting section provides a detailed table structure that can be downloaded as a CSV file for spreadsheet software or viewed directly in the browser.
Creating a resource type
This article provides instructions on how to create a new resource type in MODX. To create a new resource type, users need to browse to "Admin > System > Resource types", enter the name of the new resource type, click "Create", fill in the rest of the form as required, and click "Save".
Managing metadata
The article discusses the importance of managing metadata in a system to make searching for resources faster, easier and more intuitive. The article suggests that metadata should be descriptive, clear and complete to ensure that users can search effectively and get the best out of using the system.
Writing your own plugins
A plugin in ResourceSpace is a collection of PHP code, language files, graphics, CSS files and other related files that are structured to conform to the ResourceSpace plugin architecture. For deployment, the files that constitute a plugin are packaged together into a self-contained file called a ResourceSpace Plugin (.
Customising the header image
The article provides a simple guide on how to customize the header image of an installation. Users can access the option to replace the header image by navigating to the "System Configuration" option under the "System" menu on the admin page.
Advanced workflow
workflow, process, publish, embargo, archive, review,state, status
Version control
The article explains how to use version control functions from the resource log. Users can click on a log entry to bring up a page showing the full log entry, and a revert link will be displayed where it is relevant.
do_search
The article provides a description of the do_search function, which is used to perform a search and return matching resources. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, and offset.
get_resource_field_data
The article provides information about the function "get_resource_field_data" which returns all field data for a given resource. The function requires the ID of the resource as input and returns a JSON containing the resource metadata.
create_resource
The article provides a function called "create_resource" that creates a new resource. The function requires the ID of the resource type for the new resource, which is an integer value. The archival state of the new resource is optional, and the default value is 999.
update_field
The article provides information on the update_field function, which is used to set the value of a metadata field. The function requires the ID of the resource, the numeric ID or shortname of the field, and the value to set the field to.
copy_resource
The article provides information on the "copy_resource" function, which is used to copy a resource. The function only copies metadata and property, not the attached files. The function requires the ID of the resource to be copied and the ID of the resource type for the new resource.
get_resource_log
The "get_resource_log" function returns the full log for a resource. The function takes two parameters: the ID of the resource and the number of rows to return. The default value for the number of rows is -1, which means that all rows will be returned.
update_resource_type
The article describes the function update_resource_type, which is used to change the resource type of a resource. The function takes two parameters: the ID of the resource and the new resource type ID.
get_resource_path
The get_resource_path function returns a URL or file path for a resource file. It takes several parameters, including the ID of the resource or an array of resource IDs, a flag indicating whether a file path should be returned instead of a URL, the size of the requested file, and whether the path should be generated if it does not yet exist on disk.
get_resource_data
The article provides information about the function get_resource_data() which returns the top-level property data for a resource. The function includes truncated summary metadata, and for full, non-truncated metadata, the function get_resource_field_data() should be used.
get_alternative_files
The article describes a function called "get_alternative_files" that returns a list of alternative files for a given resource. The function takes in three optional parameters: $orderby, $sort, and $type.
add_alternative_file
The article provides information on the function "add_alternative_file" which is used to add a new alternative file. The function requires the ID of the resource and a short descriptive name for the new alternative file.
delete_alternative_file
The article provides information on the function 'delete_alternative_file' which is used to delete an alternative file. The function requires two parameters, the ID of the resource and the ID of the alternative file, both of which are of integer data type.
upload_file
The "upload_file" function allows users to upload a new local file to an existing resource, replacing any file that is already attached. The function takes in several variables, including the ID of the resource, a flag to process embedded metadata, a flag to re-process an existing file, a flag to automatically rotate images, and the path on disk of the file to upload.
upload_file_by_url
The "upload_file_by_url" function allows users to upload a new remote file to an existing resource, replacing any file that is already attached. The function requires the ID of the resource, which must already exist, and the URL of the file to upload.
delete_resource
The article provides information on how to delete a resource using the delete_resource function. The function requires the ID of the resource to be deleted, which should be an integer. The article does not provide any information on the type of resource that can be deleted using this function.
get_related_resources
The article describes a function called "get_related_resources" which returns a list of resources that are related to a particular resource. The function takes a single parameter, which is the ID of the resource.
get_field_options
The get_field_options function returns all the available tags or selectable options for a given field. The function takes two parameters: $ref, which is the ID or shortname of the field, and $nodeinfo, which provides extended field option information if set to TRUE.
add_resource_to_collection
The article provides a brief description of the add_resource_to_collection function, which is used to add a resource to a collection. The function takes two parameters, $resource and $collection, which are the IDs of the resource and collection, respectively.
remove_resource_from_collection
The article provides a brief description of the "remove_resource_from_collection" function, which is used to remove a resource from a collection. The function requires two parameters: the ID of the resource and the ID of the collection from which the resource needs to be removed.
create_collection
This article provides instructions on how to create a new collection for a user. The user needs to provide a name for the collection, which is a required field. If the user wants to use the standard upload naming format, they can set the $forupload variable to true and leave the name field empty.
delete_collection
The "delete_collection" function is used to delete a collection, and the user must have write access to the collection. The function requires the ID of the collection, which is an integer data type. The return values of the function are either true or false, depending on the success of the operation.
Watermarks
ResourceSpace allows users to enable watermarks on preview images generated for each resource. To enable watermark preview generation, users need to add the following to their config.php: $watermark = "gfx/watermark.
search_get_previews
The article describes the search_get_previews function, which is used to perform a search and return matching resources including URLs for the requested preview sizes. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, recent search day limit, preview sizes, and preview file extension.
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.
IIIF
IIIF is an API specification that aims to improve interoperability between digital image repositories. ResourceSpace provides basic support for the IIIF presentation API, which was originally created to link with the TMS plugin to enable publishing of resources related to a specified TMS object as a IIIF manifest.
set_node
The article provides information on the set_node function, which is used to create a new node in ResourceSpace. The function requires the ID of the node to be updated, the ID of the related metadata field, and the name of the node.
add_resource_nodes
The article provides a brief description of the add_resource_nodes function, which is used to add all node IDs in a list to a resource. The function takes two parameters: the ID of the resource to add nodes to and a list of node IDs to add.
add_resource_nodes_multi
The article describes a function called "add_resource_nodes_multi" which adds all node IDs in a list to the specified resources. The function takes two parameters: $resourceid, which is a list of resource IDs to add nodes to, and $nodes, which is a list of node IDs to add.
Offline job queues
ResourceSpace has developed an offline jobs function to delegate slow processes, such as creating a preview for a video file, to another script/process to be run asynchronously. The upload process focuses on getting files into the filestore, later working from a queue for further processing.
Search tiles
The Search Tiles plugin is designed to be used with ResourceSpace when collections are included in search results. It displays collection results in a dash tile style with a single collection image. The plugin offers options to style the tile, including the addition of a collection resource count and shadows on the search tile text.
Developers
The article provides information for developers interested in working with ResourceSpace, an open source project written in PHP and Javascript. The code is freely available to browse via SVN, and the article provides links to the project structure and database schema.
Coding standards v1.3
The article provides coding standards for developers working on the ResourceSpace project. The standards cover various aspects of coding, including security, documentation, functionality, PHP version, MySQL strict mode, backward compatibility, file format, coding style, indentation, line length, control structures, function calls, function definitions, MySQL statements, readability of code blocks, returning early, and avoiding cross-site scripting vulnerabilities.
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.
replace_resource_file
The article describes the function 'replace_resource_file' which replaces the primary resource file for a given resource. The function requires the ID of the resource to replace the file for and the file path or URL of the file to use as the replacement.
get_resource_all_image_sizes
The article describes a function called "get_resource_all_image_sizes" which is used to retrieve all available sizes for a specific resource. The function takes in the ID of the resource as an input and returns a JSON object containing all the available sizes for the resource.
get_node_id
The get_node_id function is used to find a node ID in a fixed tag field by providing the name of the node and the ID of the related metadata field. The function returns the ID of the existing node or boolean FALSE if no matching node was found for the specified field.
The Complete Guide to Developing Your Brand Guidelines Download
Thank you for downloading the PDF version of our Guide to Developing Your Brand Guidelines.
ResourceSpace Plugins
Explore the range of plugins that are available to expand ResourceSpace's base functionality, including integrations with third party software and systems.
How to restore your ResourceSpace installation
This article provides guidance on how to restore a ResourceSpace installation to a replacement server in the event of server failure or migration. The steps described in the article restore the existing ResourceSpace configuration, but do not cover custom ResourceSpace code, external directories used by ResourceSpace, DNS changes, or web or proxy server configuration.
put_resource_data
The put_resource_data API endpoint allows users with edit access to update the properties of a resource. The endpoint requires the ID of the resource and an associative array of columns and values in JSON format.
Database schema
Database schema for ResourceSpace.
Project structure
A breakdown of the folders used within ResourceSpace, and their typical contents and function.
ResourceSpace software design principles
ResourceSpace, an open-source digital asset management software, has outlined its design principles for developers. The principles include the KISS (Keep It Simple Stupid) principle, which advises against implementing complex solutions when a simple one will suffice, and avoiding introducing new technology when existing technology will suffice.
update_related_resource
The article describes the update_related_resource API endpoint, which allows users to add or remove resource relationships. The endpoint requires the ID of the resource and a comma-separated list of resource IDs to relate or unrelate.
login
The article provides instructions on how to log in with a username 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'.
get_users
The article provides information on the get_users function, which is used to retrieve a list of users. The function honours permissions, so users from other groups to which the user does not have access will be omitted.
Configuring Leaflet Maps
This article provides a guide to configuring Leaflet maps in ResourceSpace. The article lists several configuration options that can be used to add tile sources and customize how geolocation data is displayed.
Further videos
The article provides a list of videos that cover various topics related to using the ResourceSpace digital asset management system. The videos cover topics such as creating users, customizing the homepage slideshow, search filters, sharing resources, and more.
Image tools
The Image Tools plugin enables users to edit images by rotating, cropping or scaling them. The plugin also allows users to modify the home slideshow image using resources that have previously been uploaded to ResourceSpace.
Offline archive
The Offline Archive plugin allows users to relocate archived files to an offline location. Once enabled, users can configure the plugin to specify how the relocation will occur. There are four configuration options available: selecting the metadata field that will hold the archive reference code, entering the location that the archives will be created in, specifying a subfolder of the StaticSync folder that restored files will be placed in, and determining whether to carry across the timestamp of the original file.
relate_all_resources
The "relate_all_resources" function is used to relate all the provided resources with each other. This function is used to support the "$relate_on_upload" configuration option. The function takes a comma-separated list of resource IDs as input and returns a boolean value indicating whether the operation was successful or not.
show_hide_collection
The show_hide_collection function allows users to show or hide a collection from their drop-down list. The function requires three variables: the ID of the collection, a bit value of 1 to show or 0 to hide, and the user reference.
send_collection_to_admin
The article provides a brief description of the function "send_collection_to_admin" which sends a copy of the collection for admin review. The function takes one parameter, $collection, which is the ID of the collection and has a data type of integer.
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.
mark_email_as_invalid
The article describes a function called "mark_email_as_invalid" that can be used to mark a specified email address as invalid. This function can be used to block email addresses before the send_mail() function tries to dispatch any emails.
get_user_message
The article describes a function called "get_user_message" which retrieves a given message ID. The function only allows access to messages that belong to the user who is requesting them. The function takes a single parameter, which is the message ID, and returns an array with three elements: the message text, the message URL, and the message owner.
get_users_by_permission
The article describes a function called "get_users_by_permission" that retrieves information on all users with the given permissions. The function is available in version 10.1 or later and requires an array of permission strings as input.
OpenAI GPT
OpenAI's GPT language model has been integrated into ResourceSpace, a digital asset management system, to automate metadata processing tasks. The plugin allows users to use GPT to populate metadata fields based on data stored in another field.
The Beginner's Guide to Managing Consent for Charities & Non-Profits
The article provides a beginner's guide to managing consent for charities and non-profits. It covers different types of consent and how they can be obtained, as well as looking at the intricacies of specific use cases and best practices when consent is in place.
The Beginner's Guide to Managing Consent for Charities & non-profits Download
Thank you for downloading the PDF version of The Beginner's Guide to Managing Consent.
What is Digital Asset Management?
Digital Asset Management is critical for managing and securing digital assets. Explore the benefits of DAM, its use cases, and how it streamlines asset management.
Do you need a Digital Asset Management system? Find out here.
A Digital Asset Management (DAM) system can help organizations overcome various challenges related to managing digital assets. These challenges may include difficulties in finding specific files, using outdated assets, licensing and copyright issues, and sharing large files with external contacts.
upload_multipart
The "upload_multipart" function allows users to upload files using HTTP multipart to an existing resource. This function is available from version 10.2+ of the software. The function requires several variables to be provided, including the ID of the resource, a boolean value to indicate whether to process embedded metadata, a boolean value to indicate whether to re-process the existing file, and the file to be uploaded.
get_resource_type_fields
The "get_resource_type_fields" function allows users to retrieve metadata field information for all matching fields. This function is available from version 10.3+ and requires permission "a". Users can filter the results by resource type, fuzzy searching, and field type.
create_resource_type_field
The article provides information about the "create_resource_type_field" function. This function allows users to retrieve metadata field information for all matching fields. It is available from version 10.
Configuring the download filename format
ResourceSpace version 10.3 introduces a new system-wide configuration that allows administrators to format the final download filename. This configuration applies to resources and their alternatives, including preview sizes.
A Comprehensive Guide to Digital Curation: Tools and Techniques
Explore the world of digital curation. Learn about the concepts, tools, and techniques used to curate and preserve historical and culturally significant assets.
get_featured_collections
The "get_featured_collections" function in ResourceSpace allows users to retrieve featured collections (categories) from version 10.3 onwards. The function requires the "parent" parameter, which is the reference of the featured collection's parent.
Navigating Consent and Digital Asset Management
Consent is not just limited to personal contact information or medical records; it also applies to artwork, photos, and videos where a person is identifiable. Digital asset managers need to have robust consent policies and procedures in place to comply with regulations and protect the privacy of individuals.
get_edit_access
The "get_edit_access" function is used to check if the current user has edit access to a resource. It checks both the edit permissions and the group edit filter. The function takes a resource ID as a parameter and returns TRUE if the user has edit access to the resource, and FALSE otherwise.
consentmanager_get_consents
The "consentmanager_get_consents" function is used to retrieve all consent data for a given resource. The function takes a variable called "$resource" which represents the ID of the resource. The data type for this variable is an integer.
licensemanager_get_licenses
The article provides information about the "licensemanager_get_licenses" function, which is used to return all licenses held for a given resource. The function takes a variable called "$resource" as input, which represents the ID of the resource.
Configuring image alternatives
The article discusses configuring image alternatives using the "$image_alternatives" configuration option, similar to video file alternatives. This setting controls the options for ImageMagick utility to create alternative image formats/sizes.
toggle_active_state_for_nodes
The article discusses the function "toggle_active_state_for_nodes," available from version 10.4+ and requiring permission "k." It involves toggling nodes' active state, with a list of node IDs as input.
Table: collection
This article provides a table that outlines the structure of a collection in ResourceSpace, which is a group of resources. The table includes columns such as ref, name, user, created, public, theme, theme2, theme3, allow_changes, cant_delete, keywords, savedsearch, home_page_publish, home_page_text, home_page_image, session_id, description, type, parent, thumbnail_selection_method, bg_img_resource_ref, and order_by.
Table: keyword
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 13661 tokens. Please reduce the length of the messages.
Table: node
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10911 tokens. Please reduce the length of the messages.
Table: node_keyword
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 12343 tokens. Please reduce the length of the messages.
Table: preview_size
The article provides a table called "preview_size" that defines the preview sizes used for resource preview and thumbnail generation. The table has ten columns, including an auto-incrementing index, a short code, width and height in pixels, a boolean value to add padding to make the image the required size, a friendly name, a boolean value for system use to prevent deletion, and two boolean values to show a link to preview this size on the resource view page and allow users with restricted access to see this preview size.
Table: report
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4846 tokens. Please reduce the length of the messages.
Table: resource_type
This article provides a table of the resource_type database schema used in ResourceSpace, a digital asset management system. The resource_type table contains information about the types of resources, such as photo, video, or case study, and determines the metadata fields that a resource has.
Table: resource_type_field
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10794 tokens. Please reduce the length of the messages.
Table: user_collection
The article provides information about the user_collection table, which is used to determine which internal users a collection has been shared with. The table has three columns: user, collection, and request_feedback.
Table: usergroup
The article provides a table called "usergroup" that defines user groups. The table contains several columns, including "ref," which is an auto-incrementing index, "name," which is the name of the user group, and "permissions," which is a list of permissions that the user group has.
Table: tab
This article provides information about the "tab" table, which is used for organising metadata fields on the edit and view pages. The table has three columns: "ref", which is an auto-incrementing index; "name", which is a varchar(255) type; and "order_by", which is an integer type.
Table: resource_type_field_resource_type
Links resource_type_field records to resource_type. Used when the global column in resource_type_field is set to 0; Column Type Note resource_type_field int(11) See table resource_type_field resource_type int(11) See table resource_type Default contents are as follows.
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_field_order()
Developer reference for function update_resource_type_field_order()
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_fail()
Developer reference for function ajax_response_fail()
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()
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()
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()
remove_resource_from_collection()
Developer reference for function remove_resource_from_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()
refresh_collection_frame()
Developer reference for function refresh_collection_frame()
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()
send_collection_feedback()
Developer reference for function send_collection_feedback()
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()
remove_all_resources_from_collection()
Developer reference for function remove_all_resources_from_collection()
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()
makeFilenameUnique()
Developer reference for function makeFilenameUnique()
new_featured_collection_form()
Developer reference for function new_featured_collection_form()
get_last_resource_edit()
Developer reference for function get_last_resource_edit()
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()
collection_download_log_resource_ready()
Developer reference for function collection_download_log_resource_ready()
update_zip_progress_file()
Developer reference for function update_zip_progress_file()
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_csv_metadata_file()
Developer reference for function collection_download_process_csv_metadata_file()
collection_download_process_command_to_file()
Developer reference for function collection_download_process_command_to_file()
collection_download_process_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_download_clean_temp_files()
Developer reference for function collection_download_clean_temp_files()
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()
validate_field()
Developer reference for function validate_field()
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()
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()
get_header_image()
Developer reference for function get_header_image()
config_register_core_fieldvars()
Developer reference for function config_register_core_fieldvars()
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()
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()
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()
checkTileConfig()
Developer reference for function checkTileConfig()
checkConfigCustomHomePanels()
Developer reference for function checkConfigCustomHomePanels()
get_alluser_available_tiles()
Developer reference for function get_alluser_available_tiles()
get_default_dash()
Developer reference for function get_default_dash()
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()
render_delete_dialog_JS()
Developer reference for function render_delete_dialog_JS()
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()
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()
check_debug_log_override()
Developer reference for function check_debug_log_override()
create_debug_log_override()
Developer reference for function create_debug_log_override()
debug_function_call()
Developer reference for function debug_function_call()
rsEncrypt()
Developer reference for function rsEncrypt()
rsDecrypt()
Developer reference for function rsDecrypt()
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()
isPathWhitelisted()
Developer reference for function isPathWhitelisted()
get_checksum()
Developer reference for function get_checksum()
nicedate()
Developer reference for function nicedate()
error_alert()
Developer reference for function error_alert()
txt2html()
Developer reference for function txt2html()
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()
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()
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()
normalize_keyword()
Developer reference for function normalize_keyword()
remove_accents()
Developer reference for function remove_accents()
seems_utf8()
Developer reference for function seems_utf8()
http_get_preferred_language()
Developer reference for function http_get_preferred_language()
setLanguage()
Developer reference for function setLanguage()
perform_login()
Developer reference for function perform_login()
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()
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()
check_date_parts()
Developer reference for function check_date_parts()
check_view_display_condition()
Developer reference for function check_view_display_condition()
migrate_resource_type_field_check()
Developer reference for function migrate_resource_type_field_check()
migrate_category_tree_to_nodes()
Developer reference for function migrate_category_tree_to_nodes()
populate_resource_nodes()
Developer reference for function populate_resource_nodes()
migrate_filter()
Developer reference for function migrate_filter()
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_filename()
Developer reference for function mix_filename()
mix_email()
Developer reference for function mix_email()
safe_export()
Developer reference for function safe_export()
get_export_tables()
Developer reference for function get_export_tables()
edit_filter_to_restype_permission()
Developer reference for function edit_filter_to_restype_permission()
set_node()
Developer reference for function set_node()
delete_node()
Developer reference for function delete_node()
delete_nodes_for_resource_type_field()
Developer reference for function delete_nodes_for_resource_type_field()
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()
get_root_node_by_leaf()
Developer reference for function get_root_node_by_leaf()
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()
node_field_options_override()
Developer reference for function node_field_options_override()
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()
get_nodes_from_keywords()
Developer reference for function get_nodes_from_keywords()
update_resource_node_hitcount()
Developer reference for function update_resource_node_hitcount()
copy_resource_type_field_nodes()
Developer reference for function copy_resource_type_field_nodes()
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_pdf_template_path()
Developer reference for function get_pdf_template_path()
generate_pdf()
Developer reference for function generate_pdf()
get_template_path()
Developer reference for function get_template_path()
process_template()
Developer reference for function process_template()
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()
activate_plugin()
Developer reference for function activate_plugin()
deactivate_plugin()
Developer reference for function deactivate_plugin()
purge_plugin_config()
Developer reference for function purge_plugin_config()
get_plugin_yaml()
Developer reference for function get_plugin_yaml()
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()
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()
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()
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_search_field()
Developer reference for function render_search_field()
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()
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()
renderBreadcrumbs()
Developer reference for function renderBreadcrumbs()
renderCallToActionTile()
Developer reference for function renderCallToActionTile()
renderSocialMediaShareLinksForUrl()
Developer reference for function renderSocialMediaShareLinksForUrl()
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_field_selector_question()
Developer reference for function render_field_selector_question()
render_filter_bar_button()
Developer reference for function render_filter_bar_button()
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_custom_fields()
Developer reference for function render_custom_fields()
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()
render_csrf_data_attributes()
Developer reference for function render_csrf_data_attributes()
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()
display_field_data()
Developer reference for function display_field_data()
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()
unsubscribe_user_from_periodic_report()
Developer reference for function unsubscribe_user_from_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()
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()
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()
set_resource_defaults()
Developer reference for function set_resource_defaults()
save_resource_data_multi()
Developer reference for function save_resource_data_multi()
append_field_value()
Developer reference for function append_field_value()
remove_keyword_mappings()
Developer reference for function remove_keyword_mappings()
remove_keyword_from_resource()
Developer reference for function remove_keyword_from_resource()
add_keyword_mappings()
Developer reference for function add_keyword_mappings()
add_keyword_to_resource()
Developer reference for function add_keyword_to_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()
email_resource()
Developer reference for function email_resource()
delete_resource()
Developer reference for function delete_resource()
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_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()
get_max_resource_ref()
Developer reference for function get_max_resource_ref()
get_resource_ref_range()
Developer reference for function get_resource_ref_range()
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()
get_exiftool_fields()
Developer reference for function get_exiftool_fields()
createTempFile()
Developer reference for function createTempFile()
stripMetadata()
Developer reference for function stripMetadata()
write_metadata()
Developer reference for function write_metadata()
delete_exif_tmpfile()
Developer reference for function delete_exif_tmpfile()
update_resource()
Developer reference for function update_resource()
import_resource()
Developer reference for function import_resource()
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()
user_rating_save()
Developer reference for function user_rating_save()
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_resources_matching_keyword()
Developer reference for function get_resources_matching_keyword()
get_keyword_from_option()
Developer reference for function get_keyword_from_option()
add_field_option()
Developer reference for function add_field_option()
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()
filter_match()
Developer reference for function filter_match()
log_diff()
Developer reference for function log_diff()
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()
autocomplete_blank_fields()
Developer reference for function autocomplete_blank_fields()
get_resource_files()
Developer reference for function get_resource_files()
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()
notify_user_resources_approved()
Developer reference for function notify_user_resources_approved()
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()
resource_type_config_override()
Developer reference for function resource_type_config_override()
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()
truncate_join_field_value()
Developer reference for function truncate_join_field_value()
get_video_snapshots()
Developer reference for function get_video_snapshots()
resource_file_readonly()
Developer reference for function resource_file_readonly()
delete_resource_custom_user_access()
Developer reference for function delete_resource_custom_user_access()
get_video_info()
Developer reference for function get_video_info()
copyAllDataToResource()
Developer reference for function copyAllDataToResource()
copyResourceDataValues()
Developer reference for function copyResourceDataValues()
copy_locked_data()
Developer reference for function copy_locked_data()
copy_locked_fields()
Developer reference for function copy_locked_fields()
copyRelatedResources()
Developer reference for function copyRelatedResources()
process_edit_form()
Developer reference for function process_edit_form()
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_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()
get_resource_all_image_sizes()
Developer reference for function get_resource_all_image_sizes()
sanitize_date_field_input()
Developer reference for function sanitize_date_field_input()
download_link_generate_key()
Developer reference for function download_link_generate_key()
download_link_check_key()
Developer reference for function download_link_check_key()
filter_check()
Developer reference for function filter_check()
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_field_options()
Developer reference for function get_field_options()
get_data_by_field()
Developer reference for function get_data_by_field()
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_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_nopreview_icon()
Developer reference for function get_nopreview_icon()
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()
add_verbatim_keywords()
Developer reference for function add_verbatim_keywords()
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()
canSeePreviewTools()
Developer reference for function canSeePreviewTools()
checkPreviewToolsOptionUniqueness()
Developer reference for function checkPreviewToolsOptionUniqueness()
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()
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()
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()
compile_search_actions()
Developer reference for function compile_search_actions()
search_filter()
Developer reference for function search_filter()
search_special()
Developer reference for function search_special()
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()
search_get_previews()
Developer reference for function search_get_previews()
get_upload_here_selected_nodes()
Developer reference for function get_upload_here_selected_nodes()
get_default_search_states()
Developer reference for function get_default_search_states()
get_filter_sql()
Developer reference for function get_filter_sql()
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()
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()
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()
get_slideshow_image_file_path()
Developer reference for function get_slideshow_image_file_path()
getThemePathPerms()
Developer reference for function getThemePathPerms()
get_video_resolution()
Developer reference for function get_video_resolution()
save_themename()
Developer reference for function save_themename()
display_size_option()
Developer reference for function display_size_option()
get_search_default_restypes()
Developer reference for function get_search_default_restypes()
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()
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()
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()
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()
update_collection_parent()
Developer reference for function update_collection_parent()
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()
validate_collection_parent()
Developer reference for function validate_collection_parent()
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_collection_share()
Developer reference for function allow_collection_share()
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()
DrawOption()
Developer reference for function DrawOption()
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()
allow_upload_to_collection()
Developer reference for function allow_upload_to_collection()
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()
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()
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.
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.
update_fieldx()
Parameters Column Type Default Description $metadata_field_ref: int get_resource_table_joins 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.
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.
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.
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.
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 string $text: preg_replace'/@\S+/s' href '
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()
Parameters Column Type Default Description $collection $uploadkey 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()
Parameters This function accepts no parameters. Location include/collections_functions.php lines 6574 to 6586 Definition function upload_share_active () { global $upload_share_active ; if(isset( $upload_share_active )) { return $upload_share_active ; } elseif(isset( $_COOKIE [ "upload_share_active" ]) && getval ( "k" , "" ) != "" ) { return (int) $_COOKIE [ "upload_share_active" ]; } return false ; } This article was last updated 29th April 2024 07:05 Europe/London time based on the source file dated 25th April 2024 16:25 Europe/London time.
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.
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.
purge_expired_shares()
Description Purge all expired shares "share_group" - (int) Usergroup ref 'shared as' "share_user" - (int) user ID of share creator "share_type" - (int) 0=view, 1=upload "share_collection" - (int) Collection ID Parameters Column Type Default Description $filteropts array Array of options to filter shares purged Return string|int Location include/collections_functions.
render_workflow_state_question()
Parameters Column Type Default Description $current null $checkaccess true Location include/render_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_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.
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.
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.
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 502 to 532 Definition function leaflet_markers_legend () { global $lang , $marker_metadata_field , $marker_metadata_array , $MARKER_COLORS ; if (!isset( $marker_metadata_field ) || $lang [ 'custom_metadata_markers' ] == '' ) { ?> <b> echo escape ( $lang [ 'legend_text' ]); ?> </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='.
header_add_map_providers()
Parameters This function accepts no parameters. Location include/map_functions.php lines 534 to 683 Definition function header_add_map_providers () { global $geo_leaflet_sources , $baseurl , $geo_tile_caching ; ?> <script> // Copied from leaflet-providers.
get_geolibraries()
Parameters This function accepts no parameters. Location include/map_functions.php lines 685 to 708 Definition function get_geolibraries () { global $baseurl , $pagename , $map_default_cache , $map_layer_cache , $geo_leaflet_maps_sources , $map_zoomnavbar , $map_kml ; $map_pages = array( "geo_edit" , "geo_search" , "search" , "view" , "edit" , ); if(! in_array ( $pagename , $map_pages )) { return false ; } ?> <!--Leaflet Control Geocoder 1.
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 723 to 729 Definition function get_geo_maps_scripts () { global $baseurl ; ?> <script src=" echo $baseurl?> /lib/leaflet_plugins/leaflet-markercluster-1.
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.
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()
Parameters Column Type Default Description $options 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.
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_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 "limit" - (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 { array_map"is_int_loose" Array of extra options to filter and sort messages returned $msgusers; $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()
Parameters Column Type Default Description $messages Location include/message_functions.
message_selectedunseen()
Parameters Column Type Default Description $messages Location include/message_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.
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()
Parameters Column Type Default Description $collection_data array $userref $k "" Location include/collections_functions.
render_antispam_question()
Description Render the antispam Question form section Parameters This function accepts no parameters. Location include/render_functions.php lines 5736 to 5791 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 ) .
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.
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.
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.
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.
exiftool_resolution_calc()
Description Set resource dimensions using data from exiftool. Parameters Column Type Default Description $file_path string Path to the original file.
get_active_plugins()
Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 362 to 365 Definition function get_active_plugins () { return ps_query ( 'SELECT name, enabled_groups, config, config_json FROM plugins WHERE inst_version >= 0 ORDER BY priority' , array(), 'plugins' ); } This article was last updated 29th April 2024 07:05 Europe/London time based on the source file dated 18th April 2024 17:15 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.
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()
Parameters Column Type Default Description $collection $resources '' $search '' $selected false 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
lang_load_site_text()
Description Load all site text for the given page and language into the global $lang array Parameters Column Type Default Description &$lang $pagename string Pagename $language string "" Language $lang array Passed by reference Return void Location include/language_functions.
send_user_notification()
Description Send system notifications to specified users, checking the user preferences first if specified This will contain two arrays:- "emails" array of emails sent, with the following elements:- "email" => Email address "subject" => Email subject "body" => Body text "messages" Array of system messages sent with the following elements :- "user" => User ID "message" => message text "url" => url Parameters Column Type Default Description $users array Array of user IDs or array of user details from get_users() $notifymessage ResourceSpaceUserNotification An instance of a ResourceSpaceUserNotification object holding message properties $forcemail bool false Force system to send email instead of notification? Return array Array containing resulting messages - can be used for testing when emails are not being sent Location include/message_functions.
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_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()
The get_nodes_use_count() function is a PHP function in ResourceSpace that returns an array of node references as keys and the number of resources using them as values. The function takes an array of node references as input and filters out any non-integer values.
check_delete_nodes()
The check_delete_nodes() function is used to check an array of node IDs and delete any that relate to non-fixed list fields and are unused. The function takes an array of node IDs as a parameter and checks each node to see if it is related to a non-fixed list field.
remove_field_keywords()
The remove_field_keywords() function is a PHP function used in ResourceSpace, an open-source digital asset management system. The function deletes all keywords associated with a specified field ID for all nodes.
update_node_hitcount_from_search()
The article provides information about the function "update_node_hitcount_from_search()" in the resource_functions.php file of ResourceSpace. The function is used to increment the hit count for each node that has been used in a search for a specified resource.
update_resource_field_column()
The update_resource_field_column() function is used to update the value of a specific metadata field on a resource table. It takes three parameters: the resource ID, the metadata field ID, and the new value.
render_fa_icon_selector()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4732 tokens. Please reduce the length of the messages.
escape_quoted_data()
The article describes a PHP function called `escape_quoted_data()` that is used for output encoding in HTML and JavaScript when unsafe input is rendered inside it. The function takes a single parameter, `$unsafe`, which is a string that needs to be encoded.
acl_can_manage_tabs()
The article provides information about the function `acl_can_manage_tabs()` which is located in the `tab_functions.php` file. This function does not accept any parameters and returns the result of the `checkperm()` function with the parameter `'a'`.
get_tabs_by_refs()
The get_tabs_by_refs() function is a PHP function that retrieves entire tab records for a list of IDs. The function takes an array of tab refs as a parameter and returns an array of tab records. The function first filters the array of tab refs to remove any non-integer values.
get_tabs_with_usage_count()
The get_tabs_with_usage_count() function is used to retrieve tabs based on certain criteria, such as order by and limit. The function takes an array of criteria information as a parameter, including the order by and limit values.
get_all_tabs()
The get_all_tabs() function is a PHP function that retrieves all tab records sorted by the order_by column. This function does not accept any parameters and returns an array. The function is located in the tab_functions.
get_tab_name_options()
The article describes a function called `get_tab_name_options()` that returns a list of all tabs sorted based on the current configuration. The function takes no parameters and returns an array where the key is the tab's ID and the value is its translated name.
sort_tabs_as_configured()
The article describes a PHP function called "sort_tabs_as_configured()" that sorts a list of tab names while preserving their key ID. The function takes an array of tab ID and translated name pairs as input and returns the sorted array.
create_tab()
The create_tab() function is used to create a new system tab record. The function takes an array as a parameter, which contains the name of the new tab. The function first checks if the user has permission to manage tabs and then inserts the new tab into the database.
delete_tabs()
The delete_tabs() function is a system function that deletes tabs in ResourceSpace. The function takes an array of tab IDs as input and returns a boolean value indicating whether the query was executed successfully or not.
save_tab()
The `save_tab()` function is used to update an existing tab in ResourceSpace. It takes an array of tab records as input and returns a boolean value indicating whether the query was executed successfully or not.
can_use_owner_field()
The can_use_owner_field() function is used for initialization and system checks to ensure that the configuration is correctly enabled to use the owner field and mappings logic. The function accepts no parameters and returns a boolean value.
get_notification_users_by_owner_field()
The get_notification_users_by_owner_field() function is used to retrieve users to notify for requested resources owned by particular groups. The function takes two parameters: an array of notification users and an array of resource IDs.
override_rs_variables_by_eval()
The `override_rs_variables_by_eval()` function is a PHP code that runs on an array of variables, which is used for modifying `$GLOBALS`. The function takes two parameters: `$variables`, which is an array of variables to apply the override on, and `$code`, which is a signed string containing the PHP code to run.
get_cattree_nodes_ordered()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4684 tokens. Please reduce the length of the messages.
get_cattree_node_strings()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, you requested 5040 tokens (4016 in the messages, 1024 in the completion). Please reduce the length of the messages or completion.
cattree_node_creator()
The cattree_node_creator() function is a helper function used to build node entry arrays for ordering. It takes in several parameters, including the node ID, category tree field ID, node name, parent node ID, node order by, resource ID, and an array of child node IDs.
cattree_node_flatten()
The cattree_node_flatten() function is a helper function that adds child nodes after each flattened parent node. It takes an array of nodes, each with a child node array, as a parameter and returns an array of nodes with child nodes flattened out after their respective parents.
get_resources_nodes_by_rtf()
The get_resources_nodes_by_rtf() function is a PHP function that retrieves all resource nodes associated with a specific resource type field. The function takes a single parameter, which is the resource type field ID.
get_user_message()
The get_user_message() function retrieves the user message for the given reference. It takes two parameters: $ref, which is the message ID, and $checkaccess, which is a boolean value that checks if the user can see the given message.
get_node_strings()
The get_node_strings() function is a PHP function that returns an array of strings representing the full paths to each tree node passed. The function takes three parameters: $resource_nodes, $allnodes, and $translate.
remove_empty_temp_directory()
The remove_empty_temp_directory() function is used to remove an empty folder from the path to a file. It is particularly useful for removing temporary directories that are no longer needed once the file they were created to hold no longer exists.
get_all_resource_types()
The get_all_resource_types() function returns an array of all resource types ordered by 'order_by' then 'ref'. This function does not check or apply any permissions, so it should not be exposed to the API.
update_smart_collection()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 7957 tokens. Please reduce the length of the messages.
data_joins_field_value_translate_and_csv()
The function `data_joins_field_value_translate_and_csv()` is used to convert `$data_joins` value to a user-friendly version. The text value is split by the configured separator and all parts are translated.
report_has_thumbnail()
The article describes a function called "report_has_thumbnail()" that checks if a report has a "thumbnail" column in its SQL query. The function takes a single parameter, which is the report's SQL query.
report_process_query_placeholders()
The report_process_query_placeholders() function is used to find and replace a report's query placeholders with their values. It takes two parameters: $query, which is the report's SQL query, and $placeholders, which is an array that maps between a placeholder and its actual value.
can_edit_tile()
The can_edit_tile() function checks whether the current user can edit a dashboard tile. If the tile is only visible to the user, the function checks whether the user is the owner of the tile. If the tile is visible to all users, the function checks whether the user has dashboard admin permissions.
order_tree_nodes()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 6337 tokens. Please reduce the length of the messages.
add_sql_node_language()
Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, you requested 5106 tokens (4082 in the messages, 1024 in the completion). Please reduce the length of the messages or completion.
api_validate_upload_url()
The article describes the function `api_validate_upload_url()` which is used to validate the URL supplied in APIs create resource or upload by URL. The function requires the URL hostname to be added in config `$api_upload_urls`.
process_resource_data_joins_values()
The function "process_resource_data_joins_values()" is used to process resource data_joins array and update the values in the returned resource. The function takes two parameters, the first being the resource table record, and the second being the list of refs for the resource table data_joins.
setup_search_chunks()
The function `setup_search_chunks()` allows `$fetchrows` to support an integer or array. If an integer is supplied, the search will receive the number of rows with no offset. If an array is supplied, the search will receive the number of rows to return and an offset, allowing for chunking of results.
canSeeAnnotationsFields()
The canSeeAnnotationsFields() function is a helper function that determines whether annotations are to be displayed. It takes an array of annotation fields as a parameter and returns an array of annotation fields that can be viewed.
check_upload_terms()
The check_upload_terms() function is used to verify if the terms have been accepted for a given upload. The terms only need to be accepted when uploading through an upload share link, and if so, the accepted terms are stored in $_COOKIE["acceptedterms"].
display_related_resources()
Description Render all related resources on view page Parameters Column Type Default Description $context array Array with all required info from the view page Return void * Location include/render_functions.
remove_config_option()
Description Remove system/user preferences Parameters Column Type Default Description $user_id ?int Database user ID $name: string $name string Configuration option (variable) name Location include/config_functions.
unrelate_all_collection()
Description Un-relate all resources in a collection Parameters Column Type Default Description $collection integer ID of collection $checkperms true Return boolean Location include/collections_functions.
migrate_fixed_to_text()
Description Migrate fixed list field data to text field data for a given resource reference. Useful when changing resource type field from a data type that can contain multiple values such as a dynamic keywords field.
api_assert_post_request()
Description Assert API request is using POST method. Parameters Column Type Default Description array : Return array Returns JSend data back {@see ajax_functions.
rs_validate_token()
Description Used to compare the user's provided token with the expected value derived from the given identifier Used by isValidCSRFToken() Also used on upload_batch to validate an upload session when user cookie not available (i.
is_banned_extension()
Description Is the given extension in the list of blocked extensions? Also ensures extension is no longer than 10 characters due to resource.file_extension limit Parameters Column Type Default Description $extension string - file extension to check Return bool Location include/file_functions.
update_resource_type_field_resource_types()
Description Update the resource_type_field - resource_type mappings Parameters Column Type Default Description $ref int Resource type field ref $resource_types array Array of resource type refs Return void * Location include/config_functions.
get_resource_type_field_resource_types()
Description Get all resource_type->resource-type_field associations Parameters Column Type Default Description $fields array [] Optional array of resource_type_field data returned by get_resource_type_fields() Return array Array with resource_type_field ID as keys and arrays of resource_type IDs as values Location include/config_functions.
create_resource_type()
Description Create a new resource type with the specified name Parameters Column Type Default Description $name Name $name of new resouce type Return int| bool ref of new resource type or false if invalid data passed Location include/config_functions.
save_resource_type()
Description Save updated resource_type data Parameters Column Type Default Description $ref int Ref of resource type $savedata array Array of column values Return bool * Location include/config_functions.
rs_get_resource_type()
Description Get resource_type data Parameters Column Type Default Description $ref int Return array * Location include/config_functions.
save_resource_type_field()
Description Save resource type field - used on pages/admin/admin_resource_type_field_edit.php Parameters Column Type Default Description $ref int Field ID $columns array Array of column data bool $postdata: $migrate_data $onload_message $lang true; []; foreach$resource_types as $resource_type true false $postdata mixed POST'd data Return bool * Location include/config_functions.
cleanup_invalid_nodes()
Description Remove invalid field data from resources, optionally just for the specified resource types and/or fields Parameters Column Type Default Description $fields array [] $restypes array [] $dryrun bool false Don't delete, just return count of rows that will be affected $fields=[] array Array of resource_type_field refs $restypes=[] array Array of resource_type refs Return int Count of rows deleted/to delete Location include/node_functions.
admin_resource_type_field_constraint()
Description Display appropriate field constraint for use on admin_resource_type_field_edit.php e.g. single select/Number Parameters Column Type Default Description $ref int $currentvalue: int array"i" 0 "schema"; Metadata int field ID Current int field type Return void * Location include/render_functions.
admin_resource_type_field_option()
Parameters Column Type Default Description $propertyname string $propertytitle string $helptext string $type $currentvalue $fieldtype int $system_date_field bool $resource_type_array; $lang $baseurl_short $FIXED_LIST_FIELD_TYPES $daterange_edtf_support $allfields $newfield $resource_type_array $existingrestypes $regexp_slash_replace Location include/render_functions.
render_resource_type_selector_question()
Parameters Column Type Default Description $label string $name string $class string "stdwidth" $hidden bool false $current true false true; Location include/render_functions.
is_valid_upload_path()
Description Confirm upload path is one of valid paths. Parameters Column Type Default Description $file_path string Upload path.
resource_random_jpg()
Parameters Column Type Default Description $resource $width $height Location include/test_functions.
assert_post_request()
Description Assert API request is using POST method. Parameters Column Type Default Description $force: bool $force bool Force the assertion Return array Returns JSend data back {@see ajax_functions.
assert_content_type()
Description Assert API sent the expected content type. Parameters Column Type Default Description $expected string MIME type $received_raw: string $received_raw string MIME type Return array Returns JSend data back {@see ajax_functions.
get_resource_type_field_columns()
Parameters This function accepts no parameters. Location include/config_functions.php lines 1784 to 1836 Definition function get_resource_type_field_columns () { global $lang ; $resource_type_field_column_definitions = execution_lockout_remove_resource_type_field_props ([ 'active' => [ $lang [ 'property-field_active' ], '' , 1 , 1 ], 'global' => [ $lang [ 'property-resource_type' ], '' , 1 , 0 ], 'title' => [ $lang [ 'property-title' ], '' , 0 , 1 ], 'type' => [ $lang [ 'property-field_type' ], '' , 0 , 1 ], 'linked_data_field' => [ $lang [ 'property-field_raw_edtf' ], '' , 0 , 1 ], 'name' => [ $lang [ 'property-shorthand_name' ], $lang [ 'information-shorthand_name' ], 0 , 1 ], 'required' => [ $lang [ 'property-required' ], '' , 1 , 1 ], 'order_by' => [ $lang [ 'property-order_by' ], '' , 0 , 0 ], 'keywords_index' => [ $lang [ 'property-index_this_field' ], $lang [ "information_index_warning" ] .
apply_resource_default()
Description When changing resource type, new resource type specific fields may become available. This function will apply any resource default values for resource type specific fields that were not previously available (i.
delete_config_option()
Description Delete entry from the user_preferences table completely (instead of setting to blank via set_config_option). Used by system preferences page when deleting a file to allow fallback to value (if set) in config.
get_user_actions_recent()
Description Get recent user actions, optionally for all users. For use by action notifications cron job. the 'a' permission and the current script is not running from CLI then only the currently logged on user's actions will be returned Included columns are as per get_user_actions() - resourcerequest - array of resource requests - userrequest - array of user requests - resourcereview - array of resources to reviewdescription) Parameters Column Type Default Description $minutes int Return actions that were created in the last $minutes minutes $allusers bool Return actions for all users? If false, or if the current user does not have $userref; []; // Find all resources that have changed archive state in the given number of minutes ifis_int_loose$view_title_field Return array An array with the user id as the index and the following arrays of sub elements.
actions_filter_by_user()
Description Filter actions in the provided array to return only those applicable to the given user Parameters Column Type Default Description $actionuser int User ref to get actions for $actions array Array of actions as returned by get_user_actions_recent() func_get_args; $actions_resource_requests $actions_account_requests $actions_approve_hide_groups; Return array Subset of actions for the given user as would be provided by get_user_actions() Location include/action_functions.
resource_request_visible()
Description Can the logged in user see the request specified? Parameters Column Type Default Description $request array Array of request details Return bool * Location include/request_functions.
get_all_parents_by_leaf()
Description Build a row consisting of all parents of a given leaf node Example: 1 2 2.3 2.7 2.8.4 2.8.5 2.8.6 2.9 3 Passing in node 5 will return nodes 8,2 in one row Parameters Column Type Default Description $ref integer Node ID of tree leaf $level integer Node depth level (as returned by get_tree_node_level()) Return integer|boolean Location include/node_functions.
get_all_ancestors_for_node()
Description Return a row consisting of all ancestor nodes of a given node Example: 1 2 2.3 2.7 2.8.4 2.8.5 2.8.6 2.9 3 Passing in node 5 will return nodes 8,2 in one row Parameters Column Type Default Description $ref integer A tree node $level integer Node depth level (as returned by get_tree_node_level()) Return array|boolean Location include/node_functions.
render_pie_graph()
Description Output the Javascript to build a pie chart in the canvas denoted by $id $data must be in the following format $data = array( "slice_a label" => "slice_a value", "slice_b label" => "slice_b value", ); a string can be used to denote the total value to pad the data to Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart $total string|null null null will mean that the data is complete and an extra field is not required Return void Location include/reporting_functions.
render_bar_graph()
Description Output the Javascript to build a bar chart in the canvas denoted by $id $data must be in the following format $data = array( "point_a x value" => "point_a y value", "point_b x value" => "point_b y value", Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart Return void Location include/reporting_functions.
log_keyword_usage()
Description Log which keywords are used in a search Parameters Column Type Default Description $keywords array refs of keywords used in a search $search_result $search_results array result of the search Location include/search_functions.
create_random_image()
Description Generate a random image which can be used during testing (e.g to upload, or create previews for) - text -> Image content text - filename (default: random) - width (default: 150) - height (default: 50) - bg[red|green|blue] -> Background colour (RGB), e.
create_random_video()
Description Generate a random video which can be used during testing (e.g to upload, or create previews for) - duration (default: 5 seconds) - width (default: 300) - height (default: 300) - filename (default: random) - extension (default: mp4) - text -> Video content text (optional) Parameters Column Type Default Description $info: array $GLOBALS['ffmpeg_supported_extensions'] $info array Set video parameters: Return array Returns an "error" key if something went wrong, otherwise provides some useful info (e.
skip_scr_size_preview()
Description Determine if the scr size should be used for previews. When $resource_view_use_pre is true the scr size shouldn't be used. Where access is restricted and restricted access users can't access the scr size, the scr size shouldn't be used.
i18n_get_all_translations()
Description Return an array of all available language strings for the given id, with the language code as the key Parameters Column Type Default Description $langid: string $langid string The identifier of the lang string Return array * Location include/language_functions.
add_download_column()
Description Render the Download info for the resource tool (on view page) Parameters Column Type Default Description $ref int Resource ref $size_info array Preview size information $downloadthissize bool Should the size be downloadable or requested? $view_in_browser bool false Allow the size to be viewed directly in the browser Location include/render_functions.
escape()
Description Output encoding for HTML context when unsafe input is rendered inside it Parameters Column Type Default Description $unsafe: string | ENT_QUOTES "" $name string "icon" $current string "" Return string Location include/render_functions.
set_maxNumberOfFiles()
Parameters This function accepts no parameters. Location include/config_functions.php lines 1830 to 1833 Definition function set_maxNumberOfFiles () { return is_int_loose ( $GLOBALS [ 'upload_max_number_files' ]?? "" )? $GLOBALS [ 'upload_max_number_files' ]: 'null' ; } This article was last updated 17th January 2024 11:05 Europe/London time based on the source file dated 2nd January 2024 18:00 Europe/London time.
api_get_daily_stat_summary()
Description Return a summary of daily statistics Parameters Column Type Default Description $days int 30 The number of days - note max 365 days as only the current and previous year's data is accessed.
delete_node_resources()
Description Delete all resource node relationships for the given node. Parameters Column Type Default Description $node integer The node ID to remove from all resources.
remove_invalid_resource_node_mappings()
Description Delete invalid resource_node associations. Note, by invalid, it's meant where the node is missing. Parameters This function accepts no parameters. Location include/node_functions.
test_log()
Description Debug logs for ResourceSpace automated tests Parameters Column Type Default Description $msg: string Location include/test_functions.
render_resource_view_image()
Description Render image on view.php "access" - Resource access "edit_access" - Resource edit access Parameters Column Type Default Description $resource array Resource data $context array Array with following named elements Return void * Location include/render_functions.
related_resource_pull()
Description Get a related resource to pull images from Parameters Column Type Default Description $resource array Array of resource data from do_search() Return array|bool $resdata Array of alternative resource data to use, or false if not configured or no resource image found Location include/resource_functions.
get_resource_preview()
Description Get the largest available preview URL for the given resource and the given array of sizes Parameters Column Type Default Description $resource array Array of resource data from get_resource_data() or search results $sizes array [] Array of size IDs to look through, in order of size.
set_search_order_by()
Description Validate and set the order_by for the current search from the requested values passed to search_do() Parameters Column Type Default Description $search string $order_by string $sort: string $sort string Return string * Location include/search_functions.
update_node_active_state()
Description Batch update nodes' active state to the database. The same state will apply to all nodes in the list. For logic on which nodes to toggle {@see toggle_active_state_for_nodes()} Parameters Column Type Default Description $refs list Node IDs $active: bool $active bool Should nodes be active or not? Location include/node_functions.
toggle_active_state_for_nodes()
Description Toggle nodes' active state Parameters Column Type Default Description $refs: array 'ref' 'asc' '' [FIELD_TYPE_CATEGORY_TREE] 'ref'; $refs list Node IDs Return array<int, 0|1> Location include/node_functions.
toggle_category_tree_nodes_active_state()
Description Toggle category tree nodes' active state Parameters Column Type Default Description $rtf int Resource type field ID $node_refs: array null array_flip$node_refs; $node_refs list Return array<int, 0|1> Location include/node_functions.
i18n_merge_translations()
Description Merge values for across multiple translation strings. Where a value is missing for a language used elsewhere i18n_get_translated will be used. If no value is provided and no English (en) string is found then blank will be returned.
validate_resource_files()
Description Validate the files on disk that are associated with the given resources array of resource data e.g, from search results required return values in order to pass the check e.
send_integrity_failure_notices()
Description Send notifications about file integrity failures Parameters Column Type Default Description $failures: array get_sysvar'last_integrity_check_notify' '1970-01-01'; $failures array Array of resources that have failed integrity check Return void * Location include/message_functions.
check_resources()
Description Check integrity of primary resource files then file checksums will be checked Parameters Column Type Default Description $resources array [] Array of resource data e.
get_resources_to_validate()
Description Get an array of all resources that require files to be validated Parameters Column Type Default Description $days int Return only resources not validated in the last X number of days $GLOBALS["file_integrity_ignore_resource_types"] Return array * Location include/resource_functions.