PHP Class Artesaos\SEOTools\SEOMeta

Inheritance: implements Artesaos\SEOTools\Contracts\MetaTags

Show file Open project: artesaos/seotools Class Usage Examples

Protected Properties

Property	Type	Description
$alternateLanguages	array	The alternate languages.
$canonical	string	The canonical URL.
$config	Illuminate\Config\Repository
$description	string	The meta description.
$keywords	array	The meta keywords.
$metatags	array	extra metatags.
$next	string	The next URL in pagination.
$prev	string	The prev URL in pagination.
$title	string	The meta title.
$title_default	string	The meta title session.
$title_separator	array	The title tag separator.
$title_session	string	The meta title session.
$webmasterTags	array	The webmaster tags.

Public Methods

Method	Description
__construct ( array $config = [] )
addAlternateLanguage ( string $lang, string $url ) : Artesaos\SEOTools\Contracts\MetaTags	Add an alternate language.
addAlternateLanguages ( array $languages ) : Artesaos\SEOTools\Contracts\MetaTags	Add alternate languages.
addKeyword ( string \| array $keyword ) : Artesaos\SEOTools\Contracts\MetaTags	Add a keyword.
addMeta ( string \| array $meta, string $value = null, string $name = 'name' ) : Artesaos\SEOTools\Contracts\MetaTags	Add a custom meta tag.
generate ( boolean $minify = false ) : string	Generates meta tags.
getAlternateLanguages ( ) : array	Get alternate languages.
getCanonical ( ) : string	Get the canonical URL.
getDefaultTitle ( ) : string	Takes the default title.
getDescription ( ) : string \| null	Get the Meta description.
getKeywords ( ) : array	Get the Meta keywords.
getMetatags ( ) : array	Get all metatags.
getNext ( ) : string	Get the next URL.
getPrev ( ) : string	Get the prev URL.
getTitle ( ) : string	Takes the title formatted for display.
getTitleSeparator ( ) : string	takes the title that was set.
getTitleSession ( ) : string	takes the title that was set.
removeMeta ( string $key ) : Artesaos\SEOTools\Contracts\MetaTags	Remove a metatag.
reset ( ) : void	Reset all data.
setCanonical ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the canonical URL.
setDescription ( string $description ) : Artesaos\SEOTools\Contracts\MetaTags
setKeywords ( string \| array $keywords ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the list of keywords, you can send an array or string separated with commas also clears the previously set keywords.
setNext ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the next URL.
setPrev ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the prev URL.
setTitle ( string $title, boolean $appendDefault = true ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the title.
setTitleDefault ( string $default ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the default title tag.
setTitleSeparator ( string $separator ) : Artesaos\SEOTools\Contracts\MetaTags	Sets the separator for the title tag.

Protected Methods

Method	Description
loadWebMasterTags ( )	Load webmaster tags from configuration.
parseTitle ( string $title ) : string	Get parsed title.

Method Details

__construct() public method

public __construct ( array $config = [] )
$config	array

addAlternateLanguage() public method

Add an alternate language.

public addAlternateLanguage ( string $lang, string $url ) : Artesaos\SEOTools\Contracts\MetaTags
$lang	string	language code in ISO 639-1 format
$url	string
return	Artesaos\SEOTools\Contracts\MetaTags

addAlternateLanguages() public method

Add alternate languages.

public addAlternateLanguages ( array $languages ) : Artesaos\SEOTools\Contracts\MetaTags
$languages	array
return	Artesaos\SEOTools\Contracts\MetaTags

addKeyword() public method

Add a keyword.

public addKeyword ( string \| array $keyword ) : Artesaos\SEOTools\Contracts\MetaTags
$keyword	string \| array
return	Artesaos\SEOTools\Contracts\MetaTags

addMeta() public method

Add a custom meta tag.

public addMeta ( string \| array $meta, string $value = null, string $name = 'name' ) : Artesaos\SEOTools\Contracts\MetaTags
$meta	string \| array
$value	string
$name	string
return	Artesaos\SEOTools\Contracts\MetaTags

generate() public method

Generates meta tags.

public generate ( boolean $minify = false ) : string
$minify	boolean
return	string

getAlternateLanguages() public method

Get alternate languages.

public getAlternateLanguages ( ) : array
return	array

getCanonical() public method

Get the canonical URL.

public getCanonical ( ) : string
return	string

getDefaultTitle() public method

Takes the default title.

public getDefaultTitle ( ) : string
return	string

getDescription() public method

Get the Meta description.

public getDescription ( ) : string \| null
return	string \| null

getKeywords() public method

Get the Meta keywords.

public getKeywords ( ) : array
return	array

getMetatags() public method

Get all metatags.

public getMetatags ( ) : array
return	array

getNext() public method

Get the next URL.

public getNext ( ) : string
return	string

getPrev() public method

Get the prev URL.

public getPrev ( ) : string
return	string

getTitle() public method

Takes the title formatted for display.

public getTitle ( ) : string
return	string

getTitleSeparator() public method

takes the title that was set.

public getTitleSeparator ( ) : string
return	string

getTitleSession() public method

takes the title that was set.

public getTitleSession ( ) : string
return	string

loadWebMasterTags() protected method

Load webmaster tags from configuration.

protected loadWebMasterTags ( )

parseTitle() protected method

Get parsed title.

protected parseTitle ( string $title ) : string
$title	string
return	string

removeMeta() public method

Remove a metatag.

public removeMeta ( string $key ) : Artesaos\SEOTools\Contracts\MetaTags
$key	string
return	Artesaos\SEOTools\Contracts\MetaTags

reset() public method

Reset all data.

public reset ( ) : void
return	void

setCanonical() public method

Sets the canonical URL.

public setCanonical ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags
$url	string
return	Artesaos\SEOTools\Contracts\MetaTags

setDescription() public method

public setDescription ( string $description ) : Artesaos\SEOTools\Contracts\MetaTags
$description	string
return	Artesaos\SEOTools\Contracts\MetaTags

setKeywords() public method

Sets the list of keywords, you can send an array or string separated with commas also clears the previously set keywords.

public setKeywords ( string \| array $keywords ) : Artesaos\SEOTools\Contracts\MetaTags
$keywords	string \| array
return	Artesaos\SEOTools\Contracts\MetaTags

setNext() public method

Sets the next URL.

public setNext ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags
$url	string
return	Artesaos\SEOTools\Contracts\MetaTags

setPrev() public method

Sets the prev URL.

public setPrev ( string $url ) : Artesaos\SEOTools\Contracts\MetaTags
$url	string
return	Artesaos\SEOTools\Contracts\MetaTags

setTitle() public method

Sets the title.

public setTitle ( string $title, boolean $appendDefault = true ) : Artesaos\SEOTools\Contracts\MetaTags
$title	string
$appendDefault	boolean
return	Artesaos\SEOTools\Contracts\MetaTags

setTitleDefault() public method

Sets the default title tag.

public setTitleDefault ( string $default ) : Artesaos\SEOTools\Contracts\MetaTags
$default	string
return	Artesaos\SEOTools\Contracts\MetaTags

setTitleSeparator() public method

Sets the separator for the title tag.

public setTitleSeparator ( string $separator ) : Artesaos\SEOTools\Contracts\MetaTags
$separator	string
return	Artesaos\SEOTools\Contracts\MetaTags

Property Details

$alternateLanguages protected property

The alternate languages.

protected array $alternateLanguages
return	array

$canonical protected property

The canonical URL.

protected string $canonical
return	string

$config protected property

protected Repository,Illuminate\Config $config
return	Illuminate\Config\Repository

$description protected property

The meta description.

protected string $description
return	string

$keywords protected property

The meta keywords.

protected array $keywords
return	array

$metatags protected property

extra metatags.

protected array $metatags
return	array

$next protected property

The next URL in pagination.

protected string $next
return	string

$prev protected property

The prev URL in pagination.

protected string $prev
return	string

$title protected property

The meta title.

protected string $title
return	string

$title_default protected property

The meta title session.

protected string $title_default
return	string

$title_separator protected property

The title tag separator.

protected array $title_separator
return	array

$title_session protected property

The meta title session.

protected string $title_session
return	string

$webmasterTags protected property

The webmaster tags.

protected array $webmasterTags
return	array