Home.md

Prestashop 1.5.4.0 API documentation

Source : https://github.com/PrestaShop/PrestaShop/tree/1.5.4.0

Contents

• Interfaces
• Classes
• Functions
• Files

Interfaces

• StockManagerInterface
• TaxManagerInterface
• WebserviceOutputInterface
• WebserviceSpecificManagementInterface

Classes

• AbstractLoggerCore
• AddressControllerCore
• AddressCore
• AddressFormatCore
• AddressesControllerCore
• AdminAccessControllerCore
• AdminAddonsCatalogControllerCore
• AdminAddressesControllerCore
• AdminAdminPreferencesControllerCore
• AdminAttachmentsControllerCore
• AdminAttributeGeneratorControllerCore
• AdminAttributesGroupsControllerCore
• AdminBackupControllerCore
• AdminCarriersControllerCore
• AdminCartRulesControllerCore
• AdminCartsControllerCore
• AdminCategoriesControllerCore
• AdminCmsCategoriesControllerCore
• AdminCmsContentControllerCore
• AdminCmsControllerCore
• AdminContactsControllerCore
• AdminControllerCore
• AdminCountriesControllerCore
• AdminCurrenciesControllerCore
• AdminCustomerPreferencesControllerCore
• AdminCustomerThreadsControllerCore
• AdminCustomersControllerCore
• AdminDeliverySlipControllerCore
• AdminEmailsControllerCore
• AdminEmployeesControllerCore
• AdminFeaturesControllerCore
• AdminGendersControllerCore
• AdminGeolocationControllerCore
• AdminGroupsControllerCore
• AdminHomeControllerCore
• AdminImagesControllerCore
• AdminImportControllerCore
• AdminInformationControllerCore
• AdminInvoicesControllerCore
• AdminLanguagesControllerCore
• AdminLocalizationControllerCore
• AdminLoginControllerCore
• AdminLogsControllerCore
• AdminMaintenanceControllerCore
• AdminManufacturersControllerCore
• AdminMarketingControllerCore
• AdminMetaControllerCore
• AdminModulesControllerCore
• AdminModulesPositionsControllerCore
• AdminNotFoundControllerCore
• AdminOrderMessageControllerCore
• AdminOrderPreferencesControllerCore
• AdminOrdersControllerCore
• AdminOutstandingControllerCore
• AdminPPreferencesControllerCore
• AdminPaymentControllerCore
• AdminPdfControllerCore
• AdminPerformanceControllerCore
• AdminPreferencesControllerCore
• AdminProductsControllerCore
• AdminProfilesControllerCore
• AdminQuickAccessesControllerCore
• AdminRangePriceControllerCore
• AdminRangeWeightControllerCore
• AdminReferrersControllerCore
• AdminRequestSqlControllerCore
• AdminReturnControllerCore
• AdminScenesControllerCore
• AdminSearchConfControllerCore
• AdminSearchControllerCore
• AdminSearchEnginesControllerCore
• AdminShippingControllerCore
• AdminShopControllerCore
• AdminShopGroupControllerCore
• AdminShopUrlControllerCore
• AdminSlipControllerCore
• AdminSpecificPriceRuleControllerCore
• AdminStatesControllerCore
• AdminStatsControllerCore
• AdminStatsTabControllerCore
• AdminStatusesControllerCore
• AdminStockConfigurationControllerCore
• AdminStockCoverControllerCore
• AdminStockInstantStateControllerCore
• AdminStockManagementControllerCore
• AdminStockMvtControllerCore
• AdminStoresControllerCore
• AdminSuppliersControllerCore
• AdminSupplyOrdersControllerCore
• AdminTabCore
• AdminTabsControllerCore
• AdminTagsControllerCore
• AdminTaxRulesGroupControllerCore
• AdminTaxesControllerCore
• AdminThemesControllerCore
• AdminTrackingControllerCore
• AdminTranslationsControllerCore
• AdminWarehousesControllerCore
• AdminWebserviceControllerCore
• AdminZonesControllerCore
• AliasCore
• AttachmentControllerCore
• AttachmentCore
• AttributeCore
• AttributeGroupCore
• Auth
• AuthControllerCore
• Autoload
• BackupCore
• BestSalesControllerCore
• BlowfishCore
• CMSCategoryCore
• CMSCore
• CSVCore
• CarrierCore
• CarrierModuleCore
• CartControllerCore
• CartCore
• CartRuleCore
• CategoryControllerCore
• CategoryCore
• ChangeCurrencyControllerCore
• ChartCore
• CmsControllerCore
• CollectionCore
• CombinationCore
• CompareControllerCore
• CompareProductCore
• ConfigurationCore
• ConfigurationTestCore
• ConnectionCore
• ConnectionsSourceCore
• ContactControllerCore
• ContactCore
• ContextCore
• ControllerCore
• ControllerFactoryCore
• CookieCore
• CountryCore
• CountyCore
• Crypt_Blowfish
• CurrencyCore
• Curve
• CustomerCore
• CustomerMessageCore
• CustomerThreadCore
• CustomizationCore
• DateRangeCore
• DbCore
• DbMySQLiCore
• DbPDOCore
• DbQueryCore
• DeliveryCore
• DiscountControllerCore
• DiscountCore
• DispatcherCore
• EmployeeCore
• FeatureCore
• FeatureValueCore
• FileLoggerCore
• FileUploaderCore
• FreeOrder
• FrontControllerCore
• GenderCore
• GetFileControllerCore
• GroupCore
• GroupReductionCore
• GuestCore
• GuestTrackingControllerCore
• HTMLTemplateCore
• HTMLTemplateDeliverySlipCore
• HTMLTemplateInvoiceCore
• HTMLTemplateOrderReturnCore
• HTMLTemplateOrderSlipCore
• HTMLTemplateSupplyOrderFormCore
• HelpAccessCore
• HelperCore
• HelperFormCore
• HelperHelpAccessCore
• HelperListCore
• HelperOptionsCore
• HelperViewCore
• History
• HistoryControllerCore
• HookCore
• IdentityControllerCore
• Image
• ImageCore
• ImageManagerCore
• ImageTypeCore
• ImportModuleCore
• IndexControllerCore
• LanguageCore
• LinkCore
• LocalizationPackCore
• LoggerCore
• MailCore
• ManufacturerControllerCore
• ManufacturerCore
• MediaCore
• MessageCore
• MetaCore
• ModuleAdminControllerCore
• ModuleCore
• ModuleFrontControllerCore
• ModuleGraphCore
• ModuleGraphEngineCore
• ModuleGridCore
• ModuleGridEngineCore
• MyAccountControllerCore
• MySQLCore
• NewProductsControllerCore
• NotificationCore
• ObjectModelCore
• OrderCarrierCore
• OrderCartRuleCore
• OrderConfirmationControllerCore
• OrderControllerCore
• OrderCore
• OrderDetailControllerCore
• OrderDetailCore
• OrderDiscountCore
• OrderFollowControllerCore
• OrderHistoryCore
• OrderInvoiceCore
• OrderMessageCore
• OrderOpcControllerCore
• OrderPaymentCore
• OrderReturnControllerCore
• OrderReturnCore
• OrderReturnStateCore
• OrderSlipControllerCore
• OrderSlipCore
• OrderStateCore
• PDFCore
• PDFGeneratorCore
• PackCore
• PageCore
• PageNotFoundControllerCore
• ParentOrderControllerCore
• PasswordControllerCore
• PaymentCCCore
• PaymentModuleCore
• PdfInvoiceControllerCore
• PdfOrderReturnControllerCore
• PdfOrderSlipControllerCore
• PrestaShopDatabaseExceptionCore
• PrestaShopExceptionCore
• PrestaShopModuleExceptionCore
• PrestaShopPaymentExceptionCore
• PricesDropControllerCore
• ProductControllerCore
• ProductCore
• ProductDownloadCore
• ProductSaleCore
• ProductSupplierCore
• ProfileCore
• QqUploadedFileForm
• QqUploadedFileXhr
• QuickAccessCore
• RangePriceCore
• RangeWeightCore
• ReferrerCore
• RequestSqlCore
• RijndaelCore
• RiskCore
• SceneCore
• Search
• SearchControllerCore
• SearchCore
• SearchEngineCore
• Session
• SessionAction
• ShopCore
• ShopGroupCore
• ShopUrlCore
• SitemapControllerCore
• SmartyLazyRegister
• SpecificPriceCore
• SpecificPriceRuleCore
• StateCore
• StatisticsControllerCore
• StockAvailableCore
• StockCore
• StockManagerCore
• StockManagerFactoryCore
• StockManagerModuleCore
• StockMvtCore
• StockMvtReasonCore
• StockMvtWSCore
• StoreCore
• StoresControllerCore
• SupplierControllerCore
• SupplierCore
• SupplyOrderCore
• SupplyOrderDetailCore
• SupplyOrderHistoryCore
• SupplyOrderReceiptHistoryCore
• SupplyOrderStateCore
• TabCore
• TagCore
• TaxCalculatorCore
• TaxCore
• TaxManagerFactoryCore
• TaxManagerModuleCore
• TaxRuleCore
• TaxRulesGroupCore
• TaxRulesTaxManagerCore
• ThemeCore
• ToolsCore
• TranslateCore
• TranslatedConfigurationCore
• UpgraderCore
• Upload
• ValidateCore
• WarehouseCore
• WarehouseProductLocationCore
• WebserviceExceptionCore
• WebserviceKeyCore
• WebserviceOutputBuilderCore
• WebserviceOutputXMLCore
• WebserviceRequestCore
• WebserviceSpecificManagementImagesCore
• WebserviceSpecificManagementSearchCore
• ZoneCore
• file
• manager
• pagination

