Sunnysideup\Ecommerce\Model\Process\OrderSteps\OrderStepSendAdminNotification
Synopsis
class OrderStepSendAdminNotification
extends OrderStep
implements
OrderStepInterface
{
- // members
- protected string $emailClassName = OrderReceiptEmail::class;
- private static array $defaults = ;
- // Inherited members from OrderStep
- protected string $emailClassName;
- protected string $relevantLogEntryClassName;
- // methods
- public bool initStep()
- public void doStep()
- public null|OrderStep nextStep()
- public FieldList addOrderStepFields()
- protected bool hasCustomerMessage()
- protected string myDescription()
- // Inherited methods from OrderStep
- public void Title()
- public void getTitle()
- public void CustomerCanEditNice()
- public void getCustomerCanEditNice()
- public void CustomerCanPayNice()
- public void getCustomerCanPayNice()
- public void CustomerCanCancelNice()
- public void getCustomerCanCancelNice()
- public void ShowAsUncompletedOrderNice()
- public void getShowAsUncompletedOrderNice()
- public void ShowAsInProcessOrderNice()
- public void getShowAsInProcessOrderNice()
- public void ShowAsCompletedOrderNice()
- public void getShowAsCompletedOrderNice()
- public void HideFromEveryone()
- public void HideStepFromCustomerNice()
- public void getHideStepFromCustomerNice()
- public void i18n_singular_name()
- public void i18n_plural_name()
- public static DataList admin_manageable_steps()
- public static DataList non_admin_manageable_steps()
- public static OrderStep last_order_step()
- public static array bad_order_step_ids()
- public static void get_status_id_from_code()
- public static array get_codes_for_order_steps_to_include()
- public static array get_not_created_codes_for_order_steps_to_include()
- public string getMyCode()
- public void populateDefaults()
- public FieldList getCMSFields()
- public string CMSEditLink()
- public null|object AlternativeDisplayPage()
- public Form CustomerOrderStepForm()
- public FieldList addOrderStepFields()
- public void addQuickLogEntryButton()
- public ValidationResult validate()
- public bool initStep()
- public bool doStep()
- public null|OrderStep nextStep()
- public bool hasPassed()
- public bool hasPassedOrIsEqualTo()
- public bool hasNotPassed()
- public void isBefore()
- public string getEmailClassName()
- public void setEmailClassName()
- public bool hasBeenSent()
- public void HasCustomerMessageNice()
- public void getHasCustomerMessageNice()
- public void CalculatedEmailSubject()
- public void CalculatedCustomerMessage()
- public void ShowAsSummary()
- public void getShowAsSummary()
- public string NameAndDescription()
- public void getNameAndDescription()
- public int CalculatedDeferTimeInSeconds()
- public void getRelevantLogEntryClassName()
- public void setRelevantLogEntryClassName()
- public null|OrderStatusLog RelevantLogEntry()
- public DataList RelevantLogEntries()
- public bool canCreate()
- public bool canView()
- public void canOverrideCanViewForOrder()
- public bool canEdit()
- public bool canDelete()
- public void requireDefaultRecords()
- protected void yesOrNoNiceHelper()
- protected void onBeforeWrite()
- protected void onBeforeDelete()
- protected void onAfterDelete()
- protected bool isDefaultStatusOption()
- protected bool; sendEmailForStep()
- protected void testEmailLink()
- protected bool hasCustomerMessage()
- protected void humanReadeableDeferTimeInSeconds()
- protected bool canBeDefered()
- protected void NextOrderStep()
- protected void PreviousOrderStep()
- protected void checkValidityOfOrderSteps()
- protected string myDescription()
Hierarchy
Extends
Implements
Members
private
- $defaults
protected
- $emailClassName — string
- $emailClassName — string
- $relevantLogEntryClassName
—
string
The OrderStatusLog that is relevant to the particular step.
Methods
protected
- hasCustomerMessage() — For some ordersteps this returns true...
- myDescription() — Explains the current order step.
public
- addOrderStepFields() — Allows the opportunity for the Order Step to add any fields to Order::getCMSFields.
- doStep() — send invoice to customer or in case this is not selected, it will send a message to the shop admin only The latter is useful in case the payment does not go through (and no receipt is received).
- initStep() — can run step once order has been submitted.
- nextStep() — can do next step once the admin notification has been sent.
Inherited from Sunnysideup\Ecommerce\Model\Process\OrderStep
protected
- NextOrderStep()
- PreviousOrderStep()
- canBeDefered() — can this order step be delayed? in general, if there is a customer message we should be able to delay it.
- checkValidityOfOrderSteps()
- hasCustomerMessage() — For some ordersteps this returns true...
- humanReadeableDeferTimeInSeconds()
- isDefaultStatusOption()
- myDescription() — Explains the current order step.
- onAfterDelete() — standard SS method.
- onBeforeDelete() — move linked orders to the next status standard SS method.
- onBeforeWrite() — standard SS method.
- sendEmailForStep() — return true if done already or mailed successfully now.
- testEmailLink() — returns a link that can be used to test the email being sent during this step this method returns NULL if no email is being sent OR if there is no suitable Order to test with...
- yesOrNoNiceHelper()
public
- AlternativeDisplayPage() — tells the order to display itself with an alternative display page.
- CMSEditLink() — link to edit the record.
- CalculatedCustomerMessage()
- CalculatedDeferTimeInSeconds() — This allows you to set the time to something other than the standard DeferTimeInSeconds value based on the order provided.
- CalculatedEmailSubject()
- CustomerCanCancelNice() — casted variable.
- CustomerCanEditNice() — casted variable.
- CustomerCanPayNice() — casted variable.
- CustomerOrderStepForm() — A form that can be used by the Customer to progress step!
- HasCustomerMessageNice() — Formatted answer for "hasCustomerMessage".
- HideFromEveryone() — do not show in steps at all.
- HideStepFromCustomerNice() — casted variable.
- NameAndDescription() — Formatted answer for "hasCustomerMessage".
- RelevantLogEntries() — returns the OrderStatusLogs that are relevant to this step.
- RelevantLogEntry() — returns the OrderStatusLog that is relevant to this step.
- ShowAsCompletedOrderNice() — casted variable.
- ShowAsInProcessOrderNice() — casted variable.
- ShowAsSummary() — Formatted answer for "hasCustomerMessage".
- ShowAsUncompletedOrderNice()
- Title() — casted variable.
- addOrderStepFields() — Allows the opportunity for the Order Step to add any fields to Order::getCMSFields.
- addQuickLogEntryButton()
- admin_manageable_steps() — returns all the order steps that the admin should / can edit....
- bad_order_step_ids() — return StatusIDs (orderstep IDs) from orders that are bad....
- canCreate() — Standard SS method These are only created programmatically.
- canDelete() — Standard SS method.
- canEdit() — standard SS method.
- canOverrideCanViewForOrder() — the default for this is TRUE, but for completed order steps.
- canView() — Standard SS method.
- doStep() — doStep: should only be able to run this function once (init stops you from running it twice - in theory....) runs the actual step.
- getCMSFields()
- getCustomerCanCancelNice()
- getCustomerCanEditNice()
- getCustomerCanPayNice()
- getEmailClassName() — returns the email class used for emailing the customer during a specific step (IF ANY!).
- getHasCustomerMessageNice()
- getHideStepFromCustomerNice()
- getMyCode()
- getNameAndDescription()
- getRelevantLogEntryClassName()
- getShowAsCompletedOrderNice()
- getShowAsInProcessOrderNice()
- getShowAsSummary()
- getShowAsUncompletedOrderNice()
- getTitle()
- get_codes_for_order_steps_to_include()
- get_not_created_codes_for_order_steps_to_include() — returns a list of ordersteps that have not been created yet.
- get_status_id_from_code() — turns code into ID.
- hasBeenSent() — Has an email been sent to the customer for this order step.
- hasNotPassed()
- hasPassed() — Checks if a step has passed (been completed) in comparison to the current step.
- hasPassedOrIsEqualTo()
- i18n_plural_name()
- i18n_singular_name()
- initStep() — initStep: makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt).
- isBefore() — Opposite of hasPassed.
- last_order_step()
- nextStep() — nextStep: returns the next step (after it checks if everything is in place for the next step to run...).
- non_admin_manageable_steps() — returns all the order steps that the admin should / can edit....
- populateDefaults() — standard SS method.
- requireDefaultRecords() — standard SS method USED TO BE: Unpaid,Query,Paid,Processing,Sent,Complete,AdminCancelled,MemberCancelled,Cart.
- setEmailClassName() — sets the email class used for emailing the customer during a specific step (IF ANY!).
- setRelevantLogEntryClassName()
- validate()