AbstractItem::getTitle() - Code Metrics - Inspection of "make top button a button. fixes #2045" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c08467...5f28f7 )

by Andreas

created 2017-09-02 15:28 UTC

AbstractItem::getTitle() A

↳ Parent: AbstractItem

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace dokuwiki\Menu\Item;

/**
 * Class AbstractItem
 *
 * This class defines a single Item to be displayed in one of DokuWiki's menus. Plugins
 * can extend those menus through action plugins and add their own instances of this class,
 * overwriting some of its properties.
 *
 * Items may be shown multiple times in different contexts. Eg. for the default template
 * all menus are shown in a Dropdown list on mobile, but are split into several places on
 * desktop. The item's $context property can be used to hide the item depending on the current
 * context.
 *
 * Children usually just need to overwrite the different properties, but for complex things
 * the accessors may be overwritten instead.
 */
abstract class AbstractItem {

    /** menu item is to be shown on desktop screens only */
    const CTX_DESKTOP = 1;
    /** menu item is to be shown on mobile screens only */
    const CTX_MOBILE = 2;
    /** menu item is to be shown in all contexts */
    const CTX_ALL = 3;

    /** @var string name of the action, usually the lowercase class name */
    protected $type = '';
    /** @var string optional keyboard shortcut */
    protected $accesskey = '';
    /** @var string the page id this action links to */
    protected $id = '';
    /** @var string the method to be used when this action is used in a form */
    protected $method = 'get';
    /** @var array parameters for the action (should contain the do parameter) */
    protected $params = array();
    /** @var bool when true, a rel=nofollow should be used */
    protected $nofollow = true;
    /** @var string this item's label may contain a placeholder, which is replaced with this */
    protected $replacement = '';
    /** @var string the full path to the SVG icon of this menu item */
    protected $svg = DOKU_INC . 'lib/images/menu/00-default_checkbox-blank-circle-outline.svg';
    /** @var string can be set to overwrite the default lookup in $lang.btn_* */
    protected $label = '';
    /** @var string the tooltip title, defaults to $label */
    protected $title = '';
    /** @var int the context this titme is shown in */
    protected $context = self::CTX_ALL;

    /**
     * AbstractItem constructor.
     *
     * Sets the dynamic properties
     *
     * Children should always call the parent constructor!
     *
     * @throws \RuntimeException when the action is disabled
     */
    public function __construct() {
        global $ID;
        $this->id = $ID;
        $this->type = $this->getType();
        $this->params['do'] = $this->type;

        if(!actionOK($this->type)) throw new \RuntimeException("action disabled: {$this->type}");
    }

    /**
     * Return this item's label
     *
     * When the label property was set, it is simply returned. Otherwise, the action's type
     * is used to look up the translation in the main language file and, if used, the replacement
     * is applied.
     *
     * @return string
     */
    public function getLabel() {
        if($this->label !== '') return $this->label;

        /** @var array $lang */
        global $lang;
        $label = $lang['btn_' . $this->type];
        if(strpos($label, '%s')) {
            $label = sprintf($label, $this->replacement);
        }
        if($label === '') $label = '[' . $this->type . ']';
        return $label;
    }

    /**
     * Return this item's title
     *
     * This title should be used to display a tooltip (using the HTML title attribute). If
     * a title property was not explicitly set, the label will be returned.
     *
     * @return string
     */
    public function getTitle() {
        if($this->title === '') return $this->getLabel();
        return $this->title;
    }

    /**
     * Return the link this item links to
     *
     * Basically runs wl() on $id and $params. However if the ID is a hash it is used directly
     * as the link
     *
     * Please note that the generated URL is *not* XML escaped.
     *
     * @see wl()
     * @return string
     */
    public function getLink() {
        if($this->id[0] == '#') {
            return $this->id;
        } else {
            return wl($this->id, $this->params, false, '&');
        }
    }

    /**
     * Convenience method to get the attributes for constructing an <a> element
     *
     * @see buildAttributes()
     * @param string|false $classprefix create a class from type with this prefix, false for no class
     * @return array
     */
    public function getLinkAttributes($classprefix = 'menuitem ') {
        $attr = array(
            'href' => $this->getLink(),
            'title' => $this->getTitle(),
        );
        if($this->isNofollow()) $attr['rel'] = 'nofollow';
        if($this->getAccesskey()) {
            $attr['accesskey'] = $this->getAccesskey();
            $attr['title'] .= ' [' . $this->getAccesskey() . ']';
        }
        if($classprefix !== false) $attr['class'] = $classprefix . $this->getType();

        return $attr;
    }

