Skipper support site - Recent questions and answers in How To & Manuals

Answered: [Answered] Manually create migrations

Wed, 02 Nov 2022 08:38:58 +0000

Hello Frode,
sorry for the late reply, I missed the notification.

You can do this for example by importing your whole project (from the database for example), creating the first migration, and then marking this migration as non-exportable.

You can find these settings in the migration management dialog->enable/disable migration export

Answered: How to do references with mongodb odm?

Tue, 14 Sep 2021 20:58:25 +0000

I'm not sure where can be a problem. Just create association between two entities and fill aliases for directions you want to have generated.

Answered: Can I hide an entity from the graph

Fri, 18 Jun 2021 21:17:56 +0000

Hello,

sorry, it's not possible to hide an entity. It doesn't make sense to hide something that is exported.

But, you can split the lines leading from this entity. Simply double click on the association and check "splitted"

Answered: Import laravel migrations

Wed, 12 May 2021 06:11:42 +0000

Hello,

unfortunately, there is no way how to import existing migrations to Skipper. You can import an existing model from the database which will be imported as one initial migration.

But it seems you are having trouble also with the entity imports. Did you select correct database settings? Can you take more screenshots/screencasts with your settings?

Answered: [Solved] Skipper not get started on ubuntu 18.04

Thu, 10 Dec 2020 12:15:14 +0000

Based on testing it seems that some Linux distributions are missing library libxcb-xinerama.so.0 altought other libxcb-* libraries are installed.

In case that this is your case, it's necessary to manually install it via:

sudo apt-get install libxcb-xinerama0

Answered: [Answered] cardinality options

Fri, 03 Apr 2020 05:37:33 +0000

Hello,

Skipper is using the same cardinality marks for ORM association like any other ERD systems.

You're controlling owner side optional/required via "Parent connection" property, where you can set 0:1-* or 1:1-*

and inverse side type between one-to-many or one-to-one type via "Association type".

I want to qualify my entities associations into 0,n but don't find such choice in the association options,

"0,n" isn't a complete description of cardinality. You need to configure the owner-side and parent side. Usually something like 0:1-0:n, or 1:1-0:n, 0:1-0:1, etc. First means the parent side, second child (inverse) side.

As I wrote before, the parent side is configured via "Parent connection" where you can choose between 0:1 and 1:1, and child (inverse) side is configured via "Association type" where you can choose one-to-many ( -0:n) or one-to-one ( -0:1).

I hope it's a more clear now.

Can I store visual changes to an external module in the project?

Thu, 19 Dec 2019 14:35:28 +0000

I'm storing a skipper.module.xml file within a package that is then distributed via composer to an application that has a Project.skipper file.

