aGroupSupport.i

<?php
require_once("$admLibrary/userSearch.i");

/**
 *  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 GroupReply($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));
}

/**
 *  GroupContext:
 *  @uses validate the context for group hub cards, this will generate an array
 *  including the Cu code in ways for use as table identifiers and as co code variable.
 *  this function will also add neccessary group data to the array for common use on
 *  the server.
 *
 *  @param #pEnv array: environment variable for debugging
 *  @param $pCu string: credit union code to be used as variable or table in sql
 *  @param $pGroup array: group data needed by grouphub cards
 *
 *  @return $vContext array: common data used by group hub cards
 */

function GroupContext($pEnv, $pCu, $pGroup = null) {
  $vCu = prep_save($pCu, 20);

  $vContext = array(
    "cu_table" => strtolower($pCu),
    "cu_code" => strtoupper($pCu),
    "g_id" => $pGroup ? ( isset($pGroup['g_id']) ? intval($pGroup['g_id']) : null ) : null,
    "p_id" => $pGroup ? ( isset($pGroup['p_id']) ? intval($pGroup['p_id']) : null ) : null
  );

  return $vContext;
}

/**
 *  GroupSelect:
 *  @uses select a group by specific parameters, for now select by group_name.
 *  this function will select all display information for the group hub.
 *  also the contact information has been removed due to no forseeable use.
 *
 *  @param $pEnv array: evironment object for debugging
 *  @param $pDbh object: database access variable
 *  @param $pContext array: array of data needed for multiple group hub functions:
 *  in this case the group_name.
 *  @param $fromGroupHub -- it assumes that it is from the group hub which also needs the payload per primary user.  For other uses, that is a wasted calculation.
 *
 *  @return $sqlReturn array: single data row, the selected member
 */
function GroupSelect($pEnv, $pDbh, $pContext) {
  $cuTable = $pContext['cu_table'];
  $cuCode = $pContext['cu_code'];
  $gId = prep_save(intval($pContext["g_id"]));

  $sqlReturn = array();
  $sqlColumns = "
    g.group_id AS g_id,
    g.group_name AS g_name,
    g.tax_id AS g_taxid,
    p.profile_id AS p_id,
    p.description AS g_profile";

  // select primary user_name
  $sqlSub = "
    SELECT user_name
    FROM {$cuTable}user
    WHERE group_id = g.group_id
      AND is_group_primary = 'TRUE'";

  // select number of users in this group
  $sqlCount = "
    SELECT COUNT(user_id)
    FROM {$cuTable}user
    WHERE group_id = g.group_id";

  // select group information
  $sqlSelect = "
    SELECT $sqlColumns, (SELECT array($sqlSub)) AS g_primary, ($sqlCount) AS g_count
    FROM {$cuTable}group g
    LEFT JOIN {$cuTable}user u ON u.group_id = g.group_id
    LEFT JOIN cu_profile p ON p.profile_id = g.profile_id
    WHERE g.group_id = '$gId'";

  $sqlSelectRs = db_query($sqlSelect, $pDbh);
  if (!$sqlSelectRs) {
    if (isset($pEnv))
      $pEnv['logger']->error(db_last_error());
    throw new Exception("Failed to select group.");
  }

  // get payload for primary users
  // strip brackets
  // split into array
  $sqlGroup = db_fetch_all($sqlSelectRs)[0];
  $sqlPrimaryString = $sqlGroup['g_primary'];
  $sqlPrimaryString = str_replace(array("{", "}"), "", $sqlPrimaryString);
  $sqlPrimary = explode(",", $sqlPrimaryString);

  // get user hub payload for each primary user
  // calling script must include userSearch.i
  // for call to readUserSearch function
  $aryPrimary = array();
  if ($sqlPrimaryString != "") {
    foreach ($sqlPrimary as $key => $value) {
        $aryPayload = readUserSearch($pDbh, $cuCode, array(
          "a" => array ("username"=>$value)
        ));
      $aryPrimary[$key] = array(
        "p_name" => $value,
        "p_payload" => urlencode($aryPayload['encryption'])
      );
    }
  }

  // replace sql array with payload array
  $sqlGroup['g_primary'] = $aryPrimary;
  $sqlReturn['group'] = $sqlGroup;
  return $sqlReturn;
}

/**
 *  GroupValidate:
 *  @uses validate the json string of parameters submitted by the user for search purposes.
 *  this function will prepare the data for submission to the database (if needed).
 *  also the functioncan be used to get the correct group name value for group selection
 *  purposes.
 *
 *  @param $pEnv array: evironment object for debugging
 *  @param $pParameters string: json string of field/value pairs from user submitted
 *  form.
 *  @param $pJson boolean: tell the function if the incoming data needs to be decoded
 *  into array form.
 *
 *  @return $vParameters array: array of data valid for use in the database
 */
function GroupValidate($pEnv, $pParameters, $pJson = false) {
  $gParameters = $pParameters;
  $gValidate = array();

  // if parameters are in json string form
  // decode into array
  if ($pJson) {
    $gParameters = html_entity_decode($pParameters, ENT_QUOTES);
    $gParameters = HCU_JsonDecode($gParameters);
  }

  // validate group name parameter if available
  if (isset($gParameters['g_name'])) {
    $gName = $gParameters['g_name'];
    $gName = strtolower($gName);
    $gName = prep_save($gName, 50);
    $gName = trim($gName);

    $gValidate['g_name'] = $gName;
  }

  return $gValidate;
}

/**
 *  GroupEncrypt:
 *  @uses encode group data from anywhere given at least the group_id and profile_id. This function
 *  will also encode the string for url purposes.
 *
 *  @param $pEnv array: evironment object for debugging
 *  @param $pCu string: cu code used for accessing variables and database tables
 *  @param $pMember array: group data to encrypt
 *  @param $pJson boolean: allows user to pass array or json string to be encoded (optional)
 *
 *  @return $sMemberEncrypt string: encoded data string
 */
function GroupEncrypt($pEnv, $pCu, $pGroup, $pJson = false) {
  $sGroupEncode = $pGroup;

  if ($pJson) {
    $sGroupEncode = html_entity_decode($sGroupEncode, ENT_QUOTES);
    $sGroupEncode = HCU_JsonDecode($sGroupEncode);
  }

  $sGroupEncrypt = HCU_PayloadEncode($pCu, $sGroupEncode);
  return $sGroupEncrypt;
}

/**
 *  GroupDecrypt:
 *  @uses decrypt group data from anywhere given the encrypted string, this function will
 *  decode any url characters if neccessary.
 *
 *  @param $pEnv array: evironment object for debugging
 *  @param $pCu string: cu code used for accessing variables and database tables
 *  @param $pEncode string: encrypted data string
 *  @param $pJson boolean: allows user to return an array or json string (optional)
 *
 *  @return $sMemberDecode string | array: decrypted member data as string or array
 */
function GroupDecrypt($pEnv, $pCu, $pEncrypt, $rJson = false) {
  $sGroupDecrypt = HCU_PayloadDecode($pCu, $pEncrypt, $rJson);
  return $sGroupDecrypt;
}

?>