menu-btn

助手函数

October CMS Documentation Docs
/

助手函数

October CMS 包括各种PHP"助手"函数。 其中许多功能由 October 本身在内部使用。但是如果您发现它们有用，您可以在自己的插件和应用程序中自由使用它们。

# 数组

array_add array_divide array_dot array_undot array_except array_first array_flatten array_forget array_get array_only array_pluck array_pull array_set array_sort array_sort_recursive array_where head last

# 路径

Path Symbols app_path base_path config_path database_path plugins_path public_path storage_path temp_path themes_path cache_path

# 字符串

camel_case class_basename e ends_with snake_case str_limit starts_with str_contains str_finish str_is str_plural str_random str_singular str_slug studly_case trans trans_choice

# 其他

asset config dd env get input post redirect request response route secure_asset trace_log trace_sql url

# 数组

# array_add()

如果数组中不存在给定的键，则 array_add 函数将给定的键/值成对添加到数组中：

$array = array_add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

# array_divide()

array_divide 函数返回两个数组，一个包含键，另一个包含原始数组的值：

list($keys, $values) = array_divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

# array_dot()

array_dot 函数将多维数组扁平化为使用"点"表示法表示深度的单级数组：

$array = array_dot(['foo' => ['bar' => 'baz']]);

// ['foo.bar' => 'baz'];

# array_undot()

array_undot 函数是 array_dot 方法的对应部分。 它将点标记数组转换为标准关联数组：

$array = array_undot([
    'foo.bar' => 'baz'
]);

// [
//    'foo' => [
//        'bar' => 'baz'
//    ]
// ]

# array_except()

array_except 方法从数组中删除给定的键/值对：

$array = ['name' => 'Desk', 'price' => 100];

$array = array_except($array, ['price']);

// ['name' => 'Desk']

# array_first()

array_first 方法返回通过给定真值测试的数组的第一个元素：

$array = [100, 200, 300];

$value = array_first($array, function ($key, $value) {
    return $value >= 150;
});

// 200

默认值也可以作为第三个参数传递给该方法。 如果没有值通过真值测试，将返回此值：

$value = array_first($array, $callback, $default);

# array_flatten()

array_flatten 方法会将多维数组展平为单个级别。

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$array = array_flatten($array);

// ['Joe', 'PHP', 'Ruby'];

# array_forget()

array_forget 方法使用"点"表示法从深度嵌套的数组中删除给定的键/值对：

$array = ['products' => ['desk' => ['price' => 100]]];

array_forget($array, 'products.desk');

// ['products' => []]

# array_get()

array_get 方法使用"点"表示法从深度嵌套的数组中检索值：

$array = ['products' => ['desk' => ['price' => 100]]];

$value = array_get($array, 'products.desk');

// ['price' => 100]

array_get 函数也接受一个默认值，如果没有找到特定的键，将返回该值：

$value = array_get($array, 'names.john', 'default');

# array_only()

array_only 方法将只返回给定数组中指定的键/值对：

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$array = array_only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

# array_pluck()

array_pluck 方法将从数组中提取给定键/值对的列表：

$array = [
    ['developer' => ['name' => 'Brian']],
    ['developer' => ['name' => 'Stewie']]
];

$array = array_pluck($array, 'developer.name');

// ['Brian', 'Stewie'];

# array_pull()

array_pull 方法从数组中返回并删除一个键/值对：

$array = ['name' => 'Desk', 'price' => 100];

$name = array_pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

# array_set()

array_set 方法使用"点"表示法在深度嵌套的数组中设置一个值：

$array = ['products' => ['desk' => ['price' => 100]]];

array_set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

# array_sort()

array_sort 方法根据给定闭包的结果对数组进行排序：

$array = [
    ['name' => 'Desk'],
    ['name' => 'Chair'],
];

