entity.php

Table of Contents

mpa_draft_booking()  : array<string|int, mixed>|WP_Error
mpa_update_status()  : bool|WP_Error
mpa_get_booking()  : Booking|null
mpa_get_bookings()  : array<string|int, mixed>
mpa_get_reservations()  : array<string|int, Reservation>
mpa_get_payment()  : Payment|null
mpa_get_payments()  : array<string|int, mixed>
mpa_get_employee()  : Employee|null
mpa_get_employees()  : array<string|int, mixed>
mpa_get_employees_by_location()  : array<string|int, mixed>
mpa_get_employee_attributes()  : array<string|int, mixed>
mpa_get_location()  : Location|null
mpa_get_locations()  : array<string|int, mixed>
mpa_get_location_categories()  : array<string|int, WP_Term>|array<string|int, mixed>
mpa_get_schedule()  : Schedule|null
mpa_get_schedules()  : array<string|int, mixed>
mpa_get_service()  : Service|null
mpa_get_services()  : array<string|int, mixed>
mpa_get_service_attributes()  : array<string|int, mixed>
mpa_get_service_categories()  : array<string|int, WP_Term>|array<string|int, mixed>
mpa_get_service_category_total_count()  : int
mpa_extract_available_services()  : array<string|int, mixed>
Extracts the minimum information needed for booking/appointment shortcodes.
mpa_get_current_entity()  : AbstractEntity|null
mpa_get_entity()  : AbstractEntity|null

Functions

mpa_draft_booking()

mpa_draft_booking([array<string|int, mixed> $args = [] ]) : array<string|int, mixed>|WP_Error
Parameters
$args : array<string|int, mixed> = []

Optional. @param bool $args['payment'] Whether to create a payment post also. By default: only if payments are enabled in the plugin settings. @param bool $args['wp_error'] Whether to return a WP_Error on failure. True by default. @param bool $args['clean'] Whether to delete a booking post if failed to create a payment post. True by default.

Tags
since
1.5.0

mpa_update_status()

mpa_update_status(Booking|Payment $entity, string $status[, bool $wpError = false ]) : bool|WP_Error
Parameters
$entity : Booking|Payment
$status : string
$wpError : bool = false

Optional. Whether to return a WP_Error on failure. False by default.

Tags
since
1.5.0

mpa_get_booking()

mpa_get_booking(int $id[, bool $forceReload = false ]) : Booking|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.0
since
1.2

$id is optional.

mpa_get_bookings()

