VikRestaurants Plugin Events

• &$menu (MenuShape) The current menu instance.

None.

@since 1.8

The example below adds the Rooms Closures menu item, after Rooms, within the Restaurant category and removes the Menus and Products items from the same category.

/**
 * Trigger event to allow the plugins to manipulate the back-end menu of VikRestaurants.
 *
 * @param   MenuShape  &$menu   The menu to build.
 *
 * @return  void
 *
 * @since   1.8
 */
public function onBeforeBuildVikRestaurantsMenu(&$menu)
{
    $input = JFactory::getApplication()->input;

    // Get "Restaurant" separator. It can be found at index [1],
    // after the "Dashboard" category.
    $restaurant = $menu->get(1);

    // delete "Products" menu item
    $restaurant->unsetChild(array(
        'title' => JText::_('VRMENUMENUSPRODUCTS'),
    ));

    // delete "Menus" menu item
    $restaurant->unsetChild(array(
        'title' => JText::_('VRMENUMENUS')
    ));

    // create "Rooms Closures" menu item
    $closures = MenuFactory::createItem('Rooms Closures', 'index.php?option=com_vikrestaurants&view=roomclosures', $input->get('view') == 'roomclosures');
    // set icon for rooms closures
    $closures->setCustom('calendar-times-o');

    $items = array();

    // copy menu items in order to push
    // the rooms closures wherever we want
    foreach ($restaurant->getMenu() as $item)
    {
        // copy item
        $items[] = $item;

        // search if we copied the rooms menu item
        if ($item->getTitle() == JText::_('VRMENUROOMS'))
        {
            // include closures after the rooms
            $items[] = $closures;
        }
    }

    // setup menu items again
    $restaurant->setMenu($items);
}

The event doesn't accept any arguments.

String. The menu type to use.

@since 1.8

The example below shows how you can use the horizontal layout.

/**
 * Trigger event to allow the plugins to choose a specific type to
 * use for the layout of the back-end menu.
 * By default, VikRestaurants supports only 2 menu types:
 * - 'leftboard', vertical layout placed on the left side;
 * - 'horizontal', horizontal layout placed above the component contents.
 *
 * @return  string  The menu type to use.
 *
 * @since   1.8
 */
public function onBeforeDefineVikRestaurantsMenuType()
{
    // check if we have Joomla 4.0+
    $j4 = VersionListener::isJoomla40();

    if ($j4)
    {
        // return horizontal layout only in case of J4
        return 'horizontal';
    }

    // leave menu as it is
}