README

一个允许您读取和写入文件的文件组件。

安装

使用以下命令通过composer安装此包

$ composer require plinker/files

客户端

创建客户端实例的方式如下

<?php
require 'vendor/autoload.php';

/**
 * Initialize plinker client.
 *
 * @param string $server - URL to server listener.
 * @param string $config - server secret, and/or a additional component data
 */
$client = new \Plinker\Core\Client(
    'http://example.com/server.php',
    [
        'secret' => 'a secret password'
    ]
);

// or using global function
$client = plinker_client('http://example.com/server.php', 'a secret password');

方法

配置完成后，您可以通过其命名空间调用类及其方法。

列表

列出文件和文件夹。

调用

$result = $client->files->list('./', false, 10);

响应

Array
(
    [/] => Array
        (
            [0] => Array
                (
                    [name] => server.php
                    [type] => file
                    [size] => 706
                )

            [1] => Array
                (
                    [name] => .plinker
                    [type] => folder
                    [size] => 4096
                )

            [3] => Array
                (
                    [name] => user_classes
                    [type] => folder
                    [size] => 4096
                )

            [5] => Array
                (
                    [name] => demo.php
                    [type] => file
                    [size] => 1628
                )

        )

    [/.plinker] => Array
        (
            [2] => Array
                (
                    [name] => crontab.journal
                    [type] => file
                    [size] => 45
                )

        )

    [/user_classes] => Array
        (
            [4] => Array
                (
                    [name] => demo.php
                    [type] => file
                    [size] => 345
                )

        )

)

响应（扩展为true）

Array
(
    [/] => Array
        (
            [0] => Array
                (
                    [name] => server.php
                    [type] => file
                    [size] => 706
                    [info] => Array
                        (
                            [last_access] => 1525369379
                            [change_time] => 1525368118
                            [modified_time] => 1517173011
                            [basename] => server.php
                            [extension] => php
                            [filename] => server.php
                            [group] => 33
                            [owner] => 33
                            [inode] => 3894233
                            [path] => .
                            [pathname] => ./server.php
                            [size] => 706
                            [type] => file
                            [isDir] => 
                            [isExecutable] => 
                            [isFile] => 1
                            [isLink] => 
                            [readable] => 1
                            [writable] => 1
                        )

                )
    // snip..

创建文件

创建/上传文件，如果文件已存在，则会被覆盖。

调用

$result = $client->files->put('./path/to/file.txt', 'the file contents');

响应

number of bytes written to file

获取文件

获取文件。

调用

$result = $client->files->get('./path/to/file.txt');

响应

the file contents

删除文件

删除文件。

调用

$result = $client->files->delete('./path/to/file.txt');

响应

测试

此组件未设置任何测试。

贡献

有关详细信息，请参阅CONTRIBUTING。

安全

如果您发现任何与安全相关的问题，请通过https://cherone.co.uk联系我，而不是使用问题跟踪器。

鸣谢

• Lawrence Cherone
• 所有贡献者

开发鼓励

如果您使用此项目并从中赚钱或希望表达您的感激之情，请随时通过https://www.paypal.me/lcherone捐款，谢谢。

赞助商

让您的公司或姓名在文档中和每个GitHub仓库中列出，有关更多详细信息，请联系我https://cherone.co.uk。

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

有关附加组件的信息，请参阅组织页面。