source: trunk/lib/TemplateGlue.inc.php

<?php
/**
 * The Strangecode Codebase - a general application development framework for PHP
 * For details visit the project site: <http://trac.strangecode.com/codebase/>
 * Copyright 2001-2012 Strangecode, LLC
 *
 * This file is part of The Strangecode Codebase.
 *
 * The Strangecode Codebase is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * The Strangecode Codebase is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * TemplateGlue.inc.php
 */

/**
 * Returns an image tag for image specified in $src.
 *
 * @param  string $src     File name of the image, including path and file extension.
 * @param  string $alt     Alt tag text.
 * @param  string $extra   Additional attributes.
 */
function oImg($src, $alt='', $extra='')
{
    $filepath = preg_match('!://!', $src) ? $src : getenv('DOCUMENT_ROOT') . $src;

    if (true === ($gis = @getimagesize($filepath)) && !preg_match('/width|height/', $extra)) {
        $image_size = $gis[3];
    } else {
        $image_size = '';
    }

    return sprintf('<img src="%s" %s alt="%s" %s />',
        $src,
        $image_size,
        oTxt($alt),
        $extra
    );
}

/**
 * Prints an image tag for image specified in $src.
 *
 * @param  string $src     File name of the image, including path and file extension.
 * @param  string $alt     Alt tag text.
 * @param  string $extra   Additional attributes.
 */
function printImg($src, $alt='', $extra='')
{
    echo oImg($src, $alt, $extra);
}

/**
 * Finds the values of an enumeration or set column of a MySQL database, returning them in an array.
 * Use this to generate a pull-down menu of options or to validate the existence
 * of options. (Quinn 10 Feb 2001)
 *
 * @param  string $db_table   database table to lookup
 * @param  string $db_col     database column to lookup
 * @param  bool   $sort          Sort the output.
 * @return array    Array of the set/enum values on success, false on failure.
 */
function getSetEnumFieldValues($db_table, $db_col, $sort=false)
{
    $app =& App::getInstance();
    $db =& DB::getInstance();

    $qid = $db->query("SHOW COLUMNS FROM " . $db->escapeString($db_table) . " LIKE '" . $db->escapeString($db_col) . "'",false);

    $row = mysql_fetch_row($qid);
    if (isset($row[1]) && preg_match('/^enum|^set/i', $row[1]) && preg_match_all("/'([^']*)'/", $row[1], $enum)) {
        if ($sort) {
            natsort($enum[1]);
        }
        return $enum[1];
    } else {
        $app->logMsg(sprintf('No set or enum fields found for %s.%s', $db_table, $db_col), LOG_ERR, __FILE__, __LINE__);
        return false;
    }
}

/**
 * Prints option fields for a select form. Works only with enum or set
 * data types in table columns.
 *
 * @param  string $db_table     Database table to lookup
 * @param  string $db_col       Database column to lookup
 * @param  string $preselected  The currently selected value of the menu. compared to the $val_column
 * @param  bool   $first        Optional first item; set true for a blank item, array for item with name and value.
 * @param  bool   $sort         Sort the output.
 */
function printSetSelectForm($db_table, $db_col, $preselected, $first=false, $sort=false)
{
    $values = getSetEnumFieldValues($db_table, $db_col, $sort);
    if ($values === false) {
        ?><option value="">&nbsp;</option>
        <?php
        return false;
    }
    if (true === $first) {
        $selected = ($preselected == '') ? ' selected' : '';
        ?><option value=""<?php echo $selected; ?>>&nbsp;</option>
        <?php
    }
    // When the 'blank' value needs a specific key->val pair.
    if (is_array($first)) {
        foreach ($first as $key=>$val) {
            $selected = ($preselected == $val) ? ' selected="selected"' : '';
            ?><option value="<?php echo oTxt($key); ?>"<?php echo $selected; ?>><?php echo oTxt($val); ?></option>
            <?php
        }
    }
    foreach ($values as $v) {
        $selected = ($v == $preselected) ? ' selected' : '';
        ?><option value="<?php echo oTxt($v); ?>"<?php echo $selected; ?>><?php echo oTxt($v); ?></option>
        <?php
    }
}

/**
 * Prints radio buttons from a set/enum column.
 *
 * @param  string $db_table     Database table to lookup
 * @param  string $db_col       Database column to lookup
 * @param  string $preselected  The currently selected value of the menu. compared to the $val_column
 * @param  bool   $first        Optional first item; set true for a blank item, array for item with name and value.
 * @param  bool   $sort         Sort the output.
 */
