README

目录

方法	描述
CacheLock	使用缓存池来管理您的锁
CacheLock::__construct
CacheLock::forceRelease	{@inheritdoc}
CharMap	一个多字节/字节字符串转换映射
CharMap::create	创建一个新的 CharMap
CharMap::getCharOffset	从字节偏移量获取字符偏移量，失败时返回 -1
CharMap::getByteOffset	从字符偏移量获取字节偏移量，失败时返回 -1
CharMap::__construct	创建一个新的 CharMap
CharMap::convertByteOffset	从字节偏移量获取字符偏移量
CharMap::convertCharacterOffset	从字符偏移量获取字节偏移量
CharMap::getLength	获取字符数
CharMap::getSize	获取字节数
CharMap::count
CharMap::isEmpty
CharMap::toString
CharMap::__toString
CharMap::__unserialize
CharMap::__serialize
CircularDependencyException
Container
Container::__construct
Container::alias	将条目别名到不同的名称
Container::has	{@inheritdoc}
Container::get	{@inheritdoc}
Container::make	通过名称解析条目。如果给定一个类名，它将返回该类的全新实例。
Container::call	使用给定的参数调用给定的函数。
Container::register	注册一个服务
Container::set	向容器添加定义
Container::setMany	添加多个定义
Container::addContainerResolver	添加一个处理程序来管理条目解析（在参数解析后）
Container::__debugInfo
Container
Container::alias	将条目别名到不同的名称
Container::has	如果容器可以返回给定标识符的条目，则返回 true。
Container::get	通过标识符查找容器中的条目并返回它。
Container::make	通过名称解析条目。如果给定一个类名，它将返回该类的全新实例。
Container::call	使用给定的参数调用给定的函数。
Container::register	注册一个服务
Container::set	向容器添加定义
Container::setMany	添加多个定义
Container::addContainerResolver	添加一个处理程序来管理条目解析（在参数解析后）
ContainerError
Directory	管理目录
Directory::scanFiles	扫描目录中的文件
Directory::scanFilesArray
Directory::cwd
Directory::pushd	更改当前活动目录并存储最后一个位置
Directory::popd	恢复最后一个活动目录位置并返回它
Directory::__construct
Directory::copy	将目录复制到另一个位置
Directory::delete	递归删除目录。
Directory::exists	检查目录是否存在
Directory::isEmpty	检查是否没有文件
Directory::mkdir	创建目录
Directory::rmdir	删除目录
Directory::chdir	更改目录
Directory::isCurrentWorkingDir	检查是否是当前活动目录
Directory::search	使用正则表达式、glob或检查文件名是否包含 $query 递归地搜索文件
Directory::glob	在目录内执行 glob 搜索
Directory::files	列出目录中的文件
Directory::allFiles	递归列出文件
Directory::directories	列出目录
Directory::getFile	访问该目录中的文件
Directory::getIterator
EnumUtils
EnumUtils::generateEnumClassPhpDoc	生成魔法静态方法的 Doc 注释
EnumUtils::addPhpDocToEnumClass	自动为枚举生成静态方法 doc 块
FacadeUtils
FacadeUtils::getClassDocBlocks
FacadeUtils::createDocBlock
FacadeUtils::createMethodsForInstance
FacadeUtils::createMethods
FacadeUtils::createFacadeCode
File	管理文件
File::__construct
File::__destruct
File::getDirectory	获取文件目录
File::exists	检查文件是否存在且为常规文件
File::isModified	检查CRC校验和是否已更改
File::unlink	删除文件
File::copy	复制文件
File::delete	删除文件
File::require	将文件包含为PHP文件
File::name	获取不带扩展名的文件名
File::extension	获取最后的文件扩展名
File::hash	获取CRC32校验和
File::touch	设置文件的访问和修改时间
File::getContents	将文件作为迭代器加载
File::createContents	创建文件内容
File::read	加载文件
File::readAsArray	将文件作为行数组读取
File::readJson	解码JSON文件
File::write	保存文件
File::writeJson	将数据转储为JSON
File::getIterator
File::lock	锁定文件访问以处理并发请求
File::__debugInfo
FileContents
FileContents::__construct
FileContents::refresh	重新组织行
FileContents::reload	重新加载文件内容
FileContents::clear	清除内容
FileContents::map	使用可调用来运行所有行并替换内容为返回值
FileContents::filter	为所有行运行可调用，并删除未通过测试的行
FileContents::save	保存文件内容
FileContents::readLine	读取一行
FileContents::write	替换整个内容
FileContents::writeLine	替换或添加一行
FileContents::insertLine	插入一行，如果没有定义偏移量，则添加到文件开头，如果超出范围，则添加到文件末尾
FileContents::removeLine	删除一行，并重新组织行
FileContents::offsetExists	{@inheritdoc}
FileContents::offsetGet	{@inheritdoc}
FileContents::offsetSet	{@inheritdoc}
FileContents::offsetUnset	{@inheritdoc}
FileContents::isEmpty
FileContents::count	{@inheritdoc}
FileContents::getIterator
FileContents::jsonSerialize	{@inheritdoc}
FileContents::__toString	{@inheritdoc}
FileContents::__serialize	{@inheritdoc}
FileContents::__unserialize	{@inheritdoc}
FileContents::__debugInfo
FileFactory
FileFactory::getFile	获取一个File实例
FileFactory::getDirectory	获取一个Directory实例
FileFactory::getFileContents	获取文件内容
FileList	文件列表迭代器
FileList::create
FileList::append	将文件添加到列表中
FileList::files	仅返回文件
FileList::directories	仅返回目录
FileList::filter	使用可调用过滤结果
FileList::toArray	返回文件真实路径
FileList::isEmpty
FileList::count
FileList::getIterator
FileList::keys
FileList::values
FileList::__serialize
FileList::__unserialize
FileList::__debugInfo
FileLock	使用PHP文件创建锁
FileLock::__construct
FileLock::forceRelease	{@inheritdoc}
FileSystem
FileSystem::getFile	获取一个File实例
FileSystem::getDirectory	获取一个Directory实例
FileSystem::getFileContents	获取文件内容
FileSystemLock	创建与提供的文件具有相同文件名和目录的锁文件
FileSystemLock::__construct
FileSystemLock::forceRelease
FixedArray	具有固定容量的数组，使用LRU模型（最近最少使用首先被移除）。SplFixedArray仅适用于int偏移量（不支持null或字符串）
FixedArray::create	创建一个新的Fixed Array
FixedArray::__construct
FixedArray::clear
FixedArray::getSize	获取数组的大小。
FixedArray::setSize	将数组的大小更改为新大小size。如果size小于当前数组大小，则任何超出新大小后的值将被丢弃。
FixedArray::count	{@inheritdoc}
FixedArray::entries	按排序顺序迭代条目
FixedArray::keys	返回一个新可迭代对象，其中仅包含索引
FixedArray::values	返回一个只包含值的新的可迭代对象
FixedArray::jsonSerialize	{@inheritdoc}
FixedArray::offsetExists	{@inheritdoc}
FixedArray::offsetGet	{@inheritdoc}
FixedArray::offsetSet	{@inheritdoc}
FixedArray::offsetUnset	{@inheritdoc}
FixedArray::__debugInfo	{@inheritdoc}
FixedArray::__serialize	{@inheritdoc}
FixedArray::__unserialize	{@inheritdoc}
FixedArray::__clone	{@inheritdoc}
注入
注入::__construct
注入::__toString
注入属性	在加载的类属性上扫描#[注入]属性
注入属性::resolve	从容器中解析条目
注入属性::getDefaultPriority	设置默认优先级
内部外观
内部外观::boot	启动容器
内部外观::registerServiceProvider
内部外观::getResovedInstance
内部外观::setResolvedInstance
内部外观::getContainer
内部外观::setContainer
JsonObject	一个与json文件并发同步数据的Json对象
JsonObject::fromJsonFile
锁
Lock::createFileLock	创建一个PHP文件锁
Lock::createFileSystemLock
Lock::createSQLiteLock	创建一个SQLite锁
Lock::createNoLock	创建一个NoLock
Lock::createCacheLock	使用PSR-6缓存创建锁
Lock::createSimpleCacheLock	使用PSR-16缓存创建锁
LockFactory
LockFactory::__construct
LockFactory::createFileLock	创建一个PHP文件锁
LockFactory::createFileSystemLock	在提供的文件所在的同一目录中创建一个.lock文件
LockFactory::createSQLiteLock	创建一个SQLite锁
LockFactory::createNoLock	创建一个NoLock
LockFactory::createCacheLock	使用PSR-6缓存创建锁
LockFactory::createSimpleCacheLock	使用PSR-16缓存创建锁
LockServiceProvider
LockServiceProvider::provides	获取提供者提供的所有服务。
LockServiceProvider::register	将服务注册到容器中
LockTimeout
日志记录器
Logger::log	以任意级别记录。
Logger::emergency	系统不可用。
Logger::alert	必须立即采取行动。
Logger::critical	临界条件。
Logger::error	运行时错误，不需要立即采取行动，但通常应记录和监控。
Logger::warning	不是错误的异常事件。
Logger::notice	正常但重要的事件。
Logger::info	有趣的事件。
Logger::debug	详细的调试信息。
LoggerAwareResolver	注入Logger
LoggerAwareResolver::resolve	从容器中解析条目
LoggerAwareResolver::getDefaultPriority	设置默认优先级
映射	Map对象包含键值对，并记住键的原始插入顺序。
Map::clear	clear()方法从Map对象中删除所有元素。
Map::delete	delete()方法通过键从Map对象中删除指定的元素。
Map::get	get()方法从Map对象中返回指定的元素。
Map::search	search()方法从值返回第一个匹配的键。
Map::set	set()方法向Map对象添加或更新一个具有指定键和值的元素。
Map::add	add()方法如果Map对象中不存在，则向Map对象添加一个具有指定键和值的元素。
Map::has	has()方法返回一个布尔值，指示是否存在具有指定键的元素。
Map::keys	keys()方法返回一个新的迭代器对象，它包含Map对象中每个元素的键，按插入顺序。
Map::values	values()方法返回一个新的迭代器对象，它包含Map对象中每个元素的值，按插入顺序。
Map::entries	entries()方法返回一个新的迭代器对象，它包含Map对象中每个元素的[key, value]对，按插入顺序。
Map::forEach	forEach()方法按插入顺序对Map对象中的每个键/值对执行提供的函数一次。
Map::offsetExists	{@inheritdoc}
Map::offsetGet	{@inheritdoc}
Map::offsetSet	{@inheritdoc}
Map::offsetUnset	{@inheritdoc}
Map::count	{@inheritdoc}
Map::jsonSerialize	{@inheritdoc}
Map::__debugInfo	{@inheritdoc}
Map::__serialize	{@inheritdoc}
Map::__unserialize	{@inheritdoc}
Map::__clone	{@inheritdoc}
NoLock	NullLock
NoLock::acquire	获取锁。
NoLock::forceRelease	{@inheritdoc}
NoLock::isAcquired	返回锁是否已被获取。
NoLock::release	释放锁。
NotFound
NotFound::for
NullServiceProvider
NullServiceProvider::__construct
NullServiceProvider::provides	获取提供者提供的所有服务。
NullServiceProvider::register	将服务注册到容器中
OwnedList	模拟数据库中的一对多关系
OwnedList::create	为给定值创建一个新的OwnedList
OwnedList::__construct
OwnedList::add	在当前值和给定值之间添加关系
OwnedList::delete	删除当前值和给定值之间的关系
OwnedList::has	检查当前值和给定值之间是否存在关系
OwnedList::clear	删除所有关系
OwnedList::entries	迭代条目
OwnedList::values	迭代所有拥有的值
OwnedList::count	{@inheritdoc}
OwnedList::offsetExists
OwnedList::offsetGet
OwnedList::offsetSet
OwnedList::offsetUnset
OwnedList::jsonSerialize	{@inheritdoc}
OwnedList::__debugInfo	{@inheritdoc}
OwnedList::__serialize	{@inheritdoc}
OwnedList::__unserialize	{@inheritdoc}
OwnedList::__clone	{@inheritdoc}
ParameterResolver
ParameterResolver::__construct
ParameterResolver::canResolve
ParameterResolver::resolve
PrioritySet	优先级集合是一种按优先级排序的集合
PrioritySet::create	创建一个新的集合
PrioritySet::add	add()方法通过指定的优先级添加一个新的元素。
PrioritySet::getPriority
PrioritySet::clear	clear()方法从Set对象中删除所有元素。
PrioritySet::delete	delete()方法如果Set对象中存在指定的值，则从Set对象中删除指定的值。
PrioritySet::entries	entries()方法返回一个新的Iterator对象，它包含Set对象中每个元素的[value, value]数组，按照插入顺序。
PrioritySet::forEach	forEach()方法为Set对象中的每个值执行提供的函数一次，按照插入顺序。
PrioritySet::has	has()方法返回一个布尔值，指示Set对象中是否存在具有指定值的元素。
PrioritySet::isEmpty	检查集合是否为空
PrioritySet::values	values()方法返回一个新的Iterator对象，它包含Set对象中每个元素的值，按照插入顺序。
PrioritySet::count	{@inheritdoc}
PrioritySet::getIterator	{@inheritdoc}
PrioritySet::jsonSerialize	{@inheritdoc}
PrioritySet::__debugInfo	{@inheritdoc}
PrioritySet::__serialize
PrioritySet::__unserialize
PrioritySet::__clone	{@inheritdoc}
Range	返回一个数字序列，默认从0开始，默认递增1，并在指定的数字之前停止。
Range::__construct
Range::create	创建一个Range
Range::of	获取一个可计数对象的范围
Range::__debugInfo
Range::__toString
Range::isEmpty	检查是否为空范围
Range::count
Range::entries	按排序顺序迭代条目
RegExp
RegExp::create	初始化RegExp
RegExp::__construct	初始化RegExp
RegExp::getLastIndex	获取最后一个索引
RegExp::setLastIndex	设置最后一个索引
RegExp::test	test()方法在正则表达式和指定的字符串之间执行搜索，以查找匹配项。
RegExp::exec	exec()方法在指定的字符串中执行搜索以查找匹配项。返回一个结果数组，或null。
RegExp::replace	replace()方法用替换字符串替换字符串中此模式的所有或部分匹配项，并返回替换结果作为新字符串。
RegExp::search	search()方法在正则表达式和字符串之间执行搜索以查找匹配项。
RegExp::split	split() 方法将一个字符串分割成一个有序的子字符串列表，
RegExp::matchAll	matchAll() 方法返回一个迭代器，包含所有与正则表达式匹配的结果，包括捕获组。
RegExp::match	match() 方法检索字符串与正则表达式匹配的结果。
RegExp::__unserialize	{@inheritdoc}
RegExp::__serialize	{@inheritdoc}
RegExp::jsonSerialize	{@inheritdoc}
RegExp::__toString	{@inheritdoc}
RegExp::__debugInfo
RegExpException
RegExpException::__construct
RegExpException::getRegExp	获取 RegExp 对象
ResolverException
ResolverException::notTwice
ResolverException::invalidCallable
Set	Set 对象允许您存储任何类型的唯一值，无论是原始值还是对象引用。
Set::create	创建一个新的集合
Set::add	add() 方法将具有指定值的新的元素追加到 Set 对象的末尾。
Set::clear	clear()方法从Set对象中删除所有元素。
Set::delete	delete()方法如果Set对象中存在指定的值，则从Set对象中删除指定的值。
Set::entries	entries()方法返回一个新的Iterator对象，它包含Set对象中每个元素的[value, value]数组，按照插入顺序。
Set::has	has()方法返回一个布尔值，指示Set对象中是否存在具有指定值的元素。
Set::isEmpty	检查集合是否为空
Set::values	values()方法返回一个新的Iterator对象，它包含Set对象中每个元素的值，按照插入顺序。
Set::count	{@inheritdoc}
Set::getIterator	{@inheritdoc}
Set::jsonSerialize	{@inheritdoc}
Set::__debugInfo	{@inheritdoc}
Set::__serialize
Set::__unserialize
Set::__clone	{@inheritdoc}
SharedList	模拟数据库中找到的多对多关系
SharedList::create	创建一个新的 SharedList
SharedList::clear
SharedList::hasValue	检查值是否存在于集合中
SharedList::has	检查两个值之间是否存在关系
SharedList::add	在两个值之间添加关系
SharedList::deleteValue	删除一个值及其所有关系
SharedList::delete	删除两个值之间的关系
SharedList::get	获取共享列表的值
SharedList::entries	迭代所有共享列表的值
SharedList::count
SharedList::getIterator
SharedList::jsonSerialize
SharedList::__serialize
SharedList::__unserialize
SharedList::__debugInfo
SimpleArray	一个基础集合
SimpleArray::unshift	将一个或多个元素添加到数组的开始位置
SimpleArray::push	将一个或多个元素追加到数组的末尾
SimpleArray::shift	从数组的开始位置移除一个元素
SimpleArray::pop	从数组的末尾移除一个元素
SimpleArray::indexOf	返回值索引
SimpleCacheLock	使用 SimpleCache 管理您的锁
SimpleCacheLock::__construct
SimpleCacheLock::forceRelease	{@inheritdoc}
SimpleIterator	SimpleIterator 可以按任何顺序迭代任何内容
SimpleIterator::__construct
SimpleIterator::of	创建一个新的 SimpleIterator
SimpleIterator::ofStringable	创建一个迭代每个字符的新 SimpleIterator
SimpleIterator::ofList	从列表创建迭代器
SimpleIterator::count
SimpleIterator::entries	按排序顺序迭代条目
SimpleObject	一个基础集合
SimpleObject::search	在数组中搜索给定的值，如果成功返回第一个相应的键
SimpleObject::__get	{@inheritdoc}
SimpleObject::__set	{@inheritdoc}
SimpleObject::__unset	{@inheritdoc}
SimpleObject::__isset	{@inheritdoc}
SimpleServiceProvider
SimpleServiceProvider::__construct
SimpleServiceProvider::provides	获取提供者提供的所有服务。
SimpleServiceProvider::register	将服务注册到容器中
Slice
Slice::create	创建 Slice 实例
Slice::of	使用 Python 切片符号创建 Slice 实例
Slice::isValid	检查是否是有效的切片语法
Slice::__construct
Slice::getStart
Slice::getStop
Slice::getStep
Slice::getIteratorFor
Slice::getOffsetList
Slice::slice	返回数组对象的一个切片
Slice::join	返回一个切片的字符串
Slice::__debugInfo
Slice::__toString
SQLiteLock	一个 SQLite 数据库来管理您的锁
SQLiteLock::__construct
SQLiteLock::forceRelease	{@inheritdoc}
StackableContainer
StackableContainer::__construct
StackableContainer::hasContainer	检查容器是否已经堆叠
StackableContainer::addContainer	在顶部堆叠一个新的容器
StackableContainer::get	{@inheritdoc}
StackableContainer::has	{@inheritdoc}
状态	基本枚举类支持（Polyfill）添加类常量作为php 8.1支持的枚举情况的能力
StopWatch
StopWatch::startTask	启动一个可调用函数并返回结果时间
StopWatch::startTaskWithStartTime
StopWatch::__construct
StopWatch::getTask
StopWatch::executeTask
StopWatch::start	开始时钟
StopWatch::resume	恢复时钟（仅当暂停时）
StopWatch::reset	重置时钟
StopWatch::pause	暂停时钟
StopWatch::stop	停止时钟
StopWatch::read	读取时钟
StopWatch::getLaps
StopWatch::lap	添加圈数时间
StopWatch::isStarted
StopWatch::isPaused
StopWatch::isStopped
文本	将标量转换为它的可字符串表示形式
Text::create	创建新的文本
Text::of	创建新的文本
Text::ofSegments	创建多个文本段
Text::__construct
Text::copy	获取一个文本副本
Text::indexOf	indexOf()方法，给定一个参数：要搜索的子字符串/正则表达式，搜索整个调用字符串，并返回指定子字符串的第一个出现的位置
Text::search	indexOf的别名
Text::lastIndexOf	lastIndexOf()方法，给定一个参数：要搜索的子字符串/正则表达式，搜索整个调用字符串，并返回指定子字符串的最后一个出现的位置。
Text::at	at()方法接受一个整数值并返回指定偏移量处的字符
Text::concat	concat()方法将字符串参数连接到当前文本
Text::toLowerCase	将文本转换为小写
Text::toUpperCase	将文本转换为大写
Text::endsWith	endsWith()方法确定字符串是否以指定的字符串的字符结尾，根据情况返回true或false。
Text::startsWith	startsWith()方法确定字符串是否以指定的字符串的字符开头，根据情况返回true或false。
Text::contains	includes()方法执行搜索以确定一个字符串是否可以在另一个字符串/正则表达式中找到，根据情况返回true或false。
Text::containsAll	确定给定的字符串是否包含所有针
Text::includes	includes()方法执行大小写敏感的搜索以确定一个字符串是否可以在另一个字符串中找到，根据情况返回true或false。
Text::match	match() 方法检索字符串与正则表达式匹配的结果。
Text::matchAll	matchAll() 方法返回一个迭代器，包含所有与正则表达式匹配的结果，包括捕获组。
Text::padStart	在字符串的左侧填充另一个字符串。
Text::padEnd	在字符串的右侧填充另一个字符串。
Text::pad	在字符串的两侧填充另一个字符串。
Text::repeat	repeat()方法构建并返回一个新的字符串，该字符串包含指定次数的字符串副本，这些副本连接在一起。
Text::replace	替换字符串中给定值的第一处出现。
Text::replaceAll
Text::substring	substring()方法返回从起始索引到结束索引的字符串部分，或到字符串的末尾。
Text::ltrim	从字符串的左侧移除指定的字符。
Text::trimStart	ltrim的别名
Text::rtrim	从字符串的右侧移除指定的字符。
Text::trimEnd	rtrim的别名
Text::trim	从字符串中移除指定的字符。
Text::capitalize	返回一个字符串副本，其中第一个字符已大写，其余字符已小写。
Text::center	返回长度为width的字符串中的居中文本。填充使用指定的填充字符（默认为ASCII空格）。
Text::expandtabs	返回一个字符串副本，其中所有制表符字符都替换为一个或多个空格。
Text::find	返回子串sub在字符串s[start:end]中的最低索引。
Text::format	执行字符串格式化操作。被该方法调用的字符串可以包含普通文本或由大括号{}分隔的替换字段。
Text::index	与find()类似，但如果子串未找到，则引发ValueError。
Text::isalnum	如果字符串中的所有字符都是字母数字且至少有一个字符，则返回True，否则返回False
Text::isalpha	如果字符串中的所有字符都是字母且至少有一个字符，则返回True，否则返回False。
Text::isdecimal	如果字符串中的所有字符都是十进制字符且至少有一个字符，则返回True，否则返回False
Text::isdigit	如果字符串中的所有字符都是数字且至少有一个字符，则返回True，否则返回False。
Text::islower	如果字符串中的所有有大小写的字符都是小写且至少有一个大小写字符，则返回True，否则返回False。
Text::isnumeric	检查变量是否为数字或数字字符串
Text::istitle	如果字符串是标题化字符串且至少有一个字符，则返回True，例如，大写字母只能跟在不带大小写的字符之后，小写字母只能跟在有大小写的字符之后。
Text::isspace	如果字符串中只包含空白字符且至少有一个字符，则返回True，否则返回False。
Text::isprintable	如果字符串中的所有字符都是可打印的或字符串为空，则返回True，否则返回False。
Text::ispunct	检查提供的Text中的所有字符是否都是标点符号。
Text::iscontrol	检查Text中的所有字符是否都是控制字符
Text::isupper	如果字符串中的所有字符都是大写且至少有一个小写字符，则返回True，否则返回False。
Text::join	返回一个字符串，它是可迭代中字符串的连接。
Text::lower	返回一个字符串副本，其中所有字符都已转换为小写。
Text::lstrip	返回一个字符串副本，其中已删除前导字符。
Text::partition	在sep的第一个出现处拆分字符串，并返回一个包含分隔符之前的部分、分隔符本身和分隔符之后的部分的3元组。
Text::removeprefix	如果字符串以prefix字符串开头，则返回string[len(prefix):]。否则，返回原始字符串的副本
Text::removeSuffix	如果字符串以空字符串后跟的suffix字符串结束且该后缀不为空，则返回string[:-len(suffix)]。
Text::reverse	反转字符串
Text::rfind	返回字符串中子串sub的最高索引，其中sub包含在s[start:end]中。
Text::rindex	与rfind()类似，但如果子串sub未找到，则引发ValueError。
Text::rpartition	在sep的最后出现处拆分字符串，并返回一个包含分隔符之前的部分、分隔符本身和分隔符之后的部分的3元组。
Text::rstrip	返回一个字符串副本，其中已删除尾部字符。
Text::strip	返回一个字符串副本，其中已删除前导和尾部字符。
Text::swapcase	返回一个字符串副本，其中大写字符转换为小写，反之亦然。
Text::slice	slice()方法提取字符串的某个部分，并返回一个新字符串
Text::title	返回一个标题化版本的字符串，其中单词以大写字母开头，其余字符为小写。
Text::upper	返回一个字符串副本，其中所有有大小写的字符都已转换为大写
Text::split	使用sep作为分隔符字符串，返回字符串中的单词列表。
Text::rsplit	使用sep作为分隔符字符串，返回字符串中的单词列表。
Text::splitlines	返回字符串中的行列表，在行边界处拆分。
Text::sprintf	使用sprintf格式化字符串
Text::ucfirst	在字符串上使用ucfirst
Text::lcfirst	在字符串上使用lcfirst
Text::append	返回添加后缀的新Text
Text::prepend	返回添加前缀的新Text
Text::isBase64	检查Text是否为base 64编码
Text::base64Encode	返回一个base64解码的Text
Text::base64Decode	返回一个base64解码的Text
Text::splitChars	将Text拆分为多个Text[]
Text::countChars	计数Text内部针的出现的次数，如果使用正则表达式作为针，搜索将是大小写敏感的
Text::isEquals	检查Text是否与提供的针相同
Text::ishexadecimal	检查字符串是否为十六进制数
Text::length	返回文本的长度
Text::size	返回字节数量
Text::offsetExists
Text::offsetGet
Text::offsetSet
Text::offsetUnset
Text::count
Text::isEmpty
Text::jsonSerialize
Text::toString
Text::__toString
Text::__serialize
Text::__unserialize
Text::__debugInfo
Timer
Timer::getWatch	获取一个监视器
Timer::read	读取时钟
Timer::start	开始时钟
Timer::resume	恢复时钟（仅当暂停时）
Timer::reset	重置时钟
Timer::resetAll	重置所有时钟
Timer::pause	暂停时钟
Timer::stop	停止时钟
Timer::getLaps
Timer::lap	添加圈数时间
Tools	在我项目中使用的一些有用的函数
Tools::safe_exec	执行回调并隐藏所有可能抛出的PHP错误异常。回调内部抛出的异常将被保留。
Tools::errors_as_exceptions	方便的函数，用于将PHP错误、警告...转换为Throwable
Tools::suppress_errors	将错误处理程序设置为空闭包（从PHP 8.1开始，@不再起作用）
Tools::normalize_path	规范化路径名
Tools::pushd	更改当前活动目录，并存储最后的位置，使用popd()返回到上一个目录
Tools::popd	恢复由pushd更改的最后活动目录
Tools::each	使用回调为数组的每个元素，并返回值
Tools::iterateAll	迭代可迭代对象
Tools::filter	使用回调函数过滤可迭代对象的元素
Tools::search	搜索可迭代对象直到找到元素
Tools::map	与原始函数相同，除了回调接受更多参数，并使用字符串键外
Tools::some	测试可迭代对象中至少有一个元素通过提供的函数实现的测试。
Tools::every	测试可迭代对象中的所有元素是否通过提供的函数实现的测试。
Tools::pull	从数组中获取值（并移除它）
Tools::cloneArray	递归地克隆数组中的所有对象
Tools::iterableToArray	递归地将可迭代对象转换为数组，如果键不是字符串，将进行索引
Tools::concat	递归地将多个值连接到提供的可迭代对象中。如果提供的值是可迭代的，它将被合并到可迭代对象中（非数字键如果不可迭代将替换为提供的对象）
Tools::countValue	计数值的出现次数
Tools::isValidUrl	检查是否为有效的URL
Tools::to_snake	将驼峰式转换为camel_cased
Tools::toCamelCase	将snake_case转换为snakeCase
Tools::millitime	返回当前Unix时间戳的毫秒值
Tools::generate_uuid_v4	生成uuid V4
Tools::isAscii	返回此字符串是否完全由ASCII字符组成
Tools::isPrintableAscii	返回此字符串是否完全由可打印的ASCII字符组成
Tools::getFilesize	获取可读文件大小
Tools::randomString	生成更真实的“随机”字母数字字符串。
Tools::getWordSize	获取字符串中最长单词的长度
Tools::splitString	在不切断单词的情况下按给定长度分割字符串
Tools::join	使用提供的粘合剂将可迭代对象连接在一起
Tools::format	尝试重现Python格式
Tools::split	使用提供的分隔符分割字符串
Tools::getExecutionTime	获取脚本执行时间
Tools::pause	暂停脚本执行指定时间，结合sleep或usleep
Tools::msleep	暂停脚本执行指定毫秒数
Tools::implements_class	从已加载的类中获取实现给定父类的类
Tools::getClassConstants	获取类中定义的常量
Tools::callPrivateMethod	在对象内部调用方法，忽略其状态
TypeCheck	检查混合联合/交集类型
TypeCheck::assertType	检查给定值与提供的类型是否匹配，如果不匹配则抛出TypeError
TypeCheck::assertTypeMethod	检查给定值与提供的类型是否匹配，如果不匹配则抛出TypeError
TypeCheck::checkType	可以检查交集和联合的混合
Units	基本枚举类支持（Polyfill）添加类常量作为php 8.1支持的枚举情况的能力
Units::getStep
Units::getPlural
Units::getSingular
WatchFactory
WatchFactory::__construct
WatchFactory::getWatch	获取一个监视器
WatchFactory::read	读取时钟
WatchFactory::start	开始时钟
WatchFactory::resume	恢复时钟（仅当暂停时）
WatchFactory::reset	重置时钟
WatchFactory::resetAll	重置所有时钟
WatchFactory::pause	暂停时钟
WatchFactory::stop	停止时钟
WatchFactory::getLaps
WatchFactory::lap	添加圈数时间

