current code from svn, revision 62608

1 files changed, 180 insertions, 0 deletions

diff --git a/lib/models/HelpContent.class.php b/lib/models/HelpContent.class.php
new file mode 100644
index 0000000..5a45970
--- /dev/null
+++ b/lib/models/HelpContent.class.php
@@ -0,0 +1,180 @@
+<?php
+// +---------------------------------------------------------------------------+
+// This file is part of Stud.IP
+//
+// Copyright (C) 2014 Arne Schröder <schroeder@data-quest>,
+// Suchi & Berg GmbH <info@data-quest.de>
+// +---------------------------------------------------------------------------+
+// This program 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 2
+// of the License, or any later version.
+// +---------------------------------------------------------------------------+
+// This program 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 this program; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// +---------------------------------------------------------------------------+
+//require_once 'lib/object.inc.php';
+
+/**
+ * HelpContent.class.php - model class for Stud.IP help content
+ *
+ *
+ *
+ *
+ * @author   Arne Schröder <schroeder@data-quest>
+ * @access   public
+ *
+ * @property string content_id database column
+ * @property string language database column
+ * @property string label database column
+ * @property string icon database column
+ * @property string content database column
+ * @property string route database column
+ * @property string studip_version database column
+ * @property string position database column
+ * @property string custom database column
+ * @property string visible database column
+ * @property string author_email database column
+ * @property string installation_id database column
+ * @property string mkdate database column
+ * @property string chdate database column
+ */
+class HelpContent extends SimpleORMap {
+    
+    /**
+     * fetches set of content from database for given route
+     * 
+     * @param string $route           route for help content
+     * @param string $language        language
+     * @return array                  set of help content
+     */
+    public static function GetContentByRoute($route = '', $language = '')
+    {
+        $language = $language ?: mb_substr($GLOBALS['user']->preferred_language, 0, 2);
+        if (!$language) {
+            $language = mb_substr(Config::get()->DEFAULT_LANGUAGE, 0, 2);
+        }
+        $version = Config::get()->getValue('HELP_CONTENT_CURRENT_VERSION');
+        if (!$version)
+            return [];
+        $route = get_route($route);
+        $query = "SELECT *
+                  FROM help_content
+                  WHERE route LIKE CONCAT(?, '%') AND language = ? AND visible = 1";
+        $statement = DBManager::get()->prepare($query);
+        $statement->execute([$route, $language]);
+        $ret = $statement->fetchGrouped(PDO::FETCH_ASSOC);
+        foreach ($ret as $index => $data)
+            if (! match_route($data['route'], $route))
+                unset($ret[$index]);
+        return $ret;
+    }
+
+    /**
+     * fetches content for given content_id
+     * 
+     * @param string $id              id of help content
+     * @return array                  help content object
+     */
+    public static function GetContentByID($id = '')
+    {
+        $query = "SELECT content_id AS idx, help_content.*
+                  FROM help_content
+                  WHERE content_id = ?";
+        $statement = DBManager::get()->prepare($query);
+        $statement->execute([$id]);
+        $ret = $statement->fetchGrouped(PDO::FETCH_ASSOC);
+        return current(HelpContent::GetContentObjects($ret));
+    }
+
+    /**
+     * fetches set of help content from database filtered by parameters
+     * 
+     * @param string $term            search term for content
+     * @param boolean $as_objects     include HelpContent objects in result array
+     * @return array                  set of help content
+     */
+    public static function GetContentByFilter($term = '')
+    {
+        $params = [];
+        $condition = '';
+        if (mb_strlen(trim($term)) >= 3) { 
+            $condition =  "WHERE content LIKE CONCAT('%', ?, '%')";
+            $params[] = $term;
+        }
+        $query = "SELECT content_id AS idx, help_content.*
+                  FROM help_content
+                  $condition
+                  ORDER BY route ASC";
+        $statement = DBManager::get()->prepare($query);
+        $statement->execute($params);
+        $ret = $statement->fetchGrouped(PDO::FETCH_ASSOC);
+        return HelpContent::GetContentObjects($ret);
+    }
+
+    /**
+     * fetches help content conflicts
+     * 
+     * @return array                  set of help content
+     */
+    public static function GetConflicts()
+    {
+        $conflicts = [];
+        $query = "SELECT content_id AS idx, help_content.*
+                  FROM help_content
+                  WHERE installation_id = ?
+                  ORDER BY route";
+        $statement = DBManager::get()->prepare($query);
+        $statement->execute([Config::get()->STUDIP_INSTALLATION_ID]);
+        $ret = $statement->fetchGrouped(PDO::FETCH_ASSOC);
+        foreach ($ret as $index => $data) {
+            $query = "SELECT content_id AS idx, help_content.*
+                      FROM help_content
+                      WHERE global_content_id = ? AND language = ? AND studip_version >= ? AND installation_id <> ?
+                      ORDER BY studip_version DESC LIMIT 1";
+            $statement = DBManager::get()->prepare($query);
+            $statement->execute([$data['global_content_id'], $data['language'], $data['studip_version'], Config::get()->STUDIP_INSTALLATION_ID]);
+            $ret2 = $statement->fetchGrouped(PDO::FETCH_ASSOC);
+            if (count($ret2)) {
+                $conflicts[] = HelpContent::GetContentObjects(array_merge([$index => $data], $ret2));
+            }
+        }
+        return $conflicts;
+    }
+
+    /**
+     * builds help content objects for given set of content data
+     * 
+     * @param array $content_result   content set
+     * @return array                  set of content objects
+     */
+    public static function GetContentObjects($content_result)
+    {
+        $objects = [];
+        if (is_array($content_result)){
+            foreach($content_result as $id => $result){
+                $objects[$id] = new HelpContent();
+                $objects[$id]->setData($result, true);
+                $objects[$id]->setNew(false);
+            }
+        }
+        return $objects;
+    }
+
+    /**
+     * configure SORM
+     * 
+     * @param array $config           configuration 
+     */
+    protected static function configure($config = [])
+    {
+        $config['db_table'] = 'help_content';
+        
+        parent::configure($config);
+    }
+}