symphony/lib/toolkit/fields/field.checkbox.php
<?php
/**
* @package toolkit
*/
/**
* Checkbox field simulates a HTML checkbox field, in that it represents a
* simple yes/no field.
*/
class FieldCheckbox extends Field implements ExportableField, ImportableField
{
public function __construct()
{
parent::__construct();
$this->_name = __('Checkbox');
$this->_required = true;
$this->entryQueryFieldAdapter = new EntryQueryCheckboxAdapter($this);
$this->set('required', 'no');
$this->set('location', 'sidebar');
}
/*-------------------------------------------------------------------------
Definition:
-------------------------------------------------------------------------*/
public function canToggle()
{
return true;
}
public function getToggleStates()
{
return array(
'yes' => __('Yes'),
'no' => __('No')
);
}
public function toggleFieldData(array $data, $newState, $entry_id = null)
{
$data['value'] = $newState;
return $data;
}
public function canFilter()
{
return true;
}
public function isSortable()
{
return true;
}
public function allowDatasourceOutputGrouping()
{
return true;
}
public function allowDatasourceParamOutput()
{
return true;
}
public function fetchFilterableOperators()
{
return array(
array(
'title' => 'is',
'filter' => ' ',
'help' => __('Find values that are an exact match for the given string.')
)
);
}
public function fetchSuggestionTypes()
{
return array('static');
}
/*-------------------------------------------------------------------------
Setup:
-------------------------------------------------------------------------*/
public function createTable()
{
return Symphony::Database()
->create('tbl_entries_data_' . General::intval($this->get('id')))
->ifNotExists()
->fields([
'id' => [
'type' => 'int(11)',
'auto' => true,
],
'entry_id' => 'int(11)',
'value' => [
'type' => 'enum',
'values' => ['yes', 'no'],
'default' => $this->get('default_state') == 'on' ? 'yes' : 'no',
]
])
->keys([
'id' => 'primary',
'entry_id' => 'unique',
'value' => 'key',
])
->execute()
->success();
}
/*-------------------------------------------------------------------------
Settings:
-------------------------------------------------------------------------*/
public function findDefaults(array &$settings)
{
if (!isset($settings['default_state'])) {
$settings['default_state'] = 'off';
}
}
public function displaySettingsPanel(XMLElement &$wrapper, $errors = null)
{
parent::displaySettingsPanel($wrapper, $errors);
// Checkbox Default State
$label = Widget::Label();
$label->setAttribute('class', 'column');
$input = Widget::Input('fields['.$this->get('sortorder').'][default_state]', 'on', 'checkbox');
if ($this->get('default_state') == 'on') {
$input->setAttribute('checked', 'checked');
}
$label->setValue(__('%s Checked by default', array($input->generate())));
$wrapper->appendChild($label);
// Requirements and table display
$this->appendStatusFooter($wrapper);
}
public function commit()
{
if (!parent::commit()) {
return false;
}
$id = $this->get('id');
if ($id === false) {
return false;
}
$fields = array();
$fields['default_state'] = ($this->get('default_state') ? $this->get('default_state') : 'off');
return FieldManager::saveSettings($id, $fields);
}
/*-------------------------------------------------------------------------
Publish:
-------------------------------------------------------------------------*/
public function displayPublishPanel(XMLElement &$wrapper, $data = null, $flagWithError = null, $fieldnamePrefix = null, $fieldnamePostfix = null, $entry_id = null)
{
if (!$data) {
// TODO: Don't rely on $_POST
if (isset($_POST) && !empty($_POST)) {
$value = 'no';
} elseif ($this->get('default_state') == 'on') {
$value = 'yes';
} else {
$value = 'no';
}
} else {
$value = ($data['value'] === 'yes' ? 'yes' : 'no');
}
$label = Widget::Label();
if ($this->get('required') !== 'yes') {
$label->appendChild(new XMLElement('i', __('Optional')));
}
$input = Widget::Input('fields'.$fieldnamePrefix.'['.$this->get('element_name').']'.$fieldnamePostfix, 'yes', 'checkbox', ($value === 'yes' ? array('checked' => 'checked') : null));
$label->setValue($input->generate(false) . ' ' . $this->get('label'));
if ($flagWithError != null) {
$wrapper->appendChild(Widget::Error($label, $flagWithError));
} else {
$wrapper->appendChild($label);
}
}
public function checkPostFieldData($data, &$message, $entry_id = null)
{
$message = null;
// Check if any value was passed
$has_no_value = is_array($data) ? empty($data) : strlen(trim($data)) == 0;
// Check that the value passed was 'on' or 'yes', if it's not
// then the field has 'no value' in the context of being required. RE: #1569
$has_no_value = ($has_no_value === false) ? !in_array(strtolower($data), array('on', 'yes')) : true;
if ($this->get('required') === 'yes' && $has_no_value) {
$message = __('‘%s’ is a required field.', array($this->get('label')));
return self::__MISSING_FIELDS__;
}
return self::__OK__;
}
public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
{
$status = self::__OK__;
return array(
'value' => (strtolower($data) === 'yes' || strtolower($data) == 'on' || $data === true ? 'yes' : 'no')
);
}
/*-------------------------------------------------------------------------
Output:
-------------------------------------------------------------------------*/
public function appendFormattedElement(XMLElement &$wrapper, $data, $encode = false, $mode = null, $entry_id = null)
{
$value = ($data['value'] === 'yes' ? 'Yes' : 'No');
$wrapper->appendChild(new XMLElement($this->get('element_name'), ($encode ? General::sanitize($value) : $value)));
}
public function prepareTextValue($data, $entry_id = null)
{
return $this->prepareExportValue($data, ExportableField::VALUE, $entry_id);
}
public function getParameterPoolValue(array $data, $entry_id = null)
{
return $this->prepareExportValue($data, ExportableField::POSTDATA, $entry_id);
}
/*-------------------------------------------------------------------------
Import:
-------------------------------------------------------------------------*/
public function getImportModes()
{
return array(
'getValue' => ImportableField::STRING_VALUE,
'getPostdata' => ImportableField::ARRAY_VALUE
);
}
public function prepareImportValue($data, $mode, $entry_id = null)
{
$status = $message = null;
$modes = (object)$this->getImportModes();
$value = $this->processRawFieldData($data, $status, $message, true, $entry_id);
if ($mode === $modes->getValue) {
return $value['value'];
} elseif ($mode === $modes->getPostdata) {
return $value;
}
return null;
}
/*-------------------------------------------------------------------------
Export:
-------------------------------------------------------------------------*/
/**
* Return a list of supported export modes for use with `prepareExportValue`.
*
* @return array
*/
public function getExportModes()
{
return array(
'getBoolean' => ExportableField::BOOLEAN,
'getValue' => ExportableField::VALUE,
'getPostdata' => ExportableField::POSTDATA
);
}
/**
* Give the field some data and ask it to return a value using one of many
* possible modes.
*
* @param mixed $data
* @param integer $mode
* @param integer $entry_id
* @return string|boolean|null
*/
public function prepareExportValue($data, $mode, $entry_id = null)
{
$modes = (object)$this->getExportModes();
// Export unformatted:
if ($mode === $modes->getPostdata) {
return (
isset($data['value'])
? ($data['value'] === 'yes'
? 'yes'
: 'no')
: null
);
// Export formatted:
} elseif ($mode === $modes->getValue) {
return (
isset($data['value'])
? ($data['value'] === 'yes'
? __('Yes')
: __('No'))
: __('None')
);
// Export boolean:
} elseif ($mode === $modes->getBoolean) {
return (
isset($data['value'])
&& $data['value'] === 'yes'
);
}
return null;
}
/*-------------------------------------------------------------------------
Filtering:
-------------------------------------------------------------------------*/
public function displayFilteringOptions(XMLElement &$wrapper)
{
$existing_options = array('yes', 'no');
if (is_array($existing_options) && !empty($existing_options)) {
$optionlist = new XMLElement('ul');
$optionlist->setAttribute('class', 'tags');
$optionlist->setAttribute('data-interactive', 'data-interactive');
foreach ($existing_options as $option) {
$optionlist->appendChild(new XMLElement('li', $option));
}
$wrapper->appendChild($optionlist);
}
}
/**
* @deprecated @since Symphony 3.0.0
* @see Field::buildDSRetrievalSQL()
*/
public function buildDSRetrievalSQL($data, &$joins, &$where, $andOperation = false)
{
if (Symphony::Log()) {
Symphony::Log()->pushDeprecateWarningToLog(
get_called_class() . '::buildDSRetrievalSQL()',
'EntryQueryFieldAdapter::filter()'
);
}
$field_id = $this->get('id');
$default_state = ($this->get('default_state') == "on") ? 'yes' : 'no';
if ($andOperation) {
foreach ($data as $value) {
$this->_key++;
$value = $this->cleanValue($value);
$joins .= "
LEFT JOIN
`tbl_entries_data_{$field_id}` AS t{$field_id}_{$this->_key}
ON (e.id = t{$field_id}_{$this->_key}.entry_id)
";
if ($default_state == $value) {
$where .= "
AND (
t{$field_id}_{$this->_key}.value = '{$value}'
OR
t{$field_id}_{$this->_key}.value IS null
)
";
} else {
$where .= "
AND (t{$field_id}_{$this->_key}.value = '{$value}')
";
}
}
} else {
if (!is_array($data)) {
$data = array($data);
}
foreach ($data as &$value) {
$value = $this->cleanValue($value);
}
$this->_key++;
$data = implode("', '", $data);
$joins .= "
LEFT JOIN
`tbl_entries_data_{$field_id}` AS t{$field_id}_{$this->_key}
ON (e.id = t{$field_id}_{$this->_key}.entry_id)
";
if (strpos($data, $default_state) !== false) {
$where .= "
AND (
t{$field_id}_{$this->_key}.value IN ('{$data}')
OR
t{$field_id}_{$this->_key}.value IS null
)
";
} else {
$where .= "
AND (t{$field_id}_{$this->_key}.value IN ('{$data}'))
";
}
}
return true;
}
/*-------------------------------------------------------------------------
Sorting:
-------------------------------------------------------------------------*/
/**
* @deprecated @since Symphony 3.0.0
* @see Field::buildSortingSQL()
*/
public function buildSortingSQL(&$joins, &$where, &$sort, $order = 'ASC')
{
if (Symphony::Log()) {
Symphony::Log()->pushDeprecateWarningToLog(
get_called_class() . '::buildSortingSQL()',
'EntryQueryFieldAdapter::sort()'
);
}
if ($this->isRandomOrder($order)) {
$sort = 'ORDER BY RAND()';
} else {
$sort = sprintf(
'ORDER BY (
SELECT %s
FROM tbl_entries_data_%d AS `ed`
WHERE entry_id = e.id
) %s, `e`.`id` %s',
'`ed`.value',
$this->get('id'),
$order,
$order
);
}
}
/**
* @deprecated @since Symphony 3.0.0
* @see Field::buildSortingSelectSQL()
*/
public function buildSortingSelectSQL($sort, $order = 'ASC')
{
if (Symphony::Log()) {
Symphony::Log()->pushDeprecateWarningToLog(
get_called_class() . '::buildSortingSelectSQL()',
'EntryQueryFieldAdapter::sort()'
);
}
return null;
}
/*-------------------------------------------------------------------------
Grouping:
-------------------------------------------------------------------------*/
public function groupRecords($records)
{
if (!is_array($records) || empty($records)) {
return;
}
$groups = array($this->get('element_name') => array());
foreach ($records as $r) {
$data = $r->getData($this->get('id'));
$value = $data['value'];
if (!isset($groups[$this->get('element_name')][$value])) {
$groups[$this->get('element_name')][$value] = array(
'attr' => array('value' => $value),
'records' => array(),
'groups' => array()
);
}
$groups[$this->get('element_name')][$value]['records'][] = $r;
}
return $groups;
}
/*-------------------------------------------------------------------------
Events:
-------------------------------------------------------------------------*/
public function getExampleFormMarkup()
{
$label = Widget::Label($this->get('label'));
$label->appendChild(Widget::Input('fields['.$this->get('element_name').']', 'yes', 'checkbox', ($this->get('default_state') == 'on' ? array('checked' => 'checked') : null)));
return $label;
}
}