API Documentation
\

\BEAR_Img_Adapter_GD

GDクラス

画像ライブラリGDを取り扱うクラスです。

Summary

Methods
Properties
Constants
__construct()
onInject()
deleteFile()
getTmpFileName()
resizeMobile()
loadRemoteFile()
getExtention()
setConfig()
getConfig()
setService()
load()
resize()
show()
save()
$image
$deleteFiles
$adapter
No constants found
getImageInfo()
header()
_error()
_exception()
$file
$_srcWidth
$_srcHeight
$_srcAttr
$_result
$_log
$_config
$format
$result
N/A
No private methods found
$_srcType
$_imgResource
$_newWidth
$_newHeight
N/A

Properties

$image

$image : resource

イメージリソース

Type

resource

$deleteFiles

$deleteFiles : array

デストラクタで消去するファイルリスト

Type

array

$adapter

$adapter : \GD

画像ライブラリオブジェクト

Type

\GD — | iMagick | Cariro

$file

$file : string

Type

string

$_srcWidth

$_srcWidth : integer

元画像の幅

Type

integer

$_srcHeight

$_srcHeight : integer

元画像の高さ

Type

integer

$_srcAttr

$_srcAttr : string

イメージアトリビュート

Type

string

$_result

$_result : boolean

出力結果

Type

boolean

$_config

$_config : array

Class config

Type

array

$format

$format : string

Type

string

$result

$result : mixed

Type

mixed

$_srcType

$_srcType : string

元イメージタイプ

IMAGETYPE_GIF | IMAGETYPE_JPEG | IMAGETYPE_PNG

Type

string

$_imgResource

$_imgResource : resource

GDイメージリソース

Type

resource

$_newWidth

$_newWidth : integer

新イメージ幅

Type

integer

$_newHeight

$_newHeight : integer

新イメージ幅

Type

integer

Methods

__construct()

__construct(array  $config)

Constructor

設定を_configプロパティに代入します。

Parameters

array $config

ユーザー設定値

Throws

\BEAR_Img_Adapter_GD_Exception

onInject()

onInject() : void

Inject

設定にしたがってサービスをインジェクトします。

deleteFile()

deleteFile(string  $file) : void

ファイルの消去

作業用のファイルを消去リストに追加します。

Parameters

string $file

ファイル

getTmpFileName()

getTmpFileName(mixed  $file = false, mixed  $delete = true) : string

一時ファイル名を取得

一時画像ファイル名を生成します。 $deleteオプションがtrueの場合、デストラクタでテンポラリーファイルは消去されます

Parameters

mixed $file

ファイル名
mixed $delete

消去

Returns

string

resizeMobile()

resizeMobile() : void

モバイル端末に合わせた画像の最大リサイズ

loadRemoteFile()

loadRemoteFile(string  $file) : string

ファイルの読み込み

ローカル・リモートファイルにかかわらずファイルを読み込みます。
リモートファイルの場合はローカルにテンポラリーファイルが
作成されその名前が返されます。作られたテンポラリーファイルは
デストラクタで消去されます。キャッシュはされません。

Parameters

string $file

ファイル名

Returns

string

getExtention()

getExtention(string  $imageType) : string

image typeから拡張子を求める

Parameters

string $imageType

Returns

string

setConfig()

setConfig(mixed  $config, mixed  $values = null) : self

Set config

Parameters

mixed $config

(string) 設定キー | (array) 設定配列
mixed $values

(string) $configの時の設定値

Returns

self

getConfig()

getConfig(string  $key = null) : mixed

Get config

Parameters

string $key

設定キー、指定なければ全ての設定を取得

Returns

mixed

setService()

setService(string  $name, mixed  $service) : void

Set service

Parameters

string $name

サービスキー
mixed $service

サービス

load()

load(string  $file, string  $format = '') : void

ファイルのロード

$fileにはローカルファイルのパスまたはリモートファイルのURLを指定します。
リモートファイルの読み込みにはphp.iniでallow_url_fopen =Onの設定が必要です。

Parameters

string $file

ファイルパス
string $format

ファイルフォーマット

Throws

\BEAR_Img_Adapter_GD_Exception

resize()

resize(boolean|integer  $width = false, boolean|integer  $height = false, boolean  $smallOnly = false) : void

画像のリサイズ

画像を横幅に合わせてリサイズします。幅、高さ、の順で
指定が優先されます。
$smallOnlyをtrueにすると画像拡大をしません。
サムネール画像作成などにつかいます。

Parameters

boolean|integer $width

幅
boolean|integer $height

高さ
boolean $smallOnly

縮小のみ（小さい画像を大きくはしない）

show()

show(boolean|string  $format = false) : void

画像表示

ヘッダーと画像をhttp出力します。

Parameters

boolean|string $format

画像ファイルの場所(URL or fileパス)

save()

save(string  $filePath, string  $format) : void

画像保存

指定のフォーマットで画像をファイル保存します。
$isTemporaryがtrueの時は、ページ表示終了時にファイルを消去します。
テンポラリーファイルの保存のときに使用します。

Parameters

string $filePath

保存画像のファイルパス
string $format

画像ファイルのフォーマット

Throws

\BEAR_Img_Adapter_GD_Exception

getImageInfo()

getImageInfo() : void

画像情報の取得

getimagesizeで得られる画像情報を以下のプロパティに格納します。

_srcWidth int
srcHeight int
srcType   int
srcAttr   string

header()

header(mixed  $format = false, integer  $expire) : void

ヘッダー出力

Parameters

mixed $format

フォーマット
integer $expire

expire

_error()

_error(string  $errorFunc) : void

エラー終了

Parameters

string $errorFunc

ファンクション名

_exception()

_exception(string  $msg, array  $config = array()) : \BEAR_Exception

例外の作成

Parameters

string $msg

例外メッセージ
array $config

例外config

Returns

\BEAR_Exception