Difference between revisions of "CSData 1 0-getPageMetadata"

From ADF Docs
Jump to: navigation, search
(→‎Usage:)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
Attention: Do not change any text in the description, signature, and paramter sections.
 +
 +
Return to [[CSData_1_0]]
 +
 
== Description ==  
 
== Description ==  
−
Return the standard and custom metadata for a page.
+
Given a Page ID, getPageMetadata will return a structure containing the standard and custom metadata for a page.
  
−
== Signature ==
+
== Signature ==  
 +
public Struct <strong>getPageMetadata</strong> ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList )
  
−
Signature
+
== Parameters ==
  
−
== Parameters ==
+
<table id="lib-params">
 +
<tr class="header">
 +
<td>Required</td>
 +
<td>Name</td>
 +
<td>Type</td>
 +
<td>Description</td>
 +
</tr>
 +
 +
 +
<tr>
 +
 +
<td class="required">required</td>
 +
 +
<td>pageID</td>
 +
<td>numeric</td>
 +
<td></td>
 +
</tr>
 +
 +
<tr>
 +
 +
<td class="required">optional</td>
 +
 +
<td>categoryID</td>
 +
<td>numeric</td>
 +
<td></td>
 +
</tr>
 +
 +
<tr>
 +
 +
<td class="required">optional</td>
 +
 +
<td>subsiteID</td>
 +
<td>numeric</td>
 +
<td></td>
 +
</tr>
 +
 +
<tr>
 +
 +
<td class="required">optional</td>
 +
 +
<td>inheritedTemplateList</td>
 +
<td>string</td>
 +
<td>[Default: ] </td>
 +
</tr>
 +
 +
</table>
 +
=== Usage: ===
 +
Example 1: Get the approval status for the current page.  Uses the standard page metadata:
 +
<source lang="cfm">
 +
<cfscript>
 +
        pageMeta =  application.ADF.CSData.getpageMetadata(request.page.id);
 +
    if ( StructKeyExists(pageMeta.standard, "approvalStatus") AND
 +
              LEN(pageMeta.standard.approvalStatus)){
 +
       
 +
    pageApprovalStatus = pageMeta.standard["approvalStatus"];
 +
       
 +
        }
 +
</cfscript>
 +
</source>
  
−
Parameters
+
Example 2: Get the blogID from the custom Metadata form bound to the current page:
 +
<source lang="cfm">
 +
<cfscript>
 +
    pageMeta =  application.ADF.CSData.getpageMetadata(request.page.id);
 +
if ( StructKeyExists(pageMeta.custom, "Blogs2") AND
 +
              (StructKeyExists(pageMeta.custom.Blogs2, "blogID")) and
 +
              (LEN(pageMeta.custom.Blogs2.blogID))){
 +
  blogID = pageMeta.custom.Blogs2.blogID;
 +
   
 +
    }
 +
</cfscript>
 +
</source>

Latest revision as of 21:32, 26 March 2012

Attention: Do not change any text in the description, signature, and paramter sections.

Return to CSData_1_0

Description

Given a Page ID, getPageMetadata will return a structure containing the standard and custom metadata for a page.

Signature

public Struct getPageMetadata ( numeric pageID, numeric categoryID, numeric subsiteID, string inheritedTemplateList )

Parameters

Required Name Type Description
required pageID numeric
optional categoryID numeric
optional subsiteID numeric
optional inheritedTemplateList string [Default: ]

Usage:

Example 1: Get the approval status for the current page. Uses the standard page metadata: 

<cfscript>
        pageMeta =  application.ADF.CSData.getpageMetadata(request.page.id);
    	 if ( StructKeyExists(pageMeta.standard, "approvalStatus") AND
              LEN(pageMeta.standard.approvalStatus)){
        
     	 pageApprovalStatus = pageMeta.standard["approvalStatus"];
        
        	}
</cfscript>

Example 2: Get the blogID from the custom Metadata form bound to the current page: 

<cfscript>
     pageMeta =  application.ADF.CSData.getpageMetadata(request.page.id);
 	 if ( StructKeyExists(pageMeta.custom, "Blogs2") AND 
               (StructKeyExists(pageMeta.custom.Blogs2, "blogID")) and 
               (LEN(pageMeta.custom.Blogs2.blogID))){
  	 blogID = pageMeta.custom.Blogs2.blogID;
     
     	}
</cfscript>
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CSData_1_0-getPageMetadata&oldid=5530"