Pawtucket2 Helper Function Cheatsheet

From CollectiveAccess Documentation
Jump to: navigation, search

The following is a selection of useful helper functions available to Pawtucket2 themes. This is not the entire API, only the most commonly used functions. For a complete list see http://api.collectiveaccess.org/pawtucket2. This cheatsheet are is for Pawtucket2 only. Most helpers listed here are not supported in Pawtucket 1.x.

Object Representation Media Helpers

Functions used to obtain URLs of and technical metadata for object representation media.

Function Description Parameter notes Return value
xxx() xxx xxx xxx

Search Helpers

Functions used to streamline text searches.

Function Description Parameter notes Return value
xxx() xxx xxx xxx

Request Helpers

Functions used to obtain information about the current request.

Function Description Parameter notes Return value
caUseIdentifiersInUrls() Determines if Pawtucket is configured to use alphanumeric identifiers (catalogued record identifiers – aka idnos) or integer internal database ids (aka CollectiveAccess id's) None True if Pawtucket is configured to use idnos, false if configured to use internal numeric ids
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools