1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
<?php
declare(strict_types=1);
namespace Doctrine\ORM\Mapping;
/**
* A set of rules for determining the physical column and table names
*
* @link www.doctrine-project.org
*/
interface NamingStrategy
{
/**
* Returns a table name for an entity class.
*
* @param class-string $className
*
* @return string A table name.
*/
public function classToTableName($className);
/**
* Returns a column name for a property.
*
* @param string $propertyName A property name.
* @param class-string $className The fully-qualified class name.
*
* @return string A column name.
*/
public function propertyToColumnName($propertyName, $className = null);
/**
* Returns a column name for an embedded property.
*
* @param string $propertyName
* @param string $embeddedColumnName
* @param class-string $className
* @param class-string $embeddedClassName
*
* @return string
*/
public function embeddedFieldToColumnName(
$propertyName,
$embeddedColumnName,
$className = null,
$embeddedClassName = null
);
/**
* Returns the default reference column name.
*
* @return string A column name.
*/
public function referenceColumnName();
/**
* Returns a join column name for a property.
*
* @param string $propertyName A property name.
*
* @return string A join column name.
*/
public function joinColumnName($propertyName/*, string $className */);
/**
* Returns a join table name.
*
* @param class-string $sourceEntity The source entity.
* @param class-string $targetEntity The target entity.
* @param string $propertyName A property name.
*
* @return string A join table name.
*/
public function joinTableName($sourceEntity, $targetEntity, $propertyName = null);
/**
* Returns the foreign key column name for the given parameters.
*
* @param class-string $entityName An entity.
* @param string|null $referencedColumnName A property name or null in
* case of a self-referencing
* entity with join columns
* defined in the mapping
*
* @return string A join column name.
*/
public function joinKeyColumnName($entityName, $referencedColumnName = null);
}
|