Phundament App Class Reference
  • Package
  • Class
  • Tree

Packages

  • bootstrap
    • widgets
      • input
  • Image
  • None
  • p3admin
  • p3extensions
    • behaviors
    • commands
    • components
    • helpers
    • widgets
  • p3media
    • actions
    • controllers
    • models
  • p3pages
    • models
  • p3widgets
    • components
    • models
  • PHP
  • system
    • db
      • ar
    • gii
    • web
      • auth
      • helpers
      • widgets
  • yiiext
    • widgets
      • fancybox
      • lipsum
  • zii
    • widgets
      • grid

Classes

  • TbInput
  • TbInputHorizontal
  • TbInputInline
  • TbInputSearch
  • TbInputVertical

Class TbInput

Bootstrap input widget. Used for rendering inputs according to Bootstrap standards.

CComponent
Extended by CBaseController
Extended by CWidget
Extended by CInputWidget
Extended by TbInput

Direct known subclasses

TbInputHorizontal, TbInputVertical

Indirect known subclasses

TbInputInline, TbInputSearch

Abstract
Package: bootstrap\widgets\input
Copyright: Copyright © Christoffer Niska 2011-
License: New BSD License
Author: Christoffer Niska <ChristofferNiska@gmail.com>
Located at crisu83/yii-bootstrap/widgets/input/TbInput.php

Methods summary

public
# init( )

Initializes the widget.

Initializes the widget.

Throws

CException
if the widget could not be initialized.

Overrides

CWidget::init
protected
# processHtmlOptions( )

Processes the html options.

Processes the html options.

public
# run( )

Runs the widget.

Runs the widget.

Throws

CException
if the widget type is invalid.

Overrides

CWidget::run
protected string
# getLabel( )

Returns the label for the input.

Returns the label for the input.

Returns

string
the label
protected string
# getPrepend( )

Returns the prepend element for the input.

Returns the prepend element for the input.

Returns

string
the element
protected string
# getAppend( )

Returns the append element for the input.

Returns the append element for the input.

Returns

string
the element
protected string
# getAttributeId( string $attribute )

Returns the id that should be used for the specified attribute

Returns the id that should be used for the specified attribute

Parameters

$attribute
string
$attribute the attribute

Returns

string
the id
protected string
# getError( )

Returns the error text for the input.

Returns the error text for the input.

Returns

string
the error text
protected string
# getHint( )

Returns the hint text for the input.

Returns the hint text for the input.

Returns

string
the hint text
protected string
# getContainerCssClass( )

Returns the container CSS class for the input.

Returns the container CSS class for the input.

Returns

string
the CSS class
protected string
# getAddonCssClass( )

Returns the input container CSS classes.

Returns the input container CSS classes.

Returns

string
the CSS class
protected boolean
# hasAddOn( )

Returns whether the input has an add-on (prepend and/or append).

Returns whether the input has an add-on (prepend and/or append).

Returns

boolean
the result
abstract protected string
# checkBox( )

Renders a checkbox.

Renders a checkbox.

Returns

string
the rendered content
abstract protected string
# checkBoxList( )

Renders a list of checkboxes.

Renders a list of checkboxes.

Returns

string
the rendered content
abstract protected string
# checkBoxListInline( )

Renders a list of inline checkboxes.

Renders a list of inline checkboxes.

Returns

string
the rendered content
abstract protected string
# dropDownList( )

Renders a drop down list (select).

Renders a drop down list (select).

Returns

string
the rendered content
abstract protected string
# fileField( )

Renders a file field.

Renders a file field.

Returns

string
the rendered content
abstract protected string
# passwordField( )

Renders a password field.

Renders a password field.

Returns

string
the rendered content
abstract protected string
# radioButton( )

Renders a radio button.

Renders a radio button.

Returns

string
the rendered content
abstract protected string
# radioButtonList( )

Renders a list of radio buttons.

Renders a list of radio buttons.

Returns

string
the rendered content
abstract protected string
# radioButtonListInline( )

Renders a list of inline radio buttons.

Renders a list of inline radio buttons.

Returns

string
the rendered content
abstract protected string
# textArea( )

Renders a textarea.

Renders a textarea.

Returns

string
the rendered content
abstract protected string
# textField( )

Renders a text field.

Renders a text field.

Returns

string
the rendered content
abstract protected string
# captcha( )

Renders a CAPTCHA.

Renders a CAPTCHA.

Returns

string
the rendered content
abstract protected string
# uneditableField( )

Renders an uneditable field.

Renders an uneditable field.

Returns

string
the rendered content

Methods inherited from CInputWidget

hasModel(), resolveNameID()

Methods inherited from CWidget

__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()

Methods inherited from CBaseController

beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()

Methods inherited from CComponent

__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()

Magic methods summary

Constants summary

string TYPE_CHECKBOX 'checkbox'
#
string TYPE_CHECKBOXLIST 'checkboxlist'
#
string TYPE_CHECKBOXLIST_INLINE 'checkboxlist_inline'
#
string TYPE_DROPDOWN 'dropdownlist'
#
string TYPE_FILE 'filefield'
#
string TYPE_PASSWORD 'password'
#
string TYPE_RADIO 'radiobutton'
#
string TYPE_RADIOLIST 'radiobuttonlist'
#
string TYPE_RADIOLIST_INLINE 'radiobuttonlist_inline'
#
string TYPE_TEXTAREA 'textarea'
#
string TYPE_TEXT 'textfield'
#
string TYPE_CAPTCHA 'captcha'
#
string TYPE_UNEDITABLE 'uneditable'
#

Properties summary

public TbActiveForm $form
#

the associated form widget.

the associated form widget.

public string $label
#

the input label text.

the input label text.

public string $type
#

the input type. Following types are supported: checkbox, checkboxlist, dropdownlist, filefield, password, radiobutton, radiobuttonlist, textarea, textfield, captcha and uneditable.

the input type. Following types are supported: checkbox, checkboxlist, dropdownlist, filefield, password, radiobutton, radiobuttonlist, textarea, textfield, captcha and uneditable.

public array $data
#

the data for list inputs.

the data for list inputs.

public string $prependText
#

text to prepend.

text to prepend.

public string $appendText
#

text to append.

text to append.

public string $hintText
#

the hint text.

the hint text.

public array $labelOptions
#

label html attributes.

label html attributes.

public array $prependOptions
#

prepend html attributes.

prepend html attributes.

public array $appendOptions
#

append html attributes.

append html attributes.

public array $hintOptions
#

hint html attributes.

hint html attributes.

public array $errorOptions
#

error html attributes.

error html attributes.

public array $captchaOptions
#

captcha html attributes.

captcha html attributes.

Properties inherited from CInputWidget

$attribute, $htmlOptions, $model, $name, $value

Properties inherited from CWidget

$actionPrefix, $skin

Magic properties inherited from CWidget

$controller, $id, $owner, $viewPath

Phundament App Class Reference API documentation generated by ApiGen 2.8.0