diff --git a/lam/lib/baseModule.inc b/lam/lib/baseModule.inc index fc698fca..b4504598 100644 --- a/lam/lib/baseModule.inc +++ b/lam/lib/baseModule.inc @@ -639,15 +639,50 @@ abstract class baseModule { } /** - * Returns a hastable with all entries that may be printed out in the PDF. The - * syntax of the hashtable is specified by the module specification and the - * corresponding DTD. This method must be overwritten in case that there - * are non static things to be returned. The $this->meta['PDF_entries'] array - * may be used when there is only static content. - * + * Returns a hashtable with all entries that may be printed out in the PDF. + * This method must be overwritten in case that there are non static values + * to be returned. The $this->meta['PDF_entries'] array may be used for static content.
+ *
+ * Format of returned hashtable:
+ *
+ * This function uses XML formatted commands to define the PDF output. Each part in the PDF + * document is surrounded by "" and "".
+ * Inside the tags there are different ways to format the output: + * + * Special commands: + * + *
+ * Examples:
+ *
+ * Simple name+value lines:

+ * In most cases you will just want to display a single line per attribute with its name and value.
+ *
+ * 'myAttribute' => 'AttrName12345'
+ *
+ * This will give the following PDF output:
+ *
+ * Attribute name: 12345
+ *
+ *
+ * Multiline values:

+ * Sometimes you have multivalued attributes where it is not applicable to write all values in one line but + * where you want to list your values one below the other or show a table. This can be done by using the tag.
+ *
+ * This example only uses one column but you can just use more tags per tag to display more columns.
+ *
+ * 'myAttribute' => 'AttrName123456789' + * * @param string $scope account type - * @return array hastable of entries for the PDF. Each entry is an array where - * each entry is treated as a new line in the PDF. + * @return array PDF entries + * + * @see baseModule::get_metaData() */ function get_pdf_entries($scope = 'user') { return ((isset($this->meta['PDF_entries'])) ? $this->meta['PDF_entries'] : array());