/library/Adapto/Recordlist/PrintableRecordList.php

<?php

/**
 * This file is part of the Adapto Toolkit.
 * Detailed copyright and licensing information can be found
 * in the doc/COPYRIGHT and doc/LICENSE files which should be 
 * included in the distribution.
 *
 * @package adapto
 * @subpackage recordlist
 *
 * @copyright (c)2000-2004 Ivo Jansch
 * @license http://www.achievo.org/atk/licensing ATK Open Source License
 *

 */

/** @internal include base class */

/**
 * Recordlist implementation that renders a recordlist that is 
 * 'printer-friendly'.
 *
 * It doesn't render any actions or links, and can only be used as a
 * readonly list of records.
 *
 * @author ijansch
 * @package adapto
 * @subpackage recordlist
 *
 */
class Adapto_Recordlist_PrintableRecordList extends Adapto_RecordList
{

    /**
     * Creates printableRecordlist
     * @param $suppresslist
     * obsolete by specialRecordList
     */

    /**
     * Creates printableRecordlist
     * obsolete by specialRecordList
     *
     * @param atkEntity $entity         the entity
     * @param Array   $recordset    the list of records
     * @param Array   $suppressList fields we don't display
     * @param int  		$flags  			The prefix for embeded fields
     * @return String The rendered recordlist
     */
    function render(&$entity, $recordset, $suppressList = "", $flags = 0)
    {
        $this->setEntity($entity);
        $this->m_flags = $flags;

        $output = '<table border="0" cellspacing="0" cellpadding="4">';

        $output .= "<tr>";

        // stuff for the totals row..
        $totalisable = false;
        $totals = array();

        // display a headerrow with titles.
        // Since we are looping the attriblist anyway, we also check if there
        // are totalisable collumns.
        foreach (array_keys($this->m_entity->m_attribList) as $attribname) {
            $p_attrib = &$this->m_entity->m_attribList[$attribname];
            $musthide = (is_array($suppressList) && count($suppressList) > 0 && in_array($attribname, $suppressList));
            if (($p_attrib->hasFlag(AF_HIDE_LIST) == false)
                    && (($p_attrib->hasFlag(AF_HIDE_SELECT) == false) || ($this->m_entity->m_action != "select")) && $musthide == false) {
                $output .= '<td><b>' . atktext($p_attrib->fieldName(), $this->m_entity->m_module, $this->m_entity->m_type) . '</b></td>';

                // the totalisable check..
                if ($p_attrib->hasFlag(AF_TOTAL)) {
                    $totalisable = true;
                }

            }
        }

        $output .= "</tr>";

        for ($i = 0, $_i = count($recordset); $i < $_i; $i++) {
            $output .= '<tr>';
            foreach (array_keys($this->m_entity->m_attribList) as $attribname) {
                $p_attrib = &$this->m_entity->m_attribList[$attribname];
                $musthide = (is_array($suppressList) && count($suppressList) > 0 && in_array($attribname, $suppressList));
                if (($p_attrib->hasFlag(AF_HIDE_LIST) == false)
                        && (($p_attrib->hasFlag(AF_HIDE_SELECT) == false) || ($this->m_entity->m_action != "select")) && $musthide == false) {
                    // An <attributename>_display function may be provided in a derived
                    // class to display an attribute.
                    $funcname = $p_attrib->m_name . "_display";

                    if (method_exists($this->m_entity, $funcname)) {
                        $value = $this->m_entity->$funcname($recordset[$i], "list");
                    } else {
                        // otherwise, the display function of the particular attribute
                        // is called.
                        $value = $p_attrib->display($recordset[$i], "list");
                    }
                    $output .= '<td>' . ($value == "" ? "&nbsp;" : $value) . '</td>';

                    // Calculate totals..
                    if ($p_attrib->hasFlag(AF_TOTAL)) {
                        $totals[$attribname] = $p_attrib->sum($totals[$attribname], $recordset[$i]);
                    }
                }
            }

            $output .= '</tr>';
        }

        // totalrow..
        if ($totalisable) {
            $totalRow = '<tr>';

            // Third loop.. this time for the totals row.
            foreach (array_keys($this->m_entity->m_attribList) as $attribname) {
                $p_attrib = &$this->m_entity->m_attribList[$attribname];
                $musthide = (is_array($suppressList) && count($suppressList) > 0 && in_array($attribname, $suppressList));
                if (($p_attrib->hasFlag(AF_HIDE_LIST) == false)
                        && (($p_attrib->hasFlag(AF_HIDE_SELECT) == false) || ($this->m_entity->m_action != "select")) && $musthide == false) {
                    if ($p_attrib->hasFlag(AF_TOTAL)) {
                        $totalRow .= '<td><b>' . $p_attrib->display($totals[$attribname], "list") . '</b></td>';
                    } else {
                        $totalRow .= '<td>&nbsp;</td>';
                    }
                }
            }

            $totalRow .= "</tr>";

            $output .= $totalRow;
        }

        $output .= '</table>';

        return $output;

    }
}

?>