Download the PHP package happydemon/transmission without Composer
On this page you can find all versions of the php package happydemon/transmission. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download happydemon/transmission
More information about happydemon/transmission
Files in happydemon/transmission
Package transmission
Short Description A little helper for making calls to the Transmission Daemon RPC interface Edit
License MIT
Informations about the package transmission
Transmission
You can use this package to communicate with your transmission installation's web/RPC server.
You can set up transmission by going into preferences > remote > enable remote access.
This package was written against Transmission's RPC spec, if you ever need more info on what each call does or what data it returns, that's the best place to start.
Installation
First you'll need to pull in the library
Short intro
Next you'll need to set up the Transmission
object.
By not defining any config, the object will use sensible defaults to connect to transmission.
Let's retrieve the list of torrents we have in Transmission
Config
When initialising a Transmission
object you can pass an array with several config options;
ssl boolean
Is the transmission web server served over https?
host string
The host/IP the transmission web server is running on (defaults to 127.0.0.1).
port string
What port is the transmission web server running on (defaults to 9091).
url string
What endpoint is the transmission web server running on (defaults to /transmission/rpc).
username string
What username is used to authenticate? (empty by default)
password string
What password is used to authenticate? (empty by default)
Main torrent methods
Retrieving torrents
Retrieves the list of torrents you see in transmission.
This will always return an array with HappyDemon\Services\Transmission\Torrents\Entity
objects.
You can check out the class to see what properties are available to it.
You could also use it to retrieve a single or multiple torrents that you have the ID of:
Adding torrents
Using any of these methods will let you add new torrents.
Each time it will return a HappyDemon\Services\Transmission\Torrents\Entity
object.
The catch is, only 3 properties will be set though: id, hashString & name.
You can also add some extra options that would overwrite Transmission's own default settings:
Setting defaults
You could also overwrite Transmission's defaults 'globally'
Torrent entity methods
These are the methods that are available on a HappyDemon\Services\Transmission\Torrents\Entity
object.
Actions
start
Starts the specific torrent.
stop
Stops the specific torrent.
verify
Verifies the specific torrent.
reannounce
Reannounces the specific torrent.
remove
Removes the specific torrent.
move
Moves the specific torrent to a different location on your file system.
update
Allows you to update some torrent-specific settings.
You could also update a singular torrent-setting like this:
Getters
The entity has a lot of properties, however I've added a few getters for ease-of-use:
status
Will return the torrents status as a string, whereas $torrent->status
only returns a number.
activityDate
Will return a DateTime
object, representing the last time torrent activity happened
addedDate
Will return a DateTime
object, representing the date/time the torrent was added.
doneDate
Will return a DateTime
object, representing time the torrent was completed.
percentDone
Will return the percentage that the torrent is completed whereas $torrent->percentDone
would return this as a float.