README

本包提供了一系列旨在简化PHP项目中常见任务的工具函数。它包括文件处理、字符串操作、距离计算等多种辅助函数。

安装

您可以通过Composer安装此包

composer require mbs-dev/php-helpers

使用

导入辅助函数

use App\Helpers\Helpers;

可用函数

• 1 : getFileMimeType
• 2 : extractIdFromApiUrl
• 3 : slugify
• 4 : createUploadedFile
• 5 : generateRandomString
• 6 : genererCodeAlphanumerique
• 7 : getDistanceBetweenPoints
• 8 : extractFormData
• 9 : parseMultipartFormData

函数详情

• 1 : getFileMimeType

获取文件的MIME类型。

参数

UploadedFile $picture: 上传的文件对象。返回值：string - 文件的MIME类型。

示例

use Symfony\Component\HttpFoundation\File\UploadedFile;

$helpers = new Helpers();
$mimeType = $helpers->getFileMimeType($uploadedFile);
echo $mimeType; // Outputs the mime type

• 2 : extractIdFromApiUrl

从给定的API URL中提取ID。

参数

string $url: 要提取ID的URL。返回值：?int - 提取的ID或null（如果没有找到）。

示例

$id = Helpers::extractIdFromApiUrl('https://api.example.com/resource/123');
echo $id; // Outputs: 123

• 3 : slugify

将字符串转换为URL友好的slug。

参数

string $text: 要转换为slug的文本。返回值：string - 转换后的slug文本。

示例

$slug = Helpers::slugify('Hello World!');
echo $slug; // Outputs: hello-world

• 4 : createUploadedFile

从给定的路径创建一个UploadedFile实例。

参数

string $path: 原始文件的路径。string $copiedImagePath: 复制图像将要存储的路径。

示例：返回值：UploadedFile - 创建的UploadedFile实例。

$uploadedFile = Helpers::createUploadedFile('/path/to/original.jpg', '/path/to/copied.jpg');

• 5 : generateRandomString 根据当前日期和时间生成随机字符串。

示例：返回值：string - 生成的随机字符串。

$randomString = Helpers::generateRandomString(); echo $randomString; // 输出随机字符串

• 6 : genererCodeAlphanumerique 生成指定长度的字母数字代码。

参数

int $longueur: 代码的长度。返回值：string - 生成的代码。

示例

$code = Helpers::genererCodeAlphanumerique(10);
echo $code; // Outputs a 10-character alphanumeric code

• 7 : getDistanceBetweenPoints

计算两个地理点之间的距离。

参数

float $lat1: 第一点的纬度。float $lon1: 第一点的经度。float $lat2: 第二点的纬度。float $lon2: 第二点的经度。string $unit: 距离单位 ('mile', 'foot', 'yard', 'km', 'm')。返回值：float - 在指定单位中的两点之间的距离。

示例

$distance = Helpers::getDistanceBetweenPoints(40.748817, -73.985428, 34.052235, -118.243683, 'km');
echo $distance; // Outputs the distance in kilometers

• 8 : extractFormData

从请求中提取表单数据。

参数

\Symfony\Component\HttpFoundation\Request $request: 请求对象。返回值：array - 提取的表单数据。

示例

$formData = $helpers->extractFormData($request);
print_r($formData); // Outputs the form data

• 9 : parseMultipartFormData

从请求中解析多部分表单数据。

参数

\Symfony\Component\HttpFoundation\Request $request: 请求对象。返回值：array - 解析的表单数据。

示例

$formData = Helpers::parseMultipartFormData($request);
print_r($formData); // Outputs the parsed form data

许可协议

本包是开源软件，采用MIT许可协议。

此README提供了使用辅助函数的全面指南。根据您的包的具体细节，根据需要调整“安装”部分。