egroupware/phpgwapi/inc/class.sbox2.inc.php

<?php
  /**************************************************************************\
  * phpGroupWare API - Select Box 2                                          *
  * Written by Ralf Becker <RalfBecker@outdoor-training.de>                  *
  * Class for creating select boxes for addresse, projects, array items, ... *
  * Copyright (C) 2000, 2001 Dan Kuykendall                                  *
  * -------------------------------------------------------------------------*
  * This library is part of the phpGroupWare API                             *
  * http://www.phpgroupware.org/api                                          * 
  * ------------------------------------------------------------------------ *
  * This library is free software; you can redistribute it and/or modify it  *
  * under the terms of the GNU Lesser General Public License as published by *
  * the Free Software Foundation; either version 2.1 of the License,         *
  * or any later version.                                                    *
  * This library 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 Lesser General Public License for more details.              *
  * You should have received a copy of the GNU Lesser General Public License *
  * along with this library; if not, write to the Free Software Foundation,  *
  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
  \**************************************************************************/

  /* $Id$ */

  class sbox2 {
  	
		/*
		 * Function:	search for an id of an db-entry, eg. an address
		 * Parameter:	$name			base name for all template-vars and of the submitted vars (not to conflict with other template-var-names !!!)
		 *					$lang_name	titel of the field
		 *					$prompt		for the JavaScript prompt()
		 *					$id_name		id of previosly selected entry
		 *					$content		from id (eg. 'company: lastname, givenname' for address $id) if $id != 0, or
		 *									array with searchresult (id's as key), if array is empty if search was unsucsessful
		 * Returns:		array with vars to set in temaplate, the vars are:
		 *						{doSearchFkt}		Javascript Funktion, place somewhere in Template (before rest of the vars)
		 *						{$name.'_title}	button with titel $lang_name (if JS) or just $lang_name
		 *    				{$name}				content of $id if != 0, or lang('use Button to search for').$lang_name
		 *						{$name.'_nojs}		searchfield + button if we have no JavaScript, else empty
		 *
		 * To use call $template->set_var(getIdSearch( ... ));
		 * the template should look like {doSeachFkt} <tr><td>{XXX_title}</td><td>{XXX}</td><td>{XXX_nojs}</td></tr>   (XXX is content of $name)
		 * In the submitted page the vars $query_XXX and $id_XXX are set according to what is selected, see getAddress as Example
		 */

		function getId($name,$lang_name,$prompt,$id_name,$content='') {
			// echo "<p>getId('$name','$lang_name','$prompt',$id_name,'$content') =";
			global $phpgw;
			
			$ret['doSearchFkt'] = 
'<script language="JavaScript">'."\n".
" function doSearch(field,ask) {\n".
"  field.value = prompt(ask,'');\n".
"  if (field.value != 'null') {\n".
"   if (field.value.length == 0)\n".
"    field.value = '%';\n".
"   field.form.submit();\n".
"  } else\n".
"   field.value = ''\n".
" }\n".
'</script>';

			$ret[$name.'_title'] =
'<script language="JavaScript">'."\n".
" document.writeln('<input type=\"hidden\" name=\"query_$name\" value=\"\">');\n".
" document.writeln('<input type=\"button\" onClick=\"doSearch(this.form.query_$name,\'$prompt\')\" value=\"$lang_name\">');\n".
"</script>\n".
"<noscript>\n".
" $lang_name\n".
"</noscript>";

			if (is_array($content)) {		// result from search
				if (!count($content)) {		// search was unsuccsessful
					$ret[$name] = lang('no entries found, try again ...');
				} else {
					$ret[$name.'_OK'] = '';	// flag we have something so select
					$ret[$name] = "<select name=\"id_$name\">\n";
					while (list( $id,$text ) = each( $content )) {
						$ret[$name] .= "<option value=\"$id\">" . $phpgw->strip_html($text) . "\n";
					}
					$ret[$name] .= '<option value="0">'.lang('none')."\n";
					$ret[$name] .= '</select>';
				}
			} else {
				if ($id_name) {			
					$ret[$name] = $content . "\n<input type=\"hidden\" name=\"id_$name\" value=\"$id_name\">";
				} else {
					$ret[$name] = '<span class=note>'.lang('use Button to search for').' '.$lang_name.'</span>';
				}				
			}			
			
			$ret[$name.'_nojs'] =
"<noscript>\n".
" <input name=\"query_$name\" value=\"\" size=10> &nbsp;	<input type=\"submit\" value=\"?\">\n".
"</noscript>";

			// print_r($ret);
			
			return $ret;
		}

		function addr2name( $addr ) {
			global $phpgw;
			$name = $addr['n_family'];
			if ($addr['n_given'])
				$name .= ', '.$addr['n_given'];
			else 
				if ($addr['n_prefix'])
					$name .= ', '.$addr['n_prefix'];
			if ($addr['org_name'])
				$name = $addr['org_name'].': '.$name;
			return $phpgw->strip_html($name);			
		}

		/*
		 * Function		Allows you to show and select an address from the addressbook (works with and without javascript !!!)
		 * Parameters	$name 		string with basename of all variables (not to conflict with the name other template or submitted vars !!!)
		 *					$id_name		id of the address for edit or 0 if none selected so far
		 *					$query_name have to be called $query_XXX, the search pattern after the submit, has to be passed back to the function
		 * On Submit	$id_XXX		contains the selected address (if != 0)
		 *					$query_XXX	search pattern if the search button is pressed by the user, or '' if regular submit
		 * Returns		array with vars to set for the template, set with: $template->set_var( getAddress( ... )); (see getId( ))
		 *
		 * Note			As query's for an address are submitted, you have to check $query_XXX if it is a search or a regular submit (!$query_string)
		 */
		 
		function getAddress( $name,$id_name,$query_name,$title='') {
			// echo "<p>getAddress('$name',$id_name,'$query_name','$title')</p>";
			global $phpgw;
			
			if ($id_name || $query_name) {
				$contacts = createobject('phpgwapi.contacts');

				if ($query_name) {
					$addrs = $contacts->read( 0,0,'',$query_name,'','DESC','org_name,n_family,n_given' );
					$content = array( );
					while ($addrs && list( $key,$addr ) = each( $addrs )) {
						$content[$addr['id']] = $this->addr2name( $addr );
					}
				} else {
					list( $addr ) = $contacts->read_single_entry( $id_name );
					if (count($addr)) {
						$content = $this->addr2name( $addr );
					}			
				}
			}
			if (!$title) $title = lang('Addressbook');
			
			return $this->getId($name,$title,lang('Pattern for Search in Addressbook'),$id_name,$content);
		}		

		function addr2email( $addr,$home='' ) {
			global $phpgw;
			
			if (!is_array($addr)) {
				$home = substr($addr,-1) == 'h';
				$contacts = createobject('phpgwapi.contacts');
				list( $addr ) = $contacts->read_single_entry( intval($addr) );
			}			
			if ($home) $home = '_home';

			if (!count($addr) || !$addr['email'.$home])
				return False;

			if ($addr['n_given'])
				$name = $addr['n_given'];
			else 
				if ($addr['n_prefix'])
					$name = $addr['n_prefix'];
			
			$name .= ($name ? ' ' : '') . $addr['n_family'];

			return $name.' <'.$addr['email'.$home].'>';			
		}

		function getEmail( $name,$id_name,$query_name,$title='') {
			// echo "<p>getAddress('$name',$id_name,'$query_name','$title')</p>";
			global $phpgw;
			
			if ($id_name || $query_name) {
				$contacts = createobject('phpgwapi.contacts');

				if ($query_name) {
					$addrs = $contacts->read( 0,0,'',$query_name,'','DESC','org_name,n_family,n_given' );
					$content = array( );
					while ($addrs && list( $key,$addr ) = each( $addrs )) {
						if ($addr['email'])
							$content[$addr['id']] = $this->addr2email( $addr );
						if ($addr['email_home'])
							$content[$addr['id'].'h'] = $this->addr2email( $addr,'_home' );
					}
				} else {
					$content = $this->addr2email( $id_name );
				}
			}
			if (!$title) $title = lang('Addressbook');
			
			return $this->getId($name,$title,lang('Pattern for Search in Addressbook'),$id_name,$content);
		}
		
		/*
		 * Function		Allows you to show and select an project from the projects-app (works with and without javascript !!!)
		 * Parameters	$name 		string with basename of all variables (not to conflict with the name other template or submitted vars !!!)
		 *					$id_name		id of the project for edit or 0 if none selected so far
		 *					$query_name have to be called $query_XXX, the search pattern after the submit, has to be passed back to the function
		 * On Submit	$id_XXX		contains the selected address (if != 0)
		 *					$query_XXX	search pattern if the search button is pressed by the user, or '' if regular submit
		 * Returns		array with vars to set for the template, set with: $template->set_var( getProject( ... )); (see getId( ))
		 *
		 * Note			As query's for an address are submitted, you have to check $query_XXX if it is a search or a regular submit (!$query_string)
		 */
		 
		function getProject( $name,$id_name,$query_name,$title='' ) {
			// echo "<p>getProject('$name',$id_name,'$query_name','$title')</p>";
			global $phpgw;
			
			if ($id_name || $query_name) {
				$projects = createobject('projects.projects');
				if ($query_name) {
					$projs = $projects->read_projects( 0,0,$query_name,'','','','',0 );
					$content = array();
					while ($projs && list( $key,$proj ) = each( $projs )) {
						$content[$proj['id']] = $proj['title'];
					}			
				} else {
					list( $proj ) = $projects->read_single_project( $id_name );
					if (count($proj)) {
						$content = $proj['title'];
						// $customer_id = $proj['customer'];
					}
				}
			}			
			if (!$title) $title = lang('Project');
			
			return $this->getId($name,$title,lang('Pattern for Search in Projects'),$id_name,$content);
		}	

		/*
		 * Function:		Allows to show and select one item from an array
		 *	Parameters:		$name		string with name of the submitted var which holds the key of the selected item form array
		 *						$key		key of already selected item from $arr
		 *						$arr		array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
		 *						$no_lang	if !$no_lang send items through lang() 
		 * On submit		$XXX		is the key of the selected item (XXX is the content of $name) 
		 * Returns:			string to set for a template or to echo into html page 
		 */
		 
		function getArrayItem($name, $key, $arr=0,$no_lang=0) {		// should be in class common.sbox
     		if (!is_array($arr))
				$arr = array('no','yes');
				
     		$out = "<select name=\"$name\">\n";
  		
  			while (list($k,$text) = each($arr)) {              
  				$out .= '<option value="'.$k.'"';
  				if($k == $key) $out .= " SELECTED";
  				$out .= ">" . ($no_lang ? $text : lang($text)) . "</option>\n";
  			}
        	$out .= "</select>\n";
			
        	return $out;
     	}

		function accountInfo($id,$account_data=0,$longname=0) {
			global $phpgw;
			
			if (!$id) return '&nbsp;';
			
			if (!is_array($account_data)) {
				$accounts = createobject('phpgwapi.accounts',$id);
				$accounts->db = $phpgw->db;
				$accounts->read_repository();
				$account_data = $accounts->data;
			}
			if ($longnames)
			   return $account_data['firstname'].' '.$account_data['lastname'];
				
			return $account_data['account_lid'];	
		}		

		/*
		 * Function:		Allows to select one accountname
		 *	Parameters:		$name		string with name of the submitted var, which holds the account_id or 0 after submit
		 *						$id		account_id of already selected account
		 *						$id2text($id,$acct_data)	fkt that translates account_id $id in text to show
		 */
		 
		function getAccount($name,$id,$longnames=0) {
			global $phpgw;
			$accounts = createobject('phpgwapi.accounts');
			$accounts->db = $phpgw->db;
			$accs = $accounts->get_list('accounts'); 
			
			$aarr = Array(lang('not assigned'));
			while ($a = current($accs)) {
				$aarr[$a['account_id']] = $this->accountInfo($a['account_id'],$a,$longnames);
				next($accs);
			}
			return $this->getArrayItem($name,$selected,$aarr,1);			
		}
  }