mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-14 17:10:53 +00:00
Merge branch '1.0' into 1.1
* 1.0: [Doc] Fix typos
This commit is contained in:
commit
e612b7366f
11 changed files with 23 additions and 23 deletions
|
|
@ -21,7 +21,7 @@ On the Customer entity we are holding a collection of addresses:
|
|||
*/
|
||||
protected $addresses;
|
||||
|
||||
We can operate on it as usually - by adding and removing objects.
|
||||
We can operate on it as usual - by adding and removing objects.
|
||||
|
||||
Besides the Customer entity has a **default address** field that is the default address used both for shipping and billing,
|
||||
the one that will be filling the form fields by default.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ or that have somehow provided us their e-mail.
|
|||
How to create a Customer programmatically?
|
||||
''''''''''''''''''''''''''''''''''''''''''
|
||||
|
||||
As usually, use a factory. The only required field for the Customer entity is ``email``, provide it before adding it to the repository.
|
||||
As usual, use a factory. The only required field for the Customer entity is ``email``, provide it before adding it to the repository.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ How to create an Adjustment programmatically?
|
|||
|
||||
The Adjustments alone are a bit useless. They should be created alongside Orders.
|
||||
|
||||
As usually get a factory and create an adjustment.
|
||||
As usual, get a factory and create an adjustment.
|
||||
Then give it a ``type`` - you can find all the available types on the `AdjustmentInterface <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/Model/AdjustmentInterface.php>`_.
|
||||
The adjustment needs also the ``amount`` - which is the amount of money that will be **added to the orders total**.
|
||||
|
||||
|
|
|
|||
|
|
@ -61,12 +61,12 @@ Now create an PromotionAction that will take place after applying this promotion
|
|||
|
||||
$this->container->get('sylius.repository.promotion')->add($promotion);
|
||||
|
||||
Finally to see the effects of your promotion with couponyou need to **apply a coupon on the Order**.
|
||||
Finally to see the effects of your promotion with coupon you need to **apply a coupon on the Order**.
|
||||
|
||||
How to apply a coupon to an Order?
|
||||
----------------------------------
|
||||
|
||||
To apply you promotion with coupon that gives 100% discount on the shipping costs
|
||||
To apply your promotion with coupon that gives 100% discount on the shipping costs
|
||||
you need an order that has shipments. Set your promotion coupon on that order -
|
||||
this is what happens when a customer provides a coupon code during checkout.
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ Promotion Coupon Generator
|
|||
|
||||
Making up new codes might become difficult if you would like to prepare a lot of coupons at once. That is why Sylius
|
||||
provides a service that generates random codes for you - `CouponGenerator <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Promotion/Generator/PromotionCouponGenerator.php>`_.
|
||||
In its **PromotionCouponGeneratorInstruction** you can define the amount of coupons that will be generated, length of their codes, expiration date and usage limit.
|
||||
In its **PromotionCouponGeneratorInstruction** you can define the amount of coupons that will be generated, the length of their codes, expiration date and usage limit.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ Gateway is configured for each payment method separately using the payment metho
|
|||
How to create a PaymentMethod programmatically?
|
||||
'''''''''''''''''''''''''''''''''''''''''''''''
|
||||
|
||||
As usually, use a factory to create a new PaymentMethod and give it a unique code.
|
||||
As usual, use a factory to create a new PaymentMethod and give it a unique code.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ and **priority** that is useful for them, because the exclusive promotion should
|
|||
How to create a Promotion programmatically?
|
||||
-------------------------------------------
|
||||
|
||||
Just as usually, use a factory. The promotion needs a ``code`` and a ``name``.
|
||||
Just as usual, use a factory. The promotion needs a ``code`` and a ``name``.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
Shipments
|
||||
=========
|
||||
|
||||
A **Shipment** is a representation of a shipping request for an Order. Sylius supports multiple shipments per one Order.
|
||||
A **Shipment** is a representation of a shipping request for an Order. Sylius can attach multiple shipments to each single Order.
|
||||
|
||||
How is a Shipment created for an Order?
|
||||
'''''''''''''''''''''''''''''''''''''''
|
||||
|
|
@ -16,7 +16,7 @@ How is a Shipment created for an Order?
|
|||
The Shipment State Machine
|
||||
--------------------------
|
||||
|
||||
A Shipment that is attached to an Order will have its own state machine with such states available:
|
||||
A Shipment that is attached to an Order will have its own state machine with the following states available:
|
||||
``cart``, ``ready``, ``cancelled``, ``shipped``.
|
||||
|
||||
The allowed transitions between these states are:
|
||||
|
|
@ -46,8 +46,8 @@ Shipping Methods
|
|||
How to create a ShippingMethod programmatically?
|
||||
''''''''''''''''''''''''''''''''''''''''''''''''
|
||||
|
||||
As usually use a factory to create a new ShippingMethod. Give it a ``code``, set a desired shipping calculator and set a ``zone``.
|
||||
It need also a configuration, for instance of the amount (cost).
|
||||
As usual use a factory to create a new ShippingMethod. Give it a ``code``, set a desired shipping calculator and set a ``zone``.
|
||||
It also need a configuration, for instance of the amount (cost).
|
||||
At the end add it to the system using a repository.
|
||||
|
||||
.. code-block:: php
|
||||
|
|
@ -110,7 +110,7 @@ The already defined calculators in Sylius are described as constants in the
|
|||
ProductVariant Configuration
|
||||
----------------------------
|
||||
|
||||
In order to be able to calculate shipping costs basing on the volume and weight of products in an order
|
||||
In order to be able to calculate shipping costs based on the volume and weight of products in an order
|
||||
the ProductVariant has the ``depth``, ``width``, ``height`` and ``weight`` fields.
|
||||
|
||||
Shipment complete events
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ InventoryUnit
|
|||
InventoryUnit has a relation to a `Stockable <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Inventory/Model/StockableInterface.php>`_ on it,
|
||||
in case of Sylius Core it will be a relation to the **ProductVariant** that implements the StockableInterface on the **OrderItemUnit** that implements the InventoryUnitInterface.
|
||||
|
||||
It represents a physical unit of the product variant that is in the magazine.
|
||||
It represents a physical unit of the product variant that is in the shop.
|
||||
|
||||
Inventory On Hold
|
||||
-----------------
|
||||
|
|
@ -27,7 +27,7 @@ Putting inventory items ``onHold`` is a way of reserving them before the custome
|
|||
Availability Checker
|
||||
--------------------
|
||||
|
||||
There is a service that will help you checking the availability of items in the inventory
|
||||
There is a service that will help you check the availability of items in the inventory
|
||||
- `AvailabilityChecker <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Inventory/Checker/AvailabilityChecker.php>`_.
|
||||
|
||||
It has two methods ``isStockAvailable`` (is there at least one item available) and ``isStockSufficient`` (is there a given amount of items available).
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Each currency defined in the system should have an ExchangeRate configured.
|
|||
|
||||
**ExchangeRate** is a separate entity that holds a relation between two currencies and specifies their exchange rate.
|
||||
|
||||
Exchange rates are used for viewing the *approximate* price in a currency different form the base currency of a channel.
|
||||
Exchange rates are used for viewing the *approximate* price in a currency different from the base currency of a channel.
|
||||
|
||||
Learn more
|
||||
----------
|
||||
|
|
|
|||
|
|
@ -4,13 +4,13 @@
|
|||
Search
|
||||
======
|
||||
|
||||
Having a products search functionality in an eCommerce system is a very popular usecase.
|
||||
Having a products search functionality in an eCommerce system is a very popular use case.
|
||||
Sylius provides a products search functionality that is a grid filter.
|
||||
|
||||
Grid filters
|
||||
------------
|
||||
|
||||
For simple usecases of products search use the **filters of grids**.
|
||||
For simple use cases of products search use the **filters of grids**.
|
||||
For example, the shop's categories each have a ``search`` filter in the products grid:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
|
@ -25,7 +25,7 @@ For example, the shop's categories each have a ``search`` filter in the products
|
|||
form_options:
|
||||
type: contains
|
||||
|
||||
It searches by product names that contain a string that the user typed in the search bar.
|
||||
It searches by product names that contains a string that the user typed in the search bar.
|
||||
|
||||
The search bar looks like below:
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Taxons
|
|||
======
|
||||
|
||||
We understand Taxons in Sylius as you would normally define categories.
|
||||
Sylius gives you a possibility to categorize your products in a very flexible way, which is one of the most vital funtionalities
|
||||
Sylius gives you a possibility to categorize your products in a very flexible way, which is one of the most vital functionalities
|
||||
of the modern e-commerce systems.
|
||||
The Taxons system in Sylius works in a hierarchical way.
|
||||
Let's see exemplary categories trees:
|
||||
|
|
@ -107,10 +107,10 @@ In order to categorize products you will need to assign your taxons to them - vi
|
|||
What is the mainTaxon of a Product?
|
||||
-----------------------------------
|
||||
|
||||
The product entity in Sylius core has a field ``mainTaxon``. On its basis for instance the breadcrumbs are generated.
|
||||
But also you can use it for your own logic, like for instance links generation.
|
||||
The product entity in Sylius core has a field ``mainTaxon``. This field is used, for instance, for breadcrumbs generation.
|
||||
But you can also use it for your own logic, like for instance links generation.
|
||||
|
||||
To have it on your product you need to use the ``setMainTaxon()`` method.
|
||||
To set it on your product you need to use the ``setMainTaxon()`` method.
|
||||
|
||||
Learn more
|
||||
----------
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue