Class contactinfo

Description

The contactinfo class manages a single set of contact information which might be associated with a person or thing.

Located in /pim-defs.php (line 274)

RenderableObject
   |
   --contactinfo
Variable Summary
 mixed $addr_city
 mixed $addr_code
 mixed $addr_other
 mixed $addr_postal
 mixed $addr_street
 mixed $addr_suburb
 mixed $emails
 mixed $exists
 mixed $phone
 mixed $phone_fax
 mixed $phone_work
 mixed $urls
Method Summary
 contactinfo contactinfo ([string $id = NEW_CONTACTINFO])
 void contact_details ()
 void delete ()
 void dump ()
 void get ([string $id = ""])
 void html ()
 boolean POSTprocess ()
 void save ()
Variables
mixed $addr_city = "" (line 285)

addr_city

mixed $addr_code = "" (line 289)

addr_code

mixed $addr_country = "" (line 287)

addr_country

mixed $addr_other = "" (line 291)

addr_other

mixed $addr_postal = "" (line 279)

addr_postal

mixed $addr_street = "" (line 281)

addr_street

mixed $addr_suburb = "" (line 283)

addr_suburb

mixed $contactinfoid (line 277)

contactinfo ID

mixed $emails = "" (line 293)

emails

mixed $exists = false (line 308)

Whether contactinfo exists in database

mixed $phone = "" (line 295)

phone

mixed $phone_fax = "" (line 297)

phone_fax

mixed $phone_mobile = "" (line 301)

phone_mobile

mixed $phone_work = "" (line 299)

phone_work

mixed $urls = "" (line 303)

urls

Methods
Constructor contactinfo (line 315)

Constructor Create a new contactinfo object.

contactinfo contactinfo ([string $id = NEW_CONTACTINFO])
  • string $id: The unique identity of the contactinfo.
contact_details (line 454)

Return a standard contact details set.

This is designed for in-line contact details such as might be included as-is in an email confirmation of order for example. Only fields which are not nullstring are included.

void contact_details ()
delete (line 397)

Delete the contactinfo.

Delete this contactinfo from the database.

void delete ()
dump (line 472)

A diagnostic dump of the class variables for debugging purposes.

void dump ()
get (line 323)

Retrieves the specified contactinfo from database.

void get ([string $id = ""])
  • string $id: The unique integer identity of the contactinfo to get.
html (line 492)

Display Contactinfo subform via the render() method.

void html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.
POSTprocess (line 412)

Process a possible POST of a form with new contact info data. We only do anything here if the special var $_save_x is defined (ie. this would be from user clicking button named "_save"), and also the contact info IF $_CI_contactinfo_id. We return true if POST was processed.

  • return: True if POSTed contact info was processed, else false
boolean POSTprocess ()
save (line 361)

Save the contactinfo.

Save this contactinfo to the database. Create a new one if it doesn't already exist.

void save ()

Inherited Methods

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3