Propel 2.0

https://propelorm.org/documentation
Admin
Propel 2.0 is an evolution of the Propel ORM, adhering to PSR standards and offering architectural...
Tokens:135,372
Snippets:1,362
Trust Score:9.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Initialize Propel Project

Source: https://propelorm.org/documentation/02-buildtime.html

Use the `propel init` command to guide through the setup process, including database credentials, schema import, and configuration file format selection. This command simplifies the initial configuration.

```bash
$ propel init

```

--------------------------------

### Setup SQLite Test Database

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Execute the setup script for SQLite. This will delete the existing test.sq3 file.

```bash
./tests/bin/setup.sqlite.sh

```

--------------------------------

### Install Composer Dependencies

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Install Composer and download all necessary project dependencies.

```bash
$ composer install

```

--------------------------------

### JSON Configuration Example

Source: https://propelorm.org/documentation/10-configuration.html

This is an example of a propel.json configuration file, defining database connections and runtime settings.

```json
{
    "propel": {
        "database": {
            "connections": {
                "mysource": {
                    "adapter": "mysql",
                    "classname": "Propel\\Runtime\\Connection\\DebugPDO",
                    "dsn": "mysql:host=localhost;dbname=mydb",
                    "user": "root",
                    "password": "",
                    "attributes": []
                },
                "yoursource": {
                    "adapter": "mysql",
                    "classname": "Propel\\Runtime\\Connection\\DebugPDO",
                    "dsn": "mysql:host=localhost;dbname=yourdb",
                    "user": "root",
                    "password": "",
                    "attributes": []
                },
            }
        },
        "runtime": {
            "defaultConnection": "mysource",
            "connections": ["mysource", "yoursource"]
        },
        "generator": {
            "defaultConnection": "yoursource",
            "connections": ["yoursource"]
        }
    }
}

```

--------------------------------

### Setup PostgreSQL Test Database

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Execute the setup script for PostgreSQL to drop and recreate test databases and build Propel connection and model classes.

```bash
./tests/bin/setup.pgsql.sh

```

--------------------------------

### Create Database Schema (MySQL Example)

Source: https://propelorm.org/documentation/02-buildtime.html

Before inserting the schema, create the database using your RDBMS's command-line tools. This example uses `mysqladmin` for MySQL.

```bash
$ mysqladmin -u root -p create bookstore

```

--------------------------------

### Setup MySQL Test Database

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Execute the setup script for MySQL to drop and recreate test databases and build Propel connection and model classes.

```bash
./tests/bin/setup.mysql.sh

```

--------------------------------

### PHP Configuration Example

Source: https://propelorm.org/documentation/10-configuration.html

An example of a PHP configuration file for Propel, defining database connections and runtime/generator settings.

```php
<?php

return [
    'propel' => [
        'database' => [
            'connections' => [
                'mysource' => [
                    'adapter'    => 'mysql',
                    'classname'  => 'Propel\Runtime\Connection\DebugPDO',
                    'dsn'        => 'mysql:host=localhost;dbname=mydb',
                    'user'       => 'root',
                    'password'   => '',
                    'attributes' => []
                ],
                'yoursource' => [
                    'adapter'    => 'mysql',
                    'classname'  => 'Propel\Runtime\Connection\DebugPDO',
                    'dsn'        => 'mysql:host=localhost;dbname=yourdb',
                    'user'       => 'root',
                    'password'   => '',
                    'attributes' => []
                ]
            ]
        ],
        'runtime' => [
            'defaultConnection' => 'mysource',
            'connections' => ['mysource', 'yoursource']
        ],
        'generator' => [
            'defaultConnection' => 'yoursource',
            'connections' => ['yoursource']
        ]
    ]
];


```

--------------------------------

### XML Configuration Example

Source: https://propelorm.org/documentation/10-configuration.html

An example of a Propel configuration file written in XML format, mirroring the structure of the INI and YAML examples.

```xml
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<config>
    <propel>
        <database>
            <connections>
                <connection id="mysource">
                    <adapter>mysql</adapter>
                    <classname>Propel\Runtime\Connection\DebugPDO</classname>
                    <dsn>mysql:host=localhost;dbname=mydb</dsn>
                    <user>root</user>
                    <password>''</password>
                    <attributes></attributes>
                </connection>
                <connection id="yoursource">
                    <adapter>mysql</adapter>
                    <classname>Propel\Runtime\Connection\DebugPDO</classname>
                    <dsn>mysql:host=localhost;dbname=yourdb</dsn>
                    <user>root</user>
                    <password>''</password>
                    <attributes></attributes>
                </connection>
            </connections>
        </database>
        <runtime>
            <defaultConnection>mysource</defaultConnection>
            <connection>mysource</connection>
            <connection>yoursource</connection>
        </runtime>
        <generator>
            <defaultConnection>yoursource</defaultConnection>
            <connection>yoursource</connection>
        </generator>
    </propel>
</config>


```

--------------------------------

### Install Project Dependencies with Composer

Source: https://propelorm.org/documentation/01-installation.html

After setting up `composer.json`, run this command to install all project dependencies, including Propel.

```bash
$ php composer.phar install

```

--------------------------------

### Customized PostgreSQL Test Database Setup

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Configure and run the PostgreSQL test database setup script using environment variables for hostname, user, and password.

```bash
DB_HOSTNAME=192.168.0.3 DB_USER=postgres DB_PW=secret ./tests/bin/setup.pgsql.sh

```

--------------------------------

### Composer Project Setup

Source: https://propelorm.org/documentation/01-installation.html

Use this `composer.json` to install Propel as a project dependency via Composer.

```json
{
    "require": {
        "propel/propel": "~2.0@beta"
    }
}

```

--------------------------------

### Customized MySQL Test Database Setup

Source: https://propelorm.org/documentation/cookbook/working-with-test-suite.html

Configure and run the MySQL test database setup script using environment variables for hostname, user, and password.

```bash
DB_HOSTNAME=192.168.0.3 DB_USER=nonroot DB_PW=topsecret ./tests/bin/setup.mysql.sh

```

--------------------------------

### YAML Configuration Example

Source: https://propelorm.org/documentation/10-configuration.html

An example of a Propel configuration file written in YAML format, defining database, runtime, and generator settings.

```yaml
# An example of Propel configuration file in yaml

propel:
  database:
      connections:
          mysource:
              adapter: mysql
              classname: Propel\Runtime\Connection\DebugPDO
              dsn: mysql:host=localhost;dbname=mydb
              user: root
              password:
              attributes:
          yoursource:
              adapter: mysql
              classname: Propel\Runtime\Connection\DebugPDO
              dsn: mysql:host=localhost;dbname=yourdb
              user: root
              password:
              attributes:
  runtime:
      defaultConnection: mysource
      connections:
          - mysource
          - yoursource
  generator:
      defaultConnection: yoursource
      connections:
          - yoursource


```

--------------------------------

### YAML Configuration with Parameters

Source: https://propelorm.org/documentation/10-configuration.html

Example of using parameters in a Propel configuration file. Parameters are placeholders that get replaced with defined values.

```yaml
propel:
  general:
    project: MyProject

  paths:
    projectDir: /home/%project%


```

--------------------------------

### Test Propel Installation

Source: https://propelorm.org/documentation/01-installation.html

Verify that the Propel installation is successful by running the `propel` script from your project's root directory.

```bash
$ cd myproject
$ vendor/bin/propel

```

--------------------------------

### Using Versionable Behavior

Source: https://propelorm.org/documentation/behaviors/versionable.html

Example of how to use the versionable behavior after setting it up in the schema. It demonstrates saving an object and accessing its version information.

```php
<?php
$b = new Book();
$b->setTitle('War And Peace');
$b->save();
echo $b->getMyVersionColumn(); // 1
// For convenience and ease of use, Propel creates a getVersion() anyway
echo $b->getVersion(); // 1

```

--------------------------------

### Install Behavior via Composer

Source: https://propelorm.org/documentation/06-behaviors.html

Add the desired behavior to your composer.json file to install it. Propel will then recognize the behavior by its name.

```json
{
    "require": "formidable\FormidableBehavior"
}
```

--------------------------------

### Example Schema Definition

Source: https://propelorm.org/documentation/reference/active-record.html

An example XML schema defining a 'book' table with columns for id, title, isbn, and author_id.

```xml
<table name="book" description="Book Table">
  <column name="id" required="true" primaryKey="true" autoIncrement="true" type="INTEGER" />
  <column name="title" type="VARCHAR" required="true" />
  <column name="isbn" required="true" type="VARCHAR" size="24" phpName="ISBN" />
  <column name="author_id" required="false" type="INTEGER" />
</table>
```

--------------------------------

### INI Configuration: Mixed Syntax Example

Source: https://propelorm.org/documentation/10-configuration.html

A sample propel.ini file demonstrating a mix of classical and nested syntax for database, runtime, and generator configurations.

```ini
[propel]

; Database section
;
; Define 'mysource' connection
database.connections.mysource.adapter    = mysql
database.connections.mysource.classname  = Propel\Runtime\Connection\DebugPDO
database.connections.mysource.dsn        = mysql:host=localhost;dbname=mydb
database.connections.mysource.user       = root
database.connections.mysource.password   =
database.connections.mysource.attributes =
;
; Define 'yoursource' connection
database.connections.yoursource.adapter    = mysql
database.connections.yoursource.classname  = Propel\Runtime\Connection\DebugPDO
database.connections.yoursource.dsn        = mysql:host=localhost;dbname=yourdb
database.connections.yoursource.user       = root
database.connections.yoursource.password   =
database.connections.yoursource.attributes =

;
; Runtime section
;
runtime.defaultConnection = mysource
;
;Available runtime connections
runtime.connections[0]    = mysource
runtime.connections[1]    = yoursource

;
; Generator section
;
generator.defaultConnection = yoursource
generator.connections[0] = yoursource


```

--------------------------------

### YAML Fixture Example

Source: https://propelorm.org/documentation/cookbook/symfony2/working-with-symfony2.html

Illustrates how to define fixtures using YAML format, including basic objects, related objects, and N-N relationships.

```yaml
Awesome\Object:
     o1:
         Title: My title
         MyFoo: bar

Awesome\Related:
     r1:
         ObjectId: o1
         Description: Hello world !

Awesome\Tag:
    t1:
        name: Foo
    t2:
        name: Baz

Awesome\Post:
    p1:
        title: A Post with tags (N-N relation)
        tags: [ t1, t2 ]

```

--------------------------------

### INI Configuration: Array Conversion Example

Source: https://propelorm.org/documentation/10-configuration.html

Shows the resulting PHP array structure after parsing a deeply nested INI configuration.

```php
<?php

[
    'section_1' => [
        'sub_section_1' => [
            'sub_sub_section' => [
                'foo' => 'bar'
            ]
        ],
        'sub_section_2' => [
            'sub_sub_section' => [
                'bar' => 'baz'
            ]
        ]
    ]
]


```

--------------------------------

