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

  • TbActiveForm
  • TbAlert
  • TbBadge
  • TbBreadcrumbs
  • TbButton
  • TbButtonColumn
  • TbButtonGroup
  • TbCarousel
  • TbCollapse
  • TbDataColumn
  • TbDetailView
  • TbDropdown
  • TbGridView
  • TbHeroUnit
  • TbLabel
  • TbListView
  • TbMenu
  • TbModal
  • TbNavbar
  • TbPager
  • TbProgress
  • TbScrollSpy
  • TbTabs
  • TbThumbnails
  • TbTypeahead

Class TbActiveForm

Bootstrap active form widget.

CComponent
Extended by CBaseController
Extended by CWidget
Extended by CActiveForm
Extended by TbActiveForm
Package: bootstrap\widgets
Copyright: Copyright © Christoffer Niska 2011-
License: New BSD License
Author: Christoffer Niska <ChristofferNiska@gmail.com>
Located at crisu83/yii-bootstrap/widgets/TbActiveForm.php

Methods summary

public
# init( )

Initializes the widget. This renders the form open tag.

Initializes the widget. This renders the form open tag.

Overrides

CActiveForm::init
public string
# checkBoxRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a checkbox input row.

Renders a checkbox input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# checkBoxListRow( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Renders a checkbox list input row.

Renders a checkbox list input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the list data
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# checkBoxListInlineRow( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Renders a checkbox list inline input row.

Renders a checkbox list inline input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the list data
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# dropDownListRow( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Renders a drop-down list input row.

Renders a drop-down list input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the list data
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# fileFieldRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a file field input row.

Renders a file field input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# passwordFieldRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a password field input row.

Renders a password field input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# radioButtonRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a radio button input row.

Renders a radio button input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# radioButtonListRow( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Renders a radio button list input row.

Renders a radio button list input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the list data
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# radioButtonListInlineRow( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Renders a radio button list inline input row.

Renders a radio button list inline input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the list data
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# textFieldRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a text field input row.

Renders a text field input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# textAreaRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a text area input row.

Renders a text area input row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
public string
# captchaRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders a captcha row.

Renders a captcha row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row

Since

0.9.3
public string
# uneditableRow( CModel $model, string $attribute, array $htmlOptions = array() )

Renders an uneditable text field row.

Renders an uneditable text field row.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row

Since

0.9.5
public string
# checkBoxList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Renders a checkbox list for a model attribute. This method is a wrapper of CHtml::activeCheckBoxList. Please check CHtml::activeCheckBoxList for detailed information about the parameters for this method.

Renders a checkbox list for a model attribute. This method is a wrapper of CHtml::activeCheckBoxList. Please check CHtml::activeCheckBoxList for detailed information about the parameters for this method.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data value-label pairs used to generate the check box list.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated check box list

Since

0.9.5

Overrides

CActiveForm::checkBoxList
public string
# radioButtonList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Renders a radio button list for a model attribute. This method is a wrapper of CHtml::activeRadioButtonList. Please check CHtml::activeRadioButtonList for detailed information about the parameters for this method.

Renders a radio button list for a model attribute. This method is a wrapper of CHtml::activeRadioButtonList. Please check CHtml::activeRadioButtonList for detailed information about the parameters for this method.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data value-label pairs used to generate the radio button list.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated radio button list

Since

0.9.5

Overrides

CActiveForm::radioButtonList
protected string
# inputsList( boolean $checkbox, CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Renders an input list.

Renders an input list.

Parameters

$checkbox
boolean
$checkbox flag that indicates if the list is a checkbox-list.
$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data value-label pairs used to generate the input list.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated input list.

Since

0.9.5
public string
# errorSummary( mixed $models, string $header = null, string $footer = null, array $htmlOptions = array() )

Displays a summary of validation errors for one or several models. This method is very similar to CHtml::errorSummary except that it also works when AJAX validation is performed.

Displays a summary of validation errors for one or several models. This method is very similar to CHtml::errorSummary except that it also works when AJAX validation is performed.

Parameters

$models
mixed
$models the models whose input errors are to be displayed. This can be either a single model or an array of models.
$header
string
$header a piece of HTML code that appears in front of the errors
$footer
string
$footer a piece of HTML code that appears at the end of the errors
$htmlOptions
array
$htmlOptions additional HTML attributes to be rendered in the container div tag.

Returns

string
the error summary. Empty if no errors are found.

See

CHtml::errorSummary

Overrides

CActiveForm::errorSummary
public string
# error( CModel $model, string $attribute, array $htmlOptions = array(), boolean $enableAjaxValidation = true, boolean $enableClientValidation = true )

Displays the first validation error for a model attribute.

Displays the first validation error for a model attribute.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute name
$htmlOptions
array
$htmlOptions additional HTML attributes to be rendered in the container div tag.
$enableAjaxValidation
boolean
$enableAjaxValidation whether to enable AJAX validation for the specified attribute.
$enableClientValidation
boolean
$enableClientValidation whether to enable client-side validation for the specified attribute.

Returns

string
the validation result (error display or success message).

Overrides

CActiveForm::error
protected static string
# renderError( CModel $model, string $attribute, array $htmlOptions = array() )

Displays the first validation error for a model attribute.

Displays the first validation error for a model attribute.

Parameters

$model
CModel
$model the data model
$attribute
string
$attribute the attribute name
$htmlOptions
array
$htmlOptions additional HTML attributes to be rendered in the container div tag.

Returns

string
the error display. Empty if no errors are found.

See

CModel::getErrors
errorMessageCss
public string
# inputRow( string $type, CModel $model, string $attribute, array $data = null, array $htmlOptions = array() )

Creates an input row of a specific type.

Creates an input row of a specific type.

Parameters

$type
string
$type the input type
$model
CModel
$model the data model
$attribute
string
$attribute the attribute
$data
array
$data the data for list inputs
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated row
protected string
# getInputClassName( )

Returns the input widget class name suitable for the form.

Returns the input widget class name suitable for the form.

Returns

string
the class name

Methods inherited from CActiveForm

checkBox(), dateField(), dropDownList(), emailField(), fileField(), hiddenField(), label(), labelEx(), listBox(), numberField(), passwordField(), radioButton(), rangeField(), run(), textArea(), textField(), urlField(), validate(), validateTabular()

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_VERTICAL 'vertical'
#
string TYPE_INLINE 'inline'
#
string TYPE_HORIZONTAL 'horizontal'
#
string TYPE_SEARCH 'search'
#
string INPUT_HORIZONTAL 'bootstrap.widgets.input.TbInputHorizontal'
#
string INPUT_INLINE 'bootstrap.widgets.input.TbInputInline'
#
string INPUT_SEARCH 'bootstrap.widgets.input.TbInputSearch'
#
string INPUT_VERTICAL 'bootstrap.widgets.input.TbInputVertical'
#

Properties summary

public string $type
#

the form type. See class constants.

the form type. See class constants.
public string $input
#

input class.

input class.
public boolean $inlineErrors
#

indicates whether to display errors as blocks.

indicates whether to display errors as blocks.

Properties inherited from CActiveForm

$action, $attributes, $clientOptions, $enableAjaxValidation, $enableClientValidation, $errorMessageCssClass, $focus, $htmlOptions, $method, $stateful, $summaryID

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