Functions

• addBeginingSlash
• addNoCacheHeaders
• addTrailingSlash
• appendQueryString
• backslashToSlash
• bindDatepicker
• bqSQL
• cacheImage
• checkIco
• checkImage
• checkImageUploadError
• checkPSVersion
• checkTabRights
• checkingTab
• cmpPriceAsc
• cmpPriceDesc
• createDestImage
• createDir
• createSrcImage
• d
• ddd
• deleteImage
• displayArray
• displayDate
• displayFatalError
• displayJavascriptAlert
• downloadFile
• fd
• getAbsPath
• getBaseName
• getCurrentFolderPath
• getCurrentUrl
• getDirContent
• getFileContent
• getFileExt
• getFileUrl
• getFolderListing
• getMemoryLimit
• getParentFolderPath
• getParentPath
• getPath
• getRealPath
• getRelativeFileUrl
• getRelativePath
• getRootPath
• getThumbWidthHeight
• getValidTextEditorExts
• imageCut
• imageResize
• imagerotate
• includeDatepicker
• isInvalidPattern
• isListingDocument
• isPicture
• isUnderRoot
• isUnderSession
• isValidExt
• isValidPattern
• makeQueryString
• mime_content_type
• myRealPath
• nl2br2
• p
• pSQL
• ppp
• prependSlash
• ps_module_version_sort
• relToAbs
• removeBeginingSlash
• removeTrailingSlash
• returnDestImage
• rewriteSettingsFile
• runAdminTab
• secureFileName
• shortenFileName
• simpleXMLToArray
• slashToBackslash
• smartyDieObject
• smartyHook
• smartyMaxWords
• smartyMinifyHTML
• smartyPackJSinHTML
• smartyRegisterFunction
• smartyShowObject
• smartyTranslate
• smartyTruncate
• smarty_modifier_htmlentitiesUTF8
• smarty_modifier_truncate
• sortDocuments
• stripos
• toolsConvertPrice
• transformFilePath
• transformFileSize
• translate
• trimlrm
• writeInfo

