PHP Класс Networking\InitCmsBundle\Menu\MenuBuilder

Автор: Yorkie Chadwick ([email protected])
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$authorizationChecker Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
$currentPath string
$currentUri string
$factory Knp\Menu\FactoryInterface
$isLoggedIn boolean
$matcher Knp\Menu\Matcher\Matcher
$menuIterators array
$menuManager Networking\InitCmsBundle\Model\MenuItemManagerInterface
$request Symfony\Component\HttpFoundation\Request
$router Symfony\Component\Routing\RouterInterface
$tokenStorage Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
$translator Symfony\Component\Translation\TranslatorInterface
$viewStatus string

Открытые методы

Метод Описание
__construct ( Knp\Menu\FactoryInterface $factory, Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage, Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $authorizationChecker, Symfony\Component\HttpFoundation\RequestStack $requestStack, Symfony\Component\Routing\RouterInterface $router, Networking\InitCmsBundle\Model\MenuItemManagerInterface $menuManager, Symfony\Component\Translation\TranslatorInterface $translator, Knp\Menu\Matcher\Matcher $matcher ) MenuBuilder constructor.
addMenuIterator ( $menuName, $iterator )
addNodeToMenu ( Knp\Menu\MenuItem $menu, Networking\InitCmsBundle\Entity\MenuItem $node, $startDepth ) : boolean | Knp\Menu\ItemInterface Add a menu item node at the correct place in the menu
addVoter ( $path )
createFromMenuItem ( Networking\InitCmsBundle\Entity\MenuItem $menuItem ) : Knp\Menu\ItemInterface Create an new node using the ContentRoute object to generate the uri
createLoginMenu ( string $classes = 'nav pull-right' ) : Knp\Menu\ItemInterface Creates the login and change language navigation for the right side of the top frontend navigation
createMenu ( Knp\Menu\MenuItem $menu, array $menuIterator, integer $startDepth ) : Knp\Menu\MenuItem Creates a full menu based on the starting point given
getFullMenu ( string $menuName ) : array | boolean Retrieve the full menu tree
getMenuIterators ( ) : array
getParentMenu ( Knp\Menu\MenuItem $menu, Networking\InitCmsBundle\Entity\MenuItem $childNode ) : mixed Recursively get parents
getSubMenu ( string $menuName, integer $level = 1 ) : array | boolean Retrieves the sub menu array based on the current url
setCurrentPath ( )
setCurrentUri ( )
setLoggedIn ( )
setRecursiveAttribute ( Knp\Menu\ItemInterface $menu, array $attr ) Recursively set attributes on an item and its' children
setRecursiveChildrenAttribute ( Knp\Menu\ItemInterface $menu, array $attr ) Recursively set attributes on all children of a given menu
setViewStatus ( )
showOnlyCurrentChildren ( Knp\Menu\ItemInterface $menu ) Set the children menu item nodes to be shown only if the node is current or the parent is a current ancestor

Описание методов

__construct() публичный Метод

MenuBuilder constructor.
public __construct ( Knp\Menu\FactoryInterface $factory, Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage, Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $authorizationChecker, Symfony\Component\HttpFoundation\RequestStack $requestStack, Symfony\Component\Routing\RouterInterface $router, Networking\InitCmsBundle\Model\MenuItemManagerInterface $menuManager, Symfony\Component\Translation\TranslatorInterface $translator, Knp\Menu\Matcher\Matcher $matcher )
$factory Knp\Menu\FactoryInterface
$tokenStorage Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
$authorizationChecker Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
$requestStack Symfony\Component\HttpFoundation\RequestStack
$router Symfony\Component\Routing\RouterInterface
$menuManager Networking\InitCmsBundle\Model\MenuItemManagerInterface
$translator Symfony\Component\Translation\TranslatorInterface
$matcher Knp\Menu\Matcher\Matcher

addMenuIterator() публичный Метод

public addMenuIterator ( $menuName, $iterator )
$menuName
$iterator

addNodeToMenu() публичный Метод

Add a menu item node at the correct place in the menu
public addNodeToMenu ( Knp\Menu\MenuItem $menu, Networking\InitCmsBundle\Entity\MenuItem $node, $startDepth ) : boolean | Knp\Menu\ItemInterface
$menu Knp\Menu\MenuItem
$node Networking\InitCmsBundle\Entity\MenuItem
$startDepth
Результат boolean | Knp\Menu\ItemInterface

addVoter() публичный Метод

public addVoter ( $path )
$path string

