File Manager

<?php

/**
 * This file defines the abstract tabular report generator class.
 *
 * @package CGExtensions
 * @category Reports
 * @author  calguy1000 <calguy1000@cmsmadesimple.org>
 * @copyright Copyright 2010 by Robert Campbell
 */

namespace CGExtensions\reports;

/**
 * An abstract class to aide in generating a tabular report.
 */
abstract class tabular_report_generator extends report_generator
{
    /**
     * @ignore
     */
    private   $_row;

    /**
     * @ignore
     */
    private   $_prev_row;

    /**
     * @ignore
     */
    protected $_record_number = 0;

    /**
     * @ignore
     */
    protected function set_row($input_row)
    {
        // preprocess the data. so that we have values for all of our column keys
        // even if the values are empty.
        $rs = $this->report()->get_resultset();
        $row = array();
        foreach( $this->report()->get_columns() as $key => $col ) {
            $val = '';
            if( isset($input_row[$key]) ) $val = $input_row[$key];
            $row[$key] = $col->process_value($val,$rs);
        }

        if( is_array($this->_row) ) $this->_prev_row = $this->_row;
        $this->_row = $row;
    }

    /**
     * @ignore
     */
    protected function finish()
    {
        $this->do_group_footers(TRUE);
    }

    /**
     * A callback function that is called before each and every line.
     *
     * @abstract
     * @return void
     */
    protected function before_line() {}

    /**
     * A callback function that is called after each and every line.
     *
     * @abstract
     * @return void
     */
    protected function after_line() {}

    /**
     * A callback function that is called before the start of outputing group footers.
     *
     * @abstract
     * @return void
     */
    protected function before_group_footers() {}

    /**
     * A callback function that is called after the outputing group footers.
     *
     * @abstract
     * @return void
     */
    protected function after_group_footers() {}

    /**
     * A callback function that is called before the outputing group headers.
     *
     * @abstract
     * @return void
     */
    protected function before_group_headers() {}

    /**
     * A callback function that is called after the outputing group headers.
     *
     * @abstract
     * @return void
     */
    protected function after_group_headers() {}

    /**
     * A callback function to draw a cell.
     *
     * @abstract
     * @param tabular_report_cellfmt $cell
     * @param string $contents the cell contents.
     */
    abstract protected function draw_cell(tabular_report_cellfmt $cell,$contents);

    /**
     * A function to get cell contents for the specified column of the current row.
     *
     * @param string $col_key The column key (must be a registered column)
     * @param string $tpl The cell template.
     * @return string The formatted cell contents.
     */
    protected function get_cell_contents($col_key,$tpl)
    {
        $smarty = cmsms()->GetSmarty();

        $val = '';
        if( isset($this->_row[$col_key]) ) $val = $this->_row[$col_key];
        $col = $this->report()->get_column($col_key);

        $smarty->assign('val',$val);
        $smarty->assign('value',$val);

        $smarty->assign('min',$col->get_min());
        $smarty->assign('max',$col->get_max());
        $smarty->assign('count',$col->get_count());
        $smarty->assign('sum',$col->get_sum());
        $smarty->assign('mean',$col->get_mean());
        $smarty->assign('median',$col->get_median());
        $tmp = $smarty->fetch('string:'.$tpl);
        return $tmp;
    }

    /**
     * A function to get cell contents for a group header or footer cell.
     *
     * @param string $col_key The column key (must be a registered column)
     * @param string $grp_key The group key.
     * @param string $tpl The cell template.
     * @return string The formatted cell contents.
     */
    protected function get_group_cell_contents($col_key,$grp_key,$tpl)
    {
        $smarty = cmsms()->GetSmarty();
        $col = $this->report()->get_column($col_key);
        $smarty->assign('label',$col->get_label());
        $smarty->assign('grp_min',$col->get_grp_min($grp_key));
        $smarty->assign('grp_max',$col->get_grp_max($grp_key));
        $smarty->assign('grp_count',$col->get_grp_count($grp_key));
        $smarty->assign('grp_sum',$col->get_grp_sum($grp_key));
        $smarty->assign('grp_mean',$col->get_grp_mean($grp_key));
        $smarty->assign('grp_median',$col->get_grp_median($grp_key));
        $smarty->assign('last_val',$this->_prev_row[$col_key]);
        $contents = $this->get_cell_contents($col_key,$tpl);
        return $contents;
    }

    /**
     * A callback function called before each row.
     *
     * @abstract
     * @return void
     */
    protected function before_row()
    {
        $this->do_group_footers();
        $this->do_group_headers();
    }

    /**
     * A callback function called after each row.
     *
     * @abstract
     * @return void
     */
    protected function after_row()
    {
        $this->add_column_histories($this->_row);
        $this->_record_number++;
    }

    /**
     * Test if the value for a specified group has changed.
     *
     * @param tabular_report_defn_group $grp The group that references the watched column.
     * @param array $row The data row.
     * @return bool
     */
    protected function changed(tabular_report_defn_group $grp,$row)
    {
        $col_key = $grp->get_column();
        if( array_key_exists($col_key,$row) ) {
            $val = $row[$col_key];
            $col = $this->report()->get_column($col_key);
            return $col->changed($val);
        }
        return FALSE;
    }

    /**
     * A callback function that is called before a single group header is output.
     *
     * @abstract
     * @param tabular_report_defn_group $grp
     * @return void
     */
    protected function before_group_header(tabular_report_defn_group $grp) {}

    /**
     * A callback function that is called after a single group header is output.
     *
     * @abstract
     * @param tabular_report_defn_group $grp
     * @return void
     */
    protected function after_group_header(tabular_report_defn_group $grp) {}

