Difference between revisions of "Page Templates:Functions"

From Whirlwind eCommerce Wiki
Jump to: navigation, search
(changed addressesSetSelect to addressesShipSelect)
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Page Template Functions Shortcuts}}
 
A series of custom functions are created to allow content management to easily access content they require to build the copy in templates:
 
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 State/Country Options in a Form Select
+
;Quick Output of Options Tags for common select boxes
−
*eV::addressStateOptions($value=NULL); returns string of option tags for states
+
*[[functions:addressStateOptions|addressStateOptions]] - returns string of option tags for states
−
*eV::addressCountryOptions($value=NULL); returns string of option tags for countries
+
*[[functions:addressCountryOptions|addressCountryOptions]] - returns string of option tags for countries
 +
*[[functions:orderExpDateOptions|orderExpDateOptions]] - returns string of option tags for expiration dates of a credit card
 +
*[[functions:orderPayTypeOptions|orderPayTypeOptions]] - returns string of option tags for pay types
  
 
;Set Variables that Content Managers can use in the WYSIWYG copy editor
 
;Set Variables that Content Managers can use in the WYSIWYG copy editor
−
*eV::pageContentAttribsSet($array)
+
*[[functions:pageContentAttribSet|pageContentAttribSet]] - sets a single variable that can be used by content managers in the page manager form (including the WYSIWYG editor)
−
*eV::pageContentAttribSet($replaceString,$resultString);
+
*[[functions:pageContentAttribStart/pageContentAttribEnd|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
−
*eV::pageContentAttribSetStart($replaceString) / eV::pageContentAttribSetEnd()
+
  
 
;Retrieve Page Content to Build Pages
 
;Retrieve Page Content to Build Pages
−
*[[eV::pageMenuGet($menuId=NULL)]] returns $arrMenu (array)
+
*[[functions:pageMenuGet|pageMenuGet]] - returns menu item data
−
*eV::pageChildrenGet($pageId,$fieldList=NULL,$orderBy=NULL,$orderDir=(DESC,ASC),$orderType(str,num)) returns $arrChildren (array)
+
*[[functions:pageChildrenGet|pageChildrenGet]] - returns page data for children of a specific page
−
*eV::pageSearchGet($keywords,$fieldList=NULL,$orderBy=NULL,$orderDir=(DESC,ASC),$orderType(str,num)) returns $arrSearch (array)
+
*[[functions:pageSearchGet|pageSearchGet]] - returns page data for pages qualifying for a keyword search
−
*[[eV::pageZoneGet($zoneIdOrName,$pageId,$dBug=0)]] returns bannerOutput (string)
+
*[[functions:pageZoneGet|pageZoneGet]] - returns code to display an banner ad zone
−
*eV::pageForumPostsGet($userId=NULL,$pageId=NULL,$templateIdList=NULL,$fieldList=NULL,$orderBy=NULL) returns array (forumPostLink,ratingCount,ratingCount[1-5],ratingTotal,ratingAverage,posts[])
+
*[[functions:pageForumPostsGet|pageForumPostsGet]] - returns forum post data for posts submitted to a particular forum page
−
*eV::pagePollQuestionsGet($pageId)
+
*[[functions:pageGet|pageGet]] - return specific information about a specific page
−
*eV::pagePollResultsGet($pageId)
+
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]] - returns question and answer data for building a poll
−
*eV::pageBreadcrumbsFamilyGet($pageId)
+
*[[functions:pagePollResultsGet|pagePollResultsGet]] - returns poll submission data for building a report of poll results
−
*eV::pageBreadcrumbsHistoryGet($pageId,$breadcrumb)
+
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet(]] - returns breadcrumb data by traversing parent pages
−
*eV::pageProductsGet($pageId,$fieldList)
+
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]] - returns breadcrumb data by traversing linear browsing history
−
*eV::prodOptionString2Array($optionValue)
+
*[[functions:pageProductsGet|pageProductsGet]] - returns product data for products related to a specific page
−
*eV::recentlyViewedGet($fieldList) //returns array of page data for recently viewed items
+
*[[functions:catalogProductsGet|catalogProductsGet]] - returns product data by catalog number
−
*[[eV::pageCustomSearchGroup($groupIdOrName)]] // returns array[groupName,groupId,groupNotes,selectField,options[optionsId,optionName,link]]
+
*[[functions:recentlyViewedGet|recentlyViewedGet]] - returns data for recently viewed pages
 +
*[[functions:continueShoppingGet|continueShoppingGet]] - returns data for recently viewed pages
 +
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]] - returns Custom Search Group data used to build a custom search widget
 +
*[[functions:prodArrayToJS|prodArrayToJS]] - creates a string of pricing data that can be assigned to a javascript object to calculate pricing on the fly (ajax)
  
−
;Retrieve User Content to Build Community (Web 2.0) Pages
+
;Manage Copy
−
*eV::usersGet($fieldList,$userIdList,$orderBy=NULL,$orderDir="DESC",$orderType="str")
+
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]] - converts any relative/absolute URL in the passed copy to fully qualified URLs - useful when sending copy as an email
−
*eV::userBlogEntriesGet($fieldList,$orderBy=NULL,$userId=NULL)
+
−
*eV::userFriendsGet($fieldList,$userId=NULL) // userId defaults to session.user.userId. returnes 2 dim array [index][fieldName] for users that are on $userId's friend list
+
−
*eV::userWishListGet($fieldList,$userId=NULL); // userid defaults to session.user.userid. returns 2 min array[index][fieldName] for pages that are on $userIds wish list
+
−
*eV::usersAmbassadorGet($fieldList);
+
  
