Classes, interfaces and traits
SerializerInterface¶
Interface SerializerInterface
Serializers that implement this interface should parse and encode entities
so that they can be used in the shop's APIs.
Serialization must follow the "null" approach in order to enhance response clarity.
That means that serializers must provide a null value than an empty string or an omitted node.
« More »
AbstractJsonSerializer¶
Abstract Json Serializer
Serializers that extend this class should parse and encode entities
so that they can be used in the shop's APIs.
Serialization must follow the "null" approach in order to enhance response clarity.
That means that serializers must provide a null value than an empty string or an omitted node.
« More »
AddressJsonSerializer¶
Class AddressJsonSerializer
This class will serialize and deserialize an address entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
CategoryJsonSerializer¶
Class CategoryJsonSerializer
This class will serialize and deserialize a Category entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
CategoryListItemJsonSerializer¶
Class CategoryListItemJsonSerializer
This class will serialize and deserialize an CategoryListItem entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
CountryJsonSerializer¶
Class CountryJsonSerializer
This class will serialize and deserialize a country entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
CustomerJsonSerializer¶
Class CustomerJsonSerializer
This class will serialize and deserialize a customer entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
EmailJsonSerializer¶
Class EmailsJsonSerializer
This class will serialize and deserialize an email entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
OrderJsonSerializer¶
Class OrderJsonSerializer
This class will serialize and deserialize an Order entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
OrderListItemJsonSerializer¶
Class OrderListItemJsonSerializer
This class will serialize and deserialize an OrderListItem entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
ProductJsonSerializer¶
Class ProductJsonSerializer
This class will serialize and deserialize a Product entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
ProductListItemJsonSerializer¶
Class ProductListItemJsonSerializer
This class will serialize and deserialize an ProductListItem entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communications.
« More »
ZoneJsonSerializer¶
Class ZoneJsonSerializer
This class will serialize and deserialize a zone entity. It can be used into many
places where PHP interacts with external requests such as AJAX or API communication.
« More »
Classes, interfaces and traits
AbstractApiV2Controller¶
Class AbstractApiV2Controller
This class defines the inner core functionality of a ApiV2Controller. It contains the
initialization and request validation functionality that every controller must have.
The functionality of this class is mark as private because child controllers must not alter
the state at this point but rather adjust to it. This will force them to follow the same
principles and methodologies.
Child API controllers can use the "init" method to initialize their common dependencies.
« More »
AbstractImagesApiV2Controller¶
Class AbstractImagesApiV2Controller
Provides a listing of image files.
« More »
AddressesApiV2Controller¶
Class AddressesApiV2Controller
Provides a gateway to the AddressBookService which handles the shop address resources.
« More »
AttachmentsApiV2Controller¶
Class AttachmentsApiV2Controller
This controller enables the API consumers to handle email attachments which can be later
used in emails. The most common scenario is that if an email has attachments, they must
be already uploaded before the email is sent.
« More »
CategoriesApiV2Controller¶
Class CategoriesApiV2Controller
Provides a gateway to the CategoryWriteService and CategoryReadService classes, which handle the shop category
resources.
« More »
CategoryIconsApiV2Controller¶
Class CategoryIconsApiV2Controller
This controller handles the Category Icon file operations. The clients of the API can list, upload, rename or delete
files that exist in the server.
« More »
CategoryImagesApiV2Controller¶
Class CategoryImagesApiV2Controller
This controller handles the Category Image file operations. The clients of the API can list, upload, rename or delete
files that exist in the server.
« More »
CountriesApiV2Controller¶
Class CountriesApiV2Controller
Provides a gateway to the CountryService which handles the shop country resources.
« More »
CustomersApiV2Controller¶
Class CustomersApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the
child-controllers in order to gain access to request and response information. The $uri variable is an
array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations
without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should
not be called from a child-controller (like validation, authorization, rate limiting). The only way to
disable the execution of these methods is to override the controller.
« More »
DefaultApiV2Controller¶
Class DefaultApiV2Controller
The default APIv2 controller will be triggered when client consumers hit the "api.php/v2"
URI and it will return information about the API.
« More »
EmailsApiV2Controller¶
Class EmailsApiV2Controller
This controller provides a gateway to the EmailService of the system. The user is able to get, send, queue
and delete email records through his shop. Email forwarding is not directly supported but can be easily
implemented by getting an existing email and then sending it with the updated contact addresses.
API consumers can also upload attachments through the AttachmentsApiV2Controller and later use them within
their emails. The upload operation must be executed before sending/queuing the email because it is not possible
to send the email JSON data and upload a file at the same time. For more info see the AttachmentsV2Controller.
« More »
HttpApiV2Controller¶
Class HttpApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the
child-controllers in order to gain access to request and response information. The $uri variable is an
array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations
without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should
not be called from a child-controller (like validation, authorization, rate limiting). The only way to
disable the execution of these methods is to override the controller.
« More »
OrdersApiV2Controller¶
Class OrdersApiV2Controller
Provides a gateway to the OrderWriteService and OrderReadService classes, which handle the shop
order resources.
« More »
OrdersHistoryApiV2Controller¶
Class OrdersStatusHistoryApiV2Controller
Notice: This controller is a sub-resource of the OrdersV2Controller.
« More »
OrdersItemsApiV2Controller¶
Class OrdersItemsApiV2Controller
Notice: This controller is a sub-resource of the OrdersApiV2Controller.
« More »
OrdersItemsAttributesApiV2Controller¶
Class OrdersItemsAttributesApiV2Controller
Notice: This controller is a subresource of the OrdersItemsApiV2Controller.
« More »
OrdersTotalsApiV2Controller¶
Class OrdersTotalsApiV2Controller
Notice: This controller is a sub-resource of the OrdersV2Controller.
« More »
ProductImagesApiV2Controller¶
Class ProductImagesApiV2Controller
Provides an API interface for managing product images through the ProductWriteService.
Notice: This controller IS NOT a subresource of the ProductsApiV2Controller.
This controller can be reached by using one of the following URIs:
- http://shop.de/api.php/v2/product_images
or
- http://shop.de/api.php/v2/ProductImages
Using "productimages" as a resource name will not resolve to this controller.
« More »
ProductsApiV2Controller¶
Class ProductsApiV2Controller
Provides a gateway to the ProductWriteService and ProductReadService classes, which handle the shop
product resources.
« More »
ProductsLinksApiV2Controller¶
Class ProductsLinksApiV2Controller
Provides an API interface for managing the product links.
Notice: This controller is a subresource of the ProductsApiV2Controller.
« More »
ZonesApiV2Controller¶
Class ZonesApiV2Controller
Provides a gateway to the CountryService which handles the shop zone resources.
« More »
Classes, interfaces and traits
AdminFavoritesAjaxController¶
Class AdminFavoritesAjaxController
This class handles the ajax requests for the favorites menu box from the admin menu.
« More »
AdminInfoBoxAjaxController¶
Class AdminInfoBoxAjaxController
This class handles incoming ajax requests for the admin info box.
« More »
AfterbuyAjaxController¶
Class AfterbuyAjaxController
This class handles the ajax requests for afterbuy.
« More »
DashboardController¶
Class DashboardController
PHP controller class for the dashboard page of the admin section. The statistic results
are generated within this class and provided to the frontend through AJAX calls.
« More »
DynamicShopMessagesController¶
Class DynamicShopMessages
This controller fetches the dynamic shop messages from the shop portal through a CURL request.
« More »
EmailsController¶
Class EmailsController
PHP controller that handles the admin/emails page operations. You can also use it to
perform email operations from JavaScript by providing encoded JSON arrays with email
information from other pages.
« More »
EmbeddedModuleController¶
Class EmbeddedModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ImageProcessingController¶
Class ImageProcessingController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
InvoicesController¶
Class InvoicesController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
LawsController¶
Class LawsController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
MaxFileSizeController¶
Class MaxFileSizeController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ModuleCenterController¶
Class ModuleCenterController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
NewAttributesController¶
Class NewAttributesController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
OrdersModalsAjaxController¶
Class OrdersModalsAjaxController
AJAX controller for the orders modals.
« More »
OrdersOverviewAjaxController¶
Class OrdersAjaxController
AJAX controller for the orders main page.
« More »
OrdersOverviewController¶
Class OrdersOverviewController
Bootstraps the Orders overview page.
« More »
PackedDownloadController¶
Class PackedDownloadController
This class implements a mass downloader. It can be used to have the shop retrieve a list of resources (denoted by their URLs)
and pack them in a ZIP file. The ZIP file is stored in the cache folder and can then be downloaded.
« More »
ShopKeyController¶
Class ShopKeyController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
TemplateConfigurationController¶
Class TemplateConfigurationController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
UserConfigurationController¶
Class UserConfigurationController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
Classes, interfaces and traits
CartController¶
Class CartController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CartDropdownController¶
Class CartDropdownController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CartShippingCostsController¶
Class CartShippingCostsController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CheckQuantityController¶
Class CheckQuantityController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CheckStatusController¶
Class CheckStatusController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CookieBarController¶
Class CookieBarController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CreateGuestController¶
Class CreateGuestController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
CreateRegistreeController¶
Class CreateRegistreeController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
FilterController¶
Class FilterController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ImageRequestController¶
Class ImageRequestController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
JsTranslationsController¶
Class JsTranslationsController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
LiveSearchController¶
Class LiveSearchController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PayPalConfigurationController¶
Class PayPalConfigurationController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PayPalController¶
Class PayPalController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ProductQuestionController¶
Class ProductQuestionController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ShipcloudController¶
Class ShipcloudController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
StyleEdit3AuthenticationController¶
Class StyleEdit3AuthenticationController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
WishListController¶
Class WishListController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
Classes, interfaces and traits
AbstractModuleCenterModule¶
Class AbstractModuleCenterModule
« More »
AffiliPrintModuleCenterModule¶
Class AffiliPrintModuleCenterModule
« More »
AfterbuyModuleCenterModule¶
Class AfterbuyModuleCenterModule
« More »
BrickfoxModuleCenterModule¶
Class BrickfoxModuleCenterModule
« More »
EkomiModuleCenterModule¶
Class EkomiModuleCenterModule
« More »
FindologicModuleCenterModule¶
Class FindologicModuleCenterModule
« More »
GoogleAdwordConversionModuleCenterModule¶
Class GoogleAdwordConversionModuleCenterModule
« More »
HermesModuleCenterModule¶
Class HermesModuleCenterModule
« More »
IloxxModuleCenterModule¶
Class IloxxModuleCenterModule
« More »
IntrashipModuleCenterModule¶
Class IntrashipModuleCenterModule
« More »
ItRechtModuleCenterModule¶
Class ItRechtModuleCenterModule
« More »
JanolawModuleCenterModule¶
Class JanolawModuleCenterModule
« More »
LettrModuleCenterModule¶
Class LettrModuleCenterModule
« More »
MagnalisterModuleCenterModule¶
Class MagnalisterModuleCenterModule
« More »
MailbeezModuleCenterModule¶
Class MailbeezModuleCenterModule
« More »
NewsletterLinkModuleCenterModule¶
Class NewsletterLinkModuleCenterModule
« More »
OldOrderOverviewModuleCenterModule¶
Class OldOrderOverviewModuleCenterModule
« More »
OldOrderOverviewModuleCenterModuleController¶
Class OldOrderOverviewModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PostfinderModuleCenterModule¶
Class PostfinderModuleCenterModule
« More »
ProductAttributesModuleCenterModule¶
Class ProductAttributesModuleCenterModule
« More »
ProtectedShopsModuleCenterModule¶
Class ProtectedShopsModuleCenterModule
« More »
TrustedShopsModuleCenterModule¶
Class TrustedShopsModuleCenterModule
« More »
YategoModuleCenterModule¶
Class YategoModuleCenterModule
« More »
YoochooseModuleCenterModule¶
Class YoochooseModuleCenterModule
« More »
Classes, interfaces and traits
AbstractModuleCenterModuleController¶
Class AbstractModuleCenterModule
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
AffiliPrintModuleCenterModuleController¶
Class AffiliPrintModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
AfterbuyModuleCenterModuleController¶
Class AfterbuyModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
AmazonAdvPaymentsModuleCenterModuleController¶
Class AmazonAdvPaymentsModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
BrickfoxModuleCenterModuleController¶
Class BrickfoxModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
EkomiModuleCenterModuleController¶
Class EkomiModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
FindologicModuleCenterModuleController¶
Class FindologicModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
GoogleAdwordConversionModuleCenterModuleController¶
Class GoogleAdwordConversionModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
HeidelpayModuleCenterModuleController¶
Class HeidelpayModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
HermesModuleCenterModuleController¶
Class HermesModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
IloxxModuleCenterModuleController¶
Class IloxxModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
IntrashipModuleCenterModuleController¶
Class IntrashipModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ItRechtModuleCenterModuleController¶
Class ItRechtModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
JanolawModuleCenterModuleController¶
Class JanolawModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
KlarnaModuleCenterModuleController¶
Class KlarnaModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
LettrModuleCenterModuleController¶
Class LettrModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
MagnalisterModuleCenterModuleController¶
Class MagnalisterModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
MailbeezModuleCenterModuleController¶
Class MailbeezModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
NewsletterLinkModuleCenterModuleController¶
Class NewsletterLinkModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PayOneModuleCenterModuleController¶
Class PayOneModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PaypalNGModuleCenterModuleController¶
Class PaypalNGModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
PostfinderModuleCenterModuleController¶
Class PostfinderModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ProductAttributesModuleCenterModuleController¶
Class ProductAttributesModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ProtectedShopsModuleCenterModuleController¶
Class ProtectedShopsModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
ShipcloudModuleCenterModule¶
Class ShipcloudModuleCenterModule
« More »
ShipcloudModuleCenterModuleController¶
Controller for shipcloud configuration
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
TrustedShopsModuleCenterModuleController¶
Class TrustedShopsModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
YategoModuleCenterModuleController¶
Class YategoModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
YoochooseModuleCenterModuleController¶
Class YoochooseModuleCenterModuleController
This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
« More »
Classes, interfaces and traits
AttachmentCollectionInterface¶
Interface AttachmentCollectionInterface
« More »
AttachmentsHandlerInterface¶
Class AttachmentsHandlerInterface
« More »
EmailAddressInterface¶
Interface EmailAddressInterface
« More »
EmailAttachmentInterface¶
Interface EmailAttachmentInterface
« More »
EmailCollectionInterface¶
Interface EmailCollectionInterface
« More »
EmailContentInterface¶
Interface EmailContentInterface
« More »
EmailDeleterInterface¶
Interface EmailDeleterInterface
« More »
EmailFactoryInterface¶
Interface EmailFactoryInterface
« More »
EmailInterface¶
Interface EmailInterface
« More »
EmailReaderInterface¶
Interface EmailReaderInterface
« More »
EmailRepositoryInterface¶
Interface EmailRepositoryInterface
« More »
EmailServiceInterface¶
Interface EmailServiceInterface
« More »
EmailSubjectInterface¶
Interface EmailSubjectInterface
« More »
EmailWriterInterface¶
Interface EmailWriterInterface
« More »
MailerAdapterInterface¶
Interface MailerAdapterInterface
« More »
Classes, interfaces and traits
AbstractCustomerServiceFactory¶
Class AbstractCustomerServiceFactory
« More »
Customer¶
Class Customer
This class is used for managing customer data
« More »
CustomerDeleter¶
Class CustomerDeleter
This class is used for deleting customer data.
« More »
CustomerFactory¶
Class CustomerFactory
Factory class for all needed customer data.
« More »
CustomerReader¶
Class CustomerReader
This class is used for reading customer data from the database
« More »
CustomerReadService¶
Class CustomerReadService
This class provides methods for creating and deleting customer data
« More »
CustomerRepository¶
Class CustomerRepository
This class contains basic methods for finding, creating and deleting customer data
« More »
CustomerService¶
Class CustomerService
This class provides methods for creating and deleting customer data
« More »
CustomerServiceFactory¶
Class CustomerServiceFactory
Factory class for all needed customer data.
« More »
CustomerWriter¶
Class CustomerWriter
This class is used for writing customer data to the database
« More »
CustomerWriteService¶
Class CustomerWriteService
This class provides methods for creating and deleting customer data
« More »
Classes, interfaces and traits
AddressBlockInterface¶
Value Object.
Interface AddressBlockInterface
Stores all customer address data.
« More »
AddressBookServiceInterface¶
Interface AddressBookServiceInterface
« More »
AddressClassInterface¶
Value Object
Interface AddressClassInterface
Represents a customer address
« More »
CountryServiceInterface¶
Interface CountryServiceInterface
« More »
CustomerAdditionalAddressInfoInterface¶
Value Object
Interface CustomerAdditionalAddressInfoInterface
Represents additional address information
« More »
CustomerAddressDeleterInterface¶
Interface CustomerAddressDeleterInterface
« More »
CustomerAddressInterface¶
Interface CustomerAddressInterface
Interface AddressBlockInterface
Stores all customer address data.
« More »
CustomerAddressReaderInterface¶
Interface CustomerAddressReaderInterface
« More »
CustomerAddressRepositoryInterface¶
Interface CustomerAddressRepositoryInterface
« More »
CustomerAddressWriterInterface¶
Interface CustomerAddressWriterInterface
« More »
CustomerB2BStatusInterface¶
Interface CustomerB2BStatusInterface
« More »
CustomerCallNumberInterface¶
Value Object.
Class CustomerCallNumberInterface
Represents a phone or fax number.
« More »
CustomerCityInterface¶
Value Object.
Interface CustomerCityInterface
Represents a customer city.
« More »
CustomerCompanyInterface¶
Value Object
Interface CustomerCompanyInterface
Represents a customer company
« More »
CustomerCountryInterface¶
Interface CustomerCountryInterface
« More »
CustomerCountryIso2Interface¶
Value Object.
Interface CustomerCountryIso2Interface
Represents a customer country ISO 2 code.
« More »
CustomerCountryIso3Interface¶
Value Object.
Interface CustomerCountryIso3Interface
Represents customer country ISO 3 code.
« More »
CustomerCountryNameInterface¶
Value Object.
Interface CustomerCountryNameInterface
Represents a customer country name.
« More »
CustomerCountryReaderInterface¶
Interface CustomerCountryReaderInterface
« More »
CustomerCountryRepositoryInterface¶
Interface CustomerCountryRepositoryInterface
« More »
CustomerCountryZoneInterface¶
Interface CustomerCountryZoneInterface
« More »
CustomerCountryZoneIsoCodeInterface¶
Value Object.
Interface CustomerCountryZoneIsoCodeInterface
Represents a customer country zone ISO code.
« More »
CustomerCountryZoneNameInterface¶
Value Object.
Interface CustomerCountryZoneNameInterface
Represents a customer country zone name.
« More »
CustomerCountryZoneReaderInterface¶
Interface CustomerCountryZoneReaderInterface
« More »
CustomerCountryZoneRepositoryInterface¶
Interface CustomerCountryZoneRepositoryInterface
« More »
CustomerDeleterInterface¶
Interface CustomerDeleterInterface
« More »
CustomerEmailInterface¶
Value Object.
Interface CustomerEmailInterface
Represents a customer email.
« More »
CustomerFirstnameInterface¶
Value Object.
Interface CustomerFirstnameInterface
Represents a customer first name.
« More »
CustomerGenderInterface¶
Value Object.
Interface CustomerGenderInterface
Represents a customer gender.
« More »
CustomerHouseNumberInterface¶
Value Object
Interface CustomerHouseNumberInterface
Represents a house number
« More »
CustomerInterface¶
Interface CustomerInterface
« More »
CustomerLastnameInterface¶
Value Object.
Interface CustomerLastnameInterface
Represents a customer last name.
« More »
CustomerNumberInterface¶
Value Object.
Interface CustomerNumberInterface
Represents a customer number.
« More »
CustomerPasswordInterface¶
Value Object.
Interface CustomerPasswordInterface
Represents a customer password.
« More »
CustomerPostcodeInterface¶
Value Object.
Interface CustomerPostcodeInterface
Represents a customer post code.
« More »
CustomerReaderInterface¶
Interface CustomerReaderInterface
« More »
CustomerReadServiceInterface¶
Interface CustomerReadServiceInterface
« More »
CustomerRepositoryInterface¶
Interface CustomerRepositoryInterface
« More »
CustomerServiceInterface¶
Interface CustomerServiceInterface
« More »
CustomerServiceSettingsInterface¶
Value Object.
Interface CustomerServiceSettings
Represents the default settings of a customer/guest.
« More »
CustomerStreetInterface¶
Value Object.
Interface CustomerStreetInterface
Represents a customer street.
« More »
CustomerSuburbInterface¶
Value Object.
Interface CustomerSuburbInterface
Represents a customer suburb.
« More »
CustomerVatNumberInterface¶
Value Object.
Interface CustomerVatNumberInterface
Represents a customer VAT number.
« More »
CustomerWriterInterface¶
Interface CustomerWriterInterface
« More »
CustomerWriteServiceInterface¶
Interface CustomerWriteServiceInterface
« More »
VatNumberValidatorInterface¶
Interface VatNumberValidatorInterface
« More »
AbstractCustomerFactory¶
Interface AbstractCustomerFactory
« More »
Classes, interfaces and traits
AddressBlock¶
Value Object
Class AddressBlock
Stores all customer address data
« More »
AddressClass¶
Value Object
Class AddressClass
Represents a customer address
« More »
CustomerAdditionalAddressInfo¶
Value Object
Class CustomerAdditionalAddressInfo
Represents additional address information
« More »
CustomerB2BStatus¶
Class CustomerB2BStatus
« More »
CustomerCallNumber¶
Value Object
Class CustomerCallNumber
Represents a phone or fax number
« More »
CustomerCity¶
Value Object
Class CustomerCity
Represents a customer city
« More »
CustomerCompany¶
Value Object
Class CustomerCompany
Represents a customer company
« More »
CustomerCountryIso2¶
Value Object
Class CustomerCountryIso2
Represents a customer country ISO2 code
« More »
CustomerCountryIso3¶
Value Object
Class CustomerCountryIso3
Represents a customer country ISO3 code
« More »
CustomerCountryName¶
Value Object
Class CustomerCountryName
Represents a customer country name
« More »
CustomerCountryZoneIsoCode¶
Value Object
Class CustomerCountryZoneIsoCode
Represents a customer country zone ISO code
« More »
CustomerCountryZoneName¶
Value Object
Class CustomerCountryZoneName
Represents a customer country zone name
« More »
CustomerDateOfBirth¶
Value Object
Class CustomerDateOfBirth
Represents a customer birth date
« More »
CustomerEmail¶
Value Object
Class CustomerEmail
Represents a customer email
« More »
CustomerFirstname¶
Value Object
Class CustomerFirstname
Represents a customer firstname
« More »
CustomerGender¶
Value Object
Class CustomerGender
Represents a customer gender
« More »
CustomerHouseNumber¶
Value Object
Class CustomerHouseNumber
Represents a house number
« More »
CustomerLastname¶
Value Object
Class CustomerLastname
Represents a customer lastname
« More »
CustomerNumber¶
Value Object
Class CustomerNumber
Represents a customer number
« More »
CustomerPassword¶
Value Object
Class CustomerPassword
Represents a customer password
« More »
CustomerPostcode¶
Value Object
Class CustomerPostcode
Represents a customer postcode
« More »
CustomerServiceSettings¶
Value Object
Class CustomerServiceSettings
Represents the default settings of a customer/guest
« More »
CustomerStreet¶
Value Object
Class CustomerStreet
Represents a customer street
« More »
CustomerSuburb¶
Class CustomerSuburb
Represents a customer suburb
« More »
CustomerVatNumber¶
Value Object
Class CustomerVatNumber
Represents a tax ID number (VATIN)
« More »
Classes, interfaces and traits
OrderFactoryInterface¶
Interface OrderFactoryInterface
« More »
OrderInterface¶
Interface OrderInterface
« More »
OrderItemAttributeInterface¶
Interface OrderItemAttributeInterface
« More »
OrderItemAttributeRepositoryDeleterInterface¶
Interface OrderItemAttributeRepositoryDeleterInterface
« More »
OrderItemAttributeRepositoryFactoryInterface¶
Interface OrderItemAttributeRepositoryFactoryInterface
« More »
OrderItemAttributeRepositoryInterface¶
Interface OrderItemAttributeRepositoryInterface
« More »
OrderItemAttributeRepositoryReaderInterface¶
Interface OrderItemAttributeRepositoryReaderInterface
« More »
OrderItemAttributeRepositoryWriterInterface¶
Interface OrderItemAttributeRepositoryWriterInterface
« More »
OrderItemFactoryInterface¶
Interface OrderItemFactoryInterface
« More »
OrderItemInterface¶
Interface OrderItemInterface
« More »
OrderItemPropertyFactoryInterface¶
Interface OrderItemPropertyFactoryInterface
« More »
OrderItemPropertyRepositoryDeleterInterface¶
Interface OrderItemPropertyRepositoryDeleterInterface
« More »
OrderItemPropertyRepositoryReaderInterface¶
Interface OrderItemPropertyRepositoryReaderInterface
« More »
OrderItemPropertyRepositoryWriterInterface¶
Interface OrderItemPropertyRepositoryWriterInterface
« More »
OrderItemRepositoryDeleterInterface¶
Interface OrderItemRepositoryDeleterInterface
« More »
OrderItemRepositoryInterface¶
Interface OrderItemRepositoryInterface
« More »
OrderItemRepositoryReaderInterface¶
Interface OrderItemRepositoryReaderInterface
« More »
OrderItemRepositoryWriterInterface¶
Interface OrderItemRepositoryWriterInterface
« More »
OrderListGeneratorInterface¶
Interface OrderListGeneratorInterface
« More »
OrderObjectServiceInterface¶
Interface OrderObjectServiceInterface
« More »
OrderPaymentTypeInterface¶
Interface OrderPaymentTypeInterface
« More »
OrderReadServiceInterface¶
Interface OrderReadServiceInterface
« More »
OrderRepositoryDeleterInterface¶
Interface OrderRepositoryDeleterInterface
« More »
OrderRepositoryInterface¶
Interface OrderRepositoryInterface
« More »
OrderRepositoryReaderInterface¶
Interface OrderRepositoryReaderInterface
« More »
OrderRepositoryWriterInterface¶
Interface OrderRepositoryWriterInterface
« More »
OrderServiceSettingsInterface¶
Value Object
Interface OrderServiceSettings
Represents the default settings of an order
« More »
OrderShippingTypeInterface¶
Interface OrderShippingTypeInterface
« More »
OrderStatusHistoryReaderInterface¶
Interface OrderStatusHistoryReaderInterface
« More »
OrderStatusHistoryWriterInterface¶
Interface OrderStatusHistoryWriterInterface
« More »
OrderTotalFactoryInterface¶
Interface OrderTotalFactoryInterface
« More »
OrderTotalInterface¶
Interface OrderTotalInterface
« More »
OrderTotalRepositoryDeleterInterface¶
Interface OrderTotalRepositoryDeleterInterface
« More »
OrderTotalRepositoryInterface¶
Interface OrderTotalRepositoryInterface
« More »
OrderTotalRepositoryReaderInterface¶
Interface OrderTotalRepositoryReaderInterface
« More »
OrderTotalRepositoryWriterInterface¶
Interface OrderTotalRepositoryWriterInterface
« More »
OrderWriteServiceInterface¶
Interface OrderWriteServiceInterface
« More »
StoredOrderItemAttributeInterface¶
Interface StoredOrderItemAttributeInterface
« More »
StoredOrderItemInterface¶
Interface StoredOrderItemInterface
« More »
StoredOrderTotalInterface¶
Interface StoredOrderTotalInterface
« More »
Classes, interfaces and traits
OrderItemAttributeRepository¶
Class OrderItemAttributeRepository
« More »
OrderItemAttributeRepositoryDeleter¶
Class OrderItemAttributeRepositoryDeleter
« More »
OrderItemAttributeRepositoryReader¶
Class OrderItemAttributeRepositoryReader
« More »
OrderItemAttributeRepositoryWriter¶
Class OrderItemAttributeRepositoryWriter
« More »
OrderItemPropertyRepository¶
Class OrderItemPropertyRepository
« More »
OrderItemPropertyRepositoryDeleter¶
Class OrderItemPropertyRepositoryDeleter
« More »
OrderItemPropertyRepositoryReader¶
Class OrderItemPropertyRepositoryReader
« More »
OrderItemPropertyRepositoryWriter¶
Class OrderItemPropertyRepositoryWriter
« More »
OrderItemRepository¶
Class OrderItemRepository
« More »
OrderItemRepositoryDeleter¶
Class OrderItemRepositoryDeleter
« More »
OrderItemRepositoryReader¶
Class OrderItemRepositoryReader
« More »
OrderItemRepositoryWriter¶
Class OrderItemRepositoryWriter
« More »
OrderRepository¶
Class OrderRepository
« More »
OrderRepositoryDeleter¶
Class OrderRepositoryDeleter
« More »
OrderRepositoryReader¶
Class OrderRepositoryReader
« More »
OrderRepositoryWriter¶
Class OrderRepositoryWriter
« More »
OrderTotalRepository¶
Class OrderTotalRepository
« More »
OrderTotalRepositoryDeleter¶
Class OrderTotalRepositoryDeleter
« More »
OrderTotalRepositoryReader¶
Class OrderTotalRepositoryReader
« More »
OrderTotalRepositoryWriter¶
Class OrderTotalRepositoryWriter
« More »
Classes, interfaces and traits
CategoryFactoryInterface¶
Interface CategoryFactoryInterface
This interface defines methods for creating Category and StoredCategory objects with its CategorySettings dependency.
« More »
CategoryInterface¶
Interface CategoryInterface
« More »
CategoryListProviderFactoryInterface¶
Interface CategoryListProviderFactoryInterface
This interface defines methods for creating CategoryListProvider objects for a specific language and filter of
customer status permissions with its dependencies.
« More »
CategoryListProviderInterface¶
Interface CategoryListProviderInterface
This interface defines methods for creating a list of flattened categories with just its essential data.
The list of categories is filtered by its parent category ID and customer status permissions and for simplicity
it contains language specific data only in one language.
« More »
CategoryObjectServiceInterface¶
Interface CategoryObjectServiceInterface
This interface defines methods for creating new categories objects with its default values.
« More »
CategoryReadServiceInterface¶
Interface CategoryReadServiceInterface
This interface defines methods for retrieving data of a particular category and a collection of specific categories.
« More »
CategoryRepositoryDeleterInterface¶
Interface CategoryRepositoryDeleterInterface
This interface defines methods for deleting category records from the database and is used in the category
repository among the interfaces for writing and reading category records.
« More »
CategoryRepositoryInterface¶
Interface CategoryRepositoryInterface
This interface defines methods for handling the database operations that concern the category records of the
database. It provides a layer for more complicated methods that use the writer, reader and deleter.
« More »
CategoryRepositoryReaderInterface¶
Interface CategoryRepositoryReaderInterface
This interface defines methods for fetching category records from the database and is used in the category
repository among the classes for writing and deleting category records.
« More »
CategoryRepositoryWriterInterface¶
Interface CategoryRepositoryWriterInterface
This interface defines methods for creating and updating specific category records in the database and is used in the category
repository among the interfaces for reading and deleting category records.
« More »
CategoryServiceSettingsInterface¶
Interface CategoryServiceSettingsInterface
This class contains the file system path to the image directory by using specific constants which are defined in
the config. It is used by the factory to build the proper service environment.
By encapsulating this dependency the code becomes more explicit and testable.
« More »
CategorySettingsInterface¶
Interface CategorySettingsInterface
This interface defines methods for storing and retrieving some settings regarding display and visibility mode of
category related data and is used within a CategoryInterface.
« More »
CategorySettingsRepositoryInterface¶
Interface CategorySettingsRepositoryInterface
This interface handles the database operations that concern settings regarding display and visibility mode of category
related data of the database. It provides a layer for more complicated methods that use the writer, reader and
deleter.
« More »
CategorySettingsRepositoryReaderInterface¶
Interface CategorySettingsRepositoryReaderInterface
This interface defines methods for fetching particular columns of specific category records in the database.
The category settings are stored in the categories table and are more related to display and visibility modes of
category related data.
« More »
CategorySettingsRepositoryWriterInterface¶
Interface CategorySettingsRepositoryWriterInterface
This interface defines methods for updating particular columns of specific category records in the database.
The category settings are stored in the categories table and are more related to display and visibility modes of
category related data.
« More »
CategoryWriteServiceInterface¶
Interface CategoryWriteServiceInterface
This interface defines methods for creating, updating and deleting categories data.
« More »
StoredCategoryInterface¶
Interface StoredCategoryInterface
This interface extends the Category CategoryInterface and represents a persisted category with an unique ID.
« More »
Classes, interfaces and traits
CategoryRepository¶
Class CategoryRepository
This class handles the database operations that concern the category records of the
database. It provides a layer for more complicated methods that use the writer, reader and deleter.
« More »
CategoryRepositoryDeleter¶
Class CategoryRepositoryDeleter
This class deletes category records from the database and is used in the category repository among the classes for
writing and reading category records.
« More »
CategoryRepositoryReader¶
Class CategoryRepositoryReader
This class provides methods for fetching specific category records from the database and is used in the category
repository among the classes for writing and deleting category records.
« More »
CategoryRepositoryWriter¶
Class CategoryRepositoryWriter
This class provides methods for creating and updating specific category records in the database and is used in the category
repository among the classes for reading and deleting category records.
« More »
CategorySettingsRepository¶
Class CategorySettingsRepository
This class handles the database operations that concern settings regarding display and visibility mode of category
related data of the database. It provides a layer for more complicated methods that use the writer, reader and
deleter.
« More »
CategorySettingsRepositoryReader¶
Class CategorySettingsRepositoryReader
This class provides methods for fetching particular columns of specific category records in the database.
The category settings are stored in the categories table and are more related to display and visibility modes of
category related data.
« More »
CategorySettingsRepositoryWriter¶
Class CategorySettingsRepositoryWriter
This class provides methods for updating particular columns of specific category records in the database.
The category settings are stored in the categories table and are more related to display and visibility modes of
category related data.
« More »
Classes, interfaces and traits
ProductCategoryLinkerInterface¶
Interface ProductCategoryLinkerInterface
« More »
ProductFactoryInterface¶
Interface ProductFactoryInterface
« More »
ProductImageContainerInterface¶
Interface ProductImageContainerInterface
« More »
ProductImageContainerRepositoryInterface¶
Interface ProductImageContainerRepositoryInterface
« More »
ProductImageInterface¶
Interface ProductImageInterface
« More »
ProductImagePathsSettingsInterface¶
Interface ProductImagePathsSettingsInterface
« More »
ProductImageProcessingInterface¶
Interface ProductImageProcessingInterface
« More »
ProductInterface¶
Interface ProductInterface
« More »
ProductListProviderFactoryInterface¶
Interface ProductListProviderFactoryInterface
« More »
ProductListProviderInterface¶
Interface ProductListProviderInterface
« More »
ProductObjectServiceInterface¶
Interface ProductObjectServiceInterface
« More »
ProductPermissionSetterInterface¶
Interface ProductPermissionSetterInterface
« More »
ProductReadServiceInterface¶
Interface ProductReadServiceInterface
« More »
ProductRepositoryDeleterInterface¶
Interface ProductRepositoryDeleterInterface
« More »
ProductRepositoryInterface¶
Interface ProductRepositoryInterface
« More »
ProductRepositoryReaderInterface¶
Interface ProductRepositoryReaderInterface
« More »
ProductRepositoryWriterInterface¶
Interface ProductRepositoryWriterInterface
« More »
ProductSettingsInterface¶
Interface ProductSettingsInterface
« More »
ProductSettingsRepositoryInterface¶
Interface ProductSettingsRepositoryInterface
« More »
ProductSettingsRepositoryReaderInterface¶
Interface ProductSettingsRepositoryReaderInterface
« More »
ProductSettingsRepositoryWriterInterface¶
Interface ProductSettingsRepositoryWriterInterface
« More »
ProductWriteServiceInterface¶
Interface ProductWriteServiceInterface
« More »
StoredProductInterface¶
Interface StoredProductInterface
« More »