Utilities.php

Go to the documentation of this file.

<?php
/*-------------------------------------------------------------------------------
 * Xataface Web Application Framework
 * Copyright (C) 2005-2008 Web Lite Solutions Corp (shannah@sfu.ca)
 * 
 * This program 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 2
 * of the License, or (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *-------------------------------------------------------------------------------
 */


class Dataface_Utilities {
        
        public static function groupBy($fieldname, $records, $order=array(), $titles=array()){
                import( 'PEAR.php');
                if (!is_array($records) ){
                        return PEAR::raiseError("In Dataface_Utilities::groupBy() expected 2nd parameter to be an array, but received "+$records);
                }
                
                
                $out = array();
                $unordered = array();
                $ordered = array();
                
                foreach ($order as $orderKey){
                        $ordered[$orderKey] = array();
                }
                
                
                foreach (array_keys($records) as $i){
                        if ( is_a($records[$i], 'Dataface_Record') || is_a($records[$i], 'Dataface_RelatedRecord') ){
                                $key = $records[$i]->qq($fieldname);
                                
                        } else if (is_array($records[$i]) ) {
                                $key = $records[$i][$fieldname];
                        } else {
                                return PEAR::raiseError("In Dataface_Utilities::groupBy() each of the elements in the list of records should be either an array or a Dataface_Record object (or a Dataface_RelatedRecord object), but received: ".$records[$i]);
                        }
                        if ( !$key ){
                                continue;
                        }
                        if ( isset( $ordered[$key] ) ) $ordered[$key][] =& $records[$i];
                        else {
                                if ( !isset($unordered[$key]) ){
                                        $unordered[$key] = array();
                                }
                        
                                $unordered[$key][] =& $records[$i];
                        }
                }
                $out = array_merge($ordered, $unordered);
                $out2 = array();
                foreach (array_keys($out) as $key){
                        if ( isset($titles[$key]) ){
                                $out2[$titles[$key]] =& $out[$key];
                        } else {
                                $out2[$key] =& $out[$key];
                        }
                }
                
                return $out2;
        
        }
        
        
        public static function query2html($query, $keyFilter=array()){
                foreach ( $keyFilter as $bad ){
                        if ( isset($query[$bad]) ) unset($query[$bad]);
                }
                $qt = array();
                //call_user_func(array(__CLASS__, 'flattenQuery'), $query, $qt);
                Dataface_Utilities::flattenQuery($query, $qt);
                
                ob_start();
                foreach ($qt as $key=>$value){
                        echo "<input type=\"hidden\" name=\"$key\" value=\"$value\" />\n";
                }       
                $out = ob_get_contents();
                ob_end_clean();
                return $out;
        }
        
        public static function flattenQuery($in,&$out, $path=array()){
                $origPath = $path;
                if ( !empty($path) ){
                        $prefix = array_shift($path);
                        if ( !empty($path) ){
                                $prefix .= '['.implode('][', $path).']';
                        }
                } else {
                        $prefix = '';
                }
                $hasprefix = !empty($prefix);
                foreach ($in as $key=>$value){
                        //if ( substr($key,0,2) == '--' ) continue;
                        if ( is_array($value) ){
                                $origPath[] = $key;
                                Dataface_Utilities::flattenQuery($value, $out, $origPath);
                        } else {
                                if ( $hasprefix ){
                                        $out[$prefix.'['.$key.']'] = $value;
                                } else {
                                        $out[$key] = $value;
                                }
                        }
                }
        }
        
        
        public static function fireEvent($name, $params=array()){
                $app =& Dataface_Application::getInstance();
                $query =& $app->getQuery();
                if ( isset($query['-table']) ){
                        $table =& Dataface_Table::loadTable($query['-table']);
                        $delegate =& $table->getDelegate();
                        if ( isset($delegate) && method_exists($delegate, $name) ){
                                //$res = call_user_func(array(&$delegate, $name));
                                $res = $delegate->$name($params);
                                return $res;
                        }
                }
                
                $appDelegate =& $app->getDelegate();
                if ( isset($appDelegate) && method_exists($appDelegate, $name) ){
                        //$res = call_user_func(array(&$appDelegate, $name));
                        $res = $appDelegate->$name($params);
                        return $res;
                }
        }
        
        
        public static function quoteIdent($ident){
                return str_replace('`','', $ident);
        }
        
        
        public static function redirect($msg=null, $error=null){
                $app =& Dataface_Application::getInstance();
                $query =& $app->getQuery();
                $prefix = @$query['--prefix'];
                if ( isset($query['--error_page']) and isset($error) ){
                        $page = $query['--error_page'];
                } else if ( isset($query['--success_page']) and !isset($error) ){
                        $page = $query['--success_page'];
                } else if ( isset($query['--redirect']) ){
                        $page = $query['--redirect'];
                }
                
                if ( !isset($page) ) return;
                if ( isset($error) ){
                        if ( strpos($page,'?') === false ) $page .= '?';
                        else $page .= '&';
                                
                        $page .= $prefix.'--error_message='.urlencode($res->getMessage()).'&'.$prefix.'--error_code='.urlencode($res->getCode());
                        
                }
                        
                if ( isset($msg) ){
                        if ( strpos($page,'?') === false ) $page .= '?';
                        $page .= $prefix.'--msg='.urlencode($msg);
                }
                
                $app->redirect("$page");
        }

}