When I then make any visual changes to the project file (e.g. to get things lined up better since there are inheritances in the application that don't show at the module level) this ends up saving them to the skipper.module.xml under the vendor directory.

When trying to perform composer update, if there are updates to the module, there are changes which I then have to discard (by rerunning the composer update command with --no-interaction and "discard-changes": true set in the config).

Aside from that last point just being an annoyance, I can work around it, however when I then reopen the project file the visual styles are all over the place and I have to realign things to make sense on the project level. So my question is, is it possible to set the visual styles at the project level and leave the vendor files unmodified?

Thanks.

Answered: abstract base model class

Thu, 21 Nov 2019 19:08:41 +0000

Hi,

currently, there is no way how to change base class for all abstract classes.

How exactly do you expect to work it? Do you mean to change it for all classes? So at the project level? Or the module level? Or the entity level?

And if so, I'm still not sure where to place such abstract-base class, because the whole directory of abstract-classes is automatically managed via Skipper so there is no way how to edit it.

Can you prepare some example how you're expecting it?

And regarding created/updated by what exactly you want to replace? Can you please show currently export state and expected one?

Thanks

[Fixed] Problems with migrations using this

Thu, 07 Nov 2019 09:31:51 +0000

I added this:

I have a Account and a Tag Model and it looks like this:

Migration fails because it looks like this:

Error:

   Symfony\Component\Debug\Exception\FatalThrowableError  : Too few arguments to function Illuminate\Database\Schema\Blueprint::foreign(), 0 passed in /Users/marton/Sites/mBud/database/migrations/2019_11_07_102754_skipper_migrations_2019110710275404.php on line 276 and at least 1 expected

Answered: [Answered] Polymorphic relations

Thu, 07 Nov 2019 08:10:55 +0000

Glad you ask!

Polymorphic relations are supported in the latest beta and we still looking for testers!

https://support.skipper18.com/402/downloads-skipper-beta

Please try it and let me know.

Polymorphic relations are created like classic relations and in the wizard, you will choose "polymorphic"

[Answered] Add custom Base Model class

Mon, 04 Nov 2019 19:08:45 +0000

Is it possible to make a Base Model class for each Module?

So in BaseModel get:

use App\MyModule\MyModuleModel;

abstract class generated_class extends MyModuleModel

The reason is that I want possibility to override $connection for a complete module, so it fetches data from a second database.

/Frode

Answered: [Solved] Start Laravel project - Import from migrations

Wed, 23 Oct 2019 05:39:50 +0000

Hi,

currently, you can import your pre-created database via Import project.

But it's definitely a good idea to ship default Laravel models directly with the new Laravel project. I will add it to the todo list.

Answered: Configuration Files stored with Module

Mon, 06 May 2019 13:07:14 +0000

Hi Garry,

currently, configuration files are allowed only:

per Skipper application directory
per user settings directory
per project directory.

Module configuration files aren't currently available. It's an interesting idea but I'm not sure if such a feature will not bring some conflicts.

Imagine a situation when two modules have two opposite rules. How to solve it? There is no ordering between modules. So such configuration will be completely random.

The current behavior is explained here: https://help.skipper18.com/expert-usage/customization/configuration-files/

I will discuss it with my colleagues if we're able to implement also per-module support and let you know.

Answered: How do I add a uuid_binary as a field type?

Wed, 10 Apr 2019 19:31:19 +0000

Hi,

check following document page:

https://help.skipper18.com/expert-usage/customization/configuration-files/

and

https://help.skipper18.com/expert-usage/customization/configuration-file-structure/

You have to create a standalone configuration file (located in your project or in user-settings path) to keep these changes between updates. In case you update Skipper configuration files directly, these files will be automatically rewritten after every update.

Answered: [Answered] Association not exported, instead i get list of indexes

Thu, 31 Jan 2019 09:28:26 +0000

It seems like your MySQL Workbench file doesn't have correctly defined associations and because of that Skipper don't know how to import it.

Would be possible to share your MWB file so we can test it here? If so, please send it to ludek.vodicka@skipper18.com

Thanks.

PS: In case you're using Doctrine2, it should be better to import Doctrine2 schema files directly to Skipper instead of importing MWB.

And in case you don't have schema files from your database yet, Doctrine2 offer owns DB importer.

Answered: [Answered] How can I set default NULL for a string field in XML?

Tue, 08 Jan 2019 08:52:36 +0000

Hi Rob,

Is there any reason why you need to enter "NULL" to options? As you mentioned, if you leave "default" without value and do not check NN (not-null), Skipper and Doctrine correctly generates result SQL query.

Option- default serves only for special cases where you need to enter string default value to SQL command.

It's redundant to enter "NULL" to defaults, because NULL is already default value.

Answered: [Answered] Why are many-to-many Entities not created via export?

Tue, 13 Nov 2018 15:24:22 +0000

Hi,

it's because Doctrine2 doesn't support Many-to-many entities ;-).

Doctrine2 creates mn relations against two entities automatically without ability MN entity. Please check Doctrine2 documentation where you will find more information.

Answered: [Answered] installing Skipper on Debian stretch

Mon, 02 Apr 2018 06:10:23 +0000

Hi, there is no need to install anything. Just unpack downloaded zip and execute Skipper executable.

Answered: Write extension

Fri, 29 Dec 2017 08:30:24 +0000

Hi, as I wrote, you can check existing Gedmo extension (implemented in Skipper/config) directory as same as checking our documentation

https://help.skipper18.com/expert-usage/customization/configuration-files/
https://help.skipper18.com/expert-usage/customization/new-framework-support/
etc..

Answered: add use and custom annotation

Thu, 28 Dec 2017 17:35:22 +0000

By default, skipper can export only @ORM annotations. It's possible to write the extension which exports also other annotations (for example already implemented @Gedmo) but it's not such easy.

You can check gedmo configuration files to see how is it implemented.

Answered: [Answered] is It posible to generate the class in Entity and the yml in config?

