Propel to darmowa biblioteka ORM umożliwiająca generowanie kodu PHP zapewniającego interfejs dostępu do relacyjnej bazy danych. Przy opisywaniu struktury modelu danych Propel posługuje się specjalnym plikiem schema.xml. Na podstawie definicji z tego pliku Propel generuje klasy PHP reprezentujące poszczególne wiersze z tabeli bazy danych.
Model bazy danych stworzony w Vertabelo można przekonwertować na format XML właściwy dla Propela. Służy do tego skrypt PHP o nazwie VertabeloPropel. Generuje on na potrzeby Propela plik schema.xml ze źródłowego pliku XML pobranego z aplikacji Vertabelo. Skrypt jest dostępny w serwisie GitHub.
Instalacja skryptu
Do zarządzania zależnościami VertabeloPropel używa narzędzia Composer.
W katalogu głównym twojego projektu stwórz plik composer.json zawierający poniższy kod:
Kod
{
"require": {
"vertabelo/vertabelo-propel": "*"
}
}
"require": {
"vertabelo/vertabelo-propel": "*"
}
}
Następnie uruchom polecenie:
Kod
composer install
Ta operacja spowoduje pobranie skryptu VertabeloPropel do katalogu vendor do katalogu głównego twojego projektu. Skrypt zostanie umieszczony w pliku vendor/bin/vertabelo-propel.php, a w Windows – w pliku vendor\bin\vertabelo-propel.php.bat
Użycie skryptu VertabeloPropel
1. Stwórz model bazy danych w Vertabelo.
2. Pobierz ten model w postaci pliku XML – użyj do tego ikonki "Export model as XML file" znajdującej się na pasku narzędzi w Vertabelo. Zapisz plik XML w katalogu głównym twojego projektu.
3. Wygeneruj plik schema.xml na potrzeby Propela. Jeśli chcesz użyć do tego ustawień domyślnych (plik źródłowy: model.xml, plik wynikowy: schema.xml, nazwa bazy danych: test, default id method: native), uruchom
w Windows:
Kod
vendor\bin\vertabelo-propel.php.bat
a w Mac OS lub pod Linuksem:
Kod
vendor/bin/vertabelo-propel.php
Jeśli chcesz użyć innych ustawień niż domyślne, uruchom
w Windows:
Kod
vendor\bin\vertabelo-propel.php.bat -i model.xml -o schema.xml/
--database-name bookshop ---default-id-method native
--database-name bookshop ---default-id-method native
a w Mac OS lub pod Linuksem:
Kod
vendor/bin/vertabelo-propel.php -i model.xml -o schema.xml --database-name bookshop --default-id-method native
4. Skrypt wygeneruje plik schema.xml właściwy dla Propela.
5. Kontynuuj swoją pracę z Propelem przy tworzeniu aplikacji (lub przeczytaj artykuł "How to develop a PHP+MySQL application with Propel and Vertabelo").
Opcje skryptu
Opcje skryptu są następujące:
- --input-file (skrót -i) – ścieżka do pliku źródłowego XML z Vertabelo (wartość domyślna: "model.xml")
- --output-file (skrót -o) – ścieżka do pliku wynikowego XML dla Propela (wartość domyślna: "schema.xml")
- --database-name – nazwa bazy danych (wartość domyślna: "test")
- --default-id-method – domyślna metoda identyfikacji (defaultIdMethod). Dopuszczalne wartości to: "native" lub "none", wartość domyślna to "native".
- --help - wyświetla komunikat pomocy
---------------
Powyższa instrukcja została opracowana na podstawie dokumentacji Vertabelo (w języku angielskim).