Class Horde_Kolab_Format_XML_contact

Description

Kolab XML handler for contact groupware objects

$Horde: framework/Kolab_Format/lib/Horde/Kolab/Format/XML/contact.php,v 1.2.2.6 2008/12/12 11:39:04 wrobel Exp $

Copyright 2007-2008 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_Format/lib/Horde/Kolab/Format/XML/contact.php (line 25)

Horde_Kolab_Format_XML
   |
   --Horde_Kolab_Format_XML_contact
Direct descendents
Class Description
 class Horde_Kolab_Format_XML_contact_dummy Kolab XML handler for contact groupware objects
Variable Summary
Method Summary
 Horde_Kolab_Format_XML_contact Horde_Kolab_Format_XML_contact ()
 array|PEAR_Error _load ( &$children, array $children)
 boolean|PEAR_Error _save (array $root, array $object)
Variables
array $_address_types = array(
'business',
'home',
'other',
)
(line 133)

Address types

array $_fields_address = array(
'type' => HORDE_KOLAB_XML_TYPE_COMPOSITE,
'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
'array' => array(
'type' => array (
'type' => HORDE_KOLAB_XML_TYPE_STRING,
'value' => HORDE_KOLAB_XML_VALUE_DEFAULT,
'default' => 'home',
),'street'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'locality'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'region'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'postal-code'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'country'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),))
(line 75)

Structure of an address field

array $_fields_name = array(
'given-name' => array (
'type' => HORDE_KOLAB_XML_TYPE_STRING,
'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
),'middle-names'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'last-name'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'full-name'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'initials'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'prefix'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),'suffix'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,))
(line 39)

Structure of the name field

array $_fields_phone = array(
'type' => HORDE_KOLAB_XML_TYPE_COMPOSITE,
'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
'array' => array(
'type' => array (
'type' => HORDE_KOLAB_XML_TYPE_STRING,
'value' => HORDE_KOLAB_XML_VALUE_DEFAULT,
'default' => '',
),'number'=>array('type'=>HORDE_KOLAB_XML_TYPE_STRING,'value'=>HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,),),)
(line 112)

Structure of a phone field

array $_fields_specific (line 32)

Specific data fields for the contact object

array $_phone_types = array(
'business1',
'business2',
'businessfax',
'callback',
'car',
'company',
'home1',
'home2',
'homefax',
'isdn',
'mobile',
'pager',
'primary',
'radio',
'telex',
'ttytdd',
'assistant',
'other',
)
(line 144)

Phone types

Inherited Variables

Inherited from Horde_Kolab_Format_XML

Horde_Kolab_Format_XML::$_create_categories
Horde_Kolab_Format_XML::$_fields_attendee
Horde_Kolab_Format_XML::$_fields_basic
Horde_Kolab_Format_XML::$_fields_recurrence
Horde_Kolab_Format_XML::$_fields_simple_person
Horde_Kolab_Format_XML::$_name
Horde_Kolab_Format_XML::$_root_name
Horde_Kolab_Format_XML::$_root_version
Horde_Kolab_Format_XML::$_version
Horde_Kolab_Format_XML::$_xmldoc
Methods
Constructor Horde_Kolab_Format_XML_contact (line 168)

Constructor

Horde_Kolab_Format_XML_contact Horde_Kolab_Format_XML_contact ()
_load (line 307)

Load the groupware object based on the specifc XML values.

  • return: Array with the object data.
  • access: protected
array|PEAR_Error _load ( &$children, array $children)
  • array $children: An array of XML nodes.
  • &$children

Redefinition of:
Horde_Kolab_Format_XML::_load()
Load the groupware object based on the specifc XML values.
_save (line 392)

Save the specifc XML values.

  • return: True on success.
  • access: protected
boolean|PEAR_Error _save (array $root, array $object)
  • array $root: The XML document root.
  • array $object: The resulting data array.

Redefinition of:
Horde_Kolab_Format_XML::_save()
Save the specific XML values.

Inherited Methods

Inherited From Horde_Kolab_Format_XML

 Horde_Kolab_Format_XML::Horde_Kolab_Format_XML()
 Horde_Kolab_Format_XML::factory()
 Horde_Kolab_Format_XML::getDisposition()
 Horde_Kolab_Format_XML::getMimeType()
 Horde_Kolab_Format_XML::getName()
 Horde_Kolab_Format_XML::load()
 Horde_Kolab_Format_XML::save()
 Horde_Kolab_Format_XML::_load()
 Horde_Kolab_Format_XML::_save()

Documentation generated on Sun, 30 Jan 2011 05:15:59 +0000 by phpDocumentor 1.4.3