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

Class: Users

Source Location: /objects.php

Class Users

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From BaseConfig

BaseConfig::$backup_configfile
BaseConfig::$changed
BaseConfig::$configfile
BaseConfig::$data
BaseConfig::$upgraded

Inherited From BaseConfig

BaseConfig::__construct()
Constructor
BaseConfig::count()
Return configuration-array size
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)
BaseConfig::initConfig()
Initialise configuration after has been read, fixed and organized.
BaseConfig::loadConfig()
Load and verify config
BaseConfig::organizeConfig()
Organize configuration
BaseConfig::print_r()
Print a comprehensible representation of the users
BaseConfig::save()
Old save version
BaseConfig::saveConfig()
Save configuration if 'safe' to do so
BaseConfig::setChanged()
Set changed flag
BaseConfig::setUpgraded()
Set upgraded
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]
Method Summary
Users   __construct()  
Users   Users()  
void   addUser()   Add a user to Pivot
boolean   allowEdit()   Determines if $currentuser (or 'the current user', if left empty) is allowed to edit a page or entry that's owned by $contentowner.
boolean   checkPassword()   Check if a given password matches the one stored.
void   deleteUser()  
void   fixConfig()  
array   getUser()   Get the specifics for a given user by its username.
array   getUserByNickname()   Get the specifics for a given user by its nickname.
array   getUserEmail()   Get a list of the Users Email adresses
array   getUsernames()   Get a list of the Usernames
array   getUserNicknames()   Get a list of the Users Nicknames
array   getUsers()   Get all users as an array
boolean   hashPassword()   Hash a given password (for a given user).
boolean   isUser()   Check if a given $username is a user.
void   organizeConfig()  
void   readOld()  
int   sort()   Sort the users based on string comparison of username.
void   updateUser()   Update a given property of a user
void   verifyConfig()  

[ Top ]
Methods
Constructor __construct  [line 445]

  Users __construct( )


API Tags:
Access:  public


Redefinition of:
BaseConfig::__construct()
Constructor

[ Top ]
Constructor Users  [line 449]

  Users Users( )


API Tags:
Access:  public


[ Top ]
addUser  [line 522]

  void addUser( array $user  )

Add a user to Pivot

Parameters:
array   $user: 


[ Top ]
allowEdit  [line 818]

  boolean allowEdit( $contenttype, [string $contentowner = ""], [string $currentuser = ""]  )

Determines if $currentuser (or 'the current user', if left empty) is allowed to edit a page or entry that's owned by $contentowner.

Parameters:
string   $contentowner: 
string   $currentuser: 
   $contenttype: 


[ Top ]
checkPassword  [line 631]

  boolean checkPassword( string $username, string $password  )

Check if a given password matches the one stored.

Parameters:
string   $username: 
string   $password: 


[ Top ]
deleteUser  [line 557]

  void deleteUser( $username  )

Parameters:
   $username: 


[ Top ]
fixConfig  [line 461]

  void fixConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)

[ Top ]
getUser  [line 714]

  array getUser( string $username  )

Get the specifics for a given user by its username.

Parameters:
string   $username: 


[ Top ]
getUserByNickname  [line 734]

  array getUserByNickname( string $username  )

Get the specifics for a given user by its nickname.

Parameters:
string   $username: 


[ Top ]
getUserEmail  [line 787]

  array getUserEmail( )

Get a list of the Users Email adresses



[ Top ]
getUsernames  [line 753]

  array getUsernames( )

Get a list of the Usernames



[ Top ]
getUserNicknames  [line 770]

  array getUserNicknames( )

Get a list of the Users Nicknames



[ Top ]
getUsers  [line 804]

  array getUsers( )

Get all users as an array



[ Top ]
hashPassword  [line 670]

  boolean hashPassword( array $user, string $password  )

Hash a given password (for a given user).

Parameters:
array   $user: 
string   $password: 


[ Top ]
isUser  [line 698]

  boolean isUser( $username, string $name  )

Check if a given $username is a user.

Parameters:
string   $name: 
   $username: 


[ Top ]
organizeConfig  [line 469]

  void organizeConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::organizeConfig()
Organize configuration

[ Top ]
readOld  [line 480]

  void readOld( )


API Tags:
Access:  protected


[ Top ]
sort  [line 887]

  int sort( array $a, array $b  )

Sort the users based on string comparison of username.

Parameters:
array   $a: 
array   $b: 


[ Top ]
updateUser  [line 578]

  void updateUser( string $username, array $properties  )

Update a given property of a user

Parameters:
string   $username: 
array   $properties: 

API Tags:
See:  $this->save


[ Top ]
verifyConfig  [line 453]

  void verifyConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]

Documentation generated on Tue, 27 Jun 2017 01:06:25 +0200 by phpDocumentor 1.4.3