# think-jump

**Repository Path**: openadm/think-jump

## Basic Information

- **Project Name**: think-jump
- **Description**: ThinkPHP 跳转扩展
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-04-18
- **Last Updated**: 2024-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ThinkPHP6跳转扩展
支持Html和Ajax两种数据返回方式。
ThinkPHP6已从核心中移除Jump类，类里面包含`success`、`error`、`forbidden`、`unauthorized`、`redirect`和`result`方法。这几个方法在项目里面用的蛮多的，所以将它们移植成一个扩展使用。

## 安装
```
composer require openadm/think-jump
```

## 通过 门面(facade) 操作

### Jump::success($msg, $url, $wait, $header, $data)
```php
//facade
use \openadm\think\facade\Jump;

// 显示提示信息，然后返回上一页
Jump::success('操作成功!');

// 显示提示信息，然后返回Index/index页面
Jump::success('操作成功!', 'Index/index');

// 显示提示信息，然后15秒后返回Index/index页面
Jump::success('操作成功!', 'Index/index', 15);

// 显示提示信息，并且为页面添加header头，然后15秒后返回Index/index页面
Jump::success('操作成功!', 'Index/index', 15, ['auth-token' => 'xxx']);
```

## 通过 trait 操作

### Jump::error($msg, $url, $wait, $header, $data)
```php
//trait
use \openadm\think\traits\Jump;

// 显示提示信息，然后返回上一页
$this->error('操作失败!');

// 显示提示信息，然后返回Index/index页面
$this->error('操作失败!', 'Index/index');

// 显示提示信息，然后15秒后返回Index/index页面
$this->error('操作失败!', 'Index/index', 15);

// 显示提示信息，并且为页面添加header头，然后15秒后返回Index/index页面
$this->error('操作失败!', 'Index/index', 15, ['auth-token' => 'xxx']);
```

## 其他示例

### Jump::redirect($url, $msg, $code, $header)
```php
//跳转
Jump::redirect($url, $msg, $code, $header)

```

### Jump::result($data, $code, $msg, $type, $header)
```php
$result = [
    ['id' => 1, 'name' => 'openadm'],
    ['id' => 2, 'name' => 'china'],
];

// 返回封装后的数据集
Jump::result($result);

// 返回封装后的数据集，并且设置code
Jump::result($result, 'success');

// 返回封装后的数据集，并且设置code和msg
Jump::result($result, 'success', '查询成功');

// 返回封装后的数据集，并且设置code、msg和数据类型
Jump::result($result, 'success', '查询成功', 'json');

// 返回封装后的数据集，并且设置code、msg、数据类型和Header头
Jump::result($result, 'success', '查询成功', 'json', ['auth-token' => 'xxx']);


```

## AJAX请求
当前请求信息`header`中的`x-requested-with`为`XMLHttpRequest`时，会被认定为AJAX请求。
这时候，程序根据`header`中的`accept`来自动判断客户端所需要的数据类型，然后返回对应的数据类型。

目前，仅支持三种数据类型：`json`、`jsonp`和`xml`。

### JSON返回示例
```json
{
    "code": 0,
    "msg": "操作成功!",
    "url": "/Index/index",
    "wait": 15,
    "data": null
}
```

### JSONP返回示例
> 可在请求信息中携带`callback`参数来自定义`JSONP`回调方法，一般放在URL地址参数中，也可以放在POST参数中。
```js
jsonpReturn({
    "code": 0,
    "msg": "操作成功!",
    "url": "/Index/index",
    "wait": 15,
    "data": null
});
```

### XML返回示例
```xml
<?xml version="1.0" encoding="utf-8"?>
<think>
    <code>0</code>
    <msg>操作成功!</msg>
    <url>/Index/index</url>
    <wait>15</wait>
    <data></data>
</think>
```

## 使用配置
初始化时，首先会读取应用配置`jump.php`，然后再合并初始化时传入的配置。
优先级：`默认配置` < `配置文件` < `初始化配置`

### 配置文件
composer安装 会生成config/jump.php配置文件。
```php
<?php
// 跳转配置
return [
    // 成功跳转页面模板文件
    'success_tmpl' => app()->getRootPath() . 'vendor/openadm/think-jump/src/tpl/success.html',
    // 成功跳转页停留时间(秒)
    'success_wait' => 1,
    // 成功跳转的code值
    'success_code' => 200,
    // 错误跳转页面模板文件
    'error_tmpl'   => app()->getRootPath() . 'vendor/openadm/think-jump/src/tpl/error.html',
    // 错误跳转页停留时间(秒)
    'error_wait'   => 3,
    // 错误跳转的code值
    'error_code'   => 300,
    'forbidden_code'  => 403,
    //Unauthorized
    'unauthorized_code' => 401,
    // 默认AJAX请求返回数据格式，可用：Json,Jsonp,Xml
    'ajax_return' => 'Json',
];
```