| 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] |
Add a field to the internal field detection system
function addField( $name, $location, $type = false )
Add a field to the internal field detection system from an array or delimited string
function addFields( $fields, $location = '*', $delimiter = ',', $callback = false )
Append keywords’s to the resource array
function appendKeywords( $resource )
Apeend a TV to the documents array
function appendTV( $tvname = "", $docIDs )
Translate a result array into a HTML table
function array2table( $array, $recursive = false, $return = false, $null = ' ' )
Make fields array unique
function arrayUnique( $array )
Do basic comparison filtering
function basicFilter ( $value )
Build a URL with regard to Ditto ID
function buildURL( $args, $id = false, $dittoIdentifier = false )
Check the advSortString
function checkAdvSort( $sortBy, $sortDir = 'asc' )
Remove empty items from the array
function cleanArray( $array )
Clean the IDs of any dangerous characters
function cleanIDs( $IDs )
Sort resource array if advanced sorting is needed
function customSort( $data, $fields, $order )
Holds the default templates
$defaultTemplates
Determine the correct template to apply
function determine( $templates, $x, $start, $stop, $id )
Get Document IDs for future use
function determineIDs( $IDs, $IDType, $TVs, $orderBy, $depth, $showPublishedOnly, $seeThruUnpub, $hideFolders, $hidePrivate, $showInMenuOnly, $myWhere, $keywords, $dateSource, $limit, $summarize, $filter, $paginate, $randomize )
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 exampleFilter( $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 exampleFunction( $resource )
Filter documents via either a custom filter or basic filter
function execute( $resource, $filter )
Get a template, based on version by Doze
function fetch( $tpl )
Helper function to appendKeywords
function fetchKeywords( $resource )
Find al the template variables in the template
function findTemplateVars( $tpl )
Returns the contents of file name passed
function get_file_contents( $filename )
Get the author name, or if not available the username
function getAuthor( $createdby )
Get the IDs ready to be processed Similar to the modx version by the same name but much faster
function getChildIDs( $IDs, $depth )
Get documents and append TVs + Prefetch Data, and sort
function getDocuments( $ids = array (), $fields, $TVs, $orderBy, $published = 1, $deleted = 0, $public = 1, $where = '', $limit = "", $keywords = 0, $randomize = 0, $dateSource = false )
Determine if the provided field is a tv, a database field, or something else
function getDocVarType( $field )
Get a parameter or use the default language value
function getParam( $param, $langString )
Get a list of all available parents
function getParentList()
Get a list of all available TVs
function getTVList()