Skip to main content

Settings


Settings

The Settings Model.

This model defines the settings for Marketplace. All settings are currently available to set in the Craft control panel, and saved to your project config.

  • Full name: \kennethormandy\marketplace\models\Settings
  • Parent class: Model

Properties

secretApiKey

The secret Stripe API key.

public string $secretApiKey

defaultFeeMultiplier

A simple, Marketplace-wide default fee to use. This can be left as null, and all fees can be determined during the FeesEvent instead.

public ?float $defaultFeeMultiplier

clientId

When using OAuth, this should be set to the OAuth Client ID for Stripe Connect, from the Stripe dashboard.

public ?string $clientId

providerHandle

When using OAuth, this should be set tot the handle of the OAuth provider to use.

public string $providerHandle

The default is the handle for Marketplace’s own StripeExpressProvider.


usePayeeFieldType

Whether or not to make the deprecated Marketplace Payee Field available.

public bool $usePayeeFieldType

Methods

getClientId

Returns the Client ID setting.

public getClientId(): string

getSecretApiKey

Returns the secret Stripe API key.

public getSecretApiKey(): string

getDefaultFeeMultiplier

Returns the default fee multiplier.

public getDefaultFeeMultiplier(): ?float

rules

Returns the validation rules for attributes.

public rules(): array

See Also:



Automatically generated on 2024-11-04