### Accessing Configuration Property with get() and Potential E_NOTICE

Source: https://propelorm.org/documentation/10-configuration.html

Illustrates accessing a configuration property using the get() method. This method can raise an E_NOTICE if the specified property does not exist, unlike getConfigProperty().

```php
<?php

function getUcaseGeneralValue($name)
{
    $manager = new Propel\Common\Config\ConfigurationManager();

    // I don't know if a property $name exists, but I use get() method all the same
    return strtoupper($manager->get()['general'][$name]);
}

//Exists! Return '2.0.0-DEV'
echo getUcaseGeneralValue('version');

//Doesn't exist:
//raises an E_NOTICE 'Notice: Undefined index Barbapapa in .... line ....
//echo getUcaseGeneralValue('Barbapapa');


```

--------------------------------

### PDO Sybase DSN Examples

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Sample Data Source Names (DSNs) for the pdo_sybase driver, showing different host and port configurations.

```text
<dsn>sybase:host=localhost\SQLEXPRESS;dbname=propel</dsn>
<dsn>sybase:host=localhost\SQLEXPRESS:1433;dbname=propel</dsn>
<dsn>sybase:host=localhost:1433;dbname=propel</dsn>

```

--------------------------------

### Initialization Queries Configuration

Source: https://propelorm.org/documentation/reference/configuration-file.html

Defines an array of SQL statements to be executed each time the database connection is initialized. Useful for environment setup.

```yaml
#Array of queries to run when the database connection is initialized
queries: {empty}|array
```

--------------------------------

### Fetching a Book and its Author (Inefficient)

Source: https://propelorm.org/documentation/04-relationships.html

This example demonstrates fetching a book and then its author, which results in two separate database queries. Use `with()` or `joinWith()` to optimize this.

```php
<?php
$book = BookQuery::create()
  ->useAuthorQuery()
    ->filterByFirstName('Leo')
  ->endUse()
  ->findOne();
$author = $book->getAuthor();  // Needs another database query

```

--------------------------------

### Install Propel via Git

Source: https://propelorm.org/documentation/01-installation.html

Clone the Propel repository directly into your project's vendor directory using Git.

```bash
$ git clone git://github.com/propelorm/Propel2 vendor/propel

```

--------------------------------

### PDO MSSQL DSN Examples

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Sample Data Source Names (DSNs) for the pdo_mssql driver, showing different host, port, and database name configurations.

```text
<dsn>mssql:host=localhost\SQLEXPRESS;dbname=propel</dsn>
<dsn>mssql:host=localhost\SQLEXPRESS,1433;dbname=propel</dsn>
<dsn>mssql:host=localhost,1433;dbname=propel</dsn>

```

--------------------------------

### PHP Environment Variable Example

Source: https://propelorm.org/documentation/10-configuration.html

This snippet shows how environment variables can be set in PHP, which can then be referenced in Propel configuration.

```php
<?php

$_ENV['host']   = '192.168.0.54'; //Database host name
$_ENV['dbName'] = 'myDB'; //Database name


```

--------------------------------

### XML Fixture Example

Source: https://propelorm.org/documentation/cookbook/symfony2/working-with-symfony2.html

Defines a basic structure for XML fixtures, including object and related object definitions with attributes.

```xml
<Fixtures>
    <Object Namespace="Awesome">
        <o1 Title="My title" MyFoo="bar" />
    </Object>
    <Related Namespace="Awesome">
        <r1 ObjectId="o1" Description="Hello world !" />
    </Related>
</Fixtures>

```

--------------------------------

### Propel Migration Table Example

Source: https://propelorm.org/documentation/09-migrations.html

This SQL output shows the structure of the `propel_migration` table, which stores the version of the latest executed migration.

```sql
mysql> select * from propel_migration;
+------------+
| version    |
+------------+--
| 1286483354 |
+------------+
1 row in set (0.00 sec)


```

--------------------------------

### Generated Directory Tree for Packaged Build

Source: https://propelorm.org/documentation/cookbook/multi-component-data-model.html

The expected directory structure within 'generated-classes' after running a packaged bookstore example build.

```text
  addon/ 
    club/ 
      BookClubList.php
      BookListRel.php
  core/ 
    author/ 
      Author.php
    book/ 
      Book.php
    media/ 
      Media.php
    publisher/ 
      Publisher.php
    review/ 
      Review.php
  util/ 
    log/ 
      BookstoreLog.php
```

--------------------------------

### Add Logger to Service Container

Source: https://propelorm.org/documentation/02-buildtime.html

Add this code to your setup script to enable Propel to log warnings and errors. Ensure Monolog is installed and configured.

```php
<?php

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$defaultLogger = new Logger('defaultLogger');
$defaultLogger->pushHandler(new StreamHandler('/var/log/propel.log', Logger::WARNING));

$serviceContainer->setLogger('defaultLogger', $defaultLogger);

```

--------------------------------

### Retrieve a TableMap for a specific table

Source: https://propelorm.org/documentation/cookbook/runtime-introspection.html

Get the TableMap object for a given table using its static getTableMap() method. This is the starting point for runtime introspection.

```php
<?php
$bookTable = BookTableMap::getTableMap();

```

--------------------------------

### Execute Custom SQL with Read Connection

Source: https://propelorm.org/documentation/cookbook/replication.html

Explicitly gets a read connection to execute custom SQL queries, ensuring Propel's replication setup is respected.

```php
<?php
$con = Propel::getReadConnection(MyTableMap::DATABASE_NAME);
$stmt = $con->query('SELECT * FROM my');
/* ... */


```

