Documentation

AbstractSitemap extends SitemapWriter implements AbstractSitemap

Interfaces, Classes and Traits

AbstractSitemap

Table of Contents

$ext  : string
Extension.
$file  : string
Sitemap file.
$lastMod  : Datetime
Last modify.
__construct()  : void
__construct.
close()  : void
Close the sitemap file.
delete()  : object
Delete the sitemap.
has()  : bool
Determine whether the sitemap exists.
read()  : xml
Read the sitemap file.
write()  : void
Write on sitemap file.

Properties

Methods

__construct()

__construct.

public __construct((string) $file[, (string) $mode = 'readWriteAppend' ]) : void

Open the sitemap file.

Parameters
$file : (string)

File name with extension (.xml).

$mode : (string) = 'readWriteAppend'

Valid file opening mode.

Tags
since
1.0.0
Return values
void

close()

Close the sitemap file.

public close() : void
Tags
since
1.0.0
Return values
void

delete()

Delete the sitemap.

public delete((string) $file) : object
Parameters
$file : (string)

File name with extension (.xml).

Tags
since
1.0.0
Return values
object

has()

Determine whether the sitemap exists.

public has((string) $file) : bool
Parameters
$file : (string)

File name with extension (.xml).

Tags
since
1.0.0
Return values
bool

read()

Read the sitemap file.

public read() : xml
Tags
since
1.0.0
Return values
xml

write()

Write on sitemap file.

public write((\alphaz\Common\Sitemap\xml) $data) : void
Parameters
$data : (\alphaz\Common\Sitemap\xml)

Valid XML

Tags
since
1.0.0
Return values
void

Search results