Data Types

Added in version 5.0: empty()

All data types are immutable. All lists implement Traversable, Countable and a read only ArrayAccess with numeric keys and have an empty() method. All lists wipe duplicates.

AnnounceList

AnnounceList is a list of UriList’s. It represents the outer list in the announce-list field in the torrent file.

Creation

Announce list can be created from the following structures:

<?php

use Arokettu\Torrent\DataTypes\AnnounceList;
use Arokettu\Torrent\DataTypes\UriList;

// Build from iterable
$announceList = AnnounceList::fromIterable([
    ['url1', 'url2'],   // a list of urls with the same priority
    'url3',             // a single url will be a list of a single item
]);
// OOP way
$announceList = AnnounceList::create(
    UriList::create('url1', 'url2'),
    UriList::create('url3'),
);

Modification

<?php

use Arokettu\Torrent\DataTypes\AnnounceList;
use Arokettu\Torrent\DataTypes\UriList;

// append a list
$announceList = AnnounceList::append(
    $announceList,
    UriList::create('url4'),
);
// prepend a list
$announceList = AnnounceList::prepend(
    $announceList,
    UriList::create('url4'),
);
// remove a list
$announceList = AnnounceList::remove(
    $announceList,
    UriList::create('url4'),
);

Array representation

<?php

// toArray() return an array of arrays of strings,
// the same structure as it is represented in the torrent file
$data = $announceList->toArray();
// toArrayOfUriLists() return array of UriList objects
$lists = $announceList->toArrayOfUriLists();

Node

Node represents an item in the DHT nodes list.

Creation

<?php

use Arokettu\Torrent\DataTypes\Node;

// Build from array
$node = Node::fromArray(['localhost', 11111]);
// OOP way
$node = new Node('127.0.0.1', 12345);

Fields

Changed in version 3.0.1: getters were replaced with readonly properties

<?php

$host = $node->host; // node host or ip
$port = $node->port; // node port

// also with array access that mimics the representation in the torrent file
$host = $node[0];
$port = $node[1];

Array representation

<?php

// toArray() return a node-array [$host, $port],
// the same structure as it is represented in the torrent file
$data = $node->toArray();

NodeList

NodeList is a list of Node’s. It represents the nodes field in the torrent file.

Creation

Node list can be created from the following structures:

<?php

use Arokettu\Torrent\DataTypes\Node;
use Arokettu\Torrent\DataTypes\NodeList;

// Build from iterable
$nodeList = NodeList::fromIterable([
    ['localhost', 11111],   // [host|ip : string, port : int]
    ['127.0.0.1', 12345],   // [host|ip : string, port : int]
]);
// OOP way
$nodeList = NodeList::create(
    new Node('localhost', 11111),
    new Node('127.0.0.1', 12345),
);

Modification

<?php

use Arokettu\Torrent\DataTypes\Node;
use Arokettu\Torrent\DataTypes\NodeList;

// append a node
$nodeList = NodeList::append(
    $nodeList,
    new Node('fe00::1234', 12321),
);
// prepend a node
$nodeList = NodeList::prepend(
    $nodeList,
    new Node('fe00::1234', 12321),
);
// remove a node
$nodeList = NodeList::remove(
    $nodeList,
    new Node('fe00::1234', 12321),
);

Array representation

<?php

// toArray() return an array of node-arrays [$host, $port],
// the same structure as it is represented in the torrent file
$data = $nodeList->toArray();
// toArrayOfNodes() return array of Node objects
$nodes = $nodeList->toArrayOfNodes();

UriList

UriList is a list of strings. It represents the url-list and httpseeds fields and the inner lists in the announce-list field in the torrent file.

Creation

Uri list can be created from the following structures:

<?php

use Arokettu\Torrent\DataTypes\UriList;

// Build from iterable
$uriList = UriList::fromIterable([
    'https://example.com/announce',
    'udp://example.com/announce',
]);
// OOP way
$uriList = UriList::create(
    'https://example.com/announce',
    'udp://example.com/announce',
);

Modification

<?php

use Arokettu\Torrent\DataTypes\UriList;

// append a list
$uriList = UriList::append(
    $uriList,
    'udp://example.net/announce',
);
// prepend a list
$uriList = UriList::prepend(
    $uriList,
    'udp://example.net/announce',
);
// remove a list
$uriList = UriList::remove(
    $uriList,
    'udp://example.net/announce',
);

Array representation

<?php

// toArray() return an array of strings,
// the same structure as it is represented in the torrent file
$data = $uriList->toArray();

Attributes

Attributes class represents file attibutes in file lists. Any single character attribute may be set for future compatibility:

<?php
$isA = $file->attributes->a;
// or
$isA = $file->attributes->has('a');

Actual meaningful attributes:

<?php
/* Executable file: */
$isExecutable = $file->attributes->x;
// or
$isExecutable = $file->attributes->has('x');
// or
$isExecutable = $file->attributes->executable;

/* Symlink: */
$isSymlink = $file->attributes->l;
// or
$isSymlink = $file->attributes->has('l');
// or
$isSymlink = $file->attributes->symlink;

/* Pad file: */
$isPad = $file->attributes->p;
// or
$isPad = $file->attributes->has('p');
// or
$isPad = $file->attributes->pad;

/* Hidden file: */
$isPad = $file->attributes->h;
// or
$isPad = $file->attributes->has('h');
// or
$isPad = $file->attributes->hidden;

Signature

<?php

$signature->signature; // signature value
$signature->certificate; // cert as an object (if present)
$signature->certificatePem; // cert in pem format (if present)
$signature->certificateDer; // cert in der format (if present)
$signature->info; // info (if present)