PHP Class WhEditable

Creates editable element on page (without linking to model attribute)
See link: https://github.com/vitalets/x-editable-yii
Author: Antonio Ramirez ([email protected])
Author: Vitaliy Potapov ([email protected])
Inheritance: extends CWidget
Show file Open project: 2amigos/yiiwheels Class Usage Examples

Public Properties

Property Type Description
$apply whether to apply 'editable' js plugin to element. Only **safe** attributes become editable.
$combodate full config for **combodate** input. For details see http://vitalets.github.com/combodate/#docs
$disabled will editable be initially disabled. It means editable plugin will be applied to element, but you should call .editable('enable') method to activate it. To totally disable applying 'editable' to element use **apply** option.
$display string Example: 
'display' => 'js: function(value, sourceData) {
     var escapedValue = $("<div>").text(value).html();
     $(this).html("<b>"+escapedValue+"</b>");
}'
$emptytext text shown on empty field. If null - default X-editable value is used: Empty
$encode whether to HTML encode text on output
$format format to send date on server. If null - default X-editable value is used: yyyy-mm-dd.
$htmlOptions HTML options of element. In EditableColumn htmlOptions are PHP expressions so you can use $data to bind values to particular cell, e.g. 'data-categoryID' => '$data->categoryID'.
$inputclass css class of input. If null - default X-editable value is used: input-medium
$liveSelector string Usefull in combination of liveTarget when you want to keep field(s) editble after ajaxUpdate
$liveTarget string DOM id of target where afterAjaxUpdate handler will call live update of editable element
$mode mode of input: inline | popup. If not set - default X-editable value is used: popup.
$name name of field
$onHidden string A javascript function that will be invoked when editable form is hidden Example: 
'onHidden' => 'js: function(e, reason) {
   if(reason === "save" || reason === "cancel") {
auto-open next editable
       $(this).closest("tr").next().find(".editable").editable("show");
   }
}'
$onInit string A javascript function that will be invoked when editable element is initialized
$onSave string A javascript function that will be invoked when new value is saved Example: 
'onSave' => 'js: function(e, params) {
    alert("Saved value: " + params.newValue);
}'
$onShown string A javascript function that will be invoked when editable form is shown Example: 
'onShown' => 'js: function() {
    var $tip = $(this).data("editableContainer").tip();
    $tip.find("input").val("overwriting value of input.");
}'
$options all config options of x-editable. See full list here.
$params additional params to send on server
$pk primary key
$placement placement of popup. Can be left, top, right, bottom. If null - default X-editable value is used: top
$select2 full config for **select2** input. For details see http://ivaynberg.github.com/select2
$send Strategy for sending data on server. Can be auto|always|never. When 'auto' data will be sent on server only if **pk** and **url** defined, otherwise new value will be stored locally.
$showbuttons visibility of buttons. Can be boolean false|true or string bottom.
$source source data for **select**, **checklist**. Can be string (url) or array in format: array( array("value" => 1, "text" => "abc"), ...)
$success string Example: 
'success' => 'js: function(response, newValue) {
    if(!response.success) return response.msg;
}'
$template template for **combodate** input. For details see http://vitalets.github.com/x-editable/docs.html#combodate.
$text text to be shown as element content
$theme for jQuery UI only. The JUI theme name.
$title title of popup. If null - will be generated automatically from attribute label. Can have token {label} inside that will be replaced with actual attribute label.
$type type of editable widget. Can be text, textarea, select, date, checklist, etc.
$url url to submit value. Can be string or array containing Yii route, e.g. array('site/updateUser')
$validate string Example: 
'validate' => 'js: function(value) {
    if($.trim(value) == "") return "This field is required";
}'
$value initial value. If not set - will be taken from text
$viewformat format to display date in element. If null - equals to **format** option.
$viewseparator separator used to display tags.

Protected Properties

Property Type Description
$_prepareToAutotext

Public Methods

Method Description
attachAjaxUpdateEvent ( mixed $widget ) injects ajaxUpdate event into widget
buildHtmlOptions ( ) Builds html options
buildJsOptions ( ) Builds javascript options
getSelector ( ) : null | string Returns the plugin selector
init ( ) initialization of widget
isAutotext ( mixed $options, mixed $type ) : boolean Returns is autotext should be applied to widget: e.g. for 'select' to display text for id
registerAssets ( ) Registers assets
registerClientScript ( ) : string Registers client script
renderLink ( ) Renders a link
renderText ( ) Renders text
run ( ) Widget run method
source ( mixed $models, mixed $valueField = '', mixed $textField = '', mixed $groupField = '', mixed $groupTextField = '' ) : array Returns php-array as valid x-editable source in format: [{value: 1, text: 'text1'}, {.

Method Details

attachAjaxUpdateEvent() public static method

injects ajaxUpdate event into widget
public static attachAjaxUpdateEvent ( mixed $widget )
$widget mixed

buildHtmlOptions() public method

Builds html options
public buildHtmlOptions ( )

buildJsOptions() public method

Builds javascript options
public buildJsOptions ( )

getSelector() public method

Returns the plugin selector
public getSelector ( ) : null | string
return null | string

init() public method

initialization of widget
public init ( )

isAutotext() public static method

Returns is autotext should be applied to widget: e.g. for 'select' to display text for id
public static isAutotext ( mixed $options, mixed $type ) : boolean
$options mixed
$type mixed
return boolean

registerAssets() public method

Registers assets
public registerAssets ( )

registerClientScript() public method

Registers client script
public registerClientScript ( ) : string
return string

renderText() public method

Renders text
public renderText ( )

run() public method

Widget run method
public run ( )

source() public static method

..}] See https://github.com/vitalets/x-editable-yii/issues/37
public static source ( mixed $models, mixed $valueField = '', mixed $textField = '', mixed $groupField = '', mixed $groupTextField = '' ) : array
$models mixed
$valueField mixed
$textField mixed
$groupField mixed
$groupTextField mixed
return array

