Documentation

MakeCTeOS
in package

Table of Contents

Properties

$chCTe  : string
chave da CTe
$dom  : Dom
dom Variável onde será montado o xml do documento fiscal
$errors  : array<string|int, mixed>
$tpAmb  : string
tpAmb tipo de ambiente
$versao  : string
versao numero da versão do xml da CTe
$xml  : string
xml String com o xml do documento fiscal montado
$gCompraGov  : DOMElement
$gEstornoCred  : DOMElement
$gTribCompraGov  : DOMElement
$gTribRegular  : DOMElement
$IBSCBS  : DOMElement
$ICMS  : DOMElement
$ICMSUFFim  : DOMElement
$infAdFisco  : DOMElement
$infRespTec  : DOMElement
$infTribFed  : DOMElement
$replaceAccentedChars  : bool
$schema  : string
$vTotDFe  : DOMElement
$vTotTrib  : DOMElement
$autXML  : array<string|int, mixed>
Autorizados para download do XML do DF-e
$cobr  : DOMNode
Dados da cobrança do CT-e
$comp  : array<string|int, mixed>
Componentes do Valor da Prestação
$compl  : DOMNode
Dados complementares do CT-e para fins operacionais ou comerciais
$CTe  : DOMNode
Tag CTe
$emit  : DOMNode
Identificação do Emitente do CT-e
$enderEmit  : DOMNode
Endereço do emitente
$enderToma  : DOMNode
Dados do endereço
$ide  : DOMNode
Identificação do CT-e
$imp  : DOMNode
Informações relativas aos Impostos
$infCte  : DOMNode
Informações do CT-e
$infCteComp  : DOMNode
Informação da NF ou CT emitido pelo Tomador
$infCTeNorm  : DOMNode
Grupo de informações do CT-e Normal e Substituto
$infCteSub  : DOMNode
Informações do CT-e de substituição
$infDocRef  : array<string|int, mixed>
Informações dos demais documentos
$infFretamento  : mixed
Dados do Fretamento - CTe-OS
$infGTVe  : array<string|int, mixed>
Informações das GTVe relacionadas ao CTe OS
$infModal  : DOMNode
Informações do modal
$infPercurso  : DOMNode
Percurso do CT-e OS
$infServico  : DOMNode
Informações da Prestação do Serviço
$obsCont  : array<string|int, mixed>
Campo de uso livre do contribuinte
$obsFisco  : array<string|int, mixed>
Campo de uso livre do contribuinte
$prop  : array<string|int, mixed>
Proprietários do Veículo. Só preenchido quando o veículo não pertencer à empresa emitente do CT-e
$rodo  : DOMNode
Informações do modal Rodoviário
$seg  : array<string|int, mixed>
Informações de Seguro da Carga
$toma  : DOMNode
Indicador do "papel" do tomador do serviço no CT-e OS
$veic  : array<string|int, mixed>
Dados dos Veículos
$vPrest  : DOMNode
Valores da Prestação de Serviço

Methods

__construct()  : mixed
getChave()  : string
Retorns the key number of CTe (44 digits)
getErrors()  : array<string|int, mixed>
Retorna os erros detectados
getXML()  : string
Returns xml string and assembly it is necessary
infFretamento()  : mixed
monta()  : bool
Monta o arquivo XML usando as tag's já preenchidas
montaCTe()  : bool
Call method of xml assembly. For compatibility only.
setOnlyAscii()  : mixed
Set character convertion to ASCII only ou not
tagautXML()  : bool
Gera as tags para o elemento: "autXML" (Autorizados para download do XML) #396 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "autXML"
tagComp()  : DOMElement
Gera as tags para o elemento: "Comp" (Componentes do Valor da Prestação) #211 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3
tagCompGTVe()  : DOMElement
Gera as tags para o elemento: "Comp" (Componentes do Valor da GTVe) #172 Nível: 3 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3
tagcompl()  : DOMElement
Gera as tags para o elemento: "compl" (Dados complementares do CT-e OS para fins operacionais ou comerciais) #59 Nível: 1
tagCompraGov()  : DOMElement
Informação de compras governamentais
tagdup()  : DOMElement
#365 tag CTe/infCTe/cobr/fat/dup (opcional) É necessário criar a tag fat antes de criar as duplicatas
tagemit()  : DOMElement
Gera as tags para o elemento: "emit" (Identificação do Emitente do CT-e) #97 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "emit" do tipo elemento (Ele = E|CE|A) e nível 2
tagenderEmit()  : DOMElement
Gera as tags para o elemento: "enderEmit" (Endereço do emitente) #102 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "enderEmit" do tipo elemento (Ele = E|CE|A) e nível 3
tagfat()  : DOMElement
#360 tag CTe/infCTe/cobr/fat (opcional)
taggEstornoCred()  : DOMElement
Tipo Estorno de Crédito UB116 pai UB12
taggTribCompraGov()  : DOMElement
tagIBSCBS()  : DOMElement
tagIBSCBSTribRegular()  : DOMElement
Grupo de informações da Tributação Regular UB68 pai UB15 $this->aGTribRegular[$item]/gTribRegular IBSCBS/gIBSCBS/gTribRegular
tagicms()  : DOMElement
tagICMS Informações relativas ao ICMS #194
tagide()  : DOMElement|DOMNode
Gera as tags para o elemento: Identificação do CT-e #4 Nível: 1
taginfCTe()  : DOMElement
Gera o grupo básico: Informações do CT-e #1 Nível: 0
taginfCTeComp()  : DOMElement|DOMNode
Gera as tags para o elemento: "infCteComp" (Detalhamento do CT-e complementado) #410 Nível: 1
taginfCTeNorm()  : DOMElement
#241
taginfCteSub()  : DOMElement|DOMNode
CT-e de substituição
taginfDocRef()  : mixed
Gera as tags para o elemento: "infDocRef" (Informações dos demais documentos) #319 Nível: 3
taginfGTVe()  : DOMElement
Gera as tags para o elemento: "Comp" (Componentes do Valor da GTVe) #170 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3
taginfModal()  : DOMElement|DOMNode
Gera as tags para o elemento: "infModal" (Informações do modal) #366 Nível: 2
taginfPercurso()  : mixed
taginfRespTec()  : DOMElement
Informações do Responsável técnico tag CTe/infCte/infRespTec (opcional)
taginfServico()  : DOMElement
Gera as tags para o elemento: "taginfServico" (Informações da Carga do CT-e OS) #253 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "infServico"
taginfTribFed()  : mixed
tagInfTribFed Informações do Impostos Federais CTe OS
tagobsCont()  : bool
Gera as tags para o elemento: "ObsCont" (Campo de uso livre do contribuinte) #91 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "ObsCont" do tipo elemento (Ele = E|CE|A) e nível 3
tagobsFisco()  : bool
Gera as tags para o elemento: "ObsFisco" (Campo de uso livre do contribuinte) #94 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "ObsFisco" do tipo elemento (Ele = E|CE|A) e nível 3
tagrodo()  : DOMElement|DOMNode
Leiaute - Rodoviário Gera as tags para o elemento: "rodo" (Informações do modal Rodoviário) CT-e OS #1 Nível: 0
tagseg()  : mixed
Gera as tags para o elemento: "seg" (Informações de Seguro da Carga) #360 Nível: 2
tagtomador()  : DOMElement
Gera as tags para o elemento: toma4 (Indicador do "papel" do tomador do serviço no CT-e OS) e adiciona ao grupo ide #37 Nível: 2
tagveic()  : mixed
Leiaute - Rodoviário Gera as tags para o elemento: "veic" (Dados dos Veículos) #21 Nível: 1
tagvPrest()  : DOMElement
Gera as tags para o elemento: "vPrest" (Valores da Prestação de Serviço) #187 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "vPrest" do tipo elemento (Ele = E|CE|A) e nível 2
buildCobr()  : mixed
#359 tag CTe/infCTe/cobr (opcional) Depende de fat
checkCTeKey()  : mixed
conditionalNumberFormatting()  : string
Formatação numerica condicional
hashCSRT()  : string
Calcula hash sha1 retornando Base64Binary
buildCTe()  : DOMElement
Tag raiz do documento xml Função chamada pelo método [ monta ]
equilizeParameters()  : stdClass
Includes missing or unsupported properties in stdClass Replace all unsuported chars

