Snuze  0.8.1
snuze\Reddit\Listing\CommentListing Class Reference
Inheritance diagram for snuze\Reddit\Listing\CommentListing:

Public Member Functions

 add ($comment)
 
- Public Member Functions inherited from snuze\Reddit\Listing\Listing
 __construct ()
 
 getAfter ()
 
 getBefore ()
 
 _getSourceJson ()
 
 add ($thing)
 
 count ()
 
 getIterator ()
 
 toJson ()
 
 fromJson (string $json)
 
- Public Member Functions inherited from snuze\SnuzeObject
 __construct (array $args=null)
 
 _getSnuzeId ()
 
 _getSnuzeClass ()
 
 _ident ()
 

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\Reddit\Listing\Listing
 $children = []
 
 $_sourceJson = ''
 
- Protected Attributes inherited from snuze\SnuzeObject
 $_snuzeId = null
 
 $_snuzeClass = null
 

Detailed Description

A CommentListing is a more strict implementation of Listing, which only accepts Comment objects as its children.


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

◆ add()

snuze\Reddit\Listing\CommentListing::add (   $comment)

Add a Comment to the collection.

Overrides parent to enforce that only Comment objects may be added.

Parameters
\snuze\Reddit\Thing\Comment$commentA Comment object to add to the collection
Returns
void

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