Procedural File: _user.funcs.php

Source Location: /blogs/inc/users/model/_user.funcs.php

Page Details

This file implements login/logout handling functions.

This file is part of the evoCore framework - http://evocore.net/ See also http://sourceforge.net/projects/evocms/.

Author:	cafelog (team)
Author:	blueyed: Daniel HAHLER.
Author:	fplanque: Francois PLANQUE.
Author:	jeffbearer: Jeff BEARER - http://www.jeffbearer.com/.
Author:	jupiterx: Jordan RUNNING.
Version:	$Id: _user.funcs.php,v 1.24 2010/02/08 17:54:47 efy-yury Exp $
Copyright:	(c)2003-2010 by Francois PLANQUE - http://fplanque.net/ Parts of this file are copyright (c)2004-2006 by Daniel HAHLER - http://thequod.de/contact.
Filesource:	Source Code for this file

Functions

get_avatar_imgtag [line 603]

login get_avatar_imgtag(
user $user_login, [if $show_login = true], [if $link = true], [avatar $size = 'crop-15x15'], [style $class = 'avatar_before_login'], [image $align = ''] 
)

Get avatar <img> tag by user login

Parameters:

user	$user_login:	login
if	$show_login:	true show user login after avatar
if	$link:	true link to user profile
avatar	$size:	size
style	$class:	class
image	$align:	align

API Tags:

Return:

<img> tag

[ Top ]

get_avatar_imgtags [line 643]

coma get_avatar_imgtags(
list $user_logins_list, [if $show_login = true], [avatar $link = true], [style $size = 'crop-15x15'], [image $class = 'avatar_before_login'], [ $align = ''] 
)

Get avatar <img> tags for list of user logins

Parameters:

list	$user_logins_list:	of user logins
if	$show_login:	true show user login after each avatar
avatar	$link:	size
style	$size:	class
image	$class:	align
	$align:

API Tags:

Return:

separated login <img> tag

[ Top ]

get_login_url [line 123]

string get_login_url(
)

Get url to login

[ Top ]

get_user_admin_link [line 323]

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 skins 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 234]

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 262]

string get_user_logout_url(
)

Get the URL for the logout button

[ Top ]

get_user_profile_link [line 368]

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 400]

void get_user_profile_url(
)

Get URL to edit user profile

[ Top ]

get_user_register_link [line 170]

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 442]

void get_user_subs_url(
)

Template tag: Provide url to subscription screen

[ Top ]

is_logged_in [line 63]

void is_logged_in(
)

is_logged_in(-)

[ Top ]

logout [line 46]

void logout(
)

Log the user out

[ Top ]

profile_check_params [line 494]

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 'country': check for non-empty '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 ]

seconds_to_fields [line 665]

string seconds_to_fields(
integer $duration 
)

Convert seconds duration

Parameters:

integer

$duration:

seconds

[ Top ]

user_admin_link [line 305]

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 skins 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 101]

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 220]

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 84]

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 467]

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 357]

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 155]

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 420]

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 ]

Multilingual multiuser multiblog engine

Procedural File: _user.funcs.php

Packages

Classes

Files