Functions:pageForumPostsGet - Revision history

Root at 14:10, 21 October 2008

2008-10-21T14:10:45Z

Root at 16:50, 19 October 2008

2008-10-19T16:50:10Z

Show changes

Root at 15:52, 19 October 2008

2008-10-19T15:52:30Z

Root: New page: == Description == Retrieves array of forum post data == Syntax == $postArray = eV::pageForumPostsGet([$userId][,$pageId,][$templateIdList,][$fieldList,][$orderBy]); == Paramaters == *$us...

2008-10-19T15:40:39Z

New page: == Description == Retrieves array of forum post data == Syntax == $postArray = eV::pageForumPostsGet([$userId][,$pageId,][$templateIdList,][$fieldList,][$orderBy]); == Paramaters == *$us...

New page

== Description ==
Retrieves array of forum post data

== Syntax ==
$postArray = eV::pageForumPostsGet([$userId][,$pageId,][$templateIdList,][$fieldList,][$orderBy]);

== Paramaters ==
*$userId INT OPTIONAL (either userId OR pageId MUST be passed)
:: Entering a value into this field will filter all forum posts by this user. Use this field to get all forum posts on all pages by a specific user.
*$pageId INT OPTIONAL (either userId or pageId MUST be passed)
:: Entering a value into this field will filter all forum posts by this page. Use this field to show all forum posts made to a particular page.
*$templateIdList STRING OPTIONAL
:: comma delimited list of templateIds to filter post results by. This is used in conjunction with userId to show only posts made by the user to pages that belong to certain templates (I.e. show only posts to products via product templates)

== Return Values ==
Return multi dimensional array where first dimension is the index associated with the specific post, the second dimension is an associative array of data for that post.
Return array is as follows:

<pre>
Array
(
['posts'] => Array
(
[0] => Array
(
[] => Array
post_createDate
post_modDate
post_userId
post_handle
post_postHandle
post_userHandle
post_emailAddress
post_postEmailAddress
post_userEmailAddress
post_firstName
post_lastName
post_emailAddress
post_userImage
post_copy

page_title

reply_copy
reply_handle
reply_emailAddress
reply_firstName
reply_lastName
reply_userEmailAddress
reply_userHandle
reply_postHandle
reply_userImage
reply_postId
reply_userId
reply_title
reply_createDate
reply_modDate
reply_postEmailAddress
reply_postHandle

ratingAverage
ratingTotal
ratingCount
ratingCount1
ratingCount2
ratingCount3
ratingCount4
ratingCount5

agreeTotal
agreeCount
)
[1] ...
)
</pre>

== Examples ==
;Simple Example
<source lang="php">

// get postings for current page
$postArr = eV::pageForumPostsGet(NULL,$pageId,NULL,'
</source>

← Older revision		Revision as of 14:10, 21 October 2008
Line 1:		Line 1:
		+	{{Page Template Functions Shortcuts}}
	== Description ==		== Description ==
	Retrieves array of forum post data		Retrieves array of forum post data

@@ Line 14: / Line 14: @@
 == Return Values ==
-Return multi dimensional array where first dimension is the index associated with the specific post, the second dimension is an associative array of data for that post.
+Returns an associative array of aggregate post data. The 'posts' root element contains an indexed array of all individual posts qualifying for this request. Each indexed element is an associative array of post data.
-Return array is as follows:
+The returned array is as follows:
 <pre>
 Array
+(
      ['posts'] => Array
+         (
             [0] => Array
+                 (
-                    [] => Array
+                    [post_createDate] => DATETIME
-post_createDate
+                   [post_modDate] => DATETIME
-post_modDate
+                   [post_userId] => INT
-post_userId
+                   [post_handle] => STRING
-post_handle
+                   [post_postHandle] => STRING
-post_postHandle
+                   [post_userHandle] => STRING
-post_userHandle
+                   [post_emailAddress] => STRING
-post_emailAddress
+                   [post_postEmailAddress] => STRING
-post_postEmailAddress
+                   [post_userEmailAddress] => STRING
-post_userEmailAddress
+                   [post_firstName] => STRING
-post_firstName
+                   [post_lastName] => STRING
-post_lastName
+                   [post_emailAddress] => STRING
-post_emailAddress
+                   [post_userImage] => STRING
-post_userImage
+                   [post_copy] => STRING
-post_copy
+                   [page_title] => STRING
-page_title
+                   [reply_copy] => STRING
-reply_copy
+                   [isEditable] => BIT
-reply_handle
+                   [deleteLink] => STRING
-reply_emailAddress
+                   [editLink] => STRING
-reply_firstName
+                   [replyLink] => STRING
-reply_lastName
+                   [anchor] => STRING
-reply_userEmailAddress
-reply_userHandle
-reply_postHandle
-reply_userImage
-reply_postId
-reply_userId
-reply_title
-reply_createDate
-reply_modDate
-reply_postEmailAddress
-reply_postHandle
-ratingAverage
+                   [agreeTotal] => INT
-ratingTotal
+                   [agreeCount] => INT
-ratingCount
-ratingCount1
+           [1] => Array ...
-ratingCount2
-ratingCount3
-ratingCount4
-ratingCount5
-−
-agreeTotal
-agreeCount
+         )
-    [1] ...
+)
 </pre>
@@ Line 80: / Line 85: @@
 // get postings for current page
-$postArr = eV::pageForumPostsGet(NULL,$pageId,NULL,'
 </source>