docs: Document magic properties

This commit is contained in:
Pierre Rudloff 2019-04-21 19:10:37 +02:00
parent 4fa604eec3
commit dc4eafe33f

View file

@ -14,7 +14,14 @@ use Symfony\Component\Process\Process;
/**
* Extract info about videos.
*
* Due to the way youtube-dl, this class can also contain a playlist.
* Due to the way youtube-dl behaves, this class can also contain information about a playlist.
*
* @property-read string $title Title
* @property-read string $protocol Network protocol (HTTP, RTMP, etc.)
* @property-read string $url File URL
* @property-read string $ext File extension
* @property-read string $extractor_key youtube-dl extractor class used
* @property-read array $entries List of videos (if the object contains information about a playlist)
*/
class Video
{
@ -46,6 +53,13 @@ class Video
*/
private $password;
/**
* JSON object returned by youtube-dl.
*
* @var stdClass
*/
private $json;
/**
* VideoDownload constructor.
*