tflori / orm

example.php

<?php

use ORM\EntityManager;

require __DIR__ . '/vendor/autoload.php';

$username = 'user_a'; // $_POST['username']
$password = 'password_a'; // $_POST['password']

/**************************
 * SETUP EXAMPLE DATABASE *
 **************************/
$em = new EntityManager([
    EntityManager::OPT_CONNECTION => new \ORM\DbConfig('sqlite', '/tmp/example.sqlite')
]);

$em->getConnection()->query("DROP TABLE IF EXISTS user");

$em->getConnection()->query("CREATE TABLE user (
  id INTEGER NOT NULL PRIMARY KEY,
  username VARCHAR (20) NOT NULL,
  password VARCHAR (32) NOT NULL
)");

$em->getConnection()->query("CREATE UNIQUE INDEX user_username ON user (username)");

$em->getConnection()->query("INSERT INTO user (username, password) VALUES
  ('user_a', '" . md5('password_a') . "'),
  ('user_b', '" . md5('password_b') . "'),
  ('user_c', '" . md5('password_c') . "')
");

/*********************
 * DEFINE THE ENTITY *
 *********************/

/**
 * Class User
 *
 * The following annotations are optional
 * @property int id
 * @property string username
 * @property string password
 */
class User extends ORM\Entity {}

/*******************************
 * Fetch entity with own query *
 *******************************/
$user = $em->fetch(User::class)

The method setQuery does only exist in ORM\EntityFetcher, but not in ORM\Entity.

    ->setQuery("SELECT * FROM user WHERE username = ? AND password = ?", [$username, md5($password)])
    ->one();

var_dump($user);


/*******************************
 * Fetch with where conditions *
 *******************************/
$user = $em->fetch(User::class)

The method where does only exist in ORM\EntityFetcher, but not in ORM\Entity.

    ->where('username', 'LIKE', $username)
    ->andWhere('password', '=', md5($password))
    ->one();

var_dump($user);

/*******************************************
 * Fetch with parenthesis, group and order *
 *******************************************/
try {
    $fetcher = $em->fetch(User::class)
                  ->where(User::class . '::username LIKE ?', 'USER_A')
                  ->andWhere('password', '=', md5('password_a'))
                  ->orParenthesis()
                      ->where(User::class . '::username = ' . $em->getConnection()->quote('user_b'))
                      ->andWhere('t0.password = \'' . md5('password_b') . '\'')
                      ->close()
                  ->groupBy('id')
                  ->orderBy(
                      'CASE WHEN username = ? THEN 1 WHEN username = ? THEN 2 ELSE 3 END',
                      'ASC',
                      ['user_a', 'user_b']
                  );
    $users = $fetcher->all();

    var_dump($users);
} catch (\PDOException $exception) {
    file_put_contents('php://stderr', $exception->getMessage() . "\nSQL:" . $fetcher->getQuery());
}

/*******************
 * Cache an entity *
 *******************/
$cachedUser = serialize($user);
var_dump($cachedUser);

/******************************
 * Get previously cached User *
 ******************************/
// lets say we cached user3 with password from user1 - so modify the $cachedUser
$cachedUser = str_replace([
    's:1:"1"',
    's:6:"user_a"'
], [
    's:1:"3"',
    's:6:"user_c"'
], $cachedUser);
/** @var User $user */
$user = $em->map(unserialize($cachedUser));
$user = $em->fetch(User::class, 3);
var_dump($user, $user->isDirty(), $user->isDirty('username'));

The method isDirty does only exist in ORM\Entity, but not in ORM\EntityFetcher.

/*********************************
 * Get a previously fetched user *
 *********************************/
// sqlite returns strings and currently we do not convert to int
$user1 = $em->fetch(User::class, 1); // queries the database again
$user2 = $em->map(new User(['id' => 1]));
$user3 = $em->fetch(User::class, 1); // returns $user2
$user4 = $em->map(new User(['id' => '1']));
var_dump($user1->username, $user2->username, $user3 === $user2, $user1 === $user4);

The property username does not exist on object<ORM\Entity>. Since you implemented __get, maybe consider adding a @property annotation.

/********************************
 * Validate data for a new user *
 ********************************/
$data = [
    'username' => 'This username is way to long for a username',
    'password' => null // null is not allowed
];
$result = User::validateArray($data);
echo $result['username']->getMessage() . "\n" . $result['password']->getMessage() . "\n";