- Add comments

Author: klsheng

src/Helper/MyInvoisHelper.php

@@ -7,8 +7,22 @@
 
 namespace Klsheng\Myinvois\Helper;
 
+/**
+ * Helper class
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class MyInvoisHelper
 {
+    /**
+     * Static function helper
+     * 
+     * @param string $name Function name
+     * @param array $arguments Function parameters
+     * 
+     * @return mixed
+     */
     public static function __callStatic($name, $arguments) {
         switch ($name) {
             case 'getSubmitDocument':
@@ -18,6 +32,14 @@ public static function __callStatic($name, $arguments) {
         }
     }
 
+    /**
+     * Static function helper
+     * 
+     * @param string $content Content
+     * @param bool $binary Indicate whether result should be in binary
+     * 
+     * @return string
+     */
     public static function getHash($content, $binary = false)
     {
         return hash('sha256', $content, $binary);
@@ -54,6 +76,13 @@ private static function getInternalSubmitDocument($arguments)
         ];
     }
 
+    /**
+     * Check whether content is json format
+     * 
+     * @param string $string Content
+     * 
+     * @return bool
+     */
     public static function isJson($string) {
         json_decode($string);
         return json_last_error() === JSON_ERROR_NONE;

src/Model/AbstractModel.php

@@ -10,6 +10,12 @@
 use ReflectionClass;
 use ReflectionProperty;
 
+/**
+ * Abstract class for Model
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 abstract class AbstractModel
 {
     /**

src/MyInvoisClient.php

@@ -20,6 +20,12 @@
 use Klsheng\Myinvois\Service\Notification\NotificationService;
 use Klsheng\Myinvois\Service\Taxpayer\TaxPayerService;
 
+/**
+ * Access point to use MyInvoice services
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class MyInvoisClient
 {
     private const SANDBOX_PORTAL_BASE_URL = 'https://preprod.myinvois.hasil.gov.my';

src/Service/AbstractService.php

@@ -10,6 +10,12 @@
 use Exception;
 use Klsheng\Myinvois\MyInvoisClient;
 
+/**
+ * Abstract class for service component
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 abstract class AbstractService
 {
     /**

src/Service/Document/DocumentService.php

@@ -12,6 +12,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Document service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class DocumentService extends AbstractService
 {
     public const SANDBOX_API_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/documents';

src/Service/Document/DocumentSubmissionService.php

@@ -11,6 +11,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Document submission service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class DocumentSubmissionService extends AbstractService
 {
     public const SANDBOX_API_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/documentsubmissions';

src/Service/Document/DocumentTypeService.php

@@ -11,6 +11,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Document type service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class DocumentTypeService extends AbstractService
 {
     public const SANDBOX_API_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/documenttypes';

src/Service/Identity/IdentityService.php

@@ -11,6 +11,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Identity service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class IdentityService extends AbstractService
 {
     public const SANDBOX_IDENTITY_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/connect/token';

src/Service/Notification/NotificationService.php

@@ -12,6 +12,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Notification service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class NotificationService extends AbstractService
 {
     public const SANDBOX_API_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/notifications';

src/Service/Taxpayer/TaxPayerService.php

@@ -11,6 +11,12 @@
 use Klsheng\Myinvois\MyInvoisClient;
 use Klsheng\Myinvois\Service\AbstractService;
 
+/**
+ * Tax payer service
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class TaxPayerService extends AbstractService
 {
     public const SANDBOX_API_BASE_URL = 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/taxpayer';

src/Ubl/AccountingParty.php

@@ -11,6 +11,12 @@
 use Sabre\Xml\Writer;
 use Klsheng\Myinvois\Ubl\Constant\UblAttributes;
 
+/**
+ * Accounting party
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class AccountingParty implements ISerializable, IValidator
 {
     private $customerAssignedAccountID;

src/Ubl/AdditionalDocumentReference.php

@@ -10,6 +10,12 @@
 use InvalidArgumentException;
 use Sabre\Xml\Writer;
 
+/**
+ * Additional document reference
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class AdditionalDocumentReference implements ISerializable, IValidator
 {
     private $id;

src/Ubl/Address.php

@@ -10,6 +10,12 @@
 use InvalidArgumentException;
 use Sabre\Xml\Writer;
 
+/**
+ * Address
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class Address implements ISerializable, IValidator
 {
     private $streetName;

src/Ubl/AddressLine.php

@@ -9,6 +9,12 @@
 
 use Sabre\Xml\Writer;
 
+/**
+ * Address line
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class AddressLine implements ISerializable, IValidator
 {
     private $line;

src/Ubl/AllowanceCharge.php

@@ -12,6 +12,12 @@
 use Klsheng\Myinvois\Ubl\Constant\CurrencyCodes;
 use Klsheng\Myinvois\Ubl\Constant\UblAttributes;
 
+/**
+ * Allowance charge
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class AllowanceCharge implements ISerializable, IValidator
 {
     private $chargeIndicator;

src/Ubl/Attachment.php

@@ -11,6 +11,12 @@
 use InvalidArgumentException;
 use Sabre\Xml\Writer;
 
+/**
+ * Attachment
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class Attachment implements ISerializable, IValidator
 {
     private $filePath;

src/Ubl/BillingReference.php

@@ -10,6 +10,12 @@
 use InvalidArgumentException;
 use Sabre\Xml\Writer;
 
+/**
+ * Billing reference
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class BillingReference implements ISerializable, IValidator
 {
     private $additionalDocumentReference;

src/Ubl/Builder/AbstractDocumentBuilder.php

@@ -31,6 +31,12 @@
 use Klsheng\Myinvois\Ubl\Extension\CertDigest;
 use Klsheng\Myinvois\Ubl\Extension\IssuerSerial;
 
+/**
+ * Abstract document builder
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 abstract class AbstractDocumentBuilder implements IDocumentBuilder
 {
     private $document = null;

src/Ubl/Builder/IDocumentBuilder.php

@@ -10,6 +10,12 @@
 use DateTime;
 use Klsheng\Myinvois\Ubl\Invoice;
 
+/**
+ * document builder interface
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 interface IDocumentBuilder
 {
     /**

src/Ubl/Builder/JsonDocumentBuilder.php

@@ -11,6 +11,12 @@
 use Klsheng\Myinvois\Helper\MyInvoisHelper;
 use Klsheng\Myinvois\Ubl\Extension\Signature;
 
+/**
+ * JSON document builder
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class JsonDocumentBuilder extends AbstractDocumentBuilder
 {
     /**

src/Ubl/Builder/XmlDocumentBuilder.php

@@ -13,6 +13,12 @@
 use Klsheng\Myinvois\Helper\MyInvoisHelper;
 use Klsheng\Myinvois\Ubl\Extension\Signature;
 
+/**
+ * XML document builder
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class XmlDocumentBuilder extends AbstractDocumentBuilder
 {
     /**

src/Ubl/CommodityClassification.php

@@ -11,6 +11,12 @@
 use Sabre\Xml\Writer;
 use Klsheng\Myinvois\Ubl\Constant\UblAttributes;
 
+/**
+ * Commodity classification
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class CommodityClassification implements ISerializable, IValidator
 {
     private $itemClassificationCode;

src/Ubl/Constant/ClassificationCodes.php

@@ -7,6 +7,12 @@
 
 namespace Klsheng\Myinvois\Ubl\Constant;
 
+/**
+ * Classification codes
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class ClassificationCodes
 {
     const CODE = 'Code';

src/Ubl/Constant/CountryCodes.php

@@ -7,6 +7,12 @@
 
 namespace Klsheng\Myinvois\Ubl\Constant;
 
+/**
+ * Country codes
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class CountryCodes
 {
     const CODE = 'Code';

src/Ubl/Constant/CurrencyCodes.php

@@ -7,6 +7,12 @@
 
 namespace Klsheng\Myinvois\Ubl\Constant;
 
+/**
+ * Currency codes
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class CurrencyCodes
 {
     const CODE = 'Code';

src/Ubl/Constant/InvoiceTypeCodes.php

@@ -7,6 +7,12 @@
 
 namespace Klsheng\Myinvois\Ubl\Constant;
 
+/**
+ * Invoice type codes
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class InvoiceTypeCodes
 {
     const INVOICE = '01';

src/Ubl/Constant/MSICCodes.php

@@ -7,6 +7,12 @@
 
 namespace Klsheng\Myinvois\Ubl\Constant;
 
+/**
+ * MSIC codes
+ * 
+ * @author Sean Kau ([email protected])
+ * @since 1.0.0
+ */
 class MSICCodes
 {
     const CODE = 'Code';