Forked from sepiariver/cbGetFieldContent.snippet.php
Created
October 13, 2015 05:00
-
-
Save pepebe/0e996ae9dc9a52cf8ba7 to your computer and use it in GitHub Desktop.
Modified Content Blocks snippet tries a comma separated list of fields, in order of priority, until a value is found or nothing is returned.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Use the cbGetFieldContent snippet to get the content of a particular field. | |
* | |
* For example, this can be useful if you need to get a bit of content | |
* in a getResources call | |
* | |
* Example usage: | |
* | |
* [[cbGetFieldContent? | |
* &field=`13` | |
* &tpl=`fieldTpl` | |
* ]] | |
* | |
* [[cbGetFieldContent? | |
* &field=`13` | |
* &fieldSettingFilter=`class==keyImage` | |
* &tpl=`fieldTpl` | |
* ]] | |
* | |
* An optional &resource param allows checking for fields on other resources. | |
* An option &fieldSettingFilter allows filtering by == or != of a field setting. Only items matching the filter will be returned. | |
* An optional &limit param allows limiting the number of matched fields | |
* An optional &offset param allows skipping the first n matched fields | |
* An optional &tpl param is a chunk name defining a template to use for your field. If not set, | |
* the ContentBlocks template for the field will be used. | |
* An optional &wrapTpl param is a chunk name defining a template to use for your field wrapper. | |
* If not set, the ContentBlocks wrapper template for the field will be used. Applies only to | |
* multi-value inputs (galleries, files, etc.) | |
* An optional &returnAsJSON parameter will return all values of the selected field as JSON. | |
* | |
* @var modX $modx | |
* @var array $scriptProperties | |
*/ | |
$resource = (isset($scriptProperties['resource']) && $scriptProperties['resource'] != $modx->resource->get('id')) ? $modx->getObject('modResource', $scriptProperties['resource']) : $modx->resource; | |
if (!$resource) { | |
return ''; | |
} | |
$fld = $modx->getOption('field', $scriptProperties, 0, true); | |
$fieldSettingFilter = $modx->getOption('fieldSettingFilter', $scriptProperties, false, true); | |
$limit = $modx->getOption('limit', $scriptProperties, 0, true); | |
$offset = $modx->getOption('offset', $scriptProperties, 0, true); | |
$tpl = $modx->getOption('tpl', $scriptProperties, false, true); | |
$wrapTpl = $modx->getOption('wrapTpl', $scriptProperties, false, true); | |
$showDebug = $modx->getOption('showDebug', $scriptProperties, false, true); | |
$returnAsJSON = $modx->getOption('returnAsJSON', $scriptProperties, false, true); | |
$debug = array('scriptProperties' => $scriptProperties); | |
$output = ''; | |
// If comma-separated list in $fld, make array of IDs, else $fields = false | |
$fields = false; | |
if (strpos($fld, ',') !== false) { | |
$fields = array_filter(array_map('trim', explode(',', $fld))); | |
$fld = $fields[0]; // Let's not have $fld be a comma-separated string, in case it breaks something below | |
} | |
if(!$fld) { | |
$showDebug = true; | |
} | |
else { | |
// Make sure this is a contentblocks-enabled resource | |
$enabled = $resource->getProperty('_isContentBlocks', 'contentblocks'); | |
$debug['enabled'] = (bool)$enabled; | |
if ($enabled !== true) return; | |
// Get the field counts | |
$counts = $resource->getProperty('fieldcounts', 'contentblocks'); | |
$debug['counts'] = $counts; | |
// Loop through $fields and replace the $fld var with the first matching element | |
if (is_array($counts) && is_array($fields)) { | |
foreach ($fields as $f) { | |
if (isset($counts[$f])) { | |
$fld = $f; | |
break; | |
} | |
} | |
} | |
// Otherwise, $fld is the first ID provided and the snippet continues as in previous versions. No harm no foul. | |
if (is_array($counts) && isset($counts[$fld])) { | |
$fieldsData = $resource->getProperty('linear', 'contentblocks'); | |
$fieldsTypeData = array(); | |
$cbCorePath = $modx->getOption('contentblocks.core_path', null, $modx->getOption('core_path').'components/contentblocks/'); | |
$ContentBlocks = $modx->getService('contentblocks','ContentBlocks', $cbCorePath.'model/contentblocks/'); | |
$ContentBlocks->loadInputs(); | |
$field = $modx->getObject('cbField', $fld); | |
if($tpl) { | |
$field->set('template', $modx->getChunk($tpl)); | |
} | |
if($wrapTpl) { | |
$field->set('wrapper_template', $modx->getChunk($wrapTpl)); | |
} | |
$debug['fieldsData'] = $fieldsData; | |
foreach($fieldsData as $fieldData) { | |
if($fieldData['field'] == $fld) { | |
$fieldsTypeData[] = $fieldData; | |
} | |
} | |
$debug['fieldsTypeData'] = $fieldsTypeData; | |
if($fieldSettingFilter) { | |
$operators = array( | |
'!=' => '!=', | |
'==' => '==', | |
); | |
$filters = explode(',', $fieldSettingFilter); | |
$debug['filters'] = array('original' => $filters); | |
foreach($filters as $i => $filter) { | |
foreach($operators as $op => $symbol) { | |
if (strpos($filter, $op, 1) !== false) { | |
$operator = $op; | |
break; | |
} | |
} | |
$filter = explode($operator, $filter); | |
$debug[$i]['filter'] = $filter; | |
$setting = array_shift($filter); | |
$value = array_shift($filter); | |
$debug[$i]['setting'] = $setting; | |
$debug[$i]['value'] = $value; | |
$debug[$i]['operator'] = $operator; | |
foreach($fieldsTypeData as $idx => $fieldData) { | |
if($fieldData['settings'] && array_key_exists($setting, $fieldData['settings'])) { | |
switch($operator) { | |
case '==' : | |
if($fieldData['settings'][$setting] != $value) { | |
unset($fieldsTypeData[$idx]); | |
} | |
break; | |
case '!=' : | |
if($fieldData['settings'][$setting] == $value) { | |
unset($fieldsTypeData[$idx]); | |
} | |
break; | |
} | |
} | |
} | |
} | |
} | |
if($offset) { | |
$fieldsTypeData = array_splice($fieldsTypeData, (int)$offset); | |
$debug['offset'] = $offset; | |
} | |
if($limit) { | |
$fieldsTypeData = array_splice($fieldsTypeData, 0, $limit); | |
$debug['limit'] = $limit; | |
} | |
$debug['result'] = $fieldsTypeData; | |
if(!$returnAsJSON && count($fieldsTypeData)) { | |
$i = 0; | |
foreach($fieldsTypeData as $fieldData) { | |
$i++; | |
$output .= $ContentBlocks->generateFieldHtml($fieldData, $field, $i); | |
} | |
} | |
if($returnAsJSON) { | |
if($showDebug) { | |
$output = $modx->toJSON(array('output' => $fieldsTypeData, 'debug' => $debug)); | |
} | |
else { | |
$output = $modx->toJSON($fieldsTypeData); | |
} | |
} | |
} | |
} | |
if(!$returnAsJSON && $showDebug) { | |
$output .= '<pre>' . print_r($debug, true) . '</pre>'; | |
} | |
return $output; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment