Variable substitution system - Revision history

Isamuse: /* For Emails */ Précisions sur les variables UNSUBSCRIBE et __CHECK_READ__ spécifiques aux emailings

2025-01-22T14:58:14Z

For Emails: Précisions sur les variables __UNSUBSCRIBE__ et __CHECK_READ__ spécifiques aux emailings

← Older revision		Revision as of 14:58, 22 January 2025
Line 1,152:		Line 1,152:
	\|__CHECK_READ__		\|__CHECK_READ__
	\|		\|
	\|~~Insert~~ a blank image with a callback URL to Dolibarr (/public/emailing/mailing-read.php?tag=)		\|In emailings, insert a blank image with a callback URL to Dolibarr (/public/emailing/mailing-read.php?tag=)
			\|
			\|-
			\|__UNSUBSCRIBE__
			\|
			\|In emailings, insert a link to allow a recipient to unsubscribe from emailings. If the recipient (third party or contact) unsubscribes, his status will change to "Refuse bulk emailings"
			To setup the wording of:

			- the mention in your email for unsubscribing: Translation (key : MailUnsubcribe)

			- the landing page after unsubscribing: Translation (key: YourMailUnsubcribeOK)
	\|		\|
	\|}		\|}
Line 1,166:		Line 1,176:
	into the module descriptor.		into the module descriptor.

	= How it work =		=How it work=
	The array to define all substitution variables is defined in code by calling the method		The array to define all substitution variables is defined in code by calling the method
	<code>$substitutionarray = getCommonSubstitutionArray().</code>		<code>$substitutionarray = getCommonSubstitutionArray().</code>

Eldy: /* How it work */

2024-10-25T12:09:41Z

How it work

← Older revision		Revision as of 12:09, 25 October 2024
Line 1,169:		Line 1,169:
	The array to define all substitution variables is defined in code by calling the method		The array to define all substitution variables is defined in code by calling the method
	<code>$substitutionarray = getCommonSubstitutionArray().</code>		<code>$substitutionarray = getCommonSubstitutionArray().</code>
	This method receive the $object in parameter, so it can define the content of the substitution array using properties of this object.		This method receive the $object in parameter, so it can define the content of the substitution array using properties of this object. No database access and no IO are allowed to set the substitution array.

	Then the array will be used by calling the make_substitutions() this way:		Then the array will be used by calling the make_substitutions() this way:
	<code>$textcompleted = make_substitutions($textwithsubtitutionkeys, $substitutionarray)</code>		<code>$textcompleted = make_substitutions($textwithsubtitutionkeys, $substitutionarray)</code>


	However, sometimes to value to use is not available into the $object, neither into the environment, and it needs a database access to get the value.		However, sometimes to value to use is not available into the $object, neither into the environment, and it needs a database access to get the value.

Eldy: /* Custom substitution variables */

2024-10-25T12:07:07Z

Custom substitution variables

← Older revision		Revision as of 12:07, 25 October 2024
Line 1,158:		Line 1,158:
	*		*

	=~~Custom substitution~~ variables=		=Substitution variables provide by external module=
	Custom substitution variables can be added by external modules.		Custom substitution variables can be added by external modules.
	For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the		For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the

Eldy: /* Custom substitution variables */

2024-10-25T12:06:36Z

Custom substitution variables

← Older revision		Revision as of 12:06, 25 October 2024
Line 1,162:		Line 1,162:
	For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the		For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the

	<code>->module_parts['substitutions'] = 1 </code>		<code>$this->module_parts['substitutions'] = 1 </code>

	into the module descriptor.		into the module descriptor.

Eldy: /* Custom substitution variables */

2024-10-25T12:06:21Z

Custom substitution variables

← Older revision		Revision as of 12:06, 25 October 2024
Line 1,160:		Line 1,160:
	=Custom substitution variables=		=Custom substitution variables=
	Custom substitution variables can be added by external modules.		Custom substitution variables can be added by external modules.
	For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the		For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the

	<code>->module_parts['substitutions'] = 1 </code>		<code>->module_parts['substitutions'] = 1 </code>

	into the module descriptor.		into the module descriptor.

Eldy: /* Custom substitution variables */

2024-10-25T12:06:09Z

Custom substitution variables

