PHPackages                             sakuraiyuta/fuel-orientdb - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. sakuraiyuta/fuel-orientdb

ActiveLibrary[Database & ORM](/categories/database)

sakuraiyuta/fuel-orientdb
=========================

OrientDB connection manager for FuelPHP

420PHP

Since Feb 10Pushed 13y ago2 watchersCompare

[ Source](https://github.com/sakuraiyuta/fuel-orientdb)[ Packagist](https://packagist.org/packages/sakuraiyuta/fuel-orientdb)[ RSS](/packages/sakuraiyuta-fuel-orientdb/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

fuel-orientdb
=============

[](#fuel-orientdb)

fuel-orientdb is a library for using OrientDB with FuelPHP.

This library is still *experimental*. You should not use for production.

Table of Contents
=================

[](#table-of-contents)

- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [How to use](#how-to-use)
    - [Use raw SQL+ query](#use-raw-sql-query)
    - [Use FuelPHP-like query builder](#use-fuelphp-like-query-builder)
    - [Use raw orientdb-odm Manager](#use-raw-orientdb-odm-manager)
    - [Object-Document mapping](#object-document-mapping)
- [Testing](#testing)
- [See also](#see-also)

Features
========

[](#features)

TODO: implement

Installation
============

[](#installation)

- Install and execute [OrientDB](http://www.orientdb.org).
- Create [FuelPHP](http://fuelphp.com/) project in new directory. (any installation method you can use. ex:use git-clone, download and extract tarball manually)
- Install [composer](http://getcomposer.org).
- In project dir, create `composer.json` file. *Strongly recommended:* set `vendor-dir` value to `fuel/app/vendor`, and set `minimum-stability` to `dev`. (because it uses `doctrine/orientdb-odm` development ver) ex:

```
{
	"config" : {
		"vendor-dir" : "fuel/app/vendor"
	},
	"minimum-stability" : "dev",
	"require" : {
		"sakuraiyuta/fuel-orientdb" : "dev-master"
	}
}
```

- Execute `composer install`. This command downloads the library and dependencies.
- Change permissions `"project-dir"/fuel/app/vendor/sakuraiyuta/fuel-orientdb/tmp` writable for HTTP Server. ex: `chmod 777 "project-dir"/fuel/app/vendor/sakuraiyuta/fuel-orientdb/tmp`
- Modify your application bootstrap. Target file is `"project-dir"/fuel/app/bootstrap.php`. Add some classes to Autoloader in line `Autoloader::add_classes()`. ex:

```
Autoloader::add_classes(array(
	// Add classes you want to override here
	// Example: 'View' => APPPATH.'classes/view.php',
	"Fuel\\Core\\OrientDB" => APPPATH . "vendor/sakuraiyuta/fuel-orientdb/src/Fuel/Core/OrientDB.php",
	"Fuel\\Core\\Database_Orientdb_Connection" => APPPATH . "vendor/sakuraiyuta/fuel-orientdb/src/Fuel/Core/Database_Orientdb_Connection.php",
));
```

- *Optionally*, you can create entity classes for mapping records to objects.
- Finally, you must configure database connection settings.

Configuration
=============

[](#configuration)

You can configure database connection settings using FuelPHP common config file, and also can use `dsn` notation.

Target file is `"project-dir"/fuel/app/config/{development,staging,test,production}/db.php`. ex:

```
return array(
	'default' => array(
		'type'       => 'orientdb',
		'entity_dir' => __DIR__ . '/../test/Entity/',
		'connection'  => array(
			'dsn'        => 'orientdb:host=localhost;dbname=school-manager;port=2480',
			'username'   => 'admin',
			'password'   => 'admin',
		),
	),
);
```

- `$config["default"]["type"]` is regular value `orientdb`. Do not change.
- *Optionally* `$config["default"]["entity_dir"]` is directory read by Object-Document mapper. Default is `"project-dir"/fuel/app/classes/Entity`. See details: [Object-Document mapping](#object-document-mapping)
- `$config["default"]["connection"]["dsn"]` can splits some sections. Expression is `"dbtype":host="yourdbhostname";dbname="yourdbname";port="yourdbport"`.
    - `dbtype` is regular value `orientdb`. Do not change.
    - `host` is your hostname (or IPaddress) working OrientDB.
    - `dbname` is database name you want to use.
    - `port` is a port to connect OrientDB you want to use.
- `$config["default"]["connection"]["username"]` is username you want to use for connecting the database.
- `$config["default"]["connection"]["password"]` is password you want to use for connecting the database.

How to use
==========

[](#how-to-use)

Use raw SQL+ query
------------------

[](#use-raw-sql-query)

You can use SQL+ query provided by OrientDB, in FuelPHP controllers.

*Notice: You can only use SELECT statement. Executing INSERT, UPDATE, and DELETE statement feature is not implemented yet.*

```
// ex: Using FuelPHP DB class.
// In DB class, creates instance Database_Orientdb_Connection and execute query.
// This returns array contains stdClass object. These objects contains properties.
$result = DB::query("SELECT * FROM User");
var_dump($result);
```

Use FuelPHP-like query builder
------------------------------

[](#use-fuelphp-like-query-builder)

```
$result = OrientDB::insert("User")
	->set(
		array(
			"username" => "testuser",
			"password" => "hashedpassword",
		)
	)->execute();
var_dump($result);
```

Use raw orientdb-odm Manager
----------------------------

[](#use-raw-orientdb-odm-manager)

If you want to use a feature, mapping records to object, write as below:

```
// ex: Using raw OrientDB class.
// The class extends FuelPHP DB class (but many methods are not implemented yet).
// This returns array contains User object. These objects are mapped to records.
$result = OrientDB::get_manager()
	->getRepository("User")
	->findAll();
var_dump($result);
```

Object-Document mapping
-----------------------

[](#object-document-mapping)

*You need to create User class for mapping entities.*

Instruction is below:

- Create directory `Entity` in `"project-dir"/fuel/app/classes/`.
    - *Optionally* you can change Entity dir in configuration. See also:[Configuration](#configuration)
- Create Entity file in the directory. ex: `User.php`
- Write details in the Entity file. This needs to include annotations. ex:

```
// Need definition of namespace "Entity" for autoloading.
namespace Entity;

use Doctrine\ODM\OrientDB\Mapper\Annotations as ODM;

/**
* @ODM\Document(class="User")
*/
class User
{
    /**
     * @ODM\Property(name="@rid", type="string")
     */
    protected $rid;

    /**
     * @ODM\Property(type="string", notnull="true")
     */
    protected $username;

    /**
     * @ODM\Property(type="string", notnull="true")
     */
    protected $password;

    public function getUsername()
    {
        return $this->username;
    }

    public function setUsername($username)
    {
        $this->username = $username;
    }

    public function getPassword()
    {
        return $this->password;
    }

    public function setPassword($password)
    {
        $this->password = $password;
    }

    public function getRid()
    {
        return $this->rid;
    }

    public function setRid($rid)
    {
        $this->rid = $rid;
    }
}
```

Testing
=======

[](#testing)

This library uses PHPUnit for testing. If you want to modify, contribute to this, use PHPUnit bootstrap and configuration contains the library. Instruction is below:

- Install this library normally. See details: [Installation](#installation)
- Configure database settings. Copy `config_phpunit/db.php.sample` to `config_phpunit/db.php` and modify settings. PHPUnit uses the configuration for connecting database.
- Check `phpunit.xml` and modify settings if you want.
- Execute `phpunit test` in `fuel-orientdb` directory.

You can use [generator](bin/generate_test.sh) for generating test-class (Needs phpunit-skelgen. you can install with PEAR.)

Directories and files related to testing are below:

```
bootstrap_phpunit.php // bootstrap for PHPUnit. This prepares fixtures PHPUnit allows to call FuelPHP features.
phpunit.xml // This supplies env-variables that includes directory informations.

config_phpunit/ // contains database settings for testing CRUD. written in FuelPHP common config scheme.
├── db.php
└── db.php.sample
test
├── Entity // contains entity-class for testing Object-Document mapping.
│   └── TestClass.php
└── ... // test codes under the directory.

```

See also
========

[](#see-also)

- [FuelPHP](http://fuelphp.com) is a simple, flexible, community driven PHP 5.3+ framework.
- [Composer](http://getcomposer.org) is a tool for dependency management in PHP. Look document and understand auto-loading mechanism in Composer.
- [OrientDB](http://www.orientdb.org) is an Open Source NoSQL DBMS with both the features of Document and Graph DBMS.
- [Doctrine Project](http://www.doctrine-project.org/), for learning a concept ORM and ODM.
- [orientdb-odm](https://github.com/doctrine/orientdb-odm), using in this library.
- [CongowOrient](http://congoworient.readthedocs.org/en/latest/index.html) is a set of PHP libraries in order to use OrientDB from PHP. It's not exactly same as this (or orientdb-odm) library, but mostly looks like to use.
- [Starting to play with the Doctrine OrientDB ODM](http://odino.org/starting-to-play-with-the-doctrine-orientdb-odm/), written by Alessandro Nadalin, is a good article for learning to use the library. (Create project using Smarty framework and raw orientdb-odm library is a precondition, but some paragraph is useful even if using FuelPHP)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/44c3b867d05aeb2a3eaaf4f5f9fc701bd46369ec0414dfa20a86fdd6622895ff?d=identicon)[sakuraiyuta](/maintainers/sakuraiyuta)

---

Top Contributors

[![sakuraiyuta](https://avatars.githubusercontent.com/u/378747?v=4)](https://github.com/sakuraiyuta "sakuraiyuta (37 commits)")

### Embed Badge

![Health badge](/badges/sakuraiyuta-fuel-orientdb/health.svg)

```
[![Health](https://phpackages.com/badges/sakuraiyuta-fuel-orientdb/health.svg)](https://phpackages.com/packages/sakuraiyuta-fuel-orientdb)
```

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database

The Illuminate Database package.

2.8k52.4M9.4k](/packages/illuminate-database)[mongodb/mongodb

MongoDB driver library

1.6k64.0M546](/packages/mongodb-mongodb)[ramsey/uuid-doctrine

Use ramsey/uuid as a Doctrine field type.

90340.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel

Reliese Components for Laravel Framework code generation.

1.7k3.4M16](/packages/reliese-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)