<?php

/**
 * Class: gatTestMySQL
 *
 * This is the definition for a mysql/mariadb-based test class.  Intended usage is for unit-testing for basic CRUD
 * operations.
 *
 * This template should also serve as a guide, or documentation, for creating mysql/mariadb template classes.
 *
 *
 * @author  mike@givingassistant.org
 * @version 1.0
 *
 * HISTORY:
 * ========
 * 06-30-17     mks     original coding
 *
 */
class gatTestMySQL
{
    public $version = 1;
    public $schema = TEMPLATE_DB_PDO;                     // defines the storage schema for the class
    public $collection = COLLECTION_MYSQL_TEST;             // sets the collection (table) name
    public $seqKey = COLLECTION_MYSQL_TEST_SQK;             // sets the sequence key identifier
    public $extension = COLLECTION_MYSQL_TEST_EXT;          // sets the extension for the collection
    public $setCache = true;                                // set to true to cache class data
    public $setDeletes = true;                              // set to true to allow HARD deletes (otherwise: SOFT)
    public $setAuditing = AUDIT_NOT_ENABLED;                // set to AUDIT_value constant
    public $setJournaling = false;                          // set to true to allow journaling
    public $setUpdates = true;                              // set to true to allow record updates
    public $setHistory = false;                             // set to true to enable detailed record history tracking
    public $setDefaultStatus = STATUS_ACTIVE;               // set the default status for each record
    public $setSearchStatus = STATUS_ACTIVE;                // set the default search status
    public $setLocking = false;                             // set to true to enable record locking for collection
    public $setTimers = true;                               // set to true to enable collection query timers
    public $setPKey = DB_PKEY;                              // sets the primary key for the collection
    public $selfDestruct = true;                            // set to false if this class contains methods

    /*
     * tokens are guids -- if you're using a guid as the pkey for the class, then this value should be false.
     *                     if you're using an integer pkey, and you want a token, you have to explicitly declare
     *                     the token fields in $fields and set this value to true.
     *                     if you're using an integer pkey and you don't want a token, set this value to false.
     */
    public $setTokens = false;                              // set to true: adds the idToken field functionality
    public $cacheTimer = 0;                                 // number of seconds a tuple will remain in-cache
    public $setEnv = ENV_ALL;                               // defines the env where this class can be accessed
    public $setMeta = false;                                // defines if we'll use the meta package for history

    public $fields = [
        DB_PKEY                     => DATA_TYPE_INTEGER,   // pkey (integer) used internally and is REQUIRED
        TEST_FIELD_TEST_STRING      => DATA_TYPE_STRING,
        TEST_FIELD_TEST_DOUBLE      => DATA_TYPE_DOUBLE,
        TEST_FIELD_TEST_INT         => DATA_TYPE_INTEGER,
        TEST_FIELD_TEST_BOOL        => DATA_TYPE_BOOL,
        TEST_FIELD_TEST_OBJECT      => DATA_TYPE_OBJECT,
        DB_TOKEN                    => DATA_TYPE_STRING     // unique key (string) exposed externally and is REQUIRED
    ];

    // cache-map constants are in ./common/cacheMaps.php
    public $cacheMap = [
        DB_TOKEN                    => CM_TST_TOKEN,
        TEST_FIELD_TEST_STRING      => CM_TST_FIELD_TEST_STRING,
        TEST_FIELD_TEST_DOUBLE      => CM_TST_FIELD_TEST_DOUBLE,
        TEST_FIELD_TEST_INT         => CM_TST_FIELD_TEST_INT,
        TEST_FIELD_TEST_BOOL        => CM_TST_FIELD_TEST_BOOL,
        TEST_FIELD_TEST_OBJECT      => CM_TST_FIELD_TEST_OBJ
    ];

    // for mysql, all indexed fields are listed in this container regardless of index type.  If an field appears but
    // is not a unique or compound index, then it is just a regular index.
    public $indexes = [ DB_PKEY, TEST_FIELD_TEST_INT, DB_TOKEN ];

    // unique indexes listed as an indexed array
    public $uniqueIndexes = [ DB_TOKEN ];

    // compound indexes are listed as sub-arrays:
    // [ [ col-1, ..., col-n ], ..., [] ]
    public $compoundIndexes = null;

    // exposed fields are mutually exclusive with cacheMaps;  one or the other but not both
    public $exposedFields = null;

    // binary fields require special handling (encoding) and have to be listed here
    public $binaryFields = null;
}