Properties

$chCTe

chave da CTe

public string $chCTe = ''

$dom

dom Variável onde será montado o xml do documento fiscal

public Dom $dom

$errors

public array<string|int, mixed> $errors = []

$tpAmb

tpAmb tipo de ambiente

public string $tpAmb = '2'

$versao

versao numero da versão do xml da CTe

public string $versao = '4.00'

$xml

xml String com o xml do documento fiscal montado

public string $xml = ''

$gCompraGov

protected DOMElement $gCompraGov

$gEstornoCred

protected DOMElement $gEstornoCred

$gTribCompraGov

protected DOMElement $gTribCompraGov

$gTribRegular

protected DOMElement $gTribRegular

$infAdFisco

protected DOMElement $infAdFisco

$infRespTec

protected DOMElement $infRespTec

$infTribFed

protected DOMElement $infTribFed

$replaceAccentedChars

protected bool $replaceAccentedChars = false

$autXML

Autorizados para download do XML do DF-e

private array<string|int, mixed> $autXML = []

$cobr

Dados da cobrança do CT-e

private DOMNode $cobr = ''

$comp

Componentes do Valor da Prestação

private array<string|int, mixed> $comp = []

$compl

Dados complementares do CT-e para fins operacionais ou comerciais

private DOMNode $compl = ''

$emit

Identificação do Emitente do CT-e

private DOMNode $emit = ''

$enderEmit

Endereço do emitente

private DOMNode $enderEmit = ''

$enderToma

Dados do endereço

private DOMNode $enderToma = ''

$ide

Identificação do CT-e

private DOMNode $ide = ''

$imp

Informações relativas aos Impostos

private DOMNode $imp = ''

$infCte

Informações do CT-e

private DOMNode $infCte = ''

$infCteComp

Informação da NF ou CT emitido pelo Tomador

private DOMNode $infCteComp = ''

$infCTeNorm

Grupo de informações do CT-e Normal e Substituto

private DOMNode $infCTeNorm = ''

$infCteSub

Informações do CT-e de substituição

private DOMNode $infCteSub = ''

$infDocRef

Informações dos demais documentos

private array<string|int, mixed> $infDocRef = []

$infFretamento

Dados do Fretamento - CTe-OS

private mixed $infFretamento
Tags
@var

$infGTVe

Informações das GTVe relacionadas ao CTe OS

private array<string|int, mixed> $infGTVe = []

$infModal

Informações do modal

private DOMNode $infModal = ''

$infPercurso

Percurso do CT-e OS

private DOMNode $infPercurso = []

$infServico

Informações da Prestação do Serviço

private DOMNode $infServico = ''

$obsCont

Campo de uso livre do contribuinte

private array<string|int, mixed> $obsCont = []

$obsFisco

Campo de uso livre do contribuinte

private array<string|int, mixed> $obsFisco = []

$prop

Proprietários do Veículo. Só preenchido quando o veículo não pertencer à empresa emitente do CT-e

private array<string|int, mixed> $prop = []

$rodo

Informações do modal Rodoviário

private DOMNode $rodo = ''

$seg

Informações de Seguro da Carga

private array<string|int, mixed> $seg = []

$toma

Indicador do "papel" do tomador do serviço no CT-e OS

private DOMNode $toma = ''

$veic

Dados dos Veículos

private array<string|int, mixed> $veic = []

$vPrest

Valores da Prestação de Serviço

private DOMNode $vPrest = ''

Methods

__construct()

public __construct([string $schema = 'PL_CTe_400' ]) : mixed
Parameters
$schema : string = 'PL_CTe_400'

getChave()

Retorns the key number of CTe (44 digits)

public getChave() : string
Return values
string

getErrors()

Retorna os erros detectados

public getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getXML()

Returns xml string and assembly it is necessary

public getXML() : string
Return values
string

infFretamento()

public infFretamento(mixed $std) : mixed
Parameters
$std : mixed

monta()

Monta o arquivo XML usando as tag's já preenchidas