CacheLock

使用缓存池来管理您的锁

• 全名: \NGSOFT\Lock\CacheLock
• 父类: \NGSOFT\Lock\CacheLockAbstract

CacheLock::__construct

CacheLock::__construct( \Psr\Cache\CacheItemPoolInterface cache, string|\Stringable name, int|float seconds, string|\Stringable owner = '', bool autoRelease = true ): mixed

参数

参数	类型	描述
cache	\Psr\Cache\CacheItemPoolInterface
name	string|\Stringable
seconds	int|float
owner	string|\Stringable
autoRelease	bool

返回值

CacheLock::forceRelease

{@inheritdoc}

CacheLock::forceRelease(  ): void

返回值

CharMap

一个多字节/字节字符串转换映射

• 全名: \NGSOFT\Tools\CharMap
• 此类实现: \Stringable, \Countable

CharMap::create

创建一个新的 CharMap

CharMap::create( string string ): static

• 此方法为 静态。 参数:

参数	类型	描述
string	string

返回值

CharMap::getCharOffset

获取字符偏移量从字节偏移量，失败时返回-1

CharMap::getCharOffset( string string, int byte ): int

• 此方法为 静态。 参数:

参数	类型	描述
string	string
byte	int

返回值

CharMap::getByteOffset

获取字符偏移量从字节偏移量，偏移返回-1失败