Tue, 01 Aug 2017 11:58:07 +0000

In case you're exporting to YML there is no way how to export also to Php. It's redundant.

In case you need to generate Php classes from Yml, you can use Doctrine generate tools.

Regarding Yml spacing, there is no such option.

Answered: Is it possible to run / test dql queries

Thu, 04 May 2017 11:02:38 +0000

Unfortunately, there is no DQL query builder or test inside the Skipper.

Skipper serves for modelling ORM schema files (objects, fields, associations, etc.)

Answered: Extended php parsers to support class constants -- Howto??

Mon, 10 Apr 2017 17:13:24 +0000

There is no documentation for this feature.

This is only Php parser improvement to support existing constants in the class. Before that Skipper crashed or corrupted existing document.

Answered: [Answered] Is where a way to import from existing postgres database connection

Mon, 27 Mar 2017 05:41:28 +0000

Unfortunately, Skipper doesn't contain any logic to import data from the database (because it's ORM tool, not DB one).

The best way how to achieve this is to let your ORM to import it from DB (for example Doctrine2 has built-in tools for that) and then import schema files from Doctrine importer to Skipper.

Answered: [Solved] How to use Gedmo when starting a new project ?

Mon, 06 Mar 2017 14:39:43 +0000

There is no special settings for that. Just start modelling Doctrine2 and add Gedmo to your entities

Answered: [Solved] Printer configuration

Fri, 17 Feb 2017 16:50:25 +0000

Hi,
unfortunately universal printing framework offered by Qt is pretty limited and there are no such options.

The best way how you can do it is to export schema to PDF and than use print it from PDF.

PDF is exported like vector so there is no issues with zooming.

config generation but with relationships replaced by regular fields

Fri, 17 Feb 2017 12:08:32 +0000

Hi, using Doctrine2 less and less. I am now getting to a point were I want to use Doctrine only for migrations and without any enforced relations. Let me explain.

I'm moving towards a CQRS event sourced system and am replacing 'Enityties' with DDD concepts. Projections and Queries are now simple tables wit hardly any relationships.

Skipper is still great; I noticed I can create a relation and simply remove the 'entity alias'. This would enable me to use skipper to design an overal bounded context that shows some relationships but have doctrine generate almost no real relationships.

Unfortunately removing the alias does not add the required field.

The following block is removed when the 'store' alias is removed from the relationship.

<many-to-one field="store" target-entity="HF\Model\Entity\Commerce\Store">
  <join-columns>
    <join-column name="store_id" referenced-column-name="store_id" nullable="false"/>
  </join-columns>
</many-to-one>

Offcource I still need the store_id column to be present, but the skipper does not generate the following.

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
  <entity name="HF\Model\Entity\Commerce\ArticleGroup" table="read_commerce_articlegroup">
    <id name="articleGroupId" type="string" length="36" column="articlegroup_id"/>
    <field name="ledgerNumber" type="string" length="5" nullable="false" column="ledger_number"/>
    <field name="code" type="string" length="30" nullable="false"/>
    <field name="store_id" type="string" length="36" nullable="false"/>
    <field name="description" type="string" length="250" nullable="true" column="description"/>
  </entity>
</doctrine-mapping>

Now my question: Does or could Skipper support this? Visually available relationships, but generated xml without them

ps. I am aware this is probably an edge case + I hope I made myself clear

Bas

Answered: [Solved] name of files for entities

Mon, 06 Feb 2017 14:30:05 +0000

Hi, check "filename-format" attribute for module where you have your entity located

[Solved] How do I represent an abstract class in Skipper?

Mon, 05 Sep 2016 10:08:11 +0000

Hi.

I've been using Skipper for years now, but always with concrete classes.

We've inherited a project which has used annotations and we're very keen to migrate this to a Skipper model.

