Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NullRefExcep/yii2-core
Base for fast and efficient website development
https://github.com/NullRefExcep/yii2-core
yii2
Last synced: 3 months ago
JSON representation
Base for fast and efficient website development
- Host: GitHub
- URL: https://github.com/NullRefExcep/yii2-core
- Owner: NullRefExcep
- Created: 2015-06-29T13:17:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T19:09:36.000Z (about 3 years ago)
- Last Synced: 2024-03-21T09:52:19.601Z (3 months ago)
- Topics: yii2
- Language: PHP
- Homepage:
- Size: 116 KB
- Stars: 4
- Watchers: 6
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Lists
- docs - Core
README
# Yii2-core
[](https://packagist.org/packages/nullref/yii2-core) [](https://packagist.org/packages/nullref/yii2-core) [](https://packagist.org/packages/nullref/yii2-core) [](https://packagist.org/packages/nullref/yii2-core)
WIP
Module for administration
## Installation
The preferred way to install this extension to use [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist nullref/yii2-core "*"
```
or add
```
"nullref/yii2-core": "*"
```
to the require section of your `composer.json` file.
### Config structure
This module designed to work with special config file.
In case when you use `module/install` command it creates `installed_modules.php` file in condif folder if it doesn't exist.
This file will contain config array of installed modules (obviously).
You need to merge this config with your applications config (web, console, etc).
I recommend using the structure that described below, it used at our [application template](https://github.com/NullRefExcep/yii2-boilerplate).
- installed_modules.php
```php
$modules,
//...
];
return $config;
```
When you are using this config structure you are able to override installed modules cofiguration in `modules.php`.
Also, `modules.php` file could be included to `console.php` config file.
App-specific configs could be added directly in corresponding config file.
### Modules system
This module provides basic tools for creating system of modules.
Available modules:
- [admin](https://github.com/NullRefExcep/yii2-admin)
- [cms](https://github.com/NullRefExcep/yii2-cms)
- [category](https://github.com/NullRefExcep/yii2-category)
- [product](https://github.com/NullRefExcep/yii2-product)
- [geo](https://github.com/NullRefExcep/yii2-geo)
- [blog](https://github.com/NullRefExcep/yii2-blog)
- [multisite](https://github.com/NullRefExcep/yii2-multisite)
- [eav](https://github.com/NullRefExcep/yii2-eav)
For full integration, you have to run console command:
```
php yii module/install
```
### Content
Core module for fast web development based on Yii2.
This package contains:
- components:
* EntityManager - component for simple managing of entities (models)
- interfaces:
* IAdminModule - interface for modules which can be used by [nullref\yii2-admin](https://github.com/NullRefExcep/yii2-admin)
* IRoleContainer - interface which provide roles for RBAC
* IEntityManager - interface EntityManager
* IEntityManageble - interface for classes which contain EntityManager
### Translation overriding
Core package contain [PhpMessageSource](https://github.com/NullRefExcep/yii2-core/blob/master/src/components/i18n/PhpMessageSource.php) class that allows to merge default module's and application's messages.
Example for [admin](https://github.com/NullRefExcep/yii2-admin) module
```php
[
/** App config **/
'components' => [
'i18n' => [
'translations' => [
'*' => ['class' => 'yii\i18n\PhpMessageSource'],
'admin' => ['class' => 'nullref\core\components\i18n\PhpMessageSource'],
],
],
]
]
```
In this case messages from category `admin` from application directory will be merged with default messages from module.
### Modules migrations
Module contains `MigrateController` controller which allows work with migrations of modules.
e.g.:
`php yii core/module --moduleId=admin` -- apply migrations for module with id `admin`
Keep in mind: Migrations should have namespaces
Also, is possible work with migrations off all modules:
`php yii core/module` -- collect all possible places of migrations.
By default, migrations are looked for directory `migrations` in directory of module class.
If you want to override this behavior, you can implement `IHasMigrateNamespace` interface by module class.
### EntityManager
Component for simple work with models, which have soft delete and typification.
Config:
```php
/** module config **/
'productManager' => [
"class" => "nullref\\product\\components\\EntityManager",
'hasImage' => false,
'hasStatus' => false,
'model' => [
'class' => 'app\\models\\Product',
'relations' => [
'category' => 'nullref\\category\\behaviors\\HasCategory',
'vendor' => 'app\\behaviors\\HasVendor',
],
],
'searchModel' => 'app\\models\\ProductSearch',
],
/** ... **/
```
Available methods:
- `createModel()` - create new model
- `createSearchModel()` - create new search model
- `findOne($condition)` - find one model by condition
- `findAll($condition)` - find all models by condition
- `find($condition = [])` - create ActiveQuery with condition
- `getMap($index = 'id', $value = 'title', $condition = [], $asArray = true)` - get key=>value array of model by condition
- `delete($model)` - delete model
- `decorateQuery($query)` decorate query by settings of entity manger