Current File : /home/tjamichg/cursos.tjamich.gob.mx/vendor/knplabs/knp-menu/src/Knp/Menu/ItemInterface.php
<?php
namespace Knp\Menu;
/**
* Interface implemented by a menu item.
*
* It roughly represents a single <li> tag and is what you should interact with
* most of the time by default.
* Originally taken from ioMenuPlugin (http://github.com/weaverryan/ioMenuPlugin)
*
* @extends \IteratorAggregate<string, self>
*/
interface ItemInterface extends \ArrayAccess, \Countable, \IteratorAggregate
{
/**
* @param FactoryInterface $factory
*
* @return ItemInterface
*/
public function setFactory(FactoryInterface $factory);
/**
* @return string
*/
public function getName();
/**
* Renames the item.
*
* This method must also update the key in the parent.
*
* Provides a fluent interface
*
* @param string $name
*
* @return ItemInterface
*
* @throws \InvalidArgumentException if the name is already used by a sibling
*/
public function setName($name);
/**
* Get the uri for a menu item
*
* @return string
*/
public function getUri();
/**
* Set the uri for a menu item
*
* Provides a fluent interface
*
* @param string $uri The uri to set on this menu item
*
* @return ItemInterface
*/
public function setUri($uri);
/**
* Returns the label that will be used to render this menu item
*
* Defaults to the name of no label was specified
*
* @return string|null
*/
public function getLabel();
/**
* Provides a fluent interface
*
* @param string|null $label The text to use when rendering this menu item
*
* @return ItemInterface
*/
public function setLabel($label);
/**
* @return array
*/
public function getAttributes();
/**
* Provides a fluent interface
*
* @param array $attributes
*
* @return ItemInterface
*/
public function setAttributes(array $attributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setAttribute($name, $value);
/**
* @return array
*/
public function getLinkAttributes();
/**
* Provides a fluent interface
*
* @param array $linkAttributes
*
* @return ItemInterface
*/
public function setLinkAttributes(array $linkAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getLinkAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param string $value
*
* @return ItemInterface
*/
public function setLinkAttribute($name, $value);
/**
* @return array
*/
public function getChildrenAttributes();
/**
* Provides a fluent interface
*
* @param array $childrenAttributes
*
* @return ItemInterface
*/
public function setChildrenAttributes(array $childrenAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getChildrenAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param string $value
*
* @return ItemInterface
*/
public function setChildrenAttribute($name, $value);
/**
* @return array
*/
public function getLabelAttributes();
/**
* Provides a fluent interface
*
* @param array $labelAttributes
*
* @return ItemInterface
*/
public function setLabelAttributes(array $labelAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getLabelAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setLabelAttribute($name, $value);
/**
* @return array
*/
public function getExtras();
/**
* Provides a fluent interface
*
* @param array $extras
*
* @return ItemInterface
*/
public function setExtras(array $extras);
/**
* @param string $name The name of the extra to return
* @param mixed $default The value to return if the extra doesn't exist
*
* @return mixed
*/
public function getExtra($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setExtra($name, $value);
/**
* Whether or not this menu item should show its children.
*
* @return boolean
*/
public function getDisplayChildren();
/**
* Set whether or not this menu item should show its children
*
* Provides a fluent interface
*
* @param bool $bool
*
* @return ItemInterface
*/
public function setDisplayChildren($bool);
/**
* Whether or not to display this menu item
*
* @return bool
*/
public function isDisplayed();
/**
* Set whether or not this menu should be displayed
*
* Provides a fluent interface
*
* @param bool $bool
*
* @return ItemInterface
*/
public function setDisplay($bool);
/**
* Add a child menu item to this menu
*
* Returns the child item
*
* @param ItemInterface|string $child An ItemInterface instance or the name of a new item to create
* @param array $options If creating a new item, the options passed to the factory for the item
*
* @return ItemInterface
*
* @throws \InvalidArgumentException if the item is already in a tree
*/
public function addChild($child, array $options = []);
/**
* Returns the child menu identified by the given name
*
* @param string $name Then name of the child menu to return
*
* @return ItemInterface|null
*/
public function getChild($name);
/**
* Reorder children.
*
* Provides a fluent interface
*
* @param array $order New order of children.
*
* @return ItemInterface
*/
public function reorderChildren($order);
/**
* Makes a deep copy of menu tree. Every item is copied as another object.
*
* @return ItemInterface
*/
public function copy();
/**
* Returns the level of this menu item
*
* The root menu item is 0, followed by 1, 2, etc
*
* @return int
*/
public function getLevel();
/**
* Returns the root ItemInterface of this menu tree
*
* @return ItemInterface
*/
public function getRoot();
/**
* Returns whether or not this menu item is the root menu item
*
* @return bool
*/
public function isRoot();
/**
* @return ItemInterface|null
*/
public function getParent();
/**
* Used internally when adding and removing children
*
* Provides a fluent interface
*
* @param ItemInterface|null $parent
*
* @return ItemInterface
*/
public function setParent(ItemInterface $parent = null);
/**
* Return the children as an array of ItemInterface objects
*
* @return ItemInterface[]
*/
public function getChildren();
/**
* Provides a fluent interface
*
* @param array $children An array of ItemInterface objects
*
* @return ItemInterface
*/
public function setChildren(array $children);
/**
* Removes a child from this menu item
*
* Provides a fluent interface
*
* @param ItemInterface|string $name The name of ItemInterface instance or the ItemInterface to remove
*
* @return ItemInterface
*/
public function removeChild($name);
/**
* @return ItemInterface
*/
public function getFirstChild();
/**
* @return ItemInterface
*/
public function getLastChild();
/**
* Returns whether or not this menu items has viewable children
*
* This menu MAY have children, but this will return false if the current
* user does not have access to view any of those items
*
* @return bool
*/
public function hasChildren();
/**
* Sets whether or not this menu item is "current".
*
* If the state is unknown, use null.
*
* Provides a fluent interface
*
* @param bool|null $bool Specify that this menu item is current
*
* @return ItemInterface
*/
public function setCurrent($bool);
/**
* Gets whether or not this menu item is "current".
*
* @return bool|null
*/
public function isCurrent();
/**
* Whether this menu item is last in its parent
*
* @return bool
*/
public function isLast();
/**
* Whether this menu item is first in its parent
*
* @return bool
*/
public function isFirst();
/**
* Whereas isFirst() returns if this is the first child of the parent
* menu item, this function takes into consideration whether children are rendered or not.
*
* This returns true if this is the first child that would be rendered
* for the current user
*
* @return bool
*/
public function actsLikeFirst();
/**
* Whereas isLast() returns if this is the last child of the parent
* menu item, this function takes into consideration whether children are rendered or not.
*
* This returns true if this is the last child that would be rendered
* for the current user
*
* @return bool
*/
public function actsLikeLast();
}
Mini Shell