Bitrix API

FormatService extends BaseService uses RepositoryTrait

FinalYes

Class FormatService

Service to work with addresses formats

Table of Contents

Methods

__clone()  : mixed
__wakeup()  : mixed
findAll()  : array<string|int, mixed>|bool
Find all existing formats
findByCode()  : Format|null|bool
Find format by format code
findDefault()  : Format|bool|null
Find default (current) format
getDefaultFormatCode()  : string
Returns default (current) format code
getInstance()  : static
getRepository()  : mixed
setDefaultFormatCode()  : FormatService

Methods

findAll()

Find all existing formats

public findAll(string $languageId) : array<string|int, mixed>|bool
Parameters
$languageId : string
Return values
array<string|int, mixed>|bool

findByCode()

Find format by format code

public findByCode(string $formatCode, string $languageId) : Format|null|bool
Parameters
$formatCode : string
$languageId : string
Return values
Format|null|bool

findDefault()

Find default (current) format

public findDefault(string $languageId) : Format|bool|null
Parameters
$languageId : string
Return values
Format|bool|null

getDefaultFormatCode()

Returns default (current) format code

public getDefaultFormatCode() : string
Return values
string

getInstance()

public static getInstance() : static
Return values
static

        
On this page

Search results