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:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 

<?php

/**
 * This file is part of the Lean Mapper library (http://www.leanmapper.com)
 *
 * Copyright (c) 2013 Vojtěch Kohout (aka Tharos)
 *
 * For the full copyright and license information, please view the file
 * license-mit.txt that was distributed with this source code.
 */

namespace LeanMapper;

/**
 * Mapper interface
 *
 * @author Vojtěch Kohout
 */
interface IMapper
{

    /**
     * Gets primary key name from given table name
     *
     * @param string $table
     * @return string
     */
    public function getPrimaryKey($table);

    /**
     * Gets table name from given fully qualified entity class name
     *
     * @param string $entityClass
     * @return string
     */
    public function getTable($entityClass);

    /**
     * Gets fully qualified entity class name from given table name
     *
     * @param string $table
     * @param Row|null $row
     * @return string
     */
    public function getEntityClass($table, Row $row = null);

    /**
     * Gets table column name from given fully qualified entity class name and entity field name
     *
     * @param string $entityClass
     * @param string $field
     * @return string
     */
    public function getColumn($entityClass, $field);

    /**
     * Gets entity field (property) name from given table name and table column
     *
     * @param string $table
     * @param string $column
     * @return string
     */
    public function getEntityField($table, $column);

    /**
     * Gets relationship table name from given source table name and target table name
     *
     * @param string $sourceTable
     * @param string $targetTable
     * @return string
     */
    public function getRelationshipTable($sourceTable, $targetTable);

    /**
     * Gets name of column that contains foreign key from given source table name and target table name
     *
     * @param string $sourceTable
     * @param string $targetTable
     * @return string
     */
    public function getRelationshipColumn($sourceTable, $targetTable);

    /**
     * Gets table name from repository class name
     *
     * @param string $repositoryClass
     * @return string
     */
    public function getTableByRepositoryClass($repositoryClass);

    /**
     * Gets filters that should be used used every time when given entity is loaded from database
     *
     * @param string $entityClass
     * @param Caller|null $caller
     * @return array|ImplicitFilters
     */
    public function getImplicitFilters($entityClass, Caller $caller = null);

}