validator = JModelLegacy::getInstance('ElementValidator', 'FabrikFEModel');
$this->validator->setElementModel($this);
$this->access = new stdClass;
}
/**
* Weed out any non-serializable properties. We only ever get serialized by J!'s cache handler,
* to create the cache ID, so we don't really care about __wake() or not saving all state. We just
* want to avoid the dreaded "serialization of a closure is not allowed", and provide enough propeties
* to guarrantee a unique hash for the cache ID.
*/
public function __sleep() {
$serializable = array();
foreach ($this as $paramName => $paramValue) {
//if (!is_string($paramValue) && !is_array($paramValue) && is_callable($paramValue))
if (!is_numeric($paramValue) && !is_string($paramValue) && !is_array($paramValue))
{
continue;
}
$serializable[] = $paramName;
}
return $serializable;
}
/**
* Method to set the element id
*
* @param int $id element ID number
*
* @return void
*/
public function setId($id)
{
// Set new element ID
$this->id = $id;
}
/**
* Get the element id
*
* @return int element id
*/
public function getId()
{
return $this->id;
}
/**
* Get the element table object
*
* @param bool $force default false - force load the element
*
* @return FabrikTableElement element table
*/
public function &getElement($force = false)
{
if (!$this->element || $force)
{
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_fabrik/tables');
$row = FabTable::getInstance('Element', 'FabrikTable');
$row->load($this->id);
$this->element = $row;
// 3.1 reset the params at the same time. Seems to be required for ajax autocomplete
if ($force)
{
unset($this->params);
$this->getParams();
}
}
return $this->element;
}
/**
* Get parent element
*
* @return object element table
*/
public function getParent()
{
if (!isset($this->parent))
{
$element = $this->getElement();
if ((int) $element->parent_id !== 0)
{
$this->parent = FabTable::getInstance('element', 'FabrikTable');
$this->parent->load($element->parent_id);
}
else
{
$this->parent = $element;
}
}
return $this->parent;
}
/**
* Bind data to the _element variable - if possible we should run one query to get all the forms
* element data and then iterate over that, creating an element plugin for each row
* and bind each record to that plugins _element. This is instead of using getElement() which
* reloads in the element increasing the number of queries run
*
* @param mixed &$row (object or assoc array)
*
* @return object element table
*/
public function bindToElement(&$row)
{
if (!$this->element)
{
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_fabrik/tables');
$this->element = FabTable::getInstance('Element', 'FabrikTable');
}
if (is_object($row))
{
$row = ArrayHelper::fromObject($row);
}
$this->element->bind($row);
return $this->element;
}
/**
* Set the context in which the element occurs
*
* @param FabrikFEModelGroup &$groupModel group model
* @param FabrikFEModelForm &$formModel form model
* @param FabrikFEModelList &$listModel list model
*
* @return void
*/
public function setContext(&$groupModel, &$formModel, &$listModel)
{
// Don't assign these with &= as they already are when passed into the func
$this->group = $groupModel;
$this->form = $formModel;
$this->list = $listModel;
}
/**
* Get the element's fabrik list model
*
* @return FabrikFEModelList list model
*/
public function getListModel()
{
if (is_null($this->list))
{
$groupModel = $this->getGroup();
$this->list = $groupModel->getListModel();
}
return $this->list;
}
/**
* load in the group model
*
* @param int $groupId group id
*
* @return FabrikFEModelGroup group model
*/
public function &getGroup($groupId = null)
{
if (is_null($groupId))
{
$element = $this->getElement();
$groupId = $element->group_id;
}
if (is_null($this->group) || $this->group->getId() != $groupId)
{
$model = JModelLegacy::getInstance('Group', 'FabrikFEModel');
$model->setId($groupId);
$model->getGroup();
$this->group = $model;
}
return $this->group;
}
/**
* Get the elements group model
*
* @param int $group_id If not set uses elements default group id
*
* @return FabrikFEModelGroup group model
*/
public function getGroupModel($group_id = null)
{
return $this->getGroup($group_id);
}
/**
* Set the group model
*
* @param FabrikFEModelGroup $group group model
*
* @since 3.0.6
*
* @return null
*/
public function setGroupModel($group)
{
$this->group = $group;
}
/**
* get the elements form model
*
* @deprecated use getFormModel
*
* @return FabrikFEModelForm Form model
*/
public function getForm()
{
return $this->getFormModel();
}
/**
* get the element's form model
*
* @return FabrikFEModelForm Form model
*/
public function getFormModel()
{
if (is_null($this->form))
{
$listModel = $this->getListModel();
$table = $listModel->getTable();
$this->form = JModelLegacy::getInstance('form', 'FabrikFEModel');
$this->form->setId($table->form_id);
$this->form->getForm();
}
return $this->form;
}
/**
* Set form model
*
* @param FabrikFEModelForm $model form model
*
* @return void
*/
public function setFormModel($model)
{
$this->form = $model;
}
/**
* Shows the RAW list data - can be overwritten in plugin class
*
* @param string $data element data
* @param object $thisRow all the data in the tables current row
*
* @return string formatted value
*/
public function renderRawListData($data, $thisRow)
{
return $data;
}
/**
* replace labels shown in table view with icons (if found)
*
* @param string $data data
* @param string $view list/details
* @param string $tmpl template
*
* @since 3.0 - icon_folder is a bool - search through template folders for icons
*
* @deprecated use replaceWithIcons()
* @return string data
*/
protected function _replaceWithIcons($data, $view = 'list', $tmpl = null)
{
return $this->replaceWithIcons($data, $view, $tmpl);
}
/**
* Replace labels shown in list view with icons (if found)
*
* @param string $data Data
* @param string $view List/details
* @param string $tmpl Template
*
* @since 3.0 - icon_folder is a bool - search through template folders for icons
*
* @return string data
*/
protected function replaceWithIcons($data, $view = 'list', $tmpl = null)
{
if ($data == '')
{
$this->iconsSet = false;
return $data;
}
$params = $this->getParams();
$listModel = $this->getListModel();
$iconFile = (string) $params->get('icon_file', '');
if ((int) $params->get('icon_folder', 0) === 0 && $iconFile === '')
{
$this->iconsSet = false;
return $data;
}
if (in_array($listModel->getOutPutFormat(), array('csv', 'rss')))
{
$this->iconsSet = false;
return $data;
}
$cleanData = empty($iconFile) ? FabrikString::clean(strip_tags($data)) : $iconFile;
$cleanDatas = array($this->getElement()->name . '_' . $cleanData, $cleanData);
$opts = array('forceImage' => true);
//If subdir is set prepend file name with subdirectory (so first search through [template folders]/subdir for icons, e.g. images/subdir)
$iconSubDir = $params->get('icon_subdir', '');
if ($iconSubDir != '')
{
$iconSubDir = rtrim($iconSubDir, '/') . '/';
$iconSubDir = ltrim($iconSubDir, '/');
array_unshift($cleanDatas, $iconSubDir . $cleanData); //search subdir first
}
foreach ($cleanDatas as $cleanData)
{
foreach ($this->imageExtensions as $ex)
{
$img = FabrikHelperHTML::image($cleanData . '.' . $ex, $view, $tmpl, array(), false, $opts);
if ($img !== '')
{
$this->iconsSet = true;
$opts = new stdClass;
$opts->position = 'top';
$opts = json_encode($opts);
$data = '' . $data . ' ';
// See if data has an tag
if (class_exists('DOMDocument'))
{
$html = new DOMDocument;
/**
* The loadXML() chokes if data has & in it. But we can't htmlspecialchar() it, as that removes
* the HTML markup we're looking for. So we need to ONLY change &'s which aren't already part of
* any HTML entities which may be in the data. So use a negative lookahead regex, which finds & followed
* by anything except non-space the ;. Then after doing the loadXML, we have to turn the &s back in
* to &, to avoid double encoding 'cos we're going to do an htmpsepecialchars() on $data in a few lines.
*
* It also chokes if the data already contains any HTML entities which XML doesn't like, like é,
* so first we need to do an html_entity_decode() to get rid of those!
*/
$data = html_entity_decode($data);
$data = preg_replace('/&(?!\S+;)/', '&', $data);
$html->loadXML($data);
$data = str_replace('&', '&', $data);
$as = $html->getElementsBytagName('a');
}
if ($params->get('icon_hovertext', true))
{
$aHref = '#';
$target = '';
if (class_exists('DOMDocument') && $as->length)
{
// Data already has an lets get that for use in hover text
$a = $as->item(0);
$aHref = $a->getAttribute('href');
$target = $a->getAttribute('target');
$target = 'target="' . $target . '"';
}
$data = htmlspecialchars($data, ENT_QUOTES);
$img = ' ' . $img . ' ';
}
elseif (!empty($iconFile))
{
/**
* $$$ hugh - kind of a hack, but ... if this is an upload element, it may already be a link, and
* we'll need to replace the text in the link with the image
* After ages dicking around with a regex to do this, decided to use DOMDocument instead!
*/
if (class_exists('DOMDocument') && $as->length)
{
$img = $html->createElement('img');
$src = FabrikHelperHTML::image($cleanData . '.' . $ex, $view, $tmpl, array(), true, array('forceImage' => true));
$img->setAttribute('src', $src);
$as->item(0)->nodeValue = '';
$as->item(0)->appendChild($img);
return $html->saveHTML();
}
}
return $img;
}
}
}
return $data;
}
/**
* Build the sub query which is used when merging in in repeat element
* records from their joined table into the one field.
* Overwritten in database join element to allow for building the join
* to the table containing the stored values required labels
*
* @param string $jKey key
* @param bool $addAs add 'AS' to select sub query
*
* @return string sub query
*/
public function buildQueryElementConcat($jKey, $addAs = true)
{
$joinTable = $this->getJoinModel()->getJoin()->table_join;
$dbTable = $this->actualTableName();
// Jaanus: joined group pk? set in groupConcactJoinKey()
$pkField = $this->groupConcactJoinKey();
$fullElName = $this->_db->qn($dbTable . '___' . $this->element->name);
$sql = '(SELECT GROUP_CONCAT(' . $jKey . ' SEPARATOR \'' . GROUPSPLITTER . '\') FROM ' . $joinTable . ' WHERE parent_id = '
. $pkField . ')';
if ($addAs)
{
$sql .= ' AS ' . $fullElName;
}
return $sql;
}
/**
* Build the sub query which is used when merging in
* repeat element records from their joined table into the one field.
* Overwritten in database join element to allow for building
* the join to the table containing the stored values required ids
*
* @since 2.1.1
*
* @return string sub query
*/
protected function buildQueryElementConcatRaw()
{
$joinTable = $this->getJoinModel()->getJoin()->table_join;
$dbTable = $this->actualTableName();
$fullElName = $this->_db->qn($dbTable . '___' . $this->element->name . '_raw');
$pkField = $this->groupConcactJoinKey();
return '(SELECT GROUP_CONCAT(id SEPARATOR \'' . GROUPSPLITTER . '\') FROM ' . $joinTable . ' WHERE parent_id = ' . $pkField
. ') AS ' . $fullElName;
}
/**
* Build the sub query which is used when merging in
* repeat element records from their joined table into the one field.
* Overwritten in database join element to allow for building
* the join to the table containing the stored values required ids
*
* @since 2.1.1
*
* @return string sub query
*/
protected function buildQueryElementConcatId()
{
return '';
}
/**
* Used in form model setJoinData.
*
* @since 2.1.1
*
* @return array Element names to search data in to create join data array
*/
public function getJoinDataNames()
{
$name = $this->getFullName(true, false);
$rawName = $name . '_raw';
return array($name, $rawName);
}
/**
* Create the SQL select 'name AS alias' segment for list/form queries
*
* @param array &$aFields array of element names
* @param array &$aAsFields array of 'name AS alias' fields
* @param array $opts options : alias - replace the fullelement name in asfields "name AS
* tablename___elementname"
*
* @return void
*/
public function getAsField_html(&$aFields, &$aAsFields, $opts = array())
{
$dbTable = $this->actualTableName();
$db = FabrikWorker::getDbo();
$table = $this->getListModel()->getTable();
$fullElName = FArrayHelper::getValue($opts, 'alias', $db->qn($dbTable . '___' . $this->element->name));
$fName = $dbTable . '.' . $this->element->name;
$k = $db->qn($fName);
$secret = $this->config->get('secret');
if ($this->encryptMe())
{
$k = 'AES_DECRYPT(' . $k . ', ' . $db->q($secret) . ')';
}
if ($this->isJoin())
{
$jKey = $this->element->name;
if ($this->encryptMe())
{
$jKey = 'AES_DECRYPT(' . $jKey . ', ' . $db->q($secret) . ')';
}
$joinTable = $this->getJoinModel()->getJoin()->table_join;
//$fullElName = FArrayHelper::getValue($opts, 'alias', $k);
$fullElName = FArrayHelper::getValue($opts, 'alias', $fullElName);
$str = $this->buildQueryElementConcat($jKey);
}
else
{
if ($this->calcSelectModifier)
{
$k = $this->calcSelectModifier . '(' . $k . ')';
}
$str = $k . ' AS ' . $fullElName;
}
if ($table->db_primary_key == $fullElName)
{
array_unshift($aFields, $fullElName);
array_unshift($aAsFields, $fullElName);
}
else
{
if (!in_array($str, $aFields))
{
$aFields[] = $str;
$aAsFields[] = $fullElName;
}
$k = $db->qn($dbTable . '.' . $this->element->name);
if ($this->encryptMe())
{
$k = 'AES_DECRYPT(' . $k . ', ' . $db->q($secret) . ')';
}
if ($this->isJoin())
{
$pkField = $this->groupConcactJoinKey();
$str = $this->buildQueryElementConcatRaw();
$aFields[] = $str;
$as = $db->qn($dbTable . '___' . $this->element->name . '_raw');
$aAsFields[] = $as;
$str = $this->buildQueryElementConcatId();
$aFields[] = $str;
$as = $db->qn($dbTable . '___' . $this->element->name . '_id');
$aAsFields[] = $as;
$as = $db->qn($dbTable . '___' . $this->element->name . '___params');
$str = '(SELECT GROUP_CONCAT(params SEPARATOR \'' . GROUPSPLITTER . '\') FROM ' . $joinTable . ' WHERE parent_id = '
. $pkField . ') AS ' . $as;
// Jaanus: joined group pk set in groupConcactJoinKey()
$aFields[] = $str;
$aAsFields[] = $as;
}
else
{
$fullElName = $db->qn($dbTable . '___' . $this->element->name . '_raw');
if ($this->calcSelectModifier)
{
$k = $this->calcSelectModifier . '(' . $k . ')';
}
$str = $k . ' AS ' . $fullElName;
}
if (!in_array($str, $aFields))
{
$aFields[] = $str;
$aAsFields[] = $fullElName;
}
}
}
/**
* OMG! If repeat element inside a repeat group then the group_concat subquery needs to change the key
* it selected on - so it could either be the table pk or the joined groups pk.... :D
*
* @since 3.1rc1
*
* @return string
*/
protected function groupConcactJoinKey()
{
$table = $this->getListModel()->getTable();
if ($this->getGroupModel()->isJoin() && $this->isJoin())
{
$groupJoin = $this->getGroupModel()->getJoinModel()->getJoin();
$pkField = $groupJoin->params->get('pk');
}
else
{
$pkField = $table->db_primary_key;
}
return $pkField;
}
/**
* Get raw column name
*
* @param bool $useStep Use step in name
*
* @return string
*/
public function getRawColumn($useStep = true)
{
$n = $this->getFullName($useStep, false);
$n .= '_raw`';
return $n;
}
/**
* Is the element editable - wrapper for _editable property as 3.1 uses editable
*
* @since 3.0.7
*
* @return bool
*/
public function isEditable()
{
return $this->editable;
}
/**
* Set the element edit state - wrapper for _editable property as 3.1 uses editable
*
* @param bool $editable Is the element editable
*
* @since 3.0.7
*
* @return void
*/
public function setEditable($editable)
{
$this->editable = $editable;
}
/**
* Check user can view the read only element OR view in list view
*
* @param string $view View list/form @since 3.0.7
*
* @return bool can view or not
*/
public function canView($view = 'form')
{
$default = 1;
$key = $view == 'form' ? 'view' : 'listview';
$prop = $view == 'form' ? 'view_access' : 'list_view_access';
$params = $this->getParams();
if (!is_object($this->access) || !array_key_exists($key, $this->access))
{
$groups = $this->user->getAuthorisedViewLevels();
$this->access->$key = in_array($params->get($prop, $default), $groups);
}
// Override with check on lookup element's value = logged in user id.
if ($params->get('view_access_user', '') !== '' && $view == 'form')
{
$formModel = $this->getFormModel();
$data = $formModel->getData();
if (!empty($data) && $this->user->get('id') !== 0)
{
$lookUpId = $params->get('view_access_user', '');
$lookUp = $formModel->getElement($lookUpId, true);
// Could be a linked parent element in which case the form doesn't contain the element whose id is $lookUpId
if (!$lookUp)
{
$lookUp = FabrikWorker::getPluginManager()->getElementPlugin($lookUpId);
}
if ($lookUp)
{
$fullName = $lookUp->getFullName(false, true);
$value = $formModel->getElementData($fullName, true);
$this->access->$key = ($this->user->get('id') == $value) ? true : false;
}
else
{
FabrikWorker::logError('Did not load element ' . $lookUpId . ' for element::canView()', 'error');
}
}
}
return $this->access->$key;
}
/**
* Check if the user can use the active element
* If location is 'list' then we don't check the group canEdit() option - causes inline edit plugin not to work
* when followed by a update_col plugin.
*
* @param string $location To trigger plugin on form/list for elements
* @param string $event To trigger plugin on
*
* @return bool can use or not
*/
public function canUse($location = 'form', $event = null)
{
// Odd! even though defined in initialize() for confirmation plugin access was not set.
if (!isset($this->access))
{
$this->access = new stdClass;
}
if (!is_object($this->access) || !array_key_exists('use', $this->access))
{
/**
* $$$ hugh - testing new "Option 5" for group show, "Always show read only"
* So if element's group show is type 5, then element is de-facto read only.
*/
if ($location !== 'list' && !$this->getGroupModel()->canEdit())
{
$this->access->use = false;
}
else
{
$viewLevel = $this->getElement()->access;
if (!$this->getFormModel()->isNewRecord())
{
$editViewLevel = $this->getParams()->get('edit_access');
if ($editViewLevel)
{
$viewLevel = $editViewLevel;
}
}
$groups = $this->user->getAuthorisedViewLevels();
$this->access->use = in_array($viewLevel, $groups);
// Override with check on lookup element's value = logged in user id.
$params = $this->getParams();
if (!$this->access->use && $params->get('edit_access_user', '') !== '' && $location == 'form')
{
$formModel = $this->getFormModel();
$data = $formModel->getData();
if (!empty($data) && $this->user->get('id') !== 0)
{
$lookUpId = $params->get('edit_access_user', '');
$lookUp = $formModel->getElement($lookUpId, true);
// Could be a linked parent element in which case the form doesn't contain the element whose id is $lookUpId
if (!$lookUp)
{
$lookUp = FabrikWorker::getPluginManager()->getElementPlugin($lookUpId);
}
if ($lookUp)
{
$fullName = $lookUp->getFullName(true, true);
$value = (array) $formModel->getElementData($fullName, true);
$this->access->use = in_array($this->user->get('id'), $value);
}
else
{
FabrikWorker::logError('Did not load element ' . $lookUpId . ' for element::canUse()', 'error');
}
}
}
}
}
return $this->access->use;
}
/**
* Defines if the user can use the filter related to the element
*
* @return bool true if you can use
*/
public function canUseFilter()
{
if (!is_object($this->access) || !array_key_exists('filter', $this->access))
{
$groups = $this->user->getAuthorisedViewLevels();
// $$$ hugh - fix for where certain elements got created with 0 as the
// the default for filter_access, which isn't a legal value, should be 1
$filterAccess = $this->getParams()->get('filter_access');
$filterAccess = $filterAccess == '0' ? '1' : $filterAccess;
$this->access->filter = in_array($filterAccess, $groups);
}
return $this->access->filter;
}
/**
* Set/get if element should record its data in the database
*
* @deprecated - not used
*
* @return bool
*/
public function setIsRecordedInDatabase()
{
return true;
}
/**
* Internal element validation
*
* @param array $data Form data
* @param int $repeatCounter Repeat group counter
*
* @return bool
*/
public function validate($data, $repeatCounter = 0)
{
return true;
}
/**
* Get validation error - run through JText
*
* @return string
*/
public function getValidationErr()
{
return FText::_($this->validationError);
}
/**
* Is the element consider to be empty for purposes of rendering on the form,
* i.e. for assigning classes, etc. Can be overridden by individual elements.
*
* NOTE - this was originally intended for validation, but wound up being used for both validation
* AND rendering. Which doesn't really work, because the $data can be entirely different. Tried
* adding dataConsideredEmptyForValidation() below, but that causes issues where elements don't have
* one, we'd need to go through in one swoop and split them out in every element. So for now, leave this
* as the default which is called in both contexts, BUT the notempty validation checks to see if an
* element model has a dataCOnsideredEmptyForValidation() method and calls that in preference to this
* if it does. We can come back and revisit this issue, as we gradually split out the funcitonality in each
* element type.
*
* @param array $data Data to test against
* @param int $repeatCounter Repeat group #
*
* @return bool
*/
public function dataConsideredEmpty($data, $repeatCounter)
{
return ($data == '') ? true : false;
}
/**
* is the element consider to be empty for validation purposes, on form submit
* Used in isempty validation rule. Split out from dataConsideredEmpty in 3.2
*
* NOTE - see comments on dataConsideredEmpty(), have to hold off on putting this in the main model.
*
* @param array $data Data to test against
* @param int $repeatCounter Repeat group #
*
* @return bool
*
* @since 3.2
*/
/*
public function dataConsideredEmptyForValidation($data, $repeatCounter)
{
return ($data == '') ? true : false;
}
*/
/**
* Get an array of element html ids and their corresponding
* js events which trigger a validation.
* Examples of where this would be overwritten include timedate element with time field enabled
*
* @param int $repeatCounter Repeat group counter
*
* @return array html ids to watch for validation
*/
public function getValidationWatchElements($repeatCounter)
{
$id = $this->getHTMLId($repeatCounter);
$ar = array('id' => $id, 'triggerEvent' => 'blur');
return array($ar);
}
/**
* Manipulates posted form data for insertion into database
*
* @param mixed $val This elements posted form data
* @param array $data Posted form data
*
* @return mixed
*/
public function storeDatabaseFormat($val, $data)
{
if (is_array($val) && count($val) === 1)
{
$val = array_shift($val);
}
if (is_array($val) || is_object($val))
{
return json_encode($val);
}
else
{
return $val;
}
}
/**
* When importing csv data you can run this function on all the data to
* format it into the format that the form would have submitted the date
*
* @param array &$data To prepare
* @param string $key List column heading
* @param bool $isRaw Data is raw
*
* @return array data
*/
public function prepareCSVData(&$data, $key, $isRaw = false)
{
return $data;
}
/**
* Determines if the data in the form element is used when updating a record
*
* @param mixed $val Element form data
*
* @return bool true if ignored on update, default = false
*/
public function ignoreOnUpdate($val)
{
return false;
}
/**
* can be overwritten in add-on class
*
* checks the posted form data against elements INTERNAL validation rule - e.g. file upload size / type
*
* @param array $aErrors Existing errors
* @param object &$groupModel Group model
* @param object &$formModel Form model
* @param array $data Posted data
*
* @deprecated - not used
*
* @return array updated errors
*/
public function validateData($aErrors, &$groupModel, &$formModel, $data)
{
return $aErrors;
}
/**
* Determines the label used for the browser title
* in the form/detail views
*
* @param array $data Form data
* @param int $repeatCounter When repeating joined groups we need to know what part of the array to access
* @param array $opts Options
*
* @return string Text to add to the browser's title
*/
public function getTitlePart($data, $repeatCounter = 0, $opts = array())
{
$titlePart = $this->getValue($data, $repeatCounter, $opts);
return is_array($titlePart) ? implode(', ', $titlePart) : $titlePart;
}
/**
* This really does get just the default value (as defined in the element's settings)
*
* @param array $data Form data
*
* @return mixed
*/
public function getDefaultValue($data = array())
{
if (!isset($this->default))
{
$w = new FabrikWorker;
$element = $this->getElement();
$default = $w->parseMessageForPlaceHolder($element->default, $data);
if ($element->eval == "1" && is_string($default))
{
/**
* Inline edit with a default eval'd "return FabrikHelperElement::filterValue(290);"
* was causing the default to be eval'd twice (no idea y) - add in check for 'return' into eval string
* see http://fabrikar.com/forums/showthread.php?t=30859
*/
if (!stristr($default, 'return'))
{
$this->_default = $default;
}
else
{
FabrikHelperHTML::debug($default, 'element eval default:' . $element->label);
$default = stripslashes($default);
$default = @eval($default);
FabrikWorker::logEval($default, 'Caught exception on eval of ' . $element->name . ': %s');
// Test this does stop error
$this->_default = $default === false ? '' : $default;
}
}
if (is_array($default))
{
foreach ($default as &$d)
{
$d = FText::_($d);
}
$this->default = $default;
}
else
{
$this->default = FText::_($default);
}
}
return $this->default;
}
/**
* Called by form model to build an array of values to encrypt
*
* @param array &$values Previously encrypted values
* @param array $data Form data
* @param int $c Repeat group counter
*
* @return void
*/
public function getValuesToEncrypt(&$values, $data, $c)
{
$name = $this->getFullName(true, false);
$opts = array('raw' => true);
$group = $this->getGroup();
if ($group->canRepeat())
{
if (!array_key_exists($name, $values))
{
$values[$name]['data'] = array();
}
$values[$name]['data'][$c] = $this->getValue($data, $c, $opts);
}
else
{
$values[$name]['data'] = $this->getValue($data, $c, $opts);
}
}
/**
* Element plugin specific method for setting unencrypted values back into post data
*
* @param array &$post Data passed by ref
* @param string $key Key
* @param string $data Elements unencrypted data
*
* @return void
*/
public function setValuesFromEncryt(&$post, $key, $data)
{
FArrayHelper::setValue($post, $key, $data);
FArrayHelper::setValue($_REQUEST, $key, $data);
// $$$rob even though $post is passed by reference - by adding in the value
// we aren't actually modifying the $_POST var that post was created from
$this->app->input->set($key, $data);
}
/**
* Determines the value for the element in the form view
*
* @param array $data Form data
* @param int $repeatCounter When repeating joined groups we need to know what part of the array to access
*
* @return string value
*/
public function getROValue($data, $repeatCounter = 0)
{
return $this->getValue($data, $repeatCounter);
}
/**
* Helper method to get the default value used in getValue()
* For readonly elements:
* If the form is new we need to get the default value
* If the form is being edited we don't want to get the default value
* Otherwise use the 'use_default' value in $opts, defaulting to true
*
* @param array $data Form data
* @param array $opts Options
*
* @since 3.0.7
*
* @return mixed value
*/
protected function getDefaultOnACL($data, $opts)
{
// Rob - 31/10/2012 - if readonly and editing an existing record we don't want to show the default label
if (!$this->isEditable() && FArrayHelper::getValue($data, 'rowid') != 0)
{
$opts['use_default'] = false;
}
/**
* $$$rob - if no search form data submitted for the search element then the default
* selection was being applied instead
* otherwise get the default value so if we don't find the element's value in $data we fall back on this value
*/
return FArrayHelper::getValue($opts, 'use_default', true) == false ? '' : $this->getDefaultValue($data);
}
/**
* Use in list model storeRow() to determine if data should be stored.
* Currently only supported for db join elements whose values are default values
* avoids casing '' into 0 for int fields
*
* @param array $data Data being inserted
* @param mixed $val Element value to insert into table
*
* @since 3.0.7
*
* @return boolean
*/
public function dataIsNull($data, $val)
{
return false;
}
/**
* Determines the value for the element in the form view
*
* @param array $data Form data
* @param int $repeatCounter When repeating joined groups we need to know what part of the array to access
* @param array $opts Options, 'raw' = 1/0 use raw value
*
* @return string value
*/
public function getValue($data, $repeatCounter = 0, $opts = array())
{
$input = $this->app->input;
if (!isset($this->defaults))
{
$this->defaults = array();
}
$key = $repeatCounter . '.' . serialize($opts);
if (!array_key_exists($key, $this->defaults))
{
$groupRepeat = $this->getGroupModel()->canRepeat();
$default = $this->getDefaultOnACL($data, $opts);
$name = $this->getFullName(true, false);
if (FArrayHelper::getValue($opts, 'raw', 0) == 1)
{
$name .= '_raw';
}
/**
* @FIXME - if an element is NULL in the table, we will be applying the default even if this
* isn't a new form. Probaby needs to be a global option, although not entirely sure what
* we would set it to ...
*/
$values = FArrayHelper::getValue($data, $name, $default);
// Querystring override (seems on http://fabrikar.com/subscribe/form/22 querystring var was not being set into $data)
if (FArrayHelper::getValue($opts, 'use_querystring', false))
{
if ((is_array($values) && empty($values)) || $values === '')
{
// Trying to avoid errors if value is an array
$values = $input->get($name, null, 'array');
if (is_null($values) || (count($values) === 1 && $values[0] == ''))
{
$values = $input->get($name, '', 'string');
}
}
}
if ($groupRepeat)
{
// Weird bug where stdClass with key 0, when cast to (array) you couldn't access values[0]
if (is_object($values))
{
$values = ArrayHelper::fromObject($values);
}
if (!is_array($values))
{
$values = (array) $values;
}
$values = FArrayHelper::getValue($values, $repeatCounter, '');
}
if (FArrayHelper::getValue($opts, 'runplugins', false))
{
$formModel = $this->getFormModel();
FabrikWorker::getPluginManager()->runPlugins('onGetElementDefault', $formModel, 'form', $this);
}
$this->defaults[$key] = $values;
}
return $this->defaults[$key];
}
/**
* Is the element hidden or not - if not set then return false
*
* @return bool
*/
public function isHidden()
{
$element = $this->getElement();
return ($element->hidden == true) ? true : false;
}
/**
* Used in things like date when its id is suffixed with _cal
* called from getLabel();
*
* @param string &$id Initial id
*
* @return void
*/
protected function modHTMLId(&$id)
{
}
/**
* Should the element be tipped?
*
* @param string $mode Form/list render context
*
* @since 3.0.6
*
* @return bool
*/
private function isTipped($mode = 'form')
{
$formModel = $this->getFormModel();
if ($formModel->getParams()->get('tiplocation', 'tip') !== 'tip' && $mode === 'form')
{
return false;
}
$params = $this->getParams();
if ($params->get('rollover', '') === '')
{
return false;
}
if ($mode == 'form' && (!$formModel->isEditable() && $params->get('labelindetails', true) == false))
{
return false;
}
if ($mode === 'list' && $params->get('labelinlist', false) == false)
{
return false;
}
return true;
}
/**
* Get list heading label
*
* @return string
*/
public function getListHeading()
{
$params = $this->getParams();
$element = $this->getElement();
$label = $params->get('alt_list_heading') == '' ? $element->label : $params->get('alt_list_heading');
return FText::_($label);
}
/**
* Get the element's HTML label
*
* @param int $repeatCounter Group repeat counter
* @param string $tmpl Form template
*
* @return string label
*/
public function getLabel($repeatCounter, $tmpl = '')
{
$element = $this->getElement();
$this->modHTMLId($elementHTMLId);
$model = $this->getFormModel();
$displayData = new stdClass;
$displayData->canView = $this->canView();
$displayData->id = $this->getHTMLId($repeatCounter);
$displayData->canUse = $this->canUse();
$displayData->j3 = FabrikWorker::j3();
$displayData->hidden = $this->isHidden();
$displayData->label = FText::_($element->label);
$displayData->hasLabel = $this->get('hasLabel');
$displayData->view = $this->app->input->get('view', 'form');
$displayData->tip = $this->tipHtml($model->data);
$displayData->tipText = $this->tipTextAndValidations('form', $model->data);
$displayData->rollOver = $this->isTipped();
$displayData->isEditable = $this->isEditable();
$displayData->tipOpts = $this->tipOpts();
$labelClass = '';
if ($displayData->canView || $displayData->canUse)
{
$labelClass = 'fabrikLabel control-label';
if (empty($displayData->label))
{
$labelClass .= ' fabrikEmptyLabel';
}
if ($displayData->rollOver)
{
$labelClass .= ' fabrikHover';
}
if ($displayData->hasLabel && !$displayData->hidden)
{
if ($displayData->tip !== '')
{
$labelClass .= ' fabrikTip';
}
}
}
$displayData->icons = '';
$iconOpts = array('icon-class' => 'small');
if ($displayData->rollOver)
{
$displayData->icons .= FabrikHelperHTML::image('question-sign', 'form', $tmpl, $iconOpts) . ' ';
}
if ($displayData->isEditable)
{
$displayData->icons .= $this->validator->labelIcons();
}
$displayData->labelClass = $labelClass;
$layout = FabrikHelperHTML::getLayout('fabrik-element-label', $this->labelPaths());
$str = $layout->render($displayData);
return $str;
}
/**
* Get an array of paths to look for the element template.
*
* @return array
*/
protected function labelPaths()
{
$basePath = COM_FABRIK_BASE . 'components/com_fabrik/layouts/element';
$pluginPath = COM_FABRIK_BASE . '/plugins/fabrik_element/' . $this->getPluginName() . '/layouts';
$perThemePath = JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts/com_fabrik/element';
$perElementPath = JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts/com_fabrik/element/' . $this->getFullName(true, false);
return array($basePath, $pluginPath, $perThemePath, $perElementPath);
}
/**
* Set fabrikErrorMessage div with potential error messages
*
* @param int $repeatCounter repeat counter
* @param string $tmpl template
*
* @return string
*/
protected function addErrorHTML($repeatCounter, $tmpl = '')
{
$err = $this->getErrorMsg($repeatCounter);
$err = htmlspecialchars($err, ENT_QUOTES);
$layout = FabrikHelperHTML::getLayout('element.fabrik-element-error');
$displayData = new stdClass;
$displayData->err = $err;
$displayData->tmpl = $tmpl;
return $layout->render($displayData);
}
/**
* Add tips on element labels
* does ACL check on element's label in details setting
*
* @param string $txt Label
* @param array $data Row data
* @param string $mode Form/list render context
*
* @return string Label with tip
*/
protected function rollover_old($txt, $data = array(), $mode = 'form')
{
if (is_object($data))
{
$data = ArrayHelper::fromObject($data);
}
$rollOver = $this->tipHtml($data, $mode);
return $rollOver !== '' ? '' . $txt . ' ' : $txt;
}
/**
* Add tips on element labels
* does ACL check on element's label in details setting
*
* @param string $txt Label
* @param array $data Row data
* @param string $mode Form/list render context
*
* @return string Label with tip
*/
protected function rollover($txt, $data = array(), $mode = 'form')
{
if (is_object($data))
{
$data = ArrayHelper::fromObject($data);
}
//$title = $this->tipTextAndValidations($mode, $data);
//$opts = $this->tipOpts();
//$opts = json_encode($opts);
//return $title !== '' ? 'title="' . $title . '" opts=\'' . $opts . '\'' : '';
$layout = FabrikHelperHTML::getLayout('element.fabrik-element-tip');
$displayData = new stdClass;
$displayData->tipTitle = $this->tipTextAndValidations($mode, $data);
$displayData->tipText = $txt;
$displayData->rollOver = $this->isTipped();
$displayData->isEditable = $this->isEditable();
$displayData->tipOpts = $this->tipOpts();
$rollOver = $layout->render($displayData);
return $rollOver;
}
/**
* Get the hover tip options
*
* @return stdClass
*/
protected function tipOpts()
{
$params = $this->getParams();
$opts = new stdClass;
$pos = $params->get('tiplocation', 'top');
$opts->formTip = true;
$opts->position = $pos;
$opts->trigger = 'hover';
$opts->notice = true;
if ($this->editable)
{
if ($this->validator->hasValidations())
{
$opts->heading = FText::_('COM_FABRIK_VALIDATION');
}
}
return $opts;
}
/**
* Get Hover tip text and validation text
*
* @param string $mode View mode form/list
* @param array $data Model data
*
* @return string
*/
protected function tipTextAndValidations($mode, $data = array())
{
$lines = array();
$tmpl = $this->getFormModel()->getTmpl();
if (($mode === 'list' || !$this->validator->hasValidations()) && !$this->isTipped($mode))
{
return '';
}
$lines[] = '';
if ($this->isTipped($mode))
{
$lines[] = '' . FabrikHelperHTML::image('question-sign', 'form', $tmpl) . ' ' . $this->getTipText($data) . ' ';
}
if ($mode === 'form')
{
$validationTexts = $this->validator->hoverTexts();
foreach ($validationTexts as $validationText)
{
$lines[] = '' . $validationText . ' ';
}
}
if (count($lines) > 0)
{
$lines[] = ' ';
}
$lines = array_unique($lines);
$rollOver = implode('', $lines);
// $$$ rob - looks like htmlspecialchars is needed otherwise invalid markup created and pdf output issues.
$rollOver = htmlspecialchars($rollOver, ENT_QUOTES);
//$rollOver = str_replace('"', '"', $rollOver);
return $rollOver;
}
/**
* Get the element tip HTML
*
* @param array $data to use in parse holders - defaults to form's data
*
* @return string tip HTML
*/
protected function getTipText($data = null)
{
if (is_null($data))
{
$data = $this->getFormModel()->data;
}
$model = $this->getFormModel();
$params = $this->getParams();
if (!$model->isEditable() && !$params->get('labelindetails'))
{
return '';
}
$w = new FabrikWorker;
$tip = $w->parseMessageForPlaceHolder($params->get('rollover'), $data);
if ($params->get('tipseval'))
{
if (FabrikHelperHTML::isDebug())
{
$res = eval($tip);
}
else
{
$res = @eval($tip);
}
FabrikWorker::logEval($res, 'Caught exception (%s) on eval of ' . $this->getElement()->name . ' tip: ' . $tip);
$tip = $res;
}
$tip = FText::_($tip);
return $tip;
}
/**
* Used for the name of the filter fields
* For element this is an alias of getFullName()
* Overridden currently only in databasejoin class
*
* @return string element filter name
*/
public function getFilterFullName()
{
return FabrikString::safeColName($this->getFullName(true, false));
}
/**
* Get the field name to use in the list's slug url
*
* @param bool $raw raw
*
* @since 3.0.6
*
* @return string element slug name
*/
public function getSlugName($raw = false)
{
return $this->getFilterFullName();
}
/**
* Set and override element full name (used in pw element)
*
* @param string $name Element name
* @param bool $useStep Concat name with form's step element (true) or with '.' (false) default true
* @param bool $incRepeatGroup Include '[]' at the end of the name (used for repeat group elements) default true
*
* @return void
*/
public function setFullName($name = '', $useStep = true, $incRepeatGroup = true)
{
$groupModel = $this->getGroup();
$formModel = $this->getFormModel();
$element = $this->getElement();
$key = $element->id . '.' . $groupModel->get('id') . '_' . $formModel->getId() . '_' . $useStep . '_'
. $incRepeatGroup;
$this->fullNames[$key] = $name;
}
/**
* If already run then stored value returned
*
* @param bool $useStep Concat name with form's step element (true) or with '.' (false) default true
* @param bool $incRepeatGroup Include '[]' at the end of the name (used for repeat group elements) default true
*
* @return string element full name
*/
public function getFullName($useStep = true, $incRepeatGroup = true)
{
$groupModel = $this->getGroup();
$formModel = $this->getFormModel();
$listModel = $this->getListModel();
$element = $this->getElement();
$key = $element->id . '.' . $groupModel->get('id') . '_' . $formModel->getId() . '_' . $useStep . '_'
. $incRepeatGroup;
if (isset($this->fullNames[$key]))
{
return $this->fullNames[$key];
}
$table = $listModel->getTable();
$db_table_name = $table->db_table_name;
$thisStep = ($useStep) ? $formModel->joinTableElementStep : '.';
if ($groupModel->isJoin())
{
$joinModel = $groupModel->getJoinModel();
$join = $joinModel->getJoin();
$fullName = $join->table_join . $thisStep . $element->name;
}
else
{
$fullName = $db_table_name . $thisStep . $element->name;
}
if ($groupModel->canRepeat() == 1 && $incRepeatGroup)
{
$fullName .= '[]';
}
$this->fullNames[$key] = $fullName;
return $fullName;
}
/**
* Get order by full name
*
* @param bool $useStep Concat name with form's step element (true) or with '.' (false) default true
*
* @return string Order by full name
*/
public function getOrderbyFullName($useStep = true)
{
return $this->getFullName($useStep);
}
/**
* When copying elements from an existing table
* once a copy of all elements has been made run them through this method
* to ensure that things like watched element id's are updated
*
* @param array $newElements copied element ids (keyed on original element id)
*
* @return void
*/
public function finalCopyCheck($newElements)
{
// Overwritten in element class
}
/**
* Copy an element table row
*
* @param int $id Element id to copy
* @param string $copyText Feedback msg
* @param int $groupId Group model id
* @param string $name New element name
*
* @return mixed Error or new row
*/
public function copyRow($id, $copyText = 'Copy of %s', $groupId = null, $name = null)
{
/** @var FabrikTableElement $rule */
$rule = FabTable::getInstance('Element', 'FabrikTable');
$rule->load((int) $id);
$rule->id = null;
$rule->label = sprintf($copyText, $rule->label);
if (!is_null($groupId))
{
$rule->group_id = $groupId;
}
if (!is_null($name))
{
$rule->name = $name;
}
$groupModel = JModelLegacy::getInstance('Group', 'FabrikFEModel');
$groupModel->setId($groupId);
$groupListModel = $groupModel->getListModel();
// $$$ rob - if its a joined group then it can have the same element names
if ((int) $groupModel->getGroup()->is_join === 0)
{
if ($groupListModel->fieldExists($rule->name, array(), $groupModel))
{
$this->app->enqueueMessage(FText::_('COM_FABRIK_ELEMENT_NAME_IN_USE'), 'error');
return false;
}
}
$date = $this->date;
$tz = new DateTimeZone($this->app->get('offset'));
$date->setTimezone($tz);
$rule->created = $date->toSql();
$params = $rule->params == '' ? new stdClass : json_decode($rule->params);
$params->parent_linked = 1;
$rule->params = json_encode($params);
$rule->parent_id = $id;
$config = JComponentHelper::getParams('com_fabrik');
if ($config->get('unpublish_clones', false))
{
$rule->published = 0;
}
$rule->store();
/**
* I thought we did this in an overridden element model method, like onCopy?
* if its a database join then add in a new join record
*/
if (is_a($this, 'PlgFabrik_ElementDatabasejoin'))
{
$join = FabTable::getInstance('Join', 'FabrikTable');
$join->load(array('element_id' => $id));
$join->id = null;
$join->element_id = $rule->id;
$join->group_id = $rule->group_id;
$join->store();
}
// Copy js events
$db = FabrikWorker::getDbo(true);
$query = $db->getQuery(true);
$query->select('id')->from('#__{package}_jsactions')->where('element_id = ' . (int) $id);
$db->setQuery($query);
$actions = $db->loadColumn();
foreach ($actions as $id)
{
$jsCode = FabTable::getInstance('Jsaction', 'FabrikTable');
$jsCode->load($id);
$jsCode->id = 0;
$jsCode->element_id = $rule->id;
$jsCode->store();
}
return $rule;
}
/**
* Get the element's raw label (used for details view, not wrapped in tags
*
* @return string Label
*/
protected function getRawLabel()
{
return $this->element->label;
}
/**
* This was in the views display and _getElement code but seeing as its used
* by multiple views its safer to have it here
*
* @param int $c Repeat group counter
* @param int $elCount Order in which the element is shown in the form
* @param string $tmpl Template
*
* @return mixed - false if you shouldn't continue to render the element
*/
public function preRender($c, $elCount, $tmpl)
{
$model = $this->getFormModel();
$groupModel = $this->getGroup();
$group = $groupModel->getGroupProperties($model);
if (!$this->canUse() && !$this->canView())
{
return false;
}
if (!$this->canUse())
{
$this->setEditable(false);
}
else
{
$editable = $model->isEditable() ? true : false;
$this->setEditable($editable);
}
// Force reload?
$this->HTMLids = null;
$elementTable = $this->getElement();
$element = new stdClass;
$element->startRow = 0;
$element->endRow = 0;
$elHTMLName = $this->getFullName();
// If the element is in a join AND is the join's foreign key then we don't show the element
if ($elementTable->name == $this->_foreignKey)
{
$element->label = '';
$element->error = '';
$this->element->hidden = true;
}
else
{
$element->error = $this->getErrorMsg($c);
}
$element->plugin = $elementTable->plugin;
$element->hidden = $this->isHidden();
$element->id = $this->getHTMLId($c);
$element->className = 'fb_el_' . $element->id;
$element->containerClass = $this->containerClass($element);
$element->element = $this->preRenderElement($model->data, $c);
// Ensure that view data property contains the same html as the group's element
$model->tmplData[$elHTMLName] = $element->element;
$element->label_raw = FText::_($this->getRawLabel());
// GetLabel needs to know if the element is editable
if ($elementTable->name != $this->_foreignKey)
{
$l = $this->getLabel($c, $tmpl);
$w = new FabrikWorker;
$element->label = $w->parseMessageForPlaceHolder($l, $model->data);
}
$element->errorTag = $this->addErrorHTML($c, $tmpl);
$element->element_ro = $this->getROElement($model->data, $c);
$element->value = $this->getValue($model->data, $c);
$elName = $this->getFullName(true, false);
if (array_key_exists($elName . '_raw', $model->data))
{
$element->element_raw = $model->data[$elName . '_raw'];
}
else
{
$element->element_raw = array_key_exists($elName, $model->data) ? $model->data[$elName] : $element->value;
}
if ($this->dataConsideredEmpty($element->element_ro, $c))
{
$element->containerClass .= ' fabrikDataEmpty';
$element->dataEmpty = true;
}
else
{
$element->dataEmpty = false;
}
// Tips (if not rendered as hovers)
$tip = $this->getTipText();
if ($tip !== '')
{
$tip = FabrikHelperHTML::image('question-sign', 'form', $tmpl) . ' ' . $tip;
}
$element->labels = $groupModel->labelPosition('form');
$element->dlabels = $groupModel->labelPosition('details');
switch ($model->getParams()->get('tiplocation'))
{
default:
case 'tip':
$element->tipAbove = '';
$element->tipBelow = '';
$element->tipSide = '';
break;
case 'above':
$element->tipAbove = $tip;
$element->tipBelow = '';
$element->tipSide = '';
break;
case 'below':
$element->tipAbove = '';
$element->tipBelow = $tip;
$element->tipSide = '';
break;
case 'side':
$element->tipAbove = '';
$element->tipBelow = '';
$element->tipSide = $tip;
break;
}
return $element;
}
/**
* Build the tip HTML
*
* @param array $data Data
* @param string $mode Mode Form/List
*
* @return string
*/
protected function tipHtml($data = array(), $mode = 'form')
{
$title = $this->tipTextAndValidations($mode, $data);
$opts = $this->tipOpts();
$opts = json_encode($opts);
return $title !== '' ? 'title="' . $title . '" opts=\'' . $opts . '\'' : '';
}
/**
* Get the class name for the element wrapping dom object
*
* @param object $element element row
*
* @since 3.0
*
* @return string class names
*/
protected function containerClass($element)
{
$item = $this->getElement();
$c = array('fabrikElementContainer', 'plg-' . $item->plugin, $element->className);
if ($element->hidden)
{
$c[] = 'fabrikHide';
}
else
{
/**
* $$$ hugh - adding a class name for repeat groups, as per:
* http://fabrikar.com/forums/showthread.php?p=165128#post165128
* But as per my response on that thread, if this turns out to be a performance
* hit, may take it out. That said, I think having this class will make things
* easier for custom styling when the element ID isn't constant.
*/
$groupModel = $this->getGroupModel();
if ($groupModel->canRepeat())
{
$c[] = 'fabrikRepeatGroup___' . $this->getFullName(true, false);
}
}
if ($element->error != '')
{
$c[] = 'fabrikError';
}
$c[] = $this->getParams()->get('containerclass');
return implode(' ', $c);
}
/**
* Merge the rendered element into the views element storage arrays
*
* @param object $element to merge
* @param array &$aElements element array
* @param array &$namedData Form data
* @param array &$aSubGroupElements sub group element array
*
* @return void
*/
public function stockResults($element, &$aElements, &$namedData, &$aSubGroupElements)
{
$elHTMLName = $this->getFullName();
$aElements[$this->getElement()->name] = $element;
/**
* $$$ rob 12/10/2012 - $namedData is the formModels data - commenting out as the form data needs to be consistent
* as we loop over elements - this was setting from a string to an object ?!!!???!!
* $namedData[$elHTMLName] = $element;
*/
if ($elHTMLName)
{
// $$$ rob was keyed on int but that's not very useful for templating
$aSubGroupElements[$this->getElement()->name] = $element;
}
}
/**
* Pre-render just the element (no labels etc.)
* Was _getElement but this was ambiguous with getElement() and method is public
*
* @param array $data data
* @param int $repeatCounter repeat group counter
*
* @return string
*/
public function preRenderElement($data, $repeatCounter = 0)
{
$groupModel = $this->getGroupModel();
if (!$this->canView() && !$this->canUse())
{
return '';
}
// Used for working out if the element should behave as if it was in a new form (joined grouped) even when editing a record
$this->inRepeatGroup = $groupModel->canRepeat();
$this->_inJoin = $groupModel->isJoin();
$opts = array('runplugins' => 1);
$this->getValue($data, $repeatCounter, $opts);
if ($this->isEditable())
{
return $this->render($data, $repeatCounter);
}
else
{
$htmlId = $this->getHTMLId($repeatCounter);
// $$$ rob even when not in ajax mode the element update() method may be called in which case we need the span
// $$$ rob changed from span wrapper to div wrapper as element's content may contain divs which give html error
// Placeholder to be updated by ajax code
$v = $this->getROElement($data, $repeatCounter);
//$v = $v == '' ? ' ' : $v;
return '' . $v . '
';
}
}
/**
* Get read-only element
* Was _getROElement() but is a public method
*
* @param array $data data
* @param int $repeatCounter repeat group counter
*
* @return string
*/
public function getROElement($data, $repeatCounter = 0)
{
if (!$this->canView() && !$this->canUse())
{
return '';
}
$editable = $this->isEditable();
$this->setEditable(false);
$v = $this->render($data, $repeatCounter);
$this->addCustomLink($v, $data, $repeatCounter);
$this->setEditable($editable);
return $v;
}
/**
* Add custom link to element - must be uneditable for link to be added
*
* @param string &$v value
* @param array $data row data
* @param int $repeatCounter repeat counter
*
* @return string
*/
protected function addCustomLink(&$v, $data, $repeatCounter = 0)
{
if ($this->isEditable())
{
return $v;
}
$params = $this->getParams();
$customLink = $params->get('custom_link', '');
if ($customLink !== '' && $this->getElement()->link_to_detail == '1' && $params->get('custom_link_indetails', true))
{
$w = new FabrikWorker;
/**
* $$$ hugh - this should really happen elsewhere, but I needed a quick fix for handling
* {slug} in detail view links, which for some reason are not 'stringURLSafe' at this point,
* so they are like "4:A Page Title" instead of 4-a-page-title.
*/
if (strstr($customLink, '{slug}') && array_key_exists('slug', $data))
{
$slug = str_replace(':', '-', $data['slug']);
$slug = JApplicationHelper::stringURLSafe($slug);
$customLink = str_replace('{slug}', $slug, $customLink);
}
/**
* Testing new parseMessageForRepeats(), see comments on the function itself.
*/
$customLink = $w->parseMessageForRepeats($customLink, $data, $this, $repeatCounter);
$customLink = $w->parseMessageForPlaceHolder($customLink, $data);
$customLink = $this->getListModel()->parseMessageForRowHolder($customLink, $data);
if (trim($customLink) !== '')
{
$v = '' . $v . ' ';
}
}
return $v;
}
/**
* Get any html error messages
*
* @param int $repeatCount group repeat count
*
* @return string error messages
*/
protected function getErrorMsg($repeatCount = 0)
{
$arErrors = $this->getFormModel()->errors;
$parsed_name = $this->getFullName();
$err_msg = '';
$parsed_name = FabrikString::rtrimword($parsed_name, '[]');
if (isset($arErrors[$parsed_name]))
{
if (array_key_exists($repeatCount, $arErrors[$parsed_name]))
{
if (is_array($arErrors[$parsed_name][$repeatCount]))
{
$err_msg = implode('' . FText::_('COM_FABRIK_BETWEEN') . ' ';
$return[] = JHTML::_('select.genericlist', $rows, $v . '[0]', $attributes, 'value', 'text', $def0, $element->name . '_filter_range_0');
$return[] = '' . FText::_('COM_FABRIK_AND') . ' ';
$return[] = JHTML::_('select.genericlist', $rows, $v . '[1]', $attributes, 'value', 'text', $def1, $element->name . '_filter_range_1');
}
else
{
$return[] = '' : '';
$l = '' . $calcLabel . ' ';
$res[] = $split ? '' . $l . ' ' : '' . $l;
$format = $this->getFormatString();
$label = $this->getListHeading();
foreach ($results as $key => $o)
{
$o->label = ($o->label == 'calc') ? '' : $o->label;
$o->elLabel = $label . ' ' . $o->label;
if ($numberFormat)
{
$o->value = $this->numberFormat($o->value);
}
if ($format != '' && $sprintFFormat)
{
$o->value = sprintf($format, $o->value);
}
$o->calLabel = $calcLabel;
$class = isset($o->class) ? ' class="' . $o->class . '"' : '';
if ($split)
{
$res[] = '' . $o->label . ': ' . $o->value . '';
}
else
{
$res[] = $o->value . ' ';
}
}
ksort($results);
$res[] = $split ? ' ' : '';
return implode("\n", $res);
}
/**
* Get median
*
* @param array $results set of results to get median from
*
* @return string median value
*/
private function _median($results)
{
$results = (array) $results;
sort($results);
if ((count($results) % 2) == 1)
{
/* odd */
$midKey = floor(count($results) / 2);
return $results[$midKey];
}
else
{
$midKey = floor(count($results) / 2) - 1;
$midKey2 = floor(count($results) / 2);
return $this->simpleAvg(array(FArrayHelper::getValue($results, $midKey), FArrayHelper::getValue($results, $midKey2)));
}
}
/**
* Returns javascript which creates an instance of the class defined in formJavascriptClass()
*
* @param int $repeatCounter Repeat group counter
*
* @return array
*/
public function elementJavascript($repeatCounter)
{
return array();
}
/**
* Get JS code for ini element list js
* Overwritten in plugin classes
*
* @return string
*/
public function elementListJavascript()
{
return '';
}
/**
* Create a class for the elements default javascript options
*
* @param int $repeatCounter repeat group counter
*
* @return object options
*/
public function getElementJSOptions($repeatCounter)
{
$element = $this->getElement();
$opts = new stdClass;
$data = $this->getFormModel()->data;
$opts->repeatCounter = $repeatCounter;
$opts->editable = ($this->canView() && !$this->canUse()) ? false : $this->isEditable();
$opts->value = $this->getValue($data, $repeatCounter);
$opts->label = $element->label;
$opts->defaultVal = $this->getDefaultValue($data);
$opts->inRepeatGroup = $this->getGroup()->canRepeat() == 1;
$opts->fullName = $this->getFullName(true, false);
$opts->watchElements = $this->validator->jsWatchElements($repeatCounter);
$groupModel = $this->getGroup();
$opts->canRepeat = (bool) $groupModel->canRepeat();
$opts->isGroupJoin = (bool) $groupModel->isJoin();
$validations = $this->validator->findAll();
$opts->mustValidate = false;
foreach ($validations as $validation)
{
$validationParams = $validation->getParams();
if ($validationParams->get('must_validate', '0') === '1')
{
if ($validation->canValidate())
{
$opts->mustValidate = true;
break;
}
}
}
$opts->validations = empty($validations) ? false : true;
if ($this->isJoin())
{
$opts->joinid = (int) $this->getJoinModel()->getJoin()->id;
}
else
{
$opts->joinid = (int) $groupModel->getGroup()->join_id;
}
return $opts;
}
/**
* Does the element use the WYSIWYG editor
*
* @return bool use wysiwyg editor
*/
public function useEditor()
{
return false;
}
/**
* Processes uploaded data
*
* @return void
*/
public function processUpload()
{
}
/**
* Get the class to manage the form element
* to ensure that the file is loaded only once
*
* @param array &$srcs Scripts previously loaded
* @param string $script Script to load once class has loaded
* @param array &$shim Dependant class names to load before loading the class - put in requirejs.config shim
*
* @return void
*/
public function formJavascriptClass(&$srcs, $script = '', &$shim = array())
{
$name = $this->getElement()->plugin;
$ext = FabrikHelperHTML::isDebug() ? '.js' : '-min.js';
$formId = $this->getFormModel()->getId();
static $elementClasses;
if (!isset($elementClasses))
{
$elementClasses = array();
}
if (!array_key_exists($formId, $elementClasses))
{
$elementClasses[$formId] = array();
}
// Load up the default script
if ($script == '')
{
$script = 'plugins/fabrik_element/' . $name . '/' . $name . $ext;
}
if (empty($elementClasses[$formId][$script]))
{
$srcs['Element' . ucfirst($name)] = $script;
$elementClasses[$formId][$script] = 1;
}
}
/**
* load js file for element when in list view
*
* @param array &$srcs JS scripts to load
*
* @return null
*/
public function tableJavascriptClass(&$srcs)
{
$p = $this->getElement()->plugin;
$src = 'plugins/fabrik_element/' . $p . '/list-' . $p . '.js';
if (JFile::exists(JPATH_SITE . '/' . $src))
{
$className = 'Fb' . ucfirst($p) .'List';
$srcs[$className] = $src;
}
}
/**
* Can be overwritten in plugin classes
* e.g. if changing from db join to field we need to remove the join
* entry from the #__{package}_joins table
*
* @param object &$row that is going to be updated
*
* @return null
*/
public function beforeSave(&$row)
{
$safeHtmlFilter = JFilterInput::getInstance(null, null, 1, 1);
$post = $safeHtmlFilter->clean($_POST, 'array');
$post = $post['jform'];
$dbjoinEl = (is_subclass_of($this, 'PlgFabrik_ElementDatabasejoin') || get_class($this) == 'PlgFabrik_ElementDatabasejoin');
/**
* $$$ hugh - added test for empty id, i.e. new element, otherwise we try and delete a crap load of join table rows
* we shouldn't be deleting! Also adding defensive code to deleteJoins() to test for empty ID.
*/
if (!empty($post['id']) && !$this->isJoin() && !$dbjoinEl)
{
$this->deleteJoins((int) $post['id']);
}
}
/**
* Delete joins
*
* @param int $id element id
*
* @return null
*/
protected function deleteJoins($id)
{
// $$$ hugh - bail if no $id specified
if (empty($id))
{
return;
}
$db = FabrikWorker::getDbo(true);
$query = $db->getQuery(true);
$query->delete('#__{package}_joins')->where('element_id = ' . $id);
$db->setQuery($query);
$db->execute();
$query->clear();
$query->select('j.id AS jid')->from('#__{package}_elements AS e')->join('INNER', ' #__{package}_joins AS j ON j.element_id = e.id')
->where('e.parent_id = ' . $id);
$db->setQuery($query);
$join_ids = $db->loadColumn();
if (!empty($join_ids))
{
$query->clear();
$query->delete('#__{package}_joins')->where('id IN (' . implode(',', $join_ids) . ')');
$db->setQuery($query);
$db->execute();
}
}
/**
* If your element risks not to post anything in the form (e.g. check boxes with none checked)
* the this function will insert a default value into the database
*
* @param array &$data form data
*
* @return array form data
*/
public function getEmptyDataValue(&$data)
{
}
/**
* Used to format the data when shown in the form's email
*
* @param mixed $value element's data
* @param array $data form records data
* @param int $repeatCounter repeat group counter
*
* @return string formatted value
*/
public function getEmailValue($value, $data = array(), $repeatCounter = 0)
{
if ($this->inRepeatGroup && is_array($value))
{
$val = array();
foreach ($value as $v2)
{
$val[] = $this->getIndEmailValue($v2, $data, $repeatCounter);
}
}
else
{
$val = $this->getIndEmailValue($value, $data, $repeatCounter);
}
return $val;
}
/**
* Turn form value into email formatted value
*
* @param mixed $value Element value
* @param array $data Form data
* @param int $repeatCounter Group repeat counter
*
* @return string email formatted value
*/
protected function getIndEmailValue($value, $data = array(), $repeatCounter = 0)
{
return $value;
}
/**
* Is the element an upload element
*
* @return boolean
*/
public function isUpload()
{
return $this->is_upload;
}
/**
* If a database join element's value field points to the same db field as this element
* then this element can, within modifyJoinQuery, update the query.
* E.g. if the database join element points to a file upload element then you can replace
* the file path that is the standard $val with the html to create the image
*
* @param string $val value
* @param string $view form or list
*
* @deprecated - doesn't seem to be used
*
* @return string modified val
*/
protected function modifyJoinQuery($val, $view = 'form')
{
return $val;
}
/**
* not used
*
* @deprecated
*
* @return void
*/
public function ajax_loadTableFields()
{
$db = FabrikWorker::getDbo();
$listModel = JModelLegacy::getInstance('List', 'FabrikFEModel');
$input = $this->app->input;
$this->_cnnId = $input->getInt('cid', 0);
$tbl = $db->qn($input->get('table'));
$fieldDropDown = $listModel->getFieldsDropDown($this->_cnnId, $tbl, '-', false, 'params[join_val_column]');
$fieldDropDown2 = $listModel->getFieldsDropDown($this->_cnnId, $tbl, '-', false, 'params[join_key_column]');
echo "$('addJoinVal').innerHTML = '$fieldDropDown';";
echo "$('addJoinKey').innerHTML = '$fieldDropDown2';";
}
/**
* Get join row
*
* @return FabrikTableJoin join table or false if not loaded
*/
protected function getJoin()
{
if ($this->isJoin())
{
return $this->getJoinModel()->getJoin();
}
return false;
}
/**
* Get database field description
*
* @return string db field type
*/
public function getFieldDescription()
{
$element = $this->getPluginName();
$plugin = JPluginHelper::getPlugin('fabrik_element', $element);
$fParams = new Registry($plugin->params);
$p = $this->getParams();
if ($this->encryptMe())
{
return 'BLOB';
}
$group = $this->getGroup();
if ($group->isJoin() == 0 && $group->canRepeat())
{
return "TEXT";
}
else
{
$size = $p->get('maxlength', $this->fieldSize);
$objType = sprintf($this->fieldDesc, $size);
}
$objType = $fParams->get('defaultFieldType', $objType);
return $objType;
}
/**
* Trigger called when a row is deleted, can be used to delete images previously uploaded
*
* @param array $groups grouped data of rows to delete
*
* @return void
*/
public function onDeleteRows($groups)
{
}
/**
* Get a value to use as an empty filter value
*
* @return string
*/
public function emptyFilterValue()
{
return '';
}
/**
* Trigger called when a form or group row is stored.
* Ignores the element if it is a join chx/multi select
*
* @param array &$data Data to store
* @param int $repeatCounter Repeat group index
*
* @return bool If false, data should not be added.
*/
public function onStoreRow(&$data, $repeatCounter = 0)
{
if ($this->isJoin())
{
return false;
}
$element = $this->getElement();
// We should not process this element if it is unpublished
// Unpublished elements may not be in a valid state and may cause an error (white-screen)
if (!$element->published)
{
return false;
}
$shortName = $element->name;
$listModel = $this->getListModel();
if ($this->encryptMe())
{
$listModel->encrypt[] = $shortName;
}
$formModel = $this->getFormModel();
$name = $this->getFullName(true, false);
/**
* @TODO - fix this to use formData instead of formDataWithTableName,
* which we need to deprecate.
*/
if (!array_key_exists($name, $formModel->formDataWithTableName))
//if ($this->dataConsideredEmpty(FArrayHelper::getValue($formModel->formDataWithTableName, $name, '')))
{
$this->getEmptyDataValue($data);
}
$v = $this->getValue($formModel->formDataWithTableName, $repeatCounter);
if (!$this->ignoreOnUpdate($v))
{
$data[$shortName] = $v;
}
return true;
}
/**
* Shows the data formatted for the list view
*
* @param string $data Elements data
* @param stdClass &$thisRow All the data in the lists current row
* @param array $opts Rendering options
*
* @return string formatted value
*/
public function renderListData($data, stdClass &$thisRow, $opts = array())
{
$params = $this->getParams();
$listModel = $this->getListModel();
$data = FabrikWorker::JSONtoData($data, true);
foreach ($data as $i => &$d)
{
if ($params->get('icon_folder') == '1' && ArrayHelper::getValue($opts, 'icon', 1))
{
// $$$ rob was returning here but that stopped us being able to use links and icons together
$d = $this->replaceWithIcons($d, 'list', $listModel->getTmpl());
}
if (ArrayHelper::getValue($opts, 'rollover', 1))
{
$d = $this->rollover($d, $thisRow, 'list');
}
if (ArrayHelper::getValue($opts, 'link', 1))
{
$d = $listModel->_addLink($d, $this, $thisRow, $i);
}
}
return $this->renderListDataFinal($data);
}
/**
* Final prepare data function called from renderListData(), converts data to string and if needed
* encases in (for repeating data)
*
* @param array $data list cell data
*
* @return string cell data
*/
protected function renderListDataFinal($data)
{
if (is_array($data))
{
if (count($data) > 1)
{
if (!array_key_exists(0, $data))
{
// Occurs if we have created a list from an existing table whose data contains json objects (e.g. #__users.params)
$obj = ArrayHelper::toObject($data);
$data = array();
$data[0] = $obj;
}
// If we are storing info as json the data will contain an array of objects
if (is_object($data[0]))
{
foreach ($data as &$o)
{
$this->convertDataToString($o);
}
}
$r = '' . implode(' ', $data) . '
*
* @param mixed &$o data to convert
*
* @return void
*/
protected function convertDataToString(&$o)
{
if (is_object($o))
{
$s = '';
foreach ($o as $k => $v)
{
if (!is_string($v))
{
$v = json_encode($v);
}
$s .= '' . $v . ' ';
}
$s .= ' ';
$o = $s;
}
}
/**
* Prepares the element data for CSV export
*
* @param string $data Element data
* @param object &$thisRow All the data in the lists current row
*
* @return string Formatted CSV export value
*/
public function renderListData_csv($data, &$thisRow)
{
return $data;
}
/**
* Builds some html to allow certain elements to display the option to add in new options
* e.g. picklists, dropdowns radiobuttons
*
* @param bool $repeatCounter repeat group counter
* @param bool $onlylabel only show the label - overrides standard element settings
*
* @return string
*/
protected function getAddOptionFields($repeatCounter, $onlylabel = false)
{
$params = $this->getParams();
if (!$params->get('allow_frontend_addto'))
{
return;
}
$basePath = COM_FABRIK_BASE . '/components/com_fabrik/layouts/element';
$layout = new JLayoutFile('fabrik-element-addoptions', $basePath, array('debug' => false, 'component' => 'com_fabrik', 'client' => 'site'));
$displayData = new stdClass;
$displayData->id = $this->getHTMLId($repeatCounter);
$displayData->add_image = FabrikHelperHTML::image('plus', 'form', @$this->tmpl, array('alt' => FText::_('COM_FABRIK_ADD')));
$displayData->allowadd_onlylabel = $params->get('allowadd-onlylabel');
$displayData->savenewadditions = $params->get('savenewadditions');
$displayData->onlylabel = $onlylabel;
$displayData->hidden_field = $this->getHiddenField($displayData->id . '_additions', '', $displayData->id . '_additions');
return $layout->render($displayData);
}
/**
* Does the element force the form to submit via AJAX
*
* @deprecated - not used
*
* @return bool true if the element type forces the form to
*/
public function requiresAJAXSubmit()
{
return false;
}
/**
* Determine if the element should run its validation plugins on form submission
*
* @return bool default true
*/
public function mustValidate()
{
return true;
}
/**
* Get the name of the field to order the table data by
* can be overwritten in plugin class - but not currently done so
*
* @return string column to order by tablename___elementname and yes you can use aliases in the order by clause
*/
public function getOrderByName()
{
return $this->getFullName(true, false);
}
/**
* Not used
*
* @param string $rawval raw value
*
* @deprecated - not used
*
* @return string
*/
public function getFilterLabel($rawval)
{
return $rawval;
}
/**
* Store the element params
*
* @return bool
*
* @throws RuntimeException
*/
public function storeAttribs()
{
$element = $this->getElement();
if (!$element)
{
return false;
}
$db = FabrikWorker::getDbo(true);
$element->params = $this->getParams()->toString();
if (strlen($element->params) > 65535)
{
throw new RuntimeException(sprintf(FText::_('COM_FABRIK_ELEMENT_PARAMS_TOO_BIG'), $this->getId()));
}
$query = $db->getQuery(true);
$query->update('#__{package}_elements')->set('params = ' . $db->q($element->params))->where('id = ' . (int) $element->id);
$db->setQuery($query);
$res = $db->execute();
return $res;
}
/**
* load a new set of default properties and params for the element
* can be overridden in plugin class
*
* @param array $properties Default props
*
* @return FabrikTableElement element (id = 0)
*/
public function getDefaultProperties($properties = array())
{
$now = $this->date->toSql();
$this->setId(0);
$item = $this->getElement();
$item->set('plugin', $this->_name);
$item->set('params', $this->getDefaultAttribs());
$item->set('created', $now);
$item->set('created_by', $this->user->get('id'));
$item->set('created_by_alias', $this->user->get('username'));
$item->set('published', '1');
$item->set('show_in_list_summary', '1');
$item->set('link_to_detail', '1');
$item->bind($properties);
return $item;
}
/**
* Get a json encoded string of the element default parameters
*
* @return string
*/
public function getDefaultAttribs()
{
$o = new stdClass;
$o->rollover = '';
$o->comment = '';
$o->sub_default_value = '';
$o->sub_default_label = '';
$o->element_before_label = 1;
$o->allow_frontend_addtocheckbox = 0;
$o->database_join_display_type = 'dropdown';
$o->joinType = 'simple';
$o->join_conn_id = -1;
$o->date_table_format = 'Y-m-d';
$o->date_form_format = 'Y-m-d H:i:s';
$o->date_showtime = 0;
$o->date_time_format = 'H:i';
$o->date_defaulttotoday = 1;
$o->date_firstday = 0;
$o->multiple = 0;
$o->allow_frontend_addtodropdown = 0;
$o->password = 0;
$o->maxlength = 255;
$o->text_format = 'text';
$o->integer_length = 6;
$o->decimal_length = 2;
$o->guess_linktype = 0;
$o->disable = 0;
$o->readonly = 0;
$o->ul_max_file_size = 16000;
$o->ul_email_file = 0;
$o->ul_file_increment = 0;
$o->upload_allow_folderselect = 1;
$o->fu_fancy_upload = 0;
$o->upload_delete_image = 1;
$o->make_link = 0;
$o->fu_show_image_in_table = 0;
$o->image_library = 'gd2';
$o->make_thumbnail = 0;
$o->imagepath = '/';
$o->selectImage_root_folder = '/';
$o->image_front_end_select = 0;
$o->show_image_in_table = 0;
$o->image_float = 'none';
$o->link_target = '_self';
$o->radio_element_before_label = 0;
$o->options_per_row = 4;
$o->ck_options_per_row = 4;
$o->allow_frontend_addtoradio = 0;
$o->use_wysiwyg = 0;
$o->my_table_data = 'id';
$o->update_on_edit = 0;
$o->view_access = 1;
$o->show_in_rss_feed = 0;
$o->show_label_in_rss_feed = 0;
$o->icon_folder = -1;
$o->use_as_row_class = 0;
$o->filter_access = 1;
$o->full_words_only = 0;
$o->inc_in_adv_search = 1;
$o->sum_on = 0;
$o->sum_access = 0;
$o->avg_on = 0;
$o->avg_access = 0;
$o->median_on = 0;
$o->median_access = 0;
$o->count_on = 0;
$o->count_access = 0;
return json_encode($o);
}
/**
* Do we need to include the light-box js code
*
* @return bool
*/
public function requiresLightBox()
{
return false;
}
/**
* Do we need to include the slide-show js code
*
* @return bool
*/
public function requiresSlideshow()
{
return false;
}
/**
* Get Joomfish options
*
* @deprecated - not supporting joomfish
*
* @return array key=>value options
*/
public function getJoomfishOptions()
{
return array();
}
/**
* When filtering a table determine if the element's filter should be an exact match
* should take into account if the element is in a non-joined repeat group
*
* @param string $val element value
*
* @return bool
*/
public function isExactMatch($val)
{
$element = $this->getElement();
$filterExactMatch = isset($val['match']) ? $val['match'] : $element->filter_exact_match;
$group = $this->getGroup();
if (!$group->isJoin() && $group->canRepeat())
{
$filterExactMatch = false;
}
return $filterExactMatch;
}
/**
* Not used
*
* @deprecated - not used
*
* @return boolean
*/
public function onAjax_getFolders()
{
$input = $this->app->input;
$rDir = $input->getString('dir');
$folders = JFolder::folders($rDir);
if ($folders === false)
{
// $$$ hugh - need to echo empty JSON array otherwise we break JS which assumes an array
echo json_encode(array());
return false;
}
sort($folders);
echo json_encode($folders);
}
/**
* If used as a filter add in some JS code to watch observed filter element's changes
* when it changes update the contents of this elements dd filter's options
*
* @param bool $normal is the filter a normal (true) or advanced filter
* @param string $container container
*
* @return void
*/
public function filterJS($normal, $container)
{
// Overwritten in plugin
}
/**
* Should the element's data be returned in the search all?
* Looks at the lists selected options, if its there looks at what search mode the list is using
* and determines if the selected element can be used.
*
* @param bool $advancedMode Is the elements' list is extended search all mode?
* @param string $search Search string
*
* @return bool true
*/
public function includeInSearchAll($advancedMode = false, $search = '')
{
if ($this->isJoin() && $advancedMode)
{
return false;
}
$listModel = $this->getListModel();
$listParams = $listModel->getParams();
$searchElements = $listParams->get('list_search_elements', '');
if ($searchElements === '')
{
return false;
}
$searchElements = json_decode($searchElements);
if (!isset($searchElements->search_elements) || !is_array($searchElements->search_elements))
{
return false;
}
if (in_array($this->getId(), $searchElements->search_elements))
{
$advancedMode = $listParams->get('search-mode-advanced');
return $this->canIncludeInSearchAll($advancedMode);
}
}
/**
* Is it possible to include the element in the Search all query?
* true if basic search
* true/false if advanced search
*
* @param bool $advancedMode Is the list using advanced search
*
* @since 3.1b
*
* @return boolean
*/
public function canIncludeInSearchAll($advancedMode)
{
$params = $this->getParams();
if (!$advancedMode)
{
return true;
}
if ($this->ignoreSearchAllDefault)
{
return false;
}
$format = $params->get('text_format');
if ($format == 'integer' || $format == 'decimal')
{
return false;
}
return true;
}
/**
* Modify the label for admin list - filter elements.
* Adds a '*' if the element is not available in advanced search
*
* @param string &$label Element label
*
* @return void
*/
public function availableInAdvancedSearchLabel(&$label)
{
$label = $this->canIncludeInSearchAll(true) ? $label : $label . '*';
}
/**
* Get the value to use for graph calculations
* see timer which converts the value into seconds
*
* @param string $v standard value
*
* @return mixed calculation value
*/
public function getCalculationValue($v)
{
return (float) $v;
}
/**
* run on formModel::setFormData()
*
* @param int $c repeat group counter
*
* @return void
*/
public function preProcess($c)
{
}
/**
* Called when copy row list plugin called
*
* @param mixed $val value to copy into new record
*
* @return mixed value to copy into new record
*/
public function onCopyRow($val)
{
return $val;
}
/**
* Called when save as copy form button clicked
*
* @param mixed $val value to copy into new record
*
* @return mixed value to copy into new record
*/
public function onSaveAsCopy($val)
{
return $val;
}
/**
* Ajax call to get auto complete options (now caches results)
*
* @return string json encoded options
*/
public function onAutocomplete_options()
{
// Needed for ajax update (since we are calling this method via dispatcher element is not set)
$input = $this->app->input;
$this->setId($input->getInt('element_id'));
$this->loadMeForAjax();
$cache = FabrikWorker::getCache();
$search = $input->get('value', '', 'string');
// uh oh, can't serialize PDO db objects so no can cache, as J! serializes the args
if ($this->config->get('dbtype') === 'pdomysql')
{
echo $this->cacheAutoCompleteOptions($this, $search);
}
else
{
echo $cache->call(array(get_class($this), 'cacheAutoCompleteOptions'), $this, $search);
}
}
/**
* Cache method to populate auto-complete options
*
* @param plgFabrik_Element $elementModel element model
* @param string $search search string
* @param array $opts options, 'label' => field to use for label (db join)
*
* @since 3.0.7
*
* @return string json encoded search results
*/
public static function cacheAutoCompleteOptions($elementModel, $search, $opts = array())
{
$name = $elementModel->getFullName(false, false);
$elementModel->encryptFieldName($name);
$listModel = $elementModel->getListModel();
$db = $listModel->getDb();
$query = $db->getQuery(true);
$tableName = $listModel->getTable()->db_table_name;
$query->select('DISTINCT(' . $name . ') AS value, ' . $name . ' AS text')->from($tableName);
$query->where($name . ' LIKE ' . $db->q(addslashes('%' . $search . '%')));
$query = $listModel->buildQueryJoin($query);
$query = $listModel->buildQueryWhere(false, $query);
$query = $listModel->pluginQuery($query);
$db->setQuery($query);
$tmp = $db->loadObjectList();
foreach ($tmp as &$t)
{
$elementModel->toLabel($t->text);
$t->text = strip_tags($t->text);
}
return json_encode($tmp);
}
/**
* Get the table name that the element stores to
* can be the main table name or the joined table name
*
* @return string
*/
protected function getTableName()
{
$listModel = $this->getListModel();
$table = $listModel->getTable();
$groupModel = $this->getGroup();
if ($groupModel->isJoin())
{
$joinModel = $groupModel->getJoinModel();
$join = $joinModel->getJoin();
$name = $join->table_join;
}
else
{
$name = $table->db_table_name;
}
return $name;
}
/**
* Converts a raw value into its label equivalent
*
* @param string &$v raw value
*
* @return void
*/
protected function toLabel(&$v)
{
}
/**
* Build group by query to append to list query
*
* @return string getGroupByQuery
*/
public function getGroupByQuery()
{
return '';
}
/**
* Append element where statement to lists where array
*
* @param array &$whereArray list models where statements
*
* @return void
*/
public function appendTableWhere(&$whereArray)
{
$params = $this->getParams();
if ($params->get('append_table_where', false))
{
if (method_exists($this, 'buildQueryWhere'))
{
$where = trim($this->buildQueryWhere(array()));
if ($where != '')
{
$where = JString::substr($where, 5, JString::strlen($where) - 5);
if (!in_array($where, $whereArray))
{
$whereArray[] = $where;
}
}
}
}
}
/**
* Used by validations
*
* @param string $data this elements data
* @param string $cond what condition to apply
* @param string $compare data to compare element's data to
*
* @return bool
*/
public function greaterOrLessThan($data, $cond, $compare)
{
if ($cond == '>')
{
return $data > $compare;
}
elseif ($cond == '>=')
{
return $data >= $compare;
}
elseif ($cond == '<')
{
return $data < $compare;
}
elseif ($cond == '<=')
{
return $data <= $compare;
}
elseif ($cond == '==')
{
return $data == $compare;
}
return false;
}
/**
* Can the element plugin encrypt data
*
* @return bool
*/
public function canEncrypt()
{
return false;
}
/**
* Should the element's data be encrypted
*
* @return bool
*/
public function encryptMe()
{
$params = $this->getParams();
return ($this->canEncrypt() && $params->get('encrypt', false));
}
/**
* Format a number value
*
* @param mixed $data (double/int)
*
* @return string formatted number
*/
protected function numberFormat($data)
{
$params = $this->getParams();
if (!$params->get('field_use_number_format', false))
{
return $data;
}
$decimalLength = (int) $params->get('decimal_length', 2);
$decimalSep = $params->get('field_decimal_sep', '.');
$thousandSep = $params->get('field_thousand_sep', ',');
// Workaround for params not letting us save just a space!
if ($thousandSep == '#32')
{
$thousandSep = ' ';
}
else if ($thousandSep == '#00')
{
$thousandSep = '';
}
return number_format((float) $data, $decimalLength, $decimalSep, $thousandSep);
}
/**
* Strip number format from a number value
*
* @param mixed $val (double/int)
*
* @return string formatted number
*/
public function unNumberFormat($val)
{
$params = $this->getParams();
if (!$params->get('field_use_number_format', false))
{
return $val;
}
// Might think about rounding to decimal_length, but for now let MySQL do it
$decimalLength = (int) $params->get('decimal_length', 2);
// Swap dec and thousand seps back to Normal People Decimal Format!
$decimalSep = $params->get('field_decimal_sep', '.');
$thousandSep = $params->get('field_thousand_sep', ',');
// Workaround for params not letting us save just a space!
if ($thousandSep == '#32')
{
$thousandSep = ' ';
}
else if ($thousandSep == '#00')
{
$thousandSep = '';
}
$val = str_replace($thousandSep, '', $val);
$val = str_replace($decimalSep, '.', $val);
return $val;
}
/**
* Recursively get all linked children of an element
*
* @param int $id element id
*
* @return array
*/
public function getElementDescendents($id = 0)
{
if (empty($id))
{
$id = $this->id;
}
$db = FabrikWorker::getDbo(true);
$query = $db->getQuery(true);
$query->select('id')->from('#__{package}_elements')->where('parent_id = ' . (int) $id);
$db->setQuery($query);
$kids = $db->loadObjectList();
$all_kids = array();
foreach ($kids as $kid)
{
$all_kids[] = $kid->id;
$all_kids = array_merge($this->getElementDescendents($kid->id), $all_kids);
}
return $all_kids;
}
/**
* Get the actual table name to use when building select queries
* so if in a joined group get the joined to table's name otherwise return the
* table's db table name
*
* @return string
*/
protected function actualTableName()
{
if (isset($this->actualTable))
{
return $this->actualTable;
}
$groupModel = $this->getGroup();
if ($groupModel->isJoin())
{
$joinModel = $groupModel->getJoinModel();
return $joinModel->getJoin()->table_join;
}
$listModel = $this->getListModel();
$this->actualTable = $listModel->getTable()->db_table_name;
return $this->actualTable;
}
/**
* When creating crud query in tableModel::storeRow() each element has the chance
* to alter the row id - used by sugarid plugin to fudge rowid
*
* @param string &$rowId row id
*
* @deprecated - not used
*
* @return void
*/
public function updateRowId(&$rowId)
{
}
/**
* Fabrik3: moved to Admin Element Model
*
* @deprecated - not used
*
* @return string table name
*/
protected function getRepeatElementTableName()
{
}
/**
* Is the element a repeating element
*
* @return bool
*/
public function isRepeatElement()
{
return $this->isJoin();
}
/**
* fabrik3: moved to Admin Element Model
* if repeated element we need to make a joined db table to store repeated data in
*
* @depreciated
*
* @return void
*/
public function createRepeatElement()
{
}
/**
* get the element's associated join model
*
* @return FabrikFEModelJoin join model
*/
public function getJoinModel()
{
if (is_null($this->joinModel))
{
$this->joinModel = JModelLegacy::getInstance('Join', 'FabrikFEModel');
// $$$ rob ensure we load the join by asking for the parents id, but then ensure we set the element id back to this elements id
$this->joinModel->getJoinFromKey('element_id', $this->getParent()->id);
$this->joinModel->getJoin()->element_id = $this->getElement()->id;
}
return $this->joinModel;
}
/**
* When saving an element pk we need to update any join which has the same params->pk
*
* @param string $oldName (previous element name)
* @param string $newName (new element name)
*
* @since 3.0.6
*
* @return void
*/
public function updateJoinedPks($oldName, $newName)
{
$db = FabrikWorker::getDbo(true);
$item = $this->getListModel()->getTable();
$query = $db->getQuery(true);
// Update linked lists id.
$query->update('#__{package}_joins')->set('table_key = ' . $db->q($newName))
->where('join_from_table = ' . $db->q($item->db_table_name))->where('table_key = ' . $db->q($oldName));
$db->setQuery($query);
$db->execute();
// Update join pk parameter
$query->clear();
$query->select('id')->from('#__{package}_joins')->where('table_join = ' . $db->q($item->db_table_name));
$db->setQuery($query);
$ids = $db->loadColumn();
$testPk = $db->qn($item->db_table_name . '.' . $oldName);
$newPk = $db->qn($item->db_table_name . '.' . $newName);
foreach ($ids as $id)
{
$join = FabTable::getInstance('Join', 'FabrikTable');
$join->load($id);
$params = new Registry($join->params);
if ($params->get('pk') === $testPk)
{
$params->set('pk', $newPk);
$join->params = (string) $params;
$join->store();
}
}
}
/**
* Is the element a join
*
* @return bool
*/
public function isJoin()
{
return $this->getParams()->get('repeat', false);
}
/**
* Used by inline edit table plugin
* If returns yes then it means that there are only two possible options for the
* ajax edit, so we should simply toggle to the alternative value and show the
* element rendered with that new value (used for yes/no element)
*
* @deprecated - only called in a deprecated element method
*
* @return bool
*/
protected function canToggleValue()
{
return false;
}
/**
* Encrypt an entire columns worth of data, used when updating an element to encrypted
* with existing data in the column
*
* @return null
*/
public function encryptColumn()
{
$secret = $this->config->get('secret');
$listModel = $this->getListModel();
$db = $listModel->getDb();
$tbl = $this->actualTableName();
$name = $this->getElement()->name;
$db->setQuery("UPDATE $tbl SET " . $name . " = AES_ENCRYPT(" . $name . ", " . $db->q($secret) . ")");
$db->execute();
}
/**
* Decrypt an entire columns worth of data, used when updating an element from encrypted to decrypted
* with existing data in the column
*
* @return null
*/
public function decryptColumn()
{
// @TODO this query looks right but when going from encrypted blob to decrypted field the values are set to null
$secret = $this->config->get('secret');
$listModel = $this->getListModel();
$db = $listModel->getDb();
$tbl = $this->actualTableName();
$name = $this->getElement()->name;
$db->setQuery("UPDATE $tbl SET " . $name . " = AES_DECRYPT(" . $name . ", " . $db->q($secret) . ")");
$db->execute();
}
/**
* PN 19-Jun-11: Construct an element error string.
*
* @return string
*/
public function selfDiagnose()
{
$retStr = '';
$this->_db->setQuery("SELECT COUNT(*) FROM #__fabrik_groups " . "WHERE (id = " . $this->element->group_id . ");");
$group_id = $this->_db->loadResult();
if (!$group_id)
{
$retStr = 'No valid group assignment';
}
elseif (!$this->element->plugin)
{
$retStr = 'No plugin';
}
elseif (!$this->element->label)
{
$retStr = 'No element label';
}
else
{
$retStr = '';
}
return $retStr;
}
/**
* Shortcut to get plugin manager
*
* @since 3.0b
*
* @deprecated
*
* @return object plugin manager
*/
public function getPluginManager()
{
return FabrikWorker::getPluginManager();
}
/**
* When the element is a repeatable join (e.g. db join checkbox) then figure out how many
* records have been selected
*
* @param array $data data
* @param object $oJoin join current join
*
* @since 3.0rc1
*
* @return int number of records selected
*/
public function getJoinRepeatCount($data, $oJoin)
{
return count(FArrayHelper::getValue($data, $oJoin->table_join . '___id', array()));
}
/**
* When we do ajax requests from the element - as the plugin controller uses the J dispatcher
* the element hasn't loaded up itself, so any time you have a function onAjax_doSomething() call this
* helper function first to load up the element. Otherwise things like parameters will not be loaded
*
* @since 3.0rc1
*
* @return null
*/
protected function loadMeForAjax()
{
$input = $this->app->input;
$this->form = JModelLegacy::getInstance('form', 'FabrikFEModel');
$formId = $input->getInt('formid');
$this->form->setId($formId);
$this->setId($input->getInt('element_id'));
$this->list = JModelLegacy::getInstance('list', 'FabrikFEModel');
$this->list->loadFromFormId($formId);
$table = $this->list->getTable(true);
$table->form_id = $formId;
$element = $this->getElement(true);
$this->setEditable($this->canUse('form'));
}
/**
* get the element's cell class
*
* @since 3.0.4
*
* @return string css classes
*/
public function getCellClass()
{
$params = $this->getParams();
$classes = array();
$classes[] = $this->getFullName(true, false);
$classes[] = 'fabrik_element';
$classes[] = 'fabrik_list_' . $this->getListModel()->getId() . '_group_' . $this->getGroupModel()->getId();
$c = $params->get('tablecss_cell_class', '');
if ($c !== '')
{
$classes[] = $c;
}
return implode(' ', $classes);
}
/**
* get the elements list heading class
*
* @since 3.0.4
*
* @return string css classes
*/
public function getHeadingClass()
{
$classes = array();
$classes[] = 'fabrik_ordercell';
$classes[] = $this->getFullName(true, false);
$classes[] = $this->getElement()->id . '_order';
$classes[] = 'fabrik_list_' . $this->getListModel()->getId() . '_group_' . $this->getGroupModel()->getId();
$classes[] = $this->getParams()->get('tablecss_header_class');
return implode(' ', $classes);
}
/**
* convert XML format data into fabrik data (used by web services)
*
* @param mixed $v data
*
* @return mixed data
*/
public function fromXMLFormat($v)
{
return $v;
}
/**
* Allows the element to pre-process a rows data before and join merging of rows
* occurs. Used in calc element to do calcs on actual row rather than merged row
*
* @param string $data elements data for the current row
* @param object $row current row's data
*
* @since 3.0.5
*
* @return string formatted value
*/
public function preFormatFormJoins($data, $row)
{
return $data;
}
/**
* Return an array of parameter names which should not get updated if a linked element's parent is saved
* notably any parameter which references another element id should be returned in this array
* called from admin element model updateChildIds()
* see cascadingdropdown element for example
*
* @return array parameter names to not alter
*/
public function getFixedChildParameters()
{
return array();
}
/**
* Set row class
*
* @param array &$data row data to set class for
*
* @return null
*/
public function setRowClass(&$data)
{
$rowClass = $this->getParams()->get('use_as_row_class');
if ($rowClass == 1)
{
$col = $this->getFullName(true, false);
$rawCol = $col . '_raw';
foreach ($data as $groupKey => $group)
{
for ($i = 0; $i < count($group); $i++)
{
$c = false;
if (isset($data[$groupKey][$i]->data->$rawCol))
{
$c = $data[$groupKey][$i]->data->$rawCol;
}
elseif (isset($data[$groupKey][$i]->data->$col))
{
$c = $data[$groupKey][$i]->data->$col;
}
if ($c !== false)
{
$data[$groupKey][$i]->class .= ' ' . FabrikString::getRowClass($c, $this->element->name);
}
}
}
}
}
/**
* Unset the element models access
*
* @return null
*/
public function clearAccess()
{
unset($this->access);
}
/**
* Forces reset of defaults, etc.
*
* @return null
*/
public function reset()
{
$this->defaults = null;
}
/**
* Clear default values, need to call this if we change an elements value in any of the formData
* arrays during submission process.
*
* @return null
*/
public function clearDefaults()
{
$this->defaults = null;
}
/**
* Should the 'label' field be quoted. Overridden by databasejoin and extended classes,
* which may use a CONCAT'ed label which mustn't be quoted.
*
* @since 3.0.6
*
* @return boolean
*/
protected function quoteLabel()
{
return true;
}
/**
* Create the where part for the query that selects the list options
*
* @param array $data Current row data to use in placeholder replacements
* @param bool $incWhere Should the additional user defined WHERE statement be included
* @param string $thisTableAlias Db table alias
* @param array $opts Options
* @param JDatabaseQuery|bool $query Append where to JDatabaseQuery object or return string (false)
*
* @return string|JDatabaseQuery
*/
protected function buildQueryWhere($data = array(), $incWhere = true, $thisTableAlias = null, $opts = array(), $query = false)
{
return '';
}
/**
* Is the element set to always render in list contexts
*
* @param bool $not_shown_only Not sure???
*
* @return bool
*/
public function isAlwaysRender($not_shown_only = true)
{
$params = $this->getParams();
$element = $this->getElement();
$alwaysRender = $params->get('always_render', '0');
return $not_shown_only ? $element->show_in_list_summary == 0 && $alwaysRender == '1' : $alwaysRender == '1';
}
/**
* Called at end of form record save. Used for many-many join elements to save their data
*
* @param array &$data Form data
*
* @since 3.1rc1
*
* @return void
*/
public function onFinalStoreRow(&$data)
{
if (!$this->isJoin())
{
return;
}
$groupModel = $this->getGroupModel();
$listModel = $this->getListModel();
$db = $listModel->getDb();
$query = $db->getQuery(true);
$formData =& $this->getFormModel()->formDataWithTableName;
// I set this to raw for cdd.
$name = $this->getFullName(true, false);
$ajaxSubmit = $this->app->input->get('fabrik_ajax');
$rawName = $name . '_raw';
$shortName = $this->getElement()->name;
$join = $this->getJoin();
// The submitted element's values
$d = FArrayHelper::getValue($formData, $rawName, FArrayHelper::getValue($formData, $name));
// set $emptyish to false so if no selection, we don't save a bogus empty row
$allJoinValues = FabrikWorker::JSONtoData($d, true, false);
if ($groupModel->isJoin())
{
$groupJoinModel = $groupModel->getJoinModel();
$k = str_replace('`', '', str_replace('.', '___', $groupJoinModel->getJoin()->params->get('pk')));
$parentIds = (array) $formData[$k];
}
else
{
$k = 'rowid';
$parentIds = empty($allJoinValues) ? array() : FArrayHelper::array_fill(0, count($allJoinValues), $formData[$k]);
}
$paramsKey = $this->getJoinParamsKey();
$allParams = (array) FArrayHelper::getValue($formData, $paramsKey, array());
$allParams = array_values($allParams);
$i = 0;
$idsToKeep = array();
foreach ($parentIds as $parentId)
{
if (!array_key_exists($parentId, $idsToKeep))
{
$idsToKeep[$parentId] = array();
}
if ($groupModel->canRepeat())
{
$joinValues = FArrayHelper::getValue($allJoinValues, $i, array());
}
else
{
$joinValues = $allJoinValues;
}
$joinValues = (array) $joinValues;
// Get existing records
if ($parentId == '')
{
$ids = array();
}
else
{
$query->clear();
$query->select('id, ' . $shortName)->from($join->table_join)->where('parent_id = ' . $parentId);
$db->setQuery($query);
$ids = (array) $db->loadObjectList($shortName);
}
// If doing an ajax form submit and the element is an ajax file upload then its data is different.
if (get_class($this) === 'PlgFabrik_ElementFileupload' && $ajaxSubmit)
{
$allParams = array_key_exists('crop', $joinValues) ? array_values($joinValues['crop']) : array();
$joinValues = array_key_exists('id', $joinValues) ? array_keys($joinValues['id']) : $joinValues;
}
foreach ($joinValues as $jIndex => $jid)
{
$record = new stdClass;
$record->parent_id = $parentId;
$fkVal = FArrayHelper::getValue($joinValues, $jIndex);
$record->$shortName = $fkVal;
$record->params = FArrayHelper::getValue($allParams, $jIndex);
// Stop notice with file-upload where fkVal is an array
if (array_key_exists($fkVal, $ids))
{
$record->id = $ids[$fkVal]->id;
$idsToKeep[$parentId][] = $record->id;
}
else
{
$record->id = 0;
}
if ($record->id == 0)
{
$ok = $listModel->insertObject($join->table_join, $record);
$lastInsertId = $listModel->getDb()->insertid();
if (!$this->allowDuplicates)
{
$newId = new stdClass;
$newId->id = $lastInsertId;
$newId->$shortName = $record->$shortName;
$ids[$record->$shortName] = $newId;
}
$idsToKeep[$parentId][] = $lastInsertId;
}
else
{
$ok = $listModel->updateObject($join->table_join, $record, 'id');
}
if (!$ok)
{
throw new RuntimeException('Didn\'t save dbjoined repeat element');
}
}
$i++;
}
// Delete any records that were unselected.
$this->deleteDeselectedItems($idsToKeep, $k);
}
/**
* For joins:
* Get the key which contains the linking tables primary key values.
*
* @param bool $step Use step '___' or '.' in full name
*
* @return boolean|string
*/
public function getJoinIdKey($step = true)
{
if (!$this->isJoin())
{
return false;
}
if ($this->getGroupModel()->isJoin())
{
$join = $this->getJoin();
$idKey = $join->table_join . '___id';
}
else
{
$idKey = $this->getFullName($step, false) . '___id';
}
return $idKey;
}
/**
* For joins:
* Get the key which contains the linking tables params values.
*
* @param bool $step Use step '___' or '.' in full name
*
* @return boolean|string
*/
public function getJoinParamsKey($step = true)
{
if (!$this->isJoin())
{
return false;
}
if ($this->getGroupModel()->isJoin())
{
$join = $this->getJoin();
$paramsKey = $join->table_join . '___params';
}
else
{
$paramsKey = $this->getFullName($step, false) . '___params';
}
return $paramsKey;
}
/**
* Delete any deselected items from the cross-reference table
*
* @param array $idsToKeep List of ids to keep
* @param string $k Parent record key name
*
* @return void
*/
protected function deleteDeselectedItems($idsToKeep, $k)
{
$listModel = $this->getListModel();
$join = $this->getJoin();
$db = $listModel->getDb();
$query = $db->getQuery(true);
if (empty($idsToKeep))
{
$formData = $this->getFormModel()->formDataWithTableName;
$parentId = $formData[$k];
if (!empty($parentId))
{
$query->delete($join->table_join)->where('parent_id = ' . $db->q($parentId));
$db->setQuery($query);
$db->execute();
}
}
else
{
foreach ($idsToKeep as $parentId => $ids)
{
$query->clear();
$query->delete($join->table_join)->where('parent_id = ' . $parentId);
if (!empty($ids))
{
$query->where('id NOT IN ( ' . implode($ids, ',') . ')');
}
$db->setQuery($query);
$db->execute();
}
}
}
/**
* Return an internal validation icon - e.g. for Password element
*
* @return string
*/
public function internalValidationIcon()
{
return '';
}
/**
* Return internal validation hover text - e.g. for Password element
*
* @return string
*/
public function internalValidataionText()
{
return '';
}
/**
* Return JS event required to trigger a 'change', usually 'change',
* but some elements need a 'click' or a 'blur'. Used initially by CDD element.
* NOTE - there is also a getChangeEvent() in element.js, which should return the same thing, Don't Ask.
*
* @return string
*/
public function getChangeEvent()
{
return 'change';
}
/**
* Returns class name to use for advanced select (no surrounding space), or empty string
*
* @return bool
*/
public function getAdvancedSelectClass()
{
$fbConfig = JComponentHelper::getParams('com_fabrik');
$params = $this->getParams();
$advancedClass = '';
$globalAdvanced = (int) $fbConfig->get('advanced_behavior', '0');
if ($globalAdvanced !== 0)
{
$advancedClass = $params->get('advanced_behavior', '0') == '1' || $globalAdvanced === 2 ? 'advancedSelect' : '';
}
return $advancedClass;
}
/**
* Get the element's JLayout file
* Its actually an instance of FabrikLayoutFile which inverses the ordering added include paths.
* In FabrikLayoutFile the addedPath takes precedence over the default paths, which makes more sense!
*
* @param string $type form/details/list
* @param array $paths Optional paths to add as includes
*
* @return FabrikLayoutFile
*/
public function getLayout($type, $paths = array(), $options = array())
{
$defaultOptions = array('debug' => false, 'component' => 'com_fabrik', 'client' => 'site');
$options = array_merge($defaultOptions, $options);
$basePath = $this->layoutBasePath();
$layout = new FabrikLayoutFile('fabrik-element-' . $this->getPluginName() . '-' . $type, $basePath, $options);
foreach ($paths as $path)
{
$layout->addIncludePath($path);
}
$layout->addIncludePaths(JPATH_SITE . '/layouts');
$layout->addIncludePaths(JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts');
$layout->addIncludePaths(JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts/com_fabrik');
$layout->addIncludePaths(JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts/com_fabrik/element/');
// Custom per element layout...
$layout->addIncludePaths(JPATH_THEMES . '/' . $this->app->getTemplate() . '/html/layouts/com_fabrik/element/' . $this->getFullName(true, false));
// Custom per template layout
$view = $this->getFormModel()->isEditable() ? 'form' : 'details';
$layout->addIncludePaths(COM_FABRIK_FRONTEND . '/views/'. $view . '/tmpl/' . $this->getFormModel()->getTmpl() . '/layouts/element/');
$layout->addIncludePaths(COM_FABRIK_FRONTEND . '/views/'. $view . '/tmpl/' . $this->getFormModel()->getTmpl() . '/layouts/element/' . $this->getFullName(true, false));
$layout->addIncludePaths(COM_FABRIK_FRONTEND . '/views/list/tmpl/' . $this->getFormModel()->getListModel()->getTmpl() . '/layouts/element/');
$layout->addIncludePaths(COM_FABRIK_FRONTEND . '/views/list/tmpl/' . $this->getFormModel()->getListModel()->getTmpl() . '/layouts/element/' . $this->getFullName(true, false));
return $layout;
}
/**
* Get the JLayout base path for the plugin's layout files.
*
* @return string
*/
protected function layoutBasePath()
{
return COM_FABRIK_BASE . '/plugins/fabrik_element/' . $this->getPluginName() . '/layouts';
}
/**
* Get lower case plugin name based off class name:
* E.g. PlgFabrik_ElementDatabasejoin => databasejoin
*
* @return string
*/
protected function getPluginName()
{
$name = get_class($this);
if (strstr($name, '\\'))
{
$name = explode('\\', $name);
$name = array_pop($name);
}
return strtolower(JString::str_ireplace('PlgFabrik_Element', '', $name));
}
/**
* Validate teh element against a Joomla form Rule
*
* @param string $type Rule type e.g. 'password'
* @param mixed $value Value to validate
* @param mixed $path Optional path to load teh rule from
*
* @throws Exception
*
* @return bool
*/
protected function validateJRule($type, $value, $path = null)
{
if (!is_null($path))
{
JFormHelper::addRulePath($path);
}
$rule = JFormHelper::loadRuleType($type, true);
$xml = new SimpleXMLElement('