Skip to content

Commit 5a1184c

Browse files
committed
write documentation of utility methods
1 parent f3b2ad4 commit 5a1184c

File tree

2 files changed

+365
-19
lines changed

2 files changed

+365
-19
lines changed

src/PhpStringHelpers.php

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
<?php
2+
3+
/**
4+
* @Package: some useful php string helper Functions
5+
* @Author : Nima jahan bakhshian / dvlpr1996 <nimajahanbakhshian@gmail.com>
6+
* @URL : https://github.com/dvlpr1996
7+
* @License: MIT License Copyright (c) 2022 (until present) Nima jahan bakhshian
8+
*/
9+
210
declare(strict_types=1);
311

412
use PhpStringHelpers\utility\StrUtility as strHelpers;
@@ -67,7 +75,7 @@ function dotNotation(string $words): string
6775
}
6876

6977
if (!function_exists('entitiesWrapper')) {
70-
function entitiesWrapper(string | int $data): string
78+
function entitiesWrapper($data): string
7179
{
7280
return strHelpers::entitiesWrapper($data);
7381
}
@@ -81,23 +89,23 @@ function toSlug(string $string): string
8189
}
8290

8391
if (!function_exists('rmAllBlanks')) {
84-
function rmAllBlanks(string $words): string
92+
function rmAllBlanks(string $string): string
8593
{
86-
return strHelpers::rmAllBlanks($words);
94+
return strHelpers::rmAllBlanks($string);
8795
}
8896
}
8997

9098
if (!function_exists('alternate')) {
91-
function alternate(?string $string, string $alternate = null): string
99+
function alternate(?string $string, ?string $alternate = null): string
92100
{
93101
return strHelpers::alternate($string, $alternate);
94102
}
95103
}
96104

97105
if (!function_exists('translate')) {
98-
function translate(string $key, string $replace = '', string $fileName = 'en'): string
106+
function translate(string $key, string $replace = '', string $dirName = 'en'): string
99107
{
100-
return strHelpers::translate($key, $replace, $fileName);
108+
return strHelpers::translate($key, $replace, $dirName);
101109
}
102110
}
103111

@@ -329,7 +337,7 @@ function rmEndingNumbers(string $string): string
329337
}
330338

331339
if (!function_exists('convertToUtf8')) {
332-
function convertToUtf8(string $string): string
340+
function convertToUtf8(string $string): string|bool
333341
{
334342
return strHelpers::convertToUtf8($string);
335343
}

0 commit comments

Comments
 (0)