interface/super/rules/library/Rule.php

   1 <?php
   2  // Copyright (C) 2010-2011 Aron Racho <aron@mi-squred.com>
   3  //
   4  // This program is free software; you can redistribute it and/or
   5  // modify it under the terms of the GNU General Public License
   6  // as published by the Free Software Foundation; either version 2
   7  // of the License, or (at your option) any later version.
   8
   9 /**
  10  * This is the primary domain object representing a rule in the rules engine.
  11  * Rules are composed of:
  12  * - one or more rule types (see RuleType enum)
  13  * - a ReminderIntervals object
  14  * - a RuleFilters object
  15  * - a RuleTargets object
  16  * - a RuleActions object
  17  *
  18  * Rules are typically assembled by the RuleManager.
  19  * @author aron
  20  */
  21 class Rule {
  22     var $ruleTypes;
  23     var $id;
  24     var $title;
  25     var $developer;
  26     var $funding_source;
  27     var $release;
  28     var $web_ref;
  29     /**
  30      * @var ReminderIntervals
  31      */
  32     var $reminderIntervals;
  33
  34     /**
  35      * @var RuleFilters
  36      */
  37     var $filters;
  38
  39     /**
  40      * @var RuleTargetActionGroups
  41      */
  42     var $groups;
  43
  44     function __construct( $id='', $title='', $ruleTypes=array() ) {
  45         $this->id = $id;
  46         $this->title = $title;
  47         $this->ruleTypes = $ruleTypes;
  48     }
  49
  50     function getTitle() {
  51         return $this->title;
  52     }
  53
  54     function setDeveloper($s) {
  55         $this->developer = $s;
  56     }
  57
  58     function setFunding($s) {
  59         $this->funding_source = $s;
  60     }
  61
  62     function setRelease($s) {
  63         $this->release = $s;
  64     }
  65
  66     function setWeb_ref($s) {
  67         $this->web_ref = $s;
  68     }
  69
  70     /**
  71      * @param RuleType $ruleType
  72      */
  73     function addRuleType( $ruleType ) {
  74         if ( !$this->hasRuleType($ruleType) ) {
  75             array_push($this->ruleTypes, $ruleType->code );
  76         }
  77     }
  78
  79     /**
  80      *
  81      * @param RuleType $ruleType
  82      * @return boolean
  83      */
  84     function hasRuleType( $ruleType ) {
  85         foreach( $this->ruleTypes as $type) {
  86             if ( $type == $ruleType->code ) {
  87                 return true;
  88             }
  89         }
  90         return false;
  91     }
  92
  93     function isActiveAlert() {
  94         return $this->hasRuleType( RuleType::from(RuleType::ActiveAlert) );
  95     }
  96
  97     function isPassiveAlert() {
  98         return $this->hasRuleType( RuleType::from(RuleType::PassiveAlert) );
  99     }
 100
 101     function isCqm() {
 102         return $this->hasRuleType( RuleType::from(RuleType::CQM) );
 103     }
 104
 105     function isAmc() {
 106         return $this->hasRuleType( RuleType::from(RuleType::AMC) );
 107     }
 108
 109     function isReminder() {
 110         return $this->hasRuleType( RuleType::from(RuleType::PatientReminder) );
 111     }
 112
 113     /**
 114      * @param ReminderIntervals $reminderIntervals
 115      */
 116     function setReminderIntervals( $reminderIntervals ) {
 117         $this->reminderIntervals = $reminderIntervals;
 118     }
 119
 120     /**
 121      *
 122      * @param RuleFilters $ruleFilters
 123      */
 124     function setRuleFilters( $ruleFilters ) {
 125         $this->filters = $ruleFilters;
 126     }
 127
 128     function setGroups( array $groups ) {
 129         $this->groups = $groups;
 130     }
 131
 132     /**
 133      *
 134      * @param RuleTargets $ruleTargets
 135      */
 136     function setRuleTargets( $ruleTargets ) {
 137         $this->targets = $ruleTargets;
 138     }
 139
 140     /**
 141      * @param RuleActions $actions
 142      */
 143     function setRuleActions( $actions ) {
 144         $this->actions = $actions;
 145     }
 146
 147     function isEditable() {
 148         return true;
 149     }
 150
 151     function getRuleTypeLabels() {
 152         $labels = array();
 153         foreach( $this->ruleTypes as $ruleType ) {
 154             array_push( $labels, RuleType::from($ruleType)->lbl );
 155         }
 156         return $labels;
 157     }
 158
 159 }
 160 ?>