Class enc_qualifier

Description

A class which encapsulates a scheme qualifier. A qualifier is an attribute which is used in a metadata tag to qualify or refine it.

Qualifiers can have default values or allowed lists of values, but essentially they just allow the user to enter a string of content against a named attribute in the meta tag.

Located in /metadata-defs.php (line 110)

RenderableObject
   |
   --enc_qualifier
Variable Summary
Method Summary
 enc_qualifier enc_qualifier ([integer $scheme_id = ""], [string $qualname = ""])
 void get ([integer $scheme_id = ""], [mixed $qual_name = ""], string $qualname)
Variables
mixed $comments = "" (line 120)

Blurb regarding this qualifier

mixed $default_value = "" (line 122)

Default value of this qualifier

mixed $display_order = 0 (line 126)

Display order

mixed $list_of_values = "" (line 124)

Allowed list of values for this qualifier

mixed $qual_label = "" (line 118)

Label for qualifier

mixed $qual_name = "" (line 116)

Name of this qualifier

mixed $scheme_id = "" (line 114)

Unique encoding scheme ID

mixed $valid = false (line 112)

Whether object contains valid data

Methods
Constructor enc_qualifier (line 133)

Constructor

enc_qualifier enc_qualifier ([integer $scheme_id = ""], [string $qualname = ""])
  • integer $scheme_id: Unique ID of this scheme
  • string $qualname: Name of this qualifier
get (line 142)

Get the data for this qualifier.

void get ([integer $scheme_id = ""], [mixed $qual_name = ""], string $qualname)
  • integer $scheme_id: The unique ID of the scheme to get
  • string $qualname: Name of this qualifier

Inherited Methods

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3