phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Procedural File: _user.funcs.php

Source Location: /qp_inc/users/model/_user.funcs.php

Page Details

This file implements login/logout handling functions.

This file is part of Quam Plures - http://quamplures.net/ See also https://launchpad.net/quam-plures.

Author:  blueyed: Daniel HAHLER.
Author:  cafelog (team)
Author:  fplanque: Francois PLANQUE.
Author:  jeffbearer: Jeff BEARER - http://www.jeffbearer.com/.
Author:  jupiterx: Jordan RUNNING.
Copyright:  

(c)2003-2009 by Francois PLANQUE - http://fplanque.net/ Parts of this file are copyright (c)2004-2006 by Daniel HAHLER - http://thequod.de/contact.

Copyright:  (c) 2009 - 2011 by the Quam Plures developers - http://quamplures.net/
Filesource:  Source Code for this file
Functions
get_login_url  [line 116]

string get_login_url( )

Get url to login



[ Top ]
get_register_url  [line 131]

string get_register_url( )

Get url to login



[ Top ]
get_user_admin_link  [line 300]

string get_user_admin_link( [string $before = ''], [string $after = ''], [string $link_text = ''], [string $link_title = '#'], [string $not_visible = '']  )

Template tag: Get a link to the backoffice.

Usually provided in templates in order for newbies to find the admin interface more easily...

Parameters:
string   $before:  To be displayed before the link.
string   $after:  To be displayed after the link.
string   $link_text:  The page/controller to link to inside of $admin_url
string   $link_title:  Text for the link.
string   $not_visible:  Title for the link.


[ Top ]
get_user_logout_link  [line 211]

string get_user_logout_link( [string $before = ''], [string $after = ''], [string $link_text = ''], [ $link_title = '#'], [ $params = array()]  )

Template tag: Get a link to logout

Parameters:
string   $before: 
string   $after: 
string   $link_text:  link text can include %s for current user login
   $link_title: 
   $params: 


[ Top ]
get_user_logout_url  [line 239]

string get_user_logout_url( )

Get the URL for the logout button



[ Top ]
get_user_profile_link  [line 345]

string|false get_user_profile_link( [ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']  )

Template tag: Get a link to user profile

Parameters:
   $before: 
   $after: 
   $link_text: 
   $link_title: 


[ Top ]
get_user_profile_url  [line 377]

void get_user_profile_url( )

Get URL to edit user profile



[ Top ]
get_user_register_link  [line 163]

string get_user_register_link( [string $before = ''], [string $after = ''], [string $link_text = ''], [boolean $link_title = '#'], [string $disp_when_logged_in = false], [ $redirect = null]  )

Template tag: Get a link to new user registration

Parameters:
string   $before: 
string   $after: 
string   $link_text: 
boolean   $link_title:  Display the link, if the user is already logged in? (this is used by the login form)
string   $disp_when_logged_in:  Where to redirect
   $redirect: 


[ Top ]
get_user_subs_url  [line 419]

void get_user_subs_url( )

Template tag: Provide url to subscription screen



[ Top ]
is_logged_in  [line 62]

void is_logged_in( )

is_logged_in(-)



[ Top ]
logout  [line 45]

void logout( )

Log the user out



[ Top ]
profile_check_params  [line 470]

void profile_check_params( array $params, [User|NULL $User = NULL]  )

Check profile parameters and add errors through param_error().

Parameters:
array   $params:  associative array. Either array( $value, $input_name ) or just $value; ($input_name gets used for associating it to a form fieldname)
  • 'login': check for non-empty
  • 'nickname': check for non-empty
  • 'icq': must be a number
  • 'email': mandatory, must be well formed
  • 'url': must be well formed, in allowed scheme, not blacklisted
  • 'pass1' / 'pass2': passwords (twice), must be the same and not == login (if given)
  • 'pass_required': false/true (default is true)
User|NULL   $User:  A user to use for additional checks (password != login/nick).


[ Top ]
user_admin_link  [line 282]

void user_admin_link( [string $before = ''], [string $after = ''], [string $link_text = ''], [string $link_title = '#'], [string $not_visible = '']  )

Template tag: Output a link to the backoffice.

Usually provided in templates in order for newbies to find the admin interface more easily...

Parameters:
string   $before:  To be displayed before the link.
string   $after:  To be displayed after the link.
string   $link_text:  The page/controller to link to inside of $admin_url
string   $link_title:  Text for the link.
string   $not_visible:  Title for the link.


[ Top ]
user_login_link  [line 94]

void user_login_link( [ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']  )

Template tag: Output link to login

Parameters:
   $before: 
   $after: 
   $link_text: 
   $link_title: 


[ Top ]
user_logout_link  [line 197]

void user_logout_link( [ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#'], [ $params = array()]  )

Template tag: Output a link to logout

Parameters:
   $before: 
   $after: 
   $link_text: 
   $link_title: 
   $params: 


[ Top ]
user_pass_ok  [line 78]

boolean user_pass_ok( string $login, string $pass, [boolean $pass_is_md5 = false]  )

Check if a password is ok for a login.

Parameters:
string   $login:  login
string   $pass:  password
boolean   $pass_is_md5:  Is the password parameter already MD5()'ed?


[ Top ]
user_preferredname  [line 444]

void user_preferredname( integer $user_ID  )

Template tag: Display the user's preferred name

Used in result lists.

Parameters:
integer   $user_ID:  user ID


[ Top ]
user_profile_link  [line 334]

void user_profile_link( [ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']  )

Template tag: Display a link to user profile

Parameters:
   $before: 
   $after: 
   $link_text: 
   $link_title: 


[ Top ]
user_register_link  [line 148]

void user_register_link( [string $before = ''], [string $after = ''], [string $link_text = ''], [boolean $link_title = '#'], [ $disp_when_logged_in = false]  )

Template tag: Output a link to new user registration

Parameters:
string   $before: 
string   $after: 
string   $link_text: 
boolean   $link_title:  Display the link, if the user is already logged in? (this is used by the login form)
   $disp_when_logged_in: 


[ Top ]
user_subs_link  [line 397]

void user_subs_link( [ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']  )

Template tag: Provide a link to subscription screen

Parameters:
   $before: 
   $after: 
   $link_text: 
   $link_title: 


[ Top ]