Dolibarr ERP CRM Wiki

Variable substitution system: Difference between revisions

Page

Variable substitution system (view source)

Revision as of 14:58, 22 January 2025

4,398 bytes added ,  1 year ago
m
→‎For Emails: Précisions sur les variables __UNSUBSCRIBE__ et __CHECK_READ__ spécifiques aux emailings
VisualWikitext
mNo edit summary
Tag: 2017 source edit
m (→‎For Emails: Précisions sur les variables __UNSUBSCRIBE__ et __CHECK_READ__ spécifiques aux emailings)
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<!-- BEGIN origin interlang links -->
<!-- You can edit this section but do NOT remove these comments
    Links below will be automatically replicated on translated pages by PolyglotBot -->
[[fr:Système_de_substitution_de_variables]]
[[zh:变量替换系统]]
<!-- END interlang links -->
{{TemplateDocUser}}
{{TemplateDocUser}}
{{TemplateDocDevEn}}
{{TemplateDocDevEn}}
Line 13: Line 20:


*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 64: Line 72:
|User remote IP
|User remote IP
|}
|}
*
*


Line 69: Line 78:


*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 84: Line 94:
|contact@mycompany.com
|contact@mycompany.com
|My company contact email
|My company contact email
|
|-
|__MYCOMPANY_PHONE__
|0123456789
|My company phone number
|
|-
|__MYCOMPANY_FAX__
|0123456789
|My company fax number
|
|
|-
|-
Line 161: Line 181:
|
|
|}
|}
*
*


==Object==
==Object==
===Generic===


===Generic===
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 209: Line 231:
|V 13
|V 13
|}
|}
*
*


==Objects with amounts==
===Objects with amounts===
 
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 222: Line 247:
|__DATE_YMD__
|__DATE_YMD__
|1/1/2020
|1/1/2020
|Actual date
|Object date
|
|
|-
|-
Line 236: 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 256: 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
Line 315: Line 340:
|V13
|V13
|}
|}
*
*


==Member==


==Member==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 452: Line 479:
|V 13
|V 13
|}
|}
*
*


==Thirdparty==
==Thirdparty==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 573: Line 603:
|V13
|V13
|}
|}
*
*


==Candidate==
==Candidate==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 599: Line 632:
|V13
|V13
|}
|}
*
*


==Project==
==Project==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 625: Line 661:
|
|
|}
|}
*
*


==Shipment==
==Shipment==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 646: Line 685:
|
|
|}
|}
*
*


==Reception==


==Reception==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 668: Line 709:
|V13
|V13
|}
|}
*
*


==Contract==
==Contract==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 699: Line 743:
|
|
|}
|}
*
*


==Extrafield==
==Extrafield==
===Generic Rule===
===Generic Rule===
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 716: Line 763:
|
|
|}
|}
*
*
===Date Extrafield===
===Date Extrafield===
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 741: Line 792:
|
|
|}
|}
*
*
===Datetime Extrafield===
===Datetime Extrafield===
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 771: Line 826:
|
|
|}
|}
*
*


==Online Payment==
==Online Payment==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 793: Line 851:
|-
|-
|}
|}
*
*


==Online Proposal Signature==
*
{| class="wikitable sortable" style="width: 85%;"
|+
!Variable
!Displayed Value
!Note
!Dolibarr Mini
|-
|__ONLINE_SIGN_URL__
|[https://mydoli.com/public/onlinesign http://mydoli.com/public/onlinesign]
|Address of the Online Signature for proposal
|15
|-
|}
*
==Online Intervention Signature==
*
{| class="wikitable sortable" style="width: 85%;"
|+
!Variable
!Displayed Value
!Note
!Dolibarr Mini
|-
|__ONLINE_SIGN_FICHINTER_URL__
|[https://mydoli.com/public/onlinesign http://mydoli.com/public/onlinesign]
|Address of the Online Signature for intervention
|
|-
|}
*


==Document download==
==Document download==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 818: 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 832: 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__
|
|
|
|
|}
|}
*
*


