Class kartik\social\TwitterPlugin
| Inheritance | kartik\social\TwitterPlugin » kartik\social\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 1.0 |
Widget to render various Twitter plugins
Usage:
`
echo TwitterPlugin::widget([
'screenName' => 'TWITTER_SCREEN_NAME',
'type' => TwitterPlugin::MENTION,
'settings' => ['size' => 'large']
]);
`
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $config | string | Name of the widget | kartik\social\Widget |
| $content | string | The content to be embedded in between the plugin tag | kartik\social\Widget |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $dataApiPrefix | string | Text to be prefixed for the data api | kartik\social\Widget |
| $hashTag | string | The Twitter hash tag (to be used for hashtag button) | kartik\social\TwitterPlugin |
| $i18n | array | The the internalization configuration for this widget | kartik\social\Widget |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $language | string | The language used in displaying content. | kartik\social\Widget |
| $moduleName | string | The name of the module | kartik\social\Widget |
| $noscript | string | Text to be displayed if browser does not support javascript. | kartik\social\Widget |
| $noscriptOptions | array | HTML attributes for the noscript message container | kartik\social\Widget |
| $options | array | The HTML attributes for the plugin container. | kartik\social\Widget |
| $screenName | string | The Twitter screen name (to be used for follow, hashtag & mention buttons) | kartik\social\TwitterPlugin |
| $settings | array | The Twitter plugin settings | kartik\social\TwitterPlugin |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $tag | string | The tag for enclosing the plugin. | kartik\social\Widget |
| $timelineConfig | string | The additional configuration options for TwitterPlugin::TIMELINE, in case you do not wish to use a user timeline. | kartik\social\TwitterPlugin |
| $type | string | The Twitter plugin type defaults to Twitter Share (Tweet) button | kartik\social\TwitterPlugin |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $validPlugins | array | The valid plugins | kartik\social\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getConfig() | Gets configuration for a widget from the module | kartik\social\Widget |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initialize the widget | kartik\social\TwitterPlugin |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | Executes the widget. | yii\base\Widget |
| setConfig() | Sets configuration for a widget based on the module level configuration | kartik\social\Widget |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| registerAssets() | Registers the necessary assets | kartik\social\TwitterPlugin |
| renderNoScript() | Generates the noscript container | kartik\social\Widget |
| renderPlugin() | Generates the plugin markup | kartik\social\Widget |
| setPluginOptions() | Sets the options for the plugin | kartik\social\Widget |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| FOLLOW | 'twitter-follow-button' | kartik\social\TwitterPlugin | |
| HASHTAG | 'twitter-hashtag-button' | kartik\social\TwitterPlugin | |
| MENTION | 'twitter-mention-button' | kartik\social\TwitterPlugin | |
| SHARE | 'twitter-share-button' | kartik\social\TwitterPlugin | |
| TIMELINE | 'twitter-timeline' | kartik\social\TwitterPlugin | |
| TWEET | 'twitter-tweet' | kartik\social\TwitterPlugin |
Property Details
The Twitter hash tag (to be used for hashtag button)
The Twitter screen name (to be used for follow, hashtag & mention buttons)
The Twitter plugin settings
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/listsearch: string, the search hash tag, if you want to use embedded search timeline. @see https://dev.twitter.com/web/embedded-timelines/searchcollectionId: string, the collection identifier, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collectioncollectionName: string, the collection name, if you want to use embedded collection timeline. @see https://dev.twitter.com/web/embedded-timelines/collection
The Twitter plugin type defaults to Twitter Share (Tweet) button
Method Details
Initialize the widget
| public void init ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Registers the necessary assets
| protected void registerAssets ( ) |