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

J
	JSON
K
	keywords
L
	language
	Language File assets/ snippets/ ditto/ lang/ bulgarian-utf8. inc.php assets/ snippets/ ditto/ lang/ bulgarian. inc.php assets/ snippets/ ditto/ lang/ english. inc.php assets/ snippets/ ditto/ lang/ italian. inc.php assets/ snippets/ ditto/ lang/ nederlands. inc.php
	localFilterDelimiter
M
	Main Class
	makelink
	makeMODxSafe
	makeParamTable
	makeTab
	MODx Debug Console
	month
	monthSortDir
	multiSort
N
	noResults assets/ snippets/ ditto/ classes/ ditto. class. inc.php snippet. ditto.php
O
	orderBy
P
	paginate assets/ snippets/ ditto/ classes/ ditto. class. inc.php snippet. ditto.php
	paginateAlwaysShowLinks
	paginateSplitterCharacter
	param
	Parameters assets/ snippets/ ditto/ configs/ compatibility. config.php assets/ snippets/ ditto/ extenders/ dateFilter. extender. inc.php assets/ snippets/ ditto/ extenders/ example. extender. inc.php assets/ snippets/ ditto/ extenders/ request. extender. inc.php assets/ snippets/ ditto/ extenders/ summary. extender. inc.php assets/ snippets/ ditto/ extenders/ tagging. extender. inc.php assets/ snippets/ ditto/ formats/ atom. format. inc.php assets/ snippets/ ditto/ formats/ json. format. inc.php assets/ snippets/ ditto/ formats/ rss. format. inc.php assets/ snippets/ ditto/ formats/ xml. format. inc.php snippet. ditto.php snippet. reflect.php
	params
	parents
	parseCustomPlaceholders
	parseDBFields
	parseFields
	parseFilters
	parseOrderBy
	Persian Language File for Ditto
	phx snippet. ditto.php snippet. reflect.php
	placeholders
	Placeholders assets/ snippets/ ditto/ extenders/ dateFilter. extender. inc.php assets/ snippets/ ditto/ extenders/ example. extender. inc.php assets/ snippets/ ditto/ extenders/ tagging. extender. inc.php snippet. ditto.php
$	placeholders[‘example’]
	prepareBasicInfo
	prepareDocumentInfo
	prepareFilters
	preparePrefetch
	prepareTemplates
	process
Q
	queryLimit
R
	randomize
	Reflect Snippet
	relToAbs
	removeChunk
	removeField
	render assets/ snippets/ ditto/ classes/ ditto. class. inc.php assets/ snippets/ ditto/ debug/ modxDebugConsole. class.php
	render_link
	render_popup
	renderQELinks
	replace
	Request
	RSS
S
	save assets/ snippets/ ditto/ debug/ modxDebugConsole. class.php snippet. ditto.php
	seeThruUnpub
	setDisplayFields
	showInMenuOnly
	showItems
	showPublishedOnly
	sortFields
	source
	start snippet. ditto.php snippet. reflect.php
	stripTags
	Summary

Collection of parameters, functions, and classes that expand Ditto’s output capabilities to include JSON

Enable fetching of associated keywords for each document Can be used as [+keywords+] or as a tagData source

language for defaults, debug, and error messages

Default Bulgarian UTF-8 language file for Ditto

Delimiter used to separate individual parameters within each filter string

The Ditto class contains all functions relating to Ditto’s functionality and any supporting functions they need

Render the links to the debug console

function makeMODxSafe( $value )

Make all MODx tags safe for the output

function makeParamTable( $parameters = array(),
$header = "",
$sort = true,
$prep = true,
$wordwrap = true )

Turn an array of parameters in the format [“param”] => “value” into a table

function makeTab( $title,
$content )

Render a tab

A class designed to help developers impliment a debug console like to the one in Ditto 2

Month to filter by

Direction to sort the months

function multiSort( $resource,
$orderBy )

Sort the resource array by multiple fields Rows->Columns portion by Jon L.

function noResults( $text,
$paginate )

Render the noResults output

