README

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

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

Features
Installation
Configuration
How to use
Testing
See also

Features

TODO: implement

Installation

Install and execute OrientDB.
Create FuelPHP project in new directory. (any installation method you can use. ex:use git-clone, download and extract tarball manually)
Install composer.
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

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
$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

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

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

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

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
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

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
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 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.

sakuraiyuta / fuel-orientdb

Maintainers

Details