--------------------------------

### Left Join with `with()` (One-to-Many)

Source: https://propelorm.org/documentation/04-relationships.html

This example shows how to perform a left join with `with()` for one-to-many relationships. It highlights that `limit()` should not be used in such queries to ensure correct hydration.

```php
<?php
// this works
$authors = AuthorQuery::create()
  ->leftJoinWith('Author.Book')
  ->find();
// this does not work
$authors = AuthorQuery::create()
  ->leftJoinWith('Author.Book')
  ->limit(5)
  ->find();

```

--------------------------------

### Creating and Saving Model Objects

Source: https://propelorm.org/documentation/08-inheritance.html

Demonstrates creating new instances of Category, Article, and Video models and saving them to the database. Shows how to set properties and associate objects.

```php
<?php
// create a new Category
$cat = new Category();
$cat->setName('Movie');
$cat->save();
// create a new Article
$art = new Article();
$art->setTitle('Avatar Makes Best Opening Weekend in the History');
$art->setCategory($cat);
$art->setBody('With $232.2 million worldwide total, Avatar had one of the best-opening weekends in the history of cinema.');
$art->save();
// create a new Video
$vid = new Video();
$vid->setTitle('Avatar Trailer');
$vid->setCategory($cat);
$vid->setResourceLink('http://www.avatarmovie.com/index.html');
$vid->save();

```

--------------------------------

### Build Propel Model and Configuration Files

Source: https://propelorm.org/documentation/cookbook/silex/working-with-silex.html

Use the vendor/bin/propel script to generate SQL, configuration, and model classes based on your schema.xml and runtime-conf.xml.

```bash
vendor/bin/propel model:build
vendor/bin/propel config:convert-xml
vendor/bin/propel sql:build

```

--------------------------------

### INI Configuration: Classical and Nested Syntax

Source: https://propelorm.org/documentation/10-configuration.html

Demonstrates the classical and nested syntax for defining sections and key-value pairs in an INI configuration file.

```ini
; Classical way
[first_section]
foo = bar
bar = baz

;Nested way
first_section.foo = bar
first_section.bar = baz

```

--------------------------------

### Fetching a Book and its Author (Efficient with `joinWith()`)

Source: https://propelorm.org/documentation/04-relationships.html

This example uses `joinWith()` to fetch a book and its author in a single query. This method is a more concise alternative to using `useXXXQuery()`, `endUse()`, and `with()` when you only need to hydrate a related object.

```php
<?php
$book = BookQuery::create()
  ->joinWith('Book.Author')
  ->findOne();
$author = $book->getAuthor();  // Same result, with no supplementary query

```

--------------------------------

### Get Count of Related Objects

Source: https://propelorm.org/documentation/04-relationships.html

Efficiently get the number of related objects without hydrating them. Prefer this over count($collection) for performance.

```php
<?php
// Propel also generates a countBooks() method
$author->countBooks();


```

--------------------------------

### Propel Initialization (New Method)

Source: https://propelorm.org/documentation/whats-new.html

The recommended method for initializing Propel by including the configuration file.

```php
<?php

include $configFilePath;


```

--------------------------------

### Stub Model Class Example

Source: https://propelorm.org/documentation/02-buildtime.html

Example of a generated stub model class (e.g., Book) that extends a base class. This is where custom model code should be added.

```php
<?php

/**
 * Skeleton subclass for representing a row from the 'book' table.
 */
class Book extends BaseBook
{

}
```

--------------------------------

### Data Migration with Raw SQL

Source: https://propelorm.org/documentation/09-migrations.html

An example of a Propel migration class demonstrating data migration using raw SQL within the `postUp()` method. It shows how to insert data into the `author` table.

```php
<?php
class PropelMigration_1286483354
{
	// do nothing before structure change
	public function preUp($manager)
	{
	}

	// structure change (generated by Propel)
	public function getUpSQL()
	{
		return array('bookstore' => '
ALTER TABLE `book` ADD
(
	`author_id` INTEGER
);
//... 
');
	}

	public function postUp($manager)
	{
		// post-migration code
		$sql = "INSERT INTO author (first_name,last_name) values('Leo','Tolstoi')";
		$pdo = $manager->getAdapterConnection('bookstore');
		$stmt = $pdo->prepare($sql);
		$stmt->execute();
	}
}


```

--------------------------------

### Versionable Behavior Usage

Source: https://propelorm.org/documentation/behaviors/versionable.html

Demonstrates how to use the versionable behavior after setup. Includes saving new versions, reverting to previous versions, and comparing versions. Deleting an object also removes its versions.

```php
<?php
$book = new Book();

// automatic version increment
$book->setTitle('War and Peas');
$book->save();
echo $book->getVersion(); // 1
$book->setTitle('War and Peace');
$book->save();
echo $book->getVersion(); // 2

// reverting to a previous version
$book->toVersion(1);
echo $book->getTitle(); // 'War and Peas'
// saving a previous version creates a new one
$book->save();
echo $book->getVersion(); // 3

// checking differences between versions
print_r($book->compareVersions(1, 2));
// array(
//   'Title' => array(1 => 'War and Peas', 2 => 'War and Pace'),
// );

// deleting an object also deletes all its versions
$book->delete();

```

--------------------------------

### Get Specific Configuration Section

Source: https://propelorm.org/documentation/10-configuration.html

Retrieves all properties within a specified first-level configuration section (e.g., 'runtime', 'generator'). This is a shortcut for accessing a section via the get() method.

