Yii2-Toolbox is a collection of useful helpers, widgets etc. extending the basic functionality of Yii2
The preferred way to install this extension is through composer.
"asinfotrack/yii2-toolbox": "dev-master"
Response formatter for images. You need to add the formatter to the config as follows:
'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:
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:
'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:
public function actionPdf()
{
//create pdf with some library (eg FPDF)
$pdf = new FPDF();
// ...
$response = Yii::$app->response;
$response->data = $pdf->Output();
$response->format = 'pdf';
}
Extends \yii\web\User
with the ability to check multiple rights at once (canAll,
canAny, canOne).
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
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).
Example of usage together with AjaxAttributeAction
:
<?= 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:
public function actions()
{
return [
'toggle-archived'=>[
'class'=>AjaxAttributeAction::className(),
'targetClass'=>User::className(),
'targetAttribute'=>'is_archived',
],
];
}
This widget renders flash messages automatically. The messages can be automatically retrieved from yiis session-component or be provided via a custom callable.
Example of simple usage rendering yiis session flashes each in its own alert-container:
<?= FlashMessages::widget() ?>
Advanced usage with custom callback to provide flash messages:
<?= FlashMessages::widget([
'loadFlashesCallback'=>function() {
return ['info'=>'Hello', 'danger'=>'World!'];
},
]) ?>
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:
<?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(); ?>
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!
Renders a variable amount of stats boxes with title, icon and a value. This is ideal for a detail view of a model.
Tabs widget which remembers its active tab via javascript sessionStorage
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.
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 functionalityBooleanColumn
optimized for rendering boolean valuesIdColumn
optimized for rendering id values with or without code-tagsLinkColumn
renders links (which can be generated using a closure)
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.
Helper class to work with component-configurations
Extends the Html-helper of Yii2 with additional functionality like disguising email-addresses, bootstrap-elements, text-highlighting, etc.
Helper for common tasks concerning migrations (eg checking if a migration was applied, etc).
Functionalities to work with PKs of \yii\db\ActiveRecord
and to convert them into JSON
Provides functionality to fetch the most important server vars and to check if certain extensions are loaded
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)
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.
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.
Documentation coming soon!
A generic and very convenient action to modify model-values via ajax-calls. See the class comments for how to configure this action.
There is also an example further up in the description of AjaxToggleButton
.
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.
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.
public function actions()
{
return [
// ...
[
'class'=>'asinfotrack\yii2\toolbox\actions\DebugAction',
'view'=>'//site/debugging',
]
// ...
];
}
Within that view you simply output the contents with this statement:
<?= $content ?>
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:
public function rules()
{
return [
// ...
[['phonePrivate','phoneWork','mobile'], SelectiveRequiredValidator::className(), 'errorAttribute'=>'phonePrivate'],
// ...
];
}
Log target which outputs to the console
Has additional functionality simplifying repeating tasks while creating migrations.
Throws code 410 marking a link as expired. This is helpful if for example a meeting is over or a record was archived.
The provided Gii-Generators fix general formatting issues in the default code-templates (eg spaces instead of tabs, etc.).
To enable the provided Generators you need to update the gii config as follows:
'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',
],
],
],
],
// ...
],
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.
The CRUD-templates also fix common issues and are optimized for the model