Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs for page pnUser.php

[ class tree: Zikula_Core ] [ index: Zikula_Core ] [ all elements ] [ Todo List ]

Procedural File: pnUser.php

Source Location: /pnUser.php

Classes:



Page Details:

Zikula Application Framework



Tags:

version:  $Id: pnUser.php 24383 2008-06-12 14:15:02Z markwest $
copyright:  (c) 2001, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL






UDCONST_CORE [line 21]

UDCONST_CORE = 0



[ Top ]


UDCONST_FLOAT [line 24]

UDCONST_FLOAT = 3



[ Top ]


UDCONST_INTEGER [line 25]

UDCONST_INTEGER = 4



[ Top ]


UDCONST_MANDATORY [line 20]

UDCONST_MANDATORY = -1
Data types for User Properties




[ Top ]


UDCONST_STRING [line 22]

UDCONST_STRING = 1



[ Top ]


UDCONST_TEXT [line 23]

UDCONST_TEXT = 2



[ Top ]



pnUserAliasFromID [line 913]

void pnUserAliasFromID( [ $propid = ''])





Parameters

   $propid  
[ Top ]


pnUserDelVar [line 464]

string pnUserDelVar( $name, [ $uid = -1], uid $)

delete the contents of a user variable



Tags:

return:  true on success, false on failure
author:  Gregor J. Rothfuss
since:  1.23 - 2002/02/01
access:  public


Parameters

uid   $   the user to delete the variable for
   $name  
   $uid  
[ Top ]


pnUserGetAll [line 682]

array pnUserGetAll( [ $sortby = 'uname'], [ $sortorder = 'ASC'], $limit, [ $startnum = 1], [ $activated = ''], [ $regexpfield = ''], [ $regexpression = ''])

get a list of user information



Tags:

return:  array of user arrays
public:  


Parameters

   $sortby  
   $sortorder  
   $limit  
   $startnum  
   $activated  
   $regexpfield  
   $regexpression  
[ Top ]


pnUserGetCommentOptions [line 618]

string pnUserGetCommentOptions( [ $implode = true])

get the options for commenting


This function is deprecated, use 

  1. pnUserGetcommentArray()
    2.
in conjunction with 
  1. pnModURL()
    2.
to produce relevant URLs




Tags:

return:  the comment options string
deprecated:  
public:  


Parameters

   $implode  
[ Top ]


pnUserGetCommentOptionsArray [line 652]

array pnUserGetCommentOptionsArray( )

get the options for commenting



Tags:

return:  the comment options array
public:  


[ Top ]


pnUserGetIDFromName [line 813]

mixed pnUserGetIDFromName( $uname, uname $)

Get the uid of a user from the username



Tags:

return:  userid if found, false if not
author:  Michael Halbrook
since:  1.18 - 19/04/2004
access:  public


Parameters

uname   $   the username
   $uname  
[ Top ]


pnUserGetLang [line 598]

string pnUserGetLang( )

get the user's language



Tags:

return:  the name of the user's language
public:  
jgm - the language parameter should be a user variable, not a session variable


[ Top ]


pnUserGetTheme [line 515]

string pnUserGetTheme( [ $force = false])

get the user's theme
This function will return the current theme for the user.

Order of theme priority:

  • page-specific
  • category
  • user
  • system




Tags:

return:  the name of the user's theme
public:  


Parameters

   $force  
[ Top ]


pnUserGetVar [line 323]

string pnUserGetVar( $name, [ $uid = -1], [ $default = false], default $)

get a user variable



Tags:

return:  the value of the user variable if successful, false otherwise
author:  Jim McDonald
public:  


Parameters

default   $   the default value to return if the specified variable doesn't exist
   $name  
   $uid  
   $default  
[ Top ]


pnUserGetVars [line 245]

array pnUserGetVars( $uid, [ $force = false], uid $)

get all user variables



Tags:

return:  an associative array with all variables for a user
author:  Gregor J. Rothfuss
since:  1.33 - 2002/02/07
access:  public


Parameters

uid   $   the user id of the user
   $uid  
   $force  
[ Top ]


pnUserLoggedIn [line 231]

bool pnUserLoggedIn( )

is the user logged in?



Tags:

return:  true if the user is logged in, false if they are not
public:  


[ Top ]


pnUserLogIn [line 36]

bool pnUserLogIn( $uname, rememberme $pass, [checkPassword $rememberme = false], [ $checkPassword = true], pass $)

Log the user in



Tags:

return:  true if the user successfully logged in, false otherwise


Parameters

pass   $   the password of the user logging in
rememberme   $pass   whether $ or not to remember this login
checkPassword   $rememberme   bool true whether or not to check the password
   $uname  
   $checkPassword  
[ Top ]


pnUserLogInHTTP [line 183]

bool pnUserLogInHTTP( )

Log the user in via the REMOTE_USER SERVER property. This routine simply checks if the REMOTE_USER exists in the PN environment: if he does a session is created for him, regardless of the password being used.



Tags:

return:  true if the user successfully logged in, false otherwise


[ Top ]


pnUserLogOut [line 201]

bool pnUserLogOut( )

Log the user out



Tags:

return:  true if the user successfully logged out, false otherwise
public:  


[ Top ]


pnUserSetPassword [line 445]

void pnUserSetPassword( $pass)





Parameters

   $pass  
[ Top ]


pnUserSetVar [line 367]

bool pnUserSetVar( $name, $value, [ $uid = -1], uid $)

set a user variable



Tags:

return:  true if the set was successful, false otherwise
author:  Gregor J. Rothfuss
since:  1.23 - 2002/02/01
access:  public


Parameters

uid   $   the user to set the variable for
   $name  
   $value  
   $uid  
[ Top ]


Packages:

Files:

Classes: