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 oznaczono następującym symbolem : PHP

Funkcje podstawowe

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

strtoupper – zamienia małe litery na duże

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

substr – zwraca określony fragment łańcucha

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

ucfirst – Zamienia pierwszą literę stringa na wielką

strlen – Zwraca liczbę znaków z podanego parametru

strpos – Funkcja zwraca numeryczne stanowisko pierwszego wystąpienia szukanego znaku

Funkcje matematyczne i operujące na zmiennych

ok – zawsze zwraca true

not – neguje argument

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

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

isset – Funkcja sprawdza czy zmienna została utworzona

key – zwraca klucz bieżącego elementu tablicy

is_array – sprawdza czy podany parametr jest tablicą

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

array_search– wyszukuje w tablicy wartość

array_pop– Funkcja zwraca ostatnią wartość tablicy jednocześnie usuwając tę wartość z tablicy

array_reverse – Funkcja odwraca kolejność elementów w tablicy

array_merge_indexes – Funkcja zwraca posortowaną tablicę indeksów opisujących tablice wejściowe

array_merge_values – Funkcja zwraca posortowaną tablicę wartości tablic wejściowych.

empty – sprawdza czy argument jest “pusty”

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

serialize – Funkcja generuje z przekazanego parametru postać do zapisu

unserialize – Funkcja przywraca dane wygenerowane przez funkcje serialize

base64_decode – Funkcja dekoduje dane zakodowane algorytmem MIME base64

base64_encode – Koduje podany ciąg danych algorytmem MIME base64

md5 – Funkcja zwraca 32 znakowy skrót MD5 dla wartości podanego parametru

urlencode – Funkcja zakoduje podany parametr tak by można było go bezpiecznie użyć jako część adresu

urldecode – Funkcja odkoduje parametr w którym zawartość jest zakodowana za pomocą urlencode

json_decode – Funkcja dekoduje łańcuch JSON

json_encode – Funkcja konwertuje parametr do formatu typu JSON

sort – Funkcja sortuje wartości od najmniejszej do największej

rsort – Funkcja sortuje wartości od największej do najmniejszej

asort – Funkcja sortuje parametr(tablicę) w kierunku od najmniejszej do największej wartości zachowując klucze zespolone z wartościami

arsort – Funkcja sortuje tablice w kierunku od największej do najmniejszej wartości zachowując klucze zespolone z wartościami

unset – Funkcja usuwa zmienną

min – Funkcja zwraca najmniejszą wartość z podanych parametrów

max – Funkcja zwraca największą wartość z podanych parametrów

iconv – Funkcja konwertuje $lancuch do nowego kodowania znaków.

count – zwraca liczbę elementów tablicy

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

intval – zamienia argument na liczbę całkowitą

Funkcje czasu i daty

date – zwraca odpowiednio sformatowana datę

time – zwraca aktualny uniksowy znacznik czasu

strtotime – Parsuje większość angielskich tekstowych opisów daty i czasu do uniksowego znacznika czasu

mktime – Oblicza uniksowy znacznik czasu dla podanej daty

passed_today – sprawdza czy od daty przekazanej jako pierwszy parametr, a daty przekazanej jako 3 parametr, minęło tyle czasu ile podano w parametrze drugim

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

exit – Zatrzymuje wykonywanie dalszej części skryptu

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

registry_get – zwraca zawartość rejestru

registry_set – zapisuje wartość do rejestru

registry_unset – usuwa rejestr

registry_append – Funkcja dokleja podaną wartość do rejestru o podanej nazwie

bigregistry_get – zwraca zawartość rejestru typu BIG

bigregistry_set – zapisuje wartość do rejestru typu BIG

bigregistry_unset – usuwa rejestr typu BIG

bigregistry_append – Funkcja dokleja podaną wartość do rejestru typu BIG o podanej nazwie

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

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

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

Funkcje operujące na danych statystycznych

Kampanie

campaign_all – zwraca informacje o statusach dla wszystkich adresów, które brały udział w wybranej kampanii

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

campaign_domains – zwraca tablicę, zawierającą dane dotyczące liczby wysłanych, zwrotów, otwarć, kliknięć i wypisań z poszczególnych domen dla kampanii

campaign_geoip – zwraca dane dotyczące geolokalizacji otwarć mailingu dla kampanii

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

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

campaign_total_opened – zwraca wskaźnik Openrate dla wskazanej kampanii

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

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

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

campaign_total_ctr – zwraca wskaźnik CTR dla wskazanej kampanii

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

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

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

campaign_distribution – Funkcja zwraca dane dotyczące liczby wysłanych, odebranych maili oraz liczby kliknięć, wypisów i zwrotów z podanej wysyłki

campaign_name – zwraca nazwę dla wskazanej kampanii

campaign_links – Funkcja zwraca tablice z informacjami dotyczącymi linków w podanej kampanii

campaign_tags – Funkcja zwraca tablice ze wszystkimi nazwami tagów oraz ilością kliknięć w dany tag w linku ze wszystkich wysyłek uczestniczących w podanej kampanii

campaign_list – Funkcja zwraca tablice z danymi o wszystkich kampaniach(nr kampanii oraz nazwa kampanii).

campaign_timeline_opened_day – Funkcja zwraca dane o ilości otwarć w określonych dniach podczas kampanii

campaign_timeline_opened_week – Funkcja zwraca dane o ilości otwarć w określonych dniach tygodnia podczas kampanii

campaign_timeline_clicked_hour – Funkcja zwraca dane o ilości kliknięć w określonych godzinach podczas kampanii

campaign_timeline_clicked_day – Funkcja zwraca dane o ilości kliknięć w określonych dniach podczas kampanii

