WidgetEvent.php 838 B

12345678910111213141516171819202122232425262728293031
  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. * WidgetEvent represents the event parameter used for a widget event.
  10. *
  11. * By setting the [[isValid]] property, one may control whether to continue running the widget.
  12. *
  13. * @author Petra Barus <petra.barus@gmail.com>
  14. * @since 2.0.11
  15. */
  16. class WidgetEvent extends Event
  17. {
  18. /**
  19. * @var mixed the widget result. Event handlers may modify this property to change the widget result.
  20. */
  21. public $result;
  22. /**
  23. * @var bool whether to continue running the widget. Event handlers of
  24. * [[Widget::EVENT_BEFORE_RUN]] may set this property to decide whether
  25. * to continue running the current widget.
  26. */
  27. public $isValid = true;
  28. }