SearchResultSnippet
extends Part
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.
Tags
Table of Contents
Constants
- LIVE_BROADCAST_CONTENT_COMPLETED : mixed = 'completed'
- The live broadcast has been completed.
- LIVE_BROADCAST_CONTENT_LIVE : mixed = 'live'
- The live broadcast is active.
- LIVE_BROADCAST_CONTENT_NONE : mixed = 'none'
- The resource does not have live broadcast content.
- LIVE_BROADCAST_CONTENT_UPCOMING : mixed = 'upcoming'
- The live broadcast is upcoming.
Properties
- $channelId : string|null
- $channelTitle : string|null
- $description : string|null
- $liveBroadcastContent : string|null
- $publishedAt : CarbonImmutable|null
- $thumbnails : ThumbnailDetails|null
- $title : string|null
- $casts : array<string, string>
- Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
- $dates : array<int, string>
- Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
- $youtube : ?YouTube
Methods
- __construct() : mixed
- __debugInfo() : array<string, mixed>
- __get() : mixed
- __isset() : bool
- __set() : void
- __toString() : string
- __unset() : void
- attributeExists() : bool
- fill() : void
- getAttribute() : mixed
- getCasts() : array<string, string>
- getDates() : array<int, string>
- getRawAttribute() : mixed
- Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
- getRawAttributes() : array<string, mixed>
- getYouTube() : YouTube
- The client this part came from.
- jsonSerialize() : array<string, mixed>
- The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
- offsetExists() : bool
- offsetGet() : mixed
- offsetSet() : void
- offsetUnset() : void
- setAttribute() : void
- factory() : Factory
- Builds another part from the same client - for nested objects.
- setRawAttribute() : void
- Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
Constants
LIVE_BROADCAST_CONTENT_COMPLETED
The live broadcast has been completed.
public
mixed
LIVE_BROADCAST_CONTENT_COMPLETED
= 'completed'
LIVE_BROADCAST_CONTENT_LIVE
The live broadcast is active.
public
mixed
LIVE_BROADCAST_CONTENT_LIVE
= 'live'
LIVE_BROADCAST_CONTENT_NONE
The resource does not have live broadcast content.
public
mixed
LIVE_BROADCAST_CONTENT_NONE
= 'none'
LIVE_BROADCAST_CONTENT_UPCOMING
The live broadcast is upcoming.
public
mixed
LIVE_BROADCAST_CONTENT_UPCOMING
= 'upcoming'
Properties
$channelId
public
string|null
$channelId
The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
$channelTitle
public
string|null
$channelTitle
The title of the channel that published the resource that the search result identifies.
$description
public
string|null
$description
A description of the search result.
$liveBroadcastContent
public
string|null
$liveBroadcastContent
It indicates if the resource (video or channel) has
upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.
One of the LIVE_BROADCAST_CONTENT_* constants.
$publishedAt
public
CarbonImmutable|null
$publishedAt
The creation date and time of the resource that the search result identifies.
$thumbnails
public
ThumbnailDetails|null
$thumbnails
A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
$title
public
string|null
$title
The title of the search result.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= ['thumbnails' => 'ThumbnailDetails']
$dates
Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
protected
array<int, string>
$dates
= ['publishedAt']
$youtube read-only
protected
?YouTube
$youtube
= null
Methods
__construct()
public
__construct([YouTube|null $youtube = null ][, array<string, mixed>|object $attributes = [] ]) : mixed
Parameters
- $youtube : YouTube|null = null
-
The client, for behaviour that calls the API.
- $attributes : array<string, mixed>|object = []
__debugInfo()
public
__debugInfo() : array<string, mixed>
Return values
array<string, mixed>__get()
public
__get(string $name) : mixed
Parameters
- $name : string
__isset()
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool__set()
public
__set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
__toString()
public
__toString() : string
Return values
string__unset()
public
__unset(string $name) : void
Parameters
- $name : string
attributeExists()
public
attributeExists(string $key) : bool
Parameters
- $key : string
Return values
boolfill()
public
fill(array<string, mixed> $attributes) : void
Parameters
- $attributes : array<string, mixed>
getAttribute()
public
getAttribute(string $key) : mixed
Parameters
- $key : string
getCasts()
public
getCasts() : array<string, string>
Return values
array<string, string>getDates()
public
getDates() : array<int, string>
Return values
array<int, string>getRawAttribute()
Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
public
getRawAttribute(string $key) : mixed
Parameters
- $key : string
getRawAttributes()
public
getRawAttributes() : array<string, mixed>
Return values
array<string, mixed>getYouTube()
The client this part came from.
public
getYouTube() : YouTube
Tags
Return values
YouTubejsonSerialize()
The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
setAttribute()
public
setAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
factory()
Builds another part from the same client - for nested objects.
protected
factory() : Factory
Return values
FactorysetRawAttribute()
Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
protected
setRawAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed