Version 1.0

Author: phpfui

.githooks/pre-commit

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+PHP_CS_FIXER="vendor/bin/php-cs-fixer"
+
+if [ ! -x $PHP_CS_FIXER ]; then
+    echo ""
+    echo "php-cs-fixer not found. Try:"
+    echo ""
+    echo "  composer install"
+    echo ""
+    exit 1
+fi
+
+FILES=`git status --porcelain | grep -E '^[AM] +(src|tests).*\.php$' | cut -c 4- | tr '\n' ' '`
+if [ -z "$FILES" ]; then
+  echo "No php files found in commit."
+else
+  output=`php -l ${FILES}`
+  OUT=$?
+  if [ $OUT != '0' ]; then
+    echo "$output"
+    echo ""
+    echo "Please correct and recommit"
+
+    exit 1
+  fi
+
+  $PHP_CS_FIXER fix --config=.php-cs-fixer.dist.php ${FILES} >/dev/null 2>&1
+  git add ${FILES}
+fi

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  php-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        php: [8.2, 8.1]
+        dependency-version: [prefer-stable]
+        os: [ubuntu-latest, windows-latest]
+
+    name: ${{ matrix.os }} - PHP${{ matrix.php }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, intl, pdo_sqlite
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: vendor/bin/phpunit
+

.gitignore

@@ -0,0 +1,8 @@
+vendor/
+.idea/
+bin/
+composer.lock
+.php-cs-fixer.cache
+.phpunit.result.cache
+phpunit.xml
+

.php-cs-fixer.dist.php

@@ -0,0 +1,15 @@
+<?php
+/*
+ * This document has been generated with
+ * https://mlocati.github.io/php-cs-fixer-configurator/#version:3.0.0-rc.1|configurator
+ * you can change this configuration by importing this file.
+ *
+ */
+
+$config = include 'vendor/phpfui/phpunit-syntax-coverage/PhpCsFixer.php';
+
+return $config->setFinder(PhpCsFixer\Finder::create()
+			->exclude('vendor')
+			->in(__DIR__.'\src')
+			->in(__DIR__.'\tests')
+    );

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project owner. They will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,18 @@
+Copyright 2019 Bruce K. Wells
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions: The
+above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,167 @@
+# PHPFUI\ORM [![Tests](https://github.com/phpfui/ORM/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/ORM/actions?query=workflow%3Atests) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/ORM.svg)](https://packagist.org/packages/phpfui/ORM) ![](https://img.shields.io/badge/PHPStan-level%206-brightgreen.svg?style=flat)
+
+### PHPFUI\ORM a minimal Object Relational Mapper (ORM) for MySQL, MariaDB and SQLite3
+Why another PHP ORM? In writing minimal and fast websites, it was determined that existing PHP ORM solutions were overly complex. **PHPFUI\ORM** is less than 6k lines of code in under 50 files.  It is designed to have a minimal memory footprint and excellent execution times for most database needs.
+
+**PHPFUI\ORM** is not an attempt to write an abstraction around SQL as other ORMs do, rather it is a way to work with SQL that closely matches the semantics of SQL, with the power of PHP objects.  It allows PHP to manipulate SQL queries without having to write SQL in plain text. This is very useful for queries generated via user interfaces where the user is given a lot of flexability in how a query is defined.
+
+## Features
+- **Active Records** that present a fully type checked object interface and implement basic CRUD functionality.
+- **Active Tables** for full table operations including support for where, having, limits, ordering, grouping, joins and unions.
+- **Data Cursors** that implement **iterable** and **Countable** eliminating the need for full arrays read into memory.
+- **Validation** for fully customizable and translatable backend validation.
+- **Virtual Fields** for get and set semantics.
+- **Migrations** simple migrations offer atomic up and down migrations.
+- **Relations** for parent, children, one to one, many to many, and custom relationships.
+- **Type Safe** to prevent stupid type errors.
+- **Raw SQL Query Support** execute any valid SQL command.
+- **MultiDatabase Support** built on PDO with support for MySQL, MariaDB and SQLite.
+
+## Usage
+### Setup
+```php
+$pdo = new \PHPFUI\ORM\PDOInstance($yourConnectionString);
+// permform any custom configuration settings needed on $pdo
+\PHPFUI\ORM::addConnection($pdo);
+```
+
+### Active Record Example
+```php
+$book = new \App\Record\Book();
+$book->title = 'PHP ORM: The Right Way';
+$book->price = 24.99;
+
+$author = new \App\Record\Author();
+$author->name = 'Bruce Wells';
+
+$book->author = $author;  // Save the author
+$book->save();            // Save the book
+```
+
+### Active Table Example
+```php
+$bookTable = new \App\Table\Book();
+$bookTable->setWhere(new \PHPFUI\ORM\Condition('title', '%orm%', new \PHPFUI\ORM\Operator\Like()));
+$bookTable->join('author');
+
+foreach ($bookTable->getDataObjectCursor() as $book)
+  {
+  echo "{$book->title} by {$book->name} is $ {$book->price}\n";
+  }
+
+// discount all PHP books to 19.99
+$bookTableUpdater = new \App\Table\Book();
+$bookTableUpdater->setWhere(new \PHPFUI\ORM\Condition('title', '%PHP%', new \PHPFUI\ORM\Operator\Like()));
+$bookTableUpdater->update(['price' => 19.99]);
+
+foreach ($bookTableUpdater->getRecordCursor() as $book)
+  {
+  echo "{$book->title} by {$book->author->name} is now $ {$book->price}\n";
+  }
+```
+
+### Validation Example
+```php
+$book->title = 'This title is way to long for the database and will return a validation error. We should write a migration to make it varchar(255)!';
+$errors = $book->validate();
+foreach ($errors as $field => $fieldErrors)
+  {
+  echo "Field {$field} has the following errors:\n";
+  foreach ($fieldErrors as $error)
+    {
+    echo $error . "\n";
+    }
+  }
+```
+
+### Migration Example
+Migrations are atomic and can be run in groups or individually up or down.
+
+```php
+namespace App\Migration;
+
+class Migration_1 extends \PHPFUI\ORM\Migration
+  {
+
+  public function description() : string
+    {
+    return 'Lengthen book.title field to 255';
+    }
+
+  public function up() : bool
+    {
+    return $this->alterColumn('book', 'title', 'varchar(255) not null');
+    }
+
+  public function down() : bool
+    {
+    return $this->alterColumn('book', 'title', 'varchar(50) not null');
+    }
+  }
+```
+
+## Type Safety
+### Exceptions Supported
+Exceptions are generated in the following conditions:
+- Accessing field or offset that does not exist
+- Deleting records without a where condition (can be overridden)
+- Incorrect type for Operator (must be an array for **IN** for example)
+- Passing an incorrect type as a primary key
+- Invalid join type
+- Requesting a **RecordCursor** with a table join
+- Joining on an invalid table
+
+All of the above exceptions are programmer errors and strictly enforced. Empty queries are not considered errors. SQL may also return [Exceptions](https://www.php.net/manual/en/class.exception.php) if invalid fields are used.
+
+### Type Conversions
+If you set a field to the wrong type, the library logs an error then converts the type via the appropriate PHP cast.
+
+## Multiple Database Support
+While this is primarily a single database ORM, you can switch databases at run time. Save the value from `$connectionId = \PHPFUI\ORM::addConnection($pdo);` and then call `\PHPFUI\ORM::useConnection($db);` to switch.  `\PHPFUI\ORM::addConnection` will set the current connection.
+
+The programmer must make sure the proper database is currently selected when database reads or writes happen and that any primary keys are correctly handled.
+
+### Copy tables example:
+```php
+// get the current connection just for fun
+$currentConnection = \PHPFUI\ORM::getConnection();
+
+$cursors = [];
+// getRecordCursor will bind the cursor to the current database instance
+$cursors[] = (new \App\Table\Author())->getRecordCursor();
+$cursors[] = (new \App\Table\Book())->getRecordCursor();
+
+// set up a new database connection
+$pdo = new \PDO($newConnectionString);
+$newConnectionId = \PHPFUI\ORM::addConnection($pdo);
+
+foreach ($cursors as $cursor)
+  {
+  foreach ($cursor as $record)
+    {
+    $record->insert();	// insert into new database ($newConnectionId)
+    }
+  }
+// back to the original database
+\PHPFUI\ORM::useConnection($currentConnection);
+```
+
+## Documentation
++ [Setup](docs/1. Setup.md)
++ [Active Record](docs/2. Active Record.md)
++ [Active Table](docs/3. Active Table.md)
++ [Cursors](docs/4. Cursors.md)
++ [Virtual Fields](docs/5. Virtual Fields.md)
++ [Migrations](docs/6. Migrations.md)
++ [Validation](docs/7. Validation.md)
++ [Translations](docs/8. Translations.md)
++ [Miscellaneous](docs/9. Miscellaneous.md)
+
+## Full Class Documentation
+[PHPFUI/ORM](http://phpfui.com/?n=PHPFUI\ORM)
+
+## License
+PHPFUI is distributed under the MIT License.
+
+## PHP Versions
+This library only supports **modern** versions of PHP which still receive security updates. While we would love to support PHP from the late Ming Dynasty, the advantages of modern PHP versions far out weigh quaint notions of backward compatibility. Time to upgrade.

Tests/App/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*
+
+# But not these files...
+!.gitignore
+
+# ...even if they are in subdirectories
+!*/

Tests/Fixtures/Definition/Alpha.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests\Fixtures\Definition;
+
+abstract class Alpha extends \PHPFUI\ORM\Record
+{
+	public static bool $autoIncrement = false;
+
+	public static array $fields = [
+		'alpha' => ['sqltype', 'string', 19, false, '', false, ],
+	];
+
+	public static string $primaryKey = '';
+
+	public static string $table = '';
+}

Tests/Fixtures/Definition/Alpha_numeric.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests\Fixtures\Definition;
+
+abstract class Alpha_numeric extends \PHPFUI\ORM\Record
+{
+	public static bool $autoIncrement = false;
+
+	public static array $fields = [
+		'alpha_numeric' => ['sqltype', 'string', 19, false, '', false, ],
+	];
+
+	public static string $primaryKey = '';
+
+	public static string $table = '';
+}

Tests/Fixtures/Definition/Card.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests\Fixtures\Definition;
+
+abstract class Card extends \PHPFUI\ORM\Record
+{
+	public static bool $autoIncrement = false;
+
+	public static array $fields = [
+		'card' => ['sqltype', 'string', 19, false, '', false, ],
+	];
+
+	public static string $primaryKey = '';
+
+	public static string $table = '';
+}