Yii2-Toolbox is a collection of useful helpers, widgets etc. extending the basic functionality of Yii2, (*1)
Installation
The preferred way to install this extension is through composer., (*2)
"asinfotrack/yii2-toolbox": "~1.0.1"
Changelog
Learn about the latest improvements., (*3)
Contents
Components
MemoryUrlManager
This URL manager implements memory-functionality for urls. This enables for example to keep
the state (sorting, filtering and paging) of a GridView across requests. The default configuration
saves this data in the session variable and appends the params to the links., (*4)
The usage is very easy. Simply set this class as the url manager in your Yii-config and specify the
additional attributes according to the example below and the documentation within the class., (*5)
Example of a config:, (*6)
// ...
'urlManager'=>[
'class'=>'\asinfotrack\yii2\toolbox\components\MemoryUrlManager',
'memoryMap'=>[
//the controller
'mycontroller'=>[
//the action
'myindexaction'=>[
//regex rules...if a param matches a rule it will be memorized
'/^SearchForm/',
//if a rule is specified like this, the regex is only enabled if the callback returns true
'page'=>function() {
return rand(0,1) == 1;
},
],
],
//modules work the same, except they have one level more
'mymodule'=>[
'mymodulecontroller'=>[
//the action
'mymoduleaction'=>[
//regex rules...if a param matches a rule it will be memorized
'/^MyForm/',
],
],
],
],
],
// ...
Each entry in the memoryMap can be a string representing a regex to match params to save. You can
optionally use the regex-rule as key and a callback returning a boolean as the value. In this case
the rule is only active when the callback returns true, (*7)
Response formatter for images. You need to add the formatter to the config as follows:, (*8)
'response' => [
// ...
'formatters'=>[
'img_jpg'=>[
'class'=>'asinfotrack\yii2\toolbox\components\ImageResponseFormatter',
'extension'=>'jpg',
],
'img_png'=>[
'class'=>'asinfotrack\yii2\toolbox\components\ImageResponseFormatter',
'extension'=>'png',
],
'img_gif'=>[
'class'=>'asinfotrack\yii2\toolbox\components\ImageResponseFormatter',
'extension'=>'gif',
],
],
// ...
],
After that you can use it to output images via actions easily:, (*9)
public function actionAvatar()
{
Yii::$app->response->format = 'img_png';
return file_get_contents($pathToMyImage);
}
Additional response formatter for handling PDF-requests. You need to add the formatter to the config like this:, (*10)
'response' => [
// ...
'formatters'=>[
'pdf'=>'asinfotrack\yii2\toolbox\components\PdfResponseFormatter',
'pdf_download'=>[
'class'=>'asinfotrack\yii2\toolbox\components\PdfResponseFormatter',
'forceDownload'=>true,
],
],
// ...
],
After that you can use it to output PDFs via actions easily:, (*11)
public function actionPdf()
{
//create pdf with some library (eg FPDF)
$pdf = new FPDF();
// ...
$response = Yii::$app->response;
$response->data = $pdf->Output();
$response->format = 'pdf';
}
User
Extends \yii\web\User with the ability to check multiple rights at once (canAll,
canAny, canOne)., (*12)
ProgressiveImageGd and ProgressiveImageImagick
Both classes extend the image drivers of yurkinx/yii2-image to enable progressive encoding of jpg-files.
To use it, simply call the factory-class asinfotrack\yii2\toolbox\helpers\ImageFactory::createInstance($path, $driver=self::DRIVER_GD)
to get an instance and proceed working. Make sure either GD- or Imagick-Library is enabled., (*13)
The button-widget extends the one provided by yii2. It adds functionality to specify an icon.
The Icons depend on font-awesome and hence require the yii2-extension rmrevin/yii2-fontawesome, (*14)
An ajax button to toggle boolean values (1, 0). Together with AjaxAttributeAction this makes it
very easy to toggle boolean flags. The widget-attribute booleanAttribute is used only for reading out
values. Therefore you have to respecify this in the controller-action (step 2 below)., (*15)
Example of usage together with AjaxAttributeAction:, (*16)
<?= AjaxToggleButton::widget([
'model'=>$model,
'booleanAttribute'=>'is_archived',
'action'=>'toggle-archived',
'options'=>['class'=>'btn-primary btn-xs'],
]);
Now attach an instance of AjaxAttributeAction in the corresponding controller of the model specified:, (*17)
public function actions()
{
return [
'toggle-archived'=>[
'class'=>AjaxAttributeAction::className(),
'targetClass'=>User::className(),
'targetAttribute'=>'is_archived',
],
];
}
FlashMessages
This widget renders flash messages automatically. The messages can be automatically retrieved
from yiis session-component or be provided via a custom callable., (*18)
Example of simple usage rendering yiis session flashes each in its own alert-container:, (*19)
<?= FlashMessages::widget() ?>
Advanced usage with custom callback to provide flash messages:, (*20)
<?= FlashMessages::widget([
'loadFlashesCallback'=>function() {
return ['info'=>'Hello', 'danger'=>'World!'];
},
]) ?>
Panel
Renders a Bootstrap-Panel. You can either set its body via attribute or between begin() and end().
The attributes heading, body and footer support setting via string or via Closure returning a string.
Exemplary usage:, (*21)
<?php Panel::begin([
'heading'=>Html::tag('h3', 'Welcome!'),
'footer'=>function() {
return Yii::$app->formatter->asDatetime(time());
},
]); ?>
<p>Hello world! This is a simple panel with a heading.</p>
<?php Penel::end(); ?>
SimpleNav
Simple navigation widget which has the same functionality as the regular nav-widget (\yii\bootstrap\Nav) but
renders a plain and simple HTML-list which can then be further styled with css. No dropdown...just clean code!, (*22)
StatsBoxes
Renders a variable amount of stats boxes with title, icon and a value. This is ideal for a detail view of
a model., (*23)
TabsWithMemory
Tabs widget which remembers its active tab via javascript sessionStorage, (*24)
Video
Wrapper-widget to simplify work with video tag, (*25)
Grid column-types
The column types provided extend the functionality of the basic \yii\grid\DataColumn. The
class is AdvancedDataColumn. It has functionality to align text, set the column with with either
absolute or percent values etc., (*26)
Additionally there are three further column types:
* AdvancedActionColumn further functionality for the action column (rights per button, etc.)
* AdvancedDataColumn base class for regular data displaying with advanced functionality
* BooleanColumn optimized for rendering boolean values
* IdColumn optimized for rendering id values with or without code-tags
* LinkColumn renders links (which can be generated using a closure), (*27)
Helpers
ColorHelper
Makes working with HEX- or RGB-colors easy! It can translate between the two formats,
lighten or darken colors as well as creating steps between two colors. You can also
use it to get a colors luminance or validate color-values.
Short HEX-Formats are supported automatically., (*28)
ComponentConfig
Helper class to work with component-configurations, (*29)
DropdownHelper
Makes working with drop downs easier. Especially if you need additional options per item, (*30)
Geocoding
Helper class to work with google geocoding api's. It enables you to do one-call forward and
reverse geocoding, (*31)
Html
Extends the Html-helper of Yii2 with additional functionality like disguising email-addresses,
bootstrap-elements, text-highlighting, etc., (*32)
ImageFactory
Factory-class to create instances of image drivers. To use it, simply call createInstance($path, $driver=self::DRIVER_GD)
to get an instance and proceed working. Make sure either GD- or Imagick-Library is enabled., (*33)
MigrationHelper
Helper for common tasks concerning migrations (eg checking if a migration was applied, etc)., (*34)
PrimaryKey
Functionalities to work with PKs of \yii\db\ActiveRecord and to convert them into JSON, (*35)
QueryHelper
Recurring tasks while working wth ActiveQueries, (*36)
ServerConfig
Provides functionality to fetch the most important server vars and to check if certain
extensions are loaded, (*37)
Timestamp
This helper is responsible for common tasks associated with UNIX-Timestamps. It also has a
function to parse dates into timestamps (extracted functionality of the yii date validator), (*38)
Url
This helper extends the basic functionality of the Yii2-Url-helper. It provides functionality
to retrieve information about the currently requested url, such as TLD, subdomains, etc., (*39)
Behaviors
ArchiveBehavior / ArchiveQueryBehavior
Enables a model to be archived or not. This is similiar to a soft-delete but with the idea of not
deleting a record but archive it instead.
The behavior is fully configurable and there is also a behavior for the corresponding query-class., (*40)
StateBehavior / StateQueryBehavior
Documentation coming soon!, (*41)
Actions
AjaxAttributeAction
A generic and very convenient action to modify model-values via ajax-calls. See the class comments for how
to configure this action., (*42)
There is also an example further up in the description of AjaxToggleButton., (*43)
DebugAction
The debug action shows you relevant information about the current configuration of the hosting. It also
shows you all kind of configs right in the browser., (*44)
To enable it, all you have to to is add it to the actions()-method of a controller of your choice and
provide a view to render its contents into., (*45)
public function actions()
{
return [
// ...
[
'class'=>'asinfotrack\yii2\toolbox\actions\DebugAction',
'view'=>'//site/debugging',
]
// ...
];
}
Within that view you simply output the contents with this statement:, (*46)
<?= $content ?>
Validators
SelectiveRequiredValidator
Validator to require a certain amount of fields out of a list to be required. To use the validator
simply specify the selection of attributes and set how many of it are required:, (*47)
public function rules()
{
return [
// ...
[['phonePrivate','phoneWork','mobile'], SelectiveRequiredValidator::className(), 'errorAttribute'=>'phonePrivate'],
// ...
];
}
Console
ConsoleTarget
Log target which outputs to the console, (*48)
Migration
Has additional functionality simplifying repeating tasks while creating migrations., (*49)
Exceptions
ExpiredHttpException
Throws code 410 marking a link as expired. This is helpful if for example a meeting is over or
a record was archived., (*50)
Gii-Generators
The provided Gii-Generators fix general formatting issues in the default code-templates (eg
spaces instead of tabs, etc.)., (*51)
Installation
To enable the provided Generators you need to update the gii config as follows:, (*52)
'modules'=>[
// ...
'gii'=>[
'class'=>'yii\gii\Module',
'generators'=>[
'model'=>[
'class'=>'asinfotrack\yii2\toolbox\gii\model\Generator',
'templates'=>[
'asiToolboxModel'=>'@vendor/asinfotrack/yii2-toolbox/gii/model/default',
],
],
'crud'=>[
'class'=>'asinfotrack\yii2\toolbox\gii\crud\Generator',
'templates'=>[
'asiToolboxCrud'=>'@vendor/asinfotrack/yii2-toolbox/gii/crud/default',
],
],
],
],
// ...
],
Models
Timestamp- and BlameableBehaviour are added by default. Also there is an optional font-awesome
icon-name assignable per model. This can later be retrieved via Model::iconName().
Also there is a query-class generated by default., (*53)
CRUDs
The CRUD-templates also fix common issues and are optimized for the model, (*54)
Wallogit.com