```php
<?php

$manager = new Propel\Common\Config\ConfigurationManager();

$migrationProperties = $manager->getSection('migration');

//getSection is simply a shortcut, so I can write also:
$migrationProperties = $manager->get()['migration'];

```

--------------------------------

### PHP Example: Using Delegate Behavior with Multiple Tables

Source: https://propelorm.org/documentation/behaviors/delegate.html

Demonstrates how to use the delegate behavior to set properties on an 'Account' object, which are then delegated to its 'profile' and 'preference' related objects. It shows filling data for both delegates and saving the account.

```php
<?php
$account = new Account();
$account->setLogin('francois');
$account->setPassword('S€cr3t');

// Fill the profile via delegation
$account->setEmail('francois@example.com');
$account->setTelephone('202-555-9355');
// Fill the preference via delegation
$account->setPreferredColor('orange');
$account->setMaxSize('200');

// save the account and its profile and its preference
$account->save();

```

--------------------------------

### Install Propel and PropelBundle with Composer

Source: https://propelorm.org/documentation/cookbook/symfony4/working-with-symfony4.html

Use Composer to add Propel ORM and the PropelBundle to your Symfony4 project. This command installs the beta version of Propel 2.x and the dev version of PropelBundle 4.x.

```bash
composer require propel/propel: ~2.0@beta
composer require propel/propel-bundle: ~4.0@dev

```

--------------------------------

### Navigate to Project Directory

Source: https://propelorm.org/documentation/cookbook/working-with-existing-databases.html

Before running database reverse engineering commands, navigate to your project's root directory.

```bash
cd legacyapp
```

--------------------------------

### Set and Get Array Column Values

Source: https://propelorm.org/documentation/cookbook/working-with-advanced-column-types.html

Demonstrates setting and getting values for an 'array' column type. Propel automatically serializes and unserializes PHP arrays for storage. Also shows generated helper methods like hasXXX(), addXXX(), and removeXXX() for singular items.

```php
<?php
// The 'book' table has a 'tags' column of type array
$book = new Book();
$book->setTags(array('novel', 'russian'));
print_r($book->getTags()); // array('novel', 'russian')

// If the column name is plural, Propel also generates hasXXX(), addXXX(),
// and removeXXX() methods, where XXX is the singular column name
echo $book->hasTag('novel'); // true
$book->addTag('romantic');
print_r($book->getTags()); // array('novel', 'russian', 'romantic')
$book->removeTag('russian');
print_r($book->getTags()); // array('novel', 'romantic')


```

--------------------------------

### Custom Constraint: PropelDomain.php

Source: https://propelorm.org/documentation/behaviors/validate.html

Example of a custom Symfony constraint class for validating domain names.

```php
<?php
// /myConstraints/Propel/Runtime/Validator/Constraints/PropelDomain.php

namespace Propel\Runtime\Validator\Constraints;

use Symfony\Component\Validator\Constraint;


class PropelDomain extends Constraint
{
    public $message = 'This url does not belong to propelorm.org domain';
    public $column = '';
}
```

--------------------------------

### Criteria::addOr Refactor Example

Source: https://propelorm.org/documentation/whats-new.html

Demonstrates the refactored behavior of Criteria::addOr, which now operates only on
existing conditions.

```php
<?php

$criteria->add('column1', 'value');
$criteria->add('column2', 'value');
$criteria->addOr('column1', 'value'); // this used to be OR`ed to the first add (matched by name)


```

--------------------------------

### Custom Constraint Validator: PropelDomainValidator.php

Source: https://propelorm.org/documentation/behaviors/validate.html

Example of a custom Symfony constraint validator class for the PropelDomain constraint.

```php
<?php
 // /myConstraints/Propel/Runtime/Validator/Constraints/PropelDomainValidator.php

 namespace Propel\Runtime\Validator\Constraints;

 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;

 class PropelDomainValidator extends ConstraintValidator
 {
     public function isValid($value, Constraint $constraint)
     {
         if ('propelorm.org' === strstr($value, 'propelorm.org')) {
             return false;
         } else {
             $this->setMessage($constraint->message);

             return true;
         }
     }
 }
```

--------------------------------

### Basic Versionable Behavior Setup

Source: https://propelorm.org/documentation/behaviors/versionable.html

Add the versionable behavior to a table in schema.xml to enable basic versioning. This creates a 'version' column and a separate table to store historical data.

```xml
<table name="book">
  <column name="id" required="true" primaryKey="true" autoIncrement="true" type="integer" />
  <column name="title" type="varchar" required="true" />
  <behavior name="versionable" />
</table>
```

--------------------------------

### Install PropelBundle with Composer

Source: https://propelorm.org/documentation/cookbook/symfony2/working-with-symfony2.html

Add Propel and PropelBundle to your Symfony2 project's dependencies using Composer.

```yaml
"require": {
    "propel/propel": "2.0.*@dev",
    "propel/propel-bundle": "~2.0@dev"
}

```

--------------------------------

### Retrieve All Relations of a Table

Source: https://propelorm.org/documentation/cookbook/runtime-introspection.html

Get an array of all RelationMap objects associated with a table. RelationMap objects are lazy-loaded.

```php
<?php
// Example usage, actual retrieval is done via TableMap::getRelations()
// $allRelations = $bookTable->getRelations();

```

--------------------------------

### Sample DSNs for pdo_dblib

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Examples of Data Source Names (DSNs) for connecting to MSSQL Server using the pdo_dblib driver. These vary based on host, instance name, and port.

```text
<dsn>dblib:host=localhost\SQLEXPRESS;dbname=propel</dsn>
<dsn>dblib:host=localhost\SQLEXPRESS:1433;dbname=propel</dsn>
<dsn>dblib:host=localhost:1433;dbname=propel</dsn>

```

--------------------------------

### Get parent TableMap from ColumnMap

Source: https://propelorm.org/documentation/cookbook/runtime-introspection.html

Access the parent TableMap object of a ColumnMap to navigate back up the hierarchy.

```php
<?php
$bookTable = $bookTitleColumn->getTable();

```

--------------------------------

### Namespaced Model Class Usage

Source: https://propelorm.org/documentation/whats-new.html

Example of how to use a namespaced model class after rebuilding the model with namespace support.

```php
<?php

use My\Model\Namespace\ModelClass;

$class = new ModelClass();


```

--------------------------------

### Propel Runtime Setup Script

Source: https://propelorm.org/documentation/02-buildtime.html

This script sets up Propel by including the autoloader and the generated configuration file. It's recommended to include this script at the beginning of your PHP files.

```php
<?php

// setup the autoloading
require_once '/path/to/vendor/autoload.php';

// setup Propel
require_once '/generated-conf/config.php';

```

--------------------------------

### Configure Stream Loggers in PHP Array

Source: https://propelorm.org/documentation/07-logging.html

Set up 'defaultLogger' and 'bookstore' stream loggers with paths and levels using a PHP array configuration.

```php
<?php

return [
    'propel' => [
        'runtime' => [
            'log' => [
                'defaultLogger' => [
                    'type' => 'stream',
                    'path' => '/var/log/propel.log',
                    'level' => 300
                ],
                'bookstore' => [
                    'type' => 'stream',
                    'path' => '/var/log/propel_bookstore.log',
                ]
            ]
        ]
    ]
];
```

--------------------------------

### Generated updateRelatedTotalNbVotes() Method

Source: https://propelorm.org/documentation/cookbook/writing-behavior.html

This is an example of the updateRelatedTotalNbVotes() method, which is generated by the AggregateColumnBehavior::objectMethods() to update related aggregate columns.

```php
<?php
/**
 * Updates an aggregate column in the foreign poll_question table
 *
 * @param PropelPDO $con A connection object
 */
protected function updateRelatedTotalNbVotes(PropelPDO $con)
{
  if ($parentPollQuestion = $this->getPollQuestion()) {
    $parentPollQuestion->updateTotalNbVotes($con);
  }
}


```

--------------------------------

### Task Creation with Scoped Sortable Behavior

Source: https://propelorm.org/documentation/behaviors/sortable.html

Demonstrates creating tasks with different users and groups, showing how rank is reset for each unique scope. Requires pre-defined User and Group objects.

```php
<?php
// test groups
$adminGroup = new Group();
$userGroup = new Group();
// test users
$paul = new User();
$john = new User();

// now onto the tasks
$t1 = new Task();
$t1->setTitle('Create permissions');
$t1->setUser($paul);
$t1->setGroup($adminGroup);
$t1->save();
echo $t1->getRank(); // 1

$t2 = new Task();
$t2->setTitle('Grant permissions to users');
$t2->setUser($paul);
$t2->setGroup($adminGroup);
$t2->save();
echo $t2->getRank(); // 2

$t3 = new Task();
$t3->setTitle('Install servers');
$t3->setUser($john);
$t3->setGroup($adminGroup);
$t3->save()
echo $t3->getRank(); // 1, because John has his own task list inside the admin-group

$t4 = new Task();
$t4->setTitle('Manage content');
$t4->setUser($john);
$t4->setGroup($userGroup);
$t4->save()
echo $t4->getRank(); // 1, because John has his own task list inside the user-group



```

--------------------------------

### Manually edit composer.json for Propel installation

Source: https://propelorm.org/documentation/cookbook/symfony4/working-with-symfony4.html

Alternatively, you can manually add the Propel and PropelBundle dependencies to your composer.json file.

```json
"require": {
    "propel/propel": "~2.0@beta",
    "propel/propel-bundle": "~4.0@dev"
}

```

--------------------------------

### ARRAY Column Manipulation

Source: https://propelorm.org/documentation/reference/active-record.html

Demonstrates setting, getting, and manipulating simple PHP arrays stored in ARRAY columns.

```php
<?php
// ARRAY columns allow to store simple PHP arrays in the database.
// Nested arrays and associative arrays are not accepted.

// The 'book' table has a 'tags' column of type ARRAY
$book = new Book();
$book->setTags(array('novel', 'russian'));
print_r($book->getTags()); // array('novel', 'russian')
// The setter serializes the PHP array and stores it as a string
// The getter deserializes the string into a PHP array
// All that is transparent to the end user, who just manipulates PHP arrays

// If the column name is plural, Propel also generates hasXXX(), addXXX(),
// and removeXXX() methods, where XXX is the singular column name
echo $book->hasTag('novel'); // true
$book->addTag('romantic');
print_r($book->getTags()); // array('novel', 'russian', 'romantic')
$book->removeTag('russian');
print_r($book->getTags()); // array('novel', 'romantic')


```

--------------------------------

### Create Database Command

Source: https://propelorm.org/documentation/cookbook/symfony2/working-with-symfony2.html

Command to create a database. The `--connection` option allows specifying a particular database connection.

```bash
$ php app/console propel:database:create [--connection[=""]]
```

--------------------------------

### Schema for Delegate Behavior Parameters

Source: https://propelorm.org/documentation/behaviors/delegate.html

Illustrates the 'delegate' behavior configuration within a schema, specifically showing the 'to' parameter which specifies the tables to delegate to. This example delegates to 'profile' and 'preference'.

```xml
<table name="account">
  <column name="id" required="true" primaryKey="true" autoIncrement="true" type="integer" />
  <column name="login" type="varchar" required="true" />
  <column name="password" type="varchar" required="true" />
  <behavior name="delegate">
    <parameter name="to" value="profile, preference" />
  </behavior>
