[GitHub/WoltLab/woltlab.github.io.git] / docs / package / pip / object-type.md

# Object Type Package Installation Plugin

Registers an object type.
Read about object types in the [objectTypeDefinition](object-type-definition.md) PIP.

## Components

Each item is described as a `<type>` element with the mandatory child `<name>` that should follow the naming pattern `<packageIdentifier>.<definition>`, e.g. `com.woltlab.wcf.example`.

### `<definitionname>`

The `<name>` of the [objectTypeDefinition](object-type-definition.md).

### `<classname>`

The name of the class providing the object types's behaviour,
the class has to implement the `<interfacename>` interface of the object type definition.

### `<*>`

<span class="label label-info">Optional</span>

Additional fields may be defined for specific definitions of object types.
Refer to the documentation of these for further explanation.

## Example

{jinja{ codebox(
  title="objectType.xml",
  language="xml",
  filepath="package/pip/objectType.xml"
) }}
Commit	Line	Data
8659eb86	1	# Object Type Package Installation Plugin
0b768461	2
723dc11b	3	Registers an object type.
21609ed2	4	Read about object types in the [objectTypeDefinition](object-type-definition.md) PIP.
723dc11b TD	5
	6	## Components
	7
	8	Each item is described as a `<type>` element with the mandatory child `<name>` that should follow the naming pattern `<packageIdentifier>.<definition>`, e.g. `com.woltlab.wcf.example`.
	9
	10	### `<definitionname>`
	11
21609ed2	12	The `<name>` of the [objectTypeDefinition](object-type-definition.md).
723dc11b TD	13
	14	### `<classname>`
	15
	16	The name of the class providing the object types's behaviour,
	17	the class has to implement the `<interfacename>` interface of the object type definition.
	18
	19	### `<*>`
	20
ca3f33cf	21	<span class="label label-info">Optional</span>
723dc11b	22
7713fc20	23	Additional fields may be defined for specific definitions of object types.
723dc11b TD	24	Refer to the documentation of these for further explanation.
	25
	26	## Example
	27
9a3f5fa3	28	{jinja{ codebox(
f778fce2 MS	29	title="objectType.xml",
	30	language="xml",
	31	filepath="package/pip/objectType.xml"
9a3f5fa3	32	) }}