← Older revision		Revision as of 12:06, 25 October 2024
Line 1,160:		Line 1,160:
	=Custom substitution variables=		=Custom substitution variables=
	Custom substitution variables can be added by external modules.		Custom substitution variables can be added by external modules.
	For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the ->~~multipart~~['~~substitution~~'] = 1 into the module descriptor.		For this, the external module must embed a file called '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the
			<code>->module_parts['substitutions'] = 1 </code>
			into the module descriptor.

	= How it work =		= How it work =

Eldy: /* Custom substitution variables */

2024-10-25T12:04:50Z

Custom substitution variables

@@ Line 1,160: / Line 1,160: @@
 =Custom substitution variables=
 Custom substitution variables can be added by external modules.
-For this, the external module must embed a file called  '''mymodule/core/substitutions/functions_mymodules.lib.php'''
+For this, the external module must embed a file called  '''mymodule/core/substitutions/functions_mymodules.lib.php''' and set the ->multipart['substitution'] = 1 into the module descriptor.

Eldy: /* Objects with amounts */

2024-02-15T12:51:20Z

Objects with amounts

← Older revision		Revision as of 12:51, 15 February 2024
Line 247:		Line 247:
	\|__DATE_YMD__		\|__DATE_YMD__
	\|1/1/2020		\|1/1/2020
	\|~~Actual~~ date		\|Object date
	\|		\|
	\|-		\|-
Line 261:		Line 261:
	\|-		\|-
	\|__AMOUNT_TEXT__		\|__AMOUNT_TEXT__
	\|One ~~thousan~~ five hundred ...		\|One thousand five hundred ...
	\|Amount in words		\|Amount in words
	\|V13		\|V13
	\|-		\|-
	\|__AMOUNT_TEXTCURRENCY__		\|__AMOUNT_TEXTCURRENCY__
	\|One ~~thousan~~ five hundred ...		\|One thousand five hundred ...
	\|Amount in words with currency		\|Amount in words with currency
	\|V13		\|V13
Line 281:		Line 281:
	\|-		\|-
	\|__AMOUNT_VAT_TEXT__		\|__AMOUNT_VAT_TEXT__
	\|One ~~thousan~~ five hundred ...		\|One thousand five hundred ...
	\|VAT Amount in words		\|VAT Amount in words
	\|V13		\|V13
	\|-		\|-
	\|__AMOUNT_VAT_TEXTCURRENCY__		\|__AMOUNT_VAT_TEXTCURRENCY__
	\|One ~~thousan~~ five hundred ...		\|One thousand five hundred ...
	\|VAT Amount in words with currency		\|VAT Amount in words with currency
	\|V13		\|V13

JeremieC: Add intervention download link

2023-12-21T14:54:01Z

Add intervention download link

← Older revision		Revision as of 14:54, 21 December 2023
Line 918:		Line 918:
	\|http://mydoli.com/invoice.pdf		\|http://mydoli.com/invoice.pdf
	\|Direct download url of an invoice. This needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.		\|Direct download url of an invoice. This needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.
			\|
			\|-
			\|__DIRECTDOWNLOAD_URL_FICHINTER__
			\|http://mydoli.com/fichinter.pdf
			\|Direct download url of an intervention. This needs that the setup FICHINTER_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.
	\|		\|
	\|-		\|-
Line 932:		Line 937:
	\|__URL_INVOICE__		\|__URL_INVOICE__
	\|http://mydoli.com/compta/facture/card.php?id=xxx		\|http://mydoli.com/compta/facture/card.php?id=xxx
	\|~~Direct download url of an invoice. This needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.~~		\|
			\|
			\|-
			\|__URL_FICHINTER__
			\|
			\|
	\|		\|
	\|}		\|}

JeremieC: /* My Company */ add phone & fax

2023-12-13T09:36:03Z

My Company: add phone & fax

@@ Line 94: / Line 94: @@
 |contact@mycompany.com
 |My company contact email
+|
 |-

Variable substitution system - Revision history

Isamuse: /* For Emails */ Précisions sur les variables __UNSUBSCRIBE__ et __CHECK_READ__ spécifiques aux emailings

Eldy: /* How it work */

Eldy: /* Custom substitution variables */

Eldy: /* Custom substitution variables */

Eldy: /* Custom substitution variables */

Eldy: /* Custom substitution variables */

Eldy: /* Custom substitution variables */

Eldy: /* Objects with amounts */

JeremieC: Add intervention download link

JeremieC: /* My Company */ add phone & fax

Isamuse: /* For Emails */ Précisions sur les variables UNSUBSCRIBE et __CHECK_READ__ spécifiques aux emailings