aBankingCalendar.i

<?php
/**
 *  Reply:
 *  @uses return data to client view print to json
 *  @param assoc $pResult: array contining results of search
 *  @param assoc $pReply: empty array to return to client
 *  @param assoc $pOperation: requested search operation
 */
function BankingCalendarReplay($pResult, $pReply, $pOperation) {
  $pReply['operation'] = $pOperation;
  if (isset($pResult['data']) && count($pResult['data'])) $pReply['data'] = $pResult['data'];
  if (isset($pResult['info']) && count($pResult['info'])) $pReply['info'] = $pResult['info'];

  print json_encode(array("Results" => $pReply));
}

/**
 * @uses return calendar data for specified year each calendar
 * year has 5 fields named after each day of the week.
 *
 * these fileds are null or array,
 *   array -> if empty , user has selected to make all
 *     of this specific weekday CLOSED for business.
 *   array -> has data , user has selected to make all
 *     of this specific weekday CLOSED for business
 *     EXCEPT the dates in this array.
 *   null -> no dates have been selected as CLOSED
 *     or EXCEPTIONS to CLOSED.
 *
 * there is a single field for UNIQUE date selections
 * which are not related to being EXCEPTIONS for a
 * particular weekday.
 *
 * these UNIQUE dates are just single hand-picked dates
 * to be CLOSE for business.
 *
 * @param #pEnv array: environment variable for debugging
 * @param $pDbh object: database access variable
 * @param $pCu string: credit union code to be used as variable or table in sql
 * @param $pYear string: calendar year to search
 *
 * @param list of CLOSED for business dates for the specified year
 */
function BankingCalendarRead($pEnv, $pDbh, $pCu, $pYear) {
  $sqlReturn = array();
  $sql = "
    SELECT dates FROM cu_calendar
    WHERE cu = '$pCu'
      AND year = '$pYear'";
  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to read calendar for " . $pYear);
  }
  $sqlReturn['calendar'] = db_fetch_assoc($sqlRs);
  return $sqlReturn;
}

/**
 * @uses create calendar data for displaying CLOSED
 * for business dates.
 *
 * @param #pEnv array: environment variable for debugging
 * @param $pDbh object: database access variable
 * @param $pCu string: credit union code to be used as variable or table in sql
 * @param $pYear string: calendar year to create
 * @param $pDates json: list of CLOSED for business dates
 * refer to (BankingCalendarRead description)
 *
 * @return newly created CLOSE for business dates for the specified year
 */
function BankingCalendarCreate($pEnv, $pDbh, $pCu, $pYear, $pDates) {
  $sqlReturn = array();
  $sql = "
    INSERT INTO cu_calendar
    (cu, year, dates) VALUES ('$pCu', '$pYear', '$pDates')";
  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to create calendar for " . $pYear);
  }

  $sqlReturn['calendar'] = db_fetch_assoc($sqlRs);
  $sqlReturn['message'] = "Calendar created successfully for ". $pYear;
  return $sqlReturn;
}

/**
 * @uses update calendar data for displaying CLOSED
 * for business dates.
 *
 * @param #pEnv array: environment variable for debugging
 * @param $pDbh object: database access variable
 * @param $pCu string: credit union code to be used as variable or table in sql
 * @param $pYear string: calendar year to create
 * @param $pDates json: list of CLOSED for business dates
 * refer to (BankingCalendarRead description)
 *
 * @return updated CLOSE for business dates for the specified year
 */
function BankingCalendarUpdate($pEnv, $pDbh, $pCu, $pYear, $pDates) {
  $sqlReturn = array();
  $sql = "
    UPDATE cu_calendar
    SET dates = '$pDates'
    WHERE cu = '$pCu'
      AND year = '$pYear'";
  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to update calendar for " . $pYear);
  }

  $sqlReturn['calendar'] = db_fetch_assoc($sqlRs);
  $sqlReturn['message'] = "Calendar updated successfully for ". $pYear;
  return $sqlReturn;
}

/**
 * @uses validate the required parameters for creating and updating
 * CLOSED for business dates for a specified calendar year.
 *
 * @param $pEnv array: evironment object for debugging
 * @param $pCalendar array/json:
 * holds calendar year and list of CLOSED for business dates
 *
 * @return $vParameters array: array of data valid for use in the database
 */
function BankingCalendarValidate($pEnv, $pCalendar, $pJson = false) {
  $cValidate = array();
  $cCalendar = array();

  if ($pCalendar === null) {
    throw new Exception("Calendar data not found");
  }

  // dcode json, if needed
  if ($pJson) {
    $cCalendar = trim($pCalendar);
    $cCalendar = html_entity_decode($cCalendar);
    $cCalendar = HCU_JsonDecode($cCalendar);
  } else {
    $cCalendar = $pCalendar;
  }

  if (!is_array($cCalendar)) {
    throw new Exception("Calendar data is invalid");
  }

  // validate calendar year is 4 characters
  if (isset($cCalendar['year'])) {
    $cYear = trim($cCalendar['year']);

    if (strlen($cYear) !== 4) {
      throw new Exception("Calendar year is invalid");
    }

    $cValidate['validate']['year'] = $cYear;
  } else {
    throw new Exception("Calendar year is missing");
  }

  // validate dates list
  if (isset($cCalendar['dates'])) {
    $cDates = $cCalendar['dates'];


    // must be an array
    if (!is_array($cDates)) {
      throw new Exception("Calendar date list is invalid");
    }

    // set as json string for database
    $cDates = HCU_JsonEncode($cDates);
    $cDates = trim($cDates);

    // safety check
    if ($cDates === "") {
      throw new Exception("Calendar dates list is missing");
    }

    $cValidate['validate']['dates'] = $cDates;
  } else {
    throw new Exception("Calendar dates list is missing");
  }

  return $cValidate;
}
?>