API 文档 - ginkgo


ginkgo\Lang

语言处理


类摘要

namespace ginkgo;

class Lang {
    // 属性
    public $lang;
    public $config = array();
    public $current;
    public $clientLang;
    public $range = '';

    protected static $instance;

    private $configThis = array(
        'switch'    => false,
        'default'   => 'zh_CN',
    );

    // 方法
    public static instance( [ array $config ] ) : object
    public config( array $config )
    public range( string $range ) : string
    public getCurrent( [ bool $lower = false [, string $separator [, bool $client = false ]]] ) : string
    public setCurrent( string $lang )
    public add( mixed $name [, mixed $value [, string $range ]] )
    public set( mixed $name [, mixed $value [, string $range ]] )
    public get( [ string $name [, string $range [, array $replace [, bool $show_src = true ]]]] ) : mixed
    public load( string $path [, string $range ] ) : mixed

    protected __construct( [ array $config ] ) : object
    protected __clone()

    private init()
    private rangeProcess( string $range ) : mixed
}

成员目录

- 权限 类型 描述
属性 - - -
$lang public string 错误
$config public string 错误
$current public string 错误
$clientLang public string 错误
$range public string 错误
$instance protected object static 本类实例
$configThis private array 默认图片 MIME
方法 - - -
instance() public static 实例化
config() public 配置
range() public 设置、获取作用域
getCurrent() public 获取当前语言
setCurrent() public 设置当前语言
add() public 添加语言变量
set() public 设置语言变量
get() public 获取语言变量
load() public 载入语言文件
__construct() protected instance()
__clone() protected 克隆,无实际功能,仅供限制为单例模式使用
init() private 初始化
rangeProcess() private 作用域处理

$config 配置,$configThis 默认配置

public $config;
private $configThis;

结构

名称 类型 默认 描述
switch bool false 是否启用开关
default string zh_CN 默认语言

instance() 实例化方法

public static function instance( [ array $config ] ) : object

参数

返回

  • 本类的实例

config() 配置

public function config( array $config )

参数

返回


range() 设置、获取作用域

public function range( [ string $range ] ) : array

参数

  • range 作用域,支持二级作用域,两级作用域之间用 . 隔开,如此参数为空,则返回作用域

返回

  • 作用域

getCurrent() 获取当前语言

public function getCurrent( string $stamp [, array $font [, mixed $size = false [, mixed $posi = false [, int $angle = 0 [, int $pct = 100 ]]]]] ) : object

参数

  • stamp 文字或水印图片路径,

    当本参数为路径且图片文件不存在,或 font 参数不为空时代表文字水印

  • font 字体

  • size 水印尺寸
  • posi 水印位置
  • angle 水印旋转角度,0 - 360 之间
  • pct 水印透明度,0 - 100 之间,0 代表透明,100 代表不透明

返回

  • 本类的实例

setCurrent() 设置当前语言

public function setCurrent( int $width, int $height [, int $x_src = 0 [, int $y_src = 0 [, mixed $width_src = false [, mixed $height_src = false ]]]] ) : object

参数

  • width 目的宽度
  • height 目的高度
  • x_src 原始图片的 x 点
  • y_src 原始图片的 y 点
  • width_src 源宽度
  • height_src 源高度

返回

  • 本类的实例

add() 添加语言变量(不覆盖)

public function add( mixed $name [, mixed $value [, string $range ]] )

参数

  • name 名称

    支持两种类型:为字符串时表示语言变量名,为数组时表示批量添加

  • value

    name 为字符串时为必须,当 name 为数组时自动忽略。

  • range 作用域

返回


set() 设置语言变量(覆盖)

public function set( mixed $name [, mixed $value [, string $range ]] )

参数

  • name 名称

    支持两种类型:为字符串时表示语言变量名,为数组时表示批量设置

  • value

    name 为字符串时为必须,当 name 为数组时自动忽略。

  • range 作用域

返回


get() 读取语言变量

public function get( [ string $name [, string $range [, array $replace [, bool $show_src = true ]]]] ) : mixed

参数

  • name 名称
  • range 作用域
  • replace 输出替换
  • show_src 返回原始字符

返回

  • 语言变量

load() 载入语言文件

public function load( string $path [, string $range ] ) : mixed

参数

  • path 语言文件路径
  • range 作用域

返回

  • 语言文件内容

init() 初始化

private function init()

参数

返回


rangeProcess() 作用域处理

private function rangeProcess( string $range ) : mixed

参数

  • range 作用域

返回

  • 作用域