123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645 |
- <?php
- /**
- * Elgg Menu Item
- *
- * To create a menu item that is not a link, pass false for $href.
- *
- * Any undocumented properties set will be passed to the output/url view during rendering. E.g.
- * to give a menu item a "target" attribute, set $item->target, or include a "target" key in
- * the options array for factory().
- *
- * @package Elgg.Core
- * @subpackage Navigation
- * @since 1.8.0
- */
- class ElggMenuItem {
- /**
- * @var array Non-rendered data about the menu item
- */
- protected $data = array(
- // string Identifier of the menu
- 'name' => '',
- // array Page contexts this menu item should appear on
- 'contexts' => array('all'),
- // string Menu section identifier
- 'section' => 'default',
- // int Smaller priorities float to the top
- 'priority' => 100,
- // bool Is this the currently selected menu item
- 'selected' => false,
- // string Identifier of this item's parent
- 'parent_name' => '',
- // \ElggMenuItem The parent object or null
- 'parent' => null,
- // array Array of children objects or empty array
- 'children' => array(),
- // array Classes to apply to the li tag
- 'itemClass' => array(),
- // array Classes to apply to the anchor tag
- 'linkClass' => array(),
- );
- /**
- * @var string The menu display string (HTML)
- */
- protected $text;
- /**
- * @var string The menu url
- */
- protected $href = null;
- /**
- * @var string Tooltip
- */
- protected $title = false;
- /**
- * @var string The string to display if link is clicked
- */
- protected $confirm = '';
- /**
- * \ElggMenuItem constructor
- *
- * @param string $name Identifier of the menu item
- * @param string $text Display text of the menu item (HTML)
- * @param string $href URL of the menu item (false if not a link)
- */
- public function __construct($name, $text, $href) {
- $this->text = $text;
- if ($href) {
- $this->href = elgg_normalize_url($href);
- } else {
- $this->href = $href;
- }
- $this->data['name'] = $name;
- }
- /**
- * Create an ElggMenuItem from an associative array. Required keys are name, text, and href.
- *
- * @param array $options Option array of key value pairs
- *
- * name => STR Menu item identifier (required)
- * text => STR Menu item display text as HTML (required)
- * href => STR Menu item URL (required) (false for non-links.
- * @warning If you disable the href the <a> tag will
- * not appear, so the link_class will not apply. If you
- * put <a> tags in manually through the 'text' option
- * the default CSS selector .elgg-menu-$menu > li > a
- * may affect formatting. Wrap in a <span> if it does.)
- *
- * section => STR Menu section identifier
- * link_class => STR A class or classes for the <a> tag
- * item_class => STR A class or classes for the <li> tag
- * parent_name => STR Identifier of the parent menu item
- * contexts => ARR Page context strings
- * title => STR Menu item tooltip
- * selected => BOOL Is this menu item currently selected?
- * confirm => STR If set, the link will be drawn with the output/confirmlink view instead of output/url.
- * data => ARR Custom attributes stored in the menu item.
- *
- * @return ElggMenuItem or null on error
- */
- public static function factory($options) {
- if (!isset($options['name']) || !isset($options['text'])) {
- return null;
- }
- if (!isset($options['href'])) {
- $options['href'] = '';
- }
- $item = new \ElggMenuItem($options['name'], $options['text'], $options['href']);
- unset($options['name']);
- unset($options['text']);
- unset($options['href']);
- // special catch in case someone uses context rather than contexts
- if (isset($options['context'])) {
- $options['contexts'] = $options['context'];
- unset($options['context']);
- }
-
- // make sure contexts is set correctly
- if (isset($options['contexts'])) {
- $item->setContext($options['contexts']);
- unset($options['contexts']);
- }
- if (isset($options['link_class'])) {
- $item->setLinkClass($options['link_class']);
- unset($options['link_class']);
- } elseif (isset($options['class'])) {
- elgg_deprecated_notice("\ElggMenuItem::factory() does not accept 'class' key anymore, use 'link_class' instead", 1.9);
- $item->setLinkClass($options['class']);
- unset($options['class']);
- }
- if (isset($options['item_class'])) {
- $item->setItemClass($options['item_class']);
- unset($options['item_class']);
- }
- if (isset($options['data']) && is_array($options['data'])) {
- $item->setData($options['data']);
- unset($options['data']);
- }
-
- foreach ($options as $key => $value) {
- if (isset($item->data[$key])) {
- $item->data[$key] = $value;
- } else {
- $item->$key = $value;
- }
- }
- return $item;
- }
- /**
- * Set a data key/value pair or a set of key/value pairs
- *
- * This method allows storage of arbitrary data with this menu item. The
- * data can be used for sorting, custom rendering, or any other use.
- *
- * @param mixed $key String key or an associative array of key/value pairs
- * @param mixed $value The value if $key is a string
- * @return void
- */
- public function setData($key, $value = null) {
- if (is_array($key)) {
- $this->data = array_merge($this->data, $key);
- } else {
- $this->data[$key] = $value;
- }
- }
- /**
- * Get stored data
- *
- * @param string $key The key for the requested key/value pair
- * @return mixed
- */
- public function getData($key) {
- if (isset($this->data[$key])) {
- return $this->data[$key];
- } else {
- return null;
- }
- }
- /**
- * Set the identifier of the menu item
- *
- * @param string $name Unique identifier
- * @return void
- */
- public function setName($name) {
- $this->data['name'] = $name;
- }
- /**
- * Get the identifier of the menu item
- *
- * @return string
- */
- public function getName() {
- return $this->data['name'];
- }
- /**
- * Set the display text of the menu item
- *
- * @param string $text The display text as HTML
- * @return void
- */
- public function setText($text) {
- $this->text = $text;
- }
- /**
- * Get the display text of the menu item
- *
- * @return string The display text as HTML
- */
- public function getText() {
- return $this->text;
- }
- /**
- * Set the URL of the menu item
- *
- * @param string $href URL or false if not a link
- * @return void
- * @todo this should probably normalize
- */
- public function setHref($href) {
- $this->href = $href;
- }
- /**
- * Get the URL of the menu item
- *
- * @return string
- */
- public function getHref() {
- return $this->href;
- }
- /**
- * Set the contexts that this menu item is available for
- *
- * @param array $contexts An array of context strings. Use 'all' to match all contexts.
- * @return void
- */
- public function setContext($contexts) {
- if (is_string($contexts)) {
- $contexts = array($contexts);
- }
- $this->data['contexts'] = $contexts;
- }
- /**
- * Get an array of context strings
- *
- * @return array
- */
- public function getContext() {
- return $this->data['contexts'];
- }
- /**
- * Should this menu item be used given the current context
- *
- * @param string $context A context string (default is empty string for
- * current context stack).
- * @return bool
- */
- public function inContext($context = '') {
- if (in_array('all', $this->data['contexts'])) {
- return true;
- }
- if ($context) {
- return in_array($context, $this->data['contexts']);
- }
- foreach ($this->data['contexts'] as $context) {
- if (elgg_in_context($context)) {
- return true;
- }
- }
- return false;
- }
- /**
- * Set the selected flag
- *
- * @param bool $state Selected state (default is true)
- * @return void
- */
- public function setSelected($state = true) {
- $this->data['selected'] = $state;
- }
- /**
- * Get selected state
- *
- * @return bool
- */
- public function getSelected() {
- return $this->data['selected'];
- }
- /**
- * Set the tool tip text
- *
- * @param string $text The text of the tool tip
- * @return void
- */
- public function setTooltip($text) {
- $this->title = $text;
- }
- /**
- * Get the tool tip text
- *
- * @return string
- */
- public function getTooltip() {
- return $this->title;
- }
- /**
- * Set the confirm text shown when link is clicked
- *
- * @param string $text The text to show
- * @return void
- */
- public function setConfirmText($text) {
- $this->confirm = $text;
- }
- /**
- * Get the confirm text
- *
- * @return string
- */
- public function getConfirmText() {
- return $this->confirm;
- }
- /**
- * Set the anchor class
- *
- * @param mixed $class An array of class names, or a single string class name.
- * @return void
- */
- public function setLinkClass($class) {
- if (!is_array($class)) {
- $this->data['linkClass'] = array($class);
- } else {
- $this->data['linkClass'] = $class;
- }
- }
- /**
- * Get the anchor classes as text
- *
- * @return string
- */
- public function getLinkClass() {
- return implode(' ', $this->data['linkClass']);
- }
- /**
- * Add a link class
- *
- * @param mixed $class An array of class names, or a single string class name.
- * @return void
- */
- public function addLinkClass($class) {
- $this->addClass($this->data['linkClass'], $class);
- }
- /**
- * Set the li classes
- *
- * @param mixed $class An array of class names, or a single string class name.
- * @return void
- */
- public function setItemClass($class) {
- if (!is_array($class)) {
- $this->data['itemClass'] = array($class);
- } else {
- $this->data['itemClass'] = $class;
- }
- }
- /**
- * Get the li classes as text
- *
- * @return string
- */
- public function getItemClass() {
- // allow people to specify name with underscores and colons
- $name = strtolower($this->getName());
- $name = str_replace('_', '-', $name);
- $name = str_replace(':', '-', $name);
- $name = str_replace(' ', '-', $name);
- $class = implode(' ', $this->data['itemClass']);
- if ($class) {
- return "elgg-menu-item-$name $class";
- } else {
- return "elgg-menu-item-$name";
- }
- }
- /**
- * Add a li class
- *
- * @param mixed $class An array of class names, or a single string class name.
- * @return void
- * @since 1.9.0
- */
- public function addItemClass($class) {
- $this->addClass($this->data['itemClass'], $class);
- }
- // @codingStandardsIgnoreStart
- /**
- * Add additional classes
- *
- * @param array $current The current array of classes
- * @param mixed $additional Additional classes (either array of string)
- * @return void
- */
- protected function addClass(array &$current, $additional) {
- if (!is_array($additional)) {
- $current[] = $additional;
- } else {
- $current = array_merge($current, $additional);
- }
- }
- // @codingStandardsIgnoreEnd
- /**
- * Set the priority of the menu item
- *
- * @param int $priority The smaller numbers mean higher priority (1 before 100)
- * @return void
- * @deprecated 1.9 Use setPriority()
- */
- public function setWeight($priority) {
- elgg_deprecated_notice("\ElggMenuItem::setWeight() deprecated by \ElggMenuItem::setPriority()", 1.9);
- $this->data['priority'] = $priority;
- }
- /**
- * Get the priority of the menu item
- *
- * @return int
- * @deprecated 1.9 Use getPriority()
- */
- public function getWeight() {
- elgg_deprecated_notice("\ElggMenuItem::getWeight() deprecated by \ElggMenuItem::getPriority()", 1.9);
- return $this->data['priority'];
- }
- /**
- * Set the priority of the menu item
- *
- * @param int $priority The smaller numbers mean higher priority (1 before 100)
- * @return void
- */
- public function setPriority($priority) {
- $this->data['priority'] = $priority;
- }
- /**
- * Get the priority of the menu item
- *
- * @return int
- */
- public function getPriority() {
- return $this->data['priority'];
- }
- /**
- * Set the section identifier
- *
- * @param string $section The identifier of the section
- * @return void
- */
- public function setSection($section) {
- $this->data['section'] = $section;
- }
- /**
- * Get the section identifier
- *
- * @return string
- */
- public function getSection() {
- return $this->data['section'];
- }
- /**
- * Set the parent identifier
- *
- * @param string $name The identifier of the parent \ElggMenuItem
- * @return void
- */
- public function setParentName($name) {
- $this->data['parent_name'] = $name;
- }
- /**
- * Get the parent identifier
- *
- * @return string
- */
- public function getParentName() {
- return $this->data['parent_name'];
- }
- /**
- * Set the parent menu item
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @param \ElggMenuItem $parent The parent of this menu item
- * @return void
- * @access private
- */
- public function setParent($parent) {
- $this->data['parent'] = $parent;
- }
- /**
- * Get the parent menu item
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @return \ElggMenuItem or null
- * @access private
- */
- public function getParent() {
- return $this->data['parent'];
- }
- /**
- * Add a child menu item
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @param \ElggMenuItem $item A child menu item
- * @return void
- * @access private
- */
- public function addChild($item) {
- $this->data['children'][] = $item;
- }
- /**
- * Set the menu item's children
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @param array $children Array of \ElggMenuItems
- * @return void
- * @access private
- */
- public function setChildren($children) {
- $this->data['children'] = $children;
- }
- /**
- * Get the children menu items
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @return array
- * @access private
- */
- public function getChildren() {
- return $this->data['children'];
- }
- /**
- * Sort the children
- *
- * This is reserved for the \ElggMenuBuilder.
- *
- * @param string $sortFunction A function that is passed to usort()
- * @return void
- * @access private
- */
- public function sortChildren($sortFunction) {
- foreach ($this->data['children'] as $key => $node) {
- $this->data['children'][$key]->data['original_order'] = $key;
- }
- usort($this->data['children'], $sortFunction);
- }
- /**
- * Get all the values for this menu item. Useful for rendering.
- *
- * @return array
- * @since 1.9.0
- */
- public function getValues() {
- $values = get_object_vars($this);
- unset($values['data']);
- return $values;
- }
- /**
- * Get the menu item content (usually a link)
- *
- * @param array $vars Options to pass to output/url if a link
- * @return string
- * @deprecated 1.9 Use elgg_view_menu_item()
- */
- public function getContent(array $vars = array()) {
- elgg_deprecated_notice("\ElggMenuItem::getContent() deprecated by elgg_view_menu_item()", 1.9);
- return elgg_view_menu_item($this, $vars);
- }
- }
|