    /**
     * Convenience method to create a full <a> element
     *
     * Wraps around the label and SVG image
     *
     * @param string|false $classprefix create a class from type with this prefix, false for no class
     * @param bool $svg add SVG icon to the link
     * @return string
     */
    public function asHtmlLink($classprefix = 'menuitem ', $svg = true) {
        $attr = buildAttributes($this->getLinkAttributes($classprefix));
        $html = "<a $attr>";
        if($svg) {
            $html .= '<span>' . hsc($this->getLabel()) . '</span>';
            $html .= inlineSVG($this->getSvg());
        } else {
            $html .= hsc($this->getLabel());
        }
        $html .= "</a>";

        return $html;
    }

    /**
     * Convenience method to create a <button> element inside it's own form element
     *
     * Uses html_btn()
     *
     * @todo this does currently not support the SVG icon
     * @return string
     */
    public function asHtmlButton() {
        return html_btn(
            $this->getType(),
            $this->id,
            $this->getAccesskey(),
            $this->getParams(),
            $this->method,
            $this->getTitle(),
            $this->getLabel()
        );
    }

    /**
     * Should this item be shown in the given context
     *
     * @param int $ctx the current context
     * @return bool
     */
    public function visibleInContext($ctx) {
        return (bool) ($ctx & $this->context);
    }

    /**
     * @return string the name of this item
     */
    public function getType() {
        if($this->type === '') {
            $this->type = strtolower(substr(strrchr(get_class($this), '\\'), 1));
        }
        return $this->type;
    }

    /**
     * @return string
     */
    public function getAccesskey() {
        return $this->accesskey;
    }

    /**
     * @return array
     */
    public function getParams() {
        return $this->params;
    }

    /**
     * @return bool
     */
    public function isNofollow() {
        return $this->nofollow;
    }

    /**
     * @return string
     */
    public function getSvg() {
        return $this->svg;
    }

    /**
     * Return this Item's settings as an array as used in tpl_get_action()
     *
     * @return array
     */
    public function getLegacyData() {
        return array(
            'accesskey' => $this->accesskey ? $this->accesskey : null,
            'type' => $this->type,
            'id' => $this->id,
            'method' => $this->method,
            'params' => $this->params,
            'nofollow' => $this->nofollow,
            'replacement' => $this->replacement
        );
    }
}


