ExpressionInterface.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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;
  16. /**
  17. * An interface used by Expression objects.
  18. */
  19. interface ExpressionInterface
  20. {
  21. /**
  22. * Converts the Node into a SQL string fragment.
  23. *
  24. * @param \Cake\Database\ValueBinder $generator Placeholder generator object
  25. * @return string
  26. */
  27. public function sql(ValueBinder $generator);
  28. /**
  29. * Iterates over each part of the expression recursively for every
  30. * level of the expressions tree and executes the $visitor callable
  31. * passing as first parameter the instance of the expression currently
  32. * being iterated.
  33. *
  34. * @param callable $visitor The callable to apply to all nodes.
  35. * @return void
  36. */
  37. public function traverse(callable $visitor);
  38. }