dmField Class Reference

Inheritance diagram for dmField:
dmModel

Public Member Functions

Static Public Member Functions


Detailed Description

Definition at line 20 of file dmField.class.php.


Constructor & Destructor Documentation

dmField::__construct ( nick  ) 
Parameters:
string nick Valid CONTENTdm(R) field nickname
Since:
0.1

Definition at line 56 of file dmField.class.php.


Member Function Documentation

dmField::__toString (  ) 
Returns:
string The value of the field. Equivalent to calling getValue().
See also:
dmField::getValue()
Since:
0.1

Definition at line 65 of file dmField.class.php.

static dmField::getAll (  )  [static]
Returns:
array An array of dmField objects corresponding to all Dublin Core elements in the default collection.
Since:
0.1

Definition at line 74 of file dmField.class.php.

Referenced by dmCollection::getFields().

dmField::getCollection (  )  [final]
Returns:
dmCollection object
Since:
0.1

Definition at line 257 of file dmField.class.php.

Referenced by Draw::vocabularyAsList().

dmField::getDCName (  )  [final]
Returns:
string
Since:
0.3

Definition at line 289 of file dmField.class.php.

dmField::getDCNick (  )  [final]
Returns:
string
Since:
0.3

Definition at line 298 of file dmField.class.php.

Referenced by getDCName().

dmField::getMaxWords (  )  [final]
Returns:
int
Since:
0.1

Definition at line 346 of file dmField.class.php.

dmField::getName (  )  [final]
Returns:
string
Since:
0.1

Definition at line 362 of file dmField.class.php.

static dmField::getNameForDCNick ( nick  )  [static, final]
Parameters:
string nick
Returns:
string

Definition at line 246 of file dmField.class.php.

dmField::getNick (  )  [final]
Returns:
string
Since:
0.1

Definition at line 378 of file dmField.class.php.

Referenced by Draw::vocabularyAsList().

dmField::getType (  )  [final]
Returns:
string
Since:
0.3

Definition at line 426 of file dmField.class.php.

dmField::getValue (  )  [final]
Returns:
string
Since:
0.1

Definition at line 443 of file dmField.class.php.

Referenced by __toString().

dmField::isControlled (  )  [final]
Returns:
Boolean
Since:
0.1

Definition at line 273 of file dmField.class.php.

dmField::isDefaultSort (  )  [final]
Returns:
Boolean
Since:
0.1

Definition at line 314 of file dmField.class.php.

dmField::isHidden (  )  [final]
Returns:
Boolean
Since:
0.1

Definition at line 330 of file dmField.class.php.

dmField::isSearchable (  )  [final]
Returns:
Boolean
Since:
0.1

Definition at line 394 of file dmField.class.php.

dmField::isSortable (  )  [final]
Returns:
Boolean
Since:
0.1

Definition at line 410 of file dmField.class.php.

dmField::setCollection ( dmCollection c  )  [final]
Parameters:
dmCollection c
Since:
0.1

Definition at line 265 of file dmField.class.php.

dmField::setControlled ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.1

Definition at line 281 of file dmField.class.php.

dmField::setDCNick ( nick  )  [final]
Parameters:
string nick
Since:
0.3

Definition at line 306 of file dmField.class.php.

dmField::setDefaultSort ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.1

Definition at line 322 of file dmField.class.php.

dmField::setHidden ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.1

Definition at line 338 of file dmField.class.php.

dmField::setMaxWords ( int  )  [final]
Parameters:
int int
Since:
0.1

Definition at line 354 of file dmField.class.php.

dmField::setName ( name  )  [final]
Parameters:
name string
Since:
0.1

Definition at line 370 of file dmField.class.php.

dmField::setNick ( nick  )  [final]
Parameters:
string nick
Since:
0.1

Definition at line 386 of file dmField.class.php.

Referenced by __construct().

dmField::setSearchable ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.1

Definition at line 402 of file dmField.class.php.

dmField::setSortable ( bool  )  [final]
Parameters:
Boolean bool
Since:
0.1

Definition at line 418 of file dmField.class.php.

dmField::setType ( type  )  [final]
Parameters:
string type One of 'TEXT', 'FTS', or 'DATE', per the dmGetCollectionFieldInfo() function (this is not enforced)
Since:
0.3

Definition at line 435 of file dmField.class.php.

dmField::setValue ( value  )  [final]
Parameters:
string value
Since:
0.1

Definition at line 451 of file dmField.class.php.


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

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1