SurveyComponentManager Class Reference

SurveyComponentManager - manages survey component; the class name SurveyManager is used for management of the survey feature. More...

Public Member Functions
	SurveyComponentManager ()

Static Public Member Functions
static	enumerateContextHelpClasses ($classes)
static	setDefaults ()
static	enumerateDataItemClasses ($classes)
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	deleteSurvey ($survey)
static	deleteSurveyResponse ($response)
static	upgradeComponent ($version)

Detailed Description

SurveyComponentManager - manages survey component; the class name SurveyManager is used for management of the survey feature.

Author

janice

Definition at line 46 of file survey_component_manager.inc.

Member Function Documentation

deleteSurvey()

static SurveyComponentManager::deleteSurvey (   $survey )

static

Definition at line 129 of file survey_component_manager.inc.

     {
          $survey_id = $survey->survey_id;
          $questions = $survey->Questions();
          
          $tx = new DataTransaction();
          
          try
          {
               $xref = new SurveyQuestionXref();
               $xref->joinTransaction($tx);
               $xref->delete("WHERE survey_id={$survey_id}");
               
               $responses = $survey->Responses();
               
               if(count($responses))
               {
                    foreach($responses as $response)
                    {
                         $response->joinTransaction($tx);
                         SurveyComponentManager::deleteSurveyResponse($response);
                    }
               }
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
          
          // Delete any questions that are now not linked to any survey
          foreach($questions as $question)
          {
               $count = Query::create(SurveyQuestionXref, "WHERE survey_question_id=:survey_question_id")
               ->bind(":survey_question_id", $question->survey_question_id)
               ->executeValue("COUNT(1)");
               
               if($count == 0)
               {
                    $question->delete();
               }         
          }
     }

deleteSurveyResponse()

static SurveyComponentManager::deleteSurveyResponse (   $response )

static

Definition at line 175 of file survey_component_manager.inc.

     {
          $tx = new DataTransaction();
          
          try
          {
               $response->joinTransaction($tx);
               
               $answer = new SurveyAnswer();
               $answer->joinTransaction($tx);
               $answer->delete("WHERE response_id={$response->response_id}");
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
     }

deleteUser()

static SurveyComponentManager::deleteUser (   $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj

$user

- class SiteUser or custom user class

Definition at line 97 of file survey_component_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component survey is deleting objects dependent on user_id {$user_id}", 3);
     
          $tx = new DataTransaction();
          
          try
          {
               $surveys = Query::create(Survey, "WHERE user_id=:user_id")
                    ->bind(":user_id", $user_id)
                    ->execute();
               
               foreach($surveys as $survey)
               {
                    $survey->joinTransaction($tx);
                    SurveyComponentManager::deleteSurvey($survey);
               }
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
                    
          return $user;
     }

enumerateContextHelpClasses()

static SurveyComponentManager::enumerateContextHelpClasses (   $classes )

static

Definition at line 53 of file survey_component_manager.inc.

     {
          $classes[] = "SurveyAnswer";
          $classes[] = "SurveyQuestion";
          $classes[] = "SurveyResponse";
          $classes[] = "Survey";
 
          return $classes;
     }

enumerateDataItemClasses()

static SurveyComponentManager::enumerateDataItemClasses (   $classes )

static

Definition at line 79 of file survey_component_manager.inc.

     {
          $classes[] = "SurveyAnswer";
          $classes[] = "SurveyQuestion";
          $classes[] = "SurveyResponse";
          $classes[] = "Survey";
          $classes[] = "SurveyQuestionXref";
 
          return $classes;
     }

setDefaults()

static SurveyComponentManager::setDefaults ( )

static

Definition at line 63 of file survey_component_manager.inc.

     {
          trace("SurveyManager::setDefaults", 3);
 
          global $config;
 
          Settings::setDefaultValue("survey", "sender_email", "", "String", "The email address that will appear as the sender of the survey email", "Survey Emails");
          Settings::setDefaultValue("survey", "email_subject", "Survey from ". $config["http_host"], "String", "The default or standard subject line for survey emails", "Survey Emails");
          Settings::setDefaultValue("survey", "message_footer", "<br><br>Click the link below to access the survey:<br>[survey_link]<br><br>or go to<br>[survey_intro_link], click on [survey_title], and enter your access token [token] at the prompt.<br>", "Text", "The text to be included below the main
               message in all surveys, providing users with a link to response. 
               The text within brackets represent codes that will be filled in with data 
               from the survey record when the survey is sent.", "Survey Emails");
          Settings::setDefaultValue("survey", "interactive_graphs", false, Boolean, "Show interactive SVG graphs on the report screens, rather than static images");
 
     }

SurveyComponentManager()

SurveyComponentManager::SurveyComponentManager

(

)

Definition at line 48 of file survey_component_manager.inc.

     {
          
     }

upgradeComponent()

static SurveyComponentManager::upgradeComponent (   $version )

static

Definition at line 196 of file survey_component_manager.inc.

     {
          $mgr = new SurveyUpgradeManager();
          $mgr->upgrade($version);
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/survey/survey_component_manager.inc