PHP Class Thepixeldeveloper\Sitemap\Subelements\Image

Inheritance: implements Thepixeldeveloper\Sitemap\OutputInterface, implements Thepixeldeveloper\Sitemap\AppendAttributeInterface
Mostrar archivo Open project: thepixeldeveloper/sitemap

Protected Properties

Property Type Description
$caption string The caption of the image.
$geoLocation string The geographic location of the image.
$license string A URL to the license of the image.
$loc string Location (URL).
$title string The title of the image.

Public Methods

Method Description
__construct ( string $loc ) Image constructor
appendAttributeToCollectionXML ( XMLWriter $XMLWriter )
generateXML ( XMLWriter $XMLWriter )
getCaption ( ) : string The caption of the image.
getGeoLocation ( ) : string The geographic location of the image.
getLicense ( ) : string A URL to the license of the image.
getLoc ( ) : string Location (URL).
getTitle ( ) : string The title of the image.
setCaption ( string $caption ) Set the caption of the image.
setGeoLocation ( string $geoLocation ) Set the geographic location of the image.
setLicense ( string $license ) Set a URL to the license of the image.
setTitle ( string $title ) Set the title of the image.

Protected Methods

Method Description
optionalWriteElement ( XMLWriter $XMLWriter, string $name, string $value )

Method Details

__construct() public method

Image constructor
public __construct ( string $loc )
$loc string

appendAttributeToCollectionXML() public method

public appendAttributeToCollectionXML ( XMLWriter $XMLWriter )
$XMLWriter XMLWriter

generateXML() public method

public generateXML ( XMLWriter $XMLWriter )
$XMLWriter XMLWriter

getCaption() public method

The caption of the image.
public getCaption ( ) : string
return string

getGeoLocation() public method

The geographic location of the image.
public getGeoLocation ( ) : string
return string

getLicense() public method

A URL to the license of the image.
public getLicense ( ) : string
return string

getLoc() public method

Location (URL).
public getLoc ( ) : string
return string

getTitle() public method

The title of the image.
public getTitle ( ) : string
return string

optionalWriteElement() protected method

protected optionalWriteElement ( XMLWriter $XMLWriter, string $name, string $value )
$XMLWriter XMLWriter
$name string
$value string

setCaption() public method

Set the caption of the image.
public setCaption ( string $caption )
$caption string

setGeoLocation() public method

Set the geographic location of the image.
public setGeoLocation ( string $geoLocation )
$geoLocation string

setLicense() public method

Set a URL to the license of the image.
public setLicense ( string $license )
$license string

setTitle() public method

Set the title of the image.
public setTitle ( string $title )
$title string

Property Details

$caption protected_oe property

The caption of the image.
protected string $caption
return string

$geoLocation protected_oe property

The geographic location of the image.
protected string $geoLocation
return string

$license protected_oe property

A URL to the license of the image.
protected string $license
return string

$loc protected_oe property

Location (URL).
protected string $loc
return string

$title protected_oe property

The title of the image.
protected string $title
return string