Download the PHP package mikehaertl/defaultpersister without Composer
On this page you can find all versions of the php package mikehaertl/defaultpersister. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mikehaertl/defaultpersister
More information about mikehaertl/defaultpersister
Files in mikehaertl/defaultpersister
Package defaultpersister
Short Description Yii extension to save and restore model values in user session.
License MIT
Homepage https://github.com/mikehaertl/defaultpersister
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package defaultpersister
DefaultPersister
This is a behavior for CModel (CFormModel, CActiveRecord) which allows to save the
set of current attribute values as defaults for the current user and restore them at a later time.
Requirements
Should work with any 1.1.x version. Not tested with 1.0.x.
Usage
When this behavior is attached to a model, the current model values can be saved as default values with a simple command:
This will save all configured attributes in user state (session). To load these defaults back into the model you can use:
It's also possible to save or load only some attributes:
To only load attributes that are safe in the current scenario, you can override the
configured value of safeOnly (see below):
Finally to clear the saved default values use:
Configuration
Like all behaviors this extension has to be configured in the behaviors() method of a model:
All attributes that should be saved with saveAsDefaults() must be listed in the attributes property of the behavior.
The complete list of configuration options is:
attributes: list of attribute names that can be saved / loadedsafeOnly: if true, only attributes that are safe in the current scenario will be loaded withloadDefaults(). Default isfalse.stateKeyPrefix: prefix for the user state key that is used to store defaults. Actual key name will be prefix + model class name. Defaults todefault_.
If loadDefaults() is called before any values where ever saved with saveAsDefaults() the model is scanned for a method attributeDefaults(). If this method is found the returned values (name/value pairs) will be set as default. If no such method is available, loadDefaults() will do nothing in this case.
Since Version 1.1.0 resetDefaults() can be used to clear all attributes, one attribute or a list of attributes default values.
If YII_DEBUG is true, this behavior will trace some messages under the category application.behavior.defaultpersister.
Example
One scenario where this behavior can come in handy is e.g. when a model is used as complex filter model for a datagrid. Think of a backend area with pages for users and projects, each showing a filter form and a datagrid. Changes in the filter form trigger a AJAX grid update. Whenever backend personnel accesses such a page the last filter settings should be restored for convenience.
A controller action for this could look like:
Changelog
1.1.0
- Fixed: Model defined attributes that are not in DB will also be set in AR
- Added resetDefaults() method
