Class CMS_contactData

Description
Description | Methods (details) Constants

Class CMS_contactData

represent a contact data : job title and service, address, tel and fax numbers, email.

Located in /automne/classes/common/contactdata.php (line 29) 

CMS_grandFather
   |
   --CMS_contactData
Method Summary
Description | Constants Methods (details)
void __construct ([integer $id = 0])
void destroy ()
string getAddressField1 ()
string getAddressField2 ()
string getAddressField3 ()
string getCellphone ()
string getCity ()
string getCompany ()
string getCountry ()
string getEmail ()
string getFax ()
string getGender ()
integer getID ()
string getJobTitle ()
string getPhone ()
string getService ()
string getState ()
mixed getValue (string $property)
string getZip ()
boolean setAddressField1 (string $newValue)
boolean setAddressField2 (string $newValue)
boolean setAddressField3 (string $newValue)
boolean setCellphone (string $newCellphone)
boolean setCity (string $newCity)
boolean setCompany (string $company)
boolean setCountry (string $newCountry)
boolean setEmail (string $newEmail)
boolean setFax (string $newFax)
boolean setGender (string $gender)
boolean setJobTitle (string $newJobTitle)
boolean setPhone (string $newPhone)
boolean setService (string $newService)
boolean setState (string $newState)
boolean setValue (string $property, string $value)
boolean setZip (string $newZip)
boolean writeToPersistence ()
Methods
Description | Constants Methods (details)
Constructor __construct (line 151)

Constructor.

initializes the contactData if the id is given

  • access: public
void __construct ([integer $id = 0])
  • integer $id: DB id
destroy (line 621)

Totally destroys the contactData from database.

  • access: public
void destroy ()
getAddressField1 (line 260)

Gets the first address field.

  • return: the address field 1
  • access: public
string getAddressField1 ()
getAddressField2 (line 284)

Gets the second address field.

  • return: the address field 2
  • access: public
string getAddressField2 ()
getAddressField3 (line 308)

Gets the third address field.

  • return: the address field 3
  • access: public
string getAddressField3 ()
getCellphone (line 452)

Gets the cellphone number.

  • return: the cellphone number
  • access: public
string getCellphone ()
getCity (line 356)

Gets the city name.

  • return: the city
  • access: public
string getCity ()
getCompany (line 527)

Gets the company.

  • return: the company
  • access: public
string getCompany ()
getCountry (line 404)

Gets the country name.

  • return: the country name
  • access: public
string getCountry ()
getEmail (line 500)

Gets the email address.

  • return: the email address
  • access: public
string getEmail ()
getFax (line 476)

Gets the fax number.

  • return: the fax number
  • access: public
string getFax ()
getGender (line 551)

Gets the gender.

  • return: the gender
  • access: public
string getGender ()
getID (line 201)

Gets the DB ID of the instance.

  • return: the DB id
  • access: public
integer getID ()
getJobTitle (line 236)

Gets the job title of the person.

  • return: the job title
  • access: public
string getJobTitle ()
getPhone (line 428)

Gets the phone number.

  • return: the phone number
  • access: public
string getPhone ()
getService (line 212)

Gets the service (as an office subdivision).

  • return: The service
  • access: public
string getService ()
getState (line 380)

Gets the state name (may be abbreviated).

  • return: the state name
  • access: public
string getState ()
getValue (line 576)

Short hand to get values by property name

  • return: See functions for more details
  • access: public
mixed getValue (string $property)
  • string $property: The name of the property
getZip (line 332)

Gets the zip code.

  • return: the zip code
  • access: public
string getZip ()
setAddressField1 (line 272)

Sets the first address field.

  • return: true on success, false on failure to set it
  • access: public
boolean setAddressField1 (string $newValue)
  • string $newValue: the new address field 1
setAddressField2 (line 296)

Sets the second address field.

  • return: true on success, false on failure to set it
  • access: public
boolean setAddressField2 (string $newValue)
  • string $newValue: the new address field 2
setAddressField3 (line 320)

Sets the third address field.

  • return: true on success, false on failure to set it
  • access: public
boolean setAddressField3 (string $newValue)
  • string $newValue: the new address field 3
setCellphone (line 464)

Sets the cellphone number.

  • return: true on success, false on failure to set it
  • access: public
boolean setCellphone (string $newCellphone)
  • string $newCellphone: the new cellphone number
setCity (line 368)

Sets the city name.

  • return: true on success, false on failure to set it
  • access: public
boolean setCity (string $newCity)
  • string $newCity: the new city name
setCompany (line 539)

Sets the company

  • return: true on success, false on failure to set it
  • access: public
boolean setCompany (string $company)
  • string $company: the new company
setCountry (line 416)

Sets the country name.

  • return: true on success, false on failure to set it
  • access: public
boolean setCountry (string $newCountry)
  • string $newCountry: the new country
setEmail (line 512)

Sets the email address.

  • return: true on success, false on failure to set it
  • access: public
boolean setEmail (string $newEmail)
  • string $newEmail: the new email address
setFax (line 488)

Sets the fax number.

  • return: true on success, false on failure to set it
  • access: public
boolean setFax (string $newFax)
  • string $newFax: the new fax number
setGender (line 563)

Sets the gender

  • return: true on success, false on failure to set it
  • access: public
boolean setGender (string $gender)
  • string $gender: the new gender
setJobTitle (line 248)

Sets the job title.

  • return: true on success, false on failure to set it
  • access: public
boolean setJobTitle (string $newJobTitle)
  • string $newJobTitle: the job title to set
setPhone (line 440)

Sets the phone number.

  • return: true on success, false on failure to set it
  • access: public
boolean setPhone (string $newPhone)
  • string $newPhone: the new phone number
setService (line 224)

Sets the service (as an office subdivision).

  • return: true on success, false on failure.
  • access: public
boolean setService (string $newService)
  • string $newService: the service to set
setState (line 392)

Sets the state name (may be abbreviated).

  • return: true on success, false on failure to set it
  • access: public
boolean setState (string $newState)
  • string $newState: the new state name
setValue (line 601)

Short hand to set values by property name

  • return: true on success, false on failure
  • access: public
boolean setValue (string $property, string $value)
  • string $property: The name of the property
  • string $value: The value to set
setZip (line 344)

Sets the zip code.

  • return: true on success, false on failure to set it
  • access: public
boolean setZip (string $newZip)
  • string $newZip: the new zip code
writeToPersistence (line 642)

Writes the contactData into persistence (MySQL for now).

  • return: true on success, false on failure
  • access: public
boolean writeToPersistence ()

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()
Class Constants
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:29:35 +0100 by phpDocumentor 1.4.3