CharMap::getByteOffset( string string, int char ): int

• 此方法为 静态。 参数:

参数	类型	描述
string	string
char	int

返回值

CharMap::__construct

创建一个新的 CharMap

CharMap::__construct( string string ): mixed

参数

参数	类型	描述
string	string

返回值

CharMap::convertByteOffset

从字节偏移量获取字符偏移量

CharMap::convertByteOffset( int byte ): int

参数

参数	类型	描述
byte	int

返回值

CharMap::convertCharacterOffset

从字符偏移量获取字节偏移量

CharMap::convertCharacterOffset( int char ): int

参数

参数	类型	描述
char	int

返回值

CharMap::getLength

获取字符数

CharMap::getLength(  ): int

返回值

CharMap::getSize

获取字节数

CharMap::getSize(  ): int

返回值

CharMap::count

CharMap::count(  ): int

返回值

CharMap::isEmpty

CharMap::isEmpty(  ): bool

返回值

CharMap::toString

CharMap::toString(  ): string

返回值

CharMap::__toString

CharMap::__toString(  ): string

返回值

CharMap::__unserialize

CharMap::__unserialize( array data ): mixed

参数

参数	类型	描述
data	array

返回值

CharMap::__serialize

CharMap::__serialize(  ): array

返回值

CircularDependencyException

• 全名: \NGSOFT\Container\Exceptions\CircularDependencyException
• 父类: \NGSOFT\Container\Exceptions\ContainerError

Container

• 全名: \NGSOFT\Container\Container
• 此类实现: \NGSOFT\Container\ContainerInterface

Container::__construct

Container::__construct( iterable definitions = [] ): mixed

参数

参数	类型	描述
definitions	iterable

返回值

Container::alias

将条目别名到不同的名称

Container::alias( string|array alias, string id ): void

参数

参数	类型	描述
alias	string|array
id	string

返回值

Container::has

{@inheritdoc}

Container::has( string id ): bool

参数

参数	类型	描述
id	string

返回值

Container::get

{@inheritdoc}

Container::get( string id ): mixed

参数

参数	类型	描述
id	string

返回值

Container::make

通过名称解析条目。如果给定一个类名，它将返回该类的全新实例。

Container::make( string id, array parameters = [] ): mixed

参数

参数	类型	描述
id	string
parameters	array

返回值

Container::call

使用给定的参数调用给定的函数。

Container::call( object|array|string callable, array parameters = [] ): mixed

参数

参数	类型	描述
callable	object|array|string
parameters	array

返回值

Container::register

注册一个服务

Container::register( \NGSOFT\Container\ServiceProvider service ): void

参数

参数	类型	描述
service	\NGSOFT\Container\ServiceProvider

返回值

Container::set

向容器添加定义

Container::set( string id, mixed value ): void

参数

参数	类型	描述
id	string
value	mixed

返回值

Container::setMany

添加多个定义

Container::setMany( iterable definitions ): void

参数

参数	类型	描述
definitions	iterable

返回值

Container::addContainerResolver

添加一个处理程序来管理条目解析（在参数解析后）

Container::addContainerResolver( \NGSOFT\Container\Resolvers\ContainerResolver resolver, ?int priority = null ): void

参数

参数	类型	描述
resolver	\NGSOFT\Container\Resolvers\ContainerResolver
priority	?int

返回值

Container::__debugInfo

Container::__debugInfo(  ): mixed

返回值

Container

• 全名: \NGSOFT\Facades\Container
• 父类: \NGSOFT\Facades\Facade

Container::alias

将条目别名到不同的名称

Container::alias( array|string alias, string id ): void

• 此方法为 静态。 参数:

参数	类型	描述
alias	array|string
id	string

返回值

Container::has

如果容器可以返回给定标识符的条目，则返回 true。

Container::has( string id ): bool

否则返回false。

• 此方法为 静态。 参数:

参数	类型	描述
id	string

返回值

Container::get

通过标识符查找容器中的条目并返回它。

