SchemaDAO.inc.php

<?php
import('lib.pkp.classes.db.DAO');
import('classes.core.Services');
 
abstract class SchemaDAO extends DAO {
   var $schemaName;
 
   var $tableName;
 
   var $settingsTableName;
 
   var $primaryKeyColumn;
 
   var $primaryTableColumns = array();
 
   abstract public function newDataObject();
 
   public function getById($objectId) {
      $result = $this->retrieve(
         'SELECT * FROM ' . $this->tableName . ' WHERE ' . $this->primaryKeyColumn . ' = ?',
         (int) $objectId
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   public function insertObject($object) {
      $schemaService = Services::get('schema');
      $schema = $schemaService->get($this->schemaName);
      $sanitizedProps = $schemaService->sanitize($this->schemaName, $object->_data);
 
      $primaryDbProps = $this->_getPrimaryDbProps($object);
 
      if (empty($primaryDbProps)) {
         throw new Exception('Tried to insert ' . get_class($object) . ' without any properties for the ' . $this->tableName . ' table.');
      }
 
      $columnsList = join(', ', array_keys($primaryDbProps));
      $bindList = join(', ', array_fill(0, count($primaryDbProps), '?'));
      $this->update("INSERT INTO $this->tableName ($columnsList) VALUES ($bindList)", array_values($primaryDbProps));
 
      $object->setId($this->getInsertId());
 
      // Add additional properties to settings table if they exist
      if (count($sanitizedProps) !== count($primaryDbProps)) {
         $columns = array($this->primaryKeyColumn, 'locale', 'setting_name', 'setting_value');
         $columnsList = join(', ', $columns);
         $bindList = join(', ', array_fill(0, count($columns), '?'));
         foreach ($schema->properties as $propName => $propSchema) {
            if (!isset($sanitizedProps[$propName]) || array_key_exists($propName, $this->primaryTableColumns)) {
               continue;
            }
            if (!empty($propSchema->multilingual)) {
               foreach ($sanitizedProps[$propName] as $localeKey => $localeValue) {
                  $this->update("INSERT INTO $this->settingsTableName ($columnsList) VALUES ($bindList)", array(
                     $object->getId(),
                     $localeKey,
                     $propName,
                     $this->convertToDB($localeValue, $schema->properties->{$propName}->type),
                  ));
               }
            } else {
               $this->update("INSERT INTO $this->settingsTableName ($columnsList) VALUES ($bindList)", array(
                  $object->getId(),
                  '',
                  $propName,
                  $this->convertToDB($sanitizedProps[$propName], $schema->properties->{$propName}->type),
               ));
            }
         }
      }
 
      return $object->getId();
   }
 
   public function updateObject($object) {
      $schemaService = Services::get('schema');
      $schema = $schemaService->get($this->schemaName);
      $sanitizedProps = $schemaService->sanitize($this->schemaName, $object->_data);
 
      $primaryDbProps = $this->_getPrimaryDbProps($object);
 
      $set = join('=?,', array_keys($primaryDbProps)) . '=?';
      $this->update(
         "UPDATE $this->tableName SET $set WHERE $this->primaryKeyColumn = ?",
         array_merge(array_values($primaryDbProps), array($object->getId()))
      );
 
      $deleteSettings = [];
      $keyColumns = [$this->primaryKeyColumn, 'locale', 'setting_name'];
      foreach ($schema->properties as $propName => $propSchema) {
         if (array_key_exists($propName, $this->primaryTableColumns)) {
            continue;
         } elseif (!isset($sanitizedProps[$propName])) {
            $deleteSettings[] = $propName;
            continue;
         }
         if (!empty($propSchema->multilingual)) {
            foreach ($sanitizedProps[$propName] as $localeKey => $localeValue) {
               // Delete rows with a null value
               if (is_null($localeValue)) {
                  $this->update("DELETE FROM $this->settingsTableName WHERE $this->primaryKeyColumn = ? AND setting_name = ? AND locale = ?", [
                     $object->getId(),
                     $propName,
                     $localeKey,
                  ]);
               } else {
                  $updateArray = [
                     $this->primaryKeyColumn => $object->getId(),
                     'locale' => $localeKey,
                     'setting_name' => $propName,
                     'setting_value' => $this->convertToDB($localeValue, $schema->properties->{$propName}->type),
                  ];
                  $this->replace($this->settingsTableName, $updateArray, $keyColumns);
               }
            }
         } else {
            $updateArray = [
               $this->primaryKeyColumn => $object->getId(),
               'locale' => '',
               'setting_name' => $propName,
               'setting_value' => $this->convertToDB($sanitizedProps[$propName], $schema->properties->{$propName}->type),
            ];
            $this->replace($this->settingsTableName, $updateArray, $keyColumns);
         }
      }
 
      if (count($deleteSettings)) {
         $deleteSettingNames = join(',', array_map(function($settingName) {
            return "'$settingName'";
         }, $deleteSettings));
         $this->update("DELETE FROM $this->settingsTableName WHERE $this->primaryKeyColumn = ? AND setting_name in ($deleteSettingNames)", [
            $object->getId(),
         ]);
      }
   }
 
   public function deleteObject($object) {
      $this->deleteById($object->getId());
   }
 
   public function deleteById($objectId) {
      $this->update(
         "DELETE FROM $this->tableName WHERE $this->primaryKeyColumn = ?",
         (int) $objectId
      );
      $this->update(
         "DELETE FROM $this->settingsTableName WHERE $this->primaryKeyColumn = ?",
         (int) $objectId
      );
   }
 
   public function _fromRow($primaryRow) {
      $schemaService = Services::get('schema');
      $schema = $schemaService->get($this->schemaName);
 
      $object = $this->newDataObject();
 
      foreach ($this->primaryTableColumns as $propName => $column) {
         if (isset($primaryRow[$column])) {
            $object->setData(
               $propName,
               $this->convertFromDb($primaryRow[$column], $schema->properties->{$propName}->type)
            );
         }
      }
 
      $result = $this->retrieve(
         "SELECT * FROM $this->settingsTableName WHERE $this->primaryKeyColumn = ?",
         array($primaryRow[$this->primaryKeyColumn])
      );
 
      while (!$result->EOF) {
         $settingRow = $result->getRowAssoc(false);
         if (!empty($schema->properties->{$settingRow['setting_name']})) {
            $object->setData(
               $settingRow['setting_name'],
               $this->convertFromDB(
                  $settingRow['setting_value'],
                  $schema->properties->{$settingRow['setting_name']}->type
               ),
               empty($settingRow['locale']) ? null : $settingRow['locale']
            );
         }
         $result->MoveNext();
      }
 
      return $object;
   }
 
   public function getInsertId() {
      return $this->_getInsertId($this->tableName, $this->primaryKeyColumn);
   }
 
   private function _getPrimaryDbProps($object) {
      $schema = Services::get('schema')->get($this->schemaName);
      $sanitizedProps = Services::get('schema')->sanitize($this->schemaName, $object->_data);
 
      $primaryDbProps = [];
      foreach ($this->primaryTableColumns as $propName => $columnName) {
         if ($propName !== 'id' && array_key_exists($propName, $sanitizedProps)) {
            $primaryDbProps[$columnName] = $this->convertToDB($sanitizedProps[$propName], $schema->properties->{$propName}->type);
            // Convert empty string values for DATETIME columns into null values
            // because an empty string can not be saved to a DATETIME column
            if ($primaryDbProps[$columnName] === ''
                  && isset($schema->properties->{$propName}->validation)
                  && (
                     in_array('date_format:Y-m-d H:i:s', $schema->properties->{$propName}->validation)
                     || in_array('date_format:Y-m-d', $schema->properties->{$propName}->validation)
                  )
            ) {
               $primaryDbProps[$columnName] = null;
            }
         }
      }
 
      return $primaryDbProps;
   }
}