function printEnumRadios($name, $db_table, $db_col, $preselected, $first=false, $sort=false)
{
    $values = getSetEnumFieldValues($db_table, $db_col, $sort);
    if ($values === false) {
        return false;
    }

    foreach ($values as $v) {
        $selected = ($v == $preselected) ? ' checked="checked"' : '';
        ?><label class="sc-label-secondary"><input type="radio" name="<?php echo oTxt($name) ?>" id="<?php echo oTxt($v); ?>" value="<?php echo oTxt($v); ?>"<?php echo $selected; ?> /> <?php echo oTxt($v); ?></label>
        <?php
    }
}

/**
 * Prints checkbox fields. Works only with enum or set
 * data types in table columns.
 *
 * @param  string $db_table      database table to lookup
 * @param  string $db_col        database column to lookup
 * @param  array  $preselected   array of preselected values (matching the values in $db_col)
 * @param  int    $columns       number of table columns to print
 * @param  int    $flag          set to 'allone' for name of input fields to all be the same of a multidimensional array.
 * @param  bool   $sort          Sort the output.
 */
function printSetCheckboxes($db_table, $db_col, $preselected, $columns=1, $flag=null, $sort=false)
{
    ?>
    <table>
        <tr>
    <?php
    // Sometimes preselected comes as a comma list.
    if (!is_array($preselected)) {
        $preselected = explode(',', $preselected);
    }

    // Checkbox POST data has the primary data in the keys, and 'on' as the values.
    // Here we assume in all the values of an array are 'on' that we can find the data
    // in the array keys.
    $ps_value_count = array_count_values($preselected);
    if (isset($ps_value_count['on']) && $ps_value_count['on'] == sizeof($preselected)) {
        $preselected = array_keys($preselected);
    }

    // Retrieve values of a Set or ENUM database column.
    $values = getSetEnumFieldValues($db_table, $db_col, $sort);

    // Initialize the HTML table generation vars.
    $num_cells = sizeof($values) - 1;
    $num_rows = floor($num_cells / $columns);
    $cols_lastrow = $num_cells % $columns;
    $row_cnt = 0;
    $col_cnt = 0;
    foreach ($values as $v) {
        if ($col_cnt == $columns) {
            // Begin a new row.
            ?></tr><tr><?php
            $col_cnt = 0;
            $row_cnt++;
        }
        if ($col_cnt < $cols_lastrow) {
            $lastrow_add = $col_cnt;
        } else {
            $lastrow_add = $cols_lastrow;
        }
        $curr = $num_rows * $col_cnt + $lastrow_add + $row_cnt;
        $col_cnt++;

        // Look for preselected value.
        if (in_array($v, $preselected)) {
            $checked = ' checked="checked"';
        } else {
            $checked = '';
        }
        if ('allone' == $flag) {
            // Print a cell with multidimensional array checkboxes.
            $html_name = 'dbcol[' . $db_col . '][' . $v . ']';
        } else {
            // Print a cell with basic named checkboxes.
            $html_name = $db_col . '[' . $v . ']';
        }
        ?><td><label class="sc-label-secondary"><input type="checkbox" name="<?php echo oTxt($html_name); ?>" id="<?php echo oTxt($html_name); ?>"<?php echo $checked; ?> /> <?php echo oTxt($v); ?></label></td>
        <?php
    }
    if ($col_cnt < $columns) {
        // This last cell must expand to fill the last blank cells.
        ?><td colspan="<?php echo $columns - $col_cnt; ?>">&nbsp;</td><?php
    }
    ?>
        </tr>
    </table><?php
}

/**
 * Prints radio select fields. Works only with enum or set
 * data types in table columns.
 *
 * @param  string $db_table      database table to lookup
 * @param  string $db_col        database column to lookup
 * @param  array  $preselected   array of preselected values (matching the values in $db_col)
 * @param  int    $columns       number of table columns to print
 * @param  bool   $sort          Sort the output.
 */
