PHP Класс kartik\social\Widget

С версии: 1.0
Автор: Kartik Visweswaran ([email protected])
Наследование: extends yii\base\Widget
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$content the content to be embedded in between the plugin tag
$dataApiPrefix text to be prefixed for the data api
$i18n the the internalization configuration for this widget
$language the language used in displaying content. If not provided, defaults to en_US.
$moduleName the name of the module
$noscript text to be displayed if browser does not support javascript. If set to false will not displayed;
$noscriptOptions HTML attributes for the noscript message container
$options the HTML attributes for the plugin container.
$settings the social plugin settings
$tag the tag for enclosing the plugin. Defaults to 'div'.
$type the social plugin type

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

Свойство Тип Описание
$validPlugins the valid plugins

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

Метод Описание
getConfig ( string $widget ) : array Gets configuration for a widget from the module
init ( ) Initialize the widget
setConfig ( string $widget ) Sets configuration for a widget based on the module level configuration

Защищенные методы

Метод Описание
renderNoScript ( ) : string Generates the noscript container
renderPlugin ( ) : string Generates the plugin markup
setPluginOptions ( boolean $convertLowerCase = true ) Sets the options for the plugin

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

getConfig() публичный метод

Gets configuration for a widget from the module
public getConfig ( string $widget ) : array
$widget string name of the widget
Результат array

init() публичный метод

Initialize the widget
public init ( )

renderNoScript() защищенный метод

Generates the noscript container
protected renderNoScript ( ) : string
Результат string

renderPlugin() защищенный метод

Generates the plugin markup
protected renderPlugin ( ) : string
Результат string

setConfig() публичный метод

Sets configuration for a widget based on the module level configuration
public setConfig ( string $widget )
$widget string name of the widget

setPluginOptions() защищенный метод

Sets the options for the plugin
protected setPluginOptions ( boolean $convertLowerCase = true )
$convertLowerCase boolean

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

$content публичное свойство

the content to be embedded in between the plugin tag
public $content

$dataApiPrefix публичное свойство

text to be prefixed for the data api
public $dataApiPrefix

$i18n публичное свойство

the the internalization configuration for this widget
public $i18n

$language публичное свойство

the language used in displaying content. If not provided, defaults to en_US.
public $language

$moduleName публичное свойство

the name of the module
public $moduleName

$noscript публичное свойство

text to be displayed if browser does not support javascript. If set to false will not displayed;
public $noscript

$noscriptOptions публичное свойство

HTML attributes for the noscript message container
public $noscriptOptions

$options публичное свойство

the HTML attributes for the plugin container.
public $options

$settings публичное свойство

the social plugin settings
public $settings

$tag публичное свойство

the tag for enclosing the plugin. Defaults to 'div'.
public $tag

$type публичное свойство

the social plugin type
public $type

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

the valid plugins
protected $validPlugins