Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tables names to config sections of Readme.md, add module parameters table #48

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ Change your config main:

# page after logout
'returnLogoutUrl' => array('/user/login'),

# User model table
'tableUsers' => array('user'),

# Profile model table
'tableProfiles' => array('user_profile'),

# ProfileField model table
'tableProfileFields' => array('user_profile_field'),

),
#...
),
Expand Down Expand Up @@ -118,6 +128,16 @@ Change your config console:

# page after logout
'returnLogoutUrl' => array('/user/login'),

# User model table
'tableUsers' => 'user',

# Profile model table
'tableProfiles' => 'user_profile',

# ProfileField model table
'tableProfileFields' => 'user_profile_field',

),
#...
),
Expand All @@ -131,3 +151,8 @@ Run command:
yiic migrate --migrationPath=user.migrations

Input admin login, email and password

Module parameters
-----------------

<table><tbody><tr><td>Property</td><td>Type</td><td>Description</td><td>Default</td></tr> <tr><td>user_page_size</td><td>int</td><td>items on page</td><td>10</td></tr> <tr><td>fields_page_size</td><td>int</td><td>items on page</td><td>10</td></tr> <tr><td>hash</td><td>string</td><td>hash method</td><td>md5</td></tr> <tr><td>sendActivationMail</td><td>boolean</td><td>use email for activation user account</td><td>true</td></tr> <tr><td>loginNotActiv</td><td>boolean</td><td>allow auth for is not active user</td><td>false</td></tr> <tr><td>activeAfterRegister</td><td>boolean</td><td>activate user on registration (only $sendActivationMail = false)</td><td>false</td></tr> <tr><td>autoLogin</td><td>boolean</td><td>login after registration (need loginNotActiv or activeAfterRegister = true)</td><td>true</td></tr> <tr><td>registrationUrl</td><td>array</td><td>regitration path</td><td>array("/user/registration")</td></tr> <tr><td>recoveryUrl</td><td>array</td><td>recovery path</td><td>array("/user/recovery/recovery")</td></tr> <tr><td>loginUrl</td><td>array</td><td>login path</td><td>array("/user/login")</td></tr> <tr><td>logoutUrl</td><td>array</td><td>logout path</td><td>array("/user/logout")</td></tr> <tr><td>profileUrl</td><td>array</td><td>profile path</td><td>array("/user/profile")</td></tr> <tr><td>returnUrl</td><td>array</td><td>return path after login</td><td>array("/user/profile")</td></tr> <tr><td>returnLogoutUrl</td><td>array</td><td>return path after logout</td><td>array("/user/login")</td></tr> <tr><td>relations</td><td>array</td><td>User model relation from other models</td><td>array()</td></tr> <tr><td>profileRelations</td><td>array</td><td>Profile model relation from other models</td><td>array()</td></tr> <tr><td>captcha</td><td>array</td><td>use captcha</td><td>array('registration'=&gt;true)</td></tr> <tr><td>tableUsers</td><td>string</td><td>User model table</td><td>{{users}}</td></tr> <tr><td>tableProfiles</td><td>string</td><td>Profile model table</td><td>{{profiles}}</td></tr> <tr><td>tableProfileFields</td><td>string</td><td>ProfileField model table</td><td>{{profiles_fields}}</td></tr> </tbody></table>