README

这是一个用于PHP的有用函数集合。名字是一个双关语（在西班牙语中“Mapache”是“浣熊”的意思）

• Mapache Commons
  • 目标
  • 家族
  • 集合库
    • 方法 isAssoc()
      • 参数
    • 方法 first()
      • 参数
    • 方法 firstKey()
      • 参数
    • 方法 arrayKeyLower()
      • 参数
    • 方法 arrayKeyUpper()
      • 参数
    • 方法 generateTable()
      • 参数
    • 方法 splitOpeningClosing()
      • 参数
    • 方法 splitNotString()
      • 参数
    • 方法 arrayChangeKeyCaseRecursive()
      • 参数
    • 方法 arraySearchField()
      • 参数
    • 方法 xmlToString()
      • 参数
    • 方法 arrayToXML()
      • 参数
    • 方法 stringToXML()
      • 参数
    • 方法 xmlToArray()
      • 参数
  • 调试库
    • 方法 var_dump()
      • 参数
    • 方法 WriteLog()
      • 参数
  • 文本库
    • 方法 isUpper()
      • 参数
    • 方法 isLower()
      • 参数
    • 方法 between()
      • 参数
    • 方法 stripQuotes()
      • 参数
    • 方法 removeParenthesis()
      • 参数
    • 方法 replaceBetween()
      • 参数
    • 方法 removeFirstChars()
      • 参数
    • 方法 removeLastChars()
      • 参数
    • 方法 getArgument()
      • 参数
    • 方法 strPosNotSpace()
      • 参数
    • 方法 strposArray()
      • 参数
    • 方法 parseArg()
      • 参数
    • 方法 parseArg2()
      • 参数
    • 方法 naturalArg()
      • 参数
    • 方法 str_replace_ex()
      • 参数
    • 方法 wildCardComparison()
      • 参数
    • 方法 endsWith()
      • 参数
    • 方法 replaceCurlyVariable()
      • 参数
    • 方法 addParenthesis()
      • 参数
    • 方法 hasParenthesis()
      • 参数
    • 方法 camelCase()
      • 参数
  • 文件库
    • 字段 lastError ()
    • 方法 getDirFiles()
      • 参数
    • 方法 getDirFirstFile()
      • 参数
    • 方法 getDirFolders()
      • 参数
    • 方法 getExtensionPath()
      • 参数
    • 方法 getFileNamePath()
      • 参数
    • 方法 getBaseNamePath()
      • 参数
    • 方法 getDirPath()
      • 参数
    • 方法 fixUrlSeparator()
      • 参数
    • 方法 safeFileGetContent()
      • 参数
    • 方法 safeFilePutContent()
      • 参数
    • 方法 isAbsolutePath()
      • 参数
  • 版本列表
  • 许可证

Mapache Commons

目标

这是一组满足以下要求的有用函数

• 函数不得有依赖（除非它需要php模块）。
• 函数必须比语法糖更快且内存友好。
• 函数必须能够静态运行，并且必须是自包含的。
• 函数必须是通用的，并且必须解决通用问题。例如，不允许计算特定国家增值税的函数。

家族

• 集合库
• 文本库
• 调试库

集合库

类 CollectionLib

方法 isAssoc()

如果数组是关联数组则返回true，如果是索引数组则返回false
示例

$isAssoc=CollectionLib::isAssoc($array); // slow, more precise.
$isAssoc=CollectionLib::isAssoc($array,true); // fast, less precise

参数

• $array 输入数组（数组）

方法 first()

返回数组的第一个元素。
有时第一个元素不是索引[0]，例如 ['key1'=>1,0=2] 其中第一个元素是 'key1' 而不是 0。此函数始终返回正确的值。

参数

• $array 输入数组（数组）

方法 firstKey()

返回数组的第一个键。

参数

• $array 输入数组（数组）

方法 arrayKeyLower()

将键的字母大小写更改为小写

参数

• $array 输入数组（数组）

方法 arrayKeyUpper()

将键的字母大小写更改为小写

参数

• $array 输入数组（数组）

方法 generateTable()

从数组生成HTML表格

参数

