diff --git a/README.md b/README.md index 99f75db..cf3abc6 100644 --- a/README.md +++ b/README.md @@ -11,5 +11,6 @@ All codexten packages documentation * [Auth Module](yii-module-auth) * [User Module](yii-module-user) * [Country Module](yii-module-country) +* [Enquiry Module](yii-module-enquiry) * [Geo Module](yii-module-geo) * [Console App](yii-app-console) diff --git a/yii-module-enquiry/README.md b/yii-module-enquiry/README.md new file mode 100644 index 0000000..ecc5f84 --- /dev/null +++ b/yii-module-enquiry/README.md @@ -0,0 +1,180 @@ +Enquiry module for Yii 2.0 + +========================= + +## Creating Module + +#### Configurations + +core.php + +``` +return [ + 'aliases' => [ + '@moduleEnquiry' => '@codexten/yii/modules/enquiry', + ], +]; +``` + + + +moduleEnquiry.php + +``` +return [ + 'modules' => [ + 'enquiry' => [ + 'class' => Module::class, + 'viewPath' => '@moduleEnquiry/views', + 'controllerNamespace' => 'codexten\yii\modules\enquiry\controllers', + 'controllerMap' => [ + 'enquiry' => [ + 'class' => CrudController::class, + 'modelClass' => Enquiry::class, + ], + ], + ], + ], +]; +``` + + + +add to composer.json + +``` +"config-plugin": { + "core": "config/core.php", + "moduleEnquiry": "config/moduleEnquiry.php", + "migrationNamespaces": "config/migrationNamespaces.php" +} +``` + + + +Installation +------------ + +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +``` +composer require --prefer-dist codexten/yii-module-enquiry:"^2.0.0" +``` + +or add + +```json + "codexten/yii-module-enquiry": "~2.0.0", +``` + +to the require section of your composer.json. + + + +Add $moduleEnquiry to admin and site of your composer.json. + +```json +"config-plugin": { + "admin": [ + "$moduleEnquiry", + ], + "site": [ + "$moduleEnquiry", + ] +} +``` + +Configuration +------------- + +admin config + +```php + +return \yii\helpers\ArrayHelper::merge( + // other configurations + [], + // $moduleEnquiry + [ + 'modules' => [ + 'enquiry' => [ + 'controllerMap' => [ + 'enquiry' => [ + 'enabledActions' => [ + 'index', + 'view', + 'delete', + ], + + ], + ], + ], + ], + ] + ); + +``` + +site config + +```php +return \yii\helpers\ArrayHelper::merge( + // other configurations + [], + // $moduleEnquiry + [ + 'components' => [ + 'urlManager' => [ + 'rules' => [ + '/contact-us' => '/enquiry/enquiry/create', + ], + ], + 'view' => [ + 'theme' => [ + 'pathMap' => [ + '@moduleEnquiry/views' => [ + '@gnt/site/modules/enquiry/views', + ], + ], + ], + ], + ], + 'modules' => [ + 'enquiry' => [ + 'controllerMap' => [ + 'enquiry' => [ + 'enabledActions' => [ + 'create', + ], + ], + ], + ], + ], + ] + ); +``` + +## Override Views + +path of create.php + +​ site->modules->enquiry->views->enquiry->create + +```php + + +render('form/_fields', ['model' => $model, 'form' => $form]) ?> + +
+ + 'btn btn-primary']) ?> + +
+ + +``` + +## customization + +TBD