$array = array_values(array_sort($array, function ($value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
    ]
*/

# array_sort_recursive()

array_sort_recursive 函数使用 sort 函数对数组进行递归排序：

$array = [
    [
        'Brian',
        'Shannon',
        'Alec',
    ],
    [
        'PHP',
        'Ruby',
        'JavaScript',
    ],
];

$array = array_sort_recursive($array);

/*
    [
        [
            'Alec',
            'Brian',
            'Shannon',
        ],
        [
            'JavaScript',
            'PHP',
            'Ruby',
        ]
    ];
*/

# array_where()

array_where 函数使用给定的闭包过滤数组：

$array = [100, '200', 300, '400', 500];

$array = array_where($array, function ($value, $key) {
    return is_string($value);
});

// [1 => 200, 3 => 400]

head 函数只返回给定数组中的第一个元素：

$array = [100, 200, 300];

$first = head($array);

// 100

# last()

last 函数返回给定数组中的最后一个元素：

$array = [100, 200, 300];

$last = last($array);

// 300

# 路径

# 路径符号

路径前缀符号可用于创建动态路径。 例如，以 ~/ 开头的路径将创建一个相对于应用程序的路径：

list: ~/plugins/acme/pay/models/invoiceitem/columns.yaml

创建动态路径时支持这些符号：

符号 描述
$ 相对于插件目录
~ 相对于应用程序目录
# 相对于主题目录

# app_path()

app_path 函数返回 app 目录的绝对路径：

$path = app_path();

您还可以使用 app_path 函数来生成给定文件相对于应用程序目录的绝对路径：

$path = app_path('Http/Controllers/Controller.php');

# base_path()

base_path 函数返回项目根目录的绝对路径：

$path = base_path();

您还可以使用 base_path 函数生成给定文件相对于应用程序目录的绝对路径：

$path = base_path('vendor/bin');

# config_path($path = '')

config_path 函数返回应用程序配置目录的绝对路径：

$path = config_path();

你也可以使用 config_path 函数来生成给定文件相对于 config 目录的绝对路径：

$path = config_path('dev/cms.php');

# database_path()

database_path 函数返回应用程序数据库目录的绝对路径：

$path = database_path();

# plugins_path($path = '')

plugins_path 函数返回应用程序插件目录的绝对路径：

$path = plugins_path();

你也可以使用 plugins_path 函数来生成给定文件相对于插件目录的绝对路径：

$path = plugins_path('author/plugin/routes.php');

# public_path()

public_path 函数返回 public 目录的绝对路径：

$path = public_path();

# storage_path($path = '')

storage_path 函数返回 storage 目录的绝对路径：

$path = storage_path();

您还可以使用 storage_path 函数生成给定文件相对于存储目录的绝对路径：

$path = storage_path('app/file.txt');

# temp_path($path = '')

temp_path 函数将绝对路径返回到临时文件的可写目录：

$path = temp_path();

您还可以使用 temp_path 函数生成到给定文件相对于 temp 目录的绝对路径：

$path = temp_path('app/file.txt');

# themes_path($path = '')

themes_path 函数返回 themes 目录的绝对路径：

$path = themes_path();

您还可以使用 themes_path 函数生成到给定文件相对于主题目录的绝对路径：

$path = themes_path('mytheme/file.txt');

# cache_path($path = '')

cache_path 函数返回应用程序缓存目录的绝对路径：

$path = cache_path();

您还可以使用 cache_path 函数生成给定文件相对于缓存目录的绝对路径：

$path = cache_path('cms/cachefile.json');

# 字符串

# camel_case()

camel_case 函数将给定的字符串转换为 驼峰命名法：

$camel = camel_case('foo_bar');

// fooBar

# class_basename()

class_basename 返回给定类的类名，删除了类的命名空间：

$class = class_basename('Foo\Bar\Baz');

// Baz

# e()

e 函数在给定的字符串上运行 htmlentities：

echo e('<html>foo</html>');

// &lt;html&gt;foo&lt;/html&gt;

# ends_with()

ends_with 函数确定给定字符串是否以给定值结尾：

$value = ends_with('This is my name', 'name');

// true

# snake_case()

snake_case 函数将给定的字符串转换为 蛇形命名法：

$snake = snake_case('fooBar');

// foo_bar

# str_limit()

str_limit 函数限制字符串中的字符数。 该函数接受一个字符串作为它的第一个参数，并将结果字符的最大数量作为它的第二个参数：

$value = str_limit('The CMS platform that gets back to basics.', 6);

// The CMS...

# starts_with()

starts_with 函数确定给定字符串是否以给定值开头：

$value = starts_with('The cow goes moo', 'The');

// true

# str_contains()

str_contains 函数确定给定字符串是否包含给定值：

$value = str_contains('The bird goes tweet', 'bird');

// true

# str_finish()

str_finish 函数将给定值的单个实例添加到字符串中：

$string = str_finish('this/string', '/');

// this/string/

# str_is()

str_is 函数确定给定字符串是否与给定模式匹配。 星号可用于表示通配符：

$value = str_is('foo*', 'foobar');

// true

$value = str_is('baz*', 'foobar');

// false

# str_plural()

str_plural 函数将字符串转换为其复数形式。 该功能目前仅支持英文：

$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

# str_random()

str_random 函数生成指定长度的随机字符串：

$string = str_random(40);

# str_singular()

str_singular 函数将字符串转换为其单数形式。 该功能目前仅支持英文：

$singular = str_singular('cars');

// car

# str_slug()

str_slug 函数从给定的字符串生成一个 URL 友好的"slug"：

$title = str_slug("October CMS", "-");

// october-cms

# studly_case()

studly_case 函数将给定的字符串转换为 驼峰命名：

$value = studly_case('foo_bar');

// FooBar

# trans()

trans 函数使用您的 多语言文件 翻译成给定的语言行：

echo trans('validation.required'):

# trans_choice()

trans_choice 函数用变形翻译给定的语言行：

$value = trans_choice('foo.bar', $count);

# 其他

# asset()

使用当前的请求方案(HTTP 或 HTTPS)为资产生成 URL：

$url = asset('img/photo.jpg');

# config()

config 函数获取配置变量的值。 可以使用"点"语法访问配置值，其中包括文件名和您希望访问的选项。 如果配置选项不存在，则可以指定默认值并返回：

$value = config('app.timezone');

$value = config('app.timezone', $default);

config 助手函数也可用于在运行时通过传递键/值对数组来设置配置变量：

config(['app.debug' => true]);

# dd()

dd 函数dumps给定变量并结束脚本的执行：

dd($value);

# env()

env 函数获取环境变量的值或返回默认值：

$env = env('APP_ENV');

// 如果变量不存在，则返回默认值...
$env = env('APP_ENV', 'production');

# get()

get 函数从请求中获取输入项，仅限于 GET 变量：

$value = get('key', $default = null)

# input()

input 函数从请求中获取一个输入项：

$value = input('key', $default = null)

# post()

post 函数从请求中获取输入项，仅限于 POST 变量：

$value = post('key', $default = null)

# redirect()

redirect 函数返回重定向的实例以执行 重定向响应：

return redirect('/home');

# request()

request 函数返回当前的 请求实例：

$referer = request()->header('referer');

# response()

response 函数创建一个 响应 实例或获取响应工厂的一个实例：

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

# route()

route 函数为给定的 路由命名 生成一个 URL：

$url = route('routeName');

如果路由接受参数，您可以将它们作为第二个参数传递给方法：

$url = route('routeName', ['id' => 1]);

# secure_asset()

使用 HTTPS 为资产生成 URL：

echo secure_asset('foo/bar.zip', $title, $attributes = []);

# trace_log()

trace_log 函数向日志文件写入跟踪消息。

trace_log('此代码已通过...');

该函数支持传递异常、数组和对象：

trace_log($exception);

trace_log($array);

trace_log($object);

您还可以传递多个参数来跟踪多条消息：

trace_log($value1, $value2, $exception, '...');

# trace_sql()

trace_sql 函数启用数据库日志记录并开始监视所有 SQL 输出。

trace_sql();

Db::table('users')->count();

// select count(*) as aggregate from users

# url()

url 函数为给定路径生成一个完整的网址路径：

echo url('user/profile');

echo url('user/profile', [1]);

← 电子邮件 →