public monta() : bool
Return values
bool

montaCTe()

Call method of xml assembly. For compatibility only.

public montaCTe() : bool
Return values
bool

setOnlyAscii()

Set character convertion to ASCII only ou not

public setOnlyAscii([bool $option = false ]) : mixed
Parameters
$option : bool = false

tagautXML()

Gera as tags para o elemento: "autXML" (Autorizados para download do XML) #396 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "autXML"

public tagautXML(mixed $std) : bool
Parameters
$std : mixed
Return values
bool

tagComp()

Gera as tags para o elemento: "Comp" (Componentes do Valor da Prestação) #211 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3

public tagComp(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagCompGTVe()

Gera as tags para o elemento: "Comp" (Componentes do Valor da GTVe) #172 Nível: 3 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3

public tagCompGTVe(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagcompl()

Gera as tags para o elemento: "compl" (Dados complementares do CT-e OS para fins operacionais ou comerciais) #59 Nível: 1

public tagcompl(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagCompraGov()

Informação de compras governamentais

public tagCompraGov(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagdup()

#365 tag CTe/infCTe/cobr/fat/dup (opcional) É necessário criar a tag fat antes de criar as duplicatas

public tagdup(stdClass $std) : DOMElement
Parameters
$std : stdClass
Return values
DOMElement

tagemit()

Gera as tags para o elemento: "emit" (Identificação do Emitente do CT-e) #97 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "emit" do tipo elemento (Ele = E|CE|A) e nível 2

public tagemit(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagenderEmit()

Gera as tags para o elemento: "enderEmit" (Endereço do emitente) #102 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "enderEmit" do tipo elemento (Ele = E|CE|A) e nível 3

public tagenderEmit(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagfat()

#360 tag CTe/infCTe/cobr/fat (opcional)

public tagfat(stdClass $std) : DOMElement
Parameters
$std : stdClass
Return values
DOMElement

taggEstornoCred()

Tipo Estorno de Crédito UB116 pai UB12

public taggEstornoCred(stdClass $std) : DOMElement
Parameters
$std : stdClass
Tags
throws
DOMException
Return values
DOMElement

taggTribCompraGov()

public taggTribCompraGov(stdClass $std) : DOMElement
Parameters
$std : stdClass
Tags
throws
DOMException
Return values
DOMElement

tagIBSCBS()

public tagIBSCBS(stdClass $std) : DOMElement
Parameters
$std : stdClass
Return values
DOMElement

tagIBSCBSTribRegular()

Grupo de informações da Tributação Regular UB68 pai UB15 $this->aGTribRegular[$item]/gTribRegular IBSCBS/gIBSCBS/gTribRegular

public tagIBSCBSTribRegular(stdClass $std) : DOMElement
Parameters
$std : stdClass
Tags
throws
DOMException
Return values
DOMElement

tagicms()

tagICMS Informações relativas ao ICMS #194

public tagicms(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagide()

Gera as tags para o elemento: Identificação do CT-e #4 Nível: 1

public tagide(stdClass $std) : DOMElement|DOMNode
Parameters
$std : stdClass
Return values
DOMElement|DOMNode

taginfCTe()

Gera o grupo básico: Informações do CT-e #1 Nível: 0

public taginfCTe(stdClass $std) : DOMElement
Parameters
$std : stdClass
Return values
DOMElement

taginfCTeComp()

Gera as tags para o elemento: "infCteComp" (Detalhamento do CT-e complementado) #410 Nível: 1

public taginfCTeComp(mixed $std) : DOMElement|DOMNode
Parameters
$std : mixed
Return values
DOMElement|DOMNode

taginfCTeNorm()

#241

public taginfCTeNorm() : DOMElement
Return values
DOMElement

taginfCteSub()

CT-e de substituição

public taginfCteSub(mixed $std) : DOMElement|DOMNode
Parameters
$std : mixed
Return values
DOMElement|DOMNode

taginfDocRef()

Gera as tags para o elemento: "infDocRef" (Informações dos demais documentos) #319 Nível: 3

public taginfDocRef(mixed $std) : mixed
Parameters
$std : mixed

taginfGTVe()

Gera as tags para o elemento: "Comp" (Componentes do Valor da GTVe) #170 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "Comp" do tipo elemento (Ele = E|CE|A) e nível 3

public taginfGTVe(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

taginfModal()

Gera as tags para o elemento: "infModal" (Informações do modal) #366 Nível: 2

public taginfModal(mixed $std) : DOMElement|DOMNode
Parameters
$std : mixed
Return values
DOMElement|DOMNode

taginfPercurso()

public taginfPercurso(mixed $std) : mixed
Parameters
$std : mixed

taginfRespTec()

Informações do Responsável técnico tag CTe/infCte/infRespTec (opcional)

public taginfRespTec(stdClass $std) : DOMElement
Parameters
$std : stdClass
Tags
throws
RuntimeException
Return values
DOMElement

taginfServico()

Gera as tags para o elemento: "taginfServico" (Informações da Carga do CT-e OS) #253 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "infServico"

public taginfServico(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

taginfTribFed()

tagInfTribFed Informações do Impostos Federais CTe OS

public taginfTribFed(mixed $std) : mixed
Parameters
$std : mixed

tagobsCont()

Gera as tags para o elemento: "ObsCont" (Campo de uso livre do contribuinte) #91 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "ObsCont" do tipo elemento (Ele = E|CE|A) e nível 3

public tagobsCont(mixed $std) : bool
Parameters
$std : mixed
Return values
bool

tagobsFisco()

Gera as tags para o elemento: "ObsFisco" (Campo de uso livre do contribuinte) #94 Nível: 2 Os parâmetros para esta função são todos os elementos da tag "ObsFisco" do tipo elemento (Ele = E|CE|A) e nível 3

public tagobsFisco(mixed $std) : bool
Parameters
$std : mixed
Return values
bool

tagrodo()

Leiaute - Rodoviário Gera as tags para o elemento: "rodo" (Informações do modal Rodoviário) CT-e OS #1 Nível: 0

public tagrodo(mixed $std) : DOMElement|DOMNode
Parameters
$std : mixed
Return values
DOMElement|DOMNode

tagseg()

Gera as tags para o elemento: "seg" (Informações de Seguro da Carga) #360 Nível: 2

public tagseg(mixed $std) : mixed
Parameters
$std : mixed

tagtomador()

Gera as tags para o elemento: toma4 (Indicador do "papel" do tomador do serviço no CT-e OS) e adiciona ao grupo ide #37 Nível: 2

public tagtomador(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

tagveic()

Leiaute - Rodoviário Gera as tags para o elemento: "veic" (Dados dos Veículos) #21 Nível: 1

public tagveic(mixed $std) : mixed
Parameters
$std : mixed

tagvPrest()

Gera as tags para o elemento: "vPrest" (Valores da Prestação de Serviço) #187 Nível: 1 Os parâmetros para esta função são todos os elementos da tag "vPrest" do tipo elemento (Ele = E|CE|A) e nível 2

public tagvPrest(mixed $std) : DOMElement
Parameters
$std : mixed
Return values
DOMElement

buildCobr()

#359 tag CTe/infCTe/cobr (opcional) Depende de fat

protected buildCobr() : mixed

checkCTeKey()

protected checkCTeKey(DOMImproved $dom) : mixed
Parameters
$dom : DOMImproved

conditionalNumberFormatting()

Formatação numerica condicional

protected conditionalNumberFormatting([string|float|int|null $value = null ][, int $decimal = 2 ]) : string
Parameters
$value : string|float|int|null = null
$decimal : int = 2
Return values
string

hashCSRT()

Calcula hash sha1 retornando Base64Binary

protected hashCSRT(string $CSRT) : string
Parameters
$CSRT : string
Return values
string

buildCTe()

Tag raiz do documento xml Função chamada pelo método [ monta ]

private buildCTe() : DOMElement
Return values
DOMElement

equilizeParameters()

Includes missing or unsupported properties in stdClass Replace all unsuported chars

private equilizeParameters(stdClass $std, array<string|int, mixed> $possible) : stdClass
Parameters
$std : stdClass
$possible : array<string|int, mixed>
Return values
stdClass

        
On this page

Search results