Class organisation

Description

The organisation class manages a single set of information related to a "organisation". This is an identity distinct from the system-oriented uuser record, and is intended to be a generic mechanism for storing data on human beings.

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

RenderableObject
   |
   --organisation
Variable Summary
 mixed $contactinfo
 mixed $description
 mixed $enabled
 mixed $exists
 mixed $orgid
 mixed $org_contact
 mixed $org_name
Method Summary
 organisation organisation ([string $id = NEW_ORGANISATION])
 void delete ()
 void get ([string $id = ""])
 void html ([mixed $idmode = "hide_id"], string $id_mode)
 void initialise ()
 boolean POSTprocess ()
 void save ()
Variables
mixed $contactinfo (line 55)

Contact info object

mixed $description = "" (line 51)

Description

mixed $enabled = true (line 57)

Whether organisation is enabled

mixed $exists = false (line 59)

Whether organisation exists in database

mixed $orgid = NEW_ORGANISATION (line 47)

Organisation ID

mixed $org_contact = "" (line 53)

Contact person name

mixed $org_name = "" (line 49)

Organisation name

Methods
Constructor organisation (line 65)

Constructor Create a new organisation object.

organisation organisation ([string $id = NEW_ORGANISATION])
  • string $id: The unique identity of the organisation.
delete (line 146)

Delete the organisation.

Delete this organisation from the database.

void delete ()
get (line 74)

Get the organisation.

Retrieves the specified organisation from database.

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

Display organisation subform via the render() method.

void html ([mixed $idmode = "hide_id"], string $id_mode)
  • string $id_mode: Whether to hide the ID or not

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.
initialise (line 163)

Clear the object variables to default values.

void initialise ()
POSTprocess (line 180)

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 organisation ID $_ORG_org_id. We return true if POST was processed.

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

Save the organisation.

Save this organisation 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