PHP Class Arcanedev\SeoHelper\SeoTwitter

See link: https://dev.twitter.com/cards/overview
Author: ARCANEDEV ([email protected])
Inheritance: implements Arcanedev\SeoHelper\Contracts\SeoTwitter, use trait Arcanedev\Support\Traits\Configurable
Show file Open project: arcanedev/seo-helper

Protected Properties

Property Type Description
$card Arcanedev\SeoHelper\Contracts\Entities\TwitterCard The Twitter Card instance.
$enabled boolean Enable or Disable the Twitter Card.

Public Methods

Method Description
__construct ( array $configs ) Make SeoTwitter instance.
__toString ( ) : string Render the tag.
addImage ( string $url ) : SeoTwitter Add image to the card.
addMeta ( string $name, string $content ) : SeoTwitter Add a meta to the Twitter Card.
addMetas ( array $metas ) : SeoTwitter Add many metas to the card.
disable ( ) : SeoTwitter Disable the Twitter Card.
enable ( ) : SeoTwitter Enable the Twitter Card.
isDisabled ( ) : boolean Check if the Twitter Card is disabled.
isEnabled ( ) : boolean Check if the Twitter Card is enabled.
render ( ) : string Render the tag.
reset ( ) : SeoTwitter Reset the Twitter Card.
setCard ( Arcanedev\SeoHelper\Contracts\Entities\TwitterCard $card ) : SeoTwitter Set the Twitter Card instance.
setDescription ( string $description ) : SeoTwitter Set the card description.
setSite ( string $site ) : SeoTwitter Set the card site.
setTitle ( string $title ) : SeoTwitter Set the card title.
setType ( string $type ) : SeoTwitter Set the card type.

Private Methods

Method Description
setEnabled ( boolean $enabled ) : SeoTwitter Set the enabled status for the Twitter Card.

Method Details

__construct() public method

Make SeoTwitter instance.
public __construct ( array $configs )
$configs array

__toString() public method

Render the tag.
public __toString ( ) : string
return string

addImage() public method

Add image to the card.
public addImage ( string $url ) : SeoTwitter
$url string
return SeoTwitter

addMeta() public method

Add a meta to the Twitter Card.
public addMeta ( string $name, string $content ) : SeoTwitter
$name string
$content string
return SeoTwitter

addMetas() public method

Add many metas to the card.
public addMetas ( array $metas ) : SeoTwitter
$metas array
return SeoTwitter

disable() public method

Disable the Twitter Card.
public disable ( ) : SeoTwitter
return SeoTwitter

enable() public method

Enable the Twitter Card.
public enable ( ) : SeoTwitter
return SeoTwitter

isDisabled() public method

Check if the Twitter Card is disabled.
public isDisabled ( ) : boolean
return boolean

isEnabled() public method

Check if the Twitter Card is enabled.
public isEnabled ( ) : boolean
return boolean

render() public method

Render the tag.
public render ( ) : string
return string

reset() public method

Reset the Twitter Card.
public reset ( ) : SeoTwitter
return SeoTwitter

setCard() public method

Set the Twitter Card instance.
public setCard ( Arcanedev\SeoHelper\Contracts\Entities\TwitterCard $card ) : SeoTwitter
$card Arcanedev\SeoHelper\Contracts\Entities\TwitterCard
return SeoTwitter

setDescription() public method

Set the card description.
public setDescription ( string $description ) : SeoTwitter
$description string
return SeoTwitter

setSite() public method

Set the card site.
public setSite ( string $site ) : SeoTwitter
$site string
return SeoTwitter

setTitle() public method

Set the card title.
public setTitle ( string $title ) : SeoTwitter
$title string
return SeoTwitter

setType() public method

Set the card type.
public setType ( string $type ) : SeoTwitter
$type string
return SeoTwitter

Property Details

$card protected property

The Twitter Card instance.
protected TwitterCard,Arcanedev\SeoHelper\Contracts\Entities $card
return Arcanedev\SeoHelper\Contracts\Entities\TwitterCard

$enabled protected property

Enable or Disable the Twitter Card.
protected bool $enabled
return boolean