Newer
Older
<?php
/*********************************************************************
class.dynamic_forms.php
Forms models built on the VerySimpleModel paradigm. Allows for arbitrary
data to be associated with tickets. Eventually this model can be
extended to associate arbitrary data with registered clients and thread
entries.
Jared Hancock <jared@osticket.com>
Copyright (c) 2006-2013 osTicket
http://www.osticket.com
Released under the GNU General Public License WITHOUT ANY WARRANTY.
See LICENSE.TXT for details.
vim: expandtab sw=4 ts=4 sts=4:
**********************************************************************/
require_once(INCLUDE_DIR . 'class.orm.php');
require_once(INCLUDE_DIR . 'class.forms.php');
require_once(INCLUDE_DIR . 'class.filter.php');
require_once(INCLUDE_DIR . 'class.signal.php');
/**
* Form template, used for designing the custom form and for entering custom
* data for a ticket
*/
class DynamicForm extends VerySimpleModel {
static $meta = array(
'table' => FORM_SEC_TABLE,
'ordering' => array('title'),
'pk' => array('id'),
);
// Registered form types
static $types = array(
'T' => 'Ticket Information',
'U' => 'User Information',
function getFields($cache=true) {
if (!isset($this->_fields) || !$cache) {
$this->_fields = array();
foreach ($this->getDynamicFields() as $f)
// TODO: Index by field name or id
$this->_fields[$f->get('id')] = $f->getImpl($f);
}
return $this->_fields;
}
function getDynamicFields() {
if (!$this->_dfields && isset($this->id)) {
->filter(array('form_id'=>$this->id))
foreach ($this->_dfields as $f)
$f->setForm($this);
}
// Multiple inheritance -- delegate to Form
function __call($what, $args) {
$delegate = array($this->getForm(), $what);
if (!is_callable($delegate))
throw new Exception($what.': Call to non-existing function');
return call_user_func_array($delegate, $args);
function getField($name, $cache=true) {
foreach ($this->getFields($cache) as $f) {
}
if ($cache)
return $this->getField($name, false);
function hasField($name) {
return ($this->getField($name));
}
function getTitle() { return $this->get('title'); }
function getInstructions() { return $this->get('instructions'); }
function getForm($source=false) {
if (!$this->_form || $source) {
$fields = $this->getFields($this->_has_data);
$this->_form = new Form($fields, $source, array(
'title'=>$this->title, 'instructions'=>$this->instructions));
function isDeletable() {
return $this->get('deletable');
}
function instanciate($sort=1) {
return DynamicFormEntry::create(array(
'form_id'=>$this->get('id'), 'sort'=>$sort));
function data($data) {
if ($data instanceof DynamicFormEntry) {
$this->_fields = $data->getFields();
$this->_has_data = true;
function save($refetch=false) {
if (count($this->dirty))
$this->set('updated', new SqlFunction('NOW'));
if (isset($this->dirty['notes']))
$this->notes = Format::sanitize($this->notes);
return parent::save($refetch);
}
function delete() {
if (!$this->isDeletable())
return false;
else
return parent::delete();
function getExportableFields($exclude=array()) {
$fields = array();
foreach ($this->getFields() as $f) {
// Ignore core fields
if ($exclude && in_array($f->get('name'), $exclude))
continue;
// Ignore non-data fields
elseif (!$f->hasData() || $f->isPresentationOnly())
continue;
$fields['__field_'.$f->get('id')] = $f;
}
return $fields;
}
static function create($ht=false) {
$inst = parent::create($ht);
$inst->set('created', new SqlFunction('NOW'));
if (isset($ht['fields'])) {
$inst->save();
foreach ($ht['fields'] as $f) {
$f = DynamicFormField::create($f);
$f->form_id = $inst->id;
$f->save();
}
}
return $inst;
}
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
static function getCrossTabQuery($object_type, $object_id='object_id', $exclude=array()) {
$fields = static::getDynamicDataViewFields($exclude);
return "SELECT entry.`object_id` as `$object_id`, ".implode(',', $fields)
.' FROM '.FORM_ENTRY_TABLE.' entry
JOIN '.FORM_ANSWER_TABLE.' ans ON ans.entry_id = entry.id
JOIN '.FORM_FIELD_TABLE." field ON field.id=ans.field_id
WHERE entry.object_type='$object_type' GROUP BY entry.object_id";
}
// Materialized View for Ticket custom data (MySQL FlexViews would be
// nice)
//
// @see http://code.google.com/p/flexviews/
static function getDynamicDataViewFields($exclude) {
$fields = array();
foreach (static::getInstance()->getFields() as $f) {
if ($exclude && in_array($f->get('name'), $exclude))
continue;
$impl = $f->getImpl();
if (!$impl->hasData() || $impl->isPresentationOnly())
continue;
$name = ($f->get('name')) ? $f->get('name')
: 'field_'.$f->get('id');
$fields[] = sprintf(
'MAX(IF(field.name=\'%1$s\',ans.value,NULL)) as `%1$s`',
$name);
if ($impl->hasIdValue()) {
$fields[] = sprintf(
Loading
Loading full blame...