</table>

```

--------------------------------

### Get and Use Default Logger

Source: https://propelorm.org/documentation/07-logging.html

Retrieve the default logger instance from the service container and add an informational message.

```php
<?php
$logger = Propel::getServiceContainer()->getLogger();
$logger->addInfo('This is a message');


```

--------------------------------

### Get Form Data with Propel

Source: https://propelorm.org/documentation/cookbook/symfony2/mastering-symfony2-forms-with-propel.html

Retrieves the data object associated with a Symfony2 form, which is typically a Propel object.

```php
$book = $form->getData();
```

--------------------------------

### Basic Active Record Operations

Source: https://propelorm.org/documentation/reference/active-record.html

Demonstrates creating a new Book object, setting its properties, saving it to the database, and deleting it.

```php
<?php
$book = new Book();
$book->setTitle('War and Peace');
$book->setISBN('067003469X');
$book->save();
// INSERT INTO book (title, isbn) VALUES ('War and Peace', '067003469X')

$book->delete();
// DELETE FROM book WHERE id = 1234;

```

--------------------------------

### Get RelationMap from Foreign Key Column

Source: https://propelorm.org/documentation/cookbook/runtime-introspection.html

Access a RelationMap object directly from a foreign key column map.

```php
<?php
$publisherRelation = $bookTable->getColumn('publisher_id')->getRelation();

```

--------------------------------

### Basic Usage of I18n Behavior in PHP

Source: https://propelorm.org/documentation/behaviors/i18n.html

Demonstrates how to create an object, set translations for different locales, and save them. It also shows how to retrieve localized and non-localized data.

```php
<?php
$item = new Item();
$item->setPrice('12.99');

// add an English translation
$item->setLocale('en_US');
$item->setName('Microwave oven');
// same as
$itemI18n = new ItemI18n();
$itemI18n->setLocale('en_US');
$itemI18n->setName('Microwave oven');
$item->addItemI18n($itemI18n);

// add a French translation
$item->setLocale('fr_FR');
$item->setName('Four micro-ondes');

// save the item and its translations
$item->save();

// retrieve text and non-text translations directly from the main object
echo $item->getPrice(); // 12.99
$item->setLocale('en_US');
echo $item->getName(); // Microwave oven
$item->setLocale('fr_FR');
echo $item->getName(); // Four micro-ondes


```

--------------------------------

### Sample DSNs for pdo_sqlsrv

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Examples of Data Source Names (DSNs) for connecting to MS SQL Server using the pdo_sqlsrv driver. These show different ways to specify the server and port.

```text
<dsn>sqlsrv:server=localhost\SQLEXPRESS;Database=propel</dsn>
```

```text
<dsn>sqlsrv:server=localhost\SQLEXPRESS,1433;Database=propel</dsn>
```

```text
<dsn>sqlsrv:server=localhost,1433;Database=propel</dsn>
```

--------------------------------

### Get RelationMap by Relation Name

Source: https://propelorm.org/documentation/cookbook/runtime-introspection.html

Retrieve a specific RelationMap object by its relation name (phpName of the related table).

```php
<?php
$publisherRelation = $bookTable->getRelation('Publisher');

```

--------------------------------

### Propel Migrate Task Execution for Book Table

Source: https://propelorm.org/documentation/09-migrations.html

Command to execute the generated migration, creating the 'book' table in the database. Shows the output indicating successful execution.

```bash
$ propel migrate

[propel-migration] Executing migration PropelMigration_1286483354 up
[propel-migration] 1 of 1 SQL statements executed successfully on datasource "bookstore"
[propel-migration] Migration complete. No further migration to execute.


```

--------------------------------

### Filter by Object Column

Source: https://propelorm.org/documentation/reference/model-criteria.html

For Object columns, `filterByXXX()` accepts a PHP object. This example filters houses by geographic coordinates.

```php
<?php
$houses = HouseQuery::create()
  ->filterByCoordinates(new GeographicCoordinates(48.8527, 2.3510))
  ->find();
// example Query generated for a MySQL database
$query = 'SELECT house.* from `house`
WHERE house.COORDINATES = :p1'; // :p1 => 'O:21:"GeographicCoordinates":2:{s:8:"latitude";d:48.8527;s:9:"longitude";d:2.3510;}'
```

--------------------------------

### Generated MySQL Table Creation SQL

Source: https://propelorm.org/documentation/reference/schema.html

Example of SQL generated by Propel when MySQL vendor information is provided in the schema.

```sql
CREATE TABLE book
  ()
  ENGINE = InnoDB
  DEFAULT CHARACTER SET utf8;
```

--------------------------------

### Data Migration with ActiveRecord and Query Objects

Source: https://propelorm.org/documentation/09-migrations.html

This example shows how to perform data migration using Propel's ActiveRecord and Query objects within a migration class. It requires bootstrapping the Propel runtime and autoloading.

```php
<?php
// bootstrap the Propel runtime (and other dependencies)
require_once '/path/to/vendor/autoload.php';

set_include_path('/path/to/generated-classes' . PATH_SEPARATOR . get_include_path());
include '/path/to/generated-conf/config.php';

class PropelMigration_1286483354
{

