[Documentation] Cookbook - How to add a custom Model? #6226
Conversation
CoderMaggie
commented
Sep 27, 2016
•
CoderMaggie
commented
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes |
| BC breaks? | no |
| Related tickets | partially #5275 |
| License | MIT |
CoderMaggie
changed the title
pjedrzejewski
added
the
Documentation
| In some cases you may be needing to add new models to your application in order to cover unique business needs. | ||
| The proccess of extending Sylius with new entities is simple and intuitive. | ||
|
|
||
| As an example we will take a **Supplier entity**, which may be really useful for th shop maintenance. |
There was a problem hiding this comment.
th => the? Also still works if you just remove it entirely.
| 3. Update the database using migrations | ||
| --------------------------------------- | ||
|
|
||
| Assuming that you have the databease updated to the state before adding the new entity you should run: |
There was a problem hiding this comment.
typo error : 'databease' should be 'database'
There was a problem hiding this comment.
And I'm not a native English speaker but I would turn this phrase into :
Assuming that your database was up-to-date before adding the new entity, run:
If a native English speaker could correct me ;-)
CoderMaggie
force-pushed
the
docs/cookbook/model
branch
from
1f54ae1
to
2e8f9d4
Compare
CoderMaggie
changed the title
| .. code-block:: yaml | ||
|
|
||
| # app/config/routing/admin/admin.yml | ||
| sylius_admin_carousel_item: |
There was a problem hiding this comment.
I guess it should be app_admin_supplier
| .. image:: ../_images/container_debug_supplier.png | ||
| :align: center | ||
|
|
||
| 6. Use Sylius API to create new resource |
There was a problem hiding this comment.
We should mention that this step is optional. (using the API)
|
|
||
| .. tip:: | ||
|
|
||
| Read more about authorizing in API :doc:`here </api/authorization>`. Different requests to Sylius API are described in `the Lionframe docs <http://lakion.com/lionframe>`_. |
There was a problem hiding this comment.
I think we should add examples of getting a list of suppliers and partial update of a supplier.
There was a problem hiding this comment.
Well I wasn't sure. API is not the main issue of this cookbook.
|
|
||
| # app/config/routing.yml | ||
| app_admin: | ||
| resource: 'routing/admin/admin.yml' |
There was a problem hiding this comment.
The main admin routing file should be just routing/admin.yml.
|
|
||
| .. tip:: | ||
|
|
||
| To see what you can do with your new entity access the ``http://localhost:8000/admin/suppliers`` url. |
CoderMaggie
force-pushed
the
docs/cookbook/model
branch
from
2e8f9d4
to
888557a
Compare
| driver: | ||
| name: doctrine/orm | ||
| options: | ||
| class: AppBundle/Entity/Supplier |
There was a problem hiding this comment.
it should be backslashes instead of slashes -> AppBundle\Entity\Supplier
CoderMaggie
force-pushed
the
docs/cookbook/model
branch
from
888557a
to
b964b78
Compare
|
Nice work Magda, thank you! :) |
