Dostępne filtry

Tablice

W skład tych filtrów wchodzą:

First Randomize
Last Join
Skip Map
Take Size
Sort Uniq
Reverse

 

Tekstowe

W skład tych filtrów wchodzą:

Format Size
Append Slice
Prepend Split
Capitalize StripHtml
Downcase StripNewlines
Upcase NewlineToBr
Remove Truncate
RemoveFirst TruncateWords
Replace Times
ReplaceFirst

 

Liczbowe, Matematyczne

W skład tych filtrów wchodzą:

Plus Normalize
Minus Floor
Times Ceil
DividedBy Abs
Modulo Round

 

Data i czas

W skład tych filtrów wchodzą:

Date

 

Cena

W skład tych filtrów wchodzą:

ToPrice

 

HTML

Filtry, które po zastosowaniu zwracają gotowe fragmenty kodów HTML do wykorzystania na stronie.

W skład tych filtrów wchodzą:

A Img2
Img

 

Pozostałe

W skład tych filtrów wchodzą:

H ToInt
Escape ToNum
EscapeUri ToTimeSpan
UnEscapeUri DEBUG
ToString

 



 

Opis dostępnych filtrów:

 

First
Pobiera pierwszy element z tablicy.

Zwracany typ: zależny co przechowuje tablica.

 


 

Last
Pobiera ostatni element z tablicy.

Zwracany typ: zależny co przechowuje tablica.

 


 

Skip
Zwraca tablicę, która nie zawiera początkowych elementów z tablicy wejściowej. Omija określoną liczbę elementów. Liczba elementów do ominięcia jest przekazywana w parametrze.

Parametry: int.
Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 
Powyższy przykład zwróci:

 


 

Take
Zwraca tablicę, która zawiera tylko określoną liczbę początkowych elementów z tablicy wejściowej.

Parametry: int.
Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 
Powyższy przykład zwróci:

 


 

Sort
Sortuje elementy w tablicy według przekazanego argumentu. Argument powinien być właściwością kolekcji elementów tablicy wejściowej.

Parametry: string.
Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 


 

Reverse
Odwraca kolejność elementów w tablicy.

Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 
Powyższy przykład zwróci:

 


 

Randomize
Zwraca tablicę, w której kolejność elementów jest ustawiona w sposób losowy.

Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 
Powyższy przykład może zwrócić:

 
Kolejny przykład

 


 

Join
Łączy elementy tablicy w ciąg znaków wstawiając pomiędzy elementy przekazany parametr.

Parametry: string.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Map
Zwraca tablicę składającą się z wartości elementów kolekcji wejściowej dla wskazanej właściwości przez przekazany argument.

Parametry: string.
Zwracany typ: tablica elementów typu wskazanej właściwości.

 
Powyższy przykład może zwrócić:

 
Kolejny przykład

 
Powyższy przykład może zwrócić:

 


 

Size
Zwraca liczbę elementów w tablicy.

Zwracany typ: int.

 


 

Uniq
Zwraca tablicę unikatowych elementów. Tablica ta nie zawiera duplikatów.

Zwracany typ: tablica elementów typu zdefiniowanego w tablicy wejściowej.

 
Powyższy przykład zwróci:

 


 

Format
Formatuje tekst zgodnie z wartościami przekazanymi w poszczególnych parametrach.

Parametry: object p1, object p2 = null, object p3 = null, object p4 = null, object p5 = null, object p6 = null, object p7 = null, object p8 = null, object p9 = null, object p10 = null.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Append
Dodaje tekst przekazany przez argument na koniec tekstu wejściowego.
Jeżeli tekst wejściowy == null to filtr zwróci null.

Parametry: string.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Prepend
Dodaje tekst przekazany przez argument na początek tekstu wejściowego.
Jeżeli tekst wejściowy == null to filtr zwróci null.

Parametry: string.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Capitalize
Konwertuje tekst tak, aby każde słowo w tekście zaczynało się z dużej litery.

Zwracany typ: string.

 


 

Downcase
Konwertuje tekst tak, aby cały tekst (każda litera) był napisany małymi literami.

Zwracany typ: string.

 


 

Upcase
Konwertuje tekst tak, aby cały tekst (każda litera) był napisany wielkimi literami.

Zwracany typ: string.

 


 

Remove
Usuwa z tekstu wejściowego fragment tekstu przekazanego przez parametr.

Parametry: string.
Zwracany typ: string.

 


 

RemoveFirst
Usuwa z tekstu wejściowego pierwsze wystąpienie fragmentu tekstu przekazanego przez parametr.

Parametry: string.
Zwracany typ: string.

 


 

Replace
Zamienia w tekście wejściowym szukany fragment tekstu innym tekstem (tekst zamienny). Szukany fragment tekstu oraz tekst zamienny przekazywane są przez parametry. Parametry przyjmują wyrażenia regularne.
Jeśli chcemy wyszukać znak specjalny i użyć go jak znaku, a nie części wyrażenia regularnego, należy go poprzedzić ukośnikiem \.

Parametry: string, string = „”.
Zwracany typ: string.

 


 

ReplaceFirst
Zamienia w tekście wejściowym pierwsze wystąpienie szukanego fragmentu tekstu innym tekstem (tekst zamienny). Szukany fragment tekstuoraz tekst zamienny przekazywane są przez parametry. Parametry przyjmują wyrażenia regularne.
Jeśli chcemy wyszukać znak specjalny i użyć go jak znaku, a nie części wyrażenia regularnego, należy go poprzedzić ukośnikiem \.

Parametry: string, string = „”.
Zwracany typ: string.

 


 

Size
Zwraca długość tekstu – liczba znaków w tekście.

Zwracany typ: int.

 
Kolejny przykład

 


 

Slice
Zwraca fragment z tekstu wejściowego dla podanej pozycji początkowej oraz długości. Pozycja początkowa oraz długość przekazywane są przez parametry.
W przypadku, gdy parametr z pozycją początkową jest ujemny to pozycja początkowa liczona jest od od końca tekstu.

Uwaga
Znaki w tekście numerowane są od 0. Należy uwzględnić to przy określaniu pozycji początkowej.

Parametry: int, int = 1.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Split
Tworzy z tekstu wejściowego tablicę, w której każdy element stanowi fragment tekstu rozdzielony przez podany wzorzec. Wzorzec przekazany przez parametr.

Parametry: string.
Zwracany typ: string[].

 
Powyższy przykład zwróci:

 


 

StripHtml
Usuwa wszystkie tagi HTML z tekstu wejściowego.

Zwracany typ: string.

 


 

StripNewlines
Usuwa wszystkie znaki nowej linii (podziały wiersza) z tekstu wejściowego.

Zwracany typ: string.

 


 

NewlineToBr
Wstawia tag HTML przed każdym znakiem nowej linii w tekście wejściowym.

Zwracany typ: string.

 


 

Truncate
Obcina tekst wejściowy do podanej liczby znaków dodając na końcu tekst obcinający. Liczba znaków oraz tekst obcinający przekazywane są przez parametry. Tekst obcinający wliczony jest w liczbę znaków.

Parametry: int = 50, string = „…”.
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

TruncateWords
Obcina tekst wejściowy do podanej liczby wyrazów dodając na końcu tekst obcinający. Liczba wyrazów oraz tekst obcinający przekazywane są przez parametry.

Parametry: int 15, string = „…”
Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Times
Powtarza tekst wielokrotnie. Liczba powtórzeń przekazywana przez parametr.

Parametry: int.
Zwracany typ: string.

 


 

Plus
Dodawanie.

Parametry: int/decimal.
Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

Uwaga
Jeśli filtr Plus wywołany zostanie na elemencie wejściowym typu string to działanie będzie podobne do użycia filtru Append.

 


 

Minus
Odejmowanie.

Parametry: int/decimal.
Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

 


 

Times
Mnożenie.

Parametry: int/decimal.
Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

 


 

DividedBy
Dzielenie.

Parametry: int/decimal.
Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

 


 

Modulo
Reszta z dzielenia.

Parametry: int/decimal.
Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

 


 

Normalize
Formatuje liczbę wejściową usuwając jej „zbędne” zera w części ułamkowej.

Typ liczby wejściowej: decimal.
Zwracany typ: decimal.

 
Powyższy przykład może zwrócić:

 


 

Floor
Zwraca największą liczbę całkowitą, która jest mniejsza lub równa wejściowej.

Typ liczby wejściowej: decimal.
Zwracany typ: int.

 
Powyższy przykład zwróci:

 


 

Ceil
Zwraca najmniejszą liczbę całkowitą, która jest większa lub równa wejściowej.

Typ liczby wejściowej: decimal.
Zwracany typ: int.

 
Powyższy przykład zwróci:

 


 

Abs
Zwraca wartość bezwzględną z liczby.

 
Powyższy przykład może zwrócić:
 


 

Round
Zaokrągla liczbę wejściową do określonej ilości miejsc po przecinku.

Zwracany typ: taki sam jak element wejściowy, na którym wywołany jest filtr.

 
Powyższy przykład zwróci:

 


 

Date
Formatuje datę i czas. Zwraca datę i czas zgodnie z formatem przekazanym w parametrze.

Wskazówka
Filtr Date w sklepie korzysta z domyślnych ustawień dla DotLiquid. Należy korzystać z formatu daty zgodnego z konwencją .NET dostępnym pod linkiem:
https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.100).aspx

Parametry: string.
Zwracany typ: string.

 
Powyższy przykład może zwrócić:

 


 

