File Source for sp_grid

<?php
// *** Tangra (Application Framework and Tools for PHP)
// $Id$
//
/**
* Contains class SP_Grid_WLC
*
* @package tangra_lib
* @subpackage grids
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'grids/static_paginated_grid.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'exceptions/te_key_already_exists.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'exceptions/te_grid_invalid_number_values_for_link_cols.class.php');
/**
* Static Grid with link columns and paginator
*
* @package tangra_lib
* @subpackage grids
*/
class SP_Grid_WLC extends Static_Paginated_Grid {
/**
* Link columns
*
* @var array
* @internal
*/
private $link_cols = array();
/**
* Link columns capture values
*
* @var unknown_type
* @internal
*/
private $link_cols_capture_values_rows = array();
/**
* Adds new column
*
* Adds new linl column to the grid with name <var>$name</var>,
* href link pointing to <var>$target</var> and capture <var>$capture</var>.
* Generated link will look like: <a href="$target?$capture=$link_column_capture">Something</a>
*
* @param string $name Column name
* @param string $target_page Target page
* @param string $capture Label for the capture
*/
public function add_link_col($name, $target_page, $capture) {
if (!array_key_exists($name, $this->link_cols)) {
$this->link_cols[$name]['target_page'] = $target_page;
$this->link_cols[$name]['capture'] = $capture;
} else {
throw new TE_Key_Already_Exists($name);
}
}
/**
* Returns array containing web events that grid may generate
*
* @return array
*/
public function get_web_events() {
$ret = parent::get_web_events();
foreach($this->link_cols as $link_col) {
//matches only event targeted at current page
if ($link_col['target_page'] == $this->get_web_page()) {
$ret [] = new Web_Event_Simple_Int($link_col['capture'], Tangra_Parameter_Method::GET, $link_col['capture']);
}
}
return $ret;
}
/**
* Returns TPLE exports for the grid
*
* @return TPLE_Exports
*/
public function get_tple_exports() {
$exports = parent::get_tple_exports();
$exports->add_pair($this->get_name().'_prows_count', count($this->prepare_rows()));
return $exports;
}
/**
* Returns HTML for the grid
*
* @param string $path Path to template file
* @param string $language Navive language code
* @return string
*/
public function get_static_html($path, $language) {
$tple = new Tple();
$tple->set_delimiters('{@', '@}');
$tple->assign('cols_number', $this->get_columns_number());
$tple->assign('grid_name', $this->get_name());
$tple->assign('link_cols', $this->link_cols);
$tple->assign('language', $language);
$html = $tple->fetch($path.'/sp_grid_wlc.tpl');
return $html;
}
/**
* Adds link columns capture values
*
* Link columns capture values are values that will be added at the end of the link.
* Example:
* <a href="somepage.php?obj=5">
* somepage.php is <var>$target</var> @see SP_Grid_WLC::add_link_col()
* obj is the capture label
* 5 is the link column capture value - normally this is the id of the record but you
* may use different column @see SP_Grid_WLC::set_rows_and_link_cols_rows_from_raw_rows
*
* @param arary $row
*/
public function add_link_cols_capture_values_row($row) {
$have = count($row);
$must_have = count($this->link_cols);
if ($have == $must_have) {
$this->link_cols_capture_values_rows[] = $row;
} else {
throw new TE_Grid_Invalid_Number_Values_For_Link_Cols($must_have, $have);
}
}
/**
* Sets all link columns capture values at once
*
* @param array $rows
*/
public function set_link_cols_capture_values_rows($rows) {
foreach($rows as $row) {
$this->add_link_cols_capture_values_row($row);
}
}
/**
* Prepares row to be used in a convinient way by this class
*
* @return string
* @internal
* @throws TE_Key_Not_Exists
*/
protected function prepare_rows() {
$ret = array();
foreach($this->rows as $row_key => $row) {
if (array_key_exists($row_key, $this->link_cols_capture_values_rows)) {
$ret[$row_key]['cols'] = $row;
$ret[$row_key]['lc_vals'] = $this->link_cols_capture_values_rows[$row_key];
} else {
throw new TE_Key_Not_Exists($row_key);
}
}
return $ret;
}
/**
* Sets all data rows and link column capture rows using "raw rows"
*
* @param array $raw_rows Array of rows as returned by the SELECT form DB
* @param integer $use_col_num Which column to be used for value of link columns capture value
* @param boolean $skip_used_col If true used column will be skipped and will not exists in final array
*/
public function set_rows_and_link_cols_rows_from_raw_rows($raw_rows, $use_col_num = 0, $skip_used_col = false) {
tangra_if_not_int_throw_e($use_col_num);
foreach($raw_rows as $row) {
$c = 0;
for($i = 0; $i <= (count($row) - 1);$i++) {
if ($use_col_num == $i) {
//preparing one row of link_cols_rows
$link_cols_row = array();
foreach($this->link_cols as $key => $link_col) {
$link_cols_row[$key] = $row[$use_col_num];
}
$this->add_link_cols_capture_values_row($link_cols_row);
//setting row
if ($skip_used_col) {
unset($row[$use_col_num]);
$row = $this->shift_down($row);
$this->add_row($row);
} else {
$this->add_row($row);
}
}
}
}
}
/**
* Sets all rows at once
*
* Shorhand for setting all rows with using column 0 and skipping used column
* This function is convinient when you select from database like:
* "Select obj.id, obj.name, obj.description where...".
*
* @param array $rows
* @see SP_Grid_WLC::set_rows_and_link_cols_rows_from_raw_rows
*/
public function set_rows(&$rows) {
$this->set_rows_and_link_cols_rows_from_raw_rows($rows, 0, true);
}
/**
* Shifts down the array in order to have continiuos array index starting with 0
*
* @param array $row
* @return array
* @internal
*/
private function shift_down($row) {
$ret = array();
if ($row) {
$c = 0;
foreach($row as $item) {
$ret[$c] = $item;
$c++;
}
}
return $ret;
}
}

Source for file sp_grid_wlc.class.php