File plato/plato-interface.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158

<?php

namespace SIW\Plato;

/**
 * Abstracte klasse voor interface met Plato (import en export)
 * 
 * @copyright 2019 SIW Internationale Vrijwilligersprojecten
 * @since     3.0.0
 */
abstract class Plato_Interface {

    /**
     * Webservice url
     *
     * @var string
     */
    const API_URL = 'https://workcamp-plato.org/files/services/ExternalSynchronization.asmx/';

    /**
     * Naam van import/export (voor logging)
     *
     * @var string
     */
    protected $name;

    /**
     * Organization webkey van plato
     *
     * @var string
     */
    protected $webkey;

    /**
     * Endpoint van de webservice
     * 
     * @var string
     */
    protected $endpoint;

    /**
     * Endpoint url voor Plato
     *
     * @var string
     */
    protected $endpoint_url;

    /**
     * HTTP response van Plato
     * 
     * @var array|\WP_Error
     */
    protected $http_response;

    /**
     * XML response van Plato
     * 
     * @var \SimpleXMLElement
     */
    protected $xml_response;

    /**
     * Logger-instantie
     * 
     * @var \WC_Logger
     */
    protected $logger;

    /**
     * Logger context
     * 
     * @var array
     */
    protected $logger_context;

    /**
     * Constructor
     */
    public function __construct() {
        $this->set_logger();
        $this->set_webkey();
        $this->set_endpoint_url();
    }

    /**
     * Zet Plato-webkey
     */
    protected function set_webkey() {
        $this->webkey = siw_get_option( 'plato_organization_webkey' );
    }

    /**
     * Geeft Plato-webkey terug
     *
     * @return string
     */
    protected function get_webkey() {
        return $this->webkey;
    }

    /**
     * Zet URL van het endpoint
     */
    protected function set_endpoint_url() {
        $this->endpoint_url = self::API_URL . $this->endpoint;
    }
    
    /**
     * Voegt query argument toe aan endpoint URL
     *
     * @param string $key
     * @param string $value
     */
    protected function add_query_arg( string $key, string $value ) {
        $this->endpoint_url = add_query_arg( $key, $value, $this->endpoint_url );
    }

    /**
     * Zet (WooCommerce-)logger
     */
    private function set_logger() {
        $this->logger = wc_get_logger();
        $source = sanitize_title( "siw-{$this->name}" );
        $this->logger_context = [ 'source' => $source ];
    }

    /**
     * Schrijft boodschap naar log
     *
     * @param string $level
     * @param string $message
     */
    public function log( string $level, string $message ) {
        $this->logger->log( $level, $message, $this->logger_context );
    }

    /**
     * Controleert de response van Plato
     *
     * @return bool
     */
    protected function is_valid_response() {
        /* In het geval van een fout: foutmelding wegschrijven naar log */
        if ( is_wp_error( $this->http_response ) ) {
            $this->log('error', 'Verbinding met PLATO mislukt. Response: ' . wc_print_r( $this->http_response ) );
            return false;
        }

        /* Zoek HTML-statuscode en breek af indien ongelijk aan 200 */
        $status_code = wp_remote_retrieve_response_code( $this->http_response );
        if ( \WP_Http::OK !== $status_code ) {
            $this->log( 'error', "Verbinding met PLATO mislukt. Statuscode: {$status_code}" );
            return false;
        }
        return true;
    }
}

Namespaces

Classes

Functions