WebSVN – Moodle – Diff – /lib/listlib.php

+ *
  * @package    core
  * @subpackage lib
  * @copyright  Jamie Pratt
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+ * @todo Final removal in Moodle 6.0 MDL-80804.
  */
 defined('MOODLE_INTERNAL') || die();
  * page reload so everything is rebuilt from scratch.
+ *
  * @package moodlecore
  * @copyright Jamie Pratt
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+ * @todo Final removal in Moodle 6.0 MDL-80804.
  */
+#[\core\attribute\deprecated(null, since: 4.5, reason: 'No longer used in core code', mdl: 'MDL-72397')]
 abstract class moodle_list {
     public $attributes;
     public $listitemclassname = 'list_item';
      * @param boolean $editable
      * @param moodle_url $pageurl url for this page
      * @param integer $page if 0 no pagination. (These three params only used in top level list.)
      * @param string $pageparamname name of url param that is used for passing page no
      * @param integer $itemsperpage no of top level items.
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function __construct($type='ul', $attributes='', $editable = false, $pageurl=null, $page = 0, $pageparamname = 'page', $itemsperpage = 20) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $PAGE;
         $this->editable = $editable;
         $this->attributes = $attributes;
     /**
      * Returns html string.
+     *
+     * @param integer $indent depth of indentation.
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * @param integer $indent depth of indentation.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function to_html($indent=0, $extraargs=array()) {
-    public function to_html($indent=0, $extraargs=array()) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         if (count($this->items)) {
             $tabs = str_repeat("\t", $indent);
             $first = true;
             $itemiter = 1;
      * Recurse down the tree and find an item by it's id.
+     *
      * @param integer $id
      * @param boolean $suppresserror error if not item found?
      * @return list_item *copy* or null if item is not found
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function find_item($id, $suppresserror = false) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         if (isset($this->items)) {
             foreach ($this->items as $key => $child) {
                 if ($child->id == $id) {
                     return $this->items[$key];
+                }
             throw new \moodle_exception('listnoitem');
+        }
         return null;
+    }
+    /**
+     * Add list item
+     *
+     * @param $item
+     * @return void
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function add_item($item) {
-    public function add_item($item) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $this->items[] = $item;
+    }
+    /**
+     * Set parent item.
+     *
+     * @param $parent
+     * @return void
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
      * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
     public function set_parent($parent) {
-    public function set_parent($parent) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $this->parentitem = $parent;
+    }
      * If the parent field doesn't point to another record in the array then this is
      * a top level list
+     *
      * @param integer $offset how many list toplevel items are there in lists before this one
      * @return array(boolean, integer) whether there is more than one page, $offset + how many toplevel items where there in this list.
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     *
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function list_from_records($paged = false, $offset = 0) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $this->paged = $paged;
         $this->offset = $offset;
         $this->get_records();
         $records = $this->records;
         $page = $this->page;
         return array($this->paged, $itemiter);
+    }
     /**
+     * Should be overriden to return an array of records of list items.
+     *
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * Should be overriden to return an array of records of list items.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     abstract public function get_records();
+    /**
+     * display list of page numbers for navigation
+     *
-    /**
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * display list of page numbers for navigation
+     * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
-     */
+    public function display_page_numbers() {
-    public function display_page_numbers() {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $html = '';
         $topcount = count($this->items);
         $this->pagecount = (integer) ceil(($topcount + $this->offset)/ QUESTION_PAGE_LENGTH );
     /**
      * Returns an array of ids of peers of an item.
+     *
      * @param    int itemid - if given, restrict records to those with this parent id.
      * @return   array peer ids
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function get_items_peers($itemid) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $itemref = $this->find_item($itemid);
         $peerids = $itemref->parentlist->get_child_ids();
         return $peerids;
+    }
     /**
      * Returns an array of ids of child items.
+     *
+     * @return   array peer ids
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * @return   array peer ids
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function get_child_ids() {
-    public function get_child_ids() {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $childids = array();
         foreach ($this->items as $child) {
            $childids[] = $child->id;
+        }
      * Returns the value to be used as the parent for the $item when it goes to the top level.
      * Override if needed.
+     *
      * @param list_item $item The item which its top level parent is going to be returned.
      * @return int
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function get_top_level_parent_id($item) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         return 0; // Top level items have no parent.
+    }
     /**
      * Move a record up or down
+     *
      * @param string $direction up / down
+     * @param integer $id
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * @param integer $id
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function move_item_up_down($direction, $id) {
-    public function move_item_up_down($direction, $id) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $peers = $this->get_items_peers($id);
         $itemkey = array_search($id, $peers);
         switch ($direction) {
             case 'down' :
                 break;
+        }
         $this->reorder_peers($peers);
+    }
+    /**
+     * Reorder peers
+     *
+     * @param $peers
+     * @return void
+     * @throws dml_exception
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function reorder_peers($peers) {
-    public function reorder_peers($peers) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $DB;
         foreach ($peers as $key => $peer) {
             $DB->set_field($this->table, "sortorder", $key, array("id"=>$peer));
+        }
     /**
      * Moves the item one step up in the tree.
+     *
      * @param int $id an item index.
      * @return list_item the item that used to be the parent of the item moved.
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function move_item_left($id) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $DB;
         $item = $this->find_item($id);
         if (!isset($item->parentlist->parentitem->parentlist)) {
     /**
      * Make item with id $id the child of the peer that is just above it in the sort order.
+     *
+     * @param integer $id
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * @param integer $id
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function move_item_right($id) {
-    public function move_item_right($id) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $DB;
         $peers = $this->get_items_peers($id);
      * @param integer $left id of item to move left
      * @param integer $right id of item to move right
      * @param integer $moveup id of item to move up
      * @param integer $movedown id of item to move down
      * @return unknown
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function process_actions($left, $right, $moveup, $movedown) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         //should this action be processed by this list object?
         if (!(array_key_exists($left, $this->records) || array_key_exists($right, $this->records) || array_key_exists($moveup, $this->records) || array_key_exists($movedown, $this->records))) {
             return false;
+        }
         if (!empty($left)) {
     /**
      * @param integer $itemid an item id.
      * @return boolean Is the item with the given id the first top-level item on
+     * the current page?
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * the current page?
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function item_is_first_on_page($itemid) {
-    public function item_is_first_on_page($itemid) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         return $this->page && isset($this->items[$this->firstitem]) &&
                 $itemid == $this->items[$this->firstitem]->id;
+    }
     /**
      * @param integer $itemid an item id.
+     * @return boolean Is the item with the given id the last top-level item on
+     * the current page?
-     * @return boolean Is the item with the given id the last top-level item on
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * the current page?
+     * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
-     */
+    public function item_is_last_on_page($itemid) {
-    public function item_is_last_on_page($itemid) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         return $this->page && isset($this->items[$this->lastitem]) &&
                 $itemid == $this->items[$this->lastitem]->id;
+    }
+}
 /**
+ * @package moodlecore
+ * @copyright Jamie Pratt
- * @package moodlecore
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
- * @copyright Jamie Pratt
+ * @todo Final removal in Moodle 6.0 MDL-80804.
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
- */
+#[\core\attribute\deprecated(null, since: '4.5', reason: 'No longer used in core code.', mdl: 'MDL-72397')]
 abstract class list_item {
     /** @var moodle_list Set if there are any children of this listitem. */
     public $children;
     /**
+     * Constructor
      * Constructor
      * @param mixed $item fragment of html for list item or record
      * @param object $parent reference to parent of this item
      * @param string $attributes attributes for li tag
      * @param boolean $display whether this item is displayed. Some items may be loaded so we have a complete
      *                              structure in memory to work with for actions but are not displayed.
+     * @return list_item
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
-     * @return list_item
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function __construct($item, $parent, $attributes = '', $display = true) {
-    public function __construct($item, $parent, $attributes = '', $display = true) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         $this->item = $item;
         if (is_object($this->item)) {
             $this->id = $this->item->id;
             $this->name = $this->item->{$this->fieldnamesname};
+    }
     /**
      * Output the html just for this item. Called by to_html which adds html for children.
+     *
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
      * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function item_html($extraargs = array()) {
-    public function item_html($extraargs = array()) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         if (is_string($this->item)) {
             $html = $this->item;
         } elseif (is_object($this->item)) {
             //for debug purposes only. You should create a sub class to
+     *
      * @param integer $indent
      * @param array $extraargs any extra data that is needed to print the list item
      *                            may be used by sub class.
      * @return string html
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function to_html($indent = 0, $extraargs = array()) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         if (!$this->display) {
             return '';
+        }
         $tabs = str_repeat("\t", $indent);
             $childrenhtml = '';
+        }
         return $this->item_html($extraargs).'&nbsp;'.(join('', $this->icons)).(($childrenhtml !='')?("\n".$childrenhtml):'');
+    }
+    /**
+     * Set icon HTML
+     *
+     * @param $first
+     * @param $last
+     * @param $lastitem
+     * @return void
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function set_icon_html($first, $last, $lastitem) {
-    public function set_icon_html($first, $last, $lastitem) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $CFG;
         $strmoveup = get_string('moveup');
         $strmovedown = get_string('movedown');
         } else {
             $this->icons['right'] =  $this->image_spacer();
+        }
+    }
+    /**
+     * Return image icon HTML
+     *
+     * @param $action
+     * @param $url
+     * @param $icon
+     * @return string
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
      */
+    public function image_icon($action, $url, $icon) {
-    public function image_icon($action, $url, $icon) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $OUTPUT;
         return '<a title="' . s($action) .'" href="'.$url.'">' .
                 $OUTPUT->pix_icon('t/' . $icon, $action) . '</a> ';
+    }
+    /**
+     * Return image spacer HTML
+     *
+     * @return mixed
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
      * @todo Final removal in Moodle 6.0 MDL-80804.
+     */
     public function image_spacer() {
-    public function image_spacer() {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         global $OUTPUT;
         return $OUTPUT->spacer();
+    }
     /**
      * Recurse down tree creating list_items, called from moodle_list::list_from_records
+     *
+     * @param array $records
+     * @param array $children
-     * @param array $records
+     * @param integer $thisrecordid
-     * @param array $children
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
+     * @todo Final removal in Moodle 6.0 MDL-80804.
-     * @param integer $thisrecordid
+     */
-     */
+    public function create_children(&$records, &$children, $thisrecordid) {
-    public function create_children(&$records, &$children, $thisrecordid) {
+        \core\deprecation::emit_deprecation([$this, __FUNCTION__]);
         //keys where value is $thisrecordid
         $thischildren = moodle_array_keys_filter($children, $thisrecordid);
         foreach ($thischildren as $child) {
             $thisclass = get_class($this);
             $newlistitem = new $thisclass($records[$child], $this->children, $this->attributes);
             $this->children->add_item($newlistitem);
+            $newlistitem->create_children($records, $children, $records[$child]->id);
+        }
+    }
+    /**
+     * Set parent list
+     *
+     * @param $parent
-            $newlistitem->create_children($records, $children, $records[$child]->id);
+     * @return void
+     * @deprecated Since Moodle 4.5 MDL-72397. This is no longer used in core code.
      * @todo Final removal in Moodle 6.0 MDL-80804.
      */
     public function set_parent($parent) {

Proyectos de Subversion Moodle

(root)/lib/listlib.php – Rev 1 → 1441