src/Database/Definition/ViewDefinition.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Database\Definition;
  23
  24 use Exception;
  25 use Friendica\Core\Hook;
  26
  27 /**
  28  * Stores the whole View definitions
  29  */
  30 class ViewDefinition
  31 {
  32         /** @var string the relative path to the database view config file */
  33         const DBSTRUCTURE_RELATIVE_PATH = '/static/dbview.config.php';
  34
  35         /** @var array The complete view definition as an array */
  36         protected $definition;
  37
  38         /** @var string */
  39         protected $configFile;
  40
  41         /**
  42          * @param string $basePath The basepath of the dbview file (loads relative path in case of null)
  43          *
  44          * @throws Exception in case the config file isn't available/readable
  45          */
  46         public function __construct(string $basePath)
  47         {
  48                 $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
  49
  50                 if (!is_readable($this->configFile)) {
  51                         throw new Exception('Missing database structure config file static/dbview.config.php at basePath=' . $basePath);
  52                 }
  53         }
  54
  55         /**
  56          * @return array Returns the whole Definition as an array
  57          */
  58         public function getAll(): array
  59         {
  60                 return $this->definition;
  61         }
  62
  63         /**
  64          * Loads the database structure definition from the static/dbview.config.php file.
  65          * On first pass, defines DB_UPDATE_VERSION constant.
  66          *
  67          * @param bool  $withAddonStructure Whether to tack on addons additional tables
  68          *
  69          * @throws Exception in case the definition cannot be found
  70          *
  71          * @see static/dbview.config.php
  72          *
  73          * @return self The current instance
  74          */
  75         public function load(bool $withAddonStructure = false): self
  76         {
  77                 $definition = require $this->configFile;
  78
  79                 if (!$definition) {
  80                         throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
  81                 }
  82
  83                 if ($withAddonStructure) {
  84                         Hook::callAll('dbview_definition', $definition);
  85                 }
  86
  87                 $this->definition = $definition;
  88
  89                 return $this;
  90         }
  91 }