Skip to content

Latest commit

 

History

History
488 lines (390 loc) · 9.66 KB

yorm.md

File metadata and controls

488 lines (390 loc) · 9.66 KB

Yorm ORM

Mini-ORM für YForm ORM = Object-relational mapping = Objektrelationale Abbildung

YOrm ohne eigene Model Class verwenden

Hole alle Daten der Tabelle rex_my_table und zeige das Objekt.

$items = rex_yform_manager_table::get('rex_my_table')->query()->find();
dump($items);

YOrm mit eigener Model Class verwenden

Hinweis: Eine eigene Model Class ist nicht zwingend erforderlich, vereinfacht das Ansprechen der Tabelle mittels der OO-Notation.

Es stehen folgende Klassen zur Verfügung:

  • rex_yform_manager_dataset
  • rex_yform_manager_collection
  • rex_yform_manager_query

Klasse erstellen

Zunächst wird eine Klasse erstellt und in das project AddOn im Ordner lib abgelegt

<?php
class MyTable extends \rex_yform_manager_dataset
{
}

Klasse registrieren

Jetzt muss die erstellte Klasse noch registiert werden. Dazu öffnet man die Datei boot.php des project AddOns und fügt nachfolgenden Code ein. Wird das theme-Addon verwendet, den Code in die Datei functions.php einfügen.

rex_yform_manager_dataset::setModelClass('rex_my_table', MyTable::class);

Nun kann man alle Daten wie folgt holen:

$items = MyTable::query()->find();

Praxis-Beispiele

$items = MyTable::query()
            ->alias('t')
            ->joinRelation('relation_id', 'r')
            ->select('r.name', 'relation_name')
            ->where('t.status', '1')
            ->orderBy('t.name')
            ->find();

$item = MyTable::create()
              ->setValue('user_id', 5)
              ->setValue('article_id', 6)
              ->save();;

MyTable::query()
                ->where('user_id', 5)
                ->where('article_id', 6)
                ->find()
                ->delete();

<?php

$table = rex_yform_manager_table::get('rex_data_product');

$products = $table->query()
    ->joinRelation('category_id', 'c') // Join auf rex_data_product_category gemäß Relationsfeld category_id, mit Alias "c" für weitere Verwendung
    ->select('c.name', 'category_name') // Aus der gejointen Tabelle den Kategorienamen mit auslesen mit Alias "category_name"
    ->where('status', 1)
    ->find();

foreach ($products as $product) {
    echo $product->name;
    echo $product->category_name; // Value aus der gejointen Tabelle, siehe oben

    // Alternativ das komplette Objekt für die Kategorie auslesen
    $category = $product->getRelatedDataset('category_id');
    echo $category->name;
}

Datensatz abfragen

<?php
    $post = rex_yform_manager_dataset::get($id, 'rex_blog_post');  
?>  
<article>
    <h1><?= $post->title ?></h1>
    <p><?= $post->text ?></p>
</article>

Datensatz ändern

<?php
$post = rex_yform_manager_dataset::get($id, 'rex_blog_post');
$post->title = 'REDAXO-Tag in Wackershofen (am Grundbach)';
$post->text = '...';

if ($post->save()) { 
    echo 'Gespeichert!';
} else {
    echo implode('<br>', $post->getMessages());
}

Datensatz erstellen

<?php
$post = rex_yform_manager_dataset::create('rex_blog_post');
$post->title = 'REDAXO-Tag in Wackershofen (am Grundbach)'; 
$post->text = '...';

if ($post->save()) {
    echo 'Gespeichert!';
} else {
    echo implode('<br>', $post->getMessages());
}

Eigene Modelklassen

<?php
// boot.php  
rex_yform_manager_dataset::setModelClass(  
    'rex_blog_author',  
    rex_blog_author::class  
);  

<?php
// lib/post.php 
class rex_blog_post extends rex_yform_manager_dataset 
{ 
     
}

oder

<?php  
  
// boot.php  
rex_yform_manager_dataset::setModelClass(  
    'rex_blog_author',  
    rex_blog_author::class  
);  
  
// lib/author.php 
class rex_blog_author extends rex_yform_manager_dataset 
{ 
    public function getFullName(): string 
    { 
        return $this->first_name.' '.$this->last_name; 
    } 
} 
 
// Template 
$author = rex_blog_author::get($id); 
echo $author->getFullName();

Query-Klasse

<?php  

$query = rex_blog_post::query();  

$query  
->where('status', 1)  
->where('created', $date, '>')  
->orderBy('created', 'desc')  
; 

$posts = $query->find(); 

// $post = $query->findOne();

Collection-Klasse

<?php  

$query = rex_blog_post::query();  

// $query->...  

$posts = $query->find();  

foreach ($posts as $post) { 
echo $post->title; 
echo $post->text; 
}

<?php  

$posts->isEmpty();  
$posts->getIds();  
$posts->toKeyIndex();  
$posts->toKeyValue('title', 'text');  
$posts->getValues('title');  
$posts->groupBy('author_id');  
$posts->setValue('author_id', $authorId); 
$posts->save(); 
$posts->delete();

Relationen

<?php  

foreach ($posts as $post) {  
$author = $post->getRelatedDataset('author_id');  

echo 'Autor: '.$author->getFullName();  

echo $post->title;  
} 
 
<?php  

$posts = $author->getRelatedCollection('posts'); 

<?php  

$query = rex_blog_post::query();  

$query  
->joinRelation('author_id', 'a')  
->selectRaw(  
'CONCAT(a.first_name, " ", a.last_name)',  
'author_name' 
); 

$posts = $query->find(); 

foreach ($posts as $post) { 
echo 'Autor: '.$post->author_name; 
}

Paginierung

Beispiel 1

<?php  

$pager = new rex_pager(20);  

$query = rex_blog_post::query();  
//$query->...  

$posts = $query->paginate($pager);  

foreach ($posts as $post) { 
// ... 
} 

$pager->getRowCount(); 
$pager->getCurrentPage(); 
$pager->getLastPage(); 
$pager->getPageCount();

Beispiel 2

$pager = new rex_pager(10);
$table = rex_yform_manager_table::get('rex_table_name');
$ergebnisse = $table->query()
    ->paginate($pager);
$fragment = new rex_fragment();
$fragment->setVar('urlprovider', rex_article::getCurrent());
$fragment->setVar('pager', $pager);
echo $fragment->parse('core/navigations/pagination.php');

foreach ($ergebnisse as $erg) {
echo "ID: ".$erg->id;
}
echo $pager->getRowCount();
echo $pager->getCurrentPage();
echo $pager->getLastPage();
echo $pager->getPageCount();

Formulare

<?php  

$post = rex_blog_post::get($id);  

$yform = $post->getForm();  

// $yform->setHiddenField();  
// $yform->setObjparams();  

echo $post->executeForm($yform)

Methoden-Referenz

collection-Methoden

  • delete
  • executeForm
  • getForm
  • getIds
  • getTable
  • getTableName
  • getUniqueValue
  • getValues
  • groupBy
  • isEmpty
  • isValid
  • isValueUnique
  • populateRelation
  • save
  • setData
  • setValue
  • toKeyIndex
  • toKeyValue

query-Methoden

  • Alias
    • alias
    • getTableAlias
  • count
  • exists (liefert true oder false zurück. Optimal für große Abfragen.)
  • Find
    • find
    • findId
    • findIds
    • findOne (liefert einen Datensatz als Objekt zurück.)
  • Get
    • get
    • getAll
  • Group By
    • groupBy
    • groupByRaw
    • resetGroupBy
  • Join
    • joinRaw
    • joinRelation
    • joinType
    • joinTypeRelation
    • leftJoin
    • leftJoinRelation
    • resetJoins
  • Limit
    • limit
    • resetLimit
  • Order By
    • orderBy
    • orderByRaw
    • resetOrderBy
  • paginate (Beispiel)
  • Query
    • query
    • queryOne
  • save
  • Select
    • resetSelect
    • select
    • selectRaw (lässt individuelle Argumente zu, wie z.B. CONCAT, SUM)
  • Table
    • getTable
    • getTableName
  • Where
    • resetWhere
    • setWhereOperator
    • where
    • whereNested
    • whereRaw

dataset-Methoden

  • create
  • get
  • getAll
  • getData (liefert Felder als Array zurück)
  • getForm (liefert Formular zurück - EXPERIMENTELL!)
  • getId
  • getMessages
  • getRaw
  • getRelatedCollection
  • getRelatedDataset
  • getTable
  • getTableName
  • getValue
  • hasValue
  • isValid
  • loadData

Debugging

Hinweis: Diese Vorgehensweise wird in zukünftigen Versionen optimiert. Beteilige dich aktiv an der Entwicklung auf github.com/yakamara/redaxo_yform/!

Variante 1

Wichtig ist nur der Part mit rex_sql

$query = MyTable::query();
$query
    ->alias('t')
    ->joinRelation('relation_id', 'r')
    ->select('r.name', 'relation_name')
    ->where('t.status', '1')
    ->orderBy('t.name')
$items = rex_sql::factory()->setDebug()->getArray($query->getQuery(), $query->getParams());
$items = $query->find();

Variante 2

Datei /redaxo/src/addons/yform/plugins/manager/lib/yform/manager/dataset.php und die Variable private static $debug = false; auf true setzen