BgetGmo.class.inc

   1 <?php
   2
   3 /**
   4  * Extension of Better Getter HTTP class specially for the GMO payment
   5  * proessor.
   6  */
   7 class BgetGmo extends BgetHttp {
   8
   9   /**
  10    * Parsed response data from the GMO server.
  11    */
  12   protected $gmoResponseData;
  13
  14   /**
  15    * Are we using the test server URI?
  16    */
  17   protected $useSandboxServer = FALSE;
  18
  19   /**
  20    * Get the sandbox server usage value.
  21    *
  22    * @return
  23    *   TRUE if the test server URI will be used for queries; FALSE otherwise.
  24    */
  25   function getSandboxUsage() {
  26     return (bool)$this->useSandboxServer;
  27   }
  28
  29   /**
  30    * Set the sandbox server usage value.
  31    *
  32    * If set to TRUE, BgetGmo::getUri() will return a URL for the query test
  33    * server IF AND ONLY IF one of the shortcut paths ('EntryTran', 'ExecTran',
  34    * 'SearchTrade') are used with setUri().
  35    *
  36    * @see BgetGmo::getUri()
  37    *
  38    * @param $setting
  39    *   A boolean value representing whether the test server will be for queries;
  40    *   TRUE if so, FALSE otherwise.
  41    * @return
  42    *   $this, for chaining.
  43    */
  44   function setSandboxUsage($setting) {
  45     $this->useSandboxServer = $setting;
  46     return $this;
  47   }
  48
  49   /**
  50    * Return the parsed response data from the GMO server.
  51    *
  52    * If a query has executed but the response has not yet been parsed, this
  53    * will parse the response.
  54    *
  55    * @return
  56    *   An array of parsed response data, or NULL if there's no response to
  57    *   parse yet.
  58   */
  59   function getGmoResponseData() {
  60     if (empty($this->gmoResponseData)) {
  61       $response = $this->getResponseBody();
  62       if ($response !== NULL) {
  63         // parse_str() is an odd best; a product of the nightmarish days of old
  64         // (at least as far as PHP is concerned). As evidence, it needs a
  65         // variable passed to it which it will populate with values, sort of
  66         // like preg_match(). Why doesn't it just return such an array as its
  67         // return value? Good question, because if you use parse_str() without
  68         // that second parameter, it creates variables in the global namespace!
  69         // I'm sure that was a great idea back in the day when everybody on the
  70         // internet was completely, 100% trustworthy (so never).
  71         parse_str($response, $this->gmoResponseData);
  72       }
  73     }
  74     return $this->gmoResponseData;
  75   }
  76
  77   /**
  78    * Override the prepareRequest() method to deal with the way that GMO wants
  79    * the POST data.
  80    *
  81    * We want to set the POST data as our own built string because if we do it
  82    * the normal way, cURL wants to send the data using the multipart/form-data
  83    * enctype, which the server does *not* like.
  84    */
  85   function prepareRequest() {
  86     // Only go ahead with this if raw post data isn't already being used.
  87     if (!$this->getRawPostData()) {
  88       $this->setRawPostData(http_build_query($this->getPostFields(), '', '&'));
  89     }
  90     return parent::prepareRequest();
  91   }
  92
  93   /**
  94    * Override getUri() so that we can provide some handy shortcuts for setting
  95    * the URI and change the "real" URI depending on whether we want to return
  96    * a URI to the test server or not.
  97    */
  98   function getUri() {
  99     $uri = parent::getUri();
 100     if (in_array($uri, array('EntryTran', 'ExecTran', 'SearchTrade'))) {
 101       // Note the difference between sandbox and live URLs; sandbox ones start
 102       // with pt01, whereas live ones start with p01.
 103       if ($this->getSandboxUsage()) {
 104         return "http://pt01.mul-pay.jp/payment/{$uri}.idPass";
 105       }
 106       else {
 107         return "http://p01.mul-pay.jp/payment/{$uri}.idPass";
 108       }
 109     }
 110     else {
 111       return $uri;
 112     }
 113   }
 114 }