gyro/core/lib/interfaces/iactionsource.cls.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * Interface for all DAO objects having actions
00004  * 
00005  * @author Gerd Riesselmann
00006  * @ingroup Interfaces
00007  */ 
00008 interface IActionSource {
00009         /**
00010          * Get all actions
00011          *
00012          * @param dao_User The current user or false if no user is logged on
00013          * @param String The context. Some actions may not be approbiate in some situations. For example, 
00014          *               action 'edit' should not be returned when editing. THis can be expressed throug a 
00015          *               context named 'edit'. Default context is 'view'.   
00016          * @return Array Associative array with action url as key and action description as value 
00017          */
00018         public function get_actions($user, $context = 'view', $params = false);
00019         
00020         /**
00021          * Identify for generic actionh processing
00022          * 
00023          * @return string
00024          */
00025         public function get_action_source_name();
00026 }