[Phpgroupware-cvs] CVS: cdb/doc cdb.fields.txt,NONE,1.1

[Patrick Walsh <address@hidden>]

Update of /cvsroot/phpgroupware/cdb/doc
In directory subversions:/tmp/cvs-serv3721

Added Files:
        cdb.fields.txt 
Log Message:
Field mappings.


--- NEW FILE ---
Alright, for the purposes of filters, sync'ing, etc., we need to create names 
and mappings for all of our information.

First of all, let's come up with a list of valid tables.  All tables are 
prefixed with phpgw_cdb_ so we'll just assume that and ignore it for the 
moment.  In fact, we'll always ignore that.  

Fields are the straight forward fields that we get to just send back without 
processing.  We like these.  

Aliases are for those fields that we have to do extra lookups and fancy joins 
for.  These are pains in the buttocks.

Table                   Field                   Alias           Comments
-----                   -----                   -----           --------
contact_main    contact_id
contact_main                                    organization    Returns main 
organization (str)
contact_main                                    organization_location   Returns 
main org 
                                                                                
        location (string)
contact_main    first_name
contact_main    middle_name
contact_main    last_name
contact_main    last_name_prefix
contact_main    initials
contact_main    location
contact_main    nickname
contact_main    profession
contact_main    suffix
contact_main    title
contact_main                                    main_email      Returns main 
e-mail (string)
contact_main                                    mailing_address Returns as 
string
contact_main                                    note
contact_main                                    category
contact_phone                                   [category]      OK, this one is 
even stranger than
                                                                                
        the others.  category can be 
                                                                                
        anything listed in the contact_
                                                                                
        phone_category table, such as Home,
                                                                                
        Work, etc.  Spaces turn into _'s.  
                                                                                
        So "Business Fax" becomes
                                                                                
        business_fax, etc.
contact_phone                                   all_phones      Since more than 
8 phone numbers is
                                                                                
        possible, search/return them all as
                                                                                
        <br> separated string
contact_phone                                   phone1          Returns phone 1 
(string)
contact_phone                                   phone2
contact_phone                                   phone3
contact_phone                                   ...
contact_phone                                   phone8
contact_address                                 all_addresses   same as 
all_phones
contact_address                                 [category]      Same as 
contact_phone.[category]
contact_address                                 [category].city
contact_address                                 [category].country
contact_address                                 [category].street
contact_address                                 [category].postal_code

Table                   Field                   Alias           Comments
-----                   -----                   -----           --------
organization    name
organization    home_page
organization    network_name
organization    gov_id_num
organization                                    note
organization                                    all_locations   <br> sep list 
of locations
organization                                    all_addresses   <br> sep list 
of addresses
organization                                    all_phones              <br> 
sep list of phones
organization                                    all_contacts    comma sep list 
of associated
                                                                                
                contacts
organization                                    main_location
organization                                    main_address
organization                                    main_phone
organization                                    category
organization_client     account
organization_client billing_info
organization_client customer_id
organization_client     referred_by
contact_organization    assistant_name
contact_organization    assistant_phone
contact_organization    assistant_email
contact_organization    department
contact_organization    job_title
contact_organization    manager_name
contact_client  account
contact_client  billing_info
contact_client  customer_id
contact_client  referred_by
contact_personal        birthday
contact_personal        children
contact_personal        gender
contact_personal        gov_id_num
contact_personal        hobbies
contact_personal                                language_code
contact_personal                                language_name
contact_personal        spouse
contact_personal        anniversary
meta                    status
meta                                                    created                 
Aliased because needs to be 
                                                                                
                converted to a legible date form
meta                                                    modified                
Ditto
meta                    file_as
meta                                                    followup_status
meta                                                    created_by              
Needs to be converted to name
meta                    keywords
meta                                                    contact_flags   comma 
sep list
contact_internet        email_home
contact_internet        email_home_display
contact_internet        email_business
contact_internet        email_business_display
contact_internet        email_other
contact_internet        email_other_display
contact_internet        ftp
contact_internet        free_busy_address
contact_internet        personal_home_page
contact_internet        business_home_page
contact_internet        other_home_page
contact_internet                                send_as_plain_text
contact_internet        icq
contact_internet                                all_emails      Search/return 
all e-mails, <br> sep