createFromMenuItem() публичный Метод

Create an new node using the ContentRoute object to generate the uri
public createFromMenuItem ( Networking\InitCmsBundle\Entity\MenuItem $menuItem ) : Knp\Menu\ItemInterface
$menuItem Networking\InitCmsBundle\Entity\MenuItem
Результат Knp\Menu\ItemInterface

createLoginMenu() публичный Метод

Creates the login and change language navigation for the right side of the top frontend navigation
public createLoginMenu ( string $classes = 'nav pull-right' ) : Knp\Menu\ItemInterface
$classes string
Результат Knp\Menu\ItemInterface

createMenu() публичный Метод

Creates a full menu based on the starting point given
public createMenu ( Knp\Menu\MenuItem $menu, array $menuIterator, integer $startDepth ) : Knp\Menu\MenuItem
$menu Knp\Menu\MenuItem
$menuIterator array
$startDepth integer
Результат Knp\Menu\MenuItem

getFullMenu() публичный Метод

Retrieve the full menu tree
public getFullMenu ( string $menuName ) : array | boolean
$menuName string
Результат array | boolean

getMenuIterators() публичный Метод

public getMenuIterators ( ) : array
Результат array

getParentMenu() публичный Метод

Recursively get parents
public getParentMenu ( Knp\Menu\MenuItem $menu, Networking\InitCmsBundle\Entity\MenuItem $childNode ) : mixed
$menu Knp\Menu\MenuItem - menu to look for the parent in
$childNode Networking\InitCmsBundle\Entity\MenuItem - menu node whose parent we are looking for
Результат mixed

getSubMenu() публичный Метод

Retrieves the sub menu array based on the current url
public getSubMenu ( string $menuName, integer $level = 1 ) : array | boolean
$menuName string
$level integer
Результат array | boolean

setCurrentPath() публичный Метод

public setCurrentPath ( )

setCurrentUri() публичный Метод

public setCurrentUri ( )

setLoggedIn() публичный Метод

public setLoggedIn ( )

setRecursiveAttribute() публичный Метод

Recursively set attributes on an item and its' children
public setRecursiveAttribute ( Knp\Menu\ItemInterface $menu, array $attr )
$menu Knp\Menu\ItemInterface
$attr array

setRecursiveChildrenAttribute() публичный Метод

Recursively set attributes on all children of a given menu
Устаревший: please use setRecursiveAttribute
public setRecursiveChildrenAttribute ( Knp\Menu\ItemInterface $menu, array $attr )
$menu Knp\Menu\ItemInterface
$attr array

setViewStatus() публичный Метод

public setViewStatus ( )

showOnlyCurrentChildren() публичный Метод

Set the children menu item nodes to be shown only if the node is current or the parent is a current ancestor
public showOnlyCurrentChildren ( Knp\Menu\ItemInterface $menu )
$menu Knp\Menu\ItemInterface

Описание свойств

$authorizationChecker защищенное свойство

protected AuthorizationCheckerInterface,Symfony\Component\Security\Core\Authorization $authorizationChecker
Результат Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface

$currentPath защищенное свойство

protected string $currentPath
Результат string

$currentUri защищенное свойство

protected string $currentUri
Результат string

$factory защищенное свойство

protected FactoryInterface,Knp\Menu $factory
Результат Knp\Menu\FactoryInterface

$isLoggedIn защищенное свойство

protected bool $isLoggedIn
Результат boolean

$matcher защищенное свойство

protected Matcher,Knp\Menu\Matcher $matcher
Результат Knp\Menu\Matcher\Matcher

$menuIterators защищенное свойство

protected array $menuIterators
Результат array

$menuManager защищенное свойство

protected MenuItemManagerInterface,Networking\InitCmsBundle\Model $menuManager
Результат Networking\InitCmsBundle\Model\MenuItemManagerInterface

$request защищенное свойство

protected Request,Symfony\Component\HttpFoundation $request
Результат Symfony\Component\HttpFoundation\Request

$router защищенное свойство

protected RouterInterface,Symfony\Component\Routing $router
Результат Symfony\Component\Routing\RouterInterface

$tokenStorage защищенное свойство

protected TokenStorageInterface,Symfony\Component\Security\Core\Authentication\Token\Storage $tokenStorage
Результат Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface

$translator защищенное свойство

protected TranslatorInterface,Symfony\Component\Translation $translator
Результат Symfony\Component\Translation\TranslatorInterface

$viewStatus защищенное свойство

protected string $viewStatus
Результат string