40 lines
1.1KB

  1. <?php
  2. /**
  3. * @link http://www.yiiframework.com/
  4. * @copyright Copyright (c) 2008 Yii Software LLC
  5. * @license http://www.yiiframework.com/license/
  6. */
  7. namespace yii\base;
  8. /**
  9. * ViewEvent represents events triggered by the [[View]] component.
  10. *
  11. * @author Qiang Xue <qiang.xue@gmail.com>
  12. * @since 2.0
  13. */
  14. class ViewEvent extends Event
  15. {
  16. /**
  17. * @var string the view file being rendered.
  18. */
  19. public $viewFile;
  20. /**
  21. * @var array the parameter array passed to the [[View::render()]] method.
  22. */
  23. public $params;
  24. /**
  25. * @var string the rendering result of [[View::renderFile()]].
  26. * Event handlers may modify this property and the modified output will be
  27. * returned by [[View::renderFile()]]. This property is only used
  28. * by [[View::EVENT_AFTER_RENDER]] event.
  29. */
  30. public $output;
  31. /**
  32. * @var boolean whether to continue rendering the view file. Event handlers of
  33. * [[View::EVENT_BEFORE_RENDER]] may set this property to decide whether
  34. * to continue rendering the current view file.
  35. */
  36. public $isValid = true;
  37. }