View file vendor/cakephp/database/Expression/FieldInterface.php

File size: 1.12Kb
<?php
/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Database\Expression;

/**
 * Describes a getter and a setter for the a field property. Useful for expressions
 * that contain an identifier to compare against.
 */
interface FieldInterface
{

    /**
     * Sets the field name
     *
     * @param string|\Cake\Database\ExpressionInterface $field The field to compare with.
     * @return void
     */
    public function setField($field);

    /**
     * Returns the field name
     *
     * @return string|\Cake\Database\ExpressionInterface
     */
    public function getField();
}