PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Con vertor   Bitmessage PHP Class   README.md   Download  
File: README.md
Role: Documentation
Content type: text/plain
Description: Documentation
Class: Bitmessage PHP Class
Send control commands to a BitMessage P2P server
Author: By
Last change: update README
Date: 4 years ago
Size: 2,701 bytes
 

Contents

Class file image Download
[![Stories in Ready](https://badge.waffle.io/Conver/class.bitmessage.php.png?label=ready&title=Ready)](https://waffle.io/Conver/class.bitmessage.php) Bitmessage PHP Class ==================== [Bitmessage](https://bitmessage.org/) PHP Class to control PyBitmessage daemon using xmlrpc Release Information --------------- This repo contains in-development code for future releases. To download the latest stable release please visit the [release](https://github.com/Conver/class.bitmessage.php/releases) page. Requirements --------------- php5-xmlrpc php5-curl Getting Started --------------- 1. Make sure php5-xmlrpc & php5-curl is installed and loaded `apt-get install php5-xmlrpc php5-curl` `service apache2 restart` 2. Include class.bitmessage.php into your PHP script: `require_once('curl.php');` `require_once('class.bitmessage.php');` 3. Initialize Bitmessage connection/object: `$bitmessageObj = new bitmessage("<RPCusername>:<RPCpassword>@<RPChost>:<RPCport>/");` Optionally, you can turn off the class stt protocol (HTTP and HTTPS). Default protocol is http. `$bitmessageObj = new bitmessage("<RPCusername>:<RPCpassword>@<RPChost>:<RPCport>/", "http");` 4. Make calls to Bitmessage daemon as methods for your object. Examples: `$bitmessageObj->newAddress($label, $eighteenByteRipe = false, $totalDifficulty = 1, $smallMessageDifficulty = 1);` `$bitmessageObj->setStrip(true);` `$bitmessageObj->broadcast($address, $title, $message);` Features ======== * Automatic Decoding * Automatic HTML strip * Support SSL over HTTPS * Clean arrays (JSON decoded) Contributing ============ You can contribute to this project in different ways: * Report outstanding issues and bugs by creating an [Issue](https://github.com/Conver/class.bitmessage.php/issues/new) * Suggest feature enhancements via our [Forum Thread](https://bitmessage.org/forum) on bitmessage forum * Fork the project, create a branch and file a pull request to improve the code itself LICENSE --------------- Copyright (C) 2014 - 2014 Convertor This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>