	public function postUp($manager)
	{
		// add the post-migration code here
		$pdo = $manager->getAdapterConnection('bookstore');
		$author = new Author();
		$author->setFirstName('Leo');
		$author->setLastname('Tolstoi');
		$author->save($pdo);
	}

	public function getUpSQL()
	{
		// ...
	}
}


```

--------------------------------

### PHP Replication Configuration

Source: https://propelorm.org/documentation/cookbook/replication.html

Set up master and slave database connections using a PHP array configuration. This example defines a 'bookstore' connection with two slave servers.

```php
<?php

return [
    'propel' => [
        'database' => [
            'connections' => [
                'bookstore' => [
                    'adapter'    => 'mysql',
                    'classname'  => 'Propel\Runtime\Connection\ConnectionWrapper',
                    'dsn'        => 'mysql:host=localhost;dbname=bookstore',
                    'user'       => 'my_db_user',
                    'password'   => 's3cr3t',
                    'slaves' => [
                        ['dsn' => 'mysql:host=slave-server1;dbname=bookstore'],
                        ['dsn' => 'mysql:host=slave-server2;dbname=bookstore']
                    ]
                ]
            ]
        ],
        'runtime' => [
            'defaultConnection' => 'bookstore',
            'connections' => ['bookstore']
        ],
        'generator' => [
            'defaultConnection' => 'bookstore',
            'connections' => ['bookstore']
        ]
    ]
];
```

--------------------------------

### Propel Configuration (propel.xml)

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Example Propel ORM configuration using XML format for MS SQL Server connection.

```xml
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<config>
    <propel>
        <database>
            <connections>
                <connection id="bookstore">
                    <adapter>mssql</adapter>
                    <classname>Propel\Runtime\Connection\ConnectionWrapper</classname>
                    <dsn>sybase:host=localhost:1433;Database=propel</dsn>
                    <user>my_db_user</user>
                    <password>s3cr3t</password>
                </connection>
            </connections>
        </database>
        <runtime>
            <defaultConnection>bookstore</defaultConnection>
            <connection>bookstore</connection>
        </runtime>
        <generator>
            <defaultConnection>bookstore</defaultConnection>
            <connection>bookstore</connection>
        </generator>
    </propel>
</config>

```

--------------------------------

### Propel Configuration (propel.ini)

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Example Propel ORM configuration using INI format for MS SQL Server connection.

```ini
[propel]
; 
; Database section
; 
database.connections.bookstore.adapter    = mssql
database.connections.bookstore.classname  = Propel\Runtime\Connection\ConnectionWrapper
database.connections.bookstore.dsn        = sybase:host=localhost:1433;Database=propel
database.connections.bookstore.user       = my_db_user
database.connections.bookstore.password   = s3cr3t
database.connections.bookstore.attributes = 

; 
; Runtime section
; 
runtime.defaultConnection = bookstore
runtime.connections[0]    = bookstore

; 
; Generator section
; 
generator.defaultConnection = bookstore
generator.connections[0] = bookstore

```

--------------------------------

### Migrating Deletion and Querying from soft_delete to archivable

Source: https://propelorm.org/documentation/behaviors/archivable.html

Illustrates the equivalent code for soft delete, hard delete, finding deleted objects, and recovering deleted objects when switching from the soft_delete behavior to the archivable behavior.

```php
<?php
// do a soft delete
$book->delete(); // with soft_delete
$book->delete(); // with archivable

// do a hard delete
// with soft_delete
$book->forceDelete();
// with archivable
$book->deleteWithoutArchive();

// find deleted objects
// with soft_delete
$books = BookQuery::create()
  ->includeDeleted()
  ->where('Book.DeletedAt IS NOT NULL')
  ->find();
// with archivable
$bookArchives = BookArchiveQuery::create()
  ->find();

// recover a deleted object
// with soft_delete
$book->unDelete();
// with archivable
$book = new Book();
$book->populateFromArchive($bookArchive);
$book->save();

```

--------------------------------

### Propel Configuration (propel.json)

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Example Propel ORM configuration using JSON format for MS SQL Server connection.

```json
{
    "propel": {
        "database": {
            "connections": {
                "bookstore": {
                    "adapter": "mssql",
                    "classname": "Propel\Runtime\Connection\ConnectionWrapper",
                    "dsn": "sybase:host=localhost:1433;Database=propel",
                    "user": "my_db_user",
                    "password": "s3cr3t",
                    "attributes": []
                }
            }
        },
        "runtime": {
            "defaultConnection": "bookstore",
            "connections": ["bookstore"]
        },
        "generator": {
            "defaultConnection": "bookstore",
            "connections": ["bookstore"]
        }
    }
}

```

--------------------------------

### Propel Configuration (propel.yaml)

Source: https://propelorm.org/documentation/cookbook/using-mssql-server.html

Example Propel ORM configuration using YAML format for MS SQL Server connection.

```yaml
propel:
  database:
      connections:
          bookstore:
              adapter: mssql
              classname: Propel\Runtime\Connection\ConnectionWrapper
              dsn: sybase:host=localhost:1433;Database=propel
              user: my_db_user
              password: s3cr3t
              attributes:
  runtime:
      defaultConnection: bookstore
      connections:
          - bookstore
  generator:
      defaultConnection: bookstore
      connections:
          - bookstore

```

--------------------------------

### Download Composer

Source: https://propelorm.org/documentation/01-installation.html

Download the Composer executable if you don't have it already. Use `wget` or `curl`.

```bash
$ wget http://getcomposer.org/composer.phar
# If you haven't wget on your computer
$ curl -s http://getcomposer.org/installer | php

```
Tokens:
Raw