Getting Started with ApPHP Restaurant Site (for v2.0.0 or above)
-
1. General.
- 1.1 MVC Framework.
- 1.2 Directy CMF.
-
2. Restaurant Site Backend.
- 2.1 Module Installation.
- 2.2 Updating a Module.
- 2.3 Edit Module.
- 2.4 Module Settings.
- 2.5 Restaurant Info.
- 2.6 Working Times.
- 2.7 Restaurant Menus.
- 2.8 Restaurant Menu Categories.
- 2.9 Restaurant Dishes.
- 2.10 Adding Categories to Menu.
- 2.11 Adding Dishes to Menu Category.
- 2.12 Reservations Management.
1. General.
In this section described what are ApPHP MVC Framework and ApPHP Directy CMF.
1.1 ApPHP MVC Framework.
ApPHP MVC Framework is designed to provide modern and rapid development of websites, web applications and web services. Restaurant Site script requires framework version 0.3.0 or later for stable work. You may read more information about the framework from this Framework Documantation page.
1.2 ApPHP Directy CMF.
ApPHP Directy CMF is an open-source content management framework (CMF), built on ApPHP MVC Framework that provides a basic functionality required for creating websites and publishing web content. It includes Frontend and Backend parts, supports multi-language, roles and privileges, templates, modular development etc.
Building an application without ApPHP Directy CMF could take a weeks and weeks of hard developing, debugging and testing (depending on your experience level with PHP).
ApPHP Directy CMF eliminates the need for most of this work, freeing your valuable time for making great and modern applications. Each web applications that built with Directy CMF represents the triple chain, where application logic encapsulated in the special module: MVC Framework ↔ Directy CMF ↔ Web Application.
Find more information about the ApPHP Directy CMF in this Getting Started guide.
2. Restaurant Site Backend.
This section describes how to start work with ApPHP Restaurant Site Backend.
2.1 Module Installation.
First of all make sure Restaurant module is installed on your site. To check it go to Modules / Modules Management page and select System Modules tab. If you see this module in the list with status Enabled it means it's sucessfully installed.
If for some reason it's still not installed, you have to perform this operation before starting to work with it. To install the module simply click on Install link from the column named Actions.
2.2 Updating a Module.
Remove an old version of the module from protected/modules/ directory and upload there the new one. Then go to Modules / Modules Management page and select System Modules tab. If a new version of Restaurant module is greater than previous you will see update icon link in Actions column. Click this icon to update the module. If update operation completed successfully update icon will disappear and module version number will be changed to the latest.
2.3 Edit Module.
Once installed the Restaurant module will appear in the list of available modules on Application Modules page. Now you may edit module parameters (only allowed for system modules).
To edit a module click Edit icon from the Actions menu. On edit module page you may see all module parameters and change some of them, for ex.:
- show/hide module icon on dashboard
- show/hide module icon in side menu
- change module sort order
- etc.
2.4 Module Settings.
Module Settings allows you to configure important settings of the module. To access this page go to Modules / Modules Management, select System Modules tab and then click Restaurant module link or click on Restaurant module icon from the dashboard.
Currently you may configure following settings:
- The link URL that leads to the page with Restaurant Menu (readonly)
- The link URL that leads to the page with information about Restaurant (readonly)
- The link leads to the page with a Reservation Form (readonly)
- Definition of SEO format for category links
- The shortcode that allows to display a restaurant reservation form on the site pages (readonly)
- The email address used to receive submitted information about reservation
- Definition of visibility for reservation form fields
2.5 Restaurant Info.
Restaurant Info page is used to insert or change general restaurant information. To open this page go to Modules / Restaurant, then select Restaurant Info tab or click Restaurant Info link from Restaurant menu category in the side bar.
On this page you may edit following information:
- Upload restaurant logo image
- Add/Edit phone and fax numbers
- Add/Edit restaurant business email
- Add/Edit restaurant map code
- Specify restaurant name, description and address in available languages
2.6 Working Times.
Working Times allows administrator to specify working times of restaurant by week days. To open this page go to Modules / Restaurant, then select Working Times tab or click Working Times link from Restaurant menu category in the side bar.
On this page you may edit working times for each day of week .
2.7 Restaurant Menus.
Restaurant Menus page allows administrator to create, edit and manage different menus in restaurant. It enables to create unlimited number of menus, where each menu has it's own image, sort order, name and description.
There is a special link Menu Categories leads to the page where categories may be added to the selected menu: read more.
2.8 Restaurant Menu Categories.
Restaurant Menu Categories page allows administrator to create, edit and manage all menu categories in restaurant. It enables to create unlimited number of categories, where each category has it's owm image, sort order, name, description and status: active or not.
Once created category may be added to the selected menu: read more.
2.9 Restaurant Dishes.
Restaurant Dishes page allows administrator to create, edit and manage all dishes in restaurant. It enables to create unlimited number of dishes, where each dish has image, price, name, description, sort order etc.
Once created dish may be added to the selected menu: read more.
2.10 Adding Categories to Menu.
To add category to selected menu first of all you have to open Menus Management page, then click on Menu Categories link in the appropriate menu row. The page you will open, allows you to add or remove categories from the selected menu.
Each category may be added to different menus, but only one time to the same menu.
2.11 Adding Dishes to Menu Category.
To add dishes to menu category you have to open Menu Categories Management page, then click on Menu Items in the appropriate menu category row. The page you will open, allows you to add or remove items from the selected menu category.
Each dish may be added to different menu category, but only one time to the same category. Also after adding the dishes, you may change a default price to appropriate price, related to this specific menu category.
2.12 Reservation Management.
Reservation Management page allows administrator to view and manage restaurant reservations. To view existing reservations go to Modules / Restaurant, then select Reservations tab. On this page you see the reservation details and change it's status.
3. Restaurant Site Frontend.
This section describes what ApPHP Restaurant Site Frontend includes and how to work with it.
3.1 Viewing Restaurant Info.
The restaurant info page allows visitors of your site to get an important information about your restaurant: name & description, full address and zip code, phones, restaurant image, contact email, view restaurant location on Google map, working hours etc.
This page may be added to any menu by assigning a following link: restaurantInfo/show.
3.1 Viewing Restaurant Menu.
The restaurant menu page allows visitors to see the menu categories that your restaurant suggests and navigate through the menu to the dishes in each menu category. To see all dishes in menu category visitors may click on the category link.
This page may be added to any menu by assigning a following link: restaurantMenus/viewAll.
3.3 Online Reservation Form.
Online reservation form allows visitors of your site to send a reservation request. When visitor submit reservation form the system send an email to administrator of the site and also new reservation record is created.
Administrator can check new reservations and change their status from pending to approved or canceled.
This page may be added to any menu by assigning a following link: restaurantReservations/request or by writing a shortcode {module:restaurant!reservation} in the content of any site page (CMS module).