• $array 输入数组（数组|null）
• $css 如果为true则使用内置样式。如果为false则不使用样式。如果为字符串则使用类（字符串|bool）

方法 splitOpeningClosing()

使用开标签和闭标签分割字符串，默认为 "(" 和 ")"。
示例

CollectionLib::splitOpeningClosing("a(B,C,D)e(F,G,H)"); // ['a','B,C,D','e','F,G,H']
CollectionLib::splitOpeningClosing("a(B,C,D)e(F,G,H)i"); // ['a','B,C,D','e','F,G,H','i']

参数

• $text 输入要分割的文本（字符串）
• $openingTag 开标签，默认为 "("（字符串）
• $closingTag 闭标签，默认为 ")"（字符串）
• $startPosition 起始位置（默认为零）（int）
• $excludeEmpty 如果为true则排除所有空值。 （bool）
• $includeTag 如果为true则包括标签。 （bool）

方法 splitNotString()

通过忽略字符串中值为 " 或 ' 的部分来分割字符串。
示例

CollectionLib::splitNotString('a,b,"CC,D,E",e,f' ,","); // ['a','b','CC,D,E','e','f']

参数

• $text 输入文本（字符串）
• $separator 参数字符串 $separator（字符串）
• $offset 参数 int $offset（int）
• $excludeEmpty 参数 bool $excludeEmpty (bool)

方法 arrayChangeKeyCaseRecursive()

它递归地更改数组键的大小写（转换为小写或大写）
示例

$arr=['A'=>'a','b'=>'b'];
CollectionLib::arrayChangeKeyCaseRecursive($arr);
// returns ['a'=>'a','b'=>'b']
CollectionLib::arrayChangeKeyCaseRecursive($arr,true);
// returns ['A'=>'a','B'=>'b']

参数

• $array 输入数组（数组）
• $case [可选] 默认为 CASE_LOWER

  可以是 CASE_UPPER 或 CASE_LOWER（默认）

  (int)

方法 arraySearchField()

返回数组/对象中与字段值匹配的第一个（或所有）键的数组
示例

$array=[['name'=>'john'],['name'=>'mary']];
CollectionLib::arraySearchField($array,'name','mary'); // 1
CollectionLib::arraySearchField([(object)['name'=>'john'],(object)['name'=>'mary']],'name','mary'); // 1
CollectionLib::arraySearchField([['name'=>'john'],['name'=>'mary'],['name'=>'mary']],'name','mary',true); // returns [1,2]

参数

• $array 输入数组（数组）
• $fieldName 字段索引的名称（string|int）
• $value 要搜索的值（mixed）
• $returnAll 如果为 true，则返回所有匹配项。如果为 false，则返回第一个值。（bool）

方法 xmlToString()

将 xml（SimpleXMLElement 对象）转换为字符串
示例

$string=CollectionLib::xmlToString($xml,true); // "<root>...</root>"

参数

• $xml 参数 SimpleXMLElement $xml（SimpleXMLElement）
• $format 如果为 true，则结果被格式化。（bool）

方法 arrayToXML()

将数组转换为 xml（SimpleXMLElement 对象）示例：

$xml=CollectionLib::arrayToXML($array,'root'); // <root>...</root>

参数

• $data 参数 array $data（array）
• $rootName 根标签的名称（默认为 root）（string）
• $insidetag 用于使用 PHP 生成的 xml 设置特定条件。（string）

方法 stringToXML()

使用 simplexml_load_string 包括修正将字符串转换为 xml（SimpleXMLElement 对象）
示例

$xml=CollectionLib::stringToXML('<root><item arg="1">a</item><item arg="2">b</item></root>');

参数

• $string 要转换的值（string）
• $className 参数 null $className（null）
• $options libxml 选项（int）
• $insidetag 默认为 'value_inside'。在某些情况下，解析器在子元素为空时无法生成 XML 属性。2. 解决方案是生成一个新的标签 <_value>2</_value>（string）

方法 xmlToArray()

将 XML 类（SimpleXMLElement 对象）转换为数组。 示例：

$array=CollectionLib::xmlToArray($xml);

参数

• $xml 参数 SimpleXMLElement $xml（SimpleXMLElement）

