php-extended / php-api-nz-mega-object
A library that implements the php-extended/php-api-nz-mega-interface library
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-31 00:17:38 UTC
README
A php API wrapper to connect to mega.nz API, in full object oriented mode.
This library takes care of not disabling https certificate checking when calling for mega servers.
This API is in construction, only few of its methods are available, but contributions are welcome !
/!\ Mega seems to badly support the file_get_contents()
function.
/!\ Use a curl-based http client for better performance.
This library is inspired by the smartinm/mega-php-client library and the tutorial by Julien Marchand.
Installation
The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.
- Download
composer.phar
from their website. - Then run the following command to install this library as dependency :
php composer.phar php-extended/php-api-nz-mega-object ^7
Basic Usage
For downloading the files of a folder on mega, and put them into a folder on your filesystem, please look at the example script.
This library offers an API to see files, and download them, as follows :
The constructor needs the path and key to access mega.
MegaEndpoint : : __construct(HttpJsonEndpoint $endpoint, string $full_url) : Mega
Once a new MegaEndpoint
object is created, you may search for its root folder with
the method : MegaEndpoint : : getRootNodeInfo() : MegaNode;
Once you have a MegaNode
object, you may search for its children with the
method :
MegaEndpoint : : getChildren(MegaNodeId $node_id) : MegaNode[];
The MegaNodeId
object may be obtained with the MegaNode : getNodeId() : MegaNodeId
method. Node Ids are common objects to refer to specific nodes in a hierarchy,
and the Mega
class may retrieve MegaNode
objects with the method
MegaEndpoint : : getNodeInfo(MegaNodeId $node_id) : MegaNode
.
To separate nodes that represents folders and node that represents files, use
the MegaNode : : getNodeType() : integer
method. If the value is MegaNode : : TYPE_FOLDER
,
then the node represents a folder, and if the value is MegaNode : : TYPE_FILE
,
then it represents a downloadable file.
Then, to download files (folders are not downloadable for obvious reasons),
use the MegaEndpoint : : downloadFile(MegaNode $node) : string
method, that
returns the raw string data of the downloaded file, unencrypted.
Beware that this method does not uses streams directly to your filesystem, and may use a lot of memory if the file is really big.
To check the size of a file (folders have no size given Mega's API), use the
MegaNode : : getNodeSize() : integer
method. Beware that 32 bits system
(or 32 bits php as windows have) may not handle the file sizes for large files
very well.
Finally, almost every method of this library throws PhpExtended\Mega\MegaException
dues to various factors, mainly because cryptographic errors that may occur anywhere.
Remember to encapsulate calls to this library with try
{ ... } catch(MegaException $e) { ... }
blocks.
License
MIT (See license file).