Functions:pageSearchGet - Revision history

71.163.185.8: /* Examples */

2009-04-08T15:29:57Z

‎Examples

71.163.185.8 at 14:48, 8 April 2009

2009-04-08T14:48:33Z

71.163.185.8: added complex example

2009-04-08T14:48:05Z

added complex example

Root at 13:15, 3 April 2009

2009-04-03T13:15:37Z

Root at 19:29, 2 April 2009

2009-04-02T19:29:08Z

Root at 14:11, 21 October 2008

2008-10-21T14:11:56Z

Root at 14:55, 19 October 2008

2008-10-19T14:55:32Z

Root at 13:44, 19 October 2008

2008-10-19T13:44:01Z

Root at 02:48, 19 October 2008

2008-10-19T02:48:46Z

Root at 21:36, 18 October 2008

2008-10-18T21:36:40Z

@@ Line 477: / Line 477: @@
    	if($pagination['startIndex'] <= $childIndex && $pagination['endIndex'] >= $childIndex){
 		// display the child
- 		 echo "<hr><a href=\"" . $child['link'] . "\"><img src=\"" . $child['summaryImage'] . "\"/></a>
+ 		echo "<hr><a href=\"" . $child['link'] . "\"><img src=\"" . $child['summaryImage'] . "\"/></a>
          	<br><a href=\"" . $child['link'] . "\">" . $child['title'] . "</a>
    			<br>" . $child['summary'] . "
@@ Line 483: / Line 483: @@
 			<br><a href=\"" . $child['link'] . "\">More Info</a>
      		<br><a href=\"" . $child['addToCartLink']. "\">Add To Cart</a>";
-−
+        }
-−
    // increment tracking index
    $childIndex++;

@@ Line 386: / Line 386: @@
 echo "<br><i>Relevance:" . $search['relevance'] . "</i>";
 };
+</source>
 ;Complex Example using pagination, sorting controls
 <source lang="php">
@@ Line 489: / Line 489: @@
+}
 </source>

@@ Line 372: / Line 372: @@
 == Examples ==
-;Example
+;Simple Example
 <source lang="php">
 // call
@@ Line 386: / Line 386: @@
 echo "<br><i>Relevance:" . $search['relevance'] . "</i>";
 };
 </source>

@@ Line 76: / Line 76: @@
              // product fields
              [productName] => STRING (for first product in page)
              [productTitle] => STRING (for first product in page)
              [productDescription] => STRING (for first product in page)
@@ Line 277: / Line 279: @@
 |STRING - The name of the first product directly assigned to the page in relationships.
 |Product X
 |-
 |productTitle

@@ Line 88: / Line 88: @@
              [lowestLevelPrice] => DECIMAL
              [lowestAllPrice] => DECIMAL
              //children's children and children's grandchildren (great grandchildren to parent pageId)
@@ Line 322: / Line 325: @@
 |FLOAT - lowest price for All products assigned to the page in relationships. This price takes into consideration sale, regular, list and level (tiered) pricing. Sale prices that are not within the sale from / to price range do not qualify.
 |14.22
 |-
 |<b>qualifying pages' children and grandchildren</b>

← Older revision		Revision as of 14:11, 21 October 2008
Line 1:		Line 1:
		+	{{Page Template Functions Shortcuts}}
	== Description ==		== Description ==
	Retrieves page and product data on pages that qualify for a keyword search.		Retrieves page and product data on pages that qualify for a keyword search.

@@ Line 229: / Line 229: @@
 |-
 |author_handle
+|STRING - Handle of the user designated as the author of the page. This is the handle assigned to the user record for the user with the userId matching the authorId selected in page management for this page. Authors may only be selected if User Publisher Information is selected in Settings.
+|mwex501
 |-
-|blogger fields
+|<b>blogger fields</b>
 |-
 |blog_firstName
+|STRING - First name of the user designated as the blog owner of the page. This is the first name assigned to the user record for the user with the userId matching the blog_userId selected in page management for this page. Bloggers may only be selected if Blogging Available is selected in Settings.
+|Mark
 |-
 |blog_lastName
+|STRING - Last name of the user designated as the blog owner of the page. This is the last name assigned to the user record for the user with the userId matching the blog_userId selected in page management for this page. Bloggers may only be selected if Blogging Available is selected in Settings.
+|Wexler
 |-
 |blog_userImage
