YetORM – kvaziORM nad Nette\Database

Verze 2.0.0

• GitHub
• přepsáno pro Nette 2.1
• zavrženy magické gettery/settery (IDE stejně neumí napovědět, ani navést na místo definice)
• verze 1.x ve zvláštní větvi

Pokud narazíte na nějakou chybu, neváhejte ji nahlásit. Díky a ať vám nástroj slouží.

Editoval uestla (5. 1. 2014 4:25)

Na NDB je to v podstatě postavené. Je možné, že k něčemu podobnému, co popisuješ, dochází. Nemáš nějaký minimální „skeleton“, ve kterém je tohle chování demonstrované?

Je pravda, že na takhle složitější věci se takovéhle nástroje, které nejsou schopné zajistit integritu jednotlivých instancí (není tu IdentityMap ani podobné patterny), příliš nehodí. Komplikace podobného typu holt nelze řešit jinak než ručním ohlídáním v aplikaci…

Ahoj, můžu mít dotaz, proč je metoda __call v YetORM\Entity označena jako final? Bohužel je to pro mě poněkud omezující.

Verze 5

• GitHub (diff oproti verzi 2)
• přepsáno pro Nette 2.2 (upraveny závislosti pouze na potřebných částech Nette)
• lepší pojmenování metod a proměnných (vizte prosím commity)
• odstraněny všechny nadbytečné metody z Entity (zůstaly pouze magické metody, toRecord() a kešovaná reflexe)
• změněn zápis anotace mapovaného sloupce z $<property> -> <column> na $<property>:<column>
• odebrána magická detekce entitní třídy a tabulky na základě názvu třídy repozitáře – entitní třídu i tabulku je nutno specifikovat vždy
• přidána zkratka Repository::transaction($callback) pro transakci
• odstraněno final všude, kde to mělo smysl :-)
• přístup k neinicializovaným hodnotám na Record vyhodí výjimku

Rád bych napsal nějaký jednoduchý ukázkový tutoriál (asi vyjdu z modelu v dokumentaci) a přidal to do doplňků…

Pokud narazíte na nějakou chybu, neváhejte ji nahlásit. Díky a ať vám nástroj slouží.

@Zax: Osobně u svých entit moc anotační zápis propert nepoužívám – jednak je takový neohrabaný, IDE mi sice napoví, ale navenek se to tváří jako že zapisuju do public property třídy, ale hlavně když chci nějakou složitější logiku, tak jediná rozumná možnost je si ten getter/setter napsat.

Navíc zápis @property Author $author:author by nakonec potřeboval i syntaxi pro případ, kdyby byl autor navázán na tabulku author ještě jiným sloupcem (např. maintainer_id v ukázce v dokumentaci) – a to už si raději to $this->record->ref('author', 'maintainer_id'); napíšu…

V tomhle směru tedy anotace moc rozšiřovat neplánuji.

Můj úmysl byl okleštit entitní třídu na minimum, což se mi jakž takž povedlo (žádné nadbytečné metody, které by mohly způsobovat zbytečné kolize). Mám napsáno něco na způsob lazy bindingu hodnot vč. podpory validace, ale je to zatím v raném stádiu a kdo ví, jestli to někdy dospěje použitelného konce…

V tuhle chvíli si YetORM zachoval svoji naivitu a jednoduchost – mj. i v nedořešeném přidávání/odebírání entitních vazeb do/z kolekce (odkazované řešení se mi taky nelíbí, ale dokážu s tím žít). Takže i když knihovnu plánuji samozřejmě postupně zlepšovat, tak jsem zatím spokojen :-)

Sypu si popel na hlavu. Oháním se tu cílením na code completion v IDE nástrojích, a přitom nesmyslně změním zápis anotace mapovaného sloupce (resp. alespoň NetBeans napovídají property jako celou, tj. včetně dvojtečky – v novém hloupém zápisu totiž nejsou mezery).

Rozhodl jsem se tedy zápis vrátit zpět na šipkový – byl jsem tedy nucen v rámci udržení nějaké sémantičnosti verzování zvýšit verzi na 6. Omlouvám se za případné komplikace ;-)

YetORM je low-level jako prasátko, logiku ohledně mutací aj. (prostě vyvoněný steak) si člověk musí vyrobit sám – ať už předáváním aktuální lokálie do entity, nebo řešením parametrizovaných getterů/setterů (getTitle($lang), apod.) :-)

Zdravím,

Jelikož hodně používám YetORM i když je svým způsobem primitivní ale dostačující i na velké aplikace, tak jsem narazil na problém jak nejrychleji vytvořit repozitáře a entity z databáze. Proto jsem si vytvořil velice primitivní script který tohle udělá. Pokud tedy máte 10 a více tabulek tak se vám tento script bude třeba hodit. Script stačí nahrát někde kde je možné ho spustit. Pak nastavit připojení k požadované databázi a spustit. Script pak vytvoří adresáře models a models/entity kam vygeneruje patřičné třídy. Nehodící se třídy pak jednoduše smáznete.

