Skip to content

Internal function documentation

BlackCetha edited this page Jul 14, 2015 · 5 revisions

####__construct()

  • Check if a session is already active, if not start one
  • Validates settings or use fallback
  • Checks if the user returned from steam
    • Validates the users identity
    • Queries the Steam Web-API for data about the user
    • Stores returned data in a $_SESSION-based array
  • If the user is logged in, moves the data from the $_SESSION-array to the class-variables

####loginUrl()

  • Builds the URL of the steam loginscreen

####private static validate()

  • Creates a URL to validate the users login against
  • Populates POST-query with data and send it

Returns: SteamID64 of the user or an empty string on failure

####logout() SteamAuth does not create or destroy your session if youre using one apart from steamauth

  • Removes the users data from the $_SESSION-cache so the user is logged off from SteamAuth's view
  • Redirects to the logoutpage if set

####loggedIn() Returns: True if logged in, false if not

####forceReload()

  • Reloads the user-data from the Steam Web-API
  • Moves the data from the $_SESSION-array to class variables

Returns: True if successful, false if the user is not logged in

####debug()

  • Prints the settings (including the dynamically assigned by fallback functions)
  • Prints the array of userdata
Clone this wiki locally