调试库

类 Debug

方法 var_dump()

var_dump 的替代方案。它 "pre" 结果或它在 JavaScript 的控制台中显示结果。
示例

DebugLib::var_dump($value,true); // returns a var_dump visible via the console of javascript (browser)

参数

• $value 参数 $value（）
• $type : 0=normal （

  ), 1=javascript console, 2=table (use future) (int)

• $returnValue 参数 bool $returnValue（bool）

方法 WriteLog()

写入日志文件。如果文件超过 10mb，则文件被重置。

DebugLib::WriteLog('somefile.txt','warning','it is a warning');
DebugLib::WriteLog('somefile.txt','it is a warning');

参数

• $logFile 要写入的文件（string）
• $level 消息级别，例如 "error"，"info"，1 等。（mixed）
• $txt 如果 txt 为空，则将级别定义为警告，并使用级别进行描述（string|object|array）

文本库

类 TextLib

方法 isUpper()

如果 str 是（完全）大写，则返回 true

参数

• $str 输入文本（string）

方法 isLower()

如果 str 是（完全）小写，则返回 true

参数

• $str 参数 $str（）

方法 between()

获取一个字符串中的一个文本和另一个文本之间的字符串。 示例：

TextLib::between('Hello Brave World','Hello','World');  // returns " Brave "
TextLib::between('mary has a lamb','has','lamb') // returns ' a '

参数

• $haystack 参数 string $haystack（string）
• $startNeedle 要搜索的初始文本
  如果为空，则从 haystack 的开始处开始。（string）
• $endNeedle 要搜索的结束标签
  如果为空，则从 haystack 的末尾结束（string）
• $offset 参数 null|int $offset（null|int）
• $ignoreCase 参数 bool $ignoreCase（bool）

方法 stripQuotes()

删除文本中的引号 " 或 '，如果值在引号之间
如果值未加引号，则不修改。
如果值未正确关闭（"hello 或 "hello'），则不删除引号。
值被修剪 ' "hello world"' --> 'hello world'
示例

TextLib::stripQuotes('"hello world"');
// returns hello world

参数

• $text 参数 $text（）

方法 removeParenthesis()

删除初始和结束括号，但只有当两者都匹配时。
如果 $start 和 $end 是数组，则两者必须具有相同的计数，并且数组通过索引配对进行比较
示例

TextLib::removeParenthesis('hello'); // return "hello";
TextLib::removeParenthesis('(hello)'); // return "hello";
TextLib::removeParenthesis('[hello]'
,['(','{','[']
,[')','}',']']); // returns "hello"
TextLib::removeParenthesis("'hello'"
,"'"
,"'"); // returns "hello"

参数

• $txt 输入值。例如 "hello"，"(hello)"（string）
• $start 开放括号，默认为 '('. （string|array）
• $end 关闭括号，默认为 ')'. （string|array）

方法 replaceBetween()

替换两个针之间的文本
示例

TextLib::replaceBetween('Hello Brave World','Hello','World',' Wayne ') // returns "Hello Wayne World"

参数

• $haystack 输入值（string）
• $startNeedle 要搜索的初始文本
  如果为空，则从 haystack 的开始处开始。（string）
• $endNeedle 要搜索的结束标签
  如果为空，则从 haystack 的末尾结束（string）
• $replaceText 要替换的文本（string）
• $offset 开始搜索的偏移位置（null|int）
• $replaceTag 如果为 true，则还替换标签（bool）

方法 removeFirstChars()

从字符串中移除第一个字符（或多个字符）
示例

TextLib::removeFirstChars('Hello') // returns "ello"

参数

• $str 输入文本（字符串）
• $length 要移除的字符数量（默认为1）（整型）

方法 removeLastChars()

从字符串中移除最后一个字符（或多个字符）
示例

TextLib::removeLastChars('Hello') // returns "Hell"

参数

• $str 输入文本（字符串）
• $length 要移除的字符数量（默认为1）（整型）

方法 getArgument()

它将参数与值分开到设置的值中。
返回一个包含参数名称和值（如有）的数组。它总是返回一个二维数组 示例：

