IBOS open source
  • Namespace
  • Class

Namespaces

  • application
    • core
      • cache
        • driver
        • provider
      • components
      • controllers
      • engines
        • local
        • sae
      • model
      • modules
      • utils
      • widgets
    • modules
      • article
        • controllers
        • core
        • model
        • utils
      • calendar
        • controllers
        • model
        • utils
      • contact
        • controllers
        • model
        • utils
      • dashboard
        • controllers
        • model
        • utils
      • department
        • components
        • model
        • utils
      • diary
        • components
        • controllers
        • model
        • utils
        • widgets
      • email
        • controllers
        • core
        • model
        • utils
      • main
        • behaviors
        • components
        • controllers
        • model
        • utils
        • widgets
      • message
        • controllers
        • core
          • co
          • wx
            • callback
            • event
        • model
        • utils
      • mobile
        • components
        • controllers
        • utils
      • position
        • components
        • model
        • utils
      • recruit
        • components
        • controllers
        • core
        • model
        • utils
        • widgets
      • role
        • model
        • utils
      • user
        • components
        • controllers
        • model
        • utils
      • vote
        • components
        • controllers
        • model
        • utils
      • weibo
        • controllers
        • core
        • model
        • utils

Classes

  • CoApi
  • CodeApi

Class CoApi

CApplicationComponent
Extended by application\core\utils\System
Extended by application\core\utils\Api
Extended by application\modules\message\core\co\CoApi
Namespace: application\modules\message\core\co
Copyright: Copyright © 2015 IBOS Inc
Author: mumu 2317216477@qq.com
Located at system/modules/message/core/co/CoApi.php

Methods summary

public
# setSignParam( $param )

Parameters

$param
public string
# getSignParam( )

Returns

string
public
# setSignTypeParam( string $param )

Parameters

$param
public string
# getSignTypeParam( )

Returns

string
public
# setAuthKey( string $key )

设置验证签名用的私钥

设置验证签名用的私钥

Parameters

$key
public string
# getAuthKey( )

返回私钥

返回私钥

Returns

string
public
# setSignType( string $type )

设置签名方法

设置签名方法

Parameters

$type
public string
# getSignType( )

返回签名方法

返回签名方法

Returns

string
public static object
# getInstance( $className = __CLASS__ )

单例化api

单例化api

Returns

object

Overrides

application\core\utils\Api::getInstance
public array
# getCoToken( string $mobile, string $password )

根据酷办公账号密码获取对应accesstoken的信息

根据酷办公账号密码获取对应accesstoken的信息

Parameters

$mobile
$password

Returns

array
public array
# getUserInfo( string $accesstoken, string $uid = '' )

根据accesstoken获取用户的信息

根据accesstoken获取用户的信息

Parameters

$accesstoken
$uid

Returns

array
public type
# getCorpByCorpToken( type $corptoken )

根据corptoken获取corp的信息

根据corptoken获取corp的信息

Parameters

$corptoken

Returns

type
public type
# updateCorpByCorpToken( type $corptoken, type $post )

通过corptoken更新corp信息 支持的参数 "aeskey":"xxx", "regip":"xxxx", "logo":"xx", "name":"xx", "shortname":"xx", "area":"xx", "systemurl":"http://oa.xxx.com", "sysuser":"admin", "syspassword":"123456", "opencloud":0

通过corptoken更新corp信息 支持的参数 "aeskey":"xxx", "regip":"xxxx", "logo":"xx", "name":"xx", "shortname":"xx", "area":"xx", "systemurl":"http://oa.xxx.com", "sysuser":"admin", "syspassword":"123456", "opencloud":0

Parameters

$corptoken
$post

Returns

type
public type
# quitCorpByCorpToken( type $corptoken )

根据corptoken退出corp

根据corptoken退出corp

Parameters

$corptoken

Returns

type
public type
# createCorpByToken( type $accesstoken, array $post )

根据accesstoken创建corp 请求参数说明:

根据accesstoken创建corp 请求参数说明:

  • accesstoken:个人令牌。
  • name:企业名称。
  • code:企业代码
  • createfrom:(可选)用于标识哪个平台创建的
  • regip:(可选)注册IP
  • opencloud:(可选) yes or no 是否开启云端版IBOS

