get_composer
get_composer (arr, type[, doc])
The get_composer function gets a composer handle that corresponds to the composer type from the DCF file of the document to be published. It then populates an array with the composer parameters.
The arr parameter specifies the array to populate. The type parameter specifies the type of composer. The types are the type attribute values specified in the Compose element in the DCF file for doc.
The doc parameter specifies the document for which the composer is being created. If doc is 0 or not specified, the current document is used.
The associative array arr is populated with the values of the composer parameters. Composer parameters are defined by Parameter elements in the CCF file's Interface element. A Parameter element in the DCF file can override the composer parameters specified in the CCF file. A defined parameter that does not have a default value specified in the DCF or CCF file returns an empty string as its value.
The function returns a composer handle or an empty string if an error occurs.
|
|
Calling this function requires parsing the CCF file, unless the file has been cached. Subsequent changes to the CCF file will not be seen unless you flush the composer using the flush_composer function.
|
