More basic examples

Author: phpfui

README.md

@@ -33,6 +33,8 @@ $pdo = new \PHPFUI\ORM\PDOInstance($yourConnectionString);
 \PHPFUI\ORM::addConnection($pdo);
 ```
 
+See some basic usage examples in [scripts/examples.php](<https://github.com/phpfui/ORM/blob/main/scripts/examples.php>)
+
 ### Active Record Example
 ```php
 $book = new \App\Record\Book();

composer.json

@@ -17,7 +17,7 @@
         "psr/log": "^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "<=11.99",
+        "phpunit/phpunit": "<=12.0",
         "phpfui/phpunit-syntax-coverage": "^1.0",
         "roave/security-advisories": "dev-latest",
         "friendsofphp/php-cs-fixer": "*",
@@ -28,6 +28,9 @@
         "psr-4": {"PHPFUI\\": "src/PHPFUI/"}
     },
     "autoload-dev": {
-        "psr-4": {"Fixtures\\": "tests/Fixtures/"}
+        "psr-4": {
+            "Fixtures\\": "Tests/Fixtures/",
+            "Tests\\App\\": "Tests/App/"
+        }
     }
 }

scripts/examples.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * Usage examples
+ *
+ * You must run unit tests first to generate the models
+ */
+
+include __DIR__ . '/../vendor/autoload.php';
+
+// create the PDO object to use
+$pdo = new \PHPFUI\ORM\PDOInstance('sqlite:' . __DIR__ . '/../northwind/northwind.db');
+
+// register the PDO object with the ORM
+\PHPFUI\ORM::addConnection($pdo);
+
+// Set model directories
+\PHPFUI\ORM::$namespaceRoot = __DIR__ . '/..';
+\PHPFUI\ORM::$recordNamespace = 'Tests\\App\\Record';
+\PHPFUI\ORM::$tableNamespace = 'Tests\\App\\Table';
+\PHPFUI\ORM::$migrationNamespace = 'Tests\\Fixtures\\Migration';
+
+// specify the related record id format
+\PHPFUI\ORM::$idSuffix = '_id';
+
+// add English translations for the error messages
+\PHPFUI\ORM::setTranslationCallback(\PHPFUI\Translation\Translator::trans(...));
+\PHPFUI\Translation\Translator::setTranslationDirectory(__DIR__ . '/../translations');
+\PHPFUI\Translation\Translator::setLocale('en_US');
+
+// Simple select example
+$customerTable = new \Tests\App\Table\Customer();
+
+echo "\n\nCustomers in default data order:\n\n";
+foreach ($customerTable->getRecordCursor() as $customer)
+	{
+	echo "{$customer->first_name} {$customer->last_name}, {$customer->job_title}\n";
+	}
+
+$customerTable->addOrderBy('last_name');
+echo "\n\nCustomers in last_name order:\n\n";
+foreach ($customerTable->getRecordCursor() as $customer)
+	{
+	echo "{$customer->first_name} {$customer->last_name}, {$customer->job_title}\n";
+	}
+
+$customerTable->addOrderBy('last_name', 'desc');
+$customerTable->setLimit(10);
+
+echo "\n\nLast 10 Customers in last_name order:\n\n";
+foreach ($customerTable->getRecordCursor() as $customer)
+	{
+	echo "{$customer->first_name} {$customer->last_name}, {$customer->job_title}\n";
+	}
+
+$customerTable->setLimit(0);
+$customerTable->addGroupBy('company');
+$customerTable->addSelect(new \PHPFUI\ORM\Literal('count(*)'), 'count');
+$customerTable->addSelect('company');
+$customerTable->setOrderBy('company');
+echo "\n\nCount of Customers by company:\n\n";
+
+foreach ($customerTable->getDataObjectCursor() as $customer)
+	{
+	echo "{$customer->company}: {$customer->count}\n";
+	}
+
+
+$orderTable = new \Tests\App\Table\Order();
+// addJoin defaults to using the primary key of the related table
+$orderTable->addJoin('customer');
+$orderTable->addJoin('employee');
+$orderTable->addJoin('order_status');
+
+echo "\n\nOrders with customer, employee and order status joins:\n\n";
+foreach ($orderTable->getDataObjectCursor() as $order)
+	{
+	echo "Order {$order->order_id}: Sold to: {$order->company} Sold by: {$order->first_name} {$order->last_name}, Status: {$order->order_status_name}\n";
+	}
+
+