XML_XRD
[ class tree: XML_XRD ] [ index: XML_XRD ] [ all elements ]

Class: XML_XRD_Element_Link

Source Location: /XML_XRD-0.3.1/src/XML/XRD/Element/Link.php

Class Overview

XML_XRD_PropertyAccess
   |
   --XML_XRD_Element_Link

Link element in a XRD file. Attribute access via object properties.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods

Class: XML_XRD_PropertyAccess

XML_XRD_PropertyAccess::getProperties()
Get all properties with the given type
XML_XRD_PropertyAccess::offsetExists()
Check if the property with the given type exists
XML_XRD_PropertyAccess::offsetGet()
Return the highest ranked property with the given type
XML_XRD_PropertyAccess::offsetSet()
Not implemented.
XML_XRD_PropertyAccess::offsetUnset()
Not implemented.

Class Details

[line 29]
Link element in a XRD file. Attribute access via object properties.

Retrieving the title of a link is possible with the getTitle() convenience method.



[ Top ]


Class Variables

$href =

[line 50]

Link URL
  • Access: public

Type:   string


[ Top ]

$rel =

[line 36]

Link relation
  • Access: public

Type:   string


[ Top ]

$template =

[line 57]

Link URL template
  • Access: public

Type:   string


[ Top ]

$titles = array()

[line 64]

Array of key-value pairs: Key is the language, value the title
  • Access: public

Type:   array


[ Top ]

$type =

[line 43]

Link type (MIME type)
  • Access: public

Type:   string


[ Top ]



Method Detail

__construct (Constructor)   [line 77]

XML_XRD_Element_Link __construct( [string $rel = null], [string $href = null], [string $type = null], [boolean $isTemplate = false])

Create a new instance and load data from the XML element
  • Access: public

Parameters:

string   $rel   —  string with the relation name/URL
string   $href   —  HREF value
string   $type   —  Type value
boolean   $isTemplate   —  When set to true, the $href is used as template

[ Top ]

getTitle   [line 98]

string|null getTitle( [string $lang = null])

Returns the title of the link in the given language.

If the language is not available, the first title without the language is returned. If no such one exists, the first title is returned.

  • Return: Link title
  • Access: public

Parameters:

string   $lang   —  2-letter language name

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:57:47 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.