Skip to content

Commit 9c1d6e0

Browse files
committed
Properly nest DecisionEvent methods under class
1 parent b2d9511 commit 9c1d6e0

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/components/campaigns.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -815,43 +815,43 @@ The Campaign Engine then dispatches the Decision Event's ``eventName`` where lis
815815
816816
.. php:class:: Mautic\CampaignBundle\Events\DecisionEvent
817817
818-
.. php:method:: public checkContext(string $eventType)
818+
.. php:method:: public checkContext(string $eventType)
819819
820-
Checks if the given Event type matches the Event executed or evaluated. This is useful if listeners for different Campaign Events are listening to the same name defined as ``eventName`` in the Event's definition.
820+
Checks if the given Event type matches the Event executed or evaluated. This is useful if listeners for different Campaign Events are listening to the same name defined as ``eventName`` in the Event's definition.
821821

822-
:return: ``TRUE`` if the context matches.
823-
:returntype: bool
822+
:return: ``TRUE`` if the context matches.
823+
:returntype: bool
824824

825-
.. php:method:: public getEventConfig()
825+
.. php:method:: public getEventConfig()
826826
827-
Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event.
827+
Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event.
828828

829-
:return: Object to fetch the configuration options for the Campaign Event.
830-
:returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor
829+
:return: Object to fetch the configuration options for the Campaign Event.
830+
:returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor
831831

832-
.. php:method:: public getLog()
832+
.. php:method:: public getLog()
833833
834-
:return: The ``LeadEventLog`` object for the Condition.
835-
:returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog
834+
:return: The ``LeadEventLog`` object for the Condition.
835+
:returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog
836836

837-
.. php:method:: public getPassthrough()
837+
.. php:method:: public getPassthrough()
838838
839-
Access context data set by ``RealTimeExecutioner::execute()``.
839+
Access context data set by ``RealTimeExecutioner::execute()``.
840840

841-
:return: Returns whatever was set as the second argument to ``RealTimeExecutioner::execute()``.
842-
:returntype: mixed
841+
:return: Returns whatever was set as the second argument to ``RealTimeExecutioner::execute()``.
842+
:returntype: mixed
843843

844-
.. php:method:: public setAsApplicable()
844+
.. php:method:: public setAsApplicable()
845845
846-
Call this if the Decision is applicable to the action taken by the Contact which instructs the Campaign Engine to execute or schedule Events connected into this Decision's "action" (left) path.
846+
Call this if the Decision is applicable to the action taken by the Contact which instructs the Campaign Engine to execute or schedule Events connected into this Decision's "action" (left) path.
847847

848-
:returntype: void
848+
:returntype: void
849849

850-
.. php:method:: public setChannel(string $channel[, $channelId = null)
850+
.. php:method:: public setChannel(string $channel[, $channelId = null)
851851
852-
Set the Channel to attribute to the Event.
852+
Set the Channel to attribute to the Event.
853853

854-
:param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth.
855-
:param mixed $channelId: ID of the Channel entity.
854+
:param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth.
855+
:param mixed $channelId: ID of the Channel entity.
856856

857-
:returntype: void
857+
:returntype: void

0 commit comments

Comments
 (0)