3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Database\Definition;
25 use Friendica\Core\Hook;
28 * Stores the whole View definitions
32 /** @var string the relative path to the database view config file */
33 const DBSTRUCTURE_RELATIVE_PATH = '/static/dbview.config.php';
35 /** @var array The complete view definition as an array */
36 protected $definition;
39 protected $configFile;
42 * @param string $basePath The basepath of the dbview file (loads relative path in case of null)
44 * @throws Exception in case the config file isn't available/readable
46 public function __construct(string $basePath)
48 $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
50 if (!is_readable($this->configFile)) {
51 throw new Exception('Missing database structure config file static/dbview.config.php at basePath=' . $basePath);
56 * @return array Returns the whole Definition as an array
58 public function getAll(): array
60 return $this->definition;
64 * Loads the database structure definition from the static/dbview.config.php file.
65 * On first pass, defines DB_UPDATE_VERSION constant.
67 * @param bool $withAddonStructure Whether to tack on addons additional tables
69 * @throws Exception in case the definition cannot be found
71 * @see static/dbview.config.php
73 * @return self The current instance
75 public function load(bool $withAddonStructure = false): self
77 $definition = require $this->configFile;
80 throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
83 if ($withAddonStructure) {
84 Hook::callAll('dbview_definition', $definition);
87 $this->definition = $definition;