snuze\AuthenticationState Class Reference

Inheritance diagram for snuze\AuthenticationState:

Public Member Functions
	__construct (string $clientId, string $clientSecret, string $username, string $password, string $userAgent, \snuze\Reddit\AccessToken $token, \snuze\RateLimitBucket $bucket)
Public Member Functions inherited from snuze\SnuzeObject
	__construct (array $args=null)
	_getSnuzeId ()
	_getSnuzeClass ()
	_ident ()

Public Attributes
	$clientId = ''
	$clientSecret = ''
	$username = ''
	$password = ''
	$userAgent = ''
	$token = null
	$bucket = null

Additional Inherited Members
Protected Member Functions inherited from snuze\SnuzeObject
	debug (string $message, bool $echo=false)
	info (string $message, bool $echo=false)
	warning (string $message, bool $echo=false)
	error (string $message, bool $echo=false)
Protected Attributes inherited from snuze\SnuzeObject
	$_snuzeId = null
	$_snuzeClass = null

Detailed Description

The AuthenticationState object serves as a container for:

• The Reddit account and client credentials being used to access the API
• An AccessToken object to hold authentication data, and
• A RateLimitBucket to track the current state of the API rate limiter.

---

This file is part of Snuze, a PHP client for the Reddit API. Copyright 2019 Shaun Cummiskey shaun.nosp@m.@sha.nosp@m.unc.c.nosp@m.om https://shaunc.com/ Repository: https://github.com/snuze/snuze/ Documentation: https://snuze.shaunc.com/

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor & Destructor Documentation

__construct()

snuze\AuthenticationState::__construct	(	string	$clientId,
		string	$clientSecret,
		string	$username,
		string	$password,
		string	$userAgent,
		\snuze\Reddit\AccessToken	$token,
		\snuze\RateLimitBucket	$bucket
	)

Constructor. All parameters are mandatory.

Parameters

string	$clientId	The unique Reddit client ID of the script/bot
string	$clientSecret	The Reddit client secret for the script/bot
string	$username	The Reddit username to use
string	$password	The Reddit password to use
string	$userAgent	The User-Agent string to use
\snuze\Reddit\AccessToken	$token	A newly instantiated AccessToken object
\snuze\RateLimitBucket	$bucket	A newly instantiated RateLimitBucket object

---

The documentation for this class was generated from the following file:

• snuze-0.8.1/src/AuthenticationState.php