+|STRING - Path of the user image of the user designated as the blog owner of the page. This is the user image path assigned to the user record for the user with the userId matching the blog_userId selected in page management for this page. Bloggers may only be selected if Blogging Available is selected in Settings.
+|/files/images/image.jpg
 |-
 |blog_handle
+|STRING -Handle of the user designated as the blog owner of the page. This is the handle assigned to the user record for the user with the userId matching the blog_userId selected in page management for this page. Bloggers may only be selected if Blogging Available is selected in Settings.
+|mwex501
 |-
-|forum / comments fields
+|<b>forum / comments fields</b>
 |-
 |forumCount
+|INT - number of forum posts to the page.
+|23
 |-
 |ratingTotal
+|INT - Sum of all ratings posted to this page (each rating is on a scale of 0 to 5).
+|120
 |-
 |ratingCount
+|INT - total number of ratings submitted for the page.
+|50
 |-
 |ratingAverage
+|FLOAT - average rating for the page on a scale of 0 to 5.
+|2.4
 |-
-|product fields
+|<b>product fields</b>
 |-
 |productName
+|STRING - The name of the first product directly assigned to the page in relationships.
+|Product X
 |-
 |productTitle
+|STRING - The title of the first product directly assigned to the page in relationships.
+|This is the title of this product
 |-
 |productDescription
+|STRING - the description of the first product directly assigned to the page in relationships.
+|This is a description of the product
 |-
 |productId
+|INT - unique id assigned by the system to the product upon creation, for the first product assigned to the page in relationships
+|12
 |-
 |lowestPrice
+|FLOAT - lowest price for All products assigned to the page in relationships. This price only takes into consideration the 'price' field for the products, not the sale, level prices.
+|12.59
 |-
 |lowestListPrice
+|FLOAT - lowest of all the list prices for ALl products assigned to the page in relationships.
+|15.46
 |-
 |lowestSalePrice
+|FLOAT - lowest of all the available sale prices for all products assigned to the page in relationships. Sale prices that are not within the sale from / to price range do not qualify.
+|14.26
 |-
 |productCount
+|INT - number of products assigned to the page in relationships.
+|3
 |-
 |productIdList
+|STRING - comma delimited list of unique productIds for products assigned to the page in relationships.
+|14,26,3
 |-
 |saleFromDate
+|DATETIME - date when the sale price is first available for the first product assigned to the page in relationships. If no sale from date is assigned the value will be empty, meaning there is no beginning cut off date for the sale.
+|2008-10-12 00:00:00
 |-
 |saleToDate
+|DATETIME - date when the sale price is last available for the first product assigned to the page in relationships. If no sale to date is assigned the value will be empty, meaning there is no ending cut off date for the sale.
+|2008-10-20 00:00:00
 |-
 |lowestLevelPrice
+|FLOAT - lowest of all the level prices for all products assigned to the page in relationships.
+|10.26
 |-
 |lowestAllPrice
+|FLOAT - lowest price for All products assigned to the page in relationships. This price takes into consideration sale, regular, list and level (tiered) pricing. Sale prices that are not within the sale from / to price range do not qualify.
+|14.22
 |-
-|children's children and children's grandchildren (great grandchildren to parent pageId)
+|<b>qualifying pages' children and grandchildren</b>
 |-
 |childPageCount
+|INT - total count of pages set as children to this page via relationships.
+|6
 |-
 |grandChildPageCount
+|INT - total count of all pages set as grandchildren (children to children) to this page via relationships. Warning, with sites containing many pages / relationships, using this field could cause undue strain on the system.
+|143
 |-
-|poll data
+|<b>poll data</b>
 |-
 |pollCount
+|INT - total number of poll postings to this page
+|123
 |-
-|custom fields
+|<b>custom fields</b>
 |-
 |custom_field_?
+|Each custom field will be accessible by using custom_field_? where the ? is the field name as set in page template administration for the template used by the page.
+|-anything-
 |}

@@ Line 191: / Line 191: @@
 |-
 |startDate
-|DATETIME -
+|DATETIME - designates the first day the page should be made available to visitors. If empty, than there is no cut off start date.
+|2008-10-01 00:00:00
 |-
 |endDate
+|DATETIME - designates the last day the page should be available to visitors. If empty, than there is no cut off end date.
+|2008-10-31 00:00:00
 |-
 |isBlog
+|BIT - 0 or 1 if page is selected to be a blog (controlled in page management, but set on automatically when a blog is created by a site visitor). Use to create logic that shows / processes blog related content and logic. Note that this option will only be available in page management if Blogging Available is selected in Settings.
+|1
 |-
 |isPoll
