Usage

#How to use this class

This page gives you an idea how Axels pdo-db classes can be used.

There are 2 abstract classes:

• A class for a PDO object
  It handles the database connection, makes all queries. With it we log all database queries incl. debug information and logging.
• a class for your data objects
  Per table with your items you create a class with table definitions and extends the base class. Then it inherits all CRUD functions.

#Create PDO object

First we need to create a PDO object to connect a database. Define a database connection for a set of objects in the file pdo-db.config.php.

<?php
require_once __DIR__.'/vendor/php-abstract-dbo/src/pdo-db.class.php';
$oDB=new axelhahn\pdo_db([
    'db'=><ARRAY>,
]);

#Create your object class

This is a minimal example class “objexample” with 2 properties “label” and “description”:

<?php
namespace axelhahn;
require_once __DIR__."/../vendor/php-abstract-dbo/pdo-db-base.class.php";

class objexample extends pdo_db_base{

    /**
     * hash for a table
     * create database column, draw edit form
     * @var array 
     */
    protected array $_aProperties = [
        'label'       => ['create' => 'TEXT',],
        'description' => ['create' => 'TEXT',],
    ];

    public function __construct(object $oDB)
    {
        parent::__construct(__CLASS__, $oDB);
    }
}

See Sqlite datatypes

Key	Type	Description
create	{string}	column definition for the sql CREATE statement
validate_is	{string}	optional; if set a item value is checked: validate type - one of string
validate_regex	{string}	optional; if set a item value is checked: validate regey - eg. '/^[a-z]*$/'

For the web UI of Axels ObjectManager you additionally can set:

Key	Type	Description
attr	{array}	Key and value are the attributes of the form element. - The key “label” is used as label next to the input field. - Set “placeholder” for text input fields - set “required” => “required” to mark a must field
lookup	{array}	Lookup to another table for a 1:1 relation. The web ui will show a select box. Keys are: - “table” => {string} [TARGET_TABLE] - “colums” => {array} [LIST_OF_COLUMNS_TO_SHOW] - “where” => {string} [WHERE_CLAUSE]
force	{array}	There is an autodetection to render “a good” input field based on type of column, size and column name. All attributes given in this hash disable automatic values and you can force any input tag and attributes you want.

#Add in your code

In your php code:

// initialize database conection
require_once __DIR__.'/vendor/php-abstract-dbo/pdo-db.class.php';
$oDB=new axelhahn\pdo_db();

// initialize your objexample class
require __DIR__.'/classes/obj-example.class.php';
$o=new axelhahn\objexample($oDB);

// echo "- found records: " . $o->count()."<br>";

#Set value

Variant 1:

With the method set(PROPERTY, VALUE) you can modify the current value of a single property. The method save() detects if the current item is new or not and executes create() or update().

// create a new blank object; optional - it is done in the constructor
$o->new();

// set values
$o->set('label', 'test'.($iCount+1));
$o->set('description', 'test object #'.($iCount+1));

// store to database
$o->save();

Variant 2:

You can get the item into a variable and modify its values. Write it back by using method “setItem(ITEM)” (it uses multiple set() and then calls save()). With setItem() you also can add an array with modified properties only.

$o->new();

// get current item
$aItem=$o->getItem();

/*
returns 
Array
(
    [id] => automatic            <<< default columns for each object type
    [timecreated] => automatic
    [timeupdated] => automatic
    [deleted] => 0

    [label] =>                    <<< the properties of our object
    [description] => 
)
*/

$aItem['label']='test'.($iCount+1);
$aItem['description']='test object #'.($iCount+1);

$o->setItem($aItem);

// store to database
$o->save();

#Read an item

You need an id to read an object from database.

$o->read(25);

This you can modify and save (see above).

#Getter

Get the current object into a hash

$aItem=$o->getItem();

get a single value

// $o->get([KEY]);
$o->get('label');

#Delete an item

To delete a loaded item use

$o->delete();

After this the method getItem() will return a default item.

You also can delete an item with a known id:

$o->delete(ID);

#Search

This is an example search

$aData=$o->search(array(
    'columns'=>'*',
    'where'=>["label like 'test2%' "],
    'order'=>[
        'label ASC',
        'timecreated ASC'
    ],
    'limit'=>'0,3'
));

echo '<pre>'; print_r($aData); echo '</pre>';

array with search options
- columns - array|string
- where   - array|string
- order   - array|string
- limit   - string

#relCreate

The current item must be saved (to get an id) and then it can create a relation to a given table and its id.

$o->relCreate('objlanguages', 1);