A Promise which resolves when this Component has been successfully initialized.
The base Model class of the ORM.
This is the object which is used to map the validators in the ORM with the client side validators in Pwoli. Keys of this object are the validator strings for the ORM and the values are the corresponding validators in Pwoli. This is used by assets/js/activeForm.js
The list of active attributes in a Model.
Returns all the attributes including the ones in embedded schemas.
The model from which the attributes list has to be extracted.
The attributes list as an array.
This method applies the current request's pagination requirements. This is used by ActiveDataProvider.
The DB query used.
The query object after pagination is applied.
This method applies the current request's sort requirements. This is used by ActiveDataProvider.
The query object after sorting is applied.
The attributes list of the current Model.
The attributes list as an array.
Returns the count of records based on the query provided.
The DB query,
A Promise which resolves to the number of records found.
A record finder which returns all the Models based on the query provided. This is used by ActiveDataProvider.
The DB query to match records. See ActiveDataProvider.query
A Promise which resolves to the Models found.
Returns the active validators for the given attribute in the given Model.
The Model to be checked.
The attribute to be checked.
Returns the params required for Client Validation
Either false(meaning no validation to be performed) or an object which contains the message' and args` for client validation done by assets/js/activeForm.js
Eg:- { msg: 'Invalid value', args: {...}}
For more information on this, please refer ActiveField.clientValidators
Initializes the object. This method is invoked at the end of the constructor after the object is initialized with the given configuration.
Checks whether the given attribute is an active attribute in the given Model. Active attributes are attributes for which at-least a single validation rule is applied.
The Model in which the check is to be performed.
The attribute to be checked.
Checks whether a given attribute is required for a Model
The Model in which the check is to be performed.
The attribute to be checked.
The primary key for the model being used.
Returns the ActiveDataProvider in which the required search conditions are set for the given params.
The Model in which search is to be performed.
The search params.
The ActiveDataProvider to which the required search conditions are to be set.
The ActiveDataProvider with the search conditions set.
This method validates the given Model with the validation rules set inside it. The results of the validation will be stored in [Model._errors]. If this is an empty array, it can be considered that the validation has passed.
The Model in which validation is to be performed.
Generated using TypeDoc
MongooseAdapter is the communication interface between Pwoli and the Mongoose ORM.
An ORM Adapter defines how Pwoli should interact between that ORM(here Mongoose) for which this ORMAdapter is implemented.
Using a different ORM
Mahesh S Warrier https://github.com/codespede