public $cnt_query = false;

/**

* @param null|integer $id

* @return Model

*/

public function get_datatable($options = array()) {

$limit = $this->_limit;

$offset = $this->_offset;

$this->_limit = null;

$this->_offset = null;

$this->cnt_query = true;

$cnt = parent::find_array();

if (isset($cnt[0]['_dt_record_cnt'])) {

$cnt = $cnt[0]['_dt_record_cnt'];

} else {

// @todo throw error

$cnt = 0;

}

$this->_limit = $limit;

$this->_offset = $offset;

$this->cnt_query = false;

$results = $this->_create_json(parent::find_array(), $cnt, $options);

return $results;

}

/**

* Method to create an instance of the model class

* associated with this wrapper and populate

* it with the supplied Idiorm instance.

*

* @param array $data

* @param array $options

* @return string

*/

protected function _create_json($data, $cnt, $options) {

if ($data === false) {

return false;

}

$json = array();

$json['recordsTotal'] = $cnt;

$json['recordsFiltered'] = $cnt;

$json['data'] = array();

$x = 0;

foreach ($data as $row) {

// lets see if we have a row id we are using

if (isset($options['DT_RowId']['type'])) {

if ($options['DT_RowId']['type'] == 'fixed') {

// fixed keys will most likely not be used as they increment by the x

// value of the loop, the ideal identifier would be dynamic

if (isset($options['DT_RowId']['key'])) {

$row['DT_RowId'] = $options['DT_RowId']['key'] . $x;

} else {

// @todo exception handler

}

} elseif ($options['DT_RowId']['type'] == 'dynamic') {

// dynmaic keys increment by the value of the key and the value

// or another identifier like an id column in the dataset

if (isset($options['DT_RowId']['key'])) {

if (isset($row[$options['DT_RowId']['key']])) {

$row['DT_RowId'] = $row[$options['DT_RowId']['key']];

} else {

// @todo exception handler

}

}

}

if (isset($options['DT_RowId']['prepend'])) {

if (!empty($row['DT_RowId'])) {

$row['DT_RowId'] = $options['DT_RowId']['prepend'] . $row['DT_RowId'];

}

}

}

/**

* http://datatables.net/manual/server-side#Returned-data

* Add the data contained in the object to the row using the jQuery data() method to set the data,

* which can also then be used for later retrieval (for example on a click event).

*/

if (isset($options['DT_RowData'])) {

if (is_array($options['DT_RowData'])) {

foreach ($options['DT_RowData'] as $key => $val) {

// lets see if we are including row data via template

$templated_vals = $this->getTemplatedValues($val);

foreach ($templated_vals as $t_val) {

if (isset($row[$t_val])) {

$val = str_replace('{{' . $t_val . '}}', $row[$t_val], $val);

}

}

$row['DT_RowData'][$key] = $val;

}

}

}

/**

* the ability to add dynamic columns to the result set is very important

* for instance you may want a column called `actions` that has an edit or a delete button

* this module provides a very simple way to add these

*/

if (isset($options['dynamic_columns'])) {

foreach ($options['dynamic_columns'] as $col) {

if (isset($col['key']) && isset($col['column_template'])) {

$templated_vals = $this->getTemplatedValues($col['column_template']);

foreach ($templated_vals as $t_val) {

if (isset($row[$t_val])) {

$col['column_template'] = str_replace('{{' . $t_val . '}}', $row[$t_val], $col['column_template']);

}

}

$row[$col['key']] = $col['column_template'];

} else {

// @todo exception handler

}

}

}

// the ability to wrap columns dyanamically with html

if (isset($options['wrap_columns'])) {

foreach ($options['wrap_columns'] as $col) {

if (isset($col['key']) && isset($col['column_template'])) {

$templated_vals = $this->getTemplatedValues($col['column_template']);

foreach ($templated_vals as $t_val) {

if (isset($row[$t_val])) {

$col['column_template'] = str_replace('{{' . $t_val . '}}', $row[$t_val], $col['column_template']);

} elseif ($t_val == 'column_data') {

$col['column_template'] = str_replace('{{' . $t_val . '}}', $row[$col['key']], $col['column_template']);

}

}

$row[$col['key']] = $col['column_template'];

} else {

// @todo exception handler

}

}

}

// ability to wrap an entire column with custom HTML

if (isset($options['wrap_all']['columns'])) {

$new_row = array();

foreach ($row as $key => $val) {

if ($key == 'DT_RowId' || $key == 'DT_RowData') {

continue;

}

$new_row[$key] = str_replace('{{column_data}}', $val, $options['wrap_all']['columns']);

$new_row[$key] = str_replace('{{col_name}}', $key, $new_row[$key]);

}

foreach ($new_row as $key => $val) {

$row[$key] = $val;

}

}

// ability to rename columns for display purposes, note this happens after all processing

$new_row = array();

if (isset($options['column_display_names'])) {

foreach ($row as $row_name => $v) {

$row_renamed = false;

foreach ($options['column_display_names'] as $orig_col_name => $col_rename_to) {

if ($row_name == $orig_col_name) {

$row_renamed = true;

$new_row[$col_rename_to] = $v;

}

}

if (!$row_renamed) {

$new_row[$row_name] = $v;

}

}

if (!empty($new_row)) {

$row = $new_row;

}

}

// ability to reorder array keys to new positions

// note if the column display names option is used above then you must use the new names

// given to the columns

$new_row = array();

$old_row = $row;

if (isset($options['column_order'])) {

foreach ($options['column_order'] as $reordered_column) {

foreach ($row as $row_name => $v) {

if ($row_name == $reordered_column) {

$new_row[$reordered_column] = $v;

unset($old_row[$row_name]);

}

}

}

if (!empty($new_row)) {

$new_row = array_merge($new_row, $old_row);

$row = $new_row;

}

}

// hide any colums

if (isset($options['hide_columns'])) {

foreach ($options['hide_columns'] as $hide_col) {

foreach ($row as $row_name => $v) {

if ($row_name == $hide_col) {

unset($row[$hide_col]);

}

}

}

}

array_push($json['data'], $row);

$x = $x + 1;

}

if (isset($options['include_columns'])) {

if (isset($json['data'][0])) {

$columns = array();

foreach ($json['data'][0] as $col => $val) {

$columns[]['data'] = $col;

}

if (!empty($columns)) {

$new_json = array();

$new_json['records'] = $json;

$new_json['columns'] = $columns;

$json = $new_json;

}

}

}

$json = json_encode($json);

return $json;

}

