PHP Class Twitter\Intents\Tweet

See link: https://dev.twitter.com/web/tweet-button/web-intent
Since: 1.0.0
Afficher le fichier Open project: twitter/wordpress Class Usage Examples

Protected Properties

Свойство Type Description
$hashtags Hashtags to include in the Tweet
$in_reply_to Parent Tweet identifier
$related May be presented as a suggested account to follow after the Tweet is published
$text Pre-populated Tweet text
$url Share a URL
$validate_inputs Validate passed variables before storing
$via Associate a Tweet with an source Twitter account such as the username of your website

Méthodes publiques

Méthode Description
addHashtag ( string $hashtag ) : __CLASS__ Add a hashtag
addRelated ( string $username, string $label = '' ) : __CLASS__ Add a related Twitter account
disableValidation ( ) : __CLASS__ Do not validate inputs
enableValidation ( ) : __CLASS__ Validate inputs
fromArray ( array $values ) : __CLASS__ Construct a new Tweet intent object from an options array
getHashtags ( ) : array Get a list of hashtags stored for the Tweet
getIntentURL ( ) : string Tweet intent URL
getRelated ( ) : array Get related Twitter usernames
getVia ( ) : string Get the stored via value
isHTTPURL ( string $url ) : boolean Is the passed URL an absolute URL using the HTTP or HTTPS scheme?
setInReplyTo ( string $tweet_id ) : __CLASS__ Define a parent Tweet by ID
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
shouldValidate ( ) : boolean Should data be validated before setting?
toQueryParameters ( ) : array Convert parameters into an array prepped for use in query parameters (underscores) or data-* attributes (dashed)

Method Details

addHashtag() public méthode

Add a hashtag
Since: 1.0.0
public addHashtag ( string $hashtag ) : __CLASS__
$hashtag string hashtag
Résultat __CLASS__ support chaining

addRelated() public méthode

Add a related Twitter account
Since: 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
Résultat __CLASS__ support chaining

disableValidation() public méthode

Disabling validation may speed up Web Intent generation but may also cause user-facing issues
Since: 1.0.0
public disableValidation ( ) : __CLASS__
Résultat __CLASS__ support chaining

enableValidation() public méthode

Validate inputs
Since: 1.0.0
public enableValidation ( ) : __CLASS__
Résultat __CLASS__ support chaining

fromArray() public static méthode

Construct a new Tweet intent object from an options array
Since: 1.0.0
public static fromArray ( array $values ) : __CLASS__
$values array options array { @type string option name @type string|int|bool option value }
Résultat __CLASS__ object initialized based on passed array values

getHashtags() public méthode

Get a list of hashtags stored for the Tweet
Since: 1.0.0
public getHashtags ( ) : array
Résultat array hashtags { @type string hashtag }

getIntentURL() public méthode

Tweet intent URL
Since: 1.0.0
public getIntentURL ( ) : string
Résultat string Tweet intent URL with query parameters

getRelated() public méthode

Get related Twitter usernames
Since: 1.0.0
public getRelated ( ) : array
Résultat array { @type string username in lowercase @type string description of how the username relates to Tweet content }

getVia() public méthode

Get the stored via value
Since: 1.0.1
public getVia ( ) : string
Résultat string source Twitter account username

isHTTPURL() public static méthode

Is the passed URL an absolute URL using the HTTP or HTTPS scheme?
Since: 1.0.0
public static isHTTPURL ( string $url ) : boolean
$url string URL to test
Résultat boolean true if URL was parsed and contains a HTTP or HTTPs scheme

setInReplyTo() public méthode

Define a parent Tweet by ID
Since: 1.0.0
public setInReplyTo ( string $tweet_id ) : __CLASS__
$tweet_id string Parent Tweet ID
Résultat __CLASS__ support chaining

setText() public méthode

Pre-populate Tweet text
Since: 1.0.0
public setText ( string $text ) : __CLASS__
$text string Tweet text
Résultat __CLASS__ support chaining

setURL() public méthode

Share a URL
Since: 1.0.0
public setURL ( string $url ) : __CLASS__
$url string absolute URL
Résultat __CLASS__ support chaining

setVia() public méthode

Associate Tweet with a source account
Since: 1.0.0
public setVia ( string $username ) : __CLASS__
$username string Twitter username
Résultat __CLASS__ support chaining

shouldValidate() public méthode

Should data be validated before setting?
Since: 1.0.0
public shouldValidate ( ) : boolean
Résultat boolean validate inputs

toQueryParameters() public méthode

Convert parameters into an array prepped for use in query parameters (underscores) or data-* attributes (dashed)
Since: 1.0.0
public toQueryParameters ( ) : array
Résultat array Tweet parameters { @type string Tweet parameter @type string parameter value }

Property Details

$hashtags protected_oe property

Hashtags to include in the Tweet
Since: 1.0.0
protected $hashtags

$in_reply_to protected_oe property

Parent Tweet identifier
Since: 1.0.0
protected $in_reply_to

$text protected_oe property

Pre-populated Tweet text
Since: 1.0.0
protected $text

$url protected_oe property

Share a URL
Since: 1.0.0
protected $url

$validate_inputs protected_oe property

Validate passed variables before storing
Since: 1.0.0
protected $validate_inputs

$via protected_oe property

Associate a Tweet with an source Twitter account such as the username of your website
Since: 1.0.0
protected $via