\ PerfectWorldAPI

__construct()

__construct() : void

Class constructor

Instance()

Instance() : \PerfectWorldAPI

Returns singleton instance of class

Returns

PrintSessionDebugData()

PrintSessionDebugData() : void

Print session debug information

AddUser()

AddUser(string  $username, string  $password, string  $email, string  $question = '', string  $answer = '', string  $realName = '', integer  $gender, string  $number = '0', string  $country = '0', string  $city = '0', string  $address = '0', string  $postalcode = '0', integer  $birthday) 

Add user to Perfect World database

Parameters

UsernameIsValid()

UsernameIsValid(string  $username) : boolean

Checks if username is valid.

Parameters

Returns

UsernameExists()

UsernameExists(string  $username) : boolean

Check if username already exists in database.

Parameters

Returns

EmailIsValid()

EmailIsValid(string  $email) : boolean

Checks if the input e-mail is valid.

Parameters

Returns

EmailExists()

EmailExists(string  $email) : boolean

Check if e-mail exists.

Parameters

Returns

SetPassword()

SetPassword(string  $username = '', string  $password, string  $oldPassword = '') : boolean

Sets a password for an account. This can be useful for password resets. If you have them input an old password, be sure to check that the old password length isn't 0. Otherwise they'll be able to overwrite the password without inputting an old password. This isn't a bug in the API, it's by design.

Parameters

Returns

GetUsername()

GetUsername(  $userID) : string

Returns logged in username. If user is not logged in, empty string is returned.

Parameters

Returns

GetUserData()

GetUserData(integer  $userID,   $forceUpdate = false) : mixed

Get user's data based on ID or currently logged in account. If the data has already been accessed, it will return that unless forceUpdate is set to true. If empty userID and user is not logged in, function returns false.

Parameters

Returns

IsLoggedIn()

IsLoggedIn() : boolean

Returns true or false on whether or not the user is logged in.

Returns

GetUserID()

GetUserID() : integer

Get logged in user ID

Returns

AddGMByCharName()

AddGMByCharName(string  $charname) : boolean

Alias of AddGM

Parameters

Returns

AddGM()

AddGM(string  $charname) : boolean

Gives a user GM permissions based on roles.role_name (not users.name).

Returns true or false on whether or not query succeeded.

Parameters

Returns

AddGMByID()

AddGMByID(string  $userID) : boolean

Gives a user GM permissions based on user ID Returns true or false on whether or not query succeeded.

Parameters

Returns

AddGMByUsername()

AddGMByUsername(string  $username) : boolean

Gives a user GM permissions based on user ID Returns true or false on whether or not query succeeded.

Parameters

Returns

Login()

Login(string  $username, string  $password, string  $email = '') 

Login to an account. E-Mail parameter is optional. If you plan to use the e-mail parameter, make sure to check if the e-mail length is greater than 0, otherwise it will bypass the e-mail check and allow the user in with just username and password.

Parameters

SetLogin()

SetLogin(string  $userID, boolean  $isGM = false) : void

Set login for user. Do NOT use this to log into account.

Parameters

LoginByEmail()

LoginByEmail(string  $email, string  $password) 

Login to an account by e-mail address.

Parameters

IsGM()

IsGM() : boolean

Returns true or false on whether or not the user is a GM

Returns

Logout()

Logout() : boolean

Logs out the character by destorying the session variables. The user remains in the same session until they either delete the cookie, restart their browser, or change their session ID.

Returns

SetCharacter()

SetCharacter(integer  $charID) : boolean

Set character ID for account. If set character fails, function will return false.

If the function succeeds, it will return true and the character ID will be set.

Parameters

Returns

FillUserCharData()

FillUserCharData(integer  $userID) : boolean

Fill all character data from given user ID. This will not check if data is stored already or not.

Parameters

Returns

GetUserCharIDs()

GetUserCharIDs(integer  $userID) : mixed

Returns an array of characters from specified user ID. If no ID is put, function grabs characters from currently logged in account. If empty userID and user is not logged in, function returns false.

Parameters

Returns

GetGMList()

GetGMList() : mixed

Returns an array map of GMs.

Key 'GM Name' returns GM's Name Key 'Online' returns true or false to online status

Returns

array

GetOnlineCharList()

GetOnlineCharList() : mixed

Returns an array of online user's names and IDs

Returns

array

GetOnlineCharacterList()

GetOnlineCharacterList() : mixed

Returns an array of online user's names and IDs

Returns

array

GetCharList()

GetCharList(integer  $limit, integer  $page) : mixed

Get an array of all character's names and IDs (This can return a massive amount of data)

Parameters

Returns

array

GetCharacterName()

GetCharacterName(  $charID) : string

Returns currently selected character's name. If no character is selected, empty string is returned.

Parameters

Returns

Examples

** File not found :  **

GetCharData()

GetCharData(integer  $charID,   $forceUpdate = false) : mixed

Get character's data based on ID or currently logged in account character. If the data has already been accessed, it will return that unless forceUpdate is set to true. If empty userID and user is not logged in, function returns false.

Parameters

Returns

GetCharID()

GetCharID() : integer

Get character ID if character is set. 0 means that no character is set.

Returns

initialize()

initialize() : void

Initialization components run here

startSession()

startSession() : void

Attempt to start user session (cookie blocks will prevent this from starting)

verifyFingerprint()

verifyFingerprint() : boolean

Verify session fingerprint against user fingerprint. Returns true if fingerprint is the same. Returns false if fingerprint mismatch.

Returns

setFingerprint()

setFingerprint() : void

Set session fingerprint

setSessionVariable()

setSessionVariable(string  $variable, mixed  $value) : void

Set a session variable.

NOTE: There is mild session data hiding for shared hosts. Beware using this on anything but a dedicated host. As the data could be unhidden fairly easy by another user.

Parameters

getUserFingerprint()

getUserFingerprint() : string

Returns current user fingerprint (Not session fingerprint)

Returns

getFingerprint()

getFingerprint() : string

Return session fingerprint

Returns

getSessionVariable()

getSessionVariable(string  $variable) : mixed

Get a session variable.

NOTE: There is mild session data hiding for shared hosts. Beware using this on anything but a dedicated host. As the data could be unhidden fairly easy by another user.

Parameters

Returns