added 'module.json' - options for modules

2015-01-13 13:48:01 +02:00
parent 63bea467c3
commit b947d667d6
4 changed files with 233 additions and 13 deletions
@@ -0,0 +1,99 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014  Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
+ * Website: http://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ ************************************************************************/
+
+namespace Espo\Core\Utils;
+
+class Module
+{
+    private $fileManager;
+
+    private $config;
+
+    private $unifier;
+
+    protected $data = null;
+
+    protected $cacheFile = 'data/cache/application/modules.php';
+
+    protected $paths = array(
+        'corePath' => 'application/Espo/Resources/module.json',
+        'modulePath' => 'application/Espo/Modules/{*}/Resources/module.json',
+        'customPath' => 'custom/Espo/Custom/Resources/module.json',
+    );
+
+    public function __construct(Config $config, File\Manager $fileManager)
+    {
+        $this->config = $config;
+        $this->fileManager = $fileManager;
+
+        $this->unifier = new \Espo\Core\Utils\File\FileUnifier($this->fileManager);
+    }
+
+    protected function getConfig()
+    {
+        return $this->config;
+    }
+
+    protected function getFileManager()
+    {
+        return $this->fileManager;
+    }
+
+    protected function getUnifier()
+    {
+        return $this->unifier;
+    }
+
+    public function get($key = '', $returns = null)
+    {
+        if (!isset($this->data)) {
+            $this->init();
+        }
+
+        if (empty($key)) {
+            return $this->data;
+        }
+
+        return Util::getValueByKey($this->data, $key, $returns);
+    }
+
+    public function getAll()
+    {
+        return $this->get();
+    }
+
+    protected function init()
+    {
+        if (file_exists($this->cacheFile) && $this->getConfig()->get('useCache')) {
+            $this->data = $this->getFileManager()->getContents($this->cacheFile);
+        } else {
+            $this->data = $this->getUnifier()->unify($this->paths, true);
+
+            if ($this->getConfig()->get('useCache')) {
+                $result = $this->getFileManager()->putContentsPHP($this->cacheFile, $this->data);
+                if ($result == false) {
+                    throw new \Espo\Core\Exceptions\Error('Module - Cannot save unified modules.');
+                }
+            }
+        }
+    }
+}