Documentation

Tools

in package

• NFePHP
• NFe
• Common
• Tools

Table of Contents

Properties

$ambiente  : string

ambiente

$config  : stdClass

config class

$contingency  : Contingency|null

contingency class

$cUF  : int

$lastRequest  : string

last soap request

$lastResponse  : string

last soap response

$pathschemes  : string

Path to schemes folder

$pathwsfiles  : string

Path to storage folder

$soap  : SoapInterface|null

soap class

$tpAmb  : int

Environment

$verAplic  : string

Application version

$algorithm  : int

Sign algorithm from OPENSSL

$availableVersions  : array<string|int, mixed>

$canonical  : array<string|int, mixed>

Canonical conversion options

$certificate  : Certificate

certificate class

$modelo  : int

Model of NFe 55 or 65

$objHeader  : SoapHeader|null

$qrcode_version  : string|null

$soapnamespaces  : array<string|int, mixed>

$timezone  : string

$typePerson  : string

$urlAction  : string

$urlcUF  : int

urlcUF

$urlHeader  : string

$urlMethod  : string

$urlNamespace  : string

$urlOperation  : string

$urlPortal  : string

urlPortal Instância do WebService

$urlService  : string

urlService

$urlVersion  : string

urlVersion

$versao  : string

Version of layout

Methods

__construct()  : mixed

Loads configurations and Digital Certificate, map all paths, set timezone and instanciate Contingency::class

canonicalOptions()  : array<string|int, mixed>

Set option for canonical transformation see C14n

forceQRCodeVersion()  : void

Force use this version for QRCode format in NFCe

getAcronym()  : string

Recover state acronym from cUF number

getcUF()  : int

Recover cUF number from state acronym

getTypeOfPersonFromCertificate()  : string

Return J or F from existing type in ASN.1 certificate J - pessoa juridica (CNPJ) F - pessoa física (CPF)

loadSoapClass()  : void

Load Soap Class Soap Class may be \NFePHP\Common\Soap\SoapNative or \NFePHP\Common\Soap\SoapCurl

model()  : int

Set or get model of document NFe = 55 or NFCe = 65

setEnvironment()  : void

Alter environment from "homologacao" to "producao" and vice-versa

setEnvironmentTimeZone()  : void

Sets environment time zone

setSignAlgorithm()  : void

Set OPENSSL Algorithm using OPENSSL constants

setVerAplic()  : void

Set application version

signNFe()  : string

Sign NFe or NFCe

validKeyByUF()  : string

Validate cUF from the key content and returns the state acronym

version()  : string

Set or get parameter layout version

addQRCode()  : string

Add QRCode Tag to signed XML from a NFCe

checkContingencyForWebServices()  : void

Verifies the existence of the service

checkModelFromXml()  : void

Verify if xml model is equal as modelo property

checkSoap()  : mixed

Verify if SOAP class is loaded, if not, force load SoapCurl

correctNFeForContingencyMode()  : string

Corrects NFe fields when in contingency mode

getURIConsultaNFCe()  : string

Get URI for search NFCe by key (chave)

getXmlUrlPath()  : string

Recover path to xml database with list of soap services

isValid()  : bool

Performs xml validation with its respective XSD structure definition document NOTE: if don't exists the XSD file will return true

sendRequest()  : string

Send request message to webservice

servico()  : void

Assembles all the necessary parameters for soap communication