class views_oai_pmh_format in Views OAI-PMH 7.3

The base class for metadata formats.

Hierarchy

• class \views_oai_pmh_format

File

includes/format.inc, line 11

Metadata formats.

class views_oai_pmh_format {

  /**
   * Identifier (or prefix, in OAI-PMH's terminology) for this metadata format.
   *
   * @var string
   */
  public $id = '';

  /**
   * A descriptive name of the data format.
   *
   * @var string
   */
  public $label = '';

  /**
   * The schema for this format.
   *
   * @var string
   */
  public $schema = '';

  /**
   * The XML namespaces required by this metadata format.
   *
   * The XML namespaces required by this metadata format, keyed by namespace
   * prefix. Even if the XML output uses a default prefix, no key here is
   * allowed to be empty.
   *
   * @var array
   */
  public $namespaces = array();

  /**
   * The prefix of the metadata namespace for this format.
   *
   * Must match a key of the $namespaces array.
   *
   * @var string
   */
  public $metadata_namespace_prefix = '';

  /**
   * An array describing the attributes that are allowed.
   *
   * An array describing the attributes that are allowed for each tag of the
   * metadata format.
   *
   * @var array
   */
  public $attributes = array();

  /**
   * An array describing the mapping options, tags or attributes.
   *
   * An array describing the mapping options, tags or attributes for use in
   * the mapping interface.
   *
   * @var array
   */
  public $elements = array();

  /**
   * The element that acts as the root of each OAI record in the generated XML.
   *
   * @var string
   */
  public $root_element = '';

  /**
   * The attributes to assign to the root tag.
   *
   * The attributes to assign to the root tag, including XML namespace
   * attributes.
   *
   * @var array
   */
  public $root_attributes = array();

  /**
   * Constructor.
   */
  public function __construct($id, $label) {
    $this->id = $id;
    $this->label = $label;
    $this->attributes = array();
    $this->elements = array(
      'none' => t('- None -'),
    );
    $this->root_attributes = array();
  }

  /**
   * Return the metadata namespace.
   */
  public function get_metadata_namespace() {
    return $this->namespaces[$this->metadata_namespace_prefix];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_oai_pmh_format::$attributes	public	property	An array describing the attributes that are allowed.
views_oai_pmh_format::$elements	public	property	An array describing the mapping options, tags or attributes.
views_oai_pmh_format::$id	public	property	Identifier (or prefix, in OAI-PMH's terminology) for this metadata format.
views_oai_pmh_format::$label	public	property	A descriptive name of the data format.
views_oai_pmh_format::$metadata_namespace_prefix	public	property	The prefix of the metadata namespace for this format.
views_oai_pmh_format::$namespaces	public	property	The XML namespaces required by this metadata format.
views_oai_pmh_format::$root_attributes	public	property	The attributes to assign to the root tag.
views_oai_pmh_format::$root_element	public	property	The element that acts as the root of each OAI record in the generated XML.
views_oai_pmh_format::$schema	public	property	The schema for this format.
views_oai_pmh_format::get_metadata_namespace	public	function	Return the metadata namespace.
views_oai_pmh_format::__construct	public	function	Constructor.	7