1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Models\Db\Model;

trait Manipulation {

    /**
     * @inheritDocs
     * @param $createNew bool|NULL
     * @param int $propsFlags
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    public function Save ($createNew = NULL, $propsFlags = 0) {
        /** @var \MvcCore\Ext\Models\Db\Model */
        return static::editSave(
            $this, $createNew, $propsFlags, static::getEditMetaDataCollections($propsFlags)
        );
    }

    /**
     * @inheritDocs
     * @param int $propsFlags
     * @throws \InvalidArgumentException 
     * @return bool
     */
    public function IsNew ($propsFlags = 0) {
        /** @var \MvcCore\Ext\Models\Db\Model */
        return static::editIsNew(
            $this, $propsFlags, static::getEditMetaDataCollections($propsFlags)
        );
    }

    /**
     * @inheritDocs
     * @param int $propsFlags
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    public function Insert ($propsFlags = 0) {
        /** @var \MvcCore\Ext\Models\Db\Model */
        return static::editInsert(
            $this, $propsFlags, static::getEditMetaDataCollections($propsFlags)
        );
    }

    /**
     * @inheritDocs
     * @param int $propsFlags
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    public function Update ($propsFlags = 0) {
        /** @var \MvcCore\Ext\Models\Db\Model */
        return static::editUpdate(
            $this, $propsFlags, static::getEditMetaDataCollections($propsFlags)
        );
    }

    /**
     * @inheritDocs
     * @param int $propsFlags 
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    public function Delete ($propsFlags = 0) {
        /** @var \MvcCore\Ext\Models\Db\Model */
        return static::editDelete(
            $this, $propsFlags, static::getEditMetaDataCollections($propsFlags)
        );
    }



    /**
     * Process instance database SQL INSERT or UPDATE by automaticly founded key data.
     * Return `TRUE` if there is inserted or updated 1 or more rows or return 
     * `FALSE` if there is no row inserted or updated. Thrown an exception in any database error.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param bool|NULL $createNew 
     * @param int $propsFlags 
     * @param array $metaDataCollections 
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    protected static function editSave ($context, $createNew, $propsFlags, $metaDataCollections) {
        if ($createNew === NULL)
            $createNew = static::editIsNew($context, $propsFlags, $metaDataCollections);
        if ($createNew) {
            return static::editInsert($context, $propsFlags, $metaDataCollections);
        } else {
            return static::editUpdate($context, $propsFlags, $metaDataCollections);
        }
    }

    /**
     * Try to determinate, if model instance is new or already existing in 
     * database by property with anotated auto increment column.
     * If property is not initialized or if it has `NULL` value, than 
     * model instance is recognized as new and `TRUE` is returned, `FALSE` otherwise.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param int $propsFlags 
     * @param array $metaDataCollections 
     * @throws \InvalidArgumentException
     * @return bool
     */
    protected static function editIsNew ($context, $propsFlags, $metaDataCollections) {
        list(
            $metaData, $autoIncrementIndex
        ) = $metaDataCollections;
        if ($autoIncrementIndex === NULL) {
            throw new \InvalidArgumentException(
                "[".get_class()."] There was not possible to recognize ".
                "if database model instance is new or already existing ".
                "in database. Please define property with primary key ".
                "column attribute anotation."
            );
        } else {
            list(
                $propIsPrivate, /*$propAllowNulls*/, /*$propTypes*/, 
                $propCodeName/*, $propDbColumnName, $propFormatArgs,
                $propPrimaryKey, $propAutoIncrement, $propUniqueKey*/
            ) = $metaData[$autoIncrementIndex];
            if ($propIsPrivate) {
                $prop = new \ReflectionProperty($context, $propCodeName);
                $prop->setAccessible(TRUE);
                if (PHP_VERSION_ID >= 70400) {
                    return !(
                        $prop->isInitialized($context) && 
                        $prop->getValue($context) !== NULL
                    );
                } else {
                    return $prop->getValue($context) === NULL;
                }
            } else {
                return !isset($context->{$propCodeName});
            }
        }
    }

    /**
     * Process instance database SQL INSERT by automaticly founded key data.
     * Return `TRUE` if there is updated 1 or more rows or return 
     * `FALSE` if there is no row updated. Thrown an exception in any database error.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param int $propsFlags 
     * @param array $metaDataCollections 
     * @throws \Throwable
     * @return bool
     */
    protected static function editInsert ($context, $propsFlags, $metaDataCollections) {
        list (
            $metaData, $autoIncrIndex, 
            /*$primaryKeyColumnsIndexes*/, /*$uniqueKeyColumnsIndexes*/, 
            $connectionArgs, $tableArgs
        ) = $metaDataCollections;
        
        if ($propsFlags === 0) 
            $propsFlags = static::$defaultPropsFlags;
        $allValues = $context->GetValues(
            $propsFlags | \MvcCore\IModel::PROPS_NAMES_BY_DATABASE
        );

        list(
            $propIsPrivate, /*$propAllowNulls*/, $propTypes, 
            $propCodeName, $propDbColumnName/*, $propFormatArgs,
            $propPrimaryKey, $propAutoIncrement, $propUniqueKey*/
        ) = $metaData[$autoIncrIndex];

        if (isset($allValues[$propDbColumnName]))
            unset($allValues[$propDbColumnName]);
        
        /** @var $providerResource \MvcCore\Ext\Models\Db\Providers\Resource */
        $providerResource = static::getEditProviderResource();
        $connectionNameOrIndex = isset($connectionArgs[0]) ? $connectionArgs[0] : NULL;
        list (
            $success, $affectedRows, $rawNewId, $error
        ) = $providerResource->Insert(
            $connectionNameOrIndex, $tableArgs[0], $allValues, get_class($context), $propDbColumnName
        );

        if ($success && $affectedRows > 0) {
            $newId = static::parseToTypes($rawNewId, $propTypes);
            if ($propIsPrivate) {
                $prop = new \ReflectionProperty($context, $propCodeName);
                $prop->setAccessible(TRUE);
                $prop->setValue($context, $newId);
            } else {
                $context->{$propCodeName} = $newId;
            }
            return TRUE;
        } else {
            throw $error;
        }
    }

    /**
     * Process instance database SQL UPDATE by automaticly founded key data.
     * Return `TRUE` if there is updated 1 or more rows or return 
     * `FALSE` if there is no row updated. Thrown an exception in any database error.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param int $propsFlags 
     * @param array $metaDataCollections 
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    protected static function editUpdate ($context, $propsFlags, $metaDataCollections) {
        list (
            $metaData, /*$autoIncrIndex*/, 
            $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes, 
            $connectionArgs, $tableArgs
        ) = $metaDataCollections;
        
        if ($propsFlags === 0) 
            $propsFlags = static::$defaultPropsFlags;
        $touchedValues = $context->GetTouched(
            $propsFlags | \MvcCore\IModel::PROPS_NAMES_BY_DATABASE
        );

        $keysColumns = static::getEditAllKeysData(
            $context, $metaData, $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes
        );
        $dataColumns = array_diff_assoc($touchedValues, $keysColumns);
        
        /** @var $providerResource \MvcCore\Ext\Models\Db\Providers\Resource */
        $providerResource = static::getEditProviderResource();
        $connectionNameOrIndex = isset($connectionArgs[0]) ? $connectionArgs[0] : NULL;
        list (
            $success, $affectedRows
        ) = $providerResource->Update(
            $connectionNameOrIndex, $tableArgs[0], $keysColumns, $dataColumns
        );
        
        return $success && $affectedRows > 0;
    }
    
    /**
     * Process instance database SQL DELETE by automaticly founded key data.
     * Return `TRUE` if there is removed more than 1 row or return 
     * `FALSE` if there is no row removed. Thrown an exception in any database error.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param int $propsFlags 
     * @param array $metaDataCollections 
     * @throws \InvalidArgumentException|\Throwable
     * @return bool
     */
    protected static function editDelete ($context, $propsFlags, $metaDataCollections) {
        list (
            $metaData, /*$autoIncrIndex*/, 
            $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes, 
            $connectionArgs, $tableArgs
        ) = $metaDataCollections;
        
        $keysColumns = static::getEditAllKeysData(
            $context, $metaData, $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes
        );
        
        /** @var $providerResource \MvcCore\Ext\Models\Db\Providers\Resource */
        $providerResource = static::getEditProviderResource();
        $connectionNameOrIndex = isset($connectionArgs[0]) ? $connectionArgs[0] : NULL;
        list (
            $success, $affectedRows
        ) = $providerResource->Delete(
            $connectionNameOrIndex, $tableArgs[0], $keysColumns
        );
        
        return $success && $affectedRows > 0;
    }

    /**
     * Complete all necessary meta data collections 
     * for any edit operation from cache, once.
     * @param int $propsFlags 
     * @return array [$metaData, $autoIncrementIndex, $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes, $connectionArgs, $tableArgs]
     */
    protected static function getEditMetaDataCollections ($propsFlags = 0) {
        $metaDataCollections = static::getMetaData(
            $propsFlags, [
                \MvcCore\Ext\Models\Db\Model\IConstants::METADATA_AUTO_INCREMENT,
                \MvcCore\Ext\Models\Db\Model\IConstants::METADATA_PRIMARY_KEY,
                \MvcCore\Ext\Models\Db\Model\IConstants::METADATA_UNIQUE_KEY,
                \MvcCore\Ext\Models\Db\Model\IConstants::METADATA_CONNECTIONS,
                \MvcCore\Ext\Models\Db\Model\IConstants::METADATA_TABLES
            ]
        );
        if (!isset($metaDataCollections[4]) && static::$defaultConnectionName === NULL) {
            throw new \InvalidArgumentException(
                "[".get_called_class()."] No database connection name decorated."
            );
        }
        if (!isset($metaDataCollections[5]))
            throw new \InvalidArgumentException(
                "[".get_called_class()."] No database table name decorated."
            );
        return $metaDataCollections;
    }

    /**
     * Try co complete instance key data (for SQL WHERE condition) by anotated 
     * properties with keys. First, try to complete property/properties with 
     * primary key(s) anotation, if there is/are value(s) and if it is not 
     * possible, then try to complete property/properties with unique key 
     * anotation, if there value(s) exist(s). If there is not possible to 
     * complete any key data, thrown an invalid argument excaption.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param array $metaData 
     * @param array $primaryKeyColumnsIndexes 
     * @param array $uniqueKeyColumnsIndexes 
     * @throws \InvalidArgumentException 
     * @return array
     */
    protected static function getEditAllKeysData ($context, $metaData, $primaryKeyColumnsIndexes, $uniqueKeyColumnsIndexes) {
        list ($identified, $keyColumns) = static::getEditKeysData(
            $context, $metaData, $primaryKeyColumnsIndexes
        );
        if (!$identified) {
            foreach ($uniqueKeyColumnsIndexes as $uniqueKeyColsIndexesItem) {
                if (is_int($uniqueKeyColsIndexesItem)) {
                    list ($identified, $keyColumns) = static::getEditKeysData(
                        $context, $metaData, [$uniqueKeyColsIndexesItem]
                    );
                } else {
                    list ($identified, $keyColumns) = static::getEditKeysData(
                        $context, $metaData, $uniqueKeyColsIndexesItem
                    );
                }
                if ($identified) break;
            }
        }
        if (!$identified) {
            throw new \InvalidArgumentException(
                "[".get_class()."] There was not possible to recognize ".
                "key columns to update/delete model instance. Please define ".
                "property or properties with primary key or unique key(s) ".
                "column(s) attribute(s) anotation(s), where current instance ".
                "has not null or not initialized values."
            );
        }
        return $keyColumns;
    }

    /**
     * Try to complete key data array from instance for given metadata
     * anotation collection about primary or unique keys.
     * Return result as boolean about success key identification and
     * array with collected key data.
     * @param \MvcCore\Ext\Models\Db\Model $context 
     * @param array $metaData 
     * @param array $keyColsIndexes 
     * @return array [bool, array]
     */
    protected static function getEditKeysData ($context, $metaData, $keyColsIndexes) {
        $success = TRUE;
        $keyColumns = [];
        $phpWithTypes = PHP_VERSION_ID >= 70400;
        foreach ($keyColsIndexes as $primaryKeyColIndex) {
            list(
                $propIsPrivate, /*$propAllowNulls*/, /*$propTypes*/, 
                $propCodeName, $propDbColumnName/*, $propFormatArgs,
                $propPrimaryKey, $propAutoIncrement, $propUniqueKey*/
            ) = $metaData[$primaryKeyColIndex];
            $propValue = NULL;
            if (isset($context->initialValues[$propCodeName])) {
                $propValue = $context->initialValues[$propCodeName];
            } else if ($propIsPrivate) {
                $prop = new \ReflectionProperty($context, $propCodeName);
                $prop->setAccessible(TRUE);
                if ($phpWithTypes) {
                    if ($prop->isInitialized($context))
                        $propValue = $prop->getValue($context);
                } else {
                    $propValue = $prop->getValue($context);
                }
            } else if (isset($context->{$propCodeName})) {
                $propValue = $context->{$propCodeName};
            }
            if ($propValue === NULL) {
                $success = FALSE;
                break;
            } else {
                $keyColumns[$propDbColumnName] = $propValue;
            }
        }
        return [$success, $keyColumns];
    }
}