−
;Retrieve Order Content to Build Cart and Checkout Pages
+
;Manage Large Lists of Data
−
*eV::orderGetPayTypes() // returns array of ACTIVE pay types, dim 2: payType, payTypeName
+
*[[functions:pagination|pagination]] - easy to use tool to paginate large sets of data. Use for managing page children, search results and more
−
*eV::userGetAddresses($fieldList,$userId=NULL) // userId defaults to session.user.userId if empty. returns multidimarray, first dim = address index, 2nd dim is keys for each field. can pass fieldList to limit fields returned
+
 
 +
;Retrieve Order information for perpetual and full shopping carts, checkout stages, order history
 +
*[[functions:orderGetSummary|orderGetSummary]] - returns summerized order information. Useful for perpetual carts.
 +
*[[functions:orderGetPayTypes|orderGetPayTypes]] - returns data relating to active paytypes in the system
 +
*[[functions:userGetAddresses|userGetAddresses]] - returns data for all addresses belonging to a specific user
 +
*[[functions:orderGetShipArray|orderGetShipArray]] - returns array of shipping options and costs
 +
*[[functions:orderGetCompleteArray|orderGetCompleteArray]] - returns  full order information including payment, item, address, etc. Use for shopping carts, order summaries and receipts of orders.
 +
*[[functions:ordersGetList|ordersGetList]] - returns listing of orders for a particular user (useful for building order history pages)
 +
*[[functions:addressesShipSelect|addressesShipSelect]] - returns a complete <SELECT> tag that can be used for multiple address checkouts
 +
*[[functions:addressesGet|addressesGet]] - returns array of user/order addresses for use with generating a custom multiple address checkout process
 +
 
 +
;Integrate With 3rd Party Web Tools
 +
*[[functions:googleTrack|googleTrack]] - Google Analytics Integration
 +
*[[functions:googleTrackTrans|googleTrackTrans]] - Google eCommerce Conversion Tracking
 +
*[[functions:TEMConversionTag|TEMConversionTag]] - Trigger Email Marketing Conversion Tracking
 +
*[[functions:jellyfishOutput|jellyfishOutput]] - Jellyfish Order Conversion Tracking
 +
 
 +
;Retrieve User Content to Build Community (Web 2.0) Pages
 +
*[[functions:usersGet|usersGet]] - retrieve user data from a list of user ids
 +
*[[functions:userBlogEntriesGet|userBlogEntriesGet]] - retrieve blog entry data belonging to a specific user
 +
*[[functions:userFriendsGet|userFriendsGet]] - retrieves data for users in a specific user's 'friend list'
 +
*[[functions:userWishListGet|userWishListGet]] - retrieves product data for products in a specific user's wish list
 +
*[[functions:usersAmbassadorGet|usersAmbassadorGet]] - retrieves user data for users that are classified as 'ambassadors'
  
 
;Set Tracking Functions
 
;Set Tracking Functions
−
*eV::recentlyViewedAdd($pageId) // appends recently viewed array
+
*[[functions:recentlyViewedAdd|recentlyViewedAdd]] - registers a page to the recently viewed history when viewed
  
 
;User Management Functions
 
;User Management Functions
−
*eV::userAccountEdit($fieldList,$exitLocation=NULL,$userId=NULL) exitLocation reloads same page if empty. Also exitLocation can be passed as a post variable. userId defaults to session.user.userId. returns array [values]array [customFieldTags]array [message]string
+
*[[functions:userAccountEdit|userAccountEdit]] - manages user account information
−
*eV::userAddressAddEdit($fieldList) returns array [values]array [message]string
+
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]] - create a user account (or both a user account and address)
−
*eV::userBlogEntryAddEdit($fieldList,$userId=NULL)
+
*[[functions:userAddressAddEdit|userAddressAddEdit]] - manages user addresses
−
*eV::userBlogSetup($pageId=NULL,$userId=NULL) // page id defaults to first page belonging to user that is blog main page // userId defaults to session userId // adds blog page if none, returns blog pageId either way
+
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]] - managers user blog entries
 +
*[[functions:userBlogSetup|userBlogSetup]] - sets up a user with a blog
 +
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]] - to check if a user is logged out
 +
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]] - to check if a user is logged in
  
−
;Shortcut Functions that just plain make your job easier
+
;Retrieve additional information from address data
−
*eV::redirect($location)
+
*[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format
−
*eV::valueArrayFromQuery($query,$fieldName)
+
*[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings
  
−
;Functions used by internal actions, you probably will not use
+
;Security functions
−
*eV::ipBlockCheck($ipAddress,$forwardOnBlock=NULL) // returns T/F if address is blocked. if forwardOnBlock is passed, then it forwards to URL
+
*[[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
 +
*[[functions:redirect|redirect]] - redirects visitors to another page
 +
*[[functions:valueArrayFromQuery|valueArrayFromQuery]] - returns a single dimension array of values based on the contents of a specific column in all records of a query
 +
*[[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.

Latest revision as of 17:49, 25 May 2009

Page Template Managers

Page Template Functions

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
Set Variables that Content Managers can use in the WYSIWYG copy editor
Retrieve Page Content to Build Pages
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)
  • addressesShipSelect - returns a complete <SELECT> tag that can be used for multiple address checkouts
  • addressesGet - returns array of user/order addresses for use with generating a custom multiple address checkout process
Integrate With 3rd Party Web Tools
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
User Management Functions
Retrieve additional information from address data
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.
Retrieved from "http://wiki.whirlwind-ecommerce.com/mediawiki/index.php?title=Page_Templates:Functions&oldid=810"