PHP Class kartik\social\TwitterPlugin

Usage: echo TwitterPlugin::widget([ 'screenName' => 'TWITTER_SCREEN_NAME', 'type' => TwitterPlugin::MENTION, 'settings' => ['size' => 'large'] ]);
Since: 1.0
Author: Kartik Visweswaran ([email protected])
Inheritance: extends Widget
Datei anzeigen Open project: kartik-v/yii2-social Class Usage Examples

Public Properties

Property Type Description
$hashTag the Twitter hash tag (to be used for hashtag button)
$screenName the Twitter screen name (to be used for follow, hashtag & mention buttons)
$settings the Twitter plugin settings
$timelineConfig the additional configuration options for TwitterPlugin::TIMELINE, in case you do not wish to use a user timeline. One of the following settings may be set: - listSlug: string, the list slug and applicable only if you want to use embedded list timeline. @see https://dev.twitter.com/web/embedded-timelines/list - search: string, the search hash tag, if you want to use embedded search timeline. @see https://dev.twitter.com/web/embedded-timelines/search - collectionId: string, the collection identifier, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collection - collectionName: string, the collection name, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collection
$type the Twitter plugin type defaults to Twitter Share (Tweet) button

Public Methods

Method Description
init ( ) Initialize the widget

Protected Methods

Method Description
registerAssets ( ) Registers the necessary assets

Method Details

init() public method

Initialize the widget
public init ( )

registerAssets() protected method

Registers the necessary assets
protected registerAssets ( )

Property Details

$hashTag public_oe property

the Twitter hash tag (to be used for hashtag button)
public $hashTag

$screenName public_oe property

the Twitter screen name (to be used for follow, hashtag & mention buttons)
public $screenName

$settings public_oe property

the Twitter plugin settings
public $settings

$timelineConfig public_oe property

the additional configuration options for TwitterPlugin::TIMELINE, in case you do not wish to use a user timeline. One of the following settings may be set: - listSlug: string, the list slug and applicable only if you want to use embedded list timeline. @see https://dev.twitter.com/web/embedded-timelines/list - search: string, the search hash tag, if you want to use embedded search timeline. @see https://dev.twitter.com/web/embedded-timelines/search - collectionId: string, the collection identifier, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collection - collectionName: string, the collection name, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collection
public $timelineConfig

$type public_oe property

the Twitter plugin type defaults to Twitter Share (Tweet) button
public $type