JezK

Edit File: Notification.php

<?php
namespace Bookly\Lib\Entities;

use Bookly\Lib;
use Bookly\Lib\DataHolders\Booking\Item;
use Bookly\Lib\DataHolders\Notification\Settings;

class Notification extends Lib\Base\Entity
{
    const TYPE_APPOINTMENT_REMINDER                          = 'appointment_reminder';
    const TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED           = 'ca_status_changed';
    const TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED_RECURRING = 'ca_status_changed_recurring';
    const TYPE_CUSTOMER_BIRTHDAY                             = 'customer_birthday';
    const TYPE_CUSTOMER_NEW_WP_USER                          = 'customer_new_wp_user';
    const TYPE_STAFF_NEW_WP_USER                             = 'staff_new_wp_user';
    const TYPE_LAST_CUSTOMER_APPOINTMENT                     = 'last_appointment';
    const TYPE_NEW_BOOKING                                   = 'new_booking';
    const TYPE_NEW_BOOKING_RECURRING                         = 'new_booking_recurring';
    const TYPE_NEW_BOOKING_COMBINED                          = 'new_booking_combined';
    const TYPE_NEW_PACKAGE                                   = 'new_package';
    const TYPE_PACKAGE_DELETED                               = 'package_deleted';
    const TYPE_STAFF_DAY_AGENDA                              = 'staff_day_agenda';
    const TYPE_STAFF_WAITING_LIST                            = 'staff_waiting_list';
    const TYPE_VERIFY_EMAIL                                  = 'verify_email';
    const TYPE_VERIFY_PHONE                                  = 'verify_phone';
    const TYPE_FREE_PLACE_WAITING_LIST                       = 'free_place_waiting_list';
    const TYPE_MAILING                                       = 'mailing';
    const TYPE_NEW_GIFT_CARD                                 = 'new_gift_card';
    const TYPE_MOBILE_SC_GRANT_ACCESS_TOKEN                  = 'mobile_sc_grant_access_token';
    const TYPE_NEW_EVENT                                     = 'new_event';
    const TYPE_NEW_ATTENDEES                                 = 'new_attendees';
    const TYPE_ATTENDEE_DELETED                              = 'attendee_deleted';

/** @var array Human readable notification titles */
    public static $titles;
    /** @var array */
    public static $type_ids;
    /** @var array */
    public static $icons;

/** @var  string */
    protected $gateway = 'email';
    /** @var  string */
    protected $type;
    /** @var  bool */
    protected $active = 0;
    /** @var  string */
    protected $name = '';
    /** @var  string */
    protected $subject = '';
    /** @var  string */
    protected $message = '';
    /** @var  int */
    protected $to_staff = 0;
    /** @var  int */
    protected $to_customer = 0;
    /** @var  bool */
    protected $to_admin = 0;
    /** @var  bool */
    protected $to_custom = 0;
    /** @var  string */
    protected $custom_recipients;
    /** @var  bool */
    protected $to_organizer = 0;
    /** @var  bool */
    protected $attach_ics = 0;
    /** @var  bool */
    protected $attach_invoice = 0;
    /** @var  string json */
    protected $settings = '[]';
    /** @var Settings */
    protected $settings_object;

protected static $table = 'bookly_notifications';

protected static $schema = array(
        'id' => array( 'format' => '%d' ),
        'gateway' => array( 'format' => '%s' ),
        'type' => array( 'format' => '%s' ),
        'active' => array( 'format' => '%d' ),
        'name' => array( 'format' => '%s' ),
        'subject' => array( 'format' => '%s' ),
        'message' => array( 'format' => '%s' ),
        'to_staff' => array( 'format' => '%d' ),
        'to_customer' => array( 'format' => '%d' ),
        'to_admin' => array( 'format' => '%d' ),
        'to_custom' => array( 'format' => '%d' ),
        'custom_recipients' => array( 'format' => '%s' ),
        'to_organizer' => array( 'format' => '%d' ),
        'attach_ics' => array( 'format' => '%d' ),
        'attach_invoice' => array( 'format' => '%d' ),
        'settings' => array( 'format' => '%s' ),
    );

/**************************************************************************
     * Entity Fields Getters & Setters                                        *
     **************************************************************************/

/**
     * Get type ID.
     *
     * @return int|null
     */
    public function getTypeId()
    {
        self::initTypeIds();

return isset ( self::$type_ids[ $this->getType() ] )
            ? self::$type_ids[ $this->getType() ]
            : null;
    }

/**
     * @param string $locale
     * @return string
     */
    public function getTranslatedMessage( $locale = null )
    {
        return Lib\Utils\Common::getTranslatedString( $this->getWpmlName(), $this->getMessage(), $locale );
    }

/**
     * @param string $locale
     * @return string
     */
    public function getTranslatedSubject( $locale = null )
    {
        return Lib\Utils\Common::getTranslatedString( $this->getWpmlName() . '_subject', $this->getSubject(), $locale );
    }

/**
     * Get type string for given type ID.
     *
     * @param int $type_id
     * @return string|null
     */
    public static function getTypeString( $type_id )
    {
        self::initTypeIds();

return array_search( $type_id, self::$type_ids ) ?: null;
    }

/**
     * Notification title.
     *
     * @param $type
     * @return string
     */
    public static function getTitle( $type = null )
    {
        self::initTitles();

return array_key_exists( $type, self::$titles )
            ? self::$titles[ $type ]
            : __( 'Unknown', 'bookly-responsive-appointment-booking-tool' );
    }

/**
     * Return custom notification codes.
     *
     * @param $gateway
     * @return array
     */
    public static function getTypes( $gateway = 'email' )
    {
        $types = array(
            self::TYPE_NEW_BOOKING,
            self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED,
        );
        if ( $gateway == 'email' ) {
            $types[] = self::TYPE_VERIFY_EMAIL;
        } else {
            $types[] = self::TYPE_APPOINTMENT_REMINDER;
            $types[] = self::TYPE_LAST_CUSTOMER_APPOINTMENT;
            $types[] = self::TYPE_STAFF_DAY_AGENDA;
            $types[] = self::TYPE_VERIFY_PHONE;
        }

if ( get_option( 'bookly_cloud_token' ) != ''
            && Lib\Cloud\API::getInstance()->account->productActive( Lib\Cloud\Account::PRODUCT_MOBILE_STAFF_CABINET )
        ) {
            $types[] = self::TYPE_MOBILE_SC_GRANT_ACCESS_TOKEN;
        }

return Lib\Proxy\Shared::prepareNotificationTypes( $types, $gateway );
    }

/**
     * @return array
     */
    public static function getAssociated()
    {
        return array(
            'sms' => self::getTypes( 'sms' ),
            'email' => self::getTypes( 'email' ),
            'voice' => self::getTypes( 'voice' ),
            'whatsapp' => self::getTypes( 'whatsapp' ),
        );
    }

/**
     * Notification icon.
     *
     * @param $type
     * @return string
     */
    public static function getIcon( $type = null )
    {
        self::initIcons();

return array_key_exists( $type, self::$icons )
            ? self::$icons[ $type ]
            : 'fa-question';
    }

/**
     * Fill array with notification titles.
     */
    private static function initTitles()
    {
        if ( self::$titles === null ) {
            self::$titles = array(
                self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED => __( 'Notification about customer\'s appointment status change', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_NEW_BOOKING                         => __( 'New booking notification', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_APPOINTMENT_REMINDER                => __( 'Appointment reminder', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_CUSTOMER_BIRTHDAY                   => __( 'Customer\'s birthday greeting', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_LAST_CUSTOMER_APPOINTMENT           => __( 'Customer\'s last appointment notification', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_STAFF_DAY_AGENDA                    => __( 'Staff full day agenda', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_VERIFY_EMAIL                        => __( 'Verify customer\'s email', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_VERIFY_PHONE                        => __( 'Verify customer\'s phone', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_MAILING                             => __( 'Mailing message', 'bookly-responsive-appointment-booking-tool' ),
                self::TYPE_MOBILE_SC_GRANT_ACCESS_TOKEN        => __( 'New staff member\'s Staff Cabinet mobile app access token details', 'bookly-responsive-appointment-booking-tool' ),
                /** @see \Bookly\Backend\Modules\CloudSms\Ajax::sendTestSms */
                'test_message'                                 => __( 'Test message', 'bookly-responsive-appointment-booking-tool' ),
            );

self::$titles = Lib\Proxy\Shared::prepareNotificationTitles( self::$titles );
        }
    }

/**
     * Fill array of type ids.
     */
    private static function initTypeIds()
    {
        if ( self::$type_ids === null ) {
            self::$type_ids = array(
                /** @see \Bookly\Lib\Cloud\Account::sendLowBalanceNotification */
                'low_balance'                                  => -1,
                /** @see \Bookly\Backend\Modules\CloudSms\Ajax::sendTestSms */
                'test_message'                                 => 0,
                /** @see \Bookly\Lib\Cloud\SMS::sendWizardSms */
                'wizard_test_message'                          => 1,
                self::TYPE_STAFF_NEW_WP_USER                   => 4,
                self::TYPE_CUSTOMER_NEW_WP_USER                => 5,
                self::TYPE_NEW_BOOKING_COMBINED                => 7,
                self::TYPE_STAFF_DAY_AGENDA                    => 9,
                self::TYPE_CUSTOMER_BIRTHDAY                   => 15,
                self::TYPE_APPOINTMENT_REMINDER                => 19,
                self::TYPE_LAST_CUSTOMER_APPOINTMENT           => 20,
                self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED => 21,
                self::TYPE_NEW_BOOKING                         => 22,
                self::TYPE_VERIFY_EMAIL                        => 25,
                self::TYPE_VERIFY_PHONE                        => 26,
                self::TYPE_NEW_BOOKING_RECURRING               => 41,
                self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED_RECURRING => 42,
                self::TYPE_STAFF_WAITING_LIST                  => 53,
                self::TYPE_FREE_PLACE_WAITING_LIST             => 54,
                self::TYPE_MAILING                             => 60,
                self::TYPE_NEW_GIFT_CARD                       => 70,
                self::TYPE_NEW_PACKAGE                         => 81,
                self::TYPE_PACKAGE_DELETED                     => 83,
                self::TYPE_NEW_EVENT                           => 84,
                self::TYPE_NEW_ATTENDEES                       => 85,
                self::TYPE_ATTENDEE_DELETED                    => 86,
                self::TYPE_MOBILE_SC_GRANT_ACCESS_TOKEN        => 90,
            );
        }
    }

/**
     * Fill array of icons.
     */
    private static function initIcons()
    {
        if ( self::$icons === null ) {
            self::$icons = array(
                self::TYPE_NEW_BOOKING => 'far fa-calendar-check',
                self::TYPE_NEW_BOOKING_RECURRING => 'far fa-calendar-alt',
                self::TYPE_NEW_BOOKING_COMBINED => 'fas fa-cart-plus',
                self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED => 'fas fa-arrows-alt-h',
                self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED_RECURRING => 'fas fa-exchange-alt',
                self::TYPE_NEW_PACKAGE => 'far fa-calendar-plus',
                self::TYPE_PACKAGE_DELETED => 'far fa-calendar-minus',
                self::TYPE_CUSTOMER_NEW_WP_USER => 'fas fa-user-plus',
                self::TYPE_STAFF_NEW_WP_USER => 'fas fa-user-plus',
                self::TYPE_STAFF_WAITING_LIST => 'fas fa-list-ol',
                self::TYPE_FREE_PLACE_WAITING_LIST => 'fas fa-street-view',
                self::TYPE_APPOINTMENT_REMINDER => 'far fa-bell',
                self::TYPE_LAST_CUSTOMER_APPOINTMENT => 'fas fa-award',
                self::TYPE_CUSTOMER_BIRTHDAY => 'fas fa-gift',
                self::TYPE_STAFF_DAY_AGENDA => 'far fa-list-alt',
                self::TYPE_VERIFY_EMAIL => 'fas fa-address-card',
                self::TYPE_VERIFY_PHONE => 'fas fa-address-card',
                self::TYPE_NEW_GIFT_CARD => 'fas fa-gifts',
                self::TYPE_MOBILE_SC_GRANT_ACCESS_TOKEN => 'fas fa-key',
                self::TYPE_NEW_EVENT => 'fas fa-ticket-alt',
                self::TYPE_NEW_ATTENDEES => 'fas fa-user-check',
                self::TYPE_ATTENDEE_DELETED => 'fas fa-ticket-alt',
            );
        }
    }

/**
     * Return unique name for WPML
     *
     * @return string
     */
    private function getWpmlName()
    {
        return sprintf( '%s_%s_%d', $this->getGateway(), $this->getType(), $this->getId() );
    }

/**
     * Get Settings object.
     *
     * @return Settings
     */
    public function getSettingsObject()
    {
        if ( $this->settings_object === null ) {
            $this->settings_object = new Settings( $this );
        }

return $this->settings_object;
    }

/**
     * Check whether notification settings match given order item.
     *
     * @param Item $item
     * @return bool
     */
    public function matchesItemForClient( Item $item )
    {
        return $item->isSeries() == in_array( $this->getType(), array( self::TYPE_NEW_BOOKING_RECURRING, self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED_RECURRING ) ) &&
               $this->getSettingsObject()->allowedServiceWithStatus( $item->getService(), $item->getCA()->getStatus() );
    }

/**
     * Check whether notification settings match given order item for staff.
     *
     * @param Item    $item
     * @param Service|null $parent
     * @return bool
     */
    public function matchesItemForStaff( Item $item, $parent = null )
    {
        return $item->isSeries() == in_array( $this->getType(), array( self::TYPE_NEW_BOOKING_RECURRING, self::TYPE_CUSTOMER_APPOINTMENT_STATUS_CHANGED_RECURRING ) ) &&
               $this->getSettingsObject()->allowedServiceWithStatus( $item->getService(), $item->getCA()->getStatus(), $parent );
    }

/**
     * Gets gateway
     *
     * @return string
     */
    public function getGateway()
    {
        return $this->gateway;
    }

/**
     * Sets gateway
     *
     * @param string $gateway
     * @return $this
     */
    public function setGateway( $gateway )
    {
        $this->gateway = $gateway;

return $this;
    }

/**
     * Gets type
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

/**
     * Sets type
     *
     * @param string $type
     * @return $this
     */
    public function setType( $type )
    {
        $this->type = $type;

return $this;
    }

/**
     * Gets active
     *
     * @return bool
     */
    public function getActive()
    {
        return $this->active;
    }

/**
     * Sets active
     *
     * @param bool $active
     * @return $this
     */
    public function setActive( $active )
    {
        $this->active = $active;

return $this;
    }

/**
     * Gets to admin
     *
     * @return bool
     */
    public function getToAdmin()
    {
        return $this->to_admin;
    }

/**
     * Sets to admin
     *
     * @param bool $to_admin
     * @return $this
     */
    public function setToAdmin( $to_admin )
    {
        $this->to_admin = $to_admin;

return $this;
    }

/**
     * Gets to_custom
     *
     * @return bool
     */
    public function getToCustom()
    {
        return $this->to_custom;
    }

/**
     * Sets to_custom
     *
     * @param bool $to_custom
     * @return $this
     */
    public function setToCustom( $to_custom )
    {
        $this->to_custom = $to_custom;

return $this;
    }

/**
     * Gets custom_recipients
     *
     * @return string
     */
    public function getCustomRecipients()
    {
        return $this->custom_recipients;
    }

/**
     * Sets custom_recipients
     *
     * @param string $custom_recipients
     * @return $this
     */
    public function setCustomRecipients( $custom_recipients )
    {
        $this->custom_recipients = $custom_recipients;

return $this;
    }

/**
     * @return bool|int
     */
    public function getToOrganizer()
    {
        return $this->to_organizer;
    }

/**
     * @param bool|int $to_organizer
     * @return Notification
     */
    public function setToOrganizer( $to_organizer )
    {
        $this->to_organizer = $to_organizer;

return $this;
    }

/**
     * Gets name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

/**
     * Sets name
     *
     * @param string $name
     * @return $this
     */
    public function setName( $name )
    {
        $this->name = $name;

return $this;
    }

/**
     * Gets subject
     *
     * @return string
     */
    public function getSubject()
    {
        return $this->subject;
    }

/**
     * Sets subject
     *
     * @param string $subject
     * @return $this
     */
    public function setSubject( $subject )
    {
        $this->subject = $subject;

return $this;
    }

/**
     * Gets message
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

/**
     * Sets message
     *
     * @param string $message
     * @return $this
     */
    public function setMessage( $message )
    {
        $this->message = $message;

return $this;
    }

/**
     * Gets to_staff
     *
     * @return int
     */
    public function getToStaff()
    {
        return $this->to_staff;
    }

/**
     * Sets to_staff
     *
     * @param int $to_staff
     * @return $this
     */
    public function setToStaff( $to_staff )
    {
        $this->to_staff = $to_staff;

return $this;
    }

/**
     * Gets to_customer
     *
     * @return int
     */
    public function getToCustomer()
    {
        return $this->to_customer;
    }

/**
     * Sets to_customer
     *
     * @param int $to_customer
     * @return $this
     */
    public function setToCustomer( $to_customer )
    {
        $this->to_customer = $to_customer;

return $this;
    }

/**
     * Gets attach_ics
     *
     * @return bool
     */
    public function getAttachIcs()
    {
        return $this->attach_ics;
    }

/**
     * Sets attach_ics
     *
     * @param bool $attach_ics
     * @return $this
     */
    public function setAttachIcs( $attach_ics )
    {
        $this->attach_ics = $attach_ics;

return $this;
    }

/**
     * Gets attach_invoice
     *
     * @return bool
     */
    public function getAttachInvoice()
    {
        return $this->attach_invoice;
    }

/**
     * Sets attach_invoice
     *
     * @param bool $attach_invoice
     * @return $this
     */
    public function setAttachInvoice( $attach_invoice )
    {
        $this->attach_invoice = $attach_invoice;

return $this;
    }

/**
     * Gets settings
     *
     * @return string
     */
    public function getSettings()
    {
        return $this->settings;
    }

/**
     * Sets settings
     *
     * @param string $settings
     * @return $this
     */
    public function setSettings( $settings )
    {
        $this->settings = $settings;

return $this;
    }

/**************************************************************************
     * Overridden Methods                                                     *
     **************************************************************************/

/**
     * Save entity.
     *
     * @return false|int
     */
    public function save()
    {
        if ( is_array( $this->settings ) ) {
            $this->settings = json_encode( $this->settings );
        }

$return = parent::save();
        if ( $this->isLoaded() ) {
            // Register string for translate in WPML.
            $name = $this->getWpmlName();
            do_action( 'wpml_register_single_string', 'bookly', $name, $this->getMessage() );
            if ( $this->getGateway() == 'email' ) {
                do_action( 'wpml_register_single_string', 'bookly', $name . '_subject', $this->getSubject() );
            }
        }

return $return;
    }

}