diff --git a/library/think/Build.php b/library/think/Build.php
index 6e055c92..69a9d7e4 100644
--- a/library/think/Build.php
+++ b/library/think/Build.php
@@ -14,36 +14,44 @@ namespace think;
class Build
{
/**
- * 根据传入的build资料创建目录和文件
- * @access protected
- * @param array $build build列表
+ * 根据传入的 build 资料创建目录和文件
+ * @access public
+ * @param array $build build 列表
* @param string $namespace 应用类库命名空间
- * @param bool $suffix 类库后缀
+ * @param bool $suffix 类库后缀
* @return void
+ * @throws Exception
*/
public static function run(array $build = [], $namespace = 'app', $suffix = false)
{
// 锁定
- $lockfile = APP_PATH . 'build.lock';
- if (is_writable($lockfile)) {
- return;
- } elseif (!touch($lockfile)) {
- throw new Exception('应用目录[' . APP_PATH . ']不可写，目录无法自动生成！
请手动生成项目目录~', 10006);
- }
- foreach ($build as $module => $list) {
- if ('__dir__' == $module) {
- // 创建目录列表
- self::buildDir($list);
- } elseif ('__file__' == $module) {
- // 创建文件列表
- self::buildFile($list);
- } else {
- // 创建模块
- self::module($module, $list, $namespace, $suffix);
+ $lock = APP_PATH . 'build.lock';
+
+ // 如果锁定文件不可写(不存在)则进行处理，否则表示已经有程序在处理了
+ if (!is_writable($lock)) {
+ if (!touch($lock)) {
+ throw new Exception(
+ '应用目录[' . APP_PATH . ']不可写，目录无法自动生成！
请手动生成项目目录~',
+ 10006
+ );
}
+
+ foreach ($build as $module => $list) {
+ if ('__dir__' == $module) {
+ // 创建目录列表
+ self::buildDir($list);
+ } elseif ('__file__' == $module) {
+ // 创建文件列表
+ self::buildFile($list);
+ } else {
+ // 创建模块
+ self::module($module, $list, $namespace, $suffix);
+ }
+ }
+
+ // 解除锁定
+ unlink($lock);
}
- // 解除锁定
- unlink($lockfile);
}
/**
@@ -55,10 +63,8 @@ class Build
protected static function buildDir($list)
{
foreach ($list as $dir) {
- if (!is_dir(APP_PATH . $dir)) {
- // 创建目录
- mkdir(APP_PATH . $dir, 0755, true);
- }
+ // 目录不存在则创建目录
+ !is_dir(APP_PATH . $dir) && mkdir(APP_PATH . $dir, 0755, true);
}
}
@@ -71,12 +77,17 @@ class Build
protected static function buildFile($list)
{
foreach ($list as $file) {
+ // 先创建目录
if (!is_dir(APP_PATH . dirname($file))) {
- // 创建目录
mkdir(APP_PATH . dirname($file), 0755, true);
}
+
+ // 再创建文件
if (!is_file(APP_PATH . $file)) {
- file_put_contents(APP_PATH . $file, 'php' == pathinfo($file, PATHINFO_EXTENSION) ? " ['config.php', 'common.php'],
'__dir__' => ['controller', 'model', 'view'],
];
}
+
// 创建子目录和文件
foreach ($list as $path => $file) {
$modulePath = APP_PATH . $module . DS;
+
if ('__dir__' == $path) {
// 生成子目录
foreach ($file as $dir) {
@@ -122,16 +135,20 @@ class Build
// 生成（空白）文件
foreach ($file as $name) {
if (!is_file($modulePath . $name)) {
- file_put_contents($modulePath . $name, 'php' == pathinfo($name, PATHINFO_EXTENSION) ? "has($name);
}
/**
* 读取缓存
* @access public
- * @param string $name 缓存标识
- * @param mixed $default 默认值
+ * @param string $name 缓存标识
+ * @param mixed $default 默认值
* @return mixed
*/
public static function get($name, $default = false)
{
self::$readTimes++;
+
return self::init()->get($name, $default);
}
/**
* 写入缓存
* @access public
- * @param string $name 缓存标识
- * @param mixed $value 存储数据
- * @param int|null $expire 有效时间 0为永久
+ * @param string $name 缓存标识
+ * @param mixed $value 存储数据
+ * @param int|null $expire 有效时间 0为永久
* @return boolean
*/
public static function set($name, $value, $expire = null)
{
self::$writeTimes++;
+
return self::init()->set($name, $value, $expire);
}
/**
* 自增缓存（针对数值缓存）
* @access public
- * @param string $name 缓存变量名
- * @param int $step 步长
+ * @param string $name 缓存变量名
+ * @param int $step 步长
* @return false|int
*/
public static function inc($name, $step = 1)
{
self::$writeTimes++;
+
return self::init()->inc($name, $step);
}
/**
* 自减缓存（针对数值缓存）
* @access public
- * @param string $name 缓存变量名
- * @param int $step 步长
+ * @param string $name 缓存变量名
+ * @param int $step 步长
* @return false|int
*/
public static function dec($name, $step = 1)
{
self::$writeTimes++;
+
return self::init()->dec($name, $step);
}
/**
* 删除缓存
* @access public
- * @param string $name 缓存标识
+ * @param string $name 缓存标识
* @return boolean
*/
public static function rm($name)
{
self::$writeTimes++;
+
return self::init()->rm($name);
}
/**
* 清除缓存
* @access public
- * @param string $tag 标签名
+ * @param string $tag 标签名
* @return boolean
*/
public static function clear($tag = null)
{
self::$writeTimes++;
+
return self::init()->clear($tag);
}
/**
* 读取缓存并删除
* @access public
- * @param string $name 缓存变量名
+ * @param string $name 缓存变量名
* @return mixed
*/
public static function pull($name)
{
self::$readTimes++;
self::$writeTimes++;
+
return self::init()->pull($name);
}
/**
* 如果不存在则写入缓存
* @access public
- * @param string $name 缓存变量名
- * @param mixed $value 存储数据
- * @param int $expire 有效时间 0为永久
+ * @param string $name 缓存变量名
+ * @param mixed $value 存储数据
+ * @param int $expire 有效时间 0为永久
* @return mixed
*/
public static function remember($name, $value, $expire = null)
{
self::$readTimes++;
+
return self::init()->remember($name, $value, $expire);
}
/**
* 缓存标签
* @access public
- * @param string $name 标签名
- * @param string|array $keys 缓存标识
- * @param bool $overlay 是否覆盖
+ * @param string $name 标签名
+ * @param string|array $keys 缓存标识
+ * @param bool $overlay 是否覆盖
* @return Driver
*/
public static function tag($name, $keys = null, $overlay = false)
diff --git a/library/think/Collection.php b/library/think/Collection.php
index 3fcba5cd..82018a18 100644
--- a/library/think/Collection.php
+++ b/library/think/Collection.php
@@ -19,20 +19,35 @@ use JsonSerializable;
class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
{
+ /**
+ * @var array 数据
+ */
protected $items = [];
+ /**
+ * Collection constructor.
+ * @access public
+ * @param array $items 数据
+ */
public function __construct($items = [])
{
$this->items = $this->convertToArray($items);
}
+ /**
+ * 创建 Collection 实例
+ * @access public
+ * @param array $items 数据
+ * @return static
+ */
public static function make($items = [])
{
return new static($items);
}
/**
- * 是否为空
+ * 判断数据是否为空
+ * @access public
* @return bool
*/
public function isEmpty()
@@ -40,43 +55,33 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
return empty($this->items);
}
+ /**
+ * 将数据转成数组
+ * @access public
+ * @return array
+ */
public function toArray()
{
return array_map(function ($value) {
- return ($value instanceof Model || $value instanceof self) ? $value->toArray() : $value;
+ return ($value instanceof Model || $value instanceof self) ?
+ $value->toArray() :
+ $value;
}, $this->items);
}
+ /**
+ * 获取全部的数据
+ * @access public
+ * @return array
+ */
public function all()
{
return $this->items;
}
- /**
- * 合并数组
- *
- * @param mixed $items
- * @return static
- */
- public function merge($items)
- {
- return new static(array_merge($this->items, $this->convertToArray($items)));
- }
-
- /**
- * 比较数组，返回差集
- *
- * @param mixed $items
- * @return static
- */
- public function diff($items)
- {
- return new static(array_diff($this->items, $this->convertToArray($items)));
- }
-
/**
* 交换数组中的键和值
- *
+ * @access public
* @return static
*/
public function flip()
@@ -85,19 +90,8 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
/**
- * 比较数组，返回交集
- *
- * @param mixed $items
- * @return static
- */
- public function intersect($items)
- {
- return new static(array_intersect($this->items, $this->convertToArray($items)));
- }
-
- /**
- * 返回数组中所有的键名
- *
+ * 返回数组中所有的键名组成的新 Collection 实例
+ * @access public
* @return static
*/
public function keys()
@@ -106,8 +100,41 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
/**
- * 删除数组的最后一个元素（出栈）
- *
+ * 合并数组并返回一个新的 Collection 实例
+ * @access public
+ * @param mixed $items 新的数据
+ * @return static
+ */
+ public function merge($items)
+ {
+ return new static(array_merge($this->items, $this->convertToArray($items)));
+ }
+
+ /**
+ * 比较数组，返回差集生成的新 Collection 实例
+ * @access public
+ * @param mixed $items 做比较的数据
+ * @return static
+ */
+ public function diff($items)
+ {
+ return new static(array_diff($this->items, $this->convertToArray($items)));
+ }
+
+ /**
+ * 比较数组，返回交集组成的 Collection 新实例
+ * @access public
+ * @param mixed $items 比较数据
+ * @return static
+ */
+ public function intersect($items)
+ {
+ return new static(array_intersect($this->items, $this->convertToArray($items)));
+ }
+
+ /**
+ * 返回并删除数据中的的最后一个元素（出栈）
+ * @access public
* @return mixed
*/
public function pop()
@@ -116,30 +143,8 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
/**
- * 通过使用用户自定义函数，以字符串返回数组
- *
- * @param callable $callback
- * @param mixed $initial
- * @return mixed
- */
- public function reduce(callable $callback, $initial = null)
- {
- return array_reduce($this->items, $callback, $initial);
- }
-
- /**
- * 以相反的顺序返回数组。
- *
- * @return static
- */
- public function reverse()
- {
- return new static(array_reverse($this->items));
- }
-
- /**
- * 删除数组中首个元素，并返回被删除元素的值
- *
+ * 返回并删除数据中首个元素
+ * @access public
* @return mixed
*/
public function shift()
@@ -148,10 +153,64 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
/**
- * 把一个数组分割为新的数组块.
- *
- * @param int $size
- * @param bool $preserveKeys
+ * 在数组开头插入一个元素
+ * @access public
+ * @param mixed $value 值
+ * @param mixed $key 键名
+ * @return void
+ */
+ public function unshift($value, $key = null)
+ {
+ if (is_null($key)) {
+ array_unshift($this->items, $value);
+ } else {
+ $this->items = [$key => $value] + $this->items;
+ }
+ }
+
+ /**
+ * 在数组结尾插入一个元素
+ * @access public
+ * @param mixed $value 值
+ * @param mixed $key 键名
+ * @return void
+ */
+ public function push($value, $key = null)
+ {
+ if (is_null($key)) {
+ $this->items[] = $value;
+ } else {
+ $this->items[$key] = $value;
+ }
+ }
+
+ /**
+ * 通过使用用户自定义函数，以字符串返回数组
+ * @access public
+ * @param callable $callback 回调函数
+ * @param mixed $initial 初始值
+ * @return mixed
+ */
+ public function reduce(callable $callback, $initial = null)
+ {
+ return array_reduce($this->items, $callback, $initial);
+ }
+
+ /**
+ * 以相反的顺序创建一个新的 Collection 实例
+ * @access public
+ * @return static
+ */
+ public function reverse()
+ {
+ return new static(array_reverse($this->items));
+ }
+
+ /**
+ * 把数据分割为新的数组块
+ * @access public
+ * @param int $size 分隔长度
+ * @param bool $preserveKeys 是否保持原数据索引
* @return static
*/
public function chunk($size, $preserveKeys = false)
@@ -166,73 +225,40 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
/**
- * 在数组开头插入一个元素
- * @param mixed $value
- * @param miexed $key
- * @return void
- */
- public function unshift($value, $key = null)
- {
- if (is_null($key)) {
- array_unshift($this->items, $value);
- } else {
- $this->items = [$key => $value] + $this->items;
- }
- }
-
- /**
- * 在数组结尾插入一个元素
- * @param mixed $value
- * @param mixed $key
- * @return void
- */
- public function push($value, $key = null)
- {
- if (is_null($key)) {
- $this->items[] = $value;
- } else {
- $this->items[$key] = $value;
- }
- }
-
- /**
- * 给每个元素执行个回调
- *
- * @param callable $callback
+ * 给数据中的每个元素执行回调
+ * @access public
+ * @param callable $callback 回调函数
* @return $this
*/
public function each(callable $callback)
{
foreach ($this->items as $key => $item) {
$result = $callback($item, $key);
- if (false === $result) {
- break;
- } elseif (!is_object($item)) {
- $this->items[$key] = $result;
- }
+
+ if (false === $result) break;
+
+ if (!is_object($item)) $this->items[$key] = $result;
}
return $this;
}
/**
- * 用回调函数过滤数组中的元素
- * @param callable|null $callback
+ * 用回调函数过滤数据中的元素
+ * @access public
+ * @param callable|null $callback 回调函数
* @return static
*/
public function filter(callable $callback = null)
{
- if ($callback) {
- return new static(array_filter($this->items, $callback));
- }
-
- return new static(array_filter($this->items));
+ return new static(array_filter($this->items, $callback ?: null));
}
/**
- * 返回数组中指定的一列
- * @param $column_key
- * @param null $index_key
+ * 返回数据中指定的一列
+ * @access public
+ * @param mixed $column_key 键名
+ * @param null $index_key 作为索引值的列
* @return array
*/
public function column($column_key, $index_key = null)
@@ -245,10 +271,12 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
foreach ($this->items as $row) {
$key = $value = null;
$keySet = $valueSet = false;
+
if (null !== $index_key && array_key_exists($index_key, $row)) {
- $keySet = true;
$key = (string) $row[$index_key];
+ $keySet = true;
}
+
if (null === $column_key) {
$valueSet = true;
$value = $row;
@@ -256,6 +284,7 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
$valueSet = true;
$value = $row[$column_key];
}
+
if ($valueSet) {
if ($keySet) {
$result[$key] = $value;
@@ -264,51 +293,44 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
}
}
+
return $result;
}
/**
- * 对数组排序
- *
- * @param callable|null $callback
+ * 对数据排序，并返回排序后的数据组成的新 Collection 实例
+ * @access public
+ * @param callable|null $callback 回调函数
* @return static
*/
public function sort(callable $callback = null)
{
$items = $this->items;
+ $callback = $callback ?: function ($a, $b) {
+ return $a == $b ? 0 : (($a < $b) ? -1 : 1);
+ };
- $callback ? uasort($items, $callback) : uasort($items, function ($a, $b) {
-
- if ($a == $b) {
- return 0;
- }
-
- return ($a < $b) ? -1 : 1;
- });
-
- return new static($items);
+ return new static(uasort($items, $callback));
}
/**
- * 将数组打乱
- *
+ * 将数据打乱后组成新的 Collection 实例
+ * @access public
* @return static
*/
public function shuffle()
{
$items = $this->items;
- shuffle($items);
-
- return new static($items);
+ return new static(shuffle($items));
}
/**
- * 截取数组
- *
- * @param int $offset
- * @param int $length
- * @param bool $preserveKeys
+ * 截取数据并返回新的 Collection 实例
+ * @access public
+ * @param int $offset 起始位置
+ * @param int $length 截取长度
+ * @param bool $preserveKeys 是否保持原先的键名
* @return static
*/
public function slice($offset, $length = null, $preserveKeys = false)
@@ -316,17 +338,35 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
return new static(array_slice($this->items, $offset, $length, $preserveKeys));
}
- // ArrayAccess
+ /**
+ * 指定的键是否存在
+ * @access public
+ * @param mixed $offset 键名
+ * @return bool
+ */
public function offsetExists($offset)
{
return array_key_exists($offset, $this->items);
}
+ /**
+ * 获取指定键对应的值
+ * @access public
+ * @param mixed $offset 键名
+ * @return mixed
+ */
public function offsetGet($offset)
{
return $this->items[$offset];
}
+ /**
+ * 设置键值
+ * @access public
+ * @param mixed $offset 键名
+ * @param mixed $value 值
+ * @return void
+ */
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
@@ -336,33 +376,51 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
}
}
+ /**
+ * 删除指定键值
+ * @access public
+ * @param mixed $offset 键名
+ * @return void
+ */
public function offsetUnset($offset)
{
unset($this->items[$offset]);
}
- //Countable
+ /**
+ * 统计数据的个数
+ * @access public
+ * @return int
+ */
public function count()
{
return count($this->items);
}
- //IteratorAggregate
+ /**
+ * 获取数据的迭代器
+ * @access public
+ * @return ArrayIterator
+ */
public function getIterator()
{
return new ArrayIterator($this->items);
}
- //JsonSerializable
+ /**
+ * 将数据反序列化成数组
+ * @access public
+ * @return array
+ */
public function jsonSerialize()
{
return $this->toArray();
}
/**
- * 转换当前数据集为JSON字符串
+ * 转换当前数据集为 JSON 字符串
* @access public
- * @param integer $options json参数
+ * @param integer $options json 参数
* @return string
*/
public function toJson($options = JSON_UNESCAPED_UNICODE)
@@ -370,22 +428,24 @@ class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSeria
return json_encode($this->toArray(), $options);
}
+ /**
+ * 将数据转换成字符串
+ * @access public
+ * @return string
+ */
public function __toString()
{
return $this->toJson();
}
/**
- * 转换成数组
- *
- * @param mixed $items
+ * 将数据转换成数组
+ * @access protected
+ * @param mixed $items 数据
* @return array
*/
protected function convertToArray($items)
{
- if ($items instanceof self) {
- return $items->all();
- }
- return (array) $items;
+ return $items instanceof self ? $items->all() : (array) $items;
}
}
diff --git a/library/think/Config.php b/library/think/Config.php
index 6e690f0a..4b294e5a 100644
--- a/library/think/Config.php
+++ b/library/think/Config.php
@@ -25,7 +25,8 @@ class Config
/**
* 设定配置参数的作用域
- * @param string $range 作用域
+ * @access public
+ * @param string $range 作用域
* @return void
*/
public static function range($range)
@@ -37,10 +38,11 @@ class Config
/**
* 解析配置文件或内容
- * @param string $config 配置文件路径或内容
- * @param string $type 配置解析类型
- * @param string $name 配置名（如设置即表示二级配置）
- * @param string $range 作用域
+ * @access public
+ * @param string $config 配置文件路径或内容
+ * @param string $type 配置解析类型
+ * @param string $name 配置名（如设置即表示二级配置）
+ * @param string $range 作用域
* @return mixed
*/
public static function parse($config, $type = '', $name = '', $range = '')
@@ -58,9 +60,10 @@ class Config
/**
* 加载配置文件（PHP格式）
- * @param string $file 配置文件名
- * @param string $name 配置名（如设置即表示二级配置）
- * @param string $range 作用域
+ * @access public
+ * @param string $file 配置文件名
+ * @param string $name 配置名（如设置即表示二级配置）
+ * @param string $range 作用域
* @return mixed
*/
public static function load($file, $name = '', $range = '')
@@ -89,8 +92,9 @@ class Config
/**
* 检测配置是否存在
- * @param string $name 配置参数名（支持二级配置 . 号分割）
- * @param string $range 作用域
+ * @access public
+ * @param string $name 配置参数名（支持二级配置 . 号分割）
+ * @param string $range 作用域
* @return bool
*/
public static function has($name, $range = '')
@@ -108,8 +112,9 @@ class Config
/**
* 获取配置参数 为空则获取所有配置
- * @param string $name 配置参数名（支持二级配置 . 号分割）
- * @param string $range 作用域
+ * @access public
+ * @param string $name 配置参数名（支持二级配置 . 号分割）
+ * @param string $range 作用域
* @return mixed
*/
public static function get($name = null, $range = '')
@@ -146,9 +151,10 @@ class Config
/**
* 设置配置参数 name 为数组则为批量设置
- * @param string|array $name 配置参数名（支持二级配置 . 号分割）
- * @param mixed $value 配置值
- * @param string $range 作用域
+ * @access public
+ * @param string|array $name 配置参数名（支持二级配置 . 号分割）
+ * @param mixed $value 配置值
+ * @param string $range 作用域
* @return mixed
*/
public static function set($name, $value = null, $range = '')
@@ -191,7 +197,8 @@ class Config
/**
* 重置配置参数
- * @param string $range 作用域
+ * @access public
+ * @param string $range 作用域
* @return void
*/
public static function reset($range = '')
diff --git a/library/think/Console.php b/library/think/Console.php
index 1d97ab2b..2ccde883 100644
--- a/library/think/Console.php
+++ b/library/think/Console.php
@@ -20,20 +20,49 @@ use think\console\output\driver\Buffer;
class Console
{
-
+ /**
+ * @var string 命令名称
+ */
private $name;
+
+ /**
+ * @var string 命令版本
+ */
private $version;
- /** @var Command[] */
+ /**
+ * @var Command[] 命令
+ */
private $commands = [];
+ /**
+ * @var bool 是否需要帮助信息
+ */
private $wantHelps = false;
+ /**
+ * @var bool 是否捕获异常
+ */
private $catchExceptions = true;
- private $autoExit = true;
+
+ /**
+ * @var bool 是否自动退出执行
+ */
+ private $autoExit = true;
+
+ /**
+ * @var InputDefinition 输入定义
+ */
private $definition;
+
+ /**
+ * @var string 默认执行的命令
+ */
private $defaultCommand;
+ /**
+ * @var array 默认提供的命令
+ */
private static $defaultCommands = [
"think\\console\\command\\Help",
"think\\console\\command\\Lists",
@@ -47,6 +76,12 @@ class Console
"think\\console\\command\\optimize\\Schema",
];
+ /**
+ * Console constructor.
+ * @access public
+ * @param string $name 名称
+ * @param string $version 版本
+ */
public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
{
$this->name = $name;
@@ -60,38 +95,44 @@ class Console
}
}
+ /**
+ * 初始化 Console
+ * @access public
+ * @param bool $run 是否运行 Console
+ * @return int|Console
+ */
public static function init($run = true)
{
static $console;
+
if (!$console) {
- // 实例化console
+ // 实例化 console
$console = new self('Think Console', '0.1');
+
// 读取指令集
if (is_file(CONF_PATH . 'command' . EXT)) {
$commands = include CONF_PATH . 'command' . EXT;
+
if (is_array($commands)) {
foreach ($commands as $command) {
- if (class_exists($command) && is_subclass_of($command, "\\think\\console\\Command")) {
- // 注册指令
- $console->add(new $command());
- }
+ class_exists($command) &&
+ is_subclass_of($command, "\\think\\console\\Command") &&
+ $console->add(new $command()); // 注册指令
}
}
}
}
- if ($run) {
- // 运行
- return $console->run();
- } else {
- return $console;
- }
+
+ return $run ? $console->run() : $console;
}
/**
- * @param $command
- * @param array $parameters
- * @param string $driver
- * @return Output|Buffer
+ * 调用命令
+ * @access public
+ * @param string $command
+ * @param array $parameters
+ * @param string $driver
+ * @return Output
*/
public static function call($command, array $parameters = [], $driver = 'buffer')
{
@@ -110,9 +151,9 @@ class Console
/**
* 执行当前的指令
+ * @access public
* @return int
* @throws \Exception
- * @api
*/
public function run()
{
@@ -124,27 +165,21 @@ class Console
try {
$exitCode = $this->doRun($input, $output);
} catch (\Exception $e) {
- if (!$this->catchExceptions) {
- throw $e;
- }
+ if (!$this->catchExceptions) throw $e;
$output->renderException($e);
$exitCode = $e->getCode();
+
if (is_numeric($exitCode)) {
- $exitCode = (int) $exitCode;
- if (0 === $exitCode) {
- $exitCode = 1;
- }
+ $exitCode = ((int) $exitCode) ?: 1;
} else {
$exitCode = 1;
}
}
if ($this->autoExit) {
- if ($exitCode > 255) {
- $exitCode = 255;
- }
+ if ($exitCode > 255) $exitCode = 255;
exit($exitCode);
}
@@ -154,12 +189,14 @@ class Console
/**
* 执行指令
- * @param Input $input
- * @param Output $output
+ * @access public
+ * @param Input $input 输入
+ * @param Output $output 输出
* @return int
*/
public function doRun(Input $input, Output $output)
{
+ // 获取版本信息
if (true === $input->hasParameterOption(['--version', '-V'])) {
$output->writeln($this->getLongVersion());
@@ -168,6 +205,7 @@ class Console
$name = $this->getCommandName($input);
+ // 获取帮助信息
if (true === $input->hasParameterOption(['--help', '-h'])) {
if (!$name) {
$name = 'help';
@@ -182,25 +220,26 @@ class Console
$input = new Input([$this->defaultCommand]);
}
- $command = $this->find($name);
-
- $exitCode = $this->doRunCommand($command, $input, $output);
-
- return $exitCode;
+ return $this->doRunCommand($this->find($name), $input, $output);
}
/**
* 设置输入参数定义
- * @param InputDefinition $definition
+ * @access public
+ * @param InputDefinition $definition 输入定义
+ * @return $this;
*/
public function setDefinition(InputDefinition $definition)
{
$this->definition = $definition;
+
+ return $this;
}
/**
* 获取输入参数定义
- * @return InputDefinition The InputDefinition instance
+ * @access public
+ * @return InputDefinition
*/
public function getDefinition()
{
@@ -208,8 +247,9 @@ class Console
}
/**
- * Gets the help message.
- * @return string A help message.
+ * 获取帮助信息
+ * @access public
+ * @return string
*/
public function getHelp()
{
@@ -217,27 +257,34 @@ class Console
}
/**
- * 是否捕获异常
- * @param bool $boolean
- * @api
+ * 设置是否捕获异常
+ * @access public
+ * @param bool $boolean 是否捕获
+ * @return $this
*/
public function setCatchExceptions($boolean)
{
$this->catchExceptions = (bool) $boolean;
+
+ return $this;
}
/**
- * 是否自动退出
- * @param bool $boolean
- * @api
+ * 设置是否自动退出
+ * @access public
+ * @param bool $boolean 是否自动退出
+ * @return $this
*/
public function setAutoExit($boolean)
{
$this->autoExit = (bool) $boolean;
+
+ return $this;
}
/**
* 获取名称
+ * @access public
* @return string
*/
public function getName()
@@ -247,17 +294,21 @@ class Console
/**
* 设置名称
- * @param string $name
+ * @access public
+ * @param string $name 名称
+ * @return $this
*/
public function setName($name)
{
$this->name = $name;
+
+ return $this;
}
/**
* 获取版本
+ * @access public
* @return string
- * @api
*/
public function getVersion()
{
@@ -266,21 +317,30 @@ class Console
/**
* 设置版本
- * @param string $version
+ * @access public
+ * @param string $version 版本信息
+ * @return $this
*/
public function setVersion($version)
{
$this->version = $version;
+
+ return $this;
}
/**
* 获取完整的版本号
+ * @access public
* @return string
*/
public function getLongVersion()
{
if ('UNKNOWN' !== $this->getName() && 'UNKNOWN' !== $this->getVersion()) {
- return sprintf('%s version %s', $this->getName(), $this->getVersion());
+ return sprintf(
+ '%s version %s',
+ $this->getName(),
+ $this->getVersion()
+ );
}
return 'Console Tool';
@@ -288,7 +348,8 @@ class Console
/**
* 注册一个指令
- * @param string $name
+ * @access public
+ * @param string $name 指令名称
* @return Command
*/
public function register($name)
@@ -297,32 +358,37 @@ class Console
}
/**
- * 添加指令
- * @param Command[] $commands
+ * 批量添加指令
+ * @access public
+ * @param Command[] $commands 指令实例
+ * @return $this
*/
public function addCommands(array $commands)
{
- foreach ($commands as $command) {
- $this->add($command);
- }
+ foreach ($commands as $command) $this->add($command);
+
+ return $this;
}
/**
* 添加一个指令
- * @param Command $command
- * @return Command
+ * @access public
+ * @param Command $command 命令实例
+ * @return Command|bool
*/
public function add(Command $command)
{
- $command->setConsole($this);
-
if (!$command->isEnabled()) {
$command->setConsole(null);
- return;
+ return false;
}
+ $command->setConsole($this);
+
if (null === $command->getDefinition()) {
- throw new \LogicException(sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', get_class($command)));
+ throw new \LogicException(
+ sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', get_class($command))
+ );
}
$this->commands[$command->getName()] = $command;
@@ -336,14 +402,17 @@ class Console
/**
* 获取指令
- * @param string $name 指令名称
+ * @access public
+ * @param string $name 指令名称
* @return Command
* @throws \InvalidArgumentException
*/
public function get($name)
{
if (!isset($this->commands[$name])) {
- throw new \InvalidArgumentException(sprintf('The command "%s" does not exist.', $name));
+ throw new \InvalidArgumentException(
+ sprintf('The command "%s" does not exist.', $name)
+ );
}
$command = $this->commands[$name];
@@ -363,7 +432,8 @@ class Console
/**
* 某个指令是否存在
- * @param string $name 指令名称
+ * @access public
+ * @param string $name 指令名称
* @return bool
*/
public function has($name)
@@ -373,16 +443,22 @@ class Console
/**
* 获取所有的命名空间
+ * @access public
* @return array
*/
public function getNamespaces()
{
$namespaces = [];
+
foreach ($this->commands as $command) {
- $namespaces = array_merge($namespaces, $this->extractAllNamespaces($command->getName()));
+ $namespaces = array_merge(
+ $namespaces, $this->extractAllNamespaces($command->getName())
+ );
foreach ($command->getAliases() as $alias) {
- $namespaces = array_merge($namespaces, $this->extractAllNamespaces($alias));
+ $namespaces = array_merge(
+ $namespaces, $this->extractAllNamespaces($alias)
+ );
}
}
@@ -390,21 +466,25 @@ class Console
}
/**
- * 查找注册命名空间中的名称或缩写。
+ * 查找注册命名空间中的名称或缩写
+ * @access public
* @param string $namespace
* @return string
* @throws \InvalidArgumentException
*/
public function findNamespace($namespace)
{
- $allNamespaces = $this->getNamespaces();
- $expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
+ $expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
return preg_quote($matches[1]) . '[^:]*';
}, $namespace);
+
+ $allNamespaces = $this->getNamespaces();
$namespaces = preg_grep('{^' . $expr . '}', $allNamespaces);
if (empty($namespaces)) {
- $message = sprintf('There are no commands defined in the "%s" namespace.', $namespace);
+ $message = sprintf(
+ 'There are no commands defined in the "%s" namespace.', $namespace
+ );
if ($alternatives = $this->findAlternatives($namespace, $allNamespaces)) {
if (1 == count($alternatives)) {
@@ -420,8 +500,14 @@ class Console
}
$exact = in_array($namespace, $namespaces, true);
+
if (count($namespaces) > 1 && !$exact) {
- throw new \InvalidArgumentException(sprintf('The namespace "%s" is ambiguous (%s).', $namespace, $this->getAbbreviationSuggestions(array_values($namespaces))));
+ throw new \InvalidArgumentException(
+ sprintf(
+ 'The namespace "%s" is ambiguous (%s).',
+ $namespace,
+ $this->getAbbreviationSuggestions(array_values($namespaces)))
+ );
}
return $exact ? $namespace : reset($namespaces);
@@ -429,20 +515,22 @@ class Console
/**
* 查找指令
- * @param string $name 名称或者别名
+ * @access public
+ * @param string $name 名称或者别名
* @return Command
* @throws \InvalidArgumentException
*/
public function find($name)
{
- $allCommands = array_keys($this->commands);
- $expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
+ $expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
return preg_quote($matches[1]) . '[^:]*';
}, $name);
+
+ $allCommands = array_keys($this->commands);
$commands = preg_grep('{^' . $expr . '}', $allCommands);
if (empty($commands) || count(preg_grep('{^' . $expr . '$}', $commands)) < 1) {
- if (false !== $pos = strrpos($name, ':')) {
+ if (false !== ($pos = strrpos($name, ':'))) {
$this->findNamespace(substr($name, 0, $pos));
}
@@ -462,7 +550,7 @@ class Console
if (count($commands) > 1) {
$commandList = $this->commands;
- $commands = array_filter($commands, function ($nameOrAlias) use ($commandList, $commands) {
+ $commands = array_filter($commands, function ($nameOrAlias) use ($commandList, $commands) {
$commandName = $commandList[$nameOrAlias]->getName();
return $commandName === $nameOrAlias || !in_array($commandName, $commands);
@@ -473,7 +561,9 @@ class Console
if (count($commands) > 1 && !$exact) {
$suggestions = $this->getAbbreviationSuggestions(array_values($commands));
- throw new \InvalidArgumentException(sprintf('Command "%s" is ambiguous (%s).', $name, $suggestions));
+ throw new \InvalidArgumentException(
+ sprintf('Command "%s" is ambiguous (%s).', $name, $suggestions)
+ );
}
return $this->get($exact ? $name : reset($commands));
@@ -481,21 +571,20 @@ class Console
/**
* 获取所有的指令
- * @param string $namespace 命名空间
+ * @access public
+ * @param string $namespace 命名空间
* @return Command[]
- * @api
*/
public function all($namespace = null)
{
- if (null === $namespace) {
- return $this->commands;
- }
+ if (null === $namespace) return $this->commands;
$commands = [];
+
foreach ($this->commands as $name => $command) {
- if ($this->extractNamespace($name, substr_count($namespace, ':') + 1) === $namespace) {
- $commands[$name] = $command;
- }
+ $ext = $this->extractNamespace($name, substr_count($namespace, ':') + 1);
+
+ if ($ext === $namespace) $commands[$name] = $command;
}
return $commands;
@@ -503,7 +592,8 @@ class Console
/**
* 获取可能的指令名
- * @param array $names
+ * @access public
+ * @param array $names 指令名
* @return array
*/
public static function getAbbreviations($names)
@@ -511,7 +601,7 @@ class Console
$abbrevs = [];
foreach ($names as $name) {
for ($len = strlen($name); $len > 0; --$len) {
- $abbrev = substr($name, 0, $len);
+ $abbrev = substr($name, 0, $len);
$abbrevs[$abbrev][] = $name;
}
}
@@ -520,9 +610,11 @@ class Console
}
/**
- * 配置基于用户的参数和选项的输入和输出实例。
- * @param Input $input 输入实例
- * @param Output $output 输出实例
+ * 配置基于用户的参数和选项的输入和输出实例
+ * @access protected
+ * @param Input $input 输入实例
+ * @param Output $output 输出实例
+ * @return void
*/
protected function configureIO(Input $input, Output $output)
{
@@ -551,9 +643,10 @@ class Console
/**
* 执行指令
- * @param Command $command 指令实例
- * @param Input $input 输入实例
- * @param Output $output 输出实例
+ * @access protected
+ * @param Command $command 指令实例
+ * @param Input $input 输入实例
+ * @param Output $output 输出实例
* @return int
* @throws \Exception
*/
@@ -563,8 +656,9 @@ class Console
}
/**
- * 获取指令的基础名称
- * @param Input $input
+ * 获取指令的名称
+ * @access protected
+ * @param Input $input 输入实例
* @return string
*/
protected function getCommandName(Input $input)
@@ -574,6 +668,7 @@ class Console
/**
* 获取默认输入定义
+ * @access protected
* @return InputDefinition
*/
protected function getDefaultInputDefinition()
@@ -591,41 +686,55 @@ class Console
}
/**
- * 设置默认命令
- * @return Command[] An array of default Command instances
+ * 获取默认命令
+ * @access protected
+ * @return Command[]
*/
protected function getDefaultCommands()
{
$defaultCommands = [];
- foreach (self::$defaultCommands as $classname) {
- if (class_exists($classname) && is_subclass_of($classname, "think\\console\\Command")) {
- $defaultCommands[] = new $classname();
+ foreach (self::$defaultCommands as $class) {
+ if (class_exists($class) && is_subclass_of($class, "think\\console\\Command")) {
+ $defaultCommands[] = new $class();
}
}
return $defaultCommands;
}
- public static function addDefaultCommands(array $classnames)
+ /**
+ * 添加默认指令
+ * @access public
+ * @param array $classes 指令
+ * @return void
+ */
+ public static function addDefaultCommands(array $classes)
{
- self::$defaultCommands = array_merge(self::$defaultCommands, $classnames);
+ self::$defaultCommands = array_merge(self::$defaultCommands, $classes);
}
/**
* 获取可能的建议
- * @param array $abbrevs
+ * @access private
+ * @param array $abbrevs
* @return string
*/
private function getAbbreviationSuggestions($abbrevs)
{
- return sprintf('%s, %s%s', $abbrevs[0], $abbrevs[1], count($abbrevs) > 2 ? sprintf(' and %d more', count($abbrevs) - 2) : '');
+ return sprintf(
+ '%s, %s%s',
+ $abbrevs[0],
+ $abbrevs[1],
+ count($abbrevs) > 2 ? sprintf(' and %d more', count($abbrevs) - 2) : ''
+ );
}
/**
- * 返回命名空间部分
- * @param string $name 指令
- * @param string $limit 部分的命名空间的最大数量
+ * 返回指令的命名空间部分
+ * @access public
+ * @param string $name 指令名称
+ * @param string $limit 部分的命名空间的最大数量
* @return string
*/
public function extractNamespace($name, $limit = null)
@@ -638,16 +747,17 @@ class Console
/**
* 查找可替代的建议
- * @param string $name
- * @param array|\Traversable $collection
+ * @access private
+ * @param string $name 指令名称
+ * @param array|\Traversable $collection 建议集合
* @return array
*/
private function findAlternatives($name, $collection)
{
$threshold = 1e3;
$alternatives = [];
-
$collectionParts = [];
+
foreach ($collection as $item) {
$collectionParts[$item] = explode(':', $item);
}
@@ -655,6 +765,7 @@ class Console
foreach (explode(':', $name) as $i => $subname) {
foreach ($collectionParts as $collectionName => $parts) {
$exists = isset($alternatives[$collectionName]);
+
if (!isset($parts[$i]) && $exists) {
$alternatives[$collectionName] += $threshold;
continue;
@@ -663,8 +774,14 @@ class Console
}
$lev = levenshtein($subname, $parts[$i]);
- if ($lev <= strlen($subname) / 3 || '' !== $subname && false !== strpos($parts[$i], $subname)) {
- $alternatives[$collectionName] = $exists ? $alternatives[$collectionName] + $lev : $lev;
+
+ if ($lev <= strlen($subname) / 3 ||
+ '' !== $subname &&
+ false !== strpos($parts[$i], $subname)
+ ) {
+ $alternatives[$collectionName] = $exists ?
+ $alternatives[$collectionName] + $lev :
+ $lev;
} elseif ($exists) {
$alternatives[$collectionName] += $threshold;
}
@@ -673,14 +790,18 @@ class Console
foreach ($collection as $item) {
$lev = levenshtein($name, $item);
+
if ($lev <= strlen($name) / 3 || false !== strpos($item, $name)) {
- $alternatives[$item] = isset($alternatives[$item]) ? $alternatives[$item] - $lev : $lev;
+ $alternatives[$item] = isset($alternatives[$item]) ?
+ $alternatives[$item] - $lev :
+ $lev;
}
}
$alternatives = array_filter($alternatives, function ($lev) use ($threshold) {
return $lev < 2 * $threshold;
});
+
asort($alternatives);
return array_keys($alternatives);
@@ -688,24 +809,28 @@ class Console
/**
* 设置默认的指令
- * @param string $commandName The Command name
+ * @access public
+ * @param string $commandName 指令名称
+ * @return $this
*/
public function setDefaultCommand($commandName)
{
$this->defaultCommand = $commandName;
+
+ return $this;
}
/**
* 返回所有的命名空间
- * @param string $name
+ * @access private
+ * @param string $name 指令名称
* @return array
*/
private function extractAllNamespaces($name)
{
- $parts = explode(':', $name, -1);
$namespaces = [];
- foreach ($parts as $part) {
+ foreach (explode(':', $name, -1) as $part) {
if (count($namespaces)) {
$namespaces[] = end($namespaces) . ':' . $part;
} else {
diff --git a/library/think/Controller.php b/library/think/Controller.php
index e91f2d42..8dff8743 100644
--- a/library/think/Controller.php
+++ b/library/think/Controller.php
@@ -24,34 +24,36 @@ class Controller
* @var \think\View 视图类实例
*/
protected $view;
+
/**
- * @var \think\Request Request实例
+ * @var \think\Request Request 实例
*/
protected $request;
- // 验证失败是否抛出异常
+
+ /**
+ * @var bool 验证失败是否抛出异常
+ */
protected $failException = false;
- // 是否批量验证
+
+ /**
+ * @var bool 是否批量验证
+ */
protected $batchValidate = false;
/**
- * 前置操作方法列表
- * @var array $beforeActionList
- * @access protected
+ * @var array 前置操作方法列表
*/
protected $beforeActionList = [];
/**
* 构造方法
- * @param Request $request Request对象
* @access public
+ * @param Request $request Request 对象
*/
public function __construct(Request $request = null)
{
- if (is_null($request)) {
- $request = Request::instance();
- }
- $this->view = View::instance(Config::get('template'), Config::get('view_replace_str'));
- $this->request = $request;
+ $this->view = View::instance(Config::get('template'), Config::get('view_replace_str'));
+ $this->request = is_null($request) ? Request::instance() : $request;
// 控制器初始化
$this->_initialize();
@@ -66,7 +68,10 @@ class Controller
}
}
- // 初始化
+ /**
+ * 初始化操作
+ * @access protected
+ */
protected function _initialize()
{
}
@@ -74,8 +79,9 @@ class Controller
/**
* 前置操作
* @access protected
- * @param string $method 前置操作方法名
- * @param array $options 调用参数 ['only'=>[...]] 或者['except'=>[...]]
+ * @param string $method 前置操作方法名
+ * @param array $options 调用参数 ['only'=>[...]] 或者 ['except'=>[...]]
+ * @return void
*/
protected function beforeAction($method, $options = [])
{
@@ -83,6 +89,7 @@ class Controller
if (is_string($options['only'])) {
$options['only'] = explode(',', $options['only']);
}
+
if (!in_array($this->request->action(), $options['only'])) {
return;
}
@@ -90,6 +97,7 @@ class Controller
if (is_string($options['except'])) {
$options['except'] = explode(',', $options['except']);
}
+
if (in_array($this->request->action(), $options['except'])) {
return;
}
@@ -101,10 +109,10 @@ class Controller
/**
* 加载模板输出
* @access protected
- * @param string $template 模板文件名
- * @param array $vars 模板输出变量
- * @param array $replace 模板替换
- * @param array $config 模板参数
+ * @param string $template 模板文件名
+ * @param array $vars 模板输出变量
+ * @param array $replace 模板替换
+ * @param array $config 模板参数
* @return mixed
*/
protected function fetch($template = '', $vars = [], $replace = [], $config = [])
@@ -115,10 +123,10 @@ class Controller
/**
* 渲染内容输出
* @access protected
- * @param string $content 模板内容
- * @param array $vars 模板输出变量
- * @param array $replace 替换内容
- * @param array $config 模板参数
+ * @param string $content 模板内容
+ * @param array $vars 模板输出变量
+ * @param array $replace 替换内容
+ * @param array $config 模板参数
* @return mixed
*/
protected function display($content = '', $vars = [], $replace = [], $config = [])
@@ -129,24 +137,28 @@ class Controller
/**
* 模板变量赋值
* @access protected
- * @param mixed $name 要显示的模板变量
- * @param mixed $value 变量的值
- * @return void
+ * @param mixed $name 要显示的模板变量
+ * @param mixed $value 变量的值
+ * @return $this
*/
protected function assign($name, $value = '')
{
$this->view->assign($name, $value);
+
+ return $this;
}
/**
* 初始化模板引擎
* @access protected
* @param array|string $engine 引擎参数
- * @return void
+ * @return $this
*/
protected function engine($engine)
{
$this->view->engine($engine);
+
+ return $this;
}
/**
@@ -158,17 +170,18 @@ class Controller
protected function validateFailException($fail = true)
{
$this->failException = $fail;
+
return $this;
}
/**
* 验证数据
* @access protected
- * @param array $data 数据
- * @param string|array $validate 验证器名或者验证规则数组
- * @param array $message 提示信息
- * @param bool $batch 是否批量验证
- * @param mixed $callback 回调方法（闭包）
+ * @param array $data 数据
+ * @param string|array $validate 验证器名或者验证规则数组
+ * @param array $message 提示信息
+ * @param bool $batch 是否批量验证
+ * @param mixed $callback 回调方法（闭包）
* @return array|string|true
* @throws ValidateException
*/
@@ -178,24 +191,21 @@ class Controller
$v = Loader::validate();
$v->rule($validate);
} else {
+ // 支持场景
if (strpos($validate, '.')) {
- // 支持场景
list($validate, $scene) = explode('.', $validate);
}
+
$v = Loader::validate($validate);
- if (!empty($scene)) {
- $v->scene($scene);
- }
- }
- // 是否批量验证
- if ($batch || $this->batchValidate) {
- $v->batch(true);
- }
-
- if (is_array($message)) {
- $v->message($message);
+
+ !empty($scene) && $v->scene($scene);
}
+ // 批量验证
+ if ($batch || $this->batchValidate) $v->batch(true);
+ // 设置错误信息
+ if (is_array($message)) $v->message($message);
+ // 使用回调验证
if ($callback && is_callable($callback)) {
call_user_func_array($callback, [$v, &$data]);
}
@@ -203,11 +213,11 @@ class Controller
if (!$v->check($data)) {
if ($this->failException) {
throw new ValidateException($v->getError());
- } else {
- return $v->getError();
}
- } else {
- return true;
+
+ return $v->getError();
}
+
+ return true;
}
}
diff --git a/library/think/Cookie.php b/library/think/Cookie.php
index 3205fcd9..791d4f67 100644
--- a/library/think/Cookie.php
+++ b/library/think/Cookie.php
@@ -13,68 +13,68 @@ namespace think;
class Cookie
{
+ /**
+ * @var array cookie 设置参数
+ */
protected static $config = [
- // cookie 名称前缀
- 'prefix' => '',
- // cookie 保存时间
- 'expire' => 0,
- // cookie 保存路径
- 'path' => '/',
- // cookie 有效域名
- 'domain' => '',
- // cookie 启用安全传输
- 'secure' => false,
- // httponly设置
- 'httponly' => '',
- // 是否使用 setcookie
- 'setcookie' => true,
+ 'prefix' => '', // cookie 名称前缀
+ 'expire' => 0, // cookie 保存时间
+ 'path' => '/', // cookie 保存路径
+ 'domain' => '', // cookie 有效域名
+ 'secure' => false, // cookie 启用安全传输
+ 'httponly' => '', // httponly 设置
+ 'setcookie' => true, // 是否使用 setcookie
];
+ /**
+ * @var bool 是否完成初始化了
+ */
protected static $init;
/**
* Cookie初始化
- * @param array $config
+ * @access public
+ * @param array $config 配置参数
* @return void
*/
public static function init(array $config = [])
{
- if (empty($config)) {
- $config = Config::get('cookie');
- }
+ if (empty($config)) $config = Config::get('cookie');
+
self::$config = array_merge(self::$config, array_change_key_case($config));
+
if (!empty(self::$config['httponly'])) {
ini_set('session.cookie_httponly', 1);
}
+
self::$init = true;
}
/**
- * 设置或者获取cookie作用域（前缀）
- * @param string $prefix
- * @return string|void
+ * 设置或者获取 cookie 作用域（前缀）
+ * @access public
+ * @param string $prefix 前缀
+ * @return string|
*/
public static function prefix($prefix = '')
{
- if (empty($prefix)) {
- return self::$config['prefix'];
- }
- self::$config['prefix'] = $prefix;
+ if (empty($prefix)) return self::$config['prefix'];
+
+ return self::$config['prefix'] = $prefix;
}
/**
* Cookie 设置、获取、删除
- *
- * @param string $name cookie名称
- * @param mixed $value cookie值
- * @param mixed $option 可选参数 可能会是 null|integer|string
- *
- * @return mixed
- * @internal param mixed $options cookie参数
+ * @access public
+ * @param string $name cookie 名称
+ * @param mixed $value cookie 值
+ * @param mixed $option 可选参数 可能会是 null|integer|string
+ * @return void
*/
public static function set($name, $value = '', $option = null)
{
!isset(self::$init) && self::init();
+
// 参数设置(会覆盖黙认设置)
if (!is_null($option)) {
if (is_numeric($option)) {
@@ -82,143 +82,176 @@ class Cookie
} elseif (is_string($option)) {
parse_str($option, $option);
}
+
$config = array_merge(self::$config, array_change_key_case($option));
} else {
$config = self::$config;
}
+
$name = $config['prefix'] . $name;
- // 设置cookie
+
+ // 设置 cookie
if (is_array($value)) {
array_walk_recursive($value, 'self::jsonFormatProtect', 'encode');
$value = 'think:' . json_encode($value);
}
- $expire = !empty($config['expire']) ? $_SERVER['REQUEST_TIME'] + intval($config['expire']) : 0;
+
+ $expire = !empty($config['expire']) ?
+ $_SERVER['REQUEST_TIME'] + intval($config['expire']) :
+ 0;
+
if ($config['setcookie']) {
- setcookie($name, $value, $expire, $config['path'], $config['domain'], $config['secure'], $config['httponly']);
+ setcookie(
+ $name, $value, $expire, $config['path'], $config['domain'],
+ $config['secure'], $config['httponly']
+ );
}
+
$_COOKIE[$name] = $value;
}
/**
- * 永久保存Cookie数据
- * @param string $name cookie名称
- * @param mixed $value cookie值
- * @param mixed $option 可选参数 可能会是 null|integer|string
+ * 永久保存 Cookie 数据
+ * @access public
+ * @param string $name cookie 名称
+ * @param mixed $value cookie 值
+ * @param mixed $option 可选参数 可能会是 null|integer|string
* @return void
*/
public static function forever($name, $value = '', $option = null)
{
- if (is_null($option) || is_numeric($option)) {
- $option = [];
- }
+ if (is_null($option) || is_numeric($option)) $option = [];
+
$option['expire'] = 315360000;
+
self::set($name, $value, $option);
}
/**
- * 判断Cookie数据
- * @param string $name cookie名称
- * @param string|null $prefix cookie前缀
+ * 判断是否有 Cookie 数据
+ * @access public
+ * @param string $name cookie 名称
+ * @param string|null $prefix cookie 前缀
* @return bool
*/
public static function has($name, $prefix = null)
{
!isset(self::$init) && self::init();
+
$prefix = !is_null($prefix) ? $prefix : self::$config['prefix'];
- $name = $prefix . $name;
- return isset($_COOKIE[$name]);
+
+ return isset($_COOKIE[$prefix . $name]);
}
/**
- * Cookie获取
- * @param string $name cookie名称
- * @param string|null $prefix cookie前缀
+ * 获取 Cookie 的值
+ * @access public
+ * @param string $name cookie 名称
+ * @param string|null $prefix cookie 前缀
* @return mixed
*/
public static function get($name = '', $prefix = null)
{
!isset(self::$init) && self::init();
+
$prefix = !is_null($prefix) ? $prefix : self::$config['prefix'];
- $key = $prefix . $name;
+ $key = $prefix . $name;
if ('' == $name) {
// 获取全部
if ($prefix) {
$value = [];
+
foreach ($_COOKIE as $k => $val) {
- if (0 === strpos($k, $prefix)) {
- $value[$k] = $val;
- }
+ if (0 === strpos($k, $prefix)) $value[$k] = $val;
}
} else {
$value = $_COOKIE;
}
} elseif (isset($_COOKIE[$key])) {
$value = $_COOKIE[$key];
+
if (0 === strpos($value, 'think:')) {
- $value = substr($value, 6);
- $value = json_decode($value, true);
+ $value = json_decode(substr($value, 6), true);
array_walk_recursive($value, 'self::jsonFormatProtect', 'decode');
}
} else {
$value = null;
}
+
return $value;
}
/**
- * Cookie删除
- * @param string $name cookie名称
- * @param string|null $prefix cookie前缀
- * @return mixed
+ * 删除 Cookie
+ * @access public
+ * @param string $name cookie 名称
+ * @param string|null $prefix cookie 前缀
+ * @return void
*/
public static function delete($name, $prefix = null)
{
!isset(self::$init) && self::init();
+
$config = self::$config;
$prefix = !is_null($prefix) ? $prefix : $config['prefix'];
$name = $prefix . $name;
+
if ($config['setcookie']) {
- setcookie($name, '', $_SERVER['REQUEST_TIME'] - 3600, $config['path'], $config['domain'], $config['secure'], $config['httponly']);
+ setcookie(
+ $name, '', $_SERVER['REQUEST_TIME'] - 3600, $config['path'],
+ $config['domain'], $config['secure'], $config['httponly']
+ );
}
- // 删除指定cookie
+
+ // 删除指定 cookie
unset($_COOKIE[$name]);
}
/**
- * Cookie清空
- * @param string|null $prefix cookie前缀
- * @return mixed
+ * 清除指定前缀的所有 cookie
+ * @access public
+ * @param string|null $prefix cookie 前缀
+ * @return void
*/
public static function clear($prefix = null)
{
- // 清除指定前缀的所有cookie
- if (empty($_COOKIE)) {
- return;
- }
+ if (empty($_COOKIE)) return;
+
!isset(self::$init) && self::init();
- // 要删除的cookie前缀，不指定则删除config设置的指定前缀
+
+ // 要删除的 cookie 前缀，不指定则删除 config 设置的指定前缀
$config = self::$config;
$prefix = !is_null($prefix) ? $prefix : $config['prefix'];
+
if ($prefix) {
- // 如果前缀为空字符串将不作处理直接返回
foreach ($_COOKIE as $key => $val) {
if (0 === strpos($key, $prefix)) {
if ($config['setcookie']) {
- setcookie($key, '', $_SERVER['REQUEST_TIME'] - 3600, $config['path'], $config['domain'], $config['secure'], $config['httponly']);
+ setcookie(
+ $key, '', $_SERVER['REQUEST_TIME'] - 3600, $config['path'],
+ $config['domain'], $config['secure'], $config['httponly']
+ );
}
+
unset($_COOKIE[$key]);
}
}
}
- return;
}
- private static function jsonFormatProtect(&$val, $key, $type = 'encode')
+ /**
+ * json 转换时的格式保护
+ * @access protected
+ * @param mixed $val 要转换的值
+ * @param string $key 键名
+ * @param string $type 转换类别
+ * @return void
+ */
+ protected static function jsonFormatProtect(&$val, $key, $type = 'encode')
{
if (!empty($val) && true !== $val) {
$val = 'decode' == $type ? urldecode($val) : urlencode($val);
}
}
-
}