_shop->getProducts - grąžina prekių sąrašą.
Parametras | Tipas | Butinas | Komentras |
category_id ar scheme_id | id | * | Kategorija (masyvas) ar shema, iš kurios turi būti grąžintos prekės |
currency | string |
| Valiuta, kuria turi būti nurodytos prekių kainos, jeigu jos yra ištraukiamos |
full_info | true¦false |
| nurodo ar informacija apie prekes turi būti išplėsta. Pagal nutylėjimą false. Pilna informacija yra ištraukiama tik kai nurodytas scheme_id. |
flag1 | true¦false |
| Ištraukia tik prekes su nustatytu parametru "Akcija 1" |
flag2 | true¦false |
| Ištraukia tik prekes su nustatytu parametru "Akcija 2" |
flag3 | true¦false |
| Ištraukia tik prekes su nustatytu parametru "Akcija 3" |
order | string |
| Lauko pavadinimas, pagal kurį surūšiuoja prekių sąrašą. Pagal nutylėjimą prekės išvedamos nesurūšiuotos |
order_dir | asc¦desc |
| Rūšiavimo tvarka: asc - didėjanti, desc - mažėjanti |
limit | skaičius |
| išvedamų eilučių kiekis. Gali būti nurodytas su paslinkimu: "paslinkimas, kiekis". Pvz., "30,10". |
count_only | true¦false |
| Jeigu nustatytas true, metodas grąžina tik prekių skaičių pagal nurodytus parametrus. |
keywords
| string
|
| Raktinių žodžių sąrašas atskirtu tarpeliais. Gali būti naudojama prekių paieškai
|
cart_id | id |
| Skirtas atvejams kai vartotojas turi kelis krepšelius. Nurodžius krepšelio id bus gražintos tik jam priklausančios prekės. |
page_nr
| skaičius
|
| Jeigu nenurodomas limit parametras, galima nurodyti page_nr parametrą kuris reikš kuri iš puslapių išvesti. Aktualu tik kai nurodytas page_size parametras, arba nustatytas elementų skaičius turinio valdymo shopgoods1 modulyje
|
page_size
| skaičius |
| Jeigu nenurodomas limit parametras, galima nurodyti page_size parametrą kuris reikš kiek elementų bus suskirstoma puslapyje. Aktualu kai nurodomas page_nr parametras.
|
modifications
| both, only, none
|
| Nurodo ar gražinamuose rezultatuose išvesti ir modifikacijas (both), išvesti tik modifikacijas (only) arba tik pagrindines prekes (none) - pagal nutylėjima. Nuo versijos 2.4
|
_shop->getPaging - grąžina standartinį puslapiavimo objektą pagal paskutinįjį _shop->getProducts iškvietimą.
_shop->getModifications - grąžina produkto modifikacijų sąrašą. (Nuo versijos 2.4)
|
Parametras | Tipas | Butinas | Komentras |
product_id | id | * | Prekės ID kurios modifikacijos turi būti grąžintos
|
_shop->getProduct - grąžina pilną informaciją apie konkretų produktą.
Parametras | Tipas | Butinas | Komentras |
product_id | id | * | Prekės kurios informacija turi būti grąžinta id. |
scheme_id | id |
| Prekės šablono id. Leidžia optimizuoti rezultatų išvedimą. |
_shop->getProductCount - žr. grąžina prekių kiekį pagal nurodytus parametrus, žr. _shop->getProducts.
_shop->getCategoriesByScheme - grąžina prekių kategorijų sąrašą pagal šablono id.
Parametras | Būtinas | Tipas | Komentaras |
scheme_id | * | id | šablono id |
_shop->getSubCategories - grąžina prekių kategorijų sąrašą.
Parametras | Tipas | Butinas | Komentras |
parent_id | id |
| Grąžina tik nurodytos kategorijos subkategorijas. |
show_disabled | true¦false |
| Išvesti tik išjungtas, arba tik įjungtas kategorijas |
order |
|
| Rūšiavimo parametras. Pagal nutylėjimą rūšiuoja pagal order_id. |
order_dir | asc¦desc |
| Rūšiavimo tvarka. Pagal nutylėjimą "asc" |
lang_id | string |
| Nurodo kokia kalba išvesti kategorijų pavadinimus |
_shop->getSubCategoriesIds - grąžina visų žemiau esančių kategorijų id sąrašą.
Parametras | Tipas | Butinas | Komentras |
category_id | id |
| ID kategorijos, kurios subkategorijų sąrašą reikia grąžinti |
_shop->setFilter - nustato filtrą metodui _shop->getProducts. Veikia tik tuomet, kai _shop->getProducts parametras full_info=1.
Parametras | Tipas | Butinas | Komentras |
is | equal¦more¦less¦part¦sql|not | * | Filtro tipas. Nustato ar laukų reikšmės turi būti lygios, didesnės, mažesnės, atitikti fragmentų arba SQL uzklausai. "not" reikšmė yra nuo versijos 2.5
|
lauko_pavadinimas | string|array |
| Nustatoma filtro reikšmė. Keli variantai atskiriami simboliu "¦" arba perduodamas masyvas
|
Pvz. {_shop->setFilter is=equal name="Sony" model="Vaio"} - nustato filtrą, pagal kurį rezultatai turi turėti pavadinimą Sony ir modelį Vaio
{_shop->setFilter is=more year="1980"} - nustato filtrą, pagal kurį rezultatuose metų reikšmė bus didesnė už 1980.
{_shop->setFilter is=less price="10"} - nustato filtrą, pagal kurį rezultatuose kaina bus mažesne už 10.
{_shop->setFilter is=part description="super"} - nustato filtrą, pagal kurį rezultatuose aprašyme yra žodis "super".
{_shop->setFilter is=sql where="name_lt='Vardenis' AND surname_lt='Pavardenis'"} - nustato filtrą, pagal kurį rezultatuose vardas yra "Vardenis" ir pavardė "Pavardenis".
_shop->resetFilter - atšaukia filtravimą.
_shop->getCategory - grąžina informaciją apie kategoriją.
Parametras | Būtinas | Tipas | Komentaras |
id | * | id | Kategorijos id |
lang_id |
| skaičius | Nurodo, kokia kalba grąžinti kategorijos pavadinimą |
_shop->getCategoryPath - grąžina kategorijų kelią iki nurodytos kategorijos. Grąžina masyvą id.
Parametras | Būtinas | Tipas | Komentaras |
parent_id | * | skaičius | Nurodo, kurios kategorijos kelią grąžinti |
_shop->getCategoryPathFull - grąžina kategorijų kelią iki nurodytos kategorijos. Grąžina masyvą kategorijų duomenų.
Parametras | Būtinas | Tipas | Komentaras |
parent_id | * | skaičius | Nurodo, kurios kategorijos kelią grąžinti |
lang_id |
| kalbos kodas | Nustato, kurios kalbos kategorijų pavadinimus grąžinti. Jeigu nenurodyta, grąžina puslapio kalbos kategorijų pavadinimus |
_shop->getTemplates - grąžina naudojamų parduotuvėje prekių šablonų sąrašą.
_shop->getTemplate - grąžina pilną informaciją apie prekių šablono laukus.
Parametras | Būtinas | Tipas | Komentaras |
scheme_id | * | skaičius | Nurodo, kurio prekių šablono informaciją grąžinti |
index |
| true¦false | Suindeksuoti laukus pagal pavadinimą |
_shop->getTemplateIdByName - grąžina šablono id pagal jo pavadinimą (nuo versijos 2.2)
Parametras
| Būtinas | Tipas | Komentaras |
name
| *
| tekstas
| šablono pavadinimas
|
_shop->getCurrencies - gauti administratoriaus pasirinktas valiutas.
_shop->getCurrencyExchangeValues - grąžina bazinės valiutos keitimo kursus.
_shop->getDefaultCurrency - grąžina bazine sistemos valiutą (nuo versijos 2.5)
_shop->exchangeCurrency - grąžina sumą nurodyta valiuta (nuo versijos 2.5)
Parametras | Būtinas | Tipas | Komentaras |
value | * | string | Suma pradine valiuta
|
from_currency
| *
| string
| Pradinė valiuta
|
to_currency
| *
| string
| Valuta į kurią konvertuojama suma
|
_shop->setCurrency - nustatyti valiutą pagal nutylėjimą.
Parametras | Būtinas | Tipas | Komentaras |
currency | * | string | Kalbos kodas |
_shop->getCurrency - gauti pagal nutylėjima nustatytą valiutą.
_shop->getField - grąžina informaciją apie prekės šablono lauką.
Parametras | Būtinas | Tipas | Komentaras |
scheme_id | * | id | prekių šablono id |
field | * | string | Lauko pavadinimas |
_shop->getCarts - kuriama...
_shop->getProductPrice - apskaičiuoja nurodytam klientui prekės kainą.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | id | Prekės id, kuriai turi būti apskaičiuota kaina |
currency |
| string | Valiuta. Pagal nutylėjimą yra dabartinė vartotojo pasirinkta |
discount_group |
| string | Nuolaidos grupė, kuriai priskirtas klientas. Pagal nutylėjima apskaičiuojama dabartinė prisijungusio kliento grupė |
_shop->getProductTemplate - nurodytam prekių šablonui grąžina apdorotą atkiros prekės dizainą ("item"). Dizainas redaguojamas per Dizaino modulio Parduotuvės skyrelį. Kiekvienas prekių šablonas gali turėti savo atskiros prekės išvedimą. Turi būti nurodytas bent vienas iš šių parametrų: scheme_id, product_id, category_id, kitaip metodas grąžna -1. Jeigu nurodyta prekė arba kategorija neturi priskirto prekės šablono, metodas grąžina false. Neradus išvedimo šablono, grąžinamas kodas -1028.
Parametras | Būtinas | Tipas | Komentaras |
scheme_id |
| id | Prekės id, kuriai turi būti apskaičiuota kaina |
product_id |
| id | Valiuta. Pagal nutylėjimą yra dabartinė vartotojo pasirinkta |
category_id |
| id | Nuolaidos grupė, kuriai priskirtas klientas. Pagal nutylėjima apskaičiuojama dabartinė prisijungusio kliento grupė |
_shop->getProductListTemplate - nurodytam prekių šablonui grąžina apdorotą prekių sąrašo dizainą ("item"). Dizainas redaguojamas per Dizaino modulio Parduotuvės skyrelį. Kiekvienas prekių šablonas gali turėti savo atskiros prekės išvedimą. Turi būti nurodytas bent vienas iš šių parametrų: scheme_id, category_id, kitaip metodas grąžna -1. Jeigu nurodyta prekė arba kategorija neturi priskirto prekės šablono, metodas grąžina false. Neradus išvedimo šablono, grąžinamas kodas -1028
Parametras | Būtinas | Tipas | Komentaras |
scheme_id |
| id | Prekės kuriai turi būti apskaičiuota kaina id |
category_id |
| id | Nuolaidos grupė kuriai priskirtas klientas. Pagal nutylėjima apskaičiuojama dabartinė prisijungusio kliento grupė |
_shop->getProductVariants - grąžina prekės galimų variantų sąraša.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | id | Produkto id |
_shop->getProductVariant - grąžina prekės varianto sudedamasias dalis. Patogu tam, kad išvesti varianto pavadinimą krepšelyje esančios prekės
|
Parametras | Būtinas | Tipas | Komentaras |
variant_id | * | id | Produkto varianto id |
_shop->getVariantGroups - grąžina prekės šablono variantų grupių sąrašą.
Parametras | Būtinas | Tipas | Komentaras |
scheme_id | * | id | Kurio prekių šablono variantu grupes grąžint |
_shop->getVariantGroup - grąžina variantų grupės reikšmių sąrašą.
Parametras | Būtinas | Tipas | Komentaras |
variant_id | * | id | Kurios variantu grupės reikšmes grąžint |
_shop->getProductsTop - grąžina sąrašą perkamiausių produktų.
Parametras | Būtinas | Tipas | Komentaras |
product_id | Ne | skaičius | Jeigu yra nurodytas, skaičiuoja pirktų prekių kiekį kartu su nurodyta preke |
count | Ne | skaičius | Jeigu nurodytas apriboja ištraukiamų prekių kiekį. Rekomenduojama nurodinėti, nes prekių sąrašas gali būti labai didelis |
_shop->getCart - grąžina vartotojo krepšelio turinį. Jeigu vartotojas yra autorizuotas gražina krepšelį iš serverio. Jeigu neautorizuotas gražinamas sesijos krepšelis. parametrus žr. _shop->getSessionCart ir _shop->getStoredCart
_shop->getSessionCart - grąžina vartotojo sesijos krepšelį.
_shop->getStoredCart - grąžina vartotojo serverio krepšelį.
Parametras | Tipas | Butinas | Komentras |
cart_id | id |
| Skirtas atvejams kai vartotojas turi kelis krepšelius. Nurodžius krepšelio id bus gražintos tik jam priklausančios prekės. |
_shop->getCartValue - gražina užsakymo benrą kainą ir kainą su nuolaida
_shop->getBanksList - gražina sąrašą bankų paruoštu atsiskaitymui (iki versijos 2.1). Nuo versijos 2.1 naudokites
_payments objektu
_shop->getPaymentsList - gražina mokėjimų sąrašą (iki versijos 2.1). Nuo versijos 2.1 naudokites
_payments objektu _shop->getLogistics - grąžina sąraša pristatymo tiekėjų.
Parametras | Tipas | Butinas | Komentras |
id | id |
| Norint ištraukti konkretu pristatymo tiekėją. |
_shop->getLogisticZones - Pervežimo kompanijų regionų bei zonų sąrašas.
Parametras | Tipas | Butinas | Komentras |
logistic_id | id |
| Pervežimo kompanijos unikalus ID |
id | id |
| Zonos ID, tokiu atveju metodas grąžins įrašą apie regioną/zoną |
parent_id | id |
| Nurodo kurios zonos regionus ištraukti. Jeigu nenurodytas ištraukia pačių zonų sąrašą |
Pvz.
{_shop->getLogisticZones logistic_id=15 assign="zonu_sarasas"}
{_shop->getLogisticZones parent_id=zonu_sarasas[0] assign="pirmos_zonos_regionai"}
{_shop->getLogisticZones id=152 assign="zona"}
_shop->getLogisticRegions - Pervežimo kompanijų regionų sąrašas. (Nuo versijos 2.3)
Parametras | Tipas | Butinas | Komentras |
logistic_id | id |
| Pervežimo kompanijos unikalus ID |
id | id |
| Zonos ID, tokiu atveju metodas grąžins įrašą apie regioną/zoną |
Pvz.
{_shop->getLogisticRegions logistic_id=15 assign="zonos15_regionu_sarasas"}
{_shop->getLogisticRegions assign="visi_regionai"}
_shop->getLogisticPrices - Pervežimo kompanijų pristatymo kainos.
Parametras | Tipas | Butinas | Komentras |
logistic_id | id |
| Pasirinktos пervežimo kompanijos unikalus ID |
zone_id | id |
| Pasirinkto regiono unikalus ID |
weight_id | skaičius |
| Svorio identifikatorius
|
_shop->getLogisticWeights - Pervežimo kompanijų galimi transportavimo svoriai.
Parametras | Tipas | Butinas | Komentras |
logistic_id | id | * | Pervežimo kompanijos unikalus ID |
_shop->getDeliveryPrice - Pristatymo kaina.
Parametras | Tipas | Butinas | Komentras |
logistic_id | id |
| Pasirinktos пervežimo kompanijos unikalus ID (pašalinta versijoje 2.5, būtinas iki versijos 2.2)
|
zone_id | id | * | Pasirinkto regiono unikalus ID |
weight | skaičius |
| Prekių krepšelio svoris (būtinas iki versijos 2.5. Nuo versijos 2.5 jeigu nenurodytas - imamas šiuo metu krepšelyje esančių prekių svoris
|
currency
| kodas
|
| Valiutos, kuria apskaičiuojama kainą, kodas. Jeigu nenurodytas, pristatymo kaina skaičiuojama bazine valiuta
|
_shop->getCartWeight - grąžina krepšelio prekių svorį. Jeigu vartotojas turi kelis krepšelius yra galimybė nurodyti krepšelio id.
Parametras | Tipas | Butinas | Komentras |
cart_id | id |
| Skirtas atvejams kai vartotojas turi kelis krepšelius. Nurodžius krepšelio id bus gražintos tik jam priklausančių prekų svoris. |
_shop->getCurrentOrders - grąžina sąraša užsakymų kurie dar nėra galutiniai (dar vykdomi)
Parametras | Būtinas | Tipas | Pastabos |
content |
| true¦false | grąžina ir užsakymo turini |
_shop->getHistoryOrders - grąžina sąraša užsakymų kurie yra galutiniai (jau įvykdyti arba atmesti)
Parametras | Tipas | Butinas | Komentras |
show_all | true¦false |
| parodo visų klientų užsakymus |
content | true¦false |
| grąžina ir užsakymo turini |
limit | skaičius |
| išvedamų eilučių kiekis. Gali būti nurodytas su paslinkimu: "paslinkimas, kiekis". Pvz "30,10".Grąžinamų rezultatų kiekis |
_shop->getHistroryOrdersPaging - grąžina standartinį puslapiavimo objekta pagal paskutinįjį _shop->getProducts iškvietimą.
_shop->getOrder - grąžina užsakymo informaciją
Parametras | Būtinas | Tipas | Pastabos |
order_id | * | id | užsakymo id |
show_all |
| true¦false | parodo visų klientų užsakymus |
_shop->getProductsByText - Suranda produktus pagal tekstinius laukus.
Parametras | Tipas | Butinas | Komentras |
search_string | textas | * | Ieškomas tekstas |
category_id | id |
| Kategorijos id |
limit | skaičius |
| Grąžinamų rezultatų kiekis |
_shop->getZoneName - grąžina zonos pavadinimą.
Parametras | Būtinas | Tipas | Komentaras |
id | * | skaičius | Nurodo kurios zonos pavadinimą grąžinti |
_shop->getLists - grąžina pasirenkamųjų sąrašų pavadinimus. Kurie vėliau naudojami kaip getList metodo list paramtras.
_shop->getList - grąžina pasirenkamojo sąrašo elementus (pvz. autorių sąrašas, gamintojų sąrašas).
Parametras | Būtinas | Tipas | Komentaras |
list | * | string | Nurodo sąrašo, kuri norima gauti, pavadinimą. |
id |
| skaičius | jeigu nurodytas grąžina konkretų įrašą iš duomenų bazės |
lang_id |
| string | Nurodo kokia kalbą išvesti gamintojų pavadinimus. Pagal nutylėjimą išveda tinklapio kalba |
limit
|
| skaičius | Kiekis reikalingų ištraukti eilučių
|
query |
| string | Vykdo tekstinę paieška per įrašo pavadinimą ir aprašymą |
query_name |
| string | Vykdo tekstinę paieška tik per įrašo pavadinimą |
_shop->getManufacturers - grąžina sąrašą gamintojų.
Nerekomenduojamas. Žr. _shop->getList metodą.
_shop->getComments - grąžina komentarų sąrašą.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | skaičius | Komentuojamo produkto id |
comments_page_nr | * | skaičius | Komentarų puslapio eilės numeris |
comments_page_size |
| skaičius | Nustato puslapio dydį, t.y. kiek komentarų grąžinti. |
_shop->getCommentsPaging - grąžina prekės komentarų sąrašo puslapiavimo aprašomąjį masyvą. Turi būti iškviestas po komentarų sąrašo išvedimo.
_shop->countComments - grąžina prekės komentarų skaičių.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | skaičius | Prekės id |
_shop->getRatingsList - grąžina sąrašą įmanomų reitingo variantų (nuo -X iki X).
_shop->getRatingsComments - grąžina prekės reitingų komentarų sąrašą.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | skaičius | Reitinguojamo prekės id |
ratings_page_nr | * | skaičius | Komentarų puslapio eilės numeris |
ratings_page_size |
| skaičius | Nustato puslapio dydį, t.y. kiek komentarų grąžinti. |
_shop->getRatingsStats - grąžina prekės reitingų statistiką.
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | skaičius | Prekės id |
_shop->getMerchant - grąžina pardavėjo informacija.
Parametras | Būtinas | Tipas | Komentaras |
merchant_id | * | id | Pardavėjo id |
_shop->getMerchants - grąžina pardavėjų informacija.
_shop->getDiscountGroup - grąžina nuolaidų grupės informaciją. (nuo versijos 2.1.1)
Parametras | Būtinas | Tipas | Komentaras |
id | * | id | Nuolaidų grupės id |
_shop->getRelatedProducts - grąžina susijusias prekes. (nuo versijos 3.0)
Parametras | Būtinas | Tipas | Komentaras |
product_id | * | id | Produkto id |
_shop->getReturn - grąžina prekes gražinimo informacija (nuo versijos 2.6.1)
Parametras | Būtinas | Tipas | Komentaras |
id | * | id | Gražinimo id |
_shop->getReturnedProducts - grąžina prekes gražinimo produkto informaciją (nuo versijos 2.6.1)
Parametras | Būtinas | Tipas | Komentaras |
id | * | id | Gražinamo produkto id |
_shop->product_count - grąžina paskutiniojo iškviesto _shop->getProducts metodo apimtų įrašų skaičių. (nuo versijos 2.5)