Parameters

$accesstoken
$post
参照上面参数

Returns

type
public type
# checkMobile( type $mobile )

验证手机号是否注册

验证手机号是否注册

Parameters

$mobile

Returns

type
public type
# registerUser( array $post, string $openId = '' )

注册用户 请求参数说明: mobile: 用户注册手机号。 email : 用户邮箱 username : 用户名 以上三项不可同时为空。可全部填也可只提供一项。 password:MD5加密用户明文密码后的字符串 openid:(可选)微信登录openid

注册用户 请求参数说明: mobile: 用户注册手机号。 email : 用户邮箱 username : 用户名 以上三项不可同时为空。可全部填也可只提供一项。 password:MD5加密用户明文密码后的字符串 openid:(可选)微信登录openid

Parameters

$post
$openId

Returns

type
public type
# getVerifyCode( array $post )

获取验证码

获取验证码

Parameters

$post
这里只有一个mobile参数

Returns

type
public array
# checkVerifyCode( array $post )

验证验证码

验证验证码

Parameters

$post
需要带上mobiel和code参数

Returns

array
public array
# searchCorp( string $key, boolean $unique = false, integer $page = 0, integer $size = 20 )

搜索企业

搜索企业

Parameters

$key
搜索关键字
$unique
是否完全匹配
$page
当前页数
$size
每页显示条数

Returns

array
public array
# returnSignParam( type $arr = array() )

返回签名数组

返回签名数组

Parameters

$arr

Returns

array
public type
# getSignature( type $param, type $method = 'md5', type $key = self::IBOS_KEY )

获取签名

获取签名

Parameters

$param
$method
$key

Returns

type
public type
# returnJsonDecode( string $res )

让json_decode的第二个默认参数是false改成true

让json_decode的第二个默认参数是false改成true

Parameters

$res
返回的json格式字符串

Returns

type
protected 去掉空值与签名参数后的新签名参数组
# paraFilter( $para )

除去数组中的空值和签名参数

除去数组中的空值和签名参数

Parameters

$para
签名参数组

Returns

去掉空值与签名参数后的新签名参数组
protected 排序后的数组
# argSort( $param )

对数组排序

对数组排序

Parameters

$param
排序前的数组

Returns

排序后的数组
protected string
# createLinkstring( $param )

把数组所有元素,按照“参数=参数值”的模式用“&”字符拼接成字符串

把数组所有元素,按照“参数=参数值”的模式用“&”字符拼接成字符串

Parameters

$param
需要拼接的数组

Returns

string
拼接完成以后的字符串

Methods inherited from application\core\utils\Api

buildUrl(), fetchResult(), getOpt(), setOpt()

Constants summary

string CO_URL
# 'http://www.ibos.cn/'
string API_CENTER
# 'http://api.ibos.cn/'
string API_USER_GET_TOKEN
# 'http://api.ibos.cn/v1/users/login'
string API_USER_GET_INFO
# 'http://api.ibos.cn/v1/users/view'
string API_CORP_SEARCH
# 'http://api.ibos.cn/v1/corp/search'
string API_CORP_GET_INFO
# 'http://api.ibos.cn/v1/corp/view'
string API_CORP_CREATE
# 'http://api.ibos.cn/v1/corp/create'
string API_CORP_UPDATE_INFO
# 'http://api.ibos.cn/v1/corp/update'
string API_CORP_QUIT
# 'http://api.ibos.cn/v1/corp/quit'
string API_USER_REGISTER
# 'http://api.ibos.cn/v1/users/register'
string API_VERIFYCODE_GET
# 'http://api.ibos.cn/v1/users/verify'
string API_VERIFYCODE_CHECK
# 'http://api.ibos.cn/v1/users/verify'
string API_CHECK_MOBILE
# 'http://api.ibos.cn/v1/users/checkmobile'
string IBOS_KEY
# '3569c4ee701cb512fef319fc16ec88af'

Properties summary

Properties inherited from application\core\utils\Api

$curlopt

IBOS open source API documentation generated by ApiGen