POD fixes and removing debug output
This commit is contained in:
parent
f3346bd008
commit
2d9565775f
53 changed files with 267 additions and 215 deletions
|
|
@ -32,19 +32,26 @@ Package WebGUI::Operation::Profile
|
|||
|
||||
Operational handler for viewing, editing and validating user profile data.
|
||||
|
||||
=head2 getRequiredProfileFields ( $session )
|
||||
=head1 METHODS
|
||||
|
||||
Returns an array of hashes for required profile fields. This array is ready
|
||||
to be used as template variables in the WebGUI template system.
|
||||
|
||||
=head3 $session
|
||||
|
||||
The current WebGUI session object.
|
||||
These methods are available from this package:
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getRequiredProfileFields ( session )
|
||||
|
||||
Returns an array of hashes for required profile fields. This array is ready
|
||||
to be used as template variables in the WebGUI template system.
|
||||
|
||||
=head3 session
|
||||
|
||||
The current WebGUI session object.
|
||||
|
||||
=cut
|
||||
|
||||
# Builds Extra form requirements for anonymous registration.
|
||||
sub getRequiredProfileFields {
|
||||
my $session = shift;
|
||||
|
|
@ -82,19 +89,19 @@ sub isDuplicateEmail {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 saveProfileFields ( $session, $u, $profile )
|
||||
=head2 saveProfileFields ( session, u, profile )
|
||||
|
||||
Saves profile data to a user's profile. Does not validate any of the data.
|
||||
|
||||
=head3 $session
|
||||
=head3 session
|
||||
|
||||
WebGUI session object
|
||||
|
||||
=head3 $user
|
||||
=head3 user
|
||||
|
||||
User object. Profile data will be placed in this user's profile.
|
||||
|
||||
=head4 $profile
|
||||
=head3 profile
|
||||
|
||||
Hash ref of profile data to save.
|
||||
|
||||
|
|
@ -110,7 +117,7 @@ sub saveProfileFields {
|
|||
}
|
||||
}
|
||||
|
||||
=head2 validateProfileData ( $session )
|
||||
=head2 validateProfileData ( session )
|
||||
|
||||
Validates profile data from the session form variables. Returns processed data, warnings
|
||||
and errors.
|
||||
|
|
@ -159,7 +166,7 @@ sub validateProfileData {
|
|||
return (\%data, $error, $warning);
|
||||
}
|
||||
|
||||
=head2 www_editProfile ( $session )
|
||||
=head2 www_editProfile ( session )
|
||||
|
||||
Provide a form where user profile data can be entered or edited. The subroutine
|
||||
makes a large set of template variables which are passed to a template for presentation
|
||||
|
|
@ -168,9 +175,9 @@ selectable.
|
|||
|
||||
Calls www_editProfileSave on submission.
|
||||
|
||||
=head3 $session
|
||||
=head3 session
|
||||
|
||||
=head3 $error
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -213,7 +220,7 @@ sub www_editProfile {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_editProfileSave ( $session )
|
||||
=head2 www_editProfileSave ( session )
|
||||
|
||||
Validates all data submitted by www_editProfile. If errors or warnings are present,
|
||||
they are concatenated and sent back to www_editProfile for display and to let the user
|
||||
|
|
@ -239,7 +246,9 @@ sub www_editProfileSave {
|
|||
return WebGUI::Operation::Auth::www_auth($session);
|
||||
}
|
||||
|
||||
=head2 www_viewProfile ( $session )
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_viewProfile ( session )
|
||||
|
||||
View the profile data for a user by the userId specified by the form variable C<uid>.
|
||||
Validates that the user requesting the profile data is allowed to see it.
|
||||
|
|
@ -248,8 +257,6 @@ is PBtmpl0000000000000052. The template is not user selectable.
|
|||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub www_viewProfile {
|
||||
my $session = shift;
|
||||
my $u = WebGUI::User->new($session,$session->form->process("uid"));
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ Package WebGUI::Operation::TransactionLog
|
|||
Operations for dealing with transactions from the WebGUI Commerce System.
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_viewPurchaseHistory ( errorMessage )
|
||||
|
|
|
|||
|
|
@ -35,21 +35,27 @@ Package WebGUI::Operation::User
|
|||
Operation for creating, deleting, editing and many other user related functions.
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 _submenu ( $session, $workarea [, $title, $help] )
|
||||
=head2 _submenu ( session, workarea [, title, help] )
|
||||
|
||||
Internal utility routine for setting up the Admin Console for User functions.
|
||||
|
||||
=head3 $workarea
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 workarea
|
||||
|
||||
The form and information to display to the administrator using the function.
|
||||
|
||||
=head3 $title
|
||||
=head3 title
|
||||
|
||||
Internationalized title for the Admin Console, looked up in the WebGUI namespace if it exists.
|
||||
|
||||
=head3 $help
|
||||
=head3 help
|
||||
|
||||
Help topic. If set, then a Help icon will be displayed as a link to that topic.
|
||||
|
||||
|
|
@ -86,20 +92,24 @@ sub _submenu {
|
|||
return $ac->render($workarea, $title);
|
||||
}
|
||||
|
||||
=head2 doUserSearch ( $session, $op, $returnPaginator, $userFilter )
|
||||
=head2 doUserSearch ( session, op, returnPaginator, userFilter )
|
||||
|
||||
Subroutine that actually performs the SQL search for users.
|
||||
|
||||
=head3 $op
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 op
|
||||
|
||||
The name of the calling operation, passed so that pagination links work correctly.
|
||||
|
||||
=head3 $returnPaginator
|
||||
=head3 returnPaginator
|
||||
|
||||
A boolean. If true, a paginator object is returned. Otherwise, a WebGUI::SQL
|
||||
statement handler is returned.
|
||||
|
||||
=head3 $userFilter
|
||||
=head3 userFilter
|
||||
|
||||
Array reference, used to screen out user names via a SQL "not in ()" clause.
|
||||
|
||||
|
|
@ -149,11 +159,15 @@ sub doUserSearch {
|
|||
|
||||
Form front-end and display for searching for users.
|
||||
|
||||
=head3 $op
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 op
|
||||
|
||||
The name of the calling operation, passed so that pagination links work correctly.
|
||||
|
||||
=head3 $params
|
||||
=head3 params
|
||||
|
||||
Hashref. A set of key,value pairs that will be hidden in the user search form.
|
||||
|
||||
|
|
@ -524,10 +538,14 @@ sub www_editUserKarmaSave {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_formUsers ( $session )
|
||||
=head2 www_formUsers ( session )
|
||||
|
||||
Form helper to pick a user from the system.
|
||||
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub www_formUsers {
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ These methods are available from this class:
|
|||
|
||||
Sets an approval for a version tag.
|
||||
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub www_approveVersionTag {
|
||||
|
|
@ -472,7 +476,7 @@ sub www_manageRevisionsInTag {
|
|||
|
||||
Deletes a version tag and all asset revisions attached to it.
|
||||
|
||||
=head2 session
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Operation handler for managing workflows.
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_addWorkflow ()
|
||||
=head2 www_addWorkflow ( )
|
||||
|
||||
Allows the user to choose the type of workflow that's going to be created.
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ sub www_addWorkflow {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_addWorkflowSave ()
|
||||
=head2 www_addWorkflowSave ( )
|
||||
|
||||
Saves the results from www_addWorkflow().
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue