Snuze  0.8.1
Public Member Functions | List of all members
snuze\Request\Me Class Reference
Inheritance diagram for snuze\Request\Me:
Inheritance graph
[legend]

Public Member Functions

 __construct ()
 
- 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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from snuze\Request\Request
static getValidParameters ()
 
static getValidVerbs ()
 
- Public Attributes inherited from snuze\Request\Request
const API_URIS
 
const VERB_GET = 'GET'
 
const VERB_POST = 'POST'
 
const VERB_DELETE = 'DELETE'
 
- 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

The Me request type defines the structure and parameters of a request to the /api/v1/me API endpoint.

This endpoint returns information about the currently authenticated API user.

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

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

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

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