SilverCart\Checkout\CheckoutStep3
Checkout step 3.
Checkout step to choose the shipping method.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class CheckoutStep3
extends CheckoutStep
{
- // members
- private static array $allowed_actions = ;
- protected bool $skipShippingStep = NULL;
- // Inherited members from CheckoutStep
- protected static array $customOutput;
- protected Checkout $checkout;
- protected Controller $controller;
- // methods
- public void process()
- public CheckoutChooseShippingMethodForm CheckoutChooseShippingMethodForm()
- public bool IsVisible()
- public bool SkipShippingStep()
- public Address|null getShippingAddress()
- public DBHTMLText StepSummary()
- // Inherited methods from CheckoutStep
- public void __construct()
- public void doInit()
- public void init()
- public void process()
- public void complete()
- public array getTemplates()
- public DBHTMLText forTemplate()
- public array allowedActions()
- public bool hasAction()
- public bool IsVisible()
- public bool IsCurrentStep()
- public bool IsCompleted()
- public bool IsPreviousStepCompleted()
- public bool IsAccessible()
- public int StepNumber()
- public int getStepIndex()
- public int VisibleStepNumber()
- public string StepTitle()
- public Checkout getCheckout()
- public Controller getController()
- public CheckoutStep setController()
- public static void addCustomOutput()
- public string CustomOutput()
- public bool canAccess()
- public void resetNextSteps()
- public void redirectToNextStep()
Hierarchy
Extends
Members
private
- $allowed_actions
—
array
List of allowed actions.
protected
- $checkout
—
SilverCart\Checkout\Checkout
Checkout. - $controller
—
SilverStripe\Control\Controller
Controller. - $customOutput
—
array
A list of custom output to add to the content area. - $skipShippingStep
—
SilverCart\Checkout\bool
Determines whether to skip this step or not.
Methods
public
- CheckoutChooseShippingMethodForm() — Returns the CheckoutChooseShippingMethodForm.
- IsVisible() — Returns whether this step is visible.
- SkipShippingStep() — Returns whether to skip this step or not.
- StepSummary() — Returns the rendered step summary.
- getShippingAddress() — Returns the context shipping address.
- process() — Custom checkout step processor.
Inherited from SilverCart\Checkout\CheckoutStep
public
- CustomOutput() — Returns the combined custom output snippets as string.
- IsAccessible() — Returns whether this step is accessible.
- IsCompleted() — Returns whether this step is completed.
- IsCurrentStep() — Returns whether this step is the current step.
- IsPreviousStepCompleted() — Returns whether the previous step is completed.
- IsVisible() — Returns whether this step is visible.
- StepNumber() — Returns this step's number.
- StepTitle() — Returns the step title.
- VisibleStepNumber() — Returns this step's number respecting its visibility.
- addCustomOutput() — Add a custom output snippet.
- allowedActions() — Get a array of allowed actions defined on this step, any parent classes or extensions.
- canAccess() — Returns whether this step can be accessed.
- complete() — Marks this step as completed.
- doInit() — Optional method to initialize a checkout step.
- forTemplate() — Return a rendered version of this step.
- getCheckout() — Returns the checkout.
- getController() — Returns the controller.
- getStepIndex() — Returns this step's index.
- getTemplates() — Returs the ordered list of preferred templates for rendering this form If the template isn't set, then default to the form class name e.g "Form".
- hasAction() — Returns whether the given $action exists on this checkout step.
- init() — Optional method to initialize a checkout step.
- process() — Custom checkout step processor.
- redirectToNextStep() — Redirects to the next step.
- resetNextSteps() — Removes all following steps out of completed step list.
- setController() — Sets the controller.