self::getArgument("arg=200"); // returns ["arg","200"]
self::getArgument("arg:200",':'); // returns ["arg","200"]

参数

• $str 输入文本（字符串）
• $set 操作符的分隔符（字符串）
• $trimValue 参数 bool $trimValue（布尔型）

方法 strPosNotSpace()

它返回字符串中的第一个非空格位置。 示例：

TextLib::strPosNotSpace('   abc  def'); // returns 3

参数

• $str 输入字符串（字符串）
• $offset 偏移位置（整型）
• $charlist 被视为空格的字符列表（字符串）

方法 strposArray()

它查找文本的第一个（或最后一个）出现。
与 strpos() 不同，此方法允许找到多个针。
示例

TextLib::strposArray('a,b.d.e,f.g',['x','t','.']); // return 3
TextLib::strposArray('a,b.d.e,f.g',['x','t',','],0,true); // return 7

参数

• $haystack 输入值（string）
• $needles 要查找的值（或值）（字符串或数组）
• $offset 偏移位置（初始为0）（整型）
• $last 如果为 false（默认）则返回第一个出现。如果为 true 返回最后一个（布尔型）

方法 parseArg()

将文本 = 'a1=1,a2=2' 转换为关联数组
使用 parse_str() 方法进行转换
注意： 它不适用于引号或双引号。a1="aa,bb",bb=30 不起作用 示例：

TextLib::parseArg('a=1,b=1'); // returns ['a'=>'1','b'=>'1']

参数

• $text 包含初始值的输入字符串（字符串）
• $separator 分隔符（字符串）

方法 parseArg2()

与 parseArg() 相同，但速度慢3倍。
它还考虑引号和双引号。
示例

TextLib::parseArg2("a1=1,a2=2,a3="aa,bb"); // ["a1"=>1,"a2"=>2,"a3"=>""aa,bb""]
TextLib::parseArg("a1=1,a2=2,a3="aa,bb"); // ["a1"=>1,"a2"=>2,"a3"=>""aa","bb""=>""]

参数

• $text 包含初始值的输入字符串（字符串）
• $separator 分隔符。它不分隔引号或双引号内的文本。（字符串）

方法 naturalArg()

解析自然字符串并返回声明数组
“自然字符串”，它是一组由空格分隔的值或参数，其中值是索引，新值是索引的值。

TextLib::naturalArg('select * from table where 1=1'
,['select'=>'req','from'=>'req','where'=>'opt']);
// returns ['select'=>'*','from'=>'table','where'=>'1=1']
TextLib::naturalArg('item export table inport file'
,['item'=>'first','export'=>'opt','inport'=>'opt']);
// returns: ['item' => 'item', 'export' => 'table', 'inport' => 'file']

参数

• $txt 输入值。例如 "somevalue TYPE int LENGHT 30"（字符串）
• $separators 每个字段的指示器。
  first = 表示第一个元素（可选）
  opt = 表示字段是可选的
  req = 表示字段是必需的
  （数组）

方法 str_replace_ex()

它类似于 str_replace，但它还允许限制替换次数。

参数

• $search 参数字符串 $search（字符串）
• $replace 参数字符串 $replace（字符串）
• $subject 参数字符串 $subject（字符串）
• $limit 参数整型 $limit（整型）

方法 wildCardComparison()

与通配符 (*) 进行比较，如果两个字符串相等则返回 true
通配符仅在字符串的开始或结尾处起作用。
示例:

TextLib::wildCardComparison('abcdef','abc*'); // true
TextLib::wildCardComparison('abcdef','*def'); // true
TextLib::wildCardComparison('abcdef','*abc*'); // true
TextLib::wildCardComparison('abcdef','*cde*'); // true
TextLib::wildCardComparison('abcdef','*cde'); // false

TextLib::endsWidth('hello world','world'); // true

TextLib::addParenthesis('hello'); // return '(hello)';
TextLib::addParenthesis('(hello)');// return '(hello)';

TextLib::hasParenthesis('hello'); // return false;
TextLib::hasParenthesis('(hello)'); // return true;

TextLib::camelCase('HelloWorld'); // return "helloWorld";
TextLib::camelCase('hello_world'); // return "helloWorld";