MDL-41019 refactor string managers to new core_ classes

2013-08-08 09:10:25 +02:00
parent 50ff861263
commit 99a9d8d937
7 changed files with 1040 additions and 961 deletions
@@ -0,0 +1,129 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * String manager interface.
+ *
+ * @package    core
+ * @copyright  2010 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Interface for string manager
+ *
+ * Interface describing class which is responsible for getting
+ * of localised strings from language packs.
+ *
+ * @package    core
+ * @copyright  2010 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface core_string_manager {
+    /**
+     * Get String returns a requested string
+     *
+     * @param string $identifier The identifier of the string to search for
+     * @param string $component The module the string is associated with
+     * @param string|object|array $a An object, string or number that can be used
+     *      within translation strings
+     * @param string $lang moodle translation language, null means use current
+     * @return string The String !
+     */
+    public function get_string($identifier, $component = '', $a = null, $lang = null);
+
+    /**
+     * Does the string actually exist?
+     *
+     * get_string() is throwing debug warnings, sometimes we do not want them
+     * or we want to display better explanation of the problem.
+     *
+     * Use with care!
+     *
+     * @param string $identifier The identifier of the string to search for
+     * @param string $component The module the string is associated with
+     * @return bool true if exists
+     */
+    public function string_exists($identifier, $component);
+
+    /**
+     * Returns a localised list of all country names, sorted by country keys.
+     * @param bool $returnall return all or just enabled
+     * @param string $lang moodle translation language, null means use current
+     * @return array two-letter country code => translated name.
+     */
+    public function get_list_of_countries($returnall = false, $lang = null);
+
+    /**
+     * Returns a localised list of languages, sorted by code keys.
+     *
+     * @param string $lang moodle translation language, null means use current
+     * @param string $standard language list standard
+     *                     iso6392: three-letter language code (ISO 639-2/T) => translated name.
+     * @return array language code => translated name
+     */
+    public function get_list_of_languages($lang = null, $standard = 'iso6392');
+
+    /**
+     * Checks if the translation exists for the language
+     *
+     * @param string $lang moodle translation language code
+     * @param bool $includeall include also disabled translations
+     * @return bool true if exists
+     */
+    public function translation_exists($lang, $includeall = true);
+
+    /**
+     * Returns localised list of installed translations
+     * @param bool $returnall return all or just enabled
+     * @return array moodle translation code => localised translation name
+     */
+    public function get_list_of_translations($returnall = false);
+
+    /**
+     * Returns localised list of currencies.
+     *
+     * @param string $lang moodle translation language, null means use current
+     * @return array currency code => localised currency name
+     */
+    public function get_list_of_currencies($lang = null);
+
+    /**
+     * Load all strings for one component
+     * @param string $component The module the string is associated with
+     * @param string $lang
+     * @param bool $disablecache Do not use caches, force fetching the strings from sources
+     * @param bool $disablelocal Do not use customized strings in xx_local language packs
+     * @return array of all string for given component and lang
+     */
+    public function load_component_strings($component, $lang, $disablecache=false, $disablelocal=false);
+
+    /**
+     * Invalidates all caches, should the implementation use any
+     * @param bool $phpunitreset true means called from our PHPUnit integration test reset
+     */
+    public function reset_caches($phpunitreset = false);
+
+    /**
+     * Returns string revision counter, this is incremented after any
+     * string cache reset.
+     * @return int lang string revision counter, -1 if unknown
+     */
+    public function get_revision();
+}
+