Skip to content

Commit 3cab1ae

Browse files
adiati98adiati98
authored
Merge branch '5.x' into fix-links
2 parents 3ac58c7 + 5ce90b5 commit 3cab1ae

File tree

12 files changed

+344
-344
lines changed

12 files changed

+344
-344
lines changed

‎.ddev/web-build/Dockerfile.sphinx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ RUN curl -sSL https://github.com/pypa/pipx/releases/latest/download/pipx.pyz -o
55
RUN chmod +x /usr/local/bin/pipx
66

77
RUN pipx install --global sphinx
8-
RUN pipx install --force --global --include-deps sphinx-rtd-theme
8+
RUN pipx inject --global sphinx sphinxcontrib-phpdomain sphinx-rtd-theme

‎docs/components/campaigns.rst‎

Lines changed: 122 additions & 122 deletions
Large diffs are not rendered by default.

‎docs/components/integrations.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@ The ``HelloWorldIntegration`` needs to implement ``\Mautic\IntegrationsBundle\In
4141

4242
.. php:class:: \Mautic\IntegrationsBundle\Integration\BasicIntegration
4343
44-
.. php:method:: public function getName(): string;
44+
.. php:method:: public function getName(): string;
4545
46-
:return: Return the Integration's name.
47-
:returntype: string
46+
:return: Return the Integration's name.
47+
:returntype: string
4848

49-
.. php:method:: public function getDisplayName(): string;
49+
.. php:method:: public function getDisplayName(): string;
5050
51-
:return: Return the Integration's display name.
52-
:returntype: string
51+
:return: Return the Integration's display name.
52+
:returntype: string
5353

54-
.. php:method:: public function getIcon(): string;
54+
.. php:method:: public function getIcon(): string;
5555
56-
:return: Get the path to the Integration's icon.
57-
:returntype: string
56+
:return: Get the path to the Integration's icon.
57+
:returntype: string
5858

5959

6060

‎docs/components/integrations_authentication.rst‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,15 @@ To use the parameter based API key, create a credentials class that implements `
165165

166166
.. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\ApiKey\Credentials\ParameterCredentialsInterface
167167
168-
.. php:method:: public function getKeyName(): string;
168+
.. php:method:: public function getKeyName(): string;
169169
170-
:return: Key name.
171-
:returntype: string
170+
:return: Key name.
171+
:returntype: string
172172

173-
.. php:method:: public function getApiKey(): ?string;
173+
.. php:method:: public function getApiKey(): ?string;
174174
175-
:return: API key or null.
176-
:returntype: ?string
175+
:return: API key or null.
176+
:returntype: ?string
177177

178178
Find the code snippet as follows,
179179

@@ -221,15 +221,15 @@ To use the header based API key, create a credentials class that implements ``\M
221221

222222
.. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\ApiKey\Credentials\HeaderCredentialsInterface
223223
224-
.. php:method:: public function getKeyName(): string;
224+
.. php:method:: public function getKeyName(): string;
225225
226-
:return: Key name.
227-
:returntype: string
226+
:return: Key name.
227+
:returntype: string
228228

229-
.. php:method:: public function getApiKey(): ?string;
229+
.. php:method:: public function getApiKey(): ?string;
230230
231-
:return: API key or null.
232-
:returntype: ?string
231+
:return: API key or null.
232+
:returntype: ?string
233233

234234
Find the code snippet as follows,
235235

@@ -279,15 +279,15 @@ To use the basic auth, create a credentials class that implements ``\Mautic\Inte
279279

280280
.. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\BasicAuth\CredentialsInterface
281281
282-
.. php:method:: public function getUsername(): ?string;
282+
.. php:method:: public function getUsername(): ?string;
283283
284-
:return: User name.
285-
:returntype: ?string
284+
:return: User name.
285+
:returntype: ?string
286286

287-
.. php:method:: public function getPassword(): ?string;
287+
.. php:method:: public function getPassword(): ?string;
288288
289-
:return: Password.
290-
:returntype: ?string
289+
:return: Password.
290+
:returntype: ?string
291291

292292
Find the code snippet as follows,
293293

‎docs/components/integrations_configuration_form_notes.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,19 @@ Note Object
4141
4242
.. php:class:: \Mautic\IntegrationsBundle\DTO\Note
4343
44-
.. php:attr:: public note;
44+
.. php:attr:: public note;
4545
46-
.. php:attr:: public type;
46+
.. php:attr:: public type;
4747
48-
.. php:method:: public function getNote(): string
48+
.. php:method:: public function getNote(): string
4949
50-
:return: The string to display.
51-
:returntype: string
50+
:return: The string to display.
51+
:returntype: string
5252

53-
.. php:method:: public function getType(): string
53+
.. php:method:: public function getType(): string
5454
55-
:return: The note type, this helps annotate the note.
56-
:returntype: string
55+
:return: The note type, this helps annotate the note.
56+
:returntype: string
5757

5858
The following code snippet shows the use of ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface``.
5959

‎docs/components/points.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,15 @@ Mautic dispatches the Event ``\Mautic\PointBundle\PointEvents::TRIGGER_ON_BUILD`
139139

