Funkcje i biblioteki
W dziale tym opisane są funkcje PHP, które znajdują się w katalogu "core/" i "core/libraries/".
core/
W tym katalogu znajdują się wszystkie najważniejsze funkcje odpowiadające za zapisywanie, odczyt a także operacje na danych
boxes-admin.php
Funkcje zarządzające danymi boksów, dostępne jedynie w administracji.
deleteBox() - usuwa boks z bazy danych
listBoxes() - wyświetla listę boksów
saveBox() - zapisuje boks do bazy danych
throwBox() - pobiera dane boksu z bazy danychboxes.php
Funkcje wyświetlające bannery
throwBoxes() - zwraca tablicę z boksami aktywnymi w celu wyświetlenia ich po stronie klienta
comments-admin.phpFunkcje zarządzające danymi komentarzy, dostępne jedynie w administracji
deleteComment() - usuwa komentarz z bazy danych
deleteComments() - usuwa komentarze dla strony lub produktu
listCommentsAdmin() - wyświetla listę komentarzy dla strony lub produktu w administracji
listLastComments() - wyświetla ostatnio dodane komentarze na pulpicie
saveComments() - zapisuje formularz ze statusami komentarzy przesłany z listy komentarzy
updateProductsVotes() - zlicza średnią ocenę i ilość głosów oddanych na produkt z komentarzy zatwierdzonychcomments.php
Funkcje dodające komentarze i wyświetlające komentarze dla stron i produktów
addComment() - dodaje komentarz do bazy danych
getDatabaseName() - pobiera nazwę pliku przechowującego komentarze dla stron lub produktów
listComments() - wyświetla listę komentarzy dla strony lub produktucommon-admin.php
Funkcje różnego rodzaju, dostępne jedynie w administracji
checkLogin() - weryfikacja login'u i hasła w czasie logowania
copyDirToDir() - kopiowanie szablonów z jednego katalogu do drugiego
deleteFullDescription() - usuwa pełny opis z pliku
listBackupFiles() - wyświetla wszystkie dostępne pliki z kopią zapasową bazy danych z katalogu "files/backup/"
listNotifications() - wyświetla listę powiadomień i komunikatów w panelu administracyjnym (od v6.2)
loginActions() - odpowiada za logowanie się do administracji
restoreBackup() - przywraca dane z kopii zapasowej wg wybranych ustawień (od v6.3)
saveFullDescription() - zapisuje pełny opis do pliku
saveVariables() - zapisanie danych w tłumaczeniach i konfiguracji
throwSkinsSelect() - generowanie listy skórek (katalogów), które znajdują sie w katalogu "templates/"
throwSubpagesShowSelect() - pobranie listy dostępnych sposobów wyświetlania podstron
throwThemesSelect() - wyświetlenie listy plików (tematów) z rozszerzeniem "php" w katalogu "templates/default/"
throwTrueFalseOrNullSelect() - zwraca HTML‘owego select'a z wyborem tak/nie
throwWatermarkSelect() - zwraca pole wyboru znaku wodnegocommon.php
Funkcje różnego rodzaju, dostępne w części klienta i w administracji
checkEmail() - funkcja sprawdza format adresu email przesłanego przez np. formularz zamówienia
compareArrays() - porównuje przesłane tablice z formularza do późniejszego zapisu do bazy danych stron, plików itd
countPageNumber() - zlicza numer danej strony w przypadku paginacji/stronicowania
cutText() - obcina zbyt długie teksty (od v6.3)
displayDate() - funkcja wyświetla datę zmienioną wg różnicy czasu
displayPageDetails() - wyświetla szczegółowe dane strony wg wybranych parametrów (od v6.3)
displayPrice() - funkcja wyświetla ceny w odpowiednim formacie
displayProductDetails() - wyświetla szczegółowe dane produktu wg wybranych parametrów (od v6.3
generateDynamicMetaDescription() - na podstawie treści strony generuje opis dla pola meta description (od v6.3)
generatePrice() - funkcja generuje ceny na podstawie przesłanych parametrów: ceny i wartości modyfikującej np. 10, -10, +10%, -10%
generateSiteMap2Xml() - tworzy listę stron i produktów dla wygenerowania pliku "sitemap.xml"
getFullDescription() - pobiera pełny opis z pliku
getLanguageFromUrl() - funkcja pobiera język z przesłanego adresu URL
getUrlFromGet() - generowanie zmiennych z adresu URL dla potrzeb akcji
normalizePrice() - normalizuje przesłaną cenę przed zapisem oraz zapisuje ją
sendEmail() - funkcja wysyła email na podstawie przesłanego formularza
throwCaptchaText() - zwraca tablicę z losowym tekstem captcha do wpisania a także z jego zaszyfrowanym wynikiem
throwIconsFromExt() - pobranie odpowiedniej ikonki dla rozszerzenia pliku na stronie
throwLinksToSocial() - zwraca linki do serwisów społecznościowych
throwSiteUrls() - zwraca tablice z pełnym i skróconym adresem strony
throwStatus() - wyświetlenie ukrytych stron i produktów w części klienta dla administratora, jeśli jest włączona w konfiguracji opcja "Administrator może zobaczyć ukryte strony i produkty"
throwStreetDetails() - zwraca informacje o ulicy, numerze domu i mieszkaniafeatures-admin.php
Funkcje zarządzające danymi cech, dostępne jedynie w administracji
createFeaturesArray() - sortuje tablicę z listą cech by później ją zapisać do bazy danych
deleteFeature() - usuwa wybraną cechę z bazy danych
listFeatures() - wyświetla listę cech
listProductFeaturesAdmin() - wyświetla wszystkie dostępne cechy wraz z ich wartościami wpisanymi dla danego produktu
saveFeature() - zapisuje cechę do bazy danych
throwFeature() - pobiera dane cechyfeatures.php
Funkcje wyświetlające cechy produktów
listProductFeatures() - wyświetla cechy produktu
throwProductFeatures() - pobiera z bazy danych cechy produktufiles-admin.php
Klasa FilesAdmin, która dziedziczy metody z klasy Files i wykonuje funkcje na plikach i zdjęciach jedynie w administracji
addFiles() - zapisanie wgranych i skopiowanych plików i zdjęć do plikowej bazy danych
addFilesFromServer() - skopiowanie wybranych plików i zdjęć z katalogu "files/"
checkThumbnailCropRatio() - ustawia dodatek do nazwy pliku którego miniaturki są kadrowane - proporcje kadrowania (od v6.3)
cloneProductFiles() - kopiuje pliki produktu dla potrzeb klonowania jego danych
createArray() - funkcja przygotowuje tablice z danymi plików przed zapisem do bazy danych
deleteFiles() - usunięcie wszystkich plików i zdjęć przypisanych do strony lub produktu
deleteFilesFromDirs() - usuwanie plików i zdjęć z katalogu "files/"
deleteSelectedFiles() - usunięcie wybranych zdjęć i plików z listy
generateThumbDirs() - generowanie nazw katalogów z miniaturkami w katalogu "files/"
generateThumbs() - wygenerowanie miniaturek przesłanych zdjęć
listAllLinkFiles() - wyświetlenie wszystkich zdjęć i plików przypisanych do strony lub produktu
listFilesInDir() - generowanie listy zdjęć i plików w katalogu "files/"
listLastFiles() - wyświetla ostatnio dodane pliki
saveFiles() - zapisywanie danych (opis, pozycja itd.) plików i zdjęć do plikowej bazy danych
throwRatioFileName() - zmienia nazwę pliku którego miniaturki są kadrowane dodając proporcje kadrowania (od v6.3)
uploadFile() - Wgrywa plik przesłany z komputera na serwerfiles.php
Klasa Files wykonuje wszystkie funkcje na plikach i zdjęciach w części klienta i w administracji
generateCache() - wygenerowanie tablicy (cache) z plikowej bazy danych zawierającej dane zdjęć i plików
getDefaultImage() - pobiera domyślne zdjęcie strony lub produktu
listFiles() - wyświetlenie listy plików
listGalleryImages() - wyświetla listę zdjęć w postaci galerii (góra/dół)
listImagesByTypes() - wyświetlenie listy zdjęć z podziałem na typy (lewy/prawy itd)
listPreviewImages() - wyświetlanie podglądu zdjęć w szczegółach produktu
throwDbNames() - zwracanie nazwy plikowej bazy danychfixes-admin.php
Funkcje pobierające i sprawdzające dostępne poprawki
checkFileToUpgrade() - sprawdza czy dany błąd został poprawiony
getBugFixes() - pobiera plik z poprawkami błędów z serwera OpenSolution.org i wyświetla informacje o tym czy zostały poprawionelang-admin.php
Funkcje wykonujące modyfikacje na tłumaczeniach, dostępne jedynie w administracji
addLanguage() - dodanie nowego języka, stworzenie odpowiednich plików w katalogu "database/" i jego podkatalogach
deleteLanguage() - usunięcie wybranego języka z odpowiednimi plikami w katalogu "database/" i jego podkatalogach
listLangVariables() - pobranie z tablicy $lang (pliki w katalogu "lang/") danych i wyświetlenie ich
listLanguages() - wyświetlenie listy dostępnych języków na stronie
throwLangSelect() - wyświetlenie listy rozwijanej z językami
throwLanguages() - pobranie wszystkich nazw języków z katalogu "lang/"orders-admin.php
Klasa OrdersAdmin pełni funkcję zarządzania zamówieniami złożonymi przez klientów
deleteOrder() - usuwa zamówienie wraz z przydzielonymi do niego produktami
deleteOrderPayment() - usuwa status płatności zamówienia
deletePaymentShipping() - usuwa sposób płatności lub dostawy
exportOrders() - eksportuje dane zamówień do pliku CSV
generateCache() - generuje listę wszystkich zamówień i zapisuje do zmiennej klasy
generateOrdersSearchListArray() - generuje listę zamówień na podstawie przesłanego wyszukiwanego słowa i statusu
listLastOrders() - wyświetla najnowsze zamówienia
listOrderStatuses() - wyświetla listę zmienionych statusów zamówienia
listOrdersAdmin() - wyświetla listę zamówień generując kod HTML
listPaymentsShippingAdmin() - wyświetla listę sposobów płatności lub dostaw generując kod HTML
listProductsAdmin() - wyświetla zamówione produkty w panelu administracyjnym
listShippingPaymentsForm() - wyświetla listę płatności przypisanych do sposobu dostawy generując kod HTML
moveDatabaseFiles() - usuwa tymczasowe pliki z danymi na których operuje skrypt i nadpisuje pliki w "database/" jak: orders.php, orders_ext.php i orders_products.php
saveOrder() - zapisuje dane zamówienia wraz z produktami i sposobem dostawy i płatności
saveOrders() - zapisuje zmienione statusy zamówień przesłanych przez formularz z listy zamówień
savePaymentShipping() - zapisuje sposób płatności lub dostawy.
throwOuterPaymentsSelect() - zwraca pole wyboru z zewnętrznymi systemami płatnościorders.php
Klasa Orders pełni funkcję zarządzania koszykiem i zapisywania zamówienia
addOrder() - zapisuje dane zamówienia przesłane z formularza
checkEmptyBasket() - sprawdza czy koszyk jest pusty
checkFields() - sprawdza przesłany formularz zamówienia
countPaymentPrice() - zlicza cenę płatności. W przypadku gdy wartość zamówienia przekracza opcję "Darmowa dostawa od wartości zamówienia" wyświetla cenę 0.
countShippingPrice() - zlicza cenę dostawy w zależności od wagi zamówienia.
deleteFromBasket() - usuwa wybraną pozycję z koszyka
findOrder() - zwraca id zamówienia na podstawie przesłanego unikalnego klucza
generateBasket() - funkcja powołuje zmienną przechowującą produkty dodane do koszyka
generateProducts() - generuje zmienną z listą produktów w zamówieniu
listProducts() - funkcja generuje kod HTML z listą produktów w zamówieniu
listProductsBasketInfo() - zwraca dane do wyświetlenia boksu z zawartością koszyka
saveBasket() - zapisuje koszyk z przesłanymi, zmienionymi ilościami produktów
saveOrderPayment() - zapisuje status płatności w zamówieniu do pliku
sendEmailWithOrderDetails() - wysyła email do administratora i klienta ze szczegółami otrzymanego zamówienia.
throwLastId() - zwraca ostatnie id zamówienia lub elementu w koszyku w zależności od podanego parametru
throwOrder() - wyświetla szczegóły zamówienia tj. dane klienta, płatność i dostawę
throwOrderKey() - zwraca zakodowany klucz dla zamówienia
throwOrderPayment() - pobiera status płatności zamówienia
throwPaymentShipping() - zwraca szczegóły sposobu płatności lub dostawy
throwPaymentsShipping() - zwraca tablicę ze sposobami płatności lub dostawami w zależności od podanego parametru
throwSavedOrderId() - sprawdza id zamówienia na podstawie przesłanego ciastka
throwShippingPaymentPrice() - generuje koszt dostawy i płatności na podstawie podanych parametrów
throwShippingPaymentsSelect() - wygenerowanie listy dostępnych sposobów płatności i dostaw w postaci HTML'owego select'a
throwStatus() - wyświetla status zamówienia.pages-admin.php
Klasa PagesAdmin, która dziedziczy metody z klasy Pages i wykonuje funkcje na stronach jedynie w administracji
createArray() - funkcja przygotowuje tablice z danymi stron przed zapisem do bazy danych
deletePage() - usuwanie strony i jej podstron
generatePagesSearchListArray() - przegląda i filtruje strony na podstawie wyszukiwanej frazy
listLastPages() - funkcja wyświetla ostatnio dodane strony
listPagesAdmin() - wyświetlenie listy wszystkich stron
listPagesAdminSearch() - wyświetlenie listy stron, które posiadają w swej treści podaną frazę
listSubPagesAdmin() - wyświetlenie listy wszystkich podstron podanej strony
savePage() - zapisanie danych strony i dodanych do niej plików i zdjęć
savePages() - zapisanie danych stron (pozycja, status) przesłanych z listy stron
throwPagesSelectAdmin() - wygenerowanie listy stron w postaci HTML‘owego select'a
throwProductsPagesSelectAdmin() - wygenerowanie listy stron w postaci HTML'owego select'a
throwProductsSubPagesSelectAdmin() - wygenerowanie listy podstron w postaci HTML'owego select'a
throwSubPagesSelectAdmin() - wygenerowanie listy podstron w postaci HTML‘owego select'a
throwSubpagesIdAdmin() - pobranie id wszystkich podstron dla podanej stronypages.php
Klasa Pages odpowiada za funkcje na stronach w części klienta i w administracji
generateCache() - wygenerowanie tablicy (cache) z plikowej bazy danych z danymi stron
generateMenuData() - przygotowanie tablicy z danymi stron dla potrzeb menu
generatePageParents() - pobranie id wszystkich stron nadrzędnych do pierwszego zagłębienia dla podanej podstrony
getPageDefaultImage() - pobiera domyślne zdjęcie podanej strony (od v6.2)
getPageName() - pobiera nazwę podanej strony (od v6.2)
getPageShortDescription() - pobiera krótki opis podanej strony (od v6.2)
listSiteMap() - wyświetla listę stron i podstron dla mapy strony
listSubpages() - pobranie listy podstron podanej strony
listSubpagesGallery() - wyświetla podstrony w postaci galerii zdjęć
sortPages() - sortuje tablicę ze stronami po id lub nazwie itp. w zależności od wybranej opcji w liście stron
throwAllChildrens() - pobranie id wszystkich podstron do ostatniego zagłębienia dla podanej strony
throwMenu() - generowanie kodu HTML menu
throwPage() - pobranie wszystkich danych strony
throwPagesTree() - pobranie drzewka dostępu do stron nadrzędnych podanej strony
throwSubMenu() - generowanie podstron w menu – funkcja zależna od throwMenupayments.php
checkDotpay() - odbiera dane na temat płatności z systemu Dotpay
checkMoneybookers() - odbiera dane na temat płatności z systemu Moneybookers
checkPaymentCurl() - weryfikuje dane odebrane z systemu płatności
checkPaymentNotify() - na podstawie odpowiedzi weryfikuje system płatności
checkPaypal() - odbiera dane na temat płatności z systemu Paypal
checkPlatnosciPl() - odbiera dane na temat płatności z systemu PlatnosciPl
checkPlatnosciPlSig() - sprawdza wygenerowany klucz przez systemu PlatnosciPl
checkPrzelewy24() - odbiera dane na temat płatności z systemu Przelewy24
checkTransferuj() - odbiera dane na temat płatności z systemu Transferuj
listProductsZagiel() - pobiera zamówione produkty i generuje kod dla systemu Żagiel
throwEserviceToken() - pobiera klucz dla płatności Eservice
throwOuterPaymentsFields() - wyświetla dostępne kanały płatności dla danego systemu płatnościplugins-admin.php
checkBinaryMode() - sprawdza czy skrypt został wgrany na serwer w trybie binarnym (od v6.3)
getPluginsList() - pobiera listę dodatków ze strony OpenSolution.org
getScriptByVersion() - pobiera nazwę skryptu na podstawie jego wersji
installPlugin() - instaluje dodatek w skrypcie
listAvailablePlugins() - wyświetla wszystkie dostępne dodatki
modifyScript() - wykonuje poszczególne kroki instalacji dodatkuproducts-admin.php
Klasa ProductsAdmin, która dziedziczy metody z klasy Products, wykonuje funkcje na stronach tylko w administracji.
cloneProduct() - klonuje dane produktu
createArray() - funkcja przygotowuje tablice z danymi produktów przed zapisem do bazy danych
deleteProduct() - usuwa produkt
deleteProductExtensions() - usuwa dane dodatkowe dla produktu
exportProducts() - eksportuje dane produktów do pliku CSV
importProducts() - importuje dane produktów z pliku CSV
listLastProducts() - funkcja wyświetla ostatnio dodane produktu
listProductsAdmin() - wyświetlenie listy wszystkich produktów
saveProduct() - zapisuje szczegóły produktu wysłanych przez formularz produktu
saveProductExtensions() - zapisuje dane dodatkowe dla produktu
saveProducts() - analizuje przesłane pozycje i statusy z formularza z listy produktów.products.php
Klasa Products odpowiada za funkcje wykonywane na produktach jak wyświetlanie szczegółów, generowanie listy produktów itp.
generateCache() - generuje listę wszystkich produktów
generateProductsListArray() - generuje listę produktów potrzebnych do wyświetlenia listy
generateProductsSearchListArray() - przegląda i filtruje produkty na podstawie wyszukiwanej frazy
getProductBasketLink() - pobiera link dodawania podanego produktu do koszyka (od v6.3)
getProductDefaultImage() - pobiera domyślne zdjęcie podanego produktu (od v6.2)
getProductName() - pobiera nazwę podanego produktu (od v6.2)
getProductPrice() - pobiera cenę podanego produktu (od v6.2)
getProductShortDescription() - pobiera krótki opis podanego produktu (od v6.2)
listBestsellersProducts() - wyświetla listę najlepiej sprzedające się produkty
listProducts() - wyświetla listę produktów na danych wygenerowanych
listProductsPromoted() - wyświetla wyróżnione produkty
listSiteMap() - wyświetla listę produktów do mapy strony
sortProducts() - funkcja sortuje tablice produktów wg id, pozycji, ceny lub statusu
throwProduct() - pobiera szczegółowe dane produktu
throwProductsPagesTree() - wyświetla listę stron, w których znajduje się podany produkt.vouchers-admin.php
listVouchersAdmin() - wyświetla listę kuponów rabatowych w administracji
saveVoucher() - zapisuje dane kuponu rabatowego do bazy danychvouchers.php
changeVoucherPrice() - zmienia cenę na podstawie podanego kuponu rabatowego
checkVoucherForOrderBeforeSend() - sprawdza dostępność kuponu rabatowego
deleteVoucher() - usuwa kupon rabatowy
saveVoucherUse() - sprawdza czy użyty kupon rabatowy był poprawny i jeśli tak zapisuje jego dane
throwVoucher() - zwraca dane kuponu rabatowegocore/libraries/
W tym katalogu znajdują się biblioteki, które przechowują funkcje do wszechstronnego zastosowania, podzielone wg kategorii/plików. Opisujemy tutaj najważniejsze funkcje wykorzystywane w tym projekcie.
