For more details and usage information on ActionColumn, see the guide article on data widgets.
+The html options to be applied to the default button.
-The button rendering callbacks. The array keys are the button names (without curly brackets), and the values are the corresponding button rendering callbacks. The callbacks should use the following signature:
-function (url, model, key) {
// return the button HTML code
}
+function (url, model, key) {
// return the button HTML code
}
where $url is the URL that the column creates for the button, $model is the model object
being rendered for the current row, and $key is the key of the model in the data provider array.
You can add further conditions to the button, for example only display it, when the model is editable (here assuming you have a status field that indicates that):
-{
update: function(url, model, key) {
return model.status === 'editable' ? Html.a('Update', url) : '';
},
},
+{
update: function(url, model, key) {
return model.status === 'editable' ? Html.a('Update', url) : '';
},
},
-This is a callable that will be used to generate the content of each cell.
The signature of the function should be the following: function (model, key, index, column).
Where model, key, and index refer to the model, key and index of the row currently being rendered
and column is a reference to the Column object.
Closure the HTML attributes for the data cell tag. This can either be an array of
attributes or an anonymous function ([[Closure]]) that returns such an array.
The signature of the function should be the following: function (model, key, index, column).
@@ -31,54 +31,54 @@
and column is a reference to the Column object.
A function may be used to assign different attributes to different rows based on the data in that row.
The HTML attributes for the filter cell tag.
The footer cell content. Note that it will not be HTML-encoded.
-The HTML attributes for the footer cell tag.
The grid view object that owns this column.
-The header cell content. Note that it will not be HTML-encoded.
-The HTML attributes for the header cell tag.
-The array keys are the icon names and the values the corresponding html:
-{
eye-open: '<svg ...></svg>',
pencil: Html.tag('span', '', [ {class: 'glyphicon glyphicon-pencil'})
}
+{
eye-open: '<svg ...></svg>',
pencil: Html.tag('span', '', [ {class: 'glyphicon glyphicon-pencil'})
}
Defaults to FontAwesome 5 free svg icons.
A Promise which resolves when this Component has been successfully initialized.
-The HTML attributes for the column group tag.
The template used for composing each cell in the action column.
Tokens enclosed within curly brackets are treated as controller action IDs (also called button names
in the context of action column). They will be replaced by the corresponding button rendering callbacks
specified in buttons. For example, the token {view} will be replaced by the result of
the callback buttons['view']. If a callback cannot be found, the token will be replaced with an empty string.
As an example, to only have the view, and update button you can add the ActionColumn to your GridView columns as follows:
-{class: 'ActionColumn', template: '{view} {update}'},
+{class: 'ActionColumn', template: '{view} {update}'},
Whether this column is visible. Defaults to true.
-The visibility conditions for each button. The array keys are the button names (without curly brackets), and the values are the boolean true/false or the anonymous function. When the button name is not specified in this array it will be shown by default. The callbacks must use the following signature:
-function (model, key, index) {
return model.status === 'editable';
}
+function (model, key, index) {
return model.status === 'editable';
}
Or you can pass a boolean value:
-{
update: true
}
+{
update: true
}
-Creates a URL for the given action and model. This method is called for each button and each row.
the current row index
the created URL
-Returns header cell label. This method may be overridden to customize the label of the header cell.
label
-Initializes the object. This method is invoked at the end of the constructor after the object is initialized with the given configuration.
-Initializes the default button rendering callback for single button.
Button name as it's written in template
@@ -104,9 +104,9 @@Part of Bootstrap glyphicon class that makes it unique
Array of additional options
-Initializes the default button rendering callbacks.
-Renders a data cell.
the data model being rendered
@@ -115,7 +115,7 @@the zero-based index of the data item among the item array returned by GridView.dataProvider.
the rendering result
-Renders the data cell content.
the data model
@@ -124,23 +124,23 @@the zero-based index of the data model among the models array returned by GridView.dataProvider.
the rendering result
-Renders the filter cell.
-Renders the filter cell content. The default implementation simply renders a space. This method may be overridden to customize the rendering of the filter cell (if any).
the rendering result
-Renders the footer cell.
-Renders the footer cell content. The default implementation simply renders footer. This method may be overridden to customize the rendering of the footer cell.
the rendering result
-Renders the header cell.
-Renders the header cell content. The default implementation simply renders header. This method may be overridden to customize the rendering of the header cell.
diff --git a/docs/api-docs/classes/ActiveDataProvider.html b/docs/api-docs/classes/ActiveDataProvider.html index e9a18b1..772a6b9 100644 --- a/docs/api-docs/classes/ActiveDataProvider.html +++ b/docs/api-docs/classes/ActiveDataProvider.html @@ -2,30 +2,30 @@ActiveDataProvider implements a data provider based on db queries.
ActiveDataProvider provides real time data by performing DB queries using query.
The following is an example of using ActiveDataProvider to provide ActiveRecord instances:
-let provider = new ActiveDataProvider({
modelClass: Post,
query: { where: { companyId: 123 } },
pagination: {
pageSize: 20,
},
});
// get the posts in the current page
let posts = provider.getModels();
+let provider = new ActiveDataProvider({
modelClass: Post,
query: { where: { companyId: 123 } },
pagination: {
pageSize: 20,
},
});
// get the posts in the current page
let posts = provider.getModels();
For more details and usage information on ActiveDataProvider, see the guide article on data providers.
An ID that uniquely identifies the data provider among all data providers. Generated automatically the following way in case it is not set:
A Promise which resolves when this Component has been successfully initialized.
-The column that is used as the key of the data models. This can be a column name that returns the key value of a given data model.
If this is not set, the primary keys of modelClass will be used.
Model Class which can be used for resolving Attribute Labels, Hints etc.
-Th adapter for the ORM which is being used for the Application. eg:- SequelizeAdapter
-the query that is used to fetch data models and totalCount if it is not explicitly set. This structure of this property depends upon the ORM being used. Example for Sequelize: @@ -39,56 +39,56 @@ } }); provider.getModels(); // returns the models matching the current query.
-Promise which resolves to the number matching records for the current query.
-Returns the number of data models in the current page.
the number of data models in the current page.
-Returns the key values associated with the data models.
the list of key values corresponding to [[models]]. Each data model in [[models]] is uniquely identified by the corresponding key value in this array.
-Returns the data models in the current page.
the list of data models in the current page.
-Returns the pagination object used by this data provider. Note that you should call prepare or getModels first to get correct values of Pagination.totalCount and [[Pagination::pageCount]].
the pagination object. If this is false, it means the pagination is disabled.
-Returns the sorting object used by this data provider.
the sorting object. If this is false, it means the sorting is disabled.
-Returns the total number of data models. When pagination is false, this returns the same value as count. Otherwise, it will call prepareTotalCount to get the count.
total number of possible data models.
-Initializes the ORM Adapter. This method will initialize the ormAdapter property (when set) to make sure it refers to a valid ORM Adapter.
-Prepares the data models and keys.
whether to force data preparation even if it has been done before.
-Prepares the keys associated with the currently available data models.
-Prepares the data models that will be made available in the current page.
-Returns a value indicating the total number of data models in this data provider.
-Refreshes the data provider. After calling this method, if getModels, getKeys or getTotalCount is called again, they will re-execute the query and return the latest data available.
-Sets the data models in the current page.
the models in the current page
-Sets the pagination for this data provider.
the pagination to be used by this data provider. @@ -99,9 +99,9 @@
Sets the sort definition for this data provider.
-Sets the total number of data models.
the total number of data models.
diff --git a/docs/api-docs/classes/ActiveField.html b/docs/api-docs/classes/ActiveField.html index c8fffdc..7dd1df4 100644 --- a/docs/api-docs/classes/ActiveField.html +++ b/docs/api-docs/classes/ActiveField.html @@ -2,22 +2,24 @@ActiveField represents a form input field within an ActiveForm.
For more details and usage information on ActiveField, see the guide article on forms.
This property holds a custom input id if it was set using inputOptions or in one of the
options parameters of the input* methods.
If "for" field label attribute should be skipped.
-Adds aria HTML attributes aria-required and aria-invalid for inputs
The model attribute that this field is associated with.
-The params with which /assets/js/activeForm.js should perform the client validation.
+Whether to enable AJAX-based data validation. If not set, it will take the value of ActiveForm.enableAjaxValidation.
-Whether to enable client-side data validation. If not set, it will take the value of ActiveForm.enableClientValidation.
-The form that this field is associated with.
-A Promise which resolves when this Component has been successfully initialized.
-The default options for the input tags. The parameter passed to individual input methods (e.g. textInput) will be merged with this property when rendering the input tag.
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
The default options for the label tags. The parameter passed to label will be merged with this property when rendering the label tag.
The data model that this field is associated with.
-The HTML attributes (name-value pairs) for the field container tag.
The values will be HTML-encoded using Html.encode.
If a value is null, the corresponding attribute will not be rendered.
@@ -62,56 +64,56 @@
If you set a custom id for the container element, you may need to adjust the selectors accordingly.
Different parts of the field (e.g. input, label). This will be used together with
template to generate the final field HTML code. The keys are the token names in template,
while the values are the corresponding HTML code. Valid tokens include {input}, {label} and {error}.
Note that you normally don't need to access this property directly as
it is maintained by various methods of this class.
The jQuery selectors for selecting the container, input and error tags.
The array keys should be container, input, and/or error, and the array values
are the corresponding selectors. For example, { input: '#my-input'}.
The container selector is used under the context of the form, while the input and the error selectors are used under the context of the container.
You normally do not need to set this property as the default selectors should work well for most cases.
-The template that is used to arrange the label, the input field, the error message and the hint text.
The following tokens will be replaced when [[render()]] is called: {label}, {input}, {error} and {hint}.
Whether to perform validation when the input field loses focus. If not set, it will take the value of ActiveForm.validateOnBlur.
-Whether to perform validation when the value of the input field is changed. If not set, it will take the value of ActiveForm.validateOnChange.
-Whether to perform validation while the user is typing in the input field. If not set, it will take the value of ActiveForm.validateOnType.
Number of milliseconds that the validation should be delayed when the user types in the field
and validateOnType is set true.
If not set, it will take the value of ActiveForm.validationDelay.
Returns the string representation of this object.
string the string representation of this object.
-Adds validation class to the input options if needed.
input options
-Add role attributes to the input options
input options
Adjusts the for attribute for the label based on the input options.
the input options.
-Renders the opening tag of the field container.
the rendering result.
-Renders a checkbox.
This method will generate the checked tag attribute according to the model attribute value.
true, the method will still use template to layout the checkbox and the error message
except that the checkbox is enclosed by the label tag.
the field object itself.
-Renders a list of checkboxes. A checkbox list allows multiple selection, like listBox. As a result, the corresponding submitted value is an array. @@ -147,7 +149,7 @@
options (name => config) for the checkbox list.
For the list of available options please refer to the $options parameter of Html.activeCheckboxList.
the field object itself.
-Returns the JavaScript needed for performing client-side validation.
Calls getClientOptions to generate options array for client-side validation.
You may override this method to return the JavaScript validation code if @@ -177,11 +179,11 @@
the validation criteria as defined in clientValidators
the client-side validation script. Null if the validator does not support client-side validation.
-Adds aria attributes to the input options.
input options
-Renders a drop-down list. The selection of the drop-down list is taken from the value of the model attribute.
For the list of available options please refer to the $options parameter of Html.activeDropDownList.
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
the field object itself.
-Renders the closing tag of the field container.
the rendering result.
-Generates a tag that contains the first validation error of attribute. Note that even if there is no validation error, this method will still return an empty error tag.
the field object itself.
-Renders a file input.
This method will generate the name and value tag attributes automatically for the model attribute
unless they are explicitly specified in options.
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
the field object itself.
-Returns the JS options for the field.
the JS options.
-Returns the HTML id of the input element of this form field.
the input id.
-Renders a hidden input.
Note that this method is provided for completeness. In most cases because you do not need to validate a hidden input, you should not need to use this method. Instead, you should @@ -238,7 +240,7 @@
This method will generate the name and value tag attributes automatically for the model attribute
unless they are explicitly specified in options.
the field object itself.
-Renders the hint tag.
the hint content. @@ -254,11 +256,11 @@ See also Html.tag.
the field object itself.
-Initializes the object. This method is invoked at the end of the constructor after the object is initialized with the given configuration.
-Renders an input tag.
the input type (e.g. text, password)
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
the field object itself.
-Checks if ajax validation enabled for the field.
bool
-Checks if client validation enabled for the field.
bool
-Generates a label tag for attribute.
the label to use. If null, the label will be generated via Model.getAttributeLabel.
@@ -284,7 +286,7 @@
The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
using Html.encode. If a value is null, the corresponding attribute will not be rendered.
the field object itself.
-Renders a list box. The selection of the list box is taken from the value of the model attribute.
For the list of available options please refer to the $options parameter of Html.activeListBox.
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
the field object itself.
-Renders a password input.
This method will generate the name and value tag attributes automatically for the model attribute
unless they are explicitly specified in options.
If you set a custom id for the input element, you may need to adjust the selectors accordingly.
the field object itself.
-Renders a radio button.
This method will generate the checked tag attribute according to the model attribute value.
true, the method will still use template to layout the radio button and the error message
except that the radio is enclosed by the label tag.
the field object itself.
-Renders a list of radio buttons. A radio button list is like a checkbox list, except that it only allows single selection. The selection of the radio buttons is taken from the value of the model attribute.
@@ -344,7 +346,7 @@options (name => config) for the radio button list.
For the list of available options please refer to the options parameter of Html.activeRadioList.
the field object itself.
-Renders the whole field. This method will generate the label, error tag, input tag and hint tag (if any), and assemble them into HTML according to template.
@@ -353,10 +355,10 @@ Ifnull (not set), the default methods will be called to generate the label, error tag and input tag,
and use them as the content.
If a callback, it will be called to generate the content. The signature of the callback should be:
-function (field) {
return html;
}
+function (field) {
return html;
}
the rendering result.
-Renders a text input.
This method will generate the name and value tag attributes automatically for the model attribute
unless they are explicitly specified in options.
Note that if you set a custom id for the input element, you may need to adjust the value of selectors accordingly.
the field object itself.
-Renders a text area. The model attribute value will be used as the content in the textarea.
ActiveForm is a widget that builds an interactive HTML form for one or multiple data models.
-For more details and usage information on ActiveForm, see the guide article on forms.
+For more details and usage information on ActiveForm, see the guide article on forms.
The ActiveField objects that are currently active
-The form action URL.
The type of data that you're expecting back from the server.
-The name of the GET parameter indicating the validation request is an AJAX request.
-The client validation options for individual attributes. Each element of the array represents the validation options for a particular attribute.
-Whether to enable AJAX-based data validation. If ActiveField.enableAjaxValidation is set, its value will take precedence for that input field.
-Whether to hook up pwoli.activeForm JavaScript plugin.
This property must be set true if you want to support client validation and/or AJAX validation, or if you
want to take advantage of the yii.activeForm plugin. When this is false, the form will not generate
any JavaScript.
Whether to enable client-side data validation. If ActiveField.enableClientValidation is set, its value will take precedence for that input field.
-Whether to enable Pjax on this widget.
+Whether to perform encoding on the error summary.
-The CSS class that is added to a field container when the associated attribute has validation error.
-The default CSS class for the error summary container.
The default field class name when calling [[field()]] to create a new field.
The default configuration used by [[field()]] when creating a new field object. This can be either a configuration array or an anonymous function returning a configuration array. If the latter, the signature should be as follows:
-function (model, attribute)
+function (model, attribute)
The value of this property will be merged recursively with the $options parameter passed to field.
A Promise which resolves when this Component has been successfully initialized.
-The form submission method. This should be either post or get. Defaults to post.
When you set this to get you may see the url parameters repeated on each request.
This is because the default value of action is set to be the current request url and each submit
will add new parameters instead of replacing existing ones.
You may set action explicitly to avoid this:
let form = new ActiveForm({
method: 'get',
action: '/my-url',
});
+let form = new ActiveForm({
method: 'get',
action: '/my-url',
});
-The HTML attributes (name-value pairs) for the form tag.
The CSS class that is added to a field container when the associated attribute is required.
-Whether to scroll to the first error after validation.
-Offset in pixels that should be added when scrolling to the first error.
-The CSS class that is added to a field container when the associated attribute is required.
-Whether to perform validation when an input field loses focus. If ActiveField.validateOnBlur is set, its value will take precedence for that input field.
-Whether to perform validation when the value of an input field is changed. If ActiveField.validateOnChange is set, its value will take precedence for that input field.
-Whether to perform validation when the form is submitted.
-The CSS class that is added to a field container when the associated attribute is being validated.
-Number of milliseconds that the validation should be delayed when the user types in the field
and validateOnType is set true.
If ActiveField.validationDelay is set, its value will take precedence for that input field.
The URL for performing AJAX-based validation. If this property is not set, it will take the value of the form's action attribute.
-The prefix to the automatically generated widget IDs.
A counter used to generate id for widgets.
-Begins the form with <form> tag.
Begins a form field. This method will create a new form field and returns its opening tag. You should call endField afterwards.
@@ -109,15 +111,15 @@the additional configurations for the field object.
the opening tag.
-Ends the form with </form> tag.
This registers the necessary JavaScript code and renders the form open and close tags.
Ends a form field. This method will return the closing tag of an active form field started by beginField.
the closing tag of the form field.
-Generates a summary of the validation errors. If there is no validation error, an empty error summary markup will still be generated, but it will be hidden.
string the generated error summary.
-Generates a form field. A form field is associated with a model and an attribute. It contains a label, an input and an error message and use them to interact with end users to collect their inputs for the attribute.
@@ -146,34 +148,33 @@the additional configurations for the field object. These are properties of ActiveField or a subclass, depending on the value of fieldClass.
ActiveField the created ActiveField object.
-Returns the options for the form JS widget.
the options.
-Returns the ID of the widget.
ID of the widget.
-Initializes the widget. -This renders the form open tag.
-Initializes the widget.
+This registers the necessary JavaScript code for the frontend.
-Renders a widget.
string the rendering result.
-Runs the widget.
Validates one or several models and returns an error message array indexed by the attribute IDs. This is a helper method that simplifies the way of writing AJAX validation code.
For example, you may use the following code in a controller action to respond to an AJAX validation request:
-let model = new Post;
model.load(request.body);
if (request.xhr) {
response.setHeader('Content-Type', 'application/json');
response.write(JSON.stringify(await ActiveForm.validate(model)));
}
// ... respond to non-AJAX request ...
+let model = new Post;
model.load(request.body);
if (request.xhr) {
response.setHeader('Content-Type', 'application/json');
response.write(JSON.stringify(await ActiveForm.validate(model)));
}
// ... respond to non-AJAX request ...
To validate multiple models, simply pass each model as a parameter to this method, like
the following:
-ActiveForm.validate($model1, $model2, ...);
+ActiveForm.validate($model1, $model2, ...);
the model to be validated.
@@ -184,12 +185,12 @@When this method is used to validate multiple models, this parameter will be interpreted as a model.
the error message array indexed by the attribute IDs.
-Validates an array of model instances and returns an error message array indexed by the attribute IDs. This is a helper method that simplifies the way of writing AJAX validation code for tabular input.
For example, you may use the following code in a controller action to respond to an AJAX validation request:
-// ... load models ...
if (request.xhr) {
response.setHeader('Content-Type', 'application/json');
response.write(JSON.stringify(await ActiveForm.validateMultiple(model)));
}
// ... respond to non-AJAX request ...
+// ... load models ...
if (request.xhr) {
response.setHeader('Content-Type', 'application/json');
response.write(JSON.stringify(await ActiveForm.validateMultiple(model)));
}
// ... respond to non-AJAX request ...
an array of models to be validated.
@@ -198,4 +199,4 @@ If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated.the error message array indexed by the attribute IDs.
-Generated using TypeDoc
Generated using TypeDoc
Application is the base class for all web application classes.
-For more details and usage information on Application, see the guide article on applications.
A Promise which resolves when this Component has been successfully initialized.
-The ORM that should be used by the application. Defaults to 'sequelize' Any other ORM if used should have an ORMAdapter defined in ormAdapterClasses
-The adapters for any ORMs used by this application. The key of the adapter to be used should be specified in orm By default, support for Sequelize ORM is provided.
-The model class for the ORM being used. Eg:- [[sequelize.Model]] for Sequelize -This should be set in the entry script of the application like:
-import { DataTypes, Model } from 'sequelize';
Application.ormModelClass = Model;
-The Serializer that should be used for RESTful operations.
-The View object for the application that is used to render various view files..
-The directory that contains the view files for this module.
-Initializes the object. This method is invoked at the end of the constructor after the object is initialized with the given configuration.
-Translates a path alias into an actual path.
The alias to be translated.
The translated alias.
-Returns the full URL of the request.
-Returns the viewPath.
-The actual viewPath.
-Returns the ORM Adapter.
+The ORM Adapter class.
+Returns the viewPath.
The actual viewPath.
-The model class for the ORM being used. Eg:- [[sequelize.Model]] for Sequelize +This should be set in the entry script of the application like:
+import { DataTypes, Model } from 'sequelize';
Application.ormModelClass = Model;
+Responds to the client(eg:- browser) depending on the data.
-Adds necessary headers and status code to the given response.
-Registers a path alias.
A path alias is a short name representing a long path (a file path, a URL, etc.)
-Sets the ORM Adapter.
+Sets the viewPath.
The path to be set.
-Generated using TypeDoc
Generated using TypeDoc
ActionColumn is a column for the GridView widget that displays buttons for viewing and manipulating the items.
To add an ActionColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows:
-