Container::get( string id ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
id	string

返回值

Container::make

通过名称解析条目。如果给定一个类名，它将返回该类的全新实例。

Container::make( string id, array parameters = [] ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
id	string
parameters	array

返回值

Container::call

使用给定的参数调用给定的函数。

Container::call( object|array|string callable, array parameters = [] ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
callable	object|array|string
parameters	array

返回值

Container::register

注册一个服务

Container::register( \NGSOFT\Container\ServiceProvider service ): void

• 此方法为 静态。 参数:

参数	类型	描述
service	\NGSOFT\Container\ServiceProvider

返回值

Container::set

向容器添加定义

Container::set( string id, mixed value ): void

• 此方法为 静态。 参数:

参数	类型	描述
id	string
value	mixed

返回值

Container::setMany

添加多个定义

Container::setMany( iterable definitions ): void

• 此方法为 静态。 参数:

参数	类型	描述
definitions	iterable

返回值

Container::addContainerResolver

添加一个处理程序来管理条目解析（在参数解析后）

Container::addContainerResolver( \NGSOFT\Container\Resolvers\ContainerResolver resolver, ?int priority = null ): void

• 此方法为 静态。 参数:

参数	类型	描述
resolver	\NGSOFT\Container\Resolvers\ContainerResolver
priority	?int

返回值

ContainerError

• 全名: \NGSOFT\Container\Exceptions\ContainerError
• 父类
• 此类实现: \Psr\Container\ContainerExceptionInterface

Directory

管理目录

• 全名: \NGSOFT\Filesystem\Directory
• 父类: \NGSOFT\Filesystem\Filesystem
• 此类实现: \IteratorAggregate

Directory::scanFiles

扫描目录中的文件

Directory::scanFiles( string dirname, bool recursive = false ): \NGSOFT\Filesystem\FileList

• 此方法为 静态。 参数:

参数	类型	描述
dirname	string
recursive	bool

返回值

Directory::scanFilesArray

Directory::scanFilesArray( string dirname, bool recursive = false ): array

• 此方法为 静态。 参数:

参数	类型	描述
dirname	string
recursive	bool

返回值

Directory::cwd

Directory::cwd(  ): static

• 此方法为 静态。

返回值

Directory::pushd

更改当前活动目录并存储最后一个位置

Directory::pushd( string|self directory ): static|false

• 此方法为 静态。 参数:

参数	类型	描述
directory	string|self

返回值

Directory::popd

恢复最后一个活动目录位置并返回它

Directory::popd(  ): static|false

• 此方法为 静态。

返回值

Directory::__construct

Directory::__construct( string path = '' ): mixed

参数

参数	类型	描述
path	string

返回值

Directory::copy

将目录复制到另一个位置

Directory::copy( string|self target, ?bool &success = null ): static

参数

参数	类型	描述
target	string|self	新目录
success	?bool	如果操作成功则为true

返回值

目标目录的Directory实例

Directory::delete

递归删除目录。

Directory::delete(  ): bool

返回值

Directory::exists

检查目录是否存在

Directory::exists(  ): bool

返回值

Directory::isEmpty

检查是否没有文件

Directory::isEmpty(  ): bool

返回值

Directory::mkdir

创建目录

Directory::mkdir( int mode = 0777, bool recursive = true ): bool

参数

参数	类型	描述
mode	int
recursive	bool

返回值

Directory::rmdir

删除目录

Directory::rmdir(  ): bool

返回值

Directory::chdir

更改目录

Directory::chdir(  ): bool

返回值

Directory::isCurrentWorkingDir

检查是否是当前活动目录

Directory::isCurrentWorkingDir(  ): bool

返回值

Directory::search

使用正则表达式、glob或检查文件名是否包含 $query 递归地搜索文件

Directory::search( string pattern ): \NGSOFT\Filesystem\FileList

参数

参数	类型	描述
pattern	string

返回值

Directory::glob

在目录内执行 glob 搜索

Directory::glob( string pattern, int flags ): \NGSOFT\Filesystem\FileList

参数

参数	类型	描述
pattern	string
flags	int

返回值

Directory::files

列出目录中的文件

Directory::files( string|array extensions = [], bool hidden = false ): \NGSOFT\Filesystem\FileList

参数

参数	类型	描述
extensions	string|array
hidden	bool

返回值

Directory::allFiles

递归列出文件

Directory::allFiles( string|array extensions = [], bool hidden = false ): \NGSOFT\Filesystem\FileList

参数

参数	类型	描述
extensions	string|array
hidden	bool

返回值

Directory::directories

列出目录

Directory::directories( bool recursive = false ): \NGSOFT\Filesystem\FileList

参数

参数	类型	描述
recursive	bool

返回值

Directory::getFile

访问该目录中的文件

Directory::getFile( string target ): \NGSOFT\Filesystem\File|\NGSOFT\Filesystem\Directory

参数

参数	类型	描述
target	string

返回值

Directory::getIterator

Directory::getIterator(  ): \Traversable

返回值

EnumUtils

• 全名: \NGSOFT\Enums\EnumUtils

EnumUtils::generateEnumClassPhpDoc

生成魔法静态方法的 Doc 注释

EnumUtils::generateEnumClassPhpDoc( string className ): string

• 此方法为 静态。 参数:

参数	类型	描述
className	string

返回值

EnumUtils::addPhpDocToEnumClass

自动为枚举生成静态方法 doc 块

EnumUtils::addPhpDocToEnumClass( string className ): bool

• 此方法为 静态。 参数:

参数	类型	描述
className	string

返回值

FacadeUtils

• 全名: \NGSOFT\Tools\Utils\FacadeUtils

FacadeUtils::getClassDocBlocks

FacadeUtils::getClassDocBlocks( object|string instance, bool static = true ): array

• 此方法为 静态。 参数:

参数	类型	描述
instance	object|string
static	bool

返回值

FacadeUtils::createDocBlock

FacadeUtils::createDocBlock( string facade ): string

• 此方法为 静态。 参数:

参数	类型	描述
facade	string

返回值

FacadeUtils::createMethodsForInstance

FacadeUtils::createMethodsForInstance( object|string instance, string facade = null ): string

• 此方法为 静态。 参数:

参数	类型	描述
instance	object|string
facade	string

返回值

FacadeUtils::createMethods

FacadeUtils::createMethods( string facade ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
facade	string

返回值

FacadeUtils::createFacadeCode

FacadeUtils::createFacadeCode( object instance, ?string name = null, ?string accessor = null ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
instance	object
name	?string
accessor	?string

返回值

File

管理文件

• 全名: \NGSOFT\Filesystem\File
• 父类: \NGSOFT\Filesystem\Filesystem
• 此类实现: \IteratorAggregate

File::__construct

File::__construct( string path ): mixed

参数

参数	类型	描述
path	string

返回值

File::__destruct

File::__destruct(  ): mixed

返回值

File::getDirectory

获取文件目录

File::getDirectory(  ): \NGSOFT\Filesystem\Directory

返回值

File::exists

检查文件是否存在且为常规文件

File::exists(  ): bool

返回值

File::isModified

检查CRC校验和是否已更改

File::isModified(  ): bool

返回值

File::unlink

删除文件

File::unlink(  ): bool

返回值

File::copy

复制文件

File::copy( string|self target, ?bool &success = null ): static

参数

参数	类型	描述
target	string|self	新文件
success	?bool	如果操作成功则为true

返回值

目标文件的File实例

File::delete

删除文件

File::delete(  ): bool

返回值

File::require

将文件包含为PHP文件

File::require( array data = [], bool once = false ): mixed

参数

参数	类型	描述
data	array	要提取的数据
once	bool	require_once

返回值

File::name

获取不带扩展名的文件名

File::name(  ): string

返回值

File::extension

获取最后的文件扩展名

File::extension(  ): string

返回值

File::hash

获取CRC32校验和

File::hash(  ): string|null

返回值

File::touch

设置文件的访问和修改时间

File::touch( int|null mtime = null, int|null atime = null ): bool

参数

参数	类型	描述
mtime	int|null
atime	int|null

返回值

File::getContents

将文件作为迭代器加载

File::getContents(  ): \NGSOFT\Filesystem\FileContents

返回值

File::createContents

创建文件内容

File::createContents(  ): \NGSOFT\Filesystem\FileContents

返回值

File::read

加载文件

File::read(  ): string

返回值

File::readAsArray

将文件作为行数组读取

File::readAsArray(  ): string[]

返回值

File::readJson

解码JSON文件

File::readJson(  ): mixed

返回值

File::write

保存文件

File::write( string|string[]|\Stringable|\Stringable[] contents ): bool

参数

参数	类型	描述
内容	字符串|字符串数组|\Stringable|\Stringable[]

返回值

File::writeJson

将数据转储为JSON

File::writeJson( mixed data, int flags = JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ): bool

参数

参数	类型	描述
data	mixed
flags	int

返回值

File::getIterator

File::getIterator(  ): \Traversable

返回值

File::lock

锁定文件访问以处理并发请求

File::lock( int|float seconds, string owner = '' ): \NGSOFT\Lock\FileSystemLock

参数

参数	类型	描述
seconds	int|float
owner	string

返回值

File::__debugInfo

File::__debugInfo(  ): array

返回值

FileContents

• 全名：\NGSOFT\Filesystem\FileContents
• 该类实现：\IteratorAggregate, \ArrayAccess, \Countable, \Stringable, \JsonSerializable

FileContents::__construct

FileContents::__construct( \NGSOFT\Filesystem\File file, array lines = [], bool loaded = false ): mixed

参数

参数	类型	描述
文件	\NGSOFT\Filesystem\File
行	array
已加载	bool

返回值

FileContents::refresh

重新组织行

FileContents::refresh(  ): void

返回值

FileContents::reload

重新加载文件内容

FileContents::reload(  ): void

返回值

FileContents::clear

清除内容

FileContents::clear(  ): void

返回值

FileContents::map

使用可调用来运行所有行并替换内容为返回值

FileContents::map( callable callable ): static

参数

参数	类型	描述
callable	callable

返回值

FileContents::filter

为所有行运行可调用，并删除未通过测试的行

FileContents::filter( callable callable ): static

参数

参数	类型	描述
callable	callable

返回值

FileContents::save

保存文件内容

FileContents::save(  ): bool

返回值

FileContents::readLine

读取一行

FileContents::readLine( int offset ): string|null

参数

参数	类型	描述
偏移量	int

返回值

FileContents::write

替换整个内容

FileContents::write( string|iterable lines ): static

参数

参数	类型	描述
行	字符串|可迭代对象

返回值

FileContents::writeLine

替换或添加一行

FileContents::writeLine( string value, int|null offset = null ): static

参数

参数	类型	描述
value	string
偏移量	int|null

返回值

FileContents::insertLine

如果没有定义偏移量，则插入行将在文件的开始处添加，如果超出范围，则将在文件末尾添加

FileContents::insertLine( string value, int|null offset = null ): static

参数

参数	类型	描述
value	string
偏移量	int|null

返回值

FileContents::removeLine

删除一行，并重新组织行

FileContents::removeLine( int offset ): static

参数

参数	类型	描述
偏移量	int

返回值

FileContents::offsetExists

{@inheritdoc}

FileContents::offsetExists( mixed offset ): bool

参数

参数	类型	描述
偏移量	mixed

返回值

FileContents::offsetGet

{@inheritdoc}

FileContents::offsetGet( mixed offset ): mixed

参数

参数	类型	描述
偏移量	mixed

返回值

FileContents::offsetSet

{@inheritdoc}

FileContents::offsetSet( mixed offset, mixed value ): void

参数

参数	类型	描述
偏移量	mixed
value	mixed

返回值

FileContents::offsetUnset

{@inheritdoc}

FileContents::offsetUnset( mixed offset ): void

参数

参数	类型	描述
偏移量	mixed

返回值

FileContents::isEmpty

FileContents::isEmpty(  ): bool

返回值

FileContents::count

{@inheritdoc}

FileContents::count(  ): int

返回值

FileContents::getIterator

FileContents::getIterator(  ): \Traversable<int,string>

返回值

FileContents::jsonSerialize

{@inheritdoc}

FileContents::jsonSerialize(  ): mixed

返回值

FileContents::__toString

{@inheritdoc}

FileContents::__toString(  ): string

返回值

FileContents::__serialize

{@inheritdoc}

FileContents::__serialize(  ): array

返回值

FileContents::__unserialize

{@inheritdoc}

FileContents::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

FileContents::__debugInfo

FileContents::__debugInfo(  ): array

返回值

FileFactory

• 全名：\NGSOFT\Filesystem\FileFactory

FileFactory::getFile

获取一个File实例

FileFactory::getFile( string filename ): \NGSOFT\Filesystem\File

参数

参数	类型	描述
文件名	string

返回值

FileFactory::getDirectory

获取一个Directory实例

FileFactory::getDirectory( string dirname ): \NGSOFT\Filesystem\Directory

参数

参数	类型	描述
dirname	string

返回值

FileFactory::getFileContents

获取文件内容

FileFactory::getFileContents( string filename ): \NGSOFT\Filesystem\FileContents

参数

参数	类型	描述
文件名	string

返回值

FileList

文件列表迭代器

• 全名：\NGSOFT\Filesystem\FileList
• 该类实现：\IteratorAggregate, \Countable

FileList::create

FileList::create( array files = [] ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
文件	array

返回值

FileList::append

将文件添加到列表中

FileList::append( string|iterable|\NGSOFT\Filesystem\Filesystem files ): void

参数

参数	类型	描述
文件	字符串|可迭代对象|\NGSOFT\Filesystem\Filesystem

返回值

FileList::files

仅返回文件

FileList::files(  ): static

返回值

FileList::directories

仅返回目录

FileList::directories(  ): static

返回值

FileList::filter

使用可调用过滤结果

FileList::filter( callable callable ): static

参数

参数	类型	描述
callable	callable

返回值

FileList::toArray

返回文件真实路径

FileList::toArray(  ): array

返回值

FileList::isEmpty

FileList::isEmpty(  ): bool

返回值

FileList::count

FileList::count(  ): int

返回值

FileList::getIterator

FileList::getIterator(  ): \Traversable<string,\NGSOFT\Filesystem\File|\NGSOFT\Filesystem\Directory>

返回值

FileList::keys

FileList::keys(  ): string[]

返回值

FileList::values

FileList::values(  ): \NGSOFT\Filesystem\File[]|\NGSOFT\Filesystem\Directory[]

返回值

FileList::__serialize

FileList::__serialize(  ): array

返回值

FileList::__unserialize

FileList::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

FileList::__debugInfo

FileList::__debugInfo(  ): array

返回值

FileLock

使用PHP文件创建锁

• 全名：\NGSOFT\Lock\FileLock
• 父类：\NGSOFT\Lock\BaseLockStore

FileLock::__construct

FileLock::__construct( string|\Stringable name, int|float seconds, string|\Stringable owner = '', bool autoRelease = true, string rootpath = '', string prefix = '@flocks' ): mixed

参数

参数	类型	描述
name	string|\Stringable
seconds	int|float
owner	string|\Stringable
autoRelease	bool
rootpath	string	放置锁的位置
prefix	string	在$rootpath下的子目录

返回值

FileLock::forceRelease

{@inheritdoc}

FileLock::forceRelease(  ): void

返回值

FileSystem

• 全名：\NGSOFT\Facades\FileSystem
• 父类: \NGSOFT\Facades\Facade

FileSystem::getFile

获取一个File实例

FileSystem::getFile( string filename ): \NGSOFT\Filesystem\File

• 此方法为 静态。 参数:

参数	类型	描述
文件名	string

返回值

FileSystem::getDirectory

获取一个Directory实例

FileSystem::getDirectory( string dirname ): \NGSOFT\Filesystem\Directory

• 此方法为 静态。 参数:

参数	类型	描述
dirname	string

返回值

FileSystem::getFileContents

获取文件内容

FileSystem::getFileContents( string filename ): \NGSOFT\Filesystem\FileContents

• 此方法为 静态。 参数:

参数	类型	描述
文件名	string

返回值

FileSystemLock

创建与提供的文件具有相同文件名和目录的锁文件

• 全名：\NGSOFT\Lock\FileSystemLock
• 父类：\NGSOFT\Lock\BaseLockStore

FileSystemLock::__construct

FileSystemLock::__construct( \NGSOFT\Filesystem\File name, int|float seconds, string|\Stringable owner = '', bool autoRelease = true ): mixed

参数

参数	类型	描述
name	\NGSOFT\Filesystem\File
seconds	int|float
owner	string|\Stringable
autoRelease	bool

返回值

FileSystemLock::forceRelease

FileSystemLock::forceRelease(  ): void

返回值

FixedArray

具有固定容量的数组，使用LRU模型（最近最少使用首先被移除）。SplFixedArray仅与int偏移量一起使用（不支持null或字符串）

• 全名：\NGSOFT\DataStructure\FixedArray
• 该类实现：\NGSOFT\DataStructure\ReversibleIterator, \ArrayAccess, \JsonSerializable, \Stringable

FixedArray::create

创建一个新的Fixed Array

FixedArray::create( int size = self::DEFAULT_CAPACITY ): static

• 此方法为 静态。 参数:

参数	类型	描述
size	int

返回值

FixedArray::__construct

FixedArray::__construct( int size = self::DEFAULT_CAPACITY ): mixed

参数

参数	类型	描述
size	int

返回值

FixedArray::clear

FixedArray::clear(  ): void

返回值

FixedArray::getSize

获取数组的大小。

FixedArray::getSize(  ): int

返回值

FixedArray::setSize

将数组的大小更改为新的大小size。如果size小于当前数组大小，则超出新大小的任何值将被丢弃。

FixedArray::setSize( int size ): bool

如果size大于当前数组大小，则数组将用null值填充。

参数

参数	类型	描述
size	int

返回值

FixedArray::count

{@inheritdoc}

FixedArray::count(  ): int

返回值

FixedArray::entries

按排序顺序迭代条目

FixedArray::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

FixedArray::keys

返回一个新可迭代对象，其中仅包含索引

FixedArray::keys( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

FixedArray::values

返回一个只包含值的新的可迭代对象

FixedArray::values( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

FixedArray::jsonSerialize

{@inheritdoc}

FixedArray::jsonSerialize(  ): mixed

返回值

FixedArray::offsetExists

{@inheritdoc}

FixedArray::offsetExists( mixed offset ): bool

参数

参数	类型	描述
偏移量	mixed

返回值

FixedArray::offsetGet

{@inheritdoc}

FixedArray::offsetGet( mixed offset ): mixed

参数

参数	类型	描述
偏移量	mixed

返回值

FixedArray::offsetSet

{@inheritdoc}

FixedArray::offsetSet( mixed offset, mixed value ): void

参数

参数	类型	描述
偏移量	mixed
value	mixed

返回值

FixedArray::offsetUnset

{@inheritdoc}

FixedArray::offsetUnset( mixed offset ): void

参数

参数	类型	描述
偏移量	mixed

返回值

FixedArray::__debugInfo

{@inheritdoc}

FixedArray::__debugInfo(  ): array

返回值

FixedArray::__serialize

{@inheritdoc}

FixedArray::__serialize(  ): array

返回值

FixedArray::__unserialize

{@inheritdoc}

FixedArray::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

FixedArray::__clone

{@inheritdoc}

FixedArray::__clone(  ): void

返回值

注入

• 全名：\NGSOFT\Container\Attribute\Inject
• 该类实现：\Stringable

注入::__construct

Inject::__construct( string|array name = '' ): mixed

参数

参数	类型	描述
name	string|array

返回值

注入::__toString

Inject::__toString(  ): string

返回值

注入属性

在加载的类属性上扫描#[注入]属性

• 全名：\NGSOFT\Container\Resolvers\InjectProperties
• 父类：\NGSOFT\Container\Resolvers\ContainerResolver

注入属性::resolve

从容器中解析条目

InjectProperties::resolve( mixed value ): mixed

参数

参数	类型	描述
value	mixed

返回值

注入属性::getDefaultPriority

设置默认优先级

InjectProperties::getDefaultPriority(  ): int

返回值

内部外观

• 全名：\NGSOFT\Facades\Facade\InnerFacade
• 父类: \NGSOFT\Facades\Facade

内部外观::boot

启动容器

InnerFacade::boot( array definitions = [] ): void

参数

参数	类型	描述
definitions	array

返回值

内部外观::registerServiceProvider

InnerFacade::registerServiceProvider( string accessor, \NGSOFT\Container\ServiceProvider provider ): void

参数

参数	类型	描述
accessor	string
provider	\NGSOFT\Container\ServiceProvider

返回值

内部外观::getResovedInstance

InnerFacade::getResovedInstance( string name ): mixed

参数

参数	类型	描述
name	string

返回值

内部外观::setResolvedInstance

InnerFacade::setResolvedInstance( string name, object instance ): void

参数

参数	类型	描述
name	string
instance	object

返回值

内部外观::getContainer

InnerFacade::getContainer(  ): \NGSOFT\Container\ContainerInterface

返回值

内部外观::setContainer

InnerFacade::setContainer( \NGSOFT\Container\ContainerInterface container ): void

参数

参数	类型	描述
container	\NGSOFT\Container\ContainerInterface

返回值

JsonObject

一个与json文件并发同步数据的Json对象

• 全名：\NGSOFT\DataStructure\JsonObject
• 父类：\NGSOFT\DataStructure\SimpleObject

JsonObject::fromJsonFile

JsonObject::fromJsonFile( string filename, bool recursive = true ): static

• 此方法为 静态。 参数:

参数	类型	描述
文件名	string
recursive	bool

返回值

锁

• 全名：\NGSOFT\Facades\Lock
• 父类: \NGSOFT\Facades\Facade

Lock::createFileLock

创建一个PHP文件锁

Lock::createFileLock( string name, int seconds, string owner = '', string rootpath = '' ): \NGSOFT\Lock\FileLock

• 此方法为 静态。 参数:

参数	类型	描述
name	string
seconds	int
owner	string
rootpath	string

返回值

Lock::createFileSystemLock

Lock::createFileSystemLock( string|\NGSOFT\Filesystem\File file, int seconds, string owner = '' ): \NGSOFT\Lock\FileSystemLock

• 此方法为 静态。 参数:

参数	类型	描述
文件	字符串|\NGSOFT\Filesystem\File
seconds	int
owner	string

返回值

Lock::createSQLiteLock

创建一个SQLite锁

Lock::createSQLiteLock( string name, int seconds, string owner = '', string dbname = 'sqlocks.db3', string table = 'locks' ): \NGSOFT\Lock\SQLiteLock

• 此方法为 静态。 参数:

参数	类型	描述
name	string
seconds	int
owner	string
dbname	string
table	string

返回值

Lock::createNoLock

创建一个NoLock

Lock::createNoLock( string name, int seconds, string owner = '' ): \NGSOFT\Lock\NoLock

• 此方法为 静态。 参数:

参数	类型	描述
name	string
seconds	int
owner	string

返回值

Lock::createCacheLock

使用PSR-6缓存创建锁

Lock::createCacheLock( \Psr\Cache\CacheItemPoolInterface cache, string name, int seconds, string owner = '' ): \NGSOFT\Lock\CacheLock

• 此方法为 静态。 参数:

参数	类型	描述
cache	\Psr\Cache\CacheItemPoolInterface
name	string
seconds	int
owner	string

返回值

Lock::createSimpleCacheLock

使用PSR-16缓存创建锁

Lock::createSimpleCacheLock( \Psr\SimpleCache\CacheInterface cache, string name, int seconds, string owner = '' ): \NGSOFT\Lock\SimpleCacheLock

• 此方法为 静态。 参数:

参数	类型	描述
cache	\Psr\SimpleCache\CacheInterface
name	string
seconds	int
owner	string

返回值

LockFactory

• 全名：\NGSOFT\Lock\LockFactory

LockFactory::__construct

LockFactory::__construct( mixed rootpath = '', int|float seconds, string owner = '' ): mixed

参数

参数	类型	描述
rootpath	mixed
seconds	int|float
owner	string

返回值

LockFactory::createFileLock

创建一个PHP文件锁

LockFactory::createFileLock( string name, int seconds, string owner = '', string rootpath = '' ): \NGSOFT\Lock\FileLock

参数

参数	类型	描述
name	string
seconds	int
owner	string
rootpath	string

返回值

LockFactory::createFileSystemLock

在提供的文件所在的同一目录中创建一个.lock文件

LockFactory::createFileSystemLock( string|\NGSOFT\Filesystem\File file, int seconds, string owner = '' ): \NGSOFT\Lock\FileSystemLock

参数

参数	类型	描述
文件	字符串|\NGSOFT\Filesystem\File
seconds	int
owner	string

返回值

LockFactory::createSQLiteLock

创建一个SQLite锁

LockFactory::createSQLiteLock( string name, int seconds, string owner = '', string dbname = 'sqlocks.db3', string table = 'locks' ): \NGSOFT\Lock\SQLiteLock

参数

参数	类型	描述
name	string
seconds	int
owner	string
dbname	string
table	string

返回值

LockFactory::createNoLock

创建一个NoLock

LockFactory::createNoLock( string name, int seconds, string owner = '' ): \NGSOFT\Lock\NoLock

参数

参数	类型	描述
name	string
seconds	int
owner	string

返回值

LockFactory::createCacheLock

使用PSR-6缓存创建锁

LockFactory::createCacheLock( \Psr\Cache\CacheItemPoolInterface cache, string name, int seconds, string owner = '' ): \NGSOFT\Lock\CacheLock

参数

参数	类型	描述
cache	\Psr\Cache\CacheItemPoolInterface
name	string
seconds	int
owner	string

返回值

LockFactory::createSimpleCacheLock

使用PSR-16缓存创建锁

LockFactory::createSimpleCacheLock( \Psr\SimpleCache\CacheInterface cache, string name, int seconds, string owner = '' ): \NGSOFT\Lock\SimpleCacheLock

参数

参数	类型	描述
cache	\Psr\SimpleCache\CacheInterface
name	string
seconds	int
owner	string

返回值

LockServiceProvider

• 全名：\NGSOFT\Lock\LockServiceProvider
• 该类实现：\NGSOFT\Container\ServiceProvider

LockServiceProvider::provides

获取提供者提供的所有服务。

LockServiceProvider::provides(  ): string[]

返回值

LockServiceProvider::register

将服务注册到容器中

LockServiceProvider::register( \NGSOFT\Container\ContainerInterface container ): void

参数

参数	类型	描述
container	\NGSOFT\Container\ContainerInterface

返回值

LockTimeout

• 全名：\NGSOFT\Lock\LockTimeout
• 父类

日志记录器

• 全名：\NGSOFT\Facades\Logger
• 父类: \NGSOFT\Facades\Facade

Logger::log

以任意级别记录。

Logger::log( mixed level, string|\Stringable message, array context = [] ): void

• 此方法为 静态。 参数:

参数	类型	描述
level	mixed
message	string|\Stringable
context	array

返回值

Logger::emergency

系统不可用。

Logger::emergency( string|\Stringable message, array context = [] ): void

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::alert

必须立即采取行动。

Logger::alert( string|\Stringable message, array context = [] ): void

示例：整个网站关闭，数据库不可用等。这将触发短信警报并唤醒您。

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::critical

临界条件。

Logger::critical( string|\Stringable message, array context = [] ): void

示例：应用程序组件不可用，意外异常。

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::error

不需要立即采取行动的运行时错误，但通常应该记录和监控。

Logger::error( string|\Stringable message, array context = [] ): void

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::warning

不是错误的异常事件。

Logger::warning( string|\Stringable message, array context = [] ): void

示例：使用已弃用的API，API使用不当，不一定是错误的不理想行为。

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::notice

正常但重要的事件。

Logger::notice( string|\Stringable message, array context = [] ): void

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::info

有趣的事件。

Logger::info( string|\Stringable message, array context = [] ): void

示例：用户登录，SQL日志。

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

Logger::debug

详细的调试信息。

Logger::debug( string|\Stringable message, array context = [] ): void

• 此方法为 静态。 参数:

参数	类型	描述
message	string|\Stringable
context	array

返回值

LoggerAwareResolver

注入Logger

• 全名：\NGSOFT\Container\Resolvers\LoggerAwareResolver
• 父类：\NGSOFT\Container\Resolvers\ContainerResolver

LoggerAwareResolver::resolve

从容器中解析条目

LoggerAwareResolver::resolve( mixed value ): mixed

参数

参数	类型	描述
value	mixed

返回值

LoggerAwareResolver::getDefaultPriority

设置默认优先级

LoggerAwareResolver::getDefaultPriority(  ): int

返回值

映射

Map对象包含键值对，并记住键的原始插入顺序。

任何值（包括对象和原始值）都可以用作键或值。

• 全名：\NGSOFT\DataStructure\Map
• 该类实现：\ArrayAccess, \NGSOFT\DataStructure\ReversibleIterator, \Stringable, \JsonSerializable

另请参阅

• https://mdn.org.cn/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map - JS Map

Map::clear

clear()方法从Map对象中删除所有元素。

Map::clear(  ): void

返回值

Map::delete

delete()方法通过键从Map对象中删除指定的元素。

Map::delete( mixed key ): bool

参数

参数	类型	描述
key	mixed

返回值

Map::get

get()方法从Map对象中返回指定的元素。

Map::get( mixed key ): mixed

如果与提供的键关联的值是对象，则将获得对该对象的引用，并且对那个对象所做的任何更改将有效地修改Map对象内的对象。

参数

参数	类型	描述
key	mixed

返回值

Map::search

search()方法从值返回第一个匹配的键。

Map::search( mixed value ): mixed

参数

参数	类型	描述
value	mixed

返回值

Map::set

set()方法向Map对象添加或更新一个具有指定键和值的元素。

Map::set( mixed key, mixed value ): static

参数

参数	类型	描述
key	mixed
value	mixed

返回值

Map::add

add()方法如果Map对象中不存在，则向Map对象添加一个具有指定键和值的元素。

Map::add( mixed key, mixed value ): static

参数

参数	类型	描述
key	mixed
value	mixed

返回值

Map::has

has()方法返回一个布尔值，指示是否存在具有指定键的元素。

Map::has( mixed key ): bool

参数

参数	类型	描述
key	mixed

返回值

Map::keys

keys()方法返回一个新的迭代器对象，它包含Map对象中每个元素的键，按插入顺序。

Map::keys( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

Map::values

values()方法返回一个新的迭代器对象，它包含Map对象中每个元素的值，按插入顺序。

Map::values( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

Map::entries

entries()方法返回一个新的迭代器对象，它包含Map对象中每个元素的[key, value]对，按插入顺序。

Map::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

Map::forEach

forEach()方法按插入顺序对Map对象中的每个键/值对执行提供的函数一次。

Map::forEach( callable callable ): void

参数

参数	类型	描述
callable	callable

返回值

Map::offsetExists

{@inheritdoc}

Map::offsetExists( mixed offset ): bool

参数

参数	类型	描述
偏移量	mixed

返回值

Map::offsetGet

{@inheritdoc}

Map::offsetGet( mixed offset ): mixed

参数

参数	类型	描述
偏移量	mixed

返回值

Map::offsetSet

{@inheritdoc}

Map::offsetSet( mixed offset, mixed value ): void

参数

参数	类型	描述
偏移量	mixed
value	mixed

返回值

Map::offsetUnset

{@inheritdoc}

Map::offsetUnset( mixed offset ): void

参数

参数	类型	描述
偏移量	mixed

返回值

Map::count

{@inheritdoc}

Map::count(  ): int

返回值

Map::jsonSerialize

{@inheritdoc}

Map::jsonSerialize(  ): mixed

返回值

Map::__debugInfo

{@inheritdoc}

Map::__debugInfo(  ): array

返回值

Map::__serialize

{@inheritdoc}

Map::__serialize(  ): array

返回值

Map::__unserialize

{@inheritdoc}

Map::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

Map::__clone

{@inheritdoc}

Map::__clone(  ): void

返回值

NoLock

NullLock

• 全名：\NGSOFT\Lock\NoLock
• 父类：\NGSOFT\Lock\BaseLockStore

NoLock::acquire

获取锁。

NoLock::acquire(  ): bool

返回值

NoLock::forceRelease

{@inheritdoc}

NoLock::forceRelease(  ): void

返回值

NoLock::isAcquired

返回锁是否已被获取。

NoLock::isAcquired(  ): bool

返回值

NoLock::release

释放锁。

NoLock::release(  ): bool

返回值

如果未获取锁或未拥有锁则为假

NotFound

• 全名：\NGSOFT\Container\Exceptions\NotFound
• 父类: \NGSOFT\Container\Exceptions\ContainerError
• 该类实现：\Psr\Container\NotFoundExceptionInterface

NotFound::for

NotFound::for( string id, \Throwable previous = null ): static

• 此方法为 静态。 参数:

参数	类型	描述
id	string
previous	\Throwable

返回值

NullServiceProvider

• 全名：\NGSOFT\Container\NullServiceProvider
• 该类实现：\NGSOFT\Container\ServiceProvider

NullServiceProvider::__construct

NullServiceProvider::__construct( string|array provides = [] ): mixed

参数

参数	类型	描述
provides	string|array

返回值

NullServiceProvider::provides

获取提供者提供的所有服务。

NullServiceProvider::provides(  ): string[]

返回值

NullServiceProvider::register

将服务注册到容器中

NullServiceProvider::register( \NGSOFT\Container\ContainerInterface container ): void

参数

参数	类型	描述
container	\NGSOFT\Container\ContainerInterface

返回值

OwnedList

模拟数据库中的一对多关系

• 全名：\NGSOFT\DataStructure\OwnedList
• 该类实现：\Stringable, \NGSOFT\DataStructure\ReversibleIterator, \JsonSerializable, \ArrayAccess

OwnedList::create

为给定值创建一个新的OwnedList

OwnedList::create( int|float|string|object value ): static

• 此方法为 静态。 参数:

参数	类型	描述
value	int|float|string|object

返回值

OwnedList::__construct

OwnedList::__construct( int|float|string|object value ): mixed

参数

参数	类型	描述
value	int|float|string|object

返回值

OwnedList::add

在当前值和给定值之间添加关系

OwnedList::add( int|float|string|object value ): static

参数

参数	类型	描述
value	int|float|string|object

返回值

OwnedList::delete

删除当前值和给定值之间的关系

OwnedList::delete( int|float|string|object value ): bool

参数

参数	类型	描述
value	int|float|string|object

返回值

OwnedList::has

检查当前值和给定值之间是否存在关系

OwnedList::has( int|float|string|object value ): bool

参数

参数	类型	描述
value	int|float|string|object

返回值

OwnedList::clear

删除所有关系

OwnedList::clear(  ): void

返回值

OwnedList::entries

迭代条目

OwnedList::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): \Generator

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

OwnedList::values

迭代所有拥有的值

OwnedList::values(  ): \Generator

返回值

OwnedList::count

{@inheritdoc}

OwnedList::count(  ): int

返回值

OwnedList::offsetExists

OwnedList::offsetExists( mixed offset ): bool

参数

参数	类型	描述
偏移量	mixed

返回值

OwnedList::offsetGet

OwnedList::offsetGet( mixed offset ): mixed

参数

参数	类型	描述
偏移量	mixed

返回值

OwnedList::offsetSet

OwnedList::offsetSet( mixed offset, mixed value ): void

参数

参数	类型	描述
偏移量	mixed
value	mixed

返回值

OwnedList::offsetUnset

OwnedList::offsetUnset( mixed offset ): void

参数

参数	类型	描述
偏移量	mixed

返回值

OwnedList::jsonSerialize

{@inheritdoc}

OwnedList::jsonSerialize(  ): mixed

返回值

OwnedList::__debugInfo

{@inheritdoc}

OwnedList::__debugInfo(  ): array

返回值

OwnedList::__serialize

{@inheritdoc}

OwnedList::__serialize(  ): array

返回值

OwnedList::__unserialize

{@inheritdoc}

OwnedList::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

OwnedList::__clone

{@inheritdoc}

OwnedList::__clone(  ): void

返回值

ParameterResolver

• 全名：\NGSOFT\Container\ParameterResolver

ParameterResolver::__construct

ParameterResolver::__construct( \NGSOFT\Container\ContainerInterface container ): mixed

参数

参数	类型	描述
container	\NGSOFT\Container\ContainerInterface

返回值

ParameterResolver::canResolve

ParameterResolver::canResolve( string id, mixed value ): bool

参数

参数	类型	描述
id	string
value	mixed

返回值

ParameterResolver::resolve

ParameterResolver::resolve( string|array|object callable, array providedParameters = [] ): mixed

参数

参数	类型	描述
callable	字符串|数组|对象
提供的参数	array

返回值

PrioritySet

优先级集合是一种按优先级排序的集合

• 全名：\NGSOFT\DataStructure\PrioritySet
• 此类实现：\Countable, \JsonSerializable, \Stringable, \IteratorAggregate

PrioritySet::create

创建一个新的集合

PrioritySet::create(  ): static

• 此方法为 静态。

返回值

PrioritySet::add

add()方法通过指定的优先级添加一个新的元素。

PrioritySet::add( mixed value, int|\NGSOFT\DataStructure\Priority priority = Priority::MEDIUM ): static

参数

参数	类型	描述
value	mixed
priority	int|\NGSOFT\DataStructure\Priority	> 0 数字越大，优先级越高

返回值

PrioritySet::getPriority

PrioritySet::getPriority( mixed value ): int

参数

参数	类型	描述
value	mixed

返回值

PrioritySet::clear

clear()方法从Set对象中删除所有元素。

PrioritySet::clear(  ): void

返回值

PrioritySet::delete

delete()方法如果Set对象中存在指定的值，则从Set对象中删除指定的值。

PrioritySet::delete( mixed value ): bool

参数

参数	类型	描述
value	mixed

返回值

PrioritySet::entries

entries()方法返回一个新的Iterator对象，它包含Set对象中每个元素的[value, value]数组，按照插入顺序。

PrioritySet::entries( \NGSOFT\DataStructure\Sort sort = Sort::DESC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

PrioritySet::forEach

forEach()方法为Set对象中的每个值执行提供的函数一次，按照插入顺序。

PrioritySet::forEach( callable callable ): void

参数

参数	类型	描述
callable	callable	($value,$value, Set)

返回值

PrioritySet::has

has()方法返回一个布尔值，指示Set对象中是否存在具有指定值的元素。

PrioritySet::has( mixed value ): bool

参数

参数	类型	描述
value	mixed

返回值

PrioritySet::isEmpty

检查集合是否为空

PrioritySet::isEmpty(  ): bool

返回值

PrioritySet::values

values()方法返回一个新的Iterator对象，它包含Set对象中每个元素的值，按照插入顺序。

PrioritySet::values( \NGSOFT\DataStructure\Sort sort = Sort::DESC ): \Generator

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

PrioritySet::count

{@inheritdoc}

PrioritySet::count(  ): int

返回值

PrioritySet::getIterator

{@inheritdoc}

PrioritySet::getIterator(  ): \Traversable

返回值

PrioritySet::jsonSerialize

{@inheritdoc}

PrioritySet::jsonSerialize(  ): mixed

返回值

PrioritySet::__debugInfo

{@inheritdoc}

PrioritySet::__debugInfo(  ): array

返回值

PrioritySet::__serialize

PrioritySet::__serialize(  ): array

返回值

PrioritySet::__unserialize

PrioritySet::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

PrioritySet::__clone

{@inheritdoc}

PrioritySet::__clone(  ): void

返回值

Range

返回一个数字序列，默认从0开始，默认递增1，并在指定的数字之前停止。

• 全名：\NGSOFT\DataStructure\Range
• 此类实现：\NGSOFT\DataStructure\ReversibleIterator, \Stringable

Range::__construct

Range::__construct( int start, ?int stop = null, int step = 1 ): mixed

参数

参数	类型	描述
起始值	int
结束值	?int
步长	int

返回值

Range::create

创建一个Range

Range::create( int start, ?int stop = null, int step = 1 ): static

• 此方法为 静态。 参数:

参数	类型	描述
起始值	int
结束值	?int
步长	int

返回值

Range::of

获取一个可计数对象的范围

Range::of( \Countable|array countable ): static

• 此方法为 静态。 参数:

参数	类型	描述
可计数	\Countable|array

返回值

Range::__debugInfo

Range::__debugInfo(  ): array

返回值

Range::__toString

Range::__toString(  ): string

返回值

Range::isEmpty

检查是否为空范围

Range::isEmpty(  ): bool

返回值

Range::count

Range::count(  ): int

返回值

Range::entries

按排序顺序迭代条目

Range::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

RegExp

• 全名：\NGSOFT\RegExp
• 此类实现：\Stringable, \JsonSerializable

RegExp::create

初始化RegExp

RegExp::create( string pattern, string|string[] flags = '' ): static

• 此方法为 静态。 参数:

参数	类型	描述
pattern	string	完整的模式或没有分隔符和修饰符的模式
flags	string|string[]	修饰符

返回值

RegExp::__construct

初始化RegExp

RegExp::__construct( string pattern, string|string[] flags = '' ): mixed

参数

参数	类型	描述
pattern	string	完整的模式或没有分隔符和修饰符的模式
flags	string|string[]	修饰符

返回值

另请参阅

• https://mdn.org.cn/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp - 与之相同，只是模式是一个字符串

RegExp::getLastIndex

获取最后一个索引

RegExp::getLastIndex(  ): int

返回值

RegExp::setLastIndex

设置最后一个索引

RegExp::setLastIndex( int index ): static

参数

参数	类型	描述
索引	int

返回值

RegExp::test

test()方法在正则表达式和指定的字符串之间执行搜索，以查找匹配项。

RegExp::test( string str ): bool

参数

参数	类型	描述
字符串	string

返回值

RegExp::exec

exec()方法在指定的字符串中执行搜索以查找匹配项。返回一个结果数组，或null。

RegExp::exec( string str ): array|null

只返回第一个结果。如果设置了全局标志，则上一个匹配的最后索引将被存储，因此可以循环遍历结果（while循环）。

参数

参数	类型	描述
字符串	string	用于与正则表达式匹配的字符串

返回值

如果匹配失败，exec()方法返回null，并将lastIndex设置为0。

RegExp::replace

replace()方法将字符串中此模式的一些或所有匹配项替换为替换项，并返回替换结果的字符串。

RegExp::replace( string str, string|\Stringable|callable replacement ): string

如果使用全局修饰符，则替换所有匹配项，否则只替换第一个匹配项。

参数

参数	类型	描述
字符串	string
替换项	string|\Stringable|callable

返回值

RegExp::search

search()方法在正则表达式和字符串之间执行搜索以查找匹配项。

RegExp::search( string str ): int

参数

参数	类型	描述
字符串	string

返回值

正则表达式与给定字符串之间第一次匹配的索引，如果没有找到匹配项则返回-1。

RegExp::split

split() 方法将一个字符串分割成一个有序的子字符串列表，

RegExp::split( string str, int limit = -1 ): array

参数

参数	类型	描述
字符串	string
限制	int

返回值

RegExp::matchAll

matchAll() 方法返回一个迭代器，包含所有与正则表达式匹配的结果，包括捕获组。

RegExp::matchAll( string str ): \Traversable

参数

参数	类型	描述
字符串	string

返回值

RegExp::match

match() 方法检索字符串与正则表达式匹配的结果。

RegExp::match( string str ): array|null

参数

参数	类型	描述
字符串	string

返回值

RegExp::__unserialize

{@inheritdoc}

RegExp::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

RegExp::__serialize

{@inheritdoc}

RegExp::__serialize(  ): array

返回值

RegExp::jsonSerialize

{@inheritdoc}

RegExp::jsonSerialize(  ): mixed

返回值

RegExp::__toString

{@inheritdoc}

RegExp::__toString(  ): string

返回值

RegExp::__debugInfo

RegExp::__debugInfo(  ): array

返回值

RegExpException

• 全名：\NGSOFT\Exceptions\RegExpException
• 父类

RegExpException::__construct

RegExpException::__construct( \NGSOFT\RegExp regExp, string message = "", int code, \Throwable previous = null ): mixed

参数

参数	类型	描述
正则表达式	\NGSOFT\RegExp
message	string
代码	int
previous	\Throwable

返回值

RegExpException::getRegExp

获取 RegExp 对象

RegExpException::getRegExp(  ): \NGSOFT\RegExp

返回值

ResolverException

• 全名：\NGSOFT\Container\Exceptions\ResolverException
• 父类: \NGSOFT\Container\Exceptions\ContainerError

ResolverException::notTwice

ResolverException::notTwice( object resolver ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
resolver	object

返回值

ResolverException::invalidCallable

ResolverException::invalidCallable( mixed callable ): static

• 此方法为 静态。 参数:

参数	类型	描述
callable	mixed

返回值

Set

Set 对象允许您存储任何类型的唯一值，无论是原始值还是对象引用。

• 全名：\NGSOFT\DataStructure\Set
• 此类实现：\NGSOFT\DataStructure\ReversibleIterator, \JsonSerializable, \Stringable

Set::create

创建一个新的集合

Set::create(  ): static

• 此方法为 静态。

返回值

Set::add

add() 方法将具有指定值的新的元素追加到 Set 对象的末尾。

Set::add( mixed value ): static

参数

参数	类型	描述
value	mixed

返回值

Set::clear

clear()方法从Set对象中删除所有元素。

Set::clear(  ): void

返回值

Set::delete

delete()方法如果Set对象中存在指定的值，则从Set对象中删除指定的值。

Set::delete( mixed value ): bool

参数

参数	类型	描述
value	mixed

返回值

Set::entries

entries()方法返回一个新的Iterator对象，它包含Set对象中每个元素的[value, value]数组，按照插入顺序。

Set::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

Set::has

has()方法返回一个布尔值，指示Set对象中是否存在具有指定值的元素。

Set::has( mixed value ): bool

参数

参数	类型	描述
value	mixed

返回值

Set::isEmpty

检查集合是否为空

Set::isEmpty(  ): bool

返回值

Set::values

values()方法返回一个新的Iterator对象，它包含Set对象中每个元素的值，按照插入顺序。

Set::values( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

Set::count

{@inheritdoc}

Set::count(  ): int

返回值

Set::getIterator

{@inheritdoc}

Set::getIterator(  ): \Traversable

返回值

Set::jsonSerialize

{@inheritdoc}

Set::jsonSerialize(  ): mixed

返回值

Set::__debugInfo

{@inheritdoc}

Set::__debugInfo(  ): array

返回值

Set::__serialize

Set::__serialize(  ): array

返回值

Set::__unserialize

Set::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

Set::__clone

{@inheritdoc}

Set::__clone(  ): void

返回值

SharedList

模拟数据库中找到的多对多关系

• 全名：\NGSOFT\DataStructure\SharedList
• 此类实现：\Countable, \IteratorAggregate, \JsonSerializable, \Stringable

另请参阅

• https://en.wikipedia.org/wiki/Many-to-many_(data_model) -

SharedList::create

创建一个新的 SharedList

SharedList::create(  ): static

• 此方法为 静态。

返回值

SharedList::clear

SharedList::clear(  ): void

返回值

SharedList::hasValue

检查值是否存在于集合中

SharedList::hasValue( int|float|string|object value ): bool

参数

参数	类型	描述
value	int|float|string|object

返回值

SharedList::has

检查两个值之间是否存在关系

SharedList::has( int|float|string|object value, int|float|string|object sharedValue ): bool

参数

参数	类型	描述
value	int|float|string|object
共享值	int|float|string|object

返回值

SharedList::add

在两个值之间添加关系

SharedList::add( int|float|string|object value, int|float|string|object sharedValue ): static

参数

参数	类型	描述
value	int|float|string|object
共享值	int|float|string|object

返回值

SharedList::deleteValue

删除一个值及其所有关系

SharedList::deleteValue( int|float|string|object value ): static

参数

参数	类型	描述
value	int|float|string|object

返回值

SharedList::delete

删除两个值之间的关系

SharedList::delete( int|float|string|object value, int|float|string|object sharedValue ): static

参数

参数	类型	描述
value	int|float|string|object
共享值	int|float|string|object

返回值

SharedList::get

获取共享列表的值

SharedList::get( int|float|string|object value ): \NGSOFT\DataStructure\Set

参数

参数	类型	描述
value	int|float|string|object

返回值

SharedList::entries

迭代所有共享列表的值

SharedList::entries(  ): iterable

返回值

SharedList::count

SharedList::count(  ): int

返回值

SharedList::getIterator

SharedList::getIterator(  ): \Traversable

返回值

SharedList::jsonSerialize

SharedList::jsonSerialize(  ): mixed

返回值

SharedList::__serialize

SharedList::__serialize(  ): array

返回值

SharedList::__unserialize

SharedList::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

SharedList::__debugInfo

SharedList::__debugInfo(  ): array

返回值

SimpleArray

一个基础集合

• 全名：\NGSOFT\DataStructure\SimpleArray
• 父类：\NGSOFT\DataStructure\Collection

SimpleArray::unshift

将一个或多个元素添加到数组的开始位置

SimpleArray::unshift( mixed values ): int

参数

参数	类型	描述
值	mixed

返回值

SimpleArray::push

将一个或多个元素追加到数组的末尾

SimpleArray::push( mixed values ): int

参数

参数	类型	描述
值	mixed

返回值

SimpleArray::shift

从数组的开始位置移除一个元素

SimpleArray::shift(  ): mixed

返回值

被移除的元素

SimpleArray::pop

从数组的末尾移除一个元素

SimpleArray::pop(  ): mixed

返回值

被移除的元素

SimpleArray::indexOf

返回值索引

SimpleArray::indexOf( mixed value ): int

参数

参数	类型	描述
value	mixed

返回值

索引或未找到时为-1

SimpleCacheLock

使用 SimpleCache 管理您的锁

• 全名：\NGSOFT\Lock\SimpleCacheLock
• 父类: \NGSOFT\Lock\CacheLockAbstract

SimpleCacheLock::__construct

SimpleCacheLock::__construct( \Psr\SimpleCache\CacheInterface cache, string|\Stringable name, int|float seconds, string|\Stringable owner = '', bool autoRelease = true ): mixed

参数

参数	类型	描述
cache	\Psr\SimpleCache\CacheInterface
name	string|\Stringable
seconds	int|float
owner	string|\Stringable
autoRelease	bool

返回值

SimpleCacheLock::forceRelease

{@inheritdoc}

SimpleCacheLock::forceRelease(  ): void

返回值

SimpleIterator

SimpleIterator 可以按任何顺序迭代任何内容

• 全名：\NGSOFT\DataStructure\SimpleIterator
• 此类实现：\NGSOFT\DataStructure\ReversibleIterator

SimpleIterator::__construct

SimpleIterator::__construct( iterable iterator ): mixed

参数

参数	类型	描述
迭代器	iterable

返回值

SimpleIterator::of

创建一个新的 SimpleIterator

SimpleIterator::of( iterable iterable ): static

• 此方法为 静态。 参数:

参数	类型	描述
iterable	iterable

返回值

SimpleIterator::ofStringable

创建一个迭代每个字符的新 SimpleIterator

SimpleIterator::ofStringable( string|\Stringable value ): static

• 此方法为 静态。 参数:

参数	类型	描述
value	string|\Stringable

返回值

SimpleIterator::ofList

从列表创建迭代器

SimpleIterator::ofList( iterable&\ArrayAccess&\Countable value ): static

• 此方法为 静态。 参数:

参数	类型	描述
value	iterable&\ArrayAccess&\Countable

返回值

SimpleIterator::count

SimpleIterator::count(  ): int

返回值

SimpleIterator::entries

按排序顺序迭代条目

SimpleIterator::entries( \NGSOFT\DataStructure\Sort sort = Sort::ASC ): iterable

参数

参数	类型	描述
sort	\NGSOFT\DataStructure\Sort

返回值

SimpleObject

一个基础集合

• 全名：\NGSOFT\DataStructure\SimpleObject
• 父类：\NGSOFT\DataStructure\Collection

SimpleObject::search

在数组中搜索给定的值，如果成功返回第一个相应的键

SimpleObject::search( mixed value ): int|string|null

参数

参数	类型	描述
value	mixed

返回值

SimpleObject::__get

{@inheritdoc}

SimpleObject::__get( string name ): mixed

参数

参数	类型	描述
name	string

返回值

SimpleObject::__set

{@inheritdoc}

SimpleObject::__set( string name, mixed value ): void

参数

参数	类型	描述
name	string
value	mixed

返回值

SimpleObject::__unset

{@inheritdoc}

SimpleObject::__unset( string name ): void

参数

参数	类型	描述
name	string

返回值

SimpleObject::__isset

{@inheritdoc}

SimpleObject::__isset( string name ): bool

参数

参数	类型	描述
name	string

返回值

SimpleServiceProvider

• 全名：\NGSOFT\Container\SimpleServiceProvider
• 该类实现：\NGSOFT\Container\ServiceProvider

SimpleServiceProvider::__construct

SimpleServiceProvider::__construct( string|array provides, mixed register ): mixed

参数

参数	类型	描述
provides	string|array
注册	mixed

返回值

SimpleServiceProvider::provides

获取提供者提供的所有服务。

SimpleServiceProvider::provides(  ): string[]

返回值

SimpleServiceProvider::register

将服务注册到容器中

SimpleServiceProvider::register( \NGSOFT\Container\ContainerInterface container ): void

参数

参数	类型	描述
container	\NGSOFT\Container\ContainerInterface

返回值

Slice

• 全名：\NGSOFT\DataStructure\Slice
• 该类实现：\Stringable

Slice::create

创建 Slice 实例

Slice::create( ?int start = null, ?int stop = null, ?int step = null ): static

• 此方法为 静态。 参数:

参数	类型	描述
起始值	?int
结束值	?int
步长	?int

返回值

Slice::of

使用 Python 切片符号创建 Slice 实例

Slice::of( string slice ): static

• 此方法为 静态。 参数:

参数	类型	描述
切片	string

返回值

另请参阅

• https://www.bestprog.net/en/2019/12/07/python-strings-access-by-indexes-slices-get-a-fragment-of-a-string-examples/ - 例如 ':' '::' '0:1:' '10:2:-1' '1:'

Slice::isValid

检查是否是有效的切片语法

Slice::isValid( string slice ): bool

• 此方法为 静态。 参数:

参数	类型	描述
切片	string

返回值

Slice::__construct

Slice::__construct( ?int start = null, ?int stop = null, ?int step = null ): mixed

参数

参数	类型	描述
起始值	?int
结束值	?int
步长	?int

返回值

Slice::getStart

Slice::getStart(  ): ?int

返回值

Slice::getStop

Slice::getStop(  ): ?int

返回值

Slice::getStep

Slice::getStep(  ): ?int

返回值

Slice::getIteratorFor

Slice::getIteratorFor( array&\ArrayAccess&\Countable value ): \Traversable<int>

参数

参数	类型	描述
value	array&\ArrayAccess&\Countable

返回值

Slice::getOffsetList

Slice::getOffsetList( array&\ArrayAccess&\Countable value ): int[]

参数

参数	类型	描述
value	array&\ArrayAccess&\Countable

返回值

Slice::slice

返回数组对象的一个切片

Slice::slice( array&\ArrayAccess&\Countable value ): array

参数

参数	类型	描述
value	array&\ArrayAccess&\Countable

返回值

Slice::join

返回一个切片的字符串

Slice::join( mixed glue, mixed value ): string

参数

参数	类型	描述
粘合剂	mixed
value	mixed

返回值

Slice::__debugInfo

Slice::__debugInfo(  ): array

返回值

Slice::__toString

Slice::__toString(  ): string

返回值

SQLiteLock

一个 SQLite 数据库来管理您的锁

• 全名：\NGSOFT\Lock\SQLiteLock
• 父类：\NGSOFT\Lock\BaseLockStore

SQLiteLock::__construct

SQLiteLock::__construct( string|\Stringable name, int|float seconds, string|\PDO database = '', string|\Stringable owner = '', bool autoRelease = true, string table = 'locks' ): mixed

参数

参数	类型	描述
name	string|\Stringable	锁名
seconds	int|float	锁持续时间
数据库	string|\PDO	db3文件名或pdo实例
owner	string|\Stringable	锁的所有者
autoRelease	bool	当对象被销毁时释放锁
table	string	用于锁的表名

返回值

SQLiteLock::forceRelease

{@inheritdoc}

SQLiteLock::forceRelease(  ): void

返回值

StackableContainer

• 全名：\NGSOFT\Container\StackableContainer
• 此类实现：\Psr\Container\ContainerInterface, \Stringable

StackableContainer::__construct

StackableContainer::__construct( \Psr\Container\ContainerInterface|array containers ): mixed

参数

参数	类型	描述
容器	\Psr\Container\ContainerInterface|array

返回值

StackableContainer::hasContainer

检查容器是否已经堆叠

StackableContainer::hasContainer( \Psr\Container\ContainerInterface container ): bool

参数

参数	类型	描述
container	\Psr\Container\ContainerInterface

返回值

StackableContainer::addContainer

在顶部堆叠一个新的容器

StackableContainer::addContainer( \Psr\Container\ContainerInterface container ): void

参数

参数	类型	描述
container	\Psr\Container\ContainerInterface

返回值

StackableContainer::get

{@inheritdoc}

StackableContainer::get( string id ): mixed

参数

参数	类型	描述
id	string

返回值

StackableContainer::has

{@inheritdoc}

StackableContainer::has( string id ): bool

参数

参数	类型	描述
id	string

返回值

状态

基本枚举类支持（Polyfill）将类常量添加到作为php 8.1支持的枚举情况

• 全名：\NGSOFT\Timer\State
• 父类：\NGSOFT\Enums\Enum

StopWatch

• 全名：\NGSOFT\Timer\StopWatch

StopWatch::startTask

启动一个可调用函数并返回结果时间

StopWatch::startTask( callable task, mixed arguments ): \NGSOFT\Timer\StopWatchResult

• 此方法为 静态。 参数:

参数	类型	描述
任务	callable
参数	mixed

返回值

StopWatch::startTaskWithStartTime

StopWatch::startTaskWithStartTime( mixed task, int|float startTime, bool highResolution = false ): static

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed
开始时间	int|float
高精度	bool

返回值

StopWatch::__construct

StopWatch::__construct( mixed|callable task = self::DEFAULT_TASK, bool highResolution = true ): mixed

参数

参数	类型	描述
任务	mixed|callable	可以是任何东西
高精度	bool	如果为True，则使用可用的hrtime()，否则使用microtime()

返回值

StopWatch::getTask

StopWatch::getTask(  ): mixed

返回值

StopWatch::executeTask

StopWatch::executeTask( array arguments = [] ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
参数	array

返回值

StopWatch::start

开始时钟

StopWatch::start( int|float|null startTime = null ): bool

参数

参数	类型	描述
开始时间	int|float|null	设置开始时间

返回值

StopWatch::resume

恢复时钟（仅当暂停时）

StopWatch::resume(  ): bool

返回值

StopWatch::reset

重置时钟

StopWatch::reset(  ): void

返回值

StopWatch::pause

暂停时钟

StopWatch::pause( ?bool &success = null ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
success	?bool	如果操作成功则为True

返回值

当前时间

StopWatch::stop

停止时钟

StopWatch::stop( ?bool &success = null ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
success	?bool	如果操作成功则为True

返回值

当前时间

StopWatch::read

读取时钟

StopWatch::read(  ): \NGSOFT\Timer\StopWatchResult

返回值

StopWatch::getLaps

StopWatch::getLaps(  ): \Generator|\NGSOFT\Timer\StopWatchResult[]

返回值

StopWatch::lap

添加圈数时间

StopWatch::lap( ?string label = null ): bool

参数

参数	类型	描述
标签	?string

返回值

StopWatch::isStarted

StopWatch::isStarted(  ): bool

返回值

StopWatch::isPaused

StopWatch::isPaused(  ): bool

返回值

StopWatch::isStopped

StopWatch::isStopped(  ): bool

返回值

文本

将标量转换为它的可字符串表示形式

• 全名：\NGSOFT\DataStructure\Text
• 此类实现：\Stringable, \Countable, \ArrayAccess, \JsonSerializable

Text::create

创建新的文本

Text::create( mixed text ): static

• 此方法为 静态。 参数:

参数	类型	描述
文本	mixed

返回值

Text::of

创建新的文本

Text::of( mixed text ): static

• 此方法为 静态。 参数:

参数	类型	描述
文本	mixed

返回值

Text::ofSegments

创建多个文本段

Text::ofSegments( mixed segments ): static[]

参数

参数	类型	描述
段	mixed

返回值

Text::__construct

Text::__construct( mixed text = '' ): mixed

参数

参数	类型	描述
文本	mixed

返回值

Text::copy

获取一个文本副本

Text::copy(  ): static

返回值

Text::indexOf

indexOf()方法，给定一个参数：要搜索的子字符串/正则表达式，搜索整个调用字符串，并返回指定子字符串的第一个出现的位置

Text::indexOf( mixed needle, int offset ): int

参数

参数	类型	描述
针	mixed
偏移量	int

返回值

Text::search

indexOf的别名

Text::search( mixed needle ): mixed

参数

参数	类型	描述
针	mixed

返回值

Text::lastIndexOf

lastIndexOf()方法，给定一个参数：要搜索的子字符串/正则表达式，搜索整个调用字符串，并返回指定子字符串的最后一个出现的位置。

Text::lastIndexOf( mixed needle, int offset ): int

参数

参数	类型	描述
针	mixed
偏移量	int

返回值

Text::at

at()方法接受一个整数值并返回指定偏移量处的字符

Text::at( int offset ): string

参数

参数	类型	描述
偏移量	int

返回值

Text::concat

concat()方法将字符串参数连接到当前文本

Text::concat( mixed strings ): static

参数

参数	类型	描述
字符串	mixed

返回值

Text::toLowerCase

将文本转换为小写

Text::toLowerCase(  ): static

返回值

Text::toUpperCase

将文本转换为大写

Text::toUpperCase(  ): static

返回值

Text::endsWith

endsWith()方法确定字符串是否以指定的字符串的字符结尾，根据情况返回true或false。

Text::endsWith( mixed needle, bool ignoreCase = false ): bool

参数

参数	类型	描述
针	mixed
忽略大小写	bool

返回值

Text::startsWith

startsWith()方法确定字符串是否以指定的字符串的字符开头，根据情况返回true或false。

Text::startsWith( mixed needle, bool ignoreCase = false ): bool

参数

参数	类型	描述
针	mixed
忽略大小写	bool

返回值

Text::contains

includes()方法执行搜索以确定一个字符串是否可以在另一个字符串/正则表达式中找到，根据情况返回true或false。

Text::contains( mixed needle, bool ignoreCase = false ): bool

参数

参数	类型	描述
针	mixed
忽略大小写	bool

返回值

Text::containsAll

确定给定的字符串是否包含所有针

Text::containsAll( iterable needles, bool ignoreCase = false ): bool

参数

参数	类型	描述
多个针	iterable
忽略大小写	bool

返回值

Text::includes

includes()方法执行大小写敏感的搜索以确定一个字符串是否可以在另一个字符串中找到，根据情况返回true或false。

Text::includes( mixed needle ): bool

参数

参数	类型	描述
针	mixed

返回值

Text::match

match() 方法检索字符串与正则表达式匹配的结果。

Text::match( string pattern ): string[]

参数

参数	类型	描述
pattern	string

返回值

Text::matchAll

matchAll() 方法返回一个迭代器，包含所有与正则表达式匹配的结果，包括捕获组。

Text::matchAll( string pattern ): array

参数

参数	类型	描述
pattern	string

返回值

Text::padStart

在字符串的左侧填充另一个字符串。

Text::padStart( int length, mixed pad = ' ' ): static

参数

参数	类型	描述
长度	int
填充	mixed

返回值

Text::padEnd

在字符串的右侧填充另一个字符串。

Text::padEnd( int length, mixed pad = ' ' ): static

参数

参数	类型	描述
长度	int
填充	mixed

返回值

Text::pad

在字符串的两侧填充另一个字符串。

Text::pad( int length, mixed pad = ' ' ): static

参数

参数	类型	描述
长度	int
填充	mixed

返回值

Text::repeat

repeat() 方法构造并返回一个新的字符串，该字符串包含在它被调用的字符串上的指定数量的副本，并连接在一起。

Text::repeat( int times ): static

参数

参数	类型	描述
次数	int

返回值

Text::replace

替换字符串中给定值的第一处出现。

Text::replace( mixed search, mixed replacement ): static

参数

参数	类型	描述
搜索	mixed
替换项	mixed

返回值

Text::replaceAll

Text::replaceAll( mixed search, mixed replacement ): static

参数

参数	类型	描述
搜索	mixed
替换项	mixed

返回值

Text::substring

substring()方法返回从起始索引到结束索引的字符串部分，或到字符串的末尾。

Text::substring( int start, int|null end = null ): static

参数

参数	类型	描述
起始值	int
结束	int|null

返回值

Text::ltrim

从字符串的左侧移除指定的字符。

Text::ltrim( mixed chars ): static

参数

参数	类型	描述
字符	mixed

返回值

Text::trimStart

ltrim的别名

Text::trimStart( mixed chars ): static

参数

参数	类型	描述
字符	mixed

返回值

Text::rtrim

从字符串的右侧移除指定的字符。

Text::rtrim( mixed chars ): static

参数

参数	类型	描述
字符	mixed

返回值

Text::trimEnd

rtrim的别名

Text::trimEnd( mixed chars ): static

参数

参数	类型	描述
字符	mixed

返回值

Text::trim

从字符串中移除指定的字符。

Text::trim( mixed chars ): static

参数

参数	类型	描述
字符	mixed

返回值

Text::capitalize

返回一个字符串副本，其中第一个字符已大写，其余字符已小写。

Text::capitalize(  ): static

返回值

Text::center

返回长度为width的字符串中的居中文本。填充使用指定的填充字符（默认为ASCII空格）。

Text::center( int width, mixed fillchar = ' ' ): static

如果宽度小于或等于 len(s)，则返回原始字符串。

参数

参数	类型	描述
宽度	int
填充字符	mixed

返回值

Text::expandtabs

返回一个字符串副本，其中所有制表符字符都替换为一个或多个空格。

Text::expandtabs( int tabsize = 8 ): static

参数

参数	类型	描述
制表符大小	int

返回值

Text::find

返回子串sub在字符串s[start:end]中的最低索引。

Text::find( mixed sub, ?int start = null, ?int end = null ): int

可选参数 start 和 end 的解释与切片表示法相同。如果子字符串未找到，则返回 -1。

参数

参数	类型	描述
子字符串	mixed
起始值	?int
结束	?int

返回值

Text::format

执行字符串格式化操作。被该方法调用的字符串可以包含普通文本或由大括号{}分隔的替换字段。

Text::format( mixed args ): static

每个替换字段包含一个位置参数的数字索引，或一个关键字参数的名称。

参数

参数	类型	描述
参数	mixed

返回值

Text::index

与find()类似，但如果子串未找到，则引发ValueError。

Text::index( mixed sub, ?int start = null, ?int end = null ): int

参数

参数	类型	描述
子字符串	mixed
起始值	?int
结束	?int

返回值

Text::isalnum

如果字符串中的所有字符都是字母数字且至少有一个字符，则返回True，否则返回False

Text::isalnum(  ): bool

返回值

Text::isalpha

如果字符串中的所有字符都是字母且至少有一个字符，则返回True，否则返回False。

Text::isalpha(  ): bool

返回值

Text::isdecimal

如果字符串中的所有字符都是十进制字符且至少有一个字符，则返回True，否则返回False

Text::isdecimal(  ): bool

返回值

Text::isdigit

如果字符串中的所有字符都是数字且至少有一个字符，则返回True，否则返回False。

Text::isdigit(  ): bool

返回值

Text::islower

如果字符串中的所有有大小写的字符都是小写且至少有一个大小写字符，则返回True，否则返回False。

Text::islower(  ): bool

返回值

Text::isnumeric

检查变量是否为数字或数字字符串

Text::isnumeric(  ): bool

返回值

另请参阅

• https://php.ac.cn/manual/zh/function.is-numeric.php -

Text::istitle

如果字符串是标题化字符串并且至少有一个字符，则返回 True，例如，大写字母可能只能跟在非大写字母之后，而小写字母只能跟在大写字母之后。

Text::istitle(  ): bool

否则返回 False。

返回值

Text::isspace

如果字符串中只包含空白字符且至少有一个字符，则返回True，否则返回False。

Text::isspace(  ): bool

返回值

Text::isprintable

如果字符串中的所有字符都是可打印的或字符串为空，则返回True，否则返回False。

Text::isprintable(  ): bool

返回值

Text::ispunct

检查提供的Text中的所有字符是否都是标点符号。

Text::ispunct(  ): bool

返回值

Text::iscontrol

检查Text中的所有字符是否都是控制字符

Text::iscontrol(  ): bool

返回值

Text::isupper

如果字符串中的所有字符都是大写且至少有一个小写字符，则返回True，否则返回False。

Text::isupper(  ): bool

返回值

Text::join

返回一个字符串，它是可迭代中字符串的连接。

Text::join( mixed iterable ): static

元素之间的分隔符是提供此方法的文本。

参数

参数	类型	描述
iterable	mixed

返回值

Text::lower

返回一个字符串副本，其中所有字符都已转换为小写。

Text::lower(  ): static

返回值

Text::lstrip

返回一个字符串副本，其中已删除前导字符。

Text::lstrip( mixed chars = null ): static

chars 参数是一个字符串，指定要删除的字符集。如果省略或为 null，则 chars 参数默认为删除空白字符。chars 参数不是前缀；而是其值的所有组合都被清除。

参数

参数	类型	描述
字符	mixed

返回值

Text::partition

在 sep 的首次出现处分割字符串，并返回一个包含以下内容的 3 元组：分隔符之前的部分、分隔符本身以及分隔符之后的部分。

Text::partition( mixed sep ): array

如果未找到分隔符，则返回一个包含字符串本身、后跟两个空字符串的 3 元组。

参数

参数	类型	描述
sep	mixed

返回值

Text::removeprefix

如果字符串以 prefix 字符串开头，则返回 string[len(prefix):]。否则，返回原始字符串的副本。

Text::removeprefix( mixed prefix ): static

参数

参数	类型	描述
prefix	mixed

返回值

Text::removeSuffix

如果字符串以空字符串后跟的suffix字符串结束且该后缀不为空，则返回string[:-len(suffix)]。

Text::removeSuffix( mixed suffix ): static

否则，返回原始字符串的副本

参数

参数	类型	描述
后缀	mixed

返回值

Text::reverse

反转字符串

Text::reverse(  ): static

返回值

Text::rfind

返回字符串中子串sub的最高索引，其中sub包含在s[start:end]中。

Text::rfind( mixed sub, ?int start = null, ?int end = null ): int

可选参数 start 和 end 的解释与切片表示法相同。失败时返回 -1。

参数

参数	类型	描述
子字符串	mixed
起始值	?int
结束	?int

返回值

Text::rindex

与rfind()类似，但如果子串sub未找到，则引发ValueError。

Text::rindex( mixed sub, ?int start = null, ?int end = null ): int

参数

参数	类型	描述
子字符串	mixed
起始值	?int
结束	?int

返回值

Text::rpartition

在 sep 的最后一次出现处分割字符串，并返回一个包含以下内容的 3 元组：分隔符之前的部分、分隔符本身以及分隔符之后的部分。

Text::rpartition( mixed sep ): array

如果未找到分隔符，则返回一个包含两个空字符串、后跟字符串本身的 3 元组。

参数

参数	类型	描述
sep	mixed

返回值

Text::rstrip

返回一个字符串副本，其中已删除尾部字符。

Text::rstrip( mixed chars = null ): static

chars 参数是一个字符串，指定要删除的字符集。如果省略或为 None，则 chars 参数默认为删除空白字符。chars 参数不是前缀或后缀；而是其值的所有组合都被清除。

参数

参数	类型	描述
字符	mixed

返回值

Text::strip

返回一个字符串副本，其中已删除前导和尾部字符。

Text::strip( mixed chars = null ): static

chars 参数是一个字符串，指定要删除的字符集。如果省略或为 None，则 chars 参数默认为删除空白字符。chars 参数不是前缀或后缀；而是其值的所有组合都被清除。

参数

参数	类型	描述
字符	mixed

返回值

Text::swapcase

返回一个字符串副本，其中大写字符转换为小写，反之亦然。

Text::swapcase(  ): static

返回值

Text::slice

slice()方法提取字符串的某个部分，并返回一个新字符串

Text::slice( ?int start = null, ?int end = null, ?int step = null ): static

参数

参数	类型	描述
起始值	?int
结束	?int
步长	?int

返回值

Text::title

返回一个标题化版本的字符串，其中单词以大写字母开头，其余字符为小写。

Text::title(  ): static

返回值

Text::upper

返回一个字符串副本，其中所有有大小写的字符都已转换为大写

Text::upper(  ): static

返回值

Text::split

使用sep作为分隔符字符串，返回字符串中的单词列表。

Text::split( mixed sep = null, int maxsplit = -1 ): static[]

如果给出了 maxsplit，则最多执行 maxsplit 次分割（因此，列表将最多有 maxsplit+1 个元素）。如果未指定 maxsplit 或为 -1，则对分割的数量没有限制（执行所有可能的分割）。

参数

参数	类型	描述
sep	mixed
maxsplit	int

返回值

Text::rsplit

使用sep作为分隔符字符串，返回字符串中的单词列表。

Text::rsplit( mixed sep = ' ', int maxsplit = -1 ): array

如果给出了 maxsplit，则最多执行 maxsplit 次分割，从右侧开始。如果未指定 sep 或为 None，则任何空白字符串都是分隔符。除了从右侧分割外，rsplit() 的行为类似于 split()。

参数

参数	类型	描述
sep	mixed
maxsplit	int

返回值

Text::splitlines

返回字符串中的行列表，在行边界处拆分。

Text::splitlines( bool keepends = false ): array

除非提供 keepends 且为 true，否则行断行不包括在结果列表中。

参数

参数	类型	描述
keepends	bool

返回值

Text::sprintf

使用sprintf格式化字符串

Text::sprintf( mixed args ): static

参数

参数	类型	描述
参数	mixed

返回值

Text::ucfirst

在字符串上使用ucfirst

Text::ucfirst(  ): static

返回值

Text::lcfirst

在字符串上使用lcfirst

Text::lcfirst(  ): static

返回值

Text::append

返回添加后缀的新Text

Text::append( mixed suffix ): static

参数

参数	类型	描述
后缀	mixed

返回值

Text::prepend

返回添加前缀的新Text

Text::prepend( mixed prefix ): static

参数

参数	类型	描述
prefix	mixed

返回值

Text::isBase64

检查Text是否为base 64编码

Text::isBase64(  ): bool

返回值

Text::base64Encode

返回一个base64解码的Text

Text::base64Encode(  ): static

返回值

Text::base64Decode

返回一个base64解码的Text

Text::base64Decode(  ): static

返回值

Text::splitChars

将Text拆分为多个Text[]

Text::splitChars( int length = 1 ): array

参数

参数	类型	描述
长度	int

返回值

Text::countChars

如果使用正则表达式作为 needle，则在 Text 中计算 needle 出现的次数，搜索将是大小写敏感的。

Text::countChars( mixed needle, bool ignoreCase = false ): int

参数

参数	类型	描述
针	mixed
忽略大小写	bool

返回值

Text::isEquals

检查Text是否与提供的针相同

Text::isEquals( mixed needle, bool ignoreCase = false ): mixed

参数

参数	类型	描述
针	mixed
忽略大小写	bool

返回值

Text::ishexadecimal

检查字符串是否为十六进制数

Text::ishexadecimal(  ): bool

返回值

Text::length

返回文本的长度

Text::length(  ): int

返回值

Text::size

返回字节数量

Text::size(  ): int

返回值

Text::offsetExists

Text::offsetExists( mixed offset ): bool

参数

参数	类型	描述
偏移量	mixed

返回值

Text::offsetGet

Text::offsetGet( mixed offset ): static

参数

参数	类型	描述
偏移量	mixed

返回值

Text::offsetSet

Text::offsetSet( mixed offset, mixed value ): void

参数

参数	类型	描述
偏移量	mixed
value	mixed

返回值

Text::offsetUnset

Text::offsetUnset( mixed offset ): void

参数

参数	类型	描述
偏移量	mixed

返回值

Text::count

Text::count(  ): int

返回值

Text::isEmpty

Text::isEmpty(  ): bool

返回值

Text::jsonSerialize

Text::jsonSerialize(  ): mixed

返回值

Text::toString

Text::toString(  ): string

返回值

Text::__toString

Text::__toString(  ): string

返回值

Text::__serialize

Text::__serialize(  ): array

返回值

Text::__unserialize

Text::__unserialize( array data ): void

参数

参数	类型	描述
data	array

返回值

Text::__debugInfo

Text::__debugInfo(  ): array

返回值

Timer

• 全名：\NGSOFT\Facades\Timer
• 父类: \NGSOFT\Facades\Facade

Timer::getWatch

获取一个监视器

Timer::getWatch( mixed task = WatchFactory::DEFAULT_WATCH ): \NGSOFT\Timer\StopWatch

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed

返回值

Timer::read

读取时钟

Timer::read( mixed task = WatchFactory::DEFAULT_WATCH ): \NGSOFT\Timer\StopWatchResult

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed

返回值

Timer::start

开始时钟

Timer::start( mixed task = WatchFactory::DEFAULT_WATCH, int|float|null startTime = null ): bool

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed
开始时间	int|float|null

返回值

Timer::resume

恢复时钟（仅当暂停时）

Timer::resume( mixed task = WatchFactory::DEFAULT_WATCH ): bool

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed

返回值

Timer::reset

重置时钟

Timer::reset( mixed task = WatchFactory::DEFAULT_WATCH ): void

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed

返回值

Timer::resetAll

重置所有时钟

Timer::resetAll(  ): void

• 此方法为 静态。

返回值

Timer::pause

暂停时钟

Timer::pause( mixed task = WatchFactory::DEFAULT_WATCH, ?bool &success = null ): \NGSOFT\Timer\StopWatchResult

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed
success	?bool

返回值

Timer::stop

停止时钟

Timer::stop( mixed task = WatchFactory::DEFAULT_WATCH, ?bool &success = null ): \NGSOFT\Timer\StopWatchResult

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed
success	?bool

返回值

Timer::getLaps

Timer::getLaps( mixed task = WatchFactory::DEFAULT_WATCH ): \Generator|\NGSOFT\Timer\StopWatchResult[]

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed

返回值

Timer::lap

添加圈数时间

Timer::lap( mixed task = WatchFactory::DEFAULT_WATCH, ?string label = null ): bool

• 此方法为 静态。 参数:

参数	类型	描述
任务	mixed
标签	?string

返回值

Tools

在我项目中使用的一些有用的函数

• 全名：\NGSOFT\Tools

Tools::safe_exec

执行回调并隐藏所有可以抛出的 PHP 错误。回调内部抛出的异常将被保留。

Tools::safe_exec( callable callback, mixed args ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable
参数	mixed	要传递给回调的参数

返回值

Tools::errors_as_exceptions

方便的函数，用于将PHP错误、警告...转换为Throwable

Tools::errors_as_exceptions(  ): callable|null

• 此方法为 静态。

返回值

Tools::suppress_errors

将错误处理程序设置为空闭包（从PHP 8.1开始，@不再起作用）

Tools::suppress_errors(  ): callable|null

• 此方法为 静态。

返回值

Tools::normalize_path

规范化路径名

Tools::normalize_path( string path ): string

• 此方法为 静态。 参数:

参数	类型	描述
path	string

返回值

Tools::pushd

更改当前活动目录并存储最后的位置，使用 popd() 返回到上一个目录

Tools::pushd( string dir ): bool

• 此方法为 静态。 参数:

参数	类型	描述
目录	string

返回值

Tools::popd

恢复由pushd更改的最后活动目录

Tools::popd(  ): string|false

• 此方法为 静态。

返回值

当前目录

Tools::each

使用回调为数组的每个元素，并返回值

Tools::each( callable callback, iterable iterable ): iterable

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable
iterable	iterable

返回值

Tools::iterateAll

迭代可迭代对象

Tools::iterateAll( iterable iterable ): array

• 此方法为 静态。 参数:

参数	类型	描述
iterable	iterable

返回值

Tools::filter

使用回调函数过滤可迭代对象的元素

Tools::filter( callable callback, iterable iterable ): array

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable	接受 $value、$key、$array
iterable	iterable

返回值

Tools::search

搜索可迭代对象直到找到元素

Tools::search( callable callback, iterable iterable ): null|mixed

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable
iterable	iterable

返回值

Tools::map

与原始函数相同，除了回调接受更多参数，并使用字符串键外

Tools::map( callable callback, iterable iterable ): array

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable	接受 $value、$key、$array
iterable	iterable

返回值

Tools::some

测试可迭代对象中至少有一个元素通过提供的函数实现的测试。

Tools::some( callable callback, iterable iterable ): bool

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable
iterable	iterable

返回值

Tools::every

测试可迭代对象中的所有元素是否通过提供的函数实现的测试。

Tools::every( callable callback, iterable iterable ): bool

• 此方法为 静态。 参数:

参数	类型	描述
回调	callable
iterable	iterable

返回值

Tools::pull

从数组中获取值（并移除它）

Tools::pull( iterable|string|int keys, array|\ArrayAccess &iterable ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
键	可迭代|string|int
iterable	array|\ArrayAccess

返回值

Tools::cloneArray

递归地克隆数组中的所有对象

Tools::cloneArray( array array, bool recursive = true ): array

• 此方法为 静态。 参数:

参数	类型	描述
array	array
recursive	bool

返回值

Tools::iterableToArray

如果键不是字符串，则递归地将可迭代对象转换为数组，并将索引分配给它们。

Tools::iterableToArray( iterable iterable ): array

• 此方法为 静态。 参数:

参数	类型	描述
iterable	iterable

返回值

Tools::concat

递归地将多个值合并到提供的可迭代对象中。如果提供的值是可迭代的，则将其合并到可迭代对象中（非数字键在不是可迭代对象的情况下将被替换）

Tools::concat( array|\ArrayAccess &iterable, mixed values ): array|\ArrayAccess

• 此方法为 静态。 参数:

参数	类型	描述
iterable	array|\ArrayAccess
值	mixed

返回值

Tools::countValue

计数值的出现次数

Tools::countValue( mixed value, iterable iterable ): int

• 此方法为 静态。 参数:

参数	类型	描述
value	mixed
iterable	iterable

返回值

Tools::isValidUrl

检查是否为有效的URL

Tools::isValidUrl( string url, bool webonly = false ): bool

• 此方法为 静态。 参数:

参数	类型	描述
url	string
webonly	bool	将本地url视为无效（例如："http://localhost/index.php"）

返回值

另请参阅

• https://gist.github.com/dperini/729294 -

Tools::to_snake

将驼峰式转换为camel_cased

Tools::to_snake( string camelCased ): string

• 此方法为 静态。 参数:

参数	类型	描述
camelCased	string

返回值

Tools::toCamelCase

将snake_case转换为snakeCase

Tools::toCamelCase( string snake_case ): string

• 此方法为 静态。 参数:

参数	类型	描述
snake_case	string

返回值

Tools::millitime

返回当前Unix时间戳的毫秒值

Tools::millitime(  ): int

• 此方法为 静态。

返回值

另请参阅

• https://stackoverflow.com/questions/3656713/how-to-get-current-time-in-milliseconds-in-php -

Tools::generate_uuid_v4

生成uuid V4

Tools::generate_uuid_v4(  ): string

• 此方法为 静态。

返回值

另请参阅

• https://stackoverflow.com/questions/2040240/php-function-to-generate-v4-uuid -

Tools::isAscii

返回此字符串是否完全由ASCII字符组成

Tools::isAscii( string input ): bool

• 此方法为 静态。 参数:

参数	类型	描述
input	string

返回值

Tools::isPrintableAscii

返回此字符串是否完全由可打印的ASCII字符组成

Tools::isPrintableAscii( string input ): bool

• 此方法为 静态。 参数:

参数	类型	描述
input	string

返回值

Tools::getFilesize

获取可读文件大小

Tools::getFilesize( int|float size, int precision = 2 ): string

• 此方法为 静态。 参数:

参数	类型	描述
size	int|float
precision	int

返回值

另请参阅

• https://gist.github.com/liunian/9338301 -

Tools::randomString

生成更真实的“随机”字母数字字符串。

Tools::randomString( int length = 16 ): string

• 此方法为 静态。 参数:

参数	类型	描述
长度	int

返回值

Tools::getWordSize

获取字符串中最长单词的长度

Tools::getWordSize( string|\Stringable string ): int

• 此方法为 静态。 参数:

参数	类型	描述
string	string|\Stringable

返回值

Tools::splitString

在不切断单词的情况下按给定长度分割字符串

Tools::splitString( string|\Stringable string, int &length = null ): array

• 此方法为 静态。 参数:

参数	类型	描述
string	string|\Stringable
长度	int

返回值

Tools::join

使用提供的粘合剂将可迭代对象连接在一起

Tools::join( mixed glue, iterable values ): string

• 此方法为 静态。 参数:

参数	类型	描述
粘合剂	mixed
值	iterable

返回值

Tools::format

尝试重现Python格式

Tools::format( string message, mixed args ): string

• 此方法为 静态。 参数:

参数	类型	描述
message	string
参数	mixed

返回值

Tools::split

使用提供的分隔符分割字符串

Tools::split( mixed separator, mixed value, int limit = -1 ): array

• 此方法为 静态。 参数:

参数	类型	描述
separator	mixed
value	mixed
限制	int

返回值

Tools::getExecutionTime

获取脚本执行时间

Tools::getExecutionTime( int precision = 6 ): float|int

• 此方法为 静态。 参数:

参数	类型	描述
precision	int

返回值

Tools::pause

暂停脚本执行指定的时间，结合sleep或usleep

Tools::pause( int|float seconds ): void

• 此方法为 静态。 参数:

参数	类型	描述
seconds	int|float

返回值

Tools::msleep

暂停脚本执行指定毫秒数

Tools::msleep( int milliseconds ): void

• 此方法为 静态。 参数:

参数	类型	描述
milliseconds	int

返回值

Tools::implements_class

从已加载的类中获取实现给定父类的类

Tools::implements_class( string|object parentClass, bool instanciable = true ): array

• 此方法为 静态。 参数:

参数	类型	描述
parentClass	string|object
instanciable	bool

返回值

Tools::getClassConstants

获取类中定义的常量

Tools::getClassConstants( string|object class, bool public = true ): array

• 此方法为 静态。 参数:

参数	类型	描述
class	string|object
public	bool	如果为True，则只返回公开可见的常量

返回值

Tools::callPrivateMethod

在对象内部调用方法，忽略其状态

Tools::callPrivateMethod( object instance, string method, mixed arguments ): mixed

• 此方法为 静态。 参数:

参数	类型	描述
instance	object
method	string
参数	mixed

返回值

TypeCheck

检查混合联合/交集类型

• 全名：\NGSOFT\Tools\TypeCheck

TypeCheck::assertType

检查给定值与提供的类型是否匹配，如果不匹配则抛出TypeError

TypeCheck::assertType( string name, mixed value, string types ): void

• 此方法为 静态。 参数:

参数	类型	描述
name	string	错误显示的名称
value	mixed	要检查的值
types	string	类型

返回值

TypeCheck::assertTypeMethod

检查给定值与提供的类型是否匹配，如果不匹配则抛出TypeError

TypeCheck::assertTypeMethod( string|array method, mixed value, string types ): void

• 此方法为 静态。 参数:

参数	类型	描述
method	string|array
value	mixed
types	string

返回值

TypeCheck::checkType

可以检查交集和联合的混合

TypeCheck::checkType( mixed value, string types ): bool

例如：TypeCheck::checkType([], 'Traversable & ArrayAccess | array') 或 TypeCheck::checkType([], 'Traversable&ArrayAccess|array') 或 TypeCheck::checkType([], \Traversable::class, '&', \ArrayAccess::class, 'array') 或 TypeCheck::checkType([], \Traversable::class, '&', \ArrayAccess::class, '|', 'array') 或 TypeCheck::checkType([], \Traversable::class, TypeCheck::INTERSECTION, \ArrayAccess::class, TypeCheck::UNION, 'array') 使用 TypeCheck::UNION 是不必要的，例如：TypeCheck::checkType([], 'string', 'object', 'array') 将检查 'string|object|array'。

• 此方法为 静态。 参数:

参数	类型	描述
value	mixed
types	string

返回值

Units

基本枚举类支持（Polyfill）将类常量添加到作为php 8.1支持的枚举情况

• 全名：\NGSOFT\Timer\Units
• 父类：\NGSOFT\Enums\Enum

Units::getStep

Units::getStep(  ): int|float

返回值

Units::getPlural

Units::getPlural(  ): string

返回值

Units::getSingular

Units::getSingular(  ): string

返回值

WatchFactory

• 全名：\NGSOFT\Timer\WatchFactory

WatchFactory::__construct

WatchFactory::__construct( bool highResolution = false ): mixed

参数

参数	类型	描述
高精度	bool

返回值

WatchFactory::getWatch

获取一个监视器

WatchFactory::getWatch( mixed task = self::DEFAULT_WATCH ): \NGSOFT\Timer\StopWatch

参数

参数	类型	描述
任务	mixed

返回值

WatchFactory::read

读取时钟

WatchFactory::read( mixed task = self::DEFAULT_WATCH ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
任务	mixed

返回值

WatchFactory::start

开始时钟

WatchFactory::start( mixed task = self::DEFAULT_WATCH, int|float|null startTime = null ): bool

参数

参数	类型	描述
任务	mixed
开始时间	int|float|null

返回值

WatchFactory::resume

恢复时钟（仅当暂停时）

WatchFactory::resume( mixed task = self::DEFAULT_WATCH ): bool

参数

参数	类型	描述
任务	mixed

返回值

WatchFactory::reset

重置时钟

WatchFactory::reset( mixed task = self::DEFAULT_WATCH ): void

参数

参数	类型	描述
任务	mixed

返回值

WatchFactory::resetAll

重置所有时钟

WatchFactory::resetAll(  ): void

返回值

WatchFactory::pause

暂停时钟

WatchFactory::pause( mixed task = self::DEFAULT_WATCH, bool &success = null ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
任务	mixed
success	bool

返回值

WatchFactory::stop

停止时钟

WatchFactory::stop( mixed task = self::DEFAULT_WATCH, bool &success = null ): \NGSOFT\Timer\StopWatchResult

参数

参数	类型	描述
任务	mixed
success	bool

返回值

WatchFactory::getLaps

WatchFactory::getLaps( mixed task = self::DEFAULT_WATCH ): \Generator|\NGSOFT\Timer\StopWatchResult[]

参数

参数	类型	描述
任务	mixed

返回值

WatchFactory::lap

添加圈数时间

WatchFactory::lap( mixed task = self::DEFAULT_WATCH, ?string label = null ): bool

参数

参数	类型	描述
任务	mixed
标签	?string

返回值