Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 abbrLanguage
 addField
 addFields
 appendKeywords
 appendTV
 array2table
 arrayUnique
 ATOM
B
 bad
 basicFilter
 buildURL
C
 caseSensitive
 charset
 checkAdvSort
 cleanArray
 cleanIDs
 Compatibility
 config
 copyright
 customSort
D
 Date Filter
 dateFilterDefault
 dateFilterSource
 dateFormat
 dateSource
 day
 dbg
 debug
 Debug Class
 Default Templates
$defaultTemplates
 depth
 determine
 determineIDs
 display
 Ditto Snippet
 ditto_base
 documents
E
 Example
 exampleFilter
 exampleFunction
 execute
 extenders
F
 fetch
 fetchKeywords
 filter
 Filter Class
 filters
 Filters
$filters[“custom”][“exampleFilter”]
$filters[“parsed”][]
 findTemplateVars
 format
 Functions
G
 get_file_contents
 getAuthor
 getChildIDs
 getDocuments
 getDocumentsLite
 getDocVarType
 getParam
 getParentList
 getTVList
 globalFilterDelimiter
 good
 groupByYears
H
 hiddenFields
 hideFolders
 hidePrivate
I
 id
 IDs
 idType
 item[x]
Language for the Atom feed
function addField($name,  
$location,  
$type = false)
Add a field to the internal field detection system
function addFields($fields,  
$location = '*',
$delimiter = ',',
$callback = false)
Add a field to the internal field detection system from an array or delimited string
function appendKeywords($resource)
Append keywords’s to the resource array
function appendTV($tvname = "",
$docIDs  )
Apeend a TV to the documents array
function array2table($array,  
$recursive =  false,
$return =  false,
$null =  ' ')
Translate a result array into a HTML table
function arrayUnique($array)
Make fields array unique
Collection of parameters, functions, and classes that expand Ditto’s output capabilities to include ATOM
Parameters that are not allowed to be set
function basicFilter ($value)
Do basic comparison filtering
function buildURL($args,  
$id = false,
$dittoIdentifier = false)
Build a URL with regard to Ditto ID
Determine whether or not tag matching and duplicate tag removal are case sensitive
Charset to use for the Atom feed
function checkAdvSort($sortBy,  
$sortDir = 'asc')
Check the advSortString
function cleanArray($array)
Remove empty items from the array
function cleanIDs($IDs)
Clean the IDs of any dangerous characters
Backwards compatibility file for use with Ditto 1.0.2 calls
Load a custom configuration
Copyright message to embed in the JSON document
function customSort($data,
$fields,
$order)
Sort resource array if advanced sorting is needed
Filtering companion to Reflect or other date based filtering
Determine the default filter
Source for the day, month, and year to filter by
Format the [+date+] placeholder in human readable form
Source of the [+date+] placeholder
Day to filter by
Output variables being set
Output debugging information
The Debug class contains all functions relating to Ditto’s implimentation of the MODx debug console
Default templates for Reflect
$defaultTemplates
Holds the default templates
Number of levels deep to retrieve documents
function determine($templates,
$x,
$start,
$stop,
$id)
Determine the correct template to apply
function determineIDs($IDs,
$IDType,
$TVs,
$orderBy,
$depth,
$showPublishedOnly,
$seeThruUnpub,
$hideFolders,
$hidePrivate,
$showInMenuOnly,
$myWhere,
$keywords,
$dateSource,
$limit,
$summarize,
$filter,
$paginate,
$randomize)
Get Document IDs for future use
Number of documents to display in the results
Aggregates documents to create blogs, article/news collections, and more,with full support for templating.
Location of Ditto files
IDs of documents for Ditto to retrieve
Example file for basing new Extenders on
function exampleFilter($resource)
Takes the resource array for an individual document and asks for the return of a 0 or 1 with 1 removing the document and 0 leaving it in the result set.
function exampleFunction($resource)
Takes the resource array for an individual document and returns the value of the placeholder, in this case the uppercase version of the pagetitle
function execute($resource,
$filter)
Filter documents via either a custom filter or basic filter
Load an extender which adds functionality to Ditto
function fetch($tpl)
Get a template, based on version by Doze
function fetchKeywords($resource)
Helper function to appendKeywords
Removes items not meeting a critera.
The Filter class contains all functions relating to filtering, the removing of documents from the result set
Holds both the custom filters array for configs or extenders to add to and the parsed filters array.
Define custom or basic filters within the extender to expand Ditto’s filtering capabilities
Add the filter exampleFilter to the custom filters list with the source pagetitle and the callback exampleFilter
Add the pre-parsed filter to the parsed filters list with the source as id, the value of 9239423942 and the mode 2
function findTemplateVars($tpl)
Find al the template variables in the template
Output format to use
function get_file_contents($filename)
Returns the contents of file name passed
function getAuthor($createdby)
Get the author name, or if not available the username
function getChildIDs($IDs,
$depth)
Get the IDs ready to be processed Similar to the modx version by the same name but much faster
function getDocuments($ids =  array (),
$fields,  
$TVs,  
$orderBy,  
$published =  1,
$deleted =  0,
$public =  1,
$where =  '',
$limit =  "",
$keywords = 0,
$randomize = 0,
$dateSource = false)
Get documents and append TVs + Prefetch Data, and sort
Get an array of documents
function getDocVarType($field)
Determine if the provided field is a tv, a database field, or something else
function getParam($param,
$langString)
Get a parameter or use the default language value
function getParentList()
Get a list of all available parents
function getTVList()
Get a list of all available TVs
Filter delimiter used to separate filters in the filter string
Parameters that are allowed to be set
Group the archive by years
Allow Ditto to retrieve fields its template parser cannot handle such as nested placeholders and [fields]
Don’t show folders in the returned results
Don’t show documents the guest or user does not have permission to see
Unique ID for this Ditto instance for connection with other scripts (like Reflect) and unique URL parameters
Internal variable which holds the set of IDs for Ditto to fetch
type of IDs provided; can be either parents or documents
Individual items rendered output