FieldInterface.php 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 3.0.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Database\Expression;
  16. /**
  17. * Describes a getter and a setter for the a field property. Useful for expressions
  18. * that contain an identifier to compare against.
  19. */
  20. interface FieldInterface
  21. {
  22. /**
  23. * Sets the field name
  24. *
  25. * @param string|\Cake\Database\ExpressionInterface $field The field to compare with.
  26. * @return void
  27. */
  28. public function setField($field);
  29. /**
  30. * Returns the field name
  31. *
  32. * @return string|\Cake\Database\ExpressionInterface
  33. */
  34. public function getField();
  35. }