From 6486e683a183ff4cf8997d1663ae0d0da50eb901 Mon Sep 17 00:00:00 2001 From: Dennis Matveyev Date: Wed, 4 Dec 2013 17:55:34 -0500 Subject: [PATCH 1/4] added sample Installation notes --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 48ed2dd..5fd92a2 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,45 @@ Dependencies - [ZfcUser](https://github.com/ZF-Commons/ZfcUser) - [DoctrineModule](https://github.com/doctrine/DoctrineModule) - [DoctrineORMModule](https://github.com/doctrine/DoctrineORMModule) + +Installation +------------ +If you haven't yet, install Doctrine: ([note on using fixed versioning in composer][4]) + + php composer.phar require doctrine/doctrine-orm-module:~0.7 + +Set up Database Connection Settings for Doctrine ORM: + +Namely, go to [Doctrine Connection Settings][5], and copy/paste/modify the example configuration file content into your `config/autoload/doctrine.orm.local.php` file within `MyApp` folder, where `MyApp` is the name of your application. + +Install Zfc Components: + + php composer.phar require zf-commons/zfc-user:~0.1 + php composer.phar require zf-commons/zfc-user-doctrine-orm:~0.1 + +You do not need to create custom configuration files for the above two modules to work. ([ref][6]) + +Set up your Modules in `config/application/application.config.php`, something like + + 'modules' => array( + 'DoctrineModule', + 'DoctrineORMModule', + 'ZfcBase', + 'ZfcUser', + 'ZfcUserDoctrineORM', + 'Application', + ), + +Using `doctrine-module` you can set up your schema: + + vendor/bin/doctrine-module orm:schema-tool:update --dump-sql + +If SQL looks okay, do: + + vendor/bin/doctrine-module orm:schema-tool:update --force + +You can now navigate to `http://localhost/MyApp/user` and it should work. + + [4]: http://stackoverflow.com/a/14816988/2883328 "composer versioning" + [5]: https://github.com/doctrine/DoctrineORMModule#connection-settings + [6]: http://stackoverflow.com/a/14781304/2883328 From c8927297595af996023db66fa085a9a30769b3ed Mon Sep 17 00:00:00 2001 From: Dennis Matveyev Date: Wed, 4 Dec 2013 17:58:22 -0500 Subject: [PATCH 2/4] updated wording for Installation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fd92a2..25e501d 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Install Zfc Components: php composer.phar require zf-commons/zfc-user:~0.1 php composer.phar require zf-commons/zfc-user-doctrine-orm:~0.1 -You do not need to create custom configuration files for the above two modules to work. ([ref][6]) +For just the basics, you do not need to create custom configuration files for the above two modules to work ([ref][6]). Set up your Modules in `config/application/application.config.php`, something like From c33f0b2a29abfab29d09c55887c200788f957d12 Mon Sep 17 00:00:00 2001 From: Dennis Matveyev Date: Mon, 7 Apr 2014 10:21:04 -0400 Subject: [PATCH 3/4] Updated as per Danielss89 See https://github.com/ZF-Commons/ZfcUserDoctrineORM/pull/67/files#r11320378 --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 25e501d..a1a03d7 100644 --- a/README.md +++ b/README.md @@ -15,20 +15,13 @@ Dependencies Installation ------------ -If you haven't yet, install Doctrine: ([note on using fixed versioning in composer][4]) - - php composer.phar require doctrine/doctrine-orm-module:~0.7 - Set up Database Connection Settings for Doctrine ORM: -Namely, go to [Doctrine Connection Settings][5], and copy/paste/modify the example configuration file content into your `config/autoload/doctrine.orm.local.php` file within `MyApp` folder, where `MyApp` is the name of your application. +Namely, go to [Doctrine Connection Settings](https://github.com/doctrine/DoctrineORMModule#connection-settings), and copy/paste/modify the example configuration file content into your `config/autoload/doctrine.orm.local.php` file within `Application` folder, where `Application` is the name of your application. Install Zfc Components: - php composer.phar require zf-commons/zfc-user:~0.1 - php composer.phar require zf-commons/zfc-user-doctrine-orm:~0.1 - -For just the basics, you do not need to create custom configuration files for the above two modules to work ([ref][6]). + php composer.phar require zf-commons/zfc-user-doctrine-orm Set up your Modules in `config/application/application.config.php`, something like @@ -41,7 +34,9 @@ Set up your Modules in `config/application/application.config.php`, something li 'Application', ), -Using `doctrine-module` you can set up your schema: +Now, you can use [ZfcUser SQL schema](https://github.com/ZF-Commons/ZfcUser/tree/master/data) to set up your database tables. + +Alternatively, you can use `doctrine-module` to do this work for you: vendor/bin/doctrine-module orm:schema-tool:update --dump-sql @@ -49,8 +44,4 @@ If SQL looks okay, do: vendor/bin/doctrine-module orm:schema-tool:update --force -You can now navigate to `http://localhost/MyApp/user` and it should work. - - [4]: http://stackoverflow.com/a/14816988/2883328 "composer versioning" - [5]: https://github.com/doctrine/DoctrineORMModule#connection-settings - [6]: http://stackoverflow.com/a/14781304/2883328 +You can now navigate to `http://localhost/Application/user` and it should work. From 5f9d198ce5483e2462407c301c66fc6792bd97af Mon Sep 17 00:00:00 2001 From: Dennis Matveyev Date: Fri, 11 Apr 2014 16:11:41 -0400 Subject: [PATCH 4/4] wording clean up on README.md See https://github.com/ZF-Commons/ZfcUserDoctrineORM/pull/67/files#r11549005 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a1a03d7..cc4e71a 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Installation ------------ Set up Database Connection Settings for Doctrine ORM: -Namely, go to [Doctrine Connection Settings](https://github.com/doctrine/DoctrineORMModule#connection-settings), and copy/paste/modify the example configuration file content into your `config/autoload/doctrine.orm.local.php` file within `Application` folder, where `Application` is the name of your application. +Namely, go to [Doctrine Connection Settings](https://github.com/doctrine/DoctrineORMModule#connection-settings), and copy/paste/modify the example configuration file content into your `config/autoload/doctrine.orm.local.php`. Install Zfc Components: @@ -44,4 +44,4 @@ If SQL looks okay, do: vendor/bin/doctrine-module orm:schema-tool:update --force -You can now navigate to `http://localhost/Application/user` and it should work. +You can now navigate to `/user` and it should work.