| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- <?php
- namespace smladeoye\paystack;
- use yii\base\Component;
- use yii\base\Exception;
- use Yii;
- class Transaction extends Component
- {
- private $reference;
- public $authorization_url;
- private $callbackUrl;
- private $path;
- /** @var array holds the default transaction operation configuration */
- private $transaction = array(
- 'baseUrl'=>'/transaction',
- 'initializeUrl'=>'/initialize',
- 'verifyUrl'=>'/verify',
- 'chargeUrl'=>'/charge_authorization',
- 'timelineUrl'=>'/timeline',
- 'totalUrl'=>'/totals',
- 'exportUrl'=>'/export',
- 'beforeSend'=>array(),
- 'afterSend'=>array()
- );
- /*Constructor method to setup paystack component transaction operation configurations
- * @param $paystack, Paystack instance
- *@param config, Yii2 default object configuration array
- */
- public function __construct(Paystack $paystack,$config = [])
- {
- $this->attachBehavior('Resources',array('class'=> Resources::className()));
- $this->setPaystack($paystack);
- $this->transaction = array_replace($this->transaction,$paystack->transaction);
- $this->setConfig($this->transaction);
- parent::__construct($config);
- }
- /**set the callback url after any transaction is made
- * @param $callback*/
- public function setCallbackUrl($callback)
- {
- $this->callbackUrl = $callback;
- }
- /** @param $options array; initialize a transaction
- * @return $this
- */
- public function initialize($options = null)
- {
- if ($options)
- {
- $this->setRequestOptions($options);
- }
- if (!isset($this->requestOptions['callback_url']) && isset($this->callbackUrl))
- {
- $this->requestOptions = array_replace($this->requestOptions,array('callback_url'=>$this->callbackUrl));
- }
- $this->sendRequest(Paystack::OP_TRANS_INITIALIZE,Paystack::METHOD_POST);
- $this->setResponseOptions();
- return $this;
- }
- /**verify a particular transaction
- * @param $trx_ref transaction id or reference no
- * @return $this
- */
- public function verify($trx_ref = null)
- {
- $this->acceptArray(false);
- if ($trx_ref != null)
- $this->setRequestOptions($trx_ref);
- else
- $this->setRequestOptions($this->reference);
- $this->sendRequest(Paystack::OP_TRANS_VERIFY);
- $this->setResponseOptions();
- return $this;
- }
- /** fetch all transactions
- *@param $page array|integer, when is array it should be in key => value format with the required params
- *@param $per_page integer
- * @return $this
- */
- public function fetchAll($page = null, $per_page = null)
- {
- $options = array();
- if (is_array($page))
- {
- $this->setRequestOptions($page);
- }
- else
- {
- if ($page)
- $options['page'] = $page;
- if ($per_page)
- $options['perPage'] = $per_page;
- $this->setRequestOptions($options);
- }
- $this->sendRequest(Paystack::OP_TRANS_LIST);
- $this->setResponseOptions();
- return $this;
- }
- /** fetch a particular transaction
- * @param $id the transaction id or reference
- * @return $this
- */
- public function fetch($id = null)
- {
- $this->acceptArray(false);
- $this->setRequestOptions($id);
- $this->sendRequest(Paystack::OP_TRANS_FETCH);
- $this->setResponseOptions();
- return $this;
- }
- /**
- * @param $options
- * @return $this
- */
- public function charge($options = null)
- {
- $this->setRequestOptions($options);
- $this->sendRequest(Paystack::OP_TRANS_CHARGE,Paystack::METHOD_POST);
- $this->setResponseOptions();
- return $this;
- }
- /**
- * @param $id
- * $id could be any transaction id or reference
- * @return $this
- */
- public function timeline($id = null)
- {
- $this->acceptArray(false);
- $this->setRequestOptions($id);
- $this->sendRequest(Paystack::OP_TRANS_TIMELINE);
- $this->setResponseOptions();
- return $this;
- }
- /**
- * @param sting/array $from --> lower bound of date range for the transaction query
- * @param string (date) $to --> upper bound of date range
- * if an array is provided instead, both limit should be specified in the array
- * @return $this
- */
- public function total($from = null, $to = null)
- {
- $options = array();
- if (is_array($from))
- {
- $this->setRequestOptions($from);
- }
- else
- {
- if ($from)
- $options['from'] = $from;
- if ($to)
- $options['to'] = $to;
- $this->setRequestOptions($options);
- }
- $this->sendRequest(Paystack::OP_TRANS_TOTAL);
- $this->setResponseOptions();
- return $this;
- }
- /** @param $options, an array of options in key => value format
- * @return $this
- */
- public function export($options = null)
- {
- $this->setRequestOptions($options);
- $this->sendRequest(Paystack::OP_TRANS_EXPORT,Paystack::METHOD_GET);
- $this->setResponseOptions();
- return $this;
- }
- /** get the authorization url generated from initializing a transaction
- * @return $this
- */
- public function getAuthorizationUrl()
- {
- return $this->authorization_url;
- }
- /**
- * @param $refno string generated reference number
- * @return $this instance of the class
- */
- protected function setReference($refno)
- {
- $this->reference = $refno;
- return $this;
- }
- /**
- * @return string reference number which must have been set or generated
- */
- public function getReference()
- {
- return $this->reference;
- }
- /**
- * @return string reference number which must have been set or generated
- */
- protected function setPath($path)
- {
- $this->path = $path;
- }
- /** get the export url generated from performing export on transaction */
- public function getExportUrl()
- {
- return $this->path;
- }
- /** helper method to generate random reference which could be used in initiating a transaction*/
- public function generateRef($length = 10)
- {
- $this->reference = $this->paystack()->generateRef($length);
- return $this->reference;
- }
- /** redirect to the authorization url after successfully gettting authorization */
- public function redirect()
- {
- $url = $this->getAuthorizationUrl();
- if (empty($url))
- {
- throw new Exception('Authorization URL is empty');
- }
- Yii::$app->response->redirect($this->getAuthorizationUrl());
- }
- /** download the exported data from the export url gotten from export transaction method */
- public function download()
- {
- if (empty($this->path))
- {
- throw new Exception('Export link is empty');
- }
- Yii::$app->response->redirect($this->path);
- }
- }
|