Skip to content

Commit

Permalink
Merge pull request Sylius#7368 from Zales0123/docs-credit-card-fixes
Browse files Browse the repository at this point in the history
[Docs] Remove credit card related documentation
  • Loading branch information
pjedrzejewski committed Jan 30, 2017
2 parents 604d998 + f88c9dd commit e8daaf1
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 95 deletions.
35 changes: 0 additions & 35 deletions docs/components/Payment/credit_card_types.rst

This file was deleted.

3 changes: 1 addition & 2 deletions docs/components/Payment/index.rst
Expand Up @@ -3,7 +3,7 @@ Payment

PHP library which provides abstraction of payments management.

It ships with default **Payment**, **PaymentMethod** and **CreditCard** models.
It ships with default **Payment** and **PaymentMethod** models.

.. note::
This component does not provide any payment gateway.
Expand All @@ -16,6 +16,5 @@ It ships with default **Payment**, **PaymentMethod** and **CreditCard** models.
basic_usage
models
interfaces
credit_card_types
default_fee_calculators
state_machine
18 changes: 0 additions & 18 deletions docs/components/Payment/interfaces.rst
Expand Up @@ -4,22 +4,6 @@ Interfaces
Model Interfaces
----------------

.. _component_payment_model_credit-card-interface:

CreditCardInterface
~~~~~~~~~~~~~~~~~~~

This interface should be implemented by any custom model representing a credit card.
It also contains all the default :doc:`/components/Payment/credit_card_types`.

.. note::
This interface extends the :ref:`component_payment_model_payment-source-interface`
and the :ref:`component_resource_model_timestampable-interface`.

For more detailed information go to `Sylius API CreditCardInterface`_.

.. _Sylius API CreditCardInterface: http://api.sylius.org/Sylius/Component/Payment/Model/CreditCardInterface.html

.. _component_payment_model_payment-interface:

PaymentInterface
Expand Down Expand Up @@ -85,8 +69,6 @@ PaymentSourceInterface

This interface needs to be implemented by any custom payment source.

The default payment source is :ref:`component_payment_model_credit-card`.

.. note::
For more detailed information go to `Sylius API PaymentSourceInterface`_.

Expand Down
40 changes: 0 additions & 40 deletions docs/components/Payment/models.rst
Expand Up @@ -21,8 +21,6 @@ Every payment is represented by a **Payment** instance and has the following pro
+------------+---------------------------------------------+
| state | Payment's state |
+------------+---------------------------------------------+
| creditCard | Credit card as a source |
+------------+---------------------------------------------+
| details | Payment's details |
+------------+---------------------------------------------+
| createdAt | Date of creation |
Expand All @@ -41,44 +39,6 @@ Every payment is represented by a **Payment** instance and has the following pro
.. hint::
All default payment states are available in :ref:`component_payment_payment-states`.

.. _component_payment_model_credit-card:

CreditCard
----------

Every credit card is represented by a **CreditCard** instance and has the following properties:

+----------------+-------------------------------------------+
| Property | Description |
+================+===========================================+
| id | Unique id of the credit card |
+----------------+-------------------------------------------+
| token | Payment gateway token |
+----------------+-------------------------------------------+
| type | Type of credit card (VISA, MasterCard...) |
+----------------+-------------------------------------------+
| cardholderName | Cardholder's name |
+----------------+-------------------------------------------+
| number | Card number |
+----------------+-------------------------------------------+
| securityCode | Security code |
+----------------+-------------------------------------------+
| expiryMonth | Expiry month |
+----------------+-------------------------------------------+
| expiryYear | Expiry year |
+----------------+-------------------------------------------+
| createdAt | Date of creation |
+----------------+-------------------------------------------+
| updatedAt | Date of the last update |
+----------------+-------------------------------------------+

.. note::
This model implements the :ref:`component_payment_model_credit-card-interface`.

For more detailed information go to `Sylius API CreditCard`_.

.. _Sylius API CreditCard: http://api.sylius.org/Sylius/Component/Payment/Model/CreditCard.html

.. _component_payment_model_payment-method:

PaymentMethod
Expand Down

0 comments on commit e8daaf1

Please sign in to comment.