API Documentation
\

\TitleIconHelper

Title Icon Helper

Add your application-wide methods in the class below, your helpers will inherit them.

Summary

Methods
Properties
Constants
beforeRender()
inputWithTitleIcon()
titleIconPicker()
ngTitleIconPicker()
titleIcon()
getIconFiles()
$helpers
No constants found
_getTitleIconPickerOpenTag()
_getTitleIconPickerCloseTag()
_getAltName()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$helpers

$helpers : array

Other helpers used by FormHelper

Type

array

Methods

beforeRender()

beforeRender(string  $viewFile) : void

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The view file that is going to be rendered

inputWithTitleIcon()

inputWithTitleIcon(string  $fieldName, string  $titleIconFieldName, array  $options = array()) : string

Get input type text with title icon picker button

Parameters

string $fieldName

input field name
string $titleIconFieldName

title icon field name
array $options

option for input

Returns

string —

input and title icon picker button

titleIconPicker()

titleIconPicker(string  $name, string  $titleIcon = null) : string

Get title icon picker

Parameters

string $name

title icon field name
string $titleIcon

title icon value (if you want to display images diffrent from name field value)

Returns

string —

title icon picker and input field.

ngTitleIconPicker()

ngTitleIconPicker(string  $ngAttrName, string  $ngModel, string  $titleIcon) : string

Get title icon picker ( for angular )

Parameters

string $ngAttrName

title icon field name
string $ngModel

ng-model name
string $titleIcon

title icon value

Returns

string —

title icon picker and input field.

titleIcon()

titleIcon(string  $filePath) : string

Creates a `<img>` tag for title icon.

Parameters

string $filePath

The title icon's file path.

Returns

string —

img tag.

getIconFiles()

getIconFiles(boolean  $isCancel = true) : string

getIconFiles

Parameters

boolean $isCancel

cancel icon を必要とするか否か

Returns

string —

icon file paths

_getTitleIconPickerOpenTag()

_getTitleIconPickerOpenTag(string  $titleIcon, string  $ngModelAttribute = '') : string

getTitleIconPickerOpenTag

Parameters

string $titleIcon

title icon value
string $ngModelAttribute

ng-model

Returns

string —

open tag for title icon picker

_getTitleIconPickerCloseTag()

_getTitleIconPickerCloseTag() : string

_getTitleIconPickerCloseTag

Returns

string —

end tag for title icon picker

_getAltName()

_getAltName(string  $file) : string

_getAltName

Parameters

string $file

icon file name

Returns

string —

icon file alts