mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-12-26 16:49:10 +01:00
7c92b70b90
Do the query in return_array() only once; Make formated_list() a wrapper to formatted_list();
494 lines
15 KiB
PHP
494 lines
15 KiB
PHP
<?php
|
|
/**************************************************************************\
|
|
* phpGroupWare API - Categories *
|
|
* This file written by Joseph Engo <jengo@phpgroupware.org> *
|
|
* Category manager *
|
|
* Copyright (C) 2000, 2001 Joseph Engo *
|
|
* -------------------------------------------------------------------------*
|
|
* 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 categories
|
|
@abstract class adds ability for applications to make use of categories
|
|
@discussion examples can be found in notes app
|
|
*/
|
|
class categories
|
|
{
|
|
var $account_id;
|
|
var $app_name;
|
|
var $cats;
|
|
var $db;
|
|
var $total_records;
|
|
var $grants;
|
|
|
|
/*!
|
|
@function categories
|
|
@abstract constructor for categories class
|
|
@param $accountid account id
|
|
@param $app_name app name defaults to current app
|
|
*/
|
|
function categories($accountid = '',$app_name = '')
|
|
{
|
|
$account_id = get_account_id($accountid);
|
|
|
|
if (! $app_name)
|
|
{
|
|
$app_name = $GLOBALS['phpgw_info']['flags']['currentapp'];
|
|
}
|
|
|
|
$this->account_id = $account_id;
|
|
$this->app_name = $app_name;
|
|
$this->db = $GLOBALS['phpgw']->db;
|
|
$this->grants = $GLOBALS['phpgw']->acl->get_grants($app_name);
|
|
$this->cats = $this->return_array($type,$start,$limit,$query,$sort,$order,$public);
|
|
}
|
|
|
|
/*!
|
|
@function filter
|
|
@abstract ?
|
|
@param $type string
|
|
@result string either subs or mains
|
|
*/
|
|
function filter($type)
|
|
{
|
|
switch ($type)
|
|
{
|
|
case 'subs': $s = " AND cat_parent != '0'"; break;
|
|
case 'mains': $s = " AND cat_parent = '0'"; break;
|
|
case 'appandmains': $s = " AND cat_appname='" . $this->app_name . "' AND cat_parent ='0'"; break;
|
|
case 'appandsubs': $s = " AND cat_appname='" . $this->app_name . "' AND cat_parent !='0'"; break;
|
|
default: return False;
|
|
}
|
|
return $s;
|
|
}
|
|
|
|
/*!
|
|
@function total
|
|
@abstract returns the total number of categories for app, subs or mains
|
|
@param $for one of either 'app' 'subs' or 'mains'
|
|
@result integer count of categories
|
|
*/
|
|
function total($for = 'app')
|
|
{
|
|
switch($for)
|
|
{
|
|
case 'app': $w = " WHERE cat_appname='" . $this->app_name . "'"; break;
|
|
case 'appandmains': $w = " WHERE cat_appname='" . $this->app_name . "' AND cat_parent ='0'"; break;
|
|
case 'appandsubs': $w = " WHERE cat_appname='" . $this->app_name . "' AND cat_parent !='0'"; break;
|
|
case 'subs': $w = " WHERE cat_parent != '0'"; break;
|
|
case 'mains': $w = " WHERE cat_parent = '0'"; break;
|
|
default: return False;
|
|
}
|
|
|
|
$this->db->query("SELECT COUNT(cat_id) FROM phpgw_categories $w",__LINE__,__FILE__);
|
|
$this->db->next_record();
|
|
|
|
return $this->db->f(0);
|
|
}
|
|
|
|
/*!
|
|
@function return_array
|
|
@abstract return an array populated with categories
|
|
@param $type string defaults to 'all'
|
|
@param $start ?
|
|
@param $limit ?
|
|
@param $query string defaults to ''
|
|
@param $sort string sort order, either defaults to 'ASC'
|
|
@param $order order by
|
|
@result $cats array
|
|
*/
|
|
function return_array($type,$start,$limit = True,$query = '',$sort = '',$order = '',$public = False, $parent_id = '')
|
|
{
|
|
if ($public)
|
|
{
|
|
$public_cats = " OR cat_appname='phpgw'";
|
|
}
|
|
|
|
$filter = $this->filter($type);
|
|
|
|
if (!$sort)
|
|
{
|
|
$sort = 'ASC';
|
|
}
|
|
|
|
if ($order)
|
|
{
|
|
$ordermethod = " ORDER BY $order $sort";
|
|
}
|
|
else
|
|
{
|
|
$ordermethod = ' ORDER BY cat_main, cat_level, cat_name ASC';
|
|
}
|
|
|
|
if (is_array($this->grants))
|
|
{
|
|
$grants = $this->grants;
|
|
while(list($user) = each($grants))
|
|
{
|
|
$public_user_list[] = $user;
|
|
}
|
|
reset($public_user_list);
|
|
$grant_cats = " (cat_owner='" . $this->account_id . "' OR cat_access='public' AND cat_owner in(" . implode(',',$public_user_list) . ")) ";
|
|
}
|
|
else
|
|
{
|
|
$grant_cats = " cat_owner='" . $this->account_id . "' ";
|
|
}
|
|
|
|
if ($parent_id)
|
|
{
|
|
$parent_filter = " AND cat_parent='$parent_id'";
|
|
}
|
|
|
|
if ($query)
|
|
{
|
|
$querymethod = " AND (cat_name LIKE '%$query%' OR cat_description LIKE '%$query%') ";
|
|
}
|
|
|
|
$sql = "SELECT * from phpgw_categories WHERE (cat_appname='" . $this->app_name . "' AND" . $grant_cats . $public_cats . ")"
|
|
. $parent_filter . $querymethod . $filter;
|
|
|
|
if ($limit)
|
|
{
|
|
$this->db->limit_query($sql . $ordermethod,$start,__LINE__,__FILE__);
|
|
}
|
|
else
|
|
{
|
|
$this->db->query($sql . $ordermethod,__LINE__,__FILE__);
|
|
}
|
|
|
|
$this->total_records = $this->db->num_rows();
|
|
|
|
$i = 0;
|
|
while ($this->db->next_record())
|
|
{
|
|
$cats[$i]['id'] = $this->db->f('cat_id');
|
|
$cats[$i]['owner'] = $this->db->f('cat_owner');
|
|
$cats[$i]['access'] = $this->db->f('cat_access');
|
|
$cats[$i]['app_name'] = $this->db->f('cat_appname');
|
|
$cats[$i]['main'] = $this->db->f('cat_main');
|
|
$cats[$i]['level'] = $this->db->f('cat_level');
|
|
$cats[$i]['parent'] = $this->db->f('cat_parent');
|
|
$cats[$i]['name'] = $this->db->f('cat_name');
|
|
$cats[$i]['description'] = $this->db->f('cat_description');
|
|
$cats[$i]['data'] = $this->db->f('cat_data');
|
|
$i++;
|
|
}
|
|
return $cats;
|
|
}
|
|
|
|
/*!
|
|
@function return_single
|
|
@abstract return single
|
|
@param $id integer id of category
|
|
@result $cats array populated with
|
|
*/
|
|
function return_single($id = '')
|
|
{
|
|
$this->db->query('SELECT * FROM phpgw_categories WHERE cat_id=' . $id,__LINE__,__FILE__);
|
|
|
|
if ($this->db->next_record())
|
|
{
|
|
$cats[0]['id'] = $this->db->f('cat_id');
|
|
$cats[0]['owner'] = $this->db->f('cat_owner');
|
|
$cats[0]['access'] = $this->db->f('cat_access');
|
|
$cats[0]['app_name'] = $this->db->f('cat_appname');
|
|
$cats[0]['main'] = $this->db->f('cat_main');
|
|
$cats[0]['level'] = $this->db->f('cat_level');
|
|
$cats[0]['parent'] = $this->db->f('cat_parent');
|
|
$cats[0]['name'] = $this->db->f('cat_name');
|
|
$cats[0]['description'] = $this->db->f('cat_description');
|
|
$cats[0]['data'] = $this->db->f('cat_data');
|
|
}
|
|
return $cats;
|
|
}
|
|
|
|
/*!
|
|
@function formatted_list
|
|
@abstract return into a select box, list or other formats
|
|
@param $format currently only supports select (select box)
|
|
@param $type string - subs or mains
|
|
@param $selected - cat_id or array with cat_id values
|
|
@result $s array - populated with categories
|
|
*/
|
|
function formated_list($format,$type,$selected = '',$public = False,$site_link = 'site')
|
|
{
|
|
return $this->formatted_list($format,$type,$selected,$public,$site_link);
|
|
}
|
|
function formatted_list($format,$type,$selected = '',$public = False,$site_link = 'site')
|
|
{
|
|
if(is_array($format))
|
|
{
|
|
$temp_format = $format['format'];
|
|
$type = $format['type'];
|
|
$selected = (isset($format['selected'])?$format['selected']:'');
|
|
$public = (isset($format['public'])?$format['public']:False);
|
|
$site_link = (isset($format['site_link'])?$format['site_link']:'site');
|
|
settype($format,'string');
|
|
$format = $temp_format;
|
|
unset($temp_format);
|
|
}
|
|
|
|
$filter = $this->filter($type);
|
|
|
|
if (!is_array($selected))
|
|
{
|
|
$selected = explode(',',$selected);
|
|
}
|
|
|
|
if ($format == 'select')
|
|
{
|
|
$cats = $this->return_array($type,$start,False,$query,$sort,$order,$public);
|
|
|
|
for ($i=0;$i<count($cats);$i++)
|
|
{
|
|
$s .= '<option value="' . $cats[$i]['id'] . '"';
|
|
if (in_array($cats[$i]['id'],$selected))
|
|
{
|
|
$s .= ' selected';
|
|
}
|
|
$s .= '>' . $GLOBALS['phpgw']->strip_html($cats[$i]['name']);
|
|
if ($cats[$i]['app_name'] == 'phpgw')
|
|
{
|
|
$s .= '<' . lang('Global') . '>';
|
|
}
|
|
$s .= '</option>' . "\n";
|
|
}
|
|
return $s;
|
|
}
|
|
|
|
if ($format == 'list')
|
|
{
|
|
$space = ' ';
|
|
|
|
$cats = $this->return_array($type,$start,False,$query,$sort,$order,$public);
|
|
|
|
$s = '<table border="0" cellpadding="2" cellspacing="2">' . "\n";
|
|
|
|
if ($this->total_records > 0)
|
|
{
|
|
for ($i=0;$i<count($cats);$i++)
|
|
{
|
|
$image_set = ' ';
|
|
|
|
if (in_array($cats[$i]['id'],$selected))
|
|
{
|
|
$image_set = '<img src="' . PHPGW_IMAGES_DIR . '/roter_pfeil.gif">';
|
|
}
|
|
|
|
if (($cats[$i]['level'] == 0) && !in_array($cats[$i]['id'],$selected))
|
|
{
|
|
$image_set = '<img src="' . PHPGW_IMAGES_DIR . '/grauer_pfeil.gif">';
|
|
}
|
|
|
|
$space_set = str_repeat($space,$cats[$i]['level']);
|
|
|
|
$s .= '<tr>' . "\n";
|
|
$s .= '<td width="8">' . $image_set . '</td>' . "\n";
|
|
$s .= '<td>' . $space_set . '<a href="' . $GLOBALS['phpgw']->link($site_link,'cat_id=' . $cats[$i]['id']) . '">'
|
|
. $GLOBALS['phpgw']->strip_html($cats[$i]['name'])
|
|
. '</a></td>' . "\n"
|
|
. '</tr>' . "\n";
|
|
}
|
|
}
|
|
$s .= '</table>' . "\n";
|
|
return $s;
|
|
}
|
|
}
|
|
|
|
/*!
|
|
@function add
|
|
@abstract add categories
|
|
@param $cat_name category name
|
|
@param $cat_parent category parent
|
|
@param $cat_description category description defaults to ''
|
|
@param $cat_data category data defaults to ''
|
|
*/
|
|
function add($cat_values)
|
|
{
|
|
if ($cat_values['parent'] && $cat_values['parent'] != 0)
|
|
{
|
|
$cat_values['main'] = $this->id2name($cat_values['parent'],'main');
|
|
$cat_values['level'] = $this->id2name($cat_values['parent'],'level')+1;
|
|
}
|
|
|
|
$cat_values['descr'] = $this->db->db_addslashes($cat_values['descr']);
|
|
$cat_values['name'] = $this->db->db_addslashes($cat_values['name']);
|
|
|
|
$this->db->query("INSERT INTO phpgw_categories (cat_parent,cat_owner,cat_access,cat_appname,cat_name,cat_description,cat_data,"
|
|
. "cat_main,cat_level) VALUES ('" . $cat_values['parent'] . "','" . $this->account_id . "','" . $cat_values['access']
|
|
. "','" . $this->app_name . "','" . $cat_values['name'] . "','" . $cat_values['descr'] . "','" . $cat_values['data']
|
|
. "','" . $cat_values['main'] . "','" . $cat_values['level'] . "')",__LINE__,__FILE__);
|
|
|
|
if (!$cat_values['parent'] || $cat_values['parent'] == 0)
|
|
{
|
|
$this->db->query("SELECT MAX(cat_id) AS max FROM phpgw_categories",__LINE__,__FILE__);
|
|
$this->db->next_record();
|
|
$max = $this->db->f('max');
|
|
$this->db->query("UPDATE phpgw_categories SET cat_main='" . $max . "' WHERE cat_id='"
|
|
. $max . "'",__LINE__,__FILE__);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
@function delete
|
|
@abstract delete category
|
|
@param $cat_id int - category id
|
|
*/
|
|
function delete($cat_id,$subs = False)
|
|
{
|
|
if ($subs)
|
|
{
|
|
$subdelete = " OR cat_parent='$cat_id' OR cat_main='$cat_id' ";
|
|
}
|
|
|
|
$this->db->query("DELETE FROM phpgw_categories WHERE cat_id='$cat_id' $subdelete AND cat_appname='"
|
|
. $this->app_name . "'",__LINE__,__FILE__);
|
|
}
|
|
|
|
/*!
|
|
@function edit
|
|
@abstract edit a category
|
|
@param $cat_id int - category id
|
|
@param $cat_parent category parent
|
|
@param $cat_description category description defaults to ''
|
|
@param $cat_data category data defaults to ''
|
|
*/
|
|
function edit($cat_values)
|
|
{
|
|
if ($cat_values['parent'] && ($cat_values['parent'] != 0))
|
|
{
|
|
$cat_values['main'] = $this->id2name($cat_values['parent'],'main');
|
|
$cat_values['level'] = $this->id2name($cat_values['parent'],'level')+1;
|
|
}
|
|
else
|
|
{
|
|
$cat_values['main'] = $cat_values['id'];
|
|
$cat_values['level'] = 0;
|
|
}
|
|
|
|
$cat_values['descr'] = $this->db->db_addslashes($cat_values['descr']);
|
|
$cat_values['name'] = $this->db->db_addslashes($cat_values['name']);
|
|
|
|
$sql = "UPDATE phpgw_categories SET cat_name='" . $cat_values['name'] . "', cat_description='" . $cat_values['descr']
|
|
. "', cat_data='" . $cat_values['data'] . "', cat_parent='" . $cat_values['parent'] . "', cat_access='"
|
|
. $cat_values['access'] . "', cat_main='" . $cat_values['main'] . "', cat_level='" . $cat_values['level'] . "' "
|
|
. "WHERE cat_appname='" . $this->app_name . "' AND cat_id='" . $cat_values['id'] . "'";
|
|
|
|
$this->db->query($sql,__LINE__,__FILE__);
|
|
}
|
|
|
|
function name2id($cat_name)
|
|
{
|
|
$this->db->query("SELECT cat_id FROM phpgw_categories WHERE cat_name='" . $cat_name . "' AND cat_appname='" . $this->app_name
|
|
. "' AND cat_owner=" . $this->account_id,__LINE__,__FILE__);
|
|
|
|
if(!$this->db->num_rows())
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
$this->db->next_record();
|
|
|
|
return $this->db->f('cat_id');
|
|
}
|
|
|
|
function id2name($cat_id = '', $item = 'name')
|
|
{
|
|
if ($cat_id == '')
|
|
{
|
|
return '--';
|
|
}
|
|
switch($item)
|
|
{
|
|
case 'name': $value = 'cat_name'; break;
|
|
case 'owner': $value = 'cat_owner'; break;
|
|
case 'main': $value = 'cat_main'; break;
|
|
case 'level': $value = 'cat_level'; break;
|
|
}
|
|
|
|
$this->db->query("SELECT $value FROM phpgw_categories WHERE cat_id='" . $cat_id . "'",__LINE__,__FILE__);
|
|
$this->db->next_record();
|
|
|
|
if ($this->db->f($value))
|
|
{
|
|
return $this->db->f($value);
|
|
}
|
|
else
|
|
{
|
|
if ($item == 'name')
|
|
{
|
|
return '--';
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
@function return_name
|
|
@abstract return category name given $cat_id
|
|
@param $cat_id
|
|
@result cat_name category name
|
|
*/
|
|
// NOTE: This is only a temp wrapper, use id2name() to keep things matching across the board. (jengo)
|
|
function return_name($cat_id)
|
|
{
|
|
return $this->id2name($cat_id);
|
|
}
|
|
|
|
/*!
|
|
@function exists
|
|
@abstract used for checking if a category name exists
|
|
@param $type subs or mains
|
|
@param $cat_name category name
|
|
@result boolean true or false
|
|
*/
|
|
function exists($type,$cat_name = '',$cat_id = '')
|
|
{
|
|
$filter = $this->filter($type);
|
|
|
|
if ($cat_name)
|
|
{
|
|
$cat_exists = " cat_name='" . $this->db->db_addslashes($cat_name) . "' ";
|
|
}
|
|
|
|
if ($cat_id)
|
|
{
|
|
$cat_exists = " cat_parent='$cat_id' ";
|
|
}
|
|
|
|
if ($cat_name && $cat_id)
|
|
{
|
|
$cat_exists = " cat_name='" . $this->db->db_addslashes($cat_name) . "' AND cat_id != '$cat_id' ";
|
|
}
|
|
|
|
$this->db->query("SELECT COUNT(cat_id) FROM phpgw_categories WHERE $cat_exists $filter",__LINE__,__FILE__);
|
|
|
|
$this->db->next_record();
|
|
|
|
if ($this->db->f(0))
|
|
{
|
|
return True;
|
|
}
|
|
else
|
|
{
|
|
return False;
|
|
}
|
|
}
|
|
}
|
|
?>
|