Difference between revisions of "CEData 1 0"

From ADF Docs
Jump to: navigation, search
(→‎Functions)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
<div id='library-api'>
+
 
 
Attention: Do not change any text in the description, properties, and functions sections.
 
Attention: Do not change any text in the description, properties, and functions sections.
  
Line 15: Line 15:
  
 
== Functions ==  
 
== Functions ==  
−
:public [[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( array, string, string, string, string )
+
<div id='library-api'>
−
:public [[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( array )
+
:[[CEData_1_0-arrayOfCEDataSort|arrayOfCEDataSort]] ( array aOfS, string key, string sortOrder, string sortType, string delim )
 +
:[[CEData_1_0-buildElementInfoStruct|buildElementInfoStruct]] ( array ceData )
 
::Builds an ElementInfo structure given a ceData array
 
::Builds an ElementInfo structure given a ceData array
−
:public [[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( array, array )
+
:[[CEData_1_0-compareCEDataArray|compareCEDataArray]] ( array array1, array array2 )
−
:public [[CEData_1_0-containsFieldType|containsFieldType]] ( numeric, string )
+
:[[CEData_1_0-containsFieldType|containsFieldType]] ( numeric FormID, string fieldType )
−
 
+
:[[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( string ceName )
−
:public [[CEData_1_0-defaultFieldStruct|defaultFieldStruct]] ( string )
+
:[[CEData_1_0-deleteByElementName|deleteByElementName]] ( string ceName )
−
:public [[CEData_1_0-deleteByElementName|deleteByElementName]] ( string )
 
 
::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name
 
::Delete the Custom Element records from the data_fieldvalue table given a Custom Element name
−
:public [[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( string )
+
:[[CEData_1_0-deleteCacheInstances|deleteCacheInstances]] ( string ceName )
−
:public [[CEData_1_0-deleteCE|deleteCE]] ( string )
+
:[[CEData_1_0-deleteCE|deleteCE]] ( string datapageidList )
−
:public [[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( array, array )
+
:[[CEData_1_0-diffCEDataArray|diffCEDataArray]] ( array array1, array array2 )
−
:public [[CEData_1_0-elementExists|elementExists]] ( string )
+
:[[CEData_1_0-elementExists|elementExists]] ( string elementName )
 
::Determines whether or not an element exists
 
::Determines whether or not an element exists
−
:public [[CEData_1_0-getAllCustomElements|getAllCustomElements]] (  )
+
:[[CEData_1_0-getAllCustomElements|getAllCustomElements]] (  )
 
::Returns all the Custom Elements for the site.
 
::Returns all the Custom Elements for the site.
−
:public [[CEData_1_0-getCEData|getCEData]] ( string, string, any, string, string, string )
+
:[[CEData_1_0-getCEData|getCEData]] ( string customElementName, string customElementFieldName, any item, string queryType, string searchValues, string searchFields )
 
::Returns array of structs for all data matching the Custom Element.
 
::Returns array of structs for all data matching the Custom Element.
−
:public [[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( numeric )
+
:[[CEData_1_0-getCEDataByFieldID|getCEDataByFieldID]] ( numeric fieldID )
 
::Returns Custom Element Data records for a given FieldID
 
::Returns Custom Element Data records for a given FieldID
−
:public [[CEData_1_0-getCEDataField|getCEDataField]] ( numeric, numeric, string )
+
:[[CEData_1_0-getCEDataField|getCEDataField]] ( numeric formid, numeric datapageid, string fieldName )
 
::Returns the single field data value for the custom element record.
 
::Returns the single field data value for the custom element record.
−
:public [[CEData_1_0-getCEDataFieldUUID|getCEDataFieldUUID]] ( numeric, string, string )
+
:[[CEData_1_0-getCEDataFieldUUID|getCEDataFieldUUID]] ( numeric formid, string uuid, string fieldName )
 
::Returns the single field data value by the custom element UUID data value.
 
::Returns the single field data value by the custom element UUID data value.
−
:public [[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( string, string )
+
:[[CEData_1_0-getCEFieldValues|getCEFieldValues]] ( string ceName, string fieldName )
 
::Returns all values for a particular field in a particular custom element.
 
::Returns all values for a particular field in a particular custom element.
−
:public [[CEData_1_0-getCEForCategory|getCEForCategory]] ( string )
+
:[[CEData_1_0-getCEForCategory|getCEForCategory]] ( string categoryName )
 
::Returns a query of the CE's name and form ID that are in the Category argument.
 
::Returns a query of the CE's name and form ID that are in the Category argument.
−
:public [[CEData_1_0-getCENameByFormID|getCENameByFormID]] ( numeric )
+
:[[CEData_1_0-getCENameByFormID|getCENameByFormID]] ( numeric FormID )
−
 
+
:[[CEData_1_0-getCountForElementField|getCountForElementField]] ( string ceName, string fieldName, any fieldValue )
−
:public [[CEData_1_0-getCountForElementField|getCountForElementField]] ( string, string, any )
+
:[[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( Numeric pageid, Numeric formid, boolean currentVersionFlag, numeric versionID )
−
::
+
:[[CEData_1_0-getElementFieldID|getElementFieldID]] ( numeric CEFormID, string CEFieldName )
−
:public [[CEData_1_0-getDataFieldValueByPageID|getDataFieldValueByPageID]] ( Numeric, Numeric, boolean, numeric )
+
:[[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( Numeric formid )
−
 
+
:[[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( Numeric pageid, Numeric formid, boolean separateValueStruct )
−
:public [[CEData_1_0-getElementFieldID|getElementFieldID]] ( numeric, string )
+
:[[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( Numeric pageid, Numeric formid, Numeric versionID )
−
 
+
:[[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( Numeric pageid, Numeric formid )
−
:public [[CEData_1_0-getElementFieldsByFormID|getElementFieldsByFormID]] ( Numeric )
+
:[[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( string fieldType )
−
 
 
−
:public [[CEData_1_0-getElementInfoByPageID|getElementInfoByPageID]] ( Numeric, Numeric, boolean )
 
−
 
 
−
:public [[CEData_1_0-getElementInfoVersionsByPageID|getElementInfoVersionsByPageID]] ( Numeric, Numeric, Numeric )
 
−
 
 
−
:public [[CEData_1_0-getElementVersionsForPageID|getElementVersionsForPageID]] ( Numeric, Numeric )
 
−
 
 
−
:public [[CEData_1_0-getFieldIdsByType|getFieldIdsByType]] ( string )
 
 
::Returns a list of fieldID's for a given Field Type
 
::Returns a list of fieldID's for a given Field Type
−
:public [[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( string )
+
:[[CEData_1_0-getFormIDByCEName|getFormIDByCEName]] ( string CEName )
−
 
+
:[[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( Numeric pageid )
−
:public [[CEData_1_0-getFormIDFromPageID|getFormIDFromPageID]] ( Numeric )
 
 
::Returns the Form ID for the Page ID.
 
::Returns the Form ID for the Page ID.
−
:public [[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( numeric, string, any, string, string, string )
+
:[[CEData_1_0-getPageIDForElement|getPageIDForElement]] ( numeric formid, string fieldid, any item, string queryType, string searchValues, string searchFields )
 
::Returns Page ID Query in Data_FieldValue matching Form ID
 
::Returns Page ID Query in Data_FieldValue matching Form ID
−
:public [[CEData_1_0-invalidateElementCache|invalidateElementCache]] ( numeric, numeric )
+
:[[CEData_1_0-invalidateElementCache|invalidateElementCache]] ( numeric pageID, numeric controlID )
−
 
+
:[[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( array arrayOfStructs, string idFieldName, string idList )
−
:public [[CEData_1_0-sortArrayByIDList|sortArrayByIDList]] ( array, string, string )
 
−
 
 
 
</div>
 
</div>

Latest revision as of 20:19, 8 April 2010


Attention: Do not change any text in the description, properties, and functions sections.

Return to Library (API)

Description

Custom Element Data functions for the ADF Library

Properties

dependency = csSecurity_1_0
version = 1_0_0
wikiTitle = CEData_1_0
type = singleton

Functions

arrayOfCEDataSort ( array aOfS, string key, string sortOrder, string sortType, string delim )
buildElementInfoStruct ( array ceData )
Builds an ElementInfo structure given a ceData array
compareCEDataArray ( array array1, array array2 )
containsFieldType ( numeric FormID, string fieldType )
defaultFieldStruct ( string ceName )
deleteByElementName ( string ceName )
Delete the Custom Element records from the data_fieldvalue table given a Custom Element name
deleteCacheInstances ( string ceName )
deleteCE ( string datapageidList )
diffCEDataArray ( array array1, array array2 )
elementExists ( string elementName )
Determines whether or not an element exists
getAllCustomElements ( )
Returns all the Custom Elements for the site.
getCEData ( string customElementName, string customElementFieldName, any item, string queryType, string searchValues, string searchFields )
Returns array of structs for all data matching the Custom Element.
getCEDataByFieldID ( numeric fieldID )
Returns Custom Element Data records for a given FieldID
getCEDataField ( numeric formid, numeric datapageid, string fieldName )
Returns the single field data value for the custom element record.
getCEDataFieldUUID ( numeric formid, string uuid, string fieldName )
Returns the single field data value by the custom element UUID data value.
getCEFieldValues ( string ceName, string fieldName )
Returns all values for a particular field in a particular custom element.
getCEForCategory ( string categoryName )
Returns a query of the CE's name and form ID that are in the Category argument.
getCENameByFormID ( numeric FormID )
getCountForElementField ( string ceName, string fieldName, any fieldValue )
getDataFieldValueByPageID ( Numeric pageid, Numeric formid, boolean currentVersionFlag, numeric versionID )
getElementFieldID ( numeric CEFormID, string CEFieldName )
getElementFieldsByFormID ( Numeric formid )
getElementInfoByPageID ( Numeric pageid, Numeric formid, boolean separateValueStruct )
getElementInfoVersionsByPageID ( Numeric pageid, Numeric formid, Numeric versionID )
getElementVersionsForPageID ( Numeric pageid, Numeric formid )
getFieldIdsByType ( string fieldType )
Returns a list of fieldID's for a given Field Type
getFormIDByCEName ( string CEName )
getFormIDFromPageID ( Numeric pageid )
Returns the Form ID for the Page ID.
getPageIDForElement ( numeric formid, string fieldid, any item, string queryType, string searchValues, string searchFields )
Returns Page ID Query in Data_FieldValue matching Form ID
invalidateElementCache ( numeric pageID, numeric controlID )
sortArrayByIDList ( array arrayOfStructs, string idFieldName, string idList )
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CEData_1_0&oldid=2728"