Difference between revisions of "Page Templates:Functions"
From Whirlwind eCommerce Wiki
(added ordersGetList) |
(added captchacheck and rearranged some functions) |
||
| Line 65: | Line 65: | ||
*[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format | *[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format | ||
*[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings | *[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings | ||
| + | |||
| + | ;Security functions | ||
| + | *[[functions:captchaCheck|captchaCheck]] - validate a captcha image to ensure we don't have automated form submissions | ||
| + | *[[functions:ipBlockCheck|ipBlockCheck]] - checks if an IP is registered to the block list | ||
;Shortcut Functions that just plain make your job easier | ;Shortcut Functions that just plain make your job easier | ||
| Line 71: | Line 75: | ||
*[[functions:dollarFormat|dollarFormat]] - converts a decimal to a dollar value with preceding $ sign. | *[[functions:dollarFormat|dollarFormat]] - converts a decimal to a dollar value with preceding $ sign. | ||
*[[functions:validateEmail|validateEmail]] - checks to make sure an email address is well formatted. | *[[functions:validateEmail|validateEmail]] - checks to make sure an email address is well formatted. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 22:32, 11 March 2009
A series of custom functions are created to allow content management to easily access content they require to build the copy in templates:
- Quick Output of Options Tags for common select boxes
- addressStateOptions - returns string of option tags for states
- addressCountryOptions - returns string of option tags for countries
- orderExpDateOptions - returns string of option tags for expiration dates of a credit card
- orderPayTypeOptions - returns string of option tags for pay types
- Set Variables that Content Managers can use in the WYSIWYG copy editor
- pageContentAttribSet - sets a single variable that can be used by content managers in the page manager form (including the WYSIWYG editor)
- pageContentAttribStart/pageContentAttribEnd - wrapper that the contents of which is set as a single variable that can be used by content managers in the page manager form
- Retrieve Page Content to Build Pages
- pageMenuGet - returns menu item data
- pageChildrenGet - returns page data for children of a specific page
- pageSearchGet - returns page data for pages qualifying for a keyword search
- pageZoneGet - returns code to display an banner ad zone
- pageForumPostsGet - returns forum post data for posts submitted to a particular forum page
- pageGet - return specific information about a specific page
- pagePollQuestionsGet - returns question and answer data for building a poll
- pagePollResultsGet - returns poll submission data for building a report of poll results
- pageBreadcrumbsFamilyGet( - returns breadcrumb data by traversing parent pages
- pageBreadcrumbsHistoryGet - returns breadcrumb data by traversing linear browsing history
- pageProductsGet - returns product data for products related to a specific page
- catalogProductsGet - returns product data by catalog number
- recentlyViewedGet - returns data for recently viewed pages
- pageCustomSearchGroup - returns Custom Search Group data used to build a custom search widget
- prodArrayToJS - creates a string of pricing data that can be assigned to a javascript object to calculate pricing on the fly (ajax)
- Manage Copy
- fullyQualifyAllURLs - converts any relative/absolute URL in the passed copy to fully qualified URLs - useful when sending copy as an email
- Manage Large Lists of Data
- pagination - easy to use tool to paginate large sets of data. Use for managing page children, search results and more
- Retrieve Order information for perpetual and full shopping carts, checkout stages, order history
- orderGetSummary - returns summerized order information. Useful for perpetual carts.
- orderGetPayTypes - returns data relating to active paytypes in the system
- userGetAddresses - returns data for all addresses belonging to a specific user
- orderGetShipArray - returns array of shipping options and costs
- orderGetCompleteArray - returns full order information including payment, item, address, etc. Use for shopping carts, order summaries and receipts of orders.
- ordersGetList - returns listing of orders for a particular user (useful for building order history pages)
- Retrieve User Content to Build Community (Web 2.0) Pages
- usersGet - retrieve user data from a list of user ids
- userBlogEntriesGet - retrieve blog entry data belonging to a specific user
- userFriendsGet - retrieves data for users in a specific user's 'friend list'
- userWishListGet - retrieves product data for products in a specific user's wish list
- usersAmbassadorGet - retrieves user data for users that are classified as 'ambassadors'
- Set Tracking Functions
- recentlyViewedAdd - registers a page to the recently viewed history when viewed
- User Management Functions
- userAccountEdit - manages user account information
- userAccountAndAddressCreate - create a user account (or both a user account and address)
- userAddressAddEdit - manages user addresses
- userBlogEntryAddEdit - managers user blog entries
- userBlogSetup - sets up a user with a blog
- authorizeIsLoggedOut - to check if a user is logged out
- authorizeIsLoggedIn - to check if a user is logged in
- Retrieve additional information from address data
- addressCountryNameGet - returns full country name from ISO 2 digit format
- addressZipDetailsGet - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings
- Security functions
- captchaCheck - validate a captcha image to ensure we don't have automated form submissions
- ipBlockCheck - checks if an IP is registered to the block list
- Shortcut Functions that just plain make your job easier
- redirect - redirects visitors to another page
- valueArrayFromQuery - returns a single dimension array of values based on the contents of a specific column in all records of a query
- dollarFormat - converts a decimal to a dollar value with preceding $ sign.
- validateEmail - checks to make sure an email address is well formatted.
