Funkcje

Funkcje SAREscript

Przyjęto następująca konwencję opisu funkcji. Przed nazwą funkcji podany jest rodzaj zwracanej wartości przez funkcję. Jeżeli funkcja nie zwraca żadnych danych, oznaczono to słowem void. Jeżeli wynik funkcji może zwrócić wynik różnego typu oznaczono to słowem mixed. W nawiasie umieszczono rodzaj wymaganych parametrów. Parametry opcjonalne ujęte są w nawiasy kwadratowe. Funkcje będące dokładnymi odpowiednikami funkcji PHP.
Niektóre funkcje, szczególnie statystyczne, wymagają operowania na konkretnych adresach e-mail będących w bazie. Z tego powodu nie będą działały poprawnie w niektórych miejscach systemu, gdzie nie można ustalić adresu, lub nie znajduje się on w bazie. Przy opisie takiej funkcji znajdzie się uwaga “wymaga adresu”.

Funkcje przetwarzające teksty

lastchar – zwraca ostatni znak łańcucha

str_pad – uzupełnia łańcuch do długości znaków

str_split – dzieli łańcuch na części

str_repeat – powtarza łańcuch określoną liczbę razy

strtolower – zamienia wielkie litery na małe

substr – zwraca określony fragment łańcucha

substr_count – sprawdza liczbę wystąpień jednego łańcucha w drugim

trim – usuwa białe znaki z początku i końca łańcucha

Funkcje matematyczne i operujące na zmiennych

array_search – wyszukuje w tablicy wartość

count – zwraca liczbę elementów tablicy

current – zwraca wartość bieżącego elementu tablicy

empty – sprawdza czy argument jest “pusty”

explode – zwraca tablicę zawierającą podzielony łańcuch

in_array – sprawdza czy w tablicy znajduje się określona wartość

intval – zamienia argument na liczbę całkowitą

key – zwraca klucz bieżącego elementu tablicy

next – przesuwa wskaźnik tablicy na kolejny element i zwraca jego wartoś

not – neguje argument

ok – zawsze zwraca true

rand – zwraca losową liczbę z określonego przedziału

Funkcje czasu i daty

date – zwraca odpowiednio sformatowana datę

time – zwraca aktualny uniksowy znacznik czasu

Funkcje wpływające na zachowanie się SARE

system_setfrom – ustawia pole From podczas wysyłki newslettera

system_skipmessage – pomija wysyłkę newslettera na bieżący adres

system_setsubject – ustawia pole Subject podczas wysyłki newslettera

Funkcje operujące na danych z bazy i zewnętrznych

bigregistry_get – zwraca zawartość rejestru typu BIG

bigregistry_set – zapisuje wartość do rejestru typu BIG

bigregistry_unset – usuwa rejestr typu BIG

get_url – pobiera treść znajdującą się pod wskazanym adresem URL

get_val – zwraca dane skojarzone z bieżącym adresem e-mail

registry_get – zwraca zawartość rejestru

registry_set – zapisuje wartość do rejestru

registry_unset – usuwa rejestr

set_val – zapisuje do bazy dane skojarzone z bieżącym adresem e-mail

Funkcje operujące na danych statystycznych (raporty)

campaign_clicked – zwraca liczbę klikniętych wiadomości podczas wskazanej kampanii dla bieżącego adresu e-mail

campaign_ctr – zwraca wskaźnik CTR dla wskazanej kampanii, dla bieżącego adresu e-mail

campaign_mailings – zwraca tablicę numerów wysyłek w danej kampanii

campaign_name – zwraca nazwę dla wskazanej kampanii

campaign_opened – zwraca liczbę otwartych wiadomości podczas wskazanej kampanii dla bieżącego adresu e-mail

campaign_openrate – zwraca wskaźnik Openrate dla wskazanej kampanii, dla bieżącego adresu e-mail

campaign_sent – zwraca liczbę maili jaką wysłano na bieżący adres e-mail podczas wskazanej kampanii

campaign_total_clicked – zwraca łączną liczbę kliknięć podczas wskazanej kampanii

campaign_total_ctr – zwraca wskaźnik CTR dla wskazanej kampanii

campaign_total_opened – zwraca wskaźnik Openrate dla wskazanej kampanii

campaign_total_openrate – zwraca liczbę otwartych wiadomości podczas wskazanej kampanii

campaign_total_sent – zwraca liczbę maili wysłaną podczas wskazanej kampanii

mailing_bounced – informuje czy we wskazanej wysyłce dla bieżącego adresu e-mail zanotowano zwrot

mailing_bounced_status – zwraca kod “zwrotki” jaki zanotowano we wskazanych wysyłkach dla bieżącego adresu e-mail

mailing_clicked – informuje czy we wskazanej wysyłce dla bieżącego adresu e-mail zanotowano kliknięcie

mailing_clicked_link – informuje czy we wskazanej wysyłce dla wskazanego linka, dla bieżącego adresu e-mail zanotowano kliknięcie

mailing_opened – informuje czy we wskazanej wysyłce dla bieżącego adresu e-mail zanotowano otwarcie maila

mailing_planned_count – zwraca liczbę zaplanowanych wysyłek dla bieżącego adresu e-mail

mailing_sent – informuje czy podczas wskazanej wysyłki został wysłany e-mail dla bieżącego adresu e-mail

mailing_sent_count – zwraca liczbę wysłanych e-mail na bieżący adres e-mail w określonym czasie

mailing_total_clicked – zwraca liczbę klikniętych wiadomości e-mail podczas wskazanej wysyłki

mailing_total_ctr – zwraca wskaźnik CTR dla wskazanej wysyłki

mailing_total_opened – zwraca liczbę otwartych wiadomości e-mail podczas wskazanej wysyłki

mailing_total_openrate – zwraca wskaźnik openrate dla wskazanej wysyłki

mailing_total_sent – zwraca liczbę wysłanych wiadomości e-mail podczas wskazanej wysyłki

sms_received – informuje czy podczas wskazanej wysyłki SMS, dla bieżącego adresu e-mail, zanotowano odebranie SMSa.

sms_sent – informuje czy podczas wskazanej wysyłki SMS, dla bieżącego adresu e-mail, wysłano SMSa.

Funkcje wyjścia

barcode_ean13 – osadza w treści wiadomości znacznik HTML odpowiedzialny za wyświetlenie kodu kreskowego EAN13

print – osadza w treści wiadomości (lub wyświetla jako wynik działania) łańcuch wskazany jako argument

print_r – osadza w treści wiadomości (lub wyświetla jako wynik działania) wartość przekazanej zmiennej w czytelnej postaci

Funkcje związane z newsletterem

mailing_info_get – zwraca tablicę z informacjami o wskazanej wysyłce

mailing_send – przeprowadza wysyłkę mailingu

mailing_send_test – przeprowadza testową wysyłkę mailingu

newsletter_create – tworzy w systemie nową kreację newslettera

Funkcje specjalne

pl_imiewolacz – zwraca formę wołaczową przekazanego imienia

pl_kody – oblicza odległość pomiędzy dwoma miejscowościami na podstawie kodów pocztowych

pl_slownie – przetwarza liczbę na zapis słowny

sare_groups – zwraca tablicę zawierającą numery grup do których należy bieżący adres e-mail

sare_in_group – zwraca informację, czy bieżący adres e-mail należy do wskazanej grupy

mailing_bounced – informuje czy we wskazanej wysyłce dla bieżącego adresu e-mail zanotowano zwrot



Jak możemy Ci pomóc?