yetorm-build.php

<?php

/**
 * Vytvoření repozitářů a entit z tabulek databáze.
 *
 * @filesource	yetorm-build.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 */
/** Databázový ovladač */
define('DB_DRIVER', 'mysql');

/** Adresa SQL serveru */
define('DB_HOST', 'localhost');

/** Název databáze */
define('DB_NAME', 'nazevdatabaze');

/** Přihlašovací jméno */
define('DB_USER', 'root');

/** Přihlašovací heslo */
define('DB_PASSWORD', 'root');

/** Namespace tříd */
define('NS', 'App\\');

// Přípojení do databáze,
$db = new PDO(DB_DRIVER . ':host=' . DB_HOST . ';dbname=' . DB_NAME, DB_USER, DB_PASSWORD, array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES UTF8'));

// Načtení názvu tabulek,
$tables = array();

foreach ($db->query('SHOW TABLES')->fetchAll(PDO::FETCH_COLUMN) as $table) {

	$name = implode('', array_map(function($word) {
				return ucfirst($word);
			}, explode('_', $table)));

	$cols = array();

	foreach ($db->query("DESCRIBE `$table`") as $col) {
		$cols[$col['Field']] = '@property' . (strtolower($col['Extra']) == 'auto_increment' ? '-read' : NULL)
				. ' ' . getColType(strtolower($col['Type'])) . (strtolower($col['Null']) == 'yes' ? '|NULL' : NULL)
				. ' $' . $col['Field'] . "\n";
	}

	$tables[$name] = array(
		$table => $cols,
	);
}

// Generování tříd,
if (count($tables)) {
	foreach (array('\models', '\models\entity') as $path) {

		if (!file_exists(__DIR__ . $path)) {
			mkdir(__DIR__ . $path);
		}
	}

	foreach ($tables as $className => $table) {

		foreach ($table as $name => $cols) {

			// Repozitář,
			$properties = " * @table $name\n * @entity \\" . NS . 'Models\Entity\\' . $className;
			$buffer = "namespace " . NS . "Models\\Repository;\n\n/**\n$properties\n */\nfinal class $className extends \\" . NS . "Models\\Repository\\BaseRepository\n{\n\n}";
			file_put_contents(__DIR__ . '/models/' . $className . 'Repository.php', "<?php\n\n$buffer\n");

			// Entita,
			$properties = ' * ' . implode(' * ', $cols);
			$buffer = "namespace " . NS . "Models\\Entity;\n\n/**\n$properties */\nfinal class $className extends \\" . NS . "Models\\Entity\\BaseEntity\n{\n\n}";
			file_put_contents(__DIR__ . '/models/entity/' . $className . 'Entity.php', "<?php\n\n$buffer\n");
		}
	}
}

/**
 * Detekce typu sloupce
 * @param string $type typ sloupce
 * @param array $outputArray
 * @return string
 */
function getColType($type, $outputArray = NULL)
{
	preg_match("/\w+/", $type, $outputArray);

	$types = array(
		'string' => array('varchar', 'text'),
		'\Nette\Utils\DateTime' => array('datetime'),
	);

	foreach ($types as $_type => $array) {

		if (in_array(strtolower(trim($outputArray[0])), $array)) {
			$outputArray[0] = $_type;
			break;
		}
	}

	return $outputArray[0];
}

Ještě jednou upozorňuji, že se jedná o velice primitivní script. Nakládat sním můžete dle uvážení.

Editoval webdata (10. 9. 2014 23:56)

Takže asi jsem objevil bug a to v poslední verzi. Jsem tak kapánek zvyklej dělat komenty. Takže to co mě šlo v předchozí verzi už teď nejde. Takže tohle v předposlední verzi šlo:

<?php

namespace App\Model\Repository;

/**
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 *
 * @table centre
 * @entity \App\Model\Entity\Centre
 */
final class Centre extends \App\Model\Repository\BaseRepository
{
.
.
.
}

Teď to hlásí (výpis s tracy řádek 175)

165:        {
166:            return $this->database->table($table === NULL ? $this->getTableName() : $table);
167:        }
168:
169:
170:        /** @return string */
171:        final protected function getTableName()
172:        {
173:            if ($this->table === NULL) {
174:                if (($annotation = static::getReflection()->getAnnotation('table')) === NULL) {
175:                    throw new Exception\InvalidStateException("Table name not set.");
176:                }
177:
178:                $this->table = $annotation;
179:            }

Když to upravím takto:

/**
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 */

/**
 * @table centre
 * @entity \App\Model\Entity\Centre
 */
final class Centre extends \App\Model\Repository\BaseRepository
{
.
.
.
}

Tak to valí. Ale mě se to nelíbí. Některé komentáře jsou klíčové, protože na projektu dělá více lidí.

PS: to same plati i pro entity.

Editoval webdata (9. 9. 2014 23:15)

Bohužel ani toto nepomohlo:

/**
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 * @table centre
 * @entity \App\Model\Entity\Centre
 */

100% to šlo v 6.0.3 v 7.0.0 si nejsem jistej a teď používám 7.0.1

Tam to vypadá, že to proste musí bejt hned na začátku po /** protože tohle pak funguje

/**
 * @table centre
 * @entity \App\Model\Entity\Centre
 *
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 */

Takže ještě jedno zjištění.

Používám Nette 2.2.3. A poslední verzi YetORM 7.0.1.

Tohle prostě reflexe v nette (AnnotationsParser) nezvládne:

/**
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 *
 * @table centre
 * @entity \App\Model\Entity\Centre
 */

dump výsledku static::getReflection()->getAnnotations()

array (1)
description => array (1)
0 => "Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 *
 * @table centre
 ... " (185)

Ale pokud to upravím takto, tak to jede v pohodě.

/**
 * @jednoco Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 *
 * @table centre
 * @entity \App\Model\Entity\Centre
 */

dump výsledku static::getReflection()->getAnnotations()

array (6)
jednoco => array (1)
0 => "Repozitář středisek." (23)
filesource => array (1)
0 => "CentreRepository.php" (20)
author => array (1)
0 => "© Web Data Studio, www.web-data.cz" (35)
version => array (1)
0 => "1.0.0" (5)
table => array (1)
0 => "centre" (6)
entity => array (1)
0 => "\App\Model\Entity\Centre" (24)

Nette reflexe (AnnotationsParser) z nějakého důvodu to nezvládne parsovat.

zatím řeším takto (kvuli APIgen – komentář do dokumentace)

/**
 * @table centre
 * @entity \App\Model\Entity\Centre
 *
 * Repozitář středisek.
 *
 * @filesource	CentreRepository.php
 * @author		© Web Data Studio, www.web-data.cz
 * @version		1.0.0
 */

Editoval webdata (10. 9. 2014 14:16)

Nejdřív bych rád aspoň zreplikoval chybu, než zakládal issue, která může být neopodstatněná (a navíc chybu bych spíš předpokládal u YetORM než u Nette). Jelikož ale i s phpDocem uvedeným nahoře mi testy procházejí, tak mě napadá, že by chyba mohla být jen v kódování, které by třeba AnnotationParser nezvládl…

Máš ty skripty v utf8, @webdata ?

Takže chyba na mé straně. A docela záludná a způsobená asi nějakým bugem v MATRIXu. To UTF-8 mne nakoplo. Dělám v NetBeans a ještě nikdy jsem neměl problém že by soubor nebyl v UTF-8. Hned jsem to teda zkontroloval. Bohu dík soubor měl kódování UTF-8. Tak v čem je problém? Ješte jsem to otevřel ve Far Manager Viewer jako HEX a potom jsem to uviděl.......

Konec řádku byl jako 0×0D místo 0×0A …

Takže moje chyba.

Editoval webdata (10. 9. 2014 23:58)

Zde je odkaz na script co z tabulek v databázi vytvoří repository a entity třídy.

yetorm-builder.php

Record uvnitř entity je obálka nad instancí Nette\Database\Table\ActiveRow, a je to z důvodu pozdější manipulace se změněnými hodnotami při persistování. Duplikovat si hodnoty do privátních proměnných můžeš v custom [gs]etterech, je to ale IMHO zbytečnost, když už jsou v $recordu (pokud nevyžaduješ nějakou jinou logiku).

Ještě bych měl jeden dotaz. Rozjíždím nový projekt. Takže chci implementovat YetORM a mám nejnovější sandobox Nette 2.2.7 tuším (na stránkách je 2.2.6, ale composer myslím tahal 7).

Presenter

namespace App;

class TestPresenter extends BasePresenter
{
    private $u;

    public function inject( testRepository $u)
    {
        $this->u = $u;
    }

    public function renderDefault()
    {
        $users = $this->u;

        /* @var $user UzivatelEntity */
        foreach ($users->findAll() as $user)
        {
            echo $user->id . '<br/>';
        }
        die();
    }
}

Repositář

namespace App;

/**
 * @table  uzivatel
 * @entity \App\UzivatelEntity
 */
class testRepository extends \YetORM\Repository
{}

Entita

namespace App;

/**
 * @property-read int $id
 * @property string $nick
 */
class UzivatelEntity extends \YetORM\Entity
{
    function getTest()
    {
    }
}

Když to mám takhle tak skript skončí chybou Class name must not be empty., předpokládám, že to nějak souvisí s YetORM Repository řádek 194. Který čte anotace a tam vyhazuje tu výjimku. Pokud smažu funkci getTest() nebo ji přejmenuji na gTest(), tak vše funguje dobře a presenter vypíše ID všech záznamů. Takže pokud v entitě nepoužívám funkce s prefixem get je to v pořádku. Přišel jsem na to náhodou, když jsem přidával Grido, které nevolá getFunkce().
Protože v případě, že definuji funkci getTitle(), tak s ní můžu pracovat pokud jí nastavím aby vracela příslušný záznam z $this->record. Ale poté už nefunguje klasické $user->title.

Dělám něco špatně nebo proč to tak funguje? Rád bych přistupoval k proměnným „obyčejně“ $user->title a k těm speciální třeba $user->getArticles(). Vlastně jako je to v příkladu na Gitu. Ale jak definuji nějakou funkci s tím prefixem get → každé volání $user->title skončí chybou.

Díky za nakopnutí, ať už bolestivé nebo správným směrem.

To jsem zkoušel. Výsledek byl stejný. Ano na to jsem koukal. Zvláštní je, že výjimka vyskočí až z Nette. Nesouvisí to tedy nějak s DI?

Zapomněl jsem to napsat, že jsem zkoušel zápisy i přes protected proměnné a také bez namespace. Bez namespace to funguje stejně. Resp.

	protected $entity = 'UzivatelEntity';

Ale jak mi to hlásilo prázdnou třídu, tak jsem tam radši dal absolutní cestu. Je to strašně zvláštní chyba právě. Objevil jsem ji jinde, ale nejdříve jsem to ještě zkusil na sandboxu, než jsem to sem dal. To jsou právě jen ty test skripty.

dump(\App\testRepository::getReflection()->getAnnotation(‚table‘));

"uzivatel" (8)

$users = $this->u;
dump($users::getReflection()->getAnnotation(‚table‘));

"uzivatel" (8)

Takže předpokládám, že přes DI to probublá ok. To samé jde i pro getAnnotation(‚entity‘).

No, já jsem kvůli tomu stáhnul komplet nový sandbox. Protože na rozdělaném projektu jsem tam měl moc věcí okolo (baseEntity, baseRepository apod.). A zkusil to co „nejhloupěji“ na něm. Asi se podívám i na Git jaké jsou verze YetORM a Nette. A nebo po práci si to vyzkouším ještě doma. Ale je to opravdu opravdu zvláštní chyba/chování. :)

Případně uploadnu čistý sandbox s těmi 3 soubory někam.

Tak už vím. Chyba nebyla v Repository, ale v reflexi, kde se skenují get*() metody v entitě a hledá se návratový typ podle @return anotace, která ti v entitě chyběla – což by ale nemělo končit chybou, uznávám.

Mělo by to být opraveno v nové verzi.

Klasicky jako anotaci před metodou

/** @return int */
function getID()
{
	return $this->record->id;
}

Striptérku můžeš poslat přes PayPal, třeba přes link tady vpravo (pokud nemáš AdBlock).

Ještě mi napadá jeden dotaz: (sorry že jsem otravný)

Vycházejme z tohohle kódu, co jsem již odeslal. Pokud tohle změním:

/**
 * @property int $id
 * @property string $title
 */
class TestEntity extends \YetORM\Entity
{
    function getTest()
    {
        //smazat a funguje
    }
}

Přepíši funkci getTest() na getId():

	function getId()
{
		return 'striptérka-' . $this->id;
}

Tak procházení foreach v presenteru skončí chybou na $entita->id. A to jen v případě, že se funkce get jmenuje stejně jako volaná proměnná.

Cannot read an undeclared property App\TestEntity::$id.

Tedy není možnost přistupovat k entitě přes $entita->id a zároveň mít v entitě funkci getId(). Může to být matoucí v mém projektu a tyhle dva výsledky mohou vracet dvě různé hodnoty na stejný objekt (pokud bude v getId() nějaká funkčnost). Tohle řešení by fungovalo:

	function _getId()
{
	return 'striptérka-' . $this->id;
}

Je to chyba nebo feature?

Editoval kzk_cz (7. 1. 2015 10:55)

Jasně tomu rozumím.

Já bych jen rád měl v entitě funkci, kterou si napíši sám i přestože už tam mám @property int $id.

function getId(){}

To možné tedy není?

Možné to je, ale každá věc pak logicky bude vracet něco jiného (property vs. metoda).

Nullable done.