Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yii2mod/yii2-cms
Simple CMS extension
https://github.com/yii2mod/yii2-cms
yii2 yii2-cms yii2-cms-module yii2-extension
Last synced: about 12 hours ago
JSON representation
Simple CMS extension
- Host: GitHub
- URL: https://github.com/yii2mod/yii2-cms
- Owner: yii2mod
- License: mit
- Created: 2014-09-01T11:32:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T17:48:12.000Z (almost 5 years ago)
- Last Synced: 2024-09-18T22:32:59.081Z (9 days ago)
- Topics: yii2, yii2-cms, yii2-cms-module, yii2-extension
- Language: PHP
- Homepage:
- Size: 107 KB
- Stars: 44
- Watchers: 13
- Forks: 24
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii2 CMS Extension
This module provides a web interface for content management system and includes the following features:
- Allows CRUD operations for pages
- [Support Markdown Editor](https://github.com/yii2mod/yii2-markdown)
- [Support Froala Editor](https://www.froala.com/wysiwyg-editor)
- [Support Comments Management System](https://github.com/yii2mod/yii2-comments)
- Integrated with [yii2mod/base](https://github.com/yii2mod/base)
[](https://packagist.org/packages/yii2mod/yii2-cms)
[](https://packagist.org/packages/yii2mod/yii2-cms)
[](https://packagist.org/packages/yii2mod/yii2-cms)
[](https://travis-ci.org/yii2mod/yii2-cms)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```bash
php composer.phar require --prefer-dist yii2mod/yii2-cms "*"
```
or add
```
"yii2mod/yii2-cms": "*"
```
to the require section of your composer.json.
CONFIGURATION
------------
**Database Migrations**
Before usage this extension, we'll also need to prepare the database.
```bash
$ php yii migrate --migrationPath=@vendor/yii2mod/yii2-comments/migrations
$ php yii migrate --migrationPath=@vendor/yii2mod/yii2-cms/migrations
```
**Module Setup**
To access the module, you need to configure the modules array in your application configuration:
```php
'modules' => [
'cms' => [
'class' => 'yii2mod\cms\Module',
],
],
```
> **You can then access to management section through the following URL:**
> http://localhost/path/to/index.php?r=/cms/manage/index
**Configure Url Manager**
You need to configure the `urlManager` array in your application configuration:
```php
'components' => [
'urlManager' => [
'rules' => [
['class' => 'yii2mod\cms\components\PageUrlRule'],
]
],
],
```
**Setup Page Action**
Add to SiteController (or configure via `$route` param in `urlManager`):
```php
public function actions()
{
return [
'page' => [
'class' => 'yii2mod\cms\actions\PageAction',
]
];
}
```
**Now you can use this module with all available features.**
## Features:
1. By default this extension uses the `froala editor` for manage cms pages, you can change editor configuration by the following code:
> List of options: https://www.froala.com/wysiwyg-editor/docs/options
> Configuration example: https://github.com/froala/yii2-froala-editor#usage
```php
'modules' => [
'cms' => [
'class' => 'yii2mod\cms\Module',
'froalaEditorOptions' => [
// your custom configuration
'clientPlugins' => [
],
'clientOptions' => [
],
'excludedPlugins' => [
],
],
],
],
```
2. Markdown Editor support:
```php
'modules' => [
'cms' => [
'class' => 'yii2mod\cms\Module',
'enableMarkdown' => true,
// List of options: https://github.com/NextStepWebs/simplemde-markdown-editor#configuration
'markdownEditorOptions' => [
'showIcons' => ['code', 'table'],
],
],
],
```
3. You can insert your own widget on the page by the following steps:
- Create the widget, for example:
```php
namespace app\widgets;
use yii\base\Widget;
class MyWidget extends Widget
{
/**
* @inheritdoc
*/
public function run()
{
parent::run();
echo 'Text from widget';
}
/**
* This function used for render the widget
*
* @return string
*/
public static function show()
{
return self::widget();
}
}
```
- When you create the page via admin panel add the following code to the page content:
```
[[\app\widgets\MyWidget:show]]
```
4. You can use parameters in your page content, for example: {siteName}, {homeUrl}. For parsing this parameters you can use the `baseTemplateParams` property:
```php
public function actions()
{
return [
'page' => [
'class' => 'yii2mod\cms\actions\PageAction',
'baseTemplateParams' => [
'homeUrl' => 'your site home url',
'siteName' => Yii::$app->name
]
],
];
}
```
5. You can change comments module settings by the following code:
```php
public function actions()
{
return [
'page' => [
'class' => 'yii2mod\cms\actions\PageAction',
'commentWidgetParams' => [
'maxLevel' => 1,
'dataProviderConfig' => [
'pagination' => [
'pageSize' => 10
],
],
]
]
];
}
```
> For detail information about comments module please visit the following [page](https://github.com/yii2mod/yii2-comments)
## Support us
Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/yii2mod).
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.