Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • objectclass: An array with the following keys:
    • required: Whether or not this objectclass is required. Currently, all plugin-defined schemas must be required.
  • attributes: An array where each key defines the name of the attribute, and each value is an array with the following keys:
    • required: Whether or not this attribute is required for this objectclass
    • multiple: Whether or not this attribute permits multiple values
    • extendedtype: If the value for this attribute will be pulled from a model that supports extended types, the type of data to be pulled:
      • address_types
      • email_address_types
      • identifier_types
      • telephone_number_types
    • defaulttype: If the value for this attribute will be pulled from a model that supports extended types, the default type (cm_co_extended_types:name)

 

Note

Currently, only schemas related to person attributes are supported. ie: these attributes will only be assembled for CO Person transactions, not CO Group transactions.

Code Block
languagephp
titleExample Schema Defition
public $attributes = array(
  'testPerson' => array(
    'objectclass' => array(
      'required'    => true
    ),
    'attributes' => array(
      'testDescription' => array(
        'required'    => true,
        'multiple'    => false
      ),
      'erpNumber' => array(
        'required'     => false,
        'multiple'     => false,
        'extendedtype' => 'identifier_types',
        'defaulttype'  => 'employeenumber'
      )
    )
  )
);

...