Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * The library file for the memcached cache store.
  19   *
  20   * This file is part of the memcached cache store, it contains the API for interacting with an instance of the store.
  21   *
  22   * @package    cachestore_memcached
  23   * @copyright  2012 Sam Hemelryk
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  $string['bufferwrites'] = 'Buffer writes';
  30  $string['bufferwrites_help'] = 'Enables or disables buffered I/O. Enabling buffered I/O causes storage commands to "buffer" instead of being sent. Any action that retrieves data causes this buffer to be sent to the remote connection. Quitting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.';
  31  $string['clustered'] = 'Enable clustered servers';
  32  $string['clustered_help'] = 'This is used to allow read-one, set-multi functionality.
  33  
  34  The intended use case is to create an improved store for load-balanced configurations. The store will fetch from one server (usually localhost), but set to many (all the servers in the load-balance pool). For caches with very high read to set ratios, this saves a significant amount of network overhead.
  35  
  36  When this setting is enabled, the server listed above will be used for fetching.';
  37  $string['clusteredheader'] = 'Split servers';
  38  $string['hash'] = 'Hash method';
  39  $string['hash_help'] = 'Specifies the hashing algorithm used for the item keys. Each hash algorithm has its advantages and its disadvantages. Go with the default if you don\'t know or don\'t care.';
  40  $string['hash_default'] = 'Default (one-at-a-time)';
  41  $string['hash_md5'] = 'MD5';
  42  $string['hash_crc'] = 'CRC';
  43  $string['hash_fnv1_64'] = 'FNV1_64';
  44  $string['hash_fnv1a_64'] = 'FNV1A_64';
  45  $string['hash_fnv1_32'] = 'FNV1_32';
  46  $string['hash_fnv1a_32'] = 'FNV1A_32';
  47  $string['hash_hsieh'] = 'Hsieh';
  48  $string['hash_murmur'] = 'Murmur';
  49  $string['isshared'] = 'Shared cache';
  50  $string['isshared_help'] = "Is your memcached server also being used by other applications?
  51  
  52  If the cache is shared by other applications then each key will be deleted individually to ensure that only data owned by this application is purged (leaving external application cache data unchanged). This can result in reduced performance when purging the cache, depending on your server configuration.
  53  
  54  If you are running a dedicated cache for this application then the entire cache can safely be flushed without any risk of destroying another application's cache data. This should result in increased performance when purging the cache.
  55  ";
  56  $string['pluginname'] = 'Memcached';
  57  $string['privacy:metadata:memcached'] = 'The Memcached cachestore plugin stores data briefly as part of its caching functionality. This data is stored on an Memcache server where data is regularly removed.';
  58  $string['privacy:metadata:memcached:data'] = 'The various data stored in the cache';
  59  $string['prefix'] = 'Prefix key';
  60  $string['prefix_help'] = 'This can be used to create a "domain" for your item keys allowing you to create multiple memcached stores on a single memcached installation. It cannot be longer than 16 characters in order to ensure key length issues are not encountered.';
  61  $string['prefixinvalid'] = 'Invalid prefix. You can only use a-z A-Z 0-9-_.';
  62  $string['serialiser_igbinary'] = 'The igbinary serializer.';
  63  $string['serialiser_json'] = 'The JSON serializer.';
  64  $string['serialiser_php'] = 'The default PHP serializer.';
  65  $string['servers'] = 'Servers';
  66  $string['servers_help'] = 'This sets the servers that should be utilised by this memcached adapter.
  67  Servers should be defined one per line and consist of a server address and optionally a port and weight.
  68  If no port is provided then the default port (11211) is used.
  69  
  70  For example:
  71  <pre>
  72  server.url.com
  73  ipaddress:port
  74  servername:port:weight
  75  </pre>
  76  
  77  If *Enable clustered servers* is enabled below, there must be only one server listed here. This would usually be a name that always resolves to the local machine, like 127.0.0.1 or localhost.';
  78  $string['serversclusterinvalid'] = 'Exactly one server is required when clustering is enabled.';
  79  $string['setservers'] = 'Set Servers';
  80  $string['setservers_help'] = 'This is the list of servers that will be updated when data is modified in the cache. Generally the fully qualified name of each server in the pool.
  81  It **must** include the server listed in *Servers* above, even if by a different hostname.
  82  Servers should be defined one per line and consist of a server address and optionally a port.
  83  If no port is provided then the default port (11211) is used.
  84  
  85  For example:
  86  <pre>
  87  server.url.com
  88  ipaddress:port
  89  </pre>';
  90  $string['sessionhandlerconflict'] = 'Warning: A memcached instance ({$a}) has being configured to use the same memcached server as sessions. Purging all caches will lead to sessions also being purged.';
  91  $string['testservers'] = 'Test servers';
  92  $string['testservers_desc'] = 'One or more connection strings for memcached servers to test against. If a test server has been specified then memcached performance can be tested using the cache performance page in the administration block.
  93  As an example: 127.0.0.1:11211';
  94  $string['usecompression'] = 'Use compression';
  95  $string['usecompression_help'] = 'Enables or disables payload compression. When enabled, item values longer than a certain threshold (currently 100 bytes) will be compressed during storage and decompressed during retrieval transparently.';
  96  $string['useserialiser'] = 'Use serialiser';
  97  $string['useserialiser_help'] = 'Specifies the serializer to use for serializing non-scalar values.
  98  The valid serializers are Memcached::SERIALIZER_PHP or Memcached::SERIALIZER_IGBINARY.
  99  The latter is supported only when memcached is configured with --enable-memcached-igbinary option and the igbinary extension is loaded.';
 100  $string['upgrade200recommended'] = 'We recommend you upgrade your Memcached PHP extension to version 2.0.0 or greater.
 101  The version of the Memcached PHP extension you are currently using does not provide the functionality Moodle uses to ensure a sandboxed cache. Until you upgrade we recommend you do not configure any other applications to use the same Memcached servers as Moodle is configured to use.';