Browse Source

Added AttributeDef::EnumTemplateVerbs, to generate the documentation about the available attribute formatting placeholders

git-svn-id: http://svn.code.sf.net/p/itop/code/trunk@3835 a333f486-631f-4898-b8df-5754b55c2be0
romainq 9 years ago
parent
commit
6cb7497493
1 changed files with 36 additions and 0 deletions
  1. 36 0
      core/attributedef.class.inc.php

+ 36 - 0
core/attributedef.class.inc.php

@@ -489,6 +489,19 @@ abstract class AttributeDefinition
 		return $this->GetAsHTML($sValue, $oHostObject, $bLocalize);
 	}
 	
+
+	/**
+	 * List the available verbs for 'GetForTemplate'
+	 */	 
+	public static function EnumTemplateVerbs()
+	{
+		return array(
+			'' => 'Plain text (unlocalized) representation',
+			'html' => 'HTML representation',
+			'label' => 'Localized representation',
+		);
+	}
+
 	/**
 	 * Get various representations of the value, for insertion into a template (e.g. in Notifications)
 	 * @param $value mixed The current value of the field
@@ -819,6 +832,17 @@ class AttributeLinkedSet extends AttributeDefinition
 	}
 
 	/**
+	 * List the available verbs for 'GetForTemplate'
+	 */	 
+	public static function EnumTemplateVerbs()
+	{
+		return array(
+			'' => 'Plain text (unlocalized) representation',
+			'html' => 'HTML representation (unordered list)',
+		);
+	}
+
+	/**
 	 * Get various representations of the value, for insertion into a template (e.g. in Notifications)
 	 * @param $value mixed The current value of the field
 	 * @param $sVerb string The verb specifying the representation of the value
@@ -2502,6 +2526,18 @@ class AttributeCaseLog extends AttributeLongText
 		}
 	}
 
+	/**
+	 * List the available verbs for 'GetForTemplate'
+	 */	 
+	public static function EnumTemplateVerbs()
+	{
+		return array(
+			'' => 'Plain text representation of all the log entries',
+			'head' => 'Plain text representation of the latest entry',
+			'head_html' => 'HTML representation of the latest entry',
+			'html' => 'HTML representation of all the log entries',
+		);
+	}
 
 	/**
 	 * Get various representations of the value, for insertion into a template (e.g. in Notifications)