PHP 클래스 Twitter\Widgets\Buttons\PeriscopeOnAir

부터: 1.3.0
상속: extends Twitter\Widgets\BaseWidget
파일 보기 프로젝트 열기: twitter/wordpress 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$ALLOWED_SIZES Allowed values for the size property

보호된 프로퍼티들

프로퍼티 타입 설명
$size Size of the button
$username Periscope username

공개 메소드들

메소드 설명
__construct ( $username, $validate = true ) Require username
fromArray ( array $options ) : __CLASS__ Build a Periscope On Air object from an associative array
getUsername ( ) : string Retrieve the stored Periscope username
getWebProfileURL ( ) : Periscope Build a Periscope web profile URL
setSize ( string $size ) : __CLASS__ Set the desired size of the On Air button
toArray ( ) : array Convert the class object into an array, removing default field values
toHTML ( string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string Generate a link to a Periscope web profile configured for enhancement by the Twitter for Websites JavaScript

메소드 상세

__construct() 공개 메소드

Require username
부터: 1.3.0
public __construct ( $username, $validate = true )

fromArray() 공개 정적인 메소드

Build a Periscope On Air object from an associative array
부터: 1.3.0
public static fromArray ( array $options ) : __CLASS__
$options array associative array of options { @type string option name @type string option value }
리턴 __CLASS__ support chaining

getUsername() 공개 메소드

Retrieve the stored Periscope username
부터: 1.3.0
public getUsername ( ) : string
리턴 string Periscope username or empty string if username not set

getWebProfileURL() 공개 메소드

Build a Periscope web profile URL
부터: 1.3.0
public getWebProfileURL ( ) : Periscope
리턴 Periscope web profile URL or empty string if username not set

setSize() 공개 메소드

Set the desired size of the On Air button
부터: 1.3.0
public setSize ( string $size ) : __CLASS__
$size string button size
리턴 __CLASS__ support chaining

toArray() 공개 메소드

Convert the class object into an array, removing default field values
부터: 1.3.0
public toArray ( ) : array
리턴 array properties as associative array

toHTML() 공개 메소드

Generate a link to a Periscope web profile configured for enhancement by the Twitter for Websites JavaScript
부터: 1.3.0
public toHTML ( string $html_builder_class = '\Twitter\Helpers\HTMLBuilder' ) : string
$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.3.0
public static $ALLOWED_SIZES

$size 보호되어 있는 프로퍼티

Size of the button
부터: 1.3.0
protected $size

$username 보호되어 있는 프로퍼티

Periscope username
부터: 1.3.0
protected $username