1			<?php
2
3			namespace dokuwiki\Menu\Item;
4
5			/**
6			* Class AbstractItem
7			*
8			* This class defines a single Item to be displayed in one of DokuWiki's menus. Plugins
9			* can extend those menus through action plugins and add their own instances of this class,
10			* overwriting some of its properties.
11			*
12			* Items may be shown multiple times in different contexts. Eg. for the default template
13			* all menus are shown in a Dropdown list on mobile, but are split into several places on
14			* desktop. The item's $context property can be used to hide the item depending on the current
15			* context.
16			*
17			* Children usually just need to overwrite the different properties, but for complex things
18			* the accessors may be overwritten instead.
19			*/
20			abstract class AbstractItem {
21
22			/** menu item is to be shown on desktop screens only */
23			const CTX_DESKTOP = 1;
24			/** menu item is to be shown on mobile screens only */
25			const CTX_MOBILE = 2;
26			/** menu item is to be shown in all contexts */
27			const CTX_ALL = 3;
28
29			/** @var string name of the action, usually the lowercase class name */
30			protected $type = '';
31			/** @var string optional keyboard shortcut */
32			protected $accesskey = '';
33			/** @var string the page id this action links to */
34			protected $id = '';
35			/** @var string the method to be used when this action is used in a form */
36			protected $method = 'get';
37			/** @var array parameters for the action (should contain the do parameter) */
38			protected $params = array();
39			/** @var bool when true, a rel=nofollow should be used */
40			protected $nofollow = true;
41			/** @var string this item's label may contain a placeholder, which is replaced with this */
42			protected $replacement = '';
43			/** @var string the full path to the SVG icon of this menu item */
44			protected $svg = DOKU_INC . 'lib/images/menu/00-default_checkbox-blank-circle-outline.svg';
45			/** @var string can be set to overwrite the default lookup in $lang.btn_* */
46			protected $label = '';
47			/** @var string the tooltip title, defaults to $label */
48			protected $title = '';
49			/** @var int the context this titme is shown in */
50			protected $context = self::CTX_ALL;
51
52			/**
53			* AbstractItem constructor.
54			*
55			* Sets the dynamic properties
56			*
57			* Children should always call the parent constructor!
58			*
59			* @throws \RuntimeException when the action is disabled
60			*/
61			public function __construct() {
62			global $ID;
63			$this->id = $ID;
64			$this->type = $this->getType();
65			$this->params['do'] = $this->type;
66
67			if(!actionOK($this->type)) throw new \RuntimeException("action disabled: {$this->type}");
68			}
69
70			/**
71			* Return this item's label
72			*
73			* When the label property was set, it is simply returned. Otherwise, the action's type
74			* is used to look up the translation in the main language file and, if used, the replacement
75			* is applied.
76			*
77			* @return string
78			*/
79			public function getLabel() {
80			if($this->label !== '') return $this->label;
81
82			/** @var array $lang */
83			global $lang;
84			$label = $lang['btn_' . $this->type];
85			if(strpos($label, '%s')) {
86			$label = sprintf($label, $this->replacement);
87			}
88			if($label === '') $label = '[' . $this->type . ']';
89			return $label;
90			}
91
92			/**
93			* Return this item's title
94			*
95			* This title should be used to display a tooltip (using the HTML title attribute). If
96			* a title property was not explicitly set, the label will be returned.
97			*
98			* @return string
99			*/
100			public function getTitle() {
101			if($this->title === '') return $this->getLabel();
102			return $this->title;
103			}
104
105			/**
106			* Return the link this item links to
107			*
108			* Basically runs wl() on $id and $params. However if the ID is a hash it is used directly
109			* as the link
110			*
111			* Please note that the generated URL is not XML escaped.
112			*
113			* @see wl()
114			* @return string
115			*/
116			public function getLink() {
117			if($this->id[0] == '#') {
118			return $this->id;
119			} else {
120			return wl($this->id, $this->params, false, '&');
121			}
122			}
123
124			/**
125			* Convenience method to get the attributes for constructing an <a> element
126			*
127			* @see buildAttributes()
128			* @param string\|false $classprefix create a class from type with this prefix, false for no class
129			* @return array
130			*/
131			public function getLinkAttributes($classprefix = 'menuitem ') {
132			$attr = array(
133			'href' => $this->getLink(),
134			'title' => $this->getTitle(),
135			);
136			if($this->isNofollow()) $attr['rel'] = 'nofollow';
137			if($this->getAccesskey()) {
138			$attr['accesskey'] = $this->getAccesskey();
139			$attr['title'] .= ' [' . $this->getAccesskey() . ']';
140			}
141			if($classprefix !== false) $attr['class'] = $classprefix . $this->getType();
142
143			return $attr;
144			}
145
146			/**
147			* Convenience method to create a full <a> element
148			*
149			* Wraps around the label and SVG image
150			*
151			* @param string\|false $classprefix create a class from type with this prefix, false for no class
152			* @param bool $svg add SVG icon to the link
153			* @return string
154			*/
155			public function asHtmlLink($classprefix = 'menuitem ', $svg = true) {
156			$attr = buildAttributes($this->getLinkAttributes($classprefix));
157			$html = "<a $attr>";
158			if($svg) {
159			$html .= '<span>' . hsc($this->getLabel()) . '</span>';
160			$html .= inlineSVG($this->getSvg());
161			} else {
162			$html .= hsc($this->getLabel());
163			}
164			$html .= "</a>";
165
166			return $html;
167			}
168
169			/**
170			* Convenience method to create a <button> element inside it's own form element
171			*
172			* Uses html_btn()
173			*
174			* @todo this does currently not support the SVG icon
175			* @return string
176			*/
177			public function asHtmlButton() {
178			return html_btn(
179			$this->getType(),
180			$this->id,
181			$this->getAccesskey(),
182			$this->getParams(),
183			$this->method,
184			$this->getTitle(),
185			$this->getLabel()
186			);
187			}
188
189			/**
190			* Should this item be shown in the given context
191			*
192			* @param int $ctx the current context
193			* @return bool
194			*/
195			public function visibleInContext($ctx) {
196			return (bool) ($ctx & $this->context);
197			}
198
199			/**
200			* @return string the name of this item
201			*/
202			public function getType() {
203			if($this->type === '') {
204			$this->type = strtolower(substr(strrchr(get_class($this), '\\'), 1));
205			}
206			return $this->type;
207			}
208
209			/**
210			* @return string
211			*/
212			public function getAccesskey() {
213			return $this->accesskey;
214			}
215
216			/**
217			* @return array
218			*/
219			public function getParams() {
220			return $this->params;
221			}
222
223			/**
224			* @return bool
225			*/
226			public function isNofollow() {
227			return $this->nofollow;
228			}
229
230			/**
231			* @return string
232			*/
233			public function getSvg() {
234			return $this->svg;
235			}
236
237			/**
238			* Return this Item's settings as an array as used in tpl_get_action()
239			*
240			* @return array
241			*/
242			public function getLegacyData() {
243			return array(
244			'accesskey' => $this->accesskey ? $this->accesskey : null,
245			'type' => $this->type,
246			'id' => $this->id,
247			'method' => $this->method,
248			'params' => $this->params,
249			'nofollow' => $this->nofollow,
250			'replacement' => $this->replacement
251			);
252			}
253			}
254

splitbrain / dokuwiki

Push — master ( c08467...5f28f7 )

AbstractItem::getTitle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like