StaticSeoUrl
in package
implements
StaticSeoUrlInterface
Class StaticSeoUrl
Represents the default settings of a static seo url. Has got the static seo url contents as collection.
Tags
Interfaces, Classes and Traits
- StaticSeoUrlInterface
- Interface StaticSeoUrlInterface
Table of Contents
- $changeFrequency : float
- Change frequency for sitemap
- $id : int
- StaticSeoUrl ID
- $name : string
- StaticSeoUrl Name
- $openGraphImage : string
- Image for OpenGraph page property
- $priority : float
- Priority for sitemap
- $robotsEntry : bool
- Is it shown in robots file?
- $sitemapEntry : bool
- Is it shown in sitemap?
- $staticSeoUrlContentCollection : StaticSeoUrlContentCollection
- Collection of staticSeoUrlContents
- __construct() : mixed
- addStaticSeoUrlContent() : StaticSeoUrlInterface
- Adds a staticSeoUrlContent to the staticSeoUrlContent collection
- getChangeFrequency() : string
- Return the change frequency of the staticSeoUrl.
- getId() : int
- Return the ID of the staticSeoUrl.
- getName() : string
- Return the Name of the staticSeoUrl.
- getOpenGraphImage() : string
- Returns name of OpenGraph image file
- getPriority() : string
- Return the Priority of the staticSeoUrl.
- getStaticSeoUrlContentCollection() : StaticSeoUrlContentCollection
- Return the staticSeoUrlContent collection of the staticSeoUrl.
- isInRobotsFile() : bool
- Return true when the staticSeoUrl should be considered in the robots file, false otherwise.
- isInSitemapEntry() : bool
- Return true when the staticSeoUrl should be considered in the sitemap, false otherwise.
- setChangeFrequency() : StaticSeoUrlInterface
- Value of change frequency of staticSeoUrl in sitemap
- setId() : StaticSeoUrlInterface
- Set the ID for the staticSeoUrl.
- setIsInRobotsFile() : StaticSeoUrlInterface
- Consider the staticSeoUrl in the robots file or not.
- setIsInSitemapEntry() : StaticSeoUrlInterface
- Consider the staticSeoUrl in the sitemap or not.
- setName() : StaticSeoUrlInterface
- Set the name for the staticSeoUrl.
- setOpenGraphImage() : StaticSeoUrl
- setPriority() : StaticSeoUrlInterface
- Value of Priority of staticSeoUrl in sitemap
- setStaticSeoUrlContentCollection() : StaticSeoUrlInterface
- Set the static seo url content collection for the static seo url.
Properties
$changeFrequency
Change frequency for sitemap
protected
float
$changeFrequency
= ''
$id
StaticSeoUrl ID
protected
int
$id
= 0
$name
StaticSeoUrl Name
protected
string
$name
= ''
$openGraphImage
Image for OpenGraph page property
protected
string
$openGraphImage
$priority
Priority for sitemap
protected
float
$priority
= ''
$robotsEntry
Is it shown in robots file?
protected
bool
$robotsEntry
= alse
$sitemapEntry
Is it shown in sitemap?
protected
bool
$sitemapEntry
= alse
$staticSeoUrlContentCollection
Collection of staticSeoUrlContents
protected
StaticSeoUrlContentCollection
$staticSeoUrlContentCollection
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addStaticSeoUrlContent()
Adds a staticSeoUrlContent to the staticSeoUrlContent collection
public
addStaticSeoUrlContent(StaticSeoUrlContentInterface $staticSeoUrlContent) : StaticSeoUrlInterface
Parameters
- $staticSeoUrlContent : StaticSeoUrlContentInterface
Tags
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
getChangeFrequency()
Return the change frequency of the staticSeoUrl.
public
getChangeFrequency() : string
Return values
string —Change frequency.
getId()
Return the ID of the staticSeoUrl.
public
getId() : int
Return values
int —StaticSeoUrl ID.
getName()
Return the Name of the staticSeoUrl.
public
getName() : string
Return values
string —Name.
getOpenGraphImage()
Returns name of OpenGraph image file
public
getOpenGraphImage() : string
Return values
string —getPriority()
Return the Priority of the staticSeoUrl.
public
getPriority() : string
Return values
string —Priority.
getStaticSeoUrlContentCollection()
Return the staticSeoUrlContent collection of the staticSeoUrl.
public
getStaticSeoUrlContentCollection() : StaticSeoUrlContentCollection
Return values
StaticSeoUrlContentCollection —StaticSeoUrlContent collection.
isInRobotsFile()
Return true when the staticSeoUrl should be considered in the robots file, false otherwise.
public
isInRobotsFile() : bool
Return values
bool —isInSitemapEntry()
Return true when the staticSeoUrl should be considered in the sitemap, false otherwise.
public
isInSitemapEntry() : bool
Return values
bool —setChangeFrequency()
Value of change frequency of staticSeoUrl in sitemap
public
setChangeFrequency(StringType $changeFrequency) : StaticSeoUrlInterface
Parameters
- $changeFrequency : StringType
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setId()
Set the ID for the staticSeoUrl.
public
setId(IdType $id) : StaticSeoUrlInterface
Parameters
- $id : IdType
-
StaticSeoUrl ID.
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setIsInRobotsFile()
Consider the staticSeoUrl in the robots file or not.
public
setIsInRobotsFile(BoolType $status) : StaticSeoUrlInterface
Parameters
- $status : BoolType
-
True when it should be displayed, false otherwise.
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setIsInSitemapEntry()
Consider the staticSeoUrl in the sitemap or not.
public
setIsInSitemapEntry(BoolType $status) : StaticSeoUrlInterface
Parameters
- $status : BoolType
-
True when it should be displayed, false otherwise.
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setName()
Set the name for the staticSeoUrl.
public
setName(StringType $name) : StaticSeoUrlInterface
Parameters
- $name : StringType
-
Name for the staticSeoUrl.
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setOpenGraphImage()
public
setOpenGraphImage(FilenameStringType $openGraphImage) : StaticSeoUrl
Parameters
- $openGraphImage : FilenameStringType
Return values
StaticSeoUrl —setPriority()
Value of Priority of staticSeoUrl in sitemap
public
setPriority(StringType $priority) : StaticSeoUrlInterface
Parameters
- $priority : StringType
Return values
StaticSeoUrlInterface —Same instance for chained method calls.
setStaticSeoUrlContentCollection()
Set the static seo url content collection for the static seo url.
public
setStaticSeoUrlContentCollection(StaticSeoUrlContentCollection $staticSeoUrlContentCollection) : StaticSeoUrlInterface
Parameters
- $staticSeoUrlContentCollection : StaticSeoUrlContentCollection
Return values
StaticSeoUrlInterface —Same instance for chained method calls.