Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Interfaces

  • ProductCategoryLinkerInterface
  • ProductFactoryInterface
  • ProductImageContainerInterface
  • ProductImageContainerRepositoryInterface
  • ProductImageInterface
  • ProductImagePathsSettingsInterface
  • ProductImageProcessingInterface
  • ProductInterface
  • ProductListProviderFactoryInterface
  • ProductListProviderInterface
  • ProductObjectServiceInterface
  • ProductPermissionSetterInterface
  • ProductReadServiceInterface
  • ProductRepositoryDeleterInterface
  • ProductRepositoryInterface
  • ProductRepositoryReaderInterface
  • ProductRepositoryWriterInterface
  • ProductSettingsInterface
  • ProductSettingsRepositoryInterface
  • ProductSettingsRepositoryReaderInterface
  • ProductSettingsRepositoryWriterInterface
  • ProductWriteServiceInterface
  • StoredProductInterface

Interface ProductSettingsInterface

Interface ProductSettingsInterface

Direct known implementers

ProductSettings

Package: Product\Interfaces
Category: System
Located at Services/Core/Product/Entities/Interfaces/ProductSettingsInterface.inc.php

Methods summary

public string
# getDetailsTemplate( )

Returns the details template name.

Returns the details template name.

Returns

string
public string
# getOptionsDetailsTemplate( )

Returns the options details template.

Returns the options details template.

Returns

string
public string
# getOptionsListingTemplate( )

Returns the options listing template.

Returns the options listing template.

Returns

string
public boolean
# showOnStartpage( )

Returns true when the product is displayed on the start page, false otherwise.

Returns true when the product is displayed on the start page, false otherwise.

Returns

boolean
public integer
# getStartpageSortOrder( )

Returns the sort position.

Returns the sort position.

Returns

integer
public boolean
# showAddedDateTime( )

Returns true when the added date time is to be displayed, false otherwise.

Returns true when the added date time is to be displayed, false otherwise.

Returns

boolean
public boolean
# showQuantityInfo( )

Returns true when the quantity info is to be displayed, false otherwise.

Returns true when the quantity info is to be displayed, false otherwise.

Returns

boolean
public boolean
# showWeight( )

Returns true when the weight is to be displayed, false otherwise.

Returns true when the weight is to be displayed, false otherwise.

Returns

boolean
public boolean
# showPriceOffer( )

Returns true when the price offer is to be displayed, false otherwise.

Returns true when the price offer is to be displayed, false otherwise.

Returns

boolean
public integer
# getPriceStatus( )

Returns the price status.

Returns the price status.

Returns

integer
public float
# getMinOrder( )

Returns the minimum order value.

Returns the minimum order value.

Returns

float
public float
# getGraduatedQuantity( )

Returns the graduated quantity.

Returns the graduated quantity.

Returns

float
public boolean
# isSitemapEntry( )

Returns true when the product is to be displayed in the sitemap, false otherwise.

Returns true when the product is to be displayed in the sitemap, false otherwise.

Returns

boolean
public string
# getSitemapPriority( )

Returns the sitemap priority.

Returns the sitemap priority.

Returns

string
public string
# getSitemapChangeFreq( )

Returns the sitemap change frequency.

Returns the sitemap change frequency.

Returns

string
public boolean
# showPropertiesPrice( )

Returns true when the properties price is to be displayed, false otherwise.

Returns true when the properties price is to be displayed, false otherwise.

Returns

boolean
public string
# getPropertiesDropdownMode( )

Returns the properties dropdown mode.

Returns the properties dropdown mode.

Returns

string
public boolean
# usePropertiesCombisWeight( )

Returns true when the properties combis weight is to be used, false otherwise.

Returns true when the properties combis weight is to be used, false otherwise.

Returns

boolean
public integer
# getPropertiesCombisQuantityCheckMode( )

Returns the mode which is used for the quantity check.

Returns the mode which is used for the quantity check.

0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check

Returns

integer
public boolean
# usePropertiesCombisShippingTime( )

Returns true when the properties combis shipping time is to be used, false otherwise.

