WebSVN – Moodle – Diff – /lib/classes/output/inplace_editable.php

 // 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/>.
-/**
- * Contains class \core\output\inplace_editable
- *
- * @package    core
- * @category   output
- * @copyright  2016 Marina Glancy
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-namespace core\output;
-use templatable;
+namespace core\output;
-use renderable;
 use lang_string;
-use pix_icon;
+use lang_string;
 /**
  * @package    core
  * @category   output
  * @copyright  2016 Marina Glancy
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class inplace_editable implements templatable, renderable {
+class inplace_editable implements renderable, templatable {
     /**
      * @var string component responsible for diplsying/updating
      */
     protected $component = null;
     /**
      * Constructor.
+     *
+     * @param string $component name of the component or plugin responsible for the updating of the value (must declare callback)
-     * @param string $component name of the component or plugin responsible for the updating of the value (must declare callback)
+     * @param string $itemtype type of the item inside the component
-     * @param string $itemtype type of the item inside the component - each component/plugin may implement multiple inplace-editable elements
+     *                         Each component/plugin may implement multiple inplace-editable elements.
      * @param int $itemid identifier of the item that can be edited in-place
      * @param bool $editable whether this value is editable (check capabilities and editing mode), if false, only "displayvalue"
      *              will be displayed without anything else
      * @param string $displayvalue what needs to be displayed to the user, it must be cleaned, with applied filters (call
      *              {@link format_string()}). It may be wrapped in an html link, contain icons or other decorations
      * @param string $value what needs to be edited - usually raw value from the database, it may contain multilang tags
      * @param lang_string|string $edithint hint (title) that will be displayed under the edit link
      * @param lang_string|string $editlabel label for the input element in the editing mode (for screenreaders)
      * @param pix_icon|null $editicon icon to use to toggle editing
      */
+    public function __construct(
+        $component,
+        $itemtype,
+        $itemid,
+        $editable,
+        $displayvalue,
+        $value = null,
+        $edithint = null,
-    public function __construct($component, $itemtype, $itemid, $editable,
+        $editlabel = null,
+        ?pix_icon $editicon = null
-            $displayvalue, $value = null, $edithint = null, $editlabel = null, ?pix_icon $editicon = null) {
+    ) {
         $this->component = $component;
         $this->itemtype = $itemtype;
         $this->itemid = $itemid;
         $this->editable = $editable;
      * @param array $options toggle options as simple, non-associative array; defaults to array(0,1)
      * @return self
      */
     public function set_type_toggle($options = null) {
         if ($options === null) {
-            $options = array(0, 1);
+            $options = [0, 1];
+        }
         $options = array_values($options);
         $idx = array_search($this->value, $options, true);
         if ($idx === false) {
             throw new \coding_exception('Specified value must be one of the toggle options');
      * @param \renderer_base $output typically, the renderer that's calling this function
      * @return array data context for a mustache template
      */
     public function export_for_template(\renderer_base $output) {
         if (!$this->editable) {
-            return array(
+            return [
-                'displayvalue' => (string)$this->displayvalue
+                'displayvalue' => (string)$this->displayvalue,
-            );
+            ];
+        }
         if ($this->editicon === null) {
             $this->editicon = new pix_icon('t/editstring', (string) $this->edithint);
         }
-        return array(
+        return [
             'component' => $this->component,
             'itemtype' => $this->itemtype,
             'itemid' => $this->itemid,
             'editlabel' => (string)$this->editlabel,
             'editicon' => $this->editicon->export_for_pix(),
             'type' => $this->type,
             'options' => $this->options,
             'linkeverything' => $this->get_linkeverything() ? 1 : 0,
-        );
+        ];
+    }
     /**
      * Renders this element

Proyectos de Subversion Moodle

(root)/lib/classes/output/inplace_editable.php – Rev 1 → 1441