Skip to content

PayPalRestful Class Diagrams

lat9 edited this page Jan 17, 2024 · 18 revisions

See https://github.com/mermaidjs/mermaidjs.github.io/blob/master/classDiagram.md?plain=1 for examples

Storefront Class Diagram

 classDiagram
      `Common\Logger` *-- `Zc2Pp\ConfirmPayPalPaymentChoiceRequest`
      `Common\Helpers` o-- `Api\PayPalRestfulApi`
      `Token\TokenCache` *-- `Api\PayPalRestfulApi`
      `Common\Logger` *-- `Token\TokenCache`
      `Common\Logger` *-- `Api\PayPalRestfulApi`
      `Common\ErrorInfo` <|-- `Api\PayPalRestfulApi`
      `Api\Data\CountryCodes` o-- `Zc2Pp\Address`
      `Common\Logger` *-- `Zc2Pp\Amount`
      `Common\ErrorInfo` <|-- `Zc2Pp\CreatePayPalOrderRequest`
      `Common\Logger` *-- `Zc2Pp\CreatePayPalOrderRequest`
      `Zc2Pp\Amount` *-- `Zc2Pp\CreatePayPalOrderRequest`
      `Zc2Pp\Address` *-- `Zc2Pp\CreatePayPalOrderRequest`
      `Zc2Pp\Name` *-- `Zc2Pp\CreatePayPalOrderRequest`
       class `Api\PayPalRestfulApi` {
          #Logger log
          #TokenCache tokenCache
          #string endpoint
          -string clientId
          -string clientSecret
          #ch
          #array curlOptions
          #string paypalRequestId
          #string paypalMockResponse
          #bool keepTxnLinks
          +close(): void
          +setMockResponse(): void
          +setKeepTxnLinks(): void
          +createOrder(): bool|array
          +getOrderStatus(): bool|array
          +confirmPaymentSource(): bool|array
          +captureOrder(): bool|array
          +authorizeOrder(): bool|array
          +capturePaymentRemaining(): bool|array
          +capturePaymentAmount(): bool|array
          +reauthorizePayment(): bool|array
          +voidPayment(): bool|array
          +refundCaptureFull(): bool|array
          +refundCapturePartial(): bool|array
          #refundCapture(): bool|array
          +getRefundStatus(): bool|array
          +validatePayPalCredentials(): bool
          #getOAuth2Token(): string
          #setAuthorizationHeader(): string
          #curlPost(): bool|array
          #curlGet(): bool|array
          #curlPatch(): bool|array
          #issueRequest(): bool|array
          #handleCurlError(): void
          #handleResponse(): bool|array
      }
      class `Zc2Pp\ConfirmPayPalPaymentChoiceRequest` {
          #array request
          +get(): array
      }
      class `Api\Data\CountryCodes` {
          #array countryCodes$
          +convertCountryCode(): string$
      }
      class `Common\Helpers` {
          +arrayDiffRecursive(): array$
          +convertPayPalDate2Db(): string$
          +getDaysTo(): string$
          +getDaysFrom(): string$
      }
      class `Common\ErrorInfo` {
          #array errorInfo
          +getErrorInfo(): array
          +copyErrorInfo(): void
          #setErrorInfo(): void
          #resetErrorInfo(): void
       }
      class `Common\Logger` {
          #bool debug$
          #string debugLogFile$
          +enableDebug(): void
          +disableDebug(): void
          +logJSON(): string$
          +write(): void
      }
      class `Token\TokenCache` {
          -string encryptionAlgorithm
          -int encryptionAlgoIvLen
          -string clientSecret
          #setEncryptionAlgorithm(): string
          +get(): string
          +save(): void
          +clear(): void
      }
      class `Zc2Pp\Address` {
          +get(): array$
      }
      class `Zc2Pp\Amount` {
          #array amount
          #array defaultCurrencyCode$
          #array supportedCurrencyCodes$
          #Logger log
          +getSupportedCurrencyCodes(): array
          +get(): array
          +getCurrencyDecimals(): int
          +setDefaultCurrency(): void
          +getDefaultCurrency(): array
          +getDefaultCurrencyCode(): string
          +getValueFromFloat(): string
          +getValueFromString(): string
          +setValue(): array
      }
      class `Zc2Pp\CreatePayPalOrderRequest` {
          #Logger log
          #Amount amount
          #string paypalCurrencyCode
          #array request
          #array itemBreakdown
          #float overallDiscount
          #validateOrderAmount(): void
          +get(): array
          +getBreakdownMismatch(): array
          #getItems(): array
          #isProductPhysical(): bool
          #getOrderAmountAndBreakdown(): array
          #calculateHandling(): float
          #calculateInsurance(): float
          #calculateDiscount(): float
          #calculateOrderElementValue(): float
          #setRateConvertedValue(): array
          #getRateConvertedValue(): string
          #getShippingAddressInfo(): array
          #countItems(): int
          #buildCardPaymentSource(): array
          #buildLevel2Level3Data(): array
      }
      class `Zc2Pp\Name` {
          +get(): array$
      }
