Class metadata_scheme

Description

A class which encapsulates a metadata scheme. This is a set of

rules or a set of values (a vocabulary) designed to help people when entering metadata. This class holds the details of the scheme (name, tag, description), link(s) to resources on the scheme and possibly values for it.

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

RenderableObject
   |
   --metadata_scheme
Variable Summary
 mixed $datasrc_uri
 mixed $description
 mixed $label
 mixed $preferred
 mixed $qualifiers
 mixed $scheme_id
 mixed $tag_name
 mixed $valid
 mixed $values
Method Summary
 metadata_scheme metadata_scheme ([integer $scheme_id = ""])
 void definition_form ([string $formname = ""], [string $fieldname = ""], [string $fieldvalue = ""], [string $schemefield = ""])
 boolean get ([integer $scheme_id = ""])
Variables
mixed $datasrc_uri = "" (line 192)

URI of scheme data

mixed $description = "" (line 190)

A description of the scheme

mixed $enc_scheme_name = "" (line 184)

Name of this encoding scheme

mixed $label = "" (line 186)

Label for scheme

mixed $preferred = false (line 200)

Whether this is the 'preferred' scheme, of many

mixed $qualifiers = array() (line 198)

Array of scheme qualifier objects

mixed $reference_url = "" (line 194)

Reference URL for this scheme

mixed $scheme_id = "" (line 182)

Unique encoding scheme ID

mixed $tag_name = "" (line 188)

Scheme name to be used in meta tags

mixed $valid = false (line 180)

Whether object contains valid data

mixed $values = array() (line 196)

Array of scheme key/value pairs

Methods
Constructor metadata_scheme (line 206)

Constructor

metadata_scheme metadata_scheme ([integer $scheme_id = ""])
  • integer $scheme_id: Unique ID of this scheme
definition_form (line 278)

Render this scheme as HTML. This produces a table containing the

schem in a format suitable for a metadata definition form. If only a reference URL, then a simple URL is used, if values are available then a combo is used, if a qualifier set is defined, then a special qualifier assembly widget is displayed. In the latter two cases, an end-result for content s produced, and you can pass in the name of a javascript function to call to insert the result.

void definition_form ([string $formname = ""], [string $fieldname = ""], [string $fieldvalue = ""], [string $schemefield = ""])
  • string $formname: Name of the form this will go into
  • string $fieldname: Name of form field to update when content defined
  • string $fieldvalue: Initial value of form field we are updating
  • string $schemefield: Name of form field of scheme to update
get (line 215)

Get the data for this scheme.

  • return: Whether the get succeeded and object is valid
boolean get ([integer $scheme_id = ""])
  • integer $scheme_id: The unique ID of the scheme to get

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3