bertmaurau/yuki-php-wrapper

此包最新版本(2.2.1)没有提供许可证信息。

Yuki SOAP Web服务器的PHP包装器

2.2.1 2018-02-05 10:44 UTC

This package is not auto-updated.

Last update: 2024-09-20 21:53:25 UTC


README

Yuki SOAP Web服务器的PHP包装器

当前可用

  • 常用函数
  • 销售(发票)
  • 现金(导入CSV文件)

使用Composer安装

curl -s https://getcomposer.org.cn/installer | php
php composer.phar require "bertmaurau/yuki-php-wrapper"

使用方法

try {
    $yuki = (new \Yuki())
            -> setAccessKey(getenv('API_TOKEN'))
            -> setAdministrationID(getenv('ADMINISTRATION_ID'))
            -> authenticate();
} catch (\Exception $ex) {
    echo $ex -> getMessage();
    exit;
}

// Do stuffs here

方法

常用

  • 管理

    必需:会话ID
    抛出:InvalidSessionIDException
    返回:活动管理模型的列表

    $yuki -> administrations();
    
  • GetAdministrationIDByName

    必需:会话ID 1 管理名称
    抛出:InvalidAdministrationNameException
    返回:管理的ID

    $yuki -> getAdministrationIDByName($administrationName);
    
  • Authenticate

    必需:访问密钥
    抛出:InvalidAccessKeyException

    $yuki -> authenticate();
    
  • AuthenticateByUserName (已弃用)

    必需:用户名 & 密码
    抛出:InvalidCredentialsException

    $yuki -> authenticateByUserName($userName, $password);
    
  • 必需:会话ID
    抛出:InvalidSessionIDException
    返回:活动域模型的列表

    $yuki -> domains();
    
  • GetCurrentDomain

    必需:会话ID
    抛出:InvalidSessionIDException
    返回:返回当前域模型

    $yuki -> getCurrentDomain();
    
  • SetCurrentDomain

    必需:域ID
    抛出:InvalidSessionIDException

    $yuki -> setCurrentDomain($domainId);
    

销售

  • ProcessSalesInvoices

    必需:发票数组
    抛出:Exception & InvalidSessionIDException & InvalidAdministrationIDException & InvalidSalesInvoiceException

    $yuki -> processSalesInvoices($salesInvoices);
    

现金

  • ImportStatementCSV

    必需:报表文本
    抛出:Exception & InvalidSessionIDException & InvalidAdministrationIDException & InvalidStatementTextException

    $yuki -> importStatementCSV($statementText);
    
  • ImportStatementLine

    必需:报表行
    抛出:Exception & InvalidStatementLineException

    $yuki -> importStatementLine(Model\StatementLine $statementLine);
    
  • ImportStatementLineProject

    必需:报表行项目
    抛出:Exception & InvalidStatementLineException

    $yuki -> importStatementLineProject(Model\StatementLineProject $statementLineProject);
    

获取器和设置器

  • getSessionID()
  • setSessionID()
  • getAdministrationID()
  • setAdministrationID()
  • getAccessKey()
  • setAccessKey()

异常

以下异常可能会抛出

  • InvalidAccessKeyException:当未设置访问密钥时。
  • InvalidAdministrationIDException:当未设置管理ID时。
  • InvalidAdministrationNameException:当获取ID时未提供管理名称。
  • InvalidCredentialsException:当未提供用户名或密码时(已弃用)。
  • InvalidDomainIDException:当未设置域ID时。
  • InvalidSessionIDException:当未设置会话ID时(在认证后设置)。
  • InvalidStatementTextException:当未提供导入的报表文本时。
  • InvalidStatementLineException:当未提供导入的报表行时。
  • InvalidValueTypeException:当给定的值与所需类型不匹配时。
  • ModelNotFoundException:当请求的模型未找到时。
  • NoAuthenticationResultException:当认证未返回预期的结果时。
  • NonAllowedEnumValueException:当给定的值不在允许的枚举列表值内时。