ca1cbb0e06
- new cronjob for "delete expired connections", #219 - fixed "not updating" map changes, closed #357 - improved caching strategy for DB models (file cache) - improved "map sharing"
838 lines
23 KiB
PHP
838 lines
23 KiB
PHP
<?php
|
||
/**
|
||
* Created by PhpStorm.
|
||
* User: exodus4d
|
||
* Date: 16.02.15
|
||
* Time: 22:11
|
||
*/
|
||
|
||
namespace Model;
|
||
|
||
use DB\SQL\Schema;
|
||
use Exception;
|
||
use Controller;
|
||
use DB;
|
||
|
||
abstract class BasicModel extends \DB\Cortex {
|
||
|
||
/**
|
||
* Hive key with DB object
|
||
* @var string
|
||
*/
|
||
protected $db = 'DB_PF';
|
||
|
||
/**
|
||
* caching time of field schema - seconds
|
||
* as long as we don´t expect any field changes
|
||
* -> leave this at a higher value
|
||
* @var int
|
||
*/
|
||
//protected $ttl = 86400;
|
||
|
||
/**
|
||
* caching for relational data
|
||
* @var int
|
||
*/
|
||
protected $rel_ttl = 0;
|
||
|
||
/**
|
||
* ass static columns for this table
|
||
* -> can be overwritten in child models
|
||
* @var bool
|
||
*/
|
||
protected $addStaticFields = true;
|
||
|
||
/**
|
||
* field validation array
|
||
* @var array
|
||
*/
|
||
protected $validate = [];
|
||
|
||
/**
|
||
* enables change for "active" column
|
||
* -> see setActive();
|
||
* -> $this->active = false; will NOT work (prevent abuse)!
|
||
* @var bool
|
||
*/
|
||
protected $allowActiveChange = false;
|
||
|
||
/**
|
||
* enables check for $fieldChanges on update/insert
|
||
* -> fields that should be checked need an "activity-log" flag
|
||
* in $fieldConf config
|
||
* @var bool
|
||
*/
|
||
protected $enableActivityLogging = true;
|
||
|
||
/**
|
||
* getData() cache key prefix
|
||
* -> do not change, otherwise cached data is lost
|
||
* @var string
|
||
*/
|
||
private $dataCacheKeyPrefix = 'DATACACHE';
|
||
|
||
/**
|
||
* enables data export for this table
|
||
* -> can be overwritten in child models
|
||
* @var bool
|
||
*/
|
||
public static $enableDataExport = false;
|
||
|
||
/**
|
||
* enables data import for this table
|
||
* -> can be overwritten in child models
|
||
* @var bool
|
||
*/
|
||
public static $enableDataImport = false;
|
||
|
||
/**
|
||
* changed fields (columns) on update/insert
|
||
* -> e.g. for character "activity logging"
|
||
* @var array
|
||
*/
|
||
protected $fieldChanges = [];
|
||
|
||
/**
|
||
* default TTL for getData(); cache
|
||
*/
|
||
const DEFAULT_CACHE_TTL = 120;
|
||
|
||
public function __construct($db = NULL, $table = NULL, $fluid = NULL, $ttl = 0){
|
||
|
||
$this->addStaticFieldConfig();
|
||
|
||
parent::__construct($db, $table, $fluid, $ttl);
|
||
|
||
// insert events ------------------------------------------------------------------------------------
|
||
$this->beforeinsert( function($self, $pkeys){
|
||
return $self->beforeInsertEvent($self, $pkeys);
|
||
});
|
||
|
||
$this->afterinsert(function($self, $pkeys){
|
||
$self->afterInsertEvent($self, $pkeys);
|
||
});
|
||
|
||
// update events ------------------------------------------------------------------------------------
|
||
$this->beforeupdate( function($self, $pkeys){
|
||
return $self->beforeUpdateEvent($self, $pkeys);
|
||
});
|
||
|
||
$this->afterupdate( function($self, $pkeys){
|
||
$self->afterUpdateEvent($self, $pkeys);
|
||
});
|
||
|
||
// erase events -------------------------------------------------------------------------------------
|
||
|
||
$this->beforeerase( function($self, $pkeys){
|
||
return $self->beforeEraseEvent($self, $pkeys);
|
||
});
|
||
|
||
$this->aftererase( function($self, $pkeys){
|
||
$self->afterEraseEvent($self, $pkeys);
|
||
});
|
||
}
|
||
|
||
/**
|
||
* @param string $key
|
||
* @param mixed $val
|
||
* @return mixed|void
|
||
* @throws Exception\ValidationException
|
||
*/
|
||
public function set($key, $val){
|
||
|
||
if(
|
||
!$this->dry() &&
|
||
$key != 'updated'
|
||
){
|
||
if( $this->exists($key) ){
|
||
$currentVal = $this->get($key);
|
||
|
||
// if current value is not a relational object
|
||
// and value has changed -> update table col
|
||
if(is_object($currentVal)){
|
||
if(
|
||
is_numeric($val) &&
|
||
is_subclass_of($currentVal, 'Model\BasicModel') &&
|
||
$currentVal->_id !== (int)$val
|
||
){
|
||
$this->touch('updated');
|
||
}
|
||
}elseif($currentVal != $val){
|
||
$this->touch('updated');
|
||
}
|
||
|
||
}
|
||
}
|
||
|
||
// trim all values
|
||
if(is_string($val)){
|
||
$val = trim($val);
|
||
}
|
||
|
||
$valid = $this->validateField($key, $val);
|
||
|
||
if(!$valid){
|
||
$this->throwValidationError($key);
|
||
}else{
|
||
$this->checkFieldForActivityLogging($key, $val);
|
||
|
||
return parent::set($key, $val);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* change default "activity logging" status
|
||
* -> enable/disable
|
||
* @param $status
|
||
*/
|
||
public function setActivityLogging($status){
|
||
$this->enableActivityLogging = (bool) $status;
|
||
}
|
||
|
||
/**
|
||
* check column for value changes,
|
||
* --> if column is marked for "activity logging"
|
||
* @param string $key
|
||
* @param mixed $val
|
||
*/
|
||
protected function checkFieldForActivityLogging($key, $val){
|
||
if( $this->enableActivityLogging ){
|
||
$fieldConf = $this->fieldConf[$key];
|
||
|
||
// check for value changes if field has "activity logging" active
|
||
if($fieldConf['activity-log'] === true){
|
||
if(
|
||
is_numeric($val) ||
|
||
$fieldConf['type'] === Schema::DT_BOOL
|
||
){
|
||
$val = (int)$val;
|
||
}
|
||
|
||
if( $fieldConf['type'] === self::DT_JSON){
|
||
$currentValue = $this->get($key);
|
||
}else{
|
||
$currentValue = $this->get($key, true);
|
||
}
|
||
|
||
if($currentValue !== $val){
|
||
// field has changed
|
||
in_array($key, $this->fieldChanges) ?: $this->fieldChanges[] = $key;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* setter for "active" status
|
||
* -> default: keep current "active" status
|
||
* -> can be overwritten
|
||
* @param bool $active
|
||
* @return mixed
|
||
*/
|
||
public function set_active($active){
|
||
if( $this->allowActiveChange ){
|
||
// allowed to set/change -> reset "allowed" property
|
||
$this->allowActiveChange = false;
|
||
}else{
|
||
// not allowed to set/change -> keep current status
|
||
$active = $this->active;
|
||
}
|
||
return $active;
|
||
}
|
||
|
||
/**
|
||
* extent the fieldConf Array with static fields for each table
|
||
*/
|
||
private function addStaticFieldConfig(){
|
||
|
||
// add static fields to this mapper
|
||
// static tables (fixed data) do not require them...
|
||
if($this->addStaticFields){
|
||
$staticFieldConfig = [
|
||
'created' => [
|
||
'type' => Schema::DT_TIMESTAMP,
|
||
'default' => Schema::DF_CURRENT_TIMESTAMP,
|
||
'index' => true
|
||
],
|
||
'updated' => [
|
||
'type' => Schema::DT_TIMESTAMP,
|
||
'default' => Schema::DF_CURRENT_TIMESTAMP,
|
||
'index' => true
|
||
]
|
||
];
|
||
|
||
|
||
$this->fieldConf = array_merge($staticFieldConfig, $this->fieldConf);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* validates a table column based on validation settings
|
||
* @param $col
|
||
* @param $val
|
||
* @return bool
|
||
*/
|
||
private function validateField($col, $val){
|
||
$valid = true;
|
||
|
||
if(array_key_exists($col, $this->validate)){
|
||
|
||
$fieldValidationOptions = $this->validate[$col];
|
||
|
||
foreach($fieldValidationOptions as $validateKey => $validateOption ){
|
||
if(is_array($fieldValidationOptions[$validateKey])){
|
||
$fieldSubValidationOptions = $fieldValidationOptions[$validateKey];
|
||
|
||
foreach($fieldSubValidationOptions as $validateSubKey => $validateSubOption ){
|
||
switch($validateKey){
|
||
case 'length':
|
||
switch($validateSubKey){
|
||
case 'min';
|
||
if(strlen($val) < $validateSubOption){
|
||
$valid = false;
|
||
}
|
||
break;
|
||
case 'max';
|
||
|
||
if(strlen($val) > $validateSubOption){
|
||
$valid = false;
|
||
}
|
||
break;
|
||
}
|
||
break;
|
||
}
|
||
}
|
||
|
||
}else{
|
||
switch($validateKey){
|
||
case 'regex':
|
||
$valid = (bool)preg_match($fieldValidationOptions[$validateKey], $val);
|
||
break;
|
||
}
|
||
}
|
||
|
||
// a validation rule failed
|
||
if(!$valid){
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
return $valid;
|
||
}
|
||
|
||
/**
|
||
* get key for for all objects in this table
|
||
* @return string
|
||
*/
|
||
private function getTableCacheKey(){
|
||
return $this->dataCacheKeyPrefix .'.' . strtoupper($this->table);
|
||
}
|
||
|
||
/**
|
||
* get the cache key for this model
|
||
* ->do not set a key if the model is not saved!
|
||
* @param string $dataCacheTableKeyPrefix
|
||
* @return null|string
|
||
*/
|
||
protected function getCacheKey($dataCacheTableKeyPrefix = ''){
|
||
$cacheKey = null;
|
||
|
||
// set a model unique cache key if the model is saved
|
||
if( $this->id > 0){
|
||
$cacheKey = $this->getTableCacheKey();
|
||
|
||
// check if there is a given key prefix
|
||
// -> if not, use the standard key.
|
||
// this is useful for caching multiple data sets according to one row entry
|
||
if( !empty($dataCacheTableKeyPrefix) ){
|
||
$cacheKey .= '.' . $dataCacheTableKeyPrefix . '_';
|
||
}else{
|
||
$cacheKey .= '.ID_';
|
||
}
|
||
$cacheKey .= (string) $this->_id;
|
||
}
|
||
|
||
return $cacheKey;
|
||
}
|
||
|
||
/**
|
||
* get cached data from this model
|
||
* @param string $dataCacheKeyPrefix - optional key prefix
|
||
* @return \stdClass|null
|
||
*/
|
||
protected function getCacheData($dataCacheKeyPrefix = ''){
|
||
$cacheData = null;
|
||
|
||
// table cache exists
|
||
// -> check cache for this row data
|
||
$cacheKey = $this->getCacheKey($dataCacheKeyPrefix);
|
||
|
||
if( !is_null($cacheKey) ){
|
||
$f3 = self::getF3();
|
||
if( $f3->exists($cacheKey) ){
|
||
$cacheData = $f3->get( $cacheKey );
|
||
}
|
||
}
|
||
|
||
return $cacheData;
|
||
}
|
||
|
||
/**
|
||
* update/set the getData() cache for this object
|
||
* @param $cacheData
|
||
* @param string $dataCacheKeyPrefix
|
||
* @param int $data_ttl
|
||
*/
|
||
public function updateCacheData($cacheData, $dataCacheKeyPrefix = '', $data_ttl = self::DEFAULT_CACHE_TTL){
|
||
$cacheDataTmp = (array)$cacheData;
|
||
|
||
// check if data should be cached
|
||
// and cacheData is not empty
|
||
if(
|
||
$data_ttl > 0 &&
|
||
!empty($cacheDataTmp)
|
||
){
|
||
$cacheKey = $this->getCacheKey($dataCacheKeyPrefix);
|
||
|
||
if( !is_null($cacheKey) ){
|
||
self::getF3()->set($cacheKey, $cacheData, $data_ttl);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* unset the getData() cache for this object
|
||
* -> see also clearCacheDataWithPrefix(), for more information
|
||
*/
|
||
public function clearCacheData(){
|
||
$cacheKey = $this->getCacheKey();
|
||
$this->clearCache($cacheKey);
|
||
}
|
||
|
||
/**
|
||
* unset object cached data by prefix
|
||
* -> primarily used by object cache with multiple data caches
|
||
* @param string $dataCacheKeyPrefix
|
||
*/
|
||
public function clearCacheDataWithPrefix($dataCacheKeyPrefix = ''){
|
||
$cacheKey = $this->getCacheKey($dataCacheKeyPrefix);
|
||
$this->clearCache($cacheKey);
|
||
}
|
||
|
||
/**
|
||
* unset object cached data (if exists)
|
||
* @param $cacheKey
|
||
*/
|
||
private function clearCache($cacheKey){
|
||
if( !empty($cacheKey) ){
|
||
$f3 = self::getF3();
|
||
if( $f3->exists($cacheKey) ){
|
||
$f3->clear($cacheKey);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Throws a validation error for a giben column
|
||
* @param $col
|
||
* @throws \Exception\ValidationException
|
||
*/
|
||
protected function throwValidationError($col){
|
||
throw new Exception\ValidationException('Validation failed: "' . $col . '".', $col);
|
||
|
||
}
|
||
|
||
/**
|
||
* set "updated" field to current timestamp
|
||
* this is useful to mark a row as "changed"
|
||
*/
|
||
protected function setUpdated(){
|
||
if($this->_id > 0){
|
||
$pfDB = DB\Database::instance()->getDB('PF');
|
||
|
||
$pfDB->exec(
|
||
["UPDATE " . $this->table . " SET updated=NOW() WHERE id=:id"],
|
||
[
|
||
[':id' => $this->_id]
|
||
]
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* get single dataSet by id
|
||
* @param $id
|
||
* @param int $ttl
|
||
* @return \DB\Cortex
|
||
*/
|
||
public function getById($id, $ttl = 3) {
|
||
|
||
return $this->getByForeignKey('id', (int)$id, ['limit' => 1], $ttl);
|
||
}
|
||
|
||
/**
|
||
* checks whether this model is active or not
|
||
* each model should have an "active" column
|
||
* @return bool
|
||
*/
|
||
public function isActive(){
|
||
return (bool)$this->active;
|
||
}
|
||
|
||
/**
|
||
* set active state for a model
|
||
* -> do NOT use $this->active for status change!
|
||
* -> this will not work (prevent abuse)
|
||
* @param bool $active
|
||
*/
|
||
public function setActive($active){
|
||
// enables "active" change for this model
|
||
$this->allowActiveChange = true;
|
||
$this->active = $active;
|
||
}
|
||
|
||
/**
|
||
* get dataSet by foreign column (single result)
|
||
* @param $key
|
||
* @param $value
|
||
* @param array $options
|
||
* @param int $ttl
|
||
* @return \DB\Cortex
|
||
*/
|
||
public function getByForeignKey($key, $value, $options = [], $ttl = 60){
|
||
|
||
$querySet = [];
|
||
$query = [];
|
||
if($this->exists($key)){
|
||
$query[] = $key . " = :" . $key;
|
||
$querySet[':' . $key] = $value;
|
||
}
|
||
|
||
// check active column
|
||
if($this->exists('active')){
|
||
$query[] = "active = :active";
|
||
$querySet[':active'] = 1;
|
||
}
|
||
|
||
array_unshift($querySet, implode(' AND ', $query));
|
||
|
||
return $this->load( $querySet, $options, $ttl );
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* return false will stop any further action
|
||
* @param self $self
|
||
* @param $pkeys
|
||
* @return bool
|
||
*/
|
||
public function beforeInsertEvent($self, $pkeys){
|
||
if($this->exists('updated')){
|
||
$this->touch('updated');
|
||
}
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* return false will stop any further action
|
||
* @param self $self
|
||
* @param $pkeys
|
||
*/
|
||
public function afterInsertEvent($self, $pkeys){
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* return false will stop any further action
|
||
* @param self $self
|
||
* @param $pkeys
|
||
* @return bool
|
||
*/
|
||
public function beforeUpdateEvent($self, $pkeys){
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* return false will stop any further action
|
||
* @param self $self
|
||
* @param $pkeys
|
||
*/
|
||
public function afterUpdateEvent($self, $pkeys){
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* @param self $self
|
||
* @param $pkeys
|
||
* @return bool
|
||
*/
|
||
public function beforeEraseEvent($self, $pkeys){
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Event "Hook" function
|
||
* can be overwritten
|
||
* @param self $self
|
||
* @param $pkeys
|
||
*/
|
||
public function afterEraseEvent($self, $pkeys){
|
||
}
|
||
|
||
/**
|
||
* function should be overwritten in child classes with access restriction
|
||
* @param CharacterModel $characterModel
|
||
* @return bool
|
||
*/
|
||
public function hasAccess(CharacterModel $characterModel){
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* function should be overwritten in parent classes
|
||
* @return bool
|
||
*/
|
||
public function isValid(){
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* export and download table data as *.csv
|
||
* this is primarily used for static tables
|
||
* @return bool
|
||
*/
|
||
public function exportData(){
|
||
$status = false;
|
||
|
||
if(static::$enableDataExport){
|
||
$tableModifier = static::getTableModifier();
|
||
$headers = $tableModifier->getCols();
|
||
|
||
// just get the records with existing columns
|
||
// -> no "virtual" fields or "new" columns
|
||
$this->fields($headers);
|
||
$allRecords = $this->find();
|
||
|
||
if($allRecords){
|
||
$tableData = $allRecords->castAll(0);
|
||
|
||
// format data -> "id" must be first key
|
||
foreach($tableData as &$rowData){
|
||
$rowData = [$this->primary => $rowData['_id']] + $rowData;
|
||
unset($rowData['_id']);
|
||
}
|
||
|
||
$sheet = \Sheet::instance();
|
||
$data = $sheet->dumpCSV($tableData, $headers);
|
||
|
||
header('Expires: 0');
|
||
header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
|
||
header('Content-Type: text/csv;charset=UTF-8');
|
||
header('Content-Disposition: attachment;filename=' . $this->getTable() . '.csv');
|
||
echo $data;
|
||
exit();
|
||
}
|
||
}
|
||
|
||
return $status;
|
||
}
|
||
|
||
/**
|
||
* import table data from a *.csv file
|
||
* @return bool
|
||
*/
|
||
public function importData(){
|
||
$status = false;
|
||
|
||
// rtrim(); for arrays (removes empty values) from the end
|
||
$rtrim = function($array = []){
|
||
return array_slice($array, 0, key(array_reverse(array_diff($array, ['']), 1))+1);
|
||
};
|
||
|
||
if(static::$enableDataImport){
|
||
$filePath = $this->getF3()->get('EXPORT') . 'csv/' . $this->getTable() . '.csv';
|
||
|
||
if(is_file($filePath)){
|
||
$handle = @fopen($filePath, 'r');
|
||
$keys = array_map('lcfirst', fgetcsv($handle, 0, ';'));
|
||
$keys = $rtrim($keys);
|
||
|
||
if(count($keys) > 0){
|
||
$tableData = [];
|
||
while (!feof($handle)) {
|
||
$tableData[] = array_combine($keys, $rtrim(fgetcsv($handle, 0, ';')));
|
||
}
|
||
// import row data
|
||
$status = $this->importStaticData($tableData);
|
||
$this->getF3()->status(202);
|
||
}else{
|
||
$this->getF3()->error(502, 'File could not be read');
|
||
}
|
||
}else{
|
||
$this->getF3()->error(404, 'File not found: ' . $filePath);
|
||
}
|
||
}
|
||
|
||
return $status;
|
||
}
|
||
|
||
/**
|
||
* insert/update static data into this table
|
||
* WARNING: rows will be deleted if not part of $tableData !
|
||
* @param array $tableData
|
||
* @return array
|
||
*/
|
||
protected function importStaticData($tableData = []){
|
||
$rowIDs = [];
|
||
|
||
$addedCount = 0;
|
||
$updatedCount = 0;
|
||
$deletedCount = 0;
|
||
|
||
foreach($tableData as $rowData){
|
||
// search for existing record and update columns
|
||
$this->getById($rowData['id']);
|
||
if($this->dry()){
|
||
$addedCount++;
|
||
}else{
|
||
$updatedCount++;
|
||
}
|
||
$this->copyfrom($rowData);
|
||
$this->save();
|
||
$rowIDs[] = $this->id;
|
||
$this->reset();
|
||
}
|
||
|
||
// remove old data
|
||
$oldRows = $this->find('id NOT IN (' . implode(',', $rowIDs) . ')');
|
||
if($oldRows){
|
||
foreach($oldRows as $oldRow){
|
||
$oldRow->erase();
|
||
$deletedCount++;
|
||
}
|
||
}
|
||
return ['added' => $addedCount, 'updated' => $updatedCount, 'deleted' => $deletedCount];
|
||
}
|
||
|
||
/**
|
||
* buffer a new activity (action) logging
|
||
* -> increment buffered counter
|
||
* -> log character activity create/update/delete events
|
||
* @param int $characterId
|
||
* @param int $mapId
|
||
* @param string $action
|
||
*/
|
||
protected function bufferActivity($characterId, $mapId, $action){
|
||
Controller\LogController::instance()->bufferActivity($characterId, $mapId, $action);
|
||
}
|
||
|
||
/**
|
||
* get the current class name
|
||
* -> namespace not included
|
||
* @return string
|
||
*/
|
||
public static function getClassName(){
|
||
$parts = explode('\\', static::class);
|
||
return end($parts);
|
||
}
|
||
|
||
/**
|
||
* factory for all Models
|
||
* @param string $model
|
||
* @param int $ttl
|
||
* @return BasicModel
|
||
* @throws \Exception
|
||
*/
|
||
public static function getNew($model, $ttl = 86400){
|
||
$class = null;
|
||
|
||
$model = '\\' . __NAMESPACE__ . '\\' . $model;
|
||
if(class_exists($model)){
|
||
$class = new $model( null, null, null, $ttl );
|
||
}else{
|
||
throw new \Exception('No model class found');
|
||
}
|
||
|
||
return $class;
|
||
}
|
||
|
||
/**
|
||
* get the framework instance (singleton)
|
||
* @return \Base
|
||
*/
|
||
public static function getF3(){
|
||
return \Base::instance();
|
||
}
|
||
|
||
/**
|
||
* debug log function
|
||
* @param string $text
|
||
* @param string $type
|
||
*/
|
||
public static function log($text, $type = null){
|
||
$type = isset($type) ? $type : 'DEBUG';
|
||
Controller\LogController::getLogger($type)->write($text);
|
||
}
|
||
|
||
/**
|
||
* get tableModifier class for this table
|
||
* @return bool|DB\SQL\TableModifier
|
||
*/
|
||
public static function getTableModifier(){
|
||
$df = parent::resolveConfiguration();
|
||
$schema = new Schema($df['db']);
|
||
$tableModifier = $schema->alterTable( $df['table'] );
|
||
return $tableModifier;
|
||
}
|
||
|
||
/**
|
||
* Check whether a (multi)-column index exists or not on a table
|
||
* related to this model
|
||
* @param array $columns
|
||
* @return bool|array
|
||
*/
|
||
public static function indexExists(array $columns = []){
|
||
$tableModifier = self::getTableModifier();
|
||
$df = parent::resolveConfiguration();
|
||
|
||
$check = false;
|
||
$indexKey = $df['table'] . '___' . implode('__', $columns);
|
||
$indexList = $tableModifier->listIndex();
|
||
if(array_key_exists( $indexKey, $indexList)){
|
||
$check = $indexList[$indexKey];
|
||
}
|
||
|
||
return $check;
|
||
}
|
||
|
||
/**
|
||
* set a multi-column index for this table
|
||
* @param array $columns Column(s) to be indexed
|
||
* @param bool $unique Unique index
|
||
* @param int $length index length for text fields in mysql
|
||
* @return bool
|
||
*/
|
||
public static function setMultiColumnIndex(array $columns = [], $unique = false, $length = 20){
|
||
$status = false;
|
||
$tableModifier = self::getTableModifier();
|
||
|
||
if( self::indexExists($columns) === false ){
|
||
$tableModifier->addIndex($columns, $unique, $length);
|
||
$buildStatus = $tableModifier->build();
|
||
if($buildStatus === 0){
|
||
$status = true;
|
||
}
|
||
}
|
||
|
||
return $status;
|
||
}
|
||
|
||
}
|