We have an abstract class AbstractInvite which has (let's say) and id and a name

We then have two super-classes
class ParticipantInvite extends AbstractInvite
class PublicInvite extends AbstractInvite

I can't for the life of me work out how to represent AbstractInvite in Skipper so that the two super-classes will inherit from it.

When I create AbstractInvite in Skipper it creates the class as a concrete class rather than an abstract class...

I'm sure this is my stupidity, but how should this be drawn in Skipper?

Thanks
Dave

Answered: [Creation Error] The annotation .... a property named "unsigned"

Mon, 01 Aug 2016 17:23:35 +0000

Hi, thanks for your post. You asked a several questions so but the most important one, the first one, without necessary details.

What exactly are you trying to achieve? Are you able to manually edit exported schema (annotations) to get it work what you need? And if so, can you please post schema exported via Skipper and working schema updated manually?

Because based on the error it seems that you're trying to export "unsigned" property which isn't supported via Doctrine. And because of that updating Skipper files doesn't help. But maybe I'm wrong and you are trying to achieve something else.

So please update your post (or send it here through comments) exact schema file (php file with annotations) what is expected Skipper output and what is current output.

Regarding your question about Symfony3, check beta thread here on support site where is Symfony3 available (and will be released soon as stable version).

Answered: [Answered] Can skipper work with MySQL POINT data? Specifically for doctrine?

Tue, 01 Dec 2015 15:30:11 +0000

Hi,

it's possible to extend Skipper to work with any datatype you need (as same as you can add/edit any ORM property).

Go to following help page: https://help.skipper18.com/expert-usage/customization/configuration-file-structure and find "Data types definitons" section.

You can edit existing Doctrine2 configuration files (doctrine2.skipper.cfg.xml) or you can create your own file for each project or for all your project (check following page with more info https://help.skipper18.com/expert-usage/customization/configuration-files)

To add "point" type simply add following line to datatype definitions:

<data-types>
  <data-type name="point"/>
</data-types>

and you will be able to use this datatype in skipper.

Answered: [Answered] Correct way to import FOSUserBundle ORM to my project?

Thu, 30 Jul 2015 20:05:43 +0000

Hi,

yes, this is one of the possible ways.

It depends if you already have your project of if you're starting a new one.

In case you're starting a new one, simply attach all plugins/bundles to your project directory and select Create or Import new -> Import ORM schema files and select root path of your project:

/home/me/app/

after that all schema files will be imported and you can start with customizating/ extending of your project.

In case you already have project, use "Import to project" -> Import ORM schema files and attach new module to your existing project.

For more info about modules, you can check following article: https://help.skipper18.com/how-to-use/application-concepts/shared-modules

Answered: [Closed] How to edit the location of an Entity in properties

Sat, 18 Apr 2015 10:38:55 +0000

Based on your additional comment, what you're looking for is "namespace".

When you enter namespace for your module, all entities will be referred together with namaspace "Trade\Entity\"

You need to fill "namespace" property for the module:

Answered: Doctrine MongoDB ODM alpha support

Wed, 28 Jan 2015 14:35:47 +0000

I would like to let you know that support for MongoDB is ready. More information about MongoDB ODM support is available here.

Answered: Is possible to export model as (My)SQL?

Thu, 11 Dec 2014 19:18:41 +0000

Hi,

Skipper doesn't support export back to MySQL/MySQL Workbench because it's a redundant function to what ORM frameworks do.

Simply export your model to ORM definition file and let your ORM framework to generate SQL scripts for you.

Ludek

[How To]Skipper Support for Doctrine Extensions

Tue, 05 Aug 2014 12:38:52 +0000

Starting with version 3.2.5.1264 Skipper fully supports Gedmo extensions.

Currently support is in beta stage.

More info http://support.skipper18.com/2290/gedmo-extensions-beta-support

Answered: [Tip] Creating an association with single table inherited entity

Wed, 30 Jul 2014 08:48:01 +0000

To create association with an inherited entity (without its own primary key) you need to set up ‘virtual ID’.

Create an ID inside the inherited entity and use it as an inverse field. This ‘virtual ID’ will be only used in a visual model, it will not be exported to the definitions, but it will be properly replaced by the inherited ID.

Answered: [Hint] Can't connect to license server throught proxy on Linux

Wed, 30 Jul 2014 08:05:47 +0000

New version uses different license server communication, please let us know if you encounter similar difficulties.

Answered: [Tip]How to set up a namespace for bundle

Wed, 23 Jul 2014 10:44:41 +0000

This is solved by defining Namespace as ORM properties in the Property editor for the bundle in question:

Once the bundle has its namespace defined, all entities and associations will be exported with the proper namespaces.

Answered: [Tip]How to use External Tools to generate Doctrine Getters and Setters

Wed, 16 Jul 2014 10:51:14 +0000

I experienced "No Metadata classes to process" when using this example on a Symfony2 export, due to the namespaced @ORM/ annotations.

Install Doctrine2, recommend using composer
Create an entry in 'External Tools':

• Title:
Generate Getters and Setters
• Command:
/tmp/doctrine/vendor/bin/doctrine
• Arguments:
orm:generate-entities --update-entities=true --generate-methods=true [path for new entities]
• Initial Directory:
/tmp/doctrine
Create a Doctrine config file, cli-config.php in /tmp/doctrine

Answered: how can I add "use Symfony\Component\Validator\Constraints as Assert;" in generated files?

Wed, 09 Jul 2014 12:22:22 +0000

Skipper imports, exports and visualizes the ORM definitions, this means that Skipper deals with model elements and their ORM properties. @Assert and Symfony classes are not in the ORM scope and Skipper does not import them.

If you use XML or YML format, these are not part of the definitions.

If you use annotations where @Assert and all Symfony classes and properties are kept together, Skipper will properly separate them. This means that only @ORM annotations will be imported, and only @ORM will be changed upon export, but you will need to add and modify @Assert and other Symfony properties manually.

We may add support for another classes and annotations in the future, but it is not on our short term plan.

[How to] Create uni-directional many-to-many relationship with skipper?

Wed, 09 Jul 2014 11:38:24 +0000

Similarly to common assocation, directions on many to many assoc are handled by aliases.

As you can see in following examples, based on these aliases you can control how your association should looks like. It's because Doctrine2 handles associations based on the aliases.

In all next examples I will use following model:

In case you fill only alias to inverse entity, you will get unidirectional (one-way) association heading from first to second entity. As export, you will get:

 @ORM\ManyToMany(targetEntity="First")
 @ORM\JoinTable(
     name="mn",
     joinColumns={@ORM\JoinColumn(name="second_id", referencedColumnName="id", nullable=false)},
     inverseJoinColumns={@ORM\JoinColumn(name="first_id", referencedColumnName="id", nullable=false)}
 )

In case you fill only alias to owner entity, you will get incorrect unidirectional (one-way) association heading from second to first. I'm writing incorrect, because this isn't correct Doctrine2 configuration and based on the ERD modelling it's not possible to create such association without helper table. In this situation you will get:

 @ORM\ManyToMany(targetEntity="Second", mappedBy=)

In case you fill both aliases, you get bidirectional association (two-way) between first and second entity. In this case, Skipper exports annotations to both entities:

 SecondEntity:
  @ORM\ManyToMany(targetEntity="First", inversedBy="second")
  @ORM\JoinTable(
     name="mn",
     joinColumns={@ORM\JoinColumn(name="second_id", referencedColumnName="id", nullable=false)},
     inverseJoinColumns={@ORM\JoinColumn(name="first_id", referencedColumnName="id", nullable=false)}
  )
  private $first; 

 FirstEntity:
 @ORM\ManyToMany(targetEntity="Second", mappedBy="first")
 private $second;

Hope these examples will help you understand the concept of creating many to many association on our application.

Answered: [How to] Create uni-directional relationships with skipper?

Wed, 09 Jul 2014 11:23:52 +0000

Hi Fiya,

as Martin wrote in his answer, uni-directional assocation (@OneToMany or @ManyToOne) is configured through aliases.

As you can see in following examples, based on these aliases you can control how your association should looks like. It's because Doctrine2 handles associations based on the aliases.

In all next examples I will use following model:

In case you fill only owner alias, you will get unidirectional (one-way) association heading from child to parent. This is what you probably need. As export, you will get:

 @ORM\ManyToOne(targetEntity="First")
 @ORM\JoinColumn(name="first_id", referencedColumnName="id")

In case you fill only inverse alias, you will get incorrect unidirectional (one-way) association heading from parent to child. I'm writing incorrect, because this isn't correct Doctrine2 configuration and based on the ERD modelling it's not possible to create such association without helper table. In this situation you will get:

 @ORM\OneToMany(targetEntity="Second")

In case you fill both aliases, you get bidirectional association (two-way) between child and parent. In this case, Skipper exports annotations to both entities:

 SecondEntity:
 @ORM\ManyToOne(targetEntity="First")
 @ORM\JoinColumn(name="first_id", referencedColumnName="id")

 FirstEntity:
 @ORM\OneToMany(targetEntity="Second")

Hope these examples will help you understand the concept of creating association on our application.

Answered: [HowTo] Integrating MySQL Workbench with ORM Designer

Tue, 29 Apr 2014 09:56:32 +0000

Usually, to create and modify database only ORM
Designer and built-in Doctrine 2 functions are sufficient (and you can
stop using Workbench or at least use it separately).

The ORM point of view does not "care about the DB", it just assumes some DB is used and focuses on entities and their relations. Though DB can be configured by Doctrine2 (to a degree using the ORM properties), it might not be enough for everybody.

The problem is the MWB does not handle the abstraction layer at all, so it is not possible to integrate it to a single continuous workflow (DB to MWB to ORM Designer and vice versa). You can import the MWB schema for the first time so it is easier to start using ORM Designer on your existing projects. After first import, MySQL Workbench and ORM Designer have to be kept separate.

The import from MWB is best used as a single time measure, to convert
your standing changes to ORM Designer project and then you convert
your definition files do database (and back) using the Doctine 2
schema-tool and convert-mapping commands. Because MySQL Workbench
does not support ORM properties, you could lose lot of your work on
each import from the database, if you used MWB in each import of the
changes of the database.

So the recommended workflow would be:

A) First time import of the project you already have in MySQL Workbench:
1)Import the MWB file to ORM Designer
2)Edit the model and export the definition files using ORM Designer
3)Project the definition files to databasue using Doctrine commands

