dmField Class Reference
Inheritance diagram for dmField:
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 ($int)
- getName ()
- setName ($name)
- getNick ()
- setNick ($nick)
- isSearchable ()
- setSearchable ($bool)
- isSortable ()
- setSortable ($bool)
- getType ()
- setType ($type)
- getValue ()
- setValue ($value)
- getVocabulary ($dict=true, $include_unused=false)
Static Public Member Functions
- static getAll ()
- static getNameForDCNick ($nick)
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] |
| dmField::getDCNick | ( | ) | [final] |
- Returns:
- string
- Since:
- 0.3
Definition at line 298 of file dmField.class.php.
Referenced by getDCName().
| dmField::getMaxWords | ( | ) | [final] |
| dmField::getName | ( | ) | [final] |
| static dmField::getNameForDCNick | ( | $ | nick | ) | [static, final] |
| dmField::getNick | ( | ) | [final] |
- Returns:
- string
- Since:
- 0.1
Definition at line 378 of file dmField.class.php.
Referenced by Draw::vocabularyAsList().
| dmField::getType | ( | ) | [final] |
| dmField::getValue | ( | ) | [final] |
- Returns:
- string
- Since:
- 0.1
Definition at line 443 of file dmField.class.php.
Referenced by __toString().
| dmField::isControlled | ( | ) | [final] |
| dmField::isDefaultSort | ( | ) | [final] |
| dmField::isHidden | ( | ) | [final] |
| dmField::isSearchable | ( | ) | [final] |
| dmField::isSortable | ( | ) | [final] |
| dmField::setCollection | ( | dmCollection $ | c | ) | [final] |
| dmField::setControlled | ( | $ | bool | ) | [final] |
| dmField::setDCNick | ( | $ | nick | ) | [final] |
| dmField::setDefaultSort | ( | $ | bool | ) | [final] |
| dmField::setHidden | ( | $ | bool | ) | [final] |
| dmField::setMaxWords | ( | $ | int | ) | [final] |
| dmField::setName | ( | $ | name | ) | [final] |
| 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] |
| dmField::setSortable | ( | $ | bool | ) | [final] |
| 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] |
The documentation for this class was generated from the following file:
