Index | brandon14/fossabot-commander Documentation

A

FossabotChannel::avatarUrl() — Method in class FossabotChannel: URL to the user's profile avatar.
Arrayable — Class in namespace Brandon14\FossabotCommander\Contracts: Contract to define a 'Arrayable' object that can be converted to an array.
FossabotChannel::avatarUrl() — Method in class FossabotChannel: URL to the user's profile avatar.

B

FossabotChannel::broadcasterType() — Method in class FossabotChannel: Broadcaster type (i.e. affiliate, partner, etc.).
FossabotChannel::broadcasterType() — Method in class FossabotChannel: Broadcaster type (i.e. affiliate, partner, etc.).
FossabotApiException::body() — Method in class FossabotApiException: Parsed HTTP body from Fossabot API exception.

C

FossabotChannel::createFromBody() — Method in class FossabotChannel: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotChannel::createdAt() — Method in class FossabotChannel: Time the request was created at.
FossabotContext::createFromBody() — Method in class FossabotContext: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotContext::channel() — Method in class FossabotContext: Fossabot channel context.
FossabotMessage::createFromBody() — Method in class FossabotMessage: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotMessage::content() — Method in class FossabotMessage: Message contents.
FossabotRole::createFromBody() — Method in class FossabotRole: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotUser::createFromBody() — Method in class FossabotUser: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotChannel::createdAt() — Method in class FossabotChannel: Time the request was created at.
FossabotContext::channel() — Method in class FossabotContext: Fossabot channel context.
FossabotDataModel::createFromBody() — Method in class FossabotDataModel: Creates a new Fossabot data model instance from a parsed array of API data.
FossabotMessage::content() — Method in class FossabotMessage: Message contents.
CannotCreateContextException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when the context data model cannot be created from the parsed response data.
CannotExecuteCommandException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when the \Brandon14\FossabotCommander\Contracts\FossabotCommand::getResponse() throws an exception.
CannotGetContextException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when the API call to get the context data fails.
CannotValidateRequestException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when validating the request fails.

D

FossabotChannel::displayName() — Method in class FossabotChannel: The uppercased or internationalized version of the boradcaster's username.
$ FossabotDataModel#data — Property in class FossabotDataModel: Data model.
FossabotUser::displayName() — Method in class FossabotUser: Message user display name, uppercased or localized display name.
FossabotChannel::displayName() — Method in class FossabotChannel: The uppercased or internationalized version of the boradcaster's username.
FossabotUser::displayName() — Method in class FossabotUser: Message user display name, uppercased or localized display name.
FossabotCommander::disableLogging() — Method in class FossabotCommander: Disables logging for the \Brandon14\FossabotCommander\Contracts\FossabotCommander instance.
FossabotCommander::disableLogging() — Method in class FossabotCommander: Disables logging for the \Brandon14\FossabotCommander\Contracts\FossabotCommander instance.

E

FossabotApiException::errorClass() — Method in class FossabotApiException: Error class (error param) from Fossabot API response.
FossabotApiException::errorMessage() — Method in class FossabotApiException: Error message from Fossabot API response.
FossabotCommander::enableLogging() — Method in class FossabotCommander: Enable logging. Will throw an \Brandon14\FossabotCommander\Contracts\Exceptions\NoValidLoggerProvidedException when enabling this without providing a valid \Psr\Log\LoggerInterface instance.
FossabotCommander::enableLogging() — Method in class FossabotCommander: Enable logging. Will throw an \Brandon14\FossabotCommander\Contracts\Exceptions\NoValidLoggerProvidedException when enabling this without providing a valid \Psr\Log\LoggerInterface instance.

F

FossabotChannel — Class in namespace Brandon14\FossabotCommander\Context: Fossabot channel context data model. Contains information about the channel in which the custom API was invoked in.
FossabotContext — Class in namespace Brandon14\FossabotCommander\Context: Fossabot API context data model. Contains additional context about the Fossabot custom API request for more rich integrations.
FossabotDataModel — Class in namespace Brandon14\FossabotCommander\Context: Base Fossabot custom API data model.
FossabotMessage — Class in namespace Brandon14\FossabotCommander\Context: Fossabot message context data model. This is only present when the custom API request was invoked from a chat message or command. When dispatched from an automated action, such as a timer, this will be null.
FossabotRole — Class in namespace Brandon14\FossabotCommander\Context: Fossabot role context data model. Defines the ID, name and type of role associated to the user.
FossabotUser — Class in namespace Brandon14\FossabotCommander\Context: Fossabot user context data model. Contains information about the user that invoked the custom API request.
FossabotChannel — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Fossabot channel context data model. Contains informationa bout the channel in which the custom API was invoked in.
FossabotContext — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Fossabot API context data model. Contains additional context about the Fossabot custom API request for more rich integrations.
FossabotDataModel — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Base Fossabot custom API data model.
FossabotMessage — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Fossabot message context data model. This is only present when the custom API request was invoked from a chat message or command. When dispatched from an automated action, such as a timer, this will be null.
FossabotRole — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Fossabot role context data model. Defines the ID, name and type of role associated to the user.
FossabotUser — Class in namespace Brandon14\FossabotCommander\Contracts\Context: Fossabot user context data model. Contains information about the user that invoked the custom API request.
FossabotApiException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Generic Fossabot API exception thrown when making Fossabot custom API requests.
FossabotApiException::fossabotCode() — Method in class FossabotApiException: Error code from Fossabot API response.
FossabotCommanderException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Generic library exception.
FossabotCommand — Class in namespace Brandon14\FossabotCommander\Contracts: Class to define a response for a Fossabot custom API request. This class is only tasked with returning the response string back to Fossabot, and can use any of the additional context information to make its response.
FossabotCommander — Class in namespace Brandon14\FossabotCommander\Contracts: Main class to invoke a given \Brandon14\FossabotCommander\Contracts\FossabotCommand instance.
FossabotCommand — Class in namespace Brandon14\FossabotCommander: Class to define a response for a Fossabot custom API request. This class is only tasked with returning the response string back to Fossabot, and can use any of the additional context information to make its response.
FossabotCommander — Class in namespace Brandon14\FossabotCommander: Main class to invoke a given \Brandon14\FossabotCommander\Contracts\FossabotCommand instance.

G

FossabotCommand::getResponse() — Method in class FossabotCommand: Get string response for a Fossabot custom API request.
FossabotCommander::getHttpClient() — Method in class FossabotCommander: Get \Psr\Http\Client\ClientInterface instance.
FossabotCommander::getRequestFactory() — Method in class FossabotCommander: Get \Psr\Http\Message\RequestFactoryInterface instance.
FossabotCommander::getLogger() — Method in class FossabotCommander: Get \Psr\Log\LoggerInterface instance.
FossabotCommander::getLogging() — Method in class FossabotCommander: Gets the configured logging setting.
FossabotCommander::getIncludeLogContext() — Method in class FossabotCommander: Gets the configured logging context setting.
FossabotCommander::getLoggingContext() — Method in class FossabotCommander: Gets general class information used for providing additional logging context.
FossabotCommander::getHttpClient() — Method in class FossabotCommander: Get \Psr\Http\Client\ClientInterface instance.
FossabotCommander::getRequestFactory() — Method in class FossabotCommander: Get \Psr\Http\Message\RequestFactoryInterface instance.
FossabotCommander::getLogger() — Method in class FossabotCommander: Get \Psr\Log\LoggerInterface instance.
FossabotCommander::getLogging() — Method in class FossabotCommander: Gets the configured logging setting.
FossabotCommander::getIncludeLogContext() — Method in class FossabotCommander: Gets the configured logging context setting.
FossabotCommander::getLoggingContext() — Method in class FossabotCommander: Gets general class information used for providing additional logging context.

H

HandlesJsonable — Class in namespace Brandon14\FossabotCommander\Concerns: Trait to consolidate functionality of converting a class to JSON representation.
HandlesStringable — Class in namespace Brandon14\FossabotCommander\Concerns: Trait to consolidate the methods needs to implement the \Brandon14\FossabotCommander\Contracts\Stringable interface.

I

FossabotChannel::id() — Method in class FossabotChannel: Channel ID.
FossabotChannel::isLive() — Method in class FossabotChannel: Whether channel is live or not currently.
FossabotMessage::id() — Method in class FossabotMessage: Message ID.
FossabotRole::id() — Method in class FossabotRole: Role ID.
FossabotChannel::id() — Method in class FossabotChannel: Channel ID.
FossabotChannel::isLive() — Method in class FossabotChannel: Whether channel is live or not currently.
FossabotMessage::id() — Method in class FossabotMessage: Message ID.
FossabotRole::id() — Method in class FossabotRole: Role ID.
ImmutableDataModelException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when trying to mutate properties of the \Brandon14\FossabotCommander\Contracts\Context\FossabotDataModel instances.
InvalidArgumentException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown from \Brandon14\FossabotCommander\Contracts\Context\FossabotDataModel instances when accessing invalid property names.
InvalidStatusException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Fossabot API exception thrown when the return status of a call is not 200, or one of the special ones (i.e. rate limit, invalid token, etc.).
InvalidTokenException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when making a Fossabot API call results in a 400 response status.

J

FossabotDataModel::jsonSerialize() — Method in class FossabotDataModel: Specify data which should be serialized to JSON.
JsonParsingException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when an error occurs decoding or encoding JSON data.
Jsonable — Class in namespace Brandon14\FossabotCommander\Contracts: Contract to define a "Jsonable" object that can be converted to a JSON string.

L

FossabotChannel::login() — Method in class FossabotChannel: Channel log in name. This is the lowercase version of the broadcaster's username.
FossabotUser::login() — Method in class FossabotUser: Message user login name, the lowercased version.
FossabotChannel::login() — Method in class FossabotChannel: Channel log in name. This is the lowercase version of the broadcaster's username.
FossabotUser::login() — Method in class FossabotUser: Message user login name, the lowercased version.
FossabotCommander::log() — Method in class FossabotCommander: {@inheritDoc}

M

FossabotContext::message() — Method in class FossabotContext: Fossabot message context.
FossabotContext::message() — Method in class FossabotContext: Fossabot message context.

N

FossabotRole::name() — Method in class FossabotRole: Role name.
FossabotRole::name() — Method in class FossabotRole: Role name.
NoValidLoggerProvidedException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when enabling logging for the \Brandon14\FossabotCommander\Contracts\FossabotCommander class when no \Psr\Log\LoggerInterface has been provided.

O

FossabotDataModel::offsetExists() — Method in class FossabotDataModel: Whether an offset exists.
FossabotDataModel::offsetGet() — Method in class FossabotDataModel: Offset to retrieve.
FossabotDataModel::offsetSet() — Method in class FossabotDataModel: Offset to set.
FossabotDataModel::offsetUnset() — Method in class FossabotDataModel: Offset to unset.

P

FossabotChannel::provider() — Method in class FossabotChannel: Broadcaster provider (i.e. twitch, etc.).
FossabotChannel::providerId() — Method in class FossabotChannel: Provider ID.
FossabotMessage::provider() — Method in class FossabotMessage: Message provider (i.e. twitch, etc.).
FossabotUser::providerId() — Method in class FossabotUser: Message user provider ID.
FossabotChannel::provider() — Method in class FossabotChannel: Broadcaster provider (i.e. twitch, etc.).
FossabotChannel::providerId() — Method in class FossabotChannel: Provider ID.
FossabotMessage::provider() — Method in class FossabotMessage: Message provider (i.e. twitch, etc.).
FossabotUser::providerId() — Method in class FossabotUser: Message user provider ID.

R

FossabotUser::roles() — Method in class FossabotUser: Array of user roles.
FossabotUser::roles() — Method in class FossabotUser: Array of user roles.
RateLimitException — Class in namespace Brandon14\FossabotCommander\Contracts\Exceptions: Exception thrown when making a Fossabot API call, and it results in a rate limit throttled response (429).
RateLimitException::remaining() — Method in class RateLimitException: Remaining request in bucket.
RateLimitException::resetsAt() — Method in class RateLimitException: Time when rate limit bucket is refilled.
FossabotCommander::runCommand() — Method in class FossabotCommander: Will execute a given \Brandon14\FossabotCommander\Contracts\FossabotCommand instance. If this method throws a \Brandon14\FossabotCommander\Contracts\Exceptions\CannotValidateRequestException, then it was unable to verify that the request came from Fossabot, and should be treated as a critical error.
FossabotCommander::runCommand() — Method in class FossabotCommander: Will execute a given \Brandon14\FossabotCommander\Contracts\FossabotCommand instance. If this method throws a \Brandon14\FossabotCommander\Contracts\Exceptions\CannotValidateRequestException, then it was unable to verify that the request came from Fossabot, and should be treated as a critical error.

S

FossabotChannel::slug() — Method in class FossabotChannel: The fossabot channel URL of the broadcaster.
FossabotChannel::streamTimestamp() — Method in class FossabotChannel: Stream timestamp.
FossabotChannel::slug() — Method in class FossabotChannel: The fossabot channel URL of the broadcaster.
FossabotChannel::streamTimestamp() — Method in class FossabotChannel: Stream timestamp.
FossabotApiException::statusCode() — Method in class FossabotApiException: HTTP status code from Fossabot API exception.
FossabotCommander::setHttpClient() — Method in class FossabotCommander: Set a new \Psr\Http\Client\ClientInterface instance.
FossabotCommander::setRequestFactory() — Method in class FossabotCommander: Set a new \Psr\Http\Message\RequestFactoryInterface instance.
FossabotCommander::setLog() — Method in class FossabotCommander: Fluent setter for setting a new \Psr\Log\LoggerInterface instance.
FossabotCommander::setLogging() — Method in class FossabotCommander: Sets whether to log or not for the \Brandon14\FossabotCommander\Contracts\FossabotCommander instance.
FossabotCommander::setIncludeLogContext() — Method in class FossabotCommander: Set whether to include additional context with logging messages.
Stringable — Class in namespace Brandon14\FossabotCommander\Contracts: Defines a "stringable" class which is one that can be converted to a string or cast to a string.
FossabotCommander::setHttpClient() — Method in class FossabotCommander: Set a new \Psr\Http\Client\ClientInterface instance.
FossabotCommander::setRequestFactory() — Method in class FossabotCommander: Set a new \Psr\Http\Message\RequestFactoryInterface instance.
FossabotCommander::setLog() — Method in class FossabotCommander: Fluent setter for setting a new \Psr\Log\LoggerInterface instance.
FossabotCommander::setLogging() — Method in class FossabotCommander: Sets whether to log or not for the \Brandon14\FossabotCommander\Contracts\FossabotCommander instance.
FossabotCommander::setIncludeLogContext() — Method in class FossabotCommander: Set whether to include additional context with logging messages.
Stringable — Class in namespace [Global Namespace]: The Stringable interface denotes a class as having a toString() method. Unlike most interfaces, Stringable is implicitly present on any class that has the magic toString() method defined, although it can and should be declared explicitly.

T

HandlesJsonable::toJson() — Method in class HandlesJsonable: {@inheritDoc}
HandlesStringable::toString() — Method in class HandlesStringable: {@inheritDoc}
FossabotDataModel::toArray() — Method in class FossabotDataModel
FossabotRole::type() — Method in class FossabotRole: Role type.
Arrayable::toArray() — Method in class Arrayable
FossabotRole::type() — Method in class FossabotRole: Role type.
RateLimitException::total() — Method in class RateLimitException: Total size of rate limit bucket.
Jsonable::toJson() — Method in class Jsonable: Convert the object to its JSON representation.
Stringable::toString() — Method in class Stringable: String representation of the object. For complex objects, this would normally be a JSON string.

U

FossabotMessage::user() — Method in class FossabotMessage: User who invoked the message.
FossabotMessage::user() — Method in class FossabotMessage: User who invoked the message.

_

HandlesStringable::__toString() — Method in class HandlesStringable: Magic method https://www.php.net/manual/en/language.oop5.magic.php#object. toString allows a class to decide how it will react when it is treated like a string.
FossabotDataModel::__serialize() — Method in class FossabotDataModel: Serializes data.
FossabotDataModel::__unserialize() — Method in class FossabotDataModel: Unserializes data.
FossabotDataModel::__get() — Method in class FossabotDataModel: Gets property.
FossabotDataModel::__set() — Method in class FossabotDataModel: Sets property.
FossabotDataModel::__isset() — Method in class FossabotDataModel: Checks for existence of property.
FossabotDataModel::__unset() — Method in class FossabotDataModel: Unsets property.
FossabotApiException::__construct() — Method in class FossabotApiException: Constructs a new FossabotApiException class.
FossabotApiException::__toString() — Method in class FossabotApiException: {@inheritDoc}
InvalidTokenException::__construct() — Method in class InvalidTokenException: Constructs a new InvalidTokenException class.
RateLimitException::__construct() — Method in class RateLimitException: Constructs a new RateLimitException class.
Stringable::__toString() — Method in class Stringable: String representation of the object.
FossabotCommand::__invoke() — Method in class FossabotCommand: Get string response for a Fossabot custom API request.
FossabotCommander::__construct() — Method in class FossabotCommander: Constructs a new FossabotCommander class.
Stringable::__toString() — Method in class Stringable: String representation of the object.