src-empire/Empire/Core/Award.php line 195

Open in your IDE?
  1. <?php
  2. namespace Empire\Core;
  3. use Empire\Legacy\db;
  4. use Empire\Legacy\cgt;
  6. class Award extends AbstractEntity implements Entity, Named, Loadable {
  8.     const AWARD_GEJS_DISPLAY_IMAGE = 0;
  9.     const AWARD_GEJS_DISPLAY_NAME = 1;
  10.     const AWARD_GEJS_DISPLAY_SHORTNAME = 2;
  12.     public $hierarchy;
  14.     public $id;
  15.     public $typeName;
  16.     public $name;
  17.     public $shortName;
  18.     public $link;
  19.     public $childID;
  20.     public $parentID;
  21.     public $description;
  22.     public $count;
  23.     public $maxCount;
  24.     public $authority;
  25.     public $memberAwardID;
  26.     public $awardedBy;
  27.     public $stamp;
  28.     public $reason;
  29.     public $ooc;
  31.     protected $AWAR_ID;
  32.     protected $AWAR_NAME;
  33.     protected $AWAR_SHORTNAME;
  34.     protected $AWAR_LINK_MULTI;
  35.     protected $AWAR_LINK;
  36.     protected $AWAR_CHILD_ID;
  37.     protected $AWAR_PARENT_ID;
  38.     protected $AWAR_DESC;
  39.     protected $AWAR_HIERARCHY;
  40.     protected $AWAR_AUTHORITY;
  41.     protected $MEMB_ID;
  42.     
  43.     function __construct(){
  44.         $this->type = cint_TYPE_AWARD;
  45.         parent::__construct();
  46.     }
  48.     function getPrimaryField(){
  49.         return 'AWAR_ID';
  50.     }
  51.     function getTable(){
  52.         return 'AWARD';
  53.     }
  55.     function initialize(){
  56.         $this->id = $this->AWAR_ID;
  57.         $this->typeName = 'Award';
  59.         if(isset($this->COUNT) && $this->COUNT > 1) {
  60.             $this->name = $this->AWAR_NAME . " x" . $this->COUNT;
  61.             $this->shortName = $this->AWAR_SHORTNAME . "x" . $this->COUNT;
  62.             $this->link = preg_replace("/\{n\}/", $this->COUNT, $this->AWAR_LINK_MULTI);
  63.         } else {
  64.             $this->name = $this->AWAR_NAME;
  65.             $this->shortName = $this->AWAR_SHORTNAME;
  66.             $this->link = $this->AWAR_LINK;
  67.             $this->childID = $this->AWAR_CHILD_ID;
  68.             $this->parentID = $this->AWAR_PARENT_ID;
  69.         }
  70.         $this->description = $this->AWAR_DESC;
  71.         $this->hierarchy = $this->AWAR_HIERARCHY;
  72.         $this->count = isset($this->COUNT) ? $this->COUNT : 1;
  73.         $this->maxCount = isset($this->AWAR_MAX_COUNT) ? $this->AWAR_MAX_COUNT : 1;
  74.         $this->authority = json_decode($this->AWAR_AUTHORITY, true);
  75.     }
  77.     /**
  78.      * @return Award[]
  79.      * @throws \Exception
  80.      */
  81.     public static function loadAll() {
  82.         $get = db::prepare("SELECT * FROM AWARD WHERE AWAR_PARENT_ID IS NULL ORDER BY AWAR_HIERARCHY ASC");
  83.         
  84.         return db::fetchArrayOfObjects($get, Award::class);
  85.     }
  86.     
  87.     public static function loadByMemberAwardID($intMEAWid) {
  88.         $get = db::prepare("SELECT * FROM MEMBER_AWARD LEFT JOIN AWARD ON MEMBER_AWARD.AWAR_ID = AWARD.AWAR_ID WHERE MEAW_ID=?", $intMEAWid);
  89.         /** @var Award $award */
  90.         $award = db::fetchObject($get, Award::class);
  91.         $award->loadMemberData($award->MEMB_ID);
  92.         return $award ;
  93.     }
  95.     /**
  96.      * @param string $name the short name of an Award
  97.      * @throws \Exception
  98.      */
  99.     public static function loadByShortName(string $name): ?Award
  100.     {
  101.         $result = db::prepare("SELECT * FROM AWARD WHERE AWAR_SHORTNAME = ? LIMIT 1", $name);
  102.         return db::fetchObject($result, get_called_class());
  103.     }
  104.     
  105.     function getName() {
  106.         return $this->name;
  107.     }
  108.     
  109.     function loadMemberData($intUserID) {
  110.         $get = db::prepare("SELECT * FROM MEMBER_AWARD WHERE AWAR_ID=? AND MEMB_ID=?", $this->id, $intUserID);
  111.         $arr = db::fetchArrayOfObjects($get);
  112.         foreach($arr as $item) {
  113.             $this->memberAwardID[] = $item->MEAW_ID;
  114.             $this->awardedBy[] = User::load([$item->MEAW_AWARDBY_ID]);
  115.             $this->stamp[] = cgt::evaluateString($item->MEAW_STAMP);
  116.             $this->reason[] = $item->MEAW_REASON;
  117.             $this->ooc[] = $item->MEAW_OOC;
  118.         }
  119.         $this->count = count($arr);
  120.         if($this->count > 1) {
  121.             $this->name = $this->AWAR_NAME . " x" . $this->count;
  122.             $this->shortName = $this->AWAR_SHORTNAME . "x" . $this->count;
  123.             $this->link = preg_replace("/\{n\}/", $this->count, $this->AWAR_LINK_MULTI);
  124.         }
  126.         return $this;
  127.     }
  129.     function getRelated() {
  130.         $get = db::prepare("SELECT * FROM AWARD WHERE AWAR_HIERARCHY=? AND AWAR_ID != ?", $this->hierarchy, $this->id);
  131.         
  132.         if(db::numRows($get) == 0) {
  133.             return null;
  134.         }
  135.         
  136.         $res = db::fetchArrayOfObjects($get);
  137.         $ids = [];
  138.         foreach($res as $row) {
  139.             $ids[] = $row->AWAR_ID;
  140.         }
  141.         
  142.         return Award::load($ids);
  143.     }
  144.     
  145.     function getParent() {
  146.         $get = db::prepare("SELECT * FROM AWARD WHERE AWAR_CHILD_ID=?", $this->id);
  147.         
  148.         if(db::numRows($get) > 0) {
  149.             $row = db::fetchObject($get);
  150.             return Award::load(array($row->AWAR_ID));
  151.         }
  152.         
  153.         return false;
  154.     }
  155.     
  156.     function isParent() {
  157.         return ($this->childID != null);
  158.     }
  159.     
  160.     function isChild() {
  161.         return ($this->parentID != null);
  162.     }
  163.     
  164.     function getChild() {
  165.         $get = db::prepare("SELECT * FROM AWARD WHERE AWAR_PARENT_ID=?", $this->id);
  166.         
  167.         if(db::numRows($get) > 0) {
  168.             $row = db::fetchObject($get);
  169.             return Award::load(array($row->AWAR_ID));
  170.         }
  171.         
  172.         return false;
  173.     }
  175.     public function displayGEjs($display = self::AWARD_GEJS_DISPLAY_IMAGE) {
  176.         $ensureList = function ($string) {
  177.           if(substr($string,0, 3) !== "<ul") {
  178.               return "<ul class='gejs award-tooltip-content-authoritylist'><li>". $string . "</li></ul>";
  179.           } else {
  180.               return $string;
  181.           }
  182.         };
  183.         $return = "";
  184.         $return .= "<div class='gejs award-tooltip' data-id='" . $this->getID() . "'>";
  185.         if($display == self::AWARD_GEJS_DISPLAY_IMAGE) {
  186.             $return .= "<img src='". Core::get('base_url') . "$this->link' alt='$this->shortName'>";
  187.         } elseif ($display == self::AWARD_GEJS_DISPLAY_NAME) {
  188.             $return .= $this->name;
  189.         } elseif ($display == self::AWARD_GEJS_DISPLAY_SHORTNAME) {
  190.             $return .= $this->shortName;
  191.         }
  192.         $return .= "<div class='gejs award-tooltip-content'><strong>$this->name</strong> [$this->shortName]";
  193.         $return .= "<img src='". Core::get('base_url') . "$this->link' alt='$this->shortName' class='gejs award-tooltip-content-image'>";
  194.         $return .= "<p style='text-align: justify'>$this->description</p>";
  195.         $return .= "<div><b>Awarding authorities:</b><br>". $ensureList($this->getAuthority()) . "</div>";
  196.         for($i = 0; is_array($this->reason) && $i < count($this->reason); $i++) {
  197.             $return .= "<p><b>". $this->awardedBy[$i]->getName() .
  198.                 " - " . $this->stamp[$i]->cgtDateString ." - <span class=\"button\" style=\"padding: 2px\">" . ($this->ooc[$i] == 1 ? "<span class='fa fa-user'></span> OOC" : "<span class='fab fa-empire'></span> IC") . "</span></b><br>". $this->reason[$i] ."</p>";
  199.         }
  200.         $return .="</div></div>";
  201.         return $return;
  202.     }
  204.     public function getAuthority() {
  205.         if(!is_array($this->authority)) return "Undefined";
  207.         $test = function($key, $value) use (&$test) {
  208.             switch($key) {
  209.                 case 'tier':
  210.                     return Position::POSITION_TIER_NAMES[$value] . ($value > 0 ? " and above" : "");
  211.                     break;
  212.                 case 'position':
  213.                     $position = Position::load([$value]);
  214.                     if(null !== $position) {
  215.                         return $position->getName();
  216.                     } else {
  217.                         return "<i>Unknown Position</i>";
  218.                     }
  219.                     break;
  220.                 case 'unit':
  221.                     return Unit::load([$value])->getName();
  222.                 case 'branch':
  223.                     return Branch::load([$value])->getName();
  224.                     break;
  225.                 case 'and':
  226.                     $string = "";
  227.                     foreach($value as $item) {
  228.                         foreach($item as $k => $v) {
  229.                             $string .= $test($k,$v).", ";
  230.                         }
  231.                     }
  232.                     return rtrim($string, ", ");
  233.                 case 'or':
  234.                     $string = "<ul class='gejs award-tooltip-content-authoritylist'>";
  235.                     foreach($value as $item) {
  236.                         foreach($item as $k => $v) {
  237.                             $string .= "<li><i class='fa fa-caret-right' style='color: #669;'></i> ".$test($k,$v)."</li>";
  238.                         }
  239.                     }
  240.                     return $string . "</ul>";
  241.             }
  242.         };
  244.         foreach($this->authority as $key => $value) {
  245.             return $test($key, $value);
  246.         }
  247.     }
  249.     public function hasAuthority(User $user) {
  250.         if(!is_array($this->authority)) return true;
  252.         $test = function($key, $value) use (&$test, $user) {
  253.             switch($key) {
  254.                 case 'tier':
  255.                     $positions = $user->getPositions();
  256.                     foreach($positions as $position) {
  257.                         if($position->tier <= $value) {
  258.                             return true;
  259.                         }
  260.                     }
  261.                     return false;
  262.                 case 'position':
  263.                     $positons = $user->getPositions();
  264.                     foreach($positons as $position) {
  265.                         if($position->id == $value) return true;
  266.                     }
  267.                     return false;
  268.                 case 'unit':
  269.                     $units = $user->getUnits();
  270.                     foreach($units as $unit) {
  271.                         if($unit->id == $value) return true;
  272.                     }
  273.                     return false;
  274.                 case 'branch':
  275.                     return $user->hasBranch(Branch::load([$value]));
  276.                 case 'and':
  277.                     foreach($value as $item) {
  278.                         foreach($item as $k => $v) {
  279.                             if(!$test($k,$v)) return false;
  280.                         }
  281.                     }
  282.                     return true;
  283.                 case 'or':
  284.                     foreach($value as $item) {
  285.                         foreach($item as $k => $v) {
  286.                             if($test($k,$v)) return true;
  287.                         }
  288.                     }
  289.                     return false;
  290.             }
  291.         };
  293.         foreach($this->authority as $key => $value) {
  294.             return $test($key, $value);
  295.         }
  296.     }
  298.     public static function processBulk(array $awards, User $giver): array
  299.     {
  300.         $errors = [];
  301.         foreach ($awards as $award) {
  302.             try {
  303.                 $split = explode(' - ', $award);
  305.                 $handle = $split[0];
  306.                 $user = User::getByName($handle);
  307.                 if (!$user) {
  308.                     $errors[] = $award . ' :: User with name ' . $handle . ' not found.';
  309.                     continue;
  310.                 }
  312.                 $shortname = $split[1];
  313.                 $reason = $split[2];
  314.                 $ooc = $split[3] === 'true';
  316.                 $awardObj = Award::loadByShortName($shortname);
  317.                 if (!$awardObj) {
  318.                     $errors[] = $award . ' :: Award with short name ' . $shortname . ' not found.';
  319.                     continue;
  320.                 }
  322.                 $success = $user->giveAward($awardObj->getID(), $giver, $reason, $ooc);
  324.                 if (!$success) {
  325.                     $errors[] = $award . ' :: Receiver has already reached the limit for this award';
  326.                 }
  327.             } catch (\Exception $e) {
  328.                 $errors[] = $award . ' :: ' . $e->getMessage();
  329.             }
  330.         }
  332.         return $errors;
  333.     }
  334. }