PHP Класс Prado\Web\UI\WebControls\TRatingList

This class is EXPERIMENTAL.
С версии: 3.0
Наследование: extends TRadioButtonList
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
__construct ( ) Sets the default repeat direction to horizontal.
getAllowInput ( ) : boolean Wrapper for {@link setReadOnly ReadOnly} property.
getCaption ( ) : string
getCaptionID ( ) : string
getHalfRatingInterval ( ) : array
getRating ( ) : float
getRatingStyle ( ) : TRatingListStyle
getReadOnly ( ) : boolean
onPreRender ( $param ) Publish the the rating style css file and rating image files.
onSelectedIndexChanged ( $param )
render ( $writer ) Add rating style class name to the class attribute when {@link setReadOnly ReadOnly} property is true and when the {@link setCssClass CssClass} property is empty.
setAllowInput ( $value ) Wrapper for {@link setReadOnly ReadOnly} property.
setCaption ( $value ) : TRatingListStyle
setCaptionID ( $value )
setEnabled ( $value ) Wrapper for {@link setReadOnly ReadOnly} property.
setHalfRatingInterval ( $value ) Sets the interval such that those rating values within the interval will be considered as a half star rating.
setRating ( $value )
setRatingStyle ( $value )
setReadOnly ( $value )
setRepeatLayout ( $value ) The repeat layout must be Table.
setSelectedIndex ( $value )

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

Метод Описание
getAssetUrl ( $file = '' ) : string
getCaptionControl ( )
getCaptionControlID ( ) : string
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing postback for this control.
getPostBackOptions ( ) : array
getRatingIndex ( $rating ) : integer
getRatingStyleCssClass ( ) : string
publishImages ( $style, $fileExt = '.gif' ) : array
publishStyle ( $style ) : string
registerClientScript ( ) Registers the relevant JavaScript.

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

__construct() публичный Метод

Sets the default repeat direction to horizontal.
public __construct ( )

getAllowInput() публичный Метод

Wrapper for {@link setReadOnly ReadOnly} property.
public getAllowInput ( ) : boolean
Результат boolean whether the rating list can be edited. Defaults to true.

getAssetUrl() защищенный Метод

protected getAssetUrl ( $file = '' ) : string
Результат string asset file url.

getCaption() публичный Метод

public getCaption ( ) : string
Результат string caption text. Default is "Rate It:".

getCaptionControl() защищенный Метод

protected getCaptionControl ( )

getCaptionControlID() защищенный Метод

protected getCaptionControlID ( ) : string
Результат string find the client ID of the caption control.

getCaptionID() публичный Метод

public getCaptionID ( ) : string
Результат string control or html element ID for displaying a caption.

getClientClassName() защищенный Метод

This method overrides the parent implementation.
protected getClientClassName ( ) : string
Результат string the javascript class name

getHalfRatingInterval() публичный Метод

public getHalfRatingInterval ( ) : array
Результат array rating display half value interval, default is array(0.3, 0.7);

getPostBackOptions() защищенный Метод

protected getPostBackOptions ( ) : array
Результат array list of post back options.

getRating() публичный Метод

public getRating ( ) : float
Результат float rating value.

getRatingIndex() защищенный Метод

protected getRatingIndex ( $rating ) : integer
Результат integer rating as integer

getRatingStyle() публичный Метод

public getRatingStyle ( ) : TRatingListStyle
Результат TRatingListStyle current rating style

getRatingStyleCssClass() защищенный Метод

protected getRatingStyleCssClass ( ) : string
Результат string rating style css class name.

getReadOnly() публичный Метод

public getReadOnly ( ) : boolean
Результат boolean whether the items in the column can be edited. Defaults to false.

onPreRender() публичный Метод

Publish the the rating style css file and rating image files.
public onPreRender ( $param )

onSelectedIndexChanged() публичный Метод

public onSelectedIndexChanged ( $param )

publishImages() защищенный Метод

protected publishImages ( $style, $fileExt = '.gif' ) : array
Результат array URL of publish the rating images

publishStyle() защищенный Метод

protected publishStyle ( $style ) : string
Результат string URL of the css style file

registerClientScript() защищенный Метод

Registers the relevant JavaScript.
protected registerClientScript ( )

render() публичный Метод

Add rating style class name to the class attribute when {@link setReadOnly ReadOnly} property is true and when the {@link setCssClass CssClass} property is empty.
public render ( $writer )

setAllowInput() публичный Метод

Wrapper for {@link setReadOnly ReadOnly} property.
public setAllowInput ( $value )

setCaption() публичный Метод

public setCaption ( $value ) : TRatingListStyle
Результат TRatingListStyle current rating style

setCaptionID() публичный Метод

public setCaptionID ( $value )

setEnabled() публичный Метод

Wrapper for {@link setReadOnly ReadOnly} property.
public setEnabled ( $value )

setHalfRatingInterval() публичный Метод

Sets the interval such that those rating values within the interval will be considered as a half star rating.
public setHalfRatingInterval ( $value )

setRating() публичный Метод

public setRating ( $value )

setRatingStyle() публичный Метод

public setRatingStyle ( $value )

setReadOnly() публичный Метод

public setReadOnly ( $value )

setRepeatLayout() публичный Метод

The repeat layout must be Table.
public setRepeatLayout ( $value )

setSelectedIndex() публичный Метод

public setSelectedIndex ( $value )