[Phpgroupware-cvs] CVS: phpgwapi/doc contacts.api.txt,NONE,1.1.2.1

[Dave Hall <address@hidden>]

Update of /cvsroot/phpgroupware/phpgwapi/doc
In directory subversions:/tmp/cvs-serv589/phpgwapi/doc

Added Files:
      Tag: Version-0_9_16-branch
        contacts.api.txt 
Log Message:
Adding new contacts backend ... and associated code


--- NEW FILE ---
Complete
Nomenclature:
C: Coded
T: Tested
B: With bug
D: Documented

For $owner, get all the contacts that he share to user.
function get_people_by_owner($owner, $data)
[C  D]

Get all the contacts that are private.
function get_private_contacts()
[C BD]: Where get the the account_id for owner?

Get the people that are related to any of organizations.
function get_people_by_organizations($organizations_id, $data)
[C  D]

Get the Organzations that are related to any of `person'.
function get_organizations_by_person($person_id, $data)
[C  D]

Get the contacts that belong to any of categories.
function get_contacts_by_categories($categories_id, $data, $contact_type)
[C  D]

Get the people that belong to any of categories.
function get_people_by_categories($categories_id, $data)
[  B ] Really must be implemented? see get_contacts_by_categories

Get the organizations that belong to any of categories.
function get_organizations_by_categories($categories_id, $data)
[  B ] Really must be implemented? see get_contacts_by_categories

Get all the categories that this contact have.
function get_categories($contacts_id, $data)
[  BD] I don't know how to accomplish the objetive

Get contacts that are users.
function get_system_contacts()
[C  D]

Decide if contact is a user.
function is_user($contacts)
[C  D]

Filter what contacts that it take, are users
function are_user($contacts_id, $data)
[C  D]

Get principal email for contacts
function get_email($contacts_id)
[C  D]

Get principal phone for contacts.
function get_phone($contacts_id)
[C  D]

Get principal location for contacts.
function get_primary_location($contact_id, $data)
[  B ] Don't know how to accomplish the objective.

Get all the locations for contacts.
function get_locations($contact_id, $data)

Get all persons.
function get_persons($data)

Get all organizations.
function get_organizations($data)

Get all contacts.
function get_contacts($data)

INSERT

function add_contact($type, $principal, $comms, $location, $others)


BACKWARD COMPATIBILITY

Read the contact by this ID (old scheme).
function read_single_entry($id,$fields='')

Gets the max(id) and call read_single_entry.
function read_last_entry($fields='')

[Assigned jarg]
function
read($start=0,$limit=0,$fields='',$query='',$filter='',$sort='',$order='',
$lastmod=-1)

function add($owner,$fields,$access='',$cat_id='',$tid='n')
function change_owner($old_owner='',$new_owner='')
function delete_($id)
function update($id,$owner,$fields,$access='',$cat_id='',$tid='n')
function delete_all($owner=0)

PRIVATE???
function read_extra_fields($id)
function field_exists($id,$field_name)
function add_single_extra_field($id,$owner,$field_name,$field_value)
function delete_single_extra_field($id,$field_name)
function update_single_extra_field($id, $name, $value)