Files

• admin-dev/ajax.php
• admin-dev/ajaxfilemanager/inc/class.auth.php
• admin-dev/ajaxfilemanager/inc/class.file.php
• admin-dev/ajaxfilemanager/inc/class.history.php
• admin-dev/ajaxfilemanager/inc/class.image.php
• admin-dev/ajaxfilemanager/inc/class.manager.php
• admin-dev/ajaxfilemanager/inc/class.pagination.php
• admin-dev/ajaxfilemanager/inc/class.search.php
• admin-dev/ajaxfilemanager/inc/class.session.php
• admin-dev/ajaxfilemanager/inc/class.sessionaction.php
• admin-dev/ajaxfilemanager/inc/class.upload.php
• admin-dev/ajaxfilemanager/inc/config.php
• admin-dev/ajaxfilemanager/inc/function.base.php
• admin-dev/functions.php
• classes/Address.php
• classes/AddressFormat.php
• classes/AdminTab.php
• classes/Alias.php
• classes/Attachment.php
• classes/Attribute.php
• classes/AttributeGroup.php
• classes/Autoload.php
• classes/Backup.php
• classes/Blowfish.php
• classes/CMS.php
• classes/CMSCategory.php
• classes/CSV.php
• classes/Carrier.php
• classes/Cart.php
• classes/CartRule.php
• classes/Category.php
• classes/Chart.php
• classes/Collection.php
• classes/Combination.php
• classes/CompareProduct.php
• classes/Configuration.php
• classes/ConfigurationTest.php
• classes/Connection.php
• classes/ConnectionsSource.php
• classes/Contact.php
• classes/Context.php
• classes/ControllerFactory.php
• classes/Cookie.php
• classes/Country.php
• classes/County.php
• classes/Currency.php
• classes/Customer.php
• classes/CustomerMessage.php
• classes/CustomerThread.php
• classes/Customization.php
• classes/DateRange.php
• classes/Delivery.php
• classes/Discount.php
• classes/Dispatcher.php
• classes/Employee.php
• classes/Feature.php
• classes/FeatureValue.php
• classes/FileUploader.php
• classes/Gender.php
• classes/Group.php
• classes/GroupReduction.php
• classes/Guest.php
• classes/HelpAccess.php
• classes/Hook.php
• classes/Image.php
• classes/ImageManager.php
• classes/ImageType.php
• classes/Language.php
• classes/Link.php
• classes/LocalizationPack.php
• classes/Logger.php
• classes/Mail.php
• classes/Manufacturer.php
• classes/Media.php
• classes/Message.php
• classes/Meta.php
• classes/Notification.php
• classes/ObjectModel.php
• classes/Pack.php
• classes/Page.php
• classes/PaymentCC.php
• classes/PaymentModule.php
• classes/Product.php
• classes/ProductDownload.php
• classes/ProductSale.php
• classes/ProductSupplier.php
• classes/Profile.php
• classes/QuickAccess.php
• classes/Referrer.php
• classes/RequestSql.php
• classes/Rijndael.php
• classes/Risk.php
• classes/Scene.php
• classes/Search.php
• classes/SearchEngine.php
• classes/SpecificPrice.php
• classes/SpecificPriceRule.php
• classes/State.php
• classes/Store.php
• classes/Supplier.php
• classes/Tab.php
• classes/Tag.php
• classes/Theme.php
• classes/Tools.php
• classes/Translate.php
• classes/TranslatedConfiguration.php
• classes/Upgrader.php
• classes/Validate.php
• classes/Zone.php
• classes/controller/AdminController.php
• classes/controller/Controller.php
• classes/controller/FrontController.php
• classes/controller/ModuleAdminController.php
• classes/controller/ModuleFrontController.php
• classes/db/Db.php
• classes/db/DbMySQLi.php
• classes/db/DbPDO.php
• classes/db/DbQuery.php
• classes/db/MySQL.php
• classes/exception/PrestaShopDatabaseException.php
• classes/exception/PrestaShopException.php
• classes/exception/PrestaShopModuleException.php
• classes/exception/PrestaShopPaymentException.php
• classes/helper/Helper.php
• classes/helper/HelperForm.php
• classes/helper/HelperHelpAccess.php
• classes/helper/HelperList.php
• classes/helper/HelperOptions.php
• classes/helper/HelperView.php
• classes/log/AbstractLogger.php
• classes/log/FileLogger.php
• classes/module/CarrierModule.php
• classes/module/ImportModule.php
• classes/module/Module.php
• classes/module/ModuleGraph.php
• classes/module/ModuleGraphEngine.php
• classes/module/ModuleGrid.php
• classes/module/ModuleGridEngine.php
• classes/order/Order.php
• classes/order/OrderCarrier.php
• classes/order/OrderCartRule.php
• classes/order/OrderDetail.php
• classes/order/OrderDiscount.php
• classes/order/OrderHistory.php
• classes/order/OrderInvoice.php
• classes/order/OrderMessage.php
• classes/order/OrderPayment.php
• classes/order/OrderReturn.php
• classes/order/OrderReturnState.php
• classes/order/OrderSlip.php
• classes/order/OrderState.php
• classes/pdf/HTMLTemplate.php
• classes/pdf/HTMLTemplateDeliverySlip.php
• classes/pdf/HTMLTemplateInvoice.php
• classes/pdf/HTMLTemplateOrderReturn.php
• classes/pdf/HTMLTemplateOrderSlip.php
• classes/pdf/HTMLTemplateSupplyOrderForm.php
• classes/pdf/PDF.php
• classes/pdf/PDFGenerator.php
• classes/range/RangePrice.php
• classes/range/RangeWeight.php
• classes/shop/Shop.php
• classes/shop/ShopGroup.php
• classes/shop/ShopUrl.php
• classes/stock/Stock.php
• classes/stock/StockAvailable.php
• classes/stock/StockManager.php
• classes/stock/StockManagerFactory.php
• classes/stock/StockManagerInterface.php
• classes/stock/StockManagerModule.php
• classes/stock/StockMvt.php
• classes/stock/StockMvtReason.php
• classes/stock/StockMvtWS.php
• classes/stock/SupplyOrder.php
• classes/stock/SupplyOrderDetail.php
• classes/stock/SupplyOrderHistory.php
• classes/stock/SupplyOrderReceiptHistory.php
• classes/stock/SupplyOrderState.php
• classes/stock/Warehouse.php
• classes/stock/WarehouseProductLocation.php
• classes/tax/Tax.php
• classes/tax/TaxCalculator.php
• classes/tax/TaxManagerFactory.php
• classes/tax/TaxManagerInterface.php
• classes/tax/TaxManagerModule.php
• classes/tax/TaxRule.php
• classes/tax/TaxRulesGroup.php
• classes/tax/TaxRulesTaxManager.php
• classes/webservice/WebserviceException.php
• classes/webservice/WebserviceKey.php
• classes/webservice/WebserviceOutputBuilder.php
• classes/webservice/WebserviceOutputInterface.php
• classes/webservice/WebserviceOutputXML.php
• classes/webservice/WebserviceRequest.php
• classes/webservice/WebserviceSpecificManagementImages.php
• classes/webservice/WebserviceSpecificManagementInterface.php
• classes/webservice/WebserviceSpecificManagementSearch.php
• config/alias.php
• config/smarty.config.inc.php
• config/smartyadmin.config.inc.php
• config/smartyfront.config.inc.php
• controllers/admin/AdminAccessController.php
• controllers/admin/AdminAddonsCatalogController.php
• controllers/admin/AdminAddressesController.php
• controllers/admin/AdminAdminPreferencesController.php
• controllers/admin/AdminAttachmentsController.php
• controllers/admin/AdminAttributeGeneratorController.php
• controllers/admin/AdminAttributesGroupsController.php
• controllers/admin/AdminBackupController.php
• controllers/admin/AdminCarriersController.php
• controllers/admin/AdminCartRulesController.php
• controllers/admin/AdminCartsController.php
• controllers/admin/AdminCategoriesController.php
• controllers/admin/AdminCmsCategoriesController.php
• controllers/admin/AdminCmsContentController.php
• controllers/admin/AdminCmsController.php
• controllers/admin/AdminContactsController.php
• controllers/admin/AdminCountriesController.php
• controllers/admin/AdminCurrenciesController.php
• controllers/admin/AdminCustomerPreferencesController.php
• controllers/admin/AdminCustomerThreadsController.php
• controllers/admin/AdminCustomersController.php
• controllers/admin/AdminDeliverySlipController.php
• controllers/admin/AdminEmailsController.php
• controllers/admin/AdminEmployeesController.php
• controllers/admin/AdminFeaturesController.php
• controllers/admin/AdminGendersController.php
• controllers/admin/AdminGeolocationController.php
• controllers/admin/AdminGroupsController.php
• controllers/admin/AdminHomeController.php
• controllers/admin/AdminImagesController.php
• controllers/admin/AdminImportController.php
• controllers/admin/AdminInformationController.php
• controllers/admin/AdminInvoicesController.php
• controllers/admin/AdminLanguagesController.php
• controllers/admin/AdminLocalizationController.php
• controllers/admin/AdminLoginController.php
• controllers/admin/AdminLogsController.php
• controllers/admin/AdminMaintenanceController.php
• controllers/admin/AdminManufacturersController.php
• controllers/admin/AdminMarketingController.php
• controllers/admin/AdminMetaController.php
• controllers/admin/AdminModulesController.php
• controllers/admin/AdminModulesPositionsController.php
• controllers/admin/AdminNotFoundController.php
• controllers/admin/AdminOrderMessageController.php
• controllers/admin/AdminOrderPreferencesController.php
• controllers/admin/AdminOrdersController.php
• controllers/admin/AdminOutstandingController.php
• controllers/admin/AdminPPreferencesController.php
• controllers/admin/AdminPaymentController.php
• controllers/admin/AdminPdfController.php
• controllers/admin/AdminPerformanceController.php
• controllers/admin/AdminPreferencesController.php
• controllers/admin/AdminProductsController.php
• controllers/admin/AdminProfilesController.php
• controllers/admin/AdminQuickAccessesController.php
• controllers/admin/AdminRangePriceController.php
• controllers/admin/AdminRangeWeightController.php
• controllers/admin/AdminReferrersController.php
• controllers/admin/AdminRequestSqlController.php
• controllers/admin/AdminReturnController.php
• controllers/admin/AdminScenesController.php
• controllers/admin/AdminSearchConfController.php
• controllers/admin/AdminSearchController.php
• controllers/admin/AdminSearchEnginesController.php
• controllers/admin/AdminShippingController.php
• controllers/admin/AdminShopController.php
• controllers/admin/AdminShopGroupController.php
• controllers/admin/AdminShopUrlController.php
• controllers/admin/AdminSlipController.php
• controllers/admin/AdminSpecificPriceRuleController.php
• controllers/admin/AdminStatesController.php
• controllers/admin/AdminStatsController.php
• controllers/admin/AdminStatsTabController.php
• controllers/admin/AdminStatusesController.php
• controllers/admin/AdminStockConfigurationController.php
• controllers/admin/AdminStockCoverController.php
• controllers/admin/AdminStockInstantStateController.php
• controllers/admin/AdminStockManagementController.php
• controllers/admin/AdminStockMvtController.php
• controllers/admin/AdminStoresController.php
• controllers/admin/AdminSuppliersController.php
• controllers/admin/AdminSupplyOrdersController.php
• controllers/admin/AdminTabsController.php
• controllers/admin/AdminTagsController.php
• controllers/admin/AdminTaxRulesGroupController.php
• controllers/admin/AdminTaxesController.php
• controllers/admin/AdminThemesController.php
• controllers/admin/AdminTrackingController.php
• controllers/admin/AdminTranslationsController.php
• controllers/admin/AdminWarehousesController.php
• controllers/admin/AdminWebserviceController.php
• controllers/admin/AdminZonesController.php
• controllers/front/AddressController.php
• controllers/front/AddressesController.php
• controllers/front/AttachmentController.php
• controllers/front/AuthController.php
• controllers/front/BestSalesController.php
• controllers/front/CartController.php
• controllers/front/CategoryController.php
• controllers/front/ChangeCurrencyController.php
• controllers/front/CmsController.php
• controllers/front/CompareController.php
• controllers/front/ContactController.php
• controllers/front/DiscountController.php
• controllers/front/GetFileController.php
• controllers/front/GuestTrackingController.php
• controllers/front/HistoryController.php
• controllers/front/IdentityController.php
• controllers/front/IndexController.php
• controllers/front/ManufacturerController.php
• controllers/front/MyAccountController.php
• controllers/front/NewProductsController.php
• controllers/front/OrderConfirmationController.php
• controllers/front/OrderController.php
• controllers/front/OrderDetailController.php
• controllers/front/OrderFollowController.php
• controllers/front/OrderOpcController.php
• controllers/front/OrderReturnController.php
• controllers/front/OrderSlipController.php
• controllers/front/PageNotFoundController.php
• controllers/front/ParentOrderController.php
• controllers/front/PasswordController.php
• controllers/front/PdfInvoiceController.php
• controllers/front/PdfOrderReturnController.php
• controllers/front/PdfOrderSlipController.php
• controllers/front/PricesDropController.php
• controllers/front/ProductController.php
• controllers/front/SearchController.php
• controllers/front/SitemapController.php
• controllers/front/StatisticsController.php
• controllers/front/StoresController.php
• controllers/front/SupplierController.php
• images.inc.php