PageRenderTime 36ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 0ms

/cache/stores/memcached/addinstanceform.php

https://bitbucket.org/moodle/moodle
PHP | 147 lines | 84 code | 22 blank | 41 comment | 13 complexity | 49a9c41169dd5f7e29a91fe5397e0feb MD5 | raw file
Possible License(s): Apache-2.0, LGPL-2.1, BSD-3-Clause, MIT, GPL-3.0
  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. * The library file for the memcached cache store.
  18. *
  19. * This file is part of the memcached cache store, it contains the API for interacting with an instance of the store.
  20. *
  21. * @package cachestore_memcached
  22. * @copyright 2012 Sam Hemelryk
  23. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24. */
  25. defined('MOODLE_INTERNAL') || die();
  26. require_once($CFG->dirroot.'/cache/forms.php');
  27. require_once($CFG->dirroot.'/cache/stores/memcached/lib.php');
  28. /**
  29. * Form for adding a memcached instance.
  30. *
  31. * @copyright 2012 Sam Hemelryk
  32. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33. */
  34. class cachestore_memcached_addinstance_form extends cachestore_addinstance_form {
  35. /**
  36. * Adds the desired form elements.
  37. */
  38. protected function configuration_definition() {
  39. global $OUTPUT;
  40. $form = $this->_form;
  41. $version = phpversion('memcached');
  42. $hasrequiredversion = ($version || version_compare($version, cachestore_memcached::REQUIRED_VERSION, '>='));
  43. if (!$hasrequiredversion) {
  44. $notify = new \core\output\notification(nl2br(get_string('upgrade200recommended', 'cachestore_memcached')),
  45. \core\output\notification::NOTIFY_WARNING);
  46. $form->addElement('html', $OUTPUT->render($notify));
  47. }
  48. $form->addElement('textarea', 'servers', get_string('servers', 'cachestore_memcached'), array('cols' => 75, 'rows' => 5));
  49. $form->addHelpButton('servers', 'servers', 'cachestore_memcached');
  50. $form->addRule('servers', get_string('required'), 'required');
  51. $form->setType('servers', PARAM_RAW);
  52. $form->addElement('selectyesno', 'compression', get_string('usecompression', 'cachestore_memcached'));
  53. $form->addHelpButton('compression', 'usecompression', 'cachestore_memcached');
  54. $form->setDefault('compression', 1);
  55. $form->setType('compression', PARAM_BOOL);
  56. $serialiseroptions = cachestore_memcached::config_get_serialiser_options();
  57. $form->addElement('select', 'serialiser', get_string('useserialiser', 'cachestore_memcached'), $serialiseroptions);
  58. $form->addHelpButton('serialiser', 'useserialiser', 'cachestore_memcached');
  59. $form->setDefault('serialiser', Memcached::SERIALIZER_PHP);
  60. $form->setType('serialiser', PARAM_INT);
  61. $form->addElement('text', 'prefix', get_string('prefix', 'cachestore_memcached'), array('size' => 16));
  62. $form->setType('prefix', PARAM_TEXT); // We set to text but we have a rule to limit to alphanumext.
  63. $form->addHelpButton('prefix', 'prefix', 'cachestore_memcached');
  64. $form->addRule('prefix', get_string('prefixinvalid', 'cachestore_memcached'), 'regex', '#^[a-zA-Z0-9\-_]+$#');
  65. $form->setForceLtr('prefix');
  66. $hashoptions = cachestore_memcached::config_get_hash_options();
  67. $form->addElement('select', 'hash', get_string('hash', 'cachestore_memcached'), $hashoptions);
  68. $form->addHelpButton('hash', 'hash', 'cachestore_memcached');
  69. $form->setDefault('serialiser', Memcached::HASH_DEFAULT);
  70. $form->setType('serialiser', PARAM_INT);
  71. $form->addElement('selectyesno', 'bufferwrites', get_string('bufferwrites', 'cachestore_memcached'));
  72. $form->addHelpButton('bufferwrites', 'bufferwrites', 'cachestore_memcached');
  73. $form->setDefault('bufferwrites', 0);
  74. $form->setType('bufferwrites', PARAM_BOOL);
  75. if ($hasrequiredversion) {
  76. // Only show this option if we have the required version of memcache extension installed.
  77. // If it's not installed then this option does nothing, so there is no point in displaying it.
  78. $form->addElement('selectyesno', 'isshared', get_string('isshared', 'cachestore_memcached'));
  79. $form->addHelpButton('isshared', 'isshared', 'cachestore_memcached');
  80. $form->setDefault('isshared', 0);
  81. $form->setType('isshared', PARAM_BOOL);
  82. }
  83. $form->addElement('header', 'clusteredheader', get_string('clustered', 'cachestore_memcached'));
  84. $form->addElement('checkbox', 'clustered', get_string('clustered', 'cachestore_memcached'));
  85. $form->setDefault('checkbox', false);
  86. $form->addHelpButton('clustered', 'clustered', 'cachestore_memcached');
  87. $form->addElement('textarea', 'setservers', get_string('setservers', 'cachestore_memcached'),
  88. array('cols' => 75, 'rows' => 5));
  89. $form->addHelpButton('setservers', 'setservers', 'cachestore_memcached');
  90. $form->disabledIf('setservers', 'clustered');
  91. $form->setType('setservers', PARAM_RAW);
  92. }
  93. /**
  94. * Perform minimal validation on the settings form.
  95. *
  96. * @param array $data
  97. * @param array $files
  98. */
  99. public function validation($data, $files) {
  100. $errors = parent::validation($data, $files);
  101. if (isset($data['clustered']) && ($data['clustered'] == 1)) {
  102. // Set servers is required with in cluster mode.
  103. if (!isset($data['setservers'])) {
  104. $errors['setservers'] = get_string('required');
  105. } else {
  106. $trimmed = trim($data['setservers']);
  107. if (empty($trimmed)) {
  108. $errors['setservers'] = get_string('required');
  109. }
  110. }
  111. $validservers = false;
  112. if (isset($data['servers'])) {
  113. $servers = trim($data['servers']);
  114. $servers = explode("\n", $servers);
  115. if (count($servers) === 1) {
  116. $validservers = true;
  117. }
  118. }
  119. if (!$validservers) {
  120. $errors['servers'] = get_string('serversclusterinvalid', 'cachestore_memcached');
  121. }
  122. }
  123. return $errors;
  124. }
  125. }