    /**
     * @ignore
     */
    protected function do_group_header(tabular_report_defn_group $grp,$idx)
    {
        $lines = $grp->get_header_lines();
        if( count($lines) ) {
            $this->before_group_header($grp);
            foreach( $lines as $line ) {
                $this->before_line();
                $columns = $this->report()->get_columns();
                $keys = array_keys($columns);
                for( $col_idx = 0; $col_idx < count($keys); ) {
                    $key = $keys[$col_idx];
                    $contents = null;
                    $fmt = $line->get_cell_format($key);
                    if( is_object($fmt) ) {
                        $contents = $this->get_group_cell_contents($key,$grp->get_column(),$fmt->get_template());
                    } else {
                        // there is no format information specified in the header line
                        // but we need to know stuff like (maybe background color, alignment, color etc)
                        // so get a format from the report
                        $fmt = $this->report()->get_column($key);
                        $contents = $this->get_group_cell_contents($key,$grp->get_column(),'');
                    }
                    $this->draw_cell($fmt,$contents);
                    $col_idx += max(1,$fmt->get_span());
                }
                $this->after_line();
            }
            $this->after_group_header($grp);
        }
    }

    /**
     * @ignore
     */
    protected function do_group_headers($do_headers = false)
    {
        $grps = $this->report()->get_groups();
        if( count($grps) ) {
            foreach( $grps as $grp ) {
                $grp_header_num = 0;
                if( $do_headers || $this->_record_number == 0 || $this->changed($grp,$this->_row) ) {
                    if( $grp_header_num == 0 ) $this->before_group_headers();
                    $this->do_group_header($grp,$grp_header_num);
                }
                $grp_header_num++;
            }
        }
        if( $grp_header_num > 0 ) $this->after_group_headers();
    }

    /**
     * A callback function that is called before a single group footer is generated.
     *
     * @abstract
     * @param tabular_report_defn_group $grp
     * @return void
     */
    protected function before_group_footer(tabular_report_defn_group $grp) {}

    /**
     * A callback function that is called after a single group footer is generated.
     *
     * @abstract
     * @param tabular_report_defn_group $grp
     * @return void
     */
    protected function after_group_footer(tabular_report_defn_group $grp) {}

    /**
     * @ignore
     */
    protected function do_group_footer(tabular_report_defn_group $grp,$idx)
    {
        $lines = $grp->get_footer_lines();
        if( count($lines) ) {
            $this->before_group_footer($grp);
            foreach( $lines as $line ) {
                $this->before_line();
                $columns = $this->report()->get_columns();
                $keys = array_keys($columns);
                for( $col_idx = 0; $col_idx < count($keys); ) {
                    $key = $keys[$col_idx];
                    $contents = null;
                    $fmt = $line->get_cell_format($key);
                    if( is_object($fmt) ) {
                        $contents = $this->get_group_cell_contents($key,$grp->get_column(),$fmt->get_template());
                    } else {
                        // there is no format information specified in the header line
                        // but we need to know stuff like (maybe background color, alignment, color etc)
                        // so get a format from the report
                        $fmt = $this->report()->get_column($key);
                        $contents = $this->get_group_cell_contents($key,$grp->get_column(),'');
                    }
                    $this->draw_cell($fmt,$contents);
                    $col_idx += max(1,$fmt->get_span());
                }
                $this->after_line();
            }
            $this->after_group_footer($grp);
        }
        // this group has changed, go through all columns and reset this group
        foreach( $this->report()->get_columns() as $key => $col ) {
            $col->reset_group($grp->get_column());
        }
    }

    /**
     * @ignore
     */
    protected function do_group_footers($do_footers = false)
    {
        $grp_footer_num = 0;
        if( $do_footers || $this->_record_number > 0 ) {
            // check for column changes
            $grps = $this->report()->get_groups();
            if( count($grps) ) {
                end($grps);
                do {
                    $grp = current($grps);
                    if( $do_footers || $this->changed($grp,$this->_row) ) {
                        if( $grp_footer_num == 0 ) $this->before_group_footers();
                        $this->do_group_footer($grp,$grp_footer_num);
                        $grp_footer_num++;
                    }
                }
                while( prev($grps) );
            }
        }
        if( $grp_footer_num > 0 ) $this->after_group_footers();
    }

    /**
     * @ignore
     */
    protected function add_column_histories($row)
    {
        foreach( $this->report()->get_columns() as $key => &$col ) {
            if( array_key_exists($key,$row) ) {
                $val = $row[$key];
                $col->add_history_value($val);
                $grps = $this->report()->get_groups();
                if( count($grps) ) {
                    foreach( $grps as &$grp ) {
                        $col->add_group_history_value($grp->get_column(), $val);
                    }
                }
            }
        }
    }

    /**
     * @ignore
     */
    protected function each_row($row)
    {
        $this->set_row($row);
        $this->before_row();
        $this->before_line();
        $content_columns = $this->report()->get_content_columns();
        foreach( $this->report()->get_columns() as $key => $col ) {
            if( in_array($key,$content_columns) ) {
                // this column is in the main content row
                // though the value may still be null.
                $tpl = $this->report()->get_column($key)->get_template();
                if( !$tpl ) $tpl = '{$val}';
                $this->draw_cell($col,$this->get_cell_contents($key,$tpl));
            }
            else {
                // this column is not in the main content row
                // so draw a null value
                $this->draw_cell($col,null);
            }
        }
        $this->after_line();
        $this->after_row();
    }

} // end of class

?>