An array that holds all criteria to sort the result set by.

function paginate( $start,
$stop,
$total,
$summarize,
$tplPaginateNext,
$tplPaginatePrevious,
$tplPaginateNextOff,
$tplPaginatePreviousOff,
$tplPaginatePage,
$tplPaginateCurrentPage,
$paginateAlwaysShowLinks,
$paginateSplitterCharacter )

Paginate the documents

Determine whether or not to always show previous next links

Splitter to use if always show is disabled

The purpose of your parameter goes here

$newParameters = $oldParameter;

Pass parameters to the Ditto instance used to retreive the documents

IDs of containers for Ditto to retrieve their children to &depth depth

function parseCustomPlaceholders( $placeholders )

Parse the required fields out of the custom placeholders

function parseDBFields( $seeThruUnpub )

Parse out the fields required for each state

function parseFields( $placeholders,
$seeThruUnpub,
$dateSource,
$randomize )

Find the fields that are contained in the custom placeholders or those that are needed in other functions

function parseFilters( $filter = false,
$cFilters = false,
$pFilters = false,
$globalDelimiter,
$localDelimiter )

Split up the filters into an array and add the required fields to the fields array

function parseOrderBy( $orderBy,
$randomize )

Parse out orderBy parameter string

Path: assets/snippets/ditto/lang/ Translation: Mohsen (MotSmart ~ www.modxcms.ir) Date: 26.4.2007 Note: New language keys should added at the bottom of this page

Use PHx formatting

Initialize custom placeholders array for configs or extenders to add to

Defin the values of custom placeholders for access in the tpl like so [+phname+]

Add the placeholder example to the custom placeholders list with the source pagetitle in both display and backend using the exampleFunction callback and pagetitle as the field for QuickEdit.

function prepareBasicInfo( $ditto,
$ditto_version,
$IDs,
$summarize,
$orderBy,
$start,
$stop,
$total )

Create the outut for the Info ta

function prepareDocumentInfo( $resource )

Create the output for the Document Info tab

function prepareFilters( $filter )

Create the content of the Filters tab

function preparePrefetch( $prefetch )

Create the content of the Prefetch tab

function prepareTemplates( $templates )

Create the output for the Templates tab

function process( $template )

Take the templates and parse them for tempalte variables, Check to make sure they have fields, and sort the fields

Number of documents to retrieve from the database, same as MySQL LIMIT

Randomize the order of the output

Generates date based archives using Ditto

function relToAbs( $text,
$base )

Convert relative urls to absolute URLs Based on script from http://wintermute.com.au/bits/2005-09/php-relative-absolute-links/

Name of chunks to be stripped from content separated by commas

function removeField( $name,
$location,
$type )

Remove a field to the internal field detection system

function render( $resource,
$template,
$removeChunk,
$dateSource,
$dateFormat,
$ph = array(),
$phx = 1,
$x = 0 )

Render the document output

function render_link( $dittoID,
$ditto_base )

Render the links to the debug console

function render_popup( $ditto,
$ditto_base,
$ditto_version,
$ditto_params,
$IDs,
$fields,
$summarize,
$templates,
$orderBy,
$start,
$stop,
$total,
$filter,
$resource )

Render the contents of the debug console

function renderQELinks( $fields,
$resource,
$QEPrefix,
$placeholders )

Render QE links when needed

function replace( $placeholders,
$tpl )

Replcae placeholders with their values

Adds support for changing Ditto parameters via URL

Collection of parameters, functions, and classes that expand Ditto’s output capabilities to include RSS

function save( $html,
$filename )

Save the debug console as a file

See through unpublished folders to retrive their children Used when depth is greater than 1

function setDisplayFields( $fields,
$hiddenFields )

Move the detected fields into the Ditto fields array

Show only documents visible in the menu

Show individual items in the archive

Show only published documents

function sortFields ( $fieldList )

Sort the array of fields provided by type

Name of the Ditto snippet to use

Number of documents to skip in the results

Remove HTML tags from the parameters provided

Legacy support for the [+summary+] placeholder