Download the PHP
package sinri/ark-couchdb without Composer
On this page you can find all versions of the php package
sinri/ark-couchdb. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor sinri Package ark-couchdb Short Description The CouchDB component for Ark 2 License
MIT
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
CouchDB is a NoSQL database providing HTTP API to serve clients.
This library provided raw API client (with cURL) and entity class to cover basic use.
Now it is not fully accomplished, only base requirement considered.
Agent
To connect to the CouchDB instance, you must establish an ArkCouchDBAgent class with connection arguments.
Each API request is independent, so you can share this agent instance anywhere in your project.
API Client
All CouchDB APIs are requested through HTTP by cURL.
For the request and response, two class defined, ArkCouchDBRequest and ArkCouchDBResponse.
The two classes are use by the extended classes of ArkCouchDBAbstractApi, which provided a method callApi.
This method receives a request instance and would output a response instance.
Request
You should set request with those properties,
$api; The sub URL for the API.
$method; The constant defined for METHOD.
$headers; The headers, as an associated array.
$queries; The queries, as an associated array.
$body; The body. If type is of a JSON, you can set it as an array or object.
$bodyType; The constant defined for METHOD.
Response
Response is simple, you can get the response HTTP code and headers, and the raw text and parsed json object (as array).
Implemented API
Four kinds of API clients are provided,
Server
Database
Document
DesignDoc
You can check each PHPDoc for use and see the original doc online by reference tag.
Object Entities
Alike PDO, two kinds of object entities designed.
One for database and one for documents.
You must extend them before use.
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package sinri/ark-couchdb contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.