Developers

Coding standards

Coding standards v2.1
ResourceSpace software design principles
Contributing to the base code
Intellectual property
Prepared statements

Security in ResourceSpace

Access control
Cross-Site Request Forgery (CSRF)
Injection
File management (uploads)

Developer reference

Project structure
Database schema
Fixed list fields
Debugging ResourceSpace
Writing your own plugins
Context help links
Custom fields ("user" defined)
Query caching
All user permissions
Client side API calls
Modals
Sending user notifications
Progressive Web App
Managing (PHP) code dependencies
Managing (JS) code dependencies
OpenAPI documentation
Automated Testing

Database

Table: activity_log
Table: annotation
Table: annotation_node
Table: api_log
Table: collection
Table: collection_keyword
Table: collection_log
Table: collection_resource
Table: collection_savedsearch
Table: comment
Table: daily_stat
Table: dash_tile
Table: dynamic_tree_node
Table: external_access_keys
Table: filter
Table: filter_rule
Table: filter_rule_node
Table: ip_lockout
Table: job_queue
Table: keyword
Table: keyword_related
Table: mail_log
Table: message
Table: node
Table: node_keyword
Table: plugins
Table: preview_size
Table: report
Table: report_periodic_emails
Table: report_periodic_emails_unsubscribe
Table: request
Table: research_request
Table: resource
Table: resource_alt_files
Table: resource_custom_access
Table: resource_dimensions
Table: resource_keyword
Table: resource_log
Table: resource_node
Table: resource_related
Table: resource_type
Table: resource_type_field
Table: resource_type_field_resource_type
Table: search_log
Table: site_text
Table: slideshow
Table: sysvars
Table: tab
Table: user
Table: user_collection
Table: user_dash_tile
Table: user_message
Table: user_preferences
Table: user_rating
Table: user_report
Table: user_userlist
Table: usergroup
Table: usergroup_collection
Table: usergroup_dash_tile

User api session functions

get_api_session_destination()
get_api_session_code_user()
redeem_api_session_code()

Geolocation functions

geo_setcoords_from_country()
update_country_coords()
fetch_country_coords()
build_coords()
build_codes()

Storage test functions

storage_test_allowed()
storage_test_manifest()
storage_test_path()
storage_test_stages()
storage_test_transfer()
storage_test_unit()
storage_test_cleanup()
storage_test_lock()
storage_test_advance()
storage_test_recover()
storage_test_public()

ResourceSpace is an open source project written in PHP and Javascript with the code freely available to browse via SVN: https://www.resourcespace.com/svn

Check out the documentation for the ResourceSpace source code.
For a breakdown of folders within the project please see project structure.
For an overview of the database tables please see the database schema.
All developers must adhere to our coding standards.

Knowledge Base

Developers