From 43fb424433093ccb181bfc515035b582e30e0f9a Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Tue, 10 Jun 2008 22:47:52 +0000 Subject: [PATCH] Shop template variables --- lib/WebGUI/Help/PayDriver.pm | 225 ++++++++++++++++ lib/WebGUI/Help/Shop.pm | 125 --------- lib/WebGUI/i18n/English/PayDriver.pm | 384 +++++++++++++++++++++++++++ lib/WebGUI/i18n/English/Shop.pm | 24 -- 4 files changed, 609 insertions(+), 149 deletions(-) create mode 100644 lib/WebGUI/Help/PayDriver.pm diff --git a/lib/WebGUI/Help/PayDriver.pm b/lib/WebGUI/Help/PayDriver.pm new file mode 100644 index 000000000..6c34ef76d --- /dev/null +++ b/lib/WebGUI/Help/PayDriver.pm @@ -0,0 +1,225 @@ +package WebGUI::Help::PayDriver; + +use strict; + + +our $HELP = { + + 'email receipt template' => { + title => 'email receipt template', + body => 'email receipt template help', + isa => [], + fields => [], + variables => [ + { + name => 'viewDetailURL', + }, + { + name => 'amount', + }, + { + name => "inShopCreditDeduction", + description => "inShopCreditDeduction help", + namespace => 'Shop', + }, + { + name => 'shippingPrice', + }, + { + name => 'shippingAddress', + }, + { + name => 'paymentAddress', + }, + { + name => 'items', + variables => [ + { + name => 'viewItemUrl', + }, + { + name => 'price', + }, + { + name => 'itemShippingAddress', + }, + { + name => 'viewItemUrl', + }, + { + name => 'orderStatus', + }, + { + name => 'itemId', + }, + { + name => 'transactionId', + description => 'item transactionId', + }, + { + name => 'assetId', + description => 'item assetId', + }, + { + name => 'configuredTitle', + }, + { + name => 'options', + description => 'item options', + }, + { + name => 'shippingAddressId', + description => 'item shippingAddressId', + }, + { + name => 'shippingName', + description => 'item shippingName', + }, + { + name => 'shippingAddress1', + description => 'item shippingAddress1', + }, + { + name => 'shippingAddress2', + description => 'item shippingAddress2', + }, + { + name => 'shippingAddress3', + description => 'item shippingAddress3', + }, + { + name => 'shippingAddressCity', + description => 'item shippingAddressCity', + }, + { + name => 'shippingAddressState', + description => 'item shippingAddressState', + }, + { + name => 'shippingAddressCountry', + description => 'item shippingAddressCountry', + }, + { + name => 'shippingAddressCode', + description => 'item shippingAddressCode', + }, + { + name => 'shippingAddressPhoneNumber', + description => 'item shippingAddressPhoneNumber', + }, + ], + }, + { + name => 'transactionId', + }, + { + name => 'originatingTransactionId', + }, + { + name => 'isSuccessful', + }, + { + name => 'orderNumber', + }, + { + name => 'transactionCode', + }, + { + name => 'statusCode', + }, + { + name => 'statusMessage', + }, + { + name => 'userId', + }, + { + name => 'username', + }, + { + name => 'shopCreditDeduction', + }, + { + name => 'shippingAddressId', + }, + { + name => 'shippingAddressName', + }, + { + name => 'shippingAddress1', + }, + { + name => 'shippingAddress2', + }, + { + name => 'shippingAddress3', + }, + { + name => 'shippingAddressCity', + }, + { + name => 'shippingAddressState', + }, + { + name => 'shippingAddressCountry', + }, + { + name => 'shippingAddressCode', + }, + { + name => 'shippingAddressPhoneNumber', + }, + { + name => 'shippingDriverId', + }, + { + name => 'shippingDriverLabel', + }, + { + name => 'paymentAddressId', + }, + { + name => 'paymentAddress1', + }, + { + name => 'paymentAddress2', + }, + { + name => 'paymentAddress3', + }, + { + name => 'paymentAddressCity', + }, + { + name => 'paymentAddressState', + }, + { + name => 'paymentAddressCountry', + }, + { + name => 'paymentAddressCode', + }, + { + name => 'paymentAddressPhoneNumber', + }, + { + name => 'dateOfPurchase', + }, + { + name => 'isRecurring', + }, + { + name => 'notes', + }, + ], + related => [ + { + tag => 'address book template', + namespace => 'Shop', + }, + ], + }, + +}; + +1; diff --git a/lib/WebGUI/Help/Shop.pm b/lib/WebGUI/Help/Shop.pm index 4552f3c40..b6fc3e38c 100644 --- a/lib/WebGUI/Help/Shop.pm +++ b/lib/WebGUI/Help/Shop.pm @@ -378,131 +378,6 @@ our $HELP = { ], }, - 'email receipt template' => { - title => 'email receipt template', - body => 'email receipt template help', - isa => [], - fields => [], - variables => [ - { - name => "address1", - description => "address1 help", - }, - { - name => "address2", - description => "address2 help", - }, - { - name => "address3", - description => "address3 help", - }, - { - name => "state", - description => "state help", - }, - { - name => "city", - description => "city help", - }, - { - name => "label", - description => "label help", - }, - { - name => "name", - description => "name help", - }, - { - name => "country", - description => "country help", - }, - { - name => "code", - description => "code help", - }, - { - name => "phoneNumber", - description => "phoneNumber help", - }, - { - name => "error", - description => "error help", - required => 1, - }, - { - name => "formHeader", - description => "formHeader help", - required => 1, - }, - { - name => "formFooter", - description => "formFooter help", - required => 1, - }, - { - name => "saveButton", - description => "saveButton help", - required => 1, - }, - { - name => "address1Field", - description => "address1Field help", - required => 1, - }, - { - name => "address2Field", - description => "address2Field help", - required => 1, - }, - { - name => "address3Field", - description => "address3Field help", - required => 1, - }, - { - name => "labelField", - description => "address labelField help", - required => 1, - }, - { - name => "nameField", - description => "addres nameField help", - required => 1, - }, - { - name => "cityField", - description => "cityField help", - required => 1, - }, - { - name => "stateField", - description => "stateField help", - required => 1, - }, - { - name => "countryField", - description => "countryField help", - required => 1, - }, - { - name => "codeField", - description => "codeField help", - required => 1, - }, - { - name => "phoneNumberField", - description => "phoneNumberField help", - required => 1, - }, - ], - related => [ - { - tag => 'address book template', - namespace => 'Shop', - }, - ], - }, - }; 1; diff --git a/lib/WebGUI/i18n/English/PayDriver.pm b/lib/WebGUI/i18n/English/PayDriver.pm index 6e820f98e..edcc8f6d8 100644 --- a/lib/WebGUI/i18n/English/PayDriver.pm +++ b/lib/WebGUI/i18n/English/PayDriver.pm @@ -88,6 +88,390 @@ our $I18N = { context => q|Hover help for the group to use option.|, }, + 'email receipt template' => { + message => q|Email Receipt Template|, + lastUpdated => 1213121298, + context => q|Title of the Email Receipt Template help page|, + }, + + 'email receipt template help' => { + message => q|This template is for email receipts sent to the user.|, + lastUpdated => 1213121298, + context => q|Help body for the email receipt template|, + }, + + 'viewDetailURL' => { + message => q|A URL for viewing more details about the user's transaction.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'amount' => { + message => q|The total amount of this transaction, formatted to two decimal places.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'taxes' => { + message => q|Taxes for this transaction, formatted to two decimal places.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'shippingPrice' => { + message => q|Shipping price for this transaction, formatted to two decimal places.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddress' => { + message => q|Formatted shipping address.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddress' => { + message => q|Formatted payment/billing address.|, + lastUpdated => 1213121298, + context => q|Template variable for email receipt template|, + }, + + 'items' => { + message => q|A loop containing all items associated with this transaction.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'transactionId' => { + message => q|The unique identifier for this transaction.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'originatingTransactionId' => { + message => q|If the transaction is a recurring transaction, this will contain the transactionId for the original purchase.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'isSuccessful' => { + message => q|Whether or not this transaction completed successfully.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'orderNumber' => { + message => q|A human readable number for the transaction.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'transactionCode' => { + message => q|Transaction code or ID given by the payment gateway. Not all gateways may support this.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'statusCode' => { + message => q|The status code that came back from the gateway when trying to process the payment.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'statusMessage' => { + message => q|The extended status message that came back from the payment gateway when trying to process the payment.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'userId' => { + message => q|The userId of the user who performed this transaction.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'username' => { + message => q|The name of the user who performed this transaction, to save you a username lookup.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'shopCreditDeduction' => { + message => q|The unformatted amount of shop credit used in this transaction.|, + lastUpdated => 1213132212, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressId' => { + message => q|The ID of the shipping address used for this transaction.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressName' => { + message => q|The name assigned to the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddress1' => { + message => q|The first line in a multi-line shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddress2' => { + message => q|The second line in a multi-line shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddress3' => { + message => q|The third line in a multi-line shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressCity' => { + message => q|The city from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressState' => { + message => q|The state from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressCountry' => { + message => q|The state from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressCode' => { + message => q|The code from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingAddressPhoneNumber' => { + message => q|The phone number from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingDriverId' => { + message => q|The unique identifier for the shipping driver used in this transaction.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'shippingDriverLabel' => { + message => q|The label for the shipping driver used in this transaction.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressId' => { + message => q|The ID of the payment address used for this transaction.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressName' => { + message => q|The name assigned to the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddress1' => { + message => q|The first line in a multi-line payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddress2' => { + message => q|The second line in a multi-line payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddress3' => { + message => q|The third line in a multi-line payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressCity' => { + message => q|The city from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressState' => { + message => q|The state from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressCountry' => { + message => q|The state from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressCode' => { + message => q|The code from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressCode' => { + message => q|The code from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'paymentAddressPhoneNumber' => { + message => q|The phone number from the payment address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'dateOfPurchase' => { + message => q|The date the purchase occurred.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'isRecurring' => { + message => q|A boolean that is true if this is a recurring transaction.|, + lastUpdated => 1213134691, + context => q|Template variable for email receipt template|, + }, + + 'notes' => { + message => q|Notes about this transaction.|, + lastUpdated => 1213134744, + context => q|Template variable for email receipt template|, + }, + + 'viewItemUrl' => { + message => q|A URL to view details about this item from the transaction.|, + lastUpdated => 1213135218, + context => q|Template variable for email receipt template|, + }, + + 'price' => { + message => q|The price of this item, formatted to two decimal places.|, + lastUpdated => 1213135218, + context => q|Template variable for email receipt template|, + }, + + 'itemShippingAddress' => { + message => q|The formatted shipping address for this item.|, + lastUpdated => 1213135307, + context => q|Template variable for email receipt template|, + }, + + 'orderStatus' => { + message => q|The status of this item, Shipped, Canceled, Backordered or NotShipped.|, + lastUpdated => 1213135307, + context => q|Template variable for email receipt template|, + }, + + 'item transactionId' => { + message => q|The ID of the transaction that this item belongs to.|, + lastUpdated => 1213135697, + context => q|Template variable for email receipt template|, + }, + + 'itemId' => { + message => q|The unique identifier for this item among all items in all transactions.|, + lastUpdated => 1213135697, + context => q|Template variable for email receipt template|, + }, + + 'item assetId' => { + message => q|The assetId for this item.|, + lastUpdated => 1213135697, + context => q|Template variable for email receipt template|, + }, + + 'configuredTitle' => { + message => q|The configured title for the assetId. This is the regular title of the asset with customizations from the user.|, + lastUpdated => 1213135697, + context => q|Template variable for email receipt template|, + }, + + 'item options' => { + message => q|JSON encoded options for the asset. You should probably not use this template variable.|, + lastUpdated => 1213135697, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressId' => { + message => q|The ID of the shipping address used for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingName' => { + message => q|The name assigned to the shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddress1' => { + message => q|The first line in a multi-line shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddress2' => { + message => q|The second line in a multi-line shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddress3' => { + message => q|The third line in a multi-line shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressCity' => { + message => q|The city from the shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressState' => { + message => q|The state from the shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressCountry' => { + message => q|The state from the shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressCode' => { + message => q|The code from the shipping address for this item.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + + 'item shippingAddressPhoneNumber' => { + message => q|The phone number from the shipping address.|, + lastUpdated => 1213133715, + context => q|Template variable for email receipt template|, + }, + }; 1; diff --git a/lib/WebGUI/i18n/English/Shop.pm b/lib/WebGUI/i18n/English/Shop.pm index 8b8086584..40162f32e 100644 --- a/lib/WebGUI/i18n/English/Shop.pm +++ b/lib/WebGUI/i18n/English/Shop.pm @@ -951,36 +951,18 @@ our $I18N = { context => q|Label for a shortcut to the import products folder| }, - 'address1' => { - message => q|address1|, - lastUpdated => 1213121298, - context => q|Name of a template variable for the edit address template|, - }, - 'address1 help' => { message => q|The first address line.|, lastUpdated => 1213121298, context => q|Description of a template variable for the edit address template|, }, - 'address2' => { - message => q|address2|, - lastUpdated => 1213121298, - context => q|Name of a template variable for the edit address template|, - }, - 'address2 help' => { message => q|The second address line.|, lastUpdated => 1213121298, context => q|Description of a template variable for the edit address template|, }, - 'address3' => { - message => q|address3|, - lastUpdated => 1213121298, - context => q|Name of a template variable for the edit address template|, - }, - 'address3 help' => { message => q|The third address line|, lastUpdated => 1213121298, @@ -993,12 +975,6 @@ our $I18N = { context => q|Description of a template variable for the edit address template|, }, - 'email receipt template' => { - message => q|Email Receipt Template|, - lastUpdated => 1213121298, - context => q|Title of the Email Receipt Template help page|, - }, - }; 1;