ToPrice
Formatuje cenę do formatu wyświetlania zgodnego z kulturą dla ustawionej lokalizacji sklepu (grupowanie tysięcy, kropka czy przecinek, itd.).
Lokalizacja sklepu określa, czy sklep został zainstalowany domyślnie na rynek polski, niemiecki, itd.

Zwracany typ: string.

 
Powyższy przykład może zwrócić:

 


 

A
Tworzy tag <a>wraz z atrybutami. Wartości dla atrybutów tagu pobierane są z elementu wejściowego.

Typ elementu wejściowego: obiekt Liquid.
Zwracany typ: string.

Filtr ma zastosowanie dla obiektów:

  • Strona
  • Grupa towarowa
  • Towar
  • Blog
  • Tagi

Przykład użycia filtra A dla obiektów: Strona

 
Powyższy przykład może zwrócić:

 
Przykład użycia filtra A dla obiektów: Towar

 
Powyższy przykład może zwrócić:

 
Przykład użycia filtra A dla obiektów: Blog, Tags

 
Powyższy przykład może zwrócić:

 


 

Img

Tworzy tag <img>wraz z atrybutami. Wartości dla atrybutów tagu pobierane są z elementu wejściowego lub mogą być przekazywane przez parametry.

Uwaga
Tag <img> domyślnie ustawiony ma link do obrazka w atrybucie data-src. Należy zastosować funkcję skryptową, która przepisze wartość z atrybutu data-src do atrybutu src (lazy load).

Typ elementu wejściowego: obiekt Liquid, string.
Parametry: string size = „small”, string alt = null, string title = null.
Zwracany typ: string.

Dostępne wartości dla parametru size:
 

Parametr size Rozmiar zdjęcia (dłuższa krawędź) w px
img 0
pico 16
icon 32
thumb 50
small 100
compact 160
medium 240
large 480
grande 600
master 1920

Filtr ma zastosowanie dla obiektów:

  • Towar
  • Zdjęcia towaru (na szczegółach towaru)
  • Producent
  • Marka
  • Blog (w obiekcie blog pomijany jest parametr size. Obrazki zwracane są zawsze w rozmiarze rzeczywistym).

Przykład użycia filtra Img dla obiektów: Towar, Zdjęcia towaru

 
Powyższy przykład może zwrócić:

 
Przykład użycia filtra Img dla obiektów: Producent, Marka

 
Powyższy przykład może zwrócić:

 
Przykład użycia filtra Img dla obiektów: Blog

 
Powyższy przykład może zwrócić:

 
Przykład użycia filtra Img dla tekstu z linkiem do obrazka

 
Powyższy przykład może zwrócić

 


 

Img2
Filtr Img2 zachowuje się w podobny sposób jak wyżej opisany filtr Img. Różnicą jest to, że utworzony tag <img> ma link do obrazka nie w atrybucie data-src, lecz w atrybucie data-lazy. Dodatkowo filtr Img2 pozwala na dodanie czwartego parametru raw, w którym można wpisać wszystko, np. class=”example_class” i znajdzie się to wewnątrz tagu <img>.

Typ elementu wejściowego: obiekt Liquid, string.
Parametry: string size = „small”, string raw = null, string alt = null, string title = null.
Zwracany typ: string.
 
Przykład użycia filtra Img2 na szczegółach towaru:

 
Powyższy przykład może zwrócić:

 


 

H
Zamienia znaki specjalne na encje HTML (HTMLEncode).

Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

Escape
Alias dla filtra H.
 

 

EscapeUri
Zamienia znaki spoza zakresu ASCII na format zgodny z ASCII.

Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

UnEscapeUri
Filtr przeciwstawny do filtra EscapeUri.

Zwracany typ: string.
 


 

ToString
Konwertuje element wejściowy do typu string.

Zwracany typ: string.

 
Powyższy przykład zwróci:

 


 

ToInt
Konwertuje element wejściowy do typu int.

Zwracany typ: int.

 
Powyższy przykład zwróci:

 


 

ToNum
Konwertuje element wejściowy zgodnie z formatem dla kultury Invariant (zapewnia zawsze taki sam format). Liczby oraz daty wyświetlane są zgodnie z kulturą dla lokalizacji sklepu.

Zwracany typ: string.

 
Powyższy przykład może zwrócić:

 


 

ToTimeSpan
Konwertuje tekst do typu TimeSpan zgodnie z formatem dla kultury Invariant.

Zwracany typ: TimeSpan.

 


 

DEBUG
Wyświetla obiekty globalne i lokalne wraz z jego właściwościami oraz odpowiadającymi im wartościami.

Przykład wyświetlenia obiektu customer z filtrem DEBUG

 
Powyższy przykład może zwrócić:

 

Uwaga
Tryb debug dla obiektów dostępny jest tylko, gdy włączony jest parametr Podgląd stron w czasie rzeczywistym
 

 

Czy ten artykuł był pomocny?