diff --git a/.ddev/web-build/Dockerfile.sphinx b/.ddev/web-build/Dockerfile.sphinx index 89c1a548..615dcf83 100644 --- a/.ddev/web-build/Dockerfile.sphinx +++ b/.ddev/web-build/Dockerfile.sphinx @@ -5,4 +5,4 @@ RUN curl -sSL https://github.com/pypa/pipx/releases/latest/download/pipx.pyz -o RUN chmod +x /usr/local/bin/pipx RUN pipx install --global sphinx -RUN pipx install --force --global --include-deps sphinx-rtd-theme +RUN pipx inject --global sphinx sphinxcontrib-phpdomain sphinx-rtd-theme diff --git a/docs/components/campaigns.rst b/docs/components/campaigns.rst index 0e87e6ec..8422649b 100644 --- a/docs/components/campaigns.rst +++ b/docs/components/campaigns.rst @@ -474,148 +474,148 @@ Listeners to the event's ``batchEventName`` receives a ``\Mautic\CampaignBundle\ .. php:class:: Mautic\CampaignBundle\Events\PendingEvent -.. php:method:: public checkContext(string $eventType) + .. php:method:: public checkContext(string $eventType) - 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 ``batchEventName`` in the Event's definition. + 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 ``batchEventName`` in the Event's definition. - :return: ``TRUE`` if the context matches. - :returntype: bool + :return: ``TRUE`` if the context matches. + :returntype: bool -.. php:method:: public fail(\Mautic\CampaignBundle\Entity\LeadEventLog $log, string $reason) + .. php:method:: public fail(\Mautic\CampaignBundle\Entity\LeadEventLog $log, string $reason) - Mark a specific LeadEventLog object as failed and retry again later. + Mark a specific LeadEventLog object as failed and retry again later. - :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to fail. - :param string $reason: Reason the Event failed. + :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to fail. + :param string $reason: Reason the Event failed. - :returntype: void + :returntype: void -.. php:method:: public failAll(string $reason) + .. php:method:: public failAll(string $reason) - Fail the entire batch of LeadEventLog objects and retry again later. + Fail the entire batch of LeadEventLog objects and retry again later. - :param string $reason: Reason the Events failed. + :param string $reason: Reason the Events failed. - :returntype: void + :returntype: void -.. php:method:: public failLogs(\Doctrine\Common\Collections\ArrayCollection $logs, string $reason) + .. php:method:: public failLogs(\Doctrine\Common\Collections\ArrayCollection $logs, string $reason) - Fail a collection of LeadEventLog objects and try again later. + Fail a collection of LeadEventLog objects and try again later. - :param string $logs \\Doctrine\\Common\\Collections\\ArrayCollection: Collection to mark as failed. - :param string $reason: Reason the Events failed. + :param string $logs \\Doctrine\\Common\\Collections\\ArrayCollection: Collection to mark as failed. + :param string $reason: Reason the Events failed. - :returntype: void + :returntype: void -.. php:method:: public failRemaining(string $reason) + .. php:method:: public failRemaining(string $reason) - Fail all remaining LeadEventLog objects that are not marked as passed. + Fail all remaining LeadEventLog objects that are not marked as passed. - :param string $reason: Reason the Events failed. + :param string $reason: Reason the Events failed. - :returntype: void + :returntype: void -.. php:method:: public findLogByContactId(int $id) + .. php:method:: public findLogByContactId(int $id) - Returns a LeadEventLog object for the given contact ID. + Returns a LeadEventLog object for the given contact ID. - :param int $id: + :param int $id: - :return: Event log for the given contact. - :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog + :return: Event log for the given contact. + :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog -.. php:method:: public getConfig() + .. php:method:: public getConfig() - Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. + Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. - :return: Object to fetch the configuration options for the Campaign Event. - :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor + :return: Object to fetch the configuration options for the Campaign Event. + :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor -.. php:method:: public getContactIds() + .. php:method:: public getContactIds() - :return: Array of Contact IDs for the current batch of LeadEventLog objects to process. - :returntype: array + :return: Array of Contact IDs for the current batch of LeadEventLog objects to process. + :returntype: array -.. php:method:: public getContacts() + .. php:method:: public getContacts() - Returns the Lead objects for all Contacts in the current batch of LeadEventLog objecdts to process. + Returns the Lead objects for all Contacts in the current batch of LeadEventLog objecdts to process. - :return: Collection of Lead objects. - :returntype: \\Doctrine\\Common\\Collections\\ArrayCollection + :return: Collection of Lead objects. + :returntype: \\Doctrine\\Common\\Collections\\ArrayCollection -.. php:method:: public getContactsKeyedById() + .. php:method:: public getContactsKeyedById() - Same as ``getContacts`` except keyed by Contact ID. + Same as ``getContacts`` except keyed by Contact ID. - :return: Collection of Lead objects. - :returntype: \\Doctrine\\Common\\Collections\\ArrayCollection + :return: Collection of Lead objects. + :returntype: \\Doctrine\\Common\\Collections\\ArrayCollection -.. php:method:: public getEvent() + .. php:method:: public getEvent() - Returns the current Event entity. + Returns the current Event entity. - :return: Event entity. - :returntype: \\Mautic\\CampaignBundle\\Entity\\Event + :return: Event entity. + :returntype: \\Mautic\\CampaignBundle\\Entity\\Event -.. php:method:: public pass(\Mautic\CampaignBundle\Entity\LeadEventLog $log) + .. php:method:: public pass(\Mautic\CampaignBundle\Entity\LeadEventLog $log) - Mark a specific LeadEventLog as successful. + Mark a specific LeadEventLog as successful. - :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to pass. + :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to pass. - :returntype: void + :returntype: void -.. php:method:: public passAll() + .. php:method:: public passAll() - Mark all LeadEventLog objects as successful for the current batch. + Mark all LeadEventLog objects as successful for the current batch. - :returntype: void + :returntype: void -.. php:method:: public passAllWithError(string $reason) + .. php:method:: public passAllWithError(string $reason) - Mark all LeadEventLog objects with an error and they will **not** be retried later. + Mark all LeadEventLog objects with an error and they will **not** be retried later. - :returntype: void + :returntype: void -.. php:method:: public passLogs(\Doctrine\Common\Collections\ArrayCollection $logs) + .. php:method:: public passLogs(\Doctrine\Common\Collections\ArrayCollection $logs) - Mark a collection of LeadEventLog objects as successful. + Mark a collection of LeadEventLog objects as successful. - :param string $logs \\Doctrine\\Common\\Collections\\ArrayCollection: Collection to mark as successful. + :param string $logs \\Doctrine\\Common\\Collections\\ArrayCollection: Collection to mark as successful. - :returntype: void + :returntype: void -.. php:method:: public passRemaining() + .. php:method:: public passRemaining() - Mark remaining LeadEventLog objects that are not marked as failed. + Mark remaining LeadEventLog objects that are not marked as failed. - :returntype: void + :returntype: void -.. php:method:: public passRemainingWithError(string $reason) + .. php:method:: public passRemainingWithError(string $reason) - Mark remaining LeadEventLog objects that are not already marked as failed. + Mark remaining LeadEventLog objects that are not already marked as failed. - :param string $reason: The error message. + :param string $reason: The error message. - :returntype: void + :returntype: void -.. php:method:: public passWithError(\Mautic\CampaignBundle\Entity\LeadEventLog $log, string $reason) + .. php:method:: public passWithError(\Mautic\CampaignBundle\Entity\LeadEventLog $log, string $reason) - Mark a specific LeadEventLog with an error and do not try again. + Mark a specific LeadEventLog with an error and do not try again. - :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to pass. - :param string $reason: The error message. + :param \\Mautic\\CampaignBundle\\Entity\\LeadEventLog $log: Event log to pass. + :param string $reason: The error message. - :returntype: void + :returntype: void -.. php:method:: public setChannel(string $channel[, $channelId = null) + .. php:method:: public setChannel(string $channel[, $channelId = null) - Set the Channel to attribute to the Event. + Set the Channel to attribute to the Event. - :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. - :param mixed $channelId: ID of the Channel entity. + :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. + :param mixed $channelId: ID of the Channel entity. - :returntype: void + :returntype: void .. vale off @@ -690,45 +690,45 @@ Listeners to the event's ``eventName`` receives a ``\Mautic\CampaignBundle\Event .. php:class:: Mautic\CampaignBundle\Events\ConditionEvent -.. php:method:: public checkContext(string $eventType) + .. php:method:: public checkContext(string $eventType) - 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. + 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. - :return: ``TRUE`` if the context matches. - :returntype: bool + :return: ``TRUE`` if the context matches. + :returntype: bool -.. php:method:: public fail() + .. php:method:: public fail() - Evaluate this Condition as ``FALSE``. + Evaluate this Condition as ``FALSE``. - :returntype: void + :returntype: void -.. php:method:: public getEventConfig() + .. php:method:: public getEventConfig() - Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. + Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. - :return: Object to fetch the configuration options for the Campaign Event. - :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor + :return: Object to fetch the configuration options for the Campaign Event. + :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor -.. php:method:: public getLog() + .. php:method:: public getLog() - :return: The ``LeadEventLog`` object for the Condition. - :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog + :return: The ``LeadEventLog`` object for the Condition. + :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog -.. php:method:: public pass() + .. php:method:: public pass() - Evaluate this Condition as ``TRUE``. + Evaluate this Condition as ``TRUE``. - :returntype: void + :returntype: void -.. php:method:: public setChannel(string $channel[, $channelId = null) + .. php:method:: public setChannel(string $channel[, $channelId = null) - Set the Channel to attribute to the Event. + Set the Channel to attribute to the Event. - :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. - :param mixed $channelId: ID of the Channel entity. + :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. + :param mixed $channelId: ID of the Channel entity. - :returntype: void + :returntype: void .. vale off @@ -815,43 +815,43 @@ The Campaign Engine then dispatches the Decision Event's ``eventName`` where lis .. php:class:: Mautic\CampaignBundle\Events\DecisionEvent -.. php:method:: public checkContext(string $eventType) + .. php:method:: public checkContext(string $eventType) - 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. + 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. - :return: ``TRUE`` if the context matches. - :returntype: bool + :return: ``TRUE`` if the context matches. + :returntype: bool -.. php:method:: public getEventConfig() + .. php:method:: public getEventConfig() - Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. + Use the returned ``AbstractEventAccessor`` object to access properties configured for this Event. - :return: Object to fetch the configuration options for the Campaign Event. - :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor + :return: Object to fetch the configuration options for the Campaign Event. + :returntype: \\Mautic\\CampaignBundle\\EventCollector\\Accessor\\Event\\AbstractEventAccessor -.. php:method:: public getLog() + .. php:method:: public getLog() - :return: The ``LeadEventLog`` object for the Condition. - :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog + :return: The ``LeadEventLog`` object for the Condition. + :returntype: \\Mautic\\CampaignBundle\\Entity\\LeadEventLog -.. php:method:: public getPassthrough() + .. php:method:: public getPassthrough() - Access context data set by ``RealTimeExecutioner::execute()``. + Access context data set by ``RealTimeExecutioner::execute()``. - :return: Returns whatever was set as the second argument to ``RealTimeExecutioner::execute()``. - :returntype: mixed + :return: Returns whatever was set as the second argument to ``RealTimeExecutioner::execute()``. + :returntype: mixed -.. php:method:: public setAsApplicable() + .. php:method:: public setAsApplicable() - 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. + 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. - :returntype: void + :returntype: void -.. php:method:: public setChannel(string $channel[, $channelId = null) + .. php:method:: public setChannel(string $channel[, $channelId = null) - Set the Channel to attribute to the Event. + Set the Channel to attribute to the Event. - :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. - :param mixed $channelId: ID of the Channel entity. + :param string $channel: Name of the Channel this Event relates to. For example, ``email``, ``page``, ``form``, and so forth. + :param mixed $channelId: ID of the Channel entity. - :returntype: void + :returntype: void diff --git a/docs/components/integrations.rst b/docs/components/integrations.rst index 73893ffa..b11cff41 100644 --- a/docs/components/integrations.rst +++ b/docs/components/integrations.rst @@ -41,20 +41,20 @@ The ``HelloWorldIntegration`` needs to implement ``\Mautic\IntegrationsBundle\In .. php:class:: \Mautic\IntegrationsBundle\Integration\BasicIntegration -.. php:method:: public function getName(): string; + .. php:method:: public function getName(): string; - :return: Return the Integration's name. - :returntype: string + :return: Return the Integration's name. + :returntype: string -.. php:method:: public function getDisplayName(): string; + .. php:method:: public function getDisplayName(): string; - :return: Return the Integration's display name. - :returntype: string + :return: Return the Integration's display name. + :returntype: string -.. php:method:: public function getIcon(): string; + .. php:method:: public function getIcon(): string; - :return: Get the path to the Integration's icon. - :returntype: string + :return: Get the path to the Integration's icon. + :returntype: string diff --git a/docs/components/integrations_authentication.rst b/docs/components/integrations_authentication.rst index 98827a5e..c5253805 100644 --- a/docs/components/integrations_authentication.rst +++ b/docs/components/integrations_authentication.rst @@ -165,15 +165,15 @@ To use the parameter based API key, create a credentials class that implements ` .. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\ApiKey\Credentials\ParameterCredentialsInterface -.. php:method:: public function getKeyName(): string; + .. php:method:: public function getKeyName(): string; - :return: Key name. - :returntype: string + :return: Key name. + :returntype: string -.. php:method:: public function getApiKey(): ?string; + .. php:method:: public function getApiKey(): ?string; - :return: API key or null. - :returntype: ?string + :return: API key or null. + :returntype: ?string Find the code snippet as follows, @@ -221,15 +221,15 @@ To use the header based API key, create a credentials class that implements ``\M .. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\ApiKey\Credentials\HeaderCredentialsInterface -.. php:method:: public function getKeyName(): string; + .. php:method:: public function getKeyName(): string; - :return: Key name. - :returntype: string + :return: Key name. + :returntype: string -.. php:method:: public function getApiKey(): ?string; + .. php:method:: public function getApiKey(): ?string; - :return: API key or null. - :returntype: ?string + :return: API key or null. + :returntype: ?string Find the code snippet as follows, @@ -279,15 +279,15 @@ To use the basic auth, create a credentials class that implements ``\Mautic\Inte .. php:class:: \Mautic\IntegrationsBundle\Auth\Provider\BasicAuth\CredentialsInterface -.. php:method:: public function getUsername(): ?string; + .. php:method:: public function getUsername(): ?string; - :return: User name. - :returntype: ?string + :return: User name. + :returntype: ?string -.. php:method:: public function getPassword(): ?string; + .. php:method:: public function getPassword(): ?string; - :return: Password. - :returntype: ?string + :return: Password. + :returntype: ?string Find the code snippet as follows, diff --git a/docs/components/integrations_configuration_form_notes.rst b/docs/components/integrations_configuration_form_notes.rst index e8ff3a22..6813a84e 100644 --- a/docs/components/integrations_configuration_form_notes.rst +++ b/docs/components/integrations_configuration_form_notes.rst @@ -41,19 +41,19 @@ Note Object .. php:class:: \Mautic\IntegrationsBundle\DTO\Note -.. php:attr:: public note; + .. php:attr:: public note; -.. php:attr:: public type; + .. php:attr:: public type; -.. php:method:: public function getNote(): string + .. php:method:: public function getNote(): string - :return: The string to display. - :returntype: string + :return: The string to display. + :returntype: string -.. php:method:: public function getType(): string + .. php:method:: public function getType(): string - :return: The note type, this helps annotate the note. - :returntype: string + :return: The note type, this helps annotate the note. + :returntype: string The following code snippet shows the use of ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface``. diff --git a/docs/components/points.rst b/docs/components/points.rst index 55fcba42..0754fe1b 100644 --- a/docs/components/points.rst +++ b/docs/components/points.rst @@ -139,15 +139,15 @@ Mautic dispatches the Event ``\Mautic\PointBundle\PointEvents::TRIGGER_ON_BUILD` .. php:class:: Mautic\PointBundle\Event\TriggerBuilderEvent -.. php:method:: public function addEvent(string $key, array $action) + .. php:method:: public function addEvent(string $key, array $action) - :param string $key: Unique key for the Action. - :param array $action: :ref:`Action definition`. + :param string $key: Unique key for the Action. + :param array $action: :ref:`Action definition`. -.. php:method:: public getEvents() + .. php:method:: public getEvents() - :return: Array of registered Events. - :returntype: array + :return: Array of registered Events. + :returntype: array .. vale off diff --git a/docs/components/translator.rst b/docs/components/translator.rst index fb048c80..5531237b 100644 --- a/docs/components/translator.rst +++ b/docs/components/translator.rst @@ -63,37 +63,37 @@ In PHP templates, use ``$view['translator']`` to access the Translator service. .. php:class:: Mautic\CoreBundle\Translation\Translator -.. php:method:: trans(string $id[, array $parameters = [], ?string $domain = null, ?string $locale = null]) + .. php:method:: trans(string $id[, array $parameters = [], ?string $domain = null, ?string $locale = null]) - Returns the translation for the given key. + Returns the translation for the given key. - :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"``. - :param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``. - :param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale. + :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"``. + :param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``. + :param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale. - :returns: Returns the translated string if the key is found. Otherwise, an empty string. - :returntype: string + :returns: Returns the translated string if the key is found. Otherwise, an empty string. + :returntype: string -.. php:method:: transConditional(string $preferred, string $alternative[, array $parameters = [], ?string $domain = null, ?string $locale = null]) + .. php:method:: transConditional(string $preferred, string $alternative[, array $parameters = [], ?string $domain = null, ?string $locale = null]) - Translates the preferred key if it exists and the alternate key if it does not. + Translates the preferred key if it exists and the alternate key if it does not. - :param string $preferred: Preferred translation key. - :param string $alternative: Alternate translation key if the preferred does does not exist. - :param array $parameters: Parameters as key/value pairs to populate placeholders in the translation. - :param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``. - :param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale. + :param string $preferred: Preferred translation key. + :param string $alternative: Alternate translation key if the preferred does does not exist. + :param array $parameters: Parameters as key/value pairs to populate placeholders in the translation. + :param string|null $domain: Specific domain to look for the translation key. Defaults to ``messages`` if ``NULL``. + :param string|null $locale: Specific locale to look for the translation key. Defaults to system or user configured locale. - :returns: Returns the translated string if the key is found. Otherwise, an empty string. - :returntype: string + :returns: Returns the translated string if the key is found. Otherwise, an empty string. + :returntype: string -.. php:method:: hasId(string $id[, ?string $domain = null, ?string $local = null]) + .. php:method:: hasId(string $id[, ?string $domain = null, ?string $local = null]) - Checks to see if a translation key exists. + Checks to see if a translation key exists. - :param string $id: Translation key. For example, ``mautic.core.empty``. - :param string|null $domain: Specific domain to search. Defaults to ``messages`` if ``NULL``. - :param string|null $locale: Specific locale to search. Defaults to system or user configured locale. + :param string $id: Translation key. For example, ``mautic.core.empty``. + :param string|null $domain: Specific domain to search. Defaults to ``messages`` if ``NULL``. + :param string|null $locale: Specific locale to search. Defaults to system or user configured locale. - :returns: ``TRUE`` if the translation key exists. ``FALSE`` otherwise. - :returntype: boolean + :returns: ``TRUE`` if the translation key exists. ``FALSE`` otherwise. + :returntype: boolean diff --git a/docs/components/ui.rst b/docs/components/ui.rst index a9f947b8..ca0a91da 100644 --- a/docs/components/ui.rst +++ b/docs/components/ui.rst @@ -12,26 +12,26 @@ Mautic dispatches the Event ``\Mautic\CoreBundle\CoreEvents::VIEW_INJECT_CUSTOM_ .. php:class:: Mautic\CoreBundle\Event\CustomButtonEvent -.. php:method:: public function getLocation() + .. php:method:: public function getLocation() - :return: Requested location for the Button. + :return: Requested location for the Button. -.. php:method:: public function getButtons() + .. php:method:: public function getButtons() - :return: Array of registered Buttons. - :returntype: array + :return: Array of registered Buttons. + :returntype: array -.. php:method:: public function addButtons(array $buttons, $location = null, $route = null) + .. php:method:: public function addButtons(array $buttons, $location = null, $route = null) - :param array[] $buttons: Array of buttons. - :param string $location: Location of the Button to be placed. - :param string $route: Route. + :param array[] $buttons: Array of buttons. + :param string $location: Location of the Button to be placed. + :param string $route: Route. -.. php:method:: public function addButton(array $button, $location = null, $route = null) + .. php:method:: public function addButton(array $button, $location = null, $route = null) - :param array[] $button: :ref:`Details for button`. - :param string $location: Location of the Button to be placed. - :param string $route: Route. + :param array[] $button: :ref:`Details for button`. + :param string $location: Location of the Button to be placed. + :param string $route: Route. A Plugin can inject the Buttons into five places in Mautic's UI. diff --git a/docs/conf.py b/docs/conf.py index f968d500..c2440c78 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,11 +45,11 @@ # ones. extensions = [ 'xref', - 'phpdomain', 'code_samples_ext', 'sphinx_rtd_theme', 'sphinx.ext.viewcode', 'sphinx.ext.autosectionlabel', + 'sphinxcontrib.phpdomain', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/plugins/config.rst b/docs/plugins/config.rst index 63d475fc..61622505 100644 --- a/docs/plugins/config.rst +++ b/docs/plugins/config.rst @@ -197,22 +197,22 @@ Configure custom routes through writing a listener to the ``\Mautic\CoreBundle\C .. php:class:: Mautic\CoreBundle\Event\RouteEvent -.. php:method:: getType() + .. php:method:: getType() - :returns: The :ref:`route firewall` for the given route collection. - :returntype: string + :returns: The :ref:`route firewall` for the given route collection. + :returntype: string -.. php:method:: getCollection() + .. php:method:: getCollection() - :returns: Returns a RouteCollection object that can be used to manually define custom routes. - :returntype: \\Symfony\\Component\\Routing\\RouteCollection + :returns: Returns a RouteCollection object that can be used to manually define custom routes. + :returntype: \\Symfony\\Component\\Routing\\RouteCollection -.. php:method:: addRoutes(string $path) + .. php:method:: addRoutes(string $path) - Load custom routes through a resource file such as yaml or XML. + Load custom routes through a resource file such as yaml or XML. - :param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``. - :returntype: void + :param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``. + :returntype: void Debugging routes ================ diff --git a/docs/plugins/data.rst b/docs/plugins/data.rst index 4a48f54a..bf18649b 100644 --- a/docs/plugins/data.rst +++ b/docs/plugins/data.rst @@ -16,166 +16,166 @@ You can build the schema through Doctrine's ``Doctrine\ORM\Mapping\Builder\Class .. php:class:: Mautic\CoreBundle\Doctrine\Mapping\ClassMetadataBuilder -.. php:method:: addBigIntIdField([string $fieldName = 'id', string $columnName = 'id', bool $isPrimary = true, boolean $isNullable = false]) + .. php:method:: addBigIntIdField([string $fieldName = 'id', string $columnName = 'id', bool $isPrimary = true, boolean $isNullable = false]) - Adds autogenerated ID field type of BIGINT UNSIGNED + Adds autogenerated ID field type of BIGINT UNSIGNED - :param string $fieldName: Name of the ORM field. - :param string $columnName: Name of the column created in the database table. - :param boolean $isPrimary: ``TRUE`` to configure this field as a primary key for the table. - :param bool $isNullable: ``TRUE`` to allow ``NULL`` values. + :param string $fieldName: Name of the ORM field. + :param string $columnName: Name of the column created in the database table. + :param boolean $isPrimary: ``TRUE`` to configure this field as a primary key for the table. + :param bool $isNullable: ``TRUE`` to allow ``NULL`` values. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addCategory() + .. php:method:: addCategory() - Creates a many to one relationship with `Mautic\CategoryBundle\Entity\Category`. Defines a ``category`` ORM property mapped to a ``category_id`` column on the table with a foreign key to ``categories.id``. + Creates a many to one relationship with `Mautic\CategoryBundle\Entity\Category`. Defines a ``category`` ORM property mapped to a ``category_id`` column on the table with a foreign key to ``categories.id``. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addContact([bool $nullable = false, string $onDelete = 'CASCADE', bool $isPrimaryKey = false, ?string $inversedBy = null) + .. php:method:: addContact([bool $nullable = false, string $onDelete = 'CASCADE', bool $isPrimaryKey = false, ?string $inversedBy = null) - Creates a many to one relationship with `Mautic\LeadBundle\Entity\Lead`. Defines a ``contact`` ORM property mapped to a ``contact_id`` column on the table with a foreign key to ``leads.id``. + Creates a many to one relationship with `Mautic\LeadBundle\Entity\Lead`. Defines a ``contact`` ORM property mapped to a ``contact_id`` column on the table with a foreign key to ``leads.id``. - :param bool $nullable: ``TRUE`` to allow ``NULL`` values. - :param string $onDelete: Foreign key reference option such as ``CASCADE`` or ``SET NULL``. - :param bool $isPrimaryKey: ``TRUE`` to configure this field as a primary key for the table. - :param string|null $inversedBy: Property on the ``Mautic\LeadBundle\Entity\Lead`` entity this relates to. This is only used by Core. + :param bool $nullable: ``TRUE`` to allow ``NULL`` values. + :param string $onDelete: Foreign key reference option such as ``CASCADE`` or ``SET NULL``. + :param bool $isPrimaryKey: ``TRUE`` to configure this field as a primary key for the table. + :param string|null $inversedBy: Property on the ``Mautic\LeadBundle\Entity\Lead`` entity this relates to. This is only used by Core. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addDateAdded([bool $nullable = false]) + .. php:method:: addDateAdded([bool $nullable = false]) - Creates a mutable date/time field. Defines a ``dateAdded`` ORM property mapped to a ``date_added`` column on the table. + Creates a mutable date/time field. Defines a ``dateAdded`` ORM property mapped to a ``date_added`` column on the table. - :param bool $nullable: ``TRUE`` to allow ``NULL`` values. + :param bool $nullable: ``TRUE`` to allow ``NULL`` values. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addField(string $name, string $type[, array $mapping = []]) + .. php:method:: addField(string $name, string $type[, array $mapping = []]) - Decorates ``Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder::addField`` that sets the max length to 191 characters for string typed or indexed fields for compatibility with UTF8MB4 encoding. + Decorates ``Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder::addField`` that sets the max length to 191 characters for string typed or indexed fields for compatibility with UTF8MB4 encoding. - :param string $name: Name of the ORM field. - :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. - :param array $mapping: Custom field definitions. + :param string $name: Name of the ORM field. + :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. + :param array $mapping: Custom field definitions. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addId() + .. php:method:: addId() - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addIdColumns([string $nameColumn = 'name', string $descriptionColumn = 'description']) + .. php:method:: addIdColumns([string $nameColumn = 'name', string $descriptionColumn = 'description']) - Creates ``id``, ``name``, and ``description`` ORM fields. ``id`` is an auto-incremented unsigned integer set as a primary key. ``name`` is created as ``varchar(191)`` and ``description`` as ``longtext``. Customize the ORM names for ``name`` and ``description`` through the optional parameters. + Creates ``id``, ``name``, and ``description`` ORM fields. ``id`` is an auto-incremented unsigned integer set as a primary key. ``name`` is created as ``varchar(191)`` and ``description`` as ``longtext``. Customize the ORM names for ``name`` and ``description`` through the optional parameters. - :param string $nameColumn: Customize the name for the ``name`` field. - :param string $descriptionColumn: Customize the name for the ``description`` field. + :param string $nameColumn: Customize the name for the ``name`` field. + :param string $descriptionColumn: Customize the name for the ``description`` field. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addIpAddress([bool $nullable = false]) + .. php:method:: addIpAddress([bool $nullable = false]) - Creates a many to one relationship with `Mautic\CoreBundle\Entity\IpAddress`. Defines a ``ipAddress`` ORM property mapped to a ``ip_id`` column on the table with a foreign key to ``ip_addresses.id``. + Creates a many to one relationship with `Mautic\CoreBundle\Entity\IpAddress`. Defines a ``ipAddress`` ORM property mapped to a ``ip_id`` column on the table with a foreign key to ``ip_addresses.id``. - :param bool $nullable: ``TRUE`` to allow ``NULL`` values. + :param bool $nullable: ``TRUE`` to allow ``NULL`` values. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addNamedField(string $name, string $type, string $columnName[, $nullable = false]) + .. php:method:: addNamedField(string $name, string $type, string $columnName[, $nullable = false]) - Creates a field with a custom column name. + Creates a field with a custom column name. - :param string $name: Name of the ORM field. - :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. - :param string $columnName: Name of the table's column name. - :param bool $nullable: ``TRUE`` to allow ``NULL`` values. + :param string $name: Name of the ORM field. + :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. + :param string $columnName: Name of the table's column name. + :param bool $nullable: ``TRUE`` to allow ``NULL`` values. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addNullableField(string $name[, string $type = Types::STRING, ?string $columnName = null]) + .. php:method:: addNullableField(string $name[, string $type = Types::STRING, ?string $columnName = null]) - Creates a field that allows a ``NULL`` value. + Creates a field that allows a ``NULL`` value. - :param string $name: Name of the ORM field. - :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. - :param string $columnName: Name of the table's column name. + :param string $name: Name of the ORM field. + :param string $type: Doctrine field type. See ``Doctrine\DBAL\Types\Types``. + :param string $columnName: Name of the table's column name. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addPublishDates() + .. php:method:: addPublishDates() - Creates ``publishUp`` and ``publishDown`` nullable mutable date/time fields as ``publish_up`` and ``publish_down`` respectively. + Creates ``publishUp`` and ``publishDown`` nullable mutable date/time fields as ``publish_up`` and ``publish_down`` respectively. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: addUuid() + .. php:method:: addUuid() - Creates a ``id`` GUID field as a primary key. You should generate a UUID in the entity's ``__construct`` or pass one into the ``__construct`` when creating a new entity. You can use ``$this->id = Ramsey\Uuid\Uuid::uuid4()->toString();``. + Creates a ``id`` GUID field as a primary key. You should generate a UUID in the entity's ``__construct`` or pass one into the ``__construct`` when creating a new entity. You can use ``$this->id = Ramsey\Uuid\Uuid::uuid4()->toString();``. - :returns: ``$this`` - :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder + :returns: ``$this`` + :returntype: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ClassMetadataBuilder -.. php:method:: createField(string $name, string $type) + .. php:method:: createField(string $name, string $type) - Instantiates and returns a ``Doctrine\ORM\Mapping\Builder\FieldBuilder`` object. ``length`` is set if the field is a string type or indexed. + Instantiates and returns a ``Doctrine\ORM\Mapping\Builder\FieldBuilder`` object. ``length`` is set if the field is a string type or indexed. - :returns: \\Doctrine\\ORM\\Mapping\\Builder\\FieldBuilder + :returns: \\Doctrine\\ORM\\Mapping\\Builder\\FieldBuilder -.. php:method:: createManyToMany(string $name, string $targetEntity) + .. php:method:: createManyToMany(string $name, string $targetEntity) - Creates a many to many field to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\ManyToManyAssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\ManyToManyAssociationBuilder`` with ``orphanRemoval()`` support. + Creates a many to many field to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\ManyToManyAssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\ManyToManyAssociationBuilder`` with ``orphanRemoval()`` support. - :param string $name: Name of the ORM field. - :param string $targetEntity: Fully qualified classname for the targeted entity. + :param string $name: Name of the ORM field. + :param string $targetEntity: Fully qualified classname for the targeted entity. - :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ManyToManyAssociationBuilder + :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\ManyToManyAssociationBuilder -.. php:method:: createManyToOne(string $name, string $targetEntity) + .. php:method:: createManyToOne(string $name, string $targetEntity) - Creates a field with a many to one relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\AssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\AssociationBuilder`` with ``orphanRemoval()`` and ``isPrimaryKey()`` support. + Creates a field with a many to one relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\AssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\AssociationBuilder`` with ``orphanRemoval()`` and ``isPrimaryKey()`` support. - :param string $name: Name of the ORM field. - :param string $targetEntity: Fully qualified classname for the targeted entity. + :param string $name: Name of the ORM field. + :param string $targetEntity: Fully qualified classname for the targeted entity. - :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\AssociationBuilder + :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\AssociationBuilder -.. php:method:: createOneToMany(string $name, string $targetEntity) + .. php:method:: createOneToMany(string $name, string $targetEntity) - Creates a field with a one to many relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\OneToManyAssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\OneToManyAssociationBuilder`` with ``orphanRemoval()`` support. + Creates a field with a one to many relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\OneToManyAssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\OneToManyAssociationBuilder`` with ``orphanRemoval()`` support. - :param string $name: Name of the ORM field. - :param string $targetEntity: Fully qualified classname for the targeted entity. + :param string $name: Name of the ORM field. + :param string $targetEntity: Fully qualified classname for the targeted entity. - :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\OneToManyAssociationBuilder + :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\OneToManyAssociationBuilder -.. php:method:: createOneToOne(string $name, string $targetEntity) + .. php:method:: createOneToOne(string $name, string $targetEntity) - Creates a field with a one to one relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\AssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\AssociationBuilder`` with ``orphanRemoval()`` and ``isPrimaryKey()`` support. + Creates a field with a one to one relationship to the targeted entity. Instantiates and returns a ``Mautic\CoreBundle\Doctrine\Mapping\AssociationBuilder`` object that decorates ``Doctrine\ORM\Mapping\Builder\AssociationBuilder`` with ``orphanRemoval()`` and ``isPrimaryKey()`` support. - :param string $name: Name of the ORM field. - :param string $targetEntity: Fully qualified classname for the targeted entity. + :param string $name: Name of the ORM field. + :param string $targetEntity: Fully qualified classname for the targeted entity. - :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\AssociationBuilder + :returns: \\Mautic\\CoreBundle\\Doctrine\\Mapping\\AssociationBuilder -.. php:method:: isIndexedVarchar(string $name, string $type) + .. php:method:: isIndexedVarchar(string $name, string $type) - Checks whether the field should have a max length of 191 configured for compatibility with UTF8MB4 encoded fields. + Checks whether the field should have a max length of 191 configured for compatibility with UTF8MB4 encoded fields. - :returns: Returns ``TRUE`` if the field is a ``string`` type or is indexed. - :returntype: bool + :returns: Returns ``TRUE`` if the field is a ``string`` type or is indexed. + :returntype: bool Entity annotations ****************** @@ -291,64 +291,64 @@ Define migrations in the Plugin's ``Migrations`` directory. The file and class n .. php:class:: Mautic\IntegrationsBundle\Migration\AbstractMigration -.. php:attr:: protected tablePrefix + .. php:attr:: protected tablePrefix - Mautic's configured database table prefix. + Mautic's configured database table prefix. -.. php:method:: protected abstract isApplicable(Schema $schema) + .. php:method:: protected abstract isApplicable(Schema $schema) - :param Doctrine\\DBAL\\Schema\\Schema $schema: Use the ``Schema`` object to evaluate Mautic's current schema. + :param Doctrine\\DBAL\\Schema\\Schema $schema: Use the ``Schema`` object to evaluate Mautic's current schema. - :returns: Return ``FALSE`` to skip this migration. Otherwise, ``TRUE``. - :returntype: bool + :returns: Return ``FALSE`` to skip this migration. Otherwise, ``TRUE``. + :returntype: bool -.. php:method:: protected abstract up() + .. php:method:: protected abstract up() - Define the SQL queries through :php:meth:`addSql`. + Define the SQL queries through :php:meth:`addSql`. - :returntype: void + :returntype: void -.. php:method:: protected addSql(string $sql) + .. php:method:: protected addSql(string $sql) - :param string $sql: SQL query to execute. Prefix table and index names with :php:attr:`tablePrefix` or use :php:meth:`concatPrefix`. + :param string $sql: SQL query to execute. Prefix table and index names with :php:attr:`tablePrefix` or use :php:meth:`concatPrefix`. - :returntype: void + :returntype: void -.. php:method:: protected columnsToString(array $columns) + .. php:method:: protected columnsToString(array $columns) - :param array $columns: Array of column names. + :param array $columns: Array of column names. - :return: Returns a comma separated value list from the values given in the array. For example, ``$this->columnsToString(['a', 'b', 'c'])`` will return ``'a,b,c'``. - :returntype: string + :return: Returns a comma separated value list from the values given in the array. For example, ``$this->columnsToString(['a', 'b', 'c'])`` will return ``'a,b,c'``. + :returntype: string -.. php:method:: protected concatPrefix(string $name) + .. php:method:: protected concatPrefix(string $name) - Prefixes the given name with the configured table prefix. + Prefixes the given name with the configured table prefix. - :param string $name: Name of column or index to prefix. + :param string $name: Name of column or index to prefix. - :return: Prefixed name. - :returntype: string + :return: Prefixed name. + :returntype: string -.. php:method:: protected generateAlterTableForeignKeyStatement(string $table, array $columns, string $referenceTable, array $referenceColumns[, string $suffix = '']) + .. php:method:: protected generateAlterTableForeignKeyStatement(string $table, array $columns, string $referenceTable, array $referenceColumns[, string $suffix = '']) - Generates full SQL statement to add a new foreign key to a table. + Generates full SQL statement to add a new foreign key to a table. - :param string $table: Name of the current table without the table prefix. - :param array $columns: Array of columns for the current table. - :param string $referenceTable: Name of the referenced table without the table prefix. - :param array $referenceColumns: Array of columns for the referenced table. - :param string $suffix: String to append to the query such as ``ON DELETE CASCADE``. + :param string $table: Name of the current table without the table prefix. + :param array $columns: Array of columns for the current table. + :param string $referenceTable: Name of the referenced table without the table prefix. + :param array $referenceColumns: Array of columns for the referenced table. + :param string $suffix: String to append to the query such as ``ON DELETE CASCADE``. - :return: SQL statement for adding a new foreign key. - :returntype: string + :return: SQL statement for adding a new foreign key. + :returntype: string -.. php:method:: protected generateIndexStatement(string $table, array $columns) + .. php:method:: protected generateIndexStatement(string $table, array $columns) - Generates an ``INDEX`` statement to be used within a ``CREATE TABLE`` or ``ALTER TABLE`` statement to create an index. + Generates an ``INDEX`` statement to be used within a ``CREATE TABLE`` or ``ALTER TABLE`` statement to create an index. - :param string $table: Name of the table where the index will be added. - :param array $columns: Array of columns to included in the index. + :param string $table: Name of the table where the index will be added. + :param array $columns: Array of columns to included in the index. - :return: ``INDEX {tableName} ($columns...)`` statement - :returntype: string \ No newline at end of file + :return: ``INDEX {tableName} ($columns...)`` statement + :returntype: string \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index a5fabd16..25b618ce 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -9,4 +9,4 @@ myst-parser==4.0.0 linkify-it-py==2.0.3 esbonio==0.16.5 attrs==24.2.0 - +sphinxcontrib-phpdomain==0.13.2