Updated documentation

Author: phpfui

docs/10. Miscellaneous.md

@@ -1,5 +1,8 @@
 # PHPFUI\ORM Miscellaneous
 
+## SQLite Support
+While this library is tested against SQLite, there are differences between MySQL/MariaDB syntax and SQLite syntax. Most notabliy is insertOrUpdate() and insertOrIgnore() which are not supported for SQLite. Use the custom SQL query support below instead.
+
 ## Custom SQL Queries
 **PHFUI\ORM** supports raw string queries for special cases or complex queries.  The following static methods of [\PHPFUI\ORM](http://phpfui.com/?n=PHPFUI&c=ORM) are supported:
 

docs/2. Active Record.md

@@ -44,6 +44,10 @@ $customer->read($value);
 - **insertOrUpdate**()
  * Will try to insert the record and on a duplicate key, will update the record with the current values.
  * insertOrUpdate() returns the same values as insert().
+ * If the record only consists of primary keys, then this method is equivalent to insertOrIgnore().
+- **insertOrIgnore**()
+ * Will try to insert the record and on a duplicate key, will not update.
+ * insertOrIgnore() returns the same values as insert().
 - **read**(int | string | array $find)
  * Will try to load the first record matching the values passed in. If $find is an array, each key is used as a where condition equal to the value.
  * If not an array, read uses $find to search by primary key.

docs/5. Virtual Fields.md

@@ -3,9 +3,13 @@
 
 You can define virtual fields with get and set semantics for any **\App\Record** class. Virtual fields are evaluated before any database field, so you can override the database defaults if needed, or create new functionality.
 
-Every **\App\Record** class has a static $virtualFields array defined. The key of the array is the name of the virtual key.  The value for each virtual field is an array of strings. The first string is the virtual field class name.  Subsequent parameters are are passed the the **getValue** and **setValue** methods.
+Every **\App\Record** class has a static $virtualFields array defined. The key of the array is the name of the virtual key.  The value for each virtual field is an array of strings. The first string is the virtual field class name. Subsequent parameters are are passed the the **getValue** and **setValue** methods.
 
-## One To One and Parent Relationships
+The **VirtualField** class has two properties that will always be defined for use by the derived class:
+* $currentRecord is the current record that the virtual field should be based on.
+* $fieldName the field name that the VirtualField object was created from.  This is the key of the $virtualFields array in the Record class.
+
+## One To One and Parent Related Record Relationships
 If a field is named the same way as a corresponding table and suffixed with the proper ID, **PHPFUI\ORM** will automatically generate a One To One or parent relationship for you.
 
 A child record with an ID field of the parent record automatically has a parent relationship via the build in related record functionality.
@@ -20,6 +24,29 @@ Likewise, the Invoice record has a relationship to its Order record, and from th
 $invoice = new \App\Record\Invoice(7);
 echo $invoice->order->shipper->company;
 ```
+## Custom Related Record Relationships
+Sometimes you can't name a related record with the name of the table.  For example you might have an Employee table, but yet need to have several references to different employees in the same table. You might have the following fields which are all Employee Ids:
+* salesPerson_id
+* packedBy_id
+* inspectedBy_id
+
+You can make them all return employees with the following virtual field definitions:
+```php
+class Order extends \Tests\App\Record\Definition\Order
+	{
+	protected static array $virtualFields = [
+		'salesPerson' => [\PHPFUI\ORM\RelatedRecord::class, \App\Record\Employee::class],
+		'packedBy' => [\PHPFUI\ORM\RelatedRecord::class, \App\Record\Employee::class],
+		'inspectedBy' => [\PHPFUI\ORM\RelatedRecord::class, \App\Record\Employee::class],
+	];
+	}
+```
+### Usage
+```php
+echo 'Sales Person : ' . $order->salesPerson->fullName() . "\n";
+echo 'Packed By    : ' . $order->packedBy->initials() . "\n";
+echo 'Inspected By : ' . $order->inspectedBy->first_name . "\n";
+```
 
 ## Custom Virtual Fields
 You can write custom classes to create virtual fields on any record. Here we are adding a **gross** virtual to the OrderDetail record.
@@ -28,7 +55,7 @@ class Gross extends \PHPFUI\ORM\VirtualField
   {
   public function getValue(array $parameters) : mixed
     {
-    return number_format($parentRecord->unit_price * $parentRecord->quantity - $parentRecord->discount, 2);
+    return number_format($currentRecord->unit_price * $currentRecord->quantity - $currentRecord->discount, 2);
     }
   }
 
@@ -92,5 +119,3 @@ foreach ($suppliers as $supplier)
   echo $supplier->company . "\n";
   }
 ```
-
-