<?php

namespace dokuwiki\Menu\Item;

/**
 * Class Top
 *
 * Scroll back to the top. Uses a hash as $id which is handled special in getLink().
 * Not shown in mobile context
 */
class Top extends AbstractItem {

    /** @inheritdoc */
    public function __construct() {
        parent::__construct();

        $this->svg = DOKU_INC_COMPAT . 'lib/images/menu/10-top_arrow-up.svg';
        $this->accesskey = 't';
        $this->params = array('do' => '');
        $this->id = '#dokuwiki__top';
        $this->context = self::CTX_DESKTOP;
    }

    /**
     * Convenience method to create a <button> element
     *
     * Uses html_topbtn()
     *
     * @todo this does currently not support the SVG icon
     * @return string
     */
    public function asHtmlButton() {
        return html_topbtn();
    }

}
