PHP Класс Artesaos\SEOTools\OpenGraph

Наследование: implements Artesaos\SEOTools\Contracts\OpenGraph
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$articleProperties array Array of Article Properties.
$audioProperties array Array of Audio Properties.
$bookProperties array Array of Book Properties.
$config array Config.
$images array Array of Image Properties.
$musicAlbumProperties array Array of Music Album Properties.
$musicPlaylistProperties array Array of Music Playlist Properties.
$musicRadioStationProperties array Array of Music Radio Properties.
$musicSongProperties array Array of Music Song Properties.
$og_prefix string OpenGraph Prefix.
$profileProperties array Array of Profile Properties.
$properties array Array of Properties.
$videoEpisodeProperties array Array of Video Episode Properties.
$videoMovieProperties array Array of Video Movie Properties.
$videoOtherProperties array Array of Video Other Properties.
$videoProperties array Array of Video Properties.
$videoTVShowProperties array Array of Video TV Show Properties.

Открытые методы

Метод Описание
__construct ( array $config = [] ) : void Create a new OpenGraph instance.
addAudio ( string $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Add audio properties.
addImage ( mixed $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Add image to properties.
addImages ( array $urls ) : Artesaos\SEOTools\Contracts\OpenGraph Add images to properties.
addProperty ( string $key, string | array $value ) : Artesaos\SEOTools\Contracts\OpenGraph Add or update property.
addVideo ( string $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Add video properties.
generate ( boolean $minify = false ) : string Generates open graph tags.
removeProperty ( string $key ) : Artesaos\SEOTools\Contracts\OpenGraph Remove property.
setArticle ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set article properties.
setBook ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set book properties.
setDescription ( string $description = null ) : Artesaos\SEOTools\Contracts\OpenGraph Define description property.
setMusicAlbum ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set music album properties.
setMusicPlaylist ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set music playlist properties.
setMusicRadioStation ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set music radio station properties.
setMusicSong ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set music song properties.
setProfile ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set profile properties.
setSiteName ( string $name ) : Artesaos\SEOTools\Contracts\OpenGraph Define site_name property.
setTitle ( string $title = null ) : Artesaos\SEOTools\Contracts\OpenGraph Define title property.
setType ( string $type = null ) : Artesaos\SEOTools\Contracts\OpenGraph Define type property.
setUrl ( string $url ) : Artesaos\SEOTools\Contracts\OpenGraph Define url property.
setVideoEpisode ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set video episode properties.
setVideoMovie ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set video movie properties.
setVideoOther ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set video episode properties.
setVideoTVShow ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph Set video episode properties.

Защищенные методы

Метод Описание
cleanProperties ( array $attributes = [], array $validKeys = [] ) : array Clean invalid properties.
eachProperties ( array $properties, null | string $prefix = null, boolean $ogPrefix = true ) : string Make list of open graph tags.
makeTag ( string $key = null, string $value = null, boolean $ogPrefix = false ) : string Make a og tag.
setProperties ( string $type = null, string $key = null, array $attributes = [], array $validKeys = [] ) : void Set properties.
setupDefaults ( ) : void Add or update property.

Описание методов

__construct() публичный метод

Create a new OpenGraph instance.
public __construct ( array $config = [] ) : void
$config array config
Результат void

addAudio() публичный метод

Add audio properties.
public addAudio ( string $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$source string url for audio source
$attributes array opengraph audio attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

addImage() публичный метод

Add image to properties.
public addImage ( mixed $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$source mixed URL of image source
$attributes array Object type attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

addImages() публичный метод

Add images to properties.
public addImages ( array $urls ) : Artesaos\SEOTools\Contracts\OpenGraph
$urls array array of image urls
Результат Artesaos\SEOTools\Contracts\OpenGraph

addProperty() публичный метод

Add or update property.
public addProperty ( string $key, string | array $value ) : Artesaos\SEOTools\Contracts\OpenGraph
$key string key of property
$value string | array value of property
Результат Artesaos\SEOTools\Contracts\OpenGraph

addVideo() публичный метод

Add video properties.
public addVideo ( string $source = null, array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$source string url of video source
$attributes array opengraph video attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

cleanProperties() защищенный метод

Clean invalid properties.
protected cleanProperties ( array $attributes = [], array $validKeys = [] ) : array
$attributes array attributes input
$validKeys array keys that are allowed
Результат array

eachProperties() защищенный метод

Make list of open graph tags.
protected eachProperties ( array $properties, null | string $prefix = null, boolean $ogPrefix = true ) : string
$properties array array of properties
$prefix null | string prefix of property
$ogPrefix boolean opengraph prefix
Результат string

generate() публичный метод

Generates open graph tags.
public generate ( boolean $minify = false ) : string
$minify boolean
Результат string

makeTag() защищенный метод

Make a og tag.
protected makeTag ( string $key = null, string $value = null, boolean $ogPrefix = false ) : string
$key string meta property key
$value string meta property value
$ogPrefix boolean opengraph prefix
Результат string

removeProperty() публичный метод

Remove property.
public removeProperty ( string $key ) : Artesaos\SEOTools\Contracts\OpenGraph
$key string key
Результат Artesaos\SEOTools\Contracts\OpenGraph

setArticle() публичный метод

Set article properties.
public setArticle ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph article attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setBook() публичный метод

Set book properties.
public setBook ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph book attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setDescription() публичный метод

Define description property.
public setDescription ( string $description = null ) : Artesaos\SEOTools\Contracts\OpenGraph
$description string set the opengraph description
Результат Artesaos\SEOTools\Contracts\OpenGraph

setMusicAlbum() публичный метод

Set music album properties.
public setMusicAlbum ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph music.album attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setMusicPlaylist() публичный метод

Set music playlist properties.
public setMusicPlaylist ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph music.playlist attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setMusicRadioStation() публичный метод

Set music radio station properties.
public setMusicRadioStation ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph music.radio_station attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setMusicSong() публичный метод

Set music song properties.
public setMusicSong ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph music.song attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setProfile() публичный метод

Set profile properties.
public setProfile ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph profile attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setProperties() защищенный метод

Set properties.
protected setProperties ( string $type = null, string $key = null, array $attributes = [], array $validKeys = [] ) : void
$type string type of og:type
$key string variable key
$attributes array inputted opengraph attributes
$validKeys array valid opengraph attributes
Результат void

setSiteName() публичный метод

Define site_name property.
public setSiteName ( string $name ) : Artesaos\SEOTools\Contracts\OpenGraph
$name string set the site_name
Результат Artesaos\SEOTools\Contracts\OpenGraph

setTitle() публичный метод

Define title property.
public setTitle ( string $title = null ) : Artesaos\SEOTools\Contracts\OpenGraph
$title string set the opengraph title
Результат Artesaos\SEOTools\Contracts\OpenGraph

setType() публичный метод

Define type property.
public setType ( string $type = null ) : Artesaos\SEOTools\Contracts\OpenGraph
$type string set the opengraph type
Результат Artesaos\SEOTools\Contracts\OpenGraph

setUrl() публичный метод

Define url property.
public setUrl ( string $url ) : Artesaos\SEOTools\Contracts\OpenGraph
$url string set the opengraph url
Результат Artesaos\SEOTools\Contracts\OpenGraph

setVideoEpisode() публичный метод

Set video episode properties.
public setVideoEpisode ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph video.episode attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setVideoMovie() публичный метод

Set video movie properties.
public setVideoMovie ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph video.movie attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setVideoOther() публичный метод

Set video episode properties.
public setVideoOther ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph video.other attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setVideoTVShow() публичный метод

Set video episode properties.
public setVideoTVShow ( array $attributes = [] ) : Artesaos\SEOTools\Contracts\OpenGraph
$attributes array opengraph video.tv_show attributes
Результат Artesaos\SEOTools\Contracts\OpenGraph

setupDefaults() защищенный метод

Add or update property.
protected setupDefaults ( ) : void
Результат void

Описание свойств

$articleProperties защищенное свойство

Array of Article Properties.
protected array $articleProperties
Результат array

$audioProperties защищенное свойство

Array of Audio Properties.
protected array $audioProperties
Результат array

$bookProperties защищенное свойство

Array of Book Properties.
protected array $bookProperties
Результат array

$config защищенное свойство

Config.
protected array $config
Результат array

$images защищенное свойство

Array of Image Properties.
protected array $images
Результат array

$musicAlbumProperties защищенное свойство

Array of Music Album Properties.
protected array $musicAlbumProperties
Результат array

$musicPlaylistProperties защищенное свойство

Array of Music Playlist Properties.
protected array $musicPlaylistProperties
Результат array

$musicRadioStationProperties защищенное свойство

Array of Music Radio Properties.
protected array $musicRadioStationProperties
Результат array

$musicSongProperties защищенное свойство

Array of Music Song Properties.
protected array $musicSongProperties
Результат array

$og_prefix защищенное свойство

OpenGraph Prefix.
protected string $og_prefix
Результат string

$profileProperties защищенное свойство

Array of Profile Properties.
protected array $profileProperties
Результат array

$properties защищенное свойство

Array of Properties.
protected array $properties
Результат array

$videoEpisodeProperties защищенное свойство

Array of Video Episode Properties.
protected array $videoEpisodeProperties
Результат array

$videoMovieProperties защищенное свойство

Array of Video Movie Properties.
protected array $videoMovieProperties
Результат array

$videoOtherProperties защищенное свойство

Array of Video Other Properties.
protected array $videoOtherProperties
Результат array

$videoProperties защищенное свойство

Array of Video Properties.
protected array $videoProperties
Результат array

$videoTVShowProperties защищенное свойство

Array of Video TV Show Properties.
protected array $videoTVShowProperties
Результат array