/**

* This function only produces the COUNT query wrapped in `_dt_record_cnt`

* The parent function produces the main select queries

*/

protected function _build_select() {

if (!$this->cnt_query) {

return parent::_build_select();

}

// If the query is raw we need to remove the LIMIT and OFFSET and

// replace the param values before proceeding.

if ($this->_is_raw_query) {

$this->_values = $this->_raw_parameters;

$query = $this->_raw_query;

$new_vals = array();

if (is_array($this->_values)) {

foreach ($this->_values as $k => $v) {

// @todo find a better way to do this for raw_queries

if ($k == 'limit') {

$query = str_ireplace('LIMIT :limit', '', $query);

continue;

}

if ($k == 'offset') {

$query = str_ireplace('OFFSET :offset', '', $query);

continue;

}

if (!is_numeric($v)) {

$v = '"' . $v . '"';

}

$query = str_replace(':' . $k, $v, $query);

}

}

$query = "SELECT COUNT(*) as _dt_record_cnt FROM (" . $query . ") dt_bridge_cnt";

return $query;

}

// Build and return the full SELECT statement by concatenating

// the results of calling each separate builder method.

$query = $this->_join_if_not_empty(" ", array(

$this->_build_select_start(),

$this->_build_join(),

$this->_build_where(),

$this->_build_group_by(),

$this->_build_having(),

$this->_build_order_by(),

$this->_build_limit(),

$this->_build_offset(),

));

$query = "SELECT COUNT(*) as _dt_record_cnt FROM (" . $query . ") dt_bridge_cnt";

return $query;

}

/**

* Execute the SELECT query that has been built up by chaining methods

* on this class. Return an array of rows as associative arrays.

*/

protected function _run() {

// allow parent method to run

if (!$this->cnt_query) {

// need a way to make sure this is set

if ($this->_is_raw_query) {

if (is_array($this->_raw_parameters)) {

foreach ($this->_raw_parameters as $k => $v) {

if (!is_numeric($v)) {

$v = '"' . $v . '"';

}

$this->_raw_query = str_replace(':' . $k, $v, $this->_raw_query);

}

}

}

return parent::_run();

}

// we are not caching the COUNT - @todo - implement caching

$query = $this->_build_select();

parent::_execute($query, $this->_values, $this->_connection_name);

$statement = parent::get_last_statement();

$rows = array();

while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {

$rows[] = $row;

}

// reset Idiorm bound values

$this->_values = array();

return $rows;

}

/**

* @param string $str

* @return array

*/

private function getTemplatedValues($str) {

$templated_vals = array();

// extract a list of strings between {{tags}}

preg_match_all('/{{.*?}}/is', $str, $matches);

$matches = $matches[0];

foreach ($matches as $m) {

$m = str_replace('{{', '', $m);

$m = str_replace('}}', '', $m);

$templated_vals[] = $m;

}

return $templated_vals;

}

/**

* Factory method, a repeat of content in parent::for_table, so that

* created class is ORMDatatableBridge, not ORM

*

* @param string $table_name

* @param string $connection_name

* @return ORMDatatableBridge

*/

public static function for_table($table_name, $connection_name = parent::DEFAULT_CONNECTION) {

self::_setup_db($connection_name);

return new self($table_name, array(), $connection_name);

}

}