Skip to content

Y
yii2
Commit da388050 by Qiang Xue
Options

updated extension README files.

parent 41a44275
Showing with 57 additions and 127 deletions
extensions/composer/README.md
Yii 2 Composer Installer Yii 2 Composer Installer
======================== ========================
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
This is the composer installer for Yii 2 extensions. It implements a new composer package type named `yii2-extension`, This is the composer installer for Yii 2 extensions. It implements a new composer package type named `yii2-extension`,
which should be used by all Yii 2 extensions if they are distributed as composer packages. which should be used by all Yii 2 extensions if they are distributed as composer packages.
......
extensions/jui/README.md
Yii 2.0 Public Preview - JUI Extension JUI Extension for Yii 2
====================================== =======================
Thank you for choosing Yii - a high-performance component-based PHP framework. This is the JQuery UI extension for Yii 2. It encapsulates JQuery UI widgets as Yii widgets,
and makes using JQuery UI widgets in Yii applications extremely easy. For example, the following
single line of code in a view file would render a JQuery UI DatePicker widget:
If you are looking for a production-ready PHP framework, please use ```php
[Yii v1.1](https://github.com/yiisoft/yii). <?= yii\jui\DatePicker::widget(['name' => 'start']) ?>
```
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
This is the yii2-jui extension.
Installation Installation
...@@ -20,36 +16,16 @@ Installation ...@@ -20,36 +16,16 @@ Installation
The preferred way to install this extension is [composer](http://getcomposer.org/download/). The preferred way to install this extension is [composer](http://getcomposer.org/download/).
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-jui "*" php composer.phar require yiisoft/yii2-jui "*"
``` ```
or add or add
``` ```
"yiisoft/yii2-jui": "*" "yiisoft/yii2-jui": "*"
``` ```
to the require section of your composer.json.
*Note: You might have to run `php composer.phar selfupdate`*
Usage & Documentation
---------------------
This extension provides multiple widgets to work with jquery.ui, as well as a set of compatible jquery.ui files.
You can use these widgets in your view files after you have registered the corresponding assets.
Example:
```php
echo ProgressBar::widget([
'clientOptions' => [
'value' => 75,
],
]);
```
For further instructions refer to the yii guide. to the require section of your `composer.json` file.
extensions/smarty/README.md
Yii 2.0 Public Preview - Smarty View Renderer Smarty Extension for Yii 2
============================================= ==========================
Thank you for choosing Yii - a high-performance component-based PHP framework. This extension provides a `ViewRender` that would allow you to use Smarty view template engine.
If you are looking for a production-ready PHP framework, please use To use this extension, simply add the following code in your application configuration:
[Yii v1.1](https://github.com/yiisoft/yii).
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
This is the yii2-smarty extension.
Installation
------------
The prefered way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require yiisoft/yii2-smarty "*"
```
or add
```json
"yiisoft/yii2-smarty": "*"
```
to the require section of your composer.json.
*Note: You might have to run `php composer.phar selfupdate`*
Usage & Documentation
---------------------
This extension has to be registered prior to usage.
To enable this view renderer add it to the $rendereres property of your view object.
Example:
```php ```php
<?php
// config.php
return [ return [
//.... //....
'components' => [ 'components' => [
'view' => [ 'view' => [
'class' => 'yii\base\View',
'renderers' => [ 'renderers' => [
'tpl' => [ 'tpl' => [
'class' => 'yii\smarty\ViewRenderer', 'class' => 'yii\smarty\ViewRenderer',
...@@ -61,4 +21,21 @@ return [ ...@@ -61,4 +21,21 @@ return [
]; ];
``` ```
For further instructions refer to the related section in the yii guide. Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require yiisoft/yii2-smarty "*"
```
or add
```json
"yiisoft/yii2-smarty": "*"
```
to the require section of your composer.json.
extensions/twig/README.md
Yii 2.0 Public Preview - Twig View Renderer Twig Extension for Yii 2
=========================================== ========================
Thank you for choosing Yii - a high-performance component-based PHP framework. This extension provides a `ViewRender` that would allow you to use Twig view template engine.
If you are looking for a production-ready PHP framework, please use To use this extension, simply add the following code in your application configuration:
[Yii v1.1](https://github.com/yiisoft/yii).
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
This is the yii2-twig extension.
Installation
------------
The prefered way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require yiisoft/yii2-twig "*"
```
or add
```
"yiisoft/yii2-twig": "*"
```
to the require section of your composer.json.
*Note: You might have to run `php composer.phar selfupdate`*
Usage & Documentation
---------------------
This extension has to be registered prior to usage.
To enable this view renderer add it to the $rendereres property of your view object.
Example:
```php ```php
<?php
// config.php
return [ return [
//.... //....
'components' => [ 'components' => [
'view' => [ 'view' => [
'class' => 'yii\base\View',
'renderers' => [ 'renderers' => [
'twig' => [ 'tpl' => [
'class' => 'yii\twig\ViewRenderer', 'class' => 'yii\twig\ViewRenderer',
//'cachePath' => '@runtime/Twig/cache', //'cachePath' => '@runtime/Twig/cache',
//'options' => [], /* Array of twig options */ //'options' => [], /* Array of twig options */
...@@ -61,4 +22,22 @@ return [ ...@@ -61,4 +22,22 @@ return [
]; ];
``` ```
For further instructions refer to the related section in the yii guide.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require yiisoft/yii2-twig "*"
```
or add
```
"yiisoft/yii2-twig": "*"
```
to the require section of your composer.json.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment