Stripe Class Reference

Stripe class @TODO No reason to extends CommonObject. More...

Inheritance diagram for Stripe:

Collaboration diagram for Stripe:

Public Member Functions
	__construct ($db)
	Constructor.
	getStripeAccount ($mode='StripeTest', $fk_soc=0, $entity=-1)
	Return main company OAuth Connect stripe account.
	getStripeCustomerAccount ($id, $status=0, $site_account='')
	getStripeCustomerAccount
	customerStripe ($object, $key='', $status=0, $createifnotlinkedtostripe=0)
	Get the Stripe customer of a thirdparty (with option to create it in Stripe if not linked yet).
	getPaymentMethodStripe ($paymentmethod, $key='', $status=0)
	Get the Stripe payment method Object from its ID.
	getSelectedReader ($reader, $key='', $status=0)
	Get the Stripe reader Object from its ID.
	getPaymentIntent ($amount, $currency_code, $tag, $description='', $object=null, $customer=null, $key=null, $status=0, $usethirdpartyemailforreceiptemail=0, $mode='automatic', $confirmnow=false, $payment_method=null, $off_session=0, $noidempotency_key=1, $did=0)
	Get the Stripe payment intent.
	getSetupIntent ($description, $object, $customer, $key, $status, $usethirdpartyemailforreceiptemail=0, $confirmnow=false)
	Get the Stripe payment intent.
	cardStripe ($cu, CompanyPaymentMode $object, $stripeacc='', $status=0, $createifnotlinkedtostripe=0)
	Get the Stripe card of a company payment mode (option to create it on Stripe if not linked yet is no more available on new Stripe API)
	sepaStripe ($cu, CompanyPaymentMode $object, $stripeacc='', $status=0, $createifnotlinkedtostripe=0)
	Get the Stripe SEPA of a company payment mode (create it if it doesn't exists and $createifnotlinkedtostripe is set)
	createPaymentStripe ($amount, $currency, $origin, $item, $source, $customer, $account, $status=0, $usethirdpartyemailforreceiptemail=0, $capture=true)
	Create charge.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContentArray ($params)
	Return array of data to show into a tooltip.
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Additional Inherited Members
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.
Public Attributes inherited from CommonObject
	$origin_object
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Stripe class @TODO No reason to extends CommonObject.

Definition at line 32 of file stripe.class.php.

Constructor & Destructor Documentation

__construct()

Stripe::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 95 of file stripe.class.php.

Member Function Documentation

cardStripe()

Stripe::cardStripe	(		$cu,
		CompanyPaymentMode	$object,
			$stripeacc = '',
			$status = 0,
			$createifnotlinkedtostripe = 0 )

Get the Stripe card of a company payment mode (option to create it on Stripe if not linked yet is no more available on new Stripe API)

Parameters

\Stripe\Customer	$cu	Object stripe customer.
CompanyPaymentMode	$object	Object companypaymentmode to check, or create on stripe (create on stripe also update the societe_rib table for current entity)
string	$stripeacc	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)
int	$createifnotlinkedtostripe	1=Create the stripe card and the link if the card is not yet linked to a stripe card. Deprecated with new Stripe API and SCA.

Returns

\Stripe\Card|\Stripe\PaymentMethod|null Stripe Card or null if not found

Definition at line 842 of file stripe.class.php.

References $object, dol_print_error(), dol_syslog(), getDolGlobalString(), getUserRemoteIP(), and img_picto().

createPaymentStripe()

Stripe::createPaymentStripe	(		$amount,
			$currency,
			$origin,
			$item,
			$source,
			$customer,
			$account,
			$status = 0,
			$usethirdpartyemailforreceiptemail = 0,
			$capture = true )

Create charge.

This was called by page htdocs/stripe/payment.php and may be deprecated.

Parameters

