plugins/reports/registrants/RegistrantReportPlugin.inc.php

Go to the documentation of this file.

<?php

//$Id$

import('classes.plugins.ReportPlugin');

class RegistrantReportPlugin extends ReportPlugin {
   function register($category, $path) {
      $success = parent::register($category, $path);
      if ($success) {
         $this->import('RegistrantReportDAO');
         $registrantReportDAO = new RegistrantReportDAO();
         DAORegistry::registerDAO('RegistrantReportDAO', $registrantReportDAO);
      }
      $this->addLocaleData();
      return $success;
   }

   function getName() {
      return 'RegistrantReportPlugin';
   }

   function getDisplayName() {
      return __('plugins.reports.registrants.displayName');
   }

   function getDescription() {
      return __('plugins.reports.registrants.description');
   }

   function display(&$args) {
      $conference =& Request::getConference();
      $schedConf =& Request::getSchedConf();
      AppLocale::requireComponents(array(LOCALE_COMPONENT_APPLICATION_COMMON, LOCALE_COMPONENT_PKP_USER, LOCALE_COMPONENT_OCS_MANAGER));

      header('content-type: text/comma-separated-values; charset=utf-8');
      header('content-disposition: attachment; filename=report.csv');

      $registrantReportDao =& DAORegistry::getDAO('RegistrantReportDAO');
      list($registrants, $registrantOptions) = $registrantReportDao->getRegistrantReport(
         $conference->getId(),
         $schedConf->getId()
      );
            
      $columns = array(
         'userid' => __('plugins.reports.registrants.userid'),
         'uname' => __('user.username'),
         'fname' => __('user.firstName'),
         'mname' => __('user.middleName'),
         'lname' => __('user.lastName'),
         'affiliation' => __('user.affiliation'),
         'url' => __('user.url'),
         'email' => __('user.email'),
         'phone' => __('user.phone'),
         'fax' => __('user.fax'),
         'address' => __('common.mailingAddress'),
         'country' => __('common.country'),
         'type' => __('manager.registration.registrationType')
      );
      
      $registrationOptionDAO =& DAORegistry::getDAO('RegistrationOptionDAO');
      $registrationOptions =& $registrationOptionDAO->getRegistrationOptionsBySchedConfId($schedConf->getId());
      
      // column name = 'option' + optionId => column value = name of the registration option
      while ($registrationOption =& $registrationOptions->next()) {
         $registrationOptionIds[] = $registrationOption->getOptionId();
         $columns = array_merge($columns, array('option' . $registrationOption->getOptionId() => $registrationOption->getRegistrationOptionName()));
         unset($registrationOption);
      } 
      
      $columns = array_merge($columns, array(
         'regdate' => __('manager.registration.dateRegistered'),
         'paiddate' => __('manager.registration.datePaid'),
         'specialreq' => __('schedConf.registration.specialRequests')
         ));


      $fp = fopen('php://output', 'wt');
      String::fputcsv($fp, array_values($columns));

      while ($row =& $registrants->next()) {
         if ( isset($registrantOptions[$row['registration_id']]) ) { 
            $options = $this->mergeRegistrantOptions($registrationOptionIds, $registrantOptions[$row['registration_id']]);
         } else {
            $options = $this->mergeRegistrantOptions($registrationOptionIds);
         }
         
         foreach ($columns as $index => $junk) {
            if (isset($row[$index])) {
               $columns[$index] = $index == 'affiliation'?
                  html_entity_decode(strip_tags($row[$index]), ENT_QUOTES, 'UTF-8'):
                  $row[$index];
            } else if (isset($options[$index])) {
               $columns[$index] = $options[$index];
            } else $columns[$index] = '';
         }
         
         String::fputcsv($fp, $columns);
         unset($row);
      }
      fclose($fp);
   }

   
   function mergeRegistrantOptions($registrationOptionIds, $registrantOptions = array()) {
      $returner = array();
      foreach ( $registrationOptionIds as $id ) { 
         $returner['option'. $id] = ( in_array($id, $registrantOptions) )?__('common.yes'):__('common.no');
      }
      return $returner;
   }
}

?>

---