+|BIT - 0 or 1 if page is selected to be a poll via page management. Use to create logic that shows / processes poll related content and logic. Note that this option will only be available in page management if Polling Available is selected in Settings.
+|0
 |-
 |createDate
+|DATETIME - system generated datetime when the page record was first inserted into the database.
+|2008-10-15 14:15:56
 |-
 |modDate
+|DATETIME - system generated datetime when the page was last modified.
+|2008-10-15 16:12:44
 |-
-|author fields
+|<b>author fields</b>
 |-
 |author_firstName
+|STRING - first name of the user designated as the author of the page. This is the first name assigned to the user record for the user with the userId matching the authorId selected in page management for this page. Authors may only be selected if User Publisher Information is selected in Settings.
+|Mark
 |-
 |author_lastName
+|STRING - last name of the user designated as the author of the page. This is the last name assigned to the user record for the user with the userId matching the authorId selected in page management for this page. Authors may only be selected if User Publisher Information is selected in Settings.
+|Wexler
 |-
 |author_userImage
+|STRING - path to image selected for as the user image for the user designated as the author for the page. Authors may only be selected if User Publisher Information is selected in Settings.
+|/files/images/imagename.jpg
 |-
 |author_handle

@@ Line 163: / Line 163: @@
 |-
 |summary
+|STRING - summary information about the page. Typically used to describe the page in brief, such as in children, search results and cross sells.
+|This is some additional details about this page. To see more information click this page.
 |-
 |summaryImage
+|STRING - absolute path to an image used in summaries about the page. Typically used to accompany the summary when describing the page in brief, such as in children, search results and cross sells.
+|/files/images/thumbnails/imageName.jpg
 |-
 |summaryImageAlt
+|STRING - alt tag contents for the summaryImage.
+|This describes the image
 |-
 |summaryImageCaption
+|STRING - caption to accompany the summaryImage.
+|The above is an image!
 |-
 |linkText
+|STRING - text to represent the link to go to the page.
+|Click here for more information
 |-
 |publisher
+|STRING - name of the publisher of the page. Typically used when the page is an article, press release or content that is owned by another party. Only available in Page Management if publishing information is set to available in Settings.
+|New York Times
 |-
 |publishDate
+|DATETIME - date to present as the publishing date of the page. Typically used when the page is an article or press release. Only available in Page Management if publishing information is set to available in Settings.
+|2008-10-16 08:00:00
 |-
-|startDate]
+|startDate
+|DATETIME -
+|
 |-

@@ Line 106: / Line 106: @@
 {|border=2
 |-
-|Element
+|<b>Element</b>
-|Description
+|<b>Description</b>
-|Example
+|<b>Example</b>
 |-
-|fields automatically included
+|<b>fields automatically included</b>
 |-
 |relevance
@@ Line 143: / Line 143: @@
 |-
 |templateId
+|INT - system assigned unique template id for the template selected in page management for this page
+|12
 |-
 |notice
+|STRING - notice field entry for this page in page management. Note that notice has to be turned on in Settings to be available in page management. Also notice can be renamed in Settings, therefore might not be titled 'notice' in page management. Often notice is used as the Page Name (unique description of the page for internal use / page identification)
+|This is my page
 |-
 |title
+|STRING - title field entry for this page in page management. Note that title can be renamed in Settings, therefore might not be titled 'title' in page management. This is used as the text descriptor of the page in all areas of administration that list pages (page children, parents, page search, etc). Other fields may be designated to appear as descriptors in administration by changing the Summary Listing Details under the Page Management tab.
+|The page title
 |-
 |subTitle
+|STRING - subtitle field entry for this page in page management. Note that subtitle has to be turned on in Settings to be available in page management. Also subtitle can be renamed in Settings, therefore might not be titled 'subtitle' in page management.
+|This is the subtitle for this page
 |-
 |copy
+|STRING - HTML formatted page copy, as set in the copy field WYSIWYG editor in page management. This serves as the bulk of the page's content. Copy is typically not displayed in page searches / page children as it is to much information when listing multiple page results, though sometimes it is truncates in the results. Note that copy is HTML content, as it is managed by the WYSIWYG editor.
+|&lt;img src="image.jpg" align="right"&gt;&lt;p&gt;This is the &lt;b&gt;copy&gt;/b&gt; for this &lt;i&gt;page&lt;/i&gt;
 |-
 |summary