140140
.. php:class:: Mautic\PointBundle\Event\TriggerBuilderEvent
141141
142-
.. php:method:: public function addEvent(string $key, array $action)
142+
.. php:method:: public function addEvent(string $key, array $action)
143143
144-
:param string $key: Unique key for the Action.
145-
:param array $action: :ref:`Action definition<components/points:Custom Point Trigger definition>`.
144+
:param string $key: Unique key for the Action.
145+
:param array $action: :ref:`Action definition<components/points:Custom Point Trigger definition>`.
146146

147-
.. php:method:: public getEvents()
147+
.. php:method:: public getEvents()
148148
149-
:return: Array of registered Events.
150-
:returntype: array
149+
:return: Array of registered Events.
150+
:returntype: array
151151

152152
.. vale off
153153

‎docs/components/translator.rst‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -63,37 +63,37 @@ In PHP templates, use ``$view['translator']`` to access the Translator service.
6363

6464
.. php:class:: Mautic\CoreBundle\Translation\Translator
6565
66-
.. php:method:: trans(string $id[, array $parameters = [], ?string $domain = null, ?string $locale = null])
66+
.. php:method:: trans(string $id[, array $parameters = [], ?string $domain = null, ?string $locale = null])
6767
68-
Returns the translation for the given key.
68+
Returns the translation for the given key.
6969

70-
:param array $parameters: Parameters as key/value pairs to populate placeholders in the translation. Note that Symfony has deprecated `transChoice()` in favor of using this method plus defining the key ``%count%`` in ``$parameters``. For example, ``echo $translator->trans('helloworld.number_of_moons', ['%count%' => 1, '%world% => 'Earth']);`` with the translation, ``"helloworld.number_of_moons="{0}%world% has no moons|{1}%world% has one moon|]1,Inf[ %world% has %count% moons"``.
71-
:param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``.
72-
:param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale.
70+
:param array $parameters: Parameters as key/value pairs to populate placeholders in the translation. Note that Symfony has deprecated `transChoice()` in favor of using this method plus defining the key ``%count%`` in ``$parameters``. For example, ``echo $translator->trans('helloworld.number_of_moons', ['%count%' => 1, '%world% => 'Earth']);`` with the translation, ``"helloworld.number_of_moons="{0}%world% has no moons|{1}%world% has one moon|]1,Inf[ %world% has %count% moons"``.
71+
:param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``.
72+
:param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale.
7373

74-
:returns: Returns the translated string if the key is found. Otherwise, an empty string.
75-
:returntype: string
74+
:returns: Returns the translated string if the key is found. Otherwise, an empty string.
75+
:returntype: string
7676

77-
.. php:method:: transConditional(string $preferred, string $alternative[, array $parameters = [], ?string $domain = null, ?string $locale = null])
77+
.. php:method:: transConditional(string $preferred, string $alternative[, array $parameters = [], ?string $domain = null, ?string $locale = null])
7878
79-
Translates the preferred key if it exists and the alternate key if it does not.
79+
Translates the preferred key if it exists and the alternate key if it does not.
8080

81-
:param string $preferred: Preferred translation key.
82-
:param string $alternative: Alternate translation key if the preferred does does not exist.
83-
:param array $parameters: Parameters as key/value pairs to populate placeholders in the translation.
84-
:param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``.
85-
:param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale.
81+
:param string $preferred: Preferred translation key.
82+
:param string $alternative: Alternate translation key if the preferred does does not exist.
83+
:param array $parameters: Parameters as key/value pairs to populate placeholders in the translation.
84+
:param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``.
85+
:param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale.
8686

87-
:returns: Returns the translated string if the key is found. Otherwise, an empty string.
88-
:returntype: string
87+
:returns: Returns the translated string if the key is found. Otherwise, an empty string.
88+
:returntype: string
8989

90-
.. php:method:: hasId(string $id[, ?string $domain = null, ?string $local = null])
90+
.. php:method:: hasId(string $id[, ?string $domain = null, ?string $local = null])
9191
92-
Checks to see if a translation key exists.
92+
Checks to see if a translation key exists.
9393

94-
:param string $id: Translation key. For example, ``mautic.core.empty``.
95-
:param string|null $domain: Specific domain to search. Defaults to ``messages`` if ``NULL``.
96-
:param string|null $locale: Specific locale to search. Defaults to system or user configured locale.
94+
:param string $id: Translation key. For example, ``mautic.core.empty``.
95+
:param string|null $domain: Specific domain to search. Defaults to ``messages`` if ``NULL``.
96+
:param string|null $locale: Specific locale to search. Defaults to system or user configured locale.
9797

98-
:returns: ``TRUE`` if the translation key exists. ``FALSE`` otherwise.
99-
:returntype: boolean
98+
:returns: ``TRUE`` if the translation key exists. ``FALSE`` otherwise.
99+
:returntype: boolean

‎docs/components/ui.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,26 @@ Mautic dispatches the Event ``\Mautic\CoreBundle\CoreEvents::VIEW_INJECT_CUSTOM_
1212

1313
.. php:class:: Mautic\CoreBundle\Event\CustomButtonEvent
1414
15-
.. php:method:: public function getLocation()
15+
.. php:method:: public function getLocation()
1616
17-
:return: Requested location for the Button.
17+
:return: Requested location for the Button.
1818

19-
.. php:method:: public function getButtons()
19+
.. php:method:: public function getButtons()
2020
21-
:return: Array of registered Buttons.
22-
:returntype: array
21+
:return: Array of registered Buttons.
22+
:returntype: array
2323

24-
.. php:method:: public function addButtons(array $buttons, $location = null, $route = null)
24+
.. php:method:: public function addButtons(array $buttons, $location = null, $route = null)
2525
26-
:param array[] $buttons: Array of buttons.
27-
:param string $location: Location of the Button to be placed.
28-
:param string $route: Route.
26+
:param array[] $buttons: Array of buttons.
27+
:param string $location: Location of the Button to be placed.
28+
:param string $route: Route.
2929

30-
.. php:method:: public function addButton(array $button, $location = null, $route = null)
30+
.. php:method:: public function addButton(array $button, $location = null, $route = null)
3131
32-
:param array[] $button: :ref:`Details for button<components/ui:Button Array Format>`.
33-
:param string $location: Location of the Button to be placed.
34-
:param string $route: Route.
32+
:param array[] $button: :ref:`Details for button<components/ui:Button Array Format>`.
33+
:param string $location: Location of the Button to be placed.
34+
:param string $route: Route.
3535

3636
A Plugin can inject the Buttons into five places in Mautic's UI.
3737

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@
4545
# ones.
4646
extensions = [
4747
'xref',
48-
'phpdomain',
4948
'code_samples_ext',
5049
'sphinx_rtd_theme',
5150
'sphinx.ext.viewcode',
5251
'sphinx.ext.autosectionlabel',
52+
'sphinxcontrib.phpdomain',
5353
]
5454

5555
# Add any paths that contain templates here, relative to this directory.

‎docs/plugins/config.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -199,22 +199,22 @@ Configure custom routes through writing a listener to the ``\Mautic\CoreBundle\C
199199

200200
.. php:class:: Mautic\CoreBundle\Event\RouteEvent
201201
202-
.. php:method:: getType()
202+
.. php:method:: getType()
203203
204-
:returns: The :ref:`route firewall<plugins/config:Routing firewalls>` for the given route collection.
205-
:returntype: string
204+
:returns: The :ref:`route firewall<plugins/config:Routing firewalls>` for the given route collection.
205+
:returntype: string
206206

207-
.. php:method:: getCollection()
207+
.. php:method:: getCollection()
208208
209-
:returns: Returns a RouteCollection object that can be used to manually define custom routes.
210-
:returntype: \\Symfony\\Component\\Routing\\RouteCollection
209+
:returns: Returns a RouteCollection object that can be used to manually define custom routes.
210+
:returntype: \\Symfony\\Component\\Routing\\RouteCollection
211211

212-
.. php:method:: addRoutes(string $path)
212+
.. php:method:: addRoutes(string $path)
213213
214-
Load custom routes through a resource file such as yaml or XML.
214+
Load custom routes through a resource file such as yaml or XML.
215215

216-
:param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``.
217-
:returntype: void
216+
:param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``.
217+
:returntype: void
218218

219219
Debugging routes
220220
================

0 commit comments

Comments
 (0)