Snuze  0.8.1
snuze\Request\Info Class Reference
Inheritance diagram for snuze\Request\Info:

Public Member Functions

 __construct ()
 validate ()
- Public Member Functions inherited from snuze\Request\Request
 addHeader (string $name, string $value)
 getHeaders ()
 addParameter (string $name, $value=null)
 getParameter (string $name)
 getParameters ()
 getApiUri ()
 getEndpointPath ()
 getVerb ()
 getRequiresAuthentication ()
 getMandatoryParameters ()
 validate ()
- Public Member Functions inherited from snuze\SnuzeObject
 __construct (array $args=null)
 _getSnuzeId ()
 _getSnuzeClass ()
 _ident ()

Public Attributes

const PARAM_ID = 'id'
const REGEX_VALID_ID = '|^(?:(?:t[135]_[a-z0-9]{1,13}),?)+$|i'
- Public Attributes inherited from snuze\Request\Request
const API_URIS
const VERB_GET = 'GET'
const VERB_POST = 'POST'

Additional Inherited Members

- Static Public Member Functions inherited from snuze\Request\Request
static getValidParameters ()
static getValidVerbs ()
- Protected Member Functions inherited from snuze\Request\Request
 setApiUri (string $apiUri)
 setEndpointPath (string $endpointPath)
 setVerb (string $verb)
 setRequiresAuthentication (bool $requiresAuthentication)
- 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\Request\Request
 $parameters = []
 $mandatoryParameters = []
- Protected Attributes inherited from snuze\SnuzeObject
 $_snuzeId = null
 $_snuzeClass = null

Detailed Description

Info defines the structure and parameters of a request to the /api/info API endpoint.

This endpoint returns information about up to 100 different "thing" entities as specified by their fullname identifiers.

This file is part of Snuze, a PHP client for the Reddit API. Copyright 2019 Shaun Cummiskey Repository: Documentation:

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

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\Request\Info::__construct ( )

Constructor. Calls parent, then sets properties specific to this Request.

References snuze\Request\Info\PARAM_ID, snuze\Request\Request\setEndpointPath(), and snuze\Request\Request\setVerb().

Member Function Documentation

◆ validate()

snuze\Request\Info::validate ( )

Overrides and calls parent. Performs parameter validation specific to this type of Request.

bool Whether or not the Request is ready to send to the API

References snuze\Request\Request\getParameter().

Member Data Documentation


const snuze\Request\Info::PARAM_ID = 'id'

Defines the "id" parameter as valid. This parameter is mandatory and must be a Thing's fullname e.g. "t3_ce4vtr" or multiple comma-separated Thing fullnames e.g. "t5_abc,t1_def,t3_ghi". Only comments, links, and subreddits (t1_, t3_, and t5) can be retrieved through this Request.


const snuze\Request\Info::REGEX_VALID_ID = '|^(?:(?:t[135]_[a-z0-9]{1,13}),?)+$|i'

Defines a regular expression to test whether or not the "id" parameter's value is valid

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