int	$amount	Amount to pay
string	$currency	EUR, GPB...
string	$origin	Object type to pay (order, invoice, contract...)
int	$item	Object id to pay
string	$source	src_xxxxx or card_xxxxx or pm_xxxxx
string	$customer	Stripe customer ref 'cus_xxxxxxxxxxxxx' via customerStripe()
string	$account	Stripe account ref 'acc_xxxxxxxxxxxxx' via getStripeAccount()
int	$status	Status (0=test, 1=live)
int	$usethirdpartyemailforreceiptemail	Use thirdparty email as receipt email
boolean	$capture	Set capture flag to true (take payment) or false (wait)

Returns

Stripe

Deprecated

Definition at line 1172 of file stripe.class.php.

References dol_syslog(), dol_trunc(), getDolGlobalString(), and getUserRemoteIP().

customerStripe()

Stripe::customerStripe	(		$object,
			$key = '',
			$status = 0,
			$createifnotlinkedtostripe = 0 )

Get the Stripe customer of a thirdparty (with option to create it in Stripe if not linked yet).

Search on site_account = 0 or = $stripearrayofkeysbyenv[$status]['publishable_key']

Parameters

Societe | Adherent	$object	Object thirdparty to check, or create on stripe (create on stripe also update the stripe_account table for current entity). Used for AdherentType and Societe.
string	$key	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
	int<0,1>	$status Status (0=test, 1=live)
	int<0,1>	$createifnotlinkedtostripe 1=Create the stripe customer and the link if the thirdparty is not yet linked to a stripe customer

Returns

\Stripe\Customer|null Stripe Customer or null if not found

Definition at line 179 of file stripe.class.php.

References $object, dol_now(), dol_print_error(), dol_syslog(), getDolGlobalString(), getUserRemoteIP(), and isInEEC().

getPaymentIntent()

Stripe::getPaymentIntent	(		$amount,
			$currency_code,
			$tag,
			$description = '',
			$object = null,
			$customer = null,
			$key = null,
			$status = 0,
			$usethirdpartyemailforreceiptemail = 0,
			$mode = 'automatic',
			$confirmnow = false,
			$payment_method = null,
			$off_session = 0,
			$noidempotency_key = 1,
			$did = 0 )

Get the Stripe payment intent.

Create it with confirmnow=false Warning. If a payment was tried and failed, a payment intent was created. But if we change something on object to pay (amount or other), reusing same payment intent, is not allowed by Stripe. Recommended solution is to recreate a new payment intent each time we need one (old one will be automatically closed after a delay), that's why i comment the part of code to retrieve a payment intent with object id (never mind if we cumulate payment intent with old ones that will not be used) Note: This is used when option STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION is on when making a payment from the public/payment/newpayment.php page but not when using the STRIPE_USE_NEW_CHECKOUT.

Parameters

double	$amount	Amount
string	$currency_code	Currency code
string	$tag	Tag
string	$description	Description
?CommonObject	$object	Object to pay with Stripe
?string	$customer	Stripe customer ref 'cus_xxxxxxxxxxxxx' via customerStripe()
?string	$key	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)
int	$usethirdpartyemailforreceiptemail	1=use thirdparty email for receipt
string	$mode	automatic=automatic confirmation/payment when conditions are ok, manual=need to call confirm() on intent
boolean	$confirmnow	false=default, true=try to confirm immediately after create (if conditions are ok)
?string	$payment_method	'pm_....' (if known)
int	$off_session	If we use an already known payment method to pay when customer is not available during the checkout flow.
int	$noidempotency_key	Do not use the idempotency_key when creating the PaymentIntent
int	$did	ID of an existing line into llx_prelevement_demande (Dolibarr intent). If provided, no new line will be created.

Returns

?\Stripe\PaymentIntent Stripe PaymentIntent or null if not found and failed to create

Definition at line 370 of file stripe.class.php.

References $object, dol_now(), dol_print_error(), dol_syslog(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), and getUserRemoteIP().

getPaymentMethodStripe()

Stripe::getPaymentMethodStripe	(		$paymentmethod,
			$key = '',
			$status = 0 )

Get the Stripe payment method Object from its ID.

Parameters

string	$paymentmethod	Payment Method ID
string	$key	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)

Returns

\Stripe\PaymentMethod|null Stripe PaymentMethod or null if not found

Definition at line 296 of file stripe.class.php.

getSelectedReader()

Stripe::getSelectedReader	(		$reader,
			$key = '',
			$status = 0 )

Get the Stripe reader Object from its ID.

Parameters

string	$reader	Reader ID
string	$key	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)

Returns

\Stripe\Terminal\Reader|null Stripe Reader or null if not found

Definition at line 324 of file stripe.class.php.

getSetupIntent()

Stripe::getSetupIntent	(		$description,
			$object,
			$customer,
			$key,
			$status,
			$usethirdpartyemailforreceiptemail = 0,
			$confirmnow = false )

Get the Stripe payment intent.

Create it with confirmnow=false Warning. If a payment was tried and failed, a payment intent was created. But if we change something on object to pay (amount or other), reusing same payment intent is not allowed. Recommended solution is to recreate a new payment intent each time we need one (old one will be automatically closed after a delay), that's why i comment the part of code to retrieve a payment intent with object id (never mind if we cumulate payment intent with old ones that will not be used) Note: This is used when option STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION is on when making a payment from the public/payment/newpayment.php page but not when using the STRIPE_USE_NEW_CHECKOUT.

Parameters

string	$description	Description
Societe	$object	Object of company to link the Stripe payment mode with
string	$customer	Stripe customer ref 'cus_xxxxxxxxxxxxx' via customerStripe()
string	$key	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)
int	$usethirdpartyemailforreceiptemail	1=use thirdparty email for receipt
boolean	$confirmnow	false=default, true=try to confirm immediately after create (if conditions are ok)

Returns

\Stripe\SetupIntent|null Stripe SetupIntent or null if not found and failed to create

Definition at line 675 of file stripe.class.php.

References $object, dol_syslog(), getDolGlobalString(), and getUserRemoteIP().

getStripeAccount()

Stripe::getStripeAccount	(		$mode = 'StripeTest',
			$fk_soc = 0,
			$entity = -1 )

Return main company OAuth Connect stripe account.

Parameters

string	$mode	'StripeTest' or 'StripeLive'
int	$fk_soc	Id of thirdparty
int	$entity	Id of entity (-1 = current environment)

Returns

string Stripe account 'acc_....' or '' if no OAuth token found

Definition at line 109 of file stripe.class.php.

References dol_print_error(), and dol_syslog().

getStripeCustomerAccount()

Stripe::getStripeCustomerAccount	(		$id,
			$status = 0,
			$site_account = '' )

getStripeCustomerAccount

Parameters

int	$id	Id of third party
int	$status	Status
string	$site_account	Value to use to identify with account to use on site when site can offer several accounts. For example: 'pk_live_123456' when using Stripe service.

Returns

string Stripe customer ref 'cu_xxxxxxxxxxxxx' or ''

Definition at line 161 of file stripe.class.php.

sepaStripe()

Stripe::sepaStripe	(		$cu,
		CompanyPaymentMode	$object,
			$stripeacc = '',
			$status = 0,
			$createifnotlinkedtostripe = 0 )

Get the Stripe SEPA of a company payment mode (create it if it doesn't exists and $createifnotlinkedtostripe is set)

Parameters

\Stripe\Customer	$cu	Object stripe customer.
CompanyPaymentMode	$object	Object companypaymentmode to check, or create on stripe (create on stripe also update the societe_rib table for current entity)
string	$stripeacc	''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect
int	$status	Status (0=test, 1=live)
int	$createifnotlinkedtostripe	1=Create the stripe sepa and the link if the sepa is not yet linked to a stripe sepa. Used by the "Create bank to Stripe" feature.

Returns

\Stripe\PaymentMethod|null Stripe SEPA or null if not found

Definition at line 994 of file stripe.class.php.

References $object, dol_now(), dol_print_error(), dol_syslog(), dolDecrypt(), getDolGlobalString(), GETPOST(), and getUserRemoteIP().

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/stripe/class/stripe.class.php