function Student::get_rank_description

6.x Student.php Student::get_rank_description($rank_code = "")

Given a rank_code like FR, SO, etc., get the english description. For example: Freshman, Sophomore, etc.

1 call to Student::get_rank_description()
Student::load_student_data in classes/Student.php
This loads a student's personal data, like name and so forth.

File

classes/Student.php, line 583

Class

Student

Code

function get_rank_description($rank_code = "") {

  // Get our rank descriptions from our setting.        
  $temp = variable_get("rank_descriptions", "FR ~ Freshman\nSO ~ Sophomore\nJR ~ Junior\nSR ~ Senior\nPR ~ Professional\nGR ~ Graduate");
  $lines = explode("\n", $temp);
  foreach ($lines as $line) {
    $temp = explode("~", $line);
    $rank_array [trim($temp [0])] = trim($temp [1]);
  }

  $rank_desc = @$rank_array [$rank_code];

  // If a description isn't found, just return the code itself.
  if ($rank_desc == '') {
    $rank_desc = $rank_code;
  }

  return $rank_desc;

}