[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] phpgwapi/inc/class.contacts_sql.inc.php, 1.17.2.2.2.6
|
From: |
nomail |
|
Subject: |
[Phpgroupware-cvs] phpgwapi/inc/class.contacts_sql.inc.php, 1.17.2.2.2.64 |
|
Date: |
Wed, 23 Jun 2004 10:24:02 +0200 |
Update of /phpgwapi/inc
Modified Files:
Branch: Version-0_9_16-branch
class.contacts_sql.inc.php
date: 2004/06/23 08:24:02; author: powerstat; state: Exp; lines: +73 -24
Log Message:
more phpdoc updates and removed 2 useless breaks
=====================================================================
Index: phpgwapi/inc/class.contacts_sql.inc.php
diff -u phpgwapi/inc/class.contacts_sql.inc.php:1.17.2.2.2.63
phpgwapi/inc/class.contacts_sql.inc.php:1.17.2.2.2.64
--- phpgwapi/inc/class.contacts_sql.inc.php:1.17.2.2.2.63 Mon Jun 21
07:49:45 2004
+++ phpgwapi/inc/class.contacts_sql.inc.php Wed Jun 23 08:24:02 2004
@@ -73,7 +73,6 @@
* be langed to get a label for the field
* @access private
*/
-
var $contact_fields = array('showable' =>
array(
'per_full_name'
=> 'full name',
@@ -257,8 +256,9 @@
)
);
+
/**
- *
+ * Maps database columns to contact classes
* @access private
*/
var $map = array('contact_id' =>
array('phpgwapi.contact_central', '0'),
@@ -452,7 +452,7 @@
'key_cat_id' =>
array('phpgwapi.contact_categories', '13'));
/**
- *
+ * Database columns for import/export
* @access private
*/
var $import_export_fields = array('contact_id',
@@ -498,7 +498,7 @@
'other_name');
/**
- *
+ * Database columns for import
* @access private
*/
var $import_fields = array('contact_id' => 'contact id',
@@ -598,7 +598,7 @@
}
/**
- *
+ * Read data from session into this object
*
* @access private
*/
@@ -665,7 +665,7 @@
}
/**
- *
+ * Save this object into session
*
* @access private
*/
@@ -701,9 +701,9 @@
}
/**
- * Get the information about contact of type `person'
+ * Get the information about contact of type 'person'
*
- * @return string
+ * @return string Contact person name
*/
function get_person_name()
{
@@ -713,23 +713,23 @@
/**
* Get the information about contact of type `Organization'
*
- * @return string
+ * @return string Organization name
*/
function get_org_name()
{
return $this->_contact_org;
}
- /*************************************************************\
- * Deprecated functions section *
- \*************************************************************/
- /* send this the id and whatever fields you want to see */
/**
+ * Read one contact entry and return the wanted fields
*
- *
+ * @param integer $id ID for contact entry to read
+ * @param array $fields Wanted fields filter
+ * @return array Array with ine contact entry
* @deprecated
* @access private
+ * @internal send this the id and whatever fields you want to see
*/
function read_single_entry($id,$fields='')
{
@@ -798,6 +798,10 @@
}
/**
+ * Read last contact entry and return wanted fields
+ *
+ * @param array $fields Wanted fields
+ * @return array Array with contact fields
* @deprecated
* @access private
*/
@@ -809,7 +813,18 @@
}
/**
- * Send this the range, query, sort, order and whatever fields
you want to see
+ *
+ *
+ * @param $start
+ * @param $limit
+ * @param $fields
+ * @param $query
+ * @param $filter
+ * @param $sort
+ * @param $order
+ * @param $lastmod
+ * @return
+ * @internal Send this the range, query, sort, order and
whatever fields you want to see
* @deprecated
* @access private
*/
@@ -855,6 +870,11 @@
/**
*
*
+ * @param $owner
+ * @param $fields
+ * @param $access
+ * @param $cat_id
+ * @param $tid
* @deprecated This method is for old import only, I ask help to
code a new one
* @access private
*/
@@ -900,6 +920,9 @@
/**
*
*
+ * @param $id
+ * @param $field_name
+ * @return
* @deprecated
* @access private
*/
@@ -917,6 +940,10 @@
/**
*
*
+ * @param $id
+ * @param $owner
+ * @param $field_name
+ * @param $field_value
* @deprecated
* @access private
*/
@@ -929,6 +956,9 @@
/**
*
*
+ * @param $id
+ * @param $field_name
+ * @return
* @deprecated
* @access private
*/
@@ -941,6 +971,12 @@
/**
*
*
+ * @param $id
+ * @param $owner
+ * @param $fields
+ * @param $access
+ * @param $cat_id
+ * @param $tid
* @deprecated
* @access private
*/
@@ -978,6 +1014,7 @@
/**
*
*
+ * @param $id
* @deprecated
* @access private
*/
@@ -989,6 +1026,9 @@
/**
*
*
+ * @param $id
+ * @param $name
+ * @param $value
* @deprecated
* @access private
*/
@@ -1010,7 +1050,7 @@
* @param string $sort ASC | DESC depending what you want
* @param mixed $criteria All criterias what you want
* @param mixed $criteria_token same like $criteria but
builded<br>with sql_criteria class, more powerfull
- * @return array with records
+ * @return array Array person with records
*/
function get_persons($fields, $limit='', $ofset='',
$orderby='', $sort='', $criteria='', $criteria_token='')
{
@@ -1065,6 +1105,7 @@
*
* @param integer|array $contact_id id of the contact or array
of the same
* @param integer $action PHPGW_SQL_RETURN_SQL |
PHPGW_SQL_RUN_SQL depending what we want
+ * @param boolean $get_org True: Also get the organization;
False: get only the person data
* @return array|string Array with records or string with sql
query
*/
function get_principal_persons_data($contact_id,
$action=PHPGW_SQL_RUN_SQL, $get_org=True)
@@ -1130,7 +1171,7 @@
* @param string $sort ASC | DESC depending what you want
* @param array $criteria All criterias what you want
* @param mixed $criteria_token same like $criteria but
builded<br>with sql_criteria class, more powerfull
- * @return array with records
+ * @return array Array with organization with records
*/
function get_orgs($fields, $limit='', $ofset='', $orderby='',
$sort='', $criteria='', $criteria_token='')
{
@@ -1209,7 +1250,7 @@
* @param mixed $organizations_id Organizations Id which want
information.
* @param string $criteria
* @param integer $action PHPGW_SQL_RETURN_SQL |
PHPGW_SQL_RUN_SQL depending what we want
- * @return array (Asociative with id and all data that we
requested)
+ * @return array Asociative array with id and all data that we
requested
*/
function get_people_by_organizations($organizations_id,
$criteria='', $action=PHPGW_SQL_RUN_SQL)
{
@@ -1598,7 +1639,7 @@
* Get all sub categories from cat_id
*
* @param integer $cat_id The category id to find
- * @return array With all sub categories
+ * @return array All sub categories
* @access private
*/
function get_sub_cats($cat_id)
@@ -1685,6 +1726,7 @@
*
* @param string $comm_type
* @param string $comm_description
+ * @return
* @access private
*/
function comms_fixed($comm_type, $comm_description)
@@ -2205,6 +2247,7 @@
*
* @param integer $cid The contact_id what you want to edit
* @param array $categories The new categories
+ * @param $action
* @return
*/
function edit_category($cid, $categories=array(),
$action=PHPGW_SQL_RETURN_SQL)
@@ -2838,7 +2881,6 @@
case RETURN_RECORDS:
case PHPGW_SQL_RUN_SQL:
return $this->get_records($line, $file);
- break;
case PHPGW_SQL_RETURN_SQL:
return $this->get_sql();
}
@@ -2865,6 +2907,10 @@
/**
*
*
+ * @param $field
+ * @param $line
+ * @param $file
+ * @return
* @access private
*/
function get_records_by_field($field, $line=__LINE__,
$file=__FILE__)
@@ -2880,6 +2926,9 @@
/**
*
*
+ * @param $query
+ * @param $line
+ * @param $file
* @access private
*/
function execute_query($query, $line=__LINE__, $file=__FILE__)
@@ -2894,6 +2943,7 @@
/**
*
*
+ * @param $queries
* @access private
*/
function execute_queries($queries=array())
@@ -3201,7 +3251,7 @@
* Decide if the contact has preferred location
*
* @param integer $contact_id Contact id which want to check.
- * @return Array|Boolean False if has't preferred org or array
with all id which has preferred org.
+ * @return array|boolean False if has't preferred org or array
with all id which has preferred org.
*/
function has_preferred_location($contact_id)
{
@@ -3396,7 +3446,6 @@
$criteria =
sql_criteria::token_or(sql_criteria::token_and(sql_criteria::_equal('access',
'public'),
sql_criteria::_in('owner', $this->get_contacts_shared($owner, PHPGW_ACL_READ))),
sql_criteria::_equal('owner', $owner));
- break;
}
if($categories != PHPGW_CONTACTS_CATEGORIES_ALL)
{
@@ -3759,7 +3808,7 @@
/**
* Begin a Transaction to database.
*
- * Create de database if necesary
+ * @internal Create database object if necesary
* @access private
*/
function transaction_begin()
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] phpgwapi/inc/class.contacts_sql.inc.php, 1.17.2.2.2.64,
nomail <=