<?php
namespace Telnyx\Util;
use Telnyx\TelnyxObject;
abstract class Util
{
private static $isMbstringAvailable = null;
private static $isHashEqualsAvailable = null;
/**
* Whether the provided array (or other) is a list rather than a dictionary.
* A list is defined as an array for which all the keys are consecutive
* integers starting at 0. Empty arrays are considered to be lists.
*
* @param array|mixed $array
* @return boolean true if the given object is a list.
*/
public static function isList($array)
{
if (!is_array($array)) {
return false;
}
if ($array === []) {
return true;
}
if (array_keys($array) !== range(0, count($array) - 1)) {
return false;
}
return true;
}
/**
* Recursively converts the PHP Telnyx object to an array.
*
* @param array $values The PHP Telnyx object to convert.
* @return array
*/
public static function convertTelnyxObjectToArray($values)
{
$results = [];
foreach ($values as $k => $v) {
// FIXME: this is an encapsulation violation
if ($k[0] == '_') {
continue;
}
if ($v instanceof TelnyxObject) {
$results[$k] = $v->__toArray(true);
} elseif (is_array($v)) {
$results[$k] = self::convertTelnyxObjectToArray($v);
} else {
$results[$k] = $v;
}
}
return $results;
}
/**
* Converts a response from the Telnyx API to the corresponding PHP object.
*
* @param array $resp The response from the Telnyx API.
* @param array $opts
* @return TelnyxObject|array
*/
public static function convertToTelnyxObject($resp, $opts)
{
$types = [
// data structures
\Telnyx\Collection::OBJECT_NAME => 'Telnyx\\Collection',
// Telnyx API: Numbers
\Telnyx\AvailablePhoneNumber::OBJECT_NAME => 'Telnyx\\AvailablePhoneNumber',
\Telnyx\NumberOrder::OBJECT_NAME => 'Telnyx\\NumberOrder',
\Telnyx\NumberReservation::OBJECT_NAME => 'Telnyx\\NumberReservation',
\Telnyx\RegulatoryRequirement::OBJECT_NAME => 'Telnyx\\RegulatoryRequirement',
\Telnyx\NumberOrderDocument::OBJECT_NAME => 'Telnyx\\NumberOrderDocument',
// Telnyx API: Messaging
\Telnyx\Message::OBJECT_NAME => 'Telnyx\\Message',
\Telnyx\MessagingProfile::OBJECT_NAME => 'Telnyx\\MessagingProfile',
\Telnyx\MessagingPhoneNumber::OBJECT_NAME => 'Telnyx\\MessagingPhoneNumber',
\Telnyx\AlphanumericSenderID::OBJECT_NAME => 'Telnyx\\AlphanumericSenderID',
\Telnyx\ShortCode::OBJECT_NAME => 'Telnyx\\ShortCode',
// Telnyx API: Billing
\Telnyx\BillingGroup::OBJECT_NAME => 'Telnyx\\BillingGroup',
];
if (self::isList($resp)) {
$mapped = [];
foreach ($resp as $i) {
array_push($mapped, self::convertToTelnyxObject($i, $opts));
}
return $mapped;
} elseif (is_array($resp)) {
if (isset($resp['record_type']) && is_string($resp['record_type']) && isset($types[$resp['record_type']])) {
$class = $types[$resp['record_type']];
} else {
$class = 'Telnyx\\TelnyxObject';
}
return $class::constructFrom($resp, $opts);
} else {
return $resp;
}
}
/**
* @param string|mixed $value A string to UTF8-encode.
*
* @return string|mixed The UTF8-encoded string, or the object passed in if
* it wasn't a string.
*/
public static function utf8($value)
{
if (self::$isMbstringAvailable === null) {
self::$isMbstringAvailable = function_exists('mb_detect_encoding');
if (!self::$isMbstringAvailable) {
trigger_error("It looks like the mbstring extension is not enabled. " .
"UTF-8 strings will not properly be encoded. Ask your system " .
"administrator to enable the mbstring extension, or write to " .
"support@telnyx.com if you have any questions.", E_USER_WARNING);
}
}
if (is_string($value) && self::$isMbstringAvailable && mb_detect_encoding($value, "UTF-8", true) != "UTF-8") {
return utf8_encode($value);
} else {
return $value;
}
}
/**
* Compares two strings for equality. The time taken is independent of the
* number of characters that match.
*
* @param string $a one of the strings to compare.
* @param string $b the other string to compare.
* @return bool true if the strings are equal, false otherwise.
*/
public static function secureCompare($a, $b)
{
if (self::$isHashEqualsAvailable === null) {
self::$isHashEqualsAvailable = function_exists('hash_equals');
}
if (self::$isHashEqualsAvailable) {
return hash_equals($a, $b);
} else {
if (strlen($a) != strlen($b)) {
return false;
}
$result = 0;
for ($i = 0; $i < strlen($a); $i++) {
$result |= ord($a[$i]) ^ ord($b[$i]);
}
return ($result == 0);
}
}
/**
* Recursively goes through an array of parameters. If a parameter is an instance of
* ApiResource, then it is replaced by the resource's ID.
* Also clears out null values.
*
* @param mixed $h
* @return mixed
*/
public static function objectsToIds($h)
{
if ($h instanceof \Telnyx\ApiResource) {
return $h->id;
} elseif (static::isList($h)) {
$results = [];
foreach ($h as $v) {
array_push($results, static::objectsToIds($v));
}
return $results;
} elseif (is_array($h)) {
$results = [];
foreach ($h as $k => $v) {
if (is_null($v)) {
continue;
}
$results[$k] = static::objectsToIds($v);
}
return $results;
} else {
return $h;
}
}
/**
* @param array $params
*
* @return string
*/
public static function encodeParameters($params)
{
$flattenedParams = self::flattenParams($params);
$pieces = [];
foreach ($flattenedParams as $param) {
list($k, $v) = $param;
array_push($pieces, self::urlEncode($k) . '=' . self::urlEncode($v));
}
return implode('&', $pieces);
}
/**
* @param array $params
* @param string|null $parentKey
*
* @return array
*/
public static function flattenParams($params, $parentKey = null)
{
$result = [];
foreach ($params as $key => $value) {
$calculatedKey = $parentKey ? "{$parentKey}[{$key}]" : $key;
if (self::isList($value)) {
$result = array_merge($result, self::flattenParamsList($value, $calculatedKey));
} elseif (is_array($value)) {
$result = array_merge($result, self::flattenParams($value, $calculatedKey));
} else {
array_push($result, [$calculatedKey, $value]);
}
}
return $result;
}
/**
* @param array $value
* @param string $calculatedKey
*
* @return array
*/
public static function flattenParamsList($value, $calculatedKey)
{
$result = [];
foreach ($value as $i => $elem) {
if (self::isList($elem)) {
$result = array_merge($result, self::flattenParamsList($elem, $calculatedKey));
} elseif (is_array($elem)) {
$result = array_merge($result, self::flattenParams($elem, "{$calculatedKey}[{$i}]"));
} else {
array_push($result, ["{$calculatedKey}[{$i}]", $elem]);
}
}
return $result;
}
/**
* @param string $key A string to URL-encode.
*
* @return string The URL-encoded string.
*/
public static function urlEncode($key)
{
$s = urlencode($key);
// Don't use strict form encoding by changing the square bracket control
// characters back to their literals. This is fine by the server, and
// makes these parameter strings easier to read.
$s = str_replace('%5B', '[', $s);
$s = str_replace('%5D', ']', $s);
return $s;
}
public static function normalizeId($id)
{
if (is_array($id)) {
$params = $id;
$id = $params['id'];
unset($params['id']);
} else {
$params = [];
}
return [$id, $params];
}
/**
* Returns UNIX timestamp in milliseconds
*
* @return integer current time in millis
*/
public static function currentTimeMillis()
{
return (int) round(microtime(true) * 1000);
}
}