Property Details

$_prepareToAutotext protected property

protected $_prepareToAutotext

$apply public property

whether to apply 'editable' js plugin to element. Only **safe** attributes become editable.
public $apply

$combodate public property

full config for **combodate** input. For details see http://vitalets.github.com/combodate/#docs
public $combodate

$disabled public property

will editable be initially disabled. It means editable plugin will be applied to element, but you should call .editable('enable') method to activate it. To totally disable applying 'editable' to element use **apply** option.
public $disabled

$display public property

Example: 
'display' => 'js: function(value, sourceData) {
     var escapedValue = $("<div>").text(value).html();
     $(this).html("<b>"+escapedValue+"</b>");
}'
public string $display
return string

$emptytext public property

text shown on empty field. If null - default X-editable value is used: Empty
public $emptytext

$encode public property

whether to HTML encode text on output
public $encode

$format public property

format to send date on server. If null - default X-editable value is used: yyyy-mm-dd.
public $format

$htmlOptions public property

HTML options of element. In EditableColumn htmlOptions are PHP expressions so you can use $data to bind values to particular cell, e.g. 'data-categoryID' => '$data->categoryID'.
public $htmlOptions

$inputclass public property

css class of input. If null - default X-editable value is used: input-medium
public $inputclass

$liveSelector public property

Usefull in combination of liveTarget when you want to keep field(s) editble after ajaxUpdate
public string $liveSelector
return string

$liveTarget public property

DOM id of target where afterAjaxUpdate handler will call live update of editable element
public string $liveTarget
return string

$mode public property

mode of input: inline | popup. If not set - default X-editable value is used: popup.
public $mode

$name public property

name of field
public $name

$onHidden public property

A javascript function that will be invoked when editable form is hidden Example: 
'onHidden' => 'js: function(e, reason) {
   if(reason === "save" || reason === "cancel") {
auto-open next editable
       $(this).closest("tr").next().find(".editable").editable("show");
   }
}'
public string $onHidden
return string

$onInit public property

A javascript function that will be invoked when editable element is initialized
public string $onInit
return string

$onSave public property

A javascript function that will be invoked when new value is saved Example: 
'onSave' => 'js: function(e, params) {
    alert("Saved value: " + params.newValue);
}'
public string $onSave
return string

$onShown public property

A javascript function that will be invoked when editable form is shown Example: 
'onShown' => 'js: function() {
    var $tip = $(this).data("editableContainer").tip();
    $tip.find("input").val("overwriting value of input.");
}'
public string $onShown
return string

$options public property

all config options of x-editable. See full list here.
public $options

$params public property

additional params to send on server
public $params

$pk public property

primary key
public $pk

$placement public property

placement of popup. Can be left, top, right, bottom. If null - default X-editable value is used: top
public $placement

$select2 public property

full config for **select2** input. For details see http://ivaynberg.github.com/select2
public $select2

$send public property

Strategy for sending data on server. Can be auto|always|never. When 'auto' data will be sent on server only if **pk** and **url** defined, otherwise new value will be stored locally.
public $send

$showbuttons public property

visibility of buttons. Can be boolean false|true or string bottom.
public $showbuttons

$source public property

source data for **select**, **checklist**. Can be string (url) or array in format: array( array("value" => 1, "text" => "abc"), ...)
public $source

$success public property

Example: 
'success' => 'js: function(response, newValue) {
    if(!response.success) return response.msg;
}'
public string $success
return string

$template public property

template for **combodate** input. For details see http://vitalets.github.com/x-editable/docs.html#combodate.
public $template

$text public property

text to be shown as element content
public $text

$theme public property

for jQuery UI only. The JUI theme name.
public $theme

$title public property

title of popup. If null - will be generated automatically from attribute label. Can have token {label} inside that will be replaced with actual attribute label.
public $title

$type public property

type of editable widget. Can be text, textarea, select, date, checklist, etc.
public $type

$url public property

url to submit value. Can be string or array containing Yii route, e.g. array('site/updateUser')
public $url

$validate public property

Example: 
'validate' => 'js: function(value) {
    if($.trim(value) == "") return "This field is required";
}'
public string $validate
return string

$value public property

initial value. If not set - will be taken from text
public $value

$viewformat public property

format to display date in element. If null - equals to **format** option.
public $viewformat

$viewseparator public property

separator used to display tags.
public $viewseparator