[Revolution Snippet] SiteAtoZ

<?php
/**
 * SiteAtoZ snippet
 * @author Bob Ray <http://bobsguides.com>
 * @version 1.0.0
 * 01/25/2011
 *
 * This snippet was inspired by the work of
 * garryn, patricksamshire, and OpenGeek
*/
/** This snippet makes use of getResources to list records alphabetically, with an A to Z header of links to anchors in the text.
 *
 * By far the best practice to get it working is to call getResources directly with
 * a snippet tag in a resources. Once you get it working, and it shows every resource
 * you want to index, just change "getResources" to "SiteAtoZ" in the snippet tag.
 * Once that's working, you can add any of the optional parameters listed below.
 *
 * All of the parameters for getResources will be passed through. They can be used
 * to select the parents, sort field, tpl for each entry, etc.
 *
 * The &resources parameter can only be used to exclude resources (&resources=`-12,19`),
 * using it to include docs not work because getResources will include those resources
 * regardless of any other criteria and they will be included in every alphabet section.
 * The &where parameter will be ignored becuase it interferes with the selection by initial letter.
 *
 * Simple use:
 * [[!SiteAtoZ? &parents=`6` &tpl=`MyTpl`]]
 *
 * Required parameters:
 * ---------------
 * @property parents - (string) Comma-separated list of ID's of container documents you want included (`0` for all docs)
 * @property tpl - (string) Tpl chunk used to format each entry; Default 'AzItemTpl'
 *
 * Optional parameters:
 * ---------------
 * @property useNumbers - (boolean) Put a number array in front of the alphabet' default '0'
 * @property useAlphabet - (boolean) Use the Alphabet; default: '1'
 * @property headingSeparator - (string) separator to use between letters in heading; Default '&nbsp| '
 * @property alphabetHeadingStart - (string) Letter to start with; Default: 'A'
 * @property alphabetHeadingEnd - (string) Letter to end with; Default 'Z'
 * @property title - (string) Field to used for search; Default: pagetitle
 * @property headingLinksTpl - (string) A tpl containing the entire A-Z heading (useful if you'd like to use images)
 *
 * All other parameters are those of getResources. They should all work as they do for getResources with two exceptions:
 * @property resources can be used to exclude documents, but not to include them (@property resources=`-2,24`).
 * @property where will be ignored (it conflicts with the selection by initial letter).
 */

$sp =& $scriptProperties;
$documentId = $modx->resource->get('id');


$sp['tpl'] = empty($sp['tpl'])? 'AzItemTpl' : $sp['tpl'] ;

$sp['parents'] = empty($sp['parents'])? '0' : $sp['parents'];
$headingSeparator = empty($sp['headingSeparator'])? '<span class="az-separator"> | </span>'. "\n" : $sp['headingSeparator'] . "\n";
$title = empty($sp['title'])? 'pagetitle' : $sp['title'];
$alphabetHeadingStart = (empty($sp['alphabetHeadingStart']))? 'A' : $sp['alphabetHeadingStart'];
$alphabetHeadingEnd = (empty($sp['alphabetHeadingEnd']))? 'Z' : $sp['alphabetHeadingEnd'];
$useNumbers = $sp['useNumbers'] === '1'? true : false;
$useAlphabet = $sp['useAlphabet'] === '0'? false: true;

$n = range('0','9');
$a = range($alphabetHeadingStart, $alphabetHeadingEnd);
$alphabet = array();

if ($useNumbers) {
    $alphabet=$n;
}
if ($useAlphabet) {
    $alphabet = array_merge($alphabet,$a);
}
unset($n,$a);

$whereProperty = !empty($sp['where'])? $sp['where'] : false;
foreach ($alphabet as $k=>$v) {
    $local_where = array(
        $title . ':LIKE' => $v . '%',
    );
    /* ToDo: Some day this may work */
    /*if ($whereProperty !== false) {
        $w = $modx->fromJSON($sp['where']);
        $local_where = array_merge($local_where,$w);
        unset($w);
    }*/
    $sp['where'] = $modx->toJSON($local_where);

    $ret = $modx->runSnippet('getResources',$sp);
    if (empty($ret)) {
        $header[] = $v;
    } else {
        $header[] = '<a class="az-headeritem" href="'.$modx->makeUrl($documentId).'#jump_to_' . $v . '">' . $v . '</a>';
        $output .= '<p class="az-anchor">' . "<a name=\"jump_to_$v\" id=\"jump_to_$v\"></a><strong>" . $v . "</strong></p>\n";
        $output .= $ret;
    }
}

$headingLinks = (empty($sp['headingLinksTpl']))? implode($headingSeparator,$header) : $modx->getChunk($sp['headingLinksTpl']);

return $headingLinks . $output;

[[!SiteAtoZ? &parents=`8` &includeContent=`1` &useNumbers=`1` &tpl=`AtoZ` &showHidden=`true`]]

<a href="[[~[[+id]]]]" title="[[+pagetitle]]">[[+pagetitle]]</a><br />

&useNumbers=`1`
&combineNumbers=`1`

