library php-on-couch {🖫 683, ⚐ 19, ★ 2}

popojargo/php-on-couch

CouchDB NoSQL database access in PHP

Thursday, October 5, 2017
by popojargo
Repository
1 Watchers
2 Stars
683 Installations

PHP
0 Dependents
0 Suggesters
83 Forks
1 Open issues
19 Versions
1 % Grown

The README.md

, _(*1)

:fire:For the complete documentation, visit http://php-on-couch.readthedocs.io :fire:, _(*2)

Introduction

PHP On Couch tries to provide an easy way to work with your CouchDB documents with PHP., _(*3)

Recent changes

For the complete change list, head over here, _(*4)

Installation and testing

Install the library using composer : composer require php-on-couch/php-on-couch. You can find more detailed informations about installation here., _(*5)

To test the the application, see this topic., _(*6)

Components and documentation

For the full API document, please visite this link, _(*7)

Example

For full examples, refer to the database example or the document example., _(*8)

At first, you need to import the main components through their namespace. If you use composer, I suggest you to use their autoload wich is easy to setup. Otherwise, you can use your own autoload function or a basic require with some namespace escaping., _(*9)

use  PHPOnCouch\CouchClient; //The CouchDB client object

Here's an example for basic operations, _(*10)

// Set a new connector to the CouchDB server
$client = new CouchClient('http://my.couch.server.com:5984', 'my_database');

// document fetching by ID
$doc = $client->getDoc('some_doc_id');
// updating document
$doc->newproperty = array("hello !", "world");
try {
    $client->storeDoc($doc);
} catch (Exception $e) {
    echo "Document storage failed : " . $e->getMessage() . "<BR>\n";
}

Here's a quick example of how to fetch a view, _(*11)

// view fetching, using the view option limit
try {
    $view = $client->limit(100)->getView('orders', 'by-date');
} catch (Exception $e) {
    echo "something weird happened: " . $e->getMessage() . "<BR>\n";
}

Finally, how to use the CouchDocument class., _(*12)

//using couch_document class :
$doc = new CouchDocument($client);
$doc->set(array('_id' => 'JohnSmith', 'name' => 'Smith', 'firstname' => 'John')); //create a document and store it in the database
echo $doc->name; // should echo "Smith"
$doc->name = "Brown"; // set document property "name" to "Brown" and store the updated document in the database

Community

Contributions

Feel free to make any contributions. All contributions must follow the code style and must also comes with valid and complete tests., _(*13)

Help is really appreciated to complete add more tests., _(*14)

Feedback

, _(*15)

Don't hesitate to submit feedback, bugs and feature requests ! Our contact address is phponcouch@gmail.com, _(*16)

The Versions

05/10 2017

dev-feature/deploymentScripts

dev-feature/deploymentScripts https://github.com/PHP-on-Couch/PHP-on-Couch

CouchDB NoSQL database access in PHP

library php-on-couch

CouchDB NoSQL database access in PHP

popojargo/php-on-couch

The README.md

Table of content

Introduction

Recent changes

Installation and testing

Components and documentation

Example

Community

Contributions

Feedback

The Versions

dev-feature/deploymentScripts

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-master

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/fixHttpsProblem

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/migrateDocToSphinx

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

2.0.3

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/replace_coveralls

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/add_test_for_203

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-kl3sk_path2_update

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

2.0.2

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/http_adapter

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté

dev-feature/mango_query

The Requires

The Development Requires

by Clemens Sahs

by Michael Bailly

by Alexis Côté