Returns true when the properties combis shipping time is to be used, false otherwise.

Returns

boolean
public ProductSettingsInterface|ProductSettingsInterface
# setDetailsTemplate( StringType $template )

Sets the details listing template.

Sets the details listing template.

Parameters

$template
Name of the template

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setOptionsDetailsTemplate( StringType $template )

Sets the options details template.

Sets the options details template.

Parameters

$template
Name of the template.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setOptionsListingTemplate( StringType $template )

Sets the options listing template.

Sets the options listing template.

Parameters

$template
Name of the template.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowOnStartpage( BoolType $status )

Shows or hides a product on the start page.

Shows or hides a product on the start page.

Parameters

$status
True when it should be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setStartpageSortOrder( IntType $sortOrder )

Sets the start page sort order.

Sets the start page sort order.

Parameters

$sortOrder
Sort position.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowAddedDateTime( BoolType $status )

Shows or hides the added date time of a product.

Shows or hides the added date time of a product.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowQuantityInfo( BoolType $status )

Shows or hides the quantity info of a product.

Shows or hides the quantity info of a product.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowWeight( BoolType $status )

Shows or hides the weight of a product.

Shows or hides the weight of a product.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowPriceOffer( BoolType $status )

Shows or hides the price offer of a product.

Shows or hides the price offer of a product.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setPriceStatus( IntType $status )

Sets the price status.

Sets the price status.

Parameters

$status
New price status.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setMinOrder( DecimalType $quantity )

Sets the min order value.

Sets the min order value.

Parameters

$quantity
New minimum order.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setGraduatedQuantity( DecimalType $quantity )

Sets the graduated quantity.

Sets the graduated quantity.

Parameters

$quantity
New graduated quantity.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setSitemapEntry( BoolType $status )

Shows or hides a product in the sitemap.

Shows or hides a product in the sitemap.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setSitemapPriority( StringType $priority )

Sets the sitemap priority.

Sets the sitemap priority.

Parameters

$priority
New sitemap priority.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setSitemapChangeFreq( StringType $freq )

Sets the sitemap change frequency.

Sets the sitemap change frequency.

Parameters

$freq
New sitemap change frequency.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setShowPropertiesPrice( BoolType $status )

Shows or hides the properties price of a product.

Shows or hides the properties price of a product.

Parameters

$status
True when it is to be displayed, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setPropertiesDropdownMode( StringType $mode )

Sets the properties dropdown mode.

Sets the properties dropdown mode.

Parameters

$mode
New properties dropdown mode.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setUsePropertiesCombisWeight( BoolType $status )

Determine whether the properties combis weight is to be used or not.

Determine whether the properties combis weight is to be used or not.

Parameters

$status
True when it is to be used, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public ProductSettings|ProductSettingsInterface
# setPropertiesCombisQuantityCheckMode( IntType $status )

Determine which mode for the quantity check should be used.

Determine which mode for the quantity check should be used.

0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check

Parameters

$status

Returns

ProductSettings|ProductSettingsInterface
$this Same ProductSettings instance for chained method calls.
public ProductSettingsInterface|ProductSettingsInterface
# setUsePropertiesCombisShippingTime( BoolType $status )

Determine whether the properties combis shipping time is to be used or not.

Determine whether the properties combis shipping time is to be used or not.

Parameters

$status
True when it is to be used, false otherwise.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
public boolean
# isPermittedCustomerStatus( IdType $customerStatusId )

Returns true when the customer status is permitted, false otherwise.

Returns true when the customer status is permitted, false otherwise.

Parameters

$customerStatusId
Id of customer status.

Returns

boolean
public ProductSettingsInterface|ProductSettingsInterface
# setPermittedCustomerStatus( IdType $customerStatusId, BoolType $permitted )

Sets customer status permissions.

Sets customer status permissions.

Parameters

$customerStatusId
Id of customer status.
$permitted
Is customer permitted or not.

Returns

ProductSettingsInterface|ProductSettingsInterface
$this Same ProductSettingsInterface instance for chained method calls.
API documentation generated by ApiGen