Loading

Admin Class Diagram

 classDiagram
      `Common\ErrorInfo` <|-- `Api\PayPalRestfulApi`
      `Token\TokenCache` *-- `Api\PayPalRestfulApi`
      `Common\Logger` *-- `Admin\GetPayPalOrderTransactions`
      `Common\Helpers` o-- `Admin\GetPayPalOrderTransactions`
      `Api\PayPalRestfulApi` o-- `Admin\GetPayPalOrderTransactions`
      `Admin\Formatters\Messages` *-- `Admin\GetPayPalOrderTransactions`
      `Common\Helpers` o-- `Admin\Formatters\MainDisplay`
      `Zc2Pp\Amount` *-- `Admin\Formatters\MainDisplay`
      `Api\PayPalRestfulApi` o-- `Admin\AdminMain`
      `Admin\GetPayPalOrderTransactions` *-- `Admin\AdminMain`
      `Admin\Formatters\MainDisplay` *-- `Admin\AdminMain`
      `Common\Logger` *-- `Token\TokenCache`
      `Common\Logger` *-- `Api\PayPalRestfulApi`
      `Common\Helpers` o-- `Api\PayPalRestfulApi`
      `Common\Logger` *-- `Zc2Pp\Amount`
      `Common\Helpers` o-- `Admin\DoAuthorize`
      `Api\PayPalRestfulApi` o-- `Admin\DoAuthorize`
      `Zc2Pp\Amount` *-- `Admin\DoAuthorize`
      `Admin\GetPayPalOrderTransactions` *-- `Admin\DoAuthorize`
      `Common\Helpers` o-- `Admin\DoCapture`
      `Api\PayPalRestfulApi` o-- `Admin\DoCapture`
      `Zc2Pp\Amount` *-- `Admin\DoCapture`
      `Admin\GetPayPalOrderTransactions` *-- `Admin\DoCapture`
      `Common\Helpers` o-- `Admin\DoRefund`
      `Api\PayPalRestfulApi` o-- `Admin\DoRefund`
      `Zc2Pp\Amount` *-- `Admin\DoRefund`
      `Admin\GetPayPalOrderTransactions` *-- `Admin\DoRefund`
      `Common\Helpers` o-- `Admin\DoVoid`
      `Api\PayPalRestfulApi` o-- `Admin\DoVoid`
      `Admin\GetPayPalOrderTransactions` *-- `Admin\DoVoid`

      class `Common\ErrorInfo` {
          #array errorInfo
          +getErrorInfo(): array
          +copyErrorInfo(): void
          #setErrorInfo(): void
          #resetErrorInfo(): void
       }
      class `Api\PayPalRestfulApi` {
          #Logger log
          #TokenCache tokenCache
          #string endpoint
          -string clientId
          -string clientSecret
          #ch
          #array curlOptions
          #string paypalRequestId
          #string paypalMockResponse
          #bool keepTxnLinks
          +close(): void
          +setMockResponse(): void
          +setKeepTxnLinks(): void
          +createOrder(): bool|array
          +getOrderStatus(): bool|array
          +confirmPaymentSource(): bool|array
          +captureOrder(): bool|array
          +authorizeOrder(): bool|array
          +capturePaymentRemaining(): bool|array
          +capturePaymentAmount(): bool|array
          +reauthorizePayment(): bool|array
          +voidPayment(): bool|array
          +refundCaptureFull(): bool|array
          +refundCapturePartial(): bool|array
          #refundCapture(): bool|array
          +getRefundStatus(): bool|array
          +validatePayPalCredentials(): bool
          #getOAuth2Token(): string
          #setAuthorizationHeader(): string
          #curlPost(): bool|array
          #curlGet(): bool|array
          #curlPatch(): bool|array
          #issueRequest(): bool|array
          #handleCurlError(): void
          #handleResponse(): bool|array
      }
      class `Common\Helpers` {
          +arrayDiffRecursive(): array$
          +convertPayPalDate2Db(): string$
          +getDaysTo(): string$
          +getDaysFrom(): string$
      }

      class `Common\Logger` {
          #bool debug$
          #string debugLogFile$
          +enableDebug(): void
          +disableDebug(): void
          +logJSON(): string$
          +write(): void
      }
      class `Token\TokenCache` {
          -string encryptionAlgorithm
          -int encryptionAlgoIvLen
          -string clientSecret
          #setEncryptionAlgorithm(): string
          +get(): string
          +save(): void
          +clear(): void
      }
      class `Zc2Pp\Amount` {
          #array amount
          #array defaultCurrencyCode$
          #array supportedCurrencyCodes$
          #Logger log
          +getSupportedCurrencyCodes(): array
          +get(): array
          +getCurrencyDecimals(): int
          +setDefaultCurrency(): void
          +getDefaultCurrency(): array
          +getDefaultCurrencyCode(): string
          +getValueFromFloat(): string
          +getValueFromString(): string
          +setValue(): array
      }
      class `Admin\Formatters\Messages` {
          +output(): string
      }
      class `Admin\GetPayPalOrderTransactions` {
          #Logger log
          #string moduleName
          #string moduleVersion
          #int oID
          #PayPalRestfulApi ppr
          #array databaseTxns
          #Messages messages
          #string paymentType
          #array paypalTransactions
          #bool externalTxnAdded
          +externalTxnAdded(): bool
          +getDatabaseTxns(): array
          +getInvoiceId(): string
          +syncPayPalTxns(): void
          +getMessages(): string
          #getPayPalDatabaseTransactionsForOrder(): void
          #getPayPalUpdates(): void
          #updateAuthorizations(): void
          #updateCaptures(): void
          #updateRefunds(): void
          #transactionExists(): bool
          #getParentTxnStatus(): array
          +addDbTransaction(): string
          #getParentTxnFromResponse(): string
          +updateParentTxnDateAndStatus(): void
          #getPaymentInfo(): array
          +updateMainTransaction(): void
      }
      class `Admin\AdminMain` {
          #PayPalRestFulApi ppr
          #string adminNotifications
          +get(): string
      }
      class `Admin\Formatters\MainDisplay` {
          #string mainDisplay
          #array settledFunds
          #string modals
          #Amount amount
          #string currencyCode
          #array paypalDbTxns
          #bool jQueryLoadRequired
          #array txnTableFields$
          #array paymentTableFields$
          #bool externalTxnAdded
          +externalTxnAdded(): bool
          +get(): string
          #buildTxnTable(): string
          #buildPaymentsTable(): string
          #buildTableHeader(): string
          #buildTxnTableData(): string
          #createActionButton(): string
          #createDetailsModal(): string
          #createAuthButtonsAndModals(): array
          #createReauthModal(): string
          #createCaptureModal(): string
          #createCaptureButtonsAndModals(): array
          #createRefundModal(): string
          #createStaticFormGroup(): string
          #createModalInput(): string
          #createModalTextArea(): string
          #createModalCheckbox(): string
          #createModalButtons(): string
          #createModal(): string
          #buildPaymentTableData(): string
          #loadJQuery(): string
      }

      class `Admin\DoAuthorize` {
      }
      class `Admin\DoCapture` {
      }
      class `Admin\DoRefund` {
      }
      class `Admin\DoVoid` {
      }
Loading
Clone this wiki locally