[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Event/Result/ -> ResultAware.php (summary)

Joomla! Content Management System

Copyright: (C) 2022 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 102 lines (4 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 2 functions

  addResult()
  setResult()

Functions
Functions that are not part of a class:

addResult($data)   X-Ref
Appends data to the result array of the event.

param: mixed  $data  What to add to the result array.
return: void

setResult(array $value)   X-Ref
Handle setting the result argument directly.

This method serves a dual purpose: backwards compatibility and enforcing the use of addResult.

When $this->preventSetArgumentResult is false it acts as a backwards compatibility shim for
event handlers expecting generic event classes instead of the concrete Events implemented in
this package. This allows the migration to concrete event classes throughout the lifetime of
Joomla 4.x.

When $this->preventSetArgumentResult is false (which will always be the case on Joomla 5.0)
it will throw a BadMethodCallException if the developer tries to call setArgument('result', ...)
instead of going through the addResult() method.

param: array  $value  The new result array.
return: array



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer