System

Contracts

SystemInformationRepositoryContract

Repository for SystemInformation

Namespace

Plenty\Modules\System\Contracts

Methods

public loadValue(string $key):void

Loads a system information value by key

Parameters

string

$key

WebstoreConfigurationRepositoryContract

Repository for Webstore Configuration

Namespace

Plenty\Modules\System\Contracts

Methods

public findByPlentyId(int $plentyId):WebstoreConfiguration

Get the WebstoreConfiguration by plentyId

Parameters

int

$plentyId

public findByWebstoreId(int $webstoreId):WebstoreConfiguration

Get the WebstoreConfiguration by webstoreId

Parameters

int

$webstoreId

public updateByPlentyId(array $data, int $plentyId):WebstoreConfiguration

Parameters

array	$data
int	$plentyId

WebstoreRepositoryContract

Repository for Webstore

Namespace

Plenty\Modules\System\Contracts

Methods

public loadAll(array $columns = []):array

Shows all webstores

Parameters

array

$columns

public loadAllPreview():array

Shows a preview of all webstores with id and name

public findByPlentyId(int $plentyId):Webstore

Shows a specific webstore from type plentymarkets

Parameters

int

$plentyId

public findByStoreIdentifier(int $storeIdentifier):Webstore

Shows a specific webstore

Parameters

int

$storeIdentifier

public findById(int $clientId):Webstore

Shows a specific webstore

Parameters

int

$clientId

The client ID (webstore ID).

Models

Webstore

The webstore model appending the WebstoreConfiguration

Namespace

Plenty\Modules\System\Models

Properties

Type	Name	Description
int	id	The ID of the client (store)
string	name	The name of the client (store)
string	type	The type of the client (store)
int	storeIdentifier	The identifier of the client (store)
WebstoreConfiguration	configuration	The configuration information of the client (store)
	locations	The accounting locations of the client (store)
PluginSet	pluginSet	The plugin set of the client (store)
int	pluginSetId	The plugin set id of the client (store)

Methods

public toArray()

Returns this model as an array.

WebstoreConfiguration

The Webstore Configuration Model

Namespace

Plenty\Modules\System\Models

Properties

