[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / database / table / column / IAutoIncrementDatabaseTableColumn.class.php

<?php

namespace wcf\system\database\table\column;

/**
 * Every database table column whose values can be auto-incremented must implement this interface.
 *
 * @author  Matthias Schmidt
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package WoltLabSuite\Core\System\Database\Table\Column
 * @since   5.2
 */
interface IAutoIncrementDatabaseTableColumn
{
    /**
     * Sets if the values of the database table column are auto-increment and returns this column.
     *
     * @param bool $autoIncrement
     * @return  $this
     */
    public function autoIncrement($autoIncrement = true);

    /**
     * Returns `true` if the values of the database table column are auto-increment.
     *
     * @return  bool
     */
    public function isAutoIncremented();
}
Commit	Line	Data
f6e43f2f	1	<?php
a9229942	2
f6e43f2f MS	3	namespace wcf\system\database\table\column;
	4
	5	/**
	6	* Every database table column whose values can be auto-incremented must implement this interface.
a9229942 TD	7	*
	8	* @author Matthias Schmidt
	9	* @copyright 2001-2019 WoltLab GmbH
	10	* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
	11	* @package WoltLabSuite\Core\System\Database\Table\Column
	12	* @since 5.2
f6e43f2f	13	*/
a9229942 TD	14	interface IAutoIncrementDatabaseTableColumn
	15	{
	16	/**
	17	* Sets if the values of the database table column are auto-increment and returns this column.
	18	*
	19	* @param bool $autoIncrement
	20	* @return $this
	21	*/
	22	public function autoIncrement($autoIncrement = true);
	23
	24	/**
	25	* Returns `true` if the values of the database table column are auto-increment.
	26	*
	27	* @return bool
	28	*/
	29	public function isAutoIncremented();
f6e43f2f	30	}