RideCab Documentation

1. System Requirements

2. Installation

1. Upload the plugin Go to WordPress Admin → Plugins → Add New → Upload Plugin. Select the ridecab.zip file and click Install Now.
2. Activate Click Activate Plugin. RideCab will automatically create all required database tables.
3. Confirm WooCommerce is active RideCab requires WooCommerce 7.0+. If WooCommerce is not active, an admin notice will appear and the plugin will not load.
4. Configure Settings Navigate to RideCab → Settings and complete at minimum the General and Maps tabs.
5. Add a vehicle Go to RideCab → Vehicles → Add New. Set a name, pricing type, and rates.
6. Embed the booking form Add the shortcode [ridecab_booking_form] to any page or post.

3. General Settings

Found at RideCab → Settings → General.

4. Maps & Location Settings

Found at RideCab → Settings → Maps.

Google Maps Setup

You need two separate API keys from Google Cloud Console:

Other Settings

5. Appearance Settings

Found at RideCab → Settings → Appearance.

6. Email Settings

Found at RideCab → Settings → Emails. Configure the company information that appears at the top of every booking email, and learn how the two custom emails work.

Company Information Fields

Booking Emails

RideCab sends two custom emails for every confirmed booking:

The admin email also includes a direct View Order link to the WooCommerce order edit screen.

WooCommerce's own default order emails (New Order, Processing Order, On Hold) are automatically suppressed for RideCab orders so customers and admins receive only one set of emails per booking.

What Appears in Each Email

• Company logo, name, address, phone, and contact email — at the top of every email
• Booking reference number
• Pickup address, any intermediate stops, and destination
• Pickup date & time
• Vehicle name (if selected)
• Passenger count and luggage count
• Estimated distance and duration (if available)
• Total price and payment method
• Customer notes (if entered)

Template Overrides

Email templates follow the standard WooCommerce override path. Copy the files to your theme to customise them without losing changes on plugin update:

Translation

All strings inside the email templates use __( '...', 'ridecab' ) and are fully translatable. RideCab bundles .mo files for Arabic, German, Spanish, and French. When a customer's WordPress locale is set, WooCommerce switches to that locale before sending the customer email, then restores the site locale — so the customer receives the email in their own language automatically.

7. Vehicles

Found at RideCab → Vehicles → Add New.

Each vehicle type has its own pricing model, limits, and display options. Common fields:

8. Pricing Types

9. Surge Pricing (Surcharges)

Found at RideCab → Surge Pricing → Add New.

Surcharges are applied on top of the vehicle strategy subtotal. Three trigger types:

Each rule can be a flat amount (€15) or a percentage multiplier (1.25 = +25%).

Rules have a Priority field — higher numbers are evaluated first. Multiple rules can match and stack.

Use the Vehicle Application checkboxes to limit which vehicle types a surcharge applies to.

10. Geofence Rules

Found at RideCab → Geofence Rules → Add New.

Geofence rules override or augment the fare based on the physical location of the pickup and/or dropoff point. Each rule has two zones: Location 1 (pickup) and Location 2 (dropoff).

Zone Types

Price Types

Direction

How to Create an Airport → Station Fixed Fare

1. Set Location 1 type to "Precise location" and draw a polygon around the airport terminal area. Make it generous.
2. Set Location 2 type to "Precise location" and draw a polygon around the train station area.
3. Set Price type to "Fixed fare" and enter the amount (e.g. €100).
4. Check the vehicles the rule should apply to in Vehicle Application.
5. Set Status to Active and click Publish.

How the Calculator Uses Geofence Rules

After computing the regular fare, the calculator loops over all active geofence rules ordered by priority (highest first). For each rule it:

1. Checks if the vehicle matches the rule's Vehicle Application list.
2. Checks the Direction: for Aller/Retour rules, tests both forward (pickup in Location 1, dropoff in Location 2) and reverse. For Aller uniquement, only the forward direction is tested.
3. Runs a ray-casting point-in-polygon test for each side against the stored polygon coordinates.
4. If the vehicle and direction checks pass → applies the price rule. The first matching fixed-fare rule wins; surcharge rules all stack.

11. Booking Form

The booking form is a 3-step flow embedded via the [ridecab_booking_form] shortcode.

Time Picker (12h / 24h)

The time picker automatically detects your WordPress time format (Settings → General → Time Format).

• If the format contains g or h (PHP 12-hour chars), the 12h picker is shown with an AM/PM selector embedded inside the hour field.
• Otherwise the 24h picker is shown (00h–23h).
• Past hours are automatically hidden when today's date is selected. If the entire AM or PM period is in the past, the picker shows all hours as a fallback instead of an empty dropdown.

Instant Booking Tab

When enabled on a booking form (Forms → Edit → Enable Instant Booking), a second tab appears with a simplified time-slot picker for quick same-day bookings.

12. Booking Management

Found at RideCab → Bookings. Each booking row links to a detail page with two postboxes:

• Customer Information — name, email, phone, ride date & time.
• Trip Details — route, vehicle, distance, duration, fare breakdown, driver assignment, admin notes.

Booking Statuses

13. Calendar

Found at RideCab → Calendar. Powered by FullCalendar.

• Shows all bookings in monthly / weekly / daily views.
• Each booking event is coloured by assigned driver — the colour is set on the driver's profile (Calendar Colour field).
• Click any event to open the booking detail page.

14. Invoices

Found at RideCab → Invoices.

Generate a printable PDF invoice for any booking. Click Generate on a booking row — a new tab opens with a formatted invoice that auto-triggers the browser's Print dialog. Use Save as PDF from the print dialog.

Invoice Settings

Found at RideCab → Invoices → Settings tab. Configure:

• Company name, logo, address, phone, email, website
• SIREN / company registration number and VAT/TVA number
• Invoice number prefix and padding (e.g. INV- + 4 digits → INV-0001)
• Primary accent colour and footer text
• Signature image (PNG with transparent background recommended)

Templates

15. Drivers

Driver management is disabled by default. Enable it at RideCab → Settings → General → Enable Driver Management.

Once enabled, the Drivers submenu appears. Each driver record links to a WordPress user account. Fields include:

• Linked WP user (for login access)
• License number
• Phone
• Calendar colour (used in the admin calendar)
• Status: Active / Inactive / Suspended
• Commission rate (%)

Assign a driver to a booking on the booking detail page. The calendar will automatically display the booking in the driver's colour.

16. WooCommerce Integration

RideCab uses WooCommerce as its payment engine. The flow is:

1. Booking form submitted — fare calculated server-side via POST /wp-json/ridecab/v1/fare/estimate.
2. Ride added to WC cart as a virtual product with the calculated price.
3. Customer redirected to WC checkout — all WC payment gateways (Stripe, PayPal, bank transfer, COD, etc.) are available automatically.
4. Server-side price recalculation on checkout submit — the price is recalculated via POST /wp-json/ridecab/v1/cart/add to prevent tampering.
5. WC order created — all booking data stored in WC order meta with _ridecab_ prefix.
6. RideCab booking record created in ridecab_bookings table.

Key WC Meta Keys

17. Shortcodes

[ridecab_booking_form]

18. Translations

RideCab is 100% translation-ready. All strings use the text domain ridecab.

Bundled translations (in /languages/):

To add a new language, create a .po file based on ridecab.pot and compile it to .mo with Poedit or msgfmt.

19. FAQ