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

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

Открытые свойства

Свойство Тип Описание
$ALLOWED_SIZES Allowed values for the size property

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

Свойство Тип Описание
$intent Follow Web Intent
$show_count Show the current number of followers alongside the button
$show_screen_name Show or hide the screen name of the account
$size Size of the button

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

Метод Описание
__construct ( string $screen_name, boolean $validate = true ) Require screen name. Initialize Follow Web Intent
fromArray ( array $options ) : __CLASS__ Build a Follow button object from an associative array
getScreenName ( ) : string Return the screen name of the Twitter user
hideCount ( ) : __CLASS__ Show only the Follow button, without a follower count
hideScreenName ( ) : __CLASS__ Hide the screen name from display inside the Follow button
setSize ( string $size ) : __CLASS__ Set the desired size of the Follow button
showCount ( ) : __CLASS__ Show the number of followers alongside the Follow button
showScreenName ( ) : __CLASS__ Show the screen name to follow inside the Follow button
toArray ( ) : array Convert the class object into an array, removing default field values
toHTML ( string $anchor_text = 'Follow %s', string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string Generate HTML to encourage follow behavior and expose data to the Twitter for Websites JavaScript

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

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

Require screen name. Initialize Follow Web Intent
С версии: 1.0.0
public __construct ( string $screen_name, boolean $validate = true )
$screen_name string Twitter account name
$validate boolean validate screen name matches Twitter username allowed characters and length before saving

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

Build a Follow button object from an associative array
С версии: 1.0.0
public static fromArray ( array $options ) : __CLASS__
$options array associative array of options { @type string option name @type string|int|bool option value }
Результат __CLASS__ support chaining

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

Return the screen name of the Twitter user
С версии: 1.0.0
public getScreenName ( ) : string
Результат string Twitter screen name, or blank string if no screen name stored

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

Show only the Follow button, without a follower count
С версии: 1.0.0
public hideCount ( ) : __CLASS__
Результат __CLASS__ support chaining

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

Hide the screen name from display inside the Follow button
С версии: 1.0.0
public hideScreenName ( ) : __CLASS__
Результат __CLASS__ support chaining

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

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

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

Show the number of followers alongside the Follow button
С версии: 1.0.0
public showCount ( ) : __CLASS__
Результат __CLASS__ support chaining

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

Show the screen name to follow inside the Follow button
С версии: 1.0.0
public showScreenName ( ) : __CLASS__
Результат __CLASS__ support chaining

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

Convert the class object into an array, removing default field values
С версии: 1.0.0
public toArray ( ) : array
Результат array properties as associative array

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

Generate HTML to encourage follow behavior and expose data to the Twitter for Websites JavaScript
С версии: 1.0.0
public toHTML ( string $anchor_text = 'Follow %s', string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string
$anchor_text string inner text of the generated anchor element. Supports a single '%s' screen name passed through sprintf. Default: Follow %s
$html_builder_class string callable HTML builder with a static anchorElement class
Результат string HTML markup or empty string if minimum requirements not met

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

$ALLOWED_SIZES публичное статическое свойство

Allowed values for the size property
С версии: 1.0.0
public static $ALLOWED_SIZES

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

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

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

Show the current number of followers alongside the button
С версии: 1.0.0
protected $show_count

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

Show or hide the screen name of the account
С версии: 1.0.0
protected $show_screen_name

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

Size of the button
С версии: 1.0.0
protected $size