Docs For Class ElementSetBuilder

Description

Build an element set.

copyright: Center for History and New Media, 2009

Located in /application/models/ElementSetBuilder.php (line 15)

Omeka_Record_Builder
   |
   --ElementSetBuilder

Variable Summary

mixed $_recordClass

mixed $_settableProperties

Method Summary

ElementSetBuilder __construct ([array|string $metadata = array()], [array $elements = array()], [Omeka_Record|null $record = null])

void _beforeBuild ()

void _parseMetadataOptions ( $metadata)

Variables

mixed $_recordClass = 'ElementSet' (line 18)

access: protected

Redefinition of:

Omeka_Record_Builder::$_recordClass

mixed $_settableProperties = array('name', 'description') (line 17)

access: protected

Redefinition of:

Omeka_Record_Builder::$_settableProperties

Inherited Variables

Inherited from Omeka_Record_Builder

Omeka_Record_Builder::$_metadataOptions
Omeka_Record_Builder::$_record

Methods

Constructor __construct (line 30)

Constructor.

access: public

ElementSetBuilder __construct ([array|string $metadata = array()], [array $elements = array()], [Omeka_Record|null $record = null])

array|string $metadata: Metadata for the element set, or string name of the element set.
array $elements
Omeka_Record|null $record

Redefinition of:

Omeka_Record_Builder::__construct()

_beforeBuild (line 42)

Add elements to be associated with the element set.

access: protected

void _beforeBuild ()

Redefinition of:

Omeka_Record_Builder::_beforeBuild(): All necessary tasks to take place before the record has been inserted.

_parseMetadataOptions (line 52)

Ensure that the element set name has been provided, trim whitespace from name and description fields.

access: protected

void _parseMetadataOptions ( $metadata)

array $metadata

Redefinition of:

Omeka_Record_Builder::_parseMetadataOptions(): May be overridden by subclasses to clean up the input instructions.

Inherited Methods

Inherited From Omeka_Record_Builder

Omeka_Record_Builder::__construct()
Omeka_Record_Builder::build()
Omeka_Record_Builder::_afterBuild()
Omeka_Record_Builder::_beforeBuild()
Omeka_Record_Builder::_parseMetadataOptions()