skobkin/magnetico-web
1
1
Fork 0
Code Issues Pull requests 2 Releases Activity

Entity type-hinting and phpDoc cleanup.

Browse source
This commit is contained in:
Alexey Skobkin 2018-06-22 18:21:10 +03:00
parent a02d7685cc
commit e35a855319
2 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/Entity/File.php
View file

@ -21,7 +21,7 @@ class File
private $id; private $id;
/** /**
* @var int * @var Torrent
* *
* @ORM\ManyToOne(targetEntity="App\Entity\Torrent", inversedBy="files") * @ORM\ManyToOne(targetEntity="App\Entity\Torrent", inversedBy="files")
* @ORM\JoinColumn(name="torrent_id") * @ORM\JoinColumn(name="torrent_id")
@ -29,7 +29,7 @@ class File
private $torrent; private $torrent;
/** /**
* @var int * @var int File size in bytes
* *
* @ORM\Column(name="size", type="integer", nullable=false) * @ORM\Column(name="size", type="integer", nullable=false)
*/ */
@ -47,16 +47,18 @@ class File
return $this->id; return $this->id;
} }
public function getTorrent(): int public function getTorrent(): Torrent
{ {
return $this->torrent; return $this->torrent;
} }
/** Returns file size in bytes */
public function getSize(): int public function getSize(): int
{ {
return $this->size; return $this->size;
} }
/** Returns file path relative to the torrent root directory */
public function getPath(): string public function getPath(): string
{ {
return $this->path; return $this->path;

16
src/Entity/Torrent.php
View file

@ -23,7 +23,7 @@ class Torrent
private $id; private $id;
/** /**
* @var resource * @var resource Resource pointing to info-hash BLOB
* *
* @ORM\Column(name="info_hash", type="blob", nullable=false) * @ORM\Column(name="info_hash", type="blob", nullable=false)
*/ */
@ -35,21 +35,21 @@ class Torrent
private $infoHashHexCache; private $infoHashHexCache;
/** /**
* @var string * @var string Torrent name
* *
* @ORM\Column(name="name", type="text", nullable=false) * @ORM\Column(name="name", type="text", nullable=false)
*/ */
private $name; private $name;
/** /**
* @var int * @var int Torrent files total size in bytes
* *
* @ORM\Column(name="total_size", type="integer", nullable=false) * @ORM\Column(name="total_size", type="integer", nullable=false)
*/ */
private $totalSize; private $totalSize;
/** /**
* @var int * @var int Torrent discovery timestamp
* *
* @ORM\Column(name="discovered_on", type="integer", nullable=false) * @ORM\Column(name="discovered_on", type="integer", nullable=false)
*/ */
@ -67,11 +67,17 @@ class Torrent
return $this->id; return $this->id;
} }
/**
* Returns torrent info hash BLOB resource
*
* @return resource
*/
public function getInfoHash() public function getInfoHash()
{ {
return $this->infoHash; return $this->infoHash;
} }
/** Returns torrent info hash as HEX string */
public function getInfoHashAsHex(): string public function getInfoHashAsHex(): string
{ {
if (null === $this->infoHashHexCache) { if (null === $this->infoHashHexCache) {
@ -87,11 +93,13 @@ class Torrent
return $this->name; return $this->name;
} }
/** Returns torrent files total size in bytes */
public function getTotalSize(): int public function getTotalSize(): int
{ {
return $this->totalSize; return $this->totalSize;
} }
/** Returns torrent discovery timestamp */
public function getDiscoveredOn(): int public function getDiscoveredOn(): int
{ {
return $this->discoveredOn; return $this->discoveredOn;