Encapsulates a Dublin Core metadata element. More...

Inheritance diagram for DMDCElement:

Public Member Functions

__construct ($nick)
__toString ()
getCollection ()
setCollection (DMCollection $c)
isControlled ()
setControlled ($bool)
getDCName ()
getDCNick ()
setDCNick ($nick)
isDefaultSort ()
setDefaultSort ($bool)
isHidden ()
setHidden ($bool)
getMaxWords ()
setMaxWords ($maxwords)
getName ()
setName ($name)
getNick ()
setNick ($nick)
isSearchable ()
isSortable ()
setSearchable ($bool)
setSortable ($bool)
getType ()
setType ($type)
getValue ()
setValue ($value)
getVocabulary ($dict=true, $include_unused=false)
This method requires association with a collection, and will not work with the default collection.

Static Public Member Functions

static getAll ()
static getNameForDCNick ($nick)

Data Fields

$hidden = false
$searchable = false
$sortable = false
$is_default_sort = false

Detailed Description

Encapsulates a Dublin Core metadata element.

Author:: Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 15 of file DMDCElement.php.

Constructor & Destructor Documentation

DMDCElement::__construct ( $ nick )

Parameters:

string nick CONTENTdm(R) field nickname

Since:: 0.1

Definition at line 225 of file DMDCElement.php.

Member Function Documentation

DMDCElement::__toString ( )

Returns:: string The value of the field. Equivalent to getValue().

See also:: getValue()

Since:: 0.1

Definition at line 234 of file DMDCElement.php.

static DMDCElement::getAll ( ) [static]

Returns:: array Array of DMDCElement objects corresponding to the unqualified Dublin Core Metadata Element Set (DCMES).

Since:: 0.1

Definition at line 193 of file DMDCElement.php.

DMDCElement::getCollection ( )

Returns:: DMCollection

Since:: 0.1

Definition at line 242 of file DMDCElement.php.

Referenced by DMGenericTemplateHelper::getHtmlVocabularyAsList(), and getVocabulary().

DMDCElement::getDCName ( )

Returns:: string

Since:: 0.3

Definition at line 274 of file DMDCElement.php.

DMDCElement::getDCNick ( )

Returns:: string

Since:: 0.3

Definition at line 282 of file DMDCElement.php.

Referenced by getDCName().

DMDCElement::getMaxWords ( )

Returns:: int

Since:: 0.1

Definition at line 330 of file DMDCElement.php.

DMDCElement::getName ( )

Returns:: string

Since:: 0.1

Definition at line 346 of file DMDCElement.php.

static DMDCElement::getNameForDCNick ( $ nick ) [static]

Parameters:

string nick

Returns:: string

Definition at line 212 of file DMDCElement.php.

Referenced by getDCName().

DMDCElement::getNick ( )

Returns:: string

Since:: 0.1

Definition at line 362 of file DMDCElement.php.

Referenced by DMObject::addField(), DMGenericTemplateHelper::getHtmlVocabularyAsList(), and getVocabulary().

DMDCElement::getType ( )

Returns:: string

Since:: 0.3

Definition at line 410 of file DMDCElement.php.

DMDCElement::getValue ( )

Returns:: string

Since:: 0.1

Definition at line 431 of file DMDCElement.php.

Referenced by __toString().

DMDCElement::getVocabulary	(	$	dict = `true`,
		$	include_unused = `false`
	)

This method requires association with a collection, and will not work with the default collection.

Generally it should be called from a DMCollection object, like: DMCollection->getField("nick")->getVocabulary("subjec");

Parameters:

Boolean	dict If true, uses the CONTENTdm(R) field indices; if false, uses the controlled vocabulary.
Boolean	include_unused If true, includes terms that are not being used by any objects.

Returns:: Indexed array of strings

Since:: 0.1

Definition at line 456 of file DMDCElement.php.

Referenced by DMGenericTemplateHelper::getHtmlVocabularyAsList(), and DMGenericTemplateHelper::getHtmlVocabularyForSelect().

DMDCElement::isControlled ( )

Returns:: Boolean

Since:: 0.1

Definition at line 258 of file DMDCElement.php.

DMDCElement::isDefaultSort ( )

Returns:: Boolean

Since:: 0.1

Definition at line 298 of file DMDCElement.php.

DMDCElement::isHidden ( )

Returns:: Boolean

Since:: 0.1

Definition at line 314 of file DMDCElement.php.

DMDCElement::isSearchable ( )

Returns:: Boolean

Since:: 0.1

Definition at line 378 of file DMDCElement.php.

DMDCElement::isSortable ( )

Returns:: Boolean

Since:: 0.1

Definition at line 386 of file DMDCElement.php.

DMDCElement::setCollection ( DMCollection $ c )

Parameters:

DMCollection c

Since:: 0.1

Definition at line 250 of file DMDCElement.php.

DMDCElement::setControlled ( $ bool )

Parameters:

Boolean bool

Since:: 0.1

Definition at line 266 of file DMDCElement.php.

DMDCElement::setDCNick ( $ nick )

Parameters:

string nick

Since:: 0.3

Definition at line 290 of file DMDCElement.php.

DMDCElement::setDefaultSort ( $ bool )

Parameters:

Boolean bool

Since:: 0.1

Definition at line 306 of file DMDCElement.php.

DMDCElement::setHidden ( $ bool )

Parameters:

Boolean bool

Since:: 0.1

Definition at line 322 of file DMDCElement.php.

DMDCElement::setMaxWords ( $ maxwords )

Parameters:

int maxwords

Since:: 0.1

Definition at line 338 of file DMDCElement.php.

DMDCElement::setName ( $ name )

Parameters:

string name

Since:: 0.1

Definition at line 354 of file DMDCElement.php.

Referenced by DMConfigXML::loadCollection().

DMDCElement::setNick ( $ nick )

Parameters:

string nick

Since:: 0.1

Definition at line 370 of file DMDCElement.php.

Referenced by __construct().

DMDCElement::setSearchable ( $ bool )

Parameters:

Boolean bool

Since:: 0.1

Definition at line 394 of file DMDCElement.php.

DMDCElement::setSortable ( $ bool )

Parameters:

Boolean bool

Since:: 0.1

Definition at line 402 of file DMDCElement.php.

DMDCElement::setType ( $ type )

Parameters:

string type One of "TEXT", "FULLRES", "FTS", or "'DATE", per the dmGetCollectionFieldInfo() function

Exceptions:

DMIllegalArgumentException

Since:: 0.3

Definition at line 420 of file DMDCElement.php.

DMDCElement::setValue ( $ value )

Parameters:

string value

Since:: 0.1

Definition at line 439 of file DMDCElement.php.

The documentation for this class was generated from the following file:

DMDCElement.php