rkirkels/codedump_io

CodeDump.io API的PHP客户端

1.0.0 2015-08-16 15:24 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:03:53 UTC


README

CodeDump.io API的PHP客户端

什么是CodeDump.io?

CodeDump.io是一个网站,程序员可以将其喜欢的任何代码或配置以任何他们希望的语言“倾倒”出来,以便其他程序员从中受益。

此客户端做什么?

CodeDump.io-API-client-PHP提供与CodeDump.io API通信所需的一切

  • 从源文件字符串上传代码
  • 请求可用语言
  • 请求可用访问类型

如何安装此客户端?

可以使用Composer轻松安装客户端

"require": { "rkirkels/codedump_io": "dev-master" }

先决条件

为了使用此客户端,您需要

  • CodeDump.io的一个(免费)账户以获取您的API密钥和密钥。
  • 已安装PHP-cURL模块。

如何在代码中使用此客户端?

客户端可以作为一个新对象实例化

$client = new \codedump_io\CodeDumpClient(<apiKey>,<apiSecret>);

或作为一个单例

$client = \codedump_io\CodeDumpClient::getInstance(<apiKey>,<apiSecret>);

API密钥和密钥也可以在src/CodeDumpClient.php文件中定义,因此您在实例化时无需提供它们。

示例代码

$client = \codedump_io\CodeDumpClient::getInstance(<apiKey>,<apiSecret>);

// Get all available languages:
$client->command('languages/get');
$languages = $client->response();

// Get all access types:
$client->command('access/get');
$accessTypes = $client->response();

// Post some PHP code:
$title = 'Some cool title for your code dump';
$description = 'Some text to describe your piece of code.'; // You can use EOL characters if needed
$code = '<?php phpinfo(); ?>'; // Your actual code
$accessType = 'public';
$language = "PHP";

$linkToCodeDump = $client->addCode($title, $description, $code , $accessType, $language);

// Post code from a file:
$title = 'Some cool title for your code dump';
$description = 'Some text to describe your piece of code.'; // You can use EOL characters if needed
$file = 'file_containing_code.php';
$accessType = 'public';
$language = "PHP";

$linkToCodeDump = $client->addCodeFromFile($title, $file, $description, $accessType, $language);