@@ -80,16 +80,14 @@ A full example showing all options:
8080 # instead. This also affects what `logged_in_user` returns.
8181 user_as_object: 1
8282
83- # Optionally specify the sources of the data if not the
84- # defaults (as shown). See notes below for how these
85- # generate the resultset names. If you use standard DBIC
86- # resultset names, then these and the column names are the
87- # only settings you might need. The relationships between
83+ # Optionally specify the DBIC resultset names if you don't
84+ # use the defaults (as shown). These and the column names are the
85+ # only settings you might need. The relationships between
8886 # these resultsets is automatically introspected by
8987 # inspection of the schema.
90- users_source: 'user'
91- roles_source: 'role'
92- user_roles_source: 'user_role'
88+ users_resultset: User
89+ roles_resultset: Role
90+ user_roles_resultset: UserRole
9391
9492 # optionally set the column names
9593 users_username_column: username
@@ -127,23 +125,11 @@ A full example showing all options:
127125 # Optionally specify the algorithm when encrypting new passwords
128126 encryption_algorithm: SHA-512
129127
130- # If you don't use standard DBIC resultset names, you might
131- # need to configure these instead:
132- users_resultset: User
133- roles_resultset: Role
134- user_roles_resultset: UserRole
135-
136128 # Optional: To validate passwords using a method called
137129 # 'check_password' in users_resultset result class
138130 # which takes the password to check as a single argument:
139131 users_password_check: check_password
140132
141- # Deprecated settings. The following settings were renamed for clarity
142- # to the *_source settings
143- users_table:
144- roles_table:
145- user_roles_table:
146-
147133
148134=over
149135
@@ -204,23 +190,26 @@ By default a row object is returned as a simple hash reference using
204190L<DBIx::Class::ResultClass::HashRefInflator> . Setting this to true
205191causes normal row objects to be returned instead.
206192
207- =item user_source
193+ =item users_resultset
208194
209- Specifies the source name that contains the users. This will be camelized to generate
210- the resultset name. The relationship to user_roles_source will be introspected from
211- the schema.
195+ Defaults to C<User > .
212196
213- =item role_source
197+ Specifies the L<DBIx::Class::ResultSet> that contains the users.
198+ The relationship to user_roles_source will be introspected from the schema.
214199
215- Specifies the source name that contains the roles. This will be camelized to generate
216- the resultset name. The relationship to user_roles_source will be introspected from
217- the schema.
200+ =item roles_resultset
218201
219- =item user_roles_source
202+ Defaults to C< Roles > .
220203
221- Specifies the source name that contains the user_roles joining table. This will be
222- camelized to generate the resultset name. The relationship to the user and role
223- source will be introspected from the schema.
204+ Specifies the L<DBIx::Class::ResultSet> that contains the roles.
205+ The relationship to user_roles_source will be introspected from the schema.
206+
207+ =item user_roles_resultset
208+
209+ Defaults to C<User > .
210+
211+ Specifies the L<DBIx::Class::ResultSet> that contains the user_roles joining table.
212+ The relationship to the user and role source will be introspected from the schema.
224213
225214=item users_username_column
226215
@@ -270,18 +259,38 @@ keyword. Instead it is intended to make it easier to access a user's roles if th
270259user hash is being passed around (without requiring access to the user_has_role
271260keyword in other modules).
272261
273- =item users_resultset
262+ =back
274263
275- =item roles_resultset
264+ =head1 DEPRECATED SETTINGS
276265
277- =item user_roles_resultset
266+ =over
267+
268+ =item user_source
278269
279- These configuration values are provided for fine-grain tuning of your DBIC
280- resultset names. If you use standard DBIC naming practices, you will not need
281- to configure these, and they will be generated internally automatically.
270+ =item user_table
271+
272+ Specifies the source name that contains the users. This will be camelized to generate
273+ the resultset name. The relationship to user_roles_source will be introspected from
274+ the schema.
275+
276+ =item role_source
277+
278+ =item role_table
279+
280+ Specifies the source name that contains the roles. This will be camelized to generate
281+ the resultset name. The relationship to user_roles_source will be introspected from
282+ the schema.
283+
284+ =item user_roles_source
285+
286+ =item user_roles_table
282287
283288=back
284289
290+ Specifies the source name that contains the user_roles joining table. This will be
291+ camelized to generate the resultset name. The relationship to the user and role
292+ source will be introspected from the schema.
293+
285294=head1 SUGGESTED SCHEMA
286295
287296If you use a schema similar to the examples provided here, you should need minimal
0 commit comments