mpa_get_bookings([array<string|int, mixed> $args = [] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = []

Optional.

Tags
see
AbstractRepository::findAll()
since
1.0

mpa_get_reservations()

mpa_get_reservations(int $bookingId[, bool $forceReload = false ]) : array<string|int, Reservation>
Parameters
$bookingId : int
$forceReload : bool = false

Optional. False by default.

Tags
since
1.0

mpa_get_payment()

mpa_get_payment(int $id[, bool $forceReload = false ]) : Payment|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.5.0

mpa_get_payments()

mpa_get_payments([array<string|int, mixed> $args = ['fields' => ['id' => 'name']] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = ['fields' => ['id' => 'name']]

Optional.

Tags
since
1.5.0
see
AbstractRepository::findAll()

mpa_get_employee()

mpa_get_employee(int $id[, bool $forceReload = false ]) : Employee|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.0
since
1.2

$id is optional.

mpa_get_employees()

mpa_get_employees([array<string|int, mixed> $args = ['fields' => ['id' => 'name']] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = ['fields' => ['id' => 'name']]

Optional.

Tags
see
AbstractRepository::findAll()
since
1.0

mpa_get_employees_by_location()

mpa_get_employees_by_location(int|array<string|int, int> $location[, array<string|int, mixed> $args = ['fields' => ['id' => 'name']] ]) : array<string|int, mixed>
Parameters
$location : int|array<string|int, int>
$args : array<string|int, mixed> = ['fields' => ['id' => 'name']]

Optional.

Tags
since
1.2

TODO: move this to the \MotoPress\Appointment\Helpers\EmployeeHelper

mpa_get_employee_attributes()

mpa_get_employee_attributes(int|Employee $employee[, array<string|int, mixed> $args = [] ]) : array<string|int, mixed>
Parameters
$employee : int|Employee
$args : array<string|int, mixed> = []

Optional. @param bool $args['show_contacts'] True by default. @param bool $args['show_social_networks'] True by default. @param bool $args['show_additional_info'] True by default.

Tags
since
1.2

TODO: move this to the \MotoPress\Appointment\Helpers\EmployeeHelper

mpa_get_location()

mpa_get_location(int $id[, bool $forceReload = false ]) : Location|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.0
since
1.2

$id is optional.

mpa_get_locations()

mpa_get_locations([array<string|int, mixed> $args = ['fields' => ['id' => 'name']] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = ['fields' => ['id' => 'name']]

Optional.

Tags
see
AbstractRepository::findAll()
since
1.0

mpa_get_location_categories()

mpa_get_location_categories(int $locationId[, string|array<string|int, mixed> $fields = ['slug' => 'name'] ][, array<string|int, mixed> $args = [] ]) : array<string|int, WP_Term>|array<string|int, mixed>
Parameters
$locationId : int

Optional. 0 by default.

$fields : string|array<string|int, mixed> = ['slug' => 'name']

Optional. 'all', field name or key-value pair. ['slug' => 'name'] by default.

$args : array<string|int, mixed> = []

Optional.

Tags
since
1.1.0

mpa_get_schedule()

mpa_get_schedule(int $id[, bool $forceReload = false ]) : Schedule|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.0
since
1.2

$id is optional.

mpa_get_schedules()

mpa_get_schedules([array<string|int, mixed> $args = ['fields' => ['id' => 'title']] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = ['fields' => ['id' => 'title']]

Optional.

Tags
see
AbstractRepository::findAll()
since
1.0

mpa_get_service()

mpa_get_service(int $id[, bool $forceReload = false ]) : Service|null
Parameters
$id : int

Optional. Current post by default.

$forceReload : bool = false

Optional. False by default.

Tags
since
1.0
since
1.2

$id is optional.

mpa_get_services()

mpa_get_services([array<string|int, mixed> $args = ['fields' => ['id' => 'title']] ]) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed> = ['fields' => ['id' => 'title']]

Optional.

Tags
see
AbstractRepository::findAll()
since
1.0

mpa_get_service_attributes()

mpa_get_service_attributes(int|Service $service[, array<string|int, mixed> $args = [] ]) : array<string|int, mixed>
Parameters
$service : int|Service
$args : array<string|int, mixed> = []

Optional. @param bool $args['show_price'] True by default. @param bool $args['show_duration'] True by default.

Tags
since
1.2

mpa_get_service_categories()

mpa_get_service_categories(int $serviceId[, string|array<string|int, mixed> $fields = ['slug' => 'name'] ][, array<string|int, mixed> $args = [] ]) : array<string|int, WP_Term>|array<string|int, mixed>
Parameters
$serviceId : int

Optional. 0 by default.

$fields : string|array<string|int, mixed> = ['slug' => 'name']

Optional. 'all', field name or key-value pair. ['slug' => 'name'] by default.

$args : array<string|int, mixed> = []

Optional.

Tags
since
1.0

mpa_get_service_category_total_count()

mpa_get_service_category_total_count(WP_Term|int $term) : int
Parameters
$term : WP_Term|int
Tags
since
1.2

mpa_extract_available_services()

Extracts the minimum information needed for booking/appointment shortcodes.

mpa_extract_available_services() : array<string|int, mixed>

For example:

    $bookableServices = [
        134 => [
            'name'       => "Man's Haircut",
            'categories' => [
                'barbershop' => 'Barbershop',
                'haircuts'   => 'Haircuts'
            ],
            'employees'  => [
                125 => [
                    'name'      => 'John Doe',
                    'schedule'  => 131,
                    'locations' => [
                        129 => 'Barbershop'
                    ]
                ]
            ]
        ],
        135 => [
            'name'       => "Woman's Haircut",
            'categories' => [
                'uncategorized' => 'Uncategorized'
            ],
            'employees'  => [
                127 => [
                    'name'      => 'Mary Doe',
                    'schedule'  => 133,
                    'locations' => [
                        130 => 'Hairdressing Salon'
                    ]
                ]
            ]
        ]
    ];
Tags
since
1.0

mpa_get_current_entity()

mpa_get_current_entity() : AbstractEntity|null
Tags
since
1.2

mpa_get_entity()

mpa_get_entity(int $postId) : AbstractEntity|null
Parameters
$postId : int

Optional. Current post by default.

Tags
since
1.2

Search results