function printSetRadios($db_table, $db_col, $preselected, $columns=1, $sort=false)
{
    ?>
    <table>
        <tr>
    <?php
    // Sometimes preselected comes as a comma list.
    if (!is_array($preselected)) {
        $preselected = explode(',', $preselected);
    }

    // Checkbox POST data has the primary data in the keys, and 'on' as the values.
    // Here we assume in all the values of an array are 'on' that we can find the data
    // in the array keys.
    $ps_value_count = array_count_values($preselected);
    if (isset($ps_value_count['on']) && $ps_value_count['on'] == sizeof($preselected)) {
        $preselected = array_keys($preselected);
    }

    // Retrieve values of a Set or ENUM database column.
    $values = getSetEnumFieldValues($db_table, $db_col, $sort);

    // Initialize the HTML table generation vars.
    $num_cells = sizeof($values) - 1;
    $num_rows = floor($num_cells / $columns);
    $cols_lastrow = $num_cells % $columns;
    $row_cnt = 0;
    $col_cnt = 0;
    foreach ($values as $v) {
        if ($col_cnt == $columns) {
            // Begin a new row.
            ?></tr><tr><?php
            $col_cnt = 0;
            $row_cnt++;
        }
        if ($col_cnt < $cols_lastrow) {
            $lastrow_add = $col_cnt;
        } else {
            $lastrow_add = $cols_lastrow;
        }
        $curr = $num_rows * $col_cnt + $lastrow_add + $row_cnt;
        $col_cnt++;

        // Look for preselected value.
        if (in_array($v, $preselected)) {
            $checked = ' checked="checked"';
        } else {
            $checked = '';
        }
        // Print a cell with basic named checkboxes.
        ?><td><label class="sc-label-secondary"><input type="radio" name="<?php echo oTxt($db_col); ?>" id="<?php echo oTxt($db_col . '-' . $v); ?>" value="<?php echo oTxt($v); ?>"<?php echo $checked; ?> /> <?php echo oTxt($v); ?></label></td>
        <?php
    }
    if ($col_cnt < $columns) {
        // This last cell must expand to fill the last blank cells.
        ?><td colspan="<?php echo $columns - $col_cnt; ?>">&nbsp;</td><?php
    }
    ?>
        </tr>
    </table><?php
}

/**
 * Prints a pulldown menu containing the specified values and keys of a table.
 *
 * @param  string $db_table         database table to lookup
 * @param  string $key_column       column containing the human-readable titles for the select menu
 * @param  string $val_column       column containing the computer values for the select menu
 * @param  string $preselected      the currently selected value of the menu. compared to the $val_column
 * @param  bool   $first            Optional first item; set true for a blank item, array for item with name and value.
 * @param  string $extra_clause     SQL exclude clause. Something like "WHERE girls != 'buckteeth'"
 */
function printSelectForm($db_table, $key_column, $val_column, $preselected, $first=false, $extra_clause='', $sql_format='SELECT %1$s, %2$s FROM %3$s %4$s')
{
    $db =& DB::getInstance();

    // Sometimes preselected comes as a comma list.
    if (!is_array($preselected)) {
        $preselected = array($preselected);
    }

    // Print a blank first option.
    if (true === $first) {
        $selected = in_array('', $preselected) ? ' selected="selected"' : '';
        ?><option value=""<?php echo $selected; ?>>&nbsp;</option>
        <?php
    }

    // When the 'blank' value needs a specific key->val pair.
    if (is_array($first)) {
        foreach ($first as $key=>$val) {
            $selected = in_array($key, $preselected) ? ' selected="selected"' : '';
            ?><option value="<?php echo $key; ?>"<?php echo $selected; ?>><?php echo oTxt($val); ?></option>
            <?php
        }
    }
    // $qid = $db->query("SELECT $key_column, $val_column FROM $db_table $extra_clause",false);
    $qid = $db->query(sprintf($sql_format, $key_column, $val_column, $db_table, $extra_clause),false);
    while ($row = mysql_fetch_assoc($qid)) {
        $selected = in_array($row[$val_column], $preselected) ? ' selected="selected"' : '';
        ?><option value="<?php echo $row[$val_column]; ?>"<?php echo $selected; ?>><?php echo oTxt($row[$key_column]); ?></option><?php
    }
}

/**
 * Prints checkbox fields. Works only with enum or set
 * data types in table columns.
 *
 * @param  string $db_table         database table to lookup
 * @param  string $key_column       column containing the human-readable titles for the select menu
 * @param  string $val_column       column containing the computer values for the select menu
 * @param  string $preselected      the currently selected value of the menu. compared to the $val_column
 * @param  int    $columns          number of table columns to print
 * @param  int    $extra_clause     extra sql to send at end of select statement.
 * @param  bool   $vert_columns     display checkboxes in vertical orientation first.
 */
