[Sommaire] [Imprimer]

   1  <?php
   2  
   3  /*
   4   *  $Id: NameGenerator.php 64 2005-05-13 02:43:56Z root $
   5   *
   6   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   7   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   8   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   9   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  10   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  11   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  12   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  13   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  14   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  15   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  16   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  17   *
  18   * This software consists of voluntary contributions made by many individuals
  19   * and is licensed under the LGPL. For more information please see
  20   * <http://propel.phpdb.org>.
  21   */
  22  
  23  /**
  24   * The generic interface to a name generation algorithm.
  25   *
  26   * @author Hans Lellelid <hans@xmpl.org> (Propel)
  27   * @author Daniel Rall <dlr@finemaltcoding.com> (Torque)
  28   * @author Byron Foster <byron_foster@yahoo.com> (Torque)
  29   * @version $Revision: 64 $
  30   * @package propel.engine.database.model
  31   */
  32  interface NameGenerator {
  33      /**
  34       * The character used by most implementations as the separator
  35       * between name elements.
  36       */
  37      const STD_SEPARATOR_CHAR = '_';
  38  
  39      /**
  40       * Traditional method for converting schema table and column names
  41       * to PHP names.  The <code>CONV_METHOD_XXX</code> constants
  42       * define how names for columns and tables in the database schema
  43       * will be converted to PHP source names.
  44       *
  45       * @see PhpNameGenerator::underscoreMethod()
  46       */
  47      const CONV_METHOD_UNDERSCORE = "underscore";
  48  
  49      /**
  50       * Similar to {@link #CONV_METHOD_UNDERSCORE} except nothing is
  51       * converted to lowercase.
  52       *
  53       * @see PhpNameGenerator::phpnameMethod()
  54       */
  55      const CONV_METHOD_PHPNAME = "phpname";
  56  
  57      /**
  58       * Specifies no modification when converting from a schema column
  59       * or table name to a PHP name.
  60       */
  61      const CONV_METHOD_NOCHANGE = "nochange";
  62  
  63      /**
  64       * Given a list of <code>String</code> objects, implements an
  65       * algorithm which produces a name.
  66       *
  67       * @param inputs Inputs used to generate a name.
  68       * @return The generated name.
  69       * @throws EngineException
  70       */
  71      public function generateName($inputs);
  72  }