'modDocument', 'resource' => array ( 'id' => 94, 'type' => 'document', 'contentType' => 'text/html', 'pagetitle' => 'Albrecht Soil Analysis', 'longtitle' => 'Albrecht Soil Analysis Reporting', 'description' => 'Dr. Albrecht saw a direct link between soil quality and food quality, drawing a direct connection between poor quality forage crops, and ill health in livestock. Use crop monitor online soil analysis to start the journey to better soil and crop quality.', 'alias' => 'albrecht-soil-analysis', 'alias_visible' => 1, 'link_attributes' => '', 'published' => 1, 'pub_date' => 0, 'unpub_date' => 0, 'parent' => 0, 'isfolder' => 0, 'introtext' => 'When you correct cation balance, you have addressed soil chemistry, which improves the physical structure of the soil.', 'content' => '

Albrecht Soil Analysis

The soil is the ‘creative material’ of most of the basic needs of life. Creation starts with a handful of dust.

Dr. William A. Abrecht. University of Missouri

Physical

When you correct cation balance, you have addressed soil chemistry, which improves the physical structure of the soil.

Chemical

The correction of cation balance and the provision of minimum levels of micronutrients tkatesk care of the chemical part of soil productivity and health.

Biological

The essential understanding involves a recognition that the purpose of cation balancing is to stimulate soil biology, and much of the beneficial response relates to firing up this workforce

[[!getResources? &parents=`[[*id]]` &level=`0` &includeTVs=`1` &processTVs=`1` &includeContent=`1` &tplFirst=`projectsSectionFIRST` &tpl=`projectsSectionEVEN` &tplOdd=`projectsSectionODD` &sortby=`FIELD(modResource.id, 95 )` &sortdir=`ASC` &limit=`0` ]]

Dr. Albrecht saw a direct link between soil quality and food quality, drawing direct connection between poor quality forage crops, and ill health in livestock.

Feed the soil to feed the plant is another vital concept of the Albrecht Model of soil building.

Feed the soil to feed the plant is another vital concept of the Albrecht Model of soil building.

', 'richtext' => 0, 'template' => 13, 'menuindex' => 10, 'searchable' => 1, 'cacheable' => 1, 'createdby' => 1, 'createdon' => 1564350148, 'editedby' => 1, 'editedon' => 1566968689, 'deleted' => 0, 'deletedon' => 0, 'deletedby' => 0, 'publishedon' => 1564350120, 'publishedby' => 1, 'menutitle' => 'Soil Analysis', 'donthit' => 0, 'privateweb' => 0, 'privatemgr' => 0, 'content_dispo' => 0, 'hidemenu' => 1, 'class_key' => 'modDocument', 'context_key' => 'web', 'content_type' => 1, 'uri' => 'albrecht-soil-analysis.html', 'uri_override' => 0, 'hide_children_in_tree' => 0, 'show_in_tree' => 1, 'properties' => NULL, '_content' => ' Albrecht Soil Analysis Reporting | Crop Monitor

Albrecht Soil Analysis

The soil is the ‘creative material’ of most of the basic needs of life. Creation starts with a handful of dust.

Dr. William A. Abrecht. University of Missouri

Physical

When you correct cation balance, you have addressed soil chemistry, which improves the physical structure of the soil.

Chemical

The correction of cation balance and the provision of minimum levels of micronutrients tkatesk care of the chemical part of soil productivity and health.

Biological

The essential understanding involves a recognition that the purpose of cation balancing is to stimulate soil biology, and much of the beneficial response relates to firing up this workforce

[[!getResources? &parents=`94` &level=`0` &includeTVs=`1` &processTVs=`1` &includeContent=`1` &tplFirst=`projectsSectionFIRST` &tpl=`projectsSectionEVEN` &tplOdd=`projectsSectionODD` &sortby=`FIELD(modResource.id, 95 )` &sortdir=`ASC` &limit=`0` ]]

Dr. Albrecht saw a direct link between soil quality and food quality, drawing direct connection between poor quality forage crops, and ill health in livestock.

Feed the soil to feed the plant is another vital concept of the Albrecht Model of soil building.

Feed the soil to feed the plant is another vital concept of the Albrecht Model of soil building.

Subscribe to receive updates!

[[!FormIt? &hooks=`MailChimpSubscribe` &validate=`email:email:required,name:required` &validationErrorMessage=`true` &clearFieldsOnSuccess=`1` &submitVar=`newsletter-submit` &mailchimpListId=`04e221f3bc` &mailchimpFields=`name=FNAME,email=EMAIL` &mailchimpSubscribeField=`newsletter` &mailchimpSubscribeFieldValue=`1` &successMessage=`Thankyou for subscribing` ]] [[!+fi.successMessage:notempty=`

[[!+fi.successMessage]]

`]] [[!+fi.validation_error_message:notempty=`

[[+errors]] [[!+fi.validation_error_message]]

`]]

Address

34 Coplestone Street,
Scottsdale, Tasmania 7260

Email

enquiry@cropmonitor.info

Phone

0417 728 061

Contact Us

[[!FormIt? &hooks=`spam,email` &submitVar=`enquiry-submit` &emailTpl=`CMenquiryEmailTpl` &emailTo=`enquiries@cropmonitor.info` &successMessage=`Thankyou for contacting us, we will be in touch soon.` &validationErrorMessage=`true` &validate=`nospam:blank, name:required, email:email:required, text:required:stripTags` ]] [[!+fi.successMessage:notempty=`
[[!+fi.successMessage]]
`]] [[!+fi.validation_error_message:notempty=`
[[+errors]] [[!+fi.validation_error_message]]
`]]
', '_isForward' => false, ), 'contentType' => array ( 'id' => 1, 'name' => 'HTML', 'description' => 'HTML content', 'mime_type' => 'text/html', 'file_extensions' => '.html', 'headers' => NULL, 'binary' => 0, ), 'policyCache' => array ( ), 'elementCache' => array ( '[[*longtitle]]' => 'Albrecht Soil Analysis Reporting', '[[*introtext]]' => 'When you correct cation balance, you have addressed soil chemistry, which improves the physical structure of the soil.', '[[*description]]' => 'Dr. Albrecht saw a direct link between soil quality and food quality, drawing a direct connection between poor quality forage crops, and ill health in livestock. Use crop monitor online soil analysis to start the journey to better soil and crop quality.', '[[$dash-header]]' => ' ', '[[~18]]' => 'about.html', '[[~71]]' => 'blog/', '[[~17]]' => 'contact-us.html', '[[~4]]' => 'login/', '[[*id]]' => 94, '[[~94]]' => 'albrecht-soil-analysis.html', '[[SimpleCopyright? &startYear=`2005`]]' => '© 2005-2019 by Crop Monitor', '[[~1]]' => '/', '[[$dash-footer]]' => ' ', ), 'sourceCache' => array ( 'modChunk' => array ( 'dash-header' => array ( 'fields' => array ( 'id' => 13, 'source' => 0, 'property_preprocess' => false, 'name' => 'dash-header', 'description' => '', 'editor_type' => 0, 'category' => 0, 'cache_type' => 0, 'snippet' => ' ', 'locked' => false, 'properties' => array ( ), 'static' => false, 'static_file' => '', 'content' => ' ', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( ), ), 'sc_chunk' => array ( 'fields' => array ( 'id' => 24, 'source' => 1, 'property_preprocess' => false, 'name' => 'sc_chunk', 'description' => 'This chunk styles the year output', 'editor_type' => 0, 'category' => 4, 'cache_type' => 0, 'snippet' => '© [[+output]] by [[++site_name]]', 'locked' => false, 'properties' => array ( ), 'static' => false, 'static_file' => '', 'content' => '© [[+output]] by [[++site_name]]', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( 'id' => 1, 'name' => 'Filesystem', 'description' => '', 'class_key' => 'sources.modFileMediaSource', 'properties' => array ( 'fred' => array ( 'name' => 'fred', 'desc' => '', 'type' => 'combo-boolean', 'options' => array ( ), 'value' => false, 'lexicon' => NULL, ), 'fredReadOnly' => array ( 'name' => 'fredReadOnly', 'desc' => '', 'type' => 'combo-boolean', 'options' => array ( ), 'value' => false, 'lexicon' => NULL, ), ), 'is_stream' => true, ), ), 'dash-footer' => array ( 'fields' => array ( 'id' => 15, 'source' => 0, 'property_preprocess' => false, 'name' => 'dash-footer', 'description' => '', 'editor_type' => 0, 'category' => 0, 'cache_type' => 0, 'snippet' => ' ', 'locked' => false, 'properties' => array ( ), 'static' => false, 'static_file' => '', 'content' => ' ', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( ), ), ), 'modSnippet' => array ( 'SimpleCopyright' => array ( 'fields' => array ( 'id' => 12, 'source' => 1, 'property_preprocess' => false, 'name' => 'SimpleCopyright', 'description' => 'This Snippet returns the current year and can be called with a placeholder for the start year of the website.', 'editor_type' => 0, 'category' => 4, 'cache_type' => 0, 'snippet' => '/* * DESCRIPTION: * This snippet returns the current year * It is then styled with a chunk to output a copyright notice which you can adapt to fit your needs. * You can call this snippet with a startyear for your website. * If you use a start year it automatically changes when the year passes. * i.e. 2012 turns into 2012-2013 * * PARAMETERS: * @ &startYear (string) optional. Default: Current Year * @ &separator (string) optional. Default: \'-\' * @ &static (bool) optional. Default: 0 * @ &tpl (string) optional. Default: \'sc_chunk\' * * PLACEHOLDERS: * @ [[+output]] * * The usage defines \'2012\' as the \'current\' year purely for illustration purpose only. * This is obviously wrong in 2013 or up... * * USAGE: * // Outputs: "© 2012 by [[+site_name]]" * [[SimpleCopyright]] * * // Outputs: "© 2007-2012 by [[+site_name]]" * // After newyears eve it turns into 2012-2013 automatically * [[SimpleCopyright? &startYear=`2007`]] * * // Outputs: "© 2004 by [[+site_name]]". * // Always use \'static\' in conjunction with \'startYear\'. * // If you use \'static\' only it will ignore it\'s setting and resolve to the current year. * [[SimpleCopyright? &startYear=`2004` &static=`1`]] * * You can also set the separator just for fun... * It defaults to "-" * * This outputs "© 2007/2012" * [[SimpleCopyright? &startYear=`2007` &separator=`/`]] * */ // Get the current year $currentYear = date(\'Y\'); // Check for a starting year, separator, static & chunk $startYear = (string) $modx->getOption(\'startYear\', $scriptProperties); $separator = (string) $modx->getOption(\'separator\', $scriptProperties, \'-\'); $static = (bool) $modx->getOption(\'static\', $scriptProperties, 0); $tpl = (string) $modx->getOption(\'tpl\', $scriptProperties, \'sc_chunk\'); if($static&&!empty($startYear)){ // is static : can be the future too $construct = $startYear; } elseif(!empty($startYear)) { // is semi dynamic : set with a starting year that never exceeds the future $construct = ($startYear>=$currentYear ? $currentYear : $startYear.$separator.$currentYear); } else { // is dynamic : changes with each year $construct = $currentYear; } // Get a chunk to style the output & check if it exists... $chunk = $modx->getObject(\'modChunk\',array( \'name\' => $tpl )); if (!$chunk){ // If no chunk is found return error & write to log $modx->log(xPDO::LOG_LEVEL_ERROR, \'No chunk found!\'); return \'No chunk found!\'; } else { $outputString = $modx->getChunk($tpl,array( \'output\' => $construct )); } return $outputString;', 'locked' => false, 'properties' => array ( ), 'moduleguid' => '', 'static' => false, 'static_file' => '', 'content' => '/* * DESCRIPTION: * This snippet returns the current year * It is then styled with a chunk to output a copyright notice which you can adapt to fit your needs. * You can call this snippet with a startyear for your website. * If you use a start year it automatically changes when the year passes. * i.e. 2012 turns into 2012-2013 * * PARAMETERS: * @ &startYear (string) optional. Default: Current Year * @ &separator (string) optional. Default: \'-\' * @ &static (bool) optional. Default: 0 * @ &tpl (string) optional. Default: \'sc_chunk\' * * PLACEHOLDERS: * @ [[+output]] * * The usage defines \'2012\' as the \'current\' year purely for illustration purpose only. * This is obviously wrong in 2013 or up... * * USAGE: * // Outputs: "© 2012 by [[+site_name]]" * [[SimpleCopyright]] * * // Outputs: "© 2007-2012 by [[+site_name]]" * // After newyears eve it turns into 2012-2013 automatically * [[SimpleCopyright? &startYear=`2007`]] * * // Outputs: "© 2004 by [[+site_name]]". * // Always use \'static\' in conjunction with \'startYear\'. * // If you use \'static\' only it will ignore it\'s setting and resolve to the current year. * [[SimpleCopyright? &startYear=`2004` &static=`1`]] * * You can also set the separator just for fun... * It defaults to "-" * * This outputs "© 2007/2012" * [[SimpleCopyright? &startYear=`2007` &separator=`/`]] * */ // Get the current year $currentYear = date(\'Y\'); // Check for a starting year, separator, static & chunk $startYear = (string) $modx->getOption(\'startYear\', $scriptProperties); $separator = (string) $modx->getOption(\'separator\', $scriptProperties, \'-\'); $static = (bool) $modx->getOption(\'static\', $scriptProperties, 0); $tpl = (string) $modx->getOption(\'tpl\', $scriptProperties, \'sc_chunk\'); if($static&&!empty($startYear)){ // is static : can be the future too $construct = $startYear; } elseif(!empty($startYear)) { // is semi dynamic : set with a starting year that never exceeds the future $construct = ($startYear>=$currentYear ? $currentYear : $startYear.$separator.$currentYear); } else { // is dynamic : changes with each year $construct = $currentYear; } // Get a chunk to style the output & check if it exists... $chunk = $modx->getObject(\'modChunk\',array( \'name\' => $tpl )); if (!$chunk){ // If no chunk is found return error & write to log $modx->log(xPDO::LOG_LEVEL_ERROR, \'No chunk found!\'); return \'No chunk found!\'; } else { $outputString = $modx->getChunk($tpl,array( \'output\' => $construct )); } return $outputString;', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( 'id' => 1, 'name' => 'Filesystem', 'description' => '', 'class_key' => 'sources.modFileMediaSource', 'properties' => array ( 'fred' => array ( 'name' => 'fred', 'desc' => '', 'type' => 'combo-boolean', 'options' => array ( ), 'value' => false, 'lexicon' => NULL, ), 'fredReadOnly' => array ( 'name' => 'fredReadOnly', 'desc' => '', 'type' => 'combo-boolean', 'options' => array ( ), 'value' => false, 'lexicon' => NULL, ), ), 'is_stream' => true, ), ), 'Gallery' => array ( 'fields' => array ( 'id' => 129, 'source' => 0, 'property_preprocess' => false, 'name' => 'Gallery', 'description' => '', 'editor_type' => 0, 'category' => 45, 'cache_type' => 0, 'snippet' => '/** * Gallery * * Copyright 2010-2012 by Shaun McCormick * * Gallery is free software; you can redistribute it and/or modify it under the * terms of the GNU General Public License as published by the Free Software * Foundation; either version 2 of the License, or (at your option) any later * version. * * Gallery is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with * Gallery; if not, write to the Free Software Foundation, Inc., 59 Temple * Place, Suite 330, Boston, MA 02111-1307 USA * * @package gallery */ /** * The main Gallery snippet. * * @var modX $modx * @var Gallery $gallery * * @package gallery */ $gallery = $modx->getService(\'gallery\',\'Gallery\',$modx->getOption(\'gallery.core_path\',null,$modx->getOption(\'core_path\').\'components/gallery/\').\'model/gallery/\',$scriptProperties); if (!($gallery instanceof Gallery)) return \'\'; $modx->lexicon->load(\'gallery:web\'); /* check for REQUEST vars if property set */ $imageGetParam = $modx->getOption(\'imageGetParam\',$scriptProperties,\'galItem\'); $albumRequestVar = $modx->getOption(\'albumRequestVar\',$scriptProperties,\'galAlbum\'); $tagRequestVar = $modx->getOption(\'tagRequestVar\',$scriptProperties,\'galTag\'); if ($modx->getOption(\'checkForRequestAlbumVar\',$scriptProperties,true)) { if (!empty($_REQUEST[$albumRequestVar])) $scriptProperties[\'album\'] = $_REQUEST[$albumRequestVar]; } if ($modx->getOption(\'checkForRequestTagVar\',$scriptProperties,true)) { if (!empty($_REQUEST[$tagRequestVar])) $scriptProperties[\'tag\'] = $_REQUEST[$tagRequestVar]; } if (empty($scriptProperties[\'album\']) && empty($scriptProperties[\'tag\'])) return \'\'; $data = $modx->call(\'galItem\',\'getList\',array(&$modx,$scriptProperties)); $totalVar = $modx->getOption(\'totalVar\', $scriptProperties, \'total\'); $modx->setPlaceholder($totalVar,$data[\'total\']); /* load plugins */ $plugin = $modx->getOption(\'plugin\',$scriptProperties,\'\'); if (!empty($plugin)) { $pluginPath = $modx->getOption(\'pluginPath\',$scriptProperties,\'\'); if (empty($pluginPath)) { $pluginPath = $gallery->config[\'modelPath\'].\'gallery/plugins/\'; } /** @var GalleryPlugin $plugin */ if (($className = $modx->loadClass($plugin,$pluginPath,true,true))) { $plugin = new $className($gallery,$scriptProperties); $plugin->load(); $scriptProperties = $plugin->adjustSettings($scriptProperties); } else { return $modx->lexicon(\'gallery.plugin_err_load\',array(\'name\' => $plugin,\'path\' => $pluginPath)); } } else { if ($modx->getOption(\'useCss\',$scriptProperties,true)) { $modx->regClientCSS($gallery->config[\'cssUrl\'].\'web.css\'); } } /* iterate */ $imageProperties = $modx->getOption(\'imageProperties\',$scriptProperties,\'\'); $imageProperties = !empty($imageProperties) ? $modx->fromJSON($imageProperties) : array(); $imageProperties = array_merge(array( \'w\' => (int)$modx->getOption(\'imageWidth\',$scriptProperties,500), \'h\' => (int)$modx->getOption(\'imageHeight\',$scriptProperties,500), \'zc\' => (boolean)$modx->getOption(\'imageZoomCrop\',$scriptProperties,0), \'far\' => (string)$modx->getOption(\'imageFar\',$scriptProperties,false), \'q\' => (int)$modx->getOption(\'imageQuality\',$scriptProperties,90), ),$imageProperties); $thumbProperties = $modx->getOption(\'thumbProperties\',$scriptProperties,\'\'); $thumbProperties = !empty($thumbProperties) ? $modx->fromJSON($thumbProperties) : array(); $thumbProperties = array_merge(array( \'w\' => (int)$modx->getOption(\'thumbWidth\',$scriptProperties,100), \'h\' => (int)$modx->getOption(\'thumbHeight\',$scriptProperties,100), \'zc\' => (boolean)$modx->getOption(\'thumbZoomCrop\',$scriptProperties,1), \'far\' => (string)$modx->getOption(\'thumbFar\',$scriptProperties,\'C\'), \'q\' => (int)$modx->getOption(\'thumbQuality\',$scriptProperties,90), ),$thumbProperties); $idx = 0; $output = array(); $filesUrl = $modx->call(\'galAlbum\',\'getFilesUrl\',array(&$modx)); $filesPath = $modx->call(\'galAlbum\',\'getFilesPath\',array(&$modx)); $itemCls = $modx->getOption(\'itemCls\',$scriptProperties,\'gal-item\'); $imageAttributes = $modx->getOption(\'imageAttributes\',$scriptProperties,\'\'); $linkAttributes = $modx->getOption(\'linkAttributes\',$scriptProperties,\'\'); $linkToImage = $modx->getOption(\'linkToImage\',$scriptProperties,false); $activeCls = $modx->getOption(\'activeCls\',$scriptProperties,\'gal-item-active\'); $highlightItem = $modx->getOption($imageGetParam,$_REQUEST,false); $defaultThumbTpl = $modx->getOption(\'thumbTpl\',$scriptProperties,\'galItemThumb\'); /** @var galItem $item */ if (!is_array($data)) return \'\'; // prep for &thumbTpl_N $keys = array_keys($scriptProperties); $nthTpls = array(); foreach($keys as $key) { $keyBits = $gallery->explodeAndClean($key, \'_\'); if (isset($keyBits[0]) && $keyBits[0] === \'thumbTpl\') { if ($i = (int) $keyBits[1]) $nthTpls[$i] = $scriptProperties[$key]; } } ksort($nthTpls); foreach ($data[\'items\'] as $item) { $itemArray = $item->toArray(); $itemArray[\'idx\'] = $idx; $itemArray[\'cls\'] = $itemCls; if ($itemArray[\'id\'] == $highlightItem) { $itemArray[\'cls\'] .= \' \'.$activeCls; } $itemArray[\'filename\'] = basename($item->get(\'filename\')); $itemArray[\'image_absolute\'] = $item->get(\'base_url\').$filesUrl.$item->get(\'filename\'); $itemArray[\'fileurl\'] = $itemArray[\'image_absolute\']; $itemArray[\'filepath\'] = $filesPath.$item->get(\'filename\'); $itemArray[\'filesize\'] = $item->get(\'filesize\'); $itemArray[\'thumbnail\'] = $item->get(\'thumbnail\',$thumbProperties); $itemArray[\'image\'] = $item->get(\'thumbnail\',$imageProperties); $itemArray[\'image_attributes\'] = $imageAttributes; $itemArray[\'link_attributes\'] = $linkAttributes; if (!empty($scriptProperties[\'album\'])) $itemArray[\'album\'] = $scriptProperties[\'album\']; if (!empty($scriptProperties[\'tag\'])) $itemArray[\'tag\'] = $scriptProperties[\'tag\']; $itemArray[\'linkToImage\'] = $linkToImage; $itemArray[\'url\'] = $item->get(\'url\'); $itemArray[\'imageGetParam\'] = $imageGetParam; $itemArray[\'albumRequestVar\'] = $albumRequestVar; $itemArray[\'tagRequestVar\'] = $tagRequestVar; $itemArray[\'tag\'] = \'\'; if ($plugin) { $plugin->renderItem($itemArray); } $thumbTpl = $defaultThumbTpl; if (isset($nthTpls[$idx])) { $thumbTpl = $nthTpls[$idx]; } else { foreach ($nthTpls as $int => $tpl) { if ( ($idx % $int) === 0 ) $thumbTpl = $tpl; } } $output[] = $gallery->getChunk($thumbTpl,$itemArray); $idx++; } $output = implode("\\n",$output); /* if set, place in a container tpl */ $containerTpl = $modx->getOption(\'containerTpl\',$scriptProperties,false); if (!empty($containerTpl)) { $ct = $gallery->getChunk($containerTpl,array( \'thumbnails\' => $output, \'album_name\' => $data[\'album\'][\'name\'], \'album_description\' => $data[\'album\'][\'description\'], \'album_year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', \'albumRequestVar\' => $albumRequestVar, \'albumId\' => $data[\'album\'][\'id\'], )); if (!empty($ct)) $output = $ct; } /* set to placeholders or output directly */ $toPlaceholder = $modx->getOption(\'toPlaceholder\',$scriptProperties,false); if (!empty($toPlaceholder)) { $modx->toPlaceholders(array( $toPlaceholder => $output, $toPlaceholder.\'.id\' => $data[\'album\'][\'id\'], $toPlaceholder.\'.name\' => $data[\'album\'][\'name\'], $toPlaceholder.\'.year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', $toPlaceholder.\'.description\' => $data[\'album\'][\'description\'], $toPlaceholder.\'.total\' => $data[\'total\'], $toPlaceholder.\'.next\' => $data[\'album\'][\'id\'] + 1, $toPlaceholder.\'.prev\' => $data[\'album\'][\'id\'] - 1, )); } else { $placeholderPrefix = $modx->getOption(\'placeholderPrefix\',$scriptProperties,\'gallery.\'); $modx->toPlaceholders(array( $placeholderPrefix.\'id\' => $data[\'album\'][\'id\'], $placeholderPrefix.\'name\' => $data[\'album\'][\'name\'], $placeholderPrefix.\'year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', $placeholderPrefix.\'description\' => $data[\'album\'][\'description\'], $placeholderPrefix.\'total\' => $data[\'total\'], $placeholderPrefix.\'next\' => $data[\'album\'][\'id\'] + 1, $placeholderPrefix.\'prev\' => $data[\'album\'][\'id\'] - 1, )); return $output; } return \'\';', 'locked' => false, 'properties' => array ( 'album' => array ( 'name' => 'album', 'desc' => 'gallery.album_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'Will load only items from this album. Can be either the name or ID of the Album.', 'area_trans' => '', ), 'tag' => array ( 'name' => 'tag', 'desc' => 'gallery.tag_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'Will load only items with this tag.', 'area_trans' => '', ), 'plugin' => array ( 'name' => 'plugin', 'desc' => 'gallery.plugin_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The name of a plugin to use for front-end displaying. Please see the official docs for a list of available plugins.', 'area_trans' => '', ), 'pluginPath' => array ( 'name' => 'pluginPath', 'desc' => 'gallery.pluginpath_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'Could not load plugin "[[+name]]" from path: [[+path]]', 'area_trans' => '', ), 'thumbTpl' => array ( 'name' => 'thumbTpl', 'desc' => 'gallery.thumbtpl_desc', 'type' => 'textfield', 'options' => '', 'value' => 'galItemThumb', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The Chunk to use as a tpl for each thumbnail.', 'area_trans' => '', ), 'containerTpl' => array ( 'name' => 'containerTpl', 'desc' => 'gallery.containertpl_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'An optional chunk to wrap the output in.', 'area_trans' => '', ), 'itemCls' => array ( 'name' => 'itemCls', 'desc' => 'gallery.itemcls_desc', 'type' => 'textfield', 'options' => '', 'value' => 'gal-item', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The CSS class for each thumbnail.', 'area_trans' => '', ), 'activeCls' => array ( 'name' => 'activeCls', 'desc' => 'gallery.activecls_desc', 'type' => 'textfield', 'options' => '', 'value' => 'gal-item-active', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The CSS class to add when the active item (the item specified in the GalleryItem snippet) is displayed.', 'area_trans' => '', ), 'toPlaceholder' => array ( 'name' => 'toPlaceholder', 'desc' => 'gallery.toplaceholder_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If set, will set the output to a placeholder of this value, and the snippet call will output nothing.', 'area_trans' => '', ), 'thumbWidth' => array ( 'name' => 'thumbWidth', 'desc' => 'gallery.thumbwidth_desc', 'type' => 'textfield', 'options' => '', 'value' => '100', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The width of the generated thumbnails, in pixels.', 'area_trans' => '', ), 'thumbHeight' => array ( 'name' => 'thumbHeight', 'desc' => 'gallery.thumbheight_desc', 'type' => 'textfield', 'options' => '', 'value' => '100', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The height of the generated thumbnails, in pixels.', 'area_trans' => '', ), 'thumbZoomCrop' => array ( 'name' => 'thumbZoomCrop', 'desc' => 'gallery.thumbzoomcrop_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'Whether or not the thumbnail will be zoom-cropped.', 'area_trans' => '', ), 'thumbFar' => array ( 'name' => 'thumbFar', 'desc' => 'gallery.thumbfar_desc', 'type' => 'textfield', 'options' => '', 'value' => 'C', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The "far" value for phpThumb for the thumbnail, for aspect ratio zooming.', 'area_trans' => '', ), 'thumbQuality' => array ( 'name' => 'thumbQuality', 'desc' => 'gallery.thumbquality_desc', 'type' => 'textfield', 'options' => '', 'value' => 90, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The "q" value for phpThumb for the thumbnail, for quality.', 'area_trans' => '', ), 'thumbProperties' => array ( 'name' => 'thumbProperties', 'desc' => 'gallery.thumbproperties_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'A JSON object of parameters to pass to phpThumb as properties for the thumbnail.', 'area_trans' => '', ), 'linkToImage' => array ( 'name' => 'linkToImage', 'desc' => 'gallery.linktoimage_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If true, will link directly to the image. If false, will append GET parameters to the URL to load the image with the GalleryItem snippet.', 'area_trans' => '', ), 'imageGetParam' => array ( 'name' => 'imageGetParam', 'desc' => 'gallery.imagegetparam_desc', 'type' => 'textfield', 'options' => '', 'value' => 'galItem', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The GET param to use when not linking directly to an image. Make sure this matches the getParam property in the GalleryItem snippet call.', 'area_trans' => '', ), 'imageWidth' => array ( 'name' => 'imageWidth', 'desc' => 'gallery.imagewidth_desc', 'type' => 'textfield', 'options' => '', 'value' => 500, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If being used by a plugin, the width of the currently on-display image.', 'area_trans' => '', ), 'imageHeight' => array ( 'name' => 'imageHeight', 'desc' => 'gallery.imageheight_desc', 'type' => 'textfield', 'options' => '', 'value' => 500, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If being used by a plugin, the height of the currently on-display image.', 'area_trans' => '', ), 'imageZoomCrop' => array ( 'name' => 'imageZoomCrop', 'desc' => 'gallery.imagezoomcrop_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If being used by a plugin, whether or not the currently on-display image will be zoom-cropped.', 'area_trans' => '', ), 'imageFar' => array ( 'name' => 'imageFar', 'desc' => 'gallery.imagefar_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The "far" value for phpThumb for the image, for aspect ratio zooming.', 'area_trans' => '', ), 'imageQuality' => array ( 'name' => 'imageQuality', 'desc' => 'gallery.imagequality_desc', 'type' => 'textfield', 'options' => '', 'value' => 90, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The "q" value for phpThumb for the image, for quality.', 'area_trans' => '', ), 'imageProperties' => array ( 'name' => 'imageProperties', 'desc' => 'gallery.imageproperties_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'A JSON object of parameters to pass to phpThumb as properties for the image.', 'area_trans' => '', ), 'sort' => array ( 'name' => 'sort', 'desc' => 'gallery.sort_desc', 'type' => 'textfield', 'options' => '', 'value' => 'rank', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The field to sort images by.', 'area_trans' => '', ), 'dir' => array ( 'name' => 'dir', 'desc' => 'gallery.dir_desc', 'type' => 'textfield', 'options' => '', 'value' => 'ASC', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The direction to sort images by.', 'area_trans' => '', ), 'limit' => array ( 'name' => 'limit', 'desc' => 'gallery.limit_desc', 'type' => 'textfield', 'options' => '', 'value' => 0, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If set to non-zero, will only show X number of items.', 'area_trans' => '', ), 'start' => array ( 'name' => 'start', 'desc' => 'gallery.start_desc', 'type' => 'textfield', 'options' => '', 'value' => 0, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'The index to start grabbing from when limiting the number of items. Similar to an SQL order by start clause.', 'area_trans' => '', ), 'showInactive' => array ( 'name' => 'showInactive', 'desc' => 'gallery.showinactive_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If 1, will also display inactive images.', 'area_trans' => '', ), 'checkForRequestAlbumVar' => array ( 'name' => 'checkForRequestAlbumVar', 'desc' => 'gallery.checkforrequestalbumvar_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If 1, if a REQUEST var of "album" is found, will use that as the album property for the snippet.', 'area_trans' => '', ), 'albumRequestVar' => array ( 'name' => 'albumRequestVar', 'desc' => 'gallery.albumrequestvar_desc', 'type' => 'textfield', 'options' => '', 'value' => 'galAlbum', 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If checkForRequestAlbumVar is set to true, will look for a REQUEST var with this name to select the album.', 'area_trans' => '', ), 'checkForRequestTagVar' => array ( 'name' => 'checkForRequestTagVar', 'desc' => 'gallery.checkforrequesttagvar_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'If 1, if a REQUEST var of "tag" is found, will use that as the tag property for the snippet.', 'area_trans' => '', ), 'tagRequestVar' => array ( 'name' => 'tagRequestVar', 'desc' => 'gallery.tagrequestvar_desc', 'type' => 'textfield', 'options' => '', 'value' => 'galTag', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'If checkForRequestTagVar is set to true, will look for a REQUEST var with this name to select the tag.', 'area_trans' => '', ), 'useCss' => array ( 'name' => 'useCss', 'desc' => 'gallery.usecss_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'gallery:properties', 'area' => '', 'desc_trans' => 'Whether or not to use the pre-provided CSS for the snippet.', 'area_trans' => '', ), ), 'moduleguid' => '', 'static' => false, 'static_file' => '', 'content' => '/** * Gallery * * Copyright 2010-2012 by Shaun McCormick * * Gallery is free software; you can redistribute it and/or modify it under the * terms of the GNU General Public License as published by the Free Software * Foundation; either version 2 of the License, or (at your option) any later * version. * * Gallery is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with * Gallery; if not, write to the Free Software Foundation, Inc., 59 Temple * Place, Suite 330, Boston, MA 02111-1307 USA * * @package gallery */ /** * The main Gallery snippet. * * @var modX $modx * @var Gallery $gallery * * @package gallery */ $gallery = $modx->getService(\'gallery\',\'Gallery\',$modx->getOption(\'gallery.core_path\',null,$modx->getOption(\'core_path\').\'components/gallery/\').\'model/gallery/\',$scriptProperties); if (!($gallery instanceof Gallery)) return \'\'; $modx->lexicon->load(\'gallery:web\'); /* check for REQUEST vars if property set */ $imageGetParam = $modx->getOption(\'imageGetParam\',$scriptProperties,\'galItem\'); $albumRequestVar = $modx->getOption(\'albumRequestVar\',$scriptProperties,\'galAlbum\'); $tagRequestVar = $modx->getOption(\'tagRequestVar\',$scriptProperties,\'galTag\'); if ($modx->getOption(\'checkForRequestAlbumVar\',$scriptProperties,true)) { if (!empty($_REQUEST[$albumRequestVar])) $scriptProperties[\'album\'] = $_REQUEST[$albumRequestVar]; } if ($modx->getOption(\'checkForRequestTagVar\',$scriptProperties,true)) { if (!empty($_REQUEST[$tagRequestVar])) $scriptProperties[\'tag\'] = $_REQUEST[$tagRequestVar]; } if (empty($scriptProperties[\'album\']) && empty($scriptProperties[\'tag\'])) return \'\'; $data = $modx->call(\'galItem\',\'getList\',array(&$modx,$scriptProperties)); $totalVar = $modx->getOption(\'totalVar\', $scriptProperties, \'total\'); $modx->setPlaceholder($totalVar,$data[\'total\']); /* load plugins */ $plugin = $modx->getOption(\'plugin\',$scriptProperties,\'\'); if (!empty($plugin)) { $pluginPath = $modx->getOption(\'pluginPath\',$scriptProperties,\'\'); if (empty($pluginPath)) { $pluginPath = $gallery->config[\'modelPath\'].\'gallery/plugins/\'; } /** @var GalleryPlugin $plugin */ if (($className = $modx->loadClass($plugin,$pluginPath,true,true))) { $plugin = new $className($gallery,$scriptProperties); $plugin->load(); $scriptProperties = $plugin->adjustSettings($scriptProperties); } else { return $modx->lexicon(\'gallery.plugin_err_load\',array(\'name\' => $plugin,\'path\' => $pluginPath)); } } else { if ($modx->getOption(\'useCss\',$scriptProperties,true)) { $modx->regClientCSS($gallery->config[\'cssUrl\'].\'web.css\'); } } /* iterate */ $imageProperties = $modx->getOption(\'imageProperties\',$scriptProperties,\'\'); $imageProperties = !empty($imageProperties) ? $modx->fromJSON($imageProperties) : array(); $imageProperties = array_merge(array( \'w\' => (int)$modx->getOption(\'imageWidth\',$scriptProperties,500), \'h\' => (int)$modx->getOption(\'imageHeight\',$scriptProperties,500), \'zc\' => (boolean)$modx->getOption(\'imageZoomCrop\',$scriptProperties,0), \'far\' => (string)$modx->getOption(\'imageFar\',$scriptProperties,false), \'q\' => (int)$modx->getOption(\'imageQuality\',$scriptProperties,90), ),$imageProperties); $thumbProperties = $modx->getOption(\'thumbProperties\',$scriptProperties,\'\'); $thumbProperties = !empty($thumbProperties) ? $modx->fromJSON($thumbProperties) : array(); $thumbProperties = array_merge(array( \'w\' => (int)$modx->getOption(\'thumbWidth\',$scriptProperties,100), \'h\' => (int)$modx->getOption(\'thumbHeight\',$scriptProperties,100), \'zc\' => (boolean)$modx->getOption(\'thumbZoomCrop\',$scriptProperties,1), \'far\' => (string)$modx->getOption(\'thumbFar\',$scriptProperties,\'C\'), \'q\' => (int)$modx->getOption(\'thumbQuality\',$scriptProperties,90), ),$thumbProperties); $idx = 0; $output = array(); $filesUrl = $modx->call(\'galAlbum\',\'getFilesUrl\',array(&$modx)); $filesPath = $modx->call(\'galAlbum\',\'getFilesPath\',array(&$modx)); $itemCls = $modx->getOption(\'itemCls\',$scriptProperties,\'gal-item\'); $imageAttributes = $modx->getOption(\'imageAttributes\',$scriptProperties,\'\'); $linkAttributes = $modx->getOption(\'linkAttributes\',$scriptProperties,\'\'); $linkToImage = $modx->getOption(\'linkToImage\',$scriptProperties,false); $activeCls = $modx->getOption(\'activeCls\',$scriptProperties,\'gal-item-active\'); $highlightItem = $modx->getOption($imageGetParam,$_REQUEST,false); $defaultThumbTpl = $modx->getOption(\'thumbTpl\',$scriptProperties,\'galItemThumb\'); /** @var galItem $item */ if (!is_array($data)) return \'\'; // prep for &thumbTpl_N $keys = array_keys($scriptProperties); $nthTpls = array(); foreach($keys as $key) { $keyBits = $gallery->explodeAndClean($key, \'_\'); if (isset($keyBits[0]) && $keyBits[0] === \'thumbTpl\') { if ($i = (int) $keyBits[1]) $nthTpls[$i] = $scriptProperties[$key]; } } ksort($nthTpls); foreach ($data[\'items\'] as $item) { $itemArray = $item->toArray(); $itemArray[\'idx\'] = $idx; $itemArray[\'cls\'] = $itemCls; if ($itemArray[\'id\'] == $highlightItem) { $itemArray[\'cls\'] .= \' \'.$activeCls; } $itemArray[\'filename\'] = basename($item->get(\'filename\')); $itemArray[\'image_absolute\'] = $item->get(\'base_url\').$filesUrl.$item->get(\'filename\'); $itemArray[\'fileurl\'] = $itemArray[\'image_absolute\']; $itemArray[\'filepath\'] = $filesPath.$item->get(\'filename\'); $itemArray[\'filesize\'] = $item->get(\'filesize\'); $itemArray[\'thumbnail\'] = $item->get(\'thumbnail\',$thumbProperties); $itemArray[\'image\'] = $item->get(\'thumbnail\',$imageProperties); $itemArray[\'image_attributes\'] = $imageAttributes; $itemArray[\'link_attributes\'] = $linkAttributes; if (!empty($scriptProperties[\'album\'])) $itemArray[\'album\'] = $scriptProperties[\'album\']; if (!empty($scriptProperties[\'tag\'])) $itemArray[\'tag\'] = $scriptProperties[\'tag\']; $itemArray[\'linkToImage\'] = $linkToImage; $itemArray[\'url\'] = $item->get(\'url\'); $itemArray[\'imageGetParam\'] = $imageGetParam; $itemArray[\'albumRequestVar\'] = $albumRequestVar; $itemArray[\'tagRequestVar\'] = $tagRequestVar; $itemArray[\'tag\'] = \'\'; if ($plugin) { $plugin->renderItem($itemArray); } $thumbTpl = $defaultThumbTpl; if (isset($nthTpls[$idx])) { $thumbTpl = $nthTpls[$idx]; } else { foreach ($nthTpls as $int => $tpl) { if ( ($idx % $int) === 0 ) $thumbTpl = $tpl; } } $output[] = $gallery->getChunk($thumbTpl,$itemArray); $idx++; } $output = implode("\\n",$output); /* if set, place in a container tpl */ $containerTpl = $modx->getOption(\'containerTpl\',$scriptProperties,false); if (!empty($containerTpl)) { $ct = $gallery->getChunk($containerTpl,array( \'thumbnails\' => $output, \'album_name\' => $data[\'album\'][\'name\'], \'album_description\' => $data[\'album\'][\'description\'], \'album_year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', \'albumRequestVar\' => $albumRequestVar, \'albumId\' => $data[\'album\'][\'id\'], )); if (!empty($ct)) $output = $ct; } /* set to placeholders or output directly */ $toPlaceholder = $modx->getOption(\'toPlaceholder\',$scriptProperties,false); if (!empty($toPlaceholder)) { $modx->toPlaceholders(array( $toPlaceholder => $output, $toPlaceholder.\'.id\' => $data[\'album\'][\'id\'], $toPlaceholder.\'.name\' => $data[\'album\'][\'name\'], $toPlaceholder.\'.year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', $toPlaceholder.\'.description\' => $data[\'album\'][\'description\'], $toPlaceholder.\'.total\' => $data[\'total\'], $toPlaceholder.\'.next\' => $data[\'album\'][\'id\'] + 1, $toPlaceholder.\'.prev\' => $data[\'album\'][\'id\'] - 1, )); } else { $placeholderPrefix = $modx->getOption(\'placeholderPrefix\',$scriptProperties,\'gallery.\'); $modx->toPlaceholders(array( $placeholderPrefix.\'id\' => $data[\'album\'][\'id\'], $placeholderPrefix.\'name\' => $data[\'album\'][\'name\'], $placeholderPrefix.\'year\' => isset($data[\'album\'][\'year\']) ? $data[\'album\'][\'year\'] : \'\', $placeholderPrefix.\'description\' => $data[\'album\'][\'description\'], $placeholderPrefix.\'total\' => $data[\'total\'], $placeholderPrefix.\'next\' => $data[\'album\'][\'id\'] + 1, $placeholderPrefix.\'prev\' => $data[\'album\'][\'id\'] - 1, )); return $output; } return \'\';', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( ), ), 'getResources' => array ( 'fields' => array ( 'id' => 26, 'source' => 0, 'property_preprocess' => false, 'name' => 'getResources', 'description' => '1.6.1-pl A general purpose Resource listing and summarization snippet for MODX Revolution', 'editor_type' => 0, 'category' => 0, 'cache_type' => 0, 'snippet' => '/** * getResources * * A general purpose Resource listing and summarization snippet for MODX 2.x. * * @author Jason Coward * @copyright Copyright 2010-2013, Jason Coward * * TEMPLATES * * tpl - Name of a chunk serving as a resource template * [NOTE: if not provided, properties are dumped to output for each resource] * * tplOdd - (Opt) Name of a chunk serving as resource template for resources with an odd idx value * (see idx property) * tplFirst - (Opt) Name of a chunk serving as resource template for the first resource (see first * property) * tplLast - (Opt) Name of a chunk serving as resource template for the last resource (see last * property) * tpl_{n} - (Opt) Name of a chunk serving as resource template for the nth resource * * tplCondition - (Opt) Defines a field of the resource to evaluate against keys defined in the * conditionalTpls property. Must be a resource field; does not work with Template Variables. * conditionalTpls - (Opt) A JSON object defining a map of field values and the associated tpl to * use when the field defined by tplCondition matches the value. [NOTE: tplOdd, tplFirst, tplLast, * and tpl_{n} will take precedence over any defined conditionalTpls] * * tplWrapper - (Opt) Name of a chunk serving as a wrapper template for the output * [NOTE: Does not work with toSeparatePlaceholders] * * SELECTION * * parents - Comma-delimited list of ids serving as parents * * context - (Opt) Comma-delimited list of context keys to limit results by; if empty, contexts for all specified * parents will be used (all contexts if 0 is specified) [default=] * * depth - (Opt) Integer value indicating depth to search for resources from each parent [default=10] * * tvFilters - (Opt) Delimited-list of TemplateVar values to filter resources by. Supports two * delimiters and two value search formats. The first delimiter || represents a logical OR and the * primary grouping mechanism. Within each group you can provide a comma-delimited list of values. * These values can be either tied to a specific TemplateVar by name, e.g. myTV==value, or just the * value, indicating you are searching for the value in any TemplateVar tied to the Resource. An * example would be &tvFilters=`filter2==one,filter1==bar%||filter1==foo` * [NOTE: filtering by values uses a LIKE query and % is considered a wildcard.] * [NOTE: this only looks at the raw value set for specific Resource, i. e. there must be a value * specifically set for the Resource and it is not evaluated.] * * tvFiltersAndDelimiter - (Opt) Custom delimiter for logical AND, default \',\', in case you want to * match a literal comma in the tvFilters. E.g. &tvFiltersAndDelimiter=`&&` * &tvFilters=`filter1==foo,bar&&filter2==baz` [default=,] * * tvFiltersOrDelimiter - (Opt) Custom delimiter for logical OR, default \'||\', in case you want to * match a literal \'||\' in the tvFilters. E.g. &tvFiltersOrDelimiter=`|OR|` * &tvFilters=`filter1==foo||bar|OR|filter2==baz` [default=||] * * where - (Opt) A JSON expression of criteria to build any additional where clauses from. An example would be * &where=`{{"alias:LIKE":"foo%", "OR:alias:LIKE":"%bar"},{"OR:pagetitle:=":"foobar", "AND:description:=":"raboof"}}` * * sortby - (Opt) Field to sort by or a JSON array, e.g. {"publishedon":"ASC","createdon":"DESC"} [default=publishedon] * sortbyTV - (opt) A Template Variable name to sort by (if supplied, this precedes the sortby value) [default=] * sortbyTVType - (Opt) A data type to CAST a TV Value to in order to sort on it properly [default=string] * sortbyAlias - (Opt) Query alias for sortby field [default=] * sortbyEscaped - (Opt) Escapes the field name(s) specified in sortby [default=0] * sortdir - (Opt) Order which to sort by [default=DESC] * sortdirTV - (Opt) Order which to sort by a TV [default=DESC] * limit - (Opt) Limits the number of resources returned [default=5] * offset - (Opt) An offset of resources returned by the criteria to skip [default=0] * dbCacheFlag - (Opt) Controls caching of db queries; 0|false = do not cache result set; 1 = cache result set * according to cache settings, any other integer value = number of seconds to cache result set [default=0] * * OPTIONS * * includeContent - (Opt) Indicates if the content of each resource should be returned in the * results [default=0] * includeTVs - (Opt) Indicates if TemplateVar values should be included in the properties available * to each resource template [default=0] * includeTVList - (Opt) Limits the TemplateVars that are included if includeTVs is true to those specified * by name in a comma-delimited list [default=] * prepareTVs - (Opt) Prepares media-source dependent TemplateVar values [default=1] * prepareTVList - (Opt) Limits the TVs that are prepared to those specified by name in a comma-delimited * list [default=] * processTVs - (Opt) Indicates if TemplateVar values should be rendered as they would on the * resource being summarized [default=0] * processTVList - (opt) Limits the TemplateVars that are processed if included to those specified * by name in a comma-delimited list [default=] * tvPrefix - (Opt) The prefix for TemplateVar properties [default=tv.] * idx - (Opt) You can define the starting idx of the resources, which is an property that is * incremented as each resource is rendered [default=1] * first - (Opt) Define the idx which represents the first resource (see tplFirst) [default=1] * last - (Opt) Define the idx which represents the last resource (see tplLast) [default=# of * resources being summarized + first - 1] * outputSeparator - (Opt) An optional string to separate each tpl instance [default="\\n"] * wrapIfEmpty - (Opt) Indicates if the tplWrapper should be applied if the output is empty [default=0] * */ $output = array(); $outputSeparator = isset($outputSeparator) ? $outputSeparator : "\\n"; /* set default properties */ $tpl = !empty($tpl) ? $tpl : \'\'; $includeContent = !empty($includeContent) ? true : false; $includeTVs = !empty($includeTVs) ? true : false; $includeTVList = !empty($includeTVList) ? explode(\',\', $includeTVList) : array(); $processTVs = !empty($processTVs) ? true : false; $processTVList = !empty($processTVList) ? explode(\',\', $processTVList) : array(); $prepareTVs = !empty($prepareTVs) ? true : false; $prepareTVList = !empty($prepareTVList) ? explode(\',\', $prepareTVList) : array(); $tvPrefix = isset($tvPrefix) ? $tvPrefix : \'tv.\'; $parents = (!empty($parents) || $parents === \'0\') ? explode(\',\', $parents) : array($modx->resource->get(\'id\')); array_walk($parents, \'trim\'); $parents = array_unique($parents); $depth = isset($depth) ? (integer) $depth : 10; $tvFiltersOrDelimiter = isset($tvFiltersOrDelimiter) ? $tvFiltersOrDelimiter : \'||\'; $tvFiltersAndDelimiter = isset($tvFiltersAndDelimiter) ? $tvFiltersAndDelimiter : \',\'; $tvFilters = !empty($tvFilters) ? explode($tvFiltersOrDelimiter, $tvFilters) : array(); $where = !empty($where) ? $modx->fromJSON($where) : array(); $showUnpublished = !empty($showUnpublished) ? true : false; $showDeleted = !empty($showDeleted) ? true : false; $sortby = isset($sortby) ? $sortby : \'publishedon\'; $sortbyTV = isset($sortbyTV) ? $sortbyTV : \'\'; $sortbyAlias = isset($sortbyAlias) ? $sortbyAlias : \'modResource\'; $sortbyEscaped = !empty($sortbyEscaped) ? true : false; $sortdir = isset($sortdir) ? $sortdir : \'DESC\'; $sortdirTV = isset($sortdirTV) ? $sortdirTV : \'DESC\'; $limit = isset($limit) ? (integer) $limit : 5; $offset = isset($offset) ? (integer) $offset : 0; $totalVar = !empty($totalVar) ? $totalVar : \'total\'; $dbCacheFlag = !isset($dbCacheFlag) ? false : $dbCacheFlag; if (is_string($dbCacheFlag) || is_numeric($dbCacheFlag)) { if ($dbCacheFlag == \'0\') { $dbCacheFlag = false; } elseif ($dbCacheFlag == \'1\') { $dbCacheFlag = true; } else { $dbCacheFlag = (integer) $dbCacheFlag; } } /* multiple context support */ $contextArray = array(); $contextSpecified = false; if (!empty($context)) { $contextArray = explode(\',\',$context); array_walk($contextArray, \'trim\'); $contexts = array(); foreach ($contextArray as $ctx) { $contexts[] = $modx->quote($ctx); } $context = implode(\',\',$contexts); $contextSpecified = true; unset($contexts,$ctx); } else { $context = $modx->quote($modx->context->get(\'key\')); } $pcMap = array(); $pcQuery = $modx->newQuery(\'modResource\', array(\'id:IN\' => $parents), $dbCacheFlag); $pcQuery->select(array(\'id\', \'context_key\')); if ($pcQuery->prepare() && $pcQuery->stmt->execute()) { foreach ($pcQuery->stmt->fetchAll(PDO::FETCH_ASSOC) as $pcRow) { $pcMap[(integer) $pcRow[\'id\']] = $pcRow[\'context_key\']; } } $children = array(); $parentArray = array(); foreach ($parents as $parent) { $parent = (integer) $parent; if ($parent === 0) { $pchildren = array(); if ($contextSpecified) { foreach ($contextArray as $pCtx) { if (!in_array($pCtx, $contextArray)) { continue; } $options = $pCtx !== $modx->context->get(\'key\') ? array(\'context\' => $pCtx) : array(); $pcchildren = $modx->getChildIds($parent, $depth, $options); if (!empty($pcchildren)) $pchildren = array_merge($pchildren, $pcchildren); } } else { $cQuery = $modx->newQuery(\'modContext\', array(\'key:!=\' => \'mgr\')); $cQuery->select(array(\'key\')); if ($cQuery->prepare() && $cQuery->stmt->execute()) { foreach ($cQuery->stmt->fetchAll(PDO::FETCH_COLUMN) as $pCtx) { $options = $pCtx !== $modx->context->get(\'key\') ? array(\'context\' => $pCtx) : array(); $pcchildren = $modx->getChildIds($parent, $depth, $options); if (!empty($pcchildren)) $pchildren = array_merge($pchildren, $pcchildren); } } } $parentArray[] = $parent; } else { $pContext = array_key_exists($parent, $pcMap) ? $pcMap[$parent] : false; if ($debug) $modx->log(modX::LOG_LEVEL_ERROR, "context for {$parent} is {$pContext}"); if ($pContext && $contextSpecified && !in_array($pContext, $contextArray, true)) { $parent = next($parents); continue; } $parentArray[] = $parent; $options = !empty($pContext) && $pContext !== $modx->context->get(\'key\') ? array(\'context\' => $pContext) : array(); $pchildren = $modx->getChildIds($parent, $depth, $options); } if (!empty($pchildren)) $children = array_merge($children, $pchildren); $parent = next($parents); } $parents = array_merge($parentArray, $children); /* build query */ $criteria = array("modResource.parent IN (" . implode(\',\', $parents) . ")"); if ($contextSpecified) { $contextResourceTbl = $modx->getTableName(\'modContextResource\'); $criteria[] = "(modResource.context_key IN ({$context}) OR EXISTS(SELECT 1 FROM {$contextResourceTbl} ctx WHERE ctx.resource = modResource.id AND ctx.context_key IN ({$context})))"; } if (empty($showDeleted)) { $criteria[\'deleted\'] = \'0\'; } if (empty($showUnpublished)) { $criteria[\'published\'] = \'1\'; } if (empty($showHidden)) { $criteria[\'hidemenu\'] = \'0\'; } if (!empty($hideContainers)) { $criteria[\'isfolder\'] = \'0\'; } $criteria = $modx->newQuery(\'modResource\', $criteria); if (!empty($tvFilters)) { $tmplVarTbl = $modx->getTableName(\'modTemplateVar\'); $tmplVarResourceTbl = $modx->getTableName(\'modTemplateVarResource\'); $conditions = array(); $operators = array( \'<=>\' => \'<=>\', \'===\' => \'=\', \'!==\' => \'!=\', \'<>\' => \'<>\', \'==\' => \'LIKE\', \'!=\' => \'NOT LIKE\', \'<<\' => \'<\', \'<=\' => \'<=\', \'=<\' => \'=<\', \'>>\' => \'>\', \'>=\' => \'>=\', \'=>\' => \'=>\' ); foreach ($tvFilters as $fGroup => $tvFilter) { $filterGroup = array(); $filters = explode($tvFiltersAndDelimiter, $tvFilter); $multiple = count($filters) > 0; foreach ($filters as $filter) { $operator = \'==\'; $sqlOperator = \'LIKE\'; foreach ($operators as $op => $opSymbol) { if (strpos($filter, $op, 1) !== false) { $operator = $op; $sqlOperator = $opSymbol; break; } } $tvValueField = \'tvr.value\'; $tvDefaultField = \'tv.default_text\'; $f = explode($operator, $filter); if (count($f) >= 2) { if (count($f) > 2) { $k = array_shift($f); $b = join($operator, $f); $f = array($k, $b); } $tvName = $modx->quote($f[0]); if (is_numeric($f[1]) && !in_array($sqlOperator, array(\'LIKE\', \'NOT LIKE\'))) { $tvValue = $f[1]; if ($f[1] == (integer)$f[1]) { $tvValueField = "CAST({$tvValueField} AS SIGNED INTEGER)"; $tvDefaultField = "CAST({$tvDefaultField} AS SIGNED INTEGER)"; } else { $tvValueField = "CAST({$tvValueField} AS DECIMAL)"; $tvDefaultField = "CAST({$tvDefaultField} AS DECIMAL)"; } } else { $tvValue = $modx->quote($f[1]); } if ($multiple) { $filterGroup[] = "(EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.name = {$tvName} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id) " . "OR EXISTS (SELECT 1 FROM {$tmplVarTbl} tv WHERE tv.name = {$tvName} AND {$tvDefaultField} {$sqlOperator} {$tvValue} AND tv.id NOT IN (SELECT tmplvarid FROM {$tmplVarResourceTbl} WHERE contentid = modResource.id)) " . ")"; } else { $filterGroup = "(EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.name = {$tvName} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id) " . "OR EXISTS (SELECT 1 FROM {$tmplVarTbl} tv WHERE tv.name = {$tvName} AND {$tvDefaultField} {$sqlOperator} {$tvValue} AND tv.id NOT IN (SELECT tmplvarid FROM {$tmplVarResourceTbl} WHERE contentid = modResource.id)) " . ")"; } } elseif (count($f) == 1) { $tvValue = $modx->quote($f[0]); if ($multiple) { $filterGroup[] = "EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id)"; } else { $filterGroup = "EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id)"; } } } $conditions[] = $filterGroup; } if (!empty($conditions)) { $firstGroup = true; foreach ($conditions as $cGroup => $c) { if (is_array($c)) { $first = true; foreach ($c as $cond) { if ($first && !$firstGroup) { $criteria->condition($criteria->query[\'where\'][0][1], $cond, xPDOQuery::SQL_OR, null, $cGroup); } else { $criteria->condition($criteria->query[\'where\'][0][1], $cond, xPDOQuery::SQL_AND, null, $cGroup); } $first = false; } } else { $criteria->condition($criteria->query[\'where\'][0][1], $c, $firstGroup ? xPDOQuery::SQL_AND : xPDOQuery::SQL_OR, null, $cGroup); } $firstGroup = false; } } } /* include/exclude resources, via &resources=`123,-456` prop */ if (!empty($resources)) { $resourceConditions = array(); $resources = explode(\',\',$resources); $include = array(); $exclude = array(); foreach ($resources as $resource) { $resource = (int)$resource; if ($resource == 0) continue; if ($resource < 0) { $exclude[] = abs($resource); } else { $include[] = $resource; } } if (!empty($include)) { $criteria->where(array(\'OR:modResource.id:IN\' => $include), xPDOQuery::SQL_OR); } if (!empty($exclude)) { $criteria->where(array(\'modResource.id:NOT IN\' => $exclude), xPDOQuery::SQL_AND, null, 1); } } if (!empty($where)) { $criteria->where($where); } $total = $modx->getCount(\'modResource\', $criteria); $modx->setPlaceholder($totalVar, $total); $fields = array_keys($modx->getFields(\'modResource\')); if (empty($includeContent)) { $fields = array_diff($fields, array(\'content\')); } $columns = $includeContent ? $modx->getSelectColumns(\'modResource\', \'modResource\') : $modx->getSelectColumns(\'modResource\', \'modResource\', \'\', array(\'content\'), true); $criteria->select($columns); if (!empty($sortbyTV)) { $criteria->leftJoin(\'modTemplateVar\', \'tvDefault\', array( "tvDefault.name" => $sortbyTV )); $criteria->leftJoin(\'modTemplateVarResource\', \'tvSort\', array( "tvSort.contentid = modResource.id", "tvSort.tmplvarid = tvDefault.id" )); if (empty($sortbyTVType)) $sortbyTVType = \'string\'; if ($modx->getOption(\'dbtype\') === \'mysql\') { switch ($sortbyTVType) { case \'integer\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS SIGNED INTEGER) AS sortTV"); break; case \'decimal\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS DECIMAL) AS sortTV"); break; case \'datetime\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS DATETIME) AS sortTV"); break; case \'string\': default: $criteria->select("IFNULL(tvSort.value, tvDefault.default_text) AS sortTV"); break; } } elseif ($modx->getOption(\'dbtype\') === \'sqlsrv\') { switch ($sortbyTVType) { case \'integer\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS BIGINT) AS sortTV"); break; case \'decimal\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS DECIMAL) AS sortTV"); break; case \'datetime\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS DATETIME) AS sortTV"); break; case \'string\': default: $criteria->select("ISNULL(tvSort.value, tvDefault.default_text) AS sortTV"); break; } } $criteria->sortby("sortTV", $sortdirTV); } if (!empty($sortby)) { if (strpos($sortby, \'{\') === 0) { $sorts = $modx->fromJSON($sortby); } else { $sorts = array($sortby => $sortdir); } if (is_array($sorts)) { while (list($sort, $dir) = each($sorts)) { if ($sortbyEscaped) $sort = $modx->escape($sort); if (!empty($sortbyAlias)) $sort = $modx->escape($sortbyAlias) . ".{$sort}"; $criteria->sortby($sort, $dir); } } } if (!empty($limit)) $criteria->limit($limit, $offset); if (!empty($debug)) { $criteria->prepare(); $modx->log(modX::LOG_LEVEL_ERROR, $criteria->toSQL()); } $collection = $modx->getCollection(\'modResource\', $criteria, $dbCacheFlag); $idx = !empty($idx) || $idx === \'0\' ? (integer) $idx : 1; $first = empty($first) && $first !== \'0\' ? 1 : (integer) $first; $last = empty($last) ? (count($collection) + $idx - 1) : (integer) $last; /* include parseTpl */ include_once $modx->getOption(\'getresources.core_path\',null,$modx->getOption(\'core_path\').\'components/getresources/\').\'include.parsetpl.php\'; $templateVars = array(); if (!empty($includeTVs) && !empty($includeTVList)) { $templateVars = $modx->getCollection(\'modTemplateVar\', array(\'name:IN\' => $includeTVList)); } /** @var modResource $resource */ foreach ($collection as $resourceId => $resource) { $tvs = array(); if (!empty($includeTVs)) { if (empty($includeTVList)) { $templateVars = $resource->getMany(\'TemplateVars\'); } /** @var modTemplateVar $templateVar */ foreach ($templateVars as $tvId => $templateVar) { if (!empty($includeTVList) && !in_array($templateVar->get(\'name\'), $includeTVList)) continue; if ($processTVs && (empty($processTVList) || in_array($templateVar->get(\'name\'), $processTVList))) { $tvs[$tvPrefix . $templateVar->get(\'name\')] = $templateVar->renderOutput($resource->get(\'id\')); } else { $value = $templateVar->getValue($resource->get(\'id\')); if ($prepareTVs && method_exists($templateVar, \'prepareOutput\') && (empty($prepareTVList) || in_array($templateVar->get(\'name\'), $prepareTVList))) { $value = $templateVar->prepareOutput($value); } $tvs[$tvPrefix . $templateVar->get(\'name\')] = $value; } } } $odd = ($idx & 1); $properties = array_merge( $scriptProperties ,array( \'idx\' => $idx ,\'first\' => $first ,\'last\' => $last ,\'odd\' => $odd ) ,$includeContent ? $resource->toArray() : $resource->get($fields) ,$tvs ); $resourceTpl = false; if ($idx == $first && !empty($tplFirst)) { $resourceTpl = parseTpl($tplFirst, $properties); } if ($idx == $last && empty($resourceTpl) && !empty($tplLast)) { $resourceTpl = parseTpl($tplLast, $properties); } $tplidx = \'tpl_\' . $idx; if (empty($resourceTpl) && !empty($$tplidx)) { $resourceTpl = parseTpl($$tplidx, $properties); } if ($idx > 1 && empty($resourceTpl)) { $divisors = getDivisors($idx); if (!empty($divisors)) { foreach ($divisors as $divisor) { $tplnth = \'tpl_n\' . $divisor; if (!empty($$tplnth)) { $resourceTpl = parseTpl($$tplnth, $properties); if (!empty($resourceTpl)) { break; } } } } } if ($odd && empty($resourceTpl) && !empty($tplOdd)) { $resourceTpl = parseTpl($tplOdd, $properties); } if (!empty($tplCondition) && !empty($conditionalTpls) && empty($resourceTpl)) { $conTpls = $modx->fromJSON($conditionalTpls); $subject = $properties[$tplCondition]; $tplOperator = !empty($tplOperator) ? $tplOperator : \'=\'; $tplOperator = strtolower($tplOperator); $tplCon = \'\'; foreach ($conTpls as $operand => $conditionalTpl) { switch ($tplOperator) { case \'!=\': case \'neq\': case \'not\': case \'isnot\': case \'isnt\': case \'unequal\': case \'notequal\': $tplCon = (($subject != $operand) ? $conditionalTpl : $tplCon); break; case \'<\': case \'lt\': case \'less\': case \'lessthan\': $tplCon = (($subject < $operand) ? $conditionalTpl : $tplCon); break; case \'>\': case \'gt\': case \'greater\': case \'greaterthan\': $tplCon = (($subject > $operand) ? $conditionalTpl : $tplCon); break; case \'<=\': case \'lte\': case \'lessthanequals\': case \'lessthanorequalto\': $tplCon = (($subject <= $operand) ? $conditionalTpl : $tplCon); break; case \'>=\': case \'gte\': case \'greaterthanequals\': case \'greaterthanequalto\': $tplCon = (($subject >= $operand) ? $conditionalTpl : $tplCon); break; case \'isempty\': case \'empty\': $tplCon = empty($subject) ? $conditionalTpl : $tplCon; break; case \'!empty\': case \'notempty\': case \'isnotempty\': $tplCon = !empty($subject) && $subject != \'\' ? $conditionalTpl : $tplCon; break; case \'isnull\': case \'null\': $tplCon = $subject == null || strtolower($subject) == \'null\' ? $conditionalTpl : $tplCon; break; case \'inarray\': case \'in_array\': case \'ia\': $operand = explode(\',\', $operand); $tplCon = in_array($subject, $operand) ? $conditionalTpl : $tplCon; break; case \'between\': case \'range\': case \'>=<\': case \'><\': $operand = explode(\',\', $operand); $tplCon = ($subject >= min($operand) && $subject <= max($operand)) ? $conditionalTpl : $tplCon; break; case \'==\': case \'=\': case \'eq\': case \'is\': case \'equal\': case \'equals\': case \'equalto\': default: $tplCon = (($subject == $operand) ? $conditionalTpl : $tplCon); break; } } if (!empty($tplCon)) { $resourceTpl = parseTpl($tplCon, $properties); } } if (!empty($tpl) && empty($resourceTpl)) { $resourceTpl = parseTpl($tpl, $properties); } if ($resourceTpl === false && !empty($debug)) { $chunk = $modx->newObject(\'modChunk\'); $chunk->setCacheable(false); $output[]= $chunk->process(array(), \'
\' . print_r($properties, true) .\'
\'); } else { $output[]= $resourceTpl; } $idx++; } /* output */ $toSeparatePlaceholders = $modx->getOption(\'toSeparatePlaceholders\', $scriptProperties, false); if (!empty($toSeparatePlaceholders)) { $modx->setPlaceholders($output, $toSeparatePlaceholders); return \'\'; } $output = implode($outputSeparator, $output); $tplWrapper = $modx->getOption(\'tplWrapper\', $scriptProperties, false); $wrapIfEmpty = $modx->getOption(\'wrapIfEmpty\', $scriptProperties, false); if (!empty($tplWrapper) && ($wrapIfEmpty || !empty($output))) { $output = parseTpl($tplWrapper, array_merge($scriptProperties, array(\'output\' => $output))); } $toPlaceholder = $modx->getOption(\'toPlaceholder\', $scriptProperties, false); if (!empty($toPlaceholder)) { $modx->setPlaceholder($toPlaceholder, $output); return \'\'; } return $output;', 'locked' => false, 'properties' => array ( 'tpl' => array ( 'name' => 'tpl', 'desc' => 'Name of a chunk serving as a resource template. NOTE: if not provided, properties are dumped to output for each resource.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a chunk serving as a resource template. NOTE: if not provided, properties are dumped to output for each resource.', 'area_trans' => '', ), 'tplOdd' => array ( 'name' => 'tplOdd', 'desc' => 'Name of a chunk serving as resource template for resources with an odd idx value (see idx property).', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a chunk serving as resource template for resources with an odd idx value (see idx property).', 'area_trans' => '', ), 'tplFirst' => array ( 'name' => 'tplFirst', 'desc' => 'Name of a chunk serving as resource template for the first resource (see first property).', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a chunk serving as resource template for the first resource (see first property).', 'area_trans' => '', ), 'tplLast' => array ( 'name' => 'tplLast', 'desc' => 'Name of a chunk serving as resource template for the last resource (see last property).', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a chunk serving as resource template for the last resource (see last property).', 'area_trans' => '', ), 'tplWrapper' => array ( 'name' => 'tplWrapper', 'desc' => 'Name of a chunk serving as wrapper template for the Snippet output. This does not work with toSeparatePlaceholders.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a chunk serving as wrapper template for the Snippet output. This does not work with toSeparatePlaceholders.', 'area_trans' => '', ), 'wrapIfEmpty' => array ( 'name' => 'wrapIfEmpty', 'desc' => 'Indicates if empty output should be wrapped by the tplWrapper, if specified. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if empty output should be wrapped by the tplWrapper, if specified. Defaults to false.', 'area_trans' => '', ), 'sortby' => array ( 'name' => 'sortby', 'desc' => 'A field name to sort by or JSON object of field names and sortdir for each field, e.g. {"publishedon":"ASC","createdon":"DESC"}. Defaults to publishedon.', 'type' => 'textfield', 'options' => '', 'value' => 'publishedon', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A field name to sort by or JSON object of field names and sortdir for each field, e.g. {"publishedon":"ASC","createdon":"DESC"}. Defaults to publishedon.', 'area_trans' => '', ), 'sortbyTV' => array ( 'name' => 'sortbyTV', 'desc' => 'Name of a Template Variable to sort by. Defaults to empty string.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Name of a Template Variable to sort by. Defaults to empty string.', 'area_trans' => '', ), 'sortbyTVType' => array ( 'name' => 'sortbyTVType', 'desc' => 'An optional type to indicate how to sort on the Template Variable value.', 'type' => 'list', 'options' => array ( 0 => array ( 'text' => 'string', 'value' => 'string', 'name' => 'string', ), 1 => array ( 'text' => 'integer', 'value' => 'integer', 'name' => 'integer', ), 2 => array ( 'text' => 'decimal', 'value' => 'decimal', 'name' => 'decimal', ), 3 => array ( 'text' => 'datetime', 'value' => 'datetime', 'name' => 'datetime', ), ), 'value' => 'string', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'An optional type to indicate how to sort on the Template Variable value.', 'area_trans' => '', ), 'sortbyAlias' => array ( 'name' => 'sortbyAlias', 'desc' => 'Query alias for sortby field. Defaults to an empty string.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Query alias for sortby field. Defaults to an empty string.', 'area_trans' => '', ), 'sortbyEscaped' => array ( 'name' => 'sortbyEscaped', 'desc' => 'Determines if the field name specified in sortby should be escaped. Defaults to 0.', 'type' => 'textfield', 'options' => '', 'value' => '0', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Determines if the field name specified in sortby should be escaped. Defaults to 0.', 'area_trans' => '', ), 'sortdir' => array ( 'name' => 'sortdir', 'desc' => 'Order which to sort by. Defaults to DESC.', 'type' => 'list', 'options' => array ( 0 => array ( 'text' => 'ASC', 'value' => 'ASC', 'name' => 'ASC', ), 1 => array ( 'text' => 'DESC', 'value' => 'DESC', 'name' => 'DESC', ), ), 'value' => 'DESC', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Order which to sort by. Defaults to DESC.', 'area_trans' => '', ), 'sortdirTV' => array ( 'name' => 'sortdirTV', 'desc' => 'Order which to sort a Template Variable by. Defaults to DESC.', 'type' => 'list', 'options' => array ( 0 => array ( 'text' => 'ASC', 'value' => 'ASC', 'name' => 'ASC', ), 1 => array ( 'text' => 'DESC', 'value' => 'DESC', 'name' => 'DESC', ), ), 'value' => 'DESC', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Order which to sort a Template Variable by. Defaults to DESC.', 'area_trans' => '', ), 'limit' => array ( 'name' => 'limit', 'desc' => 'Limits the number of resources returned. Defaults to 5.', 'type' => 'textfield', 'options' => '', 'value' => '5', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Limits the number of resources returned. Defaults to 5.', 'area_trans' => '', ), 'offset' => array ( 'name' => 'offset', 'desc' => 'An offset of resources returned by the criteria to skip.', 'type' => 'textfield', 'options' => '', 'value' => '0', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'An offset of resources returned by the criteria to skip.', 'area_trans' => '', ), 'tvFilters' => array ( 'name' => 'tvFilters', 'desc' => 'Delimited-list of TemplateVar values to filter resources by. Supports two delimiters and two value search formats. THe first delimiter || represents a logical OR and the primary grouping mechanism. Within each group you can provide a comma-delimited list of values. These values can be either tied to a specific TemplateVar by name, e.g. myTV==value, or just the value, indicating you are searching for the value in any TemplateVar tied to the Resource. An example would be &tvFilters=`filter2==one,filter1==bar%||filter1==foo`.
NOTE: filtering by values uses a LIKE query and % is considered a wildcard.
ANOTHER NOTE: This only looks at the raw value set for specific Resource, i. e. there must be a value specifically set for the Resource and it is not evaluated.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Delimited-list of TemplateVar values to filter resources by. Supports two delimiters and two value search formats. THe first delimiter || represents a logical OR and the primary grouping mechanism. Within each group you can provide a comma-delimited list of values. These values can be either tied to a specific TemplateVar by name, e.g. myTV==value, or just the value, indicating you are searching for the value in any TemplateVar tied to the Resource. An example would be &tvFilters=`filter2==one,filter1==bar%||filter1==foo`.
NOTE: filtering by values uses a LIKE query and % is considered a wildcard.
ANOTHER NOTE: This only looks at the raw value set for specific Resource, i. e. there must be a value specifically set for the Resource and it is not evaluated.', 'area_trans' => '', ), 'tvFiltersAndDelimiter' => array ( 'name' => 'tvFiltersAndDelimiter', 'desc' => 'The delimiter to use to separate logical AND expressions in tvFilters. Default is ,', 'type' => 'textfield', 'options' => '', 'value' => ',', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'The delimiter to use to separate logical AND expressions in tvFilters. Default is ,', 'area_trans' => '', ), 'tvFiltersOrDelimiter' => array ( 'name' => 'tvFiltersOrDelimiter', 'desc' => 'The delimiter to use to separate logical OR expressions in tvFilters. Default is ||', 'type' => 'textfield', 'options' => '', 'value' => '||', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'The delimiter to use to separate logical OR expressions in tvFilters. Default is ||', 'area_trans' => '', ), 'depth' => array ( 'name' => 'depth', 'desc' => 'Integer value indicating depth to search for resources from each parent. Defaults to 10.', 'type' => 'textfield', 'options' => '', 'value' => '10', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Integer value indicating depth to search for resources from each parent. Defaults to 10.', 'area_trans' => '', ), 'parents' => array ( 'name' => 'parents', 'desc' => 'Optional. Comma-delimited list of ids serving as parents.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Optional. Comma-delimited list of ids serving as parents.', 'area_trans' => '', ), 'includeContent' => array ( 'name' => 'includeContent', 'desc' => 'Indicates if the content of each resource should be returned in the results. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if the content of each resource should be returned in the results. Defaults to false.', 'area_trans' => '', ), 'includeTVs' => array ( 'name' => 'includeTVs', 'desc' => 'Indicates if TemplateVar values should be included in the properties available to each resource template. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if TemplateVar values should be included in the properties available to each resource template. Defaults to false.', 'area_trans' => '', ), 'includeTVList' => array ( 'name' => 'includeTVList', 'desc' => 'Limits included TVs to those specified as a comma-delimited list of TV names. Defaults to empty.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Limits included TVs to those specified as a comma-delimited list of TV names. Defaults to empty.', 'area_trans' => '', ), 'showHidden' => array ( 'name' => 'showHidden', 'desc' => 'Indicates if Resources that are hidden from menus should be shown. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if Resources that are hidden from menus should be shown. Defaults to false.', 'area_trans' => '', ), 'showUnpublished' => array ( 'name' => 'showUnpublished', 'desc' => 'Indicates if Resources that are unpublished should be shown. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if Resources that are unpublished should be shown. Defaults to false.', 'area_trans' => '', ), 'showDeleted' => array ( 'name' => 'showDeleted', 'desc' => 'Indicates if Resources that are deleted should be shown. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if Resources that are deleted should be shown. Defaults to false.', 'area_trans' => '', ), 'resources' => array ( 'name' => 'resources', 'desc' => 'A comma-separated list of resource IDs to exclude or include. IDs with a - in front mean to exclude. Ex: 123,-456 means to include Resource 123, but always exclude Resource 456.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A comma-separated list of resource IDs to exclude or include. IDs with a - in front mean to exclude. Ex: 123,-456 means to include Resource 123, but always exclude Resource 456.', 'area_trans' => '', ), 'processTVs' => array ( 'name' => 'processTVs', 'desc' => 'Indicates if TemplateVar values should be rendered as they would on the resource being summarized. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if TemplateVar values should be rendered as they would on the resource being summarized. Defaults to false.', 'area_trans' => '', ), 'processTVList' => array ( 'name' => 'processTVList', 'desc' => 'Limits processed TVs to those specified as a comma-delimited list of TV names; note only includedTVs will be available for processing if specified. Defaults to empty.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Limits processed TVs to those specified as a comma-delimited list of TV names; note only includedTVs will be available for processing if specified. Defaults to empty.', 'area_trans' => '', ), 'prepareTVs' => array ( 'name' => 'prepareTVs', 'desc' => 'Indicates if TemplateVar values that are not processed fully should be prepared before being returned. Defaults to true.', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Indicates if TemplateVar values that are not processed fully should be prepared before being returned. Defaults to true.', 'area_trans' => '', ), 'prepareTVList' => array ( 'name' => 'prepareTVList', 'desc' => 'Limits prepared TVs to those specified as a comma-delimited list of TV names; note only includedTVs will be available for preparing if specified. Defaults to empty.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Limits prepared TVs to those specified as a comma-delimited list of TV names; note only includedTVs will be available for preparing if specified. Defaults to empty.', 'area_trans' => '', ), 'tvPrefix' => array ( 'name' => 'tvPrefix', 'desc' => 'The prefix for TemplateVar properties. Defaults to: tv.', 'type' => 'textfield', 'options' => '', 'value' => 'tv.', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'The prefix for TemplateVar properties. Defaults to: tv.', 'area_trans' => '', ), 'idx' => array ( 'name' => 'idx', 'desc' => 'You can define the starting idx of the resources, which is an property that is incremented as each resource is rendered.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'You can define the starting idx of the resources, which is an property that is incremented as each resource is rendered.', 'area_trans' => '', ), 'first' => array ( 'name' => 'first', 'desc' => 'Define the idx which represents the first resource (see tplFirst). Defaults to 1.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Define the idx which represents the first resource (see tplFirst). Defaults to 1.', 'area_trans' => '', ), 'last' => array ( 'name' => 'last', 'desc' => 'Define the idx which represents the last resource (see tplLast). Defaults to the number of resources being summarized + first - 1', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Define the idx which represents the last resource (see tplLast). Defaults to the number of resources being summarized + first - 1', 'area_trans' => '', ), 'toPlaceholder' => array ( 'name' => 'toPlaceholder', 'desc' => 'If set, will assign the result to this placeholder instead of outputting it directly.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'If set, will assign the result to this placeholder instead of outputting it directly.', 'area_trans' => '', ), 'toSeparatePlaceholders' => array ( 'name' => 'toSeparatePlaceholders', 'desc' => 'If set, will assign EACH result to a separate placeholder named by this param suffixed with a sequential number (starting from 0).', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'If set, will assign EACH result to a separate placeholder named by this param suffixed with a sequential number (starting from 0).', 'area_trans' => '', ), 'debug' => array ( 'name' => 'debug', 'desc' => 'If true, will send the SQL query to the MODX log. Defaults to false.', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'If true, will send the SQL query to the MODX log. Defaults to false.', 'area_trans' => '', ), 'where' => array ( 'name' => 'where', 'desc' => 'A JSON expression of criteria to build any additional where clauses from, e.g. &where=`{{"alias:LIKE":"foo%", "OR:alias:LIKE":"%bar"},{"OR:pagetitle:=":"foobar", "AND:description:=":"raboof"}}`', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A JSON expression of criteria to build any additional where clauses from, e.g. &where=`{{"alias:LIKE":"foo%", "OR:alias:LIKE":"%bar"},{"OR:pagetitle:=":"foobar", "AND:description:=":"raboof"}}`', 'area_trans' => '', ), 'dbCacheFlag' => array ( 'name' => 'dbCacheFlag', 'desc' => 'Determines how result sets are cached if cache_db is enabled in MODX. 0|false = do not cache result set; 1 = cache result set according to cache settings, any other integer value = number of seconds to cache result set', 'type' => 'textfield', 'options' => '', 'value' => '0', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'Determines how result sets are cached if cache_db is enabled in MODX. 0|false = do not cache result set; 1 = cache result set according to cache settings, any other integer value = number of seconds to cache result set', 'area_trans' => '', ), 'context' => array ( 'name' => 'context', 'desc' => 'A comma-delimited list of context keys for limiting results. Default is empty, i.e. do not limit results by context.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A comma-delimited list of context keys for limiting results. Default is empty, i.e. do not limit results by context.', 'area_trans' => '', ), 'tplCondition' => array ( 'name' => 'tplCondition', 'desc' => 'A condition to compare against the conditionalTpls property to map Resources to different tpls based on custom conditional logic.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A condition to compare against the conditionalTpls property to map Resources to different tpls based on custom conditional logic.', 'area_trans' => '', ), 'tplOperator' => array ( 'name' => 'tplOperator', 'desc' => 'An optional operator to use for the tplCondition when comparing against the conditionalTpls operands. Default is == (equals).', 'type' => 'list', 'options' => array ( 0 => array ( 'text' => 'is equal to', 'value' => '==', 'name' => 'is equal to', ), 1 => array ( 'text' => 'is not equal to', 'value' => '!=', 'name' => 'is not equal to', ), 2 => array ( 'text' => 'less than', 'value' => '<', 'name' => 'less than', ), 3 => array ( 'text' => 'less than or equal to', 'value' => '<=', 'name' => 'less than or equal to', ), 4 => array ( 'text' => 'greater than or equal to', 'value' => '>=', 'name' => 'greater than or equal to', ), 5 => array ( 'text' => 'is empty', 'value' => 'empty', 'name' => 'is empty', ), 6 => array ( 'text' => 'is not empty', 'value' => '!empty', 'name' => 'is not empty', ), 7 => array ( 'text' => 'is null', 'value' => 'null', 'name' => 'is null', ), 8 => array ( 'text' => 'is in array', 'value' => 'inarray', 'name' => 'is in array', ), 9 => array ( 'text' => 'is between', 'value' => 'between', 'name' => 'is between', ), ), 'value' => '==', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'An optional operator to use for the tplCondition when comparing against the conditionalTpls operands. Default is == (equals).', 'area_trans' => '', ), 'conditionalTpls' => array ( 'name' => 'conditionalTpls', 'desc' => 'A JSON map of conditional operands and tpls to compare against the tplCondition property using the specified tplOperator.', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => NULL, 'area' => '', 'desc_trans' => 'A JSON map of conditional operands and tpls to compare against the tplCondition property using the specified tplOperator.', 'area_trans' => '', ), ), 'moduleguid' => '', 'static' => false, 'static_file' => '', 'content' => '/** * getResources * * A general purpose Resource listing and summarization snippet for MODX 2.x. * * @author Jason Coward * @copyright Copyright 2010-2013, Jason Coward * * TEMPLATES * * tpl - Name of a chunk serving as a resource template * [NOTE: if not provided, properties are dumped to output for each resource] * * tplOdd - (Opt) Name of a chunk serving as resource template for resources with an odd idx value * (see idx property) * tplFirst - (Opt) Name of a chunk serving as resource template for the first resource (see first * property) * tplLast - (Opt) Name of a chunk serving as resource template for the last resource (see last * property) * tpl_{n} - (Opt) Name of a chunk serving as resource template for the nth resource * * tplCondition - (Opt) Defines a field of the resource to evaluate against keys defined in the * conditionalTpls property. Must be a resource field; does not work with Template Variables. * conditionalTpls - (Opt) A JSON object defining a map of field values and the associated tpl to * use when the field defined by tplCondition matches the value. [NOTE: tplOdd, tplFirst, tplLast, * and tpl_{n} will take precedence over any defined conditionalTpls] * * tplWrapper - (Opt) Name of a chunk serving as a wrapper template for the output * [NOTE: Does not work with toSeparatePlaceholders] * * SELECTION * * parents - Comma-delimited list of ids serving as parents * * context - (Opt) Comma-delimited list of context keys to limit results by; if empty, contexts for all specified * parents will be used (all contexts if 0 is specified) [default=] * * depth - (Opt) Integer value indicating depth to search for resources from each parent [default=10] * * tvFilters - (Opt) Delimited-list of TemplateVar values to filter resources by. Supports two * delimiters and two value search formats. The first delimiter || represents a logical OR and the * primary grouping mechanism. Within each group you can provide a comma-delimited list of values. * These values can be either tied to a specific TemplateVar by name, e.g. myTV==value, or just the * value, indicating you are searching for the value in any TemplateVar tied to the Resource. An * example would be &tvFilters=`filter2==one,filter1==bar%||filter1==foo` * [NOTE: filtering by values uses a LIKE query and % is considered a wildcard.] * [NOTE: this only looks at the raw value set for specific Resource, i. e. there must be a value * specifically set for the Resource and it is not evaluated.] * * tvFiltersAndDelimiter - (Opt) Custom delimiter for logical AND, default \',\', in case you want to * match a literal comma in the tvFilters. E.g. &tvFiltersAndDelimiter=`&&` * &tvFilters=`filter1==foo,bar&&filter2==baz` [default=,] * * tvFiltersOrDelimiter - (Opt) Custom delimiter for logical OR, default \'||\', in case you want to * match a literal \'||\' in the tvFilters. E.g. &tvFiltersOrDelimiter=`|OR|` * &tvFilters=`filter1==foo||bar|OR|filter2==baz` [default=||] * * where - (Opt) A JSON expression of criteria to build any additional where clauses from. An example would be * &where=`{{"alias:LIKE":"foo%", "OR:alias:LIKE":"%bar"},{"OR:pagetitle:=":"foobar", "AND:description:=":"raboof"}}` * * sortby - (Opt) Field to sort by or a JSON array, e.g. {"publishedon":"ASC","createdon":"DESC"} [default=publishedon] * sortbyTV - (opt) A Template Variable name to sort by (if supplied, this precedes the sortby value) [default=] * sortbyTVType - (Opt) A data type to CAST a TV Value to in order to sort on it properly [default=string] * sortbyAlias - (Opt) Query alias for sortby field [default=] * sortbyEscaped - (Opt) Escapes the field name(s) specified in sortby [default=0] * sortdir - (Opt) Order which to sort by [default=DESC] * sortdirTV - (Opt) Order which to sort by a TV [default=DESC] * limit - (Opt) Limits the number of resources returned [default=5] * offset - (Opt) An offset of resources returned by the criteria to skip [default=0] * dbCacheFlag - (Opt) Controls caching of db queries; 0|false = do not cache result set; 1 = cache result set * according to cache settings, any other integer value = number of seconds to cache result set [default=0] * * OPTIONS * * includeContent - (Opt) Indicates if the content of each resource should be returned in the * results [default=0] * includeTVs - (Opt) Indicates if TemplateVar values should be included in the properties available * to each resource template [default=0] * includeTVList - (Opt) Limits the TemplateVars that are included if includeTVs is true to those specified * by name in a comma-delimited list [default=] * prepareTVs - (Opt) Prepares media-source dependent TemplateVar values [default=1] * prepareTVList - (Opt) Limits the TVs that are prepared to those specified by name in a comma-delimited * list [default=] * processTVs - (Opt) Indicates if TemplateVar values should be rendered as they would on the * resource being summarized [default=0] * processTVList - (opt) Limits the TemplateVars that are processed if included to those specified * by name in a comma-delimited list [default=] * tvPrefix - (Opt) The prefix for TemplateVar properties [default=tv.] * idx - (Opt) You can define the starting idx of the resources, which is an property that is * incremented as each resource is rendered [default=1] * first - (Opt) Define the idx which represents the first resource (see tplFirst) [default=1] * last - (Opt) Define the idx which represents the last resource (see tplLast) [default=# of * resources being summarized + first - 1] * outputSeparator - (Opt) An optional string to separate each tpl instance [default="\\n"] * wrapIfEmpty - (Opt) Indicates if the tplWrapper should be applied if the output is empty [default=0] * */ $output = array(); $outputSeparator = isset($outputSeparator) ? $outputSeparator : "\\n"; /* set default properties */ $tpl = !empty($tpl) ? $tpl : \'\'; $includeContent = !empty($includeContent) ? true : false; $includeTVs = !empty($includeTVs) ? true : false; $includeTVList = !empty($includeTVList) ? explode(\',\', $includeTVList) : array(); $processTVs = !empty($processTVs) ? true : false; $processTVList = !empty($processTVList) ? explode(\',\', $processTVList) : array(); $prepareTVs = !empty($prepareTVs) ? true : false; $prepareTVList = !empty($prepareTVList) ? explode(\',\', $prepareTVList) : array(); $tvPrefix = isset($tvPrefix) ? $tvPrefix : \'tv.\'; $parents = (!empty($parents) || $parents === \'0\') ? explode(\',\', $parents) : array($modx->resource->get(\'id\')); array_walk($parents, \'trim\'); $parents = array_unique($parents); $depth = isset($depth) ? (integer) $depth : 10; $tvFiltersOrDelimiter = isset($tvFiltersOrDelimiter) ? $tvFiltersOrDelimiter : \'||\'; $tvFiltersAndDelimiter = isset($tvFiltersAndDelimiter) ? $tvFiltersAndDelimiter : \',\'; $tvFilters = !empty($tvFilters) ? explode($tvFiltersOrDelimiter, $tvFilters) : array(); $where = !empty($where) ? $modx->fromJSON($where) : array(); $showUnpublished = !empty($showUnpublished) ? true : false; $showDeleted = !empty($showDeleted) ? true : false; $sortby = isset($sortby) ? $sortby : \'publishedon\'; $sortbyTV = isset($sortbyTV) ? $sortbyTV : \'\'; $sortbyAlias = isset($sortbyAlias) ? $sortbyAlias : \'modResource\'; $sortbyEscaped = !empty($sortbyEscaped) ? true : false; $sortdir = isset($sortdir) ? $sortdir : \'DESC\'; $sortdirTV = isset($sortdirTV) ? $sortdirTV : \'DESC\'; $limit = isset($limit) ? (integer) $limit : 5; $offset = isset($offset) ? (integer) $offset : 0; $totalVar = !empty($totalVar) ? $totalVar : \'total\'; $dbCacheFlag = !isset($dbCacheFlag) ? false : $dbCacheFlag; if (is_string($dbCacheFlag) || is_numeric($dbCacheFlag)) { if ($dbCacheFlag == \'0\') { $dbCacheFlag = false; } elseif ($dbCacheFlag == \'1\') { $dbCacheFlag = true; } else { $dbCacheFlag = (integer) $dbCacheFlag; } } /* multiple context support */ $contextArray = array(); $contextSpecified = false; if (!empty($context)) { $contextArray = explode(\',\',$context); array_walk($contextArray, \'trim\'); $contexts = array(); foreach ($contextArray as $ctx) { $contexts[] = $modx->quote($ctx); } $context = implode(\',\',$contexts); $contextSpecified = true; unset($contexts,$ctx); } else { $context = $modx->quote($modx->context->get(\'key\')); } $pcMap = array(); $pcQuery = $modx->newQuery(\'modResource\', array(\'id:IN\' => $parents), $dbCacheFlag); $pcQuery->select(array(\'id\', \'context_key\')); if ($pcQuery->prepare() && $pcQuery->stmt->execute()) { foreach ($pcQuery->stmt->fetchAll(PDO::FETCH_ASSOC) as $pcRow) { $pcMap[(integer) $pcRow[\'id\']] = $pcRow[\'context_key\']; } } $children = array(); $parentArray = array(); foreach ($parents as $parent) { $parent = (integer) $parent; if ($parent === 0) { $pchildren = array(); if ($contextSpecified) { foreach ($contextArray as $pCtx) { if (!in_array($pCtx, $contextArray)) { continue; } $options = $pCtx !== $modx->context->get(\'key\') ? array(\'context\' => $pCtx) : array(); $pcchildren = $modx->getChildIds($parent, $depth, $options); if (!empty($pcchildren)) $pchildren = array_merge($pchildren, $pcchildren); } } else { $cQuery = $modx->newQuery(\'modContext\', array(\'key:!=\' => \'mgr\')); $cQuery->select(array(\'key\')); if ($cQuery->prepare() && $cQuery->stmt->execute()) { foreach ($cQuery->stmt->fetchAll(PDO::FETCH_COLUMN) as $pCtx) { $options = $pCtx !== $modx->context->get(\'key\') ? array(\'context\' => $pCtx) : array(); $pcchildren = $modx->getChildIds($parent, $depth, $options); if (!empty($pcchildren)) $pchildren = array_merge($pchildren, $pcchildren); } } } $parentArray[] = $parent; } else { $pContext = array_key_exists($parent, $pcMap) ? $pcMap[$parent] : false; if ($debug) $modx->log(modX::LOG_LEVEL_ERROR, "context for {$parent} is {$pContext}"); if ($pContext && $contextSpecified && !in_array($pContext, $contextArray, true)) { $parent = next($parents); continue; } $parentArray[] = $parent; $options = !empty($pContext) && $pContext !== $modx->context->get(\'key\') ? array(\'context\' => $pContext) : array(); $pchildren = $modx->getChildIds($parent, $depth, $options); } if (!empty($pchildren)) $children = array_merge($children, $pchildren); $parent = next($parents); } $parents = array_merge($parentArray, $children); /* build query */ $criteria = array("modResource.parent IN (" . implode(\',\', $parents) . ")"); if ($contextSpecified) { $contextResourceTbl = $modx->getTableName(\'modContextResource\'); $criteria[] = "(modResource.context_key IN ({$context}) OR EXISTS(SELECT 1 FROM {$contextResourceTbl} ctx WHERE ctx.resource = modResource.id AND ctx.context_key IN ({$context})))"; } if (empty($showDeleted)) { $criteria[\'deleted\'] = \'0\'; } if (empty($showUnpublished)) { $criteria[\'published\'] = \'1\'; } if (empty($showHidden)) { $criteria[\'hidemenu\'] = \'0\'; } if (!empty($hideContainers)) { $criteria[\'isfolder\'] = \'0\'; } $criteria = $modx->newQuery(\'modResource\', $criteria); if (!empty($tvFilters)) { $tmplVarTbl = $modx->getTableName(\'modTemplateVar\'); $tmplVarResourceTbl = $modx->getTableName(\'modTemplateVarResource\'); $conditions = array(); $operators = array( \'<=>\' => \'<=>\', \'===\' => \'=\', \'!==\' => \'!=\', \'<>\' => \'<>\', \'==\' => \'LIKE\', \'!=\' => \'NOT LIKE\', \'<<\' => \'<\', \'<=\' => \'<=\', \'=<\' => \'=<\', \'>>\' => \'>\', \'>=\' => \'>=\', \'=>\' => \'=>\' ); foreach ($tvFilters as $fGroup => $tvFilter) { $filterGroup = array(); $filters = explode($tvFiltersAndDelimiter, $tvFilter); $multiple = count($filters) > 0; foreach ($filters as $filter) { $operator = \'==\'; $sqlOperator = \'LIKE\'; foreach ($operators as $op => $opSymbol) { if (strpos($filter, $op, 1) !== false) { $operator = $op; $sqlOperator = $opSymbol; break; } } $tvValueField = \'tvr.value\'; $tvDefaultField = \'tv.default_text\'; $f = explode($operator, $filter); if (count($f) >= 2) { if (count($f) > 2) { $k = array_shift($f); $b = join($operator, $f); $f = array($k, $b); } $tvName = $modx->quote($f[0]); if (is_numeric($f[1]) && !in_array($sqlOperator, array(\'LIKE\', \'NOT LIKE\'))) { $tvValue = $f[1]; if ($f[1] == (integer)$f[1]) { $tvValueField = "CAST({$tvValueField} AS SIGNED INTEGER)"; $tvDefaultField = "CAST({$tvDefaultField} AS SIGNED INTEGER)"; } else { $tvValueField = "CAST({$tvValueField} AS DECIMAL)"; $tvDefaultField = "CAST({$tvDefaultField} AS DECIMAL)"; } } else { $tvValue = $modx->quote($f[1]); } if ($multiple) { $filterGroup[] = "(EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.name = {$tvName} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id) " . "OR EXISTS (SELECT 1 FROM {$tmplVarTbl} tv WHERE tv.name = {$tvName} AND {$tvDefaultField} {$sqlOperator} {$tvValue} AND tv.id NOT IN (SELECT tmplvarid FROM {$tmplVarResourceTbl} WHERE contentid = modResource.id)) " . ")"; } else { $filterGroup = "(EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.name = {$tvName} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id) " . "OR EXISTS (SELECT 1 FROM {$tmplVarTbl} tv WHERE tv.name = {$tvName} AND {$tvDefaultField} {$sqlOperator} {$tvValue} AND tv.id NOT IN (SELECT tmplvarid FROM {$tmplVarResourceTbl} WHERE contentid = modResource.id)) " . ")"; } } elseif (count($f) == 1) { $tvValue = $modx->quote($f[0]); if ($multiple) { $filterGroup[] = "EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id)"; } else { $filterGroup = "EXISTS (SELECT 1 FROM {$tmplVarResourceTbl} tvr JOIN {$tmplVarTbl} tv ON {$tvValueField} {$sqlOperator} {$tvValue} AND tv.id = tvr.tmplvarid WHERE tvr.contentid = modResource.id)"; } } } $conditions[] = $filterGroup; } if (!empty($conditions)) { $firstGroup = true; foreach ($conditions as $cGroup => $c) { if (is_array($c)) { $first = true; foreach ($c as $cond) { if ($first && !$firstGroup) { $criteria->condition($criteria->query[\'where\'][0][1], $cond, xPDOQuery::SQL_OR, null, $cGroup); } else { $criteria->condition($criteria->query[\'where\'][0][1], $cond, xPDOQuery::SQL_AND, null, $cGroup); } $first = false; } } else { $criteria->condition($criteria->query[\'where\'][0][1], $c, $firstGroup ? xPDOQuery::SQL_AND : xPDOQuery::SQL_OR, null, $cGroup); } $firstGroup = false; } } } /* include/exclude resources, via &resources=`123,-456` prop */ if (!empty($resources)) { $resourceConditions = array(); $resources = explode(\',\',$resources); $include = array(); $exclude = array(); foreach ($resources as $resource) { $resource = (int)$resource; if ($resource == 0) continue; if ($resource < 0) { $exclude[] = abs($resource); } else { $include[] = $resource; } } if (!empty($include)) { $criteria->where(array(\'OR:modResource.id:IN\' => $include), xPDOQuery::SQL_OR); } if (!empty($exclude)) { $criteria->where(array(\'modResource.id:NOT IN\' => $exclude), xPDOQuery::SQL_AND, null, 1); } } if (!empty($where)) { $criteria->where($where); } $total = $modx->getCount(\'modResource\', $criteria); $modx->setPlaceholder($totalVar, $total); $fields = array_keys($modx->getFields(\'modResource\')); if (empty($includeContent)) { $fields = array_diff($fields, array(\'content\')); } $columns = $includeContent ? $modx->getSelectColumns(\'modResource\', \'modResource\') : $modx->getSelectColumns(\'modResource\', \'modResource\', \'\', array(\'content\'), true); $criteria->select($columns); if (!empty($sortbyTV)) { $criteria->leftJoin(\'modTemplateVar\', \'tvDefault\', array( "tvDefault.name" => $sortbyTV )); $criteria->leftJoin(\'modTemplateVarResource\', \'tvSort\', array( "tvSort.contentid = modResource.id", "tvSort.tmplvarid = tvDefault.id" )); if (empty($sortbyTVType)) $sortbyTVType = \'string\'; if ($modx->getOption(\'dbtype\') === \'mysql\') { switch ($sortbyTVType) { case \'integer\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS SIGNED INTEGER) AS sortTV"); break; case \'decimal\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS DECIMAL) AS sortTV"); break; case \'datetime\': $criteria->select("CAST(IFNULL(tvSort.value, tvDefault.default_text) AS DATETIME) AS sortTV"); break; case \'string\': default: $criteria->select("IFNULL(tvSort.value, tvDefault.default_text) AS sortTV"); break; } } elseif ($modx->getOption(\'dbtype\') === \'sqlsrv\') { switch ($sortbyTVType) { case \'integer\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS BIGINT) AS sortTV"); break; case \'decimal\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS DECIMAL) AS sortTV"); break; case \'datetime\': $criteria->select("CAST(ISNULL(tvSort.value, tvDefault.default_text) AS DATETIME) AS sortTV"); break; case \'string\': default: $criteria->select("ISNULL(tvSort.value, tvDefault.default_text) AS sortTV"); break; } } $criteria->sortby("sortTV", $sortdirTV); } if (!empty($sortby)) { if (strpos($sortby, \'{\') === 0) { $sorts = $modx->fromJSON($sortby); } else { $sorts = array($sortby => $sortdir); } if (is_array($sorts)) { while (list($sort, $dir) = each($sorts)) { if ($sortbyEscaped) $sort = $modx->escape($sort); if (!empty($sortbyAlias)) $sort = $modx->escape($sortbyAlias) . ".{$sort}"; $criteria->sortby($sort, $dir); } } } if (!empty($limit)) $criteria->limit($limit, $offset); if (!empty($debug)) { $criteria->prepare(); $modx->log(modX::LOG_LEVEL_ERROR, $criteria->toSQL()); } $collection = $modx->getCollection(\'modResource\', $criteria, $dbCacheFlag); $idx = !empty($idx) || $idx === \'0\' ? (integer) $idx : 1; $first = empty($first) && $first !== \'0\' ? 1 : (integer) $first; $last = empty($last) ? (count($collection) + $idx - 1) : (integer) $last; /* include parseTpl */ include_once $modx->getOption(\'getresources.core_path\',null,$modx->getOption(\'core_path\').\'components/getresources/\').\'include.parsetpl.php\'; $templateVars = array(); if (!empty($includeTVs) && !empty($includeTVList)) { $templateVars = $modx->getCollection(\'modTemplateVar\', array(\'name:IN\' => $includeTVList)); } /** @var modResource $resource */ foreach ($collection as $resourceId => $resource) { $tvs = array(); if (!empty($includeTVs)) { if (empty($includeTVList)) { $templateVars = $resource->getMany(\'TemplateVars\'); } /** @var modTemplateVar $templateVar */ foreach ($templateVars as $tvId => $templateVar) { if (!empty($includeTVList) && !in_array($templateVar->get(\'name\'), $includeTVList)) continue; if ($processTVs && (empty($processTVList) || in_array($templateVar->get(\'name\'), $processTVList))) { $tvs[$tvPrefix . $templateVar->get(\'name\')] = $templateVar->renderOutput($resource->get(\'id\')); } else { $value = $templateVar->getValue($resource->get(\'id\')); if ($prepareTVs && method_exists($templateVar, \'prepareOutput\') && (empty($prepareTVList) || in_array($templateVar->get(\'name\'), $prepareTVList))) { $value = $templateVar->prepareOutput($value); } $tvs[$tvPrefix . $templateVar->get(\'name\')] = $value; } } } $odd = ($idx & 1); $properties = array_merge( $scriptProperties ,array( \'idx\' => $idx ,\'first\' => $first ,\'last\' => $last ,\'odd\' => $odd ) ,$includeContent ? $resource->toArray() : $resource->get($fields) ,$tvs ); $resourceTpl = false; if ($idx == $first && !empty($tplFirst)) { $resourceTpl = parseTpl($tplFirst, $properties); } if ($idx == $last && empty($resourceTpl) && !empty($tplLast)) { $resourceTpl = parseTpl($tplLast, $properties); } $tplidx = \'tpl_\' . $idx; if (empty($resourceTpl) && !empty($$tplidx)) { $resourceTpl = parseTpl($$tplidx, $properties); } if ($idx > 1 && empty($resourceTpl)) { $divisors = getDivisors($idx); if (!empty($divisors)) { foreach ($divisors as $divisor) { $tplnth = \'tpl_n\' . $divisor; if (!empty($$tplnth)) { $resourceTpl = parseTpl($$tplnth, $properties); if (!empty($resourceTpl)) { break; } } } } } if ($odd && empty($resourceTpl) && !empty($tplOdd)) { $resourceTpl = parseTpl($tplOdd, $properties); } if (!empty($tplCondition) && !empty($conditionalTpls) && empty($resourceTpl)) { $conTpls = $modx->fromJSON($conditionalTpls); $subject = $properties[$tplCondition]; $tplOperator = !empty($tplOperator) ? $tplOperator : \'=\'; $tplOperator = strtolower($tplOperator); $tplCon = \'\'; foreach ($conTpls as $operand => $conditionalTpl) { switch ($tplOperator) { case \'!=\': case \'neq\': case \'not\': case \'isnot\': case \'isnt\': case \'unequal\': case \'notequal\': $tplCon = (($subject != $operand) ? $conditionalTpl : $tplCon); break; case \'<\': case \'lt\': case \'less\': case \'lessthan\': $tplCon = (($subject < $operand) ? $conditionalTpl : $tplCon); break; case \'>\': case \'gt\': case \'greater\': case \'greaterthan\': $tplCon = (($subject > $operand) ? $conditionalTpl : $tplCon); break; case \'<=\': case \'lte\': case \'lessthanequals\': case \'lessthanorequalto\': $tplCon = (($subject <= $operand) ? $conditionalTpl : $tplCon); break; case \'>=\': case \'gte\': case \'greaterthanequals\': case \'greaterthanequalto\': $tplCon = (($subject >= $operand) ? $conditionalTpl : $tplCon); break; case \'isempty\': case \'empty\': $tplCon = empty($subject) ? $conditionalTpl : $tplCon; break; case \'!empty\': case \'notempty\': case \'isnotempty\': $tplCon = !empty($subject) && $subject != \'\' ? $conditionalTpl : $tplCon; break; case \'isnull\': case \'null\': $tplCon = $subject == null || strtolower($subject) == \'null\' ? $conditionalTpl : $tplCon; break; case \'inarray\': case \'in_array\': case \'ia\': $operand = explode(\',\', $operand); $tplCon = in_array($subject, $operand) ? $conditionalTpl : $tplCon; break; case \'between\': case \'range\': case \'>=<\': case \'><\': $operand = explode(\',\', $operand); $tplCon = ($subject >= min($operand) && $subject <= max($operand)) ? $conditionalTpl : $tplCon; break; case \'==\': case \'=\': case \'eq\': case \'is\': case \'equal\': case \'equals\': case \'equalto\': default: $tplCon = (($subject == $operand) ? $conditionalTpl : $tplCon); break; } } if (!empty($tplCon)) { $resourceTpl = parseTpl($tplCon, $properties); } } if (!empty($tpl) && empty($resourceTpl)) { $resourceTpl = parseTpl($tpl, $properties); } if ($resourceTpl === false && !empty($debug)) { $chunk = $modx->newObject(\'modChunk\'); $chunk->setCacheable(false); $output[]= $chunk->process(array(), \'
\' . print_r($properties, true) .\'
\'); } else { $output[]= $resourceTpl; } $idx++; } /* output */ $toSeparatePlaceholders = $modx->getOption(\'toSeparatePlaceholders\', $scriptProperties, false); if (!empty($toSeparatePlaceholders)) { $modx->setPlaceholders($output, $toSeparatePlaceholders); return \'\'; } $output = implode($outputSeparator, $output); $tplWrapper = $modx->getOption(\'tplWrapper\', $scriptProperties, false); $wrapIfEmpty = $modx->getOption(\'wrapIfEmpty\', $scriptProperties, false); if (!empty($tplWrapper) && ($wrapIfEmpty || !empty($output))) { $output = parseTpl($tplWrapper, array_merge($scriptProperties, array(\'output\' => $output))); } $toPlaceholder = $modx->getOption(\'toPlaceholder\', $scriptProperties, false); if (!empty($toPlaceholder)) { $modx->setPlaceholder($toPlaceholder, $output); return \'\'; } return $output;', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( ), ), 'FormIt' => array ( 'fields' => array ( 'id' => 16, 'source' => 0, 'property_preprocess' => false, 'name' => 'FormIt', 'description' => 'A dynamic form processing snippet.', 'editor_type' => 0, 'category' => 8, 'cache_type' => 0, 'snippet' => '/** * FormIt * * Copyright 2009-2012 by Shaun McCormick * * FormIt is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at your option) any * later version. * * FormIt is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with * FormIt; if not, write to the Free Software Foundation, Inc., 59 Temple Place, * Suite 330, Boston, MA 02111-1307 USA * * @package formit */ /** * FormIt * * A dynamic form processing Snippet for MODx Revolution. * * @var modX $modx * @var array $scriptProperties * * @package formit */ $modelPath = $modx->getOption( \'formit.core_path\', null, $modx->getOption(\'core_path\', null, MODX_CORE_PATH) . \'components/formit/\' ) . \'model/formit/\'; $modx->loadClass(\'FormIt\', $modelPath, true, true); $fi = new FormIt($modx, $scriptProperties); $fi->initialize($modx->context->get(\'key\')); $fi->loadRequest(); $fields = $fi->request->prepare(); return $fi->request->handle($fields);', 'locked' => false, 'properties' => array ( 'hooks' => array ( 'name' => 'hooks', 'desc' => 'prop_formit.hooks_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'What scripts to fire, if any, after the form passes validation. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.', 'area_trans' => '', ), 'preHooks' => array ( 'name' => 'preHooks', 'desc' => 'prop_formit.prehooks_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'What scripts to fire, if any, once the form loads. You can pre-set form fields via $scriptProperties[`hook`]->fields[`fieldname`]. This can be a comma-separated list of hooks, and if the first fails, the proceeding ones will not fire. A hook can also be a Snippet name that will execute that Snippet.', 'area_trans' => '', ), 'submitVar' => array ( 'name' => 'submitVar', 'desc' => 'prop_formit.submitvar_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If set, will not begin form processing if this POST variable is not passed.', 'area_trans' => '', ), 'validate' => array ( 'name' => 'validate', 'desc' => 'prop_formit.validate_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'A comma-separated list of fields to validate, with each field name as name:validator (eg: username:required,email:required). Validators can also be chained, like email:email:required. This property can be specified on multiple lines.', 'area_trans' => '', ), 'errTpl' => array ( 'name' => 'errTpl', 'desc' => 'prop_formit.errtpl_desc', 'type' => 'textfield', 'options' => '', 'value' => '[[+error]]', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'The wrapper template for error messages.', 'area_trans' => '', ), 'validationErrorMessage' => array ( 'name' => 'validationErrorMessage', 'desc' => 'prop_formit.validationerrormessage_desc', 'type' => 'textfield', 'options' => '', 'value' => '

A form validation error occurred. Please check the values you have entered.

', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'A general error message to set to a placeholder if validation fails. Can contain [[+errors]] if you want to display a list of all errors at the top.', 'area_trans' => '', ), 'validationErrorBulkTpl' => array ( 'name' => 'validationErrorBulkTpl', 'desc' => 'prop_formit.validationerrorbulktpl_desc', 'type' => 'textfield', 'options' => '', 'value' => '
  • [[+error]]
    • ', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'HTML tpl that is used for each individual error in the generic validation error message value.', 'area_trans' => '', ), 'trimValuesBeforeValidation' => array ( 'name' => 'trimValuesBeforeValidation', 'desc' => 'prop_formit.trimvaluesdeforevalidation_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Whether or not to trim spaces from the beginning and end of values before attempting validation. Defaults to true.', 'area_trans' => '', ), 'customValidators' => array ( 'name' => 'customValidators', 'desc' => 'prop_formit.customvalidators_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'A comma-separated list of custom validator names (snippets) you plan to use in this form. They must be explicitly stated here, or they will not be run.', 'area_trans' => '', ), 'clearFieldsOnSuccess' => array ( 'name' => 'clearFieldsOnSuccess', 'desc' => 'prop_formit.clearfieldsonsuccess_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If true, will clear the fields on a successful form submission that does not redirect.', 'area_trans' => '', ), 'successMessage' => array ( 'name' => 'successMessage', 'desc' => 'prop_formit.successmessage_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If set, will set this a placeholder with the name of the value of the property &successMessagePlaceholder, which defaults to `fi.successMessage`.', 'area_trans' => '', ), 'successMessagePlaceholder' => array ( 'name' => 'successMessagePlaceholder', 'desc' => 'prop_formit.successmessageplaceholder_desc', 'type' => 'textfield', 'options' => '', 'value' => 'fi.successMessage', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'The placeholder to set the success message to.', 'area_trans' => '', ), 'store' => array ( 'name' => 'store', 'desc' => 'prop_formit.store_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If true, will store the data in the cache for retrieval using the FormItRetriever snippet.', 'area_trans' => '', ), 'placeholderPrefix' => array ( 'name' => 'placeholderPrefix', 'desc' => 'prop_formit.placeholderprefix_desc', 'type' => 'textfield', 'options' => '', 'value' => 'fi.', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'The prefix to use for all placeholders set by FormIt for fields. Defaults to `fi.`', 'area_trans' => '', ), 'storeTime' => array ( 'name' => 'storeTime', 'desc' => 'prop_formit.storetime_desc', 'type' => 'textfield', 'options' => '', 'value' => '300', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `store` is set to true, this specifies the number of seconds to store the data from the form submission. Defaults to five minutes.', 'area_trans' => '', ), 'storeLocation' => array ( 'name' => 'storeLocation', 'desc' => 'prop_formit.storelocation_desc', 'type' => 'list', 'options' => array ( 0 => array ( 'value' => 'cache', 'text' => 'formit.opt_cache', 'name' => 'MODX Cache', ), 1 => array ( 'value' => 'session', 'text' => 'formit.opt_session', 'name' => 'Session', ), ), 'value' => 'cache', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `store` is set to true, this specifies the cache location of the data from the form submission. Defaults to MODX cache.', 'area_trans' => '', ), 'allowFiles' => array ( 'name' => 'allowFiles', 'desc' => 'prop_formit.allowfiles_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If set to 0, will prevent files from being submitted on the form.', 'area_trans' => '', ), 'spamEmailFields' => array ( 'name' => 'spamEmailFields', 'desc' => 'prop_formit.spamemailfields_desc', 'type' => 'textfield', 'options' => '', 'value' => 'email', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `spam` is set as a hook, a comma-separated list of fields containing emails to check spam against.', 'area_trans' => '', ), 'spamCheckIp' => array ( 'name' => 'spamCheckIp', 'desc' => 'prop_formit.spamcheckip_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `spam` is set as a hook, and this is true, will check the IP as well.', 'area_trans' => '', ), 'recaptchaJs' => array ( 'name' => 'recaptchaJs', 'desc' => 'prop_formit.recaptchajs_desc', 'type' => 'textfield', 'options' => '', 'value' => '{}', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `recaptcha` is set as a hook, this can be a JSON object that will be set to the JS RecaptchaOptions variable, which configures options for reCaptcha.', 'area_trans' => '', ), 'recaptchaTheme' => array ( 'name' => 'recaptchaTheme', 'desc' => 'prop_formit.recaptchatheme_desc', 'type' => 'list', 'options' => array ( 0 => array ( 'value' => 'red', 'text' => 'formit.opt_red', 'name' => 'Red', ), 1 => array ( 'value' => 'white', 'text' => 'formit.opt_white', 'name' => 'White', ), 2 => array ( 'value' => 'clean', 'text' => 'formit.opt_clean', 'name' => 'Clean', ), 3 => array ( 'value' => 'blackglass', 'text' => 'formit.opt_blackglass', 'name' => 'Black Glass', ), ), 'value' => 'clean', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `recaptcha` is set as a hook, this will select a theme for the reCaptcha widget.', 'area_trans' => '', ), 'redirectTo' => array ( 'name' => 'redirectTo', 'desc' => 'prop_formit.redirectto_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `redirect` is set as a hook, this must specify the Resource ID to redirect to.', 'area_trans' => '', ), 'redirectParams' => array ( 'name' => 'redirectParams', 'desc' => 'prop_formit.redirectparams_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'A JSON array of parameters to pass to the redirect hook that will be passed when redirecting.', 'area_trans' => '', ), 'emailTo' => array ( 'name' => 'emailTo', 'desc' => 'prop_formit.emailto_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `email` is set as a hook, then this specifies the email(s) to send the email to. Can be a comma-separated list of email addresses.', 'area_trans' => '', ), 'emailToName' => array ( 'name' => 'emailToName', 'desc' => 'prop_formit.emailtoname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, then this must be a parallel list of comma-separated names for the email addresses specified in the `emailTo` property.', 'area_trans' => '', ), 'emailFrom' => array ( 'name' => 'emailFrom', 'desc' => 'prop_formit.emailfrom_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, and this is set, will specify the From: address for the email. If not set, will first look for an `email` form field. If none is found, will default to the `emailsender` system setting.', 'area_trans' => '', ), 'emailFromName' => array ( 'name' => 'emailFromName', 'desc' => 'prop_formit.emailfromname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, and this is set, will specify the From: name for the email.', 'area_trans' => '', ), 'emailReplyTo' => array ( 'name' => 'emailReplyTo', 'desc' => 'prop_formit.emailreplyto_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, and this is set, will specify the Reply-To: address for the email.', 'area_trans' => '', ), 'emailReplyToName' => array ( 'name' => 'emailReplyToName', 'desc' => 'prop_formit.emailreplytoname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, and this is set, will specify the Reply-To: name for the email.', 'area_trans' => '', ), 'emailCC' => array ( 'name' => 'emailCC', 'desc' => 'prop_formit.emailcc_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `email` is set as a hook, then this specifies the email(s) to send the email to as a CC. Can be a comma-separated list of email addresses.', 'area_trans' => '', ), 'emailCCName' => array ( 'name' => 'emailCCName', 'desc' => 'prop_formit.emailccname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, then this must be a parallel list of comma-separated names for the email addresses specified in the `emailCC` property.', 'area_trans' => '', ), 'emailBCC' => array ( 'name' => 'emailBCC', 'desc' => 'prop_formit.emailbcc_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `email` is set as a hook, then this specifies the email(s) to send the email to as a BCC. Can be a comma-separated list of email addresses.', 'area_trans' => '', ), 'emailBCCName' => array ( 'name' => 'emailBCCName', 'desc' => 'prop_formit.emailbccname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, then this must be a parallel list of comma-separated names for the email addresses specified in the `emailBCC` property.', 'area_trans' => '', ), 'emailReturnPath' => array ( 'name' => 'emailReturnPath', 'desc' => 'prop_formit.emailreturnpath_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, and this is set, will specify the Return-path: address for the email. If not set, will take the value of `emailFrom` property.', 'area_trans' => '', ), 'emailSubject' => array ( 'name' => 'emailSubject', 'desc' => 'prop_formit.emailsubject_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If `email` is set as a hook, this is required as a subject line for the email.', 'area_trans' => '', ), 'emailUseFieldForSubject' => array ( 'name' => 'emailUseFieldForSubject', 'desc' => 'prop_formit.emailusefieldforsubject_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If the field `subject` is passed into the form, if this is true, it will use the field content for the subject line of the email.', 'area_trans' => '', ), 'emailHtml' => array ( 'name' => 'emailHtml', 'desc' => 'prop_formit.emailhtml_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `email` is set as a hook, this toggles HTML emails or not. Defaults to true.', 'area_trans' => '', ), 'emailConvertNewlines' => array ( 'name' => 'emailConvertNewlines', 'desc' => 'prop_formit.emailconvertnewlines_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If true and emailHtml is set to 1, will convert newlines to BR tags in the email.', 'area_trans' => '', ), 'emailMultiWrapper' => array ( 'name' => 'emailMultiWrapper', 'desc' => 'prop_formit.emailmultiwrapper_desc', 'type' => 'textfield', 'options' => '', 'value' => '[[+value]]', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Will wrap each item in a collection of fields sent via checkboxes/multi-selects. Defaults to just the value.', 'area_trans' => '', ), 'emailMultiSeparator' => array ( 'name' => 'emailMultiSeparator', 'desc' => 'prop_formit.emailmultiseparator_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'The default separator for collections of items sent through checkboxes/multi-selects. Defaults to a newline.', 'area_trans' => '', ), 'fiarTpl' => array ( 'name' => 'fiarTpl', 'desc' => 'prop_formit.fiartpl_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiartpl_desc', 'area_trans' => '', ), 'fiarToField' => array ( 'name' => 'fiarToField', 'desc' => 'prop_formit.fiartofield_desc', 'type' => 'textfield', 'options' => '', 'value' => 'email', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiartofield_desc', 'area_trans' => '', ), 'fiarSubject' => array ( 'name' => 'fiarSubject', 'desc' => 'prop_formit.fiarsubject_desc', 'type' => 'textfield', 'options' => '', 'value' => '[[++site_name]] Auto-Responder', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarsubject_desc', 'area_trans' => '', ), 'fiarFrom' => array ( 'name' => 'fiarFrom', 'desc' => 'prop_formit.fiarfrom_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarfrom_desc', 'area_trans' => '', ), 'fiarFromName' => array ( 'name' => 'fiarFromName', 'desc' => 'prop_formit.fiarfromname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarfromname_desc', 'area_trans' => '', ), 'fiarReplyTo' => array ( 'name' => 'fiarReplyTo', 'desc' => 'prop_formit.fiarreplyto_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarreplyto_desc', 'area_trans' => '', ), 'fiarReplyToName' => array ( 'name' => 'fiarReplyToName', 'desc' => 'prop_formit.fiarreplytoname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarreplytoname_desc', 'area_trans' => '', ), 'fiarCC' => array ( 'name' => 'fiarCC', 'desc' => 'prop_formit.fiarcc_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarcc_desc', 'area_trans' => '', ), 'fiarCCName' => array ( 'name' => 'fiarCCName', 'desc' => 'prop_fiar.fiarccname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'Optional. If `FormItAutoResponder` is set as a hook, then this must be a parallel list of comma-separated names for the email addresses specified in the `emailCC` property.', 'area_trans' => '', ), 'fiarBCC' => array ( 'name' => 'fiarBCC', 'desc' => 'prop_formit.fiarbcc_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarbcc_desc', 'area_trans' => '', ), 'fiarBCCName' => array ( 'name' => 'fiarBCCName', 'desc' => 'prop_formit.fiarbccname_desc', 'type' => 'textfield', 'options' => '', 'value' => '', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarbccname_desc', 'area_trans' => '', ), 'fiarHtml' => array ( 'name' => 'fiarHtml', 'desc' => 'prop_formit.fiarhtml_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.fiarhtml_desc', 'area_trans' => '', ), 'mathMinRange' => array ( 'name' => 'mathMinRange', 'desc' => 'prop_formit.mathminrange_desc', 'type' => 'textfield', 'options' => '', 'value' => '10', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathminrange_desc', 'area_trans' => '', ), 'mathMaxRange' => array ( 'name' => 'mathMaxRange', 'desc' => 'prop_formit.mathmaxrange_desc', 'type' => 'textfield', 'options' => '', 'value' => '100', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathmaxrange_desc', 'area_trans' => '', ), 'mathField' => array ( 'name' => 'mathField', 'desc' => 'prop_formit.mathfield_desc', 'type' => 'textfield', 'options' => '', 'value' => 'math', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathfield_desc', 'area_trans' => '', ), 'mathOp1Field' => array ( 'name' => 'mathOp1Field', 'desc' => 'prop_formit.mathop1field_desc', 'type' => 'textfield', 'options' => '', 'value' => 'op1', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathop1field_desc', 'area_trans' => '', ), 'mathOp2Field' => array ( 'name' => 'mathOp2Field', 'desc' => 'prop_formit.mathop2field_desc', 'type' => 'textfield', 'options' => '', 'value' => 'op2', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathop2field_desc', 'area_trans' => '', ), 'mathOperatorField' => array ( 'name' => 'mathOperatorField', 'desc' => 'prop_formit.mathoperatorfield_desc', 'type' => 'textfield', 'options' => '', 'value' => 'operator', 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.mathoperatorfield_desc', 'area_trans' => '', ), 'saveTmpFiles' => array ( 'name' => 'saveTmpFiles', 'desc' => 'prop_formit.savetmpfiles_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If set to 1, FormIt will store submitted files in a temporary folder.', 'area_trans' => '', ), 'attachFilesToEmail' => array ( 'name' => 'attachFilesToEmail', 'desc' => 'prop_formit.attachfiles_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => true, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'If true, FormIt will add all file fields as attachments in the email.', 'area_trans' => '', ), 'storeAttachments' => array ( 'name' => 'storeAttachments', 'desc' => 'prop_formit.store_attachments_desc', 'type' => 'combo-boolean', 'options' => '', 'value' => false, 'lexicon' => 'formit:properties', 'area' => '', 'desc_trans' => 'prop_formit.store_attachments_desc', 'area_trans' => '', ), ), 'moduleguid' => '', 'static' => false, 'static_file' => '', 'content' => '/** * FormIt * * Copyright 2009-2012 by Shaun McCormick * * FormIt is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at your option) any * later version. * * FormIt is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with * FormIt; if not, write to the Free Software Foundation, Inc., 59 Temple Place, * Suite 330, Boston, MA 02111-1307 USA * * @package formit */ /** * FormIt * * A dynamic form processing Snippet for MODx Revolution. * * @var modX $modx * @var array $scriptProperties * * @package formit */ $modelPath = $modx->getOption( \'formit.core_path\', null, $modx->getOption(\'core_path\', null, MODX_CORE_PATH) . \'components/formit/\' ) . \'model/formit/\'; $modx->loadClass(\'FormIt\', $modelPath, true, true); $fi = new FormIt($modx, $scriptProperties); $fi->initialize($modx->context->get(\'key\')); $fi->loadRequest(); $fields = $fi->request->prepare(); return $fi->request->handle($fields);', ), 'policies' => array ( 'web' => array ( ), ), 'source' => array ( ), ), ), 'modTemplateVar' => array ( ), ), );