campaign_timeline_clicked_hour – Funkcja zwraca dane o ilości kliknięć w określonych dniach tygodnia podczas kampanii

campaign_total_bounced – zwraca całkowitą ilość zwrotów dla podanego jako parametr numeru kampanii

campaign_total_opted_out – zwraca ilość adresów, które wypisały się podczas wybranej kampanii

Mailing

bind_email – Ustawia kontekst adresu email jako bieżący

bind_hash – ustawia kontekst zahashowanego adresu email jako bieżący

mailing_all – Funkcja zwraca informacje o statusach dla wszystkich adresów które brały udział w wysyłce

mailing_info_get – Funkcja zwraca tablicę zawierająca ogólne informacje o przeprowadzonej wysyłce

mailing_info_count – Funkcja zwraca tablicę z informacjami o ilości wysłanych i zaplanowanych maili do wysłania w trakcie danej wysyłki

mailing_planed_count – Funkcja zwraca liczbę wszystkich maili zaplanowanych do wysyłki na bieżący adres e-mail

mailing_distribution – Funkcja zwraca dane dotyczące liczby wysłanych, odebranych maili oraz liczby kliknięć, wypisów i zwrotów z podanej wysyłki

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

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

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

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

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_total_bounced – zwraca dane o ilości zwrotów dla wybranych wysyłek

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

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

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

mailing_send – Funkcja przeprowadza wysyłkę mailigu

mailing_send_test – Funkcja przeprowadza wysyłkę testową na adres $email_testowy

mailing_comment_set – Funkcja zapisuje podaną treść jako komentarz dla danej wysyłki

mailing_comment_get – Funkcja pobiera komentarz zapisany dla danej wysyłki

mailing_comment_append – Funkcja dodaje podaną treść do istniejącego komentarza dla danej wysyłki

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

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

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

mailing_total_opted_out – zwraca ilość adresów które wypisały się podczas wybranych wysyłek

mailing_tags_clicked – zwraca tablice z listą wszystkich tagów w mailingu oraz informacją, czy został kliknięty konkretny tag w linku przez konkretny adres email

mailing_agent – zwraca dane dotyczące liczby otwarć, kliknięć przez poszczególne przeglądarki, systemy operacyjne dla wysyłki

mailing_geoip – zwraca dane dotyczące geolokalizacja otwarć, kliknięć mailingu dla wysyłki

mailing_links – zwraca informacje o linkach użytych w kreacjach wysłanych w podanych wysyłkach

mailing_open_reach – zwraca wskaźnik (liczba od 0 do 1) otwarć do doręczonych mail z wybranych wysyłek

mailing_tags – zwraca dane dotyczące tagów w linkach powiązanych z liczbą kliknięć we wszystkie linki mające ten sam tag

mailing_domains – zwraca dane dotyczące domyślnie liczby wysłanych, zwrotów, otwarć,kliknięć i wypisań z poszczególnych domen dla wysyłki

mailings_id – zwraca numery wysyłek z podanego zakresu czasu

t_mailings_id – zwraca numery wysyłek maili transakcyjnych z podanego zakresu czasu

t_mailing_info_get – zwraca tablicę zawierająca ogólne informacje o przeprowadzonej wysyłce transakcyjnej

mailing_timeline_clicked_day – zwraca dane o ilości kliknięć w określonych dniach dla wybranych wysyłek

mailing_timeline_clicked_hour – zwraca dane o ilości kliknięć w określonych godzinach dla wybranych wysyłek

mailing_timeline_opened_day – zwraca dane o ilości otwarć w określonych dniach dla wybranych wysyłek

mailing_timeline_clicked_week – zwraca dane o ilości kliknięć w określonych dniach tygodnia dla wybranych wysyłek

mailing_timeline_opened_hour – zwraca dane o ilości kliknięć w określonych godzinach dla wybranych wysyłek

mailing_timeline_opened_week – zwraca dane o ilości otwarć w określonych dniach tygodnia dla wybranych wysyłek

Sms

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

sms_info_get – Funkcja zwraca tablicę zawierająca ogólne informacje o przeprowadzonej (lub zaplanowanej) wysyłce

sms_info_count – Funkcja zwraca tablicę z informacjami o ilości wysłanych i zaplanowanych smsów do wysłania

sms_campaign_name – Funkcja zwraca nazwę kampanii na podstawie podanego parametru

sms_allowed_senders – Funkcja zwraca listę wszystkich dodanych nadpisów nadawców sms, których można użyć w wiadomościach pro

Grupy

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

sare_group_add – Funkcja dodaje bieżący adres do grupy.

sare_group_remove – Funkcja usuwa bieżący adres z grupy.

sare_group_copy – kopiuje adresy z grupy X do grupy Y

sare_group_info – zwraca tablicę zawierającą informacje o grupie

 

Funkcje specjalne

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

sare_property – zwraca tablicę cech stworzonych w systemie wraz z informacją o ich właściwościach

Funkcje dodatkowe

find_by_gsm – adresy z bazy które posiadają podany numer telefonu

get_request – zwraca parametry przekazane jako żądanie HTTP

get_request_agent – zwraca dane o przeglądarce, systemie operacyjnym użytkownika oraz urządzeniu

get_request_ip – zwraca adres IP urządzenia użytkownika

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

redirect – ustawia przekierowanie na podany url

zipcode_info_get – Funkcja zwraca tablicę z informacjami na temat miasta oraz województwa na podstawie podanego kodu pocztowego

zipcode_distance – Funkcja oblicza odległość pomiędzy kodem/kodami pocztowymi

survey_report_get – zwraca raport z ankiety o identyfikatorze $surveyId w formacie csv

Możliwość komentowania jest wyłączona.