==Event==
==Event==
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 861: Line 974:
|V13
|V13
|}
|}
*
*


==Objects with amounts==
==Dates==
 
*
*
{| class="wikitable sortable"
 
{| class="wikitable sortable" style="width: 85%;"
|+
|+
!Variable
!Variable
Line 871: Line 987:
!Note
!Note
!Dolibarr Mini
!Dolibarr Mini
|-
|__DATE_YMD__
|1/1/2020
|Actual date
|
|-
|__DATE_DUE_YMD__
|1/1/2020
|Due date
|
|-
|__AMOUNT__
|1243.34
|Amount
|
|-
|__AMOUNT_EXCL_TAX__
|1234.45
|Amount without taxes
|
|-
|__AMOUNT_VAT__
|123.4
|VAT amount
|
|-
|__AMOUNT_FORMATED__
|1243.34 €
|Amount formated
|
|-
|__AMOUNT_EXCL_TAX_FORMATED__
|1234.45 €
|Amount without taxes formated
|
|-
|__AMOUNT_VAT_FORMATED__
|123.4 €
|VAT amount formated
|
|-
|-
|__DAY__
|__DAY__
Line 986: Line 1,062:
|next year
|next year
|
|
|}
*
==Multicompany==
*
{| class="wikitable sortable" style="width: 85%;"
|+
!Variable
!Displayed Value
!Note
!Dolibarr Mini
|-
|__ENTITY_ID__
|
|
|V13
|}
*
==System==
*
{| class="wikitable sortable" style="width: 85%;"
|+
!Variable
!Displayed Value
!Note
!Dolibarr Mini
|-
|-
|__DOL_MAIN_URL_ROOT__
|__DOL_MAIN_URL_ROOT__
Line 996: Line 1,105:
|Any translation Key
|Any translation Key
|
|
|-
|<nowiki>__(AnyTranslationKey|langfile)__</nowiki>
|Translation
|Any translation Key (load also language file before)
|V13
|-
|-
|__[AnyConstantKey]__
|__[AnyConstantKey]__
Line 1,001: Line 1,115:
|Value of a constant key
|Value of a constant key
|
|
|}
*
==For Emails==
*
{| class="wikitable sortable" style="width: 85%;"
|+
!Variable
!Displayed Value
!Note
!Dolibarr Mini
|-
|-
|__CONTACT_NAME_XXX__
|__CONTACT_NAME_XXX__
|Mr T
|Mister T
|XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple : __CONTACT_NAME_BILLING__ for the billing contact). The output will be Title + LastName + First Name
|XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple : __CONTACT_NAME_BILLING__ for the billing contact). The output will be LastName + First Name
|V14
|-
|__CONTACT_LASTNAME_XXX__
|T
|XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple : __CONTACT_NAME_BILLING__ for the billing contact).
|V14
|-
|__CONTACT_FIRSTNAME_XXX__
|Mister
|XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple : __CONTACT_NAME_BILLING__ for the billing contact).
|V14
|-
|__CONTACT_TITLE_XXX__
|Mr
|XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple : __CONTACT_NAME_BILLING__ for the billing contact).
|V14
|-
|__CHECK_READ__
|
|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,010: Line 1,168:
*
*


=Custom substitution variables=
=Substitution variables provide by external module=
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
 
<code>$this->module_parts['substitutions'] = 1 </code>
 
into the module descriptor.
 
=How it work=
The array to define all substitution variables is defined in code by calling the method
<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. 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:
<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.
In such a case, the substitution is not done by the getCommonSubstitutionArray(). The getCommonSubstitutionArray() will just add an entry into the array of substitution with the information to explain how to get the value like for this entry:
<code>$substitutionarray['__PROJECT_NAME__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:'.$object->id</code>
The substitution will be done by the make_substitutions() and only it is required by calling the method defined (here fetchAndSetSubstitution with the param $object->id of the object Project defined into file /projet/class/project.class.php).
Thus, the heavy database access is done only if required.
Isamuse
25

edits

Retrieved from "https://wiki.dolibarr.org/index.php/Special:MobileDiff/50323...62244"