Source for file actions.php

Documentation is available at actions.php

  1. <?php
  2. /**
  3. * List of all currently available actions
  4. *
  5. * @author     Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Actions
  11. *
  12. *  path (bumblebee root)/inc/actions/actions.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. require_once 'inc/permissions.php';
  20.  
  21. /**
  22. * An available action
  23. *
  24. * @package    Bumblebee
  25. * @subpackage Actions
  26. */
  27. class ActionData {
  28.   /** @var string    name of the action in action= URL */
  29.   var $name;
  30.   /** @var string    title for the html page */
  31.   var $title;
  32.   /** @var string    name of the action for the menu */
  33.   var $menu;
  34.   /** @var string    name of the Action* class that should be instantiated */
  35.   var $action_class;
  36.   /** @var boolean   include the entry on the menu */
  37.   var $menu_visible;
  38.   /** @var integer   permissions required for this action */
  39.   var $permissions;
  40.   /** @var integer   menu order number (lowest numbers at top of menu) */
  41.   var $menu_order = NULL;
  42.   /** @var integer   name of the action that should follow next (defaults to $this->name) */
  43.   var $next_action;
  44.  
  45.   /**
  46.   *  Create a new ActionData object
  47.   *
  48.   * @param string $class          name of the class to be instantiated
  49.   * @param string $file          name of the php file to be included
  50.   * @param string $name 
  51.   * @param string $title 
  52.   * @param string $menu 
  53.   * @param integer $permissions    from permissions.php (default: BBROLE_NONE)
  54.   * @param integer $menu_order     use negative number for not shown on menu, default: use in order instantiated into ActionListing
  55.   * @param string $next_action 
  56.   */
  57.   function ActionData($class, $file, $name, $title, $menu, $permissions=BBROLE_NONE,
  58.                       $menu_order=NULL, $next_action=NULL) {
  59.     $this->action_class = $class;
  60.     $this->name         = $name;
  61.     $this->file         = $file;
  62.     $this->menu         = $menu;
  63.     $this->title        = $title;
  64.     $this->permissions  = $permissions;
  65.     $this->menu_order   = $menu_order;
  66.     $this->menu_visible = ($menu_order === NULL || $menu_order > 0);
  67.     $this->next_action  = $next_action === NULL ? $name : $next_action;
  68.   }
  69.  
  70.   function name() {
  71.     return $this->name;
  72.   }
  73.  
  74.   function title() {
  75.     return $this->title;
  76.   }
  77.  
  78.   function menu() {
  79.     return $this->menu;
  80.   }
  81.   function permissions() {
  82.     return $this->permissions;
  83.   }
  84.  
  85.   function menu_order() {
  86.     return $this->menu_order;
  87.   }
  88.  
  89.   function menu_visible($permissions=-1) {
  90.     return $this->menu_visible & $permissions;
  91.   }
  92.  
  93.   function requires_admin() {
  94.     return $this->permissions >= BBROLE_ADMIN_BASE;
  95.   }
  96.  
  97.   function next_action($action=NULL) {
  98.     if ($action === NULL)
  99.       return $this->next_action;
  100.     return $this->next_action = $action;
  101.   }
  102.  
  103.   function action_class() {
  104.     return $this->action_class;
  105.   }
  106.  
  107.   function include_file() {
  108.     return $this->file;
  109.   }
  110.  
  111. }
  112.  
  113. /**
  114. * List of all currently available actions
  115. *
  116. * Create data structures that can describe both the action-word to be acted
  117. * on, as well as the title to be reflected in the HTML title tag.
  118. *
  119. * @todo //TODO: this should be integrated with the Menu class
  120. * @todo //TODO: document the fixed up version
  121. * @package    Bumblebee
  122. * @subpackage Actions
  123. */
  124. class ActionListing {
  125.   /** @var array  list of ActionData objects */
  126.   var $actions        = array();
  127.   /** @var string name of default action when none is explicitly specified in the URL */
  128.   var $default_action = 'view';
  129.  
  130.   function ActionListing() {
  131.     $this->_populate();
  132.     $this->_initialise();
  133.   }
  134.  
  135.   /** @todo //TODO:: conditionally initialise these -- at least limit the number of extraneous T_() calls for non admin users */
  136.   function _populate() {
  137.     $this->actions[] = new ActionData('ActionUnknown', 'unknownaction.php',
  138.         'unknown',    T_('Oops! I cannot do that!'), T_('Unknown'), BBROLE_NONE, -1);
  139.     $this->actions[] = new ActionData('ActionUnknown', 'unknownaction.php',
  140.         'forbidden!', T_('No, you cannot do that'), T_('Forbidden'), BBROLE_NONE, -1);
  141.     $this->actions[] = new ActionData('ActionOffline', 'offline.php',
  142.         'offline', T_('System Offline'), T_('System Offline'), BBROLE_NONE, -1);
  143.  
  144.     $this->actions[] = new ActionData('ActionView', 'view.php',
  145.         'view',       T_('View list of instruments'), T_('Main'), BBROLE_NONE);
  146.     $this->actions[] = new ActionData('ActionCalendar', 'calendar.php',
  147.         'calendar',   T_('View instrument calendar'), T_('Calendar'), BBROLE_NONE, -1);
  148.     $this->actions[] = new ActionData('ActionBook', 'book.php',
  149.         'book',       T_('View/edit instrument bookings'), T_('Bookings'), BBROLE_NONE, -1);
  150.     $this->actions[] = new ActionData('ActionBookContact', 'bookcontact.php',
  151.         'bookcontact',T_('Requeset an instrument booking'), T_('Request booking'), BBROLE_NONE, -1);
  152.     $this->actions[] = new ActionData('ActionPassword', 'password.php',
  153.         'passwd',     T_('Change password'), T_('Change password'),    BBROLE_PASSWD);
  154.     $this->actions[] = new ActionData('ActionPrintLoginForm', 'login.php',
  155.         'login',      T_('Login'), T_('Login'), BBROLE_NONE, -1, 'view');
  156.     $this->actions[] = new ActionData('ActionLogout', 'logout.php',
  157.         'logout',     T_('Logout'), T_('Logout'), BBROLE_LOGOUT);
  158.  
  159.     $this->actions[] = new ActionData('ActionGroups', 'groups.php',
  160.         'groups',     T_('Manage groups'), T_('Edit groups'), BBROLE_ADMIN_GROUPS);
  161.     $this->actions[] = new ActionData('ActionProjects', 'projects.php',
  162.         'projects',   T_('Manage projects'), T_('Edit projects'), BBROLE_ADMIN_PROJECTS);
  163.     $this->actions[] = new ActionData('ActionUsers', 'users.php',
  164.         'users',      T_('Manage users'), T_('Edit users'), BBROLE_ADMIN_USERS);
  165.     $this->actions[] = new ActionData('ActionInstruments', 'instruments.php',
  166.         'instruments', T_('Manage instruments'), T_('Edit instruments'), BBROLE_ADMIN_INSTRUMENTS);
  167.     $this->actions[] = new ActionData('ActionConsumables', 'consumables.php',
  168.         'consumables', T_('Manage consumables'), T_('Edit consumables'), BBROLE_ADMIN_CONSUMABLES);
  169.     $this->actions[] = new ActionData('ActionConsume', 'consume.php',
  170.         'consume',    T_('Record consumable usage'), T_('Use consumable'), BBROLE_ADMIN_CONSUME);
  171.     $this->actions[] = new ActionData('ActionMasquerade', 'masquerade.php',
  172.         'masquerade', T_('Masquerade as another user'), T_('Masquerade'), BBROLE_ADMIN_MASQ);
  173.     $this->actions[] = new ActionData('ActionCosts', 'costs.php',
  174.         'costs',      T_('Edit standard costs'), T_('Edit costs'), BBROLE_ADMIN_COSTS);
  175.     $this->actions[] = new ActionData('ActionSpecialCosts', 'specialcosts.php',
  176.         'specialcosts',    T_('Edit or create special charges'), T_('Edit special costs'), BBROLE_ADMIN_COSTS, -1);
  177.     $this->actions[] = new ActionData('ActionUserClass', 'userclass.php',
  178.         'userclass',  T_('Edit or create user class'), T_('Edit user class'), BBROLE_ADMIN_COSTS, -1);
  179.     $this->actions[] = new ActionData('ActionInstrumentClass', 'instrumentclass.php',
  180.         'instrumentclass', T_('Edit or create instrument class'), T_('Edit instrument class'), BBROLE_ADMIN_COSTS, -1);
  181.     $this->actions[] = new ActionData('ActionDeletedBookings', 'deletedbookings.php',
  182.         'deletedbookings', T_('View deleted bookings'), T_('Deleted bookings'), BBROLE_ADMIN_DELETEDBOOKINGS);
  183.     $this->actions[] = new ActionData('ActionEmaillist', 'emaillist.php',
  184.         'emaillist',  T_('Email lists'), T_('Email lists'), BBROLE_ADMIN_EMAILLIST);
  185.     $this->actions[] = new ActionData('ActionExport', 'export.php',
  186.         'export',     T_('Export data'), T_('Export data'), BBROLE_ADMIN_EXPORT);
  187.     $this->actions[] = new ActionData('ActionBilling', 'billing.php',
  188.         'billing',    T_('Prepare billing summaries'), T_('Billing reports'), BBROLE_ADMIN_BILLING);
  189.     $this->actions[] = new ActionData('ActionBackupDB', 'backupdatabase.php',
  190.         'backupdb',   T_('Backup database'), T_('Backup database'), BBROLE_ADMIN_BACKUPDB);
  191.     $this->actions[] = new ActionData('ActionSettings', 'settings.php',
  192.         'settings',   T_('Configuration editor'), T_('Configure system'), BBROLE_ADMIN_CONFIG);
  193.  
  194.   }
  195.  
  196.   function _initialise() {
  197.     $actions = $this->actions;
  198.     $this->actions = array();
  199.     foreach ($actions as $action) {
  200.       $this->actions[$action->name()] = $action;
  201.     }
  202.     $this->actions[''] = clone($this->actions[$this->default_action]);
  203.     $this->actions['']->menu_visible = false;
  204.   }
  205.  
  206.   function action_exists($action) {
  207.     return isset($this->actions[$action]);
  208.   }
  209.  
  210. } //ActionListing
  211.  
  212. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:30 +0000 by phpDocumentor 1.3.0