Type	Name	Description
int	webstoreId
int	error404ContentPageId
int	attributesDropDown
int	attributeSelectDefaultOption
int	attributeVariantCheck
int	attributeWithMarkup
int	bankContentPageId
int	basketReservationTime
int	cancellationRightsContentPageId
int	categoryItemCount
int	categoryLevelLimit
int	closed
int	defaultAccountingLocation
string	defaultCurrency
string	defaultLanguage
string	defaultLayout
int	defaultShippingCountryId
array	defaultShippingCountryList
array	defaultCurrencyList
int	defaultParcelServiceId
int	defaultParcelServicePresetId
int	defaultMethodOfPaymentId
int	defaultCustomerClassId
int	dhlPackstationValidation
int	dhlAllowPackstationActive
float	dhlLimitOrderAmountForPackstation
int	dhlAllowPostidentActive
float	displayAttributeMarkup
string	displayItemName
int	displayItemOnly4Customer
int	displayPriceColumn
int	displayPriceNetto
string	doctype
string	domain
string	domainSsl
int	dontSplitItemBundle
string	faviconPath
int	frontPageContentPageId
int	helpContentPageId
int	itemNotFoundContentPageId
int	paymentMethodsContentPageId
int	contactContentPageId
int	legalDisclosureContentPageId
int	blogRatingActive
int	blogMaxRatingPoints
int	blogCommentsActive
int	blogNewFeedbackVisibility
int	blogCustomerNameVisibility
int	itemMaxRatingPoints
int	itemCommentsActive
int	itemNewFeedbackVisibility
int	itemCustomerNameVisibility
int	categoryRatingActive
int	categoryMaxRatingPoints
int	categoryCommentsActive
int	categoryNewFeedbackVisibility
int	categoryCustomerNameVisibility
int	choiceNominationRatingActive
int	choiceNominationMaxRatingPoints
int	choiceNominationCommentsActive
int	choiceNominationNewFeedbackVisibility
int	choiceNominationCustomerNameVisibility
int	feedbackRatingActive
int	feedbackMaxRatingPoints
int	feedbackCommentsActive
int	feedbackNewFeedbackVisibility
int	feedbackCustomerNameVisibility
array	languageList
int	languageMode
int	loginMode
int	oversellingWarning
int	maxLoginAttempts
int	mobileRedirectActive
int	mobileRedirectUrl
int	mobileRedirectItemUrl
string	name
int	newsletterDirId
int	paypalAccount
array	ebayAccount
int	privacyPolicyContentPageId
string	rootDir
int	sessionLifetime
int	shippingContentPageId
int	socialMedia
int	termsConditionsContentPageId
string	trustedShopsCertificationDeSealHtml
string	trustedShopsCertificationDeTrustedShopsId
string	trustedShopsCertificationEnSealHtml
string	trustedShopsCertificationEnTrustedShopsId
string	trustedShopsCertificationFrSealHtml
string	trustedShopsCertificationFrTrustedShopsId
string	urlFacebook
string	urlFileExtension
string	urlGooglePlus
string	urlItemCategory
string	urlItemContent
string	urlLinking
string	urlNeedle
string	urlTitleItemContent
string	urlTitleItemName
string	urlTwitter
int	useCharacterCrossSelling
int	useDefaultShippingCountryAsShopCountry
int	calcEbayShippingCostsActive
int	autoGroupOpenEbayTransactions
int	calcRicardoShippingCostsActive
int	calcHoodShippingCostsActive
int	ebayDownsellingActive
int	addressCheckRegistrationSave
int	addressCheckRegistrationInput
int	addressCheckInvoiceDetailsSave
int	addressCheckInvoiceDetailsInput
int	addressCheckShippingDetailsSave
int	addressCheckShippingDetailsInput
int	addressCheckCustomerDetailsSave
int	addressCheckCustomerDetailsInput
int	addressCheckAfterDays
int	facebookLoginActive
int	itemCategorySorting1
int	itemCategorySorting2
int	itemSortByMonthlySales
int	showBasePriceActive
int	jumpPaymentActive
int	jumpShippingActive
int	showContentTermsFsk
int	newsletterRegistrationActive
int	ignoreCouponMinOrderValueActive
int	ipAddressSaveInactive
int	reuseOrderActive
int	editOrderActive
int	currencySymbol
int	externalVatCheckInactive
int	customerRegistrationCheck
int	schedulerPropertyID
int	customerLoginMethod
int	watchlistActive
int	itemwishlistActive
int	documentsActive
int	dynamicExportActive
int	couponVisibilityActive
int	retoureMethod
int	itemlistPrice
int	itemlistWeight
int	schedulerActive
int	editSchedulerPaymentMethodActive
int	showSEPAMandateDownload
int	changeEmailActive
int	changePasswordActive
int	changePasswordSendmail
int	logoutHiddenActive
int	displayStatusInactive
int	displayMyAccountPaymentDateInactive
int	displayMyAccountDeliveryDateInactive
int	displayWeightInactive
int	displayInvoiceDownload
int	displayShippingDateActive
int	minimumOrderValue
array	itemAvailabilityDisabledList
array	itemMeasureUnit
int	quickloginValidDays
int	captchaCodeInactive
int	itemListingOrderImportItemName
int	orderRowDeliveryDate
array	browserLanguage
int	categoryRedirectActive
int	itemRedirectActive
string	googleRecaptchaApiWebsitekey
string	itemSearchEngine
bool	itemRatingAllowComments
bool	itemRatingMaxRatingPoints
bool	itemRatingActive
int	currencyConversion
int	urlTrailingSlash
bool	isCookieSubdomainIndependent
string	itemSearchOperator
string	itemAutocompleteSearchOperator

Methods

public toArray()

Returns this model as an array.

Module

Contracts

PlentyModuleRepositoryContract

Repository for PlentyModule

Namespace

Plenty\Modules\System\Module\Contracts

Methods

public isActive(string $module):bool

Returns whether or not a given module is active

Parameters

string

$module

The keyPath for the module

public isHidden(string $module):bool

Returns whether or not a given module is hidden

Parameters

string

$module

The keyPath for the module

public getQuantity(string $module):int

Get the 'quantity' attribute of the given module

Parameters

string

$module

keyPath of the module in Question

public getValueForModule(string $module, string $value):void

Get any value for any module

Parameters

string	$module	The keyPath of the module
string	$value	The key for the value

Statistic

Models

CloudMetrics

Represent cloud metrics for a specific day

Namespace

Plenty\Modules\System\Statistic\Models

Properties

Type	Name	Description
int	plentyId
string	date
int	webspaceMB
int	webspaceDocumentsMB
int	websiteContentMB
int	cloudSpaceDocumentsMB
int	cloudSpaceItemsMB
int	cloudSpacePrivateMB
int	cloudSpacePublicMB
int	dbSpaceMb
int	websiteTrafficMB
int	cdnTrafficMB
int	cdnTrafficCount
int	contentCachingPutRequests
int	contentCachingGetRequests
int	userAccounts
int	warehouses
int	warehousesSales
int	facetSearchItems
int	facetSearchCalls
int	items
int	itemVariations
int	hbciDailyAccounts
int	hbciHourlyAccounts
int	ebicsDailyAccounts
int	ebicsHourlyAccounts
int	emailAccountsWithTicketGeneration
int	ebayAccountsWithTicketGeneration

Methods

public toArray()

Returns this model as an array.

CloudMetricsList

Represent a list of cloud metrics objects

Namespace

Plenty\Modules\System\Statistic\Models

Properties

Type	Name	Description
int	page
int	totalsCount
bool	isLastPage
array	objects

Methods

public toArray()

Returns this model as an array.