function printDBCheckboxes($db_table, $key_column, $val_column, $preselected, $columns=1, $extra_clause='', $vert_columns=false)
{
    $db =& DB::getInstance();

    // Sometimes preselected comes as a comma list.
    if (!is_array($preselected)) {
        $preselected = explode(',', $preselected);
    }

    // Checkbox POST data has the primary data in the keys, and 'on' as the values.
    // Here we assume in all the values of an array are 'on' that we can find the data
    // in the array keys.
    $ps_value_count = array_count_values($preselected);
    if (isset($ps_value_count['on']) && $ps_value_count['on'] == sizeof($preselected)) {
        $preselected = array_keys($preselected);
    }

    $qid = $db->query("SELECT $key_column, $val_column FROM $db_table $extra_clause",false);
    while ($row = mysql_fetch_assoc($qid)) {
        $values[] = $row;
    }

    // Rearrange array so sort is in vertical columns. FIXME: doesn't work.
//  if ($vert_columns) {
//      $per_col = ceil(sizeof($values) / $columns);
//      $columns = ceil(sizeof($values) / $per_col);
//      $curr_row = 0;
//      $curr_col = 0;
//      $pos = 0;
//         foreach ($values as $k=>$v) {
//             $pos = $curr_row * $columns + $curr_col;
//             if ($curr_row <= $per_col) {
//                 $curr_row++;
//             } else {
//                 $curr_row = 0;
//                 $curr_col++;
//             }
// //             echo '<li>' . $pos . '-' . $v[$key_column];
//             $new_values[$pos] = $v;
//         }
//         $values = $new_values;
//         ksort($values);
//  }

    if (empty($values)) {
        return false;
    }

    // Initialize the HTML table generation vars.
    $num_cells = sizeof($values) - 1;
    $num_rows = floor($num_cells / $columns);
    $cols_lastrow = $num_cells % $columns;
    $row_cnt = 0;
    $col_cnt = 0;
    ?>
    <table border="0" cellspacing="0" cellpadding="0">
        <tr>
    <?php
    foreach ($values as $box) {
        if ($col_cnt == $columns) {
            // Begin a new row.
            ?></tr><tr><?php
            $col_cnt = 0;
            $row_cnt++;
        }

        if ($col_cnt < $cols_lastrow) {
            $lastrow_add = $col_cnt;
        } else {
            $lastrow_add = $cols_lastrow;
        }

        $curr = $num_rows * $col_cnt + $lastrow_add + $row_cnt;
        $col_cnt++;

        // Look for preselected value.
        if (in_array($box[$val_column], $preselected)) {
            $checked = ' checked="checked"';
        } else {
            $checked = '';
        }

        // Print a cell with basic named checkboxes.
        $html_name = $val_column . '[' . $box[$val_column] . ']';
        $html_id = $val_column . '-' . $box[$val_column] . '';
        ?>
        <td><input type="checkbox" name="<?php echo oTxt($html_name); ?>" id="<?php echo oTxt($html_id); ?>"<?php echo $checked; ?> /></td>
        <td><label for="<?php echo oTxt($html_id); ?>" class="sc-normal"><?php echo oTxt($box[$key_column]); ?></label></td>
        <?php
    }

    if ($col_cnt < $columns) {
        // This last cell must expand to fill the last blank cells.
        ?><td colspan="<?php echo $columns - $col_cnt; ?>">&nbsp;</td><?php
    }
    ?>
        </tr>
    </table><?php
}

/**
 * Prints submit buttons based on given array of submit button names and titles.
 *
 * @access  public
 * @param   array   $submit_buttons     Array of buttons, the key being the button name, and value being the title of the button.
 * @return  void
 * @author  Quinn Comendant <quinn@strangecode.com>
 * @version 1.0
 * @since   15 Jun 2005 13:42:21
 */
function printSubmitButtons($submit_buttons)
{
    if (is_array($submit_buttons) && !empty($submit_buttons)) {
        foreach ($submit_buttons as $i => $b) {
            if (is_array($b)) {
                $defaults = array();
                $defaults['type'] = isset($b['type']) ? $b['type'] : 'submit';
                if (isset($b['href'])) {
                    echo '<a';
                    foreach (array_diff_key($b, array('value' => null)) as $key => $value) {
                        printf(' %s="%s"', $key, oTxt($value));
                    }
                    echo '>' . oTxt($b['value']) . '</a>';
                } else {
                    $defaults['id'] = isset($b['id']) ? $b['id'] : sprintf('sc-%s-button', $b['name']);
                    $b = array_merge($defaults, $b);
                    echo '<input';
                    foreach ($b as $key => $value) {
                        printf(' %s="%s"', $key, oTxt($value));
                    }
                    echo ' />';
                }
            } else {
                // For backwards compatibility.
                ?><input type="submit" name="<?php echo oTxt($i) ?>" value="<?php echo oTxt($b); ?>" /><?php
            }
        }
    }
}