B)Any subsequent modifications of the database:
1)Generate definition files from the DB using Doctrine
2)Import the definitions files to ORM Designer project, all attributes
will properly merge
4)Edit the project and export changes
2)Update the database using Doctrine commands

So you can keep administering the DB with MySQL anytime you need to
make direct changes using MySQL Workbench, you can generate new
definition files using Doctrine and import these to ORM Designer.

This is also the only way how to keep separate names for your entities
in your model (UserAddresses) and database (user_addresses), because
these are handled by ORM properties, and as I mentioned before MySQL
Workbench does not support these. On the other hand this can be
handled by ORM Designer quite easily, just define your entity as shown
on the screenshot:
http://i.imgur.com/NzhuDbz.png

Also renaming of the entities might be getting a little easier by
using templates (by using the on-update template you can automatically
generate the table name from the entity name):
http://help.orm-designer.com/en/extending-templates

The template similar to one you need is in our template library under
the example number 3:
http://help.orm-designer.com/en/template-library

Answered: [Tip] How to configure namespace for Doctrine2 project

Mon, 17 Mar 2014 09:56:27 +0000

Nota bene: For the Inheritance to work correctly with annotations export format, you need to prefix the namespace with a backslash. Otherwise the generated class definition will read

namespace Acme\DemoBundle\Entity;
class Child extends Acme\DemoBundle\Entity\Parent
{

This will cause the Parent class to be invalid (FQCN \Acme\DemoBundle\Entity\Acme\DemoBundle\Entity\Parent). With an extra backslash in the front, the namespace definition is left intact while the extends statement is corrected.

Answered: [Tip] How to configure export format and path for ORM schema files

Sat, 08 Mar 2014 22:27:04 +0000

Hey Ludek,
I believe this needs to be improved as If person is working on a big project where entities are divided into bundles and with seperated folders. In my case all the relations and namespaces are changed and they are all created in a single location.

Each entity should be exported in the same location where they have been imported in my opinion.

[Tip] How to transfer schema files from PHP to XML or YML

Thu, 19 Dec 2013 16:18:53 +0000

If you need to transfer your schema files do different format you can do this pretty automatically. It is the same when importing PHP annotations and exporting to XML or YML and it is the same for other way around (XML/YML to PHP annotations).

To transfer the project from XML to PHP annotations just do the following

1) Import your project to ORM Designer.

