EmailTemplates

class EmailTemplates extends DolibarrApi (View source)

API for handling Object of table llx_c_email_templates

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
static string[] $INTFIELDS
CEmailTemplate $email_template
string $table_element

Methods

__construct()

Constructor of the class

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
array
deleteById(int $id)

Delete an email template

array
deleteByLAbel(string $label)

Delete an email template

object
getById(int $id)

Get properties of a email template by id

object
getByLabel(string $label)

Get properties of an email template by label

array
index(string $sortfield = "e.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $fk_user = '', string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

List email templates

int
post(array $request_data = null)

Create an email template

object
putById(int $id, array $request_data = null)

Update an email template

object
putbyLabel(string $label, array $request_data = null)

Update an email template

Details

at line 67
__construct()

Constructor of the class

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 514
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 88
array deleteById(int $id)

Delete an email template

Parameters

int $id

email template ID

Return Value

array

Exceptions

RestException
RestException
RestException

at line 126
array deleteByLAbel(string $label)

Delete an email template

Parameters

string $label

email template label

Return Value

array

Exceptions

RestException
RestException
RestException

at line 165
object getById(int $id)

Get properties of a email template by id

Return an array with email template information

Parameters

int $id

ID of email template

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException

at line 185
object getByLabel(string $label)

Get properties of an email template by label

Return an array with order information

Parameters

string $label

Label of object

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException

at line 212
array index(string $sortfield = "e.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $fk_user = '', string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

List email templates

Get a list of email templates

Parameters

string $sortfield

Sort field
string $sortorder

Sort order
int $limit

Limit for list
int $page

Page number
string $fk_user

User ids to filter email templates of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string $sqlfilters

Other criteria to filter answers separated by a comma. Syntax example "(e.active:=:1) and (e.module:=:'adherent')"
string $properties

Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool $pagination_data

If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Return Value

array

Array of order objects

Exceptions

RestException
RestException

at line 308
int post(array $request_data = null)

Create an email template

Example: {"module":"adherent","type_template":"member","active": 1,"label":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"label":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

array $request_data

Request data

Return Value

int

ID of email template

Exceptions

RestException
RestException
RestException

at line 361
object putById(int $id, array $request_data = null)

Update an email template

Example: {"module":"adherent","type_template":"member","active": 1,"label":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"label":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

int $id

Id of order to update
array $request_data Data

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException
RestException
RestException

at line 416
object putbyLabel(string $label, array $request_data = null)

Update an email template

Example: {"module":"adherent","type_template":"member","active": 1,"label":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"label":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

string $label

Label of order to update
array $request_data Data

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException
RestException