1
0
mirror of synced 2024-12-15 07:36:03 +03:00
doctrine2/lib/Doctrine/ORM/Mapping/NamingStrategy.php

89 lines
2.8 KiB
PHP
Raw Normal View History

2011-12-22 18:07:18 +04:00
<?php
/*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
2012-05-26 16:37:00 +04:00
* and is licensed under the MIT license. For more information, see
2011-12-22 18:07:18 +04:00
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\ORM\Mapping;
2011-12-22 18:07:18 +04:00
/**
* A set of rules for determining the physical column and table names
*
2012-05-26 16:37:00 +04:00
*
2011-12-22 18:07:18 +04:00
* @link www.doctrine-project.org
* @since 2.3
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*/
interface NamingStrategy
{
/**
2012-12-03 13:36:08 +04:00
* Returns a table name for an entity class.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @param string $className The fully-qualified class name.
*
* @return string A table name.
2011-12-22 18:07:18 +04:00
*/
function classToTableName($className);
/**
2012-12-03 13:36:08 +04:00
* Returns a column name for a property.
*
* @param string $propertyName A property name.
* @param string|null $className The fully-qualified class name.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @return string A column name.
2011-12-22 18:07:18 +04:00
*/
function propertyToColumnName($propertyName, $className = null);
2011-12-22 18:07:18 +04:00
/**
2012-12-03 13:36:08 +04:00
* Returns the default reference column name.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @return string A column name.
2011-12-22 18:07:18 +04:00
*/
2011-12-23 17:03:28 +04:00
function referenceColumnName();
2011-12-22 18:07:18 +04:00
2011-12-24 18:34:49 +04:00
/**
2012-12-03 13:36:08 +04:00
* Returns a join column name for a property.
*
* @param string $propertyName A property name.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @return string A join column name.
2011-12-22 18:07:18 +04:00
*/
2011-12-23 17:03:28 +04:00
function joinColumnName($propertyName);
2011-12-22 18:07:18 +04:00
/**
2012-12-03 13:36:08 +04:00
* Returns a join table name.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @param string $sourceEntity The source entity.
* @param string $targetEntity The target entity.
* @param string|null $propertyName A property name.
*
* @return string A join table name.
2011-12-22 18:07:18 +04:00
*/
function joinTableName($sourceEntity, $targetEntity, $propertyName = null);
2011-12-22 18:07:18 +04:00
2011-12-24 18:34:49 +04:00
/**
2012-12-03 13:36:08 +04:00
* Returns the foreign key column name for the given parameters.
*
* @param string $entityName An entity.
* @param string|null $referencedColumnName A property.
2011-12-22 18:07:18 +04:00
*
2012-12-03 13:36:08 +04:00
* @return string A join column name.
2011-12-22 18:07:18 +04:00
*/
function joinKeyColumnName($entityName, $referencedColumnName = null);
2012-05-26 16:37:00 +04:00
}