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

Class: Services_Yahoo_Maps_XMLDocument

Source Location: /Services_Yahoo-0.2.0/Yahoo/Maps/XMLDocument.php

Class Overview


Provides facilities for creating and modifying XML for use with the Yahoo! Maps API.


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005 Bryan Dunlap

Methods


Inherited Variables

Inherited Methods


Class Details

[line 44]
Provides facilities for creating and modifying XML for use with the Yahoo! Maps API.

The Yahoo! Maps XML is based on geoRSS 2.0



[ Top ]


Method Detail

__construct (Constructor)   [line 77]

Services_Yahoo_Maps_XMLDocument __construct( [string $file = false])

Constructor
  • Throws: Services_Yahoo_Exception
  • Access: public

Parameters:

string   $file   —  (optional) a string containing the path to a valid XML document

[ Top ]

addGroup   [line 95]

void addGroup( array $options)

Adds a group sub-element to the groups element
  • Throws: Services_Yahoo_Exception
  • Access: public

Parameters:

array   $options   —  an array containing valid attributes for the group element

[ Top ]

addItem   [line 127]

void addItem( array $options)

Adds an item sub-element to the channel element
  • Throws: Services_Yahoo_Exception
  • Access: public

Parameters:

array   $options   —  an array containing valid attributes for the item element

[ Top ]

setBrandingImage   [line 173]

void setBrandingImage( $options, string $imageURL)

Sets the image sub-element of the channel element
  • Access: public

Parameters:

string   $imageURL   —  a string containing a valid URL to an image
   $options   — 

[ Top ]

setDefaultViewNumbered   [line 206]

void setDefaultViewNumbered( [boolean $defaultViewNumbered = true])

Sets the "defaultViewNumbered" attribute of the ymaps:Groups element
  • Access: public

Parameters:

boolean   $defaultViewNumbered   — 

[ Top ]

setDescription   [line 194]

void setDescription( string $description)

Sets the description sub-element of the channel element
  • Access: public

Parameters:

string   $description   —  a string containing the description

[ Top ]

setLanguageCode   [line 220]

void setLanguageCode( string $languageCode)

Sets the ymaps::IntlCode sub-element of the channel element
  • Access: public

Parameters:

string   $languageCode   —  a string containing the language code

[ Top ]

setLatitude   [line 232]

void setLatitude( float $latitude)

Sets the geo:lat sub-element of the channel element
  • Access: public

Parameters:

float   $latitude   —  a float representing latitude

[ Top ]

setLink   [line 256]

void setLink( string $link)

Sets the link sub-element of the channel element
  • Access: public

Parameters:

string   $link   —  a string containing a valid URL

[ Top ]

setLongitude   [line 244]

void setLongitude( float $longitude)

Sets the geo:long sub-element of the channel element
  • Access: public

Parameters:

float   $longitude   —  a float representing longitude

[ Top ]

setTitle   [line 268]

void setTitle( string $title)

Sets the title sub-element of the channel element
  • Access: public

Parameters:

string   $title   —  a string containing a title

[ Top ]

setZoomLevel   [line 280]

void setZoomLevel( integer $zoomLevel)

Sets the ymaps:ZoomLevel sub-element of the channel element
  • Access: public

Parameters:

integer   $zoomLevel   —  an integer representing the map"s zoom level

[ Top ]

toFile   [line 294]

boolean toFile( string $file)

Exports the DOM representation to XML and saves to file
  • Return: true if successful
  • Throws: Services_Yahoo_Exception
  • Access: public

Parameters:

string   $file   —  the string containing the path of the file to save to

[ Top ]

toXML   [line 309]

string toXML( )

Exports the DOM representation to an XML string
  • Throws: Services_Yahoo_Exception
  • Access: public

[ Top ]


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