frenzelgmbh/cm-categories

Common Address Module for yii2

dev-master 2015-07-25 20:13 UTC

GPL v2

• Philipp Frenzel

• yii2
• frenzel gmbh
• address module

README

Common Categories Module (Frenzel GmbH 2014) v.0.1

Installation

Add the following line to your composer.json require section:

"frenzelgmbh/cmcategories":"*"

php yii migrate --migrationPath=@vendor/frenzelgmbh/cm-categories/migrations

Inside your yii-config, pls. add the following lines to your modules section. As you might see, the gridview needs to be implemented too.

'cmcategories'=>[
  'class' => 'frenzelgmbh\cmcategories\Module',
],
'gridview' =>  [
  'class' => '\kartik\grid\Module'
],

After this, you should be able to see the set of build in widgets and options under:

http://yourhost/index.php?r=cmcategories/default/test

Design

The Categories module is use to store categories, that can be linked to any other "module". So in general all modules are referenced by:

• mod_table (which should hold the table name VARCHAR(100))

ATTENTION: be carefull with the order of the modules, that you register as the order is relevant for the connection to this module. Categories can be assigned to each module, that you configure within your app config.

Datastructure

This module allows you to store cmcategories data related to any other "record" and "module" you pass by as parameters. It allows you to save 1:n cmcategories records, while one record of cmcategories can be filled with the following fields:

• Parent (self reference)
• Name Pls. notice, that records aren't deleted in all of our models, they just get marked as deleted!

Widgets

The "create"-Button:

if(class_exists('\frenzelgmbh\cmcategories\widgets\CreateCategoriesModal')){
  echo \frenzelgmbh\cmcategories\widgets\CreateCategoriesModal::widget(array(
    'module'      => 'tbl_test',
    'id'          => 1
  )); 
}

The "related"-Grid:

if(class_exists('\frenzelgmbh\cmcategories\widgets\RelatedCategoriesGrid')){
  echo \frenzelgmbh\cmcategories\widgets\RelatedCategoriesGrid::widget(array(
    'module'      => 'tbl_test',
    'id'          => 1
  )); 
}