PHP Класс Twitter\Widgets\Buttons\Tweet

См. ссылку: Tweet button documentation
С версии: 1.0.0
Наследование: extends Twitter\Widgets\BaseWidget
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$intent Tweet Web Intent
$size Large is currently the only supported size.

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

Метод Описание
__construct ( boolean $validate = true ) Create a new button. Initialize the web intent.
addHashtag ( string $hashtag ) : __CLASS__ Add a hashtag
addRelated ( string $username, string $label = '' ) : __CLASS__ Add a related Twitter account
fromArray ( array $options ) : __CLASS__ Create a Tweet button from an associative array
setInReplyTo ( string $tweet_id ) : __CLASS__ Define a parent Tweet by ID
setIntent ( Tweet $intent ) : __CLASS__ Set a new intent
setSize ( string $size ) : __CLASS__ Set the size of the Tweet button
setText ( string $text ) : __CLASS__ Pre-populate Tweet text
setURL ( string $url ) : __CLASS__ Share a URL
setVia ( string $username ) : __CLASS__ Associate Tweet with a source account
toArray ( ) : array Return Tweet button parameters suitable
toHTML ( string $anchor_text = 'Tweet', string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string Tweet button HTML

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

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

Create a new button. Initialize the web intent.
С версии: 1.0.0
public __construct ( boolean $validate = true )
$validate boolean Validate inputs such as screen

addHashtag() публичный Метод

Add a hashtag
С версии: 1.0.0
public addHashtag ( string $hashtag ) : __CLASS__
$hashtag string hashtag
Результат __CLASS__ support chaining

addRelated() публичный Метод

Add a related Twitter account
С версии: 1.0.0
public addRelated ( string $username, string $label = '' ) : __CLASS__
$username string Twitter username
$label string brief description of how the account relates to the Tweet content
Результат __CLASS__ support chaining

fromArray() публичный статический Метод

Create a Tweet button from an associative array
public static fromArray ( array $options ) : __CLASS__
$options array { @type string parameter name @type string|int|bool parameter value }
Результат __CLASS__ new button with configured parameters

setInReplyTo() публичный Метод

Define a parent Tweet by ID
С версии: 1.0.0
public setInReplyTo ( string $tweet_id ) : __CLASS__
$tweet_id string Parent Tweet ID
Результат __CLASS__ support chaining

setIntent() публичный Метод

Set a new intent
С версии: 1.0.0
public setIntent ( Tweet $intent ) : __CLASS__
$intent Twitter\Intents\Tweet Tweet Intent
Результат __CLASS__ support chaining

setSize() публичный Метод

Set the size of the Tweet button
С версии: 1.0.0
public setSize ( string $size ) : __CLASS__
$size string button size
Результат __CLASS__ support chaining

setText() публичный Метод

Pre-populate Tweet text
С версии: 1.0.0
public setText ( string $text ) : __CLASS__
$text string Tweet text
Результат __CLASS__ support chaining

setURL() публичный Метод

Share a URL
С версии: 1.0.0
public setURL ( string $url ) : __CLASS__
$url string absolute URL
Результат __CLASS__ support chaining

setVia() публичный Метод

Associate Tweet with a source account
С версии: 1.0.0
public setVia ( string $username ) : __CLASS__
$username string Twitter username
Результат __CLASS__ support chaining

toArray() публичный Метод

Return Tweet button parameters suitable
С версии: 1.0.0
public toArray ( ) : array
Результат array Tweet button parameter array { @type string dashed parameter name @type string parameter value }

toHTML() публичный Метод

Tweet button HTML
С версии: 1.0.0
public toHTML ( string $anchor_text = 'Tweet', string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string
$anchor_text string inner text of the generated anchor element. Default: Tweet
$html_builder_class string callable HTML builder with a static anchorElement class
Результат string HTML markup

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

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

Tweet Web Intent
С версии: 1.0.0
protected $intent

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

Large is currently the only supported size.
С версии: 1.0.0
protected $size