PHPackages                             laker-ls/yii2-pencil - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. laker-ls/yii2-pencil

ActiveYii2-extension[Templating & Views](/categories/templating)

laker-ls/yii2-pencil
====================

Module create and view interactive text and image.

2.2.4(6y ago)163BSD-3-ClausePHP

Since Aug 27Pushed 6y ago1 watchersCompare

[ Source](https://github.com/laker-ls/yii2-pencil)[ Packagist](https://packagist.org/packages/laker-ls/yii2-pencil)[ Docs](https://github.com/laker-ls/pencil)[ RSS](/packages/laker-ls-yii2-pencil/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (1)Versions (22)Used By (0)

 yii2-pencil
=============

[](#----yii2-pencil)

[![Stable Version](https://camo.githubusercontent.com/dfe219dfef29e4c02805998719c0a0525808377c55b413f2dbb1d40f90cd3037/68747470733a2f2f706f7365722e707567782e6f72672f6c616b65722d6c732f796969322d70656e63696c2f762f737461626c65)](https://packagist.org/packages/laker-ls/yii2-pencil)[![Unstable Version](https://camo.githubusercontent.com/73933916fb648cb81881edf28de2a5cf2f6a3068ae9588952c19240f251c76aa/68747470733a2f2f706f7365722e707567782e6f72672f6c616b65722d6c732f796969322d70656e63696c2f762f756e737461626c65)](https://packagist.org/packages/laker-ls/yii2-pencil)[![License](https://camo.githubusercontent.com/32ff75f25bc4188b992b546b9f25470970f5558ad6a4d109ff5ca90f0c165542/68747470733a2f2f706f7365722e707567782e6f72672f6c616b65722d6c732f796969322d70656e63696c2f6c6963656e7365)](https://packagist.org/packages/laker-ls/yii2-pencil)[![Total Downloads](https://camo.githubusercontent.com/f034e024ed6f39d41531d9edf6293fa21dd0133cae3fde95344bb76322a203d1/68747470733a2f2f706f7365722e707567782e6f72672f6c616b65722d6c732f796969322d70656e63696c2f646f776e6c6f616473)](https://packagist.org/packages/laker-ls/yii2-pencil)

> ВНИМАНИЕ: Для работы необходим developeruz/yii2-db-rbac с существующей ролью.

Отображение текста, которое редактируется через модальное окно, когда пользователь авторизован как администратор. Не админ, видит обычный текст, в то же время администратор может взаимодействовать с ним, по нажатию на текст всплывает модальное окно с одним полем textarea, переносы в данном поле работают и конвертируются в ``, вся стилизация текста должна задаваться через css.
Вы можете настраивать в каком теге выводить текст и передавать ему классы и другие атрибуты. Вид текста для администратора отличается и может быть дополнен атрибутами, которые выводят только для админа.

Отображение изображений, которые редактируются через модальное окна, когда пользователь авторизован как администратор. Все пользователи видят изображения, однако админу дополнительно отображается кнопка для редактирования изображений.

Установка
---------

[](#установка)

Рекомендуемый способ установки этого расширения является использование [composer](http://getcomposer.org/download/). Проверьте [composer.json](https://github.com/laker-ls/yii2-pencil/blob/master/composer.json) на предмет требований и зависимостей данного расширения.

Для установки запустите

```
$ php composer.phar require laker-ls/yii2-pencil "~2.2.5"

```

или добавьте в `composer.json` в раздел `require` следующую строку

```
"laker-ls/yii2-pencil": "~2.2.5"

```

> Смотрите [список изменений](https://github.com/laker-ls/yii2-pencil/blob/master/CHANGE.md) для подробной информации о версиях.

Подключение
-----------

[](#подключение)

Выполните миграции в консоли:

```
yii migrate --migrationPath=@lakerLS/pencil/migrations

```

В конфиге приложения подключите модуль и укажите роли параметром `accessRoles`, которым разрешено редактирование. Параметром `imagePath` передайте пути к папкам (оригинал и миниатюра), в которых будут храниться изображения:

```
'modules' => [
    'pencil' => [
        'class' => '\lakerLS\pencil\Module',
        'params' => [
            'accessRoles' => ['admin'],
            'imagePath' => [
                'full' => 'upload/image-gallery/full',
                'mini' => 'upload/image-gallery/mini',
            ],
        ],
    ],
]
```

В контроллере, в котором вызывается экшен с "карандашами" обязательно должно передаваться `id` текущей категории. Данный код служит примером, в каждом случае переданные параметры будут отличаться, но свойствой `categoryId` не должно менять своё имя.

```
    public $categoryId;

    public function actionIndex($category)
    {
        // Где $category объект текущей категории.
        $this->categoryId = $category->id;

        // Если страница статическая, то можем задать `id` явно, но данный способ не является хорошей практикой.
        $this->categoryId = 1;

        return $this->render('view');
    }
```

Расширение готово к работе.

Использование виджета для текста
--------------------------------

[](#использование-виджета-для-текста)

```
use lakerLS\pencil\widgets\PencilText;