[interchange-docs] xmldocs - racke modified refs/if-mm.tag

[docs at icdevgroup.org]

User:      racke
Date:      2007-02-15 14:29:43 GMT
Modified:  refs     if-mm.tag
Log:
documented logged_in function

Revision  Changes    Path
1.2       +64 -0     xmldocs/refs/if-mm.tag


rev 1.2, prev_rev 1.1
Index: if-mm.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/if-mm.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- if-mm.tag	17 Feb 2005 23:25:39 -0000	1.1
+++ if-mm.tag	15 Feb 2007 14:29:43 -0000	1.2
@@ -1,7 +1,54 @@
+__NAME__ purpose
+check permissions for UI tasks
+__END__
+
 __NAME__ synopsis 
 <row>
 
 	<entry>
+	<group choice='optional'>
+		<arg choice='plain'>function</arg>
+		<arg choice='plain'>key</arg>
+	</group>
+	</entry>
+	<entry>
+	yes
+	</entry>
+	<entry>
+	yes
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	function to check permissions for
+	</entry>
+
+</row> 
+
+<row>
+
+	<entry>
+	name
+	</entry>
+	<entry>
+	<!-- POS -->
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+
+<row>
+
+	<entry>
 	table
 	</entry>
 	<entry>
@@ -39,4 +86,21 @@
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
+__END__
+
+__NAME__ description
+This tag performs various checks on behalf of the UI:
+</para><para>
+<refsect2>
+<title>logged_in</title>
+<para>
+Checks whether the current user is logged into the UI.
+<programlisting>
+[if-mm !logged_in]
+[calc]$Session->{ui_error} = 'Not authorized!'; return;[/calc]
+[bounce page="admin/error"]
+[/if-mm]
+</programlisting>
+</para>
+</refsect2>
 __END__