2) Open the module editor on the Files and Export tab, and set data format to Doctrine2 Annotations.

3)Check if you are exporting the annotations to proper folders – ORM Designer will automatically merge the PHP annotations with the PHP file already present in the location.

4)Check if all of your entities have the extension in the attribute export-file-name set properly*. If not you can edit the value directly in the schema.module.xml.

*This attribute is used to preserve the original file structure of your project when you first import it to the ORM Designer. It will have the original filename and the .xml extension. You just need to change it to .php.

5) Export the schema files.

To transfer the schema files to XML or YML just switch the settings and file names.

[Tip] Porting model from one ORM framework to another

Mon, 16 Dec 2013 15:27:15 +0000

Hello Everybody,

If you have project developed in Doctrine, Doctrine2, Propel or CakePHP, and need to transfer it to different framework ORM Designer can help you, but it cannot do it completely automatically. Let me explain how to do this and why:

It is not a problem for ORM Designer to export to one framework the schema definitions imported from another. The output format of the data is handled easily. Problem is with the ORM properties. Each ORM framework uses different set of functions which is covered by various properties. And even the similar function can have different names. These sets can even differ across various versions. The conversion matrix that would properly deal with all the different properties and their syntax across the frameworks is impossible to create.

This means you can transfer your model, all your entities and relations together with the core attributes (names, ids, fields etc.) to different framework, and then you will need to check all entities and fix the ORM properties. Please proceed as follows:

