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

Public Member Functions

 __construct (string $subredditName)
 
- Public Member Functions inherited from snuze\Request\Links\Links
 __construct (string $subredditName, string $sort)
 
 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 ()
 

Static Public Member Functions

static getValidParameters ()
 
- Static Public Member Functions inherited from snuze\Request\Links\Links
static getValidSorts ()
 
- Static Public Member Functions inherited from snuze\Request\Request
static getValidParameters ()
 
static getValidVerbs ()
 

Additional Inherited Members

- Public Attributes inherited from snuze\Request\Links\Links
const SORT_CONTRO = 'controversial'
 
const SORT_HOT = 'hot'
 
const SORT_NEW = 'new'
 
const SORT_RANDOM = 'random'
 
const SORT_RISING = 'rising'
 
const SORT_TOP = 'top'
 
const PARAM_AFTER = 'after'
 
const PARAM_BEFORE = 'before'
 
const PARAM_COUNT = 'count'
 
const PARAM_INCLUDE_CATEGORIES = 'include_categories'
 
const PARAM_LIMIT = 'limit'
 
const PARAM_SHOW = 'show'
 
const PARAM_SR_DETAIL = 'sr_detail'
 
- 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

RandomLinks defines the structure and parameters of a request to the /r/[subreddit]/random API endpoint.

This endpoint returns a random link from the specified subreddit.

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.

Member Function Documentation

◆ getValidParameters()

static snuze\Request\Links\RandomLinks::getValidParameters ( )
static

Override parent. Unlike other link requests, this one accepts no parameters

Returns
array An empty array
The documentation for this class was generated from the following file: