FooterTotalColumn Class Reference

Inheritance diagram for FooterTotalColumn:

Collaboration diagram for FooterTotalColumn:

Public Member Functions
	FooterTotalColumn ($field, $template="", $style="", $colspan=1, $typeHint=Number)
	onStartRow ($item)
	format ()
	Renderering function for the footer column. More...
Public Member Functions inherited from FooterColumn
	FooterColumn ($style="", $colspan=1)

Public Attributes
	$total = 0
	$template = ""
	$field = ""
Public Attributes inherited from FooterColumn
	$colspan
	The colspan for this column. More...
	$style
	Any CSS styles to be applied to this column. More...

Detailed Description

Definition at line 171 of file data_column.inc.

Member Function Documentation

FooterTotalColumn()

FooterTotalColumn::FooterTotalColumn	(		$field,
			$template = "",
			$style = "",
			$colspan = 1,
			$typeHint = Number
	)

Parameters

string	$field	- the field to be totals
string	$template	- the formatting template
string	$style
number	$colspan

Definition at line 184 of file data_column.inc.

     {
          $this->field = $field;
          $this->typeHint = $typeHint;
          
          /*
           * If the calling function puts a "$" before the
           * field name, then mark this as type currency and
           * output the "$" before the total.
           */
          if (!is_callable($this->field) && strpos($this->field, "$", 0) !== FALSE)
          {
               $this->typeHint = Currency;
               $this->field = substr($this->field, 1); 
          }
               
          /*
           * In case the field has template formatting instructions,
           * move those out to the template variable so that
           * the field var is just the field and can be totalled
           * correctly.
           */
          $matches = array();
          if (preg_match("/:(.*?)}/", $this->field, $matches))
          {
               $this->template = $matches[1];
               $this->field = str_replace($matches[1], "", $this->field);
          } 
          
          $this->FooterColumn($style, $colspan);
     }

format()

FooterTotalColumn::format

(

)

Renderering function for the footer column.

Returns

string

Reimplemented from FooterColumn.

Definition at line 233 of file data_column.inc.

     {
          if(!$this->typeHint || $this->typeHint == Number)
          {
               $renderer = new NumberTypeRenderer();
          }
          elseif($this->typeHint == Currency)
          {
               $renderer = new CurrencyTypeRenderer();
               $out = "$";
          }
          
          $out .= $renderer->format($this->total, $this->template);
          return $out;
     }

onStartRow()

FooterTotalColumn::onStartRow

(

$item

)

Definition at line 216 of file data_column.inc.

     {
          if (is_callable($this->field))
          {
               $val = call_user_func($this->field, $item);
          }
          else 
          {
               $val = $item->format($this->field);
          }
          
          // Make the number a raw number value before adding
          $val = str_replace(",", "", $val);
          
          $this->total += $val;
     }

Member Data Documentation

$field

FooterTotalColumn::$field = ""

Definition at line 175 of file data_column.inc.

$template

FooterTotalColumn::$template = ""

Definition at line 174 of file data_column.inc.

$total

FooterTotalColumn::$total = 0

Definition at line 173 of file data_column.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/framework/data_column.inc