Import your project in the ORM designer
Save the project
Locate the project file (*.ormdesigner2)
Remove all ORM specific properties (defined by ) from the project file
Change the definition of the ORM framework in the project file header. Keywords for the frameworks are propel, doctrine, doctrine2 and cakePHP. For example:
Change this

to
Open the edited project in the ORM Designer
Check all your entities. All ORM properties of the new ORM framework will be automatically generated but will have no values set. If you used some of these properties, you will have to define them manually again.

Note: There is a dirty variant of this method. You can skip removing the ORM specific properties. Then the properties that use same name in both frameworks will be merged. However the properties that have different names, will not be merged and will be unrecognized or may even cause some error. In this case you will have to look for the incompatible properties selectively and remove them.

[Tip] How to set up signed / unsigned property to an association field

Tue, 12 Nov 2013 12:03:29 +0000

When an association is created new field is automatically inserted in owner entity. Basic field properties (type, size and required flag) are automatically copied from inverse side entity primary key. However ORM properties that are specific to each framework are not copied and need to be set up. You can do it manually for every new association or set up a template that will be automatically used for all new associations and entities.

Templates

If you want to ensure that all new entities will have primary keys set as unsigned and all new associations will have the association field set as unsigned add the following templates to the ORM Designer configuration files:

<!-- primary key -->

<template element='field' use-case='create' selector='primary-field'>
    <field 
     name="id" 
     type="integer" 
     required="true" 
     unique="true" 
     primary="true" 
     auto-increment="true">
        <orm-attributes>
            <attribute name="unsigned">true</attribute>
        </orm-attributes>
    </field>    
</template>

<template element='entity' use-case='create'>
    <entity>
        <field 
         name="id" 
         type="integer" 
         size="4" 
         required="true" 
         unique="true" 
         primary="true" 
         auto-increment="true">
            <orm-attributes>
                <attribute name="unsigned">true</attribute>
            </orm-attributes>
        </field>        
    </entity>
</template>

<!-- foreign key -->

<template element='field' use-case='create' selector='association-field'>
    <field name="{entity-inverse#UL}_{field-inverse#UL}">
        <orm-attributes>
            <attribute name="unsigned">true</attribute>
        </orm-attributes> 
    </field>
</template>

<template element='field' use-case='create' selector='many-to-many-field'>
    <field 
     name="{entity-inverse#UL}_{field-inverse#UL}" 
     required="true" 
     primary="true">
        <orm-attributes>
            <attribute name="unsigned">true</attribute>
        </orm-attributes>
    </field>
</template>

Configuration files

It is best to store modified cfg files in the user configuration folder, because the changes made to the application configuration files are removed when you reinstall/update ORM Designer.

You can check our documentation to see which configuration file to use, where are they located and their loading order and how to add the templates to the configuration.

[Tip] How to configure exported file names for Doctrine2

Thu, 18 Jul 2013 12:43:06 +0000

Question received by email.

For Symfony2 and Doctrine2 it's necessary to change exported file names from .dcm.yml to .orm.yml. We know about this limitation and we will implement automatical file name resolver in one of following versions.

For now, it's necessary to change file-suffix manually for each module or each entity. The recommended way is to change file name format for whole module:

Simply select your module and in ORM property editor choose ".orm" for file-suffix property.

You can also configure file name for each entity manually by editing export-file-name property in entity ORM property editor:

Hope this tips will help you enjoy ORM Designer. If you have any question about this topic, feel free to discus it bellow!