Unclear Doc about ivorygooglemapbundle

[egeloen]

I know the documentation is very unclear, I need to rewrite it but I don't have lot of time actually...

Can you be more precise on what don't you understand because if I need to explain all the possibility of the Map ORM, it will be a very large post like you can see in documentation.

[mablae]

To be more precise: What steps are needed to implement the correct usage of "the ID & the association"? Let's say I want to persist your pre-build models with all details.

Thanks for your quick reply ;-)

[mablae]

Maybe I can do a little bit of rewriting the docs tomorrow, I want to work with your bundle, I'll do a fork so you can easily merge my pull requests when wanted....

[egeloen]

The pre-build model are located in Resources/public/config/doctrine. It's super classes ORM mapping.

I will give you a simple example where a map is linked to markers. Of course, a map can have rectangles, polylines & others. The steps are the same for this entities.

First, you need to create a map, a marker, a coordinate & a bound class in your bundle which extends the coreesponding classes in Ivory\GoogleMapBundle\Entity\*. Warning, your entities need to be located in your Entity folder.
Secondly, in their classes, you need to create an ID with this getter.
Thridly, like you can see in Ivory\GoogleMapBundle\Model\Map, a map can have a collection of markers. So if you want to persist the markers with a map, you need to initialize an ArrayCollection in the map constructor for their markers.

Map class:

use Ivory\GoogleMapBundle\Entity\Map as BaseMap;
use Doctrine\Common\Collections\ArrayCollection;

class Map extends BaseMap
{
    protected $id;

    public function __construct()
    {
        // Call the parent constructor
        parent::__construct();

        // Link map to a center entity and/or a bound entity
        $this->center = new Coordinate();
        $this->bound = new Bound();

        // Initialize the array collection
        $this->markers = new ArrayCollection();
    }

    public function getId()
    {
        return $this->id;
    }
}

Marker class:

use Ivory\GoogleMapBundle\Entity\Marker as BaseMarker;

class Marker extends BaseMarker
{
    protected $id;

    public function __construct()
    {
        // Call parent constructor
        parent::__construct();

        // Link marker to a position entity
        $this->position = new Coordinate();
    }

    public function getId()
    {
        return $this->id;
    }
}

After creating your classes, you need to define your ORM mapping

Map ORM mapping:

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="Namespace\Entity\Map">
        <id name="id" type="integer">
            <generator strategy="AUTO" />
        </id>
        <one-to-one field="center" target-entity="Namespace\Entity\Coordinate" />
        <one-to-one field="bound" target-entity="Namespace\Entity\Bound" />
        <many-to-many field="markers" target-entity="Namespace\Entity\Marker" />
    </entity>

</doctrine-mapping>

Marker ORM mapping:

// src/YourBundle/Resources/config/doctrine/Marker.orm.xml
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="Namespace\Entity\Marker">
        <id name="id" type="integer">
            <generator strategy="AUTO" />
        </id>
        <one-to-one field="position" target-entity="Namespace\Entity\Coordinate" />
    </entity>

</doctrine-mapping>

[mablae]

Thanks again! Thats what I needed. I'm very new to symfony2, so I'm not that good at it yet.