Difference between revisions of "Freeside:3:Documentation:Developer/FS/CurrentUser"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
Line 1: Line 1:
 
==NAME==
 
==NAME==
FS::CurrentUser - Package representing the current user
+
FS::CurrentUser - Package representing the current user (and session)
  
 
==SYNOPSIS==
 
==SYNOPSIS==
 
==DESCRIPTION==
 
==DESCRIPTION==
 +
==CLASS METHODS==
 +
; load_user USERNAME
 +
:Sets the current user to the provided username
 
; new_session
 
; new_session
 
:Creates a new session for the current user and returns the session key
 
:Creates a new session for the current user and returns the session key
Line 10: Line 13:
  
 
==BUGS==
 
==BUGS==
Creepy crawlies
+
Minimal docs
  
 
==SEE ALSO==
 
==SEE ALSO==
Line 16: Line 19:
 
Hey! '''The above document had some coding errors, which are explained below:'''
 
Hey! '''The above document had some coding errors, which are explained below:'''
  
; Around line 47:
+
; Around line 150:
:'=item' outside of any '=over'
 
; Around line 103:
 
 
:You forgot a '=back' before '=head1'
 
:You forgot a '=back' before '=head1'

Revision as of 11:49, 30 March 2015

NAME

FS::CurrentUser - Package representing the current user (and session)

SYNOPSIS

DESCRIPTION

CLASS METHODS

load_user USERNAME
Sets the current user to the provided username
new_session
Creates a new session for the current user and returns the session key
load_user_session SESSION_KEY
Sets the current user via the provided session key

BUGS

Minimal docs

SEE ALSO

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 150:
You forgot a '=back' before '=head1'