<?php
/**
 * SiteAtoZ snippet
 * @author Bob Ray <http://bobsguides.com>
 * @version 1.0.1
 * 01/25/2011
 *
 * This snippet was inspired by the work of
 * garryn, patricksamshire, and OpenGeek
*/
/** This snippet makes use of getResources to list records alphabetically, with an A to Z header of links to anchors in the text.
 *
 * By far the best practice to get it working is to call getResources directly with
 * a snippet tag in a resources. Once you get it working, and it shows every resource
 * you want to index, just change "getResources" to "SiteAtoZ" in the snippet tag.
 * Once that's working, you can add any of the optional parameters listed below.
 *
 * All of the parameters for getResources will be passed through. They can be used
 * to select the parents, sort field, tpl for each entry, etc.
 *
 * The &resources parameter can only be used to exclude resources (&resources=`-12,19`),
 * using it to include docs not work because getResources will include those resources
 * regardless of any other criteria and they will be included in every alphabet section.
 * The &where parameter will be ignored becuase it interferes with the selection by initial letter.
 *
 * Simple use:
 * [[!SiteAtoZ? &parents=`6` &tpl=`MyTpl`]]
 *
 * Required parameters:
 * ---------------
 * @property parents - (string) Comma-separated list of ID's of container documents you want included (`0` for all docs)
 * @property tpl - (string) Tpl chunk used to format each entry; Default 'AzItemTpl'
 *
 * Optional parameters:
 * ---------------
 * @property useNumbers - (boolean) Put a number array in front of the alphabet' default '0'
 * @property combineNumbers (boolean) group 0-9 titles together; default '0'
 * @property useAlphabet - (boolean) Use the Alphabet; default: '1'
 * @property headingSeparator - (string) separator to use between letters in heading; Default '&nbsp| '
 * @property alphabetHeadingStart - (string) Letter to start with; Default: 'A'
 * @property alphabetHeadingEnd - (string) Letter to end with; Default 'Z'
 * @property title - (string) Field to used for search; Default: pagetitle
 * @property headingLinksTpl - (string) A tpl containing the entire A-Z heading (useful if you'd like to use images)
 * @property noData - (string) string to show if search comes up empty
 *
 * All other parameters are those of getResources. They should all work as they do for getResources with two exceptions:
 * @property resources can be used to exclude documents, but not to include them (@property resources=`-2,24`).
 * @property where will be ignored (it conflicts with the selection by initial letter).
 */

/* http://support.internetconnection.net/CODE_LIBRARY/Javascript_Show_Hide.shtml */

$sp =& $scriptProperties;
$documentId = $modx->resource->get('id');


$sp['tpl'] = empty($sp['tpl'])? 'AzItemTpl' : $sp['tpl'] ;

$sp['parents'] = empty($sp['parents'])? '0' : $sp['parents'];
$headingSeparator = empty($sp['headingSeparator'])? '<span class="az-separator"> | </span>'. "\n" : $sp['headingSeparator'] . "\n";
$title = empty($sp['title'])? 'pagetitle' : $sp['title'];
$alphabetHeadingStart = (empty($sp['alphabetHeadingStart']))? 'A' : $sp['alphabetHeadingStart'];
$alphabetHeadingEnd = (empty($sp['alphabetHeadingEnd']))? 'Z' : $sp['alphabetHeadingEnd'];
$useNumbers = $sp['useNumbers'] === '1'? true : false;
$combineNumbers = $sp['combineNumbers'] === '1'? true : false;
$useAlphabet = $sp['useAlphabet'] === '0'? false: true;

if ($combineNumbers) {
    $n = array('[0-9]');
} else {
    $n = range('0','9');
}
$a = range($alphabetHeadingStart, $alphabetHeadingEnd);
$alphabet = array();

if ($useNumbers) {
    $alphabet=$n;
}
if ($useAlphabet) {
    $alphabet = array_merge($alphabet,$a);
}
unset($n,$a);

$whereProperty = !empty($sp['where'])? $sp['where'] : false;

$noData = true;
foreach ($alphabet as $k=>$v) {
    if ($combineNumbers && ($v == '[0-9]') ) {
        $local_where = array(
            $title . ':REGEXP' => '^[0-9]',
        );
    } else {
        $local_where = array(
            $title . ':LIKE' => $v . '%',
        );
    }
    /* ToDo: Some day this may work */
    /*if ($whereProperty !== false) {
        $w = $modx->fromJSON($sp['where']);
        $local_where = array_merge($local_where,$w);
        unset($w);
    }*/
    $sp['where'] = $modx->toJSON($local_where);

    $ret = $modx->runSnippet('getResources',$sp);
    if (empty($ret)) {
        $header[] = $v;
    } else {
        $noData = false; /* found at least one */
        $header[] = '<a class="az-headeritem" href="'.$modx->makeUrl($documentId).'#jump_to_' . $v . '">' . $v . '</a>';
        $output .= '<p class="az-anchor">' . "<a name=\"jump_to_$v\" id=\"jump_to_$v\"></a><strong>" . $v . "</strong></p>\n";
        $output .= $ret;
    }
}
if ($noData === true) {
    $modx->setPlaceholder('noData',$sp['noData']);
}
$headingLinks = (empty($sp['headingLinksTpl']))? implode($headingSeparator,$header) : $modx->getChunk($sp['headingLinksTpl']);

return $headingLinks . "\n" . '<p class="az-noData">[[+noData]]</p>' . "\n" . $output;

[[!SiteAtoZ? &parents=`8` &useNumbers=`1` &combineNumbers=`1` &tpl=`AtoZ` &showHidden=`true` &useJS=`1` &cssFile=`/assets/templates/tapanime/style/siteatoz2.css`]]