PHPdocs keywords

List of keywords used in phpdoc attributes.

Keyword	Value	Count
@Depricated	since version 2.4.4	1
@TODO	No reason to extends CommonObject	1
	deprecate this. Use fetch_object() so you can access a field with its name instead of using an index of position of field.	1
	Add User $user as first param	1
	really should be broken into multiple methods, or even a class.	1
	The field argument is optional. If field is omitted, DCOUNT counts all records in the	1
	The field argument is optional. If field is omitted, DCOUNTA counts all records in the	1
	WARNING: This make a fetch on all records instead of making one request with a join.	1
@abstract	* @return boolean true when api access is allowed false otherwise	1
	*	8
@acces	public	1
@access	hybrid` comment	1
	protected` comment	1
	hybrid	4
	protected	40
	private	156
	public	180
@alias	getAbbreviatedName	1
	setTimezone	2
	toDateTime	2
	getTimestamp	2
	to	2
	copy	3
	diffForHumans	4
@author	Michael - https://www.php.net/manual/fr/function.empty.php#90767	1
	François Kooman (fkooman@tuxed.net)	1
	Thomas Tanghus (http://tanghus.net/)	1
	François Kooman (https://tuxed.net/)	1
	Michael Niewöhner (foss@mniewoehner.de)	1
	rosali (https://github.com/rosali)	1
	Thomas Müller	1
	Brett (https://github.com/bretten)	1
	Frank Edelhaeuser (fedel@users.sourceforge.net)	1
	Christian Kraus	1
	Fabien Potencier	1
	Jordi Boggiano	1
	Paul Nicholls - github.com/pauln	1
	Patrick Hayes	1
	Camptocamp	1
	prinsmc	1
	Thomas Welton	1
	Andrii Gakhov	1
	Sumukh Sridhara <@sumukhsridhara>	1
	Mouhamed SEYE	1
	Christian Schmidt	1
	Lukasz Karapuda	1
	Bartek Matosiuk	1
	Bartosz Matosiuk	1
	Eduardo Gulias Davis	1
	Guilherme Blanco	1
	Jonathan Wage	1
	Roman Borschel	1
	Ward Peeters	1
	xu.li	1
	Arjen Brouwer	1
	Jean-François Simon	1
	Lars Strojny	1
	De Cock Xavier	1
	Fedonyuk Anton	1
	Ion Bazan	1
	Nico Oelgart	1
	Gert de Pagter	1
	Serban Ghita (since 2012)	1
	Nick Ilyin	1
	Robin Appelman (https://icewind.nl/)	1
	Nicola asuni	1
	Piotr Galecki, Nicola Asuni, Andy Meier	1
	Alexander Escalona Fern\E1ndez, Nicola Asuni	1
	Valentin Schmidt, Nicola Asuni	1
	Nicola Asuni, Alexander Escalona Fern\E1ndez	1
	Klemen Vodopivec, Nicola Asuni	1
	Vincent@luo MSN:kele_100@hotmail.com	1
	Mark Roduner	1
	James David Low (http://jameslow.com/)	2
	Jean-Tiare LE BIGOT (http://www.jtlebi.fr/)	2
	Armin Hackmann	2
	Antoine Corcy	2
	ieter Hordijk	2
	Alexander Pervakov	2
	Romain-Geissler	2
	Jan Flora	2
	Sebastiaan Stok	2
	Joel R. Simpson	2
	Dave Drager	2
	Nick Lombard	2
	Grégoire Pineau	2
	Baptiste Clavié	2
	Ingo Fischer	2
Tomas V.V. Cox	2
algorithm based on code by Alexander Songe	2
Maxime Delorme, Nicola Asuni	2
Evert Pot (https://evertpot.com/)	3
Flávio Heleno	3
Michael Bommarito	3
Dominik Tobschall (http://tobschall.de/)	4
Xavier Noguer	4
Thanks to Guillaume and Henning Reich for posting great attachment code to the mail list	4
Aleksander Machniak	4
Andreas W\FCrmser, Nicola Asuni	4
Jaco van Kooten	4
Ivan Enderlin	5
Christian Schmidt	6
Richard Heyes	6
Cipriano Groenendal	6
Sean Coates	6
Paul Meagher	7
Pedro Amorim	8
Nicola Asuni - info@tecnick.com	10
Fabien Potencier	11
Xavier De Cock	11
Dietrich Ayala	18
Scott Nichol	20
Evert Pot (http://www.rooftopsolutions.nl/)	23
Nicolas Grekas	46
R.Arul Kumaran	102
Nicola Asuni	119
Chris Corbyn	122
Evert Pot (http://evertpot.com/)	303
@backupGlobals	disabled	1
@backupStaticAttributes	enabled	1
@brief	PHP class extension of the TCPDF library to import existing PDF documents.	1
	This is a PHP class for decoding common PDF filters.	1
	trait for handling deprecated properties and methods	1
	This is a PHP class for parsing PDF documents..	2
	PHP class for generating PDF documents without requiring external extensions.	3
@category	Function Configuration	4
	Mail	6
	Error Returns	7
	PhpSpreadsheet	9
	Date/Time Functions	11
	Logical Functions	12
	Database Functions	12
	Financial Functions	20
	Engineering Functions	24
	Mathematical and Trigonometric Functions	25
	Statistical Functions	32
	Framework	108
@class	tcpdi_parser	1
	TCPDF_PARSER	1
	TCPDF_IMPORT	1
	TCPDF2DBarcode	1
	TCPDFBarcode	1
	TCPDF	1
	TCPDF_COLORS	1
	TCPDF_STATIC	1
	TCPDF_FONTS	1
	TCPDF_IMAGES	1
	TCPDF_FONT_DATA	1
	TCPDF_FILTERS	1
	QRcode	1
	Datamatrix	1
	Documents {@requires user,external}	1
	DolibarrApiAccess {@requires user,external}	38
@code	Stripe-Account} header with that account ID.	1
	Stripe-Version} header with that API version.	1
@codeCoverageIgnore	Pure PHPStan wrapper.	1
	*	1
	*/	7
@const	Database label	1
	Version min database	1
	integer ENC_7BIT	1
	integer ENC_8BIT	1
	integer ENC_BINARY	1
	integer ENC_BASE64	1
	integer ENC_QUOTED_PRINTABLE	1
	integer ENC_OTHER	1
	integer TYPE_MESSAGE	1
	integer TYPE_APPLICATION	1
	integer TYPE_AUDIO	1
	integer TYPE_IMAGE	1
	integer TYPE_VIDEO	1
	integer TYPE_MODEL	1
	integer TYPE_OTHER	1
	integer CLIENT_OPENTIMEOUT	1
	integer CLIENT_READTIMEOUT	1
	integer CLIENT_WRITETIMEOUT	1
	integer CLIENT_CLOSETIMEOUT	1
	integer NIL	1
	integer IMAP_OPENTIMEOUT	1
	integer IMAP_READTIMEOUT	1
	integer IMAP_WRITETIMEOUT	1
	integer IMAP_CLOSETIMEOUT	1
	integer OP_DEBUG	1
	integer OP_READONLY	1
	integer OP_ANONYMOUS	1
	integer OP_SHORTCACHE	1
	integer OP_SILENT	1
	integer OP_PROTOTYPE	1
	integer OP_HALFOPEN	1
	integer OP_EXPUNGE	1
	integer OP_SECURE	1
	integer CL_EXPUNGE	1
	integer FT_UID	1
	integer FT_PEEK	1
	integer FT_NOT	1
	integer FT_INTERNAL	1
	integer FT_PREFETCHTEXT	1
	integer ST_UID	1
	integer ST_SILENT	1
	integer ST_SET	1
	integer CP_UID	1
	integer CP_MOVE	1
	integer SE_UID	1
	integer SE_FREE	1
	integer SE_NOPREFETCH	1
	integer SO_FREE	1
	integer SO_NOSERVER	1
	integer SA_MESSAGES	1
	integer SA_RECENT	1
	integer SA_UNSEEN	1
	integer SA_UIDNEXT	1
	integer SA_UIDVALIDITY	1
	integer SA_ALL	1
	integer LATT_NOINFERIORS	1
	integer LATT_NOSELECT	1
	integer LATT_MARKED	1
	integer LATT_UNMARKED	1
	integer LATT_REFERRAL	1
	integer LATT_HASCHILDREN	1
	integer LATT_HASNOCHILDREN	1
	integer SORTDATE	1
	integer SORTARRIVAL	1
integer SORTFROM	1
integer SORTSUBJECT	1
integer SORTTO	1
integer SORTCC	1
integer SORTSIZE	1
integer TYPETEXT	1
integer TYPEMULTIPART	1
integer TYPEMESSAGE	1
integer TYPEAPPLICATION	1
integer TYPEAUDIO	1
integer TYPEIMAGE	1
integer TYPEVIDEO	1
integer TYPEMODEL	1
integer TYPEOTHER	1
integer ENC7BIT	1
integer ENC8BIT	1
integer ENCBINARY	1
integer ENCBASE64	1
integer ENCQUOTEDPRINTABLE	1
integer ENCOTHER	1
integer IMAP_GC_ELT	1
integer IMAP_GC_ENV	1
integer IMAP_GC_TEXTS	1
OAUTH_VERSION */	2
integer TYPE_TEXT	2
integer TYPE_MULTIPART	2
@copyright	Copyright (C) 2007-2015 fruux GmbH. (https://fruux.com/)	1
	2010-2015 - Laurent Destailleur - eldy@users.sourceforge.net	1
	2010 - Vikas Mahajan - http://vikasmahajan.wordpress.com	1
	GPL License 2010 - Laurent Destailleur - eldy@users.sourceforge.net	1
	Copyright (C) Robin Appelman (https://icewind.nl/)	1
	Copyright (C) fruux GmbH (https://fruux.com/).	2
	Copyright (C) fruux GmbH. (https://fruux.com/)	2
	Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)	2
	2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)	2
	2012 - Stephen Larroque - lrq3000@gmail.com	2
	2013 Luracast	2
	2014 Luracast	2
	2012 Luracast	2
	Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).	3
	Copyright (c) 2006 - 2015 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)	3
	GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)	4
	2003-2006 PEAR	6
	Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).	15
	2010 Luracast	102
	Copyright (C) fruux GmbH (https://fruux.com/)	322
@dataProvider	provideLevelsAndMessages	1
	getCastFileInfoTests */	1
	provideCastSplDoublyLinkedList	1
	provideNodes	1
	provideFilter	1
@depends	testMyObjectCreate	1
	testEnableDeveloperMode	1
	testConfigurationPage	1
	testAboutPage	1
	testTriggerDeclared	1
	testModuleEnabled	3
@deprecated	* @param float $numero Number to convert	1
	* @param string|array $out Value to check/clear.	1
	Use print dol_get_fiche_head() instead	1
	Use print dol_get_fiche_end() instead	1
	Form::editfieldkey	1
	Use load_fiche_titre instead	1
	Use print load_fiche_titre instead	1
	Duplicate of ascii_check()	1
	Use actioncomm->getPictoType() instead	1
	Use `\Debugbar\Bridge\NamespacedTwigProfileCollector` instead for Twig 2.x and 3.x	1
	use DebugBar\Bridge\TwigProfileCollector instead	1
	Use instead origin_type = element_type to guess the line of origin of the shipment line.	1
	* @see $product_desc	1
	Use $price_ht instead	1
	Use $socid	1
	Use fk_project instead	1
	Use $description instead	1
	* @see $company	1
	Use label	1
	* @see $email	1
	Has been replaced by a search into llx_mailing_unsubscribe	1
	* @see $position	1
	see $amount	1
	Use $this->errors	1
	Use user_creation_id	1
	Use user_modification_id	1
	Use product	1
	Use contract	1
	Use order	1
	Use invoice	1
	Use member	1
	Use project	1
	Use product_ref	1
	Use product_label	1
	Use $project instead.	1
	Use $fk_project instead.	1
	Use $origin_type and $origin_id instead.	1
	Use $status instead.	1
	Use $state_id. We can remove this property when the field 'fk_departement' have been renamed into 'state_id' in all tables	1
	Use $cond_reglement_id instead - Kept for compatibility	1
	Use $note_private instead.	1
	Use $date_modification	1
	Use $date_modification instead.	1
	Store only id in user_creation_id	1
	Use $totalpaid instead	1
	Try to use id property as possible (even if field into database is still rowid)	1
	* @see $desc	1
	Use socid instead.	1
	* @see $title	1
	* @see $name	1
	Same as box_id?	1
	Use $paid	1
	See $total_ttc, $total_ht, $total_tva	1
	Use $total_tva	1
	* @see $note_private, $note_public	1
	* @var ?Fournisseur	1
	Use $subprice	1
	Use $product_label	1
	Use $desc	1
	Use $title	1
	Use desc	1
	* @see $product_id	1
	* @see $supplier_barcode	1
	* @see $supplier_fk_barcode_type	1
Use fk_commande	1
Use $amount instead.	1
Use label instead	1
Use $amount instead	1
* @see $type	1
Duplicate field. We already have the field $this->status	1
see $iban	1
* @see $owner_name	1
* @see $address	1
Use currency_code instead	1
* @see $balance	1
See fk_account	1
Use $title instead	1
Use $user_validation_id	1
The discount percent is on line level now	1
* @see $num_payment	1
* @see $fk_salary	1
* @see $datep	1
* @see $date_valid	1
* @see expandEntities	1
Use socid	1
* @see $iban_prefix	1
Use $name instead	1
Use $state_code instead	1
Use $state instead	1
Use $country instead	1
Use $idprof1 instead	1
Use $idprof2 instead	1
Use $idprof3 instead	1
Use $code_compta_client	1
Use $note_public, $note_private - Note is split in public and private notes	1
* @see $authorid	1
* @see $usermodid	1
Use ($datef - $datep)	1
* @see $contact_id	1
Try to use $status now	1
* @see $availability_id	1
Use $label instead	1
Use $status instead	1
Use $status_buy instead	1
* @see $ref_supplier	1
* @see $warehouse_id	1
* @see $origin_id	1
* see $origin_type	1
* @see $user_author_id	1
* @see $price_ht	1
* @var string Mode reglement	1
* @see $date_reception	1
* @see $date_start	1
* @see $date_end	1
* @see $date_c	1
* @see $date_m	1
Use date_start instead	1
Use date_end instead	1
use status instead	1
* @see product_label;	1
* @see $origin_line_id	1
use status	1
Was used by createPaymentStripe only that is deprecated	1
This function will never be used. Status of a contract is status of its lines.	1
since V18	1
Use getJavascriptRenderer	1
Use update function instead	1
* @see setStarted()	1
Use select_dolusers instead	1
Use getSelectConditionsPaiements() instead and handle noprint locally.	1
* @see formconfirm()	1
* @return void	1
* @see selectDate(), form_date(), select_month(), select_year(), select_dayofweek()	1
Use instead selectColor	1
Use print xxx->select_juridicalstatus instead	1
Use method price to output a price	1
Use the doActions of hooks instead of this.	1
* @see update_note()	1
ldap_close is an alias of ldap_unbind, so use unbind() instead.	1
Use getName() instead	1
* @return bool	1
yes this setTypeFromTypeString came deprecated because it exists only for manage setup conversion	1
Use print xxx->showdocuments() instead.	1
Use setDiscount() instead.	1
* @see setCanceled()	1
* @see setDiscount()	1
* @see setPaid()	1
Use parseCurlResponse instead	1
Use getPropertiesIteratorForPath() instead (as it's more memory efficient)	1
Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect.	1
2.0.0 No longer used by internal code. Please use the Complex\Complex class instead	1
Use the assertSentTimes method instead	1
Use "reduceSpread" instead	1
This is no longer being maintained, it was an experiment at the time.	1
use get_soapbody instead	1
The `save` method is deprecated and will be removed in a	1
in favor on addThrowable	1
in favor on formatThrowableData	1
Use setAsCustomer() instead	1
use set_availability	1
use set_demand_reason	1
Use Product::update instead	1
see getControllerUrl()	1
see main	1
search on some categories must be done using a WHERE EXISTS or NOT EXISTS and not a LEFT JOIN. @TODO Replace with getWhereQuery($type, $searchCategoryList)	1
search on some categories must be done using a WHERE EXISTS or NOT EXISTS and not a LEFT JOIN	1
Will be removed in v5. Use getDataUri() instead.	1
since SwiftMailer 6.1.0; use Swift_Signers_DKIMSigner instead.	2
Will be removed in a future Laravel version.	2
* @see $date_shipping	2
* @see $civility_code	2
* @see $id	2
No more used (we have info into debit/credit and sens)	2
* @see $subprice	2
* @see $fk_account	2
Use $user_modification_id	2
* @see $date	2
* @see $remise_percent, $fk_remise_except	2
Use $num_payment instead	2
* @see $amount	2
* @see $total_ht	2
*	2
* @see $date_creation	2
* @see $date_validation	2
* @see $total_ttc	2
* @see $product_type	2
Seems not used.	2
Use self::VERSIONS	3
* @see $socid	3
Use $origin_object instead.	3
Use $user_creation_id	3
* @see $ref_supplier	3
Use $label	3
* @see $total_tva	3
* @see $amount, $amounts	4
* @see $status	4
* @see setPaid()	4
* @see setUnpaid()	4
* @see $ref_customer	5
* @see $product_label	5
* @see $label	5
Use setDeliveryDate	5
* @see $product_ref	6
It uses OS language package and strftime() which is deprecated since PHP 8.1.	6
since version 2.6.9	8
see getNextValue	12
* @see $name	27
To avoid conflict between different third-party libraries, static setters should not be used.	30
*/	68
@deprectad	Remove this. A "proforma invoice" is an order with a look of invoice, not an invoice !	1
@example	symfony/yaml:*	1
	*	1
	DOMAIN\username	1
	$restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);	1
	$restler->setOverridingFormats('JsonFormat', 'XmlFormat'...);	1
	http://localhost/restler3	1
	http://restler3.com	1
	_pre_get_json	1
	_post_get_json	1
	Basic	1
	Digest	1
	OAuth	1
	GET	1
	jsonFormat, xmlFormat, yamlFormat etc	2
	JsonFormat	2
	return ['Illuminate\\View\\View' => 'illuminate/view:4.2.*']	2
	$date->add('hour', 3)	2
	$date->add(15, 'days')	2
	$date->add(CarbonInterval::days(4))	2
	getPreciseTimestamp() 1532087464437474 (microsecond maximum precision)	2
	getPreciseTimestamp(6) 1532087464437474	2
	getPreciseTimestamp(5) 153208746443747 (1/100000 second precision)	2
	getPreciseTimestamp(4) 15320874644375 (1/10000 second precision)	2
	getPreciseTimestamp(3) 1532087464437 (millisecond precision)	2
	getPreciseTimestamp(2) 153208746444 (1/100 second precision)	2
	getPreciseTimestamp(1) 15320874644 (1/10 second precision)	2
	getPreciseTimestamp(0) 1532087464 (second precision)	2
	getPreciseTimestamp(-1) 153208746 (10 second precision)	2
	getPreciseTimestamp(-2) 15320875 (100 second precision)	2
	$date->sub('hour', 3)	2
	$date->sub(15, 'days')	2
	$date->sub(CarbonInterval::days(4))	2
	array('application/json'=>'json');	4
	* ```	213
@expectedException	\Psr\Log\InvalidArgumentException	1
@expires	numOfSeconds	1
@file	* PHP class to creates array representations for 2D barcodes to be used with TCPDF.	1
	* PHP class to creates array representations for common 1D barcodes to be used with TCPDF.	1
	* PHP color class for TCPDF	1
	* This is a PHP class that contains static methods for the TCPDF class.	1
	* Unicode data and font methods for TCPDF library.	1
	* This is a PHP class that contains static image methods for the TCPDF class.	1
	* Unicode data and encoding maps for TCPDF.	1
	* This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters).	1
	DeprecationHandler.php	1
@final	*/	1
@fixme	Firefox (Geckodriver/Marionette) support	1
@global	Conf $conf Dolibarr configuration object (global)	1
	DoliDB $db Database connection object (global)	1
	User $user Current user object (global)	1
	Translate $langs Language translation object, initialized within the function if not already.	1
	HookManager $hookmanager Hook manager object, initialized within the function if not already for executing hooks.	1
	string $action Current action, can be modified by hooks.	1
	object $object Current object, can be modified by hooks.	1
@hybrid	- both public and protected (enhanced info for authorized)	1
@ignore	* @return void	8
	*/	15
@info	http://php.net/manual/es/errorfunc.constants.php	1
@ingroup	core	1
@inheritdoc	*/	2
	self::query($charset = 'UTF-8')	2
@internal	param string $data composed json output	2
	*	5
	*/	21
@license	http://www.opensource.org/licenses/mit-license.html MIT License	1
	https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE	1
	http://code.google.com/p/sabredav/wiki/License Modified BSD License	2
	http://sabre.io/license/	4
	https://www.gnu.org/copyleft/gpl.html GPL License	6
	http://www.opensource.org/licenses/bsd-license.php BSD License	6
	http://www.opensource.org/licenses/mit-license.html MIT License	7
	http://www.opensource.org/licenses/lgpl-license.php LGPL	106
	http://sabre.io/license/ Modified BSD License	340
@link	https://github.com/SciDevs/delicious-api/blob/master/api/oauth.md	1
	https://devcenter.heroku.com/articles/oauth	1
	https://developer.vimeo.com/	1
	https://developer.vimeo.com/api/authentication	1
	https://www.dropbox.com/developers/core/docs	1
	http://strava.github.io/	1
	http://strava.github.io/api/v3/oauth/	1
	https://api.hubic.com/docs/	1
	https://dev.netatmo.com/doc/	1
	https://bufferapp.com/developers/api	1
	http://developer.linkedin.com/documents/authentication	1
	http://www.dailymotion.com/doc/api/authentication.html	1
	https://developer.nest.com/documentation	1
	https://flowerpowerdev.parrot.com/projects/flower-power-web-service-api/wiki	1
	https://developers.box.com/oauth/	1
	http://runkeeper.com/developer/healthgraph/registration-authorization	1
	https://developers.500px.com/	1
	Swift_Mime_SimpleMessage}.	1
	https://www.paymentstandards.ch/en/home/software-partner/alternative-schemes.html	1
	\GeoIp2\Exception\AddressNotFoundException} exception will be	1
	\InvalidArgumentException} will be thrown. If the database is	1
	\MaxMind\Db\Reader\InvalidDatabaseException}	1
	https://devcenter.heroku.com/articles/oauth#scopes	1
	http://instagram.com/developer/authentication/#scope	1
	https://www.deviantart.com/developers/authentication	1
	https://www.deviantart.com/developers/http/v1/20150217	1
	http://developer.linkedin.com/documents/authentication#granting	1
	http://www.reddit.com/dev/api/oauth	1
	http://vk.com/dev/permissions	1
	https://developers.facebook.com/docs/reference/login/	1
	https://developers.facebook.com/tools/explorer For a list of permissions use 'Get Access Token'	1
	http://tools.ietf.org/html/rfc5322#section-3.2.3)	1
	BYTES_PER_MINUTE} or {@link MESSAGES_PER_MINUTE}	1
	http://en.wikipedia.org/wiki/Operator-precedence_parser#Pseudo-code	1
	getInstance()} instead.	1
	withDependencies()},	1
	addConstructorValue()} or {@link addConstructorLookup()}.	1
	Swift_Plugins_Decorator_Replacements}.	1
	Swift_Plugins_Decorator_Replacements},	1
	Swift_Plugins_Decorator_Replacements::getReplacementsFor()}.	1
	Swift_Plugins_Decorator_Replacements} then the call will be	1
	LEVEL_TOP} for a message instance.	1
	Swift_Mime_SimpleMimeEntity} such as an Attachment or MimePart.	1
	Swift_Mime_SimpleMimeEntity} and return it's CID source.	1
	get()} or it may	1
	Swift_Mime_SimpleHeaderSet} for this entity.	1
	LEVEL_MIXED}.	1
	getNameAddresses()}	1
	http://php.net/manual/en/jsonserializable.jsonserialize.php	1
	https://php.net/manual/en/dateinterval.createfromdatestring.php	1
	https://php.net/manual/en/jsonserializable.jsonserialize.php	1
	https://php.net/manual/en/datetime.gettimezone.php	1
	http://www.php.net/manual/en/function.array-merge-recursive.php#96201	1
	https://php.net/manual/en/function.imap-rfc822-parse-headers.php	1
	https://php.net/manual/en/function.imap-mime-header-decode.php	1
	BaseStripeClient} class.	1
	DEFAULT_API_BASE}.	1
	DEFAULT_CONNECT_BASE}.	1
	DEFAULT_FILES_BASE}.	1
	AbstractService} class.	1
	http://php.net/manual/en/pdostatement.bindcolumn.php	1
	http://php.net/manual/en/pdostatement.bindparam.php	1
	http://php.net/manual/en/pdostatement.bindvalue.php	1
	http://php.net/manual/en/pdostatement.execute.php	1
http://php.net/manual/en/pdo.begintransaction.php	1
http://php.net/manual/en/pdo.commit.php	1
http://php.net/manual/en/pdo.exec.php	1
http://php.net/manual/en/pdo.getattribute.php	1
http://php.net/manual/en/pdo.intransaction.php	1
http://php.net/manual/en/pdo.lastinsertid.php	1
http://php.net/manual/en/pdo.prepare.php	1
http://php.net/manual/en/pdo.query.php	1
http://php.net/manual/en/pdo.quote.php	1
http://php.net/manual/en/pdo.rollback.php	1
http://php.net/manual/en/pdo.setattribute.php	1
https://jawbone.com/up/developer/authentication	2
https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/detailed/	2
https://images-na.ssl-images-amazon.com/images/G/01/lwa/dev/docs/website-developer-guide._TTH_.pdf	2
\Stripe\StripeClient}.	2
Swift_OutputByteStream}.	2
https://php.net/manual/en/datetime.modify.php	2
http://php.net/manual/en/pdo.errorinfo.php	2
commit()}	3
Swift_InputByteStream}.	3
toString()} for that).	3
register()} must be called before this will work.	4
http://pear.php.net/package/Mail_mime	6
write()} and {@link flushBuffers()} operations will be mirrored.	6
http://php.net/manual/en/imap.constants.php	26
http://luracast.com/products/restler/	106
@method	bool hasEmergency($record)	1
bool hasAlert($record)	1
bool hasCritical($record)	1
bool hasError($record)	1
bool hasWarning($record)	1
bool hasNotice($record)	1
bool hasInfo($record)	1
bool hasDebug($record)	1
bool hasEmergencyRecords()	1
bool hasAlertRecords()	1
bool hasCriticalRecords()	1
bool hasErrorRecords()	1
bool hasWarningRecords()	1
bool hasNoticeRecords()	1
bool hasInfoRecords()	1
bool hasDebugRecords()	1
bool hasEmergencyThatContains($message)	1
bool hasAlertThatContains($message)	1
bool hasCriticalThatContains($message)	1
bool hasErrorThatContains($message)	1
bool hasWarningThatContains($message)	1
bool hasNoticeThatContains($message)	1
bool hasInfoThatContains($message)	1
bool hasDebugThatContains($message)	1
bool hasEmergencyThatMatches($message)	1
bool hasAlertThatMatches($message)	1
bool hasCriticalThatMatches($message)	1
bool hasErrorThatMatches($message)	1
bool hasWarningThatMatches($message)	1
bool hasNoticeThatMatches($message)	1
bool hasInfoThatMatches($message)	1
bool hasDebugThatMatches($message)	1
bool hasEmergencyThatPasses($message)	1
bool hasAlertThatPasses($message)	1
bool hasCriticalThatPasses($message)	1
bool hasErrorThatPasses($message)	1
bool hasWarningThatPasses($message)	1
bool hasNoticeThatPasses($message)	1
bool hasInfoThatPasses($message)	1
bool hasDebugThatPasses($message)	1
Ods getParentWriter	1
Swift_SmtpTransport setUsername(string $username) Set the username to authenticate with.	1
string getUsername() Get the username to authenticate with.	1
Swift_SmtpTransport setPassword(string $password) Set the password to authenticate with.	1
string getPassword() Get the password to authenticate with.	1
Swift_SmtpTransport setAuthMode(string $mode) Set the auth mode to use to authenticate.	1
string getAuthMode() Get the auth mode to use to authenticate.	1
static void onGet() onGet(Callable $function) fired before reading the request details	1
static void onRoute() onRoute(Callable $function) fired before finding the api method	1
static void onNegotiate() onNegotiate(Callable $function) fired before content negotiation	1
static void onPreAuthFilter() onPreAuthFilter(Callable $function) fired before pre auth filtering	1
static void onAuthenticate() onAuthenticate(Callable $function) fired before auth	1
static void onPostAuthFilter() onPostAuthFilter(Callable $function) fired before post auth filtering	1
static void onValidate() onValidate(Callable $function) fired before validation	1
static void onCall() onCall(Callable $function) fired before api method call	1
static void onCompose() onCompose(Callable $function) fired before composing response	1
static void onRespond() onRespond(Callable $function) fired before sending response	1
static void onComplete() onComplete(Callable $function) fired after sending response	1
static void onMessage() onMessage(Callable $function) fired before composing error response	1
void onGet() onGet(Callable $function) fired before reading the request details	1
void onRoute() onRoute(Callable $function) fired before finding the api method	1
void onNegotiate() onNegotiate(Callable $function) fired before content negotiation	1
void onPreAuthFilter() onPreAuthFilter(Callable $function) fired before pre auth filtering	1
void onAuthenticate() onAuthenticate(Callable $function) fired before auth	1
void onPostAuthFilter() onPostAuthFilter(Callable $function) fired before post auth filtering	1
void onValidate() onValidate(Callable $function) fired before validation	1
void onCall() onCall(Callable $function) fired before api method call	1
void onCompose() onCompose(Callable $function) fired before composing response	1
void onRespond() onRespond(Callable $function) fired before sending response	1
void onComplete() onComplete(Callable $function) fired after sending response	1
void onMessage() onMessage(Callable $function) fired before composing error response	1
Carbon|false create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $tz = null) Create a new Carbon instance from a specific date and time.	1
Carbon createFromDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to now.	1
Carbon|false createFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.	1
Carbon|false createFromIsoFormat($format, $time, $tz = null, $locale = 'en', $translator = null) Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).	1
Carbon|false createFromLocaleFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific format and a string in a given language.	1
Carbon|false createFromLocaleIsoFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific ISO format and a string in a given language.	1
Carbon createFromTime($hour = 0, $minute = 0, $second = 0, $tz = null) Create a Carbon instance from just a time. The date portion is set to today.	1
Carbon createFromTimeString($time, $tz = null) Create a Carbon instance from a time string. The date portion is set to today.	1
Carbon createFromTimestamp($timestamp, $tz = null) Create a Carbon instance from a timestamp and set the timezone (use default one if not specified).	1
Carbon createFromTimestampMs($timestamp, $tz = null) Create a Carbon instance from a timestamp in milliseconds.	1
Carbon createFromTimestampMsUTC($timestamp) Create a Carbon instance from a timestamp in milliseconds.	1
Carbon createFromTimestampUTC($timestamp) Create a Carbon instance from an timestamp keeping the timezone to UTC.	1
Carbon createMidnightDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to midnight.	1
Carbon|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null) Create a new safe Carbon instance from a specific date and time.	1
Carbon disableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
Carbon enableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
Carbon fromSerialized($value) Create an instance from a serialized string.	1
Closure|Carbon getTestNow() Get the Carbon instance (real or mock) to be returned when a "now"	1
Carbon instance($date) Create a Carbon instance from a DateTime one.	1
Carbon|null make($var) Make a Carbon instance from given variable if possible.	1
Carbon maxValue() Create a Carbon instance for the greatest supported date.	1
Carbon minValue() Create a Carbon instance for the lowest supported date.	1
Carbon now($tz = null) Get a Carbon instance for the current date and time.	1
Carbon parse($time = null, $tz = null) Create a carbon instance from a string.	1
Carbon parseFromLocale($time, $locale = null, $tz = null) Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).	1
Carbon|false rawCreateFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.	1
Carbon rawParse($time = null, $tz = null) Create a carbon instance from a string.	1
Carbon resetMacros() Remove all macros and generic macros.	1
Carbon setFallbackLocale($locale) Set the fallback locale.	1
Carbon setHumanDiffOptions($humanDiffOptions) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
Carbon setTestNow($testNow = null) Set a Carbon instance (real or mock) to be returned when a "now"	1
Carbon setTestNowAndTimezone($testNow = null, $tz = null) Set a Carbon instance (real or mock) to be returned when a "now"	1
Carbon setUtf8($utf8) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
Carbon today($tz = null) Create a Carbon instance for today.	1
Carbon tomorrow($tz = null) Create a Carbon instance for tomorrow.	1
Carbon useStrictMode($strictModeEnabled = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
Carbon yesterday($tz = null) Create a Carbon instance for yesterday.	1
bool isUtc() Check if the current instance has UTC timezone. (Both isUtc and isUTC cases are valid.)	1
bool isLocal() Check if the current instance has non-UTC timezone.	1
bool isValid() Check if the current instance is a valid date.	1
bool isDST() Check if the current instance is in a daylight saving time.	1
bool isSunday() Checks if the instance day is sunday.	1
bool isMonday() Checks if the instance day is monday.	1
bool isTuesday() Checks if the instance day is tuesday.	1
bool isWednesday() Checks if the instance day is wednesday.	1
bool isThursday() Checks if the instance day is thursday.	1
bool isFriday() Checks if the instance day is friday.	1
bool isSaturday() Checks if the instance day is saturday.	1
bool isSameYear(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentYear() Checks if the instance is in the same year as the current moment.	1
bool isNextYear() Checks if the instance is in the same year as the current moment next year.	1
bool isLastYear() Checks if the instance is in the same year as the current moment last year.	1
bool isSameWeek(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same week as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentWeek() Checks if the instance is in the same week as the current moment.	1
bool isNextWeek() Checks if the instance is in the same week as the current moment next week.	1
bool isLastWeek() Checks if the instance is in the same week as the current moment last week.	1
bool isSameDay(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentDay() Checks if the instance is in the same day as the current moment.	1
bool isNextDay() Checks if the instance is in the same day as the current moment next day.	1
bool isLastDay() Checks if the instance is in the same day as the current moment last day.	1
bool isSameHour(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same hour as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentHour() Checks if the instance is in the same hour as the current moment.	1
bool isNextHour() Checks if the instance is in the same hour as the current moment next hour.	1
bool isLastHour() Checks if the instance is in the same hour as the current moment last hour.	1
bool isSameMinute(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same minute as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMinute() Checks if the instance is in the same minute as the current moment.	1
bool isNextMinute() Checks if the instance is in the same minute as the current moment next minute.	1
bool isLastMinute() Checks if the instance is in the same minute as the current moment last minute.	1
bool isSameSecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same second as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentSecond() Checks if the instance is in the same second as the current moment.	1
bool isNextSecond() Checks if the instance is in the same second as the current moment next second.	1
bool isLastSecond() Checks if the instance is in the same second as the current moment last second.	1
bool isSameMicro(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMicro() Checks if the instance is in the same microsecond as the current moment.	1
bool isNextMicro() Checks if the instance is in the same microsecond as the current moment next microsecond.	1
bool isLastMicro() Checks if the instance is in the same microsecond as the current moment last microsecond.	1
bool isSameMicrosecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMicrosecond() Checks if the instance is in the same microsecond as the current moment.	1
bool isNextMicrosecond() Checks if the instance is in the same microsecond as the current moment next microsecond.	1
bool isLastMicrosecond() Checks if the instance is in the same microsecond as the current moment last microsecond.	1
bool isCurrentMonth() Checks if the instance is in the same month as the current moment.	1
bool isNextMonth() Checks if the instance is in the same month as the current moment next month.	1
bool isLastMonth() Checks if the instance is in the same month as the current moment last month.	1
bool isCurrentQuarter() Checks if the instance is in the same quarter as the current moment.	1
bool isNextQuarter() Checks if the instance is in the same quarter as the current moment next quarter.	1
bool isLastQuarter() Checks if the instance is in the same quarter as the current moment last quarter.	1
bool isSameDecade(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same decade as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentDecade() Checks if the instance is in the same decade as the current moment.	1
bool isNextDecade() Checks if the instance is in the same decade as the current moment next decade.	1
bool isLastDecade() Checks if the instance is in the same decade as the current moment last decade.	1
bool isSameCentury(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same century as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentCentury() Checks if the instance is in the same century as the current moment.	1
bool isNextCentury() Checks if the instance is in the same century as the current moment next century.	1
bool isLastCentury() Checks if the instance is in the same century as the current moment last century.	1
bool isSameMillennium(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same millennium as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMillennium() Checks if the instance is in the same millennium as the current moment.	1
bool isNextMillennium() Checks if the instance is in the same millennium as the current moment next millennium.	1
bool isLastMillennium() Checks if the instance is in the same millennium as the current moment last millennium.	1
$this years(int $value) Set current instance year to the given value.	1
$this year(int $value) Set current instance year to the given value.	1
$this setYears(int $value) Set current instance year to the given value.	1
$this setYear(int $value) Set current instance year to the given value.	1
$this months(int $value) Set current instance month to the given value.	1
$this month(int $value) Set current instance month to the given value.	1
$this setMonths(int $value) Set current instance month to the given value.	1
$this setMonth(int $value) Set current instance month to the given value.	1
$this days(int $value) Set current instance day to the given value.	1
$this day(int $value) Set current instance day to the given value.	1
$this setDays(int $value) Set current instance day to the given value.	1
$this setDay(int $value) Set current instance day to the given value.	1
$this hours(int $value) Set current instance hour to the given value.	1
$this hour(int $value) Set current instance hour to the given value.	1
$this setHours(int $value) Set current instance hour to the given value.	1
$this setHour(int $value) Set current instance hour to the given value.	1
$this minutes(int $value) Set current instance minute to the given value.	1
$this minute(int $value) Set current instance minute to the given value.	1
$this setMinutes(int $value) Set current instance minute to the given value.	1
$this setMinute(int $value) Set current instance minute to the given value.	1
$this seconds(int $value) Set current instance second to the given value.	1
$this second(int $value) Set current instance second to the given value.	1
$this setSeconds(int $value) Set current instance second to the given value.	1
$this setSecond(int $value) Set current instance second to the given value.	1
$this millis(int $value) Set current instance millisecond to the given value.	1
$this milli(int $value) Set current instance millisecond to the given value.	1
$this setMillis(int $value) Set current instance millisecond to the given value.	1
$this setMilli(int $value) Set current instance millisecond to the given value.	1
$this milliseconds(int $value) Set current instance millisecond to the given value.	1
$this millisecond(int $value) Set current instance millisecond to the given value.	1
$this setMilliseconds(int $value) Set current instance millisecond to the given value.	1
$this setMillisecond(int $value) Set current instance millisecond to the given value.	1
$this micros(int $value) Set current instance microsecond to the given value.	1
$this micro(int $value) Set current instance microsecond to the given value.	1
$this setMicros(int $value) Set current instance microsecond to the given value.	1
$this setMicro(int $value) Set current instance microsecond to the given value.	1
$this microseconds(int $value) Set current instance microsecond to the given value.	1
$this microsecond(int $value) Set current instance microsecond to the given value.	1
$this setMicroseconds(int $value) Set current instance microsecond to the given value.	1
$this setMicrosecond(int $value) Set current instance microsecond to the given value.	1
$this addYears(int $value = 1) Add years (the $value count passed in) to the instance (using date interval).	1
$this addYear() Add one year to the instance (using date interval).	1
$this subYears(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval).	1
$this subYear() Sub one year to the instance (using date interval).	1
$this addYearsWithOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addYearWithOverflow() Add one year to the instance (using date interval) with overflow explicitly allowed.	1
$this subYearsWithOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subYearWithOverflow() Sub one year to the instance (using date interval) with overflow explicitly allowed.	1
$this addYearsWithoutOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addYearWithoutOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearsWithoutOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearWithoutOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this addYearsWithNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addYearWithNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearsWithNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearWithNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this addYearsNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addYearNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearsNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subYearNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonths(int $value = 1) Add months (the $value count passed in) to the instance (using date interval).	1
$this addMonth() Add one month to the instance (using date interval).	1
$this subMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval).	1
$this subMonth() Sub one month to the instance (using date interval).	1
$this addMonthsWithOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addMonthWithOverflow() Add one month to the instance (using date interval) with overflow explicitly allowed.	1
$this subMonthsWithOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subMonthWithOverflow() Sub one month to the instance (using date interval) with overflow explicitly allowed.	1
$this addMonthsWithoutOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonthWithoutOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthsWithoutOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthWithoutOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonthsWithNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonthWithNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthsWithNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthWithNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonthsNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMonthNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthsNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMonthNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDays(int $value = 1) Add days (the $value count passed in) to the instance (using date interval).	1
$this addDay() Add one day to the instance (using date interval).	1
$this subDays(int $value = 1) Sub days (the $value count passed in) to the instance (using date interval).	1
$this subDay() Sub one day to the instance (using date interval).	1
$this addHours(int $value = 1) Add hours (the $value count passed in) to the instance (using date interval).	1
$this addHour() Add one hour to the instance (using date interval).	1
$this subHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using date interval).	1
$this subHour() Sub one hour to the instance (using date interval).	1
$this addMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using date interval).	1
$this addMinute() Add one minute to the instance (using date interval).	1
$this subMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using date interval).	1
$this subMinute() Sub one minute to the instance (using date interval).	1
$this addSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using date interval).	1
$this addSecond() Add one second to the instance (using date interval).	1
$this subSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using date interval).	1
$this subSecond() Sub one second to the instance (using date interval).	1
$this addMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	1
$this addMilli() Add one millisecond to the instance (using date interval).	1
$this subMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	1
$this subMilli() Sub one millisecond to the instance (using date interval).	1
$this addMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	1
$this addMillisecond() Add one millisecond to the instance (using date interval).	1
$this subMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	1
$this subMillisecond() Sub one millisecond to the instance (using date interval).	1
$this addMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	1
$this addMicro() Add one microsecond to the instance (using date interval).	1
$this subMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	1
$this subMicro() Sub one microsecond to the instance (using date interval).	1
$this addMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	1
$this addMicrosecond() Add one microsecond to the instance (using date interval).	1
$this subMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	1
$this subMicrosecond() Sub one microsecond to the instance (using date interval).	1
$this addMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval).	1
$this addMillennium() Add one millennium to the instance (using date interval).	1
$this subMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval).	1
$this subMillennium() Sub one millennium to the instance (using date interval).	1
$this addMillenniaWithOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addMillenniumWithOverflow() Add one millennium to the instance (using date interval) with overflow explicitly allowed.	1
$this subMillenniaWithOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subMillenniumWithOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly allowed.	1
$this addMillenniaWithoutOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMillenniumWithoutOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniaWithoutOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniumWithoutOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMillenniaWithNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMillenniumWithNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniaWithNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniumWithNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMillenniaNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addMillenniumNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniaNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subMillenniumNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval).	1
$this addCentury() Add one century to the instance (using date interval).	1
$this subCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval).	1
$this subCentury() Sub one century to the instance (using date interval).	1
$this addCenturiesWithOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addCenturyWithOverflow() Add one century to the instance (using date interval) with overflow explicitly allowed.	1
$this subCenturiesWithOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subCenturyWithOverflow() Sub one century to the instance (using date interval) with overflow explicitly allowed.	1
$this addCenturiesWithoutOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturyWithoutOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturiesWithoutOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturyWithoutOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturiesWithNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturyWithNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturiesWithNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturyWithNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturiesNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addCenturyNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturiesNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subCenturyNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval).	1
$this addDecade() Add one decade to the instance (using date interval).	1
$this subDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval).	1
$this subDecade() Sub one decade to the instance (using date interval).	1
$this addDecadesWithOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addDecadeWithOverflow() Add one decade to the instance (using date interval) with overflow explicitly allowed.	1
$this subDecadesWithOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subDecadeWithOverflow() Sub one decade to the instance (using date interval) with overflow explicitly allowed.	1
$this addDecadesWithoutOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecadeWithoutOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadesWithoutOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadeWithoutOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecadesWithNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecadeWithNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadesWithNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadeWithNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecadesNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addDecadeNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadesNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subDecadeNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval).	1
$this addQuarter() Add one quarter to the instance (using date interval).	1
$this subQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval).	1
$this subQuarter() Sub one quarter to the instance (using date interval).	1
$this addQuartersWithOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this addQuarterWithOverflow() Add one quarter to the instance (using date interval) with overflow explicitly allowed.	1
$this subQuartersWithOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
$this subQuarterWithOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly allowed.	1
$this addQuartersWithoutOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuarterWithoutOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuartersWithoutOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuarterWithoutOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuartersWithNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuarterWithNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuartersWithNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuarterWithNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuartersNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this addQuarterNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuartersNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
$this subQuarterNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
$this addWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using date interval).	1
$this addWeek() Add one week to the instance (using date interval).	1
$this subWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using date interval).	1
$this subWeek() Sub one week to the instance (using date interval).	1
$this addWeekdays(int $value = 1) Add weekdays (the $value count passed in) to the instance (using date interval).	1
$this addWeekday() Add one weekday to the instance (using date interval).	1
$this subWeekdays(int $value = 1) Sub weekdays (the $value count passed in) to the instance (using date interval).	1
$this subWeekday() Sub one weekday to the instance (using date interval).	1
$this addRealMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	1
$this addRealMicro() Add one microsecond to the instance (using timestamp).	1
$this subRealMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	1
$this subRealMicro() Sub one microsecond to the instance (using timestamp).	1
CarbonPeriod microsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	1
$this addRealMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	1
$this addRealMicrosecond() Add one microsecond to the instance (using timestamp).	1
$this subRealMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	1
$this subRealMicrosecond() Sub one microsecond to the instance (using timestamp).	1
CarbonPeriod microsecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	1
$this addRealMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	1
$this addRealMilli() Add one millisecond to the instance (using timestamp).	1
$this subRealMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	1
$this subRealMilli() Sub one millisecond to the instance (using timestamp).	1
CarbonPeriod millisUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	1
$this addRealMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	1
$this addRealMillisecond() Add one millisecond to the instance (using timestamp).	1
$this subRealMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	1
$this subRealMillisecond() Sub one millisecond to the instance (using timestamp).	1
CarbonPeriod millisecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	1
$this addRealSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using timestamp).	1
$this addRealSecond() Add one second to the instance (using timestamp).	1
$this subRealSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using timestamp).	1
$this subRealSecond() Sub one second to the instance (using timestamp).	1
CarbonPeriod secondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each second or every X seconds if a factor is given.	1
$this addRealMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using timestamp).	1
$this addRealMinute() Add one minute to the instance (using timestamp).	1
$this subRealMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using timestamp).	1
$this subRealMinute() Sub one minute to the instance (using timestamp).	1
CarbonPeriod minutesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each minute or every X minutes if a factor is given.	1
$this addRealHours(int $value = 1) Add hours (the $value count passed in) to the instance (using timestamp).	1
$this addRealHour() Add one hour to the instance (using timestamp).	1
$this subRealHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using timestamp).	1
$this subRealHour() Sub one hour to the instance (using timestamp).	1
CarbonPeriod hoursUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each hour or every X hours if a factor is given.	1
$this addRealDays(int $value = 1) Add days (the $value count passed in) to the instance (using timestamp).	1
$this addRealDay() Add one day to the instance (using timestamp).	1
$this subRealDays(int $value = 1) Sub days (the $value count passed in) to the instance (using timestamp).	1
$this subRealDay() Sub one day to the instance (using timestamp).	1
CarbonPeriod daysUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each day or every X days if a factor is given.	1
$this addRealWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using timestamp).	1
$this addRealWeek() Add one week to the instance (using timestamp).	1
$this subRealWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using timestamp).	1
$this subRealWeek() Sub one week to the instance (using timestamp).	1
CarbonPeriod weeksUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each week or every X weeks if a factor is given.	1
$this addRealMonths(int $value = 1) Add months (the $value count passed in) to the instance (using timestamp).	1
$this addRealMonth() Add one month to the instance (using timestamp).	1
$this subRealMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using timestamp).	1
$this subRealMonth() Sub one month to the instance (using timestamp).	1
CarbonPeriod monthsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each month or every X months if a factor is given.	1
$this addRealQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using timestamp).	1
$this addRealQuarter() Add one quarter to the instance (using timestamp).	1
$this subRealQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using timestamp).	1
$this subRealQuarter() Sub one quarter to the instance (using timestamp).	1
CarbonPeriod quartersUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each quarter or every X quarters if a factor is given.	1
$this addRealYears(int $value = 1) Add years (the $value count passed in) to the instance (using timestamp).	1
$this addRealYear() Add one year to the instance (using timestamp).	1
$this subRealYears(int $value = 1) Sub years (the $value count passed in) to the instance (using timestamp).	1
$this subRealYear() Sub one year to the instance (using timestamp).	1
CarbonPeriod yearsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each year or every X years if a factor is given.	1
$this addRealDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using timestamp).	1
$this addRealDecade() Add one decade to the instance (using timestamp).	1
$this subRealDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using timestamp).	1
$this subRealDecade() Sub one decade to the instance (using timestamp).	1
CarbonPeriod decadesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each decade or every X decades if a factor is given.	1
$this addRealCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using timestamp).	1
$this addRealCentury() Add one century to the instance (using timestamp).	1
$this subRealCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using timestamp).	1
$this subRealCentury() Sub one century to the instance (using timestamp).	1
CarbonPeriod centuriesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each century or every X centuries if a factor is given.	1
$this addRealMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using timestamp).	1
$this addRealMillennium() Add one millennium to the instance (using timestamp).	1
$this subRealMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using timestamp).	1
$this subRealMillennium() Sub one millennium to the instance (using timestamp).	1
CarbonPeriod millenniaUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millennium or every X millennia if a factor is given.	1
$this roundYear(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this roundYears(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this floorYear(float $precision = 1) Truncate the current instance year with given precision.	1
$this floorYears(float $precision = 1) Truncate the current instance year with given precision.	1
$this ceilYear(float $precision = 1) Ceil the current instance year with given precision.	1
$this ceilYears(float $precision = 1) Ceil the current instance year with given precision.	1
$this roundMonth(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this roundMonths(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this floorMonth(float $precision = 1) Truncate the current instance month with given precision.	1
$this floorMonths(float $precision = 1) Truncate the current instance month with given precision.	1
$this ceilMonth(float $precision = 1) Ceil the current instance month with given precision.	1
$this ceilMonths(float $precision = 1) Ceil the current instance month with given precision.	1
$this roundDay(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this roundDays(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this floorDay(float $precision = 1) Truncate the current instance day with given precision.	1
$this floorDays(float $precision = 1) Truncate the current instance day with given precision.	1
$this ceilDay(float $precision = 1) Ceil the current instance day with given precision.	1
$this ceilDays(float $precision = 1) Ceil the current instance day with given precision.	1
$this roundHour(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this roundHours(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this floorHour(float $precision = 1) Truncate the current instance hour with given precision.	1
$this floorHours(float $precision = 1) Truncate the current instance hour with given precision.	1
$this ceilHour(float $precision = 1) Ceil the current instance hour with given precision.	1
$this ceilHours(float $precision = 1) Ceil the current instance hour with given precision.	1
$this roundMinute(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this roundMinutes(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this floorMinute(float $precision = 1) Truncate the current instance minute with given precision.	1
$this floorMinutes(float $precision = 1) Truncate the current instance minute with given precision.	1
$this ceilMinute(float $precision = 1) Ceil the current instance minute with given precision.	1
$this ceilMinutes(float $precision = 1) Ceil the current instance minute with given precision.	1
$this roundSecond(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this roundSeconds(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this floorSecond(float $precision = 1) Truncate the current instance second with given precision.	1
$this floorSeconds(float $precision = 1) Truncate the current instance second with given precision.	1
$this ceilSecond(float $precision = 1) Ceil the current instance second with given precision.	1
$this ceilSeconds(float $precision = 1) Ceil the current instance second with given precision.	1
$this roundMillennium(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this roundMillennia(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this floorMillennium(float $precision = 1) Truncate the current instance millennium with given precision.	1
$this floorMillennia(float $precision = 1) Truncate the current instance millennium with given precision.	1
$this ceilMillennium(float $precision = 1) Ceil the current instance millennium with given precision.	1
$this ceilMillennia(float $precision = 1) Ceil the current instance millennium with given precision.	1
$this roundCentury(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this roundCenturies(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this floorCentury(float $precision = 1) Truncate the current instance century with given precision.	1
$this floorCenturies(float $precision = 1) Truncate the current instance century with given precision.	1
$this ceilCentury(float $precision = 1) Ceil the current instance century with given precision.	1
$this ceilCenturies(float $precision = 1) Ceil the current instance century with given precision.	1
$this roundDecade(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this roundDecades(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this floorDecade(float $precision = 1) Truncate the current instance decade with given precision.	1
$this floorDecades(float $precision = 1) Truncate the current instance decade with given precision.	1
$this ceilDecade(float $precision = 1) Ceil the current instance decade with given precision.	1
$this ceilDecades(float $precision = 1) Ceil the current instance decade with given precision.	1
$this roundQuarter(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this roundQuarters(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this floorQuarter(float $precision = 1) Truncate the current instance quarter with given precision.	1
$this floorQuarters(float $precision = 1) Truncate the current instance quarter with given precision.	1
$this ceilQuarter(float $precision = 1) Ceil the current instance quarter with given precision.	1
$this ceilQuarters(float $precision = 1) Ceil the current instance quarter with given precision.	1
$this roundMillisecond(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this roundMilliseconds(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this floorMillisecond(float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this floorMilliseconds(float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this ceilMillisecond(float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this ceilMilliseconds(float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this roundMicrosecond(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this roundMicroseconds(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this floorMicrosecond(float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this floorMicroseconds(float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this ceilMicrosecond(float $precision = 1) Ceil the current instance microsecond with given precision.	1
$this ceilMicroseconds(float $precision = 1) Ceil the current instance microsecond with given precision.	1
string shortAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
static Carbon|false createFromFormat(string $format, string $time, string|DateTimeZone $timezone = null) Parse a string into a new Carbon object according to the specified format.	1
static Carbon __set_state(array $array) https://php.net/manual/en/datetime.set-state.php	1
static CarbonInterval years($years = 1) Create instance specifying a number of years or modify the number of years if called on an instance.	1
static CarbonInterval year($years = 1) Alias for years()	1
static CarbonInterval months($months = 1) Create instance specifying a number of months or modify the number of months if called on an instance.	1
static CarbonInterval month($months = 1) Alias for months()	1
static CarbonInterval weeks($weeks = 1) Create instance specifying a number of weeks or modify the number of weeks if called on an instance.	1
static CarbonInterval week($weeks = 1) Alias for weeks()	1
static CarbonInterval days($days = 1) Create instance specifying a number of days or modify the number of days if called on an instance.	1
static CarbonInterval dayz($days = 1) Alias for days()	1
static CarbonInterval daysExcludeWeeks($days = 1) Create instance specifying a number of days or modify the number of days (keeping the current number of weeks) if called on an instance.	1
static CarbonInterval dayzExcludeWeeks($days = 1) Alias for daysExcludeWeeks()	1
static CarbonInterval day($days = 1) Alias for days()	1
static CarbonInterval hours($hours = 1) Create instance specifying a number of hours or modify the number of hours if called on an instance.	1
static CarbonInterval hour($hours = 1) Alias for hours()	1
static CarbonInterval minutes($minutes = 1) Create instance specifying a number of minutes or modify the number of minutes if called on an instance.	1
static CarbonInterval minute($minutes = 1) Alias for minutes()	1
static CarbonInterval seconds($seconds = 1) Create instance specifying a number of seconds or modify the number of seconds if called on an instance.	1
static CarbonInterval second($seconds = 1) Alias for seconds()	1
static CarbonInterval milliseconds($milliseconds = 1) Create instance specifying a number of milliseconds or modify the number of milliseconds if called on an instance.	1
static CarbonInterval millisecond($milliseconds = 1) Alias for milliseconds()	1
static CarbonInterval microseconds($microseconds = 1) Create instance specifying a number of microseconds or modify the number of microseconds if called on an instance.	1
static CarbonInterval microsecond($microseconds = 1) Alias for microseconds()	1
$this addYears(int $years) Add given number of years to the current interval	1
$this subYears(int $years) Subtract given number of years to the current interval	1
$this addMonths(int $months) Add given number of months to the current interval	1
$this subMonths(int $months) Subtract given number of months to the current interval	1
$this addWeeks(int|float $weeks) Add given number of weeks to the current interval	1
$this subWeeks(int|float $weeks) Subtract given number of weeks to the current interval	1
$this addDays(int|float $days) Add given number of days to the current interval	1
$this subDays(int|float $days) Subtract given number of days to the current interval	1
$this addHours(int|float $hours) Add given number of hours to the current interval	1
$this subHours(int|float $hours) Subtract given number of hours to the current interval	1
$this addMinutes(int|float $minutes) Add given number of minutes to the current interval	1
$this subMinutes(int|float $minutes) Subtract given number of minutes to the current interval	1
$this addSeconds(int|float $seconds) Add given number of seconds to the current interval	1
$this subSeconds(int|float $seconds) Subtract given number of seconds to the current interval	1
$this addMilliseconds(int|float $milliseconds) Add given number of milliseconds to the current interval	1
$this subMilliseconds(int|float $milliseconds) Subtract given number of milliseconds to the current interval	1
$this addMicroseconds(int|float $microseconds) Add given number of microseconds to the current interval	1
$this subMicroseconds(int|float $microseconds) Subtract given number of microseconds to the current interval	1
$this roundYear(int|float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this roundYears(int|float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this floorYear(int|float $precision = 1) Truncate the current instance year with given precision.	1
$this floorYears(int|float $precision = 1) Truncate the current instance year with given precision.	1
$this ceilYear(int|float $precision = 1) Ceil the current instance year with given precision.	1
$this ceilYears(int|float $precision = 1) Ceil the current instance year with given precision.	1
$this roundMonth(int|float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this roundMonths(int|float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this floorMonth(int|float $precision = 1) Truncate the current instance month with given precision.	1
$this floorMonths(int|float $precision = 1) Truncate the current instance month with given precision.	1
$this ceilMonth(int|float $precision = 1) Ceil the current instance month with given precision.	1
$this ceilMonths(int|float $precision = 1) Ceil the current instance month with given precision.	1
$this roundWeek(int|float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this roundWeeks(int|float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this floorWeek(int|float $precision = 1) Truncate the current instance day with given precision.	1
$this floorWeeks(int|float $precision = 1) Truncate the current instance day with given precision.	1
$this ceilWeek(int|float $precision = 1) Ceil the current instance day with given precision.	1
$this ceilWeeks(int|float $precision = 1) Ceil the current instance day with given precision.	1
$this roundDay(int|float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this roundDays(int|float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this floorDay(int|float $precision = 1) Truncate the current instance day with given precision.	1
$this floorDays(int|float $precision = 1) Truncate the current instance day with given precision.	1
$this ceilDay(int|float $precision = 1) Ceil the current instance day with given precision.	1
$this ceilDays(int|float $precision = 1) Ceil the current instance day with given precision.	1
$this roundHour(int|float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this roundHours(int|float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this floorHour(int|float $precision = 1) Truncate the current instance hour with given precision.	1
$this floorHours(int|float $precision = 1) Truncate the current instance hour with given precision.	1
$this ceilHour(int|float $precision = 1) Ceil the current instance hour with given precision.	1
$this ceilHours(int|float $precision = 1) Ceil the current instance hour with given precision.	1
$this roundMinute(int|float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this roundMinutes(int|float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this floorMinute(int|float $precision = 1) Truncate the current instance minute with given precision.	1
$this floorMinutes(int|float $precision = 1) Truncate the current instance minute with given precision.	1
$this ceilMinute(int|float $precision = 1) Ceil the current instance minute with given precision.	1
$this ceilMinutes(int|float $precision = 1) Ceil the current instance minute with given precision.	1
$this roundSecond(int|float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this roundSeconds(int|float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this floorSecond(int|float $precision = 1) Truncate the current instance second with given precision.	1
$this floorSeconds(int|float $precision = 1) Truncate the current instance second with given precision.	1
$this ceilSecond(int|float $precision = 1) Ceil the current instance second with given precision.	1
$this ceilSeconds(int|float $precision = 1) Ceil the current instance second with given precision.	1
$this roundMillennium(int|float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this roundMillennia(int|float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this floorMillennium(int|float $precision = 1) Truncate the current instance millennium with given precision.	1
$this floorMillennia(int|float $precision = 1) Truncate the current instance millennium with given precision.	1
$this ceilMillennium(int|float $precision = 1) Ceil the current instance millennium with given precision.	1
$this ceilMillennia(int|float $precision = 1) Ceil the current instance millennium with given precision.	1
$this roundCentury(int|float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this roundCenturies(int|float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this floorCentury(int|float $precision = 1) Truncate the current instance century with given precision.	1
$this floorCenturies(int|float $precision = 1) Truncate the current instance century with given precision.	1
$this ceilCentury(int|float $precision = 1) Ceil the current instance century with given precision.	1
$this ceilCenturies(int|float $precision = 1) Ceil the current instance century with given precision.	1
$this roundDecade(int|float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this roundDecades(int|float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this floorDecade(int|float $precision = 1) Truncate the current instance decade with given precision.	1
$this floorDecades(int|float $precision = 1) Truncate the current instance decade with given precision.	1
$this ceilDecade(int|float $precision = 1) Ceil the current instance decade with given precision.	1
$this ceilDecades(int|float $precision = 1) Ceil the current instance decade with given precision.	1
$this roundQuarter(int|float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this roundQuarters(int|float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this floorQuarter(int|float $precision = 1) Truncate the current instance quarter with given precision.	1
$this floorQuarters(int|float $precision = 1) Truncate the current instance quarter with given precision.	1
$this ceilQuarter(int|float $precision = 1) Ceil the current instance quarter with given precision.	1
$this ceilQuarters(int|float $precision = 1) Ceil the current instance quarter with given precision.	1
$this roundMillisecond(int|float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this roundMilliseconds(int|float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this floorMillisecond(int|float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this floorMilliseconds(int|float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this ceilMillisecond(int|float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this ceilMilliseconds(int|float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this roundMicrosecond(int|float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this roundMicroseconds(int|float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this floorMicrosecond(int|float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this floorMicroseconds(int|float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this ceilMicrosecond(int|float $precision = 1) Ceil the current instance microsecond with given precision.	1
$this ceilMicroseconds(int|float $precision = 1) Ceil the current instance microsecond with given precision.	1
bool isUtc() Check if the current instance has UTC timezone. (Both isUtc and isUTC cases are valid.)	1
bool isLocal() Check if the current instance has non-UTC timezone.	1
bool isValid() Check if the current instance is a valid date.	1
bool isDST() Check if the current instance is in a daylight saving time.	1
bool isSunday() Checks if the instance day is sunday.	1
bool isMonday() Checks if the instance day is monday.	1
bool isTuesday() Checks if the instance day is tuesday.	1
bool isWednesday() Checks if the instance day is wednesday.	1
bool isThursday() Checks if the instance day is thursday.	1
bool isFriday() Checks if the instance day is friday.	1
bool isSaturday() Checks if the instance day is saturday.	1
bool isSameYear(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentYear() Checks if the instance is in the same year as the current moment.	1
bool isNextYear() Checks if the instance is in the same year as the current moment next year.	1
bool isLastYear() Checks if the instance is in the same year as the current moment last year.	1
bool isSameWeek(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same week as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentWeek() Checks if the instance is in the same week as the current moment.	1
bool isNextWeek() Checks if the instance is in the same week as the current moment next week.	1
bool isLastWeek() Checks if the instance is in the same week as the current moment last week.	1
bool isSameDay(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentDay() Checks if the instance is in the same day as the current moment.	1
bool isNextDay() Checks if the instance is in the same day as the current moment next day.	1
bool isLastDay() Checks if the instance is in the same day as the current moment last day.	1
bool isSameHour(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same hour as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentHour() Checks if the instance is in the same hour as the current moment.	1
bool isNextHour() Checks if the instance is in the same hour as the current moment next hour.	1
bool isLastHour() Checks if the instance is in the same hour as the current moment last hour.	1
bool isSameMinute(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same minute as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMinute() Checks if the instance is in the same minute as the current moment.	1
bool isNextMinute() Checks if the instance is in the same minute as the current moment next minute.	1
bool isLastMinute() Checks if the instance is in the same minute as the current moment last minute.	1
bool isSameSecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same second as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentSecond() Checks if the instance is in the same second as the current moment.	1
bool isNextSecond() Checks if the instance is in the same second as the current moment next second.	1
bool isLastSecond() Checks if the instance is in the same second as the current moment last second.	1
bool isSameMicro(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMicro() Checks if the instance is in the same microsecond as the current moment.	1
bool isNextMicro() Checks if the instance is in the same microsecond as the current moment next microsecond.	1
bool isLastMicro() Checks if the instance is in the same microsecond as the current moment last microsecond.	1
bool isSameMicrosecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMicrosecond() Checks if the instance is in the same microsecond as the current moment.	1
bool isNextMicrosecond() Checks if the instance is in the same microsecond as the current moment next microsecond.	1
bool isLastMicrosecond() Checks if the instance is in the same microsecond as the current moment last microsecond.	1
bool isCurrentMonth() Checks if the instance is in the same month as the current moment.	1
bool isNextMonth() Checks if the instance is in the same month as the current moment next month.	1
bool isLastMonth() Checks if the instance is in the same month as the current moment last month.	1
bool isCurrentQuarter() Checks if the instance is in the same quarter as the current moment.	1
bool isNextQuarter() Checks if the instance is in the same quarter as the current moment next quarter.	1
bool isLastQuarter() Checks if the instance is in the same quarter as the current moment last quarter.	1
bool isSameDecade(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same decade as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentDecade() Checks if the instance is in the same decade as the current moment.	1
bool isNextDecade() Checks if the instance is in the same decade as the current moment next decade.	1
bool isLastDecade() Checks if the instance is in the same decade as the current moment last decade.	1
bool isSameCentury(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same century as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentCentury() Checks if the instance is in the same century as the current moment.	1
bool isNextCentury() Checks if the instance is in the same century as the current moment next century.	1
bool isLastCentury() Checks if the instance is in the same century as the current moment last century.	1
bool isSameMillennium(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same millennium as the instance. If null passed, compare to now (with the same timezone).	1
bool isCurrentMillennium() Checks if the instance is in the same millennium as the current moment.	1
bool isNextMillennium() Checks if the instance is in the same millennium as the current moment next millennium.	1
bool isLastMillennium() Checks if the instance is in the same millennium as the current moment last millennium.	1
CarbonImmutable years(int $value) Set current instance year to the given value.	1
CarbonImmutable year(int $value) Set current instance year to the given value.	1
CarbonImmutable setYears(int $value) Set current instance year to the given value.	1
CarbonImmutable setYear(int $value) Set current instance year to the given value.	1
CarbonImmutable months(int $value) Set current instance month to the given value.	1
CarbonImmutable month(int $value) Set current instance month to the given value.	1
CarbonImmutable setMonths(int $value) Set current instance month to the given value.	1
CarbonImmutable setMonth(int $value) Set current instance month to the given value.	1
CarbonImmutable days(int $value) Set current instance day to the given value.	1
CarbonImmutable day(int $value) Set current instance day to the given value.	1
CarbonImmutable setDays(int $value) Set current instance day to the given value.	1
CarbonImmutable setDay(int $value) Set current instance day to the given value.	1
CarbonImmutable hours(int $value) Set current instance hour to the given value.	1
CarbonImmutable hour(int $value) Set current instance hour to the given value.	1
CarbonImmutable setHours(int $value) Set current instance hour to the given value.	1
CarbonImmutable setHour(int $value) Set current instance hour to the given value.	1
CarbonImmutable minutes(int $value) Set current instance minute to the given value.	1
CarbonImmutable minute(int $value) Set current instance minute to the given value.	1
CarbonImmutable setMinutes(int $value) Set current instance minute to the given value.	1
CarbonImmutable setMinute(int $value) Set current instance minute to the given value.	1
CarbonImmutable seconds(int $value) Set current instance second to the given value.	1
CarbonImmutable second(int $value) Set current instance second to the given value.	1
CarbonImmutable setSeconds(int $value) Set current instance second to the given value.	1
CarbonImmutable setSecond(int $value) Set current instance second to the given value.	1
CarbonImmutable millis(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable milli(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable setMillis(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable setMilli(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable milliseconds(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable millisecond(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable setMilliseconds(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable setMillisecond(int $value) Set current instance millisecond to the given value.	1
CarbonImmutable micros(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable micro(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable setMicros(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable setMicro(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable microseconds(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable microsecond(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable setMicroseconds(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable setMicrosecond(int $value) Set current instance microsecond to the given value.	1
CarbonImmutable addYears(int $value = 1) Add years (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addYear() Add one year to the instance (using date interval).	1
CarbonImmutable subYears(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subYear() Sub one year to the instance (using date interval).	1
CarbonImmutable addYearsWithOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addYearWithOverflow() Add one year to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subYearsWithOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subYearWithOverflow() Sub one year to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addYearsWithoutOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addYearWithoutOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearsWithoutOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearWithoutOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addYearsWithNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addYearWithNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearsWithNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearWithNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addYearsNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addYearNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearsNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subYearNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonths(int $value = 1) Add months (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMonth() Add one month to the instance (using date interval).	1
CarbonImmutable subMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMonth() Sub one month to the instance (using date interval).	1
CarbonImmutable addMonthsWithOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addMonthWithOverflow() Add one month to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subMonthsWithOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subMonthWithOverflow() Sub one month to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addMonthsWithoutOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonthWithoutOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthsWithoutOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthWithoutOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonthsWithNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonthWithNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthsWithNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthWithNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonthsNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMonthNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthsNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMonthNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDays(int $value = 1) Add days (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addDay() Add one day to the instance (using date interval).	1
CarbonImmutable subDays(int $value = 1) Sub days (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subDay() Sub one day to the instance (using date interval).	1
CarbonImmutable addHours(int $value = 1) Add hours (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addHour() Add one hour to the instance (using date interval).	1
CarbonImmutable subHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subHour() Sub one hour to the instance (using date interval).	1
CarbonImmutable addMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMinute() Add one minute to the instance (using date interval).	1
CarbonImmutable subMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMinute() Sub one minute to the instance (using date interval).	1
CarbonImmutable addSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addSecond() Add one second to the instance (using date interval).	1
CarbonImmutable subSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subSecond() Sub one second to the instance (using date interval).	1
CarbonImmutable addMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMilli() Add one millisecond to the instance (using date interval).	1
CarbonImmutable subMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMilli() Sub one millisecond to the instance (using date interval).	1
CarbonImmutable addMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMillisecond() Add one millisecond to the instance (using date interval).	1
CarbonImmutable subMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMillisecond() Sub one millisecond to the instance (using date interval).	1
CarbonImmutable addMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMicro() Add one microsecond to the instance (using date interval).	1
CarbonImmutable subMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMicro() Sub one microsecond to the instance (using date interval).	1
CarbonImmutable addMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMicrosecond() Add one microsecond to the instance (using date interval).	1
CarbonImmutable subMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMicrosecond() Sub one microsecond to the instance (using date interval).	1
CarbonImmutable addMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addMillennium() Add one millennium to the instance (using date interval).	1
CarbonImmutable subMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subMillennium() Sub one millennium to the instance (using date interval).	1
CarbonImmutable addMillenniaWithOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addMillenniumWithOverflow() Add one millennium to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subMillenniaWithOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subMillenniumWithOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addMillenniaWithoutOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMillenniumWithoutOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniaWithoutOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniumWithoutOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMillenniaWithNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMillenniumWithNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniaWithNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniumWithNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMillenniaNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addMillenniumNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniaNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subMillenniumNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addCentury() Add one century to the instance (using date interval).	1
CarbonImmutable subCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subCentury() Sub one century to the instance (using date interval).	1
CarbonImmutable addCenturiesWithOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addCenturyWithOverflow() Add one century to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subCenturiesWithOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subCenturyWithOverflow() Sub one century to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addCenturiesWithoutOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturyWithoutOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturiesWithoutOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturyWithoutOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturiesWithNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturyWithNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturiesWithNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturyWithNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturiesNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addCenturyNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturiesNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subCenturyNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addDecade() Add one decade to the instance (using date interval).	1
CarbonImmutable subDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subDecade() Sub one decade to the instance (using date interval).	1
CarbonImmutable addDecadesWithOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addDecadeWithOverflow() Add one decade to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subDecadesWithOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subDecadeWithOverflow() Sub one decade to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addDecadesWithoutOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecadeWithoutOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadesWithoutOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadeWithoutOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecadesWithNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecadeWithNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadesWithNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadeWithNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecadesNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addDecadeNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadesNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subDecadeNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addQuarter() Add one quarter to the instance (using date interval).	1
CarbonImmutable subQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subQuarter() Sub one quarter to the instance (using date interval).	1
CarbonImmutable addQuartersWithOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addQuarterWithOverflow() Add one quarter to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subQuartersWithOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable subQuarterWithOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly allowed.	1
CarbonImmutable addQuartersWithoutOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuarterWithoutOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuartersWithoutOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuarterWithoutOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuartersWithNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuarterWithNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuartersWithNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuarterWithNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuartersNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addQuarterNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuartersNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable subQuarterNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	1
CarbonImmutable addWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addWeek() Add one week to the instance (using date interval).	1
CarbonImmutable subWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subWeek() Sub one week to the instance (using date interval).	1
CarbonImmutable addWeekdays(int $value = 1) Add weekdays (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable addWeekday() Add one weekday to the instance (using date interval).	1
CarbonImmutable subWeekdays(int $value = 1) Sub weekdays (the $value count passed in) to the instance (using date interval).	1
CarbonImmutable subWeekday() Sub one weekday to the instance (using date interval).	1
CarbonImmutable addRealMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMicro() Add one microsecond to the instance (using timestamp).	1
CarbonImmutable subRealMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMicro() Sub one microsecond to the instance (using timestamp).	1
CarbonPeriod microsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	1
CarbonImmutable addRealMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMicrosecond() Add one microsecond to the instance (using timestamp).	1
CarbonImmutable subRealMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMicrosecond() Sub one microsecond to the instance (using timestamp).	1
CarbonPeriod microsecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	1
CarbonImmutable addRealMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMilli() Add one millisecond to the instance (using timestamp).	1
CarbonImmutable subRealMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMilli() Sub one millisecond to the instance (using timestamp).	1
CarbonPeriod millisUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	1
CarbonImmutable addRealMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMillisecond() Add one millisecond to the instance (using timestamp).	1
CarbonImmutable subRealMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMillisecond() Sub one millisecond to the instance (using timestamp).	1
CarbonPeriod millisecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	1
CarbonImmutable addRealSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealSecond() Add one second to the instance (using timestamp).	1
CarbonImmutable subRealSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealSecond() Sub one second to the instance (using timestamp).	1
CarbonPeriod secondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each second or every X seconds if a factor is given.	1
CarbonImmutable addRealMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMinute() Add one minute to the instance (using timestamp).	1
CarbonImmutable subRealMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMinute() Sub one minute to the instance (using timestamp).	1
CarbonPeriod minutesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each minute or every X minutes if a factor is given.	1
CarbonImmutable addRealHours(int $value = 1) Add hours (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealHour() Add one hour to the instance (using timestamp).	1
CarbonImmutable subRealHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealHour() Sub one hour to the instance (using timestamp).	1
CarbonPeriod hoursUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each hour or every X hours if a factor is given.	1
CarbonImmutable addRealDays(int $value = 1) Add days (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealDay() Add one day to the instance (using timestamp).	1
CarbonImmutable subRealDays(int $value = 1) Sub days (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealDay() Sub one day to the instance (using timestamp).	1
CarbonPeriod daysUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each day or every X days if a factor is given.	1
CarbonImmutable addRealWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealWeek() Add one week to the instance (using timestamp).	1
CarbonImmutable subRealWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealWeek() Sub one week to the instance (using timestamp).	1
CarbonPeriod weeksUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each week or every X weeks if a factor is given.	1
CarbonImmutable addRealMonths(int $value = 1) Add months (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMonth() Add one month to the instance (using timestamp).	1
CarbonImmutable subRealMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMonth() Sub one month to the instance (using timestamp).	1
CarbonPeriod monthsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each month or every X months if a factor is given.	1
CarbonImmutable addRealQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealQuarter() Add one quarter to the instance (using timestamp).	1
CarbonImmutable subRealQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealQuarter() Sub one quarter to the instance (using timestamp).	1
CarbonPeriod quartersUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each quarter or every X quarters if a factor is given.	1
CarbonImmutable addRealYears(int $value = 1) Add years (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealYear() Add one year to the instance (using timestamp).	1
CarbonImmutable subRealYears(int $value = 1) Sub years (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealYear() Sub one year to the instance (using timestamp).	1
CarbonPeriod yearsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each year or every X years if a factor is given.	1
CarbonImmutable addRealDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealDecade() Add one decade to the instance (using timestamp).	1
CarbonImmutable subRealDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealDecade() Sub one decade to the instance (using timestamp).	1
CarbonPeriod decadesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each decade or every X decades if a factor is given.	1
CarbonImmutable addRealCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealCentury() Add one century to the instance (using timestamp).	1
CarbonImmutable subRealCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealCentury() Sub one century to the instance (using timestamp).	1
CarbonPeriod centuriesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each century or every X centuries if a factor is given.	1
CarbonImmutable addRealMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable addRealMillennium() Add one millennium to the instance (using timestamp).	1
CarbonImmutable subRealMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using timestamp).	1
CarbonImmutable subRealMillennium() Sub one millennium to the instance (using timestamp).	1
CarbonPeriod millenniaUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millennium or every X millennia if a factor is given.	1
CarbonImmutable roundYear(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
CarbonImmutable roundYears(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
CarbonImmutable floorYear(float $precision = 1) Truncate the current instance year with given precision.	1
CarbonImmutable floorYears(float $precision = 1) Truncate the current instance year with given precision.	1
CarbonImmutable ceilYear(float $precision = 1) Ceil the current instance year with given precision.	1
CarbonImmutable ceilYears(float $precision = 1) Ceil the current instance year with given precision.	1
CarbonImmutable roundMonth(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
CarbonImmutable roundMonths(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
CarbonImmutable floorMonth(float $precision = 1) Truncate the current instance month with given precision.	1
CarbonImmutable floorMonths(float $precision = 1) Truncate the current instance month with given precision.	1
CarbonImmutable ceilMonth(float $precision = 1) Ceil the current instance month with given precision.	1
CarbonImmutable ceilMonths(float $precision = 1) Ceil the current instance month with given precision.	1
CarbonImmutable roundDay(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
CarbonImmutable roundDays(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
CarbonImmutable floorDay(float $precision = 1) Truncate the current instance day with given precision.	1
CarbonImmutable floorDays(float $precision = 1) Truncate the current instance day with given precision.	1
CarbonImmutable ceilDay(float $precision = 1) Ceil the current instance day with given precision.	1
CarbonImmutable ceilDays(float $precision = 1) Ceil the current instance day with given precision.	1
CarbonImmutable roundHour(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
CarbonImmutable roundHours(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
CarbonImmutable floorHour(float $precision = 1) Truncate the current instance hour with given precision.	1
CarbonImmutable floorHours(float $precision = 1) Truncate the current instance hour with given precision.	1
CarbonImmutable ceilHour(float $precision = 1) Ceil the current instance hour with given precision.	1
CarbonImmutable ceilHours(float $precision = 1) Ceil the current instance hour with given precision.	1
CarbonImmutable roundMinute(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
CarbonImmutable roundMinutes(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
CarbonImmutable floorMinute(float $precision = 1) Truncate the current instance minute with given precision.	1
CarbonImmutable floorMinutes(float $precision = 1) Truncate the current instance minute with given precision.	1
CarbonImmutable ceilMinute(float $precision = 1) Ceil the current instance minute with given precision.	1
CarbonImmutable ceilMinutes(float $precision = 1) Ceil the current instance minute with given precision.	1
CarbonImmutable roundSecond(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
CarbonImmutable roundSeconds(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
CarbonImmutable floorSecond(float $precision = 1) Truncate the current instance second with given precision.	1
CarbonImmutable floorSeconds(float $precision = 1) Truncate the current instance second with given precision.	1
CarbonImmutable ceilSecond(float $precision = 1) Ceil the current instance second with given precision.	1
CarbonImmutable ceilSeconds(float $precision = 1) Ceil the current instance second with given precision.	1
CarbonImmutable roundMillennium(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
CarbonImmutable roundMillennia(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
CarbonImmutable floorMillennium(float $precision = 1) Truncate the current instance millennium with given precision.	1
CarbonImmutable floorMillennia(float $precision = 1) Truncate the current instance millennium with given precision.	1
CarbonImmutable ceilMillennium(float $precision = 1) Ceil the current instance millennium with given precision.	1
CarbonImmutable ceilMillennia(float $precision = 1) Ceil the current instance millennium with given precision.	1
CarbonImmutable roundCentury(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
CarbonImmutable roundCenturies(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
CarbonImmutable floorCentury(float $precision = 1) Truncate the current instance century with given precision.	1
CarbonImmutable floorCenturies(float $precision = 1) Truncate the current instance century with given precision.	1
CarbonImmutable ceilCentury(float $precision = 1) Ceil the current instance century with given precision.	1
CarbonImmutable ceilCenturies(float $precision = 1) Ceil the current instance century with given precision.	1
CarbonImmutable roundDecade(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
CarbonImmutable roundDecades(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
CarbonImmutable floorDecade(float $precision = 1) Truncate the current instance decade with given precision.	1
CarbonImmutable floorDecades(float $precision = 1) Truncate the current instance decade with given precision.	1
CarbonImmutable ceilDecade(float $precision = 1) Ceil the current instance decade with given precision.	1
CarbonImmutable ceilDecades(float $precision = 1) Ceil the current instance decade with given precision.	1
CarbonImmutable roundQuarter(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
CarbonImmutable roundQuarters(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
CarbonImmutable floorQuarter(float $precision = 1) Truncate the current instance quarter with given precision.	1
CarbonImmutable floorQuarters(float $precision = 1) Truncate the current instance quarter with given precision.	1
CarbonImmutable ceilQuarter(float $precision = 1) Ceil the current instance quarter with given precision.	1
CarbonImmutable ceilQuarters(float $precision = 1) Ceil the current instance quarter with given precision.	1
CarbonImmutable roundMillisecond(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
CarbonImmutable roundMilliseconds(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
CarbonImmutable floorMillisecond(float $precision = 1) Truncate the current instance millisecond with given precision.	1
CarbonImmutable floorMilliseconds(float $precision = 1) Truncate the current instance millisecond with given precision.	1
CarbonImmutable ceilMillisecond(float $precision = 1) Ceil the current instance millisecond with given precision.	1
CarbonImmutable ceilMilliseconds(float $precision = 1) Ceil the current instance millisecond with given precision.	1
CarbonImmutable roundMicrosecond(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
CarbonImmutable roundMicroseconds(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
CarbonImmutable floorMicrosecond(float $precision = 1) Truncate the current instance microsecond with given precision.	1
CarbonImmutable floorMicroseconds(float $precision = 1) Truncate the current instance microsecond with given precision.	1
CarbonImmutable ceilMicrosecond(float $precision = 1) Ceil the current instance microsecond with given precision.	1
CarbonImmutable ceilMicroseconds(float $precision = 1) Ceil the current instance microsecond with given precision.	1
string shortAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string shortRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
string longRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	1
static CarbonImmutable|false createFromFormat(string $format, string $time, string|DateTimeZone $timezone = null) Parse a string into a new CarbonImmutable object according to the specified format.	1
static CarbonImmutable __set_state(array $array) https://php.net/manual/en/datetime.set-state.php	1
static CarbonPeriod start($date, $inclusive = null) Create instance specifying start date or modify the start date if called on an instance.	1
static CarbonPeriod since($date, $inclusive = null) Alias for start().	1
static CarbonPeriod sinceNow($inclusive = null) Create instance with start date set to now or set the start date to now if called on an instance.	1
static CarbonPeriod end($date = null, $inclusive = null) Create instance specifying end date or modify the end date if called on an instance.	1
static CarbonPeriod until($date = null, $inclusive = null) Alias for end().	1
static CarbonPeriod untilNow($inclusive = null) Create instance with end date set to now or set the end date to now if called on an instance.	1
static CarbonPeriod dates($start, $end = null) Create instance with start and end dates or modify the start and end dates if called on an instance.	1
static CarbonPeriod between($start, $end = null) Create instance with start and end dates or modify the start and end dates if called on an instance.	1
static CarbonPeriod recurrences($recurrences = null) Create instance with maximum number of recurrences or modify the number of recurrences if called on an instance.	1
static CarbonPeriod times($recurrences = null) Alias for recurrences().	1
static CarbonPeriod options($options = null) Create instance with options or modify the options if called on an instance.	1
static CarbonPeriod toggle($options, $state = null) Create instance with options toggled on or off, or toggle options if called on an instance.	1
static CarbonPeriod filter($callback, $name = null) Create instance with filter added to the stack or append a filter if called on an instance.	1
static CarbonPeriod push($callback, $name = null) Alias for filter().	1
static CarbonPeriod prepend($callback, $name = null) Create instance with filter prepended to the stack or prepend a filter if called on an instance.	1
static CarbonPeriod filters(array $filters = []) Create instance with filters stack or replace the whole filters stack if called on an instance.	1
static CarbonPeriod interval($interval) Create instance with given date interval or modify the interval if called on an instance.	1
static CarbonPeriod each($interval) Create instance with given date interval or modify the interval if called on an instance.	1
static CarbonPeriod every($interval) Create instance with given date interval or modify the interval if called on an instance.	1
static CarbonPeriod step($interval) Create instance with given date interval or modify the interval if called on an instance.	1
static CarbonPeriod stepBy($interval) Create instance with given date interval or modify the interval if called on an instance.	1
static CarbonPeriod invert() Create instance with inverted date interval or invert the interval if called on an instance.	1
static CarbonPeriod years($years = 1) Create instance specifying a number of years for date interval or replace the interval by the given a number of years if called on an instance.	1
static CarbonPeriod year($years = 1) Alias for years().	1
static CarbonPeriod months($months = 1) Create instance specifying a number of months for date interval or replace the interval by the given a number of months if called on an instance.	1
static CarbonPeriod month($months = 1) Alias for months().	1
static CarbonPeriod weeks($weeks = 1) Create instance specifying a number of weeks for date interval or replace the interval by the given a number of weeks if called on an instance.	1
static CarbonPeriod week($weeks = 1) Alias for weeks().	1
static CarbonPeriod days($days = 1) Create instance specifying a number of days for date interval or replace the interval by the given a number of days if called on an instance.	1
static CarbonPeriod dayz($days = 1) Alias for days().	1
static CarbonPeriod day($days = 1) Alias for days().	1
static CarbonPeriod hours($hours = 1) Create instance specifying a number of hours for date interval or replace the interval by the given a number of hours if called on an instance.	1
static CarbonPeriod hour($hours = 1) Alias for hours().	1
static CarbonPeriod minutes($minutes = 1) Create instance specifying a number of minutes for date interval or replace the interval by the given a number of minutes if called on an instance.	1
static CarbonPeriod minute($minutes = 1) Alias for minutes().	1
static CarbonPeriod seconds($seconds = 1) Create instance specifying a number of seconds for date interval or replace the interval by the given a number of seconds if called on an instance.	1
static CarbonPeriod second($seconds = 1) Alias for seconds().	1
$this roundYear(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this roundYears(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	1
$this floorYear(float $precision = 1) Truncate the current instance year with given precision.	1
$this floorYears(float $precision = 1) Truncate the current instance year with given precision.	1
$this ceilYear(float $precision = 1) Ceil the current instance year with given precision.	1
$this ceilYears(float $precision = 1) Ceil the current instance year with given precision.	1
$this roundMonth(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this roundMonths(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	1
$this floorMonth(float $precision = 1) Truncate the current instance month with given precision.	1
$this floorMonths(float $precision = 1) Truncate the current instance month with given precision.	1
$this ceilMonth(float $precision = 1) Ceil the current instance month with given precision.	1
$this ceilMonths(float $precision = 1) Ceil the current instance month with given precision.	1
$this roundWeek(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this roundWeeks(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this floorWeek(float $precision = 1) Truncate the current instance day with given precision.	1
$this floorWeeks(float $precision = 1) Truncate the current instance day with given precision.	1
$this ceilWeek(float $precision = 1) Ceil the current instance day with given precision.	1
$this ceilWeeks(float $precision = 1) Ceil the current instance day with given precision.	1
$this roundDay(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this roundDays(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	1
$this floorDay(float $precision = 1) Truncate the current instance day with given precision.	1
$this floorDays(float $precision = 1) Truncate the current instance day with given precision.	1
$this ceilDay(float $precision = 1) Ceil the current instance day with given precision.	1
$this ceilDays(float $precision = 1) Ceil the current instance day with given precision.	1
$this roundHour(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this roundHours(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	1
$this floorHour(float $precision = 1) Truncate the current instance hour with given precision.	1
$this floorHours(float $precision = 1) Truncate the current instance hour with given precision.	1
$this ceilHour(float $precision = 1) Ceil the current instance hour with given precision.	1
$this ceilHours(float $precision = 1) Ceil the current instance hour with given precision.	1
$this roundMinute(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this roundMinutes(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	1
$this floorMinute(float $precision = 1) Truncate the current instance minute with given precision.	1
$this floorMinutes(float $precision = 1) Truncate the current instance minute with given precision.	1
$this ceilMinute(float $precision = 1) Ceil the current instance minute with given precision.	1
$this ceilMinutes(float $precision = 1) Ceil the current instance minute with given precision.	1
$this roundSecond(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this roundSeconds(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	1
$this floorSecond(float $precision = 1) Truncate the current instance second with given precision.	1
$this floorSeconds(float $precision = 1) Truncate the current instance second with given precision.	1
$this ceilSecond(float $precision = 1) Ceil the current instance second with given precision.	1
$this ceilSeconds(float $precision = 1) Ceil the current instance second with given precision.	1
$this roundMillennium(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this roundMillennia(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	1
$this floorMillennium(float $precision = 1) Truncate the current instance millennium with given precision.	1
$this floorMillennia(float $precision = 1) Truncate the current instance millennium with given precision.	1
$this ceilMillennium(float $precision = 1) Ceil the current instance millennium with given precision.	1
$this ceilMillennia(float $precision = 1) Ceil the current instance millennium with given precision.	1
$this roundCentury(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this roundCenturies(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	1
$this floorCentury(float $precision = 1) Truncate the current instance century with given precision.	1
$this floorCenturies(float $precision = 1) Truncate the current instance century with given precision.	1
$this ceilCentury(float $precision = 1) Ceil the current instance century with given precision.	1
$this ceilCenturies(float $precision = 1) Ceil the current instance century with given precision.	1
$this roundDecade(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this roundDecades(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	1
$this floorDecade(float $precision = 1) Truncate the current instance decade with given precision.	1
$this floorDecades(float $precision = 1) Truncate the current instance decade with given precision.	1
$this ceilDecade(float $precision = 1) Ceil the current instance decade with given precision.	1
$this ceilDecades(float $precision = 1) Ceil the current instance decade with given precision.	1
$this roundQuarter(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this roundQuarters(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	1
$this floorQuarter(float $precision = 1) Truncate the current instance quarter with given precision.	1
$this floorQuarters(float $precision = 1) Truncate the current instance quarter with given precision.	1
$this ceilQuarter(float $precision = 1) Ceil the current instance quarter with given precision.	1
$this ceilQuarters(float $precision = 1) Ceil the current instance quarter with given precision.	1
$this roundMillisecond(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this roundMilliseconds(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	1
$this floorMillisecond(float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this floorMilliseconds(float $precision = 1) Truncate the current instance millisecond with given precision.	1
$this ceilMillisecond(float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this ceilMilliseconds(float $precision = 1) Ceil the current instance millisecond with given precision.	1
$this roundMicrosecond(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this roundMicroseconds(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	1
$this floorMicrosecond(float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this floorMicroseconds(float $precision = 1) Truncate the current instance microsecond with given precision.	1
$this ceilMicrosecond(float $precision = 1) Ceil the current instance microsecond with given precision.	1
$this ceilMicroseconds(float $precision = 1) Ceil the current instance microsecond with given precision.	1
CarbonImmutable|false create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $tz = null) Create a new Carbon instance from a specific date and time.	1
CarbonImmutable createFromDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to now.	1
CarbonImmutable|false createFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.	1
CarbonImmutable|false createFromIsoFormat($format, $time, $tz = null, $locale = 'en', $translator = null) Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).	1
CarbonImmutable|false createFromLocaleFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific format and a string in a given language.	1
CarbonImmutable|false createFromLocaleIsoFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific ISO format and a string in a given language.	1
CarbonImmutable createFromTime($hour = 0, $minute = 0, $second = 0, $tz = null) Create a Carbon instance from just a time. The date portion is set to today.	1
CarbonImmutable createFromTimeString($time, $tz = null) Create a Carbon instance from a time string. The date portion is set to today.	1
CarbonImmutable createFromTimestamp($timestamp, $tz = null) Create a Carbon instance from a timestamp and set the timezone (use default one if not specified).	1
CarbonImmutable createFromTimestampMs($timestamp, $tz = null) Create a Carbon instance from a timestamp in milliseconds.	1
CarbonImmutable createFromTimestampMsUTC($timestamp) Create a Carbon instance from a timestamp in milliseconds.	1
CarbonImmutable createFromTimestampUTC($timestamp) Create a Carbon instance from an timestamp keeping the timezone to UTC.	1
CarbonImmutable createMidnightDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to midnight.	1
CarbonImmutable|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null) Create a new safe Carbon instance from a specific date and time.	1
CarbonImmutable disableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
CarbonImmutable enableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
CarbonImmutable fromSerialized($value) Create an instance from a serialized string.	1
Closure|CarbonImmutable getTestNow() Get the Carbon instance (real or mock) to be returned when a "now"	1
CarbonImmutable instance($date) Create a Carbon instance from a DateTime one.	1
CarbonImmutable|null make($var) Make a Carbon instance from given variable if possible.	1
CarbonImmutable maxValue() Create a Carbon instance for the greatest supported date.	1
CarbonImmutable minValue() Create a Carbon instance for the lowest supported date.	1
CarbonImmutable now($tz = null) Get a Carbon instance for the current date and time.	1
CarbonImmutable parse($time = null, $tz = null) Create a carbon instance from a string.	1
CarbonImmutable parseFromLocale($time, $locale = null, $tz = null) Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).	1
CarbonImmutable|false rawCreateFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.	1
CarbonImmutable rawParse($time = null, $tz = null) Create a carbon instance from a string.	1
CarbonImmutable resetMacros() Remove all macros and generic macros.	1
CarbonImmutable setFallbackLocale($locale) Set the fallback locale.	1
CarbonImmutable setHumanDiffOptions($humanDiffOptions) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
CarbonImmutable setTestNow($testNow = null) Set a Carbon instance (real or mock) to be returned when a "now"	1
CarbonImmutable setTestNowAndTimezone($testNow = null, $tz = null) Set a Carbon instance (real or mock) to be returned when a "now"	1
CarbonImmutable setUtf8($utf8) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
CarbonImmutable today($tz = null) Create a Carbon instance for today.	1
CarbonImmutable tomorrow($tz = null) Create a Carbon instance for tomorrow.	1
CarbonImmutable useStrictMode($strictModeEnabled = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	1
CarbonImmutable yesterday($tz = null) Create a Carbon instance for yesterday.	1
static Carbon create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $tz = null)	1
static Carbon createFromDate($year = null, $month = null, $day = null, $tz = null)	1
static Carbon|false createFromFormat($format, $time, $tz = null)	1
static Carbon createFromTime($hour = 0, $minute = 0, $second = 0, $tz = null)	1
static Carbon createFromTimeString($time, $tz = null)	1
static Carbon createFromTimestamp($timestamp, $tz = null)	1
static Carbon createFromTimestampMs($timestamp, $tz = null)	1
static Carbon createFromTimestampUTC($timestamp)	1
static Carbon createMidnightDate($year = null, $month = null, $day = null, $tz = null)	1
static Carbon|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null)	1
static Carbon disableHumanDiffOption($humanDiffOption)	1
static Carbon enableHumanDiffOption($humanDiffOption)	1
static Carbon fromSerialized($value)	1
static Carbon getLastErrors()	1
static Carbon getTestNow()	1
static Carbon instance($date)	1
static Carbon isMutable()	1
static Carbon|null make($var)	1
static Carbon maxValue()	1
static Carbon minValue()	1
static Carbon now($tz = null)	1
static Carbon parse($time = null, $tz = null)	1
static Carbon setHumanDiffOptions($humanDiffOptions)	1
static Carbon setUtf8($utf8)	1
static Carbon today($tz = null)	1
static Carbon tomorrow($tz = null)	1
static Carbon useStrictMode($strictModeEnabled = true)	1
static Carbon yesterday($tz = null)	1
static bool hasForLocale(string $key, string $locale = null)	1
static bool has(string $key, string $locale = null, bool $fallback = true)	1
static mixed get(string $key, array $replace = [], string $locale = null, bool $fallback = true)	1
static string choice(string $key, \Countable|int|array $number, array $replace = [], string $locale = null)	1
static array info(string $hashedValue)	1
static bool check(string $value, string $hashedValue, array $options = [])	1
static bool needsRehash(string $hashedValue, array $options = [])	1
static string make(string $value, array $options = [])	1
static \Illuminate\Hashing\HashManager extend($driver, \Closure $callback)	1
static \Illuminate\Contracts\Validation\Validator make(array $data, array $rules, array $messages = [], array $customAttributes = [])	1
static void excludeUnvalidatedArrayKeys()	1
static void extend(string $rule, \Closure|string $extension, string $message = null)	1
static void extendImplicit(string $rule, \Closure|string $extension, string $message = null)	1
static void replacer(string $rule, \Closure|string $replacer)	1
static array validate(array $data, array $rules, array $messages = [], array $customAttributes = [])	1
static \Closure createClassListener(string $listener, bool $wildcard = false)	1
static \Closure makeListener(\Closure|string $listener, bool $wildcard = false)	1
static \Illuminate\Events\Dispatcher setQueueResolver(callable $resolver)	1
static array getListeners(string $eventName)	1
static array|null dispatch(string|object $event, mixed $payload = [], bool $halt = false)	1
static array|null until(string|object $event, mixed $payload = [])	1
static bool hasListeners(string $eventName)	1
static void assertDispatched(string|\Closure $event, callable|int $callback = null)	1
static void assertDispatchedTimes(string $event, int $times = 1)	1
static void assertNotDispatched(string|\Closure $event, callable|int $callback = null)	1
static void assertNothingDispatched()	1
static void assertListening(string $expectedEvent, string $expectedListener)	1
static void flush(string $event)	1
static void forget(string $event)	1
static void forgetPushed()	1
static void listen(\Closure|string|array $events, \Closure|string|array $listener = null)	1
static void push(string $event, array $payload = [])	1
static void subscribe(object|string $subscriber)	1
static \Illuminate\Auth\AuthManager extend(string $driver, \Closure $callback)	1
static \Illuminate\Auth\AuthManager provider(string $name, \Closure $callback)	1
static \Illuminate\Contracts\Auth\Authenticatable loginUsingId(mixed $id, bool $remember = false)	1
static \Illuminate\Contracts\Auth\Authenticatable|null user()	1
static \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard guard(string|null $name = null)	1
static \Illuminate\Contracts\Auth\UserProvider|null createUserProvider(string $provider = null)	1
static \Symfony\Component\HttpFoundation\Response|null onceBasic(string $field = 'email',array $extraConditions = [])	1
static bool attempt(array $credentials = [], bool $remember = false)	1
static bool hasUser()	1
static bool check()	1
static bool guest()	1
static bool once(array $credentials = [])	1
static bool onceUsingId(mixed $id)	1
static bool validate(array $credentials = [])	1
static bool viaRemember()	1
static bool|null logoutOtherDevices(string $password, string $attribute = 'password')	1
static int|string|null id()	1
static void login(\Illuminate\Contracts\Auth\Authenticatable $user, bool $remember = false)	1
static void logout()	1
static void logoutCurrentDevice()	1
static void setUser(\Illuminate\Contracts\Auth\Authenticatable $user)	1
static void shouldUse(string $name);	1
static \Illuminate\Contracts\Foundation\Application loadEnvironmentFrom(string $file)	1
static \Illuminate\Support\ServiceProvider register(\Illuminate\Support\ServiceProvider|string $provider, bool $force = false)	1
static \Illuminate\Support\ServiceProvider resolveProvider(string $provider)	1
static array getProviders(\Illuminate\Support\ServiceProvider|string $provider)	1
static mixed make($abstract, array $parameters = [])	1
static mixed makeWith($abstract, array $parameters = [])	1
static bool configurationIsCached()	1
static bool hasBeenBootstrapped()	1
static bool isDownForMaintenance()	1
static bool isLocal()	1
static bool isProduction()	1
static bool routesAreCached()	1
static bool runningInConsole()	1
static bool runningUnitTests()	1
static bool shouldSkipMiddleware()	1
static string basePath(string $path = '')	1
static string bootstrapPath(string $path = '')	1
static string configPath(string $path = '')	1
static string databasePath(string $path = '')	1
static string detectEnvironment(callable $callback)	1
static string environmentFile()	1
static string environmentFilePath()	1
static string environmentPath()	1
static string getCachedConfigPath()	1
static string getCachedPackagesPath()	1
static string getCachedRoutesPath()	1
static string getCachedServicesPath()	1
static string currentLocale()	1
static string getNamespace()	1
static string resourcePath(string $path = '')	1
static string storagePath(string $path = '')	1
static string version()	1
static string|bool environment(string|array ...$environments)	1
static never abort(int $code, string $message = '', array $headers = [])	1
static void boot()	1
static void booted(callable $callback)	1
static void booting(callable $callback)	1
static void bootstrapWith(array $bootstrappers)	1
static void loadDeferredProviders()	1
static void registerConfiguredProviders()	1
static void registerDeferredProvider(string $provider, string $service = null)	1
static void terminate()	1
static \Illuminate\Mail\Mailer mailer(string|null $name = null)	1
static void alwaysFrom(string $address, string|null $name = null)	1
static void alwaysReplyTo(string $address, string|null $name = null)	1
static void alwaysReturnPath(string $address)	1
static void alwaysTo(string $address, string|null $name = null)	1
static \Illuminate\Mail\PendingMail bcc($users)	1
static \Illuminate\Mail\PendingMail to($users)	1
static \Illuminate\Support\Collection queued(string $mailable, \Closure|string $callback = null)	1
static \Illuminate\Support\Collection sent(string $mailable, \Closure|string $callback = null)	1
static array failures()	1
static bool hasQueued(string $mailable)	1
static bool hasSent(string $mailable)	1
static mixed later(\DateTimeInterface|\DateInterval|int $delay, \Illuminate\Contracts\Mail\Mailable|string|array $view, string $queue = null)	1
static mixed laterOn(string $queue, \DateTimeInterface|\DateInterval|int $delay, \Illuminate\Contracts\Mail\Mailable|string|array $view)	1
static mixed queue(\Illuminate\Contracts\Mail\Mailable|string|array $view, string $queue = null)	1
static mixed queueOn(string $queue, \Illuminate\Contracts\Mail\Mailable|string|array $view)	1
static void assertNotQueued(string $mailable, callable $callback = null)	1
static void assertNotSent(string $mailable, callable|int $callback = null)	1
static void assertNothingQueued()	1
static void assertQueued(string|\Closure $mailable, callable|int $callback = null)	1
static void assertSent(string|\Closure $mailable, callable|int $callback = null)	1
static void raw(string $text, $callback)	1
static void plain(string $view, array $data, $callback)	1
static void html(string $html, $callback)	1
static void send(\Illuminate\Contracts\Mail\Mailable|string|array $view, array $data = [], \Closure|string $callback = null)	1
static \Illuminate\Auth\Access\Gate guessPolicyNamesUsing(callable $callback)	1
static \Illuminate\Auth\Access\Response authorize(string $ability, array|mixed $arguments = [])	1
static \Illuminate\Auth\Access\Response inspect(string $ability, array|mixed $arguments = [])	1
static \Illuminate\Auth\Access\Response allowIf(\Closure|bool $condition, string|null $message = null, mixed $code = null)	1
static \Illuminate\Auth\Access\Response denyIf(\Closure|bool $condition, string|null $message = null, mixed $code = null)	1
static \Illuminate\Contracts\Auth\Access\Gate after(callable $callback)	1
static \Illuminate\Contracts\Auth\Access\Gate before(callable $callback)	1
static \Illuminate\Contracts\Auth\Access\Gate define(string $ability, callable|string $callback)	1
static \Illuminate\Contracts\Auth\Access\Gate forUser(\Illuminate\Contracts\Auth\Authenticatable|mixed $user)	1
static \Illuminate\Contracts\Auth\Access\Gate policy(string $class, string $policy)	1
static array abilities()	1
static bool allows(string $ability, array|mixed $arguments = [])	1
static bool any(iterable|string $abilities, array|mixed $arguments = [])	1
static bool check(iterable|string $abilities, array|mixed $arguments = [])	1
static bool denies(string $ability, array|mixed $arguments = [])	1
static bool has(string $ability)	1
static mixed getPolicyFor(object|string $class)	1
static mixed raw(string $ability, array|mixed $arguments = [])	1
static \Illuminate\Cache\RateLimiter for(string $name, \Closure $callback)	1
static \Closure limiter(string $name)	1
static bool tooManyAttempts($key, $maxAttempts)	1
static int hit($key, $decaySeconds = 60)	1
static mixed attempts($key)	1
static mixed resetAttempts($key)	1
static int retriesLeft($key, $maxAttempts)	1
static void clear($key)	1
static int availableIn($key)	1
static bool attempt($key, $maxAttempts, \Closure $callback, $decaySeconds = 60)	1
static \Illuminate\Http\JsonResponse json(string|array $data = [], int $status = 200, array $headers = [], int $options = 0)	1
static \Illuminate\Http\JsonResponse jsonp(string $callback, string|array $data = [], int $status = 200, array $headers = [], int $options = 0)	1
static \Illuminate\Http\RedirectResponse redirectGuest(string $path, int $status = 302, array $headers = [], bool|null $secure = null)	1
static \Illuminate\Http\RedirectResponse redirectTo(string $path, int $status = 302, array $headers = [], bool|null $secure = null)	1
static \Illuminate\Http\RedirectResponse redirectToAction(string $action, mixed $parameters = [], int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse redirectToIntended(string $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)	1
static \Illuminate\Http\RedirectResponse redirectToRoute(string $route, mixed $parameters = [], int $status = 302, array $headers = [])	1
static \Illuminate\Http\Response make(array|string $content = '', int $status = 200, array $headers = [])	1
static \Illuminate\Http\Response noContent($status = 204, array $headers = [])	1
static \Illuminate\Http\Response view(string $view, array $data = [], int $status = 200, array $headers = [])	1
static \Symfony\Component\HttpFoundation\BinaryFileResponse download(\SplFileInfo|string $file, string|null $name = null, array $headers = [], string|null $disposition = 'attachment')	1
static \Symfony\Component\HttpFoundation\BinaryFileResponse file($file, array $headers = [])	1
static \Symfony\Component\HttpFoundation\StreamedResponse stream(\Closure $callback, int $status = 200, array $headers = [])	1
static \Symfony\Component\HttpFoundation\StreamedResponse streamDownload(\Closure $callback, string|null $name = null, array $headers = [], string|null $disposition = 'attachment')	1
static \Illuminate\Cache\TaggedCache tags(array|mixed $names)	1
static \Illuminate\Contracts\Cache\Lock lock(string $name, int $seconds = 0, mixed $owner = null)	1
static \Illuminate\Contracts\Cache\Lock restoreLock(string $name, string $owner)	1
static \Illuminate\Contracts\Cache\Repository store(string|null $name = null)	1
static \Illuminate\Contracts\Cache\Store getStore()	1
static bool add(string $key, $value, \DateTimeInterface|\DateInterval|int $ttl = null)	1
static bool flush()	1
static bool forever(string $key, $value)	1
static bool forget(string $key)	1
static bool has(string $key)	1
static bool missing(string $key)	1
static bool put(string $key, $value, \DateTimeInterface|\DateInterval|int $ttl = null)	1
static int|bool decrement(string $key, $value = 1)	1
static int|bool increment(string $key, $value = 1)	1
static mixed get(string $key, mixed $default = null)	1
static mixed pull(string $key, mixed $default = null)	1
static mixed remember(string $key, \DateTimeInterface|\DateInterval|int $ttl, \Closure $callback)	1
static mixed rememberForever(string $key, \Closure $callback)	1
static mixed sear(string $key, \Closure $callback)	1
static \SessionHandlerInterface getHandler()	1
static bool handlerNeedsRequest()	1
static bool isStarted()	1
static bool migrate(bool $destroy = false)	1
static bool save()	1
static bool start()	1
static mixed get(string $key, $default = null)	1
static mixed flash(string $key, $value = true)	1
static mixed pull(string $key, $default = null)	1
static mixed remove(string $key)	1
static string getId()	1
static string getName()	1
static string token()	1
static string|null previousUrl()	1
static void forget(string|array $keys)	1
static void push(string $key, mixed $value)	1
static void put(string|array $key, $value = null)	1
static void setId(string $id)	1
static void setPreviousUrl(string $url)	1
static void setRequestOnHandler(\Illuminate\Http\Request $request)	1
static \Symfony\Component\Finder\SplFileInfo[] allFiles(string $directory, bool $hidden = false)	1
static \Symfony\Component\Finder\SplFileInfo[] files(string $directory, bool $hidden = false)	1
static array directories(string $directory)	1
static array glob(string $pattern, int $flags = 0)	1
static bool cleanDirectory(string $directory)	1
static bool copy(string $path, string $target)	1
static bool copyDirectory(string $directory, string $destination, int|null $options = null)	1
static bool deleteDirectories(string $directory)	1
static bool deleteDirectory(string $directory, bool $preserve = false)	1
static bool isDirectory(string $directory)	1
static bool isFile(string $file)	1
static bool isReadable(string $path)	1
static bool isWritable(string $path)	1
static bool makeDirectory(string $path, int $mode = 0755, bool $recursive = false, bool $force = false)	1
static bool move(string $path, string $target)	1
static bool moveDirectory(string $from, string $to, bool $overwrite = false)	1
static int append(string $path, string $data)	1
static int prepend(string $path, string $data)	1
static int|bool put(string $path, string $contents, bool $lock = false)	1
static mixed chmod(string $path, int|null $mode = null)	1
static mixed getRequire(string $path, array $data = [])	1
static mixed requireOnce(string $file, array $data = [])	1
static string basename(string $path)	1
static string dirname(string $path)	1
static string extension(string $path)	1
static string get(string $path, bool $lock = false)	1
static string hash(string $path)	1
static string name(string $path)	1
static string sharedGet(string $path)	1
static string type(string $path)	1
static string|null guessExtension(string $path)	1
static void ensureDirectoryExists(string $path, int $mode = 0755, bool $recursive = true)	1
static void link(string $target, string $link)	1
static \Illuminate\Support\LazyCollection lines(string $path)	1
static void relativeLink(string $target, string $link)	1
static void replace(string $path, string $content)	1
static array getQueuedCookies()	1
static unqueue($name)	1
static void queue(...$parameters)	1
static \GuzzleHttp\Promise\PromiseInterface response($body = null, $status = 200, $headers = [])	1
static \Illuminate\Http\Client\Factory fake($callback = null)	1
static \Illuminate\Http\Client\PendingRequest accept(string $contentType)	1
static \Illuminate\Http\Client\PendingRequest acceptJson()	1
static \Illuminate\Http\Client\PendingRequest asForm()	1
static \Illuminate\Http\Client\PendingRequest asJson()	1
static \Illuminate\Http\Client\PendingRequest asMultipart()	1
static \Illuminate\Http\Client\PendingRequest async()	1
static \Illuminate\Http\Client\PendingRequest attach(string|array $name, string $contents = '', string|null $filename = null, array $headers = [])	1
static \Illuminate\Http\Client\PendingRequest baseUrl(string $url)	1
static \Illuminate\Http\Client\PendingRequest beforeSending(callable $callback)	1
static \Illuminate\Http\Client\PendingRequest bodyFormat(string $format)	1
static \Illuminate\Http\Client\PendingRequest contentType(string $contentType)	1
static \Illuminate\Http\Client\PendingRequest dd()	1
static \Illuminate\Http\Client\PendingRequest dump()	1
static \Illuminate\Http\Client\PendingRequest retry(int $times, int $sleep = 0, ?callable $when = null)	1
static \Illuminate\Http\Client\PendingRequest sink(string|resource $to)	1
static \Illuminate\Http\Client\PendingRequest stub(callable $callback)	1
static \Illuminate\Http\Client\PendingRequest timeout(int $seconds)	1
static \Illuminate\Http\Client\PendingRequest withBasicAuth(string $username, string $password)	1
static \Illuminate\Http\Client\PendingRequest withBody(resource|string $content, string $contentType)	1
static \Illuminate\Http\Client\PendingRequest withCookies(array $cookies, string $domain)	1
static \Illuminate\Http\Client\PendingRequest withDigestAuth(string $username, string $password)	1
static \Illuminate\Http\Client\PendingRequest withHeaders(array $headers)	1
static \Illuminate\Http\Client\PendingRequest withMiddleware(callable $middleware)	1
static \Illuminate\Http\Client\PendingRequest withOptions(array $options)	1
static \Illuminate\Http\Client\PendingRequest withToken(string $token, string $type = 'Bearer')	1
static \Illuminate\Http\Client\PendingRequest withUserAgent(string $userAgent)	1
static \Illuminate\Http\Client\PendingRequest withoutRedirecting()	1
static \Illuminate\Http\Client\PendingRequest withoutVerifying()	1
static array pool(callable $callback)	1
static \Illuminate\Http\Client\Response delete(string $url, array $data = [])	1
static \Illuminate\Http\Client\Response get(string $url, array|string|null $query = null)	1
static \Illuminate\Http\Client\Response head(string $url, array|string|null $query = null)	1
static \Illuminate\Http\Client\Response patch(string $url, array $data = [])	1
static \Illuminate\Http\Client\Response post(string $url, array $data = [])	1
static \Illuminate\Http\Client\Response put(string $url, array $data = [])	1
static \Illuminate\Http\Client\Response send(string $method, string $url, array $options = [])	1
static \Illuminate\Http\Client\ResponseSequence fakeSequence(string $urlPattern = '*')	1
static void assertSent(callable $callback)	1
static void assertSentInOrder(array $callbacks)	1
static void assertNotSent(callable $callback)	1
static void assertSentCount(int $count)	1
static void assertSequencesAreEmpty()	1
static bool has($key)	1
static mixed get($key, $default = null)	1
static void prepend($key, $value)	1
static void push($key, $value)	1
static void set($key, $value = null)	1
static \Illuminate\Contracts\Queue\Job|null pop(string $queue = null)	1
static \Illuminate\Contracts\Queue\Queue setConnectionName(string $name)	1
static int size(string $queue = null)	1
static mixed bulk(array $jobs, mixed $data = '', string $queue = null)	1
static mixed later(\DateTimeInterface|\DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null)	1
static mixed laterOn(string $queue, \DateTimeInterface|\DateInterval|int $delay, string|object $job, mixed $data = '')	1
static mixed push(string|object $job, mixed $data = '', $queue = null)	1
static mixed pushOn(string $queue, string|object $job, mixed $data = '')	1
static mixed pushRaw(string $payload, string $queue = null, array $options = [])	1
static string getConnectionName()	1
static void assertNotPushed(string|\Closure $job, callable $callback = null)	1
static void assertNothingPushed()	1
static void assertPushed(string|\Closure $job, callable|int $callback = null)	1
static void assertPushedOn(string $queue, string|\Closure $job, callable $callback = null)	1
static void assertPushedWithChain(string $job, array $expectedChain = [], callable $callback = null)	1
static \Illuminate\Contracts\Routing\UrlGenerator setRootControllerNamespace(string $rootNamespace)	1
static bool hasValidSignature(\Illuminate\Http\Request $request, bool $absolute = true)	1
static string action(string|array $action, $parameters = [], bool $absolute = true)	1
static string asset(string $path, bool $secure = null)	1
static string secureAsset(string $path)	1
static string current()	1
static string full()	1
static void mixin(object $mixin, bool $replace = true)	1
static string previous($fallback = false)	1
static string route(string $name, $parameters = [], bool $absolute = true)	1
static string secure(string $path, array $parameters = [])	1
static string signedRoute(string $name, array $parameters = [], \DateTimeInterface|\DateInterval|int $expiration = null, bool $absolute = true)	1
static string temporarySignedRoute(string $name, \DateTimeInterface|\DateInterval|int $expiration, array $parameters = [], bool $absolute = true)	1
static string to(string $path, $extra = [], bool $secure = null)	1
static void defaults(array $defaults)	1
static void forceScheme(string $scheme)	1
static bool isValidUrl(string $path)	1
static \Closure getRouteResolver()	1
static \Closure getUserResolver()	1
static \Illuminate\Http\Request capture()	1
static \Illuminate\Http\Request createFrom(\Illuminate\Http\Request $from, \Illuminate\Http\Request|null $to = null)	1
static \Illuminate\Http\Request createFromBase(\Symfony\Component\HttpFoundation\Request $request)	1
static \Illuminate\Http\Request duplicate(array|null $query = null, array|null $request = null, array|null $attributes = null, array|null $cookies = null, array|null $files = null, array|null $server = null)	1
static \Illuminate\Http\Request instance()	1
static \Illuminate\Http\Request merge(array $input)	1
static \Illuminate\Http\Request replace(array $input)	1
static \Illuminate\Http\Request setJson(\Symfony\Component\HttpFoundation\ParameterBag $json)	1
static \Illuminate\Http\Request setRouteResolver(\Closure $callback)	1
static \Illuminate\Http\Request setUserResolver(\Closure $callback)	1
static \Illuminate\Http\UploadedFile|\Illuminate\Http\UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)	1
static \Illuminate\Routing\Route|object|string route(string|null $param = null, string|null $default = null)	1
static \Illuminate\Session\Store session()	1
static \Illuminate\Session\Store|null getSession()	1
static \Symfony\Component\HttpFoundation\ParameterBag|mixed json(string|null $key = null, mixed $default = null)	1
static array all(array|mixed|null $keys = null)	1
static array allFiles()	1
static array except(array|mixed $keys)	1
static array ips()	1
static array keys()	1
static array only(array|mixed $keys)	1
static array segments()	1
static array toArray()	1
static array validate(array $rules, ...$params)	1
static array validateWithBag(string $errorBag, array $rules, ...$params)	1
static bool accepts(string|array $contentTypes)	1
static bool acceptsAnyContentType()	1
static bool acceptsHtml()	1
static bool acceptsJson()	1
static bool ajax()	1
static bool anyFilled(string|array $key)	1
static bool expectsJson()	1
static bool filled(string|array $key)	1
static bool fullUrlIs(mixed ...$patterns)	1
static bool hasAny(string|array $key)	1
static bool hasCookie(string $key)	1
static bool hasFile(string $key)	1
static bool hasHeader(string $key)	1
static bool hasValidSignature(bool $absolute = true)	1
static bool is(mixed ...$patterns)	1
static bool isJson()	1
static bool matchesType(string $actual, string $type)	1
static bool offsetExists(string $offset)	1
static bool pjax()	1
static bool prefers(string|array $contentTypes)	1
static bool prefetch()	1
static bool routeIs(mixed ...$patterns)	1
static bool secure()	1
static bool wantsJson()	1
static mixed filterFiles(mixed $files)	1
static mixed offsetGet(string $offset)	1
static mixed user(string|null $guard = null)	1
static string decodedPath()	1
static string fingerprint()	1
static string format($default = 'html')	1
static string fullUrl()	1
static string fullUrlWithQuery(array $query)	1
static string method()	1
static string path()	1
static string root()	1
static string url()	1
static string userAgent()	1
static string|array old(string|null $key = null, string|array|null $default = null)	1
static string|array|null cookie(string|null $key = null, string|array|null $default = null)	1
static string|array|null header(string|null $key = null, string|array|null $default = null)	1
static string|array|null input(string|null $key = null, string|array|null $default = null)	1
static string|array|null post(string|null $key = null, string|array|null $default = null)	1
static string|array|null query(string|null $key = null, string|array|null $default = null)	1
static string|array|null server(string|null $key = null, string|array|null $default = null)	1
static string|null bearerToken()	1
static string|null ip()	1
static string|null segment(int $index, string|null $default = null)	1
static void flash()	1
static void flashExcept(array|mixed $keys)	1
static void flashOnly(array|mixed $keys)	1
static void offsetSet(string $offset, mixed $value)	1
static void offsetUnset(string $offset)	1
static void setLaravelSession(\Illuminate\Contracts\Session\Session $session)	1
static mixed reset(array $credentials, \Closure $callback)	1
static string sendResetLink(array $credentials, \Closure $callback = null)	1
static \Illuminate\Contracts\Auth\CanResetPassword getUser(array $credentials)	1
static string createToken(\Illuminate\Contracts\Auth\CanResetPassword $user)	1
static void deleteToken(\Illuminate\Contracts\Auth\CanResetPassword $user)	1
static bool tokenExists(\Illuminate\Contracts\Auth\CanResetPassword $user, string $token)	1
static \Illuminate\Auth\Passwords\TokenRepositoryInterface getRepository()	1
static \Illuminate\Contracts\Auth\PasswordBroker broker(string|null $name = null)	1
static \Doctrine\DBAL\Driver\PDOConnection getPdo()	1
static \Illuminate\Database\ConnectionInterface connection(string $name = null)	1
static \Illuminate\Database\Query\Builder table(string $table, string $as = null)	1
static \Illuminate\Database\Query\Expression raw($value)	1
static array getQueryLog()	1
static array prepareBindings(array $bindings)	1
static array pretend(\Closure $callback)	1
static array select(string $query, array $bindings = [], bool $useReadPdo = true)	1
static bool insert(string $query, array $bindings = [])	1
static bool logging()	1
static bool statement(string $query, array $bindings = [])	1
static bool unprepared(string $query)	1
static int affectingStatement(string $query, array $bindings = [])	1
static int delete(string $query, array $bindings = [])	1
static int transactionLevel()	1
static int update(string $query, array $bindings = [])	1
static mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)	1
static mixed transaction(\Closure $callback, int $attempts = 1)	1
static string getDefaultConnection()	1
static void afterCommit(\Closure $callback)	1
static void beginTransaction()	1
static void commit()	1
static void enableQueryLog()	1
static void disableQueryLog()	1
static void flushQueryLog()	1
static \Illuminate\Database\Connection beforeExecuting(\Closure $callback)	1
static void rollBack(int $toLevel = null)	1
static void setDefaultConnection(string $name)	1
static \Illuminate\Foundation\Bus\PendingDispatch queue(string $command, array $parameters = [])	1
static \Illuminate\Foundation\Console\ClosureCommand command(string $command, callable $callback)	1
static int call(string $command, array $parameters = [], \Symfony\Component\Console\Output\OutputInterface|null $outputBuffer = null)	1
static int handle(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface|null $output = null)	1
static string output()	1
static void terminate(\Symfony\Component\Console\Input\InputInterface $input, int $status)	1
static \Illuminate\Support\Carbon create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $tz = null)	1
static \Illuminate\Support\Carbon createFromDate($year = null, $month = null, $day = null, $tz = null)	1
static \Illuminate\Support\Carbon createFromTime($hour = 0, $minute = 0, $second = 0, $tz = null)	1
static \Illuminate\Support\Carbon createFromTimeString($time, $tz = null)	1
static \Illuminate\Support\Carbon createFromTimestamp($timestamp, $tz = null)	1
static \Illuminate\Support\Carbon createFromTimestampMs($timestamp, $tz = null)	1
static \Illuminate\Support\Carbon createFromTimestampUTC($timestamp)	1
static \Illuminate\Support\Carbon createMidnightDate($year = null, $month = null, $day = null, $tz = null)	1
static \Illuminate\Support\Carbon disableHumanDiffOption($humanDiffOption)	1
static \Illuminate\Support\Carbon enableHumanDiffOption($humanDiffOption)	1
static \Illuminate\Support\Carbon fromSerialized($value)	1
static \Illuminate\Support\Carbon getLastErrors()	1
static \Illuminate\Support\Carbon getTestNow()	1
static \Illuminate\Support\Carbon instance($date)	1
static \Illuminate\Support\Carbon isMutable()	1
static \Illuminate\Support\Carbon maxValue()	1
static \Illuminate\Support\Carbon minValue()	1
static \Illuminate\Support\Carbon now($tz = null)	1
static \Illuminate\Support\Carbon parse($time = null, $tz = null)	1
static \Illuminate\Support\Carbon setHumanDiffOptions($humanDiffOptions)	1
static \Illuminate\Support\Carbon setUtf8($utf8)	1
static \Illuminate\Support\Carbon today($tz = null)	1
static \Illuminate\Support\Carbon tomorrow($tz = null)	1
static \Illuminate\Support\Carbon useStrictMode($strictModeEnabled = true)	1
static \Illuminate\Support\Carbon yesterday($tz = null)	1
static \Illuminate\Support\Carbon|false createFromFormat($format, $time, $tz = null)	1
static \Illuminate\Support\Carbon|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null)	1
static \Illuminate\Support\Carbon|null make($var)	1
static mixed use(mixed $handler)	1
static void useCallable(callable $callable)	1
static void useClass(string $class)	1
static void useDefault()	1
static void useFactory(object $factory)	1
static \Illuminate\Routing\PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])	1
static \Illuminate\Routing\PendingResourceRegistration resource(string $name, string $controller, array $options = [])	1
static \Illuminate\Routing\Route any(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route|null current()	1
static \Illuminate\Routing\Route delete(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route fallback(array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route get(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route|null getCurrentRoute()	1
static \Illuminate\Routing\RouteCollectionInterface getRoutes()	1
static \Illuminate\Routing\Route match(array|string $methods, string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route options(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route patch(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route permanentRedirect(string $uri, string $destination)	1
static \Illuminate\Routing\Route post(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route put(string $uri, array|string|callable|null $action = null)	1
static \Illuminate\Routing\Route redirect(string $uri, string $destination, int $status = 302)	1
static \Illuminate\Routing\Route substituteBindings(\Illuminate\Support\Facades\Route $route)	1
static \Illuminate\Routing\Route view(string $uri, string $view, array $data = [], int|array $status = 200, array $headers = [])	1
static \Illuminate\Routing\RouteRegistrar as(string $value)	1
static \Illuminate\Routing\RouteRegistrar controller(string $controller)	1
static \Illuminate\Routing\RouteRegistrar domain(string $value)	1
static \Illuminate\Routing\RouteRegistrar middleware(array|string|null $middleware)	1
static \Illuminate\Routing\RouteRegistrar name(string $value)	1
static \Illuminate\Routing\RouteRegistrar namespace(string|null $value)	1
static \Illuminate\Routing\RouteRegistrar prefix(string $prefix)	1
static \Illuminate\Routing\RouteRegistrar scopeBindings()	1
static \Illuminate\Routing\RouteRegistrar where(array $where)	1
static \Illuminate\Routing\RouteRegistrar withoutMiddleware(array|string $middleware)	1
static \Illuminate\Routing\Router|\Illuminate\Routing\RouteRegistrar group(\Closure|string|array $attributes, \Closure|string $routes)	1
static \Illuminate\Routing\ResourceRegistrar resourceVerbs(array $verbs = [])	1
static string|null currentRouteAction()	1
static string|null currentRouteName()	1
static void apiResources(array $resources, array $options = [])	1
static void bind(string $key, string|callable $binder)	1
static void model(string $key, string $class, \Closure|null $callback = null)	1
static void pattern(string $key, string $pattern)	1
static void resources(array $resources, array $options = [])	1
static void substituteImplicitBindings(\Illuminate\Support\Facades\Route $route)	1
static boolean uses(...$patterns)	1
static boolean is(...$patterns)	1
static boolean has(string $name)	1
static mixed input(string $key, string|null $default = null)	1
static \Illuminate\Redis\Connections\Connection connection(string $name = null)	1
static \Illuminate\Redis\Limiters\ConcurrencyLimiterBuilder funnel(string $name)	1
static \Illuminate\Redis\Limiters\DurationLimiterBuilder throttle(string $name)	1
static \Illuminate\Contracts\View\Factory addNamespace(string $namespace, string|array $hints)	1
static \Illuminate\Contracts\View\View first(array $views, \Illuminate\Contracts\Support\Arrayable|array $data = [], array $mergeData = [])	1
static \Illuminate\Contracts\View\Factory replaceNamespace(string $namespace, string|array $hints)	1
static \Illuminate\Contracts\View\Factory addExtension(string $extension, string $engine, \Closure|null $resolver = null)	1
static \Illuminate\Contracts\View\View file(string $path, array $data = [], array $mergeData = [])	1
static \Illuminate\Contracts\View\View make(string $view, array $data = [], array $mergeData = [])	1
static array composer(array|string $views, \Closure|string $callback)	1
static array creator(array|string $views, \Closure|string $callback)	1
static bool exists(string $view)	1
static mixed share(array|string $key, $value = null)	1
static \Illuminate\Contracts\Filesystem\Filesystem assertExists(string|array $path)	1
static \Illuminate\Contracts\Filesystem\Filesystem assertMissing(string|array $path)	1
static \Illuminate\Contracts\Filesystem\Filesystem cloud()	1
static \Illuminate\Contracts\Filesystem\Filesystem build(string|array $root)	1
static \Illuminate\Contracts\Filesystem\Filesystem disk(string|null $name = null)	1
static \Illuminate\Filesystem\FilesystemManager extend(string $driver, \Closure $callback)	1
static \Symfony\Component\HttpFoundation\StreamedResponse download(string $path, string|null $name = null, array|null $headers = [])	1
static \Symfony\Component\HttpFoundation\StreamedResponse response(string $path, string|null $name = null, array|null $headers = [], string|null $disposition = 'inline')	1
static array allDirectories(string|null $directory = null)	1
static array allFiles(string|null $directory = null)	1
static array directories(string|null $directory = null, bool $recursive = false)	1
static array files(string|null $directory = null, bool $recursive = false)	1
static bool append(string $path, string $data)	1
static bool copy(string $from, string $to)	1
static bool deleteDirectory(string $directory)	1
static bool makeDirectory(string $path)	1
static bool move(string $from, string $to)	1
static bool prepend(string $path, string $data)	1
static bool put(string $path, \Psr\Http\Message\StreamInterface|\Illuminate\Http\File|\Illuminate\Http\UploadedFile|string|resource $contents, mixed $options = [])	1
static bool setVisibility(string $path, string $visibility)	1
static bool writeStream(string $path, resource $resource, array $options = [])	1
static resource|null readStream(string $path)	1
static string get(string $path)	1
static string getVisibility(string $path)	1
static string path(string $path)	1
static string temporaryUrl(string $path, \DateTimeInterface $expiration, array $options = [])	1
static string url(string $path)	1
static string|false putFile(string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $file, mixed $options = [])	1
static string|false putFileAs(string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $file, string $name, mixed $options = [])	1
static void buildTemporaryUrlsUsing(\Closure $callback)	1
static \Psr\Log\LoggerInterface channel(string $channel = null)	1
static \Psr\Log\LoggerInterface stack(array $channels, string $channel = null)	1
static \Psr\Log\LoggerInterface build(array $config)	1
static \Illuminate\Log\Logger withContext(array $context = [])	1
static \Illuminate\Log\Logger withoutContext()	1
static void alert(string $message, array $context = [])	1
static void critical(string $message, array $context = [])	1
static void debug(string $message, array $context = [])	1
static void emergency(string $message, array $context = [])	1
static void error(string $message, array $context = [])	1
static void info(string $message, array $context = [])	1
static void log($level, string $message, array $context = [])	1
static void notice(string $message, array $context = [])	1
static void warning(string $message, array $context = [])	1
static void write(string $level, string $message, array $context = [])	1
static \Illuminate\Database\Schema\Builder create(string $table, \Closure $callback)	1
static \Illuminate\Database\Schema\Builder createDatabase(string $name)	1
static \Illuminate\Database\Schema\Builder disableForeignKeyConstraints()	1
static \Illuminate\Database\Schema\Builder drop(string $table)	1
static \Illuminate\Database\Schema\Builder dropDatabaseIfExists(string $name)	1
static \Illuminate\Database\Schema\Builder dropIfExists(string $table)	1
static \Illuminate\Database\Schema\Builder enableForeignKeyConstraints()	1
static \Illuminate\Database\Schema\Builder rename(string $from, string $to)	1
static \Illuminate\Database\Schema\Builder table(string $table, \Closure $callback)	1
static bool hasColumn(string $table, string $column)	1
static bool hasColumns(string $table, array $columns)	1
static bool dropColumns(string $table, array $columns)	1
static bool hasTable(string $table)	1
static void defaultStringLength(int $length)	1
static void registerCustomDoctrineType(string $class, string $name, string $type)	1
static array getColumnListing(string $table)	1
static string getColumnType(string $table, string $column)	1
static void morphUsingUuids()	1
static \Illuminate\Database\Connection getConnection()	1
static \Illuminate\Database\Schema\Builder setConnection(\Illuminate\Database\Connection $connection)	1
static \Illuminate\Http\RedirectResponse action(string $action, mixed $parameters = [], int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse away(string $path, int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse back(int $status = 302, array $headers = [], $fallback = false)	1
static \Illuminate\Http\RedirectResponse guest(string $path, int $status = 302, array $headers = [], bool $secure = null)	1
static \Illuminate\Http\RedirectResponse home(int $status = 302)	1
static \Illuminate\Http\RedirectResponse intended(string $default = '/', int $status = 302, array $headers = [], bool $secure = null)	1
static \Illuminate\Http\RedirectResponse refresh(int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse route(string $route, mixed $parameters = [], int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse secure(string $path, int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse signedRoute(string $name, mixed $parameters = [], \DateTimeInterface|\DateInterval|int $expiration = null, int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse temporarySignedRoute(string $name, \DateTimeInterface|\DateInterval|int $expiration, mixed $parameters = [], int $status = 302, array $headers = [])	1
static \Illuminate\Http\RedirectResponse to(string $path, int $status = 302, array $headers = [], bool $secure = null)	1
static \Illuminate\Routing\UrlGenerator getUrlGenerator()	1
static void setSession(\Illuminate\Session\Store $session)	1
static void setIntendedUrl(string $url)	1
static bool supported(string $key, string $cipher)	1
static mixed decrypt(string $payload, bool $unserialize = true)	1
static string decryptString(string $payload)	1
static string encrypt(mixed $value, bool $serialize = true)	1
static string encryptString(string $value)	1
static string generateKey(string $cipher)	1
static string getKey()	1
static \Illuminate\Bus\Batch|null findBatch(string $batchId)	1
static \Illuminate\Bus\PendingBatch batch(array|mixed $jobs)	1
static \Illuminate\Contracts\Bus\Dispatcher map(array $map)	1
static \Illuminate\Contracts\Bus\Dispatcher pipeThrough(array $pipes)	1
static \Illuminate\Foundation\Bus\PendingChain chain(array $jobs)	1
static bool hasCommandHandler($command)	1
static bool|mixed getCommandHandler($command)	1
static mixed dispatch($command)	1
static mixed dispatchNow($command, $handler = null)	1
static mixed dispatchSync($command, $handler = null)	1
static void assertDispatched(string|\Closure $command, callable|int $callback = null)	1
static void assertDispatchedTimes(string $command, int $times = 1)	1
static void assertNotDispatched(string|\Closure $command, callable|int $callback = null)	1
static void assertDispatchedAfterResponse(string|\Closure $command, callable|int $callback = null)	1
static void assertDispatchedAfterResponseTimes(string $command, int $times = 1)	1
static void assertNotDispatchedAfterResponse(string|\Closure $command, callable $callback = null)	1
static void assertBatched(callable $callback)	1
static void assertBatchCount(int $count)	1
static void assertChained(array $expectedChain)	1
static void assertDispatchedSync(string|\Closure $command, callable $callback = null)	1
static void assertDispatchedSyncTimes(string $command, int $times = 1)	1
static void assertNotDispatchedSync(string|\Closure $command, callable $callback = null)	1
static void assertDispatchedWithoutChain(string|\Closure $command, callable $callback = null)	1
static \Illuminate\Notifications\ChannelManager locale(string|null $locale)	1
static \Illuminate\Support\Collection sent(mixed $notifiable, string $notification, callable $callback = null)	1
static bool hasSent(mixed $notifiable, string $notification)	1
static mixed channel(string|null $name = null)	1
static void assertNotSentTo(mixed $notifiable, string|\Closure $notification, callable $callback = null)	1
static void assertSentOnDemand(string|\Closure $notification, callable $callback = null)	1
static void assertSentTo(mixed $notifiable, string|\Closure $notification, callable $callback = null)	1
static void assertSentOnDemandTimes(string $notification, int $times = 1)	1
static void assertSentToTimes(mixed $notifiable, string $notification, int $times = 1)	1
static void assertTimesSent(int $expectedCount, string $notification)	1
static void send(\Illuminate\Support\Collection|array|mixed $notifiables, $notification)	1
static void sendNow(\Illuminate\Support\Collection|array|mixed $notifiables, $notification)	1
static array getClassComponentAliases()	1
static array getCustomDirectives()	1
static array getExtensions()	1
static bool check(string $name, array ...$parameters)	1
static string compileString(string $value)	1
static string render(string $string, array $data = [], bool $deleteCachedView = false)	1
static string renderComponent(\Illuminate\View\Component $component)	1
static string getPath()	1
static string stripParentheses(string $expression)	1
static void aliasComponent(string $path, string|null $alias = null)	1
static void aliasInclude(string $path, string|null $alias = null)	1
static void compile(string|null $path = null)	1
static void component(string $class, string|null $alias = null, string $prefix = '')	1
static void components(array $components, string $prefix = '')	1
static void componentNamespace(string $namespace, string $prefix)	1
static void directive(string $name, callable $handler)	1
static void extend(callable $compiler)	1
static void if(string $name, callable $callback)	1
static void include(string $path, string|null $alias = null)	1
static void precompiler(callable $precompiler)	1
static void setEchoFormat(string $format)	1
static void setPath(string $path)	1
static void withDoubleEncoding()	1
static void withoutComponentTags()	1
static void withoutDoubleEncoding()	1
static void stringable(string|callable $class, callable|null $handler = null)	1
static \Illuminate\Broadcasting\Broadcasters\Broadcaster channel(string $channel, callable|string $callback, array $options = [])	1
static mixed auth(\Illuminate\Http\Request $request)	1
static \Illuminate\Contracts\Broadcasting\Broadcaster connection($name = null);	1
static void routes(array $attributes = null)	1
static \Illuminate\Broadcasting\BroadcastManager socket($request = null)	1
static void setUpProcess(callable $callback)	1
static void setUpTestCase(callable $callback)	1
static void setUpTestDatabase(callable $callback)	1
static void tearDownProcess(callable $callback)	1
static void tearDownTestCase(callable $callback)	1
static int|false token()	1
integer getPartNumber()	1
integer setPartNumber(integer $part_number)	1
string getContent()	1
string setContent(string $content)	1
string getType()	1
string setType(string $type)	1
string getContentType()	1
string setContentType(string $content_type)	1
string getId()	1
string setId(string $id)	1
string getSize()	1
string setSize(integer $size)	1
string getName()	1
string getDisposition()	1
string setDisposition(string $disposition)	1
string setImgSrc(string $img_src)	1
integer getMsglist()	1
integer setMsglist($msglist)	1
integer getUid()	1
integer getMsgn()	1
Attribute getPriority()	1
Attribute getSubject()	1
Attribute getMessageId()	1
Attribute getMessageNo()	1
Attribute getReferences()	1
Attribute getDate()	1
Attribute getFrom()	1
Attribute getTo()	1
Attribute getCc()	1
Attribute getBcc()	1
Attribute getReplyTo()	1
Attribute getInReplyTo()	1
Attribute getSender()	1
WhereQuery all()	1
WhereQuery answered()	1
WhereQuery deleted()	1
WhereQuery new()	1
WhereQuery old()	1
WhereQuery recent()	1
WhereQuery seen()	1
WhereQuery unanswered()	1
WhereQuery undeleted()	1
WhereQuery unflagged()	1
WhereQuery unseen()	1
WhereQuery not()	1
WhereQuery unkeyword($value)	1
WhereQuery to($value)	1
WhereQuery text($value)	1
WhereQuery subject($value)	1
WhereQuery since($date)	1
WhereQuery on($date)	1
WhereQuery keyword($value)	1
WhereQuery from($value)	1
WhereQuery flagged()	1
WhereQuery cc($value)	1
WhereQuery body($value)	1
WhereQuery before($date)	1
WhereQuery bcc($value)	1
WhereQuery inReplyTo($value)	1
WhereQuery messageId($value)	1
bool isiPhone()	1
bool isBlackBerry()	1
bool isPixel()	1
bool isHTC()	1
bool isNexus()	1
bool isDell()	1
bool isMotorola()	1
bool isSamsung()	1
bool isLG()	1
bool isSony()	1
bool isAsus()	1
bool isXiaomi()	1
bool isNokiaLumia()	1
bool isMicromax()	1
bool isPalm()	1
bool isVertu()	1
bool isPantech()	1
bool isFly()	1
bool isWiko()	1
bool isiMobile()	1
bool isSimValley()	1
bool isWolfgang()	1
bool isAlcatel()	1
bool isNintendo()	1
bool isAmoi()	1
bool isINQ()	1
bool isOnePlus()	1
bool isGenericPhone()	1
bool isiPad()	1
bool isNexusTablet()	1
bool isGoogleTablet()	1
bool isSamsungTablet()	1
bool isKindle()	1
bool isSurfaceTablet()	1
bool isHPTablet()	1
bool isAsusTablet()	1
bool isBlackBerryTablet()	1
bool isHTCtablet()	1
bool isMotorolaTablet()	1
bool isNookTablet()	1
bool isAcerTablet()	1
bool isToshibaTablet()	1
bool isLGTablet()	1
bool isFujitsuTablet()	1
bool isPrestigioTablet()	1
bool isLenovoTablet()	1
bool isDellTablet()	1
bool isYarvikTablet()	1
bool isMedionTablet()	1
bool isArnovaTablet()	1
bool isIntensoTablet()	1
bool isIRUTablet()	1
bool isMegafonTablet()	1
bool isEbodaTablet()	1
bool isAllViewTablet()	1
bool isArchosTablet()	1
bool isAinolTablet()	1
bool isNokiaLumiaTablet()	1
bool isSonyTablet()	1
bool isPhilipsTablet()	1
bool isCubeTablet()	1
bool isCobyTablet()	1
bool isMIDTablet()	1
bool isMSITablet()	1
bool isSMiTTablet()	1
bool isRockChipTablet()	1
bool isFlyTablet()	1
bool isbqTablet()	1
bool isHuaweiTablet()	1
bool isNecTablet()	1
bool isPantechTablet()	1
bool isBronchoTablet()	1
bool isVersusTablet()	1
bool isZyncTablet()	1
bool isPositivoTablet()	1
bool isNabiTablet()	1
bool isKoboTablet()	1
bool isDanewTablet()	1
bool isTexetTablet()	1
bool isPlaystationTablet()	1
bool isTrekstorTablet()	1
bool isPyleAudioTablet()	1
bool isAdvanTablet()	1
bool isDanyTechTablet()	1
bool isGalapadTablet()	1
bool isMicromaxTablet()	1
bool isKarbonnTablet()	1
bool isAllFineTablet()	1
bool isPROSCANTablet()	1
bool isYONESTablet()	1
bool isChangJiaTablet()	1
bool isGUTablet()	1
bool isPointOfViewTablet()	1
bool isOvermaxTablet()	1
bool isHCLTablet()	1
bool isDPSTablet()	1
bool isVistureTablet()	1
bool isCrestaTablet()	1
bool isMediatekTablet()	1
bool isConcordeTablet()	1
bool isGoCleverTablet()	1
bool isModecomTablet()	1
bool isVoninoTablet()	1
bool isECSTablet()	1
bool isStorexTablet()	1
bool isVodafoneTablet()	1
bool isEssentielBTablet()	1
bool isRossMoorTablet()	1
bool isiMobileTablet()	1
bool isTolinoTablet()	1
bool isAudioSonicTablet()	1
bool isAMPETablet()	1
bool isSkkTablet()	1
bool isTecnoTablet()	1
bool isJXDTablet()	1
bool isiJoyTablet()	1
bool isFX2Tablet()	1
bool isXoroTablet()	1
bool isViewsonicTablet()	1
bool isVerizonTablet()	1
bool isOdysTablet()	1
bool isCaptivaTablet()	1
bool isIconbitTablet()	1
bool isTeclastTablet()	1
bool isOndaTablet()	1
bool isJaytechTablet()	1
bool isBlaupunktTablet()	1
bool isDigmaTablet()	1
bool isEvolioTablet()	1
bool isLavaTablet()	1
bool isAocTablet()	1
bool isMpmanTablet()	1
bool isCelkonTablet()	1
bool isWolderTablet()	1
bool isMediacomTablet()	1
bool isMiTablet()	1
bool isNibiruTablet()	1
bool isNexoTablet()	1
bool isLeaderTablet()	1
bool isUbislateTablet()	1
bool isPocketBookTablet()	1
bool isKocasoTablet()	1
bool isHisenseTablet()	1
bool isHudl()	1
bool isTelstraTablet()	1
bool isGenericTablet()	1
bool isAndroidOS()	1
bool isBlackBerryOS()	1
bool isPalmOS()	1
bool isSymbianOS()	1
bool isWindowsMobileOS()	1
bool isWindowsPhoneOS()	1
bool isiOS()	1
bool isiPadOS()	1
bool isSailfishOS()	1
bool isMeeGoOS()	1
bool isMaemoOS()	1
bool isJavaOS()	1
bool iswebOS()	1
bool isbadaOS()	1
bool isBREWOS()	1
bool isChrome()	1
bool isDolfin()	1
bool isOpera()	1
bool isSkyfire()	1
bool isEdge()	1
bool isIE()	1
bool isFirefox()	1
bool isBolt()	1
bool isTeaShark()	1
bool isBlazer()	1
bool isSafari()	1
bool isWeChat()	1
bool isUCBrowser()	1
bool isbaiduboxapp()	1
bool isbaidubrowser()	1
bool isDiigoBrowser()	1
bool isMercury()	1
bool isObigoBrowser()	1
bool isNetFront()	1
bool isGenericBrowser()	1
bool isPaleMoon()	1
bool isBot()	1
bool isMobileBot()	1
bool isDesktopMode()	1
bool isTV()	1
bool isWebKit()	1
bool isConsole()	1
bool isWatch()	1
static void onGet(Callable $function) fired before reading the request details	1
static void onRoute(Callable $function) fired before finding the api method	1
static void onNegotiate(Callable $function) fired before content negotiation	1
static void onPreAuthFilter(Callable $function) fired before pre auth filtering	1
static void onAuthenticate(Callable $function) fired before auth	1
static void onPostAuthFilter(Callable $function) fired before post auth filtering	1
static void onValidate(Callable $function) fired before validation	1
static void onCall(Callable $function) fired before api method call	1
static void onCompose(Callable $function) fired before composing response	1
static void onRespond(Callable $function) fired before sending response	1
static void onComplete(Callable $function) fired after sending response	1
static void onMessage(Callable $function) fired before composing error response	1
void onGet(Callable $function) fired before reading the request details	1
void onRoute(Callable $function) fired before finding the api method	1
void onNegotiate(Callable $function) fired before content negotiation	1
void onPreAuthFilter(Callable $function) fired before pre auth filtering	1
void onAuthenticate(Callable $function) fired before auth	1
void onPostAuthFilter(Callable $function) fired before post auth filtering	1
void onValidate(Callable $function) fired before validation	1
void onCall(Callable $function) fired before api method call	1
void onCompose(Callable $function) fired before composing response	1
void onRespond(Callable $function) fired before sending response	1
void onComplete(Callable $function) fired after sending response	1
void onMessage(Callable $function) fired before composing error response	1
static startOfWeek(int $weekStartsAt = null)	1
static addWeeks(int $weeks = 1)	1
static dayOfYear(int $dayOfYear)	1
string getTranslationMessage(string $key, ?string $locale = null, ?string $default = null, $translator = null)	1
static next(int|string $day = null)	1
static startOfWeek(int $day = 1)	1
static subWeeks(int $weeks = 1)	1
static year(int $year = null)	1
bool lessThan($date)	1
static resolveCarbon($date = null)	1
static Translator translator()	1
string|static locale(string $locale = null, string ...$fallbackLocales)	1
string toJSON()	1
static resolveCarbon($date)	1
static copy()	1
static nowWithSameTz()	1
static static yesterday($timezone = null)	1
static static tomorrow($timezone = null)	1
\Carbon\Carbon|\Carbon\CarbonImmutable shiftTimezone($timezone) Set the timezone	1
$this setTime(int $hour, int $minute, int $second = 0, int $microseconds = 0)	1
$this setDate(int $year, int $month, int $day)	1
$this addMonths(int $value = 1)	1
static Carbon|CarbonImmutable getTestNow()	1
and inject its dependencies.	1
style callback into class and method.	1
boolean is[...]()	1
Tags name(string $value) name attribute	2
Tags action(string $value) action attribute	2
Tags placeholder(string $value) placeholder attribute	2
Tags value(string $value) value attribute	2
Tags required(boolean $value) required attribute	2
Tags class(string $value) required attribute	2
static Tags form() creates a html form	2
static Tags input() creates a html input element	2
static Tags button() creates a html button element	2
bool canBeCreatedFromFormat($date, $format) Checks if the (date)time string is in a given format and valid to create a	2
CarbonInterface createStrict(?int $year = 0, ?int $month = 1, ?int $day = 1, ?int $hour = 0, ?int $minute = 0, ?int $second = 0, $tz = null) Create a new Carbon instance from a specific date and time using strict validation.	2
mixed executeWithLocale($locale, $func) Set the current locale to the given, execute the passed function, reset the locale to previous one,	2
void genericMacro($macro, $priority = 0) Register a custom macro.	2
array getAvailableLocales() Returns the list of internally available locales and already loaded custom locales.	2
Language[] getAvailableLocalesInfo() Returns list of Language object for each available locale. This object allow you to get the ISO name, native	2
array getDays() Get the days of the week	2
string|null getFallbackLocale() Get the fallback locale.	2
array getFormatsToIsoReplacements() List of replacements from date() format to isoFormat().	2
int getHumanDiffOptions() Return default humanDiff() options (merged flags as integer).	2
array getIsoUnits() Returns list of locale units for ISO formatting.	2
array getLastErrors() {@inheritdoc}	2
string getLocale() Get the current translator locale.	2
callable|null getMacro($name) Get the raw callable macro registered globally for a given name.	2
int getMidDayAt() get midday/noon hour	2
string getTimeFormatByPrecision($unitPrecision) Return a format from H:i to H:i:s.u according to given unit precision.	2
string getTranslationMessageWith($translator, string $key, ?string $locale = null, ?string $default = null) Returns raw translation message for a given key.	2
\Symfony\Component\Translation\TranslatorInterface getTranslator() Get the default translator instance in use.	2
int getWeekEndsAt() Get the last day of week	2
int getWeekStartsAt() Get the first day of week	2
array getWeekendDays() Get weekend days	2
bool hasFormat($date, $format) Checks if the (date)time string is in a given format.	2
bool hasFormatWithModifiers($date, $format) Checks if the (date)time string is in a given format.	2
bool hasMacro($name) Checks if macro is registered globally.	2
bool hasRelativeKeywords($time) Determine if a time string will produce a relative date.	2
bool hasTestNow() Determine if there is a valid test instance set. A valid test instance	2
bool isImmutable() Returns true if the current class/instance is immutable.	2
bool isModifiableUnit($unit) Returns true if a property can be changed via setter.	2
bool isMutable() Returns true if the current class/instance is mutable.	2
bool isStrictModeEnabled() Returns true if the strict mode is globally in use, false else.	2
bool localeHasDiffOneDayWords($locale) Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow).	2
bool localeHasDiffSyntax($locale) Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after).	2
bool localeHasDiffTwoDayWords($locale) Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow).	2
bool localeHasPeriodSyntax($locale) Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X).	2
bool localeHasShortUnits($locale) Returns true if the given locale is internally supported and has short-units support.	2
void macro($name, $macro) Register a custom macro.	2
void mixin($mixin) Mix another object into the class.	2
string pluralUnit(string $unit) Returns standardized plural of a given singular/plural unit name (in English).	2
void resetMonthsOverflow() @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void resetToStringFormat() Reset the format used to the default when type juggling a Carbon instance to a string	2
void resetYearsOverflow() @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void serializeUsing($callback) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
bool setLocale($locale) Set the current translator locale and indicate if the source locale file exists.	2
void setMidDayAt($hour) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void setToStringFormat($format) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void setTranslator(TranslatorInterface $translator) Set the default translator instance to use.	2
void setWeekEndsAt($day) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void setWeekStartsAt($day) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void setWeekendDays($days) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
bool shouldOverflowMonths() Get the month overflow global behavior (can be overridden in specific instances).	2
bool shouldOverflowYears() Get the month overflow global behavior (can be overridden in specific instances).	2
string singularUnit(string $unit) Returns standardized singular of a given singular/plural unit name (in English).	2
string translateTimeString($timeString, $from = null, $to = null, $mode = CarbonInterface::TRANSLATE_ALL) Translate a time string from a locale to an other.	2
string translateWith(TranslatorInterface $translator, string $key, array $parameters = [], $number = null) Translate using translation string or callback available.	2
void useMonthsOverflow($monthsOverflow = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
void useYearsOverflow($yearsOverflow = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.	2
mixed withTestNow($testNow = null, $callback = null) Temporarily sets a static date to be used within the callback.	2
static mixed executeWithLocale($locale, $func)	2
static array getAvailableLocales()	2
static array getDays()	2
static int getHumanDiffOptions()	2
static array getIsoUnits()	2
static int getMidDayAt()	2
static \Symfony\Component\Translation\TranslatorInterface getTranslator()	2
static int getWeekEndsAt()	2
static int getWeekStartsAt()	2
static array getWeekendDays()	2
static bool hasFormat($date, $format)	2
static bool hasMacro($name)	2
static bool hasRelativeKeywords($time)	2
static bool hasTestNow()	2
static bool isImmutable()	2
static bool isModifiableUnit($unit)	2
static bool isStrictModeEnabled()	2
static bool localeHasDiffOneDayWords($locale)	2
static bool localeHasDiffSyntax($locale)	2
static bool localeHasDiffTwoDayWords($locale)	2
static bool localeHasPeriodSyntax($locale)	2
static bool localeHasShortUnits($locale)	2
static void macro($name, $macro)	2
static void mixin($mixin)	2
static string pluralUnit(string $unit)	2
static void resetMonthsOverflow()	2
static void resetToStringFormat()	2
static void resetYearsOverflow()	2
static void serializeUsing($callback)	2
static bool setLocale($locale)	2
static void setMidDayAt($hour)	2
static void setTestNow($testNow = null)	2
static void setToStringFormat($format)	2
static void setTranslator(\Symfony\Component\Translation\TranslatorInterface $translator)	2
static void setWeekEndsAt($day)	2
static void setWeekStartsAt($day)	2
static void setWeekendDays($days)	2
static bool shouldOverflowMonths()	2
static bool shouldOverflowYears()	2
static string singularUnit(string $unit)	2
static void useMonthsOverflow($monthsOverflow = true)	2
static void useYearsOverflow($yearsOverflow = true)	2
static void setLocale(string $locale)	2
static bool exists(string|array $key)	2
static bool has(string|array $key)	2
static void flush()	2
static bool delete(string|array $paths)	2
static bool exists(string $path)	2
static bool missing(string $path)	2
static int lastModified(string $path)	2
static int size(string $path)	2
static string|false mimeType(string $path)	2
static void macro(string $name, object|callable $macro)	2
static void listen(\Closure $callback)	2
bool isUtc() Check if the current instance has UTC timezone. (Both isUtc and isUTC cases are valid.)	2
bool isLocal() Check if the current instance has non-UTC timezone.	2
bool isValid() Check if the current instance is a valid date.	2
bool isDST() Check if the current instance is in a daylight saving time.	2
bool isSunday() Checks if the instance day is sunday.	2
bool isMonday() Checks if the instance day is monday.	2
bool isTuesday() Checks if the instance day is tuesday.	2
bool isWednesday() Checks if the instance day is wednesday.	2
bool isThursday() Checks if the instance day is thursday.	2
bool isFriday() Checks if the instance day is friday.	2
bool isSaturday() Checks if the instance day is saturday.	2
bool isSameYear(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentYear() Checks if the instance is in the same year as the current moment.	2
bool isNextYear() Checks if the instance is in the same year as the current moment next year.	2
bool isLastYear() Checks if the instance is in the same year as the current moment last year.	2
bool isSameWeek(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same week as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentWeek() Checks if the instance is in the same week as the current moment.	2
bool isNextWeek() Checks if the instance is in the same week as the current moment next week.	2
bool isLastWeek() Checks if the instance is in the same week as the current moment last week.	2
bool isSameDay(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentDay() Checks if the instance is in the same day as the current moment.	2
bool isNextDay() Checks if the instance is in the same day as the current moment next day.	2
bool isLastDay() Checks if the instance is in the same day as the current moment last day.	2
bool isSameHour(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same hour as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentHour() Checks if the instance is in the same hour as the current moment.	2
bool isNextHour() Checks if the instance is in the same hour as the current moment next hour.	2
bool isLastHour() Checks if the instance is in the same hour as the current moment last hour.	2
bool isSameMinute(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same minute as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentMinute() Checks if the instance is in the same minute as the current moment.	2
bool isNextMinute() Checks if the instance is in the same minute as the current moment next minute.	2
bool isLastMinute() Checks if the instance is in the same minute as the current moment last minute.	2
bool isSameSecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same second as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentSecond() Checks if the instance is in the same second as the current moment.	2
bool isNextSecond() Checks if the instance is in the same second as the current moment next second.	2
bool isLastSecond() Checks if the instance is in the same second as the current moment last second.	2
bool isSameMicro(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentMicro() Checks if the instance is in the same microsecond as the current moment.	2
bool isNextMicro() Checks if the instance is in the same microsecond as the current moment next microsecond.	2
bool isLastMicro() Checks if the instance is in the same microsecond as the current moment last microsecond.	2
bool isSameMicrosecond(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentMicrosecond() Checks if the instance is in the same microsecond as the current moment.	2
bool isNextMicrosecond() Checks if the instance is in the same microsecond as the current moment next microsecond.	2
bool isLastMicrosecond() Checks if the instance is in the same microsecond as the current moment last microsecond.	2
bool isCurrentMonth() Checks if the instance is in the same month as the current moment.	2
bool isNextMonth() Checks if the instance is in the same month as the current moment next month.	2
bool isLastMonth() Checks if the instance is in the same month as the current moment last month.	2
bool isCurrentQuarter() Checks if the instance is in the same quarter as the current moment.	2
bool isNextQuarter() Checks if the instance is in the same quarter as the current moment next quarter.	2
bool isLastQuarter() Checks if the instance is in the same quarter as the current moment last quarter.	2
bool isSameDecade(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same decade as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentDecade() Checks if the instance is in the same decade as the current moment.	2
bool isNextDecade() Checks if the instance is in the same decade as the current moment next decade.	2
bool isLastDecade() Checks if the instance is in the same decade as the current moment last decade.	2
bool isSameCentury(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same century as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentCentury() Checks if the instance is in the same century as the current moment.	2
bool isNextCentury() Checks if the instance is in the same century as the current moment next century.	2
bool isLastCentury() Checks if the instance is in the same century as the current moment last century.	2
bool isSameMillennium(Carbon|DateTimeInterface|string|null $date = null) Checks if the given date is in the same millennium as the instance. If null passed, compare to now (with the same timezone).	2
bool isCurrentMillennium() Checks if the instance is in the same millennium as the current moment.	2
bool isNextMillennium() Checks if the instance is in the same millennium as the current moment next millennium.	2
bool isLastMillennium() Checks if the instance is in the same millennium as the current moment last millennium.	2
CarbonInterface years(int $value) Set current instance year to the given value.	2
CarbonInterface year(int $value) Set current instance year to the given value.	2
CarbonInterface setYears(int $value) Set current instance year to the given value.	2
CarbonInterface setYear(int $value) Set current instance year to the given value.	2
CarbonInterface months(int $value) Set current instance month to the given value.	2
CarbonInterface month(int $value) Set current instance month to the given value.	2
CarbonInterface setMonths(int $value) Set current instance month to the given value.	2
CarbonInterface setMonth(int $value) Set current instance month to the given value.	2
CarbonInterface days(int $value) Set current instance day to the given value.	2
CarbonInterface day(int $value) Set current instance day to the given value.	2
CarbonInterface setDays(int $value) Set current instance day to the given value.	2
CarbonInterface setDay(int $value) Set current instance day to the given value.	2
CarbonInterface hours(int $value) Set current instance hour to the given value.	2
CarbonInterface hour(int $value) Set current instance hour to the given value.	2
CarbonInterface setHours(int $value) Set current instance hour to the given value.	2
CarbonInterface setHour(int $value) Set current instance hour to the given value.	2
CarbonInterface minutes(int $value) Set current instance minute to the given value.	2
CarbonInterface minute(int $value) Set current instance minute to the given value.	2
CarbonInterface setMinutes(int $value) Set current instance minute to the given value.	2
CarbonInterface setMinute(int $value) Set current instance minute to the given value.	2
CarbonInterface seconds(int $value) Set current instance second to the given value.	2
CarbonInterface second(int $value) Set current instance second to the given value.	2
CarbonInterface setSeconds(int $value) Set current instance second to the given value.	2
CarbonInterface setSecond(int $value) Set current instance second to the given value.	2
CarbonInterface millis(int $value) Set current instance millisecond to the given value.	2
CarbonInterface milli(int $value) Set current instance millisecond to the given value.	2
CarbonInterface setMillis(int $value) Set current instance millisecond to the given value.	2
CarbonInterface setMilli(int $value) Set current instance millisecond to the given value.	2
CarbonInterface milliseconds(int $value) Set current instance millisecond to the given value.	2
CarbonInterface millisecond(int $value) Set current instance millisecond to the given value.	2
CarbonInterface setMilliseconds(int $value) Set current instance millisecond to the given value.	2
CarbonInterface setMillisecond(int $value) Set current instance millisecond to the given value.	2
CarbonInterface micros(int $value) Set current instance microsecond to the given value.	2
CarbonInterface micro(int $value) Set current instance microsecond to the given value.	2
CarbonInterface setMicros(int $value) Set current instance microsecond to the given value.	2
CarbonInterface setMicro(int $value) Set current instance microsecond to the given value.	2
CarbonInterface microseconds(int $value) Set current instance microsecond to the given value.	2
CarbonInterface microsecond(int $value) Set current instance microsecond to the given value.	2
CarbonInterface setMicroseconds(int $value) Set current instance microsecond to the given value.	2
CarbonInterface setMicrosecond(int $value) Set current instance microsecond to the given value.	2
CarbonInterface addYears(int $value = 1) Add years (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addYear() Add one year to the instance (using date interval).	2
CarbonInterface subYears(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subYear() Sub one year to the instance (using date interval).	2
CarbonInterface addYearsWithOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addYearWithOverflow() Add one year to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subYearsWithOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subYearWithOverflow() Sub one year to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addYearsWithoutOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addYearWithoutOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearsWithoutOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearWithoutOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addYearsWithNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addYearWithNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearsWithNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearWithNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addYearsNoOverflow(int $value = 1) Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addYearNoOverflow() Add one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearsNoOverflow(int $value = 1) Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subYearNoOverflow() Sub one year to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonths(int $value = 1) Add months (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMonth() Add one month to the instance (using date interval).	2
CarbonInterface subMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMonth() Sub one month to the instance (using date interval).	2
CarbonInterface addMonthsWithOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addMonthWithOverflow() Add one month to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subMonthsWithOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subMonthWithOverflow() Sub one month to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addMonthsWithoutOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonthWithoutOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthsWithoutOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthWithoutOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonthsWithNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonthWithNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthsWithNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthWithNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonthsNoOverflow(int $value = 1) Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMonthNoOverflow() Add one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthsNoOverflow(int $value = 1) Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMonthNoOverflow() Sub one month to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDays(int $value = 1) Add days (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addDay() Add one day to the instance (using date interval).	2
CarbonInterface subDays(int $value = 1) Sub days (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subDay() Sub one day to the instance (using date interval).	2
CarbonInterface addHours(int $value = 1) Add hours (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addHour() Add one hour to the instance (using date interval).	2
CarbonInterface subHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subHour() Sub one hour to the instance (using date interval).	2
CarbonInterface addMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMinute() Add one minute to the instance (using date interval).	2
CarbonInterface subMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMinute() Sub one minute to the instance (using date interval).	2
CarbonInterface addSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addSecond() Add one second to the instance (using date interval).	2
CarbonInterface subSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subSecond() Sub one second to the instance (using date interval).	2
CarbonInterface addMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMilli() Add one millisecond to the instance (using date interval).	2
CarbonInterface subMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMilli() Sub one millisecond to the instance (using date interval).	2
CarbonInterface addMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMillisecond() Add one millisecond to the instance (using date interval).	2
CarbonInterface subMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMillisecond() Sub one millisecond to the instance (using date interval).	2
CarbonInterface addMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMicro() Add one microsecond to the instance (using date interval).	2
CarbonInterface subMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMicro() Sub one microsecond to the instance (using date interval).	2
CarbonInterface addMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMicrosecond() Add one microsecond to the instance (using date interval).	2
CarbonInterface subMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMicrosecond() Sub one microsecond to the instance (using date interval).	2
CarbonInterface addMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addMillennium() Add one millennium to the instance (using date interval).	2
CarbonInterface subMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subMillennium() Sub one millennium to the instance (using date interval).	2
CarbonInterface addMillenniaWithOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addMillenniumWithOverflow() Add one millennium to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subMillenniaWithOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subMillenniumWithOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addMillenniaWithoutOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMillenniumWithoutOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniaWithoutOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniumWithoutOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMillenniaWithNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMillenniumWithNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniaWithNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniumWithNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMillenniaNoOverflow(int $value = 1) Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addMillenniumNoOverflow() Add one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniaNoOverflow(int $value = 1) Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subMillenniumNoOverflow() Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addCentury() Add one century to the instance (using date interval).	2
CarbonInterface subCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subCentury() Sub one century to the instance (using date interval).	2
CarbonInterface addCenturiesWithOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addCenturyWithOverflow() Add one century to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subCenturiesWithOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subCenturyWithOverflow() Sub one century to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addCenturiesWithoutOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturyWithoutOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturiesWithoutOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturyWithoutOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturiesWithNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturyWithNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturiesWithNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturyWithNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturiesNoOverflow(int $value = 1) Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addCenturyNoOverflow() Add one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturiesNoOverflow(int $value = 1) Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subCenturyNoOverflow() Sub one century to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addDecade() Add one decade to the instance (using date interval).	2
CarbonInterface subDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subDecade() Sub one decade to the instance (using date interval).	2
CarbonInterface addDecadesWithOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addDecadeWithOverflow() Add one decade to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subDecadesWithOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subDecadeWithOverflow() Sub one decade to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addDecadesWithoutOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecadeWithoutOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadesWithoutOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadeWithoutOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecadesWithNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecadeWithNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadesWithNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadeWithNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecadesNoOverflow(int $value = 1) Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addDecadeNoOverflow() Add one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadesNoOverflow(int $value = 1) Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subDecadeNoOverflow() Sub one decade to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addQuarter() Add one quarter to the instance (using date interval).	2
CarbonInterface subQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subQuarter() Sub one quarter to the instance (using date interval).	2
CarbonInterface addQuartersWithOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addQuarterWithOverflow() Add one quarter to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subQuartersWithOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface subQuarterWithOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly allowed.	2
CarbonInterface addQuartersWithoutOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuarterWithoutOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuartersWithoutOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuarterWithoutOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuartersWithNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuarterWithNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuartersWithNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuarterWithNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuartersNoOverflow(int $value = 1) Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addQuarterNoOverflow() Add one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuartersNoOverflow(int $value = 1) Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface subQuarterNoOverflow() Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.	2
CarbonInterface addWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addWeek() Add one week to the instance (using date interval).	2
CarbonInterface subWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subWeek() Sub one week to the instance (using date interval).	2
CarbonInterface addWeekdays(int $value = 1) Add weekdays (the $value count passed in) to the instance (using date interval).	2
CarbonInterface addWeekday() Add one weekday to the instance (using date interval).	2
CarbonInterface subWeekdays(int $value = 1) Sub weekdays (the $value count passed in) to the instance (using date interval).	2
CarbonInterface subWeekday() Sub one weekday to the instance (using date interval).	2
CarbonInterface addRealMicros(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMicro() Add one microsecond to the instance (using timestamp).	2
CarbonInterface subRealMicros(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMicro() Sub one microsecond to the instance (using timestamp).	2
CarbonPeriod microsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	2
CarbonInterface addRealMicroseconds(int $value = 1) Add microseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMicrosecond() Add one microsecond to the instance (using timestamp).	2
CarbonInterface subRealMicroseconds(int $value = 1) Sub microseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMicrosecond() Sub one microsecond to the instance (using timestamp).	2
CarbonPeriod microsecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.	2
CarbonInterface addRealMillis(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMilli() Add one millisecond to the instance (using timestamp).	2
CarbonInterface subRealMillis(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMilli() Sub one millisecond to the instance (using timestamp).	2
CarbonPeriod millisUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	2
CarbonInterface addRealMilliseconds(int $value = 1) Add milliseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMillisecond() Add one millisecond to the instance (using timestamp).	2
CarbonInterface subRealMilliseconds(int $value = 1) Sub milliseconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMillisecond() Sub one millisecond to the instance (using timestamp).	2
CarbonPeriod millisecondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.	2
CarbonInterface addRealSeconds(int $value = 1) Add seconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealSecond() Add one second to the instance (using timestamp).	2
CarbonInterface subRealSeconds(int $value = 1) Sub seconds (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealSecond() Sub one second to the instance (using timestamp).	2
CarbonPeriod secondsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each second or every X seconds if a factor is given.	2
CarbonInterface addRealMinutes(int $value = 1) Add minutes (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMinute() Add one minute to the instance (using timestamp).	2
CarbonInterface subRealMinutes(int $value = 1) Sub minutes (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMinute() Sub one minute to the instance (using timestamp).	2
CarbonPeriod minutesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each minute or every X minutes if a factor is given.	2
CarbonInterface addRealHours(int $value = 1) Add hours (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealHour() Add one hour to the instance (using timestamp).	2
CarbonInterface subRealHours(int $value = 1) Sub hours (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealHour() Sub one hour to the instance (using timestamp).	2
CarbonPeriod hoursUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each hour or every X hours if a factor is given.	2
CarbonInterface addRealDays(int $value = 1) Add days (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealDay() Add one day to the instance (using timestamp).	2
CarbonInterface subRealDays(int $value = 1) Sub days (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealDay() Sub one day to the instance (using timestamp).	2
CarbonPeriod daysUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each day or every X days if a factor is given.	2
CarbonInterface addRealWeeks(int $value = 1) Add weeks (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealWeek() Add one week to the instance (using timestamp).	2
CarbonInterface subRealWeeks(int $value = 1) Sub weeks (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealWeek() Sub one week to the instance (using timestamp).	2
CarbonPeriod weeksUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each week or every X weeks if a factor is given.	2
CarbonInterface addRealMonths(int $value = 1) Add months (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMonth() Add one month to the instance (using timestamp).	2
CarbonInterface subRealMonths(int $value = 1) Sub months (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMonth() Sub one month to the instance (using timestamp).	2
CarbonPeriod monthsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each month or every X months if a factor is given.	2
CarbonInterface addRealQuarters(int $value = 1) Add quarters (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealQuarter() Add one quarter to the instance (using timestamp).	2
CarbonInterface subRealQuarters(int $value = 1) Sub quarters (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealQuarter() Sub one quarter to the instance (using timestamp).	2
CarbonPeriod quartersUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each quarter or every X quarters if a factor is given.	2
CarbonInterface addRealYears(int $value = 1) Add years (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealYear() Add one year to the instance (using timestamp).	2
CarbonInterface subRealYears(int $value = 1) Sub years (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealYear() Sub one year to the instance (using timestamp).	2
CarbonPeriod yearsUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each year or every X years if a factor is given.	2
CarbonInterface addRealDecades(int $value = 1) Add decades (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealDecade() Add one decade to the instance (using timestamp).	2
CarbonInterface subRealDecades(int $value = 1) Sub decades (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealDecade() Sub one decade to the instance (using timestamp).	2
CarbonPeriod decadesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each decade or every X decades if a factor is given.	2
CarbonInterface addRealCenturies(int $value = 1) Add centuries (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealCentury() Add one century to the instance (using timestamp).	2
CarbonInterface subRealCenturies(int $value = 1) Sub centuries (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealCentury() Sub one century to the instance (using timestamp).	2
CarbonPeriod centuriesUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each century or every X centuries if a factor is given.	2
CarbonInterface addRealMillennia(int $value = 1) Add millennia (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface addRealMillennium() Add one millennium to the instance (using timestamp).	2
CarbonInterface subRealMillennia(int $value = 1) Sub millennia (the $value count passed in) to the instance (using timestamp).	2
CarbonInterface subRealMillennium() Sub one millennium to the instance (using timestamp).	2
CarbonPeriod millenniaUntil($endDate = null, int $factor = 1) Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millennium or every X millennia if a factor is given.	2
CarbonInterface roundYear(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	2
CarbonInterface roundYears(float $precision = 1, string $function = "round") Round the current instance year with given precision using the given function.	2
CarbonInterface floorYear(float $precision = 1) Truncate the current instance year with given precision.	2
CarbonInterface floorYears(float $precision = 1) Truncate the current instance year with given precision.	2
CarbonInterface ceilYear(float $precision = 1) Ceil the current instance year with given precision.	2
CarbonInterface ceilYears(float $precision = 1) Ceil the current instance year with given precision.	2
CarbonInterface roundMonth(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	2
CarbonInterface roundMonths(float $precision = 1, string $function = "round") Round the current instance month with given precision using the given function.	2
CarbonInterface floorMonth(float $precision = 1) Truncate the current instance month with given precision.	2
CarbonInterface floorMonths(float $precision = 1) Truncate the current instance month with given precision.	2
CarbonInterface ceilMonth(float $precision = 1) Ceil the current instance month with given precision.	2
CarbonInterface ceilMonths(float $precision = 1) Ceil the current instance month with given precision.	2
CarbonInterface roundDay(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	2
CarbonInterface roundDays(float $precision = 1, string $function = "round") Round the current instance day with given precision using the given function.	2
CarbonInterface floorDay(float $precision = 1) Truncate the current instance day with given precision.	2
CarbonInterface floorDays(float $precision = 1) Truncate the current instance day with given precision.	2
CarbonInterface ceilDay(float $precision = 1) Ceil the current instance day with given precision.	2
CarbonInterface ceilDays(float $precision = 1) Ceil the current instance day with given precision.	2
CarbonInterface roundHour(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	2
CarbonInterface roundHours(float $precision = 1, string $function = "round") Round the current instance hour with given precision using the given function.	2
CarbonInterface floorHour(float $precision = 1) Truncate the current instance hour with given precision.	2
CarbonInterface floorHours(float $precision = 1) Truncate the current instance hour with given precision.	2
CarbonInterface ceilHour(float $precision = 1) Ceil the current instance hour with given precision.	2
CarbonInterface ceilHours(float $precision = 1) Ceil the current instance hour with given precision.	2
CarbonInterface roundMinute(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	2
CarbonInterface roundMinutes(float $precision = 1, string $function = "round") Round the current instance minute with given precision using the given function.	2
CarbonInterface floorMinute(float $precision = 1) Truncate the current instance minute with given precision.	2
CarbonInterface floorMinutes(float $precision = 1) Truncate the current instance minute with given precision.	2
CarbonInterface ceilMinute(float $precision = 1) Ceil the current instance minute with given precision.	2
CarbonInterface ceilMinutes(float $precision = 1) Ceil the current instance minute with given precision.	2
CarbonInterface roundSecond(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	2
CarbonInterface roundSeconds(float $precision = 1, string $function = "round") Round the current instance second with given precision using the given function.	2
CarbonInterface floorSecond(float $precision = 1) Truncate the current instance second with given precision.	2
CarbonInterface floorSeconds(float $precision = 1) Truncate the current instance second with given precision.	2
CarbonInterface ceilSecond(float $precision = 1) Ceil the current instance second with given precision.	2
CarbonInterface ceilSeconds(float $precision = 1) Ceil the current instance second with given precision.	2
CarbonInterface roundMillennium(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	2
CarbonInterface roundMillennia(float $precision = 1, string $function = "round") Round the current instance millennium with given precision using the given function.	2
CarbonInterface floorMillennium(float $precision = 1) Truncate the current instance millennium with given precision.	2
CarbonInterface floorMillennia(float $precision = 1) Truncate the current instance millennium with given precision.	2
CarbonInterface ceilMillennium(float $precision = 1) Ceil the current instance millennium with given precision.	2
CarbonInterface ceilMillennia(float $precision = 1) Ceil the current instance millennium with given precision.	2
CarbonInterface roundCentury(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	2
CarbonInterface roundCenturies(float $precision = 1, string $function = "round") Round the current instance century with given precision using the given function.	2
CarbonInterface floorCentury(float $precision = 1) Truncate the current instance century with given precision.	2
CarbonInterface floorCenturies(float $precision = 1) Truncate the current instance century with given precision.	2
CarbonInterface ceilCentury(float $precision = 1) Ceil the current instance century with given precision.	2
CarbonInterface ceilCenturies(float $precision = 1) Ceil the current instance century with given precision.	2
CarbonInterface roundDecade(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	2
CarbonInterface roundDecades(float $precision = 1, string $function = "round") Round the current instance decade with given precision using the given function.	2
CarbonInterface floorDecade(float $precision = 1) Truncate the current instance decade with given precision.	2
CarbonInterface floorDecades(float $precision = 1) Truncate the current instance decade with given precision.	2
CarbonInterface ceilDecade(float $precision = 1) Ceil the current instance decade with given precision.	2
CarbonInterface ceilDecades(float $precision = 1) Ceil the current instance decade with given precision.	2
CarbonInterface roundQuarter(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	2
CarbonInterface roundQuarters(float $precision = 1, string $function = "round") Round the current instance quarter with given precision using the given function.	2
CarbonInterface floorQuarter(float $precision = 1) Truncate the current instance quarter with given precision.	2
CarbonInterface floorQuarters(float $precision = 1) Truncate the current instance quarter with given precision.	2
CarbonInterface ceilQuarter(float $precision = 1) Ceil the current instance quarter with given precision.	2
CarbonInterface ceilQuarters(float $precision = 1) Ceil the current instance quarter with given precision.	2
CarbonInterface roundMillisecond(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	2
CarbonInterface roundMilliseconds(float $precision = 1, string $function = "round") Round the current instance millisecond with given precision using the given function.	2
CarbonInterface floorMillisecond(float $precision = 1) Truncate the current instance millisecond with given precision.	2
CarbonInterface floorMilliseconds(float $precision = 1) Truncate the current instance millisecond with given precision.	2
CarbonInterface ceilMillisecond(float $precision = 1) Ceil the current instance millisecond with given precision.	2
CarbonInterface ceilMilliseconds(float $precision = 1) Ceil the current instance millisecond with given precision.	2
CarbonInterface roundMicrosecond(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	2
CarbonInterface roundMicroseconds(float $precision = 1, string $function = "round") Round the current instance microsecond with given precision using the given function.	2
CarbonInterface floorMicrosecond(float $precision = 1) Truncate the current instance microsecond with given precision.	2
CarbonInterface floorMicroseconds(float $precision = 1) Truncate the current instance microsecond with given precision.	2
CarbonInterface ceilMicrosecond(float $precision = 1) Ceil the current instance microsecond with given precision.	2
CarbonInterface ceilMicroseconds(float $precision = 1) Ceil the current instance microsecond with given precision.	2
string shortAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string longAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Absolute' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string shortRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string longRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'Relative' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string shortRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string longRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToNow' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string shortRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (short format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
string longRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) Get the difference (long format, 'RelativeToOther' mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)	2
static void assertNothingSent()	3
static array all()	3
static string getLocale()	4
static copy()	4
@mixin	\Illuminate\Contracts\Support\MessageBag	1
	Client	1
	Query	1
	\Illuminate\Support\Collection	2
	\Illuminate\Support\Enumerable	2
	DeprecatedProperties	3
@mymodule	to search into directory "img" of module.	1
	if picto.png is stored into htdocs/mymodule/img	4
@note	This array should be removed in future, once previous constants are moved to the string value. Deprecated	1
	Move to const array when PHP 5.6 will be our minimum target	3
@override	*	1
	*/	1
	* @param Node $node Node to analyze	2
@package	Testmymodule	1
	Ticket	1
	geoPHP	1
	sfMapFishPlugin	1
	Webklex\IMAP	1
	DebugBar\Bridge\Twig	1
	Webklex\PHPIMAP\Traits	1
	Luracast\Restler\UI	2
	Webklex\PHPIMAP\Query	2
	PrestaShopWebservice	2
	Webklex\PHPIMAP\Support\Masks	3
	Webklex\PHPIMAP\Connection\Protocols	4
	Webklex\PHPIMAP\Support	5
	Luracast\Restler	6
	restler	6
	Mail_Mime	6
	Webklex\PHPIMAP	10
	Webklex\PHPIMAP\Events	11
	Webklex\PHPIMAP\Exceptions	17
	com.tecnick.tcpdf	22
	Restler	102
@param	$sessionname string Session name	1
string $text Text to show on logo	1
string $options More parameters on img tag	1
string $morecss More CSS	1
mixed $c data to check if countable	1
array $matches Array with a decimal numeric entity into key 0, value without the &# into the key 1	1
string $val Brute value found into $_GET, $_POST or PHP_SELF	1
string $type 0=POST, 1=GET, 2=PHP_SELF, 3=GET without sql reserved keywords (the less tolerant test)	1
string|array $var Variable name	1
int<0,2> $type 1=GET, 0=POST, 2=PHP_SELF	1
int<0,1> $stopcode 0=No stop code, 1=Stop code (default) if injection found	1
string $head Optional head lines	1
string $title HTML title	1
string $help_url Url links to help page	1
string $target Target to use on links	1
int $disablejs More content into html header	1
int $disablehead More content into html header	1
array|string $arrayofjs Array of complementary js files	1
array|string $arrayofcss Array of complementary css files	1
string $morecssonbody More CSS on body tag. For example 'classforhorizontalscrolloftabs'.	1
string $replacemainareaby Replace call to main_area() by a print of this string	1
int $disablenofollow Disable the "nofollow" on meta robot header	1
int $disablenoindex Disable the "noindex" on meta robot header	1
string $contenttype Content type. For example, 'text/html'	1
int<0,1> $forcenocache Force disabling of cache for the page	1
string $head Optional head lines	1
string $title HTML title	1
int<0,1> $disablejs Disable js output	1
int<0,1> $disablehead Disable head output	1
string[] $arrayofjs Array of complementary js files	1
string[] $arrayofcss Array of complementary css files	1
int<0,1> $disableforlogin Do not load heavy js and css for login pages	1
int<0,1> $disablenofollow Disable nofollow tag for meta robots	1
int<0,1> $disablenoindex Disable noindex tag for meta robots	1
string $head Lines in the HEAD	1
string $title Title of web page	1
string $target Target to use in menu links (Example: '' or '_top')	1
int<0,1> $disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax)	1
int<0,1> $disablehead Do not output head section	1
string[] $arrayofjs Array of js files to add in header	1
string[] $arrayofcss Array of css files to add in header	1
string $helppagename Name of wiki page for help ('' by default).	1
int<0,1> $hideloginname Hide login name. Show only the image.	1
string $urllogout URL for logout (Will use DOL_URL_ROOT.'/user/logout.php?token=...' if empty)	1
string $menu_array_before Table of menu entries to show before entries of menu handler. This param is deprecated and must be provided to ''.	1
string $helppagename Name of wiki page for help ('' by default).	1
string $notused Deprecated. Used in past to add content into left menu. Hooks can be used now.	1
array $menu_array_after Table of menu entries to show after entries of menu handler	1
int $leftmenuwithoutmainarea Must be set to 1. 0 by default for backward compatibility with old modules.	1
string $title Title of web page	1
int<0,1> $acceptdelayedhtml 1 if caller request to have html delayed content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect)	1
string $helppagename Page name ('EN:xxx,ES:eee,FR:fff,DE:ddd...' or 'http://localpage')	1
Translate $langs Language	1
string $urlaction Url post	1
string $urlobject Url of the link under the search box	1
string $title Title search area	1
string $htmlmorecss Add more css	1
string $htmlinputname Field Name input form	1
string $accesskey Accesskey	1
string $prefhtmlinputname Complement for id to avoid multiple same id in the page	1
string $img Image to use	1
int $showtitlebefore Show title before input text instead of into placeholder. This can be set when output is dedicated for text browsers.	1
int $autofocus Set autofocus on field	1
string $comment A text to add as HTML comment into HTML generated page	1
string $zone 'private' (for private pages) or 'public' (for public pages)	1
Workstation $object Workstation	1
MyObject $object MyObject	1
Target $object Target	1
Opensurveysondage $object Current viewing poll	1
string $numsondage Num survey	1
string $name Key to test	1
array $tableau Array in which searching key ($_POST by default)	1
string $id L'identifiant du sondage	1
bool $admin True pour générer une URL pour l'administration d'un sondage, False pour un URL publique	1
int $car Length of string to generate key	1
Holiday $holiday Object $holiday	1
int $user_id User id	1
int $id validator for current leave represented by (id)	1
int $cancreate flag for user right	1
int $now date	1
int $autoValidation boolean flag on autovalidation	1
string $class Class to load	1
array{time:int} $itemA Message A information	1
array{time:int} $itemB Message B information	1
mixed $v Feature information of a product.	1
array $val Array of val	1
string $typerecord Type of record ('payment', 'payment_supplier', 'payment_expensereport', 'payment_vat', ...)	1
string[] $fieldlist Array of fields	1
Object $obj If we show a particular record, obj is filled with record fields	1
string $tabname Name of SQL table	1
string $context 'add'=Output field for the "add form", 'edit'=Output field for the "edit form", 'hide'=Output field for the "add form" but we don't want it to be rendered	1
string $mainfile Full path name of main file to generate/update	1
string $main_dir Full path name to main.inc.php file	1
string $masterfile Full path name of master file to generate/update	1
string $main_dir Full path name to master.inc.php file	1
string $conffile Path to conf file to generate/update	1
Translate $langs Language	1
Conf $conf Conf	1
string $table Table name	1
string $fk_source Id of element source (name of field)	1
string $sourcetype Type of element source	1
string $fk_target Id of element target	1
string $targettype Type of element target	1
string $oldname Old name (relative to DOL_DATA_ROOT)	1
string $newname New name (relative to DOL_DATA_ROOT)	1
array $listofmodule List of modules, like array('MODULE_KEY_NAME'=>', $reloadmode)	1
int $force 1=Reload module even if not already loaded	1
string $mode 'export' or 'import'	1
string $program the script that was originally run	1
string $header the message to signal to the user	1
string $dolibarr_main_document_root Root directory of Dolibarr bin files	1
string $subtitle Title	1
string $next Next	1
string $action Action code ('set' or 'upgrade')	1
string $param Param	1
string $forcejqueryurl Set jquery relative URL (must end with / if defined)	1
string $csstable Css for table	1
integer $nonext 1=No button "Next step", 2=Show button but disabled with a link to enable	1
string $setuplang Language code	1
string $jscheckfunction Add a javascript check function	1
integer $withpleasewait Add also please wait tags	1
string $morehtml Add more HTML content	1
string $message Message	1
int $level Level of log	1
string $dolibarr_main_document_root Current main document root	1
string $force_install_databaserootlogin Login	1
string $force_install_databaserootpass Password	1
string $table Table of Element	1
string $sourcetype Source element type	1
string $targettype Target element type	1
string $barcode barcode	1
string $profid1 profid1	1
string $profid2 profid2	1
array $filterthirdparty Filter fields (key=>value to filer on. For example 'client'=>2, 'supplier'=>1, 'category'=>idcateg, 'name'=>'searchstring', ...)	1
array $invoice Invoice	1
string $id_order id of order to copy invoice from	1
string $ref_order ref of order to copy invoice from	1
string $ref_ext_order ref_ext of order to copy invoice from	1
array{id:string,ref:string,ref_ext:string,status?:string} $invoice Invoice	1
array $project Project info	1
int $idthirdparty Id of thirdparty	1
array $order Order info	1
int $id Id of order to validate	1
int $id_warehouse Id of warehouse to use for stock decrease	1
array{id:string,ref:string,refext:string} $order Order info	1
array $thirdpartywithuser Datas	1
array $shortuser Array of login/password info	1
array $authentication Array of authentication information	1
array{id:int,thirdparty_id:int|string,amount:float|string,num_payment:string,bank_account:int|string,payment_mode_id?:int|string,invoice_id?:int|string,int_label?:string,emitter:string,bank_source:string} $payment Payment	1
array $contact $contact	1
array $contact Contact	1
string $lang Lang to force	1
string $listofidstring List of id with comma	1
array $filterproduct Filter fields	1
int $id Category id	1
string $lang Force lang	1
string $authentication Authentication string	1
array $authentication Array with permissions	1
string $modulepart Properties of document	1
string $file Relative path	1
string $refname Ref of object to check permission for external users (autodetect if not provided)	1
BOM $object BillOfMaterials	1
string $mysqldate Date YYYMMDD	1
string $selectedDate Date YYYMMDD	1
int $month Month	1
string $command Command	1
string $text Text	1
string $text Text of error	1
string $resourceType Resource type	1
string $currentFolder Current folder	1
string $resourceType Resource type	1
string $currentFolder Current folder	1
string $currentFolder Current folder	1
string $CKEcallback Callback	1
string $sBasePath sBasePath	1
string $sFolder sFolder	1
string $resourceType Resource type	1
string $resourceType Resource type	1
string $sCommand Command	1
string $resourceType Resource type	1
string $folderPath Path	1
string $fileName Filename	1
string $folderPath Folder	1
string $folderPath Folder path	1
string $folderPath Folder - Folder to create (recursively)	1
?string $lastFolder Internal - Child Folder we are creating, prevents recursion	1
string $path given an url path return the physical directory that it corresponds to	1
string $sExtension File extension	1
string $sNewFolderName Folder	1
string $sNewFileName Folder	1
string $errorNumber errorNumber	1
string $fileUrl fileUrl	1
string $fileName fileName	1
string $customMsg customMsg	1
string $callback callback	1
string $sFileUrl sFileUrl	1
string $customMsg customMsg	1
string $charToRemove Char to remove	1
string $charToRemove Rhar to remove	1
string $string String	1
string $value Value	1
string $ext Extension	1
array $formExtensions Array of extensions	1
string $filePath absolute path to file	1
string $filePath Absolute path to file	1
string $extension File extension	1
string $url Url provided by zapier	1
string $json Data to send	1
string $type of field (duration, string..)	1
string $val the value to display	1
string $k Key	1
string $v Value	1
SimpleXMLElement $xml Xml	1
stdClass $a	1
stdClass $b	1
string $input String	1
int $line_max Max length of lines	1
string $parser 'parsedown' or 'nl2br'	1
string $parser 'dolibarr'	1
float $num Number to convert (must be a numeric value, like reported by price2num())	1
Translate $langs Language	1
string $currency ''=number to translate | 'XX'=currency code to use into text	1
boolean $centimes false=no cents/centimes | true=there is cents/centimes	1
Translate $langs Language	1
string $numorcurrency 'number' or 'amount'	1
integer $hundreds Hundreds	1
integer $tens Tens	1
integer $units Units	1
float $mens Value of this mensuality (interests include, set 0 if we don't paid interests for this mensuality)	1
float $capital Remaining capital for this mensuality	1
float $rate Loan rate	1
int $numactualloadterm Actual loan term	1
int $nbterm Total number of term for this loan	1
Establishment $object Object related to tabs	1
Don $object Donation	1
Adherent $object Member	1
AdherentType $object Member	1
Adherent $object Member or null	1
Subscription $object Subscription	1
string $file Filename	1
string $file Full path name of file	1
bool $url Image with url (true or false)	1
string $file Path of source file to resize/crop	1
int $mode 0=Resize, 1=Crop	1
int $newWidth Largeur maximum que dois faire l'image destination (0=keep ratio)	1
int $newHeight Hauteur maximum que dois faire l'image destination (0=keep ratio)	1
int $src_x Position of croping image in source image (not use if mode=0)	1
int $src_y Position of croping image in source image (not use if mode=0)	1
string $filetowrite Path of file to write (overwrite source file if not provided)	1
int $newquality Value for the new quality of image, for supported format (use 0 for maximum/unchanged).	1
string $file_path Full path to image to rotate	1
string $fileSource Full path to source image to rotate	1
string|bool $fileDest string : Full path to image to rotate | false return gd img | null the raw image stream will be outputted directly	1
int $quality output image quality	1
string $file Path of source file to resize	1
int $maxWidth Maximum width of the thumbnail (-1=unchanged, 160 by default)	1
int $maxHeight Maximum height of the thumbnail (-1=unchanged, 120 by default)	1
string $extName Extension to differentiate thumb file name ('_small', '_mini')	1
int $quality Quality of compression (0=worst, 100=best)	1
string $outdir Directory where to store thumb	1
int $targetformat New format of target (IMAGETYPE_GIF, IMAGETYPE_JPG, IMAGETYPE_PNG, IMAGETYPE_BMP, IMAGETYPE_WBMP ... or 0 to keep old format)	1
Object $object Object related to tabs	1
DoliDB $db Database handler	1
Translate $langs Object langs	1
Conf $conf Object conf	1
string $diroutputpdf Dir to output file	1
string $newlangid Lang id	1
array $filter Array with filters	1
integer $dateafterdate Invoice after date	1
integer $datebeforedate Invoice before date	1
integer $paymentdateafter Payment after date (must includes hour)	1
integer $paymentdatebefore Payment before date (must includes hour)	1
int $usestdout Add information onto standard output	1
int $regenerate ''=Use existing PDF files, 'nameofpdf'=Regenerate all PDF files using the template	1
string $filesuffix Suffix to add into file name of generated PDF	1
string $paymentbankid Only if payment on this bank account id	1
array $thirdpartiesid List of thirdparties id when using filter=excludethirdpartiesid or filter=onlythirdpartiesid	1
string $fileprefix Prefix to add into filename of generated PDF	1
User $object Object related to tabs	1
UserGroup $object Object group	1
boolean $foruserprofile Show for user profile view	1
Mailing $object Object related to tabs	1
Account $object Object related to tabs	1
string $num val to account statement	1
CommonObject $object Object related to tabs	1
?Account $account A bank account (used to get BIC/SWIFT)	1
?string $swift Swift value (used to get BIC/SWIFT, param $account non used if provided)	1
?Account $account A bank account	1
?string $ibantocheck Bank account number (used to get BAN, $account not used if provided)	1
Account $account A bank account	1
string $IentOfi IentOfi	1
string $InumCta InumCta	1
Asset $object Asset	1
AssetModel $object AssetModel	1
string $mode 'user' or 'group'	1
string $usertotest Login value to test	1
string $passwordtotest Password value to test	1
string $entitytotest Instance of data we must check	1
array $authmode Array list of selected authentication mode array('http', 'dolibarr', 'xxx'...)	1
string $context Context checkLoginPassEntity was created for ('api', 'dav', 'ws', '')	1
Translate $langs Lang object (must be initialized by a new).	1
Conf $conf Conf object	1
Societe $mysoc Company object	1
int $type 2 =>Return a salt for DES encryption	1
int $level Encode level: 0 no encoding, 1 encoding	1
boolean $generic true=Create generic password (32 chars/numbers), false=Use the configured password generation module	1
array $replaceambiguouschars Discard ambiguous characters. For example array('I').	1
int $length Length of random string (Used only if $generic is true)	1
string $htmlname HTML name of element to insert key into	1
string $htmlnameofbutton HTML name of button	1
int $generic 1=Return a generic pass, 0=Return a pass following setup rules	1
array $arrayofmesures Array of measures already filled	1
string $tablealias Alias of table ('t' for example)	1
array $arrayofxaxis Array of xaxis already filled	1
array $arrayofgroupby Array of groupby already filled	1
string $code Code	1
string $encoding Encoding ('EAN13', 'ISBN', 'C128', 'UPC', 'CBR', 'QRCODE', 'DATAMATRIX', 'ANY'...)	1
int<1,max> $scale Scale	1
string $mode 'png' or 'jpg' ...	1
string $ean Code	1
string $upc Code	1
string $text the text-line (:: ...)	1
string $bars where to place the bars (...)	1
int<1,max> $scale scale factor ( 1 < scale < unlimited (scale 50 will produce 5400x300 pixels when using EAN-13!!!))	1
string $mode png,gif,jpg (default='png')	1
int $total_y the total height of the image ( default: scale * 60 )	1
array{}|array{top:int,bottom:int,left:int,right:int} $space default: $space[top] = 2 * $scale; $space[bottom]= 2 * $scale; $space[left] = 2 * $scale; $space[right] = 2 * $scale;	1
string $ean Code	1
string $chain string to encode	1
int $length Length of random string	1
string $chain String to encode	1
string $key If '', we use $conf->file->instance_unique_id (so $dolibarr_main_instance_unique_id in conf.php)	1
string $ciphering Default ciphering algorithm	1
string $forceseed To force the seed	1
string $key If '', we use $conf->file->instance_unique_id	1
string $chain String to hash	1
string $type Type of hash ('0':auto will use MAIN_SECURITY_HASH_ALGO else md5, '1':sha1, '2':sha1+md5, '3':md5, '4': for OpenLdap, '5':sha256, '6':password_hash).	1
int $nosalt Do not include any salt	1
string $chain String to hash (not hashed string)	1
string $hash hash to compare	1
string $type Type of hash ('0':auto, '1':sha1, '2':sha1+md5, '3':md5, '4': for OpenLdap, '5':sha256). Use '3' here, if hash is not needed for security purpose, for security need, prefer '0'.	1
string $password Password to hash	1
string $type Type of hash	1
User $user User to check	1
string $features Features to check (it must be module name or $object->element. Can be a 'or' check with 'levela|levelb'.	1
int|string|Object $object Object or Object ID or list of Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).	1
string $tableandshare 'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity for multicompany module. Param not used if objectid is null (optional).	1
string $feature2 Feature to check, second level of permission (optional). Can be a 'or' check with 'sublevela|sublevelb'.	1
string $dbt_keyfield Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional). Can use '' if NA.	1
string $dbt_select Field rowid name, for select into tableandshare if not "rowid". Not used if objectid is null (optional)	1
int $isdraft 1=The object with id=$objectid is a draft	1
int $mode Mode (0=default, 1=return without dying)	1
User $user User to check	1
array $featuresarray Features/modules to check. Example: ('user','service','member','project','task',...)	1
int|string|Object $object Full object or object ID or list of object id. For example if we want to check a particular record (optional) is linked to a owned thirdparty (optional).	1
string $tableandshare 'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity for multicompany modume. Param not used if objectid is null (optional).	1
array|string $feature2 Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.	1
string $dbt_keyfield Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional). Can use '' if NA.	1
string $dbt_select Field name for select if not rowid. Not used if objectid is null (optional).	1
string $parenttableforentity Parent table for entity. Example 'fk_website@website'	1
string $message Force error message	1
int $http_response_code HTTP response code	1
int $stringalreadysanitized 1 if string is already sanitized with HTML entities	1
string $message Force error message	1
int $printheader Show header before	1
int $printfooter Show footer after	1
int $showonlymessage Show only message parameter. Otherwise add more information.	1
array|null $params More parameters provided to hook	1
Facture $object Invoice object	1
string $mode Can be 'customers' or 'suppliers'	1
float $qty Quantity	1
float $pu Unit price (HT or TTC depending on price_base_type. TODO Add also mode 'INCT' when pu is price HT+VAT+LT1+LT2)	1
float $remise_percent_ligne Discount for line	1
float $txtva 0=do not apply VAT tax, VAT rate=apply (this is VAT rate only without text code, we don't need text code because we alreaydy have all tax info into $localtaxes_array)	1
float $uselocaltax1_rate 0=do not use localtax1, >0=apply and get value from localtaxes_array (or database if empty), -1=autodetect according to seller if we must apply, get value from localtaxes_array (or database if empty). Try to always use -1.	1
float $uselocaltax2_rate 0=do not use localtax2, >0=apply and get value from localtaxes_array (or database if empty), -1=autodetect according to seller if we must apply, get value from localtaxes_array (or database if empty). Try to always use -1.	1
float $remise_percent_global 0	1
string $price_base_type 'HT'=Unit price parameter $pu is HT, 'TTC'=Unit price parameter $pu is TTC (HT+VAT but not Localtax. TODO Add also mode 'INCT' when pu is price HT+VAT+LT1+LT2)	1
int $info_bits Miscellaneous information on line	1
int $type 0/1=Product/service	1
Societe|string $seller Thirdparty seller (we need $seller->country_id property). Provided only if seller is the supplier, otherwise $seller will be $mysoc.	1
array $localtaxes_array Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).	1
integer $progress Situation invoices progress (value from 0 to 100, 100 by default)	1
double $multicurrency_tx Currency rate (1 by default)	1
double $pu_devise Amount in currency	1
string $multicurrency_code Value of the foreign currency if multicurrency is used ('EUR', 'USD', ...). It will be used for rounding according to currency.	1
array $versionarray Tableau de version (vermajeur,vermineur,autre)	1
array $versionarray1 Array of version (vermajor,verminor,patch)	1
array $versionarray2 Array of version (vermajor,verminor,patch)	1
string $sqlfile Full path to sql file	1
int $silent 1=Do not output anything, 0=Output line for update page	1
int $entity Entity targeted for multicompany module	1
int $usesavepoint 1=Run a savepoint before each request and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).	1
string $handler Handler targeted for menu (replace __HANDLER__ with this value between quotes)	1
string $okerror Family of errors we accept ('default', 'none')	1
int $linelengthlimit Limit for length of each line (Use 0 if unknown, may be faster if defined)	1
int $nocommentremoval Do no try to remove comments (in such a case, we consider that each line is a request, so use also $linelengthlimit=0)	1
int $offsetforchartofaccount Offset to use to load chart of account table to update sql on the fly to add offset to rowid and account_parent value	1
int $colspan 2=Add a colspan=2 on td	1
int $onlysqltoimportwebsite Only sql requests used to import a website template are allowed	1
string $database Database (replace __DATABASE__ with this value)	1
string|int $name Name of constant or rowid of line	1
int $entity Multi company id, -1 for all entities	1
int $entity Multi company id	1
string $value Value of constant	1
string $type Type of constant. Deprecated, only strings are allowed for $value. Caller must json encode/decode to store other type of data.	1
int $visible Is constant visible in Setup->Other page (0 by default)	1
string $note Note on parameter	1
int $entity Multi company id (0 means all entities)	1
int $nbofactivatedmodules Number if activated modules	1
int $nboftotalmodules Nb of total modules	1
int $nbmodulesnotautoenabled Nb of modules not auto enabled that are activated	1
object $object Descriptor class	1
int $mysessionid To avoid to try to delete my own session	1
string $value Name of module to activate	1
int $withdeps Activate/Disable also all dependencies	1
int $noconfverification Remove verification of $conf variable for module	1
string $value Nom du module a desactiver	1
int $requiredby 1=Desactive aussi modules dependants	1
array $taborder Taborder	1
array $tabname Tabname	1
array $tablib Tablib	1
array $tabsql Tabsql	1
array $tabsqlsort Tabsqlsort	1
array $tabfield Tabfield	1
array $tabfieldvalue Tabfieldvalue	1
array $tabfieldinsert Tabfieldinsert	1
array $tabrowid Tabrowid	1
array $tabcond Tabcond	1
array $tabhelp Tabhelp	1
array $tabcomplete Tab complete (will replace all other in future). Key is table name.	1
string $country_code CountryCode	1
array $elementList elementList	1
array $tableau Array of constants array('key'=>array('type'=>type, 'label'=>label)	1
int<2,3> $strictw3c 0=Include form into table (deprecated), 1=Form is outside table to respect W3C (deprecated), 2=No form nor button at all, 3=No form nor button at all and each field has a unique name (form is output by caller, recommended) (typed as int<2,3> to highlight the deprecated values)	1
string $helptext Tooltip help to use for the column name of values	1
string $text Text to use for the column name of values	1
DolibarrModules[] $modules Array of all modules	1
string $label Model label	1
string $description Model description	1
string $butlabel Label	1
string $testlabel Label	1
string $dn Dn	1
string $objectclass Class	1
array $result Array to show. This array is already encoded into charset_output	1
int $level Level	1
int $count Count	1
string $var Var	1
int $hide Hide	1
int $subcount Subcount	1
Commande $object Object related to tabs	1
string $format "vcal" or "ical"	1
string $title Title of export	1
string $desc Description of export	1
array $events_array Array of events ("uid","startdate","duration","enddate","title","summary","category","email","url","desc","author")	1
string $outputfile Output file	1
string $format "rss"	1
string $title Title of export	1
string $desc Description of export	1
array $events_array Array of events ("uid","startdate","summary","url","desc","author","category","image") or Array of WebsitePage	1
string $outputfile Output file	1
string $filter (optional) Filter	1
string $url Url (If empty, forge URL for agenda RSS export)	1
string $langcode Language code to show in header	1
string $format "vcal" or "ical"	1
string $string String to encode	1
string $line String to convert	1
string $str String to convert	1
int $forcal (optional) 1 = For cal	1
string $str String to convert	1
Form $form Form object	1
int $canedit Can edit filter fields	1
int $status Status	1
int $year Year	1
int $month Month	1
int $day Day	1
int $showbirthday Show birthday	1
string $filtera Filter on create by user	1
string $filtert Filter on assigned to user	1
string $filtered Filter of done by user	1
int $pid Product id	1
int $socid Third party id	1
string $action Action string	1
array $showextcals Array with list of external calendars (used to show links to select calendar), or -1 to show no legend	1
string|array $actioncode Preselected value(s) of actioncode for filter on event type	1
int $usergroupid Id of group to filter on users	1
string $excludetype A type to exclude ('systemauto', 'system', '')	1
int $resourceid Preselected value of resource for filter on resource	1
int $search_categ_cus Tag id	1
string $param Parameters to add to url	1
string $name Name of template	1
Categorie $object Object related to tabs	1
string $type Type of category	1
Object $line Object of line	1
string $save_path Value of session.save_path into php.ini	1
string $session_name Session name (Example: 'DOLSESSID_xxxxxx')	1
string $sess_id Session ID	1
string $sess_id Session iDecodeStream	1
string $val Content of session	1
string $sess_id Session iDecodeStream	1
int $max_lifetime Max lifetime	1
Cronjob $object Object cron	1
Expedition $object Object related to tabs	1
string $url URL to call.	1
string $postorget 'POST', 'GET', 'HEAD', 'PUT', 'PUTALREADYFORMATED', 'POSTALREADYFORMATED', 'DELETE'	1
string $param Parameters of URL (x=value1&y=value2) or may be a formatted content with $postorget='PUTALREADYFORMATED'	1
integer $followlocation 0=Do not follow, 1=Follow location.	1
string[] $addheaders Array of string to add into header. Example: ('Accept: application/xrds+xml', ....)	1
string[] $allowedschemes List of schemes that are allowed ('http' + 'https' only by default)	1
int $localurl 0=Only external URL are possible, 1=Only local URL, 2=Both external and local URL are allowed.	1
int $ssl_verifypeer -1=Auto (no ssl check on dev, check on prod), 0=No ssl check, 1=Always ssl check	1
string $iptocheck IP to check	1
int $localurl 0=external url only, 1=internal url only	1
int $mode 0=return 'mydomain', 1=return 'mydomain.com', 2=return 'abc.mydomain.com'	1
string $content Text content	1
Reception $object Object related to tabs	1
array $fulltree Array of entries in correct order	1
string $key Key of entry into fulltree to show picto	1
int $silent Do not output indent and picto, returns only value	1
array $tab Array of all elements	1
array $pere Array with parent ids ('rowid'=>,'mainmenu'=>,'leftmenu'=>,'fk_mainmenu'=>,'fk_leftmenu'=>)	1
int $rang Level of element	1
string $iddivjstree Id to use for parent ul element	1
int $donoresetalreadyloaded Do not reset global array $donoresetalreadyloaded used to avoid to go down on an already processed record	1
int $showfk 1=show fk_links to parent into label (used by menu editor only)	1
string $moreparam Add more param on url of elements	1
array $aCurrencies Currencies array	1
PaymentExpenseReport $object Current payment object	1
string $bvrb BVRB number	1
FactureFournisseur $object Object related to tabs	1
CommandeFournisseur $object Object related to tabs	1
string|int $str string to check	1
string $siren SIREN to check	1
string $siret SIRET to check	1
string $str NIF to check	1
string $str NN to check	1
string $ftp_server Server name	1
string $ftp_port Server port	1
string $ftp_user FTP user	1
string $ftp_password FTP password	1
string $section Directory	1
integer $ftp_passive Use a passive mode	1
string $dir Directory	1
string $localfile The local file path	1
string $file The remote file path	1
string $file File name	1
string $localfile The path to the local file	1
string $newdir Dir create	1
Dolresource $object Object	1
string $replacewith String to use as replacement	1
Website $website Web site object	1
int $removephppart 0=Replace PHP sections with a PHP badge. 1=Remove completely PHP sections.	1
string $contenttype Content type	1
int $containerid Contenair id	1
string $content Content string	1
string $contenttype Content type	1
int $containerid Contenair id	1
int $websiteid ID of website	1
string $websitepagetype Type of page ('blogpost', 'page', ...)	1
int $websitepageid ID of page	1
string $content Content string	1
string $containerref Ref of container to redirect to (Example: 'mypage' or 'mypage.php').	1
string $containeraliasalt Ref of alternative aliases to redirect to.	1
int $containerid Id of container.	1
int $permanent 0=Use temporary redirect 302, 1=Use permanent redirect 301	1
array $parameters Array of parameters to append to the URL.	1
string $containerref Path to file to include (must be a page from website root. Example: 'mypage.php' means 'mywebsite/mypage.php')	1
string $type 'blogpost', 'product', 'software', 'organization', 'qa', ...	1
array $data Array of data parameters for structured data	1
array $params Array of parameters	1
Object $object Object	1
int $no Numero of image (if there is several images. 1st one by default)	1
string $type Type of container to search into (Example: '', 'page', 'blogpost', 'page,blogpost', ...)	1
string $algo Algorithm used for search (Example: 'meta' is searching into meta information like title and description, 'content', 'sitefiles', or any combination 'meta,content,sitefiles')	1
string $searchstring Search string	1
int $max Max number of answers	1
string $sortfield Sort Fields	1
string $sortorder Sort order ('DESC' or 'ASC')	1
string $langcode Language code ('' or 'en', 'fr', 'es', ...)	1
array $otherfilters Other filters	1
int $status 0 or 1, or -1 for both	1
Website $object Object website	1
WebsitePage $objectpage Object website page	1
string $urltograb URL to grab (example: http://www.nltechno.com/ or http://www.nltechno.com/dir1/ or http://www.nltechno.com/dir1/mapage1)	1
string $tmp Content to parse	1
string $action Var $action	1
int $modifylinks 0=Do not modify content, 1=Replace links with a link to viewimage	1
int $grabimages 0=Do not grab images, 1=Grab images	1
string $grabimagesinto 'root' or 'subpage'	1
string $source String to decode	1
string $subdir Sub directory (Example: '/mailings' will look for /core/modules/mailings/)	1
Translate|null $outputlangs Output lang to use to autodetect output format if setup not done	1
object $object Object to show	1
int $usetable Output into a table	1
string $email Email address (Ex: "toto@example.com", "John Do ")	1
string $trackingid Tracking id (Ex: thi123 for thirdparty with id 123)	1
string $mail Email address (Ex: "toto@example.com", "John Do ")	1
int $http 1: verify http is provided, 0: not verify http	1
int $pass 1: verify user and pass is provided, 0: not verify user and pass	1
int $port 1: verify port is provided, 0: not verify port	1
int $path 1: verify a path is provided "/" or "/..." or "/.../", 0: not verify path	1
int $query 1: verify query is provided, 0: not verify query	1
int $anchor 1: verify anchor is provided, 0: not verify anchor	1
Societe $company VAT number	1
integer $http 1 = keep both http:// and https://, 0: remove http:// but not https://	1
string $mail Email	1
string $replace Replacement character (default: *)	1
int $nbreplace Number of replacement character (default: 8)	1
int $nbdisplaymail Number of character unchanged (default: 4)	1
int $nbdisplaydomain Number of character unchanged of domain (default: 3)	1
bool $displaytld Display tld (default: true)	1
array $data Array of data	1
string $troptions Options for tr	1
string $tdoptions Options for td	1
array $data Array of data	1
int $tableMarkup Table markup	1
string $tableoptions Options for table	1
string $troptions Options for tr	1
string $tdoptions Options for td	1
string $mask Mask to use. Must contains {0...0}. Can contains {t..}, {u...}, {user_extra_xxx}, .;.	1
string $table Table containing field with counter	1
string $field Field containing already used values of counter	1
string $where To add a filter on selection (for example to filter on invoice types)	1
Societe|string $objsoc The company that own the object we need a counter for	1
string $date Date to use for the {y},{m},{d} tags.	1
string $mode 'next' for next value or 'last' for last value	1
bool $bentityon Activate the entity filter. Default is true (for modules not compatible with multicompany)	1
User $objuser Object user we need data from.	1
int $forceentity Entity id to force	1
string $string String to test	1
string $start String Value for start	1
string $end String Value for end	1
string $mask Mask to use	1
string $bin Value to convert	1
boolean $pad Add 0	1
boolean $upper Convert to tupper	1
string $hexa Hexadecimal string to convert (example: 'FF')	1
string $time Date au format 'timestamp'	1
float $weight Masse a convertir	1
int $from_unit Unite originale en puissance de 10	1
int $to_unit Nouvelle unite en puissance de 10	1
DoliDB $db Handler database	1
Conf $conf Object conf	1
User $user Object user	1
array $tab Array (key=>value) with all parameters to save/update	1
int $reduction Reduction percentage	1
string $option Option string	1
DoliDB $db Database handler	1
string $type Type of models (company, invoice, ...)	1
int $maxfilenamelength Max length of value to show	1
string $ip IP Address	1
string $lastname Lastname	1
string $firstname Firstname	1
int $objectid Id of record	1
string $objecttype Type of object ('invoice', 'order', 'expedition_bon', 'myobject@mymodule', ...)	1
int $withpicto Picto to show	1
string $option More options	1
string $tabletocleantree Table to clean	1
string $fieldfkparent Field name that contains id of parent	1
array $arraycolor Array	1
string $colorifnotfound Color code to return if entry not defined or not a RGB format	1
array $colorifnotfound Color code array to return if entry not defined	1
string $color the color you need to valid	1
boolean $allow_white in case of white isn't valid	1
string $hex Color in hex ('#AA1122' or 'AA1122' or '#a12' or 'a12')	1
integer $ratio Default=-50. Note: 0=Component color is unchanged, -100=Component color become 88, +100=Component color become 00 or FF	1
integer $brightness Default=0. Adjust brightness. -100=Decrease brightness by 100%, +100=Increase of 100%.	1
string $hex Color in hex ('#AA1122' or 'AA1122' or '#a12' or 'a12')	1
integer $steps Step/offset added to each color component. It should be between -255 and 255. Negative = darker, positive = lighter	1
string $hex color in hex	1
float|false $alpha 0 to 1 to add alpha channel	1
string $hex Color in hex	1
float|false $alpha 0 to 1 to add alpha channel	1
array $input Array of products	1
string $moduleobject Module object name	1
int $min Between 0 and 255	1
int $max Between 0 and 255	1
int $min Between 0 and 255	1
int $max Between 0 and 255	1
string $notetoshow Text to convert	1
float $amount Amount to format	1
string $code PHP code to check.	1
string $string String to sanitize	1
string $text String to sanitize	1
int $allowedemoji Mode to allow emoji	1
string $invoice_number Invoice number to generate payment reference	1
int $statut Invoice status, if draft (0), no reference generating	1
string $use_rf false/(0) generate FI Bank payment reference	1
string $recipient_account Account number for pank payment	1
string $amount Amount of invoice payment	1
string $bank_reference FI Payment reference number or RF creditor reference	1
string $due_date Payments due to date	1
array{}|array{name:string,key:string,type:string,label:string,picot?:string,enabled:int<0,1>,notnull:int<0,1>,position:int,visible:int,noteditable?:int<0,1>,alwayseditable?:int<0,1>,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int<0,1>,css?:string,cssview?:string,csslist?:string,help?:string,showoncombobox?:int<0,1>,disabled?:int<0,1>,autofocusoncreate?:int<0,1>,arrayofkeyval?:array,validate?:int<0,1>,comment?:string} $addfieldentry Array of 1 field entry to add	1
string $delfieldentry Id of field to remove	1
Object $object If object was already loaded/known, it is pass to avoid another include and new.	1
string $moduletype 'external' or 'internal'	1
string $file Filename or path	1
int $number 0 = For Menus, 1 = For permissions, 2 = For Dictionaries	1
string $file file with path	1
int|string $a value 1	1
int|string $b value 2	1
string $file filename or path	1
array $permissions permissions existing in file	1
int|null $key key for permission needed	1
array{0:string,1:string}|null $right $right to update or add	1
string|null $objectname name of object	1
string|null $module name of module	1
int<-2,2> $action 0 for delete, 1 for add, 2 for update, -1 when delete object completely, -2 for generate rights after add	1
string $string The formatted properties string.	1
string $objectname name of the objectClass	1
string $destfile file where write table of properties	1
string $file file or path	1
string $objectname name of object wants to deleted	1
string $file file for searching	1
string $start start line if exist	1
string $end end line if exist	1
string $excludestart Ignore if start line is $excludestart	1
int $includese Include start and end line	1
string $destfile file where write table of permissions	1
string $srcfile Source file to use as example	1
string $file Path of modified file	1
string[] $objects Array of objects in the module	1
string $modulename Name of module	1
string $file File api module	1
string[] $objects Array of objects in the module	1
string $objectname Name of object want to remove	1
string $file path of filename	1
array $menus all menus for module	1
mixed|null $menuWantTo menu get for do actions	1
int|null $key key for the concerned menu	1
int<-1,2> $action for specify what action (0 = delete perm, 1 = add perm, 2 = update perm, -1 = when we delete object)	1
string $module The name of the module.	1
string $file The path to the module descriptor file.	1
array> $dicts The dictionary data to be updated.	1
bool|int|string $val	1
string $modulename The lowercase name of the module for which the dictionary table is being created.	1
string $file The file path to the Dolibarr module builder file where the dictionaries are defined.	1
string $namedic The name of the dictionary, which will also be used as the base for the table name.	1
array> $dictionnaires An optional array containing pre-existing dictionary data, including 'tabname', 'tablib', 'tabsql', etc.	1
string $file_api filename or path of api	1
string $file_doc filename or path of documentation	1
string $path path of directory	1
int $type type of file 1= file,2=directory	1
Contrat $object Object related to tabs	1
mixed $val Value to show	1
bool $assoc False return an object, true return an array	1
bool $assoc False return an object, true return an array. Try to always use it with true !	1
string $val Value to decode	1
string $utf16 UTF-16 character	1
string $utf8 UTF-8 character	1
string $refgmtdate Reference period for timezone (timezone differs on winter and summer. May be 'now', 'winter' or 'summer')	1
int $time Date timestamp (or string with format YYYY-MM-DD)	1
int $duration_value Value of delay to add	1
string $duration_unit Unit of added delay (d, m, y, w, h, i)	1
int $ruleforendofmonth Change the behavior of PHP over data-interval, 0 or 1	1
int $iHours Hours	1
int $iMinutes Minutes	1
int $iSeconds Seconds	1
int $iSecond Number of seconds	1
string $format Output format	1
int $lengthOfDay Length of day (default 86400 seconds for 1 day, 28800 for 8 hour)	1
int $lengthOfWeek Length of week (default 7)	1
int $duration_value Duration value	1
string $duration_unit Duration unit	1
string $datefield Name of SQL field where apply sql date filter	1
int|string $day_date Day date (Can be 0 or '' for filter on a month)	1
int|string $month_date Month date (Can be 0 or '' for filter on a year)	1
int|string $year_date Year date	1
int $excludefirstand Exclude first and	1
mixed $gm False or 0 or 'tzserver' = Input date fields are date info in the server TZ. True or 1 or 'gmt' = Input are date info in GMT TZ.	1
string $string Date in a string	1
int|string $gm 'gmt' or 1 =Input date is GM date,	1
int $year Year	1
int $day Day	1
int $month Month	1
int $year Year	1
int $day Day	1
int $month Month	1
bool|int|string $gm False or 0 or 'tzserver' = Return date to compare with server TZ,	1
int $year Year	1
int $timestampStart Timestamp start (UTC with hour, min, sec = 0)	1
int $timestampEnd Timestamp end (UTC with hour, min, sec = 0)	1
string $country_code Country code	1
int $lastday Last day is included, 0: no, 1:yes	1
int $includesaturday Include saturday as non working day (-1=use setup, 0=no, 1=yes)	1
int $includesunday Include sunday as non working day (-1=use setup, 0=no, 1=yes)	1
int $includefriday Include friday as non working day (-1=use setup, 0=no, 1=yes)	1
int $includemonday Include monday as non working day (-1=use setup, 0=no, 1=yes)	1
int $timestampStart Timestamp start UTC	1
int $timestampEnd Timestamp end UTC	1
int $lastday Last day is included, 0: no, 1:yes	1
int $timestampStart Timestamp for start date (date must be UTC to avoid calculation errors)	1
int $timestampEnd Timestamp for end date (date must be UTC to avoid calculation errors)	1
int $inhour 0: return number of days, 1: return number of hours	1
int $lastday We include last day, 0: no, 1:yes	1
int $halfday Tag to define half day when holiday start and end	1
string $country_code Country code (company country code if not defined)	1
int $short 0=Return long label, 1=Return short label	1
string[] $TWeek array of week numbers (week 1 must be '01')	1
string[] $TWeek array of week numbers	1
int $day Day number	1
string $selected Preselected value	1
string $htmlname HTML name of input field	1
string $url Ajax Url to call for request: /path/page.php. Must return a json array ('key'=>id, 'value'=>String shown into input field once selected, 'label'=>String shown into combo list)	1
string $urloption More parameters on URL request	1
int $autoselect Automatic selection if just one value (trigger("change") on field is done if search return only 1 result)	1
array $ajaxoptions Multiple options array	1
string $moreparams More params provided to ajax call	1
string $htmlname HTML name of input field	1
array $fields Array of key of fields to autocomplete	1
string $url URL for ajax request : /chemin/fichier.php	1
string $option More parameters on URL request	1
int $autoselect Automatic selection if just one value	1
string $title Title of dialog box	1
string $message Message of dialog box	1
int $w Width of dialog box	1
int $h height of dialog box	1
array $events More events option. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))	1
int $minLengthToAutocomplete Minimum length of input string to start autocomplete	1
int $forcefocus Force focus on field	1
string $widthTypeOfAutocomplete 'resolve' or 'off'	1
string $idforemptyvalue '-1'	1
string $morecss More css	1
array $events Add some Ajax events option on change of $htmlname component to call ajax to autofill a HTML element (select#htmlname and #inputautocompletehtmlname)	1
string $code Name of constant	1
array $input Array of complementary actions to do if success ("disabled"|"enabled'|'set'|'del') => CSS element to switch, 'alert' => message to show, ... Example: array('disabled'=>array(0=>'cssid'))	1
int|null $entity Entity. Current entity is used if null.	1
int $revertonoff 1=Revert on/off	1
int $strict Use only "disabled" with delConstant and "enabled" with setConstant	1
int $forcereload Force to reload page if we click/change value (this is supported only when there is no 'alert' option in input)	1
int $marginleftonlyshort 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No left margin.	1
int $forcenoajax 1 = Force to use a ahref link instead of ajax code.	1
int $setzeroinsteadofdel 1 = Set constantto '0' instead of deleting it	1
string $suffix Suffix to use on the name of the switch_on picto. Example: '', '_red'	1
string $mode Add parameter &mode= to the href link (Used for href link)	1
string $morecss More CSS	1
Object $object Object to set	1
string $code Name of property in object : 'status' or 'status_buy' for product by example	1
string $field Name of database field : 'tosell' or 'tobuy' for product by example	1
string $text_on Text if on ('Text' or 'Text:Picto on:Css picto on')	1
string $text_off Text if off ('Text' or 'Text:Picto off:Css picto off')	1
array $input Array of type->list of CSS element to switch. Example: array('disabled'=>array(0=>'cssid'))	1
string $htmlname Name of HTML component. Keep '' or use a different value if you need to use this component several time on the same page for the same field.	1
int $forcenojs Force the component to work as link post (without javascript) instead of ajax call	1
Societe $object Object company shown	1
Object $object Object for tabs	1
int|string $searchkey Id or code of country to search	1
string $withcode '0'=Return label,	1
DoliDB $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)	1
Translate $outputlangs Langs object for output translation	1
int $entconv 0=Return value without entities and not converted to output charset, 1=Ready for html output	1
string $searchlabel Label of country to search (warning: searching on label is not reliable)	1
int $id id of state (province/departement)	1
'0'|'1'|'2'|'all' $withcode '0'=Return label,	1
?DoliDB $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)	1
int<0,1> $withregion '0'=Ignores region,	1
Translate $outputlangs Langs object for output translation, not fully implemented yet	1
int<0,1> $entconv 0=Return value without entities and not converted to output charset, 1=Ready for html output	1
string $code_iso Code iso of currency	1
int $withcode '1'=show code + label	1
Translate $outputlangs Output language	1
string $code Code of juridical status	1
Object $object Object	1
Societe $object Third party object	1
int $showuserlogin 1=Show also user login if it exists	1
Conf $conf Object conf	1
Translate $langs Object langs	1
DoliDB $db Object db	1
Adherent|Societe $filterobj Object thirdparty or member	1
Contact $objcon Object contact	1
int $noprint Return string but does not output it	1
string|string[] $actioncode Filter on actioncode	1
Conf $conf Object conf	1
Translate $langs Object langs	1
DoliDB $db Object db	1
mixed $filterobj Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket... to list events linked to an object	1
Contact $objcon Filter on object contact to filter events on a contact	1
int $noprint Return string but does not output it	1
string|string[] $actioncode Filter on actioncode	1
string $donetodo Filter on event 'done' or 'todo' or ''=nofilter (all).	1
array $filters Filter on other fields	1
string $sortfield Sort field	1
string $sortorder Sort order	1
string $module You can add module name here if elementtype in table llx_actioncomm is objectkey@module	1
Societe $object Third party object	1
string $sqlANDOR "AND", "OR" or "" sql condition	1
string $donetodo donetodo	1
string $now now	1
array $filters array	1
Object $objcon objcon	1
Object $filterobj filterobj	1
int $addformmessage Add the payment form message	1
string $suffix Suffix to use on constants	1
Object $object Object related to payment	1
string $type Type of URL ('proposal', ...)	1
string $ref Ref of object	1
CommonObject $obj object (needed to make multicompany good links)	1
int $mode 0=True url, 1=Url formatted with colors	1
string $type Type of URL ('proposal', ...)	1
string $ref Ref of object	1
int $localorexternal 0=Url for browser, 1=Url for external access	1
CommonObject $obj object (needed to make multicompany good links)	1
string $param Params to add on url links	1
int $maxstep Limit steps to maxstep or no limit if 0	1
string $filemaster Full path of filename master.inc.php for website to generate	1
string $filealias Full path of filename to generate	1
string $filetpl Full path of filename to generate	1
int $backupold 1=Make a backup of old page	1
string $pathofwebsite Path of website root	1
string $fileindex Full path of file index.php	1
string $filetpl File tpl the index.php page redirect to (used only if $fileindex is provided)	1
string $filewrapper Full path of file wrapper.php	1
Website $object Object website	1
string $filehtmlheader Full path of filename to generate	1
string $htmlheadercontent Content of file	1
string $filecss Full path of filename to generate	1
string $csscontent Content of file	1
string $filejs Full path of filename to generate	1
string $jscontent Content of file	1
string $filerobot Full path of filename to generate	1
string $robotcontent Content of file	1
string $filehtaccess Full path of filename to generate	1
string $htaccess Content of file	1
Website $website Object website to load the template into	1
string $phpfullcodestringold PHP old string (before the change). For example ""	1
string $phpfullcodestring PHP new string. For example ""	1
string $pathfile String to find basename.	1
string $utf8_path Starting path from which to search. This is a full path.	1
string $types Can be "directories", "files", or "all"	1
int $recursive Determines whether subdirectories are searched	1
string $filter Regex filter to restrict list. This regex value must be escaped for '/' by doing preg_quote($var,'/'), since this char is used for preg_match function,	1
string|string[] $excludefilter Array of Regex for exclude filter (example: array('(\.meta|_preview.*\.png)$','^\.')). Exclude is checked both into fullpath and into basename (So '^xxx' may exclude 'xxx/dirscanned/...' and dirscanned/xxx').	1
string $sortcriteria Sort criteria ('','fullname','relativename','name','date','size')	1
int $sortorder Sort order (SORT_ASC, SORT_DESC)	1
int $mode 0=Return array minimum keys loaded (faster), 1=Force all keys like date and size to be loaded (slower), 2=Force load of date only, 3=Force load of size only, 4=Force load of perm	1
int $nohook Disable all hooks	1
string $relativename For recursive purpose only. Must be "" at first call.	1
int $donotfollowsymlinks Do not follow symbolic links	1
int $nbsecondsold Only files older than $nbsecondsold	1
string $path Starting path from which to search. Example: 'produit/MYPROD'	1
string $filter Regex filter to restrict list. This regex value must be escaped for '/', since this char is used for preg_match function	1
string[]|null $excludefilter Array of Regex for exclude filter (example: array('(\.meta|_preview.*\.png)$','^\.'))	1
string $sortcriteria Sort criteria ("","fullname","name","date","size")	1
int $sortorder Sort order (SORT_ASC, SORT_DESC)	1
int $mode 0=Return array minimum keys loaded (faster), 1=Force all keys like description	1
array $filearray Array of array('name'=>'xxx','fullname'=>'/abc/xxx','date'=>'yyy','size'=>99,'type'=>'dir|file',...) Array of files obtained using dol_dir_list	1
string $relativedir Relative dir from DOL_DATA_ROOT	1
object $a File 1	1
object $b File 2	1
string $folder Name of folder	1
string $dir Path of Directory	1
string $uri URI to test	1
string $folder Name of folder	1
string $srcfile Source file (can't be a directory)	1
array $arrayreplacement Array with strings to replace. Example: array('valuebefore'=>'valueafter', ...)	1
string $destfile Destination file (can't be a directory). If empty, will be same than source file.	1
string $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666'	1
int $indexdatabase 1=index new file into database.	1
int $arrayreplacementisregex 1=Array of replacement is already an array with key that is a regex. Warning: the key must be escaped with preg_quote for '/'	1
string $srcfile Source file (can't be a directory)	1
string $destfile Destination file (can't be a directory)	1
string $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666'	1
int $overwriteifexists Overwrite file if exists (1 by default)	1
string $srcfile Source file (a directory)	1
string $destfile Destination file (a directory)	1
string $newmask Mask for new file ('0' by default means getDolGlobalString('MAIN_UMASK')). Example: '0666'	1
int $overwriteifexists Overwrite file if exists (1 by default)	1
array $arrayreplacement Array to use to replace filenames with another one during the copy (works only on file names, not on directory names).	1
int $excludesubdir 0=Do not exclude subdirectories, 1=Exclude subdirectories, 2=Exclude subdirectories if name is not a 2 chars (used for country codes subdirectories).	1
string[] $excludefileext Exclude some file extensions	1
string $srcfile Source file (can't be a directory. use native php @rename() to move a directory)	1
string $destfile Destination file (can't be a directory. use native php @rename() to move a directory)	1
string $newmask Mask in octal string for new file ('0' by default means $conf->global->MAIN_UMASK)	1
int $overwriteifexists Overwrite file if exists (1 by default)	1
array $moreinfo Array with more information to set in index table	1
string $srcdir Source directory	1
string $destdir Destination directory	1
int $overwriteifexists Overwrite directory if exists (1 by default)	1
int $indexdatabase Index new name of files into database.	1
int $renamedircontent Also rename contents inside srcdir after the move to match new destination name.	1
string $filename Filename	1
string $src_file Source full path filename ($_FILES['field']['tmp_name'])	1
string $dest_file Target full path filename ($_FILES['field']['name'])	1
int $allowoverwrite 1=Overwrite target file if it already exists	1
int $disablevirusscan 1=Disable virus scan	1
integer $uploaderrorcode Value of PHP upload error code ($_FILES['field']['error'])	1
int $nohook Disable all hooks	1
string $varfiles _FILES var name	1
string $upload_dir For information. Already included into $dest_file.	1
string $file File to delete or mask of files to delete	1
int $disableglob Disable usage of glob like * so function is an exact delete function that will return error if no file found	1
int $nohook Disable all hooks	1
object|null $object Current object in use	1
boolean $allowdotdot Allow to delete file path with .. inside. Never use this, it is reserved for migration purpose.	1
int $nolog Disable log file	1
string $dir Directory to delete	1
string $dir Dir to delete	1
int $count Counter to count nb of elements found to delete	1
int $onlysub Delete only files and subdir, not main directory	1
int $countdeleted Counter to count nb of elements found really deleted	1
int $nolog Disable log files (too verbose when making recursive directories)	1
object $object Object to clean	1
string $pathtoscan Path to scan	1
string $upload_dir Directory where to store uploaded file (note: used to forge $destpath = $upload_dir + filename)	1
int $allowoverwrite 1=Allow overwrite existing file	1
int $updatesessionordb 1=Do no edit _SESSION variable but update database index. 0=Update _SESSION and not database index. -1=Do not update SESSION neither db.	1
string $varfiles _FILES var name	1
string $savingdocmask Mask to use to define output filename. For example 'XXXXX-__YYYYMMDD__-__file__'	1
string $link Link to add (to add a link instead of a file)	1
int $generatethumbs 1=Generate also thumbs for uploaded image files	1
Object $object Object used to set 'src_object_*' fields	1
int $filenb File nb to delete	1
int $donotupdatesession -1 or 1 = Do not update _SESSION variable	1
int $donotdeletefile 1=Do not delete physically file	1
string $file File name (May end with '.noexe')	1
string $fullpathorig Full path of origin for file (can be '')	1
int $setsharekey Set also the share key	1
Object $object Object used to set 'src_object_*' fields	1
string $file File name	1
string $fileinput Input file name	1
string $ext Format of target file (It is also extension added to file if fileoutput is not provided).	1
string $fileoutput Output filename	1
string $page Page number if we convert a PDF into png	1
string $inputfile Source file name	1
string $outputfile Target file name	1
string $mode 'gz' or 'bz' or 'zip'	1
string $errorstring Error string	1
string $inputfile File to uncompress	1
string $outputdir Target dir name	1
string $inputdir Source dir name	1
string $outputfile Target file name (output directory must exists and be writable)	1
string $mode 'zip'	1
string $excludefiles A regex pattern to exclude files. For example: '/\.log$|\/temp\//'	1
string $rootdirinzip Add a root dir level in zip file	1
string $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666'	1
string $dir Directory to scan	1
string $regexfilter Regex filter to restrict list. This regex value must be escaped for '/', since this char is used for preg_match function	1
string[] $excludefilter Array of Regex for exclude filter (example: array('(\.meta|_preview.*\.png)$','^\.')). This regex value must be escaped for '/', since this char is used for preg_match function	1
int<0,1> $nohook Disable all hooks	1
int<0,3> $mode 0=Return array minimum keys loaded (faster), 1=Force all keys like date and size to be loaded (slower), 2=Force load of date only, 3=Force load of size only	1
string $modulepart Module of document ('module', 'module_user_temp', 'module_user' or 'module_temp'). Example: 'medias', 'invoice', 'logs', 'tax-vat', ...	1
string $original_file Relative path with filename, relative to modulepart.	1
string $entity Restrict onto entity (0=no restriction)	1
User|null $fuser User object (forced)	1
string $refname Ref of object to check permission for external users (autodetect if not provided by taking the dirname of $original_file) or for hierarchy	1
string $mode Check permission for 'read' or 'write'	1
string $directory Directory of cache	1
string $filename Name of filecache	1
mixed $object Object to store in cachefile	1
int $cachetime Cachetime delay	1
string $pathfile Full path of a file	1
array $file_list Array for response	1
SimpleXMLElement $dir SimpleXMLElement of files to test	1
string $path Path of files relative to $pathref. We start with ''. Used by recursive calls.	1
string $pathref Path ref (DOL_DOCUMENT_ROOT)	1
array $checksumconcat Array of checksum	1
string $htmlname The id of the component where we need to drag and drop	1
string $filetpl Full path of the source filename for the backups. Example /mydir/mydocuments/mymodule/filename.ext	1
int $max_versions The maximum number of backup versions to keep.	1
string $archivedir Target directory of backups (without ending /). Keep empty to save into the same directory than source file.	1
string $suffix 'v' (versioned files) or 'd' (archived files after deletion)	1
string $moveorcopy 'move' or 'copy'	1
string $mode 'output' or 'temp' or 'version'	1
string $key key to return value, return $default if not set	1
string $key key to return value, return 0 if not set	1
int $default value to return	1
string $key key to return value, return '' if not set	1
User $tmpuser To get another user than current user	1
string $key key to return value, return 0 if not set	1
int $default value to return	1
User $tmpuser To get another user than current user	1
string $module Module name to check	1
int|string|null $timestamp timestamp to check	1
string $type Type of database (mysql, pgsql...)	1
string $user Authorized username	1
string $element Current element	1
int<0,1> $shared 0=Return id of current entity only,	1
?CommonObject $currentobject Current object if needed	1
CommonObject $currentobject Current object	1
string $keyname Name of key to test	1
int|string $n Numeric value	1
string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable	1
string $paramname Name or parameter to test	1
string $paramname Name or parameter to test	1
int<0,3> $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)	1
string $paramname Name of parameter to found	1
string $check Type of check	1
int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)	1
?int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)	1
mixed $options Options to pass to filter_var when $check is set to 'custom'	1
int $noreplace Force disable of replacement of __xxx__ strings.	1
string $paramname Name of the $_GET or $_POST parameter	1
int<0,3> $method Type of method (0 = $_GET then $_POST, 1 = only $_GET, 2 = only $_POST, 3 = $_POST then $_GET)	1
string $paramname Name of the $_GET or $_POST parameter	1
string|int $rounding Type of rounding ('', 'MU', 'MT, 'MS', 'CU', 'CT', integer) {@see price2num()}	1
string|array $out Value to check/clear.	1
string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...)	1
string $classname Class name (deprecated)	1
string $path Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile	1
int $type 0=Used for a Filesystem path, 1=Used for an URL path (output relative), 2=Used for an URL path (output full path using same host that current url), 3=Used for an URL path (output full path using host defined into $dolibarr_main_url_root of conf file)	1
int $returnemptyifnotfound 0:If $type==0 and if file was not found into alternate dir, return default path into main dir (no test on it)	1
object $obj Object to get properties from	1
string[] $properties Optional list of properties to get.	1
T $object Object to clone	1
int $native 0=Full isolation method, 1=Native PHP method, 2=Full isolation method keeping only scalar and array properties (recommended)	1
int $size Size we want	1
string $type Type of optimizing:	1
string $newstr String to replace bad chars with.	1
string $newstr String to replace bad chars with	1
int $type 0=Accept all Url, 1=Clean external Url (keep only relative Url)	1
string $stringtoclean String to clean. Example 'abc@mycompany.com '	1
string $str String to clean	1
string $newstr String to replace forbidden chars with	1
array|string $badcharstoreplace Array of forbidden characters to replace. Use '' to keep default list.	1
array|string $badcharstoremove Array of forbidden characters to remove. Use '' to keep default list.	1
int $keepspaces 1=Do not treat space as a special char to replace or remove	1
string $str String to clean	1
int $removetabcrlf Remove also CR-LF	1
string $stringtoescape String to escape	1
int<0,3> $mode 0=Escape also ' and " into ', 1=Escape ' but not " for usage into 'string', 2=Escape " but not ' for usage into "string", 3=Escape ' and " with \	1
int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n.	1
int<1,2> $stringforquotes 2=String for doublequotes, 1=String for simple quotes	1
string $stringtoescape String to escape	1
int $keepb 1=Replace b tags with escaped value (except if in $noescapetags), 0=Remove them completely	1
int $keepn 1=Preserve \r\n strings, 0=Replace them with escaped value, -1=Remove them. Set to 1 when escaping for a .</td> <td>1</td> </tr> <tr> <td>string $noescapetags '' or 'common' or list of tags to not escape.</td> <td>1</td> </tr> <tr> <td>int $escapeonlyhtmltags 1=Escape only html tags, not the special chars like accents.</td> <td>1</td> </tr> <tr> <td>int $cleanalsojavascript Clean also javascript. @TODO switch this option to 1 by default.</td> <td>1</td> </tr> <tr> <td>string $message Line to log. ''=Show nothing</td> <td>1</td> </tr> <tr> <td>int $level Log level</td> <td>1</td> </tr> <tr> <td>int $ident 1=Increase ident of 1 (after log), -1=Decrease ident of 1 (before log)</td> <td>1</td> </tr> <tr> <td>string $suffixinfilename When output is a file, append this suffix into default log filename. Example '_stripe', '_mail'</td> <td>1</td> </tr> <tr> <td>string $restricttologhandler Force output of log only to this log handler</td> <td>1</td> </tr> <tr> <td>array|null $logcontext If defined, an array with extra information (can be used by some log handlers)</td> <td>1</td> </tr> <tr> <td>string $name Unique identifier for the dialog</td> <td>1</td> </tr> <tr> <td>string $label Title of the dialog</td> <td>1</td> </tr> <tr> <td>string $buttonstring Text for the button that opens the dialog</td> <td>1</td> </tr> <tr> <td>string $exportSiteName Name of the "submit" input for site export</td> <td>1</td> </tr> <tr> <td>string $overwriteGitUrl URL for the link that triggers the overwrite action in GIT</td> <td>1</td> </tr> <tr> <td>Website $website Website object</td> <td>1</td> </tr> <tr> <td>string $name A name for the html component</td> <td>1</td> </tr> <tr> <td>string $label Label shown in Popup title top bar</td> <td>1</td> </tr> <tr> <td>string $buttonstring button string (HTML text we can click on)</td> <td>1</td> </tr> <tr> <td>string $url Relative Url to open. For example '/project/card.php'</td> <td>1</td> </tr> <tr> <td>string $disabled Disabled text</td> <td>1</td> </tr> <tr> <td>string $jsonopen Some JS code to execute on click/open of popup</td> <td>1</td> </tr> <tr> <td>string $backtopagejsfields The back to page must be managed using javascript instead of a redirect.</td> <td>1</td> </tr> <tr> <td>string $accesskey A key to use shortcut</td> <td>1</td> </tr> <tr> <td>array<string,array<int<0,5>,string>> $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.</td> <td>1</td> </tr> <tr> <td>string $active Active tab name (document', 'info', 'ldap', ....)</td> <td>1</td> </tr> <tr> <td>int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no sepaaration under tab (to start a tab just after), -3=Add tab header but no footer separation</td> <td>1</td> </tr> <tr> <td>string $morecss More Css</td> <td>1</td> </tr> <tr> <td>array<int,array<int<0,5>,string>> $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.</td> <td>1</td> </tr> <tr> <td>string $active Active tab name</td> <td>1</td> </tr> <tr> <td>int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no separation under tab (to start a tab just after), -3=-2+'noborderbottom'</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS on the link <a></td> <td>1</td> </tr> <tr> <td>int $dragdropfile 0 (default) or 1. 1 enable a drop zone for file to be upload, 0 disable it</td> <td>1</td> </tr> <tr> <td>int<-1,1> $notab -1 or 0=Add tab footer, 1=no tab footer</td> <td>1</td> </tr> <tr> <td>int<-1,1> $notab -1 or 0=Add tab footer, 1=no tab footer</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object to show</td> <td>1</td> </tr> <tr> <td>string $paramid Name of parameter to use to name the id into the URL next/previous link</td> <td>1</td> </tr> <tr> <td>string $morehtml More html content to output just before the nav bar</td> <td>1</td> </tr> <tr> <td>int $shownav Show Condition (navigation is shown if value is 1)</td> <td>1</td> </tr> <tr> <td>string $fieldid Name of the field in DB to use to select next et previous (we make the select max and min on this field). Use 'none' for no prev/next search.</td> <td>1</td> </tr> <tr> <td>string $fieldref Name of the field (object->ref) to use to select next et previous</td> <td>1</td> </tr> <tr> <td>string $morehtmlref More html to show after the ref (see $morehtmlleft for before)</td> <td>1</td> </tr> <tr> <td>string $moreparam More param to add in nav link url.</td> <td>1</td> </tr> <tr> <td>int $nodbprefix Do not include DB prefix to forge table name</td> <td>1</td> </tr> <tr> <td>string $morehtmlleft More html code to show before the ref (see $morehtmlref for after)</td> <td>1</td> </tr> <tr> <td>string $morehtmlstatus More html code to show under navigation arrows</td> <td>1</td> </tr> <tr> <td>int $onlybanner Put this to 1, if the card will contains only a banner (this add css 'arearefnobottom' on div)</td> <td>1</td> </tr> <tr> <td>string $morehtmlright More html code to show before navigation arrows</td> <td>1</td> </tr> <tr> <td>string $langkey Translation key</td> <td>1</td> </tr> <tr> <td>string $fieldkey Key of the html select field the text refers to</td> <td>1</td> </tr> <tr> <td>int $fieldrequired 1=Field is mandatory</td> <td>1</td> </tr> <tr> <td>boolean $var false or true</td> <td>1</td> </tr> <tr> <td>string $moreclass More class to add</td> <td>1</td> </tr> <tr> <td>Object $object A company or contact object</td> <td>1</td> </tr> <tr> <td>int $withcountry 1=Add country into address string</td> <td>1</td> </tr> <tr> <td>string $sep Separator to use to separate info when building string</td> <td>1</td> </tr> <tr> <td>?Translate $outputlangs Object lang that contains language for text translation.</td> <td>1</td> </tr> <tr> <td>int $mode 0=Standard output, 1=Remove address</td> <td>1</td> </tr> <tr> <td>string $extralangcode User extralanguage $langcode as values for address, town</td> <td>1</td> </tr> <tr> <td>string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)</td> <td>1</td> </tr> <tr> <td>int|false $ts Timestamp (If is_gmt is true, timestamp is already includes timezone and daylight saving offset, if is_gmt is false, timestamp is a GMT timestamp and we must compensate with server PHP TZ)</td> <td>1</td> </tr> <tr> <td>bool $is_gmt See comment of timestamp parameter</td> <td>1</td> </tr> <tr> <td>int|string $time GM Timestamps date</td> <td>1</td> </tr> <tr> <td>string $format Output date format (tag of strftime function)</td> <td>1</td> </tr> <tr> <td>string|bool $tzoutput true or 'gmt' => string is for Greenwich location</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang that contains language for text translation.</td> <td>1</td> </tr> <tr> <td>boolean $encodetooutput false=no convert into output pagecode</td> <td>1</td> </tr> <tr> <td>int $timestamp Timestamp</td> <td>1</td> </tr> <tr> <td>boolean $fast Fast mode. deprecated.</td> <td>1</td> </tr> <tr> <td>string $forcetimezone '' to use the PHP server timezone. Or use a form like 'gmt', 'Europe/Paris' or '+0200' to force timezone.</td> <td>1</td> </tr> <tr> <td>int $hour Hour (can be -1 for undefined)</td> <td>1</td> </tr> <tr> <td>int $minute Minute (can be -1 for undefined)</td> <td>1</td> </tr> <tr> <td>int $second Second (can be -1 for undefined)</td> <td>1</td> </tr> <tr> <td>int $month Month (1 to 12)</td> <td>1</td> </tr> <tr> <td>int $day Day (1 to 31)</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>mixed $gm True or 1 or 'gmt'=Input information are GMT values</td> <td>1</td> </tr> <tr> <td>int $check 0=No check on parameters (Can use day 32, etc...)</td> <td>1</td> </tr> <tr> <td>string $mode 'auto' => for backward compatibility (avoid this),</td> <td>1</td> </tr> <tr> <td>int $size Size to print</td> <td>1</td> </tr> <tr> <td>int $shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)</td> <td>1</td> </tr> <tr> <td>int $shortunit Use short label of size unit (for example 'b' instead of 'bytes')</td> <td>1</td> </tr> <tr> <td>string $url Url to show</td> <td>1</td> </tr> <tr> <td>string $target Target for link</td> <td>1</td> </tr> <tr> <td>int $max Max number of characters to show</td> <td>1</td> </tr> <tr> <td>int $withpicto With picto</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $email EMail to show (only email, without 'Name of recipient' before)</td> <td>1</td> </tr> <tr> <td>int $cid Id of contact if known</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party if known</td> <td>1</td> </tr> <tr> <td>int $addlink 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on)</td> <td>1</td> </tr> <tr> <td>int $max Max number of characters to show</td> <td>1</td> </tr> <tr> <td>int $showinvalid 1=Show warning if syntax email is wrong</td> <td>1</td> </tr> <tr> <td>int|string $withpicto Show picto</td> <td>1</td> </tr> <tr> <td>string $value Social network ID to show (only skype, without 'Name of recipient' before)</td> <td>1</td> </tr> <tr> <td>int $cid Id of contact if known</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party if known</td> <td>1</td> </tr> <tr> <td>string $type 'skype','facebook',...</td> <td>1</td> </tr> <tr> <td>array<string,array{rowid:int,label:string,url:string,icon:string,active:int}> $dictsocialnetworks List of socialnetworks available</td> <td>1</td> </tr> <tr> <td>string $profID Value of profID to format</td> <td>1</td> </tr> <tr> <td>string $profIDtype Type of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')</td> <td>1</td> </tr> <tr> <td>string $countrycode Country code to use for formatting</td> <td>1</td> </tr> <tr> <td>int<0,2> $addcpButton Add button to copy to clipboard (1 => show only on hoover ; 2 => always display )</td> <td>1</td> </tr> <tr> <td>string $phone Phone number to format</td> <td>1</td> </tr> <tr> <td>string $countrycode Country code to use for formatting</td> <td>1</td> </tr> <tr> <td>int $cid Id of contact if known</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party if known</td> <td>1</td> </tr> <tr> <td>string $addlink ''=no link to create action, 'AC_TEL'=add link to clicktodial (if module enabled) and add link to create event (if conf->global->AGENDA_ADDACTIONFORPHONE set), 'tel'=Force "tel:..." link</td> <td>1</td> </tr> <tr> <td>string $separ Separation between numbers for a better visibility example : xx.xx.xx.xx.xx. You can also use 'hidenum' to hide the number, keep only the picto.</td> <td>1</td> </tr> <tr> <td>string $withpicto Show picto ('fax', 'phone', 'mobile')</td> <td>1</td> </tr> <tr> <td>string $titlealt Text to show on alt</td> <td>1</td> </tr> <tr> <td>int $adddivfloat Add div float around phone.</td> <td>1</td> </tr> <tr> <td>int $mode 0=return IP + country/flag, 1=return only country/flag, 2=return only IP</td> <td>1</td> </tr> <tr> <td>string $address Address string, already formatted with dol_format_address()</td> <td>1</td> </tr> <tr> <td>int $htmlid Html ID (for example 'gmap')</td> <td>1</td> </tr> <tr> <td>int $element 'thirdparty'|'contact'|'member'|'user'|'other'</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>int $noprint No output. Result is the function return</td> <td>1</td> </tr> <tr> <td>string $charfornl Char to use instead of nl2br. '' means we use a standad nl2br.</td> <td>1</td> </tr> <tr> <td>string $address email (Ex: "toto@example.com". Long form "John Do <johndo@example.com>" will be false)</td> <td>1</td> </tr> <tr> <td>int $acceptsupervisorkey If 1, the special string '__SUPERVISOREMAIL__' is also accepted as valid</td> <td>1</td> </tr> <tr> <td>int $acceptuserkey If 1, the special string '__USER_EMAIL__' is also accepted as valid</td> <td>1</td> </tr> <tr> <td>string $domain Domain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr")</td> <td>1</td> </tr> <tr> <td>string $phone phone (Ex: "0601010101")</td> <td>1</td> </tr> <tr> <td>string $s String to truncate</td> <td>1</td> </tr> <tr> <td>int $nbofchar Nb of characters to keep</td> <td>1</td> </tr> <tr> <td>string $string String to calculate length</td> <td>1</td> </tr> <tr> <td>string $stringencoding Encoding of string</td> <td>1</td> </tr> <tr> <td>string $string String to scan</td> <td>1</td> </tr> <tr> <td>int $start Start position (0 for first char)</td> <td>1</td> </tr> <tr> <td>int|null $length Length (in nb of characters or nb of bytes depending on trunconbytes param)</td> <td>1</td> </tr> <tr> <td>string $stringencoding Page code used for input string encoding</td> <td>1</td> </tr> <tr> <td>int $trunconbytes 1=Length is max of bytes instead of max of characters</td> <td>1</td> </tr> <tr> <td>string $string String to truncate</td> <td>1</td> </tr> <tr> <td>int $size Max string size visible (excluding …). 0 for no limit. WARNING: Final string size can have 3 more chars (if we added …, or if size was max+1 so it does not worse to replace with ...)</td> <td>1</td> </tr> <tr> <td>string $trunc Where to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'</td> <td>1</td> </tr> <tr> <td>string $stringencoding Tell what is source string encoding</td> <td>1</td> </tr> <tr> <td>int $nodot Truncation do not add … after truncation. So it's an exact truncation.</td> <td>1</td> </tr> <tr> <td>int $display Trunc is used to display data and can be changed for small screen. TODO Remove this param (must be dealt with CSS)</td> <td>1</td> </tr> <tr> <td>string $key Key</td> <td>1</td> </tr> <tr> <td>string $titlealt Text on title tag for tooltip. Not used if param notitle is set to 1.</td> <td>1</td> </tr> <tr> <td>string $picto Name of image file to show ('filenew', ...).</td> <td>1</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag (For example 'class="pictofixedwidth"')</td> <td>1</td> </tr> <tr> <td>int<0,1> $pictoisfullpath If true or 1, image path is a full path, 0 if not</td> <td>1</td> </tr> <tr> <td>int $srconly Return only content of the src attribute of img.</td> <td>1</td> </tr> <tr> <td>int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.</td> <td>1</td> </tr> <tr> <td>string $alt Force alt for bind people</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class css on img tag (For example 'myclascss').</td> <td>1</td> </tr> <tr> <td>int $marginleftonlyshort 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only.</td> <td>1</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>1</td> </tr> <tr> <td>string $picto Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...)</td> <td>1</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag (ie: class="datecallink")</td> <td>1</td> </tr> <tr> <td>int $pictoisfullpath If 1, image path is a full path</td> <td>1</td> </tr> <tr> <td>int $srconly Return only content of the src attribute of img.</td> <td>1</td> </tr> <tr> <td>int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.</td> <td>1</td> </tr> <tr> <td>string|int $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4).</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory.</td> <td>1</td> </tr> <tr> <td>int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.</td> <td>1</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>1</td> </tr> <tr> <td>string $numaction Action id or code to show</td> <td>1</td> </tr> <tr> <td>string $moreatt More attributes</td> <td>1</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>1</td> </tr> <tr> <td>int $size Taille de l'icone : 3 = 16x16px , 2 = 14x14px</td> <td>1</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>1</td> </tr> <tr> <td>string $other Add more attributes on img</td> <td>1</td> </tr> <tr> <td>int $usehelpcursor 1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor</td> <td>1</td> </tr> <tr> <td>int|string $usealttitle Text to use as alt title</td> <td>1</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute.</td> <td>1</td> </tr> <tr> <td>string $morecss Add more CSS</td> <td>1</td> </tr> <tr> <td>int $selected Selected</td> <td>1</td> </tr> <tr> <td>string $allow Allow</td> <td>1</td> </tr> <tr> <td>string $brand Brand name of credit card</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $text Text info</td> <td>1</td> </tr> <tr> <td>integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto</td> <td>1</td> </tr> <tr> <td>int $nodiv No div</td> <td>1</td> </tr> <tr> <td>string $admin '1'=Info for admin users. '0'=Info for standard users (change only the look), 'error', 'warning', 'xxx'=Other</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS ('', 'warning', 'error')</td> <td>1</td> </tr> <tr> <td>string $textfordropdown Show a text to click to dropdown the info box.</td> <td>1</td> </tr> <tr> <td>DoliDB|null $db Database handler</td> <td>1</td> </tr> <tr> <td>string|string[] $error String or array of errors strings to show</td> <td>1</td> </tr> <tr> <td>string[]|null $errors Array of errors</td> <td>1</td> </tr> <tr> <td>string $prefixcode Prefix of public error code</td> <td>1</td> </tr> <tr> <td>string $errormessage Complete error message</td> <td>1</td> </tr> <tr> <td>string[] $errormessages Array of error messages</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $email Email</td> <td>1</td> </tr> <tr> <td>string $name Label of field</td> <td>1</td> </tr> <tr> <td>string $file Url used when we click on sort picto</td> <td>1</td> </tr> <tr> <td>string $field Field to use for new sorting</td> <td>1</td> </tr> <tr> <td>string $begin ("" by default)</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters on sort url links ("" by default)</td> <td>1</td> </tr> <tr> <td>string $moreattrib Options of attribute td ("" by default)</td> <td>1</td> </tr> <tr> <td>string $sortfield Current field used to sort</td> <td>1</td> </tr> <tr> <td>string $sortorder Current sort order</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.</td> <td>1</td> </tr> <tr> <td>string $tooltip Tooltip</td> <td>1</td> </tr> <tr> <td>int $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style</td> <td>1</td> </tr> <tr> <td>string $name Translation key of field to show or complete HTML string to show</td> <td>1</td> </tr> <tr> <td>int $thead 0=To use with standard table format, 1=To use inside <thead><tr>, 2=To use with <div></td> <td>1</td> </tr> <tr> <td>string $file Url used when we click on sort picto</td> <td>1</td> </tr> <tr> <td>string $field Field to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def"</td> <td>1</td> </tr> <tr> <td>string $begin ("" by default)</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters on sort url links ("" by default)</td> <td>1</td> </tr> <tr> <td>string $moreattrib Add more attributes on th ("" by default). To add more css class, use param $prefix.</td> <td>1</td> </tr> <tr> <td>string $sortfield Current field used to sort (Ex: 'd.datep,d.id')</td> <td>1</td> </tr> <tr> <td>string $sortorder Current sort order (Ex: 'asc,desc')</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.</td> <td>1</td> </tr> <tr> <td>int $disablesortlink 1=Disable sort link</td> <td>1</td> </tr> <tr> <td>string $tooltip Tooltip</td> <td>1</td> </tr> <tr> <td>int $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style</td> <td>1</td> </tr> <tr> <td>string $title Title to show</td> <td>1</td> </tr> <tr> <td>string $title Title to show</td> <td>1</td> </tr> <tr> <td>string $mesg Added message to show on right</td> <td>1</td> </tr> <tr> <td>string $id To force an id on html objects by example id="name" where name is id</td> <td>1</td> </tr> <tr> <td>string $title Title to show (HTML sanitized content)</td> <td>1</td> </tr> <tr> <td>string $morehtmlright Added message to show on right</td> <td>1</td> </tr> <tr> <td>string $id To force an id on html objects</td> <td>1</td> </tr> <tr> <td>string $morecssontable More css on table</td> <td>1</td> </tr> <tr> <td>string $morehtmlcenter Added message to show on center</td> <td>1</td> </tr> <tr> <td>string $title Title to show (required)</td> <td>1</td> </tr> <tr> <td>int|null $page Numero of page to show in navigation links (required)</td> <td>1</td> </tr> <tr> <td>string $file Url of page (required)</td> <td>1</td> </tr> <tr> <td>string $options More parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function.</td> <td>1</td> </tr> <tr> <td>string $sortfield Field to sort on ('' by default)</td> <td>1</td> </tr> <tr> <td>string $sortorder Order to sort ('' by default)</td> <td>1</td> </tr> <tr> <td>string $morehtmlcenter String in the middle ('' by default). We often find here string $massaction coming from $form->selectMassAction()</td> <td>1</td> </tr> <tr> <td>int $num Number of records found by select with limit+1</td> <td>1</td> </tr> <tr> <td>int|string $totalnboflines Total number of records/lines for all pages (if known). Use a negative value of number to not show number. Use '' if unknown.</td> <td>1</td> </tr> <tr> <td>string $picto Icon to use before title (should be a 32x32 transparent png file)</td> <td>1</td> </tr> <tr> <td>int $pictoisfullpath 1=Icon name is a full absolute url of image</td> <td>1</td> </tr> <tr> <td>string $morehtmlright More html to show (after arrows)</td> <td>1</td> </tr> <tr> <td>string $morecss More css to the table</td> <td>1</td> </tr> <tr> <td>int $limit Max number of lines (-1 = use default, 0 = no limit, > 0 = limit).</td> <td>1</td> </tr> <tr> <td>int $hideselectlimit Force to hide select limit</td> <td>1</td> </tr> <tr> <td>int $hidenavigation Force to hide the arrows and page for navigation</td> <td>1</td> </tr> <tr> <td>int $pagenavastextinput 1=Do not suggest list of pages to navigate but suggest the page number into an input field.</td> <td>1</td> </tr> <tr> <td>string $morehtmlrightbeforearrow More html to show (before arrows)</td> <td>1</td> </tr> <tr> <td>int $page Number of page</td> <td>1</td> </tr> <tr> <td>string $file Page URL (in most cases provided with $_SERVER["PHP_SELF"])</td> <td>1</td> </tr> <tr> <td>string $options Other url parameters to propagate ("" by default, may include sortfield and sortorder)</td> <td>1</td> </tr> <tr> <td>integer $nextpage Do we show a next page button</td> <td>1</td> </tr> <tr> <td>string $betweenarrows HTML content to show between arrows. MUST contains '<li> </li>' tags or '<li><span> </span></li>'.</td> <td>1</td> </tr> <tr> <td>string $afterarrows HTML content to show after arrows. Must NOT contains '<li> </li>' tags.</td> <td>1</td> </tr> <tr> <td>int $limit Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)</td> <td>1</td> </tr> <tr> <td>int $totalnboflines Total number of records/lines for all pages (if known)</td> <td>1</td> </tr> <tr> <td>int $hideselectlimit Force to hide select limit</td> <td>1</td> </tr> <tr> <td>string $beforearrows HTML content to show before arrows. Must NOT contains '<li> </li>' tags.</td> <td>1</td> </tr> <tr> <td>int $hidenavigation Force to hide the switch mode view and the navigation tool (hide limit section, html in $betweenarrows and $afterarrows but not $beforearrows)</td> <td>1</td> </tr> <tr> <td>string $rate Rate value to format ('19.6', '19,6', '19.6%', '19,6%', '19.6 (CODEX)', ...)</td> <td>1</td> </tr> <tr> <td>boolean $addpercent Add a percent % sign in output</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information on vat (0=Default, 1=French NPR vat)</td> <td>1</td> </tr> <tr> <td>int $usestarfornpr -1=Never show, 0 or 1=Use '*' for NPR vat rates</td> <td>1</td> </tr> <tr> <td>int $html Used for html output</td> <td>1</td> </tr> <tr> <td>string|float $amount Amount value to format</td> <td>1</td> </tr> <tr> <td>int<0,1> $form Type of formatting: 1=HTML, 0=no formatting (no by default)</td> <td>1</td> </tr> <tr> <td>Translate|string|null $outlangs Object langs for output. '' use default lang. 'none' use international separators.</td> <td>1</td> </tr> <tr> <td>int $trunc 1=Truncate if there is more decimals than MAIN_MAX_DECIMALS_SHOWN (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accuracy) before being inserted into database or after a computation, so this parameter should be useless.</td> <td>1</td> </tr> <tr> <td>int $rounding MINIMUM number of decimal to show: 0=no change, -1=we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT)</td> <td>1</td> </tr> <tr> <td>int|string $forcerounding MAXIMUM number of decimal to forcerounding decimal: -1=no change, 'MU' or 'MT' or a numeric to round to MU or MT or to a given number of decimal</td> <td>1</td> </tr> <tr> <td>string $currency_code To add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)</td> <td>1</td> </tr> <tr> <td>string|float $amount Amount to convert/clean or round</td> <td>1</td> </tr> <tr> <td>string|int $rounding ''=No rounding</td> <td>1</td> </tr> <tr> <td>int $option Put 1 if you know that content is already universal format number (so no correction on decimal will be done)</td> <td>1</td> </tr> <tr> <td>float $dimension Dimension</td> <td>1</td> </tr> <tr> <td>int $unit Unit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...)</td> <td>1</td> </tr> <tr> <td>string $type 'weight', 'volume', ...</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Translate language object</td> <td>1</td> </tr> <tr> <td>int $round -1 = non rounding, x = number of decimal</td> <td>1</td> </tr> <tr> <td>string $forceunitoutput 'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)</td> <td>1</td> </tr> <tr> <td>float|string $vatrate Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example</td> <td>1</td> </tr> <tr> <td>int $local Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_buyer Object of buying third party</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_seller Object of selling third party ($mysoc if not defined)</td> <td>1</td> </tr> <tr> <td>int $vatnpr If vat rate is NPR or not</td> <td>1</td> </tr> <tr> <td>int $local Local tax to test (1 or 2)</td> <td>1</td> </tr> <tr> <td>int $local LocalTax to get</td> <td>1</td> </tr> <tr> <td>int|string $vatrate VAT ID or Rate. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.</td> <td>1</td> </tr> <tr> <td>Societe $buyer Company object</td> <td>1</td> </tr> <tr> <td>Societe $seller Company object</td> <td>1</td> </tr> <tr> <td>int<0,1> $firstparamisid 1 if first param is id into table (use this if you can)</td> <td>1</td> </tr> <tr> <td>int|string $vatrate VAT ID or Rate+Code. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.</td> <td>1</td> </tr> <tr> <td>int $local Number of localtax (1 or 2, or 0 to return 1 & 2)</td> <td>1</td> </tr> <tr> <td>Societe $buyer Company object</td> <td>1</td> </tr> <tr> <td>Societe $seller Company object</td> <td>1</td> </tr> <tr> <td>int $firstparamisid 1 if first param is ID into table instead of Rate+code (use this if you can)</td> <td>1</td> </tr> <tr> <td>int $idprod Id of product or 0 if not a predefined product</td> <td>1</td> </tr> <tr> <td>Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)</td> <td>1</td> </tr> <tr> <td>int $idprodfournprice Id product_fournisseur_price (for "supplier" proposal/order/invoice)</td> <td>1</td> </tr> <tr> <td>int $idprod Id of product</td> <td>1</td> </tr> <tr> <td>int $local 1 for localtax1, 2 for localtax 2</td> <td>1</td> </tr> <tr> <td>Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_seller Object Seller company</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_buyer Object Buyer company</td> <td>1</td> </tr> <tr> <td>int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_seller Thirdparty seller</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_buyer Thirdparty buyer</td> <td>1</td> </tr> <tr> <td>int $idprod Id product</td> <td>1</td> </tr> <tr> <td>int $idprodfournprice Id supplier price for product</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_seller Third party seller</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_buyer Third party buyer</td> <td>1</td> </tr> <tr> <td>int $local Localtax to process (1 or 2)</td> <td>1</td> </tr> <tr> <td>string|int $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')</td> <td>1</td> </tr> <tr> <td>integer $case 1=Yes/No, 0=yes/no, 2=Disabled checkbox, 3=Disabled checkbox + Yes/No</td> <td>1</td> </tr> <tr> <td>int $color 0=texte only, 1=Text is formatted with a color font style ('ok' or 'error'), 2=Text is formatted with 'ok' color.</td> <td>1</td> </tr> <tr> <td>string|int $num Id of object (deprecated, $object will be used in future)</td> <td>1</td> </tr> <tr> <td>int $level Level of subdirs to return (1, 2 or 3 levels). (deprecated, global option will be used in future)</td> <td>1</td> </tr> <tr> <td>int $alpha 0=Keep number only to forge path, 1=Use alpha part after the - (By default, use 0). (deprecated, global option will be used in future)</td> <td>1</td> </tr> <tr> <td>int $withoutslash 0=With slash at end (except if '/', we return ''), 1=without slash at end</td> <td>1</td> </tr> <tr> <td>?CommonObject $object Object to use to get ref to forge the path.</td> <td>1</td> </tr> <tr> <td>string $modulepart Type of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.</td> <td>1</td> </tr> <tr> <td>string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')</td> <td>1</td> </tr> <tr> <td>string $dataroot Data root directory (To avoid having the data root in the loop. Using this will also lost the warning, on first dir, saying PHP has no permission when open_basedir is used)</td> <td>1</td> </tr> <tr> <td>string $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'</td> <td>1</td> </tr> <tr> <td>string $filepath Full file path</td> <td>1</td> </tr> <tr> <td>string $newmask Force new mask. For example '0644'</td> <td>1</td> </tr> <tr> <td>string $stringtoclean String to clean</td> <td>1</td> </tr> <tr> <td>integer $removelinefeed 1=Replace all new lines by 1 space, 0=Only ending new lines are removed others are replaced with \n, 2=The ending new line is removed but others are kept with the same number of \n than the nb of <br> when there is both "...<br>\n..."</td> <td>1</td> </tr> <tr> <td>string $pagecodeto Encoding of input/output string</td> <td>1</td> </tr> <tr> <td>integer $strip_tags 0=Use internal strip, 1=Use strip_tags() php function (bugged when text contains a < char that is not for a html tag or when tags is not closed like '<img onload=aaa')</td> <td>1</td> </tr> <tr> <td>integer $removedoublespaces Replace double space into one space</td> <td>1</td> </tr> <tr> <td>int $cleanalsosomestyles Remove absolute/fixed positioning from inline styles</td> <td>1</td> </tr> <tr> <td>int $removeclassattribute 1=Remove the class attribute from tags</td> <td>1</td> </tr> <tr> <td>int $cleanalsojavascript Remove also occurrence of 'javascript:'.</td> <td>1</td> </tr> <tr> <td>int $allowiframe Allow iframe tags.</td> <td>1</td> </tr> <tr> <td>string[] $allowed_tags List of allowed tags to replace the default list</td> <td>1</td> </tr> <tr> <td>int $allowlink Allow "link" tags.</td> <td>1</td> </tr> <tr> <td>string[] $allowed_attributes Array of tags not allowed</td> <td>1</td> </tr> <tr> <td>array $disallowed_tags Array of tags not allowed</td> <td>1</td> </tr> <tr> <td>int $cleanalsosomestyles Clean also some tags</td> <td>1</td> </tr> <tr> <td>string $text Input text</td> <td>1</td> </tr> <tr> <td>int $nboflines Nb of lines to get (default is 1 = first line only)</td> <td>1</td> </tr> <tr> <td>string $charset Charset of $text string (UTF-8 by default)</td> <td>1</td> </tr> <tr> <td>int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br</td> <td>1</td> </tr> <tr> <td>bool $forxml false=Use <br>, true=Use <br /></td> <td>1</td> </tr> <tr> <td>string $stringtoencode String to encode</td> <td>1</td> </tr> <tr> <td>int $nouseofiframesandbox 0=Default, 1=Allow use of option MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS for html sanitizing (not yet working)</td> <td>1</td> </tr> <tr> <td>string $check 'restricthtmlnolink' or 'restricthtml' or 'restricthtmlallowclass' or 'restricthtmlallowunvalid'</td> <td>1</td> </tr> <tr> <td>int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)</td> <td>1</td> </tr> <tr> <td>string $pagecodefrom Pagecode stringtoencode is encoded</td> <td>1</td> </tr> <tr> <td>int $removelasteolbr 1=Remove last br or lasts \n (default), 0=Do nothing</td> <td>1</td> </tr> <tr> <td>string $pagecodeto Page code for result</td> <td>1</td> </tr> <tr> <td>string $a Operand a</td> <td>1</td> </tr> <tr> <td>string $b Operand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)</td> <td>1</td> </tr> <tr> <td>string $c Operand c</td> <td>1</td> </tr> <tr> <td>int $keepsomeentities Entities but &, <, >, " are not converted.</td> <td>1</td> </tr> <tr> <td>string $string The input string to encode</td> <td>1</td> </tr> <tr> <td>int $flags Flags (see PHP doc above)</td> <td>1</td> </tr> <tr> <td>string $encoding Encoding page code</td> <td>1</td> </tr> <tr> <td>bool $double_encode When double_encode is turned off, PHP will not encode existing html entities</td> <td>1</td> </tr> <tr> <td>string $s String to check</td> <td>1</td> </tr> <tr> <td>int $clean Clean if it is not an ISO. Warning, if file is utf8, you will get a bad formatted file.</td> <td>1</td> </tr> <tr> <td>string $s String to check</td> <td>1</td> </tr> <tr> <td>int $maxchar Not yet used</td> <td>1</td> </tr> <tr> <td>string $text Text</td> <td>1</td> </tr> <tr> <td>int $maxlinesize Linewidth in character count (default = 0 == nolimit)</td> <td>1</td> </tr> <tr> <td>string $charset Give the charset used to encode the $text variable in memory.</td> <td>1</td> </tr> <tr> <td>string $msg Content to check</td> <td>1</td> </tr> <tr> <td>int $option 0=Full detection, 1=Fast check</td> <td>1</td> </tr> <tr> <td>string $text1 Text 1</td> <td>1</td> </tr> <tr> <td>string $text2 Text 2</td> <td>1</td> </tr> <tr> <td>bool $forxml true=Use <br /> instead of <br> if we have to add a br tag</td> <td>1</td> </tr> <tr> <td>bool $invert invert order of description lines (we often use config MAIN_CHANGE_ORDER_CONCAT_DESCRIPTION in this parameter)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>int $onlykey 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys),</td> <td>1</td> </tr> <tr> <td>string[]|null $exclude Array of family keys we want to exclude. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)</td> <td>1</td> </tr> <tr> <td>?CommonObject $object Object for keys on object</td> <td>1</td> </tr> <tr> <td>string[]|null $include Array of family keys we want to include. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)</td> <td>1</td> </tr> <tr> <td>string $text Source string in which we must do substitution</td> <td>1</td> </tr> <tr> <td>array<string,string> $substitutionarray Array with key->val to substitute. Example: array('__MYKEY__' => 'MyVal', ...)</td> <td>1</td> </tr> <tr> <td>?Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>int $converttextinhtmlifnecessary 0=Convert only value into HTML if text is already in HTML</td> <td>1</td> </tr> <tr> <td>array<string,string> $substitutionarray Array substitution old value => new value value</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>CommonObject $object Source object</td> <td>1</td> </tr> <tr> <td>mixed $parameters Add more parameters (useful to pass product lines)</td> <td>1</td> </tr> <tr> <td>string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)</td> <td>1</td> </tr> <tr> <td>int $date_start Start date</td> <td>1</td> </tr> <tr> <td>int $date_end End date</td> <td>1</td> </tr> <tr> <td>string $format Output format</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>int $date_start Start date</td> <td>1</td> </tr> <tr> <td>int $date_end End date</td> <td>1</td> </tr> <tr> <td>string $format Output date format ('day', 'dayhour', ...)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>integer $withparenthesis 1=Add parenthesis, 0=no parenthesis</td> <td>1</td> </tr> <tr> <td>string $firstname Firstname</td> <td>1</td> </tr> <tr> <td>string $lastname Lastname</td> <td>1</td> </tr> <tr> <td>int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname</td> <td>1</td> </tr> <tr> <td>string|string[] $mesgs Message string or array</td> <td>1</td> </tr> <tr> <td>string $style Which style to use ('mesgs' by default, 'warnings', 'errors')</td> <td>1</td> </tr> <tr> <td>string|null $mesg Message string</td> <td>1</td> </tr> <tr> <td>string[]|null $mesgs Message array</td> <td>1</td> </tr> <tr> <td>string $style Which style to use ('mesgs' by default, 'warnings', 'errors')</td> <td>1</td> </tr> <tr> <td>string $messagekey A key to be used to allow the feature "Never show this message again"</td> <td>1</td> </tr> <tr> <td>string $style Style of message output ('ok' or 'error')</td> <td>1</td> </tr> <tr> <td>int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)</td> <td>1</td> </tr> <tr> <td>int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)</td> <td>1</td> </tr> <tr> <td>string $style Which style to use ('ok', 'warning', 'error')</td> <td>1</td> </tr> <tr> <td>int $keepembedded Set to 1 if message must be kept embedded into its html place (this disable jnotify)</td> <td>1</td> </tr> <tr> <td>int<0,1> $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)</td> <td>1</td> </tr> <tr> <td>array<string|int,mixed> $array Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects)</td> <td>1</td> </tr> <tr> <td>string $index Key in array to use for sorting criteria</td> <td>1</td> </tr> <tr> <td>string $order Sort order ('asc' or 'desc')</td> <td>1</td> </tr> <tr> <td>int<0,1> $natsort If values are strings (I said value not type): 0=Use alphabetical order, 1=use "natural" sort (natsort)</td> <td>1</td> </tr> <tr> <td>int<0,1> $case_sensitive 1=sort is case sensitive, 0=not case sensitive</td> <td>1</td> </tr> <tr> <td>int<0,1> $keepindex If 0 and index key of array to sort is a numeric, then index will be rewritten. If 1 or index key is not numeric, key for index is kept after sorting.</td> <td>1</td> </tr> <tr> <td>string $str String to encode (UTF-8)</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $key Code or Id to get Id or Code</td> <td>1</td> </tr> <tr> <td>string $tablename Table name without prefix</td> <td>1</td> </tr> <tr> <td>string $fieldkey Field to search the key into</td> <td>1</td> </tr> <tr> <td>string $fieldid Field to get</td> <td>1</td> </tr> <tr> <td>int $entityfilter Filter by entity</td> <td>1</td> </tr> <tr> <td>string $filters Filters to add. WARNING: string must be escaped for SQL and not coming from user input.</td> <td>1</td> </tr> <tr> <td>string $var Variable</td> <td>1</td> </tr> <tr> <td>string $regextext Text that must be a valid regex string</td> <td>1</td> </tr> <tr> <td>int<0,1> $matchrule 1=Test if start with, 0=Test if equal</td> <td>1</td> </tr> <tr> <td>string $strToEvaluate String with condition to check</td> <td>1</td> </tr> <tr> <td>string $onlysimplestring '0' (deprecated, do not use it anymore)=Accept all chars,</td> <td>1</td> </tr> <tr> <td>string $s String to evaluate</td> <td>1</td> </tr> <tr> <td>int<0,1> $returnvalue 0=No return (deprecated, used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).</td> <td>1</td> </tr> <tr> <td>int<0,1> $hideerrors 1=Hide errors</td> <td>1</td> </tr> <tr> <td>string $onlysimplestring '0' (deprecated, do not use it anymore)=Accept all chars,</td> <td>1</td> </tr> <tr> <td>string $element Variable to check</td> <td>1</td> </tr> <tr> <td>string $codelang Language code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR')</td> <td>1</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"')</td> <td>1</td> </tr> <tr> <td>int<0,1> $notitlealt No title alt</td> <td>1</td> </tr> <tr> <td>string $countrycode Country code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ...</td> <td>1</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>object|null $object Object object</td> <td>1</td> </tr> <tr> <td>array<array<int,string>> $head List of head tabs (updated by this function)</td> <td>1</td> </tr> <tr> <td>int $h New position to fill (updated by this function)</td> <td>1</td> </tr> <tr> <td>string $type Value for object where objectvalue can be</td> <td>1</td> </tr> <tr> <td>string $mode 'add' to complete head, 'remove' to remove entries</td> <td>1</td> </tr> <tr> <td>string $filterorigmodule Filter on module origin: 'external' will show only external modules. 'core' only core modules. No filter (default) will add both.</td> <td>1</td> </tr> <tr> <td>string $zone 'private' (for private pages) or 'public' (for public pages)</td> <td>1</td> </tr> <tr> <td>?string $string String to explode</td> <td>1</td> </tr> <tr> <td>string $delimiter Delimiter between each couple of data. Example: ';' or '[\n;]+' or '(\n\r|\r|\n|;)'</td> <td>1</td> </tr> <tr> <td>string $kv Delimiter between key and value</td> <td>1</td> </tr> <tr> <td>string $selector Selector ('#id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char.</td> <td>1</td> </tr> <tr> <td>string|string[] $fields String or array of strings, filled with the name of all fields in the SQL query we must check (combined with a OR). Example: array("p.field1","p.field2")</td> <td>1</td> </tr> <tr> <td>string $value The value to look for.</td> <td>1</td> </tr> <tr> <td>integer $mode 0=value is list of keyword strings,</td> <td>1</td> </tr> <tr> <td>integer $nofirstand 1=Do not output the first 'AND'</td> <td>1</td> </tr> <tr> <td>string $file Original filename (full or relative path)</td> <td>1</td> </tr> <tr> <td>string $extImgTarget Force image extension for thumbs. Use '' to keep same extension than original image (default).</td> <td>1</td> </tr> <tr> <td>string $relativepath Relative path of docs.</td> <td>1</td> </tr> <tr> <td>int<0,1> $alldata Return array with all components (1 is recommended, then use a simple a href link with the class, target and mime attribute added. 'documentpreview' css class is handled by jquery code into main.inc.php)</td> <td>1</td> </tr> <tr> <td>string $htmlname Id of html object ('#idvalue' or '.classvalue')</td> <td>1</td> </tr> <tr> <td>string $addlink Add a 'link to' after</td> <td>1</td> </tr> <tr> <td>string $textonlink Text to show on link or 'image'</td> <td>1</td> </tr> <tr> <td>string $file Filename we looking for information</td> <td>1</td> </tr> <tr> <td>string $file Filename we looking for MIME type</td> <td>1</td> </tr> <tr> <td>string $default Default mime type if extension not found in known list</td> <td>1</td> </tr> <tr> <td>int<0,4> $mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa</td> <td>1</td> </tr> <tr> <td>string $tablename Name of table dictionary (without the MAIN_DB_PREFIX, example: 'c_holiday_types')</td> <td>1</td> </tr> <tr> <td>string $field The name of field where to find the value to return</td> <td>1</td> </tr> <tr> <td>int $id Id of line record</td> <td>1</td> </tr> <tr> <td>bool $checkentity Add filter on entity</td> <td>1</td> </tr> <tr> <td>string $rowidfield Name of the column rowid (to use for the filter on $id)</td> <td>1</td> </tr> <tr> <td>int<0,1> $type_user 0=We test for internal user, 1=We test for external user</td> <td>1</td> </tr> <tr> <td>array{enabled:int<0,1>,module:string,perms:string} $menuentry Array for feature entry to test</td> <td>1</td> </tr> <tr> <td>string[] $listofmodulesforexternal Array with list of modules allowed to external users</td> <td>1</td> </tr> <tr> <td>float $n Number to round up</td> <td>1</td> </tr> <tr> <td>int $x Multiple. For example 60 to round up to nearest exact minute for a date with seconds.</td> <td>1</td> </tr> <tr> <td>string $label label of badge no html : use in alt attribute for accessibility</td> <td>1</td> </tr> <tr> <td>string $html optional : label of badge with html</td> <td>1</td> </tr> <tr> <td>string $type type of badge : Primary Secondary Success Danger Warning Info Light Dark status0 status1 status2 status3 status4 status5 status6 status7 status8 status9</td> <td>1</td> </tr> <tr> <td>''|'pill'|'dot' $mode Default '' , 'pill', 'dot'</td> <td>1</td> </tr> <tr> <td>string $url the url for link</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params Various params for future : recommended rather than adding more function arguments. array('attr'=>array('title'=>'abc'))</td> <td>1</td> </tr> <tr> <td>string $statusLabel Label of badge no html : use in alt attribute for accessibility</td> <td>1</td> </tr> <tr> <td>string $statusLabelShort Short label of badge no html</td> <td>1</td> </tr> <tr> <td>string $html Optional : label of badge with html</td> <td>1</td> </tr> <tr> <td>string $statusType status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 : image name or badge name</td> <td>1</td> </tr> <tr> <td>int<0,6> $displayMode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $url The url for link</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params Various params. Example: array('tooltip'=>'no|...', 'badgeParams'=>...)</td> <td>1</td> </tr> <tr> <td>string $label Label or tooltip of button if $text is provided. Also used as tooltip in title attribute. Can be escaped HTML content or full simple text.</td> <td>1</td> </tr> <tr> <td>string $text Optional : short label on button. Can be escaped HTML content or full simple text.</td> <td>1</td> </tr> <tr> <td>string $actionType 'default', 'danger', 'email', 'clone', 'cancel', 'delete', ...</td> <td>1</td> </tr> <tr> <td>string|array<int,array{lang:string,enabled:bool,perm:bool,label:string,url:string}> $url Url for link or array of subbutton description</td> <td>1</td> </tr> <tr> <td>string $id Attribute id of action button. Example 'action-delete'. This can be used for full ajax confirm if this code is reused into the ->formconfirm() method.</td> <td>1</td> </tr> <tr> <td>int|boolean $userRight User action right</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params = [ // Various params for future : recommended rather than adding more function arguments</td> <td>1</td> </tr> <tr> <td>string $moreClass more css class label</td> <td>1</td> </tr> <tr> <td>string $fieldValidationErrorMsg message to add in tooltip</td> <td>1</td> </tr> <tr> <td>string $label label of button</td> <td>1</td> </tr> <tr> <td>string $helpText optional : content for help tooltip</td> <td>1</td> </tr> <tr> <td>string $iconClass class for icon element (Example: 'fa fa-file')</td> <td>1</td> </tr> <tr> <td>string $url the url for link</td> <td>1</td> </tr> <tr> <td>string $id attribute id of button</td> <td>1</td> </tr> <tr> <td>int<-2,2> $status 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled, -2 disable Other reason use param $helpText as tooltip help</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params various params for future : recommended rather than adding more function arguments</td> <td>1</td> </tr> <tr> <td>string $elementType Element type (Value of $object->element or value of $object->element@$object->module). Example:</td> <td>1</td> </tr> <tr> <td>int $element_id Element id (Use this or element_ref but not both. If id and ref are empty, object with no fetch is returned)</td> <td>1</td> </tr> <tr> <td>string $element_type Element type ('module' or 'myobject@mymodule' or 'mymodule_myobject')</td> <td>1</td> </tr> <tr> <td>string $element_ref Element ref (Use this or element_id but not both. If id and ref are empty, object with no fetch is returned)</td> <td>1</td> </tr> <tr> <td>int<0,2> $useCache If you want to store object in cache or get it from cache 0 => no use cache , 1 use cache, 2 force reload cache</td> <td>1</td> </tr> <tr> <td>int $maxCacheByType Number of object in cache for this element type</td> <td>1</td> </tr> <tr> <td>string $filename File name to test</td> <td>1</td> </tr> <tr> <td>string $header The first left header of the table (automatic translated)</td> <td>1</td> </tr> <tr> <td>string $link (optional) The link to a internal dolibarr page, where to go on clicking on the number or the ... (without the first "/")</td> <td>1</td> </tr> <tr> <td>string $arguments (optional) Additional arguments for the link (e.g. "search_status=0")</td> <td>1</td> </tr> <tr> <td>integer $emptyColumns (optional) Number of empty columns to add after the first column</td> <td>1</td> </tr> <tr> <td>integer $number (optional) The number that is shown right after the first header, when -1 the link is shown as '...'</td> <td>1</td> </tr> <tr> <td>string $pictofulllist (optional) The picto to use for the full list link</td> <td>1</td> </tr> <tr> <td>bool $addLineBreak (optional) Add a extra line break after the complete table (\<br\>)</td> <td>1</td> </tr> <tr> <td>integer $tableColumnCount The complete count columns of the table</td> <td>1</td> </tr> <tr> <td>integer $num The count of the rows of the table, when it is zero (0) the "$noneWord" is shown instead</td> <td>1</td> </tr> <tr> <td>integer $nbofloop (optional) The maximum count of rows thaht the table show (when it is zero (0) no summary line will show, expect "$noneWord" when $num === 0)</td> <td>1</td> </tr> <tr> <td>integer $total (optional) The total value thaht is shown after when the table has minimum of one entire</td> <td>1</td> </tr> <tr> <td>string $noneWord (optional) The word that is shown when the table has no entries ($num === 0)</td> <td>1</td> </tr> <tr> <td>boolean $extraRightColumn (optional) Add a additional column after the summary word and total number</td> <td>1</td> </tr> <tr> <td>string $fullpath_original_file_osencoded Full path of file to return.</td> <td>1</td> </tr> <tr> <td>int<-1,2> $method -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream</td> <td>1</td> </tr> <tr> <td>string $valuetocopy The value to print</td> <td>1</td> </tr> <tr> <td>int<0,1> $showonlyonhover Show the copy-paste button only on hover</td> <td>1</td> </tr> <tr> <td>string $texttoshow Replace the value to show with this text. Use 'none' to show no text (only the copy-paste picto)</td> <td>1</td> </tr> <tr> <td>string $stringtodecode String to decode (json or serialize coded)</td> <td>1</td> </tr> <tr> <td>string $filter String with universal search string. Must be '(aaa:bbb:ccc) OR (ddd:eeee:fff) ...' with</td> <td>1</td> </tr> <tr> <td>string $errorstr Error message string</td> <td>1</td> </tr> <tr> <td>int<0,1> $noand 1=Do not add the AND before the condition string.</td> <td>1</td> </tr> <tr> <td>int<0,1> $nopar 1=Do not add the parenthesis around the final condition string.</td> <td>1</td> </tr> <tr> <td>int<0,1> $noerror 1=If search criteria is not valid, does not return an error string but invalidate the SQL</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Universal SQL filter string. Must have been trimmed before.</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Universal SQL filter string. Must have been trimmed before.</td> <td>1</td> </tr> <tr> <td>string $error Returned error message</td> <td>1</td> </tr> <tr> <td>int $parenthesislevel Returned level of global parenthesis that we can remove/simplify, 0 if error or we can't simplify.</td> <td>1</td> </tr> <tr> <td>string[] $matches Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.nature:is:NULL"</td> <td>1</td> </tr> <tr> <td>string[] $matches Array of found string by regex search.</td> <td>1</td> </tr> <tr> <td>ActionComm $actionstatic actioncomm</td> <td>1</td> </tr> <tr> <td>array<int,array{percent:int}> $histo histo</td> <td>1</td> </tr> <tr> <td>int $key key</td> <td>1</td> </tr> <tr> <td>ActionComm $object Object ActionComm</td> <td>1</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>DoliDB $db Object db</td> <td>1</td> </tr> <tr> <td>?CommonObject $filterobj Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket|... to list events linked to an object</td> <td>1</td> </tr> <tr> <td>?Contact $objcon Filter on object contact to filter events on a contact</td> <td>1</td> </tr> <tr> <td>int $noprint Return string but does not output it</td> <td>1</td> </tr> <tr> <td>string $actioncode Filter on actioncode</td> <td>1</td> </tr> <tr> <td>string $donetodo Filter on event 'done' or 'todo' or ''=nofilter (all).</td> <td>1</td> </tr> <tr> <td>array<string,string> $filters Filter on other fields</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>string $hourTime 'getpost' to include hour, minute, second values from the HTTP request, 'XX:YY:ZZ' to set</td> <td>1</td> </tr> <tr> <td>string $gm Passed to dol_mktime</td> <td>1</td> </tr> <tr> <td>?int $timestamp If null, the timestamp will be created from request data</td> <td>1</td> </tr> <tr> <td>string $hourTime If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp</td> <td>1</td> </tr> <tr> <td>string $gm If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp</td> <td>1</td> </tr> <tr> <td>string $message Custom error message to display. If empty, a default "Record Not Found" message is shown.</td> <td>1</td> </tr> <tr> <td>int<0,1> $printheader Determines if the page header should be printed (1 = yes, 0 = no).</td> <td>1</td> </tr> <tr> <td>int<0,1> $printfooter Determines if the page footer should be printed (1 = yes, 0 = no).</td> <td>1</td> </tr> <tr> <td>int<0,1> $showonlymessage If set to 1, only the error message is displayed without any additional information or hooks.</td> <td>1</td> </tr> <tr> <td>mixed $params Optional parameters to pass to hooks for further processing or customization.</td> <td>1</td> </tr> <tr> <td>Project $project Object related to tabs</td> <td>1</td> </tr> <tr> <td>string $moreparam More param on url</td> <td>1</td> </tr> <tr> <td>string $fuser Filter on user</td> <td>1</td> </tr> <tr> <td>string $inc Line number (start to 0, then increased by recursive call)</td> <td>1</td> </tr> <tr> <td>string $parent Id of parent task to show (0 to show all)</td> <td>1</td> </tr> <tr> <td>Task[] $lines Array of lines</td> <td>1</td> </tr> <tr> <td>int $level Level (start to 0, then increased/decrease by recursive call), or -1 to show all level in order of $lines without the recursive groupment feature.</td> <td>1</td> </tr> <tr> <td>string $var Color</td> <td>1</td> </tr> <tr> <td>int $showproject Show project columns</td> <td>1</td> </tr> <tr> <td>int $taskrole Array of roles of user for each tasks</td> <td>1</td> </tr> <tr> <td>string $projectsListId List of id of project allowed to user (string separated with comma)</td> <td>1</td> </tr> <tr> <td>int $addordertick Add a tick to move task</td> <td>1</td> </tr> <tr> <td>int $projectidfortotallink 0 or Id of project to use on total line (link to see all time consumed for project)</td> <td>1</td> </tr> <tr> <td>string $dummy Not used.</td> <td>1</td> </tr> <tr> <td>int $showbilltime Add the column 'TimeToBill' and 'TimeBilled'</td> <td>1</td> </tr> <tr> <td>array $arrayfields Array with displayed column information</td> <td>1</td> </tr> <tr> <td>array $arrayofselected Array with selected fields</td> <td>1</td> </tr> <tr> <td>array $TWeek Array of week numbers</td> <td>1</td> </tr> <tr> <td>int $inc Counter that count number of lines legitimate to show (for return)</td> <td>1</td> </tr> <tr> <td>int $parent Id of parent task to start</td> <td>1</td> </tr> <tr> <td>Task[] $lines Array of all tasks</td> <td>1</td> </tr> <tr> <td>string $taskrole Array of task filtered on a particular user</td> <td>1</td> </tr> <tr> <td>Form $form Object form</td> <td>1</td> </tr> <tr> <td>int $socid Id thirdparty</td> <td>1</td> </tr> <tr> <td>int $projectsListId Id of project I have permission on</td> <td>1</td> </tr> <tr> <td>int $mytasks Limited to task I am contact to</td> <td>1</td> </tr> <tr> <td>int $status -1=No filter on statut, 0 or 1 = Filter on status</td> <td>1</td> </tr> <tr> <td>array $listofoppstatus List of opportunity status</td> <td>1</td> </tr> <tr> <td>array $hiddenfields List of info to not show ('projectlabel', 'declaredprogress', '...', )</td> <td>1</td> </tr> <tr> <td>int $max Max nb of record to show in HTML list</td> <td>1</td> </tr> <tr> <td>Task $task the task object</td> <td>1</td> </tr> <tr> <td>bool|string $label true = auto, false = don't display, string = replace output</td> <td>1</td> </tr> <tr> <td>bool|string $progressNumber true = auto, false = don't display, string = replace output</td> <td>1</td> </tr> <tr> <td>bool $hideOnProgressNull hide if progress is null</td> <td>1</td> </tr> <tr> <td>bool $spaced used to add space at bottom (made by css)</td> <td>1</td> </tr> <tr> <td>Task $task the task object</td> <td>1</td> </tr> <tr> <td>string $label empty = auto (progress), string = replace output</td> <td>1</td> </tr> <tr> <td>string $tooltip empty = auto , string = replace output</td> <td>1</td> </tr> <tr> <td>BonPrelevement $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>string $type 'bank-transfer' or 'direct-debit'</td> <td>1</td> </tr> <tr> <td>BonPrelevement $object Member</td> <td>1</td> </tr> <tr> <td>int $nbOfInvoices No of invoices</td> <td>1</td> </tr> <tr> <td>int $nbOfSalaryInvoice No of salary invoices</td> <td>1</td> </tr> <tr> <td>string $reportname Name of report</td> <td>1</td> </tr> <tr> <td>string $notused Not used</td> <td>1</td> </tr> <tr> <td>integer $builddate Date generation</td> <td>1</td> </tr> <tr> <td>array $moreparam Array with list of params to add into form</td> <td>1</td> </tr> <tr> <td>Paiement $object Current salaries object</td> <td>1</td> </tr> <tr> <td>Object $object Holiday</td> <td>1</td> </tr> <tr> <td>int $id ID of bank line</td> <td>1</td> </tr> <tr> <td>string $paymentmethod Filter on this payment method (''=none, 'paypal', ...)</td> <td>1</td> </tr> <tr> <td>string $label Text or HTML tag to display, if empty it display the URL</td> <td>1</td> </tr> <tr> <td>int $mode 0=True url, 1=Url formatted with colors</td> <td>1</td> </tr> <tr> <td>string $type Type of URL ('free', 'order', 'invoice', 'contractline', 'member', 'boothlocation', ...)</td> <td>1</td> </tr> <tr> <td>string $ref Ref of object</td> <td>1</td> </tr> <tr> <td>int|float $amount Amount of money to request for</td> <td>1</td> </tr> <tr> <td>string $freetag Free tag (required and used for $type='free' only)</td> <td>1</td> </tr> <tr> <td>int $localorexternal 0=Url for browser, 1=Url for external access</td> <td>1</td> </tr> <tr> <td>ProductLot $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty id</td> <td>1</td> </tr> <tr> <td>Productlot $batch Product batch object</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty id</td> <td>1</td> </tr> <tr> <td>string $measuring_style Style of unit: weight, volume,...</td> <td>1</td> </tr> <tr> <td>string $measuring_style Style of unit: 'weight', 'volume', ..., '' = 'net_measure' for option PRODUCT_ADD_NET_MEASURE</td> <td>1</td> </tr> <tr> <td>Fiscalyear $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array with authentication information ('login'=>,'password'=>,'entity'=>,'dolibarrkey'=>)</td> <td>1</td> </tr> <tr> <td>int $error Number of errors</td> <td>1</td> </tr> <tr> <td>string $errorcode Error string code</td> <td>1</td> </tr> <tr> <td>string $errorlabel Error string label</td> <td>1</td> </tr> <tr> <td>mixed $var Value to test</td> <td>1</td> </tr> <tr> <td>boolean $allow_false Setting this to true will make the function consider a boolean value of false as NOT empty. This parameter is false by default.</td> <td>1</td> </tr> <tr> <td>boolean $allow_ws Setting this to true will make the function consider a string with nothing but white space as NOT empty. This parameter is false by default.</td> <td>1</td> </tr> <tr> <td>AccountingAccount $object Accounting account</td> <td>1</td> </tr> <tr> <td>string $account Accounting account</td> <td>1</td> </tr> <tr> <td>string $accounta Auxiliary accounting account</td> <td>1</td> </tr> <tr> <td>string $nom Name of report</td> <td>1</td> </tr> <tr> <td>string $variant Link for alternate report</td> <td>1</td> </tr> <tr> <td>integer $builddate Date of generation</td> <td>1</td> </tr> <tr> <td>array $moreparam Array with list of params to add into hidden fields of form</td> <td>1</td> </tr> <tr> <td>array $moreoptions Array with list of params to add to table</td> <td>1</td> </tr> <tr> <td>stdClass $conf Config</td> <td>1</td> </tr> <tr> <td>int $from_time [=null] Get current time or set time to find fiscal period</td> <td>1</td> </tr> <tr> <td>string $module Module</td> <td>1</td> </tr> <tr> <td>string $section Section</td> <td>1</td> </tr> <tr> <td>Contact $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>Ticket $object Object Ticket</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>int $car Length of string to generate key</td> <td>1</td> </tr> <tr> <td>string $title Title</td> <td>1</td> </tr> <tr> <td>string $head Head array</td> <td>1</td> </tr> <tr> <td>int $disablejs More content into html header</td> <td>1</td> </tr> <tr> <td>int $disablehead More content into html header</td> <td>1</td> </tr> <tr> <td>array $arrayofjs Array of complementary js files</td> <td>1</td> </tr> <tr> <td>array $arrayofcss Array of complementary css files</td> <td>1</td> </tr> <tr> <td>string $memoryid Memory id of shared area</td> <td>1</td> </tr> <tr> <td>mixed $data Data to save. It must not be a null value.</td> <td>1</td> </tr> <tr> <td>int $expire ttl in seconds, 0 never expire</td> <td>1</td> </tr> <tr> <td>string $memoryid Memory id of shared area</td> <td>1</td> </tr> <tr> <td>int $memoryid Memory id of shared area ('main', 'agenda', ...)</td> <td>1</td> </tr> <tr> <td>string $data Data to save. Must be a not null value.</td> <td>1</td> </tr> <tr> <td>int $expire ttl in seconds, 0 never expire</td> <td>1</td> </tr> <tr> <td>string $origin Origin ('commande', ...)</td> <td>1</td> </tr> <tr> <td>int $origin_id Origin id</td> <td>1</td> </tr> <tr> <td>string $filter Filter (Do not use a string from a user input)</td> <td>1</td> </tr> <tr> <td>ChargeSociales $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handle</td> <td>1</td> </tr> <tr> <td>string $direction 'sell' or 'buy'</td> <td>1</td> </tr> <tr> <td>int $m Month</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler object</td> <td>1</td> </tr> <tr> <td>int $direction 'sell' (customer invoice) or 'buy' (supplier invoices)</td> <td>1</td> </tr> <tr> <td>int $m Month</td> <td>1</td> </tr> <tr> <td>Translate|null $outputlangs Output lang to use to autodetect output format if we need 'auto' detection</td> <td>1</td> </tr> <tr> <td>string $mode 'setup' = Use setup, 'auto' = Force autodetection whatever is setup</td> <td>1</td> </tr> <tr> <td>string $format Array(width,height). Keep empty to use default setup.</td> <td>1</td> </tr> <tr> <td>string $metric Unit of format ('mm')</td> <td>1</td> </tr> <tr> <td>string $pagetype 'P' or 'l'</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output langs object</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output langs object</td> <td>1</td> </tr> <tr> <td>string $logo Full path to logo file to use</td> <td>1</td> </tr> <tr> <td>bool $url Image with url (true or false)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF initialized object</td> <td>1</td> </tr> <tr> <td>string $htmlcontent HTML Content</td> <td>1</td> </tr> <tr> <td>Societe|Contact $thirdparty Contact or thirdparty</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>int $includealias 1=Include alias name after name</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output langs object</td> <td>1</td> </tr> <tr> <td>Societe $sourcecompany Source company object</td> <td>1</td> </tr> <tr> <td>Societe|string|null $targetcompany Target company object</td> <td>1</td> </tr> <tr> <td>Contact|string|null $targetcontact Target contact object</td> <td>1</td> </tr> <tr> <td>int $usecontact Use contact instead of company</td> <td>1</td> </tr> <tr> <td>string $mode Address type ('source', 'target', 'targetwithdetails', 'targetwithdetails_xxx': target but include also phone/fax/email/url)</td> <td>1</td> </tr> <tr> <td>Object|null $object Object we want to build document for</td> <td>1</td> </tr> <tr> <td>int $page_height Height of page</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>array|null $exclude Array of family keys we want to exclude. For example array('mycompany', 'object', 'date', 'user', ...)</td> <td>1</td> </tr> <tr> <td>Object|null $object Object</td> <td>1</td> </tr> <tr> <td>int $onlykey 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys), 2=Values are truncated and html sanitized (to use for help tooltip)</td> <td>1</td> </tr> <tr> <td>array|null $include Array of family keys we want to include. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>int $h Height of PDF</td> <td>1</td> </tr> <tr> <td>int $w Width of PDF</td> <td>1</td> </tr> <tr> <td>string $unit Unit of height (mm, pt, ...)</td> <td>1</td> </tr> <tr> <td>string $text Text to show</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang</td> <td>1</td> </tr> <tr> <td>int $curx X</td> <td>1</td> </tr> <tr> <td>int $cury Y</td> <td>1</td> </tr> <tr> <td>Account $account Bank account object</td> <td>1</td> </tr> <tr> <td>int $onlynumber Output only number (bank+desk+key+number according to country, but without name of bank and address)</td> <td>1</td> </tr> <tr> <td>int $default_font_size Default font size</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf The PDF factory</td> <td>1</td> </tr> <tr> <td>string $paramfreetext Constant name of free text</td> <td>1</td> </tr> <tr> <td>Societe $fromcompany Object company</td> <td>1</td> </tr> <tr> <td>int $marge_basse Margin bottom we use for the autobreak</td> <td>1</td> </tr> <tr> <td>int $marge_gauche Margin left (no more used)</td> <td>1</td> </tr> <tr> <td>int $page_hauteur Page height</td> <td>1</td> </tr> <tr> <td>Object $object Object shown in PDF</td> <td>1</td> </tr> <tr> <td>int $showdetails Show company address details into footer (0=Nothing, 1=Show address, 2=Show managers, 3=Both)</td> <td>1</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text, 0=Show free text</td> <td>1</td> </tr> <tr> <td>int $page_largeur Page width</td> <td>1</td> </tr> <tr> <td>string $watermark Watermark text to print on page</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>object $object Object</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang</td> <td>1</td> </tr> <tr> <td>int $posx X</td> <td>1</td> </tr> <tr> <td>int $posy Y</td> <td>1</td> </tr> <tr> <td>float $w Width of cells. If 0, they extend up to the right margin of the page.</td> <td>1</td> </tr> <tr> <td>float $h Cell minimum height. The cell extends automatically if needed.</td> <td>1</td> </tr> <tr> <td>int $align Align</td> <td>1</td> </tr> <tr> <td>string $default_font_size Font size</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF object</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>int $w Width</td> <td>1</td> </tr> <tr> <td>int $h Height</td> <td>1</td> </tr> <tr> <td>int $posx Pos x</td> <td>1</td> </tr> <tr> <td>int $posy Pos y</td> <td>1</td> </tr> <tr> <td>int $hideref Hide reference</td> <td>1</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>1</td> </tr> <tr> <td>int $issupplierline Is it a line for a supplier object ?</td> <td>1</td> </tr> <tr> <td>string $align text alignment ('L', 'C', 'R', 'J' (default))</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>int $i Current line number (0 = first line, 1 = second line, ...)</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>int $i Current line number</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)</td> <td>1</td> </tr> <tr> <td>HookManager|null $hookmanager Hook manager instance</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)</td> <td>1</td> </tr> <tr> <td>string $realpath Full path to photo file to use</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)</td> <td>1</td> </tr> <tr> <td>Deplacement $object Object related to tabs</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level:int,prefix:string}> $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level:int,prefix:string}> $menu_array_before Table of menu entries to show before entries of menu handler (menu->liste filled with menu->add)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level:int,prefix:string}> $menu_array_after Table of menu entries to show after entries of menu handler (menu->liste filled with menu->add)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level:int,prefix:string}> $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)</td> <td>1</td> </tr> <tr> <td>string $type_user 0=We need backoffice menu, 1=We need frontoffice menu</td> <td>1</td> </tr> <tr> <td>array $menuentry Array for menu entry</td> <td>1</td> </tr> <tr> <td>array $listofmodulesforexternal Array with list of modules allowed to external users</td> <td>1</td> </tr> <tr> <td>int $showmode 1 or 2</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty). For eldy menu, it contains menu entries loaded from database.</td> <td>1</td> </tr> <tr> <td>array{}|array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string} $menuval All the $menuval array</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $menu_array_before Table of menu entries to show before entries of menu handler (menu->liste filled with menu->add)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $menu_array_after Table of menu entries to show after entries of menu handler (menu->liste filled with menu->add)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)</td> <td>1</td> </tr> <tr> <td>int $type_user Type of user</td> <td>1</td> </tr> <tr> <td>array $arrayofmembers Array of members</td> <td>1</td> </tr> <tr> <td>string $modele Force modele to use ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs to use for translation</td> <td>1</td> </tr> <tr> <td>string $outputdir Output directory</td> <td>1</td> </tr> <tr> <td>string $template pdf generenate document class to use default 'standard'</td> <td>1</td> </tr> <tr> <td>string $filename Name of output file (without extension)</td> <td>1</td> </tr> <tr> <td>array $arrayofrecords Array of records</td> <td>1</td> </tr> <tr> <td>string $modele Force le modele a utiliser ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang a utiliser pour traduction</td> <td>1</td> </tr> <tr> <td>string $outputdir Output directory</td> <td>1</td> </tr> <tr> <td>string $template pdf generenate document class to use default 'standardlabel'</td> <td>1</td> </tr> <tr> <td>string $value Remove standard separators</td> <td>1</td> </tr> <tr> <td>int $entitytotest Numero of instance (always 1 if module multicompany not enabled)</td> <td>1</td> </tr> <tr> <td>string $value Ex: $_SERVER["REMOTE_USER"]</td> <td>1</td> </tr> <tr> <td>string $temp_dir the temporary directory holding all the parts of the file</td> <td>1</td> </tr> <tr> <td>string $upload_dir the temporary directory to create file</td> <td>1</td> </tr> <tr> <td>string $fileName the original file name</td> <td>1</td> </tr> <tr> <td>string $chunkSize each chunk size (in bytes)</td> <td>1</td> </tr> <tr> <td>string $totalSize original file size (in bytes)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF handler</td> <td>1</td> </tr> <tr> <td>array $params Array of params</td> <td>1</td> </tr> <tr> <td>array $sqltree Sqltree</td> <td>1</td> </tr> <tr> <td>string $selecteddir Selected dir</td> <td>1</td> </tr> <tr> <td>string $fullpathselecteddir Full path of selected dir</td> <td>1</td> </tr> <tr> <td>string $modulepart Modulepart</td> <td>1</td> </tr> <tr> <td>string $websitekey Website key</td> <td>1</td> </tr> <tr> <td>int $pageid Page id</td> <td>1</td> </tr> <tr> <td>string $preopened Current open dir</td> <td>1</td> </tr> <tr> <td>string $fullpathpreopened Full path of current open dir</td> <td>1</td> </tr> <tr> <td>int $depth Depth</td> <td>1</td> </tr> <tr> <td>string $sql SQL string</td> <td>1</td> </tr> <tr> <td>Availabilities $object Availabilities</td> <td>1</td> </tr> <tr> <td>Calendar $object Calendar</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object RecruitmentCandidature</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object RecruitmentJobPosition</td> <td>1</td> </tr> <tr> <td>int $mode 0=True url, 1=Url formatted with colors</td> <td>1</td> </tr> <tr> <td>string $ref Ref of object</td> <td>1</td> </tr> <tr> <td>int $localorexternal 0=Url for browser, 1=Url for external access</td> <td>1</td> </tr> <tr> <td>SocieteAccount $object SocieteAccount</td> <td>1</td> </tr> <tr> <td>Mo $object Mo</td> <td>1</td> </tr> <tr> <td>string $message Message explaining the error to the user</td> <td>1</td> </tr> <tr> <td>string[] $values</td> <td>1</td> </tr> <tr> <td>object $valueObject</td> <td>1</td> </tr> <tr> <td>string|int|float|bool|array|object $value</td> <td>1</td> </tr> <tr> <td>string|null $acceptHeaderValue</td> <td>1</td> </tr> <tr> <td>string|string[] $input</td> <td>1</td> </tr> <tr> <td>string|string[] $values</td> <td>1</td> </tr> <tr> <td>string|string[] $values2</td> <td>1</td> </tr> <tr> <td>array<string, int|string|null> $parts</td> <td>1</td> </tr> <tr> <td>$string (string) The input string.</td> <td>1</td> </tr> <tr> <td>$split_length (int) Maximum length of the chunk.</td> <td>1</td> </tr> <tr> <td>mixed $a</td> <td>1</td> </tr> <tr> <td>mixed $b</td> <td>1</td> </tr> <tr> <td>string $package The name of the Composer package that is triggering the deprecation</td> <td>1</td> </tr> <tr> <td>string $version The version of the package that introduced the deprecation</td> <td>1</td> </tr> <tr> <td>string $message The message of the deprecation</td> <td>1</td> </tr> <tr> <td>mixed ...$args Values to insert in the message using printf() formatting</td> <td>1</td> </tr> <tr> <td>string|object $class</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Support\DeferringDisplayableValue|\Illuminate\Contracts\Support\Htmlable|string|null $value</td> <td>1</td> </tr> <tr> <td>bool $doubleEncode</td> <td>1</td> </tr> <tr> <td>object $object</td> <td>1</td> </tr> <tr> <td>int|\Closure $sleepMilliseconds</td> <td>1</td> </tr> <tr> <td>callable|null $when</td> <td>1</td> </tr> <tr> <td>string $trait</td> <td>1</td> </tr> <tr> <td>string|array|int|null $key</td> <td>1</td> </tr> <tr> <td>bool $overwrite</td> <td>1</td> </tr> <tr> <td>string $data data to deflate</td> <td>1</td> </tr> <tr> <td>string $context 'add'=Output field for the "add form", 'edit'=Output field for the "edit form", 'hide'=Output field for the "add form" but we don't want it to be rendered</td> <td>1</td> </tr> <tr> <td>string $context 'add'=Output field for the "add form", 'edit'=Output field for the "edit form", 'preview'=show in readonly the template, 'hide'=Output field for the "add form" but we don't want it to be rendered</td> <td>1</td> </tr> <tr> <td>array $fieldlist Array of fields</td> <td>1</td> </tr> <tr> <td>Object $obj If we show a particular record, obj is filled with record fields</td> <td>1</td> </tr> <tr> <td>int $idrss The id of the RSS feed</td> <td>1</td> </tr> <tr> <td>array $boxlist A list with boxes/widgets</td> <td>1</td> </tr> <tr> <td>string $name The name of the PHP extension</td> <td>1</td> </tr> <tr> <td>array $activated A list with all activated PHP extensions. Deprecated.</td> <td>1</td> </tr> <tr> <td>array $loaded A list with all loaded PHP extensions</td> <td>1</td> </tr> <tr> <td>array $functions A list with all PHP functions to check</td> <td>1</td> </tr> <tr> <td>ConferenceOrBooth $object ConferenceOrBooth</td> <td>1</td> </tr> <tr> <td>int $with_project Add project id to URL</td> <td>1</td> </tr> <tr> <td>Project $object Project</td> <td>1</td> </tr> <tr> <td>ConferenceOrBoothAttendee $object ConferenceOrBoothAttendee</td> <td>1</td> </tr> <tr> <td>string $username Company AADE username</td> <td>1</td> </tr> <tr> <td>string $password Company AADE password</td> <td>1</td> </tr> <tr> <td>string $AFMcalledby Company vat number</td> <td>1</td> </tr> <tr> <td>string $AFMcalledfor Client vat number</td> <td>1</td> </tr> <tr> <td>int $day Day</td> <td>1</td> </tr> <tr> <td>int $month Month</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $monthshown Current month shown in calendar view</td> <td>1</td> </tr> <tr> <td>string $style Style to use for this day</td> <td>1</td> </tr> <tr> <td>array $eventarray Array of events</td> <td>1</td> </tr> <tr> <td>int $maxprint Nb of actions to show each day on month view (0 means no limit)</td> <td>1</td> </tr> <tr> <td>int $maxnbofchar Nb of characters to show for event line</td> <td>1</td> </tr> <tr> <td>string $newparam Parameters on current URL</td> <td>1</td> </tr> <tr> <td>int $showinfo Add extended information (used by day and week view)</td> <td>1</td> </tr> <tr> <td>int $minheight Minimum height for each event. 60px by default.</td> <td>1</td> </tr> <tr> <td>int $nonew 0=Add "new entry button", 1=No "new entry button", -1=Only "new entry button"</td> <td>1</td> </tr> <tr> <td>array{}|array{0:array{0:int,1:int,2:int},1:array{0:int,1:int,2:int},2:array{0:int,1:int,2:int}} $bookcalcalendarsarray Used for Bookcal module array of calendar of bookcal</td> <td>1</td> </tr> <tr> <td>string $color Color</td> <td>1</td> </tr> <tr> <td>int $minus Delta (1 = 16 unit). Positive value = darker color, Negative value = brighter color.</td> <td>1</td> </tr> <tr> <td>int $minusunit Minus unit</td> <td>1</td> </tr> <tr> <td>array $fieldssource List of source fields</td> <td>1</td> </tr> <tr> <td>int $pos Pos</td> <td>1</td> </tr> <tr> <td>array $fieldssource Array of field source</td> <td>1</td> </tr> <tr> <td>array $listofkey Array of keys</td> <td>1</td> </tr> <tr> <td>array $array Array of field source</td> <td>1</td> </tr> <tr> <td>mixed $position key of position to insert to</td> <td>1</td> </tr> <tr> <td>array $insertArray Array to insert</td> <td>1</td> </tr> <tr> <td>int $product_type Type of product</td> <td>1</td> </tr> <tr> <td>Inventory $inventory Object inventory</td> <td>1</td> </tr> <tr> <td>string $title parameter</td> <td>1</td> </tr> <tr> <td>string $get parameter</td> <td>1</td> </tr> <tr> <td>string $haystack string to test</td> <td>1</td> </tr> <tr> <td>string $needle string to find</td> <td>1</td> </tr> <tr> <td>Object $static_object static object to fetch</td> <td>1</td> </tr> <tr> <td>string $tmp_ref ref of the object to fetch</td> <td>1</td> </tr> <tr> <td>StockTransfer $object StockTransfer</td> <td>1</td> </tr> <tr> <td>int $order_id Id of order to check</td> <td>1</td> </tr> <tr> <td>int $product_id Product id</td> <td>1</td> </tr> <tr> <td>int $order_id Order id</td> <td>1</td> </tr> <tr> <td>string $code Alias.Fieldname</td> <td>1</td> </tr> <tr> <td>string $sqlmaxforexport SQL request to parse</td> <td>1</td> </tr> <tr> <td>KnowledgeRecord $object KnowledgeRecord</td> <td>1</td> </tr> <tr> <td>string $tablename Name of table</td> <td>1</td> </tr> <tr> <td>array $elementarray Element array</td> <td>1</td> </tr> <tr> <td>array $tarr Array of all tasks</td> <td>1</td> </tr> <tr> <td>array $task Array with properties of one task</td> <td>1</td> </tr> <tr> <td>array $task_dependencies Task dependencies (array(array(0=>idtask,1=>idtasktofinishfisrt))</td> <td>1</td> </tr> <tr> <td>int $project_id Id of project</td> <td>1</td> </tr> <tr> <td>array $tarr tarr</td> <td>1</td> </tr> <tr> <td>int $parent Parent</td> <td>1</td> </tr> <tr> <td>array $task_dependencies Task dependencies</td> <td>1</td> </tr> <tr> <td>string $head Head string</td> <td>1</td> </tr> <tr> <td>int $day Day</td> <td>1</td> </tr> <tr> <td>int $month Month</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $today Today's day</td> <td>1</td> </tr> <tr> <td>array<string,array{id:string,rank:int,url:string,name:string,group:string,override?:int<0,1>,children?:array<array{id:string,rank:int,url:string,name:string,group:string,override?:int<0,1>}>}> $Tmenu Array of menu</td> <td>1</td> </tr> <tr> <td>array{id:string,rank:int,url:string,name:string,group:string,override?:int<0,1>,children?:array<array{id:string,rank:int,url:string,name:string,group:string,override?:int<0,1>,active?:bool,separator?:bool}>} $item Item of menu</td> <td>1</td> </tr> <tr> <td>int $deep Level of deep</td> <td>1</td> </tr> <tr> <td>array{rank?:int} $a PDF lines array fields configs</td> <td>1</td> </tr> <tr> <td>array{rank?:int} $b PDF lines array fields configs</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_document_root Root directory of Dolibarr bin files</td> <td>1</td> </tr> <tr> <td>string $soutitre Title</td> <td>1</td> </tr> <tr> <td>string $next Next</td> <td>1</td> </tr> <tr> <td>integer $nonext No button "Next step"</td> <td>1</td> </tr> <tr> <td>string $setuplang Language code</td> <td>1</td> </tr> <tr> <td>Position $object Position object</td> <td>1</td> </tr> <tr> <td>array $TMergedSkills skill list with all rate to add good picto</td> <td>1</td> </tr> <tr> <td>string $field which column of comparison we are working with</td> <td>1</td> </tr> <tr> <td>array $TSkill1 skill list of first column</td> <td>1</td> </tr> <tr> <td>array $TSkill2 skill list of second column</td> <td>1</td> </tr> <tr> <td>array $TUser list of users (employees) in selected usergroup of a column</td> <td>1</td> </tr> <tr> <td>int $fk_usergroup selected usergroup id</td> <td>1</td> </tr> <tr> <td>string $namelist html name</td> <td>1</td> </tr> <tr> <td>int[] $TUser array of employees we need to get skills</td> <td>1</td> </tr> <tr> <td>int $fk_job job we need to get required skills</td> <td>1</td> </tr> <tr> <td>SkillRank $object SkillRank</td> <td>1</td> </tr> <tr> <td>int $selected_rank rank we want to preselect</td> <td>1</td> </tr> <tr> <td>int $fk_skill id of skill we display ranks</td> <td>1</td> </tr> <tr> <td>string $inputname html name of input</td> <td>1</td> </tr> <tr> <td>string $mode view or edit</td> <td>1</td> </tr> <tr> <td>Skilldet $object Skilldet</td> <td>1</td> </tr> <tr> <td>Evaluation $object Evaluation</td> <td>1</td> </tr> <tr> <td>object $obj Object needed to be represented</td> <td>1</td> </tr> <tr> <td>object[] $objects all rows retrieve from sql query</td> <td>1</td> </tr> <tr> <td>Job $object Job</td> <td>1</td> </tr> <tr> <td>Position $object Position</td> <td>1</td> </tr> <tr> <td>Skill $object Skill</td> <td>1</td> </tr> <tr> <td>float $paymentAmount Amount</td> <td>1</td> </tr> <tr> <td>string $currencyCodeType Currency code</td> <td>1</td> </tr> <tr> <td>string $paymentType Payment type</td> <td>1</td> </tr> <tr> <td>string $returnURL Url to use if payment is OK</td> <td>1</td> </tr> <tr> <td>string $cancelURL Url to use if payment is KO</td> <td>1</td> </tr> <tr> <td>double $paymentAmount Payment amount</td> <td>1</td> </tr> <tr> <td>string $currencyCodeType Currency</td> <td>1</td> </tr> <tr> <td>string $paymentType Payment type</td> <td>1</td> </tr> <tr> <td>string $returnURL Return Url</td> <td>1</td> </tr> <tr> <td>string $cancelURL Cancel Url</td> <td>1</td> </tr> <tr> <td>string $tag Full tag</td> <td>1</td> </tr> <tr> <td>string $solutionType Type ('Mark' or 'Sole')</td> <td>1</td> </tr> <tr> <td>string $landingPage Landing page ('Login' or 'Billing')</td> <td>1</td> </tr> <tr> <td>string $shipToName Ship to name</td> <td>1</td> </tr> <tr> <td>string $shipToStreet Ship to street</td> <td>1</td> </tr> <tr> <td>string $shipToCity Ship to city</td> <td>1</td> </tr> <tr> <td>string $shipToState Ship to state</td> <td>1</td> </tr> <tr> <td>string $shipToCountryCode Ship to country code</td> <td>1</td> </tr> <tr> <td>string $shipToZip Ship to zip</td> <td>1</td> </tr> <tr> <td>string $shipToStreet2 Ship to street2</td> <td>1</td> </tr> <tr> <td>string $phoneNum Phone</td> <td>1</td> </tr> <tr> <td>string $email Email</td> <td>1</td> </tr> <tr> <td>string $desc Description</td> <td>1</td> </tr> <tr> <td>string $token Token</td> <td>1</td> </tr> <tr> <td>string $token Token</td> <td>1</td> </tr> <tr> <td>string $paymentType Type</td> <td>1</td> </tr> <tr> <td>string $currencyCodeType Currency</td> <td>1</td> </tr> <tr> <td>string $payerID Payer ID</td> <td>1</td> </tr> <tr> <td>string $ipaddress IP Address</td> <td>1</td> </tr> <tr> <td>string $FinalPaymentAmt Amount</td> <td>1</td> </tr> <tr> <td>string $methodName is name of API method.</td> <td>1</td> </tr> <tr> <td>string $nvpStr is nvp string.</td> <td>1</td> </tr> <tr> <td>string $nvpstr NVPString</td> <td>1</td> </tr> <tr> <td>EmailCollector $object EmailCollector</td> <td>1</td> </tr> <tr> <td>object $structure Structure of message</td> <td>1</td> </tr> <tr> <td>object $part Part of message</td> <td>1</td> </tr> <tr> <td>integer $jk Number of email</td> <td>1</td> </tr> <tr> <td>object $mbox object connection imap</td> <td>1</td> </tr> <tr> <td>integer $jk numéro du mail</td> <td>1</td> </tr> <tr> <td>integer $fpos position de la pièce jointe</td> <td>1</td> </tr> <tr> <td>integer $type type de la pièce jointe</td> <td>1</td> </tr> <tr> <td>object $mbox object connection imaap</td> <td>1</td> </tr> <tr> <td>string $path Path to file</td> <td>1</td> </tr> <tr> <td>string $filename Name of file</td> <td>1</td> </tr> <tr> <td>mixed $data Content to save</td> <td>1</td> </tr> <tr> <td>string $message Message</td> <td>1</td> </tr> <tr> <td>integer $coding Type of content</td> <td>1</td> </tr> <tr> <td>string $username Username to validate as a login</td> <td>1</td> </tr> <tr> <td>string $password Password to validate for $username</td> <td>1</td> </tr> <tr> <td>float $pv_ht Selling price without tax</td> <td>1</td> </tr> <tr> <td>float $remise_percent Discount percent on line</td> <td>1</td> </tr> <tr> <td>float $tva_tx Vat rate (not used)</td> <td>1</td> </tr> <tr> <td>float $localtax1_tx Vat rate special 1 (not used)</td> <td>1</td> </tr> <tr> <td>float $localtax2_tx Vat rate special 2 (not used)</td> <td>1</td> </tr> <tr> <td>int $fk_pa Id of buying price (prefer set this to 0 and provide $pa_ht instead. With id, buying price may have change)</td> <td>1</td> </tr> <tr> <td>float $pa_ht Buying price without tax</td> <td>1</td> </tr> <tr> <td>Partnership $object Partnership</td> <td>1</td> </tr> <tr> <td>Object $objtoshow Object to show</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix of key</td> <td>1</td> </tr> <tr> <td>int $PRICE Price</td> <td>1</td> </tr> <tr> <td>string $CURRENCY Currency</td> <td>1</td> </tr> <tr> <td>string $EMAIL EMail</td> <td>1</td> </tr> <tr> <td>string $urlok Url to go back if payment is OK</td> <td>1</td> </tr> <tr> <td>string $urlko Url to go back if payment is KO</td> <td>1</td> </tr> <tr> <td>string $TAG Full tag</td> <td>1</td> </tr> <tr> <td>string $mode Mode (test | confirm)</td> <td>1</td> </tr> <tr> <td>string $oldemail Target email</td> <td>1</td> </tr> <tr> <td>string $message Message to send</td> <td>1</td> </tr> <tr> <td>string $total Total amount of unpayed invoices</td> <td>1</td> </tr> <tr> <td>string $userlang Code lang to use for email output.</td> <td>1</td> </tr> <tr> <td>string $oldtarget Target name</td> <td>1</td> </tr> <tr> <td>string $mode Mode (test | confirm)</td> <td>1</td> </tr> <tr> <td>string $oldemail Target email</td> <td>1</td> </tr> <tr> <td>string $message Message to send</td> <td>1</td> </tr> <tr> <td>string $total Total amount of unpayed invoices</td> <td>1</td> </tr> <tr> <td>string $userlang Code lang to use for email output.</td> <td>1</td> </tr> <tr> <td>string $oldtarget Target name of sale representative</td> <td>1</td> </tr> <tr> <td>string $mode Mode (test | confirm)</td> <td>1</td> </tr> <tr> <td>string $oldemail Target email</td> <td>1</td> </tr> <tr> <td>string $message Message to send</td> <td>1</td> </tr> <tr> <td>string $total Total amount of unpayed invoices</td> <td>1</td> </tr> <tr> <td>string $userlang Code lang to use for email output.</td> <td>1</td> </tr> <tr> <td>string $oldtarget Target name</td> <td>1</td> </tr> <tr> <td>int $duration_value duration value</td> <td>1</td> </tr> <tr> <td>string $mode Mode (test | confirm)</td> <td>1</td> </tr> <tr> <td>string $oldemail Target Email</td> <td>1</td> </tr> <tr> <td>string $message Message to send</td> <td>1</td> </tr> <tr> <td>string $total Total amount of unpayed invoices</td> <td>1</td> </tr> <tr> <td>string $userlang Code lang to use for email output.</td> <td>1</td> </tr> <tr> <td>string $oldtarget Target name of sale representative</td> <td>1</td> </tr> <tr> <td>int $duration_value Duration value</td> <td>1</td> </tr> <tr> <td>string $element Value to test</td> <td>1</td> </tr> <tr> <td>User $u Object user</td> <td>1</td> </tr> <tr> <td>Product $product Object product</td> <td>1</td> </tr> <tr> <td>string $element Value to test</td> <td>1</td> </tr> <tr> <td>string $path Path</td> <td>1</td> </tr> <tr> <td>string $script_file Filename</td> <td>1</td> </tr> <tr> <td>string|int $number Number to format</td> <td>1</td> </tr> <tr> <td>int $nbdec Number of decimal digits</td> <td>1</td> </tr> <tr> <td>$filename string Path to the file to modify</td> <td>1</td> </tr> <tr> <td>$fileType string Filetype identification for the file</td> <td>1</td> </tr> <tr> <td>$name string Name of developer to add in header</td> <td>1</td> </tr> <tr> <td>$email string Email for the developer</td> <td>1</td> </tr> <tr> <td>string $l String</td> <td>1</td> </tr> <tr> <td>string $s Size to format</td> <td>1</td> </tr> <tr> <td>string $infilename Input filename</td> <td>1</td> </tr> <tr> <td>string $outfilename Output filename</td> <td>1</td> </tr> <tr> <td>array $input Array of input</td> <td>1</td> </tr> <tr> <td>array $arrayofprimaryalreadyintabledef Array of table already output with a primary key set into definition</td> <td>1</td> </tr> <tr> <td>boolean $header Boolean</td> <td>1</td> </tr> <tr> <td>array $substitutionarray Array with substitution key=>val</td> <td>1</td> </tr> <tr> <td>Translate $outlangs Output langs</td> <td>1</td> </tr> <tr> <td>Object $object Object to use to get values</td> <td>1</td> </tr> <tr> <td>Translate $outlangs Language for output</td> <td>1</td> </tr> <tr> <td>int $number Number to encode in full text</td> <td>1</td> </tr> <tr> <td>string $isamount ''=it's just a number, '1'=It's an amount (default currency), 'currencycode'=It's an amount (foreign currency)</td> <td>1</td> </tr> <tr> <td>int $flags</td> <td>1</td> </tr> <tr> <td>string $family Name of family key of array $sqls</td> <td>1</td> </tr> <tr> <td>string $date Date value</td> <td>1</td> </tr> <tr> <td>int $id Object invoice (or id of invoice)</td> <td>1</td> </tr> <tr> <td>string $modele Force le modele a utiliser ('' to not force)</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>ExpenseReport $object Object ExpenseReport</td> <td>1</td> </tr> <tr> <td>string $modele Force the model to use ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs lang object to use for translation</td> <td>1</td> </tr> <tr> <td>DoliDB $db object base de donnee</td> <td>1</td> </tr> <tr> <td>Object $object Object fichinter</td> <td>1</td> </tr> <tr> <td>bool</td> <td>1</td> </tr> <tr> <td>int $fk_workstation Id of workstation we need to get linked resources</td> <td>1</td> </tr> <tr> <td>int $fk_workstation Id of workstation we need to remove linked resources</td> <td>1</td> </tr> <tr> <td>int $status New status to set</td> <td>1</td> </tr> <tr> <td>int $fk_workstation id of workstation we need to get linked usergroups</td> <td>1</td> </tr> <tr> <td>int $fk_workstation Id of workstation we need to remove linked usergroups</td> <td>1</td> </tr> <tr> <td>int $origin_line_id Id of source line</td> <td>1</td> </tr> <tr> <td>int $rang Rang</td> <td>1</td> </tr> <tr> <td>object $line_ext Object with full information of line. $line_ext->detail_batch must be an array of ExpeditionLineBatch</td> <td>1</td> </tr> <tr> <td>string $notused Internal reference of other object</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>int $id Id of source line (order line)</td> <td>1</td> </tr> <tr> <td>array $dbatch Array of value (key 'detail' -> Array, key 'qty' total quantity for line, key ix_l : original line index)</td> <td>1</td> </tr> <tr> <td>int $id ID</td> <td>1</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>bool $also_update_stock true if the stock should be increased back (false by default)</td> <td>1</td> </tr> <tr> <td>User $user User making the deletion</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>bool $also_update_stock true if the stock should be increased back (false by default)</td> <td>1</td> </tr> <tr> <td>MyObject $object Object source to build document</td> <td>1</td> </tr> <tr> <td>User $user User making deletion</td> <td>1</td> </tr> <tr> <td>MyObject $object Object to generate</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>string $option Where the link point to</td> <td>1</td> </tr> <tr> <td>int $max Max length to show</td> <td>1</td> </tr> <tr> <td>int $short Use short labels</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=No tooltip</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>integer $delivery_date Date of delivery</td> <td>1</td> </tr> <tr> <td>string $labelmovement Label of movement</td> <td>1</td> </tr> <tr> <td>MyObject $object Object to show</td> <td>1</td> </tr> <tr> <td>string $param More parameters</td> <td>1</td> </tr> <tr> <td>array $head Array with properties of box title</td> <td>1</td> </tr> <tr> <td>array $contents Array with properties of box lines</td> <td>1</td> </tr> <tr> <td>int $nooutput No print, only return string</td> <td>1</td> </tr> <tr> <td>string $name Name</td> <td>1</td> </tr> <tr> <td>int $id ID of shipment</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter shipments of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $value Href</td> <td>1</td> </tr> <tr> <td>int $id Id of shipment to update</td> <td>1</td> </tr> <tr> <td>int $id Id of shipment to update</td> <td>1</td> </tr> <tr> <td>int $id Shipment ID</td> <td>1</td> </tr> <tr> <td>int $id Shipment ID</td> <td>1</td> </tr> <tr> <td>int $id Expedition ID</td> <td>1</td> </tr> <tr> <td>int $id_stockdluo Rowid in product_batch table</td> <td>1</td> </tr> <tr> <td>int $id_line_expdet rowid of expedtiondet record</td> <td>1</td> </tr> <tr> <td>User $f_user User that create</td> <td>1</td> </tr> <tr> <td>int $notrigger 1 = disable triggers</td> <td>1</td> </tr> <tr> <td>int $id_expedition rowid of shipment</td> <td>1</td> </tr> <tr> <td>int $id_line_expdet id of shipment line</td> <td>1</td> </tr> <tr> <td>int $fk_product If provided, load also detailed information of lot</td> <td>1</td> </tr> <tr> <td>int $nolines 0=Default to load extrafields, 1=No extrafields</td> <td>1</td> </tr> <tr> <td>int $limit Limit the number of lines returned</td> <td>1</td> </tr> <tr> <td>array $parameters Array of parameters</td> <td>1</td> </tr> <tr> <td>string $action 'add', 'update', 'view'</td> <td>1</td> </tr> <tr> <td>Object $object Object output on PDF</td> <td>1</td> </tr> <tr> <td>string $action 'add', 'update', 'view'</td> <td>1</td> </tr> <tr> <td>Object $pdfhandler PDF builder handler</td> <td>1</td> </tr> <tr> <td>string $action 'add', 'update', 'view'</td> <td>1</td> </tr> <tr> <td>array $parameters Array of parameters</td> <td>1</td> </tr> <tr> <td>string $action 'add', 'update', 'view'</td> <td>1</td> </tr> <tr> <td>Hookmanager $hookmanager hookmanager</td> <td>1</td> </tr> <tr> <td>int $id ID of myobject</td> <td>1</td> </tr> <tr> <td>int $id Id of myobject to update</td> <td>1</td> </tr> <tr> <td>int $id MyObject ID</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.product_id:=:1) and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>int $id ID of Currency</td> <td>1</td> </tr> <tr> <td>string $code Code of Currency (ex: EUR)</td> <td>1</td> </tr> <tr> <td>int $id ID of Currency</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>int $id Id of Currency to update</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id Currency ID</td> <td>1</td> </tr> <tr> <td>int $id Currency ID</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>MultiCurrency $object Object to clean</td> <td>1</td> </tr> <tr> <td>MultiCurrency $object Object to clean</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $code code</td> <td>1</td> </tr> <tr> <td>string $code currency code</td> <td>1</td> </tr> <tr> <td>double $rate new rate</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs object db</td> <td>1</td> </tr> <tr> <td>string $code code value search</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Object db</td> <td>1</td> </tr> <tr> <td>string $code Code value search</td> <td>1</td> </tr> <tr> <td>integer|string $date_document Date from document (propal, order, invoice, ...)</td> <td>1</td> </tr> <tr> <td>int $fk_facture Id of invoice</td> <td>1</td> </tr> <tr> <td>double $amount amount to convert</td> <td>1</td> </tr> <tr> <td>string $way 'dolibarr' mean the amount is in dolibarr currency</td> <td>1</td> </tr> <tr> <td>string $table 'facture' or 'facture_fourn'</td> <td>1</td> </tr> <tr> <td>float|null $invoice_rate Invoice rate if known (to avoid to make the getInvoiceRate call)</td> <td>1</td> </tr> <tr> <td>int $fk_facture id of facture</td> <td>1</td> </tr> <tr> <td>string $table facture or facture_fourn</td> <td>1</td> </tr> <tr> <td>stdClass $TRate Object containing all currencies rates</td> <td>1</td> </tr> <tr> <td>string $key Key to use. Come from getDolGlobalString("MULTICURRENCY_APP_ID")</td> <td>1</td> </tr> <tr> <td>int $addifnotfound Add if not found</td> <td>1</td> </tr> <tr> <td>string $mode "" for standard use, "cron" to use it in a cronjob</td> <td>1</td> </tr> <tr> <td>string $code current code to search</td> <td>1</td> </tr> <tr> <td>User $user User making the deletion</td> <td>1</td> </tr> <tr> <td>int $fk_multicurrency Id of currency</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of ref</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $id id du contrat a charger</td> <td>1</td> </tr> <tr> <td>int $status Status of lines to get</td> <td>1</td> </tr> <tr> <td>string $option 'all' or 'others'</td> <td>1</td> </tr> <tr> <td>array $status sort contracts having these status</td> <td>1</td> </tr> <tr> <td>array $product_categories sort contracts containing these product categories</td> <td>1</td> </tr> <tr> <td>array $line_status sort contracts where lines have these status</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>string $mode "inactive" pour services a activer, "expired" pour services expires</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $socid Id of thirdparty</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>int $thirdparty_id Thirdparty id</td> <td>1</td> </tr> <tr> <td>int $delayindaysshort To renew the resources x day before (positive value) or after (negative value) the end of date (default is 0)</td> <td>1</td> </tr> <tr> <td>int $expired 0=Not expired, 1=Expired, -1=Both or unknown</td> <td>1</td> </tr> <tr> <td>string $moreatt More attribute</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length</td> <td>1</td> </tr> <tr> <td>string $ref Ref of contract line</td> <td>1</td> </tr> <tr> <td>int $end1 the ending index for the first sequence</td> <td>1</td> </tr> <tr> <td>int $end2 the ending index for the second sequence</td> <td>1</td> </tr> <tr> <td>int $notrigger Set to 1 if you don't want triggers to be fired</td> <td>1</td> </tr> <tr> <td>User $user Object User who activate contract</td> <td>1</td> </tr> <tr> <td>int $date Date real activation</td> <td>1</td> </tr> <tr> <td>int|string $date_end Date planned end. Use '-1' to keep it unchanged.</td> <td>1</td> </tr> <tr> <td>string $comment A comment typed by user</td> <td>1</td> </tr> <tr> <td>User $user Object User who close contract</td> <td>1</td> </tr> <tr> <td>int $date_end_real Date end</td> <td>1</td> </tr> <tr> <td>string $comment A comment typed by user</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>int $id ID of contract</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter contracts of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $id Id of contract</td> <td>1</td> </tr> <tr> <td>string $dateend {@from body} Date end {@type timestamp}</td> <td>1</td> </tr> <tr> <td>int $id Id of contract to update</td> <td>1</td> </tr> <tr> <td>int $id Id of contract to update</td> <td>1</td> </tr> <tr> <td>int $id Contract ID</td> <td>1</td> </tr> <tr> <td>int $id object ID</td> <td>1</td> </tr> <tr> <td>string $mode 'O' for create, R for regenerate (Look always 0 meant toujours 0 within the framework of XML exchanges according to documentation)</td> <td>1</td> </tr> <tr> <td>string $type Declaration type by default - introduction or expedition (always 'expedition' for Des)</td> <td>1</td> </tr> <tr> <td>string $period_reference Period of reference</td> <td>1</td> </tr> <tr> <td>int $period_year Year of declaration</td> <td>1</td> </tr> <tr> <td>int $period_month Month of declaration</td> <td>1</td> </tr> <tr> <td>string $type_declaration Declaration type by default - 'introduction' or 'expedition' (always 'expedition' for Des)</td> <td>1</td> </tr> <tr> <td>string $type Declaration type by default - 'introduction' or 'expedition' (always 'expedition' for Des)</td> <td>1</td> </tr> <tr> <td>int $period_reference Reference period</td> <td>1</td> </tr> <tr> <td>string $exporttype 'deb' for DEB, 'des' for DES</td> <td>1</td> </tr> <tr> <td>string $type Declaration type by default - introduction or expedition (always 'expedition' for Des)</td> <td>1</td> </tr> <tr> <td>int $period_reference Reference declaration</td> <td>1</td> </tr> <tr> <td>string $exporttype deb=DEB, des=DES</td> <td>1</td> </tr> <tr> <td>string $code_douane_spe Specific customs authorities code</td> <td>1</td> </tr> <tr> <td>array $TLinesFraisDePort Data of shipping costs line</td> <td>1</td> </tr> <tr> <td>string $type Declaration type by default - introduction or expedition (always 'expedition' for Des)</td> <td>1</td> </tr> <tr> <td>Categorie $categ_fraisdeport category of shipping costs</td> <td>1</td> </tr> <tr> <td>int $i Line Id</td> <td>1</td> </tr> <tr> <td>string $number Number to verify / convert</td> <td>1</td> </tr> <tr> <td>string $content_xml Content</td> <td>1</td> </tr> <tr> <td>User $user Object User who activate contract</td> <td>1</td> </tr> <tr> <td>int $line_id Id of line to activate</td> <td>1</td> </tr> <tr> <td>int $date_start Opening date</td> <td>1</td> </tr> <tr> <td>int|string $date_end Expected end date</td> <td>1</td> </tr> <tr> <td>User $user Object User who close contract</td> <td>1</td> </tr> <tr> <td>int $line_id Id of line to close</td> <td>1</td> </tr> <tr> <td>int $date_end End date</td> <td>1</td> </tr> <tr> <td>int|string $date_start Date start (now if empty)</td> <td>1</td> </tr> <tr> <td>int|string $date_end Date end</td> <td>1</td> </tr> <tr> <td>string $force_number Reference to force on contract (not implemented yet)</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=execute triggers</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $numsurvey Ref of survey (admin or not)</td> <td>1</td> </tr> <tr> <td>int $id Id of contract to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>string $ref_customer Customer ref</td> <td>1</td> </tr> <tr> <td>string $ref_supplier Supplier ref</td> <td>1</td> </tr> <tr> <td>int $only_services 0=Default for all, 1=Force only services (depending on setup, we may also have physical products in a contract)</td> <td>1</td> </tr> <tr> <td>int $loadalsotranslation 0=Default to not load translations, 1=Load also translations of product descriptions</td> <td>1</td> </tr> <tr> <td>int $noextrafields 0=Default to load extrafields, 1=Do not load the extrafields of lines</td> <td>1</td> </tr> <tr> <td>User $user User that modifies</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>string $numsondage Num sondage admin to delete</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>float $pu_ht Unit price net</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float $txtva Vat rate</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Local tax 1 rate</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Local tax 2 rate</td> <td>1</td> </tr> <tr> <td>int $fk_product Id produit</td> <td>1</td> </tr> <tr> <td>float $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>int $date_start Date de debut prevue</td> <td>1</td> </tr> <tr> <td>int $date_end Date de fin prevue</td> <td>1</td> </tr> <tr> <td>int $rowid Id de la ligne de facture</td> <td>1</td> </tr> <tr> <td>string $desc Description de la ligne</td> <td>1</td> </tr> <tr> <td>float $pu Prix unitaire</td> <td>1</td> </tr> <tr> <td>float $qty Quantite</td> <td>1</td> </tr> <tr> <td>float $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>int $date_start Date de debut prevue</td> <td>1</td> </tr> <tr> <td>int $date_end Date de fin prevue</td> <td>1</td> </tr> <tr> <td>float $tvatx Taux TVA</td> <td>1</td> </tr> <tr> <td>float $localtax1tx Local tax 1 rate</td> <td>1</td> </tr> <tr> <td>float $localtax2tx Local tax 2 rate</td> <td>1</td> </tr> <tr> <td>int|string $date_start_real Date de debut reelle</td> <td>1</td> </tr> <tr> <td>int|string $date_end_real Date de fin reelle</td> <td>1</td> </tr> <tr> <td>string $comment Comment content</td> <td>1</td> </tr> <tr> <td>string $comment_user Comment author</td> <td>1</td> </tr> <tr> <td>string $user_ip Comment author IP</td> <td>1</td> </tr> <tr> <td>int $id_comment Id of the comment</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto, 7=Same than 6 with fixed length</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label (status of services), 5=Short label + Picto, 6=Long label + Picto (status of services), 7=Same than 6 with fixed length (status of services)</td> <td>1</td> </tr> <tr> <td>string $ref Ref object</td> <td>1</td> </tr> <tr> <td>int|string $user_id ID of user to list, or comma separated list of IDs of users to list</td> <td>1</td> </tr> <tr> <td>string $order Sort order</td> <td>1</td> </tr> <tr> <td>string $filter SQL Filter</td> <td>1</td> </tr> <tr> <td>string $order Sort order</td> <td>1</td> </tr> <tr> <td>string $filter SQL Filter</td> <td>1</td> </tr> <tr> <td>User $user User that validate</td> <td>1</td> </tr> <tr> <td>User $user User that approve</td> <td>1</td> </tr> <tr> <td>int $fk_user Id user</td> <td>1</td> </tr> <tr> <td>integer $dateStart Start date of period to check</td> <td>1</td> </tr> <tr> <td>integer $dateEnd End date of period to check</td> <td>1</td> </tr> <tr> <td>int $halfday Tag to define how start and end the period to check:</td> <td>1</td> </tr> <tr> <td>int $fk_user Id user</td> <td>1</td> </tr> <tr> <td>integer $timestamp Time stamp date for a day (YYYY-MM-DD) without hours (= 12:00AM in english and not 12:00PM that is 12:00)</td> <td>1</td> </tr> <tr> <td>string $status Filter on holiday status. '-1' = no filter.</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=_No picto, 1=Includes the picto in the linkn, 2=Picto only</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int|string $startdate Date holiday should start</td> <td>1</td> </tr> <tr> <td>int $selected Id of preselected status</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS on select component</td> <td>1</td> </tr> <tr> <td>string $name name du paramètre de configuration</td> <td>1</td> </tr> <tr> <td>string $value vrai si mise à jour OK sinon faux</td> <td>1</td> </tr> <tr> <td>string $name Name of parameter</td> <td>1</td> </tr> <tr> <td>string $createifnotfound 'stringvalue'=Create entry with string value if not found. For example 'YYYYMMDDHHMMSS'.</td> <td>1</td> </tr> <tr> <td>int $userID Id of user</td> <td>1</td> </tr> <tr> <td>float $nbHoliday Nb of days</td> <td>1</td> </tr> <tr> <td>int $fk_type Type of vacation</td> <td>1</td> </tr> <tr> <td>boolean $single Single</td> <td>1</td> </tr> <tr> <td>int $userid Id user</td> <td>1</td> </tr> <tr> <td>int $user_id User ID</td> <td>1</td> </tr> <tr> <td>int $fk_type Filter on type</td> <td>1</td> </tr> <tr> <td>boolean $stringlist If true return a string list of id. If false, return an array with detail.</td> <td>1</td> </tr> <tr> <td>boolean $type If true, read Dolibarr user list, if false, return vacation balance list.</td> <td>1</td> </tr> <tr> <td>string $filters Filters. Warning: This must not contains data from user input.</td> <td>1</td> </tr> <tr> <td>int $userDolibarrWithoutCP Number of active users in Dolibarr without holidays</td> <td>1</td> </tr> <tr> <td>int $userCP Number of active users into table of holidays</td> <td>1</td> </tr> <tr> <td>int $fk_user_action Id user creation</td> <td>1</td> </tr> <tr> <td>int $fk_user_update Id user update</td> <td>1</td> </tr> <tr> <td>string $label Label (Example: 'Leave', 'Manual update', 'Leave request cancelation'...)</td> <td>1</td> </tr> <tr> <td>int $new_solde New value</td> <td>1</td> </tr> <tr> <td>int $fk_type Type of vacation</td> <td>1</td> </tr> <tr> <td>string $order Filtrage par ordre</td> <td>1</td> </tr> <tr> <td>string $filter Filtre de séléction</td> <td>1</td> </tr> <tr> <td>int $active Status of type. -1 = Both</td> <td>1</td> </tr> <tr> <td>int $affect Filter on affect (a request will change sold or not). -1 = Both</td> <td>1</td> </tr> <tr> <td>array $arraydata Label of holiday type (if known)</td> <td>1</td> </tr> <tr> <td>DoliDB $db Handler access data base</td> <td>1</td> </tr> <tr> <td>int $socid Id third party</td> <td>1</td> </tr> <tr> <td>int $userid Id user for filter</td> <td>1</td> </tr> <tr> <td>int $id ID of subscription</td> <td>1</td> </tr> <tr> <td>int $id ID of subscription to update</td> <td>1</td> </tr> <tr> <td>int $id ID of subscription to delete</td> <td>1</td> </tr> <tr> <td>string $text Text to make substitution to</td> <td>1</td> </tr> <tr> <td>int<0,2> $addbadge Add badge (1=Full label, 2=First letters only)</td> <td>1</td> </tr> <tr> <td>User $user Object user qui demande la creation</td> <td>1</td> </tr> <tr> <td>int $notrigger 1 ne declenche pas les triggers, 0 sinon</td> <td>1</td> </tr> <tr> <td>int $nosyncuser 0=Synchronize linked user (standard info), 1=Do not synchronize linked user</td> <td>1</td> </tr> <tr> <td>int $nosyncuserpass 0=Synchronize linked user (password), 1=Do not synchronize linked user</td> <td>1</td> </tr> <tr> <td>int $nosyncthirdparty 0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty</td> <td>1</td> </tr> <tr> <td>string $action Current action for hookmanager</td> <td>1</td> </tr> <tr> <td>User $user User making change</td> <td>1</td> </tr> <tr> <td>User $user Object user de l'utilisateur qui fait la modification</td> <td>1</td> </tr> <tr> <td>string $password New password (to generate if empty)</td> <td>1</td> </tr> <tr> <td>int $isencrypted 0 ou 1 if the password needs to be encrypted in the DB (default: 0)</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not raise the triggers</td> <td>1</td> </tr> <tr> <td>int $nosyncuser Do not synchronize linked user</td> <td>1</td> </tr> <tr> <td>int $userid Id of user to link to</td> <td>1</td> </tr> <tr> <td>int $thirdpartyid Id of user to link to</td> <td>1</td> </tr> <tr> <td>string $login login of member</td> <td>1</td> </tr> <tr> <td>string $firstname Firstname</td> <td>1</td> </tr> <tr> <td>string $lastname Lastname</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref To load member from its ref</td> <td>1</td> </tr> <tr> <td>int $fk_soc To load member from its link to third party</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference</td> <td>1</td> </tr> <tr> <td>bool $fetch_optionals To load optionals (extrafields)</td> <td>1</td> </tr> <tr> <td>bool $fetch_subscriptions To load member subscriptions</td> <td>1</td> </tr> <tr> <td>int $date Date of effect of subscription</td> <td>1</td> </tr> <tr> <td>double $amount Amount of subscription (0 accepted for some members)</td> <td>1</td> </tr> <tr> <td>int $accountid Id bank account. NOT USED.</td> <td>1</td> </tr> <tr> <td>string $operation Code of payment mode (if Id bank account provided). Example: 'CB', ... NOT USED.</td> <td>1</td> </tr> <tr> <td>string $label Label operation (if Id bank account provided).</td> <td>1</td> </tr> <tr> <td>string $num_chq Numero cheque (if Id bank account provided)</td> <td>1</td> </tr> <tr> <td>string $emetteur_nom Name of cheque writer</td> <td>1</td> </tr> <tr> <td>string $emetteur_banque Name of bank of cheque</td> <td>1</td> </tr> <tr> <td>int $datesubend Date end subscription</td> <td>1</td> </tr> <tr> <td>int $fk_type Member type id</td> <td>1</td> </tr> <tr> <td>int $subscriptionid Id of created subscription</td> <td>1</td> </tr> <tr> <td>string $option Which action ('bankdirect', 'bankviainvoice', 'invoiceonly', ...)</td> <td>1</td> </tr> <tr> <td>int $accountid Id bank account</td> <td>1</td> </tr> <tr> <td>int $datesubscription Date of subscription</td> <td>1</td> </tr> <tr> <td>int $paymentdate Date of payment</td> <td>1</td> </tr> <tr> <td>string $operation Code of type of operation (if Id bank account provided). Example 'CB', ...</td> <td>1</td> </tr> <tr> <td>string $label Label operation (if Id bank account provided)</td> <td>1</td> </tr> <tr> <td>double $amount Amount of subscription (0 accepted for some members)</td> <td>1</td> </tr> <tr> <td>string $num_chq Numero cheque (if Id bank account provided)</td> <td>1</td> </tr> <tr> <td>string $emetteur_nom Name of cheque writer</td> <td>1</td> </tr> <tr> <td>string $emetteur_banque Name of bank of cheque</td> <td>1</td> </tr> <tr> <td>int $autocreatethirdparty Auto create new thirdparty if member not yet linked to a thirdparty and we request an option that generate invoice.</td> <td>1</td> </tr> <tr> <td>string $ext_payment_id External id of payment (for example Stripe charge id)</td> <td>1</td> </tr> <tr> <td>string $ext_payment_site Name of external paymentmode (for example 'stripe')</td> <td>1</td> </tr> <tr> <td>User $user user adherent qui valide</td> <td>1</td> </tr> <tr> <td>int $withpictoimg 0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small)</td> <td>1</td> </tr> <tr> <td>string $option Page for link ('card', 'category', 'subscription', ...)</td> <td>1</td> </tr> <tr> <td>string $mode ''=Show firstname+lastname as label (using default order), 'firstname'=Show only firstname, 'lastname'=Show only lastname, 'login'=Show login, 'ref'=Show ref</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes 1=Add link to notes</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int $need_subscription 1 if member type need subscription, 0 otherwise</td> <td>1</td> </tr> <tr> <td>int $date_end_subscription Date fin adhesion</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $mode "expired" for membership to renew, "shift" for member to validate</td> <td>1</td> </tr> <tr> <td>int $id Id of member to load</td> <td>1</td> </tr> <tr> <td>string $daysbeforeendlist Nb of days before end of subscription (negative number = after subscription). Can be a list of delay, separated by a semicolon, for example '10;5;0;-5'</td> <td>1</td> </tr> <tr> <td>string $langtodelete Language code to delete</td> <td>1</td> </tr> <tr> <td>User $user Object user making delete</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>User $user Object user making change</td> <td>1</td> </tr> <tr> <td>int $rowid Id of member type to load</td> <td>1</td> </tr> <tr> <td>string $excludefilter Filter to exclude. This value must not come from a user input.</td> <td>1</td> </tr> <tr> <td>int $mode 0=Return array of member instance</td> <td>1</td> </tr> <tr> <td>int $id ID of member</td> <td>1</td> </tr> <tr> <td>int $thirdparty ID of third party</td> <td>1</td> </tr> <tr> <td>string $email Email of third party</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of third party</td> <td>1</td> </tr> <tr> <td>string $typeid ID of the type of member</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma.</td> <td>1</td> </tr> <tr> <td>int $id ID of member to update</td> <td>1</td> </tr> <tr> <td>int $id member ID</td> <td>1</td> </tr> <tr> <td>Object $object Object to clean</td> <td>1</td> </tr> <tr> <td>int $id ID of member</td> <td>1</td> </tr> <tr> <td>int $id ID of member</td> <td>1</td> </tr> <tr> <td>string $start_date Start date {@from body} {@type timestamp}</td> <td>1</td> </tr> <tr> <td>string $end_date End date {@from body} {@type timestamp}</td> <td>1</td> </tr> <tr> <td>float $amount Amount (may be 0) {@from body}</td> <td>1</td> </tr> <tr> <td>string $label Label {@from body}</td> <td>1</td> </tr> <tr> <td>int $id ID of member</td> <td>1</td> </tr> <tr> <td>int $id ID of member type</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.libelle:like:'SO-%') and (t.subscription:=:'1')"</td> <td>1</td> </tr> <tr> <td>int $id ID of member type to update</td> <td>1</td> </tr> <tr> <td>int $id member type ID</td> <td>1</td> </tr> <tr> <td>User $user User that create</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $rowid Id subscription</td> <td>1</td> </tr> <tr> <td>User $user User who updated</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=Disable triggers</td> <td>1</td> </tr> <tr> <td>string $option Page for link ('', 'nolink', ...)</td> <td>1</td> </tr> <tr> <td>int $id Id subscription</td> <td>1</td> </tr> <tr> <td>string $resok resultat si test equal</td> <td>1</td> </tr> <tr> <td>string $resko resultat si test non equal</td> <td>1</td> </tr> <tr> <td>string $line SQL request line to convert</td> <td>1</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>1</td> </tr> <tr> <td>resource $resultset Curseur de la requete voulue</td> <td>1</td> </tr> <tr> <td>string $stringtoencode String to escape</td> <td>1</td> </tr> <tr> <td>string $tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql</td> <td>1</td> </tr> <tr> <td>string $query SQL query string</td> <td>1</td> </tr> <tr> <td>int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).</td> <td>1</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>1</td> </tr> <tr> <td>int $result_mode Result mode</td> <td>1</td> </tr> <tr> <td>string $sql query string</td> <td>1</td> </tr> <tr> <td>string $resql query result</td> <td>1</td> </tr> <tr> <td>string $host database server host</td> <td>1</td> </tr> <tr> <td>string $login login</td> <td>1</td> </tr> <tr> <td>string $passwd password</td> <td>1</td> </tr> <tr> <td>string $name name of database (not used for mysql, used for pgsql)</td> <td>1</td> </tr> <tr> <td>int $port Port of database server</td> <td>1</td> </tr> <tr> <td>resource $resultset Resulset of requests</td> <td>1</td> </tr> <tr> <td>string $primary_key Nom du champ qui sera la clef primaire</td> <td>1</td> </tr> <tr> <td>string $type Type de la table</td> <td>1</td> </tr> <tr> <td>array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur</td> <td>1</td> </tr> <tr> <td>array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext</td> <td>1</td> </tr> <tr> <td>array $keys Tableau des champs cles noms => valeur</td> <td>1</td> </tr> <tr> <td>array{type:string,label:string,enabled:int|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Tableau associatif de description du champ a inserer[nom du parameter][valeur du parameter]</td> <td>1</td> </tr> <tr> <td>string $field_position Optionnel ex.: "after champtruc"</td> <td>1</td> </tr> <tr> <td>array{type:string,label:string,enabled:int|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Array with description of field format</td> <td>1</td> </tr> <tr> <td>string $field Optionnel : Name of field if we want description of field</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_host Ip serveur</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_user Nom user a creer</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_pass Password user a creer</td> <td>1</td> </tr> <tr> <td>resource $resultset Fre cursor</td> <td>1</td> </tr> <tr> <td>resource|PgSql\Connection $resultset Handler of the desired SQL request</td> <td>1</td> </tr> <tr> <td>string $database Name of database</td> <td>1</td> </tr> <tr> <td>string $baseUrl Base url</td> <td>1</td> </tr> <tr> <td>string $basePath Base path</td> <td>1</td> </tr> <tr> <td>string $name The name used by this collector widget.</td> <td>1</td> </tr> <tr> <td>int $severity Error type.</td> <td>1</td> </tr> <tr> <td>string $message Message of error.</td> <td>1</td> </tr> <tr> <td>string $fileName File where error is generated.</td> <td>1</td> </tr> <tr> <td>int $line Line number where error is generated.</td> <td>1</td> </tr> <tr> <td>int $type Error code.</td> <td>1</td> </tr> <tr> <td>string $path Path</td> <td>1</td> </tr> <tr> <td>string $name Name</td> <td>1</td> </tr> <tr> <td>string $path Path</td> <td>1</td> </tr> <tr> <td>string $file File</td> <td>1</td> </tr> <tr> <td>int $lines Lines</td> <td>1</td> </tr> <tr> <td>string $file File</td> <td>1</td> </tr> <tr> <td>mixed $obj Object</td> <td>1</td> </tr> <tr> <td>string $action Code action</td> <td>1</td> </tr> <tr> <td>User $user Object user that create</td> <td>1</td> </tr> <tr> <td>int $id Id of contact/address to update</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>string $action Current action for hookmanager</td> <td>1</td> </tr> <tr> <td>int $nosyncuser No sync linked user (external users and contacts are linked)</td> <td>1</td> </tr> <tr> <td>array $info Info string loaded by _load_ldap_info</td> <td>1</td> </tr> <tr> <td>int $id Id of contact</td> <td>1</td> </tr> <tr> <td>User $user User asking to change alert or birthday</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>int $id Id of contact</td> <td>1</td> </tr> <tr> <td>?User $user Load also alerts of this user (subscribing to alerts) that want alerts about this contact</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference, not given by Dolibarr</td> <td>1</td> </tr> <tr> <td>string $email Email</td> <td>1</td> </tr> <tr> <td>int $loadalsoroles Load also roles. Try to always 0 here and load roles with a separate call of fetchRoles().</td> <td>1</td> </tr> <tr> <td>User $user User making the delete</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable all trigger</td> <td>1</td> </tr> <tr> <td>int $id Id of the contact to load</td> <td>1</td> </tr> <tr> <td>int $withpicto Include picto with link (1=picto + name, 2=picto only, -1=photo+name, -2=photo only)</td> <td>1</td> </tr> <tr> <td>string $option Where the link point to</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length of</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more param into URL</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $status Type (0 = public, 1 = private)</td> <td>1</td> </tr> <tr> <td>string $element Element type</td> <td>1</td> </tr> <tr> <td>User $user User who defines the discount</td> <td>1</td> </tr> <tr> <td>int|string $statut Id or code for prospection status</td> <td>1</td> </tr> <tr> <td>User|null $user User that modify</td> <td>1</td> </tr> <tr> <td>double $capital Capital</td> <td>1</td> </tr> <tr> <td>double $rate rate</td> <td>1</td> </tr> <tr> <td>int $nbterm nb term</td> <td>1</td> </tr> <tr> <td>int $loanid Id object</td> <td>1</td> </tr> <tr> <td>int $loanid Loan id</td> <td>1</td> </tr> <tr> <td>int $loanid Loan id</td> <td>1</td> </tr> <tr> <td>int $datemax Date max</td> <td>1</td> </tr> <tr> <td>int $id id object</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>User $user Object user making delete</td> <td>1</td> </tr> <tr> <td>User $user User who modified</td> <td>1</td> </tr> <tr> <td>int $mode 0=label, 1=short label, 2=Picto + Short label, 3=Picto, 4=Picto + Label</td> <td>1</td> </tr> <tr> <td>int $mode 0=Label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $maxlen Label max length</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('nolink', ...)</td> <td>1</td> </tr> <tr> <td>int $id Id of record</td> <td>1</td> </tr> <tr> <td>int $status Statut</td> <td>1</td> </tr> <tr> <td>int $fk_loan Id of fk_loan to do link with this payment</td> <td>1</td> </tr> <tr> <td>string $mode 'payment_loan'</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=No picto</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length label</td> <td>1</td> </tr> <tr> <td>User $user User that creates //not used</td> <td>1</td> </tr> <tr> <td>int $fk_combination ID of the ProductCombination</td> <td>1</td> </tr> <tr> <td>int $fk_combination ID of the ProductCombination</td> <td>1</td> </tr> <tr> <td>int $id Attribute id</td> <td>1</td> </tr> <tr> <td>User $user User who updates the attribute</td> <td>1</td> </tr> <tr> <td>0|1 $notrigger 1 = Do not execute trigger (0 by default)</td> <td>1</td> </tr> <tr> <td>string $filters Filter on other fields</td> <td>1</td> </tr> <tr> <td>string $filters Filter on other fields</td> <td>1</td> </tr> <tr> <td>int $position Position of line</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line</td> <td>1</td> </tr> <tr> <td>array $rows Array of rows</td> <td>1</td> </tr> <tr> <td>int $selected Object line selected</td> <td>1</td> </tr> <tr> <td>int $addcreateline 1=Add create line</td> <td>1</td> </tr> <tr> <td>string $var Is it a an odd line (true)</td> <td>1</td> </tr> <tr> <td>int $selected Object line selected</td> <td>1</td> </tr> <tr> <td>int $rowid ID of the ProductCombination</td> <td>1</td> </tr> <tr> <td>int $fk_price_level The price level to fetch, use 0 for all</td> <td>1</td> </tr> <tr> <td>bool $useCache To use cache or not</td> <td>1</td> </tr> <tr> <td>int $clean Levels of PRODUIT_MULTIPRICES_LIMIT</td> <td>1</td> </tr> <tr> <td>int $productid Product ID of variant</td> <td>1</td> </tr> <tr> <td>int $donotloadpricelevel Avoid loading price impact for each level. If PRODUIT_MULTIPRICES is not set, this has no effect.</td> <td>1</td> </tr> <tr> <td>int $fk_product_parent Rowid of parent product</td> <td>1</td> </tr> <tr> <td>bool $sort_by_ref Sort result by product child reference</td> <td>1</td> </tr> <tr> <td>int $fk_product_parent Id of parent product</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $fk_product_parent Rowid of parent product</td> <td>1</td> </tr> <tr> <td>Product $parent Parent product</td> <td>1</td> </tr> <tr> <td>int $prodid Id of parent product</td> <td>1</td> </tr> <tr> <td>array<string,string> $features Format: [$attr] => $attr_val</td> <td>1</td> </tr> <tr> <td>int $productid Parent Product rowid</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Product $product Parent product</td> <td>1</td> </tr> <tr> <td>array<int,int> $combinations Attribute and value combinations.</td> <td>1</td> </tr> <tr> <td>array<string,array<string,array{weight:string|float,price:string|float}>> $variations Price and weight variations</td> <td>1</td> </tr> <tr> <td>bool|array $price_var_percent Is the price variation a relative variation?</td> <td>1</td> </tr> <tr> <td>bool|float $forced_pricevar If the price variation is forced</td> <td>1</td> </tr> <tr> <td>bool|float $forced_weightvar If the weight variation is forced</td> <td>1</td> </tr> <tr> <td>bool|string $forced_refvar If the reference is forced</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference</td> <td>1</td> </tr> <tr> <td>int $origProductId Origin product id</td> <td>1</td> </tr> <tr> <td>Product $destProduct Destination product</td> <td>1</td> </tr> <tr> <td>int $prod_child id of child</td> <td>1</td> </tr> <tr> <td>int $rowid Row id</td> <td>1</td> </tr> <tr> <td>int $fk_product_attribute_combination Id of product combination</td> <td>1</td> </tr> <tr> <td>int $fk_price_level The price level to fetch, use 0 for all</td> <td>1</td> </tr> <tr> <td>Object $obj Object resultset</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>ProductCombination $productCombination Product combination</td> <td>1</td> </tr> <tr> <td>int $fkPriceLevel Price level</td> <td>1</td> </tr> <tr> <td>int $id Product attribute value id</td> <td>1</td> </tr> <tr> <td>int $prodattr_id Product attribute id</td> <td>1</td> </tr> <tr> <td>bool $only_used Fetch only used attribute values</td> <td>1</td> </tr> <tr> <td>int<0,1> $returnonlydata 0: return object, 1: return only data</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $rowid Id</td> <td>1</td> </tr> <tr> <td>string $ref ref</td> <td>1</td> </tr> <tr> <td>User $user making insert</td> <td>1</td> </tr> <tr> <td>string $period Period : 'lastmonth', 'currentmonth', 'last3months', 'last6months', 'currentyear', 'lastyear', 'fiscalyear', 'lastfiscalyear', 'actualandlastfiscalyear' or 'custom' (see above)</td> <td>1</td> </tr> <tr> <td>string $date_min [=''] Start date of period if 'custom' is set in period parameter</td> <td>1</td> </tr> <tr> <td>string $date_max [=''] End date of period if 'custom' is set in period parameter</td> <td>1</td> </tr> <tr> <td>string $format [=''] by default uses '1' for 'Configurable (CSV)' for format number</td> <td>1</td> </tr> <tr> <td>int $lettering [=0] by default don't export or 1 to export lettering data (columns 'letterring_code' and 'date_lettering' returns empty or not)</td> <td>1</td> </tr> <tr> <td>int $alreadyexport [=0] by default export data only if it's not yet exported or 1 already exported (always export data even if 'date_export" is set)</td> <td>1</td> </tr> <tr> <td>int $notnotifiedasexport [=0] by default notified as exported or 1 not notified as exported (when the export is done, notified or not the column 'date_export')</td> <td>1</td> </tr> <tr> <td>int $rowid Id</td> <td>1</td> </tr> <tr> <td>string|null $account_number Account number</td> <td>1</td> </tr> <tr> <td>int|boolean $limittocurrentchart 1 or true=Load record only if it is into current active chart of account</td> <td>1</td> </tr> <tr> <td>string $limittoachartaccount 'ABC'=Load record only if it is into chart account with code 'ABC' (better and faster than previous parameter if you have chart of account code).</td> <td>1</td> </tr> <tr> <td>User $user User making action</td> <td>1</td> </tr> <tr> <td>User $user User making update</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto</td> <td>1</td> </tr> <tr> <td>int $withlabel 0=No label, 1=Include label of account</td> <td>1</td> </tr> <tr> <td>int $nourl 1=Disable url</td> <td>1</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>int $withcompletelabel 0=Short label (field short label), 1=Complete label (field label)</td> <td>1</td> </tr> <tr> <td>string $option 'ledger', 'journals', 'accountcard'</td> <td>1</td> </tr> <tr> <td>int $id ID of record</td> <td>1</td> </tr> <tr> <td>Societe $buyer Object buyer</td> <td>1</td> </tr> <tr> <td>Societe $seller Object seller</td> <td>1</td> </tr> <tr> <td>Product $product Product object sell or buy</td> <td>1</td> </tr> <tr> <td>Facture|FactureFournisseur $facture Facture</td> <td>1</td> </tr> <tr> <td>FactureLigne|SupplierInvoiceLine $factureDet Facture Det</td> <td>1</td> </tr> <tr> <td>array $accountingAccount Array of Accounting account</td> <td>1</td> </tr> <tr> <td>string $type Customer / Supplier</td> <td>1</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>string $mode Mode</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit limit</td> <td>1</td> </tr> <tr> <td>int $offset offset limit</td> <td>1</td> </tr> <tr> <td>array $filter filter array</td> <td>1</td> </tr> <tr> <td>string $filtermode filter mode (AND or OR)</td> <td>1</td> </tr> <tr> <td>int $option option (0: general account or 1: subaccount)</td> <td>1</td> </tr> <tr> <td>int $countonly Do not fill the $object->lines, return only the count.</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset limit</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter array</td> <td>1</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>1</td> </tr> <tr> <td>int $showAlreadyExportMovements Show movements when field 'date_export' is not empty (0:No / 1:Yes (Default))</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset limit</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter</td> <td>1</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>1</td> </tr> <tr> <td>int $option option (0: aggregate by general account or 1: aggreegate by subaccount)</td> <td>1</td> </tr> <tr> <td>User $user User that modifies</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('' or _tmp')</td> <td>1</td> </tr> <tr> <td>string $piece_num Piece num</td> <td>1</td> </tr> <tr> <td>string $field Field</td> <td>1</td> </tr> <tr> <td>string $value Value</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('' or _tmp')</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('' or 'tmp_')</td> <td>1</td> </tr> <tr> <td>string $importkey Import key</td> <td>1</td> </tr> <tr> <td>int $delyear Year to delete</td> <td>1</td> </tr> <tr> <td>string $journal Journal to delete</td> <td>1</td> </tr> <tr> <td>string $mode Mode</td> <td>1</td> </tr> <tr> <td>int $delmonth Month</td> <td>1</td> </tr> <tr> <td>int $piecenum Piecenum to delete</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('' or '_tmp')</td> <td>1</td> </tr> <tr> <td>int $piecenum Accounting document to get</td> <td>1</td> </tr> <tr> <td>int $piecenum Id of line to get</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('' or '_tmp')</td> <td>1</td> </tr> <tr> <td>string $model Model</td> <td>1</td> </tr> <tr> <td>int $direction If 0: tmp => real, if 1: real => tmp</td> <td>1</td> </tr> <tr> <td>string $piece_num Piece num = Transaction ref</td> <td>1</td> </tr> <tr> <td>string $selectid Preselected chart of accounts</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in html form</td> <td>1</td> </tr> <tr> <td>array $event Event options</td> <td>1</td> </tr> <tr> <td>int $select_in Value is a aa.rowid (0 default) or aa.account_number (1)</td> <td>1</td> </tr> <tr> <td>int $select_out Set value returned by select 0=rowid (default), 1=account_number</td> <td>1</td> </tr> <tr> <td>string $aabase Set accounting_account base class to display empty=all or from 1 to 8 will display only account beginning by this number</td> <td>1</td> </tr> <tr> <td>string $account Accounting account</td> <td>1</td> </tr> <tr> <td>string $account Accounting account</td> <td>1</td> </tr> <tr> <td>string $alias Bookkeeping alias table</td> <td>1</td> </tr> <tr> <td>bool $force Force reload</td> <td>1</td> </tr> <tr> <td>int $id Bookkeeping ID</td> <td>1</td> </tr> <tr> <td>int $date Bookkeeping date</td> <td>1</td> </tr> <tr> <td>bool $force Force reload</td> <td>1</td> </tr> <tr> <td>string $mode active or closed ?</td> <td>1</td> </tr> <tr> <td>int $date_start Date start</td> <td>1</td> </tr> <tr> <td>int $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $fiscal_period_id Fiscal year ID</td> <td>1</td> </tr> <tr> <td>int $new_fiscal_period_id New fiscal year ID</td> <td>1</td> </tr> <tr> <td>bool $separate_auxiliary_account Separate auxiliary account</td> <td>1</td> </tr> <tr> <td>bool $generate_bookkeeping_records Generate closure bookkeeping records</td> <td>1</td> </tr> <tr> <td>int $fiscal_period_id Fiscal year ID</td> <td>1</td> </tr> <tr> <td>int $inventory_journal_id Inventory journal ID</td> <td>1</td> </tr> <tr> <td>int $new_fiscal_period_id New fiscal year ID</td> <td>1</td> </tr> <tr> <td>int $date_start Date start</td> <td>1</td> </tr> <tr> <td>int $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $id Id</td> <td>1</td> </tr> <tr> <td>int $id Id of category to know which account to exclude</td> <td>1</td> </tr> <tr> <td>int $id_cat Id category</td> <td>1</td> </tr> <tr> <td>array $cpts list of accounts array</td> <td>1</td> </tr> <tr> <td>int $cpt_id Id of accounting account</td> <td>1</td> </tr> <tr> <td>int|array $cpt Accounting account or array of accounting account</td> <td>1</td> </tr> <tr> <td>string $date_start Date start</td> <td>1</td> </tr> <tr> <td>string $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $sens Sens of the account: 0: credit - debit (use this by default), 1: debit - credit</td> <td>1</td> </tr> <tr> <td>string $thirdparty_code Thirdparty code</td> <td>1</td> </tr> <tr> <td>int $month Specific month - Can be empty</td> <td>1</td> </tr> <tr> <td>int $year Specific year - Can be empty</td> <td>1</td> </tr> <tr> <td>int $catid Custom group ID</td> <td>1</td> </tr> <tr> <td>int $categorytype -1=All, 0=Only non computed groups, 1=Only computed groups</td> <td>1</td> </tr> <tr> <td>int $active 1= active, 0=not active</td> <td>1</td> </tr> <tr> <td>int $cat_id Id if personalized accounting group/category</td> <td>1</td> </tr> <tr> <td>string $predefinedgroupwhere Sql criteria filter to select accounting accounts. This value must be sanitized and not come from an input of a user.</td> <td>1</td> </tr> <tr> <td>int $rowid Id of record to load</td> <td>1</td> </tr> <tr> <td>string $journal_code Journal code</td> <td>1</td> </tr> <tr> <td>int $withlabel 0=No label, 1=Include label of journal, 2=Include nature of journal</td> <td>1</td> </tr> <tr> <td>int $nourl 1=Disable url</td> <td>1</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>1</td> </tr> <tr> <td>int $nature Id type</td> <td>1</td> </tr> <tr> <td>int $mode 0=label long, 1=label short</td> <td>1</td> </tr> <tr> <td>User $user User who write in the bookkeeping</td> <td>1</td> </tr> <tr> <td>array $journal_data Journal data to write in the bookkeeping</td> <td>1</td> </tr> <tr> <td>int $max_nb_errors Nb error authorized before stop the process</td> <td>1</td> </tr> <tr> <td>array $journal_data Journal data to write in the bookkeeping</td> <td>1</td> </tr> <tr> <td>int $search_date_end Search date end</td> <td>1</td> </tr> <tr> <td>string $sep CSV separator</td> <td>1</td> </tr> <tr> <td>string $account Accounting account number</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty id</td> <td>1</td> </tr> <tr> <td>array $bookkeeping_ids Lettering specific list of bookkeeping id</td> <td>1</td> </tr> <tr> <td>bool $only_has_subledger_account Get only lines who have subledger account</td> <td>1</td> </tr> <tr> <td>array $bank_ids List of bank ids</td> <td>1</td> </tr> <tr> <td>array $link_by_element List of payment ids by link key</td> <td>1</td> </tr> <tr> <td>array $element_by_link List of element ids by link key</td> <td>1</td> </tr> <tr> <td>string $link_key Link key (used for recursive function)</td> <td>1</td> </tr> <tr> <td>array $current_group Current group (used for recursive function)</td> <td>1</td> </tr> <tr> <td>int $mode Mode of list: 0=flat list, 1=rich list</td> <td>1</td> </tr> <tr> <td>int $type Format id</td> <td>1</td> </tr> <tr> <td>int $formatexportset Id of export format</td> <td>1</td> </tr> <tr> <td>array $TData Array with data</td> <td>1</td> </tr> <tr> <td>int $formatexportset Id of export format</td> <td>1</td> </tr> <tr> <td>int $withAttachment [=0] Not add files</td> <td>1</td> </tr> <tr> <td>int $downloadMode [=0] Direct download. Deprecated. Always use value 1.</td> <td>1</td> </tr> <tr> <td>int $outputMode [=0] Print on screen. Deprecated. Always use value 1.</td> <td>1</td> </tr> <tr> <td>int $noouput 0=old mode. Deprecated. Always use value 1.</td> <td>1</td> </tr> <tr> <td>string $str String</td> <td>1</td> </tr> <tr> <td>integer $size Data to trunc</td> <td>1</td> </tr> <tr> <td>string $str Original string to encode and optionally truncate</td> <td>1</td> </tr> <tr> <td>integer $size Truncate string after $size characters</td> <td>1</td> </tr> <tr> <td>int $typeproduct 0 type product, 1 type service</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>string $filter Filter USF</td> <td>1</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of product</td> <td>1</td> </tr> <tr> <td>int<0,1> $qty_frozen If the qty is Frozen</td> <td>1</td> </tr> <tr> <td>int $fk_bom_child Id of BOM Child</td> <td>1</td> </tr> <tr> <td>int $fk_unit Unit</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line to update</td> <td>1</td> </tr> <tr> <td>float $qty_frozen Frozen quantity</td> <td>1</td> </tr> <tr> <td>int $fk_unit Unit of line</td> <td>1</td> </tr> <tr> <td>array<int,float|int> $TNetNeeds Array of ChildBom and infos linked to</td> <td>1</td> </tr> <tr> <td>float $qty qty needed</td> <td>1</td> </tr> <tr> <td>array<int,array{bom:BOM,parent_id:int,qty:float,level:int}> $TNetNeeds Array of ChildBom and infos linked to</td> <td>1</td> </tr> <tr> <td>float $qty qty needed</td> <td>1</td> </tr> <tr> <td>int $level level of recursivity</td> <td>1</td> </tr> <tr> <td>array $TParentBom We put all found parent bom in $TParentBom</td> <td>1</td> </tr> <tr> <td>int $bom_id ID of bom from which we want to get parent bom ids</td> <td>1</td> </tr> <tr> <td>int $level Protection against infinite loop</td> <td>1</td> </tr> <tr> <td>string $filtermode No more used</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $id ID of bom</td> <td>1</td> </tr> <tr> <td>int $id Id of bom to update</td> <td>1</td> </tr> <tr> <td>int $id BOM ID</td> <td>1</td> </tr> <tr> <td>int $id Id of BOM</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>string $key_text Action string</td> <td>1</td> </tr> <tr> <td>string $event_text Input event text</td> <td>1</td> </tr> <tr> <td>string $action Event action code ('CONTRACT_MODIFY', 'RECRUITMENTCANDIDATURE_MODIFIY', ...)</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object</td> <td>1</td> </tr> <tr> <td>Object $conf Dolibarr settings object</td> <td>1</td> </tr> <tr> <td>float $totalonlinkedelements Sum of total amounts (excl VAT) of</td> <td>1</td> </tr> <tr> <td>float $object_total_ht The total amount (excl VAT) of the object</td> <td>1</td> </tr> <tr> <td>string $action Event action code ('CONTRACT_MODIFY', 'RECRUITMENTCANDIDATURE_MODIFIY', or example by external module: 'SENTBYSMS'...)</td> <td>1</td> </tr> <tr> <td>string $action Event action code</td> <td>1</td> </tr> <tr> <td>Ticket $object Object</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>string $sendto Addresses to send the mail, format "first@address.net, second@address.net," etc.</td> <td>1</td> </tr> <tr> <td>string $body email body (first line). Non-translated string.</td> <td>1</td> </tr> <tr> <td>string $sendto Addresses to send the mail, format "first@address.net, second@address.net, " etc.</td> <td>1</td> </tr> <tr> <td>string $body email body (first line). Non-translated string.</td> <td>1</td> </tr> <tr> <td>string $see_ticket string indicating the ticket public address</td> <td>1</td> </tr> <tr> <td>string $option status filter ('', 'validated', ...)</td> <td>1</td> </tr> <tr> <td>string $filtertype 1 to filter on type of payment == 'PRE'</td> <td>1</td> </tr> <tr> <td>int $multicurrency Return multicurrency_amount instead of amount</td> <td>1</td> </tr> <tr> <td>int $withbadge 1=Add span for badge css, 2=Add span and show short label</td> <td>1</td> </tr> <tr> <td>string $table table of invoice</td> <td>1</td> </tr> <tr> <td>int $mode 0=Return id+label, 1=Return code+id</td> <td>1</td> </tr> <tr> <td>integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, 1 otherwise)</td> <td>1</td> </tr> <tr> <td>int $paye Status field paye</td> <td>1</td> </tr> <tr> <td>integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, -1 otherwise)</td> <td>1</td> </tr> <tr> <td>int $type Type invoice. If -1, we use $this->type</td> <td>1</td> </tr> <tr> <td>int $cond_reglement Condition of payment (code or id) to use. If 0, we use current condition.</td> <td>1</td> </tr> <tr> <td>int $id Invoice ID with remain to pay</td> <td>1</td> </tr> <tr> <td>int $did ID of unitary payment request to pay</td> <td>1</td> </tr> <tr> <td>string $service 'StripeTest', 'StripeLive', ...</td> <td>1</td> </tr> <tr> <td>string $forcestripe To force another stripe env: 'cus_account@pk_...:sk_...'</td> <td>1</td> </tr> <tr> <td>int $id State ID</td> <td>1</td> </tr> <tr> <td>string $code State code</td> <td>1</td> </tr> <tr> <td>User $user User who updates</td> <td>1</td> </tr> <tr> <td>boolean $force_price True of not</td> <td>1</td> </tr> <tr> <td>boolean $force_price Force price</td> <td>1</td> </tr> <tr> <td>string $text Text of label or key to translate</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select field ('edit' prefix will be added)</td> <td>1</td> </tr> <tr> <td>string $preselected Value to show/edit (not used in this function)</td> <td>1</td> </tr> <tr> <td>object $object Object (on the page we show)</td> <td>1</td> </tr> <tr> <td>boolean $perm Permission to allow button to edit parameter. Set it to 0 to have a not edited field.</td> <td>1</td> </tr> <tr> <td>string $typeofdata Type of data ('string' by default, 'email', 'amount:99', 'numeric:99', 'text' or 'textarea:rows:cols', 'datepicker' ('day' do not work, don't know why), 'dayhour' or 'datehourpicker' 'checkbox:ckeditor:dolibarr_zzz:width:height:savemethod:1:rows:cols', 'select;xxx[:class]'...)</td> <td>1</td> </tr> <tr> <td>string $moreparam More param to add on a href URL.</td> <td>1</td> </tr> <tr> <td>int $fieldrequired 1 if we want to show field as mandatory using the "fieldrequired" CSS.</td> <td>1</td> </tr> <tr> <td>int $notabletag 1=Do not output table tags but output a ':', 2=Do not output table tags and no ':', 3=Do not output table tags but output a ' '</td> <td>1</td> </tr> <tr> <td>string $help Tooltip help</td> <td>1</td> </tr> <tr> <td>string $text Text of label (not used in this function)</td> <td>1</td> </tr> <tr> <td>string $value Value to show/edit</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object (that we want to show)</td> <td>1</td> </tr> <tr> <td>boolean $perm Permission to allow button to edit parameter</td> <td>1</td> </tr> <tr> <td>string $typeofdata Type of data ('string' by default, 'checkbox', 'email', 'phone', 'amount:99', 'numeric:99',</td> <td>1</td> </tr> <tr> <td>string $editvalue When in edit mode, use this value as $value instead of value (for example, you can provide here a formatted price instead of numeric value, or a select combo). Use '' to use same than $value</td> <td>1</td> </tr> <tr> <td>?CommonObject $extObject External object ???</td> <td>1</td> </tr> <tr> <td>mixed $custommsg String or Array of custom messages : eg array('success' => 'MyMessage', 'error' => 'MyMessage')</td> <td>1</td> </tr> <tr> <td>string $moreparam More param to add on the form on action href URL parameter</td> <td>1</td> </tr> <tr> <td>int $notabletag Do no output table tags</td> <td>1</td> </tr> <tr> <td>string $formatfunc Call a specific method of $object->$formatfunc to output field in view mode (For example: 'dol_print_email')</td> <td>1</td> </tr> <tr> <td>string $gm 'auto' or 'tzuser' or 'tzuserrel' or 'tzserver' (when $typeofdata is a date)</td> <td>1</td> </tr> <tr> <td>array<string,int> $moreoptions Array with more options. For example array('addnowlink'=>1), array('valuealreadyhtmlescaped'=>1)</td> <td>1</td> </tr> <tr> <td>string $editaction [=''] use GETPOST default action or set action to edit mode</td> <td>1</td> </tr> <tr> <td>string $fieldname Name of the field</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object</td> <td>1</td> </tr> <tr> <td>boolean $perm Permission to allow button to edit parameter. Set it to 0 to have a not edited field.</td> <td>1</td> </tr> <tr> <td>string $typeofdata Type of data ('string' by default, 'email', 'amount:99', 'numeric:99', 'text' or 'textarea:rows:cols', 'datepicker' ('day' do not work, don't know why), 'ckeditor:dolibarr_zzz:width:height:savemethod:1:rows:cols', 'select;xxx[:class]'...)</td> <td>1</td> </tr> <tr> <td>string $check Same coe than $check parameter of GETPOST()</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object</td> <td>1</td> </tr> <tr> <td>string $value Value to show/edit</td> <td>1</td> </tr> <tr> <td>string $htmlname DIV ID (field name)</td> <td>1</td> </tr> <tr> <td>int $condition Condition to edit</td> <td>1</td> </tr> <tr> <td>string $inputType Type of input ('string', 'numeric', 'datepicker' ('day' do not work, don't know why), 'textarea:rows:cols', 'ckeditor:dolibarr_zzz:width:height:?:1:rows:cols', 'select:loadmethod:savemethod:buttononly')</td> <td>1</td> </tr> <tr> <td>string $editvalue When in edit mode, use this value as $value instead of value</td> <td>1</td> </tr> <tr> <td>?CommonObject $extObject External object</td> <td>1</td> </tr> <tr> <td>mixed $custommsg String or Array of custom messages : eg array('success' => 'MyMessage', 'error' => 'MyMessage')</td> <td>1</td> </tr> <tr> <td>string $text Text to show</td> <td>1</td> </tr> <tr> <td>string $htmltext HTML content of tooltip. Must be HTML/UTF8 encoded.</td> <td>1</td> </tr> <tr> <td>int $tooltipon 1=tooltip on text, 2=tooltip on image, 3=tooltip on both</td> <td>1</td> </tr> <tr> <td>int $direction -1=image is before, 0=no image, 1=image is after</td> <td>1</td> </tr> <tr> <td>string $img Html code for image (use img_xxx() function to get it)</td> <td>1</td> </tr> <tr> <td>string $extracss Add a CSS style to td tags</td> <td>1</td> </tr> <tr> <td>int $notabs 0=Include table and tr tags, 1=Do not include table and tr tags, 2=use div, 3=use span</td> <td>1</td> </tr> <tr> <td>string $incbefore Include code before the text</td> <td>1</td> </tr> <tr> <td>int $noencodehtmltext Do not encode into html entity the htmltext</td> <td>1</td> </tr> <tr> <td>string $tooltiptrigger ''=Tooltip on hover, 'abc'=Tooltip on click (abc is a unique key)</td> <td>1</td> </tr> <tr> <td>int $forcenowrap Force no wrap between text and picto (works with notabs=2 only)</td> <td>1</td> </tr> <tr> <td>string $text Text to show</td> <td>1</td> </tr> <tr> <td>string $htmltext Content of tooltip</td> <td>1</td> </tr> <tr> <td>int $direction 1=Icon is after text, -1=Icon is before text, 0=no icon</td> <td>1</td> </tr> <tr> <td>string $type Type of picto ('info', 'infoclickable', 'help', 'helpclickable', 'warning', 'superadmin', 'mypicto@mymodule', ...) or image filepath or 'none'</td> <td>1</td> </tr> <tr> <td>string $extracss Add a CSS style to td, div or span tag</td> <td>1</td> </tr> <tr> <td>int $noencodehtmltext Do not encode into html entity the htmltext</td> <td>1</td> </tr> <tr> <td>int $notabs 0=Include table and tr tags, 1=Do not include table and tr tags, 2=use div, 3=use span</td> <td>1</td> </tr> <tr> <td>string $tooltiptrigger ''=Tooltip on hover and hidden on smartphone, 'abconsmartphone'=Tooltip on hover and on click on smartphone, 'abc'=Tooltip on click (abc is a unique key, clickable link is on image or on link if param $type='none' or on both if $type='xxxclickable')</td> <td>1</td> </tr> <tr> <td>int $forcenowrap Force no wrap between text and picto (works with notabs=2 only)</td> <td>1</td> </tr> <tr> <td>string $selected Value auto selected when at least one record is selected. Not a preselected value. Use '0' by default.</td> <td>1</td> </tr> <tr> <td>array<string,string> $arrayofaction array('code'=>'label', ...). The code is the key stored into the GETPOST('massaction') when submitting action.</td> <td>1</td> </tr> <tr> <td>int $alwaysvisible 1=select button always visible</td> <td>1</td> </tr> <tr> <td>string $name Name for massaction</td> <td>1</td> </tr> <tr> <td>string $cssclass CSS class used to check for select</td> <td>1</td> </tr> <tr> <td>string $selected Id or Code or Label of preselected country</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select object</td> <td>1</td> </tr> <tr> <td>string $htmloption More html options on select object</td> <td>1</td> </tr> <tr> <td>integer $maxlength Max length for labels (0=no limit)</td> <td>1</td> </tr> <tr> <td>string $morecss More css class</td> <td>1</td> </tr> <tr> <td>string $usecodeaskey ''=Use id as key (default), 'code3'=Use code on 3 alpha as key, 'code2"=Use code on 2 alpha as key</td> <td>1</td> </tr> <tr> <td>int<0,1>|string $showempty Show empty choice</td> <td>1</td> </tr> <tr> <td>int<0,1> $disablefavorites 1=Disable favorites,</td> <td>1</td> </tr> <tr> <td>int<0,1> $addspecialentries 1=Add dedicated entries for group of countries (like 'European Economic Community', ...)</td> <td>1</td> </tr> <tr> <td>string[] $exclude_country_code Array of country code (iso2) to exclude</td> <td>1</td> </tr> <tr> <td>int<0,1> $hideflags Hide flags</td> <td>1</td> </tr> <tr> <td>string $selected Id or Code of preselected incoterm</td> <td>1</td> </tr> <tr> <td>string $location_incoterms Value of input location</td> <td>1</td> </tr> <tr> <td>string $page Defined the form action</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select object</td> <td>1</td> </tr> <tr> <td>string $htmloption Options html on select object</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>1</td> </tr> <tr> <td>array<array{method:string,url:string,htmlname:string,params:array<string,string>}> $events Event options to run on change. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))</td> <td>1</td> </tr> <tr> <td>int<0,1> $disableautocomplete Disable autocomplete</td> <td>1</td> </tr> <tr> <td>string $selected Preselected type</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in html form</td> <td>1</td> </tr> <tr> <td>int<0,1>|string $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>int $hidetext Do not show label 'Type' before combo box (used only if there is at least 2 choices to select)</td> <td>1</td> </tr> <tr> <td>integer $forceall 1=Force to show products and services in combo list, whatever are activated modules, 0=No force, 2=Force to show only Products, 3=Force to show only services, -1=Force none (and set hidden field to 'service')</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $selected Preselected type</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>int|string $selected Preselected ID</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras. WARNING: To avoid SQL injection, only few chars [.a-z0-9 =<>()] are allowed here. Example: ((s.client:IN:1,3) AND (s.status:=:1)). Do not use a filter coming from input of users.</td> <td>1</td> </tr> <tr> <td>string|int<1,1> $showempty Add an empty field (Can be '1' or text key to use on empty line like 'SelectThirdParty')</td> <td>1</td> </tr> <tr> <td>int $showtype Show third party type in combolist (customer, prospect or supplier)</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>1</td> </tr> <tr> <td>array<array{method:string,url:string,htmlname:string,params:array<string,string>}> $events Ajax event options to run on change. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))</td> <td>1</td> </tr> <tr> <td>int $limit Maximum number of elements</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css styles to the SELECT component</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>int<0,3> $hidelabel Hide label (0=no, 1=yes, 2=show search icon (before) and placeholder, 3 search icon after)</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>bool $multiple add [] in the name of element and add 'multiple' attribute (not working with ajax_autocompleter)</td> <td>1</td> </tr> <tr> <td>string[] $excludeids Exclude IDs from the select combo</td> <td>1</td> </tr> <tr> <td>int<0,1> $showcode Show code</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party or 0 for all or -1 for empty list</td> <td>1</td> </tr> <tr> <td>int|string $selected ID of preselected contact id</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field ('none' for a not editable field)</td> <td>1</td> </tr> <tr> <td>int<0,3>|string $showempty 0=no empty value, 1=add an empty value, 2=add line 'Internal' (used by user edit), 3=add an empty value only if more than one record into list</td> <td>1</td> </tr> <tr> <td>string $exclude List of contacts id to exclude</td> <td>1</td> </tr> <tr> <td>string $limitto Not used</td> <td>1</td> </tr> <tr> <td>integer $showfunction Add function into label</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to class style</td> <td>1</td> </tr> <tr> <td>bool $nokeyifsocid When 1, we force the option "Press a key to show list" to 0 if there is a value for $socid</td> <td>1</td> </tr> <tr> <td>integer $showsoc Add company into label</td> <td>1</td> </tr> <tr> <td>int $forcecombo 1=Force to use combo box (so no ajax beautify effect)</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>string $htmlid Html id to use instead of htmlname</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras. WARNING: To avoid SQL injection, only few chars [.a-z0-9 =<>()] are allowed here. Example: ((s.client:IN:1,3) AND (s.status:=:1)). Do not use a filter coming from input of users.</td> <td>1</td> </tr> <tr> <td>string $selected Preselected type</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras. WARNING: To avoid SQL injection, only few chars [.a-z0-9 =<>] are allowed here, example: 's.rowid <> x'</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty Add an empty field (Can be '1' or text to use on empty line like 'SelectThirdParty')</td> <td>1</td> </tr> <tr> <td>int<0,1> $showtype Show third party type in combolist (customer, prospect or supplier)</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use standard HTML select component without beautification</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter on key value</td> <td>1</td> </tr> <tr> <td>int<0,1> $outputmode 0=HTML select string, 1=Array</td> <td>1</td> </tr> <tr> <td>int $limit Limit number of answers</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css styles to the SELECT component</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>string[] $excludeids Exclude IDs from the select combo</td> <td>1</td> </tr> <tr> <td>int<0,1> $showcode Show code in list</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party or 0 for all or -1 for empty list</td> <td>1</td> </tr> <tr> <td>array|int|string $selected Array of ID of preselected contact id</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field ('none' for a not editable field)</td> <td>1</td> </tr> <tr> <td>int<0,3>|string $showempty 0=no empty value, 1=add an empty value, 2=add line 'Internal' (used by user edit), 3=add an empty value only if more than one record into list</td> <td>1</td> </tr> <tr> <td>string $exclude List of contacts id to exclude</td> <td>1</td> </tr> <tr> <td>string $limitto Disable answers that are not id in this array list</td> <td>1</td> </tr> <tr> <td>integer $showfunction Add function into label</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to class style</td> <td>1</td> </tr> <tr> <td>int $options_only 1=Return options only (for ajax treatment), 2=Return array</td> <td>1</td> </tr> <tr> <td>integer $showsoc Add company into label</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box (so no ajax beautify effect)</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>string $htmlid Html id to use instead of htmlname</td> <td>1</td> </tr> <tr> <td>bool $multiple add [] in the name of element and add 'multiple' attribute</td> <td>1</td> </tr> <tr> <td>integer $disableifempty Set tag 'disabled' on select if there is no choice</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras. WARNING: To avoid SQL injection, only few chars [.a-z0-9 =<>] are allowed here, example: 's.rowid <> x'</td> <td>1</td> </tr> <tr> <td>string $selected Id Fixed reduction preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of the form field</td> <td>1</td> </tr> <tr> <td>string $filter Optional filter critreria</td> <td>1</td> </tr> <tr> <td>int $maxvalue Max value for lines that can be selected</td> <td>1</td> </tr> <tr> <td>string $selected Id user preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Field name in form</td> <td>1</td> </tr> <tr> <td>int<0,1> $show_empty 0=liste sans valeur nulle, 1=ajoute valeur inconnue</td> <td>1</td> </tr> <tr> <td>int[] $exclude Array list of users id to exclude</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled If select list must be disabled</td> <td>1</td> </tr> <tr> <td>int[]|string $include Array list of users id to include. User '' for all users or 'hierarchy' to have only supervised users or 'hierarchyme' to have supervised + me</td> <td>1</td> </tr> <tr> <td>int[]|int $enableonly Array list of users id to be enabled. All other must be disabled</td> <td>1</td> </tr> <tr> <td>string $force_entity '0' or Ids of environment to force</td> <td>1</td> </tr> <tr> <td>string|int|User $selected User id or user object of user preselected. If 0 or < -2, we use id of current user. If -1 or '', keep unselected (if empty is allowed)</td> <td>1</td> </tr> <tr> <td>string $htmlname Field name in form</td> <td>1</td> </tr> <tr> <td>int<0,1>|string $show_empty 0=list with no empty value, 1=add also an empty value into list</td> <td>1</td> </tr> <tr> <td>int[]|null $exclude Array list of users id to exclude</td> <td>1</td> </tr> <tr> <td>int $disabled If select list must be disabled</td> <td>1</td> </tr> <tr> <td>int[]|string $include Array list of users id to include. User '' for all users or 'hierarchy' to have only supervised users or 'hierarchyme' to have supervised + me</td> <td>1</td> </tr> <tr> <td>array|string $enableonly Array list of users id to be enabled. If defined, it means that others will be disabled</td> <td>1</td> </tr> <tr> <td>string $force_entity '0' or list of Ids of environment to force, separated by a coma, or 'default' = do no extend to all entities allowed to superadmin.</td> <td>1</td> </tr> <tr> <td>int $maxlength Maximum length of string into list (0=no limit)</td> <td>1</td> </tr> <tr> <td>int<-1,1> $showstatus 0=show user status only if status is disabled, 1=always show user status into label, -1=never show user status</td> <td>1</td> </tr> <tr> <td>string $morefilter Add more filters into sql request (Example: 'employee = 1'). This value must not come from user input.</td> <td>1</td> </tr> <tr> <td>integer $show_every 0=default list, 1=add also a value "Everybody" at beginning of list</td> <td>1</td> </tr> <tr> <td>string $enableonlytext If option $enableonlytext is set, we use this text to explain into label why record is disabled. Not used if enableonly is empty.</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>int<0,1> $notdisabled Show only active users (this will also happened whatever is this option if USER_HIDE_INACTIVE_IN_COMBOBOX is on).</td> <td>1</td> </tr> <tr> <td>int<0,2> $outputmode 0=HTML select string, 1=Array</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcecombo Force the component to be a simple combo box without ajax</td> <td>1</td> </tr> <tr> <td>int<0,1> $show_empty 0=list without the empty value, 1=add empty value</td> <td>1</td> </tr> <tr> <td>int[]|string $include Array list of users id to include or 'hierarchy' to have only supervised users</td> <td>1</td> </tr> <tr> <td>int[]|int $enableonly Array list of users id to be enabled. All other must be disabled</td> <td>1</td> </tr> <tr> <td>int<0,1> $showstatus 0=show user status only if status is disabled, 1=always show user status into label, -1=never show user status</td> <td>1</td> </tr> <tr> <td>int[] $listofuserid Array with properties of each user</td> <td>1</td> </tr> <tr> <td>int[] $listofcontactid Array with properties of each contact</td> <td>1</td> </tr> <tr> <td>int[] $listofotherid Array with properties of each other contact</td> <td>1</td> </tr> <tr> <td>int $show_empty 0=list without the empty value, 1=add empty value</td> <td>1</td> </tr> <tr> <td>int[]|string $include Array list of users id to include or 'hierarchy' to have only supervised users</td> <td>1</td> </tr> <tr> <td>int[] $enableonly Array list of users id to be enabled. All other must be disabled</td> <td>1</td> </tr> <tr> <td>int<-1,1> $showstatus 0=show user status only if status is disabled, 1=always show user status into label, -1=never show user status</td> <td>1</td> </tr> <tr> <td>array<int,array{transparency:bool|int<0,1>}> $listofresourceid Array with properties of each resource</td> <td>1</td> </tr> <tr> <td>int $selected Preselected products</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field (must be unique in page).</td> <td>1</td> </tr> <tr> <td>int|string $filtertype Filter on product type (''=nofilter, 0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>int $price_level Level of price to show</td> <td>1</td> </tr> <tr> <td>int $status Sell status: -1=No filter on sell status, 0=Products not on sell, 1=Products on sell</td> <td>1</td> </tr> <tr> <td>int $finished 2=all, 1=finished, 0=raw material</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>int $hidelabel Hide label (0=no, 1=yes, 2=show search icon (before) and placeholder, 3 search icon after)</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty Id (to get also price dedicated to this customer)</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>1</td> </tr> <tr> <td>int<0,1> $hidepriceinlabel 1=Hide prices in label</td> <td>1</td> </tr> <tr> <td>string $warehouseStatus Warehouse status filter to count the quantity in stock. Following comma separated filter options can be used</td> <td>1</td> </tr> <tr> <td>?mixed[] $selected_combinations Selected combinations. Format: array([attrid] => attrval, [...])</td> <td>1</td> </tr> <tr> <td>int<0,1> $nooutput No print if 1, return the output into a string</td> <td>1</td> </tr> <tr> <td>int<-1,1> $status_purchase Purchase status: -1=No filter on purchase status, 0=Products not on purchase, 1=Products on purchase</td> <td>1</td> </tr> <tr> <td>string $selected Preselected BOM id</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field (must be unique in page).</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>int $status Sell status -1=Return all bom, 0=Draft BOM, 1=Validated BOM</td> <td>1</td> </tr> <tr> <td>int $type type of the BOM (-1=Return all BOM, 0=Return disassemble BOM, 1=Return manufacturing BOM)</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>1</td> </tr> <tr> <td>string $nooutput No print, return the output into a string</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>string[] $TProducts Add filter on a defined product</td> <td>1</td> </tr> <tr> <td>int $selected Preselected product</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on product type (''=nofilter, 0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>int $price_level Level of price to show</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter on product</td> <td>1</td> </tr> <tr> <td>int $status -1=Return all products, 0=Products not on sell, 1=Products on sell</td> <td>1</td> </tr> <tr> <td>int $finished Filter on finished field: 2=No filter</td> <td>1</td> </tr> <tr> <td>int $outputmode 0=HTML select string, 1=Array</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty Id (to get also price dedicated to this customer)</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>1</td> </tr> <tr> <td>int $hidepriceinlabel 1=Hide prices in label</td> <td>1</td> </tr> <tr> <td>string $warehouseStatus Warehouse status filter to group/count stock. Following comma separated filter options can be used.</td> <td>1</td> </tr> <tr> <td>int $status_purchase Purchase status -1=Return all products, 0=Products not on purchase, 1=Products on purchase</td> <td>1</td> </tr> <tr> <td>stdClass $objp Resultset of fetch</td> <td>1</td> </tr> <tr> <td>array{key:string,value:string,label:string,label2:string,desc:string,type:string,price_ht:string,price_ttc:string,price_ht_locale:string,price_ttc_locale:string,pricebasetype:string,tva_tx:string,default_vat_code:string,qty:string,discount:string,duration_value:string,duration_unit:string,pbq:string,labeltrans:string,desctrans:string,ref_customer:string} $optJson Option (var used for returned value in json format)</td> <td>1</td> </tr> <tr> <td>int $price_level Price level</td> <td>1</td> </tr> <tr> <td>int $selected Preselected value</td> <td>1</td> </tr> <tr> <td>int<0,1> $hidepriceinlabel Hide price in label</td> <td>1</td> </tr> <tr> <td>int<0,1> $novirtualstock Do not load virtual stock, even if slow option STOCK_SHOW_VIRTUAL_STOCK_IN_PRODUCTS_COMBO is on.</td> <td>1</td> </tr> <tr> <td>int $socid Id third party</td> <td>1</td> </tr> <tr> <td>string $selected Preselected product</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML Select</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on product type (''=nofilter, 0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>string $filtre For a SQL filter</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>int<0,1> $hidelabel Hide label (0=no, 1=yes)</td> <td>1</td> </tr> <tr> <td>int<0,1> $alsoproductwithnosupplierprice 1=Add also product without supplier prices</td> <td>1</td> </tr> <tr> <td>string $placeholder Placeholder</td> <td>1</td> </tr> <tr> <td>int $socid Id of supplier thirdparty (0 = no filter)</td> <td>1</td> </tr> <tr> <td>string $selected Product price preselected (must be 'id' in product_fournisseur_price or 'idprod_IDPROD')</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on product type (''=nofilter, 0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>string $filtre Generic filter. Data must not come from user input.</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter of produdts</td> <td>1</td> </tr> <tr> <td>int $statut -1=Return all products, 0=Products not on buy, 1=Products on buy</td> <td>1</td> </tr> <tr> <td>int $limit Limit of line number</td> <td>1</td> </tr> <tr> <td>int $alsoproductwithnosupplierprice 1=Add also product without supplier prices</td> <td>1</td> </tr> <tr> <td>string $morecss Add more CSS</td> <td>1</td> </tr> <tr> <td>int $showstockinlist Show stock information (slower).</td> <td>1</td> </tr> <tr> <td>int $productid Id of product</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field</td> <td>1</td> </tr> <tr> <td>int $selected_supplier Pre-selected supplier if more than 1 result</td> <td>1</td> </tr> <tr> <td>string $selected Id du type de delais pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>string $filtertype To add a filter</td> <td>1</td> </tr> <tr> <td>int $addempty Add empty entry</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $selected Id or code of type origin to select by default</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>string $exclude To exclude a code value (Example: SRC_PROP)</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css to the HTML select component</td> <td>1</td> </tr> <tr> <td>int $notooltip Do not show the tooltip for admin</td> <td>1</td> </tr> <tr> <td>int $noprint if set to one we return the html to print, if 0 (default) we print it</td> <td>1</td> </tr> <tr> <td>string $selected Id or code or preselected payment mode</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on field type in llx_c_paiement ('CRDT' or 'DBIT' or array('code'=>xx,'label'=>zz))</td> <td>1</td> </tr> <tr> <td>int $format 0=id+label, 1=code+code, 2=code+label, 3=id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1=can be empty, 0 otherwise</td> <td>1</td> </tr> <tr> <td>int $noadmininfo 0=Add admin info, 1=Disable admin info</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>int $active Active or not, -1 = all</td> <td>1</td> </tr> <tr> <td>string $morecss Add more CSS on select tag</td> <td>1</td> </tr> <tr> <td>string $selected Id pre-selectionne</td> <td>1</td> </tr> <tr> <td>int $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $selected Id of the transport mode preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of the select field</td> <td>1</td> </tr> <tr> <td>int $format 0=id+label, 1=code+code, 2=code+label, 3=id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1=can be empty, 0 else</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>string $selected Id shipping mode preselected</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>int $noinfoadmin 0=Add admin info, 1=Disable admin info</td> <td>1</td> </tr> <tr> <td>string $selected Id of shipping mode</td> <td>1</td> </tr> <tr> <td>int $addempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>string $selected Preselected ID</td> <td>1</td> </tr> <tr> <td>int $socid Company ID</td> <td>1</td> </tr> <tr> <td>string $selected Preselected Unit ID</td> <td>1</td> </tr> <tr> <td>string $htmlname Select name</td> <td>1</td> </tr> <tr> <td>int<0,1> $showempty Add an empty line</td> <td>1</td> </tr> <tr> <td>string $unit_type Restrict to one given unit type</td> <td>1</td> </tr> <tr> <td>int|string $selected Id account preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select zone</td> <td>1</td> </tr> <tr> <td>int $status Status of searched accounts (0=open, 1=closed, 2=both)</td> <td>1</td> </tr> <tr> <td>string $filtre To filter the list. This parameter must not come from input of users</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>string $moreattrib To add more attribute on select</td> <td>1</td> </tr> <tr> <td>int $showcurrency Show currency in label</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=Return string, do not send to output</td> <td>1</td> </tr> <tr> <td>string $selected Id establishment preselected</td> <td>1</td> </tr> <tr> <td>int $status Status of searched establishment (0=open, 1=closed, 2=both)</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>string $selected Id of bank account</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html field</td> <td>1</td> </tr> <tr> <td>int $addempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>string|int $type Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.</td> <td>1</td> </tr> <tr> <td>string $selected Id of category preselected or 'auto' (autoselect category if there is only one element). Not used if $outputmode = 1.</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML field name</td> <td>1</td> </tr> <tr> <td>int $maxlength Maximum length for labels</td> <td>1</td> </tr> <tr> <td>int|string|array $fromid Keep only or Exclude (depending on $include parameter) all categories (including the leaf $fromid) into the tree after this id $fromid.</td> <td>1</td> </tr> <tr> <td>int<0,3> $outputmode 0=HTML select string, 1=Array with full label only, 2=Array extended, 3=Array with full picto + label</td> <td>1</td> </tr> <tr> <td>int<0,1> $include [=0] Removed or 1=Keep only</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int<0,2> $useempty 0=No empty value, 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries. Default is 1.</td> <td>1</td> </tr> <tr> <td>string $page Url of page to call if confirmation is OK</td> <td>1</td> </tr> <tr> <td>string $title Title</td> <td>1</td> </tr> <tr> <td>string $question Question</td> <td>1</td> </tr> <tr> <td>string $action Action</td> <td>1</td> </tr> <tr> <td>array{text:string}|array<array{label:string,type:string,size:string,morecss:string,moreattr:string,style:string}> $formquestion An array with complementary inputs to add into forms: array(array('label'=> ,'type'=> , 'size'=>, 'morecss'=>, 'moreattr'=>'autofocus' or 'style=...'))</td> <td>1</td> </tr> <tr> <td>string $selectedchoice "" or "no" or "yes"</td> <td>1</td> </tr> <tr> <td>int|string $useajax 0=No, 1=Yes use Ajax to show the popup, 2=Yes and also submit page with &confirm=no if choice is No, 'xxx'=Yes and preoutput confirm box with div id=dialog-confirm-xxx</td> <td>1</td> </tr> <tr> <td>int $height Force height of box</td> <td>1</td> </tr> <tr> <td>int $width Force width of box</td> <td>1</td> </tr> <tr> <td>string $page Url of page to call if confirmation is OK. Can contains parameters (param 'action' and 'confirm' will be reformatted)</td> <td>1</td> </tr> <tr> <td>string $title Title</td> <td>1</td> </tr> <tr> <td>string $question Question</td> <td>1</td> </tr> <tr> <td>string $action Action</td> <td>1</td> </tr> <tr> <td>array<array{name:string,value:string,values:string[],default:string,label:string,type:string,size:string,morecss:string,moreattr:string,style:string,inputko?:int<0,1>}>|string|null $formquestion An array with complementary inputs to add into forms: array(array('label'=> ,'type'=> , 'size'=>, 'morecss'=>, 'moreattr'=>'autofocus' or 'style=...'))</td> <td>1</td> </tr> <tr> <td>int<0,1>|''|'no'|'yes'|'1'|'0' $selectedchoice '' or 'no', or 'yes' or '1', 1, '0' or 0</td> <td>1</td> </tr> <tr> <td>int<0,2>|string $useajax 0=No, 1=Yes use Ajax to show the popup, 2=Yes and also submit page with &confirm=no if choice is No, 'xxx'=Yes and preoutput confirm box with div id=dialog-confirm-xxx</td> <td>1</td> </tr> <tr> <td>int|string $height Force height of box (0 = auto)</td> <td>1</td> </tr> <tr> <td>int $width Force width of box ('999' or '90%'). Ignored and forced to 90% on smartphones.</td> <td>1</td> </tr> <tr> <td>int $disableformtag 1=Disable form tag. Can be used if we are already inside a <form> section.</td> <td>1</td> </tr> <tr> <td>string $labelbuttonyes Label for Yes</td> <td>1</td> </tr> <tr> <td>string $labelbuttonno Label for No</td> <td>1</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)</td> <td>1</td> </tr> <tr> <td>string $selected Id preselected project</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select field</td> <td>1</td> </tr> <tr> <td>int $discard_closed Discard closed projects (0=Keep,1=hide completely except $selected,2=Disable)</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length</td> <td>1</td> </tr> <tr> <td>int $forcefocus Force focus on field (works with javascript only)</td> <td>1</td> </tr> <tr> <td>string $textifnoproject Text to show if no project</td> <td>1</td> </tr> <tr> <td>string $selected Id condition pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html field</td> <td>1</td> </tr> <tr> <td>int $addempty Add empty entry</td> <td>1</td> </tr> <tr> <td>string $type Type ('direct-debit' or 'bank-transfer')</td> <td>1</td> </tr> <tr> <td>int $filtertype If > 0, include payment terms with deposit percentage (for objects other than invoices and invoice templates)</td> <td>1</td> </tr> <tr> <td>int $deposit_percent < 0 : deposit_percent input makes no sense (for example, in list filters)</td> <td>1</td> </tr> <tr> <td>int $page Page</td> <td>1</td> </tr> <tr> <td>string $selected Id condition pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html field</td> <td>1</td> </tr> <tr> <td>string $selected Id condition pre-selectionne</td> <td>1</td> </tr> <tr> <td>int $addempty Add empty entry</td> <td>1</td> </tr> <tr> <td>string $selected Date preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Html name of date input fields or 'none'</td> <td>1</td> </tr> <tr> <td>int $displayhour Display hour selector</td> <td>1</td> </tr> <tr> <td>int $displaymin Display minutes selector</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=No print output, return string</td> <td>1</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>1</td> </tr> <tr> <td>string $selected Id of user preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of input html field. If 'none', we just output the user link.</td> <td>1</td> </tr> <tr> <td>int[] $exclude List of users id to exclude</td> <td>1</td> </tr> <tr> <td>int[] $include List of users id to include</td> <td>1</td> </tr> <tr> <td>string $selected Id mode pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on field type in llx_c_paiement ('CRDT' or 'DBIT' or array('code'=>xx,'label'=>zz))</td> <td>1</td> </tr> <tr> <td>string $type Type ('direct-debit' or 'bank-transfer')</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=Return string, no output</td> <td>1</td> </tr> <tr> <td>string $selected Id mode pre-select</td> <td>1</td> </tr> <tr> <td>string $selected code pre-selectionne</td> <td>1</td> </tr> <tr> <td>double $rate Current rate</td> <td>1</td> </tr> <tr> <td>string $currency Currency code to explain the rate</td> <td>1</td> </tr> <tr> <td>string $page Page URL where form is shown</td> <td>1</td> </tr> <tr> <td>int $selected Value preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of SELECT component. If 'none', not changeable. Example 'remise_id'.</td> <td>1</td> </tr> <tr> <td>int $socid Third party id</td> <td>1</td> </tr> <tr> <td>float $amount Total amount available</td> <td>1</td> </tr> <tr> <td>string $filter SQL filter on discounts</td> <td>1</td> </tr> <tr> <td>int $maxvalue Max value for lines that can be selected</td> <td>1</td> </tr> <tr> <td>string $more More string to add</td> <td>1</td> </tr> <tr> <td>int $hidelist 1=Hide list</td> <td>1</td> </tr> <tr> <td>int $discount_type 0 => customer discount, 1 => supplier discount</td> <td>1</td> </tr> <tr> <td>Societe $societe Filter on third party</td> <td>1</td> </tr> <tr> <td>string $selected Id contact pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select. If 'none', we just show contact link.</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>string $selected Id preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras. WARNING: To avoid SQL injection, only few chars [.a-z0-9 =<>()] are allowed here (example: 's.rowid <> x', 's.client IN (1,3)'). Do not use a filter coming from input of users.</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty Add an empty field (Can be '1' or text key to use on empty line like 'SelectThirdParty')</td> <td>1</td> </tr> <tr> <td>int<0,1> $showtype Show third party type in combolist (customer, prospect or supplier)</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>int $nooutput No print output. Return it only.</td> <td>1</td> </tr> <tr> <td>int[] $excludeids Exclude IDs from the select combo</td> <td>1</td> </tr> <tr> <td>string $textifnothirdparty Text to show if no thirdparty</td> <td>1</td> </tr> <tr> <td>int $mode 0 = Add currency symbol into label, 1 = Add 3 letter iso code</td> <td>1</td> </tr> <tr> <td>string $useempty '1'=Allow empty value</td> <td>1</td> </tr> <tr> <td>string $selected Preselected currency code</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select list</td> <td>1</td> </tr> <tr> <td>string $filter Optional filters criteras (example: 'code <> x', ' in (1,3)')</td> <td>1</td> </tr> <tr> <td>bool $excludeConfCurrency false = If company current currency not in table, we add it into list. Should always be available.</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $country_code Country code with quotes ("'CA'", or "'CA,IN,...'")</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field</td> <td>1</td> </tr> <tr> <td>float|string $selectedrate Force preselected vat rate. Can be '8.5' or '8.5 (NOO)' for example. Use '' for no forcing.</td> <td>1</td> </tr> <tr> <td>Societe $societe_vendeuse Thirdparty seller</td> <td>1</td> </tr> <tr> <td>Societe $societe_acheteuse Thirdparty buyer</td> <td>1</td> </tr> <tr> <td>int $idprod Id product. O if unknown of NA.</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information on line (1 for NPR)</td> <td>1</td> </tr> <tr> <td>int|string $type ''=Unknown, 0=Product, 1=Service (Used if idprod not defined)</td> <td>1</td> </tr> <tr> <td>bool $options_only Return HTML options lines only (for ajax treatment)</td> <td>1</td> </tr> <tr> <td>int $mode 0=Use vat rate as key in combo list, 1=Add VAT code after vat rate into key, -1=Use id of vat line as key</td> <td>1</td> </tr> <tr> <td>int $type_vat 0=All type, 1=VAT rate sale, 2=VAT rate purchase</td> <td>1</td> </tr> <tr> <td>int $h 1 or 2=Show also hours (2=hours on a new line), -1 has same effect but hour and minutes are prefilled with 23:59 if date is empty, 3 show hour always empty</td> <td>1</td> </tr> <tr> <td>int $m 1=Show also minutes, -1 has same effect but hour and minutes are prefilled with 23:59 if date is empty, 3 show minutes always empty</td> <td>1</td> </tr> <tr> <td>int $empty 0=Fields required, 1=Empty inputs are allowed, 2=Empty inputs are allowed for hours only</td> <td>1</td> </tr> <tr> <td>string $form_name Not used</td> <td>1</td> </tr> <tr> <td>int $d 1=Show days, month, years</td> <td>1</td> </tr> <tr> <td>int $addnowlink Add a link "Now"</td> <td>1</td> </tr> <tr> <td>int $disabled Disable input fields</td> <td>1</td> </tr> <tr> <td>int $fullday When a checkbox with this html name is on, hour and day are set with 00:00 or 23:59</td> <td>1</td> </tr> <tr> <td>string $addplusone Add a link "+1 hour". Value must be name of another select_date field.</td> <td>1</td> </tr> <tr> <td>int|string $adddateof Add a link "Date of invoice" using the following date.</td> <td>1</td> </tr> <tr> <td>integer|string $set_time_end Pre-selected date (must be a local PHP server timestamp), -1 to keep date not preselected, '' to use current date with 00:00 hour (Parameter 'empty' must be 0 or 2).</td> <td>1</td> </tr> <tr> <td>int $empty 0=Fields required, 1=Empty inputs are allowed, 2=Empty inputs are allowed for hours only</td> <td>1</td> </tr> <tr> <td>int $forcenewline Force new line between the 2 dates.</td> <td>1</td> </tr> <tr> <td>integer|string $set_time Pre-selected date (must be a local PHP server timestamp), -1 to keep date not preselected, '' to use current date with 00:00 hour (Parameter 'empty' must be 0 or 2).</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix for fields name</td> <td>1</td> </tr> <tr> <td>int $h 1 or 2=Show also hours (2=hours on a new line), -1 has same effect but hour and minutes are prefilled with 23:59 if date is empty, 3 show hour always empty</td> <td>1</td> </tr> <tr> <td>int $m 1=Show also minutes, -1 has same effect but hour and minutes are prefilled with 23:59 if date is empty, 3 show minutes always empty</td> <td>1</td> </tr> <tr> <td>int $empty 0=Fields required, 1=Empty inputs are allowed, 2=Empty inputs are allowed for hours only</td> <td>1</td> </tr> <tr> <td>string $form_name Not used</td> <td>1</td> </tr> <tr> <td>int<0,1> $d 1=Show days, month, years</td> <td>1</td> </tr> <tr> <td>int<0,2> $addnowlink Add a link "Now", 1 with server time, 2 with local computer time</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled Disable input fields</td> <td>1</td> </tr> <tr> <td>int|string $fullday When a checkbox with id #fullday is checked, hours are set with 00:00 (if value if 'fulldaystart') or 23:59 (if value is 'fulldayend')</td> <td>1</td> </tr> <tr> <td>string $addplusone Add a link "+1 hour". Value must be name of another selectDate field.</td> <td>1</td> </tr> <tr> <td>int|string|array $adddateof Add a link "Date of ..." using the following date. Must be array(array('adddateof'=>..., 'labeladddateof'=>...))</td> <td>1</td> </tr> <tr> <td>string $openinghours Specify hour start and hour end for the select ex 8,20</td> <td>1</td> </tr> <tr> <td>int $stepminutes Specify step for minutes between 1 and 30</td> <td>1</td> </tr> <tr> <td>string $labeladddateof Label to use for the $adddateof parameter. Deprecated. Used only when $adddateof is not an array.</td> <td>1</td> </tr> <tr> <td>string $placeholder Placeholder</td> <td>1</td> </tr> <tr> <td>mixed $gm 'auto' (for backward compatibility, avoid this), 'gmt' or 'tzserver' or 'tzuserrel'</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix</td> <td>1</td> </tr> <tr> <td>string $selected Selected duration type</td> <td>1</td> </tr> <tr> <td>string[] $excludetypes Array of duration types to exclude. Example array('y', 'm')</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix for input fields</td> <td>1</td> </tr> <tr> <td>int|string $iSecond Default preselected duration (number of seconds or '')</td> <td>1</td> </tr> <tr> <td>int $disabled Disable the combo box</td> <td>1</td> </tr> <tr> <td>string $typehour If 'select' then input hour and input min is a combo,</td> <td>1</td> </tr> <tr> <td>integer $minunderhours If 1, show minutes selection under the hours</td> <td>1</td> </tr> <tr> <td>string $selected Preselected tickets</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field (must be unique in page).</td> <td>1</td> </tr> <tr> <td>string $filtertype To add a filter</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>int<0,3> $hidelabel Hide label (0=no, 1=yes, 2=show search icon (before) and placeholder, 3 search icon after)</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty Id (to get also price dedicated to this customer)</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>1</td> </tr> <tr> <td>array<string,string> $selected_combinations Selected combinations. Format: array([attrid] => attrval, [...])</td> <td>1</td> </tr> <tr> <td>int<0,1> $nooutput No print, return the output into a string</td> <td>1</td> </tr> <tr> <td>string $selected Preselected ticket</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on ticket type</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter on ticket ref or subject</td> <td>1</td> </tr> <tr> <td>int $outputmode 0=HTML select string, 1=Array</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>1</td> </tr> <tr> <td>object $objp Result set of fetch</td> <td>1</td> </tr> <tr> <td>mixed[] $optJson Option (var used for returned value in json format)</td> <td>1</td> </tr> <tr> <td>string $selected Preselected tickets</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field (must be unique in page).</td> <td>1</td> </tr> <tr> <td>string $filtertype To add a filter</td> <td>1</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>1</td> </tr> <tr> <td>int $status Ticket status</td> <td>1</td> </tr> <tr> <td>int<0,3> $hidelabel Hide label (0=no, 1=yes, 2=show search icon (before) and placeholder, 3 search icon after)</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty Id (to get also price dedicated to this customer)</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>1</td> </tr> <tr> <td>array<string,string> $selected_combinations Selected combinations. Format: array([attrid] => attrval, [...])</td> <td>1</td> </tr> <tr> <td>int<0,1> $nooutput No print, return the output into a string</td> <td>1</td> </tr> <tr> <td>string $selected Preselected project</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on project type</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter on project ref or subject</td> <td>1</td> </tr> <tr> <td>stdClass $objp Result set of fetch</td> <td>1</td> </tr> <tr> <td>array{key:string,value:string,type:string} $optJson Option (var used for returned value in json format)</td> <td>1</td> </tr> <tr> <td>string $selected Preselected tickets</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field (must be unique in page).</td> <td>1</td> </tr> <tr> <td>string $filtertype To add a filter</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>int<0,3> $hidelabel Hide label (0=no, 1=yes, 2=show search icon before and placeholder, 3 search icon after)</td> <td>1</td> </tr> <tr> <td>array<string,string|string[]> $ajaxoptions Options for ajax_autocompleter</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty Id (to get also price dedicated to this customer)</td> <td>1</td> </tr> <tr> <td>array<string,string> $selected_combinations Selected combinations. Format: array([attrid] => attrval, [...])</td> <td>1</td> </tr> <tr> <td>int<0,1> $nooutput No print, return the output into a string</td> <td>1</td> </tr> <tr> <td>string $selected Preselected adherent</td> <td>1</td> </tr> <tr> <td>string $filtertype Filter on adherent type</td> <td>1</td> </tr> <tr> <td>string $filterkey Filter on member status</td> <td>1</td> </tr> <tr> <td>int $status Member status</td> <td>1</td> </tr> <tr> <td>object $objp Result set of fetch</td> <td>1</td> </tr> <tr> <td>mixed[] $optJson Option (var used for returned value in json format)</td> <td>1</td> </tr> <tr> <td>string $objectdesc 'ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'. For hard coded custom needs. Try to prefer method using $objectfield instead of $objectdesc.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select component</td> <td>1</td> </tr> <tr> <td>int $preSelectedValue Preselected value (ID of element)</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty ''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)</td> <td>1</td> </tr> <tr> <td>string $searchkey Search criteria</td> <td>1</td> </tr> <tr> <td>string $placeholder Place holder</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $moreparams More params provided to ajax call</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled 1=Html component is disabled</td> <td>1</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>1</td> </tr> <tr> <td>string $objectfield Object:Field that contains the definition of parent (in table $fields or $extrafields). Example: 'Object:xxx' or 'Object@module:xxx' (old syntax 'Module_Object:xxx') or 'Object:options_xxx' or 'Object@module:options_xxx' (old syntax 'Module_Object:options_xxx')</td> <td>1</td> </tr> <tr> <td>string|int<0,1> $showempty ''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select area. Try to start name with "multi" or "search_multi" if this is a multiselect</td> <td>1</td> </tr> <tr> <td>array{label:string,data-html:string,disable?:int<0,1>,css?:string} $array Array like array(key => value) or array(key=>array('label'=>..., 'data-...'=>..., 'disabled'=>..., 'css'=>...))</td> <td>1</td> </tr> <tr> <td>string|string[] $id Preselected key or array of preselected keys for multiselect. Use 'ifone' to autoselect record if there is only one record.</td> <td>1</td> </tr> <tr> <td>int<0,1>|string $show_empty 0 no empty value allowed, 1 or string to add an empty value into list (If 1: key is -1 and value is '' or ' ', If placeholder string: key is -1 and value is the string), <0 to add an empty value with key that is this value.</td> <td>1</td> </tr> <tr> <td>int<0,1> $key_in_label 1 to show key into label with format "[key] value"</td> <td>1</td> </tr> <tr> <td>int<0,1> $value_as_key 1 to use value as key</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>int<0,1> $translate 1=Translate and encode value</td> <td>1</td> </tr> <tr> <td>int $maxlen Length maximum for labels</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled Html select box is disabled</td> <td>1</td> </tr> <tr> <td>string $sort 'ASC' or 'DESC' = Sort on label, '' or 'NONE' or 'POS' = Do not sort, we keep original order</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to css styles</td> <td>1</td> </tr> <tr> <td>int $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $moreparamonempty Add more param on the empty option line. Not used if show_empty not set</td> <td>1</td> </tr> <tr> <td>int $disablebademail 1=Check if a not valid email, 2=Check string '---', and if found into value, disable and colorize entry</td> <td>1</td> </tr> <tr> <td>int $nohtmlescape No html escaping (not recommended, use 'data-html' if you need to use label with HTML content).</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select area</td> <td>1</td> </tr> <tr> <td>string $url Url. Must return a json_encode of array(key=>array('text'=>'A text', 'url'=>'An url'), ...)</td> <td>1</td> </tr> <tr> <td>string $id Preselected key</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag</td> <td>1</td> </tr> <tr> <td>string $moreparamtourl Add more parameters onto the Ajax called URL</td> <td>1</td> </tr> <tr> <td>int $disabled Html select box is disabled</td> <td>1</td> </tr> <tr> <td>int $minimumInputLength Minimum Input Length</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to css styles</td> <td>1</td> </tr> <tr> <td>int $callurlonselect If set to 1, some code is added so an url return by the ajax is called when value is selected.</td> <td>1</td> </tr> <tr> <td>string $placeholder String to use as placeholder</td> <td>1</td> </tr> <tr> <td>integer $acceptdelayedhtml 1 = caller is requesting to have html js content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select area</td> <td>1</td> </tr> <tr> <td>array<string,array{text:string,url:string}> $array Array (key=>array('text'=>'A text', 'url'=>'An url'), ...)</td> <td>1</td> </tr> <tr> <td>string $id Preselected key</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag</td> <td>1</td> </tr> <tr> <td>int<0,1> $disableFiltering If set to 1, results are not filtered with searched string</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled Html select box is disabled</td> <td>1</td> </tr> <tr> <td>int $minimumInputLength Minimum Input Length</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to css styles</td> <td>1</td> </tr> <tr> <td>int<0,1> $callurlonselect If set to 1, some code is added so an url return by the ajax is called when value is selected.</td> <td>1</td> </tr> <tr> <td>string $placeholder String to use as placeholder</td> <td>1</td> </tr> <tr> <td>int<0,1> $acceptdelayedhtml 1 = caller is requesting to have html js content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect)</td> <td>1</td> </tr> <tr> <td>string $textfortitle Text to show on title.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select</td> <td>1</td> </tr> <tr> <td>array<string,string|array{id:string,label:string,color:string,picto:string,labelhtml:string}> $array Array(key=>value) or Array(key=>array('id'=>key, 'label'=>value, 'color'=> , 'picto'=> , 'labelhtml'=> ))</td> <td>1</td> </tr> <tr> <td>string[] $selected Array of keys preselected</td> <td>1</td> </tr> <tr> <td>int<0,1> $key_in_label 1 to show key like in "[key] value"</td> <td>1</td> </tr> <tr> <td>int<0,1> $value_as_key 1 to use value as key</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css style</td> <td>1</td> </tr> <tr> <td>int<0,1> $translate Translate and encode value</td> <td>1</td> </tr> <tr> <td>int|string $width Force width of select box. May be used only when using jquery couch. Example: 250, '95%'</td> <td>1</td> </tr> <tr> <td>string $moreattrib Add more options on select component. Example: 'disabled'</td> <td>1</td> </tr> <tr> <td>string $elemtype Type of element we show ('category', ...). Will execute a formatting function on it. To use in readonly mode if js component support HTML formatting.</td> <td>1</td> </tr> <tr> <td>string $placeholder String to use as placeholder</td> <td>1</td> </tr> <tr> <td>int<-1,1> $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field</td> <td>1</td> </tr> <tr> <td>array<string,array{label:string,checked:string,enabled?:string,type?:string,langfile?:string}> $array Array with array of fields we could show. This array may be modified according to setup of user.</td> <td>1</td> </tr> <tr> <td>string $varpage Id of context for page. Can be set by caller with $varpage=(empty($contextpage)?$_SERVER["PHP_SELF"]:$contextpage);</td> <td>1</td> </tr> <tr> <td>string $pos Position colon on liste value 'left' or '' (meaning 'right').</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact'). Old mode (0, 1, 2, ...) is deprecated.</td> <td>1</td> </tr> <tr> <td>int<0,1> $rendermode 0=Default, use multiselect. 1=Emulate multiselect (recommended)</td> <td>1</td> </tr> <tr> <td>int<0,1> $nolink 1=Do not add html links</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object we want to show links to</td> <td>1</td> </tr> <tr> <td>string $morehtmlright More html to show on right of title</td> <td>1</td> </tr> <tr> <td>array<int,string> $compatibleImportElementsList Array of compatibles elements object for "import from" action</td> <td>1</td> </tr> <tr> <td>string $title Title</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object we want to show links to</td> <td>1</td> </tr> <tr> <td>string[] $restrictlinksto Restrict links to some elements, for example array('order') or array('supplier_order'). null or array() if no restriction.</td> <td>1</td> </tr> <tr> <td>string[] $excludelinksto Do not show links of this type, for example array('order') or array('supplier_order'). null or array() if no exclusion.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select field</td> <td>1</td> </tr> <tr> <td>string $value Pre-selected value</td> <td>1</td> </tr> <tr> <td>int $option 0 return yes/no, 1 return 1/0</td> <td>1</td> </tr> <tr> <td>bool $disabled true or false</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add empty line</td> <td>1</td> </tr> <tr> <td>int $addjscombo 1=Add js beautifier on combo box</td> <td>1</td> </tr> <tr> <td>string $labelyes Label for Yes</td> <td>1</td> </tr> <tr> <td>string $labelno Label for No</td> <td>1</td> </tr> <tr> <td>string $selected Id modele pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $type Type of searched templates</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object to show.</td> <td>1</td> </tr> <tr> <td>string $paramid Name of parameter to use to name the id into the URL next/previous link.</td> <td>1</td> </tr> <tr> <td>string $morehtml More html content to output just before the nav bar.</td> <td>1</td> </tr> <tr> <td>int<0,1> $shownav Show Condition (navigation is shown if value is 1).</td> <td>1</td> </tr> <tr> <td>string $fieldid Name of field id into database to use for select next and previous (we make the select max and min on this field compared to $object->ref). Use 'none' to disable next/prev.</td> <td>1</td> </tr> <tr> <td>string $fieldref Name of field ref of object (object->ref) to show or 'none' to not show ref.</td> <td>1</td> </tr> <tr> <td>string $morehtmlref More html to show after ref.</td> <td>1</td> </tr> <tr> <td>string $moreparam More param to add in nav link url. Must start with '&...'.</td> <td>1</td> </tr> <tr> <td>int<0,1> $nodbprefix Do not include DB prefix to forge table name.</td> <td>1</td> </tr> <tr> <td>string $morehtmlleft More html code to show before ref.</td> <td>1</td> </tr> <tr> <td>string $morehtmlstatus More html code to show under navigation arrows (status place).</td> <td>1</td> </tr> <tr> <td>string $morehtmlright More html code to show after ref.</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object containing data to retrieve file name</td> <td>1</td> </tr> <tr> <td>int $width Width of photo</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS on img of barcode</td> <td>1</td> </tr> <tr> <td>string $modulepart Key to define module concerned ('societe', 'userphoto', 'memberphoto')</td> <td>1</td> </tr> <tr> <td>Societe|Adherent|Contact|User|CommonObject $object Object containing data to retrieve file name</td> <td>1</td> </tr> <tr> <td>int $width Width of photo</td> <td>1</td> </tr> <tr> <td>int $height Height of photo (auto if 0)</td> <td>1</td> </tr> <tr> <td>int<0,1> $caneditfield Add edit fields</td> <td>1</td> </tr> <tr> <td>string $cssclass CSS name to use on img for photo</td> <td>1</td> </tr> <tr> <td>string $imagesize 'mini', 'small' or '' (original)</td> <td>1</td> </tr> <tr> <td>int<0,1> $addlinktofullsize Add link to fullsize image</td> <td>1</td> </tr> <tr> <td>int<0,1> $cache 1=Accept to use image in cache</td> <td>1</td> </tr> <tr> <td>string $forcecapture '', 'user' or 'environment'. Force parameter capture on HTML input file element to ask a smartphone to allow to open camera to take photo. Auto if ''.</td> <td>1</td> </tr> <tr> <td>int<0,1> $noexternsourceoverwrite No overwrite image with extern source (like 'gravatar' or other module)</td> <td>1</td> </tr> <tr> <td>int|object|object[] $selected Id group or group(s) preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Field name in form</td> <td>1</td> </tr> <tr> <td>int<0,1> $show_empty 0=liste sans valeur nulle, 1=ajoute valeur inconnue</td> <td>1</td> </tr> <tr> <td>string|int[] $exclude Array list of groups id to exclude</td> <td>1</td> </tr> <tr> <td>int<0,1> $disabled If select list must be disabled</td> <td>1</td> </tr> <tr> <td>string|int[] $include Array list of groups id to include</td> <td>1</td> </tr> <tr> <td>int[] $enableonly Array list of groups id to be enabled. All other must be disabled</td> <td>1</td> </tr> <tr> <td>string $force_entity '0' or Ids of environment to force</td> <td>1</td> </tr> <tr> <td>bool $multiple add [] in the name of element and add 'multiple' attribute (not working with ajax_autocompleter)</td> <td>1</td> </tr> <tr> <td>string $morecss More css to add to html component</td> <td>1</td> </tr> <tr> <td>string $pos Position of colon on the list. Value 'left' or 'right'</td> <td>1</td> </tr> <tr> <td>string $massactionname Mass action button name that will launch an action on the selected items</td> <td>1</td> </tr> <tr> <td>int $addcheckuncheckall Add the check all/uncheck all checkbox (use javascript) and code to manage this</td> <td>1</td> </tr> <tr> <td>string $massactionname Mass action name</td> <td>1</td> </tr> <tr> <td>string $selected preselected category</td> <td>1</td> </tr> <tr> <td>string $htmlname name of HTML select list</td> <td>1</td> </tr> <tr> <td>int<0,1> $useempty 1=Add empty line</td> <td>1</td> </tr> <tr> <td>int[] $excludeid id to exclude</td> <td>1</td> </tr> <tr> <td>string $target htmlname of target select to bind event</td> <td>1</td> </tr> <tr> <td>int $default_selected default category to select if fk_c_type_fees change = EX_KME</td> <td>1</td> </tr> <tr> <td>array<string,int|string> $params param to give</td> <td>1</td> </tr> <tr> <td>int<0,1> $info_admin Show the tooltip help picto to setup list</td> <td>1</td> </tr> <tr> <td>integer $useempty 1=Add empty choice</td> <td>1</td> </tr> <tr> <td>integer $allchoice 1=Add all choice</td> <td>1</td> </tr> <tr> <td>integer $useid 0=use 'code' as key, 1=use 'id' as key</td> <td>1</td> </tr> <tr> <td>int $discard_closed Discard closed projects (0=Keep,1=hide completely,2=Disable)</td> <td>1</td> </tr> <tr> <td>string $showproject 'all' = Show project info, ''=Hide project info</td> <td>1</td> </tr> <tr> <td>array<array<string,array{type:string}>> $arrayofcriterias Array of available search criteria. Example: array($object->element => $object->fields, 'otherfamily' => otherarrayoffields, ...)</td> <td>1</td> </tr> <tr> <td>array<int,string> $search_component_params Array of selected search criteria</td> <td>1</td> </tr> <tr> <td>string[] $arrayofinputfieldsalreadyoutput Array of input fields already inform. The component will not generate a hidden input field if it is in this list.</td> <td>1</td> </tr> <tr> <td>string $search_component_params_hidden String with $search_component_params criteria</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix</td> <td>1</td> </tr> <tr> <td>string $modelType Model type</td> <td>1</td> </tr> <tr> <td>int<0,1> $default 1=Show also Default mail template</td> <td>1</td> </tr> <tr> <td>int<0,1> $addjscombo Add js combobox</td> <td>1</td> </tr> <tr> <td>string $save_label Alternative label for save button</td> <td>1</td> </tr> <tr> <td>string $cancel_label Alternative label for cancel button</td> <td>1</td> </tr> <tr> <td>array<array{addclass?:string,name?:string,label_key?:string}> $morebuttons Add additional buttons between save and cancel</td> <td>1</td> </tr> <tr> <td>bool $withoutdiv Option to remove enclosing centered div</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $dol_openinpopup If the button are shown in a context of a page shown inside a popup, we put here the string name of popup.</td> <td>1</td> </tr> <tr> <td>int $selected Id of invoice subtype to preselect by default</td> <td>1</td> </tr> <tr> <td>string $htmlname Select field name</td> <td>1</td> </tr> <tr> <td>int<0,1> $addempty Add an empty entry</td> <td>1</td> </tr> <tr> <td>int<0,1> $noinfoadmin 0=Add admin info, 1=Disable admin info</td> <td>1</td> </tr> <tr> <td>string $morecss Add more CSS on select tag</td> <td>1</td> </tr> <tr> <td>mixed $value Value of property</td> <td>1</td> </tr> <tr> <td>string $name Name of method</td> <td>1</td> </tr> <tr> <td>mixed[] $arguments Method arguments</td> <td>1</td> </tr> <tr> <td>array $parameters Hook parameters.</td> <td>1</td> </tr> <tr> <td>array|string $allContexts Context to check</td> <td>1</td> </tr> <tr> <td>string $string1 First string</td> <td>1</td> </tr> <tr> <td>string $string2 Second string</td> <td>1</td> </tr> <tr> <td>string $file1 Path to the first file</td> <td>1</td> </tr> <tr> <td>string $file2 Path to the second file</td> <td>1</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> $table the table returned by the computeTable function</td> <td>1</td> </tr> <tr> <td>string $separator the separator between lines; this optional parameter defaults to "\n"</td> <td>1</td> </tr> <tr> <td>string $separator the separator between lines; this optional parameter defaults to '<br>'</td> <td>1</td> </tr> <tr> <td>string $indentation indentation to add to every line of the generated HTML; this optional parameter defaults to ''</td> <td>1</td> </tr> <tr> <td>string $separator the separator between lines; this optional parameter defaults to '<br>'</td> <td>1</td> </tr> <tr> <td>string $indentation indentation to add to every line of the generated HTML</td> <td>1</td> </tr> <tr> <td>string $separator the separator between lines</td> <td>1</td> </tr> <tr> <td>string $index the current index, passes by reference</td> <td>1</td> </tr> <tr> <td>string $type the type of line</td> <td>1</td> </tr> <tr> <td>array $_options An array of options for stream_context_create()</td> <td>1</td> </tr> <tr> <td>int $_val Value</td> <td>1</td> </tr> <tr> <td>string $_strErrorsTo Errors to</td> <td>1</td> </tr> <tr> <td>boolean $_part Variant</td> <td>1</td> </tr> <tr> <td>boolean $_vDebug Value for debug</td> <td>1</td> </tr> <tr> <td>mixed $_strConfigPath path to config file or VOID</td> <td>1</td> </tr> <tr> <td>int $_type Integer value representing Mail Transport Type</td> <td>1</td> </tr> <tr> <td>string $_path Path to the sendmail executable</td> <td>1</td> </tr> <tr> <td>string $_strHost Host Name or IP of the Mail Server to use</td> <td>1</td> </tr> <tr> <td>int|string $_intPort Port Number of the Mail Server to use</td> <td>1</td> </tr> <tr> <td>string $_strID User Name for authentication on Mail Server</td> <td>1</td> </tr> <tr> <td>string $_strPW User Password for authentication on Mail Server</td> <td>1</td> </tr> <tr> <td>string $_strToken User token</td> <td>1</td> </tr> <tr> <td>string $_strCharSet Character set used for current message</td> <td>1</td> </tr> <tr> <td>string $_strTransEncode Content-Transfer-Encoding</td> <td>1</td> </tr> <tr> <td>string $_strTransEncodeType Content-Transfer-Encoding</td> <td>1</td> </tr> <tr> <td>string $_strFrom Address from which mail will be sent</td> <td>1</td> </tr> <tr> <td>string $_strReplyTo Address from which mail will be the reply-to</td> <td>1</td> </tr> <tr> <td>string $_strInReplyTo List of Msg-Id</td> <td>1</td> </tr> <tr> <td>string $_strReferences List of Msg-Id</td> <td>1</td> </tr> <tr> <td>string $_type TO, CC, or BCC lists to add addrresses into</td> <td>1</td> </tr> <tr> <td>mixed $_addrList Array or COMMA delimited string of addresses</td> <td>1</td> </tr> <tr> <td>string $_strAddr Email address</td> <td>1</td> </tr> <tr> <td>string $_which Which collection of addresses to return ('to', 'cc', 'bcc')</td> <td>1</td> </tr> <tr> <td>string $_addrTo TO Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string $_strCC CC Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string $_strBCC Recipients BCC Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string $_strSubject Message Subject</td> <td>1</td> </tr> <tr> <td>string $strContent Message Content</td> <td>1</td> </tr> <tr> <td>string $strType Type</td> <td>1</td> </tr> <tr> <td>string $strContent File data to attach to message</td> <td>1</td> </tr> <tr> <td>string $strFileName File Name to give to attachment</td> <td>1</td> </tr> <tr> <td>string $strMimeType File Mime Type of attachment</td> <td>1</td> </tr> <tr> <td>string $strCid File Cid of attachment (if defined, to be shown inline)</td> <td>1</td> </tr> <tr> <td>string $strContent Image data to attach to message</td> <td>1</td> </tr> <tr> <td>string $strImageName Image Name to give to attachment</td> <td>1</td> </tr> <tr> <td>string $strMimeType Image Mime Type of attachment</td> <td>1</td> </tr> <tr> <td>string $strImageCid CID</td> <td>1</td> </tr> <tr> <td>integer $_value Message Sensitivity</td> <td>1</td> </tr> <tr> <td>integer $_value Message Priority</td> <td>1</td> </tr> <tr> <td>boolean $_flag MD5flag</td> <td>1</td> </tr> <tr> <td>string $strXdata Message X-Header Content</td> <td>1</td> </tr> <tr> <td>string $type Type of boundary</td> <td>1</td> </tr> <tr> <td>resource $socket Socket handler</td> <td>1</td> </tr> <tr> <td>string $response Expected response ('250', ...). Example of response we can get:</td> <td>1</td> </tr> <tr> <td>string $_strSend String to send</td> <td>1</td> </tr> <tr> <td>string $_returnCode Expected return code</td> <td>1</td> </tr> <tr> <td>string $CRLF CRLF</td> <td>1</td> </tr> <tr> <td>int $_errNum Error Code Number</td> <td>1</td> </tr> <tr> <td>string $_errMsg Error Message</td> <td>1</td> </tr> <tr> <td>string $type The categorie type (e.g Categorie::TYPE_WAREHOUSE)</td> <td>1</td> </tr> <tr> <td>array $preSelected A list with the elements that should pre-selected</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $searchCategoryProductOperator Used only if $multiselect is 1. Set to 0 or 1 to enable the checkbox to search with a or (0=not preseleted, 1=preselected), -1=Checkbox never shown.</td> <td>1</td> </tr> <tr> <td>int $multiselect 0 or 1</td> <td>1</td> </tr> <tr> <td>int $nocateg 1=Add an entry '- No Category -'</td> <td>1</td> </tr> <tr> <td>string $showempty 1 or 'string' to add an empty entry</td> <td>1</td> </tr> <tr> <td>int $selected Id category pre-selection</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter as an Universal Search string or Array (array use is deprecated)</td> <td>1</td> </tr> <tr> <td>string $name Filename</td> <td>1</td> </tr> <tr> <td>array $value either an argument list (two strings) or a single string</td> <td>1</td> </tr> <tr> <td>mixed $in Input</td> <td>1</td> </tr> <tr> <td>bool $force Force rebuild?</td> <td>1</td> </tr> <tr> <td>string $buffer String to parse</td> <td>1</td> </tr> <tr> <td>string $selected Preselected type</td> <td>1</td> </tr> <tr> <td>string $morecss Add more CSS on select</td> <td>1</td> </tr> <tr> <td>int $noerrorifempty No print error if list is empty for the country</td> <td>1</td> </tr> <tr> <td>string $morecss Class on first column td</td> <td>1</td> </tr> <tr> <td>int $showform Show form tags and submit button (recommended is to use with value 0)</td> <td>1</td> </tr> <tr> <td>int $noprint 1=Return HTML string instead of printing it to output</td> <td>1</td> </tr> <tr> <td>string $morejs Add more js. For example: ".on( \'saveSnapshot\', function(e) { alert(\'ee\'); });". Used by CKEditor only.</td> <td>1</td> </tr> <tr> <td>boolean $disallowAnyContent Disallow to use any content. true=restrict to a predefined list of allowed elements. Used by CKEditor only.</td> <td>1</td> </tr> <tr> <td>string $titlecontent Show title content before editor area. Used by ACE editor only.</td> <td>1</td> </tr> <tr> <td>string $option For ACE editor, set the source language ('html', 'php', 'javascript', ...)</td> <td>1</td> </tr> <tr> <td>string $moreparam Add extra tags to the textarea</td> <td>1</td> </tr> <tr> <td>string $morecss Add extra css to the textarea</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML name of WYSIWYG field</td> <td>1</td> </tr> <tr> <td>string $content Content of WYSIWYG field</td> <td>1</td> </tr> <tr> <td>int|string $width Width in pixel of edit area (auto by default)</td> <td>1</td> </tr> <tr> <td>int $height Height in pixel of edit area (200px by default)</td> <td>1</td> </tr> <tr> <td>string $toolbarname Name of bar set to use ('Full', 'dolibarr_notes[_encoded]', 'dolibarr_details[_encoded]'=the less featured, 'dolibarr_mailings[_encoded]', 'dolibarr_readonly').</td> <td>1</td> </tr> <tr> <td>string $toolbarlocation Deprecated. Not used</td> <td>1</td> </tr> <tr> <td>boolean $toolbarstartexpanded Bar is visible or not at start</td> <td>1</td> </tr> <tr> <td>boolean|int $uselocalbrowser Enabled to add links to local object with local browser. If false, only external images can be added in content.</td> <td>1</td> </tr> <tr> <td>boolean|string $okforextendededitor True=Allow usage of extended editor tool if qualified (like ckeditor). If 'textarea', force use of simple textarea. If 'ace', force use of Ace.</td> <td>1</td> </tr> <tr> <td>int $rows Size of rows for textarea tool</td> <td>1</td> </tr> <tr> <td>string $cols Size of cols for textarea tool (textarea number of cols '70' or percent 'x%')</td> <td>1</td> </tr> <tr> <td>int $readonly 0=Read/Edit, 1=Read only</td> <td>1</td> </tr> <tr> <td>array $poscursor Array for initial cursor position array('x'=>x, 'y'=>y).</td> <td>1</td> </tr> <tr> <td>int $selected Preselected type</td> <td>1</td> </tr> <tr> <td>array $exclude Exclude values from the list</td> <td>1</td> </tr> <tr> <td>int $scriptonly Add warning if synchro only work with a script (0 = disable, 1 = Dolibarr2ldap, 2 = ldap2dolibarr, 3 = all)</td> <td>1</td> </tr> <tr> <td>string $to Recipients SMS</td> <td>1</td> </tr> <tr> <td>string $from Sender SMS</td> <td>1</td> </tr> <tr> <td>string $msg Message</td> <td>1</td> </tr> <tr> <td>int $deliveryreceipt Not used</td> <td>1</td> </tr> <tr> <td>int $deferred Deferred or not</td> <td>1</td> </tr> <tr> <td>int $priority Priority</td> <td>1</td> </tr> <tr> <td>int $class Class</td> <td>1</td> </tr> <tr> <td>int $result Result of sms sending</td> <td>1</td> </tr> <tr> <td>string $a Server</td> <td>1</td> </tr> <tr> <td>string $desc Description</td> <td>1</td> </tr> <tr> <td>string $response Server</td> <td>1</td> </tr> <tr> <td>string $openid_identity Server</td> <td>1</td> </tr> <tr> <td>array $arr An array</td> <td>1</td> </tr> <tr> <td>string $url URL</td> <td>1</td> </tr> <tr> <td>string $method Method</td> <td>1</td> </tr> <tr> <td>string $params Params</td> <td>1</td> </tr> <tr> <td>string $content Content</td> <td>1</td> </tr> <tr> <td>string $url Url to found endpoint</td> <td>1</td> </tr> <tr> <td>string $url Url of endpoint to request</td> <td>1</td> </tr> <tr> <td>int $selected Id code pre-selected</td> <td>1</td> </tr> <tr> <td>array $barcodelist Array of barcodes generators</td> <td>1</td> </tr> <tr> <td>int $code_id Id du code barre</td> <td>1</td> </tr> <tr> <td>string $idForm Id of html form, ex id="idform"</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>int $useempty Display empty value in select</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>int $selected Id condition preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom du formulaire select</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>int $selected Id condition preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom du formulaire select</td> <td>1</td> </tr> <tr> <td>string $selected Id of preselected input method</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select list</td> <td>1</td> </tr> <tr> <td>int $addempty 0=list with no empty value, 1=list with empty value</td> <td>1</td> </tr> <tr> <td>integer $selected Type pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom champ formulaire</td> <td>1</td> </tr> <tr> <td>string $jstoexecuteonadd Name of javascript function to call once the barcode scanning session is complete and user has click on "Add".</td> <td>1</td> </tr> <tr> <td>string $mode 'all' (both product and lot barcode) or 'product' (product barcode only) or 'lot' (lot number only)</td> <td>1</td> </tr> <tr> <td>int $warehouseselect 0 (disable warehouse select) or 1 (enable warehouse select)</td> <td>1</td> </tr> <tr> <td>int $useempty Show an empty value in list</td> <td>1</td> </tr> <tr> <td>int $fk_user User we want templates</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>int $fk_user User that has created the template</td> <td>1</td> </tr> <tr> <td>string $selected Preselected ecotaxes</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of combo list</td> <td>1</td> </tr> <tr> <td>string $selected Value of preselected revenue stamp</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of combo list</td> <td>1</td> </tr> <tr> <td>string $country_code Country Code</td> <td>1</td> </tr> <tr> <td>integer $selected pourcentage pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname nom de la liste deroulante</td> <td>1</td> </tr> <tr> <td>int $disabled Disabled or not</td> <td>1</td> </tr> <tr> <td>int $increment increment value</td> <td>1</td> </tr> <tr> <td>int $start start value</td> <td>1</td> </tr> <tr> <td>int $end end value</td> <td>1</td> </tr> <tr> <td>int $showempty Add also an empty line</td> <td>1</td> </tr> <tr> <td>int $type Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.</td> <td>1</td> </tr> <tr> <td>integer $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of combo list</td> <td>1</td> </tr> <tr> <td>int $nocateg Show also an entry "Not categorized"</td> <td>1</td> </tr> <tr> <td>int|string $showempty Add also an empty line</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int|string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of combo list (example: 'search_sale')</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $showstatus 0=show user status only if status is disabled, 1=always show user status into label, -1=never show user status</td> <td>1</td> </tr> <tr> <td>int|string $showempty 1=show also an empty value or text to show for empty</td> <td>1</td> </tr> <tr> <td>int $norepresentative Show also an entry "Not categorized"</td> <td>1</td> </tr> <tr> <td>int $selectedtask Pre-selected task</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select</td> <td>1</td> </tr> <tr> <td>int $modeproject 1 to restrict on projects owned by user</td> <td>1</td> </tr> <tr> <td>int $modetask 1 to restrict on tasks associated to user</td> <td>1</td> </tr> <tr> <td>int $useempty 0=Allow empty values</td> <td>1</td> </tr> <tr> <td>string $filteronprojstatus Filter on project status ('-1'=no filter, '0,1'=Draft+Validated status)</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>int $inc Cursor counter</td> <td>1</td> </tr> <tr> <td>int $parent Id of parent task we want to see</td> <td>1</td> </tr> <tr> <td>array $lines Array of task lines</td> <td>1</td> </tr> <tr> <td>int $selectedtask Id selected task</td> <td>1</td> </tr> <tr> <td>int $selectedproject Id selected project</td> <td>1</td> </tr> <tr> <td>string $color String with hex (FFFFFF) or comma RGB ('255,255,255')</td> <td>1</td> </tr> <tr> <td>string $textifnotdefined Text to show if color not defined</td> <td>1</td> </tr> <tr> <td>string $set_color Pre-selected color</td> <td>1</td> </tr> <tr> <td>string $prefix Name of HTML field</td> <td>1</td> </tr> <tr> <td>string $form_name Deprecated. Not used.</td> <td>1</td> </tr> <tr> <td>int $showcolorbox 1=Show color code and color box, 0=Show only color code</td> <td>1</td> </tr> <tr> <td>array $arrayofcolors Array of colors. Example: array('29527A','5229A3','A32929','7A367A','B1365F','0D7813')</td> <td>1</td> </tr> <tr> <td>string $set_color Pre-selected color with format '#......'</td> <td>1</td> </tr> <tr> <td>string $prefix Name of HTML field</td> <td>1</td> </tr> <tr> <td>string $form_name Deprecated. Not used.</td> <td>1</td> </tr> <tr> <td>int $showcolorbox 1=Show color code and color box, 0=Show only color code</td> <td>1</td> </tr> <tr> <td>array $arrayofcolors Array of possible colors to choose in the selector. All colors are possible if empty. Example: array('29527A','5229A3','A32929','7A367A','B1365F','0D7813')</td> <td>1</td> </tr> <tr> <td>string $morecss Add css style into input field</td> <td>1</td> </tr> <tr> <td>string $setpropertyonselect Set this CSS property after selecting a color</td> <td>1</td> </tr> <tr> <td>string $default Default color</td> <td>1</td> </tr> <tr> <td>string $color Color of image</td> <td>1</td> </tr> <tr> <td>string $module Name of module</td> <td>1</td> </tr> <tr> <td>string $name Name of image</td> <td>1</td> </tr> <tr> <td>int $x Largeur de l'image en pixels</td> <td>1</td> </tr> <tr> <td>int $y Hauteur de l'image en pixels</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select object</td> <td>1</td> </tr> <tr> <td>int $useempty Show empty in list</td> <td>1</td> </tr> <tr> <td>int $longlabel Show long label</td> <td>1</td> </tr> <tr> <td>string $morecss More Css</td> <td>1</td> </tr> <tr> <td>bool $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value (''=current year, -1=none, year otherwise)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select object</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>int $min_year Offset of minimum year into list (by default current year -10)</td> <td>1</td> </tr> <tr> <td>int $max_year Offset of maximum year into list (by default current year + 5)</td> <td>1</td> </tr> <tr> <td>int $invert Invert</td> <td>1</td> </tr> <tr> <td>string $option Option</td> <td>1</td> </tr> <tr> <td>bool $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value (''=current year, -1=none, year otherwise)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select object</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>int $min_year Offset of minimum year into list (by default current year -10)</td> <td>1</td> </tr> <tr> <td>int $max_year Offset of maximum year into list (by default current year + 5)</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>int $invert Invert</td> <td>1</td> </tr> <tr> <td>string $option Option</td> <td>1</td> </tr> <tr> <td>bool $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>User $user Object User</td> <td>1</td> </tr> <tr> <td>string $areacode Code of area for pages - 0 = Home page ... See getListOfPagesForBoxes()</td> <td>1</td> </tr> <tr> <td>string $dictionarytable Dictionary table</td> <td>1</td> </tr> <tr> <td>string $keyfield Field for key</td> <td>1</td> </tr> <tr> <td>string $labelfield Label field</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select field</td> <td>1</td> </tr> <tr> <td>string $value Pre-selected value</td> <td>1</td> </tr> <tr> <td>int $option 0 return automatic/manual, 1 return 1/0</td> <td>1</td> </tr> <tr> <td>bool $disabled true or false</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add empty line</td> <td>1</td> </tr> <tr> <td>array $search_groupby Array of preselected fields</td> <td>1</td> </tr> <tr> <td>array $arrayofgroupby Array of groupby to fill</td> <td>1</td> </tr> <tr> <td>array $search_xaxis Array of preselected fields</td> <td>1</td> </tr> <tr> <td>array $arrayofxaxis Array of groupby to fill</td> <td>1</td> </tr> <tr> <td>string $mode 'available' or 'activated'</td> <td>1</td> </tr> <tr> <td>int $zone Name or area (-1 for all, 0 for Homepage, 1 for Accountancy, 2 for xxx, ...)</td> <td>1</td> </tr> <tr> <td>User|null $user Object user to filter</td> <td>1</td> </tr> <tr> <td>array $excludelist Array of box id (box.box_id = boxes_def.rowid) to exclude</td> <td>1</td> </tr> <tr> <td>int $includehidden Include also hidden boxes</td> <td>1</td> </tr> <tr> <td>int $zone Name of area (0 for Homepage, ...)</td> <td>1</td> </tr> <tr> <td>string $boxorder List of boxes with correct order 'A:123,456,...-B:789,321...'</td> <td>1</td> </tr> <tr> <td>int $userid Id of user</td> <td>1</td> </tr> <tr> <td>string $key Google key</td> <td>1</td> </tr> <tr> <td>string $address Address</td> <td>1</td> </tr> <tr> <td>string $short_label Short Label ('g', 'kg', ...)</td> <td>1</td> </tr> <tr> <td>string $unit_type Unit type ('size', 'surface', 'volume', 'weight', ...)</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter USF</td> <td>1</td> </tr> <tr> <td>string $code code of unit</td> <td>1</td> </tr> <tr> <td>string $unit_type weight,size,surface,volume,qty,time...</td> <td>1</td> </tr> <tr> <td>double $value value to convert</td> <td>1</td> </tr> <tr> <td>int $fk_unit current unit id of value</td> <td>1</td> </tr> <tr> <td>int $fk_new_unit the id of unit to convert in</td> <td>1</td> </tr> <tr> <td>int $id Id of unit in dictionary</td> <td>1</td> </tr> <tr> <td>DoliDB $db database</td> <td>1</td> </tr> <tr> <td>string $selected Id printer type pre-selected</td> <td>1</td> </tr> <tr> <td>string $selected Id printer profile pre-selected</td> <td>1</td> </tr> <tr> <td>int $templateid Template ID</td> <td>1</td> </tr> <tr> <td>int $templateid Template id</td> <td>1</td> </tr> <tr> <td>int $printerid Printer id</td> <td>1</td> </tr> <tr> <td>int $addimgandbarcode Add image and barcode into the test</td> <td>1</td> </tr> <tr> <td>Facture|Commande $object Order or invoice object</td> <td>1</td> </tr> <tr> <td>int $templateid Template id</td> <td>1</td> </tr> <tr> <td>int $printerid Printer id</td> <td>1</td> </tr> <tr> <td>int $templateid Template id</td> <td>1</td> </tr> <tr> <td>int $printerid Printer id</td> <td>1</td> </tr> <tr> <td>string|Project $selected Id of preselected project or Project (or ''). Note: If you know the ref, you can also provide it into $selected_input_value to save one request in some cases.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field</td> <td>1</td> </tr> <tr> <td>int|string $show_empty Add an empty line</td> <td>1</td> </tr> <tr> <td>int $discard_closed Discard closed projects (0=Keep, 1=hide completely, 2=Disable). Use a negative value to not show the "discarded" tooltip.</td> <td>1</td> </tr> <tr> <td>int $mode 0 for HTML mode and 1 for JSON mode</td> <td>1</td> </tr> <tr> <td>string $filterkey Key to filter on ref or title</td> <td>1</td> </tr> <tr> <td>string $htmlid Html id to use instead of htmlname, by example id="htmlid"</td> <td>1</td> </tr> <tr> <td>int $selected Id project preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html component</td> <td>1</td> </tr> <tr> <td>int|string $show_empty Add an empty line</td> <td>1</td> </tr> <tr> <td>int $discard_closed Discard closed projects (0=Keep,1=hide completely,2=Disable)</td> <td>1</td> </tr> <tr> <td>int $mode 0 for HTML mode and 1 for array return (to be used by json_encode for example)</td> <td>1</td> </tr> <tr> <td>string $filterkey Key to filter on title or ref</td> <td>1</td> </tr> <tr> <td>string $htmlid Html id to use instead of htmlname</td> <td>1</td> </tr> <tr> <td>int $selected Id task preselected</td> <td>1</td> </tr> <tr> <td>int $discard_closed Discard closed projects (0=Keep, 1=hide completely, 2=Disable)</td> <td>1</td> </tr> <tr> <td>string $showmore 'all' = Show project info, 'progress' = Show task progression, ''=Show nothing more</td> <td>1</td> </tr> <tr> <td>string $table_element Table of the element to update</td> <td>1</td> </tr> <tr> <td>int|string $socid If of thirdparty to use as filter or 'id1,id2,...'</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $limitonstatus Add filters to limit length of list to opened status (for example to avoid ERR_RESPONSE_HEADERS_TOO_BIG on project/element.php page). TODO To implement</td> <td>1</td> </tr> <tr> <td>string $projectkey Equivalent key to fk_projet for actual table_element</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML name</td> <td>1</td> </tr> <tr> <td>string $preselected Preselected (int or 'all' or 'none')</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty line</td> <td>1</td> </tr> <tr> <td>int $useshortlabel Use short label</td> <td>1</td> </tr> <tr> <td>int $showallnone Add choice "All" and "None"</td> <td>1</td> </tr> <tr> <td>int $showpercent Show default probability for status</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css</td> <td>1</td> </tr> <tr> <td>int $addcombojs 1=Add a js combo</td> <td>1</td> </tr> <tr> <td>int $selectedInvoiceId Id invoice preselected</td> <td>1</td> </tr> <tr> <td>int $selectedLineId Id invoice line preselected</td> <td>1</td> </tr> <tr> <td>string $htmlNameInvoice Name of HTML select for Invoice</td> <td>1</td> </tr> <tr> <td>string $htmlNameInvoiceLine Name of HTML select for Invoice Line</td> <td>1</td> </tr> <tr> <td>array $filters Array of filters</td> <td>1</td> </tr> <tr> <td>int $lineOnly return only option for line</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>string $selected Id preselected</td> <td>1</td> </tr> <tr> <td>int $percent_value percentage of the opportunity</td> <td>1</td> </tr> <tr> <td>string $htmlname_status name of HTML element for status select</td> <td>1</td> </tr> <tr> <td>string $htmlname_percent name of HTML element for percent input</td> <td>1</td> </tr> <tr> <td>string $filter optional filters criteras</td> <td>1</td> </tr> <tr> <td>int $nooutput No print output. Return it only.</td> <td>1</td> </tr> <tr> <td>string|array $filter filter USF</td> <td>1</td> </tr> <tr> <td>int $entity Entity to get</td> <td>1</td> </tr> <tr> <td>int $mode 0=Return id+label, 1=Return code+label</td> <td>1</td> </tr> <tr> <td>int $mode 0=return id+label, 1=return code+Label</td> <td>1</td> </tr> <tr> <td>string $selected Code state preselected</td> <td>1</td> </tr> <tr> <td>int $country_codeid 0=list for all countries, otherwise country code or country rowid to show</td> <td>1</td> </tr> <tr> <td>string $htmlname Id of department</td> <td>1</td> </tr> <tr> <td>string $parent_field_id Parent select name to monitor</td> <td>1</td> </tr> <tr> <td>integer $selected Code state preselected (mus be state id)</td> <td>1</td> </tr> <tr> <td>integer $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show</td> <td>1</td> </tr> <tr> <td>string $htmlname Id of department. If '', we want only the string with <option></td> <td>1</td> </tr> <tr> <td>string $morecss Add more css</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field</td> <td>1</td> </tr> <tr> <td>string $selected Civility/Title code preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select combo field</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on SELECT element</td> <td>1</td> </tr> <tr> <td>int $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $selected Preselected code for juridical type</td> <td>1</td> </tr> <tr> <td>mixed $country_codeid 0=All countries, else the code of the country to display</td> <td>1</td> </tr> <tr> <td>string $filter Add a SQL filter on list</td> <td>1</td> </tr> <tr> <td>string $selected Preselected code of juridical type</td> <td>1</td> </tr> <tr> <td>int $country_codeid 0=list for all countries, otherwise list only country requested</td> <td>1</td> </tr> <tr> <td>string $filter Add a SQL filter on list. Data must not come from user input.</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML name of select</td> <td>1</td> </tr> <tr> <td>object $object Object we try to find contacts</td> <td>1</td> </tr> <tr> <td>string $var_id Name of id field</td> <td>1</td> </tr> <tr> <td>int $selected Pre-selected third party</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML form</td> <td>1</td> </tr> <tr> <td>array $limitto Disable answers that are not id in this array list</td> <td>1</td> </tr> <tr> <td>int $forceid This is to force another object id than object->id</td> <td>1</td> </tr> <tr> <td>string $moreparam String with more param to add into url when noajax search is used.</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS on select component</td> <td>1</td> </tr> <tr> <td>object $object Object to use to find type of contact</td> <td>1</td> </tr> <tr> <td>string $selected Default selected value</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML select name</td> <td>1</td> </tr> <tr> <td>string $source Source ('internal' or 'external')</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort criteria ('position', 'code', ...)</td> <td>1</td> </tr> <tr> <td>int $showempty 1=Add en empty line</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css to select component</td> <td>1</td> </tr> <tr> <td>int $output 0=return HTML, 1= direct print</td> <td>1</td> </tr> <tr> <td>int $forcehidetooltip Force hide tooltip for admin</td> <td>1</td> </tr> <tr> <td>string $htmlname Html component name and id</td> <td>1</td> </tr> <tr> <td>Contact $contact Contact Object</td> <td>1</td> </tr> <tr> <td>string $rendermode view, edit</td> <td>1</td> </tr> <tr> <td>array $selected $key=>$val $val is selected Roles for input mode</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>string $preselected Default value to show</td> <td>1</td> </tr> <tr> <td>string $country_code FR, IT, ...</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>int $local LocalTax</td> <td>1</td> </tr> <tr> <td>float $selected Preselected value</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML select name</td> <td>1</td> </tr> <tr> <td>int $selected Selected value</td> <td>1</td> </tr> <tr> <td>string $htmlname HTML select name</td> <td>1</td> </tr> <tr> <td>string $htmlidname HTML select id</td> <td>1</td> </tr> <tr> <td>string $typeinput HTML output</td> <td>1</td> </tr> <tr> <td>string $allowempty Allow empty value or not</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>string $selected Id preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>string $filter optional filters criteras</td> <td>1</td> </tr> <tr> <td>int $nooutput No print output. Return it only.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>Societe|null $prospectstatic Prospect object</td> <td>1</td> </tr> <tr> <td>int $statusprospect status of prospect</td> <td>1</td> </tr> <tr> <td>int $idprospect id of prospect</td> <td>1</td> </tr> <tr> <td>string $mode select if we want activate de html part or js</td> <td>1</td> </tr> <tr> <td>int $offset Offset limit</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>string $filter Filter USF</td> <td>1</td> </tr> <tr> <td>int $code code of unit</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>Translate $outputLang Output lang for error</td> <td>1</td> </tr> <tr> <td>string $errMsg your error message</td> <td>1</td> </tr> <tr> <td>string $email e-mail address to validate</td> <td>1</td> </tr> <tr> <td>int $maxLength string max length (not used)</td> <td>1</td> </tr> <tr> <td>string $price Price to validate</td> <td>1</td> </tr> <tr> <td>string|int $stamp timestamp to validate</td> <td>1</td> </tr> <tr> <td>string $phone Phone string to validate</td> <td>1</td> </tr> <tr> <td>string $url to validate</td> <td>1</td> </tr> <tr> <td>mixed $duration to validate</td> <td>1</td> </tr> <tr> <td>mixed $string to validate</td> <td>1</td> </tr> <tr> <td>boolean $bool Boolean to validate</td> <td>1</td> </tr> <tr> <td>array $values Boolean to validate</td> <td>1</td> </tr> <tr> <td>string $table the db table name without $this->db->prefix()</td> <td>1</td> </tr> <tr> <td>string $col the target col</td> <td>1</td> </tr> <tr> <td>integer $id of element</td> <td>1</td> </tr> <tr> <td>string $classname the class name</td> <td>1</td> </tr> <tr> <td>string $classpath the class path</td> <td>1</td> </tr> <tr> <td>string $expr Expression</td> <td>1</td> </tr> <tr> <td>array $tokens Expression</td> <td>1</td> </tr> <tr> <td>array $vars Array</td> <td>1</td> </tr> <tr> <td>string $code Code</td> <td>1</td> </tr> <tr> <td>string $msg Msg</td> <td>1</td> </tr> <tr> <td>string|null $info String</td> <td>1</td> </tr> <tr> <td>string $val Val</td> <td>1</td> </tr> <tr> <td>int $n N</td> <td>1</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only contracts not linked to a third party, id=contracts not linked or linked to third party id)</td> <td>1</td> </tr> <tr> <td>int $selected Id contract preselected</td> <td>1</td> </tr> <tr> <td>int $showempty Show empty line</td> <td>1</td> </tr> <tr> <td>int $showRef Show customer and supplier reference on each contract (when found)</td> <td>1</td> </tr> <tr> <td>int $page Page</td> <td>1</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only contracts not linked to a third party, id=contracts not linked or linked to third party id)</td> <td>1</td> </tr> <tr> <td>int $selected Id contract preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone html</td> <td>1</td> </tr> <tr> <td>int $maxlength Maximum length of label</td> <td>1</td> </tr> <tr> <td>int $showempty Show empty line</td> <td>1</td> </tr> <tr> <td>int $showRef Show customer and supplier reference on each contract (when found)</td> <td>1</td> </tr> <tr> <td>string $srclang Language to use. If '' or 'auto', we use browser lang.</td> <td>1</td> </tr> <tr> <td>string $dir Force directory that contains /langs subdirectory (value is sometimes '..' like into install/* pages or support/* pages). Use '' by default.</td> <td>1</td> </tr> <tr> <td>Conf $conf Object with Dolibarr configuration</td> <td>1</td> </tr> <tr> <td>int $mode 0=Long language code, 1=Short language code (en, fr, es, ...)</td> <td>1</td> </tr> <tr> <td>array $domains Array of lang files to load</td> <td>1</td> </tr> <tr> <td>string $domain File name to load (.lang file). Must be "file" or "file@module" for module language files:</td> <td>1</td> </tr> <tr> <td>integer $alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US)</td> <td>1</td> </tr> <tr> <td>int $stopafterdirection Stop when the DIRECTION tag is found (optimize speed)</td> <td>1</td> </tr> <tr> <td>string $forcelangdir To force a different lang directory</td> <td>1</td> </tr> <tr> <td>int $loadfromfileonly 1=Do not load overwritten translation from file or old conf.</td> <td>1</td> </tr> <tr> <td>int $forceloadifalreadynotfound Force attempt to reload lang file if it was previously not found</td> <td>1</td> </tr> <tr> <td>array $tabtranslatedomain Store translations to be stored in cache</td> <td>1</td> </tr> <tr> <td>string $langkey To create key for cachekey in recursivity</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $domain Domain to check</td> <td>1</td> </tr> <tr> <td>string $key Key to translate</td> <td>1</td> </tr> <tr> <td>string $param1 param1 string</td> <td>1</td> </tr> <tr> <td>string $param2 param2 string</td> <td>1</td> </tr> <tr> <td>string $param3 param3 string</td> <td>1</td> </tr> <tr> <td>string $param4 param4 string</td> <td>1</td> </tr> <tr> <td>int $maxsize Max length of text. Warning: Will not work if paramX has HTML content. deprecated.</td> <td>1</td> </tr> <tr> <td>string $str String to convert</td> <td>1</td> </tr> <tr> <td>string $langdir Directory to scan</td> <td>1</td> </tr> <tr> <td>integer $maxlength Max length for each value in combo box (will be truncated)</td> <td>1</td> </tr> <tr> <td>int $usecode 1=Show code instead of country name for language variant, 2=Show only code</td> <td>1</td> </tr> <tr> <td>int $mainlangonly 1=Show only main languages ('fr_FR' no' fr_BE', 'es_ES' not 'es_MX', ...)</td> <td>1</td> </tr> <tr> <td>string $filename Language filename to search</td> <td>1</td> </tr> <tr> <td>integer $searchalt Search also alternate language file</td> <td>1</td> </tr> <tr> <td>int|string $number Number to encode in full text</td> <td>1</td> </tr> <tr> <td>string $isamount ''=it's just a number, '1'=It's an amount (default currency), 'currencycode'=It's an amount (foreign currency)</td> <td>1</td> </tr> <tr> <td>string $key Translation key to get label (key in language file)</td> <td>1</td> </tr> <tr> <td>string $tablename Table name without prefix. This value must always be a hardcoded string and not a value coming from user input.</td> <td>1</td> </tr> <tr> <td>string $fieldkey Field for key. This value must always be a hardcoded string and not a value coming from user input.</td> <td>1</td> </tr> <tr> <td>string $fieldlabel Field for label. This value must always be a hardcoded string and not a value coming from user input.</td> <td>1</td> </tr> <tr> <td>string $keyforselect Use another value than the translation key for the where into select</td> <td>1</td> </tr> <tr> <td>int $filteronentity Use a filter on entity</td> <td>1</td> </tr> <tr> <td>string $currency_code Currency Code</td> <td>1</td> </tr> <tr> <td>string $amount If not '', show currency + amount according to langs ($10, 10€).</td> <td>1</td> </tr> <tr> <td>string $currency_code Currency code</td> <td>1</td> </tr> <tr> <td>integer $forceloadall 1=Force to load all currencies into cache. We know we need to use all of them. By default read and cache only the requested currency.</td> <td>1</td> </tr> <tr> <td>string $currency_code Get only currency. Get all if ''.</td> <td>1</td> </tr> <tr> <td>string $choices Choice of purge mode ('tempfiles', 'tempfilesold' to purge temp older than $nbsecondsold seconds, 'logfiles', or mix of this). Note that 'allfiles' is also possible but very dangerous.</td> <td>1</td> </tr> <tr> <td>int $nbsecondsold Nb of seconds old to accept deletion of a directory if $choice is 'tempfilesold', or deletion of file if $choice is 'allfiles'</td> <td>1</td> </tr> <tr> <td>string $compression 'gz' or 'bz' or 'none'</td> <td>1</td> </tr> <tr> <td>string $type 'mysql', 'postgresql', ...</td> <td>1</td> </tr> <tr> <td>int $usedefault 1=Use default backup profile (Set this to 1 when used as cron)</td> <td>1</td> </tr> <tr> <td>string $file 'auto' or filename to build</td> <td>1</td> </tr> <tr> <td>int $keeplastnfiles Keep only last n files (not used yet)</td> <td>1</td> </tr> <tr> <td>int $execmethod 0=Use default method (that is 1 by default), 1=Use the PHP 'exec' - need size of dump in memory, but low memory method is used if GETPOST('lowmemorydump') is set, 2=Use the 'popen' method (low memory method)</td> <td>1</td> </tr> <tr> <td>int $lowmemorydump 1=Use the low memory method. If $lowmemorydump is set, it means we want to make the compression using an external pipe instead retrieving the content of the dump in PHP memory array $output_arr and then print it into the PHP pipe open with xopen().</td> <td>1</td> </tr> <tr> <td>string $command Command line to execute.</td> <td>1</td> </tr> <tr> <td>string $outputfile A path for an output file (used only when method is 2). For example: $conf->admin->dir_temp.'/out.tmp';</td> <td>1</td> </tr> <tr> <td>int $execmethod 0=Use default method (that is 1 by default), 1=Use the PHP 'exec', 2=Use the 'popen' method</td> <td>1</td> </tr> <tr> <td>string $redirectionfile If defined, a redirection of output to this file is added.</td> <td>1</td> </tr> <tr> <td>int $noescapecommand 1=Do not escape command. Warning: Using this parameter needs you already have sanitized the $command parameter. If not, it will lead to security vulnerability.</td> <td>1</td> </tr> <tr> <td>string $redirectionfileerr If defined, a redirection of error is added to this file instead of to channel 1.</td> <td>1</td> </tr> <tr> <td>string $module Module name</td> <td>1</td> </tr> <tr> <td>string $outputfile Output file name</td> <td>1</td> </tr> <tr> <td>string $tables Table name or '*' for all</td> <td>1</td> </tr> <tr> <td>string $sendto Recipients emails</td> <td>1</td> </tr> <tr> <td>string $from Sender email</td> <td>1</td> </tr> <tr> <td>string $message Message</td> <td>1</td> </tr> <tr> <td>string $filename List of files to attach (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>string $filter Filter file send</td> <td>1</td> </tr> <tr> <td>int $sizelimit Limit size to send file</td> <td>1</td> </tr> <tr> <td>string $selectedid The selected id</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of controm</td> <td>1</td> </tr> <tr> <td>integer $show_empty Show empty option</td> <td>1</td> </tr> <tr> <td>string $attrname code of attribute</td> <td>1</td> </tr> <tr> <td>string $type Type of attribute ('boolean', 'int', 'varchar', 'text', 'html', 'date', 'datetime', 'price', 'pricecy', 'phone', 'mail', 'password', 'url', 'select', 'checkbox', ...)</td> <td>1</td> </tr> <tr> <td>string $length Size/length of attribute ('5', '24,8', ...)</td> <td>1</td> </tr> <tr> <td>string $default_value Default value for field (in database)</td> <td>1</td> </tr> <tr> <td>array $param Params for field (ex for select list : array('options'=>array('value'=>'label of option'))</td> <td>1</td> </tr> <tr> <td>string $perms Permission</td> <td>1</td> </tr> <tr> <td>string $list Into list view by default</td> <td>1</td> </tr> <tr> <td>string $attrname code of attribute</td> <td>1</td> </tr> <tr> <td>string $label label of attribute</td> <td>1</td> </tr> <tr> <td>string $type Type of attribute ('int', 'varchar', 'text', 'html', 'date', 'datehour', 'float')</td> <td>1</td> </tr> <tr> <td>int $pos Position of attribute</td> <td>1</td> </tr> <tr> <td>string $size Size/length of attribute ('5', '24,8', ...)</td> <td>1</td> </tr> <tr> <td>string $elementtype Element type ('member', 'product', 'thirdparty', ...)</td> <td>1</td> </tr> <tr> <td>int $unique Is field unique or not</td> <td>1</td> </tr> <tr> <td>int $required Is field required or not</td> <td>1</td> </tr> <tr> <td>array|string $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) )</td> <td>1</td> </tr> <tr> <td>int $alwayseditable Is attribute always editable regardless of the document status</td> <td>1</td> </tr> <tr> <td>string $perms Permission to check</td> <td>1</td> </tr> <tr> <td>string $list Visibility</td> <td>1</td> </tr> <tr> <td>string $help Help on tooltip</td> <td>1</td> </tr> <tr> <td>string $default Default value (in database. use the default_value feature for default value on screen).</td> <td>1</td> </tr> <tr> <td>string $computed Computed value</td> <td>1</td> </tr> <tr> <td>string $entity Entity of extrafields</td> <td>1</td> </tr> <tr> <td>string $langfile Language file</td> <td>1</td> </tr> <tr> <td>string $enabled Condition to have the field enabled or not</td> <td>1</td> </tr> <tr> <td>int $totalizable Is a measure. Must show a total on lists</td> <td>1</td> </tr> <tr> <td>int $printable Is extrafield displayed on PDF</td> <td>1</td> </tr> <tr> <td>array $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...)</td> <td>1</td> </tr> <tr> <td>string $attrname Code of attribute to delete</td> <td>1</td> </tr> <tr> <td>string $elementtype Element type ('member', 'product', 'thirdparty', 'contact', ...)</td> <td>1</td> </tr> <tr> <td>string $attrname Code of attribute to delete</td> <td>1</td> </tr> <tr> <td>string $elementtype Element type ('member', 'product', 'thirdparty', ...)</td> <td>1</td> </tr> <tr> <td>string $type Type of attribute ('boolean', 'int', 'varchar', 'text', 'html', 'date', 'datetime','price','phone','mail','password','url','select','checkbox', ...)</td> <td>1</td> </tr> <tr> <td>int $length Length of attribute</td> <td>1</td> </tr> <tr> <td>array $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) )</td> <td>1</td> </tr> <tr> <td>string $entity Entity of extrafields</td> <td>1</td> </tr> <tr> <td>string $type Type of attribute</td> <td>1</td> </tr> <tr> <td>int $size Length of attribute</td> <td>1</td> </tr> <tr> <td>string $elementtype Element type ('member', 'product', 'thirdparty', ...)</td> <td>1</td> </tr> <tr> <td>array $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) )</td> <td>1</td> </tr> <tr> <td>string $help Help on tooltip.</td> <td>1</td> </tr> <tr> <td>string $entity Entity of extrafields</td> <td>1</td> </tr> <tr> <td>string $elementtype Type of element ('all' = all or $object->table_element like 'adherent', 'commande', 'thirdparty', 'facture', 'propal', 'product', ...).</td> <td>1</td> </tr> <tr> <td>string $attrname The name of the attribute.</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string|array $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value); for dates in filter mode, a range array('start'=><timestamp>, 'end'=><timestamp>) should be provided</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add after name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add before name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $morecss More css (to defined size of field. Old behaviour: may also be a numeric)</td> <td>1</td> </tr> <tr> <td>int $objectid Current object id</td> <td>1</td> </tr> <tr> <td>string $extrafieldsobjectkey The key to use to store retrieved data (commonly $object->table_element)</td> <td>1</td> </tr> <tr> <td>int $mode 1=Used for search filters</td> <td>1</td> </tr> <tr> <td>string $extrafieldsobjectkey Required (for example $object->table_element).</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>string $extrafieldsobjectkey If defined, use the new method to get extrafields data</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>object $object Object</td> <td>1</td> </tr> <tr> <td>int $colspan Value of colspan to use (it must includes the first column with title)</td> <td>1</td> </tr> <tr> <td>string $display_type "card" for form display, "line" for document line display (extrafields on propal line, order line, etc...)</td> <td>1</td> </tr> <tr> <td>string $mode Show output ('view') or input ('create' or 'edit') for extrafield</td> <td>1</td> </tr> <tr> <td>array|null $extralabels Deprecated (old $array of extrafields, now set this to null)</td> <td>1</td> </tr> <tr> <td>object $object Object</td> <td>1</td> </tr> <tr> <td>string $onlykey Only some keys are filled:</td> <td>1</td> </tr> <tr> <td>int $todefaultifmissing 1=Set value to the default value in database if value is mandatory and missing</td> <td>1</td> </tr> <tr> <td>array|string $extrafieldsobjectkey array of extrafields (old usage) or value of object->table_element (new usage)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keysuffix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>mixed $v Value to test</td> <td>1</td> </tr> <tr> <td>string $type Type of extrafield 'sellist', 'link', 'select', ...</td> <td>1</td> </tr> <tr> <td>array $arrayofrecords Array of record information (array('textleft'=>,'textheader'=>, ..., 'id'=>,'photo'=>)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang object for output language</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output langs</td> <td>1</td> </tr> <tr> <td>array $param Associative array containing label content and optional parameters</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>int $pt point</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>int $x1 X1</td> <td>1</td> </tr> <tr> <td>int $y1 Y1</td> <td>1</td> </tr> <tr> <td>int $x2 X2</td> <td>1</td> </tr> <tr> <td>int $y2 Y2</td> <td>1</td> </tr> <tr> <td>int $epaisseur Epaisseur</td> <td>1</td> </tr> <tr> <td>int $nbPointilles Nb pointilles</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>int $x1 X1</td> <td>1</td> </tr> <tr> <td>int $y1 Y1</td> <td>1</td> </tr> <tr> <td>int $x2 X2</td> <td>1</td> </tr> <tr> <td>int $y2 Y2</td> <td>1</td> </tr> <tr> <td>int $epaisseur Epaisseur</td> <td>1</td> </tr> <tr> <td>int $taille Size</td> <td>1</td> </tr> <tr> <td>int $value value</td> <td>1</td> </tr> <tr> <td>string $src from ('in' or 'mm')</td> <td>1</td> </tr> <tr> <td>string $dest to ('in' or 'mm')</td> <td>1</td> </tr> <tr> <td>int $pt Point</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>array{metric:string,name:string,code:string,marginLeft:float,marginTip:float,SpaceX:float,SpaceY:float,NX:int,NY:int,width:float,height:float,font-size:float} $format Format</td> <td>1</td> </tr> <tr> <td>string $elementtype Type of element ('' = all, 'adherent', 'commande', 'thirdparty', 'facture', 'propal', 'product', ...).</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)</td> <td>1</td> </tr> <tr> <td>string $extrafieldsobjectkey If defined (for example $object->table_element), use the new method to get extrafields data</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add after name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add before name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $morecss More css (to defined size of field. Old behaviour: may also be a numeric)</td> <td>1</td> </tr> <tr> <td>int $objectid Current object id</td> <td>1</td> </tr> <tr> <td>int $mode 1=Used for search filters</td> <td>1</td> </tr> <tr> <td>string $extrafieldsobjectkey If defined (for example $object->table_element), function uses the new method to get extrafields data</td> <td>1</td> </tr> <tr> <td>string $htmlname Html control name</td> <td>1</td> </tr> <tr> <td>integer $selected selected value</td> <td>1</td> </tr> <tr> <td>integer $readonly Select is read only or not</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $actiontype Action type ('create', 'view', 'edit', 'list')</td> <td>1</td> </tr> <tr> <td>string $action Action type ('create', 'view', 'edit', 'list', 'add', 'update')</td> <td>1</td> </tr> <tr> <td>string $module Name of target module (thirdparty, contact, ...)</td> <td>1</td> </tr> <tr> <td>string $card Tab name of card (ex: 'card', 'info', 'contactcard', ...) or '' for a list page</td> <td>1</td> </tr> <tr> <td>string $canvas Name of canvas (ex: mycanvas, default, or mycanvas@myexternalmodule)</td> <td>1</td> </tr> <tr> <td>int $id Object id (if ref not provided)</td> <td>1</td> </tr> <tr> <td>string $ref Object ref (if id not provided)</td> <td>1</td> </tr> <tr> <td>int $id Object id</td> <td>1</td> </tr> <tr> <td>array $options Options array</td> <td>1</td> </tr> <tr> <td>int $fk_element ID of element</td> <td>1</td> </tr> <tr> <td>string $element Code of element</td> <td>1</td> </tr> <tr> <td>object $file Filename</td> <td>1</td> </tr> <tr> <td>string $file_name Filename</td> <td>1</td> </tr> <tr> <td>string $file_name Filename</td> <td>1</td> </tr> <tr> <td>string $options is array('max_width', 'max_height')</td> <td>1</td> </tr> <tr> <td>string $uploaded_file Upload file</td> <td>1</td> </tr> <tr> <td>object $file File</td> <td>1</td> </tr> <tr> <td>string $error Error</td> <td>1</td> </tr> <tr> <td>string $index Index</td> <td>1</td> </tr> <tr> <td>int $matches ???</td> <td>1</td> </tr> <tr> <td>string $name ???</td> <td>1</td> </tr> <tr> <td>string $name Filename</td> <td>1</td> </tr> <tr> <td>string $type ???</td> <td>1</td> </tr> <tr> <td>string $index ???</td> <td>1</td> </tr> <tr> <td>string $uploaded_file Upload file</td> <td>1</td> </tr> <tr> <td>string $name Name</td> <td>1</td> </tr> <tr> <td>int $size Size</td> <td>1</td> </tr> <tr> <td>string $type Type</td> <td>1</td> </tr> <tr> <td>string $error Error</td> <td>1</td> </tr> <tr> <td>string $index Index</td> <td>1</td> </tr> <tr> <td>string $file File</td> <td>1</td> </tr> <tr> <td>string $element String of element ('product', 'facture', ...)</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>string $ref Ref of object to check</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of object to check</td> <td>1</td> </tr> <tr> <td>CommonObject $object commonobject</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params params</td> <td>1</td> </tr> <tr> <td>string $objref Customer ref</td> <td>1</td> </tr> <tr> <td>string $objref Supplier ref</td> <td>1</td> </tr> <tr> <td>int<0,1> $withcountry 1=Add country into address string</td> <td>1</td> </tr> <tr> <td>string $sep Separator to use to build string</td> <td>1</td> </tr> <tr> <td>int<0,1> $withregion 1=Add region into address string</td> <td>1</td> </tr> <tr> <td>string $extralangcode User extralanguages as value</td> <td>1</td> </tr> <tr> <td>string $modulepart Module related to document</td> <td>1</td> </tr> <tr> <td>int $initsharekey Init the share key if it was not yet defined</td> <td>1</td> </tr> <tr> <td>int $relativelink 0=Return full external link, 1=Return link relative to root of file</td> <td>1</td> </tr> <tr> <td>int $fk_socpeople Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link</td> <td>1</td> </tr> <tr> <td>int|string $type_contact Type of contact (code or id). Must be id or code found into table llx_c_type_contact. For example: SALESREPFOLL</td> <td>1</td> </tr> <tr> <td>string $source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>1</td> </tr> <tr> <td>CommonObject $objFrom Source element</td> <td>1</td> </tr> <tr> <td>'internal'|'external' $source Nature of contact ('internal' or 'external')</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line contact-element</td> <td>1</td> </tr> <tr> <td>int $statut New status of link</td> <td>1</td> </tr> <tr> <td>int $type_contact_id Id of contact type (not modified if 0)</td> <td>1</td> </tr> <tr> <td>int $fk_socpeople Id of soc_people to update (not modified if 0)</td> <td>1</td> </tr> <tr> <td>int $rowid Id of contact link line to delete</td> <td>1</td> </tr> <tr> <td>string $source '' or 'internal' or 'external'</td> <td>1</td> </tr> <tr> <td>string $code Type of contact (code or id)</td> <td>1</td> </tr> <tr> <td>int $statusoflink Status of links to get (-1=all). Not used.</td> <td>1</td> </tr> <tr> <td>'external'|'thirdparty'|'internal' $source Source of contact: 'external' or 'thirdparty' (llx_socpeople) or 'internal' (llx_user)</td> <td>1</td> </tr> <tr> <td>int<0,1> $list 0:Returned array contains all properties, 1:Return array contains just id</td> <td>1</td> </tr> <tr> <td>string $code Filter on this code of contact type ('SHIPPING', 'BILLING', ...)</td> <td>1</td> </tr> <tr> <td>int $status Status of user or company</td> <td>1</td> </tr> <tr> <td>int[] $arrayoftcids Array with ID of type of contacts. If we provide this, we can make a ec.fk_c_type_contact in ($arrayoftcids) to avoid link on tc table. TODO Not implemented.</td> <td>1</td> </tr> <tr> <td>int $rowid Id of link between object and contact</td> <td>1</td> </tr> <tr> <td>'internal'|'external'|'all' $source 'internal', 'external' or 'all'</td> <td>1</td> </tr> <tr> <td>string $order Sort order by : 'position', 'code', 'rowid'...</td> <td>1</td> </tr> <tr> <td>int<0,1> $option 0=Return array id->label, 1=Return array code->label</td> <td>1</td> </tr> <tr> <td>int<0,1> $activeonly 0=all status of contact, 1=only the active</td> <td>1</td> </tr> <tr> <td>string $code Type of contact (Example: 'CUSTOMER', 'SERVICE')</td> <td>1</td> </tr> <tr> <td>string $source 'internal', 'external' or 'all'</td> <td>1</td> </tr> <tr> <td>int<0,1> $option 0=Return array id->label, 1=Return array code->label</td> <td>1</td> </tr> <tr> <td>int<0,1> $activeonly 0=all status of contact, 1=only the active</td> <td>1</td> </tr> <tr> <td>string $code Type of contact (Example: 'CUSTOMER', 'SERVICE')</td> <td>1</td> </tr> <tr> <td>string $element Filter on 1 element type</td> <td>1</td> </tr> <tr> <td>string $excludeelement Exclude 1 element type. Example: 'agenda'</td> <td>1</td> </tr> <tr> <td>string $source 'external' or 'internal'</td> <td>1</td> </tr> <tr> <td>string $code 'BILLING', 'SHIPPING', 'SALESREPFOLL', ...</td> <td>1</td> </tr> <tr> <td>int $status limited to a certain status</td> <td>1</td> </tr> <tr> <td>?int $contactid Id du contact. Use this->contact_id if empty.</td> <td>1</td> </tr> <tr> <td>int<0,1> $force_thirdparty_id Force thirdparty id</td> <td>1</td> </tr> <tr> <td>string $ref Wildcard</td> <td>1</td> </tr> <tr> <td>int $userid Id du contact</td> <td>1</td> </tr> <tr> <td>string $table Table element or element line</td> <td>1</td> </tr> <tr> <td>string $key Import key</td> <td>1</td> </tr> <tr> <td>string $element Element name</td> <td>1</td> </tr> <tr> <td>string $table Table of element or element line</td> <td>1</td> </tr> <tr> <td>string $field Field to update</td> <td>1</td> </tr> <tr> <td>mixed $value New value</td> <td>1</td> </tr> <tr> <td>string $table To force other table element or element line (should not be used)</td> <td>1</td> </tr> <tr> <td>int $id To force other object id (should not be used)</td> <td>1</td> </tr> <tr> <td>string $format Data format ('text', 'int', 'date'). 'text' is used if not defined</td> <td>1</td> </tr> <tr> <td>string $id_field To force rowid field name. 'rowid' is used if not defined</td> <td>1</td> </tr> <tr> <td>User|string $fuser Update the user of last update field with this user. If not provided, current user is used except if value is 'none'</td> <td>1</td> </tr> <tr> <td>string $trigkey Trigger key to run (in most cases something like 'XXX_MODIFY')</td> <td>1</td> </tr> <tr> <td>string $fk_user_field Name of field to save user id making change</td> <td>1</td> </tr> <tr> <td>string $filter Optional SQL filter. Use SQL or Universal Search Filter.</td> <td>1</td> </tr> <tr> <td>string $fieldid Name of field to use for the select MAX and MIN</td> <td>1</td> </tr> <tr> <td>int<0,1> $nodbprefix Do not include DB prefix to forge table name</td> <td>1</td> </tr> <tr> <td>string $source Source of contact: external (llx_socpeople) or internal (llx_user) or thirdparty (llx_societe)</td> <td>1</td> </tr> <tr> <td>int $projectid Project id to link element to</td> <td>1</td> </tr> <tr> <td>int<0,1> $notrigger Disable the trigger</td> <td>1</td> </tr> <tr> <td>int $id Id of new payment method</td> <td>1</td> </tr> <tr> <td>string $code multicurrency code</td> <td>1</td> </tr> <tr> <td>double $rate multicurrency rate</td> <td>1</td> </tr> <tr> <td>int $mode mode 1 : amounts in company currency will be recalculated, mode 2 : amounts in foreign currency will be recalculated</td> <td>1</td> </tr> <tr> <td>int $id Id of new payment terms</td> <td>1</td> </tr> <tr> <td>float $deposit_percent % of deposit if needed by payment terms</td> <td>1</td> </tr> <tr> <td>int $id Id of transport mode</td> <td>1</td> </tr> <tr> <td>int $id Id of new payment terms</td> <td>1</td> </tr> <tr> <td>int $id Address id</td> <td>1</td> </tr> <tr> <td>int $shipping_method_id Id of shipping method</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $userused Object user</td> <td>1</td> </tr> <tr> <td>int $warehouse_id Id of warehouse</td> <td>1</td> </tr> <tr> <td>User $user User object that make change</td> <td>1</td> </tr> <tr> <td>string $modelpdf Modele name</td> <td>1</td> </tr> <tr> <td>int $fk_account Id of bank account</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $userused Object user</td> <td>1</td> </tr> <tr> <td>boolean $fk_parent_line Table with fk_parent_line field or not</td> <td>1</td> </tr> <tr> <td>int $id Id of parent line</td> <td>1</td> </tr> <tr> <td>int<0,1> $includealltree 0 = 1st level child, 1 = All level child</td> <td>1</td> </tr> <tr> <td>int[] $rows Array of rows</td> <td>1</td> </tr> <tr> <td>int $rang Rang value</td> <td>1</td> </tr> <tr> <td>int $fk_parent_line Parent line id</td> <td>1</td> </tr> <tr> <td>string $ref_ext Update field ref_ext</td> <td>1</td> </tr> <tr> <td>string $suffix '', '_public' or '_private'</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=execute triggers</td> <td>1</td> </tr> <tr> <td>int $exclspec >0 = Exclude special product (product_type=9)</td> <td>1</td> </tr> <tr> <td>'none'|'auto'|'0'|'1' $roundingadjust 'none'=Do nothing, 'auto'=Use default method (MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND if defined, or '0'), '0'=Force mode Total of rounding, '1'=Force mode Rounding of total</td> <td>1</td> </tr> <tr> <td>int<0,1> $nodatabaseupdate 1=Do not update database total fields of the main object. Update only properties in memory. Can be used to save SQL when this method is called several times, so we can do it only once at end.</td> <td>1</td> </tr> <tr> <td>?Societe $seller If roundingadjust is '0' or '1' or maybe 'auto', it means we recalculate total for lines before calculating total for object and for this, we need seller object (used to analyze lines to check corrupted data).</td> <td>1</td> </tr> <tr> <td>string $origin Linked element type</td> <td>1</td> </tr> <tr> <td>int $origin_id Linked element id</td> <td>1</td> </tr> <tr> <td>User $f_user User that create</td> <td>1</td> </tr> <tr> <td>?int $sourceid Object source id (if not defined, $this->id)</td> <td>1</td> </tr> <tr> <td>string $sourcetype Object source type (if not defined, $this->element)</td> <td>1</td> </tr> <tr> <td>?int $targetid Object target id (if not defined, $this->id)</td> <td>1</td> </tr> <tr> <td>string $targettype Object target type (if not defined, $this->element)</td> <td>1</td> </tr> <tr> <td>string $clause 'OR' or 'AND' clause used when both source id and target id are provided</td> <td>1</td> </tr> <tr> <td>int<0,1> $alsosametype 0=Return only links to object that differs from source type. 1=Include also link to objects of same type.</td> <td>1</td> </tr> <tr> <td>string $orderby SQL 'ORDER BY' clause</td> <td>1</td> </tr> <tr> <td>int<0,1>|string $loadalsoobjects Load also the array $this->linkedObjects. Use 0 to not load (increase performances), Use 1 to load all, Use value of type ('facture', 'facturerec', ...) to load only a type of object.</td> <td>1</td> </tr> <tr> <td>int $rowid Row id of line to delete. If defined, other parameters are not used.</td> <td>1</td> </tr> <tr> <td>string $field_select name of field we need to get a list</td> <td>1</td> </tr> <tr> <td>int $fk_object_where id of object we need to remove linked items</td> <td>1</td> </tr> <tr> <td>string $field_where name of field of object we need to delete linked items</td> <td>1</td> </tr> <tr> <td>int $status Status to set</td> <td>1</td> </tr> <tr> <td>int $elementId Id of element to force (use this->id by default if null)</td> <td>1</td> </tr> <tr> <td>string $elementType Type of element to force (use this->table_element by default)</td> <td>1</td> </tr> <tr> <td>string $trigkey Trigger key to use for trigger. Use '' means automatic but it is not recommended and is deprecated.</td> <td>1</td> </tr> <tr> <td>string $fieldstatus Name of status field in this->table_element</td> <td>1</td> </tr> <tr> <td>int $id Record id</td> <td>1</td> </tr> <tr> <td>string $ref Record ref</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line</td> <td>1</td> </tr> <tr> <td>int $id Force id of object</td> <td>1</td> </tr> <tr> <td>int $entity Force entity to check</td> <td>1</td> </tr> <tr> <td>int $predefined -1=All, 0=Count free product/service only, 1=Count predefined product/service only, 2=Count predefined product, 3=Count predefined service</td> <td>1</td> </tr> <tr> <td>int $selected ID line selected</td> <td>1</td> </tr> <tr> <td>string $var Not used</td> <td>1</td> </tr> <tr> <td>int $selected ID line selected</td> <td>1</td> </tr> <tr> <td>''|'services' $restrictlist ''=All lines, 'services'=Restrict to services only</td> <td>1</td> </tr> <tr> <td>int[] $selectedLines Array of lines id for selected lines</td> <td>1</td> </tr> <tr> <td>CommonObjectLine $line Line</td> <td>1</td> </tr> <tr> <td>string $var Not used</td> <td>1</td> </tr> <tr> <td>int[] $selectedLines Array of lines id for selected lines</td> <td>1</td> </tr> <tr> <td>int $resource_id Resource id</td> <td>1</td> </tr> <tr> <td>string $resource_type 'resource'</td> <td>1</td> </tr> <tr> <td>int $busy Busy or not</td> <td>1</td> </tr> <tr> <td>int $mandatory Mandatory or not</td> <td>1</td> </tr> <tr> <td>int $rowid Id of resource line to delete</td> <td>1</td> </tr> <tr> <td>string $element element name (for trigger) TODO: use $this->element into commonobject class</td> <td>1</td> </tr> <tr> <td>string $modelspath Relative folder where generators are placed</td> <td>1</td> </tr> <tr> <td>string $modele Generator to use. Caller must set it to from obj->model_pdf or from GETPOST for example.</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language to use</td> <td>1</td> </tr> <tr> <td>int<0,1> $hidedetails 1 to hide details. 0 by default</td> <td>1</td> </tr> <tr> <td>int<0,1> $hidedesc 1 to hide product description. 0 by default</td> <td>1</td> </tr> <tr> <td>int<0,1> $hideref 1 to hide product reference. 0 by default</td> <td>1</td> </tr> <tr> <td>?array<string,mixed> $moreparams Array to provide more information</td> <td>1</td> </tr> <tr> <td>string $destfull Full path of file to index</td> <td>1</td> </tr> <tr> <td>int $update_main_doc_field Update field main_doc field into the table of the object.</td> <td>1</td> </tr> <tr> <td>string $file Path file in UTF8 to original file to create thumbs from.</td> <td>1</td> </tr> <tr> <td>string $file Path file in UTF8 to original file to delete thumbs.</td> <td>1</td> </tr> <tr> <td>string $fieldname Name of field</td> <td>1</td> </tr> <tr> <td>string $alternatevalue Alternate value to use</td> <td>1</td> </tr> <tr> <td>string $type Type of data</td> <td>1</td> </tr> <tr> <td>string $onlykey Only the following key is filled. When we make update of only one language field ($action = 'update_languages'), calling page must set this to avoid to have other languages being reset.</td> <td>1</td> </tr> <tr> <td>int $id ID of object</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line. Use the id of object if not defined. Deprecated. Function must be called without parameters.</td> <td>1</td> </tr> <tr> <td>array{}|array{label:array<string,string>,type:array<string,string>,size:array<string,string>,default:array<string,string>,computed:array<string,string>,unique:array<string,int>,required:array<string,int>,param:array<string,mixed>,perms:array<string,mixed[]>,list:array<string,int>|array<string,string>,pos:array<string,int>,totalizable:array<string,int>,help:array<string,string>,printable:array<string,int>,enabled:array<string,int>,langfile:array<string,string>,css:array<string,string>,csslist:array<string,string>,hidden:array<string,int>,mandatoryfieldsofotherentities?:array<string,string>,loaded?:int,count:int} $optionsArray Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters.</td> <td>1</td> </tr> <tr> <td>string $key Key of the extrafield to update (without starting 'options_')</td> <td>1</td> </tr> <tr> <td>string $key Key of the extrafield (without starting 'options_')</td> <td>1</td> </tr> <tr> <td>?array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $val Array of properties for field to show (used only if ->fields not defined)</td> <td>1</td> </tr> <tr> <td>string|string[] $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)</td> <td>1</td> </tr> <tr> <td>int<0,1> $nonewbutton Force to not show the new button on field that are links to object</td> <td>1</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $val Array of properties of field to show</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>mixed $morecss Value for CSS to use (Old usage: May also be a numeric to define a size).</td> <td>1</td> </tr> <tr> <td>string $fieldKey Key of attribute to clear</td> <td>1</td> </tr> <tr> <td>string $fieldKey Key of attribute</td> <td>1</td> </tr> <tr> <td>string $msg the field error message</td> <td>1</td> </tr> <tr> <td>array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> $fields Array of properties of field to show</td> <td>1</td> </tr> <tr> <td>Extrafields $extrafields Extrafield Object</td> <td>1</td> </tr> <tr> <td>string $mode Show output ('view') or input ('create' or 'edit') for extrafield</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $params Optional parameters. Example: array('style'=>'class="oddeven"', 'colspan'=>$colspan)</td> <td>1</td> </tr> <tr> <td>string $keysuffix Suffix string to add after name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Prefix string to add before name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $onetrtd All fields in same tr td. Used by objectline_create.tpl.php for example.</td> <td>1</td> </tr> <tr> <td>string $display_type "card" for form display, "line" for document line display (extrafields on propal line, order line, etc...)</td> <td>1</td> </tr> <tr> <td>string $type Type for prefix</td> <td>1</td> </tr> <tr> <td>int $origin_id Old thirdparty id (the thirdparty to delete)</td> <td>1</td> </tr> <tr> <td>int $dest_id New thirdparty id (the thirdparty that will received element of the other)</td> <td>1</td> </tr> <tr> <td>string[] $tables Tables that need to be changed</td> <td>1</td> </tr> <tr> <td>int<0,1> $ignoreerrors Ignore errors. Return true even if errors. We need this when replacement can fails like for categories (categorie of old thirdparty may already exists on new one)</td> <td>1</td> </tr> <tr> <td>int $origin_id Old product id (the product to delete)</td> <td>1</td> </tr> <tr> <td>int $dest_id New product id (the product that will received element of the other)</td> <td>1</td> </tr> <tr> <td>string[] $tables Tables that need to be changed</td> <td>1</td> </tr> <tr> <td>int<0,1> $ignoreerrors Ignore errors. Return true even if errors. We need this when replacement can fails like for categories (categorie of old product may already exists on new one)</td> <td>1</td> </tr> <tr> <td>float $unitPrice Product unit price</td> <td>1</td> </tr> <tr> <td>float $discountPercent Line discount percent</td> <td>1</td> </tr> <tr> <td>int $fk_product Product id</td> <td>1</td> </tr> <tr> <td>string $modulepart Module part</td> <td>1</td> </tr> <tr> <td>string $imagesize Image size</td> <td>1</td> </tr> <tr> <td>string $modulepart 'product', 'ticket', ...</td> <td>1</td> </tr> <tr> <td>string $sdir Directory to scan (full absolute path)</td> <td>1</td> </tr> <tr> <td>int<0,1>|''|'small' $size 0 or ''=original size, 1 or 'small'=use thumbnail if possible</td> <td>1</td> </tr> <tr> <td>int $nbmax Nombre maximum de photos (0=pas de max)</td> <td>1</td> </tr> <tr> <td>int $nbbyrow Number of image per line or -1 to use div separator or 0 to use no separator. Used only if size=1 or 'small'.</td> <td>1</td> </tr> <tr> <td>int $showfilename 1=Show filename</td> <td>1</td> </tr> <tr> <td>int $showaction 1=Show icon with action links (resize, delete)</td> <td>1</td> </tr> <tr> <td>int $maxHeight Max height of original image when size='small' (so we can use original even if small requested). If 0, always use 'small' thumb image.</td> <td>1</td> </tr> <tr> <td>int $maxWidth Max width of original image when size='small'</td> <td>1</td> </tr> <tr> <td>int $nolink Do not add a href link to view enlarged imaged into a new tab</td> <td>1</td> </tr> <tr> <td>int|string $overwritetitle Do not add title tag on image</td> <td>1</td> </tr> <tr> <td>int $usesharelink Use the public shared link of image (if not available, the 'nophoto' image will be shown instead)</td> <td>1</td> </tr> <tr> <td>string $cache A string if we want to use a cached version of image</td> <td>1</td> </tr> <tr> <td>string $addphotorefcss Add CSS to img of photos</td> <td>1</td> </tr> <tr> <td>stdClass $obj Contain data of object from database</td> <td>1</td> </tr> <tr> <td>string $alias String of alias of table for fields. For example 't'. It is recommended to use '' and set alias into fields definition.</td> <td>1</td> </tr> <tr> <td>string[] $excludefields Array of fields to exclude</td> <td>1</td> </tr> <tr> <td>string|int $value Value to protect</td> <td>1</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $fieldsentry Properties of field</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>User $user User that modifies</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int<0,1> $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int<0,1> $forcechilddeletion 0=no, 1=Force deletion of children</td> <td>1</td> </tr> <tr> <td>int $parentId Parent Id</td> <td>1</td> </tr> <tr> <td>string $parentField Name of Foreign key parent column</td> <td>1</td> </tr> <tr> <td>string $type_categ Category type ('customer', 'supplier', 'website_page', ...)</td> <td>1</td> </tr> <tr> <td>int[]|int $categories Category ID or array of Categories IDs</td> <td>1</td> </tr> <tr> <td>string $type_categ Category type ('customer', 'supplier', 'website_page', ...) defined into const class Categorie type</td> <td>1</td> </tr> <tr> <td>boolean $remove_existing True: Remove existings categories from Object if not supplies by $categories, False: let them</td> <td>1</td> </tr> <tr> <td>int $fromId Id object source</td> <td>1</td> </tr> <tr> <td>int $toId Id object cible</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('product', ...)</td> <td>1</td> </tr> <tr> <td>integer $mode 0=Use path to find record, 1=Use src_object_xxx fields (Mode 1 is recommended for new objects)</td> <td>1</td> </tr> <tr> <td>string $action Trigger event code</td> <td>1</td> </tr> <tr> <td>object $object Object concerned. Some context information may also be provided into array property object->context.</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Translate $langs Object lang</td> <td>1</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>1</td> </tr> <tr> <td>array $forcedirtriggers null=All default directories. This parameter is used by modulebuilder module only.</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $code Code</td> <td>1</td> </tr> <tr> <td>string $code_iso Code ISO</td> <td>1</td> </tr> <tr> <td>array<string, array<string, string>> $fields Array of fields to check</td> <td>1</td> </tr> <tr> <td>int $errors Reference of errors variable</td> <td>1</td> </tr> <tr> <td>int $withdolfichehead With dol_get_fiche_head() and dol_get_fiche_end()</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('create' or 'edit')</td> <td>1</td> </tr> <tr> <td>int $public 1=If we show the form for the public interface</td> <td>1</td> </tr> <tr> <td>Contact|null $with_contact [=NULL] Contact to link to this ticket if it exists</td> <td>1</td> </tr> <tr> <td>string $action [=''] Action in card</td> <td>1</td> </tr> <tr> <td>?Ticket $object [=NULL] Ticket object</td> <td>1</td> </tr> <tr> <td>string|array $selected Id of preselected field or array of Ids</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on field type in llx_c_ticket_type (array('code'=>xx,'label'=>zz))</td> <td>1</td> </tr> <tr> <td>int $format 0=id+libelle, 1=code+code, 2=code+libelle, 3=id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1=peut etre vide, 0 sinon</td> <td>1</td> </tr> <tr> <td>int $noadmininfo 0=Add admin info, 1=Disable admin info</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $multiselect Is multiselect ?</td> <td>1</td> </tr> <tr> <td>string $selected Id pre-selected category</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select component</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on some properties in llx_c_ticket_category ('public = 1'). This parameter must not come from input of users.</td> <td>1</td> </tr> <tr> <td>int $format 0 = id+label, 1 = code+code, 2 = code+label, 3 = id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1 = can be empty, 0 = or not</td> <td>1</td> </tr> <tr> <td>int $noadmininfo 0 = ddd admin info, 1 = disable admin info</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>int $use_multilevel If > 0 create a multilevel select which use $htmlname example: $use_multilevel = 1 permit to have 2 select boxes.</td> <td>1</td> </tr> <tr> <td>string $selected Id severity pre-selected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of the select area</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on field type in llx_c_ticket_severity (array('code'=>xx,'label'=>zz))</td> <td>1</td> </tr> <tr> <td>int $format 0 = id+label, 1 = code+code, 2 = code+label, 3 = id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1 = can be empty, 0 = or not</td> <td>1</td> </tr> <tr> <td>int $noadmininfo 0 = add admin info, 1 = disable admin info</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $width Width of form</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>int $code_region Code</td> <td>1</td> </tr> <tr> <td>int $fk_pays Country Id</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $ref ref object</td> <td>1</td> </tr> <tr> <td>string $element_type Element type</td> <td>1</td> </tr> <tr> <td>int $fk_element Id of element</td> <td>1</td> </tr> <tr> <td>int $id Id of order</td> <td>1</td> </tr> <tr> <td>string $url Url to follow on click (does not include DOL_URL_ROOT)</td> <td>1</td> </tr> <tr> <td>int $enabled Menu active or not (0=Not active, 1=Active, 2=Active but grey)</td> <td>1</td> </tr> <tr> <td>int $idafter Array key after which inserting new entry</td> <td>1</td> </tr> <tr> <td>string $url Url to follow on click</td> <td>1</td> </tr> <tr> <td>int $enabled Menu active or not</td> <td>1</td> </tr> <tr> <td>string $type Label type ('long', 'short' or 'code'). This can be a translation key.</td> <td>1</td> </tr> <tr> <td>int $limit Limit the number of lines returned</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter as an Universal Search string.</td> <td>1</td> </tr> <tr> <td>string $filtermode No more used</td> <td>1</td> </tr> <tr> <td>string $action Id of action in llx_c_action_trigger</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party</td> <td>1</td> </tr> <tr> <td>Object $object Object the notification is about</td> <td>1</td> </tr> <tr> <td>int $socid Id of company. If this is filled, function will return only records belonging to this thirdparty</td> <td>1</td> </tr> <tr> <td>string $notifcode Code of action in llx_c_action_trigger (new usage) or Id of action in llx_c_action_trigger (old usage)</td> <td>1</td> </tr> <tr> <td>int $socid Id of third party or 0 for all thirdparties or -1 for no thirdparties</td> <td>1</td> </tr> <tr> <td>Object $object Object the notification is about (need it to check threshold value of some notifications)</td> <td>1</td> </tr> <tr> <td>int $userid Id of user or 0 for all users or -1 for no users</td> <td>1</td> </tr> <tr> <td>array $scope Scope where to search</td> <td>1</td> </tr> <tr> <td>string $notifcode Code of action in llx_c_action_trigger (new usage) or Id of action in llx_c_action_trigger (old usage)</td> <td>1</td> </tr> <tr> <td>Object $object Object the notification deals on</td> <td>1</td> </tr> <tr> <td>array $filename_list List of files to attach (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>array $mimetype_list List of MIME type of attached files</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list List of attached file name in message</td> <td>1</td> </tr> <tr> <td>int $rowid id discount to load</td> <td>1</td> </tr> <tr> <td>int $fk_facture_source fk_facture_source</td> <td>1</td> </tr> <tr> <td>int $fk_invoice_supplier_source fk_invoice_supplier_source</td> <td>1</td> </tr> <tr> <td>User $user Object of user asking to delete</td> <td>1</td> </tr> <tr> <td>int $rowidline Invoice line id (To use discount into invoice lines)</td> <td>1</td> </tr> <tr> <td>int $rowidinvoice Invoice id (To use discount as a credit note to reduce payment of invoice)</td> <td>1</td> </tr> <tr> <td>?Societe $company Object third party for filter</td> <td>1</td> </tr> <tr> <td>?User $user Filtre sur un user auteur des remises</td> <td>1</td> </tr> <tr> <td>string $filter Filter other. Warning: Do not use a user input value here.</td> <td>1</td> </tr> <tr> <td>int|float $maxvalue Filter on max value for discount</td> <td>1</td> </tr> <tr> <td>int<0,1> $discount_type 0 => customer discount, 1 => supplier discount</td> <td>1</td> </tr> <tr> <td>int<0,1> $multicurrency Return multicurrency_amount instead of amount</td> <td>1</td> </tr> <tr> <td>CommonInvoice $invoice Object invoice (customer of supplier)</td> <td>1</td> </tr> <tr> <td>int<-1,1> $multicurrency 1=Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount</td> <td>1</td> </tr> <tr> <td>int<-1,1> $multicurrency 1=Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount</td> <td>1</td> </tr> <tr> <td>int<-1,1> $multicurrency Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount</td> <td>1</td> </tr> <tr> <td>int<0,1> $withpicto 0=No picto, 1=Include picto into link, 2=Picto only</td> <td>1</td> </tr> <tr> <td>string $option Where to link to ('invoice' or 'discount')</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $menu_handler Menu handler</td> <td>1</td> </tr> <tr> <td>User $user User that load</td> <td>1</td> </tr> <tr> <td>string $mymainmenu Value for mainmenu to filter menu to load (always '')</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)</td> <td>1</td> </tr> <tr> <td>Menu $newmenu Menu array to complete (in most cases, it's empty, may be already initialized with some menu manager like eldy)</td> <td>1</td> </tr> <tr> <td>string $mymainmenu Value for mainmenu to filter menu to load (often $_SESSION["mainmenu"])</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,module:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tabMenu Array with menu entries already loaded</td> <td>1</td> </tr> <tr> <td>string $mymainmenu Value for mainmenu that defined mainmenu</td> <td>1</td> </tr> <tr> <td>string $myleftmenu Value for left that defined leftmenu</td> <td>1</td> </tr> <tr> <td>int $type_user Looks for menu entry for 0=Internal users, 1=External users</td> <td>1</td> </tr> <tr> <td>string $menu_handler Name of menu_handler used ('auguria', 'eldy'...)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tabMenu Array to store new entries found (in most cases, it's empty, but may be already filled)</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> $tab Tab array with all menu entries</td> <td>1</td> </tr> <tr> <td>int $pere Id of parent</td> <td>1</td> </tr> <tr> <td>int $level Level</td> <td>1</td> </tr> <tr> <td>User $user Object of user that ask creation</td> <td>1</td> </tr> <tr> <td>User $user User executing update</td> <td>1</td> </tr> <tr> <td>array $links array of Link objects to fill</td> <td>1</td> </tr> <tr> <td>string $objecttype type of the associated object in dolibarr</td> <td>1</td> </tr> <tr> <td>int $objectid id of the associated object in dolibarr</td> <td>1</td> </tr> <tr> <td>string $sortfield field used to sort</td> <td>1</td> </tr> <tr> <td>string $sortorder sort order</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>string $objecttype Type of the associated object in dolibarr</td> <td>1</td> </tr> <tr> <td>int $objectid Id of the associated object in dolibarr</td> <td>1</td> </tr> <tr> <td>int $rowid Id of link to load</td> <td>1</td> </tr> <tr> <td>User $user Object suer</td> <td>1</td> </tr> <tr> <td>array $socialnetworks Array of social networks</td> <td>1</td> </tr> <tr> <td>int $colspan Colspan</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>int $useempty Show empty value or not</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add an empty value in list</td> <td>1</td> </tr> <tr> <td>Website $website Object Website</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select zone</td> <td>1</td> </tr> <tr> <td>int $pageid Preselected container ID</td> <td>1</td> </tr> <tr> <td>int $showempty Show empty record</td> <td>1</td> </tr> <tr> <td>string $action Action on page that use this select list</td> <td>1</td> </tr> <tr> <td>array $excludeids Exclude some ID in list</td> <td>1</td> </tr> <tr> <td>string $htmlname htmlname</td> <td>1</td> </tr> <tr> <td>string $geojson json of geometric objects</td> <td>1</td> </tr> <tr> <td>string $centroidjson json of geometric center of object</td> <td>1</td> </tr> <tr> <td>string $markertype type of marker, point, multipts, linestrg, polygon</td> <td>1</td> </tr> <tr> <td>string $urlRSS Url to parse</td> <td>1</td> </tr> <tr> <td>int $maxNb Max nb of records to get (0 for no limit)</td> <td>1</td> </tr> <tr> <td>int $cachedelay 0=No cache, nb of seconds we accept cache files (cachedir must also be defined)</td> <td>1</td> </tr> <tr> <td>string $cachedir Directory where to save cache file (For example $conf->externalrss->dir_temp)</td> <td>1</td> </tr> <tr> <td>string $p Start</td> <td>1</td> </tr> <tr> <td>string $element Tag</td> <td>1</td> </tr> <tr> <td>array $attrs Attributes of tags</td> <td>1</td> </tr> <tr> <td>string $p P</td> <td>1</td> </tr> <tr> <td>string $text Tag</td> <td>1</td> </tr> <tr> <td>string $p P</td> <td>1</td> </tr> <tr> <td>string $el Tag</td> <td>1</td> </tr> <tr> <td>string $str1 Str1</td> <td>1</td> </tr> <tr> <td>string $str2 Str2</td> <td>1</td> </tr> <tr> <td>string $text Text</td> <td>1</td> </tr> <tr> <td>string $el El</td> <td>1</td> </tr> <tr> <td>string $text Text</td> <td>1</td> </tr> <tr> <td>array $item A parsed item of a ATOM feed</td> <td>1</td> </tr> <tr> <td>int $maxlength (optional) The maximum length for the description</td> <td>1</td> </tr> <tr> <td>array $feed The ATOM feed that possible contain a link to a logo or icon</td> <td>1</td> </tr> <tr> <td>string $bindDn DN</td> <td>1</td> </tr> <tr> <td>string $pass Password</td> <td>1</td> </tr> <tr> <td>User $user Object user that create</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>string $dn Old DN entry key (uid=qqq,ou=xxx,dc=aaa,dc=bbb) (before update)</td> <td>1</td> </tr> <tr> <td>string $newrdn New RDN entry key (uid=qqq)</td> <td>1</td> </tr> <tr> <td>string $newparent New parent (ou=xxx,dc=aaa,dc=bbb)</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>bool $deleteoldrdn If true the old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry.</td> <td>1</td> </tr> <tr> <td>User $user Object user that update</td> <td>1</td> </tr> <tr> <td>string $olddn Old DN entry key (before update)</td> <td>1</td> </tr> <tr> <td>string $newrdn New RDN entry key (uid=qqq) (for ldap_rename)</td> <td>1</td> </tr> <tr> <td>string $newparent New parent (ou=xxx,dc=aaa,dc=bbb) (for ldap_rename)</td> <td>1</td> </tr> <tr> <td>string $host Server host or address</td> <td>1</td> </tr> <tr> <td>int $port Server port (default 389)</td> <td>1</td> </tr> <tr> <td>int $timeout Timeout in second (default 1s)</td> <td>1</td> </tr> <tr> <td>string $filterrecord Record</td> <td>1</td> </tr> <tr> <td>string $attribute Attributes</td> <td>1</td> </tr> <tr> <td>string $search Value of field to search, '*' for all. Not used if $activefilter is set.</td> <td>1</td> </tr> <tr> <td>string $userDn DN (Ex: ou=adherents,ou=people,dc=parinux,dc=org)</td> <td>1</td> </tr> <tr> <td>string $useridentifier Name of key field (Ex: uid).</td> <td>1</td> </tr> <tr> <td>array $attributeArray Array of fields required. Note this array must also contain field $useridentifier (Ex: sn,userPassword)</td> <td>1</td> </tr> <tr> <td>int $activefilter '1' or 'user'=use field this->filter as filter instead of parameter $search, 'group'=use field this->filtergroup as filter, 'member'=use field this->filtermember as filter</td> <td>1</td> </tr> <tr> <td>array $attributeAsArray Array of fields wanted as an array not a string</td> <td>1</td> </tr> <tr> <td>string $hex Hex value</td> <td>1</td> </tr> <tr> <td>string $ldapUser User login</td> <td>1</td> </tr> <tr> <td>string $binsid Binary SID</td> <td>1</td> </tr> <tr> <td>string $checkDn Search DN (Ex: ou=users,cn=my-domain,cn=com)</td> <td>1</td> </tr> <tr> <td>string $filter Search filter (ex: (sn=name_person) )</td> <td>1</td> </tr> <tr> <td>User|string $user Not used.</td> <td>1</td> </tr> <tr> <td>string $filter Filter for search. Must start with &.</td> <td>1</td> </tr> <tr> <td>string $uacf UACF</td> <td>1</td> </tr> <tr> <td>string $samtype SamType</td> <td>1</td> </tr> <tr> <td>string $value AD time to convert</td> <td>1</td> </tr> <tr> <td>string $pagecodeto Page code for result string</td> <td>1</td> </tr> <tr> <td>string $keygroup Key of group</td> <td>1</td> </tr> <tr> <td>string $path Full absolute path on filesystem of file, including file name</td> <td>1</td> </tr> <tr> <td>string $file Only filename (can be basename($path))</td> <td>1</td> </tr> <tr> <td>string $type Mime type (can be dol_mimetype($file))</td> <td>1</td> </tr> <tr> <td>int $keytodelete Key index in file array (0, 1, 2, ...)</td> <td>1</td> </tr> <tr> <td>ModelMail $arraydefaultmessage Array with message template content</td> <td>1</td> </tr> <tr> <td>string $helpforsubstitution Help string for substitution</td> <td>1</td> </tr> <tr> <td>string $function Function ('textgenerationmail', 'textgenerationwebpage', ...)</td> <td>1</td> </tr> <tr> <td>string $htmlContent HTML name of WYSIWYG field to fill</td> <td>1</td> </tr> <tr> <td>string $type_template Get message for model/type=$type_template, type='all' also included.</td> <td>1</td> </tr> <tr> <td>User $user Get templates public + limited to this user</td> <td>1</td> </tr> <tr> <td>int $id Id of template to get, or</td> <td>1</td> </tr> <tr> <td>int $active 1=Only active template, 0=Only disabled, -1=All</td> <td>1</td> </tr> <tr> <td>string $label Label of template to get</td> <td>1</td> </tr> <tr> <td>int $defaultfortype 1=Only default templates, 0=Only not default, -1=All</td> <td>1</td> </tr> <tr> <td>string $type_template Get message for key module</td> <td>1</td> </tr> <tr> <td>User $user Use template public or limited to this user</td> <td>1</td> </tr> <tr> <td>string $type_template Get message for key module</td> <td>1</td> </tr> <tr> <td>User $user Use template public or limited to this user</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output lang object</td> <td>1</td> </tr> <tr> <td>int $active 1=Only active template, 0=Only disabled, -1=All</td> <td>1</td> </tr> <tr> <td>CommonObject $object Object to use</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang</td> <td>1</td> </tr> <tr> <td>string $mode 'formemail', 'formemailwithlines', 'formemailforlines', 'emailing', ...</td> <td>1</td> </tr> <tr> <td>Object $object Object if applicable</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>Adherent $member Member</td> <td>1</td> </tr> <tr> <td>Societe $mysoc Object thirdparty</td> <td>1</td> </tr> <tr> <td>Societe $object Object</td> <td>1</td> </tr> <tr> <td>Contact $object contact</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs object for output</td> <td>1</td> </tr> <tr> <td>CommonObjectLine $line Object line</td> <td>1</td> </tr> <tr> <td>int $linenumber The number of the line for the substitution of "object_line_pos"</td> <td>1</td> </tr> <tr> <td>Expedition $object Main object to use as data source</td> <td>1</td> </tr> <tr> <td>string $array_key Name of the key for return array</td> <td>1</td> </tr> <tr> <td>Object $object Dolibarr Object</td> <td>1</td> </tr> <tr> <td>boolean|int $recursive Want to fetch child array or child object.</td> <td>1</td> </tr> <tr> <td>Object $object Object with extrafields (must have $object->array_options filled)</td> <td>1</td> </tr> <tr> <td>array $array_to_fill Substitution array</td> <td>1</td> </tr> <tr> <td>Extrafields $extrafields Extrafields object</td> <td>1</td> </tr> <tr> <td>string $array_key Prefix for name of the keys into returned array</td> <td>1</td> </tr> <tr> <td>float $x Abscissa of first point</td> <td>1</td> </tr> <tr> <td>float $y Ordinate of first point</td> <td>1</td> </tr> <tr> <td>float $l ??</td> <td>1</td> </tr> <tr> <td>float $h ??</td> <td>1</td> </tr> <tr> <td>int $hidebottom Hide bottom</td> <td>1</td> </tr> <tr> <td>array $a PDF lines array fields configs</td> <td>1</td> </tr> <tr> <td>array $b PDF lines array fields configs</td> <td>1</td> </tr> <tr> <td>object $object common object</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs langs</td> <td>1</td> </tr> <tr> <td>string $colKey the column key</td> <td>1</td> </tr> <tr> <td>string $colKey the column key</td> <td>1</td> </tr> <tr> <td>string $newColKey the new column key</td> <td>1</td> </tr> <tr> <td>array $defArray a single column definition array</td> <td>1</td> </tr> <tr> <td>string $targetCol target column used to place the new column beside</td> <td>1</td> </tr> <tr> <td>bool $insertAfterTarget insert before or after target column ?</td> <td>1</td> </tr> <tr> <td>string $columnText column text</td> <td>1</td> </tr> <tr> <td>object $object CommonObject</td> <td>1</td> </tr> <tr> <td>int $i the $object->lines array key</td> <td>1</td> </tr> <tr> <td>int $hideref hide ref</td> <td>1</td> </tr> <tr> <td>int $hidedesc hide desc</td> <td>1</td> </tr> <tr> <td>int $issupplierline if object need supplier product</td> <td>1</td> </tr> <tr> <td>object $object Common object</td> <td>1</td> </tr> <tr> <td>string $extrafieldKey The extrafield key</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs The output langs (if value is __(XXX)__ we use it to translate it).</td> <td>1</td> </tr> <tr> <td>object $object line of common object</td> <td>1</td> </tr> <tr> <td>array $params array of additional parameters</td> <td>1</td> </tr> <tr> <td>float $tab_top Tab top position</td> <td>1</td> </tr> <tr> <td>float $tab_height Default tab height</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>1</td> </tr> <tr> <td>int $hidetop Hide top</td> <td>1</td> </tr> <tr> <td>object $object common object det</td> <td>1</td> </tr> <tr> <td>Object $object Common object</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Langs</td> <td>1</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>1</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>1</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>1</td> </tr> <tr> <td>int $selected preselect status</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>int $useempty 1=Add empty line</td> <td>1</td> </tr> <tr> <td>int $useshortlabel Use short labels</td> <td>1</td> </tr> <tr> <td>int $selected Preselected type</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>int $active 1=Active only, 0=Unactive only, -1=All</td> <td>1</td> </tr> <tr> <td>array $attributes an array of attributes keys and values,</td> <td>1</td> </tr> <tr> <td>Translate $outputLangs if needed can use another lang</td> <td>1</td> </tr> <tr> <td>bool $editMode true will display output on edit mod</td> <td>1</td> </tr> <tr> <td>bool $editMode True will display output on edit modECM</td> <td>1</td> </tr> <tr> <td>bool $noMessageInUpdate display event message on errors and success</td> <td>1</td> </tr> <tr> <td>FormSetupItem $item the setup item</td> <td>1</td> </tr> <tr> <td>bool $editMode Display as edit mod</td> <td>1</td> </tr> <tr> <td>array $params an array of arrays of params from old modulBuilder params</td> <td>1</td> </tr> <tr> <td>string $confKey the conf name to store</td> <td>1</td> </tr> <tr> <td>array $params an array of params from old modulBuilder params</td> <td>1</td> </tr> <tr> <td>string $confKey the conf key used in database</td> <td>1</td> </tr> <tr> <td>string $targetItemKey target item used to place the new item beside</td> <td>1</td> </tr> <tr> <td>bool $insertAfterTarget insert before or after target item ?</td> <td>1</td> </tr> <tr> <td>bool $cache To use cache or not</td> <td>1</td> </tr> <tr> <td>int $rank the item rank</td> <td>1</td> </tr> <tr> <td>string $itemKey the item key</td> <td>1</td> </tr> <tr> <td>FormSetupItem $a formSetup item</td> <td>1</td> </tr> <tr> <td>FormSetupItem $b formSetup item</td> <td>1</td> </tr> <tr> <td>string $confKey the conf key used in database</td> <td>1</td> </tr> <tr> <td>string $type 'dolibarr' (dolibarr password rules apply) or 'generic'</td> <td>1</td> </tr> <tr> <td>string $type possible values based on old module builder setup : 'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'</td> <td>1</td> </tr> <tr> <td>array|string $errors the error text</td> <td>1</td> </tr> <tr> <td>string $templateType email template type</td> <td>1</td> </tr> <tr> <td>int $catType Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.</td> <td>1</td> </tr> <tr> <td>array $fieldOptions A table of field options</td> <td>1</td> </tr> <tr> <td>array $fieldOptions A table of field options</td> <td>1</td> </tr> <tr> <td>string[] $arraycontext Array list of searched hooks tab/features. For example: 'thirdpartycard' (for hook methods into page card thirdparty), 'thirdpartydao' (for hook methods into Societe), ...</td> <td>1</td> </tr> <tr> <td>string $method Name of method hooked ('doActions', 'printSearchForm', 'showInputField', ...)</td> <td>1</td> </tr> <tr> <td>array<string,mixed> $parameters Array of parameters</td> <td>1</td> </tr> <tr> <td>object $object Object to use hooks on</td> <td>1</td> </tr> <tr> <td>string $action Action code on calling page ('create', 'edit', 'view', 'add', 'update', 'delete'...)</td> <td>1</td> </tr> <tr> <td>string $url Url</td> <td>1</td> </tr> <tr> <td>string $title Title zone (Title or '' or 'none')</td> <td>1</td> </tr> <tr> <td>int $addcancel 1=Add 'Cancel' button</td> <td>1</td> </tr> <tr> <td>int $sectionid If upload must be done inside a particular ECM section (is sectionid defined, sectiondir must not be)</td> <td>1</td> </tr> <tr> <td>int $perm Value of permission to allow upload</td> <td>1</td> </tr> <tr> <td>int $size Length of input file area. Deprecated.</td> <td>1</td> </tr> <tr> <td>Object $object Object to use (when attachment is done on an element)</td> <td>1</td> </tr> <tr> <td>string $options Add an option column</td> <td>1</td> </tr> <tr> <td>integer $useajax Use fileupload ajax (0=never, 1=if enabled, 2=always whatever is option).</td> <td>1</td> </tr> <tr> <td>string $savingdocmask Mask to use to define output filename. For example 'XXXXX-__YYYYMMDD__-__file__'</td> <td>1</td> </tr> <tr> <td>integer $linkfiles 1=Also add form to link files, 0=Do not show form to link files</td> <td>1</td> </tr> <tr> <td>string $htmlname Name and id of HTML form ('formuserfile' by default, 'formuserfileecm' when used to upload a file in ECM)</td> <td>1</td> </tr> <tr> <td>string $accept Specifies the types of files accepted (This is not a security check but an user interface facility. eg '.pdf,image/*' or '.png,.jpg' or 'video/*')</td> <td>1</td> </tr> <tr> <td>string $sectiondir If upload must be done inside a particular directory (if sectiondir defined, sectionid must not be)</td> <td>1</td> </tr> <tr> <td>int $usewithoutform 0=Default, 1=Disable <form> and <input hidden> to use in existing form area, 2=Disable the tag <form> only</td> <td>1</td> </tr> <tr> <td>int $capture 1=Add tag capture="capture" to force use of micro or video recording to generate file. When setting this to 1, you must also provide a value for $accept.</td> <td>1</td> </tr> <tr> <td>int $disablemulti 0=Default, 1=Disable multiple file upload</td> <td>1</td> </tr> <tr> <td>int $nooutput 0=Output result with print, 1=Return result</td> <td>1</td> </tr> <tr> <td>string $modulepart propal, facture, facture_fourn, ...</td> <td>1</td> </tr> <tr> <td>string $modulesubdir Sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module.</td> <td>1</td> </tr> <tr> <td>string $filedir Directory to scan</td> <td>1</td> </tr> <tr> <td>int $genallowed Generation is allowed (1/0 or array of formats)</td> <td>1</td> </tr> <tr> <td>integer $allowgenifempty Show warning if no model activated</td> <td>1</td> </tr> <tr> <td>int $iconPDF Show only PDF icon with link (1/0)</td> <td>1</td> </tr> <tr> <td>string $title Title to show on top of form</td> <td>1</td> </tr> <tr> <td>string $modulepart Module the files are related to ('propal', 'facture', 'facture_fourn', 'mymodule', 'mymodule:MyObject', 'mymodule_temp', ...)</td> <td>1</td> </tr> <tr> <td>string $modulesubdir Existing (so sanitized) sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into a subdir of module.</td> <td>1</td> </tr> <tr> <td>string $filedir Directory to scan (must not end with a /). Example: '/mydolibarrdocuments/facture/FAYYMM-1234'</td> <td>1</td> </tr> <tr> <td>int|string[] $genallowed Generation is allowed (1/0 or array list of templates)</td> <td>1</td> </tr> <tr> <td>integer $allowgenifempty Allow generation even if list of template ($genallowed) is empty (show however a warning)</td> <td>1</td> </tr> <tr> <td>int $iconPDF Deprecated, see getDocumentsLink</td> <td>1</td> </tr> <tr> <td>string $title Title to show on top of form. Example: '' (Default to "Documents") or 'none'</td> <td>1</td> </tr> <tr> <td>string $morepicto Add more HTML content into cell with picto</td> <td>1</td> </tr> <tr> <td>Object|null $object Object when method is called from an object card.</td> <td>1</td> </tr> <tr> <td>int $hideifempty Hide section of generated files if there is no file</td> <td>1</td> </tr> <tr> <td>string $removeaction (optional) The action to remove a file</td> <td>1</td> </tr> <tr> <td>string $tooltipontemplatecombo Text to show on a tooltip after the combo list of templates</td> <td>1</td> </tr> <tr> <td>string $modulepart 'propal', 'facture', 'facture_fourn', ...</td> <td>1</td> </tr> <tr> <td>string $modulesubdir Sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module.</td> <td>1</td> </tr> <tr> <td>string $filedir Full path to directory to scan</td> <td>1</td> </tr> <tr> <td>string $filter Filter filenames on this regex string (Example: '\.pdf$')</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css to the download picto</td> <td>1</td> </tr> <tr> <td>int $allfiles 0=Only generated docs, 1=All files</td> <td>1</td> </tr> <tr> <td>array $filearray Array of files loaded by dol_dir_list('files') function before calling this.</td> <td>1</td> </tr> <tr> <td>Object|null $object Object on which document is linked to.</td> <td>1</td> </tr> <tr> <td>string $modulepart Value for modulepart used by download or viewimage wrapper.</td> <td>1</td> </tr> <tr> <td>string $param Parameters on sort links (param must start with &, example &aaa=bbb&ccc=ddd)</td> <td>1</td> </tr> <tr> <td>int $forcedownload Force to open dialog box "Save As" when clicking on file.</td> <td>1</td> </tr> <tr> <td>string $relativepath Relative path of docs (autodefined if not provided), relative to module dir, not to MAIN_DATA_ROOT.</td> <td>1</td> </tr> <tr> <td>int $permonobject Permission on object (so permission to delete or crop document)</td> <td>1</td> </tr> <tr> <td>int $useinecm Change output for use in ecm module:</td> <td>1</td> </tr> <tr> <td>string $textifempty Text to show if filearray is empty ('NoFileFound' if not defined)</td> <td>1</td> </tr> <tr> <td>int $maxlength Maximum length of file name shown.</td> <td>1</td> </tr> <tr> <td>string $title Title before list. Use 'none' to disable title.</td> <td>1</td> </tr> <tr> <td>string $url Full url to use for click links ('' = autodetect)</td> <td>1</td> </tr> <tr> <td>int $showrelpart 0=Show only filename (default), 1=Show first level 1 dir</td> <td>1</td> </tr> <tr> <td>int $permtoeditline Permission to edit document line (You must provide a value, -1 is deprecated and must not be used any more)</td> <td>1</td> </tr> <tr> <td>string $upload_dir Full path directory so we can know dir relative to MAIN_DATA_ROOT. Fill this to complete file data with database indexes.</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field ('name', 'size', 'position', ...)</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order ('ASC' or 'DESC')</td> <td>1</td> </tr> <tr> <td>int $disablemove 1=Disable move button, 0=Position move is possible.</td> <td>1</td> </tr> <tr> <td>int $addfilterfields Add the line with filters</td> <td>1</td> </tr> <tr> <td>int $disablecrop Disable crop feature on images (-1 = auto, prefer to set it explicitly to 0 or 1)</td> <td>1</td> </tr> <tr> <td>string $moreattrondiv More attributes on the div for responsive. Example 'style="height:280px; overflow: auto;"'</td> <td>1</td> </tr> <tr> <td>string $upload_dir Directory that was scanned. This directory will contains files into subdirs REF/files</td> <td>1</td> </tr> <tr> <td>array $filearray Array of files loaded by dol_dir_list function before calling this function</td> <td>1</td> </tr> <tr> <td>string $modulepart Value for modulepart used by download wrapper. Value can be $object->table_name (that is 'myobject' or 'mymodule_myobject') or $object->element.'-'.$module (for compatibility purpose)</td> <td>1</td> </tr> <tr> <td>string $param Parameters on sort links</td> <td>1</td> </tr> <tr> <td>int $forcedownload Force to open dialog box "Save As" when clicking on file</td> <td>1</td> </tr> <tr> <td>string $relativepath Relative path of docs (autodefined if not provided)</td> <td>1</td> </tr> <tr> <td>int $permissiontodelete Permission to delete</td> <td>1</td> </tr> <tr> <td>int $useinecm Change output for use in ecm module</td> <td>1</td> </tr> <tr> <td>string $textifempty Text to show if filearray is empty</td> <td>1</td> </tr> <tr> <td>int $maxlength Maximum length of file name shown</td> <td>1</td> </tr> <tr> <td>string $url Full url to use for click links ('' = autodetect)</td> <td>1</td> </tr> <tr> <td>int $addfilterfields Add line with filters</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>int $permissiontodelete Deletion is allowed</td> <td>1</td> </tr> <tr> <td>string $action Action</td> <td>1</td> </tr> <tr> <td>string $selected ???</td> <td>1</td> </tr> <tr> <td>string $param More param to add into URL</td> <td>1</td> </tr> <tr> <td>array $file Array with data of file. Example: array('name'=>...)</td> <td>1</td> </tr> <tr> <td>string $relativepath Relative path of docs</td> <td>1</td> </tr> <tr> <td>integer $ruleforpicto Rule for picto: 0=Use the generic preview picto, 1=Use the picto of mime type of file). Use a negative value to show a generic picto even if preview not available.</td> <td>1</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only interventions not linked to a third party, id=intervention not linked or linked to third party id)</td> <td>1</td> </tr> <tr> <td>int $selected Id intervention preselected</td> <td>1</td> </tr> <tr> <td>int $showempty Show empty line ('1' or string to show for empty line)</td> <td>1</td> </tr> <tr> <td>bool $draftonly Show only drafts intervention</td> <td>1</td> </tr> <tr> <td>int $year number</td> <td>1</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month</td> <td>1</td> </tr> <tr> <td>int $year year number</td> <td>1</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month</td> <td>1</td> </tr> <tr> <td>string $sql SQL request</td> <td>1</td> </tr> <tr> <td>string $sql SQL request</td> <td>1</td> </tr> <tr> <td>string $sql SQL</td> <td>1</td> </tr> <tr> <td>string $sql SQL</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month</td> <td>1</td> </tr> <tr> <td>string $sql SQL</td> <td>1</td> </tr> <tr> <td>int $id_incoterm Id of incoterm to set or '' to remove</td> <td>1</td> </tr> <tr> <td>string $location location of incoterm</td> <td>1</td> </tr> <tr> <td>string $selectid Preselected journal code</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in html form</td> <td>1</td> </tr> <tr> <td>int $nature Limit the list to a particular type of journals (1:various operations / 2:sale / 3:purchase / 4:bank / 9: has-new)</td> <td>1</td> </tr> <tr> <td>int $select_in 0=selectid value is the journal rowid (default) or 1=selectid is journal code</td> <td>1</td> </tr> <tr> <td>int $select_out Set value returned by select. 0=rowid (default), 1=code</td> <td>1</td> </tr> <tr> <td>string $morecss More css non HTML object</td> <td>1</td> </tr> <tr> <td>string $usecache Key to use to store result into a cache. Next call with same key will reuse the cache.</td> <td>1</td> </tr> <tr> <td>int $disabledajaxcombo Disable ajax combo box.</td> <td>1</td> </tr> <tr> <td>string[] $selectedIds Preselected journal code array</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in html form</td> <td>1</td> </tr> <tr> <td>int $nature Limit the list to a particular type of journals (1:various operations / 2:sale / 3:purchase / 4:bank / 9: has-new)</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>int $select_in 0=selectid value is the journal rowid (default) or 1=selectid is journal code</td> <td>1</td> </tr> <tr> <td>int $select_out Set value returned by select. 0=rowid (default), 1=code</td> <td>1</td> </tr> <tr> <td>string $morecss More css non HTML object</td> <td>1</td> </tr> <tr> <td>string $usecache Key to use to store result into a cache. Next call with same key will reuse the cache.</td> <td>1</td> </tr> <tr> <td>int $disabledajaxcombo Disable ajax combo box.</td> <td>1</td> </tr> <tr> <td>int $selected Preselected type</td> <td>1</td> </tr> <tr> <td>int $allcountries All countries</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select field</td> <td>1</td> </tr> <tr> <td>string $selectedkey Value</td> <td>1</td> </tr> <tr> <td>string $selectid Preselected id of accounting accounts (depends on $select_in)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML field id. If name start with '.', it is name of HTML css class, so several component with same name in different forms can be used.</td> <td>1</td> </tr> <tr> <td>int|string $showempty 1=Add an empty field, 2=Add an empty field+'None' field</td> <td>1</td> </tr> <tr> <td>array<array<string,mixed>> $event Event options</td> <td>1</td> </tr> <tr> <td>int $select_in 0=selectid value is a aa.rowid (default) or 1=selectid is aa.account_number</td> <td>1</td> </tr> <tr> <td>int $select_out Set value returned by select. 0=rowid (default), 1=account_number</td> <td>1</td> </tr> <tr> <td>string $morecss More css non HTML object</td> <td>1</td> </tr> <tr> <td>string $usecache Key to use to store result into a cache. Next call with same key will reuse the cache.</td> <td>1</td> </tr> <tr> <td>string $active Filter on status active or not: '0', '1' or '' for no filter</td> <td>1</td> </tr> <tr> <td>string $selectid Preselected pcg_type</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in html form</td> <td>1</td> </tr> <tr> <td>int|string $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>string $morecss More css</td> <td>1</td> </tr> <tr> <td>string $usecache Key to use to store result into a cache. Next call with same key will reuse the cache.</td> <td>1</td> </tr> <tr> <td>string $labelhtmlname HTML name of label for autofill of account from name.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select object</td> <td>1</td> </tr> <tr> <td>int $useempty Affiche valeur vide dans liste</td> <td>1</td> </tr> <tr> <td>string $output_format (html/option (for option html only)/array (to return options arrays</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>string $selected Id preselected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select object</td> <td>1</td> </tr> <tr> <td>int $option option (0: aggregate by general account or 1: aggregate by subaccount)</td> <td>1</td> </tr> <tr> <td>int $useempty Show empty value in list</td> <td>1</td> </tr> <tr> <td>string $filter optional filters criteria</td> <td>1</td> </tr> <tr> <td>int $nooutput No print output. Return it only.</td> <td>1</td> </tr> <tr> <td>string $library 'auto' (default)</td> <td>1</td> </tr> <tr> <td>float $xi Xi</td> <td>1</td> </tr> <tr> <td>float $xt Xt</td> <td>1</td> </tr> <tr> <td>float $x Label interval</td> <td>1</td> </tr> <tr> <td>boolean $bool XGrid or not</td> <td>1</td> </tr> <tr> <td>boolean $bool XValues or not</td> <td>1</td> </tr> <tr> <td>boolean $bool YGrid or not</td> <td>1</td> </tr> <tr> <td>string $label Y label</td> <td>1</td> </tr> <tr> <td>int|string $w Width (Example: 320 or '100%' or '10px')</td> <td>1</td> </tr> <tr> <td>array $data Data</td> <td>1</td> </tr> <tr> <td>array $datacolor Data color array(array(R,G,B),array(R,G,B)...) or array('#......','#......'...)</td> <td>1</td> </tr> <tr> <td>array $bordercolor Border Color array(array(R,G,B),array(R,G,B)...) or array('#FFFFFF','#......'...)</td> <td>1</td> </tr> <tr> <td>int $borderwidth Border Width</td> <td>1</td> </tr> <tr> <td>int $borderskip Can be 'start' to skip start border, 'end' to skip end border, 'middle' to skip middle border,</td> <td>1</td> </tr> <tr> <td>array $tooltipsLabels Tooltips Labels array('...','...'...)</td> <td>1</td> </tr> <tr> <td>array $tooltipsTitles Tooltips Titles array('...','...'...)</td> <td>1</td> </tr> <tr> <td>array $type Array with type for each series. Example: array('type1', 'type2', ...) where type can be:</td> <td>1</td> </tr> <tr> <td>array $legend Legend. Example: array('seriename1','seriname2',...)</td> <td>1</td> </tr> <tr> <td>int $legendwidthmin Min width</td> <td>1</td> </tr> <tr> <td>int $max Max value</td> <td>1</td> </tr> <tr> <td>int $min Min value</td> <td>1</td> </tr> <tr> <td>int|string $h Height int or '90%' or '10px'</td> <td>1</td> </tr> <tr> <td>boolean $mirrorGraphValues Mirror Values if true and doesn't if false</td> <td>1</td> </tr> <tr> <td>int $showlegend 1=Show legend (default), 0=Hide legend, 2=Show legend on right</td> <td>1</td> </tr> <tr> <td>int $showpointvalue 1=Show value for each point, as tooltip or inline (default), 0=Hide value, 2=Show values for each series on same point</td> <td>1</td> </tr> <tr> <td>int $showpercent 1=Show percent for each point, as tooltip or inline, 0=Hide percent (default)</td> <td>1</td> </tr> <tr> <td>array $bg_color array(R,G,B) ou 'onglet' ou 'default'</td> <td>1</td> </tr> <tr> <td>array $bg_colorgrid array(R,G,B) ou 'onglet' ou 'default'</td> <td>1</td> </tr> <tr> <td>string $fileurl Url path to show image if saved onto disk</td> <td>1</td> </tr> <tr> <td>int|string $shownographyet Show graph to say there is not enough data or the message in $shownographyet if it is a string.</td> <td>1</td> </tr> <tr> <td>string $direction 'width' or 'height'</td> <td>1</td> </tr> <tr> <td>string $defaultsize Value we want as default size</td> <td>1</td> </tr> <tr> <td>string $type 'country' or 'city'</td> <td>1</td> </tr> <tr> <td>string $datfile Data file</td> <td>1</td> </tr> <tr> <td>string $ip IP to scan</td> <td>1</td> </tr> <tr> <td>string $name FQN of host (example: myserver.xyz.com)</td> <td>1</td> </tr> <tr> <td>string $formname Name of form where select is included</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value (-1..100)</td> <td>1</td> </tr> <tr> <td>int $canedit 1=can edit, 0=read only</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html prefix for html fields (selectX and valX)</td> <td>1</td> </tr> <tr> <td>integer $showempty Show an empty line if select is used</td> <td>1</td> </tr> <tr> <td>integer $onlyselect 0=Standard, 1=Hide percent of completion and force usage of a select list, 2=Same than 1 and add "Incomplete (Todo+Running)</td> <td>1</td> </tr> <tr> <td>string $morecss More css on select field</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>string $typeelement 'invoice', 'propal', 'order', 'invoice_supplier', 'order_supplier', 'fichinter'</td> <td>1</td> </tr> <tr> <td>int $socid Socid of user</td> <td>1</td> </tr> <tr> <td>int $forceshowtitle Show title even if there is no actions to show</td> <td>1</td> </tr> <tr> <td>string $morecss More css on table</td> <td>1</td> </tr> <tr> <td>int $max Max number of record</td> <td>1</td> </tr> <tr> <td>string $moreparambacktopage More param for the backtopage</td> <td>1</td> </tr> <tr> <td>string $morehtmlcenter More html text on center of title line</td> <td>1</td> </tr> <tr> <td>int $assignedtouser Assign event by default to this user id (will be ignored if not enough permissions)</td> <td>1</td> </tr> <tr> <td>array|string $selected Type pre-selected (can be 'manual', 'auto' or 'AC_xxx'). Can be an array too.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select field</td> <td>1</td> </tr> <tr> <td>string $excludetype A type to exclude ('systemauto', 'system', '')</td> <td>1</td> </tr> <tr> <td>integer $onlyautoornot 1=Group all type AC_XXX into 1 line AC_MANUAL. 0=Keep details of type, -1=Keep details and add a combined line "All manual", -2=Combined line is disabled (not implemented yet)</td> <td>1</td> </tr> <tr> <td>int $hideinfohelp 1=Do not show info help, 0=Show, -1=Show+Add info to tell how to set default value</td> <td>1</td> </tr> <tr> <td>int $multiselect 1=Allow multiselect of action type</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=No output</td> <td>1</td> </tr> <tr> <td>string $morecss More css to add to SELECT component.</td> <td>1</td> </tr> <tr> <td>int $number numero de telephone</td> <td>1</td> </tr> <tr> <td>string $type Type ('cell')</td> <td>1</td> </tr> <tr> <td>string $type Type 'image/jpeg' or 'JPEG'</td> <td>1</td> </tr> <tr> <td>string $photo Photo</td> <td>1</td> </tr> <tr> <td>string $family Family name</td> <td>1</td> </tr> <tr> <td>string $first First name</td> <td>1</td> </tr> <tr> <td>string $additional Additional (e.g. second name, nick name)</td> <td>1</td> </tr> <tr> <td>string $prefix Title prefix (e.g. "Mr.", "Ms.", "Prof.")</td> <td>1</td> </tr> <tr> <td>string $suffix Suffix (e.g. "sen." for senior, "jun." for junior)</td> <td>1</td> </tr> <tr> <td>integer $date Date</td> <td>1</td> </tr> <tr> <td>string $label Label</td> <td>1</td> </tr> <tr> <td>string $address E-mail address</td> <td>1</td> </tr> <tr> <td>string $type (optional) The type of the e-mail (typical "PREF" or "INTERNET")</td> <td>1</td> </tr> <tr> <td>string $note Note</td> <td>1</td> </tr> <tr> <td>string $org Org</td> <td>1</td> </tr> <tr> <td>string $prodid Prodid</td> <td>1</td> </tr> <tr> <td>string $uid Uid</td> <td>1</td> </tr> <tr> <td>string $url URL</td> <td>1</td> </tr> <tr> <td>string $type Type</td> <td>1</td> </tr> <tr> <td>Object $object Object (User or Contact)</td> <td>1</td> </tr> <tr> <td>Societe|null $company Company. May be null</td> <td>1</td> </tr> <tr> <td>Translate $langs Lang object</td> <td>1</td> </tr> <tr> <td>string $urlphoto Full public URL of photo</td> <td>1</td> </tr> <tr> <td>string $geojson A json string</td> <td>1</td> </tr> <tr> <td>string $to Recipients emails (RFC 2822: "Name firstname <email>[, ...]" or "email[, ...]" or "<email>[, ...]"). Note: the keyword '__SUPERVISOREMAIL__' is not allowed here and must be replaced by caller.</td> <td>1</td> </tr> <tr> <td>string $from Sender email (RFC 2822: "Name firstname <email>[, ...]" or "email[, ...]" or "<email>[, ...]")</td> <td>1</td> </tr> <tr> <td>string $msg Message</td> <td>1</td> </tr> <tr> <td>array $filename_list List of files to attach (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>array $mimetype_list List of MIME type of attached files</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list List of attached file name in message</td> <td>1</td> </tr> <tr> <td>string $addr_cc Email cc (Example: 'abc@def.com, ghk@lmn.com')</td> <td>1</td> </tr> <tr> <td>string $addr_bcc Email bcc (Note: This is autocompleted with MAIN_MAIL_AUTOCOPY_TO if defined)</td> <td>1</td> </tr> <tr> <td>int $deliveryreceipt Ask a delivery receipt</td> <td>1</td> </tr> <tr> <td>int $msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown make autodetection (with fast mode, not reliable)</td> <td>1</td> </tr> <tr> <td>string $errors_to Email for errors-to</td> <td>1</td> </tr> <tr> <td>string $css Css option</td> <td>1</td> </tr> <tr> <td>string $trackid Tracking string (contains type and id of related element)</td> <td>1</td> </tr> <tr> <td>string $moreinheader More in header. $moreinheader must contains the "\r\n" at end of each line</td> <td>1</td> </tr> <tr> <td>string $sendcontext 'standard', 'emailing', 'ticket', 'password', ... (used to define which sending mode and parameters to use)</td> <td>1</td> </tr> <tr> <td>string $replyto Reply-to email (will be set to the same value than From by default if not provided)</td> <td>1</td> </tr> <tr> <td>string $upload_dir_tmp Temporary directory (used to convert images embedded as img src=data:image)</td> <td>1</td> </tr> <tr> <td>string $in_reply_to Message-ID of the message we reply to</td> <td>1</td> </tr> <tr> <td>string $references String with list of Message-ID of the thread ('<123> <456> ...')</td> <td>1</td> </tr> <tr> <td>string $stringtoencode String to encode</td> <td>1</td> </tr> <tr> <td>string $sourcefile Path to file to encode</td> <td>1</td> </tr> <tr> <td>string $message Add also a message</td> <td>1</td> </tr> <tr> <td>string $msg String</td> <td>1</td> </tr> <tr> <td>array $filename_list Array of filenames</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list Array of mime types</td> <td>1</td> </tr> <tr> <td>string $msgtext Message string</td> <td>1</td> </tr> <tr> <td>array $filename_list Tableau</td> <td>1</td> </tr> <tr> <td>array $mimetype_list Tableau</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list Tableau</td> <td>1</td> </tr> <tr> <td>array $cidlist Array of CID if file must be completed with CID code</td> <td>1</td> </tr> <tr> <td>array $images_list Array of array image</td> <td>1</td> </tr> <tr> <td>string $host Add ssl:// for SSL/TLS.</td> <td>1</td> </tr> <tr> <td>int $port Example: 25, 465</td> <td>1</td> </tr> <tr> <td>resource $socket Socket</td> <td>1</td> </tr> <tr> <td>string $response Response string</td> <td>1</td> </tr> <tr> <td>string $images_dir Path to store physical images files. For example $dolibarr_main_data_root.'/medias'</td> <td>1</td> </tr> <tr> <td>string $images_dir Location of where to store physically images files. For example $dolibarr_main_data_root.'/medias'</td> <td>1</td> </tr> <tr> <td>string $address Example: 'John Doe <john@doe.com>, Alan Smith <alan@smith.com>' or 'john@doe.com, alan@smith.com'</td> <td>1</td> </tr> <tr> <td>int $format 0=auto, 1=emails with <>, 2=emails without <>, 3=auto + label between ", 4 label or email, 5 mailto link</td> <td>1</td> </tr> <tr> <td>int $encode 0=No encode name, 1=Encode name to RFC2822</td> <td>1</td> </tr> <tr> <td>int $maxnumberofemail 0=No limit. Otherwise, maximum number of emails returned ($address may contains several email separated with ','). Add '...' if there is more.</td> <td>1</td> </tr> <tr> <td>string $address Example: 'John Doe <john@doe.com>, Alan Smith <alan@smith.com>' or 'john@doe.com, alan@smith.com'</td> <td>1</td> </tr> <tr> <td>User $user User that modify</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>int $short Use short labels</td> <td>1</td> </tr> <tr> <td>int $excludedraft 0=All status, 1=Exclude draft status</td> <td>1</td> </tr> <tr> <td>int $showempty 1=Add empty line</td> <td>1</td> </tr> <tr> <td>string $mode 'customer', 'supplier'</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select field</td> <td>1</td> </tr> <tr> <td>DoliDB|null $db Database handler</td> <td>1</td> </tr> <tr> <td>string|array $selected Language pre-selected. Can be an array if $multiselect is 1.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>1</td> </tr> <tr> <td>int $showauto Show 'auto' choice</td> <td>1</td> </tr> <tr> <td>array $filter Array of keys to exclude in list (opposite of $onlykeys)</td> <td>1</td> </tr> <tr> <td>int|string $showempty '1'=Add empty value or 'string to show'</td> <td>1</td> </tr> <tr> <td>int $showwarning Show a warning if language is not complete</td> <td>1</td> </tr> <tr> <td>int $disabled Disable edit of select</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css styles</td> <td>1</td> </tr> <tr> <td>int $showcode 1=Add language code into label at beginning, 2=Add language code into label at end</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box (so no ajax beautify effect)</td> <td>1</td> </tr> <tr> <td>int $multiselect Make the combo a multiselect</td> <td>1</td> </tr> <tr> <td>array $onlykeys Array of language keys to restrict list with the following keys (opposite of $filter). Example array('fr', 'es', ...)</td> <td>1</td> </tr> <tr> <td>int $mainlangonly 1=Show only main languages ('fr_FR' no' fr_BE', 'es_ES' not 'es_MX', ...)</td> <td>1</td> </tr> <tr> <td>string $selected Preselected menu value</td> <td>1</td> </tr> <tr> <td>array $dirmenuarray Array of directories to scan</td> <td>1</td> </tr> <tr> <td>string $moreattrib More attributes on html select tag</td> <td>1</td> </tr> <tr> <td>string $selected Menu pre-selected</td> <td>1</td> </tr> <tr> <td>string[] $dirmenuarray Directories to scan</td> <td>1</td> </tr> <tr> <td>string $selected Menu pre-selectionnee</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>string $selected Paper format pre-selected</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select field</td> <td>1</td> </tr> <tr> <td>string $filter Value to filter on code</td> <td>1</td> </tr> <tr> <td>int $showempty Add empty value</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select component</td> <td>1</td> </tr> <tr> <td>string $type Type preselected</td> <td>1</td> </tr> <tr> <td>array $typewecanchangeinto Array of possible switch combination from 1 type to another one. This will grey not possible combinations.</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>int $type_user Type of user</td> <td>1</td> </tr> <tr> <td>string $forcemainmenu To force mainmenu to load</td> <td>1</td> </tr> <tr> <td>string $forceleftmenu To force leftmenu to load</td> <td>1</td> </tr> <tr> <td>string $mode 'top', 'left', 'jmobile'</td> <td>1</td> </tr> <tr> <td>array $moredata An array with more data to output</td> <td>1</td> </tr> <tr> <td>string $host database server host</td> <td>1</td> </tr> <tr> <td>string $login login</td> <td>1</td> </tr> <tr> <td>string $passwd password</td> <td>1</td> </tr> <tr> <td>string $name name of database (not used for mysql, used for pgsql)</td> <td>1</td> </tr> <tr> <td>integer $port Port of database server</td> <td>1</td> </tr> <tr> <td>int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions).</td> <td>1</td> </tr> <tr> <td>int $result_mode Result mode (not used with sqlite)</td> <td>1</td> </tr> <tr> <td>SQLite3Result $resultset Curseur de la requete voulue</td> <td>1</td> </tr> <tr> <td>SQLite3Result $resultset Curseur de la requete voulue</td> <td>1</td> </tr> <tr> <td>string $table Table name</td> <td>1</td> </tr> <tr> <td>string $field_name Field name to add</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_host Ip serveur</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_user Nom user a creer</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_pass Password user a creer</td> <td>1</td> </tr> <tr> <td>string $name Function name to define in Sqlite</td> <td>1</td> </tr> <tr> <td>int $arg_count Arguments count</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $month Month</td> <td>1</td> </tr> <tr> <td>int $day Day</td> <td>1</td> </tr> <tr> <td>int $daynr ???</td> <td>1</td> </tr> <tr> <td>bool $sunday_first_day_of_week ???</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $month Month</td> <td>1</td> </tr> <tr> <td>int $day Day</td> <td>1</td> </tr> <tr> <td>int $week_behaviour Week behaviour, bit masks: WEEK_MONDAY_FIRST, WEEK_YEAR, WEEK_FIRST_WEEKDEAY</td> <td>1</td> </tr> <tr> <td>int $calc_year ??? Year where the week started</td> <td>1</td> </tr> <tr> <td>string $test Test string (example: 'cd.statut=0', 'field IS NULL')</td> <td>1</td> </tr> <tr> <td>string $resok resultat si test equal</td> <td>1</td> </tr> <tr> <td>string $resko resultat si test non equal</td> <td>1</td> </tr> <tr> <td>string $stringtosanitize String to escape</td> <td>1</td> </tr> <tr> <td>int $allowsimplequote 1=Allow simple quotes in string. When string is used as a list of SQL string ('aa', 'bb', ...)</td> <td>1</td> </tr> <tr> <td>int $allowsequals 1=Allow equals sign</td> <td>1</td> </tr> <tr> <td>int $allowsspace 1=Allow space char</td> <td>1</td> </tr> <tr> <td>int $allowschars 1=Allow a-z chars</td> <td>1</td> </tr> <tr> <td>string $log Add more log to default log line</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order, separated by comma. Example: 'ASC,DESC'. Note: If the quantity for sortorder values is lower than sortfield, we used the last value for missing values.</td> <td>1</td> </tr> <tr> <td>string $string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)</td> <td>1</td> </tr> <tr> <td>mixed $gm 'gmt'=Input information are GMT values, 'tzserver'=Local to server TZ</td> <td>1</td> </tr> <tr> <td>string $sql The sql query string</td> <td>1</td> </tr> <tr> <td>string $sql The sql query string. Must end with "... LIMIT x"</td> <td>1</td> </tr> <tr> <td>string $line SQL request line to convert</td> <td>1</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>1</td> </tr> <tr> <td>bool $unescapeslashquot Unescape "slash quote" with "quote quote"</td> <td>1</td> </tr> <tr> <td>string $host Database server host</td> <td>1</td> </tr> <tr> <td>string $login Login</td> <td>1</td> </tr> <tr> <td>string $passwd Password</td> <td>1</td> </tr> <tr> <td>string $name Name of database (not used for mysql, used for pgsql)</td> <td>1</td> </tr> <tr> <td>integer $port Port of database server</td> <td>1</td> </tr> <tr> <td>int $result_mode Result mode (not used with pgsql)</td> <td>1</td> </tr> <tr> <td>resource $resultset Curseur de la requete voulue</td> <td>1</td> </tr> <tr> <td>resource $resultset Resulset of requests</td> <td>1</td> </tr> <tr> <td>string $test Test expression (example: 'cd.statut=0', 'field IS NULL')</td> <td>1</td> </tr> <tr> <td>string $resok Result to generate when test is True</td> <td>1</td> </tr> <tr> <td>string $resko Result to generate when test is False</td> <td>1</td> </tr> <tr> <td>string $tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec PostgreSQL</td> <td>1</td> </tr> <tr> <td>string $field_position Optionnel ex.: "after champtruc"</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_host Ip server</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_user Name of user to create</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_pass Password of user to create</td> <td>1</td> </tr> <tr> <td>string $host Database server host</td> <td>1</td> </tr> <tr> <td>string $login Login</td> <td>1</td> </tr> <tr> <td>string $passwd Password</td> <td>1</td> </tr> <tr> <td>string $name Name of database (not used for mysql, used for pgsql)</td> <td>1</td> </tr> <tr> <td>integer $port Port of database server</td> <td>1</td> </tr> <tr> <td>int $result_mode Result mode (Using 1=MYSQLI_USE_RESULT instead of 0=MYSQLI_STORE_RESULT will not buffer the result and save memory)</td> <td>1</td> </tr> <tr> <td>mysqli_result $resultset Resulset of requests</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_host Ip server or '%'</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_user Nom new user</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_pass Password for the new user</td> <td>1</td> </tr> <tr> <td>string $socket Socket</td> <td>1</td> </tr> <tr> <td>string $resok result if test is equal</td> <td>1</td> </tr> <tr> <td>string $resko result if test is not equal</td> <td>1</td> </tr> <tr> <td>int $param Date TMS to convert</td> <td>1</td> </tr> <tr> <td>string $line SQL request line to convert</td> <td>1</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>1</td> </tr> <tr> <td>mysqli_result|resource|SQLite3Result $resultset Cursor of the desired request</td> <td>1</td> </tr> <tr> <td>string $stringtoencode String to escape</td> <td>1</td> </tr> <tr> <td>string $stringtosanitize String to escape</td> <td>1</td> </tr> <tr> <td>string $tab Table name concerned by insert. Not used under MySql but required for compatibility with Postgresql</td> <td>1</td> </tr> <tr> <td>string $log Add more log to default log line</td> <td>1</td> </tr> <tr> <td>string $query SQL query string</td> <td>1</td> </tr> <tr> <td>int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).</td> <td>1</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>1</td> </tr> <tr> <td>int $result_mode Result mode</td> <td>1</td> </tr> <tr> <td>string $host Database server host</td> <td>1</td> </tr> <tr> <td>string $login Login</td> <td>1</td> </tr> <tr> <td>string $passwd Password</td> <td>1</td> </tr> <tr> <td>string $name Name of database (not used for mysql, used for pgsql)</td> <td>1</td> </tr> <tr> <td>int $port Port of database server</td> <td>1</td> </tr> <tr> <td>mysqli_result|resource|SQLite3Result $resultset Resulset of requests</td> <td>1</td> </tr> <tr> <td>string $primary_key Name of the field that will be the primary key</td> <td>1</td> </tr> <tr> <td>string $type Type of the table</td> <td>1</td> </tr> <tr> <td>array $unique_keys Associative array Name of fields that will be unique key => value</td> <td>1</td> </tr> <tr> <td>array $fulltext_keys Field name table that will be indexed in fulltext</td> <td>1</td> </tr> <tr> <td>array $keys Table of key fields names => value</td> <td>1</td> </tr> <tr> <td>string $field_position Optional ex .: "after field stuff"</td> <td>1</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Array with description of field format</td> <td>1</td> </tr> <tr> <td>string $field Optional : Name of field if we want description of field</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_host Server IP</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_user Username to create</td> <td>1</td> </tr> <tr> <td>string $dolibarr_main_db_pass User password to create</td> <td>1</td> </tr> <tr> <td>resource|mysqli_result|SQLite3Result $resultset Free cursor</td> <td>1</td> </tr> <tr> <td>mysqli_result|resource|PgSql\Connection|SQLite3Result $resultset Handler of the desired request</td> <td>1</td> </tr> <tr> <td>string $database Name of database</td> <td>1</td> </tr> <tr> <td>array $array_sql SQL requests to be executed when enabling module</td> <td>1</td> </tr> <tr> <td>string $options String with options when disabling module:</td> <td>1</td> </tr> <tr> <td>string[] $array_sql SQL requests to be executed when module is disabled</td> <td>1</td> </tr> <tr> <td>string $options Options when disabling module:</td> <td>1</td> </tr> <tr> <td>int $translated 1=Special version keys are translated, 0=Special version keys are not translated</td> <td>1</td> </tr> <tr> <td>string $reldir Relative directory where to scan files. Example: '/install/mysql/' or '/module/sql/'</td> <td>1</td> </tr> <tr> <td>string $onlywithsuffix Only with the defined suffix</td> <td>1</td> </tr> <tr> <td>string $option Options when disabling module ('newboxdefonly'=insert only boxes definition)</td> <td>1</td> </tr> <tr> <td>int $reinitadminperms If 1, we also grant them to all admin users</td> <td>1</td> </tr> <tr> <td>int $force_entity Force current entity</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>string $name Name</td> <td>1</td> </tr> <tr> <td>string $dir Directory</td> <td>1</td> </tr> <tr> <td>string $options Options when enabling module ('', 'newboxdefonly', 'noboxes', 'menuonly')</td> <td>1</td> </tr> <tr> <td>string $codeenabledisable HTML code for button to enable/disable module</td> <td>1</td> </tr> <tr> <td>string $codetoconfig HTML code to go to config page</td> <td>1</td> </tr> <tr> <td>array $dictionaryArray Array describing one dictionary. Keys are:</td> <td>1</td> </tr> <tr> <td>string $langs Optional translation file to include (appears to be unused)</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $options Options when enabling module ('', 'noboxes')</td> <td>1</td> </tr> <tr> <td>string $sql Sql request to count</td> <td>1</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>1</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>1</td> </tr> <tr> <td>array $cibles Array with targets</td> <td>1</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>1</td> </tr> <tr> <td>array $forcedir null=All default directories. This parameter is used by modulebuilder module only.</td> <td>1</td> </tr> <tr> <td>string $sql Sql request to count</td> <td>1</td> </tr> <tr> <td>string $sql Sql request to count</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $sql Requete sql de comptage</td> <td>1</td> </tr> <tr> <td>int $id ID</td> <td>1</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>1</td> </tr> <tr> <td>string $sql Requete sql de comptage</td> <td>1</td> </tr> <tr> <td>array $socid Array of id soc to add</td> <td>1</td> </tr> <tr> <td>int $type_of_target Defined in advtargetemailing.class.php</td> <td>1</td> </tr> <tr> <td>array $contactid Array of contact id to add</td> <td>1</td> </tr> <tr> <td>string $type type</td> <td>1</td> </tr> <tr> <td>Expedition $object Object expedition to generate (or id if old method)</td> <td>1</td> </tr> <tr> <td>Expedition $object Object expedition</td> <td>1</td> </tr> <tr> <td>int $posy Start Position</td> <td>1</td> </tr> <tr> <td>Expedition $object common object</td> <td>1</td> </tr> <tr> <td>Expedition $object Object source to build document</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>Expedition $object Object invoice</td> <td>1</td> </tr> <tr> <td>PaiementFourn $object Id of object to generate</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>PaiementFourn $object Object PaiementFourn</td> <td>1</td> </tr> <tr> <td>integer $tab_top Top position of table</td> <td>1</td> </tr> <tr> <td>integer $tab_height Height of table (rectangle)</td> <td>1</td> </tr> <tr> <td>PaiementFourn $object Object to show</td> <td>1</td> </tr> <tr> <td>PaiementFourn $object Object to show</td> <td>1</td> </tr> <tr> <td>Holiday $holiday holiday object</td> <td>1</td> </tr> <tr> <td>Holiday $holiday Holiday object</td> <td>1</td> </tr> <tr> <td>Contrat $contract Object contract</td> <td>1</td> </tr> <tr> <td>int $type 0 = product , 1 = service</td> <td>1</td> </tr> <tr> <td>Contrat $object Object source to build document</td> <td>1</td> </tr> <tr> <td>Contrat $object Object to generate</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>int $tab_top tab height position</td> <td>1</td> </tr> <tr> <td>int $tab_height tab height</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object language for output</td> <td>1</td> </tr> <tr> <td>Contrat $object Object to show</td> <td>1</td> </tr> <tr> <td>Contrat $object Object to show</td> <td>1</td> </tr> <tr> <td>integer $maxfilenamelength Max length of value to show</td> <td>1</td> </tr> <tr> <td>mixed $montant amount</td> <td>1</td> </tr> <tr> <td>mixed $devise1 devise 1 ex: euro</td> <td>1</td> </tr> <tr> <td>mixed $devise2 devise 2 ex: centimes</td> <td>1</td> </tr> <tr> <td>string $path Path for the file</td> <td>1</td> </tr> <tr> <td>string $contents Contents of the file</td> <td>1</td> </tr> <tr> <td>array $content Array containing the info about the message</td> <td>1</td> </tr> <tr> <td>int $ident 1=Increase ident of 1, -1=Decrease ident of 1</td> <td>1</td> </tr> <tr> <td>Product $objprod Object product</td> <td>1</td> </tr> <tr> <td>Bom $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>Bom $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>BOM $object Object source to build document</td> <td>1</td> </tr> <tr> <td>UserGroup $object Object source to build document</td> <td>1</td> </tr> <tr> <td>int|float $tab_top Top position of table</td> <td>1</td> </tr> <tr> <td>int|float $tab_height Height of table (rectangle)</td> <td>1</td> </tr> <tr> <td>Asset $object Object source to build document</td> <td>1</td> </tr> <tr> <td>Commande $object Object invoice</td> <td>1</td> </tr> <tr> <td>Commande $object Object to show</td> <td>1</td> </tr> <tr> <td>Commande $object common object</td> <td>1</td> </tr> <tr> <td>Account $object Object to show</td> <td>1</td> </tr> <tr> <td>Account $object Object to show</td> <td>1</td> </tr> <tr> <td>Account $object CompanyBankAccount bank account to generate document for</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>1</td> </tr> <tr> <td>int $hidedetails Do not show line details (not used for this template)</td> <td>1</td> </tr> <tr> <td>int $hidedesc Do not show desc (not used for this template)</td> <td>1</td> </tr> <tr> <td>int $hideref Do not show ref (not used for this template)</td> <td>1</td> </tr> <tr> <td>null|array $moreparams More parameters</td> <td>1</td> </tr> <tr> <td>CompanyBankAccount $object Object to show</td> <td>1</td> </tr> <tr> <td>int $posy Y</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>CompanyBankAccount $object Object invoice</td> <td>1</td> </tr> <tr> <td>CompanyBankAccount $object Object to show</td> <td>1</td> </tr> <tr> <td>int $showaddress 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>1</td> </tr> <tr> <td>CompanyBankAccount $object Object to show</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>1</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text</td> <td>1</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>1</td> </tr> <tr> <td>Facture $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>1</td> </tr> <tr> <td>Facture $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>1</td> </tr> <tr> <td>Facture $object Invoice object</td> <td>1</td> </tr> <tr> <td>Translate $langs Translation object</td> <td>1</td> </tr> <tr> <td>int $pagenbr Page number</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf TCPDF object</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>Facture $object Object invoice</td> <td>1</td> </tr> <tr> <td>int $posy Position y in PDF</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>Facture $object Object invoice</td> <td>1</td> </tr> <tr> <td>int $default_font_size Font size</td> <td>1</td> </tr> <tr> <td>int $tab3_posx pos x</td> <td>1</td> </tr> <tr> <td>int $tab3_top pos y</td> <td>1</td> </tr> <tr> <td>int $tab3_width width</td> <td>1</td> </tr> <tr> <td>int $tab3_height height</td> <td>1</td> </tr> <tr> <td>Facture $object Object source to build document</td> <td>1</td> </tr> <tr> <td>int $showaddress 0=no, 1=yes (usually set to 1 for first page, and 0 for next pages)</td> <td>1</td> </tr> <tr> <td>Facture $object common object</td> <td>1</td> </tr> <tr> <td>RemiseCheque $object Object RemiseCheque</td> <td>1</td> </tr> <tr> <td>string $_dir Directory</td> <td>1</td> </tr> <tr> <td>string $number Number</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Pdf object</td> <td>1</td> </tr> <tr> <td>int $page Current page number</td> <td>1</td> </tr> <tr> <td>int $pages Total number of pages</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object language for output</td> <td>1</td> </tr> <tr> <td>int $pages Pages</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>Propal $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>Propal $object object proposal</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs langs</td> <td>1</td> </tr> <tr> <td>Propal $object Object propal</td> <td>1</td> </tr> <tr> <td>int $posy Start position</td> <td>1</td> </tr> <tr> <td>Propal $object Object invoice</td> <td>1</td> </tr> <tr> <td>MO $object Object source to build document</td> <td>1</td> </tr> <tr> <td>Mo $object Id of object to generate</td> <td>1</td> </tr> <tr> <td>Mo $object Object order</td> <td>1</td> </tr> <tr> <td>Mo $object Object to show</td> <td>1</td> </tr> <tr> <td>Mo $object Object to show</td> <td>1</td> </tr> <tr> <td>Mo $object Object to show</td> <td>1</td> </tr> <tr> <td>Mo $object common object</td> <td>1</td> </tr> <tr> <td>integer $maxfilenamelength Max length of value to show</td> <td>1</td> </tr> <tr> <td>Adherent $object Object source to build document</td> <td>1</td> </tr> <tr> <td>string $mode Tell if doc module is called for 'member', ...</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=Generate only file on disk and do not return it on response</td> <td>1</td> </tr> <tr> <td>string $filename Name of output file (without extension)</td> <td>1</td> </tr> <tr> <td>CommonObject $object member</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>1</td> </tr> <tr> <td>int $idmember Id member</td> <td>1</td> </tr> <tr> <td>string $photo Photo (full path to image file used as replacement for key __PHOTOS__ into left, right, header or footer text)</td> <td>1</td> </tr> <tr> <td>Adherent|array $object Member object. Old usage: Array of record information (array('textleft'=>,'textheader'=>, ...'id'=>,'photo'=>)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang object for output language</td> <td>1</td> </tr> <tr> <td>string $srctemplatepath Full path of source filename for generator using a template file. Example: '5161', 'AVERYC32010', 'CARD', ...</td> <td>1</td> </tr> <tr> <td>string $mode Tell if doc module is called for 'member', ...</td> <td>1</td> </tr> <tr> <td>int $nooutput 1=Generate only file on disk and do not return it on response</td> <td>1</td> </tr> <tr> <td>string $filename Name of output file (without extension)</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object thirdparty</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>string $subdir subdirectory of document like for expedition subdir is sendings</td> <td>1</td> </tr> <tr> <td>string $uri URI</td> <td>1</td> </tr> <tr> <td>string $subdir subdir for file</td> <td>1</td> </tr> <tr> <td>string $printerid Printer id returned by Google Cloud Print</td> <td>1</td> </tr> <tr> <td>string $printjobtitle Job Title</td> <td>1</td> </tr> <tr> <td>string $filepath File Path to be send to Google Cloud Print</td> <td>1</td> </tr> <tr> <td>string $contenttype File content type by example application/pdf, image/png</td> <td>1</td> </tr> <tr> <td>int $maxfilenamelength Max length of value to show</td> <td>1</td> </tr> <tr> <td>ExpenseReport $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>ExpenseReport $object Object to show</td> <td>1</td> </tr> <tr> <td>ExpenseReport $object Object to show</td> <td>1</td> </tr> <tr> <td>string $code Code of third party</td> <td>1</td> </tr> <tr> <td>int $type Client ou fournisseur (0:customer, 1:supplier)</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database object</td> <td>1</td> </tr> <tr> <td>Societe $societe Third party object</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>Societe $societe Third party object</td> <td>1</td> </tr> <tr> <td>string $type 'customer' or 'supplier'</td> <td>1</td> </tr> <tr> <td>string $code Code of third party</td> <td>1</td> </tr> <tr> <td>Societe $societe Object third party</td> <td>1</td> </tr> <tr> <td>string $type 'supplier' or 'customer'</td> <td>1</td> </tr> <tr> <td>int $type Client ou fournisseur (1:client, 2:fournisseur)</td> <td>1</td> </tr> <tr> <td>string $code Code a verifier</td> <td>1</td> </tr> <tr> <td>Translate $langs Object language</td> <td>1</td> </tr> <tr> <td>Societe $object Object source to build document</td> <td>1</td> </tr> <tr> <td>Product $objproduct Object product</td> <td>1</td> </tr> <tr> <td>int $type Type of third party (1:customer, 2:supplier, -1:autodetect)</td> <td>1</td> </tr> <tr> <td>Product $objproduct Object product</td> <td>1</td> </tr> <tr> <td>int $type Produit ou service (0:product, 1:service)</td> <td>1</td> </tr> <tr> <td>Product $product Object product</td> <td>1</td> </tr> <tr> <td>Product $object Object source to build document</td> <td>1</td> </tr> <tr> <td>SupplierProposal $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>SupplierProposal $object Object to generate</td> <td>1</td> </tr> <tr> <td>Object $object Object proposal</td> <td>1</td> </tr> <tr> <td>int|float $posy Y</td> <td>1</td> </tr> <tr> <td>SupplierProposal $object Id of object to generate</td> <td>1</td> </tr> <tr> <td>SupplierProposal $object Object supplier propsal</td> <td>1</td> </tr> <tr> <td>SupplierProposal $object Object to show</td> <td>1</td> </tr> <tr> <td>int|float $posy Y</td> <td>1</td> </tr> <tr> <td>Object $object common object</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Third party object</td> <td>1</td> </tr> <tr> <td>Reception|null $reception Reception object</td> <td>1</td> </tr> <tr> <td>Reception $reception Reception object</td> <td>1</td> </tr> <tr> <td>Reception $object Object source to build document</td> <td>1</td> </tr> <tr> <td>Reception $object Object reception to generate (or id if old method)</td> <td>1</td> </tr> <tr> <td>Reception $object Object reception</td> <td>1</td> </tr> <tr> <td>int $totalOrdered Total ordered</td> <td>1</td> </tr> <tr> <td>int $totalAmount Total amount</td> <td>1</td> </tr> <tr> <td>Object|NULL $object Object reception to generate</td> <td>1</td> </tr> <tr> <td>Reception $object Object to show</td> <td>1</td> </tr> <tr> <td>Project $project Object project</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>Project $project Object project</td> <td>1</td> </tr> <tr> <td>Task|string $object Object task</td> <td>1</td> </tr> <tr> <td>Task|string $object Object Task</td> <td>1</td> </tr> <tr> <td>array $taskresource Resource array</td> <td>1</td> </tr> <tr> <td>array $tasktime times object</td> <td>1</td> </tr> <tr> <td>Commande $object Object source to build document</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>1</td> </tr> <tr> <td>Project $object Object to show</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>1</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text</td> <td>1</td> </tr> <tr> <td>array $taskresource Reference array</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang object to use for output</td> <td>1</td> </tr> <tr> <td>array $tasktime Array of times object</td> <td>1</td> </tr> <tr> <td>Project $object Object source to build document</td> <td>1</td> </tr> <tr> <td>int $socid Thirdparty id</td> <td>1</td> </tr> <tr> <td>int $month Month</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object pdf</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs</td> <td>1</td> </tr> <tr> <td>Fichinter $object Object to generate</td> <td>1</td> </tr> <tr> <td>?Fichinter $object FichInter Object</td> <td>1</td> </tr> <tr> <td>Fichinter $object Object to show</td> <td>1</td> </tr> <tr> <td>Fichinter $object Object to show</td> <td>1</td> </tr> <tr> <td>StockTransfer $object Object StockTransfer to generate (or id if old method)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>StockTransfer $object Object invoice</td> <td>1</td> </tr> <tr> <td>int $deja_regle Montant deja regle</td> <td>1</td> </tr> <tr> <td>StockTransfer $object Stock Transfer object</td> <td>1</td> </tr> <tr> <td>StockTransfer $object Object to show</td> <td>1</td> </tr> <tr> <td>StockTransfer $object Object to show</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $object Object to generate</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $object Object invoice</td> <td>1</td> </tr> <tr> <td>int $deja_regle Amount already paid (in the currency of invoice)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>Object $object Object to show</td> <td>1</td> </tr> <tr> <td>int $posy Position y in PDF</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $object Object to show</td> <td>1</td> </tr> <tr> <td>int $showaddress 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $object Object to show</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>1</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text</td> <td>1</td> </tr> <tr> <td>Delivery $object Object delivery</td> <td>1</td> </tr> <tr> <td>Delivery $objforref Object for number to search</td> <td>1</td> </tr> <tr> <td>Delivery $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>Delivery $object common object</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>Ticket $ticket Object ticket</td> <td>1</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>1</td> </tr> <tr> <td>Ticket $ticket Object ticket</td> <td>1</td> </tr> <tr> <td>string $photo Photo (full path to image file used as replacement for key %PHOTOS% into left, right, header or footer text)</td> <td>1</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>1</td> </tr> <tr> <td>string $code code to print</td> <td>1</td> </tr> <tr> <td>string $encoding type of barcode</td> <td>1</td> </tr> <tr> <td>boolean $is2d true if 2d barcode</td> <td>1</td> </tr> <tr> <td>int $x x position in user units</td> <td>1</td> </tr> <tr> <td>int $y y position in user units</td> <td>1</td> </tr> <tr> <td>int $w width in user units</td> <td>1</td> </tr> <tr> <td>int $h height in user units</td> <td>1</td> </tr> <tr> <td>string $file File name to generate</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang to translate values</td> <td>1</td> </tr> <tr> <td>int $c Column position</td> <td>1</td> </tr> <tr> <td>string $val cell value</td> <td>1</td> </tr> <tr> <td>string $endCell ending cell</td> <td>1</td> </tr> <tr> <td>string $thickness style \PhpOffice\PhpSpreadsheet\Style\Border</td> <td>1</td> </tr> <tr> <td>string $color color \PhpOffice\PhpSpreadsheet\Style\Color</td> <td>1</td> </tr> <tr> <td>bool $bold true if bold</td> <td>1</td> </tr> <tr> <td>string $color color \PhpOffice\PhpSpreadsheet\Style\Color</td> <td>1</td> </tr> <tr> <td>string $horizontal PhpOffice\PhpSpreadsheet\Style\Alignment</td> <td>1</td> </tr> <tr> <td>array $TDatas array(ColumnName=>array(Row value 1, row value 2, etc ...))</td> <td>1</td> </tr> <tr> <td>bool $boldTitle true if bold headers</td> <td>1</td> </tr> <tr> <td>string $startCell A1</td> <td>1</td> </tr> <tr> <td>array $TDatas array(Title=>val)</td> <td>1</td> </tr> <tr> <td>bool $boldTitle true if bold titles</td> <td>1</td> </tr> <tr> <td>string $firstColumn first column to autosize</td> <td>1</td> </tr> <tr> <td>string $lastColumn to last column to autosize</td> <td>1</td> </tr> <tr> <td>string $val Cell value</td> <td>1</td> </tr> <tr> <td>string $startCell Starting cell</td> <td>1</td> </tr> <tr> <td>int $length Length</td> <td>1</td> </tr> <tr> <td>int $offset Starting offset</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>integer $maxfilenamelength Max length of value to show</td> <td>1</td> </tr> <tr> <td>Entrepot $object Object source to build document</td> <td>1</td> </tr> <tr> <td>?CommonObject $objcommon Object Product, Thirdparty</td> <td>1</td> </tr> <tr> <td>string $type Type of barcode (EAN, ISBN, ...)</td> <td>1</td> </tr> <tr> <td>int $type -1=Nothing, 0=Product, 1=Service</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>?Societe $objthirdparty Object third-party</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database</td> <td>1</td> </tr> <tr> <td>int $type Type of barcode (EAN, ISBN, ...) as rowid</td> <td>1</td> </tr> <tr> <td>?CommonObject $objthirdparty Object third-party</td> <td>1</td> </tr> <tr> <td>string $type Type of barcode (EAN, ISBN, ...)</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Object third-party</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Object third-party</td> <td>1</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>1</td> </tr> <tr> <td>?Product $objproduct Object product</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database</td> <td>1</td> </tr> <tr> <td>int $type Type of barcode (EAN, ISBN, ...) as rowid</td> <td>1</td> </tr> <tr> <td>?CommonObject $objproduct Object product (not used)</td> <td>1</td> </tr> <tr> <td>string $type Type of barcode (EAN, ISBN, ...)</td> <td>1</td> </tr> <tr> <td>Product $product Object product</td> <td>1</td> </tr> <tr> <td>string $encoding Mode of encoding</td> <td>1</td> </tr> <tr> <td>string $readable Code can be read (What is this ? is this used ?)</td> <td>1</td> </tr> <tr> <td>string $encoding Mode of encoding</td> <td>1</td> </tr> <tr> <td>string $readable Code can be read</td> <td>1</td> </tr> <tr> <td>string $encoding Mode of encoding</td> <td>1</td> </tr> <tr> <td>string $readable Code can be read (What is this ? is this used ?)</td> <td>1</td> </tr> <tr> <td>string $encoding Mode of encoding ('QRCODE', 'EAN13', ...)</td> <td>1</td> </tr> <tr> <td>string $readable Code can be read</td> <td>1</td> </tr> <tr> <td>string $dolEncodingType dolibarr barcode encoding type</td> <td>1</td> </tr> <tr> <td>string $tableNameWithPrefix Table name with prefix</td> <td>1</td> </tr> <tr> <td>string $_dir repertoire</td> <td>1</td> </tr> <tr> <td>int $month mois du rapport</td> <td>1</td> </tr> <tr> <td>int $year annee du rapport</td> <td>1</td> </tr> <tr> <td>string $outputlangs Lang output object</td> <td>1</td> </tr> <tr> <td>int $page Object to show</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>array $lines Array of lines</td> <td>1</td> </tr> <tr> <td>int $max Maximum number of records to load</td> <td>1</td> </tr> <tr> <td>int $cachedelay Delay we accept for cache file</td> <td>1</td> </tr> <tr> <td>array $head Array with properties of box title</td> <td>1</td> </tr> <tr> <td>array $contents Array with properties of box lines</td> <td>1</td> </tr> <tr> <td>int $nooutput No print, only return string</td> <td>1</td> </tr> <tr> <td>int $nooutput No $stringtoprint .=, only return string</td> <td>1</td> </tr> <tr> <td>string $param More parameters</td> <td>1</td> </tr> <tr> <td>int $rowid Row id to load</td> <td>1</td> </tr> <tr> <td>array{text?:string,sublink?:string,subpicto:?string,nbcol?:int,limit?:int,subclass?:string,graph?:string} $head Array with properties of box title</td> <td>1</td> </tr> <tr> <td>array<array<array{tr?:string,td?:string,target?:string,text?:string,text2?:string,textnoformat?:string,tooltip?:string,logo?:string,url?:string,maxlength?:string}>> $contents Array with properties of box lines</td> <td>1</td> </tr> <tr> <td>?string[] $forcedirwidget null=All default directories. This parameter is used by modulebuilder module only.</td> <td>1</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>string $mode Depreciation mode (economic, accelerated_depreciation, ...)</td> <td>1</td> </tr> <tr> <td>string $ref Ref line</td> <td>1</td> </tr> <tr> <td>int $depreciation_date Depreciation date</td> <td>1</td> </tr> <tr> <td>double $depreciation_ht Depreciation amount HT</td> <td>1</td> </tr> <tr> <td>double $cumulative_depreciation_ht Depreciation cumulative amount HT</td> <td>1</td> </tr> <tr> <td>string $accountancy_code_debit Accountancy code Debit</td> <td>1</td> </tr> <tr> <td>string $accountancy_code_credit Accountancy code Credit</td> <td>1</td> </tr> <tr> <td>int $asset_depreciation_id Asset depreciation line ID</td> <td>1</td> </tr> <tr> <td>User $user Object user that dispose</td> <td>1</td> </tr> <tr> <td>int $disposal_invoice_id Disposal invoice ID</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>string $mode Depreciation mode (economic, accelerated_depreciation, ...)</td> <td>1</td> </tr> <tr> <td>int $class_type Type (0:asset, 1:asset model)</td> <td>1</td> </tr> <tr> <td>bool $all_field Get all fields</td> <td>1</td> </tr> <tr> <td>int $class_type Type (0:asset, 1:asset model)</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $id ID of supplier invoice</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter invoices of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>array $request_data Request datas</td> <td>1</td> </tr> <tr> <td>int $id Id of supplier invoice to update</td> <td>1</td> </tr> <tr> <td>int $id Supplier invoice ID</td> <td>1</td> </tr> <tr> <td>int $id Invoice ID</td> <td>1</td> </tr> <tr> <td>int $id Id of SupplierInvoice</td> <td>1</td> </tr> <tr> <td>int $datepaye {@from body} Payment date {@type timestamp}</td> <td>1</td> </tr> <tr> <td>int $payment_mode_id {@from body} Payment mode ID (look it up via REST GET to /setup/dictionary/payment_types) {@min 1}</td> <td>1</td> </tr> <tr> <td>int $accountid {@from body} Bank account ID (look it up via REST GET to /bankaccounts) {@min 1}</td> <td>1</td> </tr> <tr> <td>string $comment {@from body} Note (optional)</td> <td>1</td> </tr> <tr> <td>string $chqemetteur {@from body} Payment issuer (mandatory if payment_mode_id corresponds to 'CHQ'-payment type)</td> <td>1</td> </tr> <tr> <td>float $amount {@from body} Amount of payment if we don't want to use the remain to pay</td> <td>1</td> </tr> <tr> <td>array $request_data supplier invoice line data</td> <td>1</td> </tr> <tr> <td>int $id Id of order to load</td> <td>1</td> </tr> <tr> <td>User $user Validator User</td> <td>1</td> </tr> <tr> <td>int $billed 1=Billed</td> <td>1</td> </tr> <tr> <td>string $option On what the link points</td> <td>1</td> </tr> <tr> <td>Societe $soc company object</td> <td>1</td> </tr> <tr> <td>User $user Object user making the change</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Id of warhouse for stock change</td> <td>1</td> </tr> <tr> <td>int $secondlevel 0=Standard approval, 1=Second level approval (used when option SUPPLIER_ORDER_3_STEPS_TO_BE_APPROVED is set)</td> <td>1</td> </tr> <tr> <td>User $user User making action</td> <td>1</td> </tr> <tr> <td>User $user User making action</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Id warehouse to use for stock change (not used for supplier orders).</td> <td>1</td> </tr> <tr> <td>integer $date Date</td> <td>1</td> </tr> <tr> <td>int $methode Method</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>1</td> </tr> <tr> <td>string $desc Description</td> <td>1</td> </tr> <tr> <td>float $pu_ht Unit price (used if $price_base_type is 'HT')</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float $txtva VAT Rate</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Localtax1 tax</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Localtax2 tax</td> <td>1</td> </tr> <tr> <td>int $fk_product Id product</td> <td>1</td> </tr> <tr> <td>int $fk_prod_fourn_price Id supplier price</td> <td>1</td> </tr> <tr> <td>string $ref_supplier Supplier reference price</td> <td>1</td> </tr> <tr> <td>float $remise_percent Remise</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>float $pu_ttc Unit price TTC (used if $price_base_type is 'TTC')</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $info_bits More information</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>int $date_start Date start of service</td> <td>1</td> </tr> <tr> <td>int $date_end Date end of service</td> <td>1</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>1</td> </tr> <tr> <td>int|null $fk_unit Code of the unit to use. Null to use the default one</td> <td>1</td> </tr> <tr> <td>int|string $pu_ht_devise Amount in currency</td> <td>1</td> </tr> <tr> <td>string $origin 'order', ...</td> <td>1</td> </tr> <tr> <td>int $origin_id Id of origin object</td> <td>1</td> </tr> <tr> <td>int $rang Rank</td> <td>1</td> </tr> <tr> <td>int $special_code Special code</td> <td>1</td> </tr> <tr> <td>User $user User object making change</td> <td>1</td> </tr> <tr> <td>int $product Id of product to dispatch</td> <td>1</td> </tr> <tr> <td>double $qty Qty to dispatch</td> <td>1</td> </tr> <tr> <td>int $entrepot Id of warehouse to add product</td> <td>1</td> </tr> <tr> <td>double $price Unit Price for PMP value calculation (Unit price without Tax and taking into account discount)</td> <td>1</td> </tr> <tr> <td>string $comment Comment for stock movement</td> <td>1</td> </tr> <tr> <td>int|string $eatby eat-by date</td> <td>1</td> </tr> <tr> <td>int|string $sellby sell-by date</td> <td>1</td> </tr> <tr> <td>string $batch Lot number</td> <td>1</td> </tr> <tr> <td>int $fk_commandefourndet Id of supplier order line</td> <td>1</td> </tr> <tr> <td>int $notrigger 1 = notrigger</td> <td>1</td> </tr> <tr> <td>int $fk_reception Id of reception to link</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Disable call to triggers</td> <td>1</td> </tr> <tr> <td>int $status Filter on stats (-1 = no filter, 0 = lines draft to be approved, 1 = approved lines)</td> <td>1</td> </tr> <tr> <td>User $user User that input data</td> <td>1</td> </tr> <tr> <td>integer $date Date of reception</td> <td>1</td> </tr> <tr> <td>string $type Type of receipt ('tot' = total/done, 'par' = partial, 'nev' = never, 'can' = cancel)</td> <td>1</td> </tr> <tr> <td>User $user Object user making change</td> <td>1</td> </tr> <tr> <td>integer $delivery_date Planned delivery date</td> <td>1</td> </tr> <tr> <td>int $id_projet Delivery date</td> <td>1</td> </tr> <tr> <td>User $user User that create</td> <td>1</td> </tr> <tr> <td>int $idc Id of purchase order to update</td> <td>1</td> </tr> <tr> <td>int $comclientid Id of sale order to use as template</td> <td>1</td> </tr> <tr> <td>int $status New status</td> <td>1</td> </tr> <tr> <td>int $rowid ID de la ligne de facture</td> <td>1</td> </tr> <tr> <td>string $desc Line description</td> <td>1</td> </tr> <tr> <td>int|float $pu Unit price</td> <td>1</td> </tr> <tr> <td>int|float $qty Quantity</td> <td>1</td> </tr> <tr> <td>int|float $remise_percent Percent discount on line</td> <td>1</td> </tr> <tr> <td>int|float $txtva VAT rate</td> <td>1</td> </tr> <tr> <td>int|float $txlocaltax1 Localtax1 tax</td> <td>1</td> </tr> <tr> <td>int|float $txlocaltax2 Localtax2 tax</td> <td>1</td> </tr> <tr> <td>string $price_base_type Type of price base</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information</td> <td>1</td> </tr> <tr> <td>integer $date_start Date start of service</td> <td>1</td> </tr> <tr> <td>integer $date_end Date end of service</td> <td>1</td> </tr> <tr> <td>array $array_options Extrafields array</td> <td>1</td> </tr> <tr> <td>int|float $pu_ht_devise Unit price in currency</td> <td>1</td> </tr> <tr> <td>string $mode "opened", "awaiting" for orders awaiting reception</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object lang to use for traduction</td> <td>1</td> </tr> <tr> <td>Translate $langs Language object</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>int $origin_id Old product id</td> <td>1</td> </tr> <tr> <td>int $dest_id New product id</td> <td>1</td> </tr> <tr> <td>User $user User action</td> <td>1</td> </tr> <tr> <td>int $closeopenorder Close if received</td> <td>1</td> </tr> <tr> <td>string $comment Comment</td> <td>1</td> </tr> <tr> <td>int $rowid Id line order</td> <td>1</td> </tr> <tr> <td>User $user User making the change</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Disable call to triggers</td> <td>1</td> </tr> <tr> <td>int $id Id if payment to get</td> <td>1</td> </tr> <tr> <td>string $ref Ref of payment to get</td> <td>1</td> </tr> <tr> <td>User $user Object of creating user</td> <td>1</td> </tr> <tr> <td>int $closepaidinvoices 1=Also close paid invoices to paid, 0=Do nothing more</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Thirdparty</td> <td>1</td> </tr> <tr> <td>int $id Id du paiement don't il faut afficher les infos</td> <td>1</td> </tr> <tr> <td>string $filter SQL filter. Warning: This value must not come from a user input.</td> <td>1</td> </tr> <tr> <td>User $user user object that creates</td> <td>1</td> </tr> <tr> <td>int $id Id supplier invoice</td> <td>1</td> </tr> <tr> <td>string $ref Ref supplier invoice</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of invoice</td> <td>1</td> </tr> <tr> <td>User $user User that modify</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>string $force_number Reference to force on invoice</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Id of warehouse for stock change</td> <td>1</td> </tr> <tr> <td>string $desc Description of the line</td> <td>1</td> </tr> <tr> <td>double $pu Unit price (HT or TTC according to price_base_type, > 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>double $txtva Force Vat rate to use, -1 for auto.</td> <td>1</td> </tr> <tr> <td>double $txlocaltax1 LocalTax1 Rate</td> <td>1</td> </tr> <tr> <td>double $txlocaltax2 LocalTax2 Rate</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $fk_product Product/Service ID predefined</td> <td>1</td> </tr> <tr> <td>double $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>int $date_start Service start date</td> <td>1</td> </tr> <tr> <td>int $date_end Service expiry date</td> <td>1</td> </tr> <tr> <td>int $fk_code_ventilation Accounting breakdown code</td> <td>1</td> </tr> <tr> <td>int $info_bits Line type bits</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $rang Position of line</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>1</td> </tr> <tr> <td>int|null $fk_unit Code of the unit to use. Null to use the default one</td> <td>1</td> </tr> <tr> <td>int $origin_id id origin document</td> <td>1</td> </tr> <tr> <td>double $pu_devise Amount in currency</td> <td>1</td> </tr> <tr> <td>string $ref_supplier Supplier ref</td> <td>1</td> </tr> <tr> <td>int $special_code Special code</td> <td>1</td> </tr> <tr> <td>int $fk_parent_line Parent line id</td> <td>1</td> </tr> <tr> <td>int $fk_remise_except Id discount used</td> <td>1</td> </tr> <tr> <td>int $id Id of line invoice</td> <td>1</td> </tr> <tr> <td>string $desc Description of line</td> <td>1</td> </tr> <tr> <td>double $pu Prix unitaire (HT ou TTC selon price_base_type)</td> <td>1</td> </tr> <tr> <td>double $vatrate VAT Rate (Can be '8.5', '8.5 (ABC)')</td> <td>1</td> </tr> <tr> <td>double $txlocaltax1 LocalTax1 Rate</td> <td>1</td> </tr> <tr> <td>double $txlocaltax2 LocalTax2 Rate</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $idproduct Id produit</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information of line</td> <td>1</td> </tr> <tr> <td>int|string $date_start Date start of service</td> <td>1</td> </tr> <tr> <td>int|string $date_end Date end of service</td> <td>1</td> </tr> <tr> <td>double $pu_devise Amount in currency</td> <td>1</td> </tr> <tr> <td>int $rang Line rank</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line to delete</td> <td>1</td> </tr> <tr> <td>int $id Id of the invoice to load</td> <td>1</td> </tr> <tr> <td>array{moretitle?:string} $params ex option, infologin</td> <td>1</td> </tr> <tr> <td>string $option Where point the link</td> <td>1</td> </tr> <tr> <td>?array<string,mixed> $moreparams Array to provide more information</td> <td>1</td> </tr> <tr> <td>?array{selected?:int<0,1>} $arraydata Array of data</td> <td>1</td> </tr> <tr> <td>int $vatreversecharge 0 = Off, 1 = On</td> <td>1</td> </tr> <tr> <td>int|string $template Name (or id) of email template (Must be a template of type 'invoice_supplier_send')</td> <td>1</td> </tr> <tr> <td>int $rowid Line id</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=execute triggers</td> <td>1</td> </tr> <tr> <td>int $notrigger 1 no triggers</td> <td>1</td> </tr> <tr> <td>int $noerrorifdiscountalreadylinked 1=Do not make error if lines is linked to a discount and discount already linked to another</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>int $facFournId Id invoice</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>1</td> </tr> <tr> <td>int $fk_product Product/Service ID predefined</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>string $label Label</td> <td>1</td> </tr> <tr> <td>string $desc Description de la ligne</td> <td>1</td> </tr> <tr> <td>double $pu_ht Unit price</td> <td>1</td> </tr> <tr> <td>double $pu_ttc Unit price with tax</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>double $txtva Taux de tva force, sinon -1</td> <td>1</td> </tr> <tr> <td>int $txlocaltax1 Local tax 1 rate (deprecated)</td> <td>1</td> </tr> <tr> <td>int $txlocaltax2 Local tax 2 rate (deprecated)</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $date_start Date start</td> <td>1</td> </tr> <tr> <td>int $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $info_bits VAT npr or not ?</td> <td>1</td> </tr> <tr> <td>int $special_code Special code</td> <td>1</td> </tr> <tr> <td>int $rang Position of line</td> <td>1</td> </tr> <tr> <td>string $fk_unit Unit</td> <td>1</td> </tr> <tr> <td>int $pu_ht_devise Unit price in currency</td> <td>1</td> </tr> <tr> <td>int $rowid ID</td> <td>1</td> </tr> <tr> <td>int $fk_product Product/Service ID predefined</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>string $label Label of the line</td> <td>1</td> </tr> <tr> <td>string $desc Description de la ligne</td> <td>1</td> </tr> <tr> <td>double $pu_ht Unit price HT (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>double $txtva VAT rate forced with format '5.0 (XXX)', or -1</td> <td>1</td> </tr> <tr> <td>int $txlocaltax1 Local tax 1 rate (deprecated)</td> <td>1</td> </tr> <tr> <td>int $txlocaltax2 Local tax 2 rate (deprecated)</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $date_start Date start</td> <td>1</td> </tr> <tr> <td>int $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $info_bits Bits of type of lines</td> <td>1</td> </tr> <tr> <td>int $special_code Special code</td> <td>1</td> </tr> <tr> <td>int $rang Position of line</td> <td>1</td> </tr> <tr> <td>string $fk_unit Unit</td> <td>1</td> </tr> <tr> <td>double $pu_ht_devise Unit price in currency</td> <td>1</td> </tr> <tr> <td>double $pu_ttc Unit price TTC (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>User $user User asking creation</td> <td>1</td> </tr> <tr> <td>string $name Category name</td> <td>1</td> </tr> <tr> <td>int $id_fourn Supplier Id</td> <td>1</td> </tr> <tr> <td>int $rowid Line id of price</td> <td>1</td> </tr> <tr> <td>float $qty Min quantity for which price is valid</td> <td>1</td> </tr> <tr> <td>float $buyprice Purchase price for the quantity min</td> <td>1</td> </tr> <tr> <td>User $user Object user user made changes</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>Societe $fourn Supplier</td> <td>1</td> </tr> <tr> <td>int $availability Product availability</td> <td>1</td> </tr> <tr> <td>string $ref_fourn Supplier ref</td> <td>1</td> </tr> <tr> <td>float $tva_tx New VAT Rate (For example 8.5. Should not be a string)</td> <td>1</td> </tr> <tr> <td>string|float $charges costs affering to product</td> <td>1</td> </tr> <tr> <td>float $remise_percent Discount regarding qty (percent)</td> <td>1</td> </tr> <tr> <td>float $remise Discount regarding qty (amount)</td> <td>1</td> </tr> <tr> <td>int $newnpr Set NPR or not</td> <td>1</td> </tr> <tr> <td>int $delivery_time_days Delay in days for delivery (max). May be '' if not defined.</td> <td>1</td> </tr> <tr> <td>array $localtaxes_array Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).</td> <td>1</td> </tr> <tr> <td>string $newdefaultvatcode Default vat code</td> <td>1</td> </tr> <tr> <td>float $multicurrency_buyprice Purchase price for the quantity min in currency</td> <td>1</td> </tr> <tr> <td>float $multicurrency_tx Rate currency</td> <td>1</td> </tr> <tr> <td>string $multicurrency_code Currency code</td> <td>1</td> </tr> <tr> <td>string $desc_fourn Custom description for product_fourn_price</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode</td> <td>1</td> </tr> <tr> <td>int $fk_barcode_type Barcode type</td> <td>1</td> </tr> <tr> <td>array $options Extrafields of product fourn price</td> <td>1</td> </tr> <tr> <td>int $rowid Line id</td> <td>1</td> </tr> <tr> <td>int $ignore_expression Ignores the math expression for calculating price and uses the db value instead</td> <td>1</td> </tr> <tr> <td>int $prodid Id of product</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>int $socid Filter on a third party id</td> <td>1</td> </tr> <tr> <td>int $prodid Product id</td> <td>1</td> </tr> <tr> <td>float $qty Minimum quantity</td> <td>1</td> </tr> <tr> <td>int $socid get min price for specific supplier</td> <td>1</td> </tr> <tr> <td>int $expression_id Expression</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto</td> <td>1</td> </tr> <tr> <td>string $option Target of link ('', 'customer', 'prospect', 'supplier')</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length of name</td> <td>1</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $showunitprice Show "Unit price" into output string</td> <td>1</td> </tr> <tr> <td>int $showsuptitle Show "Supplier" into output string</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length of name</td> <td>1</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>array $productFournList list of ProductFournisseur objects</td> <td>1</td> </tr> <tr> <td>int $product_fourn_price_id Id of supplier price</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>array $productFournLogList list of ProductFournisseur price log objects</td> <td>1</td> </tr> <tr> <td>int $maxlength Maxlength of ref</td> <td>1</td> </tr> <tr> <td>int $notooltip No tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss ''=Add more css on link</td> <td>1</td> </tr> <tr> <td>int $add_label 0=Default, 1=Add label into string, >1=Add first chars into string</td> <td>1</td> </tr> <tr> <td>string $sep ' - '=Separator between ref and label if option 'add_label' is set</td> <td>1</td> </tr> <tr> <td>User $user Object user who adds/changes price</td> <td>1</td> </tr> <tr> <td>integer $datec date create</td> <td>1</td> </tr> <tr> <td>float $buyprice price for qty</td> <td>1</td> </tr> <tr> <td>float $qty qty for price</td> <td>1</td> </tr> <tr> <td>float $multicurrency_buyprice Purchase price for the quantity min in currency</td> <td>1</td> </tr> <tr> <td>float $multicurrency_unitBuyPrice Unit Purchase price in currency</td> <td>1</td> </tr> <tr> <td>float $multicurrency_tx Rate currency</td> <td>1</td> </tr> <tr> <td>int $fk_multicurrency key multi currency</td> <td>1</td> </tr> <tr> <td>string $multicurrency_code Currency code</td> <td>1</td> </tr> <tr> <td>int $id ID of supplier order</td> <td>1</td> </tr> <tr> <td>string $product_ids Product ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $status Filter by order status : draft | validated | approved | running | received_start | received_end | cancelled | refused</td> <td>1</td> </tr> <tr> <td>string $sqlfilterlines Other criteria to filter answers separated by a comma. Syntax example "(tl.fk_product:=:'17') and (tl.price:<:'250')"</td> <td>1</td> </tr> <tr> <td>int $id Id of supplier order to update</td> <td>1</td> </tr> <tr> <td>int $id ID of supplier order</td> <td>1</td> </tr> <tr> <td>string $source Source of the contact (internal, external, all).</td> <td>1</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...)</td> <td>1</td> </tr> <tr> <td>int $id Id of supplier order to update</td> <td>1</td> </tr> <tr> <td>int $contactid Id of contact/user to add</td> <td>1</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...)</td> <td>1</td> </tr> <tr> <td>string $source Source of the contact (external, internal)</td> <td>1</td> </tr> <tr> <td>int $id Id of supplier order to update</td> <td>1</td> </tr> <tr> <td>int $contactid Id of contact/user to add</td> <td>1</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER, SALESREPFOLL, ...).</td> <td>1</td> </tr> <tr> <td>string $source Source of the contact (internal, external).</td> <td>1</td> </tr> <tr> <td>int $id Supplier order ID</td> <td>1</td> </tr> <tr> <td>int $secondlevel 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>integer $date Date (unix timestamp in sec)</td> <td>1</td> </tr> <tr> <td>int $method Method</td> <td>1</td> </tr> <tr> <td>integer $closeopenorder Close order if everything is received {@required false}</td> <td>1</td> </tr> <tr> <td>string $comment Comment {@required false}</td> <td>1</td> </tr> <tr> <td>array $lines Array of product dispatches</td> <td>1</td> </tr> <tr> <td>int $typentid Id of type of third party for filter</td> <td>1</td> </tr> <tr> <td>int $status Status of donation for filter</td> <td>1</td> </tr> <tr> <td>int $id ID of order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $id Id of order to update</td> <td>1</td> </tr> <tr> <td>User $user User making payment</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>string $mode 'payment_donation'</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>int $status Id statut</td> <td>1</td> </tr> <tr> <td>int $minimum Minimum</td> <td>1</td> </tr> <tr> <td>User $user User who created the donation</td> <td>1</td> </tr> <tr> <td>User $user Object utilisateur qui met a jour le don</td> <td>1</td> </tr> <tr> <td>int $id Id of donation to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of donation to load</td> <td>1</td> </tr> <tr> <td>int $id id of donation</td> <td>1</td> </tr> <tr> <td>int $userid User who validate the donation/promise</td> <td>1</td> </tr> <tr> <td>int $id id of donation</td> <td>1</td> </tr> <tr> <td>int $modepayment mode of payment</td> <td>1</td> </tr> <tr> <td>int $id id of donation</td> <td>1</td> </tr> <tr> <td>string $param 1=promesses de dons validees , 2=xxx, 3=encaisses</td> <td>1</td> </tr> <tr> <td>int $id ID of order</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of object</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $sqlfilterlines Other criteria to filter answers separated by a comma. Syntax example "(tl.fk_product:=:'17') and (tl.price:<:'250')"</td> <td>1</td> </tr> <tr> <td>int $id Id of order</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line to delete</td> <td>1</td> </tr> <tr> <td>int $id ID of order</td> <td>1</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER)</td> <td>1</td> </tr> <tr> <td>int $contactid Id of contact</td> <td>1</td> </tr> <tr> <td>int $id Id of the order</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Warehouse ID to use for stock change (Used only if option STOCK_CALCULATE_ON_VALIDATE_ORDER is on)</td> <td>1</td> </tr> <tr> <td>int $proposalid Id of the proposal</td> <td>1</td> </tr> <tr> <td>int $warehouse_id Id of a warehouse</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Warehouse ID to use for stock change (Used only if option STOCK_CALCULATE_ON_VALIDATE_ORDER is on)</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>1</td> </tr> <tr> <td>Object $object Object source</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>string $desc Description of line</td> <td>1</td> </tr> <tr> <td>float $pu_ht Unit price (without tax)</td> <td>1</td> </tr> <tr> <td>float $qty Quantite</td> <td>1</td> </tr> <tr> <td>float $txtva Force Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Local tax 1 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Local tax 2 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of product</td> <td>1</td> </tr> <tr> <td>float $remise_percent Percentage discount of the line</td> <td>1</td> </tr> <tr> <td>int $info_bits Bits of type of lines</td> <td>1</td> </tr> <tr> <td>int $fk_remise_except Id remise</td> <td>1</td> </tr> <tr> <td>float $pu_ttc Prix unitaire TTC</td> <td>1</td> </tr> <tr> <td>int|string $date_start Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)</td> <td>1</td> </tr> <tr> <td>int|string $date_end End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.</td> <td>1</td> </tr> <tr> <td>int $rang Position of line</td> <td>1</td> </tr> <tr> <td>int $fk_parent_line Parent line</td> <td>1</td> </tr> <tr> <td>int $fk_fournprice Id supplier price</td> <td>1</td> </tr> <tr> <td>int $pa_ht Buying price (without tax)</td> <td>1</td> </tr> <tr> <td>array $array_options extrafields array. Example array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)</td> <td>1</td> </tr> <tr> <td>string $origin Depend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be 'orderdet', 'propaldet'..., else 'order','propal,'....</td> <td>1</td> </tr> <tr> <td>int $origin_id Depend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be Id of origin object (aka line id), else object id</td> <td>1</td> </tr> <tr> <td>double $pu_ht_devise Unit price in currency</td> <td>1</td> </tr> <tr> <td>string $ref_ext line external reference</td> <td>1</td> </tr> <tr> <td>int $noupdateafterinsertline No update after insert of line</td> <td>1</td> </tr> <tr> <td>int $idproduct Product Id</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float $remise_percent Product discount relative</td> <td>1</td> </tr> <tr> <td>int|string $date_start Start date of the line</td> <td>1</td> </tr> <tr> <td>int|string $date_end End date of the line</td> <td>1</td> </tr> <tr> <td>int $id Id of object to load</td> <td>1</td> </tr> <tr> <td>string $notused Internal reference of other object</td> <td>1</td> </tr> <tr> <td>int $idremise Id for the fixed discount</td> <td>1</td> </tr> <tr> <td>int $only_product Return only physical products, not services</td> <td>1</td> </tr> <tr> <td>int $fk_product Add a filter on a product</td> <td>1</td> </tr> <tr> <td>int $filtre_statut Filtre sur statut</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line to delete</td> <td>1</td> </tr> <tr> <td>User $user User qui positionne la remise</td> <td>1</td> </tr> <tr> <td>float $remise Discount (percent)</td> <td>1</td> </tr> <tr> <td>User $user User setting the discount</td> <td>1</td> </tr> <tr> <td>float|string $remise Discount (percent)</td> <td>1</td> </tr> <tr> <td>int<0,1> $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>User $user User qui positionne la remise</td> <td>1</td> </tr> <tr> <td>float $remise Discount</td> <td>1</td> </tr> <tr> <td>int $date Date</td> <td>1</td> </tr> <tr> <td>User $user Object utilisateur qui modifie</td> <td>1</td> </tr> <tr> <td>int $availability_id Id du nouveau mode</td> <td>1</td> </tr> <tr> <td>int $demand_reason_id Id of new demand</td> <td>1</td> </tr> <tr> <td>User $user User that make change</td> <td>1</td> </tr> <tr> <td>string $ref_client Customer ref</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line to update</td> <td>1</td> </tr> <tr> <td>string $desc Description of line</td> <td>1</td> </tr> <tr> <td>float $pu Unit price</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float $remise_percent Percent of discount</td> <td>1</td> </tr> <tr> <td>float $txtva Taux TVA</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Local tax 1 rate</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Local tax 2 rate</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information on line</td> <td>1</td> </tr> <tr> <td>int|string $date_start Start date of the line</td> <td>1</td> </tr> <tr> <td>int|string $date_end End date of the line</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>1</td> </tr> <tr> <td>int $fk_parent_line Id of parent line (0 in most cases, used by modules adding sublevels into lines).</td> <td>1</td> </tr> <tr> <td>int $skip_update_total Keep fields total_xxx to 0 (used for special lines by some modules)</td> <td>1</td> </tr> <tr> <td>int $fk_fournprice Id of origin supplier price</td> <td>1</td> </tr> <tr> <td>int $pa_ht Price (without tax) of product when it was bought</td> <td>1</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>1</td> </tr> <tr> <td>double $pu_ht_devise Amount in currency</td> <td>1</td> </tr> <tr> <td>int $notrigger disable line update trigger</td> <td>1</td> </tr> <tr> <td>string $ref_ext external reference</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('toship', 'tobill', 'shippedtobill')</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int $billed If invoiced</td> <td>1</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $donotshowbilled Do not show billed status after order status</td> <td>1</td> </tr> <tr> <td>string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)</td> <td>1</td> </tr> <tr> <td>int $max Max length to show</td> <td>1</td> </tr> <tr> <td>int $short ???</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes Add link to notes</td> <td>1</td> </tr> <tr> <td>string $target attribute target for link</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>int $limit limit</td> <td>1</td> </tr> <tr> <td>int $mode 0 = long label</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int $mode 0 = long label,</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>int $id ID of hook</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>int $id Hook ID</td> <td>1</td> </tr> <tr> <td>array $data Array of data to validate</td> <td>1</td> </tr> <tr> <td>array $fields Array of fields needed</td> <td>1</td> </tr> <tr> <td>int $id Id</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>User $user Object user making delete</td> <td>1</td> </tr> <tr> <td>User $user User that modify</td> <td>1</td> </tr> <tr> <td>int $year Year</td> <td>1</td> </tr> <tr> <td>int $id Id of social contribution</td> <td>1</td> </tr> <tr> <td>string $ref Ref of VAT (not used yet)</td> <td>1</td> </tr> <tr> <td>string $option link option</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $id Id of vat payment</td> <td>1</td> </tr> <tr> <td>int $closepaidvat 1=Also close paid contributions to paid, 0=Do nothing more</td> <td>1</td> </tr> <tr> <td>User|null $user User that modify</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>int $bankaccount_from_id BankAccount ID to use as the source of the internal wire transfer {@from body}{@required true}</td> <td>1</td> </tr> <tr> <td>int $bankaccount_to_id BankAccount ID to use as the destination of the internal wire transfer {@from body}{@required true}</td> <td>1</td> </tr> <tr> <td>string $date Date of the internal wire transfer (UNIX timestamp) {@from body}{@required true}{@type timestamp}</td> <td>1</td> </tr> <tr> <td>string $description Description of the internal wire transfer {@from body}{@required true}</td> <td>1</td> </tr> <tr> <td>float $amount Amount to transfer from the source to the destination BankAccount {@from body}{@required true}</td> <td>1</td> </tr> <tr> <td>float $amount_to Amount to transfer to the destination BankAccount (only when accounts does not share the same currency) {@from body}{@required false}</td> <td>1</td> </tr> <tr> <td>string $cheque_number Cheque numero {@from body}{@required false}</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>string $date Payment date (timestamp) {@from body} {@type timestamp}</td> <td>1</td> </tr> <tr> <td>string $type Payment mode (TYP,VIR,PRE,LIQ,VAD,CB,CHQ...) {@from body}</td> <td>1</td> </tr> <tr> <td>string $label Label {@from body}</td> <td>1</td> </tr> <tr> <td>float $amount Amount (may be 0) {@from body}</td> <td>1</td> </tr> <tr> <td>int $category Category</td> <td>1</td> </tr> <tr> <td>string $cheque_number Cheque numero {@from body}</td> <td>1</td> </tr> <tr> <td>string $cheque_writer Name of cheque writer {@from body}</td> <td>1</td> </tr> <tr> <td>string $cheque_bank Bank of cheque writer {@from body}</td> <td>1</td> </tr> <tr> <td>string $accountancycode Accountancy code {@from body}</td> <td>1</td> </tr> <tr> <td>string $datev Payment date value (timestamp) {@from body} {@type timestamp}</td> <td>1</td> </tr> <tr> <td>string $num_releve Bank statement numero {@from body}</td> <td>1</td> </tr> <tr> <td>int $id ID of account</td> <td>1</td> </tr> <tr> <td>int $url_id ID to set in the URL {@from body}</td> <td>1</td> </tr> <tr> <td>string $url URL of the link {@from body}</td> <td>1</td> </tr> <tr> <td>string $type Type of link ('payment', 'company', 'member', ...) {@from body}</td> <td>1</td> </tr> <tr> <td>int $line_id Id of bank entry</td> <td>1</td> </tr> <tr> <td>int $url_id Id of object related to link</td> <td>1</td> </tr> <tr> <td>string $url Url (deprecated, we use now 'url_id' and 'type' instead)</td> <td>1</td> </tr> <tr> <td>string $label Link label</td> <td>1</td> </tr> <tr> <td>string $type Type of link ('payment', 'company', 'member', ...)</td> <td>1</td> </tr> <tr> <td>int $fk_bank To search using bank transaction id</td> <td>1</td> </tr> <tr> <td>int $url_id To search using link to</td> <td>1</td> </tr> <tr> <td>string $type To search using type</td> <td>1</td> </tr> <tr> <td>int $date Date operation</td> <td>1</td> </tr> <tr> <td>string $oper 'VIR','PRE','LIQ','VAD','CB','CHQ'...</td> <td>1</td> </tr> <tr> <td>string $label Description</td> <td>1</td> </tr> <tr> <td>float $amount Amount</td> <td>1</td> </tr> <tr> <td>string $num_chq Numero cheque or transfer</td> <td>1</td> </tr> <tr> <td>int $categorie Category id (optional)</td> <td>1</td> </tr> <tr> <td>User $user User that create</td> <td>1</td> </tr> <tr> <td>string $emetteur Name of cheque writer</td> <td>1</td> </tr> <tr> <td>string $banque Bank of cheque writer</td> <td>1</td> </tr> <tr> <td>string $accountancycode When we record a free bank entry, we must provide accounting account if accountancy module is on.</td> <td>1</td> </tr> <tr> <td>int $datev Date value</td> <td>1</td> </tr> <tr> <td>string $num_releve Label of bank receipt for reconciliation</td> <td>1</td> </tr> <tr> <td>float $amount_main_currency Amount</td> <td>1</td> </tr> <tr> <td>User $user Object user making creation</td> <td>1</td> </tr> <tr> <td>User $user Object user making action</td> <td>1</td> </tr> <tr> <td>User|null $user Object user making update</td> <td>1</td> </tr> <tr> <td>int $id Id of bank account to get</td> <td>1</td> </tr> <tr> <td>string $ref Ref of bank account to get</td> <td>1</td> </tr> <tr> <td>int $option 1=Exclude future operation date (this is to exclude input made in advance and have real account sold)</td> <td>1</td> </tr> <tr> <td>int|string $date_end Date until we want to get bank account balance</td> <td>1</td> </tr> <tr> <td>string $field 'dateo' or 'datev'</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $filteraccountid To get info for a particular account id</td> <td>1</td> </tr> <tr> <td>int $filteraccountid To get info for a particular account id</td> <td>1</td> </tr> <tr> <td>int $withpicto Include picto into link</td> <td>1</td> </tr> <tr> <td>string $mode ''=Link to card, 'transactions'=Link to transactions card</td> <td>1</td> </tr> <tr> <td>string $option ''=Show ref, 'reflabel'=Show ref+label</td> <td>1</td> </tr> <tr> <td>int $includeibanbic 1=Return also key for IBAN and BIC</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>int $rowid Id of bank transaction to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of bank transaction to load</td> <td>1</td> </tr> <tr> <td>string $num External num to load (ex: num of transaction for paypal fee)</td> <td>1</td> </tr> <tr> <td>User|null $user User object that delete</td> <td>1</td> </tr> <tr> <td>User|null $user User object that delete</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=Disable all triggers</td> <td>1</td> </tr> <tr> <td>int $cat Category id</td> <td>1</td> </tr> <tr> <td>int $conciliated 1=Set transaction to conciliated, 0=Keep transaction non conciliated</td> <td>1</td> </tr> <tr> <td>string $option Option ('', 'showall', 'showconciliated', 'showconciliatedandaccounted'). Options may be slow.</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=no, 1=yes (no update trigger)</td> <td>1</td> </tr> <tr> <td>User $user User that create</td> <td>1</td> </tr> <tr> <td>int $id_bank Id bank account</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>string $morecss morecss string</td> <td>1</td> </tr> <tr> <td>int $id Id of record</td> <td>1</td> </tr> <tr> <td>string $account Auxiliary accounting account</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $code Code object</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $socid Id third party for filter. This value must be forced during the new to external user company if user is an external user.</td> <td>1</td> </tr> <tr> <td>string $mode Option ('customer', 'supplier')</td> <td>1</td> </tr> <tr> <td>int $userid Id user for filter (creation user)</td> <td>1</td> </tr> <tr> <td>int $typentid Id typent of thirdpary for filter</td> <td>1</td> </tr> <tr> <td>int $categid Id category of thirdpary for filter</td> <td>1</td> </tr> <tr> <td>int $year Year to scan</td> <td>1</td> </tr> <tr> <td>int $numberYears Years to scan</td> <td>1</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is year, 2=Label of abscissa is last number of year</td> <td>1</td> </tr> <tr> <td>int $id ID of invoice</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $orderid Id of the order</td> <td>1</td> </tr> <tr> <td>int $contractid Id of the contract</td> <td>1</td> </tr> <tr> <td>int $id Id of invoice to update</td> <td>1</td> </tr> <tr> <td>int $contactid Row key of the contact in the array contact_ids.</td> <td>1</td> </tr> <tr> <td>int $id Id of invoice to update</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id Invoice ID</td> <td>1</td> </tr> <tr> <td>int $id Order ID</td> <td>1</td> </tr> <tr> <td>int $fk_socpeople Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link</td> <td>1</td> </tr> <tr> <td>string $type_contact Type of contact (code). Must a code found into table llx_c_type_contact. For example: BILLING</td> <td>1</td> </tr> <tr> <td>string $source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>1</td> </tr> <tr> <td>int $id Invoice ID</td> <td>1</td> </tr> <tr> <td>string $force_number force ref invoice</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Warehouse ID</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>int $id Order ID</td> <td>1</td> </tr> <tr> <td>string $close_code Code filled if we classify to 'Paid completely' when payment is not complete (for escompte for example)</td> <td>1</td> </tr> <tr> <td>string $close_note Comment defined if we classify to 'Paid' when payment is not complete (for escompte for example)</td> <td>1</td> </tr> <tr> <td>int $id Order ID</td> <td>1</td> </tr> <tr> <td>int $id Invoice ID</td> <td>1</td> </tr> <tr> <td>int $discountid Id of discount</td> <td>1</td> </tr> <tr> <td>int $id Id of invoice</td> <td>1</td> </tr> <tr> <td>int $discountid Id of a discount coming from a credit note</td> <td>1</td> </tr> <tr> <td>int $paymentid {@from body} Payment mode Id {@min 1}</td> <td>1</td> </tr> <tr> <td>int $accountid {@from body} Account Id {@min 1}</td> <td>1</td> </tr> <tr> <td>string $comment {@from body} Note private (optional)</td> <td>1</td> </tr> <tr> <td>string $chqemetteur {@from body} Payment issuer (mandatory if paymentcode = 'CHQ')</td> <td>1</td> </tr> <tr> <td>array $arrayofamounts {@from body} Array with id of invoices with amount to pay for each invoice</td> <td>1</td> </tr> <tr> <td>int $paymentid {@from body} Payment mode Id {@min 1}</td> <td>1</td> </tr> <tr> <td>string $closepaidinvoices {@from body} Close paid invoices {@choice yes,no}</td> <td>1</td> </tr> <tr> <td>int $accountid {@from body} Account Id {@min 1}</td> <td>1</td> </tr> <tr> <td>string $num_payment {@from body} Payment number (optional)</td> <td>1</td> </tr> <tr> <td>string $comment {@from body} Note private (optional)</td> <td>1</td> </tr> <tr> <td>string $chqemetteur {@from body} Payment issuer (mandatory if paiementcode = 'CHQ')</td> <td>1</td> </tr> <tr> <td>string $chqbank {@from body} Issuer bank name (optional)</td> <td>1</td> </tr> <tr> <td>string $ref_ext {@from body} External reference (optional)</td> <td>1</td> </tr> <tr> <td>bool $accepthigherpayment {@from body} Accept higher payments that it remains to be paid (optional)</td> <td>1</td> </tr> <tr> <td>int $id Id of payment</td> <td>1</td> </tr> <tr> <td>string $num_payment Payment number</td> <td>1</td> </tr> <tr> <td>array|null $data Datas to validate</td> <td>1</td> </tr> <tr> <td>int $id ID of template invoice</td> <td>1</td> </tr> <tr> <td>int $facid Id of source invoice</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>1</td> </tr> <tr> <td>array $onlylines Only the lines of the array</td> <td>1</td> </tr> <tr> <td>int $info_bits VAT npr or not ?</td> <td>1</td> </tr> <tr> <td>int $pa_ht Price (without tax) of product for margin calculation</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable the trigger</td> <td>1</td> </tr> <tr> <td>int $origin_id Old product id</td> <td>1</td> </tr> <tr> <td>int $dest_id New product id</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable the trigger</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable the trigger</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0 otherwise</td> <td>1</td> </tr> <tr> <td>int $forceduedate If set, do not recalculate due date from payment condition but force it with value</td> <td>1</td> </tr> <tr> <td>User $user Object user that ask creation</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>array $lines Ids of lines to use for invoice. If empty, all lines will be used.</td> <td>1</td> </tr> <tr> <td>Propal|Commande $origin The original proposal or order</td> <td>1</td> </tr> <tr> <td>int $date Invoice date</td> <td>1</td> </tr> <tr> <td>int $payment_terms_id Invoice payment terms</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>bool $autoValidateDeposit Whether to aumatically validate the deposit created</td> <td>1</td> </tr> <tr> <td>array $overrideFields Array of fields to force values</td> <td>1</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes 1=Add link to notes</td> <td>1</td> </tr> <tr> <td>string $target Target of link ('', '_self', '_blank', '_parent', '_backoffice', ...)</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Reference of invoice</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of invoice</td> <td>1</td> </tr> <tr> <td>int $notused Not used</td> <td>1</td> </tr> <tr> <td>bool $fetch_situation Load also the previous and next situation invoice into $tab_previous_situation_invoice and $tab_next_situation_invoice</td> <td>1</td> </tr> <tr> <td>string $ref_client Customer ref</td> <td>1</td> </tr> <tr> <td>User $user User making the deletion.</td> <td>1</td> </tr> <tr> <td>string $force_number Reference to force on invoice</td> <td>1</td> </tr> <tr> <td>int $idwarehouse Id of warehouse to use for stock decrease if option to decrease on stock is on (0=no decrease)</td> <td>1</td> </tr> <tr> <td>int $batch_rule 0=do not decrement batch, else batch rule to use, 1=take in batches ordered by sellby and eatby dates</td> <td>1</td> </tr> <tr> <td>Translate $langs Translate object</td> <td>1</td> </tr> <tr> <td>double $pu_ht Unit price without tax (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>double $txtva Force Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')</td> <td>1</td> </tr> <tr> <td>double $txlocaltax1 Local tax 1 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>double $txlocaltax2 Local tax 2 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of predefined product/service</td> <td>1</td> </tr> <tr> <td>double $remise_percent Percent of discount on line</td> <td>1</td> </tr> <tr> <td>int|string $date_start Date start of service</td> <td>1</td> </tr> <tr> <td>int|string $date_end Date end of service</td> <td>1</td> </tr> <tr> <td>int $fk_code_ventilation Code of dispatching into accountancy</td> <td>1</td> </tr> <tr> <td>int $fk_remise_except Id discount used</td> <td>1</td> </tr> <tr> <td>string $price_base_type 'HT' or 'TTC'</td> <td>1</td> </tr> <tr> <td>double $pu_ttc Unit price with tax (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.</td> <td>1</td> </tr> <tr> <td>int $rang Position of line (-1 means last value + 1)</td> <td>1</td> </tr> <tr> <td>int $fk_prev_id Previous situation line id reference</td> <td>1</td> </tr> <tr> <td>double $pu_ht_devise Unit price in foreign currency</td> <td>1</td> </tr> <tr> <td>double $pu Prix unitaire (HT ou TTC selon price_base_type) (> 0 even for credit note lines)</td> <td>1</td> </tr> <tr> <td>int $date_start Date de debut de validite du service</td> <td>1</td> </tr> <tr> <td>int $date_end Date de fin de validite du service</td> <td>1</td> </tr> <tr> <td>double $txtva VAT Rate (Can be '8.5', '8.5 (ABC)')</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>int $info_bits Miscellaneous information</td> <td>1</td> </tr> <tr> <td>integer $rang rank of line</td> <td>1</td> </tr> <tr> <td>int $idline id of line to check</td> <td>1</td> </tr> <tr> <td>float $situation_percent progress percentage need to be test</td> <td>1</td> </tr> <tr> <td>FactureLigne $line Invoice line</td> <td>1</td> </tr> <tr> <td>int $percent Percentage</td> <td>1</td> </tr> <tr> <td>boolean $update_price Update object price</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line to delete</td> <td>1</td> </tr> <tr> <td>float $remise Discount</td> <td>1</td> </tr> <tr> <td>User $user User that set discount</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>string $modele Generator to use. Caller must set it to obj->model_pdf or GETPOST('model','alpha') for example.</td> <td>1</td> </tr> <tr> <td>int $rounding Minimum number of decimal to show. If 0, no change, if -1, we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT)</td> <td>1</td> </tr> <tr> <td>float $value value of retained warranty</td> <td>1</td> </tr> <tr> <td>int $timestamp date limit of retained warranty in timestamp format</td> <td>1</td> </tr> <tr> <td>string $dateYmd date limit of retained warranty in Y m d format</td> <td>1</td> </tr> <tr> <td>int|string $template Name (or id) of email template (Must be a template of type 'facture_send')</td> <td>1</td> </tr> <tr> <td>boolean $allow_validated_drafts return true if the invoice has been validated before returning to DRAFT state.</td> <td>1</td> </tr> <tr> <td>int $rowid id of invoice line to get</td> <td>1</td> </tr> <tr> <td>int $notrigger 1 no triggers</td> <td>1</td> </tr> <tr> <td>int $noerrorifdiscountalreadylinked 1=Do not make error if lines is linked to a discount and discount already linked to another</td> <td>1</td> </tr> <tr> <td>User $tmpuser User that deletes</td> <td>1</td> </tr> <tr> <td>int $invoiceid Invoice id</td> <td>1</td> </tr> <tr> <td>bool $include_credit_note Include credit note or not</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=no, 1=yes (no update trigger)</td> <td>1</td> </tr> <tr> <td>int $id Id bank account</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=Link, 1=Picto into link, 2=Picto</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>string $type Type ('direct-debit' for direct debit or 'bank-transfer' for credit transfer)</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>string $motif Motif</td> <td>1</td> </tr> <tr> <td>int $date_rejet Date reject</td> <td>1</td> </tr> <tr> <td>int $bonid Bon id</td> <td>1</td> </tr> <tr> <td>int $facturation 1=Bill the reject</td> <td>1</td> </tr> <tr> <td>Facture $fac Invoice object</td> <td>1</td> </tr> <tr> <td>int $amounts If you want to get the amount of the order for each invoice</td> <td>1</td> </tr> <tr> <td>int $rowid id of invoice to retrieve</td> <td>1</td> </tr> <tr> <td>int $rowid Id de la facture a recuperer</td> <td>1</td> </tr> <tr> <td>int $invoice_id ID of invoice to add or ID of salary to add</td> <td>1</td> </tr> <tr> <td>int $client_id id invoice customer</td> <td>1</td> </tr> <tr> <td>string $number bank account number</td> <td>1</td> </tr> <tr> <td>string $type 'debit-order' or 'bank-transfer'</td> <td>1</td> </tr> <tr> <td>int $line_id ID of line added (returned parameter)</td> <td>1</td> </tr> <tr> <td>int $client_id ID of thirdparty for invoices, ID of user for salaries</td> <td>1</td> </tr> <tr> <td>string $number bank account number</td> <td>1</td> </tr> <tr> <td>int $error Id of error</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of direct debit</td> <td>1</td> </tr> <tr> <td>User $user Id of user</td> <td>1</td> </tr> <tr> <td>int $date date of action</td> <td>1</td> </tr> <tr> <td>string $type 'salary' for type=salary</td> <td>1</td> </tr> <tr> <td>User $user Id of user</td> <td>1</td> </tr> <tr> <td>int $date Date of action</td> <td>1</td> </tr> <tr> <td>int $method Method of transmission to bank (0=Internet, 1=Api...)</td> <td>1</td> </tr> <tr> <td>int $amounts If you want to get the amount of the order for each invoice or salary</td> <td>1</td> </tr> <tr> <td>string $type 'salary' for type=salary</td> <td>1</td> </tr> <tr> <td>string $type for type=salary</td> <td>1</td> </tr> <tr> <td>string $type for salary invoice</td> <td>1</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>1</td> </tr> <tr> <td>int $forsalary 0= for facture & facture_supplier, 1=for salary</td> <td>1</td> </tr> <tr> <td>int $banque dolibarr mysoc bank</td> <td>1</td> </tr> <tr> <td>int $agence dolibarr mysoc bank office (guichet)</td> <td>1</td> </tr> <tr> <td>string $mode real=do action, simu=test only</td> <td>1</td> </tr> <tr> <td>string $executiondate Date to execute the transfer</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>int $did ID of an existing payment request. If $did is defined, we use the existing payment request.</td> <td>1</td> </tr> <tr> <td>string $sourcetype 'invoice' or 'salary'</td> <td>1</td> </tr> <tr> <td>User $user Object user that delete</td> <td>1</td> </tr> <tr> <td>int $rowid id of notification</td> <td>1</td> </tr> <tr> <td>DoliDB $db database handler</td> <td>1</td> </tr> <tr> <td>int $executiondate Timestamp date to execute transfer</td> <td>1</td> </tr> <tr> <td>int $forsalary If the SEPA is to pay salaries</td> <td>1</td> </tr> <tr> <td>string $row_code_client Customer code (soc.code_client)</td> <td>1</td> </tr> <tr> <td>int $row_datec Creation date of bank account (rib.datec)</td> <td>1</td> </tr> <tr> <td>string $row_drum Id of customer bank account (rib.rowid)</td> <td>1</td> </tr> <tr> <td>int $rowid id of line</td> <td>1</td> </tr> <tr> <td>string $client_nom name of customer</td> <td>1</td> </tr> <tr> <td>string $rib_banque code of bank</td> <td>1</td> </tr> <tr> <td>string $rib_guichet code of bank office</td> <td>1</td> </tr> <tr> <td>string $rib_number bank account</td> <td>1</td> </tr> <tr> <td>float $amount amount</td> <td>1</td> </tr> <tr> <td>string $ref ref of invoice</td> <td>1</td> </tr> <tr> <td>int $facid id of invoice</td> <td>1</td> </tr> <tr> <td>string $rib_dom bank address</td> <td>1</td> </tr> <tr> <td>string $row_code_client soc.code_client as code,</td> <td>1</td> </tr> <tr> <td>string $row_nom pl.client_nom AS name,</td> <td>1</td> </tr> <tr> <td>string $row_address soc.address AS adr,</td> <td>1</td> </tr> <tr> <td>string $row_zip soc.zip</td> <td>1</td> </tr> <tr> <td>string $row_town soc.town</td> <td>1</td> </tr> <tr> <td>string $row_country_code c.code AS country,</td> <td>1</td> </tr> <tr> <td>string $row_cb pl.code_banque AS cb, Not used for SEPA</td> <td>1</td> </tr> <tr> <td>string $row_cg pl.code_guichet AS cg, Not used for SEPA</td> <td>1</td> </tr> <tr> <td>string $row_cc pl.number AS cc, Not used for SEPA</td> <td>1</td> </tr> <tr> <td>float $row_somme pl.amount AS somme,</td> <td>1</td> </tr> <tr> <td>string $row_ref Invoice ref (f.ref) or Salary ref</td> <td>1</td> </tr> <tr> <td>int $row_idfac p.fk_facture AS idfac or p.fk_facture_fourn or p.fk_salary,</td> <td>1</td> </tr> <tr> <td>string $row_iban rib.iban_prefix AS iban,</td> <td>1</td> </tr> <tr> <td>string $row_bic rib.bic AS bic,</td> <td>1</td> </tr> <tr> <td>string $row_datec rib.datec,</td> <td>1</td> </tr> <tr> <td>string $row_drum rib.rowid used to generate rum</td> <td>1</td> </tr> <tr> <td>string $row_rum rib.rum Rum defined on company bank account</td> <td>1</td> </tr> <tr> <td>string $row_comment A free text string for the Unstructured data field</td> <td>1</td> </tr> <tr> <td>Conf $configuration conf</td> <td>1</td> </tr> <tr> <td>int $ladate Date</td> <td>1</td> </tr> <tr> <td>int $nombre 0 or 1</td> <td>1</td> </tr> <tr> <td>float $total Total</td> <td>1</td> </tr> <tr> <td>string $CrLf End of line character</td> <td>1</td> </tr> <tr> <td>string $format FRST or RCUR or ALL</td> <td>1</td> </tr> <tr> <td>int $total total amount</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>string $mode Mode 'direct_debit' or 'credit_transfer'</td> <td>1</td> </tr> <tr> <td>mixed $userid Id user for filter or array of user ids</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>string $ref Ref of record</td> <td>1</td> </tr> <tr> <td>User $user USer that Delete</td> <td>1</td> </tr> <tr> <td>int $active Active or not</td> <td>1</td> </tr> <tr> <td>int $id Id record</td> <td>1</td> </tr> <tr> <td>string $ref Ref record</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>int $account_id Bank account for cheque receipt</td> <td>1</td> </tr> <tr> <td>int $limit Limit ref of cheque to this</td> <td>1</td> </tr> <tr> <td>array $toRemise array with cheques to remise</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>string $model Model name</td> <td>1</td> </tr> <tr> <td>int $account_id Compte bancaire concerne</td> <td>1</td> </tr> <tr> <td>int $bank_id Id of bank transaction line concerned</td> <td>1</td> </tr> <tr> <td>integer $rejection_date Date to use on the negative payment</td> <td>1</td> </tr> <tr> <td>int $date Date creation</td> <td>1</td> </tr> <tr> <td>int $ref ref of bordereau</td> <td>1</td> </tr> <tr> <td>string $option Sur quoi pointe le lien</td> <td>1</td> </tr> <tr> <td>int $id Id of payment to get</td> <td>1</td> </tr> <tr> <td>string $ref Ref of payment to get (currently ref = id but this may change in future)</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $closepaidinvoices 1=Also close paid invoices to paid, 0=Do nothing more</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Thirdparty</td> <td>1</td> </tr> <tr> <td>string $mode 'payment', 'payment_supplier'</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>1</td> </tr> <tr> <td>string $accountancycode When we record a free bank entry, we must provide accounting account if accountancy module is on.</td> <td>1</td> </tr> <tr> <td>string $addbankurl 'direct-debit' or 'credit-transfer': Add another entry into bank_url.</td> <td>1</td> </tr> <tr> <td>int $id_bank Id compte bancaire</td> <td>1</td> </tr> <tr> <td>int $date New date</td> <td>1</td> </tr> <tr> <td>string $num_payment New num</td> <td>1</td> </tr> <tr> <td>User|null $user User making reject</td> <td>1</td> </tr> <tr> <td>int $id id du paiement don't il faut afficher les infos</td> <td>1</td> </tr> <tr> <td>string $filter Filter</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>int $socid Id third party</td> <td>1</td> </tr> <tr> <td>mixed $userid Id user for filter or array of user ids</td> <td>1</td> </tr> <tr> <td>string $mode 'payment_salary'</td> <td>1</td> </tr> <tr> <td>int $date New date</td> <td>1</td> </tr> <tr> <td>int $maxlen Longueur max libelle</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $id ID of salary</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>int $id ID of salary</td> <td>1</td> </tr> <tr> <td>array $request_data Data</td> <td>1</td> </tr> <tr> <td>int $id ID of salary</td> <td>1</td> </tr> <tr> <td>int $pid ID of payment salary</td> <td>1</td> </tr> <tr> <td>int $id Id of salary</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>int $id ID of paymentsalary</td> <td>1</td> </tr> <tr> <td>int $id ID of payment salary</td> <td>1</td> </tr> <tr> <td>array $params params to construct tooltip data</td> <td>1</td> </tr> <tr> <td>int $mode 0=label long, 1=labels short, 2=Picto + Label short, 3=Picto, 4=Picto + Label long, 5=Label short + Picto</td> <td>1</td> </tr> <tr> <td>double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, 1 otherwise)</td> <td>1</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>RecruitmentCandidature $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>RecruitmentCandidature $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object Object we need next value for</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object Object source to build document</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object RecruitmentJobPosition to generate</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object Object to show</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $object Object to show</td> <td>1</td> </tr> <tr> <td>int $id ID of jobposition</td> <td>1</td> </tr> <tr> <td>int $id ID of candidature</td> <td>1</td> </tr> <tr> <td>int $id Id of jobposition to update</td> <td>1</td> </tr> <tr> <td>int $id Id of candidature to update</td> <td>1</td> </tr> <tr> <td>int $id jobposition ID</td> <td>1</td> </tr> <tr> <td>int $id candidature ID</td> <td>1</td> </tr> <tr> <td>int $status Statut</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $ref Ref</td> <td>1</td> </tr> <tr> <td>int $limit limit</td> <td>1</td> </tr> <tr> <td>int $offset offset limit</td> <td>1</td> </tr> <tr> <td>string|array $filter filter array</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>string $newref New ref</td> <td>1</td> </tr> <tr> <td>string $newlang New language</td> <td>1</td> </tr> <tr> <td>string $pathtofile Full path of zip file</td> <td>1</td> </tr> <tr> <td>array|string $languagecodes 'auto' to show all languages available for page, or language codes array like array('en','fr','de','es')</td> <td>1</td> </tr> <tr> <td>Translate $weblangs Language Object</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS class on component</td> <td>1</td> </tr> <tr> <td>string $htmlname Suffix for HTML name</td> <td>1</td> </tr> <tr> <td>string $pathtotmpzip Path to the tmp zip file</td> <td>1</td> </tr> <tr> <td>string $exportPath Relative path of directory to export files into (specified by the user)</td> <td>1</td> </tr> <tr> <td>string $filename name of file</td> <td>1</td> </tr> <tr> <td>string $name_template name of template</td> <td>1</td> </tr> <tr> <td>string $pathname path of file</td> <td>1</td> </tr> <tr> <td>mixed $etat state</td> <td>1</td> </tr> <tr> <td>mixed $pathname path of file</td> <td>1</td> </tr> <tr> <td>string $dossierSource filepath of folder source</td> <td>1</td> </tr> <tr> <td>string $dossierDestination filepath of folder dest</td> <td>1</td> </tr> <tr> <td>mixed $fichierModifie files modified</td> <td>1</td> </tr> <tr> <td>string $str string</td> <td>1</td> </tr> <tr> <td>string $str1 first string</td> <td>1</td> </tr> <tr> <td>string $str2 second string</td> <td>1</td> </tr> <tr> <td>array $exceptNumPge num of page files we don't want to change</td> <td>1</td> </tr> <tr> <td>string $inplaceFile path of file to modify in place</td> <td>1</td> </tr> <tr> <td>array $differences array of differences between files</td> <td>1</td> </tr> <tr> <td>int $id Id object.</td> <td>1</td> </tr> <tr> <td>string $website_id Web site id (page name must also be filled if this parameter is used)</td> <td>1</td> </tr> <tr> <td>string $page Page name (website id must also be filled if this parameter is used). Example 'myaliaspage' or 'fr/myaliaspage'</td> <td>1</td> </tr> <tr> <td>string $aliasalt Alternative alias to search page (slow)</td> <td>1</td> </tr> <tr> <td>string $websiteid Web site</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter as an Universal Search string.</td> <td>1</td> </tr> <tr> <td>string $websiteid Web site</td> <td>1</td> </tr> <tr> <td>array $filter Filter array</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>string $newref New ref/alias of page</td> <td>1</td> </tr> <tr> <td>string $newlang New language</td> <td>1</td> </tr> <tr> <td>int $istranslation 1=New page is a translation of the cloned page.</td> <td>1</td> </tr> <tr> <td>int $newwebsite 0=Same web site, >0=Id of new website</td> <td>1</td> </tr> <tr> <td>string $newtitle New title</td> <td>1</td> </tr> <tr> <td>int $id ID of MO</td> <td>1</td> </tr> <tr> <td>int $id Id of MO to update</td> <td>1</td> </tr> <tr> <td>int $id MO ID</td> <td>1</td> </tr> <tr> <td>int $id ID of state</td> <td>1</td> </tr> <tr> <td>array $request_data Request datas</td> <td>1</td> </tr> <tr> <td>string $role Get lines linked to current line with the selected role ('consumed', 'produced', ...)</td> <td>1</td> </tr> <tr> <td>int $lineid Id of production line to filter children</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $idline Id of line to delete</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $fk_movement Movement</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $mode Type line supported (0 by default) (0: consumed and produced lines; 1: consumed lines; 2: produced lines)</td> <td>1</td> </tr> <tr> <td>bool $also_delete_lines true if the consumed/produced lines is deleted (false by default)</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('nolink', '', 'production', ...)</td> <td>1</td> </tr> <tr> <td>string $rolefilter string lines role filter</td> <td>1</td> </tr> <tr> <td>string $restrictlist ''=All lines, 'services'=Restrict to services only</td> <td>1</td> </tr> <tr> <td>array $selectedLines Array of lines id for selected lines</td> <td>1</td> </tr> <tr> <td>MoLine $line Line</td> <td>1</td> </tr> <tr> <td>string $var Var</td> <td>1</td> </tr> <tr> <td>array $selectedLines Array of lines id for selected lines</td> <td>1</td> </tr> <tr> <td>int $depth Depth for recursing loop count</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter array. Example array('field'=>'valueforlike', 'customurl'=>...)</td> <td>1</td> </tr> <tr> <td>User $user User that create</td> <td>1</td> </tr> <tr> <td>DoliDB $db Handler access base de donnees</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $fk_user_author Id of new user</td> <td>1</td> </tr> <tr> <td>User $user User making change</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>User $userofexpensereport New user we want to have the expense report on.</td> <td>1</td> </tr> <tr> <td>int $id Id {@min 1}</td> <td>1</td> </tr> <tr> <td>string $ref Ref {@name ref}</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $status ID status</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $projectid Project id</td> <td>1</td> </tr> <tr> <td>User|null $user User that delete</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>User $fuser User</td> <td>1</td> </tr> <tr> <td>string $details Details</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>string $detail Detail</td> <td>1</td> </tr> <tr> <td>string $option Where point the link ('', 'document', ..)</td> <td>1</td> </tr> <tr> <td>string $ligne_total_ht Amount without taxes</td> <td>1</td> </tr> <tr> <td>string $ligne_total_tva Amount of all taxes</td> <td>1</td> </tr> <tr> <td>float $qty Qty</td> <td>1</td> </tr> <tr> <td>double $up Unit price (price with tax)</td> <td>1</td> </tr> <tr> <td>int $fk_c_type_fees Type payment</td> <td>1</td> </tr> <tr> <td>int<-1,0>|string $vatrate Vat rate (Can be '10' or '10 (ABC)')</td> <td>1</td> </tr> <tr> <td>string $date Date</td> <td>1</td> </tr> <tr> <td>string $comments Description</td> <td>1</td> </tr> <tr> <td>int $fk_project Project id</td> <td>1</td> </tr> <tr> <td>int $fk_c_exp_tax_cat Car category id</td> <td>1</td> </tr> <tr> <td>int $type Type line</td> <td>1</td> </tr> <tr> <td>int $fk_ecm_files Id of ECM file to link to this expensereport line</td> <td>1</td> </tr> <tr> <td>int $rowid Line to edit</td> <td>1</td> </tr> <tr> <td>int $type_fees_id Type payment</td> <td>1</td> </tr> <tr> <td>int $projet_id Project id</td> <td>1</td> </tr> <tr> <td>double $vatrate Vat rate. Can be '8.5' or '8.5* (8.5NPROM...)'</td> <td>1</td> </tr> <tr> <td>string $comments Description</td> <td>1</td> </tr> <tr> <td>float $qty Qty</td> <td>1</td> </tr> <tr> <td>double $value_unit Unit price (with taxes)</td> <td>1</td> </tr> <tr> <td>int $date Date</td> <td>1</td> </tr> <tr> <td>int $expensereport_id Expense report id</td> <td>1</td> </tr> <tr> <td>int $fk_c_exp_tax_cat Id of category of car</td> <td>1</td> </tr> <tr> <td>int $fk_ecm_files Id of ECM file to link to this expensereport line</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=No trigger</td> <td>1</td> </tr> <tr> <td>int $rowid Row id</td> <td>1</td> </tr> <tr> <td>User|string $fuser User</td> <td>1</td> </tr> <tr> <td>int<0,1> $notrigger 1=No trigger</td> <td>1</td> </tr> <tr> <td>User $fuser User</td> <td>1</td> </tr> <tr> <td>integer $date_debut Start date</td> <td>1</td> </tr> <tr> <td>integer $date_fin End date</td> <td>1</td> </tr> <tr> <td>string $modele Force le mnodele a utiliser ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs object lang a utiliser pour traduction</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide details of lines</td> <td>1</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>1</td> </tr> <tr> <td>int $hideref Hide ref</td> <td>1</td> </tr> <tr> <td>?array $moreparams Array to provide more information</td> <td>1</td> </tr> <tr> <td>int $active Active or not</td> <td>1</td> </tr> <tr> <td>string $option 'topay' or 'toapprove'</td> <td>1</td> </tr> <tr> <td>string $option 'topay' or 'toapprove'</td> <td>1</td> </tr> <tr> <td>int $fk_cat Category of the vehicle used</td> <td>1</td> </tr> <tr> <td>float $qty Number of kilometers</td> <td>1</td> </tr> <tr> <td>float $tva VAT rate</td> <td>1</td> </tr> <tr> <td>DoliDB $db Handlet database</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=No trigger</td> <td>1</td> </tr> <tr> <td>bool $fromaddline false=keep default behavior, true=exclude the update_price() of parent object</td> <td>1</td> </tr> <tr> <td>ExpenseReportRule $rule object rule to check</td> <td>1</td> </tr> <tr> <td>int $fk_user user author id</td> <td>1</td> </tr> <tr> <td>string $mode day|EX_DAY / month|EX_MON / year|EX_YEA to get amount</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>int $fk_c_type_fees type of expense</td> <td>1</td> </tr> <tr> <td>int|string $date date of expense</td> <td>1</td> </tr> <tr> <td>int $fk_user user of expense</td> <td>1</td> </tr> <tr> <td>int $id Id of Expense Report</td> <td>1</td> </tr> <tr> <td>int $id Id of Expense Report to update</td> <td>1</td> </tr> <tr> <td>int $id Expense Report ID</td> <td>1</td> </tr> <tr> <td>int $id Expense Report ID</td> <td>1</td> </tr> <tr> <td>int $pid Payment ID</td> <td>1</td> </tr> <tr> <td>int $id ID of expense report</td> <td>1</td> </tr> <tr> <td>array $request_data {@from body} Request data</td> <td>1</td> </tr> <tr> <td>int $id ID of paymentExpenseReport</td> <td>1</td> </tr> <tr> <td>array $request_data data</td> <td>1</td> </tr> <tr> <td>int $id ID of payment ExpenseReport</td> <td>1</td> </tr> <tr> <td>int $mode 1=only active; 2=only inactive; other value return all</td> <td>1</td> </tr> <tr> <td>User $userauthor user author id</td> <td>1</td> </tr> <tr> <td>int $fk_c_exp_tax_cat category</td> <td>1</td> </tr> <tr> <td>int $fk_c_exp_tax_cat category id</td> <td>1</td> </tr> <tr> <td>int $active active</td> <td>1</td> </tr> <tr> <td>int $default_c_exp_tax_cat id Default c_exp_tax_cat</td> <td>1</td> </tr> <tr> <td>string $mode 'payment_expensereport'</td> <td>1</td> </tr> <tr> <td>int $id Payment id</td> <td>1</td> </tr> <tr> <td>int $userid Id user for filter</td> <td>1</td> </tr> <tr> <td>array|string|object|null $content</td> <td>1</td> </tr> <tr> <td>string|string[] $rootElementName</td> <td>1</td> </tr> <tr> <td>string|array|object|XmlSerializable $value</td> <td>1</td> </tr> <tr> <td>object $object</td> <td>1</td> </tr> <tr> <td>LibXMLError[] $errors</td> <td>1</td> </tr> <tr> <td>Throwable $previousException</td> <td>1</td> </tr> <tr> <td>int $operation 1 = add, 2 = modify, 3 = delete</td> <td>1</td> </tr> <tr> <td>array $headers</td> <td>1</td> </tr> <tr> <td>resource $body</td> <td>1</td> </tr> <tr> <td>resource|callable|string $body</td> <td>1</td> </tr> <tr> <td>string $reportName</td> <td>1</td> </tr> <tr> <td>\DOMNode $dom</td> <td>1</td> </tr> <tr> <td>mixed $path</td> <td>1</td> </tr> <tr> <td>Xml\Request\AddressBookMultiGetReport $report</td> <td>1</td> </tr> <tr> <td>bool $modified should be set to true, if this event handler</td> <td>1</td> </tr> <tr> <td>Xml\Request\AddressBookQueryReport $report</td> <td>1</td> </tr> <tr> <td>string $vcardData</td> <td>1</td> </tr> <tr> <td>string $test anyof or allof (which means OR or AND)</td> <td>1</td> </tr> <tr> <td>string $mimeType</td> <td>1</td> </tr> <tr> <td>string $target</td> <td>1</td> </tr> <tr> <td>array $propertiesFilter</td> <td>1</td> </tr> <tr> <td>int $addressBookId</td> <td>1</td> </tr> <tr> <td>string $uri</td> <td>1</td> </tr> <tr> <td>array|string $privileges</td> <td>1</td> </tr> <tr> <td>int $recursion</td> <td>1</td> </tr> <tr> <td>bool $throwExceptions if set to false, this method won't throw exceptions</td> <td>1</td> </tr> <tr> <td>string $mainPrincipal</td> <td>1</td> </tr> <tr> <td>string $checkPrincipal</td> <td>1</td> </tr> <tr> <td>string $currentPrincipal</td> <td>1</td> </tr> <tr> <td>array $searchProperties The properties to search on. This is a</td> <td>1</td> </tr> <tr> <td>array $requestedProperties this is the list of properties to</td> <td>1</td> </tr> <tr> <td>string $collectionUri the principal collection to search on.</td> <td>1</td> </tr> <tr> <td>string $test "allof" to use AND to search the</td> <td>1</td> </tr> <tr> <td>string $path</td> <td>1</td> </tr> <tr> <td>Xml\Request\ExpandPropertyReport $report</td> <td>1</td> </tr> <tr> <td>array $path</td> <td>1</td> </tr> <tr> <td>array $requestedProperties the list of required properties</td> <td>1</td> </tr> <tr> <td>int $depth</td> <td>1</td> </tr> <tr> <td>string $path</td> <td>1</td> </tr> <tr> <td>Xml\Request\PrincipalSearchPropertySetReport $report</td> <td>1</td> </tr> <tr> <td>int $type</td> <td>1</td> </tr> <tr> <td>string|null $href</td> <td>1</td> </tr> <tr> <td>string $privilegeName</td> <td>1</td> </tr> <tr> <td>bool $prefixBaseUrl</td> <td>1</td> </tr> <tr> <td>string $privName</td> <td>1</td> </tr> <tr> <td>array $privilege</td> <td>1</td> </tr> <tr> <td>array $elems</td> <td>1</td> </tr> <tr> <td>string $storagePath where the actual files are stored</td> <td>1</td> </tr> <tr> <td>string $principalPrefix list of principals to iterate</td> <td>1</td> </tr> <tr> <td>string $collation</td> <td>1</td> </tr> <tr> <td>string $matchType</td> <td>1</td> </tr> <tr> <td>int $requestType</td> <td>1</td> </tr> <tr> <td>int $depth</td> <td>1</td> </tr> <tr> <td>array $mutations A list of updates</td> <td>1</td> </tr> <tr> <td>int $resultCode</td> <td>1</td> </tr> <tr> <td>int $resultCode</td> <td>1</td> </tr> <tr> <td>Tree|INode|array|null $treeOrNode The tree object</td> <td>1</td> </tr> <tr> <td>bool $sendResponse whether to send the HTTP response to the DAV client</td> <td>1</td> </tr> <tr> <td>mixed $default</td> <td>1</td> </tr> <tr> <td>array $yieldFirst</td> <td>1</td> </tr> <tr> <td>string $uri The new uri</td> <td>1</td> </tr> <tr> <td>array|\Traversable $fileProperties The list with nodes</td> <td>1</td> </tr> <tr> <td>bool $strip404s</td> <td>1</td> </tr> <tr> <td>$fileProperties</td> <td>1</td> </tr> <tr> <td>string[] $resourceType list of resourcetype values</td> <td>1</td> </tr> <tr> <td>array $mutations list of new properties values</td> <td>1</td> </tr> <tr> <td>string|string[] $resourceType</td> <td>1</td> </tr> <tr> <td>string|null $dataDir</td> <td>1</td> </tr> <tr> <td>string $name</td> <td>1</td> </tr> <tr> <td>string $contents</td> <td>1</td> </tr> <tr> <td>string|null $mimeType</td> <td>1</td> </tr> <tr> <td>INode[] $children</td> <td>1</td> </tr> <tr> <td>string $sourcePath The source location</td> <td>1</td> </tr> <tr> <td>string $destinationPath The full destination path</td> <td>1</td> </tr> <tr> <td>string $sourcePath The path to the file which should be moved</td> <td>1</td> </tr> <tr> <td>string $destinationPath The full destination path, so not just the destination parent node</td> <td>1</td> </tr> <tr> <td>array $paths list of nodes that must be fetched</td> <td>1</td> </tr> <tr> <td>string $destinationName</td> <td>1</td> </tr> <tr> <td>string $method</td> <td>1</td> </tr> <tr> <td>string $url</td> <td>1</td> </tr> <tr> <td>string|resource|null $body</td> <td>1</td> </tr> <tr> <td>string $body xml body</td> <td>1</td> </tr> <tr> <td>mixed $conditions</td> <td>1</td> </tr> <tr> <td>string $locksFile path to file</td> <td>1</td> </tr> <tr> <td>string $action</td> <td>1</td> </tr> <tr> <td>array $postVars</td> <td>1</td> </tr> <tr> <td>Backend\BackendInterface $authBackend</td> <td>1</td> </tr> <tr> <td>string $bearerToken</td> <td>1</td> </tr> <tr> <td>string $mailbox</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\Xml\Element\Response[] $responses</td> <td>1</td> </tr> <tr> <td>string $syncToken</td> <td>1</td> </tr> <tr> <td>mixed $report</td> <td>1</td> </tr> <tr> <td>string|string[] $reports</td> <td>1</td> </tr> <tr> <td>LockInfo[] $locks</td> <td>1</td> </tr> <tr> <td>array|string|null $resourceTypes</td> <td>1</td> </tr> <tr> <td>int|DateTime $time</td> <td>1</td> </tr> <tr> <td>int $shareAccess</td> <td>1</td> </tr> <tr> <td>string[] $methods</td> <td>1</td> </tr> <tr> <td>string $httpStatus</td> <td>1</td> </tr> <tr> <td>bool $enablePost</td> <td>1</td> </tr> <tr> <td>mixed $output</td> <td>1</td> </tr> <tr> <td>array $a</td> <td>1</td> </tr> <tr> <td>array $b</td> <td>1</td> </tr> <tr> <td>DAV\INode $node</td> <td>1</td> </tr> <tr> <td>HtmlOutputHelper $html</td> <td>1</td> </tr> <tr> <td>mixed $value</td> <td>1</td> </tr> <tr> <td>string $baseUri</td> <td>1</td> </tr> <tr> <td>scalar $input</td> <td>1</td> </tr> <tr> <td>string $targetName new local file/collection name</td> <td>1</td> </tr> <tr> <td>string $sourcePath Full path to source node</td> <td>1</td> </tr> <tr> <td>DAV\INode $sourceNode Source node itself</td> <td>1</td> </tr> <tr> <td>string $uri absolute uri</td> <td>1</td> </tr> <tr> <td>string $collectionUrl</td> <td>1</td> </tr> <tr> <td>array $conditions</td> <td>1</td> </tr> <tr> <td>string $overrideName</td> <td>1</td> </tr> <tr> <td>DAV\Locks\LockInfo $lock</td> <td>1</td> </tr> <tr> <td>string $principalUrl</td> <td>1</td> </tr> <tr> <td>CalendarMultiGetReport $report</td> <td>1</td> </tr> <tr> <td>Xml\Request\CalendarQueryReport $report</td> <td>1</td> </tr> <tr> <td>resource|string $data</td> <td>1</td> </tr> <tr> <td>string $path</td> <td>1</td> </tr> <tr> <td>bool $modified should be set to true, if this event handler</td> <td>1</td> </tr> <tr> <td>RequestInterface $request the http request</td> <td>1</td> </tr> <tr> <td>ResponseInterface $response the http response</td> <td>1</td> </tr> <tr> <td>bool $isNew is the item a new one, or an update</td> <td>1</td> </tr> <tr> <td>VObject\Node|string $check value to check against</td> <td>1</td> </tr> <tr> <td>array $calendarInfo</td> <td>1</td> </tr> <tr> <td>array $principalInfo</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\Server $server</td> <td>1</td> </tr> <tr> <td>string $path</td> <td>1</td> </tr> <tr> <td>DateTime|null $start</td> <td>1</td> </tr> <tr> <td>DateTime|null $end</td> <td>1</td> </tr> <tr> <td>bool $expand</td> <td>1</td> </tr> <tr> <td>string $componentType</td> <td>1</td> </tr> <tr> <td>string $format</td> <td>1</td> </tr> <tr> <td>array $properties</td> <td>1</td> </tr> <tr> <td>array $properties Some CalDAV properties</td> <td>1</td> </tr> <tr> <td>string $name Name of the file</td> <td>1</td> </tr> <tr> <td>resource $data initial payload, passed as a readable stream resource</td> <td>1</td> </tr> <tr> <td>string $senderEmail. The 'senderEmail' is the email that shows up</td> <td>1</td> </tr> <tr> <td>string $to Recipient email address</td> <td>1</td> </tr> <tr> <td>string $subject Subject of the email</td> <td>1</td> </tr> <tr> <td>string $body iCalendar body</td> <td>1</td> </tr> <tr> <td>array $headers List of headers</td> <td>1</td> </tr> <tr> <td>RequestInterface $request HTTP request</td> <td>1</td> </tr> <tr> <td>ResponseInterface $response HTTP Response</td> <td>1</td> </tr> <tr> <td>VCalendar $vCal Parsed iCalendar object</td> <td>1</td> </tr> <tr> <td>mixed $calendarPath Path to calendar collection</td> <td>1</td> </tr> <tr> <td>mixed $modified the iCalendar object has been touched</td> <td>1</td> </tr> <tr> <td>mixed $isNew Whether this was a new item or we're updating one</td> <td>1</td> </tr> <tr> <td>VCalendar|string|null $oldObject</td> <td>1</td> </tr> <tr> <td>array $ignore any addresses to not send messages to</td> <td>1</td> </tr> <tr> <td>bool $modified a marker to indicate that the original object modified by this process</td> <td>1</td> </tr> <tr> <td>string $email address</td> <td>1</td> </tr> <tr> <td>int $operation 1 = add, 2 = modify, 3 = delete</td> <td>1</td> </tr> <tr> <td>mixed $subscriptionId</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\PropPatch $propPatch</td> <td>1</td> </tr> <tr> <td>bool $canBeShared</td> <td>1</td> </tr> <tr> <td>bool $canBePublished</td> <td>1</td> </tr> <tr> <td>array $values All the options</td> <td>1</td> </tr> <tr> <td>string $etag</td> <td>1</td> </tr> <tr> <td>int $type</td> <td>1</td> </tr> <tr> <td>string $inReplyTo</td> <td>1</td> </tr> <tr> <td>string $summary</td> <td>1</td> </tr> <tr> <td>mixed $objects</td> <td>1</td> </tr> <tr> <td>DateTimeZone $timeZone</td> <td>1</td> </tr> <tr> <td>VCalendar[] $objects</td> <td>1</td> </tr> <tr> <td>string $arg1,... Unlimited number of args</td> <td>1</td> </tr> <tr> <td>array $children</td> <td>1</td> </tr> <tr> <td>bool $defaults</td> <td>1</td> </tr> <tr> <td>string $valueType Force a specific valuetype, such as URI or TEXT</td> <td>1</td> </tr> <tr> <td>string $valueParam</td> <td>1</td> </tr> <tr> <td>int $start</td> <td>1</td> </tr> <tr> <td>int $end</td> <td>1</td> </tr> <tr> <td>string $type FREE, BUSY, BUSY-UNAVAILABLE or BUSY-TENTATIVE</td> <td>1</td> </tr> <tr> <td>string $msg</td> <td>1</td> </tr> <tr> <td>resource|string|Component $expected</td> <td>1</td> </tr> <tr> <td>resource|string|Component $actual</td> <td>1</td> </tr> <tr> <td>string $message</td> <td>1</td> </tr> <tr> <td>string|resource|array $data</td> <td>1</td> </tr> <tr> <td>int $options</td> <td>1</td> </tr> <tr> <td>string $charset</td> <td>1</td> </tr> <tr> <td>string|null $name such as VCALENDAR, VEVENT</td> <td>1</td> </tr> <tr> <td>bool $defaults</td> <td>1</td> </tr> <tr> <td>string|Property|Component $item</td> <td>1</td> </tr> <tr> <td>string $tzid</td> <td>1</td> </tr> <tr> <td>false $failIfUncertain</td> <td>1</td> </tr> <tr> <td>string $dt</td> <td>1</td> </tr> <tr> <td>string $date</td> <td>1</td> </tr> <tr> <td>string $duration</td> <td>1</td> </tr> <tr> <td>bool $asString</td> <td>1</td> </tr> <tr> <td>string $date</td> <td>1</td> </tr> <tr> <td>DateTimeZone|string $referenceTz</td> <td>1</td> </tr> <tr> <td>string|array $part</td> <td>1</td> </tr> <tr> <td>$parameters list of parameters that will eventually be added to</td> <td>1</td> </tr> <tr> <td>VCalendar|string $calendar</td> <td>1</td> </tr> <tr> <td>string|array $userHref</td> <td>1</td> </tr> <tr> <td>VCalendar|string|null $oldCalendar</td> <td>1</td> </tr> <tr> <td>string $attendee</td> <td>1</td> </tr> <tr> <td>VCalendar $calendar</td> <td>1</td> </tr> <tr> <td>Component|array $input</td> <td>1</td> </tr> <tr> <td>string|null $uid</td> <td>1</td> </tr> <tr> <td>DateTimeZone $timeZone reference timezone for floating dates and</td> <td>1</td> </tr> <tr> <td>DateTimeInterface[] $dt</td> <td>1</td> </tr> <tr> <td>DateTimeZone $timeZone reference timezone for floating dates and</td> <td>1</td> </tr> <tr> <td>int $target</td> <td>1</td> </tr> <tr> <td>string $fieldName</td> <td>1</td> </tr> <tr> <td>int $options</td> <td>1</td> </tr> <tr> <td>resource|string|array|null $input</td> <td>1</td> </tr> <tr> <td>int $options</td> <td>1</td> </tr> <tr> <td>resource|string|array $input</td> <td>1</td> </tr> <tr> <td>string|resource|null $input</td> <td>1</td> </tr> <tr> <td>int $options</td> <td>1</td> </tr> <tr> <td>string $line Unfolded line</td> <td>1</td> </tr> <tr> <td>string $propertyNamePrefix</td> <td>1</td> </tr> <tr> <td>string $clarkedTagName</td> <td>1</td> </tr> <tr> <td>XML\Reader $reader</td> <td>1</td> </tr> <tr> <td>callable $callBack</td> <td>1</td> </tr> <tr> <td>float|null timeout</td> <td>1</td> </tr> <tr> <td>?string $vendorDir</td> <td>1</td> </tr> <tr> <td>string[] $classMap Class to filename map</td> <td>1</td> </tr> <tr> <td>string $prefix The prefix</td> <td>1</td> </tr> <tr> <td>string[]|string $paths The PSR-0 root directories</td> <td>1</td> </tr> <tr> <td>string $prefix The prefix/namespace, with trailing '\\'</td> <td>1</td> </tr> <tr> <td>string[]|string $paths The PSR-4 base directories</td> <td>1</td> </tr> <tr> <td>string $prefix The prefix</td> <td>1</td> </tr> <tr> <td>string[]|string $paths The PSR-0 base directories</td> <td>1</td> </tr> <tr> <td>string $prefix The prefix/namespace, with trailing '\\'</td> <td>1</td> </tr> <tr> <td>string[]|string $paths The PSR-4 base directories</td> <td>1</td> </tr> <tr> <td>bool $useIncludePath</td> <td>1</td> </tr> <tr> <td>bool $classMapAuthoritative</td> <td>1</td> </tr> <tr> <td>string|null $apcuPrefix</td> <td>1</td> </tr> <tr> <td>bool $prepend Whether to prepend the autoloader or not</td> <td>1</td> </tr> <tr> <td>string $class The name of the class</td> <td>1</td> </tr> <tr> <td>string $class The name of the class</td> <td>1</td> </tr> <tr> <td>string $class</td> <td>1</td> </tr> <tr> <td>string $ext</td> <td>1</td> </tr> <tr> <td>string $type</td> <td>1</td> </tr> <tr> <td>bool $includeDevRequirements</td> <td>1</td> </tr> <tr> <td>VersionParser $parser Install composer/semver to have access to this class and functionality</td> <td>1</td> </tr> <tr> <td>string $packageName</td> <td>1</td> </tr> <tr> <td>string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package</td> <td>1</td> </tr> <tr> <td>array[] $data A vendor/composer/installed.php data set</td> <td>1</td> </tr> <tr> <td>mixed $level</td> <td>1</td> </tr> <tr> <td>string $filename a valid filename</td> <td>1</td> </tr> <tr> <td>string $pdfdata The PDF file content</td> <td>1</td> </tr> <tr> <td>int $pageno pagenumber</td> <td>1</td> </tr> <tr> <td>mixed $value A PDF-Value. Structure of values see cases in this method</td> <td>1</td> </tr> <tr> <td>string $s</td> <td>1</td> </tr> <tr> <td>string $hex</td> <td>1</td> </tr> <tr> <td>$offset (int) Stream offset.</td> <td>1</td> </tr> <tr> <td>$length (int) Stream length.</td> <td>1</td> </tr> <tr> <td>$key (array) Object key to find (obj, gen).</td> <td>1</td> </tr> <tr> <td>int $pageno Pagenumber to use</td> <td>1</td> </tr> <tr> <td>array $obj Array of pdf-data</td> <td>1</td> </tr> <tr> <td>array $content_ref</td> <td>1</td> </tr> <tr> <td>array $obj</td> <td>1</td> </tr> <tr> <td>array $page a /Page</td> <td>1</td> </tr> <tr> <td>string $box_index Type of Box @see $availableBoxes</td> <td>1</td> </tr> <tr> <td>int The page number</td> <td>1</td> </tr> <tr> <td>array a /Page</td> <td>1</td> </tr> <tr> <td>integer $pageno</td> <td>1</td> </tr> <tr> <td>int $x The x-coordinate given in user-unit</td> <td>1</td> </tr> <tr> <td>int $y The y-coordinate given in user-unit</td> <td>1</td> </tr> <tr> <td>int $w The width given in user-unit</td> <td>1</td> </tr> <tr> <td>int $h The height given in user-unit</td> <td>1</td> </tr> <tr> <td>int $_x The x-position</td> <td>1</td> </tr> <tr> <td>int $_y The y-position</td> <td>1</td> </tr> <tr> <td>int $_w The new width of the template</td> <td>1</td> </tr> <tr> <td>int $_h The new height of the template</td> <td>1</td> </tr> <tr> <td>int $_w The width of the template</td> <td>1</td> </tr> <tr> <td>int $_h The height of the template</td> <td>1</td> </tr> <tr> <td>string $wkb</td> <td>1</td> </tr> <tr> <td>bool $is_hex_string</td> <td>1</td> </tr> <tr> <td>string $wkb An Extended-WKB binary string</td> <td>1</td> </tr> <tr> <td>string $georss - an XML feed containing geoRSS</td> <td>1</td> </tr> <tr> <td>string $return_type Should be either 'string' or 'array'</td> <td>1</td> </tr> <tr> <td>string - Address to geocode</td> <td>1</td> </tr> <tr> <td>string - Type of Geometry to return. Can either be 'points' or 'bounds' (polygon)</td> <td>1</td> </tr> <tr> <td>Geometry|bounds-array - Limit the search area to within this region. For example</td> <td>1</td> </tr> <tr> <td>return_multiple - Return all results in a multipoint or multipolygon</td> <td>1</td> </tr> <tr> <td>string $kml A KML string</td> <td>1</td> </tr> <tr> <td>mixed $input The GeoJSON string or object</td> <td>1</td> </tr> <tr> <td>Geometry $obj The object to serialize</td> <td>1</td> </tr> <tr> <td>Point $geometry</td> <td>1</td> </tr> <tr> <td>string $hash the geohash (lowercase)</td> <td>1</td> </tr> <tr> <td>string $direction the direction of the neighbor (top, bottom, left or right)</td> <td>1</td> </tr> <tr> <td>string $WKT A WKT string</td> <td>1</td> </tr> <tr> <td>Geometry $geometry A Geometry object</td> <td>1</td> </tr> <tr> <td>string $gpx A GPX string</td> <td>1</td> </tr> <tr> <td>array $points An array of at least two points with</td> <td>1</td> </tr> <tr> <td>array $components array of geometries</td> <td>1</td> </tr> <tr> <td>numeric $x The x coordinate (or longitude)</td> <td>1</td> </tr> <tr> <td>numeric $y The y coordinate (or latitude)</td> <td>1</td> </tr> <tr> <td>numeric $z The z coordinate (or altitude) - optional</td> <td>1</td> </tr> <tr> <td>boolean $pointOnBoundary - whether a boundary should be considered "in" or not</td> <td>1</td> </tr> <tr> <td>boolean $pointOnVertex - whether a vertex should be considered "in" or not</td> <td>1</td> </tr> <tr> <td>$w (float) width</td> <td>1</td> </tr> <tr> <td>$h (float) height</td> <td>1</td> </tr> <tr> <td>$x (float) X coordinate</td> <td>1</td> </tr> <tr> <td>$y (float) Y coodiante</td> <td>1</td> </tr> <tr> <td>$fitonpage (boolean) if true the block is resized to not exceed page dimensions.</td> <td>1</td> </tr> <tr> <td>$file (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg').</td> <td>1</td> </tr> <tr> <td>$x (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).</td> <td>1</td> </tr> <tr> <td>$y (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).</td> <td>1</td> </tr> <tr> <td>$resize (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).</td> <td>1</td> </tr> <tr> <td>$ismask (boolean) true if this image is a mask, false otherwise</td> <td>1</td> </tr> <tr> <td>$imgmask (mixed) image object returned by this function or false</td> <td>1</td> </tr> <tr> <td>$fitbox (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).</td> <td>1</td> </tr> <tr> <td>$hidden (boolean) If true do not display the image.</td> <td>1</td> </tr> <tr> <td>$fitonpage (boolean) If true the image is resized to not exceed page dimensions.</td> <td>1</td> </tr> <tr> <td>$alt (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned).</td> <td>1</td> </tr> <tr> <td>$altimgs (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.</td> <td>1</td> </tr> <tr> <td>$file (string) Name of the file containing the image.</td> <td>1</td> </tr> <tr> <td>$wpx (float) Original width of the image in pixels.</td> <td>1</td> </tr> <tr> <td>$hpx (float) original height of the image in pixels.</td> <td>1</td> </tr> <tr> <td>$resize (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library).</td> <td>1</td> </tr> <tr> <td>$filehash (string) File hash used to build unique file names.</td> <td>1</td> </tr> <tr> <td>$startxref (int) Offset at which the xref section starts (position of the 'xref' keyword).</td> <td>1</td> </tr> <tr> <td>$img (int) GD image Resource ID.</td> <td>1</td> </tr> <tr> <td>$c (int) alpha color</td> <td>1</td> </tr> <tr> <td>$h (float) The height of the break. By default, the value equals the height of the last printed cell.</td> <td>1</td> </tr> <tr> <td>$cell (boolean) if true add the current left (or right o for RTL) padding to the X coordinate</td> <td>1</td> </tr> <tr> <td>$y (float) The value of the ordinate in user units.</td> <td>1</td> </tr> <tr> <td>$resetx (bool) if true (default) reset the X position.</td> <td>1</td> </tr> <tr> <td>$x (float) The value of the abscissa.</td> <td>1</td> </tr> <tr> <td>$y (float) The value of the ordinate.</td> <td>1</td> </tr> <tr> <td>$name (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.</td> <td>1</td> </tr> <tr> <td>$dest (string) Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local server file with the name given by name.</li><li>S: return the document as a string (name is ignored).</li><li>FI: equivalent to F + I option</li><li>FD: equivalent to F + D option</li><li>E: return the document as base64 mime multi-part email attachment (RFC 2045)</li></ul></td> <td>1</td> </tr> <tr> <td>$filename (string) Filename of the PDF document to import.</td> <td>1</td> </tr> <tr> <td>$destroyall (boolean) if true destroys all class variables, otherwise preserves critical variables.</td> <td>1</td> </tr> <tr> <td>$preserve_objcopy (boolean) if true preserves the objcopy variable</td> <td>1</td> </tr> <tr> <td>$a (string) Base alias.</td> <td>1</td> </tr> <tr> <td>$aliases (array) Array of page aliases.</td> <td>1</td> </tr> <tr> <td>$diff (int) initial difference to add.</td> <td>1</td> </tr> <tr> <td>$boxes (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox').</td> <td>1</td> </tr> <tr> <td>$n (int) page number</td> <td>1</td> </tr> <tr> <td>$type (string) type of barcode: <ul><li>C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.</li><li>C39+ : CODE 39 with checksum</li><li>C39E : CODE 39 EXTENDED</li><li>C39E+ : CODE 39 EXTENDED + CHECKSUM</li><li>C93 : CODE 93 - USS-93</li><li>S25 : Standard 2 of 5</li><li>S25+ : Standard 2 of 5 + CHECKSUM</li><li>I25 : Interleaved 2 of 5</li><li>I25+ : Interleaved 2 of 5 + CHECKSUM</li><li>C128 : CODE 128</li><li>C128A : CODE 128 A</li><li>C128B : CODE 128 B</li><li>C128C : CODE 128 C</li><li>EAN2 : 2-Digits UPC-Based Extension</li><li>EAN5 : 5-Digits UPC-Based Extension</li><li>EAN8 : EAN 8</li><li>EAN13 : EAN 13</li><li>UPCA : UPC-A</li><li>UPCE : UPC-E</li><li>MSI : MSI (Variation of Plessey code)</li><li>MSI+ : MSI + CHECKSUM (modulo 11)</li><li>POSTNET : POSTNET</li><li>PLANET : PLANET</li><li>RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)</li><li>KIX : KIX (Klant index - Customer index)</li><li>IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200</li><li>CODABAR : CODABAR</li><li>CODE11 : CODE 11</li><li>PHARMA : PHARMACODE</li><li>PHARMA2T : PHARMACODE TWO-TRACKS</li></ul></td> <td>1</td> </tr> <tr> <td>$w (int) annotation width</td> <td>1</td> </tr> <tr> <td>$h (int) annotation height</td> <td>1</td> </tr> <tr> <td>$stream (string) appearance stream</td> <td>1</td> </tr> <tr> <td>$type (string) type of barcode: <ul><li>C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.</li><li>C39+ : CODE 39 with checksum</li><li>C39E : CODE 39 EXTENDED</li><li>C39E+ : CODE 39 EXTENDED + CHECKSUM</li><li>C93 : CODE 93 - USS-93</li><li>S25 : Standard 2 of 5</li><li>S25+ : Standard 2 of 5 + CHECKSUM</li><li>I25 : Interleaved 2 of 5</li><li>I25+ : Interleaved 2 of 5 + CHECKSUM</li><li>C128 : CODE 128</li><li>C128A : CODE 128 A</li><li>C128B : CODE 128 B</li><li>C128C : CODE 128 C</li><li>EAN2 : 2-Digits UPC-Based Extension</li><li>EAN5 : 5-Digits UPC-Based Extension</li><li>EAN8 : EAN 8</li><li>EAN13 : EAN 13</li><li>UPCA : UPC-A</li><li>UPCE : UPC-E</li><li>MSI : MSI (Variation of Plessey code)</li><li>MSI+ : MSI + CHECKSUM (modulo 11)</li><li>POSTNET : POSTNET</li><li>PLANET : PLANET</li><li>RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)</li><li>KIX : KIX (Klant index - Customer index)</li><li>IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200</li><li>IMBPRE: Pre-processed Intelligent Mail Barcode - Onecode - USPS-B-3200, using only F,A,D,T letters</li><li>CODABAR : CODABAR</li><li>CODE11 : CODE 11</li><li>PHARMA : PHARMACODE</li><li>PHARMA2T : PHARMACODE TWO-TRACKS</li></ul></td> <td>1</td> </tr> <tr> <td>$extended (boolean) if true uses the extended mode.</td> <td>1</td> </tr> <tr> <td>$checksum (boolean) if true add a checksum to the code.</td> <td>1</td> </tr> <tr> <td>$code (string) code to process.</td> <td>1</td> </tr> <tr> <td>$checksum (boolean) if true add a checksum to the code (modulo 11)</td> <td>1</td> </tr> <tr> <td>$seq (string) barcode as binary sequence.</td> <td>1</td> </tr> <tr> <td>$bararray (array) barcode array.</td> <td>1</td> </tr> <tr> <td>$type (string) barcode type: A, B, C or empty for automatic switch (AUTO mode)</td> <td>1</td> </tr> <tr> <td>$code (string) code to split.</td> <td>1</td> </tr> <tr> <td>$len (string) barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A</td> <td>1</td> </tr> <tr> <td>$len (string) barcode type: 2 = 2-Digit, 5 = 5-Digit</td> <td>1</td> </tr> <tr> <td>$xmp (string) Custom XMP data.</td> <td>1</td> </tr> <tr> <td>$xmp (string) Custom XMP RDF data.</td> <td>1</td> </tr> <tr> <td>$code (string) zip code to represent. Must be a string containing a zip code of the form DDDDD or DDDDD-DDDD.</td> <td>1</td> </tr> <tr> <td>$planet (boolean) if true print the PLANET barcode, otherwise print POSTNET</td> <td>1</td> </tr> <tr> <td>$kix (boolean) if true prints the KIX variation (doesn't use the start and end symbols, and the checksum) - in this case the house number must be sufficed with an X and placed at the end of the code.</td> <td>1</td> </tr> <tr> <td>$code (string) code to print, separate the ZIP (routing code) from the rest using a minus char '-' (BarcodeID_ServiceTypeID_MailerID_SerialNumber-RoutingCode)</td> <td>1</td> </tr> <tr> <td>$code (string) pre-formatted IMB barcode (65 chars "FADT")</td> <td>1</td> </tr> <tr> <td>$objid (int) Object ID (leave empty to get a new ID).</td> <td>1</td> </tr> <tr> <td>$txt (string) text to underline</td> <td>1</td> </tr> <tr> <td>$w (int) width to underline</td> <td>1</td> </tr> <tr> <td>$txt (string) text to linethrough</td> <td>1</td> </tr> <tr> <td>$w (int) line length (width)</td> <td>1</td> </tr> <tr> <td>$txt (string) text to overline</td> <td>1</td> </tr> <tr> <td>$w (int) width to overline</td> <td>1</td> </tr> <tr> <td>$s (string) data string to escape.</td> <td>1</td> </tr> <tr> <td>$time (mixed) Document creation timestamp in seconds or date-time string.</td> <td>1</td> </tr> <tr> <td>$time (mixed) Document modification timestamp in seconds or date-time string.</td> <td>1</td> </tr> <tr> <td>$n (int) Object ID.</td> <td>1</td> </tr> <tr> <td>$timestamp (int) Timestamp to convert.</td> <td>1</td> </tr> <tr> <td>$n (int) object reference for encryption mode</td> <td>1</td> </tr> <tr> <td>$language (array)</td> <td>1</td> </tr> <tr> <td>$url (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)</td> <td>1</td> </tr> <tr> <td>$name (string) link name</td> <td>1</td> </tr> <tr> <td>$color (array) array of RGB text color</td> <td>1</td> </tr> <tr> <td>$style (string) font style (U, D, B, I)</td> <td>1</td> </tr> <tr> <td>$px (int) pixels</td> <td>1</td> </tr> <tr> <td>$number (string) number to convert specified as a string</td> <td>1</td> </tr> <tr> <td>$text_to_convert (string) Text to convert.</td> <td>1</td> </tr> <tr> <td>$hex (string) hexadecimal number to convert specified as a string</td> <td>1</td> </tr> <tr> <td>$s (string) data string to encrypt</td> <td>1</td> </tr> <tr> <td>$code_arr (string) array of hexadecimal values (13 bytes holding 102 bits right justified).</td> <td>1</td> </tr> <tr> <td>$num (int) value to reversr</td> <td>1</td> </tr> <tr> <td>$n (int) is the type of table: 2 for 2of13 table, 5 for 5of13table</td> <td>1</td> </tr> <tr> <td>$size (int) size of table (78 for n=2 and 1287 for n=5)</td> <td>1</td> </tr> <tr> <td>$password (string) password</td> <td>1</td> </tr> <tr> <td>$permissions (Array) the set of permissions (specify the ones you want to block):<ul><li>print : Print the document;</li><li>modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';</li><li>copy : Copy or otherwise extract text and graphics from the document;</li><li>annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);</li><li>fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;</li><li>extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);</li><li>assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;</li><li>print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.</li><li>owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.</li></ul></td> <td>1</td> </tr> <tr> <td>$user_pass (String) user password. Empty by default.</td> <td>1</td> </tr> <tr> <td>$owner_pass (String) owner password. If not specified, a random value is used.</td> <td>1</td> </tr> <tr> <td>$pubkeys (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))</td> <td>1</td> </tr> <tr> <td>$unicode (boolean) TRUE means that the input text is unicode (default = true)</td> <td>1</td> </tr> <tr> <td>$encoding (string) Charset encoding (used only when converting back html entities); default is UTF-8.</td> <td>1</td> </tr> <tr> <td>$diskcache (boolean) DEPRECATED FEATURE</td> <td>1</td> </tr> <tr> <td>$pdfa (integer) If not false, set the document to PDF/A mode and the good version (1 or 3).</td> <td>1</td> </tr> <tr> <td>$s (float) scaling factor for width and height as percent. 0 is not allowed.</td> <td>1</td> </tr> <tr> <td>$format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numbers (width, height) or an array containing the following measures and options:<ul></td> <td>1</td> </tr> <tr> <td>$orientation (string) page orientation. Possible values are (case insensitive):<ul></td> <td>1</td> </tr> <tr> <td>$angle (float) gradient angle of the straight line. Default is 0 (horizontal line).</td> <td>1</td> </tr> <tr> <td>$t_x (int) movement to the right (or left for RTL)</td> <td>1</td> </tr> <tr> <td>$autopagebreak (boolean) Boolean indicating if auto-page-break mode should be on or off.</td> <td>1</td> </tr> <tr> <td>$bottommargin (float) bottom margin of the page.</td> <td>1</td> </tr> <tr> <td>$t_x (int) movement to the right</td> <td>1</td> </tr> <tr> <td>$angle (float) angle in degrees for counter-clockwise rotation</td> <td>1</td> </tr> <tr> <td>$x (int) abscissa of the rotation center. Default is current x position</td> <td>1</td> </tr> <tr> <td>$y (int) ordinate of the rotation center. Default is current y position</td> <td>1</td> </tr> <tr> <td>$tm (array) transformation matrix</td> <td>1</td> </tr> <tr> <td>$width (float) The width.</td> <td>1</td> </tr> <tr> <td>$style (array) Line style. Array with keys among the following:</td> <td>1</td> </tr> <tr> <td>$ret (boolean) if true do not send the command.</td> <td>1</td> </tr> <tr> <td>$x (float) Abscissa of point.</td> <td>1</td> </tr> <tr> <td>$y (float) Ordinate of point.</td> <td>1</td> </tr> <tr> <td>$x (float) Abscissa of end point.</td> <td>1</td> </tr> <tr> <td>$y (float) Ordinate of end point.</td> <td>1</td> </tr> <tr> <td>$op (string) options</td> <td>1</td> </tr> <tr> <td>$re (string) regular expression (leave empty for default).</td> <td>1</td> </tr> <tr> <td>$x1 (float) Abscissa of first point.</td> <td>1</td> </tr> <tr> <td>$y1 (float) Ordinate of first point.</td> <td>1</td> </tr> <tr> <td>$x2 (float) Abscissa of second point.</td> <td>1</td> </tr> <tr> <td>$y2 (float) Ordinate of second point.</td> <td>1</td> </tr> <tr> <td>$style (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>1</td> </tr> <tr> <td>$border_style (array) Border style of rectangle. Array with keys among the following:</td> <td>1</td> </tr> <tr> <td>$segments (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).</td> <td>1</td> </tr> <tr> <td>$astart: (float) Angle start of draw line. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$afinish: (float) Angle finish of draw line. Default value: 360.</td> <td>1</td> </tr> <tr> <td>$line_style (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>1</td> </tr> <tr> <td>$enable (Boolean) if true enable Right-To-Left language mode.</td> <td>1</td> </tr> <tr> <td>$resetx (Boolean) if true reset the X position on direction change.</td> <td>1</td> </tr> <tr> <td>$xc (float) Abscissa of center point.</td> <td>1</td> </tr> <tr> <td>$yc (float) Ordinate of center point.</td> <td>1</td> </tr> <tr> <td>$xang: (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$angs: (float) Angle start of draw line. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$angf: (float) Angle finish of draw line. Default value: 360.</td> <td>1</td> </tr> <tr> <td>$pie (boolean) if true do not mark the border point (used to draw pie sectors).</td> <td>1</td> </tr> <tr> <td>$startpoint (boolean) if true output a starting point.</td> <td>1</td> </tr> <tr> <td>$ccw (boolean) if true draws in counter-clockwise.</td> <td>1</td> </tr> <tr> <td>$svg (boolean) if true the angles are in svg mode (already calculated).</td> <td>1</td> </tr> <tr> <td>$mode (mixed) can be false, 'L' for LTR or 'R' for RTL</td> <td>1</td> </tr> <tr> <td>$r (float) Radius.</td> <td>1</td> </tr> <tr> <td>$angstr: (float) Angle start of draw line. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$angend: (float) Angle finish of draw line. Default value: 360.</td> <td>1</td> </tr> <tr> <td>$line_style (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>1</td> </tr> <tr> <td>$nc (integer) Number of curves used to draw a 90 degrees portion of circle.</td> <td>1</td> </tr> <tr> <td>$h (float) cell height.</td> <td>1</td> </tr> <tr> <td>$fontsize (int) Font size in internal units</td> <td>1</td> </tr> <tr> <td>$padding (boolean) If true add cell padding</td> <td>1</td> </tr> <tr> <td>$scale (float) adjusting factor to convert pixels to user units.</td> <td>1</td> </tr> <tr> <td>$left (float) Left margin.</td> <td>1</td> </tr> <tr> <td>$top (float) Top margin.</td> <td>1</td> </tr> <tr> <td>$right (float) Right margin. Default value is the left one.</td> <td>1</td> </tr> <tr> <td>$keepmargins (boolean) if true overwrites the default page margins</td> <td>1</td> </tr> <tr> <td>$pad (float) internal padding.</td> <td>1</td> </tr> <tr> <td>$left (float) left padding</td> <td>1</td> </tr> <tr> <td>$top (float) top padding</td> <td>1</td> </tr> <tr> <td>$right (float) right padding</td> <td>1</td> </tr> <tr> <td>$bottom (float) bottom padding</td> <td>1</td> </tr> <tr> <td>$left (float) left margin</td> <td>1</td> </tr> <tr> <td>$top (float) top margin</td> <td>1</td> </tr> <tr> <td>$right (float) right margin</td> <td>1</td> </tr> <tr> <td>$bottom (float) bottom margin</td> <td>1</td> </tr> <tr> <td>$auto (boolean) Boolean indicating if mode should be on or off.</td> <td>1</td> </tr> <tr> <td>$margin (float) Distance from the bottom of the page.</td> <td>1</td> </tr> <tr> <td>$closed (boolean) if true the polygon is closes, otherwise will remain open</td> <td>1</td> </tr> <tr> <td>$r: (float) Radius of inscribed circle.</td> <td>1</td> </tr> <tr> <td>$ns (integer) Number of sides.</td> <td>1</td> </tr> <tr> <td>$angle (float) Angle oriented (anti-clockwise). Default value: 0.</td> <td>1</td> </tr> <tr> <td>$draw_circle (boolean) Draw inscribed circle or not. Default value: false.</td> <td>1</td> </tr> <tr> <td>$zoom (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul></td> <td>1</td> </tr> <tr> <td>$compress (boolean) Boolean indicating if compression must be enabled.</td> <td>1</td> </tr> <tr> <td>$mode (boolean) If true force sRGB output intent.</td> <td>1</td> </tr> <tr> <td>$r (float) Radius of inscribed circle.</td> <td>1</td> </tr> <tr> <td>$nv (integer) Number of vertices.</td> <td>1</td> </tr> <tr> <td>$ng (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon).</td> <td>1</td> </tr> <tr> <td>$draw_circle: (boolean) Draw inscribed circle or not. Default value is false.</td> <td>1</td> </tr> <tr> <td>$unicode (boolean) if true set the meta information in Unicode</td> <td>1</td> </tr> <tr> <td>$title (string) The title.</td> <td>1</td> </tr> <tr> <td>$subject (string) The subject.</td> <td>1</td> </tr> <tr> <td>$author (string) The name of the author.</td> <td>1</td> </tr> <tr> <td>$keywords (string) The list of keywords.</td> <td>1</td> </tr> <tr> <td>$creator (string) The name of the creator.</td> <td>1</td> </tr> <tr> <td>$r (float) the radius of the circle used to round off the corners of the rectangle.</td> <td>1</td> </tr> <tr> <td>$pnum (int) page number (1 ... numpages)</td> <td>1</td> </tr> <tr> <td>$rx (float) the x-axis radius of the ellipse used to round off the corners of the rectangle.</td> <td>1</td> </tr> <tr> <td>$ry (float) the y-axis radius of the ellipse used to round off the corners of the rectangle.</td> <td>1</td> </tr> <tr> <td>$x0 (float) Abscissa of first point.</td> <td>1</td> </tr> <tr> <td>$y0 (float) Ordinate of first point.</td> <td>1</td> </tr> <tr> <td>$x1 (float) Abscissa of second point.</td> <td>1</td> </tr> <tr> <td>$y1 (float) Ordinate of second point.</td> <td>1</td> </tr> <tr> <td>$head_style (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)</td> <td>1</td> </tr> <tr> <td>$arm_size (float) length of arrowhead arms</td> <td>1</td> </tr> <tr> <td>$arm_angle (int) angle between an arm and the shaft</td> <td>1</td> </tr> <tr> <td>$orientation (string) page orientation.</td> <td>1</td> </tr> <tr> <td>$tocpage (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content).</td> <td>1</td> </tr> <tr> <td>$tocpage (boolean) if true set the tocpage state to false (end the page used to display Table Of Content).</td> <td>1</td> </tr> <tr> <td>$tocpage (boolean) if true the page is designated to contain the Table-Of-Content.</td> <td>1</td> </tr> <tr> <td>$name (string) Destination name.</td> <td>1</td> </tr> <tr> <td>$y (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;).</td> <td>1</td> </tr> <tr> <td>$x (float) X position in user units of the destiantion on the selected page (default = -1 = current position;).</td> <td>1</td> </tr> <tr> <td>$page (int) page number (default is the current page)</td> <td>1</td> </tr> <tr> <td>$ln (string) header image logo</td> <td>1</td> </tr> <tr> <td>$lw (string) header image logo width in mm</td> <td>1</td> </tr> <tr> <td>$ht (string) string to print as title on document header</td> <td>1</td> </tr> <tr> <td>$hs (string) string to print on document header</td> <td>1</td> </tr> <tr> <td>$hm (int) distance in user units</td> <td>1</td> </tr> <tr> <td>$fm (int) distance in user units</td> <td>1</td> </tr> <tr> <td>$val (boolean) set to true to print the page header (default), false otherwise.</td> <td>1</td> </tr> <tr> <td>$val (boolean) set to true to print the page footer (default), false otherwise.</td> <td>1</td> </tr> <tr> <td>$val (boolean) set to true to reset Header xobject template at each page, false otherwise.</td> <td>1</td> </tr> <tr> <td>$onload (boolean) if true executes this object when opening the document</td> <td>1</td> </tr> <tr> <td>$type (string) field type</td> <td>1</td> </tr> <tr> <td>$x (int) horizontal position</td> <td>1</td> </tr> <tr> <td>$y (int) vertical position</td> <td>1</td> </tr> <tr> <td>$name (string) Field name.</td> <td>1</td> </tr> <tr> <td>$w (int) Width of the radio button.</td> <td>1</td> </tr> <tr> <td>$prop (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td> <td>1</td> </tr> <tr> <td>$opt (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference.</td> <td>1</td> </tr> <tr> <td>$onvalue (string) Value to be returned if selected.</td> <td>1</td> </tr> <tr> <td>$checked (boolean) Define the initial state.</td> <td>1</td> </tr> <tr> <td>$js (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered).</td> <td>1</td> </tr> <tr> <td>$name (string) Full name of the spot color.</td> <td>1</td> </tr> <tr> <td>$c (float) Cyan color for CMYK. Value between 0 and 100.</td> <td>1</td> </tr> <tr> <td>$m (float) Magenta color for CMYK. Value between 0 and 100.</td> <td>1</td> </tr> <tr> <td>$y (float) Yellow color for CMYK. Value between 0 and 100.</td> <td>1</td> </tr> <tr> <td>$k (float) Key (Black) color for CMYK. Value between 0 and 100.</td> <td>1</td> </tr> <tr> <td>$tint (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).</td> <td>1</td> </tr> <tr> <td>$color (array) Array of colors (1=gray, 3=RGB, 4=CMYK or 5=spotcolor=CMYK+name values).</td> <td>1</td> </tr> <tr> <td>$s (string) The string whose length is to be computed</td> <td>1</td> </tr> <tr> <td>$fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line-through</li><li>O: overline</li></ul> or any combination. The default value is regular.</td> <td>1</td> </tr> <tr> <td>$sa (string) The array of chars whose total length is to be computed</td> <td>1</td> </tr> <tr> <td>$fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular.</td> <td>1</td> </tr> <tr> <td>$notlast (boolean) If false ignore the font-spacing.</td> <td>1</td> </tr> <tr> <td>$checked (boolean) define the initial state.</td> <td>1</td> </tr> <tr> <td>$onvalue (string) value to be returned if selected.</td> <td>1</td> </tr> <tr> <td>$s (string) The input string.</td> <td>1</td> </tr> <tr> <td>$family (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.</td> <td>1</td> </tr> <tr> <td>$style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul></td> <td>1</td> </tr> <tr> <td>$family (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.</td> <td>1</td> </tr> <tr> <td>$style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.</td> <td>1</td> </tr> <tr> <td>$size (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12</td> <td>1</td> </tr> <tr> <td>$caption (string) caption.</td> <td>1</td> </tr> <tr> <td>$action (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.</td> <td>1</td> </tr> <tr> <td>$enable (boolean) if true enable user's rights on PDF reader</td> <td>1</td> </tr> <tr> <td>$document (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.</td> <td>1</td> </tr> <tr> <td>$annots (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.</td> <td>1</td> </tr> <tr> <td>$form (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate</td> <td>1</td> </tr> <tr> <td>$signature (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.</td> <td>1</td> </tr> <tr> <td>$ef (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files</td> <td>1</td> </tr> <tr> <td>$formex (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.</td> <td>1</td> </tr> <tr> <td>$signing_cert (mixed) signing certificate (string or filename prefixed with 'file://')</td> <td>1</td> </tr> <tr> <td>$private_key (mixed) private key (string or filename prefixed with 'file://')</td> <td>1</td> </tr> <tr> <td>$private_key_password (string) password</td> <td>1</td> </tr> <tr> <td>$extracerts (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.</td> <td>1</td> </tr> <tr> <td>$cert_type (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.</td> <td>1</td> </tr> <tr> <td>$info (array) array of option information: Name, Location, Reason, ContactInfo.</td> <td>1</td> </tr> <tr> <td>$approval (string) Enable approval signature eg. for PDF incremental update</td> <td>1</td> </tr> <tr> <td>$tsa_host (string) Time Stamping Authority (TSA) server (prefixed with 'https://')</td> <td>1</td> </tr> <tr> <td>$tsa_username (string) Specifies the username for TSA authorization (optional) OR specifies the TSA authorization PEM file (see: example_66.php, optional)</td> <td>1</td> </tr> <tr> <td>$tsa_password (string) Specifies the password for TSA authorization (optional)</td> <td>1</td> </tr> <tr> <td>$tsa_cert (string) Specifies the location of TSA certificate for authorization (optional for cURL)</td> <td>1</td> </tr> <tr> <td>$size (float) The font size in points.</td> <td>1</td> </tr> <tr> <td>$s (int) Font measure.</td> <td>1</td> </tr> <tr> <td>$char (int) Input character code.</td> <td>1</td> </tr> <tr> <td>$char (mixed) Character to check (integer value or string)</td> <td>1</td> </tr> <tr> <td>$text (string) Text to process.</td> <td>1</td> </tr> <tr> <td>$subs (array) Array of possible character substitutions. The key is the character to check (integer value) and the value is a single intege value or an array of possible substitutes.</td> <td>1</td> </tr> <tr> <td>$font (string) Font name.</td> <td>1</td> </tr> <tr> <td>$link (int) The link identifier returned by AddLink()</td> <td>1</td> </tr> <tr> <td>$y (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)</td> <td>1</td> </tr> <tr> <td>$page (int) Number of target page; -1 indicates the current page (default value). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.</td> <td>1</td> </tr> <tr> <td>$text (string) annotation text or alternate content</td> <td>1</td> </tr> <tr> <td>$opt (array) array of options (see section 8.4 of PDF reference 1.7).</td> <td>1</td> </tr> <tr> <td>$signature (string) Digital signature as binary string</td> <td>1</td> </tr> <tr> <td>$page (int) starting group page (leave empty for next page).</td> <td>1</td> </tr> <tr> <td>$num (int) Starting page number.</td> <td>1</td> </tr> <tr> <td>$name (string) Layer name (only a-z letters and numbers). Leave empty for automatic name.</td> <td>1</td> </tr> <tr> <td>$print (boolean|null) Set to TRUE to print this layer, FALSE to not print and NULL to not set this option</td> <td>1</td> </tr> <tr> <td>$view (boolean) Set to true to view this layer.</td> <td>1</td> </tr> <tr> <td>$lock (boolean) If true lock the layer</td> <td>1</td> </tr> <tr> <td>$v (string) visibility mode. Legal values are: all, print, screen or view.</td> <td>1</td> </tr> <tr> <td>$parms (array) parameters</td> <td>1</td> </tr> <tr> <td>$gs (array) extgstate</td> <td>1</td> </tr> <tr> <td>$x (float) Abscissa of the cell origin</td> <td>1</td> </tr> <tr> <td>$y (float) Ordinate of the cell origin</td> <td>1</td> </tr> <tr> <td>$fstroke (int) outline size in user units (false = disable)</td> <td>1</td> </tr> <tr> <td>$fclip (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).</td> <td>1</td> </tr> <tr> <td>$ffill (boolean) if true fills the text</td> <td>1</td> </tr> <tr> <td>$calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li><li>B : cell bottom</li></ul></td> <td>1</td> </tr> <tr> <td>$rtloff (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position.</td> <td>1</td> </tr> <tr> <td>$stroking (boolean) If true apply overprint for stroking operations.</td> <td>1</td> </tr> <tr> <td>$nonstroking (boolean) If true apply overprint for painting operations other than stroking.</td> <td>1</td> </tr> <tr> <td>$mode (integer) Overprint mode: (0 = each source colour component value replaces the value previously painted for the corresponding device colorant; 1 = a tint value of 0.0 for a source colour component shall leave the corresponding component of the previously painted colour unchanged).</td> <td>1</td> </tr> <tr> <td>$stroking (float) Alpha value for stroking operations: real value from 0 (transparent) to 1 (opaque).</td> <td>1</td> </tr> <tr> <td>$bm (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity</td> <td>1</td> </tr> <tr> <td>$nonstroking (float) Alpha value for non-stroking operations: real value from 0 (transparent) to 1 (opaque).</td> <td>1</td> </tr> <tr> <td>$ais (boolean)</td> <td>1</td> </tr> <tr> <td>$y (mixed) starting y position, leave empty for current position.</td> <td>1</td> </tr> <tr> <td>$addpage (boolean) if true add a page, otherwise only return the true/false state</td> <td>1</td> </tr> <tr> <td>$quality (int) JPEG quality, integer between 1 and 100</td> <td>1</td> </tr> <tr> <td>$cols (int) number of columns</td> <td>1</td> </tr> <tr> <td>$ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$h (int) cell proportion respect font height (typical value = 1.25).</td> <td>1</td> </tr> <tr> <td>$version (string) PDF document version.</td> <td>1</td> </tr> <tr> <td>$preferences (array) array of options.</td> <td>1</td> </tr> <tr> <td>$transition (boolean) if true prints tcolor transitions to white.</td> <td>1</td> </tr> <tr> <td>$vertical (boolean) if true prints bar vertically.</td> <td>1</td> </tr> <tr> <td>$colors (string) colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.</td> <td>1</td> </tr> <tr> <td>$x (float) abscissa of the crop mark center.</td> <td>1</td> </tr> <tr> <td>$y (float) ordinate of the crop mark center.</td> <td>1</td> </tr> <tr> <td>$w (float) width of the crop mark.</td> <td>1</td> </tr> <tr> <td>$h (float) height of the crop mark.</td> <td>1</td> </tr> <tr> <td>$type (string) type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT.</td> <td>1</td> </tr> <tr> <td>$color (array) crop mark color (default spot registration color).</td> <td>1</td> </tr> <tr> <td>$valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>M : middle</li><li>B : bottom</li></ul></td> <td>1</td> </tr> <tr> <td>$oldchar (int) Integer code (unicode) of the character to replace.</td> <td>1</td> </tr> <tr> <td>$newchar (int) Integer code (unicode) of the new character.</td> <td>1</td> </tr> <tr> <td>$double (boolean) if true print two concentric crop marks.</td> <td>1</td> </tr> <tr> <td>$cola (array) crop mark color (default spot registration color 'All').</td> <td>1</td> </tr> <tr> <td>$colb (array) second crop mark color (default spot registration color 'None').</td> <td>1</td> </tr> <tr> <td>$coords (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).</td> <td>1</td> </tr> <tr> <td>$coords (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.</td> <td>1</td> </tr> <tr> <td>$col1 (array) first color (lower left corner) (RGB components).</td> <td>1</td> </tr> <tr> <td>$col2 (array) second color (lower right corner) (RGB components).</td> <td>1</td> </tr> <tr> <td>$col3 (array) third color (upper right corner) (RGB components).</td> <td>1</td> </tr> <tr> <td>$col4 (array) fourth color (upper left corner) (RGB components).</td> <td>1</td> </tr> <tr> <td>$coords (array) <ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul></td> <td>1</td> </tr> <tr> <td>$coords_min (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0</td> <td>1</td> </tr> <tr> <td>$coords_max (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1</td> <td>1</td> </tr> <tr> <td>$x (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode).</td> <td>1</td> </tr> <tr> <td>$type (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)</td> <td>1</td> </tr> <tr> <td>$coords (array) array of coordinates.</td> <td>1</td> </tr> <tr> <td>$stops (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).</td> <td>1</td> </tr> <tr> <td>$background (array) An array of colour components appropriate to the colour space, specifying a single background colour value.</td> <td>1</td> </tr> <tr> <td>$x (float) X coordinate.</td> <td>1</td> </tr> <tr> <td>$y (float) Y coordinate.</td> <td>1</td> </tr> <tr> <td>$w (float) Cell width.</td> <td>1</td> </tr> <tr> <td>$h (float) Cell height.</td> <td>1</td> </tr> <tr> <td>$align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul></td> <td>1</td> </tr> <tr> <td>$ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul></td> <td>1</td> </tr> <tr> <td>$x (float) x position in user units</td> <td>1</td> </tr> <tr> <td>$y (float) y position in user units</td> <td>1</td> </tr> <tr> <td>$ishtml (boolean) INTERNAL USE ONLY -- set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods.</td> <td>1</td> </tr> <tr> <td>$maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.</td> <td>1</td> </tr> <tr> <td>$valign (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:<ul><li>T: TOP</li><li>M: middle</li><li>B: bottom</li></ul>. This feature works only when $ishtml=false and the cell must fit in a single page.</td> <td>1</td> </tr> <tr> <td>$fitcell (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). $maxh must be greater than 0 and equal to $h.</td> <td>1</td> </tr> <tr> <td>$rx (float) the x-axis radius.</td> <td>1</td> </tr> <tr> <td>$ry (float) the y-axis radius.</td> <td>1</td> </tr> <tr> <td>$cw: (float) indicates whether to go clockwise.</td> <td>1</td> </tr> <tr> <td>$o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).</td> <td>1</td> </tr> <tr> <td>$nc (integer) Number of curves used to draw a 90 degrees portion of arc.</td> <td>1</td> </tr> <tr> <td>$r (float) radius.</td> <td>1</td> </tr> <tr> <td>$cw: (float) indicates whether to go clockwise (default: true).</td> <td>1</td> </tr> <tr> <td>$o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.</td> <td>1</td> </tr> <tr> <td>$file (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string.</td> <td>1</td> </tr> <tr> <td>$useBoundingBox (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.</td> <td>1</td> </tr> <tr> <td>$fixoutvals (boolean) if true remove values outside the bounding box.</td> <td>1</td> </tr> <tr> <td>$bc (string) barcode</td> <td>1</td> </tr> <tr> <td>$type (string) type of barcode (see tcpdf_barcodes_1d.php for supported formats).</td> <td>1</td> </tr> <tr> <td>$x (int) x position in user units (empty string = current x position)</td> <td>1</td> </tr> <tr> <td>$y (int) y position in user units (empty string = current y position)</td> <td>1</td> </tr> <tr> <td>$w (int) width in user units (empty string = remaining page width)</td> <td>1</td> </tr> <tr> <td>$h (int) height in user units (empty string = remaining page height)</td> <td>1</td> </tr> <tr> <td>$xres (float) width of the smallest bar in user units (empty string = default value = 0.4mm)</td> <td>1</td> </tr> <tr> <td>$type (string) type of barcode (see tcpdf_barcodes_2d.php for supported formats).</td> <td>1</td> </tr> <tr> <td>$x (int) x position in user units</td> <td>1</td> </tr> <tr> <td>$y (int) y position in user units</td> <td>1</td> </tr> <tr> <td>$w (int) width in user units</td> <td>1</td> </tr> <tr> <td>$h (int) height in user units</td> <td>1</td> </tr> <tr> <td>$distort (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio</td> <td>1</td> </tr> <tr> <td>$h (float) Line height</td> <td>1</td> </tr> <tr> <td>$ln (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.</td> <td>1</td> </tr> <tr> <td>$maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.</td> <td>1</td> </tr> <tr> <td>$wadj (float) first line width will be reduced by this amount (used in HTML mode).</td> <td>1</td> </tr> <tr> <td>$margin (array) margin array of the parent container</td> <td>1</td> </tr> <tr> <td>$width (string) border width</td> <td>1</td> </tr> <tr> <td>$style (string) border style to convert</td> <td>1</td> </tr> <tr> <td>$cssborder (string) border properties</td> <td>1</td> </tr> <tr> <td>$csspadding (string) padding properties</td> <td>1</td> </tr> <tr> <td>$cssmargin (string) margin properties</td> <td>1</td> </tr> <tr> <td>$cssbspace (string) border-spacing CSS properties</td> <td>1</td> </tr> <tr> <td>$spacing (string) letter-spacing value</td> <td>1</td> </tr> <tr> <td>$parent (float) font spacing (tracking) value of the parent element</td> <td>1</td> </tr> <tr> <td>$stretch (string) stretch mode</td> <td>1</td> </tr> <tr> <td>$parent (float) stretch value of the parent element</td> <td>1</td> </tr> <tr> <td>$val (string) String containing font size value and unit.</td> <td>1</td> </tr> <tr> <td>$parent_size (float) Parent font size in points.</td> <td>1</td> </tr> <tr> <td>$html (string) html code</td> <td>1</td> </tr> <tr> <td>$data (array) parameters array</td> <td>1</td> </tr> <tr> <td>$x (float) upper-left corner X coordinate</td> <td>1</td> </tr> <tr> <td>$y (float) upper-left corner Y coordinate</td> <td>1</td> </tr> <tr> <td>$html (string) html text to print. Default value: empty string.</td> <td>1</td> </tr> <tr> <td>$ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.</td> <td>1</td> </tr> <tr> <td>$html (string) text to display</td> <td>1</td> </tr> <tr> <td>$ln (boolean) if true add a new line after text (default = true)</td> <td>1</td> </tr> <tr> <td>$fill (boolean) Indicates if the background must be painted (true) or transparent (false).</td> <td>1</td> </tr> <tr> <td>$cell (boolean) if true add the current left (or right for RTL) padding to each Write (default false).</td> <td>1</td> </tr> <tr> <td>$maxbottomliney (int) maximum y value of current line</td> <td>1</td> </tr> <tr> <td>$hbz (string) Distance between current y and line bottom.</td> <td>1</td> </tr> <tr> <td>$hb (string) The height of the break.</td> <td>1</td> </tr> <tr> <td>$firsttag (boolean) set to true when the tag is the first.</td> <td>1</td> </tr> <tr> <td>$lasttag (boolean) set to true when the tag is the last.</td> <td>1</td> </tr> <tr> <td>$tag (array) array of tag properties.</td> <td>1</td> </tr> <tr> <td>$xmax (int) end X coordinate for border.</td> <td>1</td> </tr> <tr> <td>$symbol (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext')</td> <td>1</td> </tr> <tr> <td>$booklet (boolean) true set the booklet mode on, false otherwise.</td> <td>1</td> </tr> <tr> <td>$inner (float) Inner page margin.</td> <td>1</td> </tr> <tr> <td>$outer (float) Outer page margin.</td> <td>1</td> </tr> <tr> <td>$reverse (boolean) if true swap left and right margins.</td> <td>1</td> </tr> <tr> <td>$tagvs (array) array of tags and relative vertical spaces.</td> <td>1</td> </tr> <tr> <td>$width (float) width of the indentation. Use negative value to disable it.</td> <td>1</td> </tr> <tr> <td>$isopen (boolean) if true keeps the top/bottom border open for the cell sides that cross the page.</td> <td>1</td> </tr> <tr> <td>$color (array) RGB array of colors</td> <td>1</td> </tr> <tr> <td>$fontstyle (string) additional font styles to add</td> <td>1</td> </tr> <tr> <td>$htmlval (string) String containing values and unit.</td> <td>1</td> </tr> <tr> <td>$refsize (string) Reference value in points.</td> <td>1</td> </tr> <tr> <td>$points (boolean) If true returns points, otherwise returns value in user's units.</td> <td>1</td> </tr> <tr> <td>$listdepth (int) list nesting level</td> <td>1</td> </tr> <tr> <td>$listtype (string) type of list</td> <td>1</td> </tr> <tr> <td>$size (float) current font size</td> <td>1</td> </tr> <tr> <td>$gvars (array) array of graphic variablesto restore</td> <td>1</td> </tr> <tr> <td>$extended (boolean) if true restore extended graphic variables</td> <td>1</td> </tr> <tr> <td>$data (string) page data</td> <td>1</td> </tr> <tr> <td>$append (boolean) if true append data, false replace.</td> <td>1</td> </tr> <tr> <td>$key (string) image sub-key</td> <td>1</td> </tr> <tr> <td>$key (string) font sub-key</td> <td>1</td> </tr> <tr> <td>$frompage (int) number of the source page</td> <td>1</td> </tr> <tr> <td>$topage (int) number of the destination page (must be less than $frompage)</td> <td>1</td> </tr> <tr> <td>$page (int) page to remove</td> <td>1</td> </tr> <tr> <td>$page (int) number of page to copy (0 = current page)</td> <td>1</td> </tr> <tr> <td>$numbersfont (string) set the font for page numbers (please use monospaced font for better alignment).</td> <td>1</td> </tr> <tr> <td>$filler (string) string used to fill the space between text and page number.</td> <td>1</td> </tr> <tr> <td>$color (array) RGB color array for bookmark title (values from 0 to 255).</td> <td>1</td> </tr> <tr> <td>$templates (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.</td> <td>1</td> </tr> <tr> <td>$correct_align (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)</td> <td>1</td> </tr> <tr> <td>$color (array) RGB color array for title (values from 0 to 255).</td> <td>1</td> </tr> <tr> <td>$self (boolean) if true restores current class object to previous state without the need of reassignment via the returned value.</td> <td>1</td> </tr> <tr> <td>$numcols (int) number of columns (set to zero to disable columns mode)</td> <td>1</td> </tr> <tr> <td>$width (int) column width</td> <td>1</td> </tr> <tr> <td>$y (int) column starting Y position (leave empty for current Y position)</td> <td>1</td> </tr> <tr> <td>$columns (array)</td> <td>1</td> </tr> <tr> <td>$col (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column.</td> <td>1</td> </tr> <tr> <td>$stroke (int) outline size in user units (0 = disable).</td> <td>1</td> </tr> <tr> <td>$fill (boolean) if true fills the text (default).</td> <td>1</td> </tr> <tr> <td>$clip (boolean) if true activate clipping mode</td> <td>1</td> </tr> <tr> <td>$params (array) Array of parameters: enabled (boolean) set to true to enable shadow; depth_w (float) shadow width in user units; depth_h (float) shadow height in user units; color (array) shadow color or false to use the stroke color; opacity (float) Alpha value: real value from 0 (transparent) to 1 (opaque); blend_mode (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity.</td> <td>1</td> </tr> <tr> <td>$word (array) array of chars</td> <td>1</td> </tr> <tr> <td>$patterns (array) Array of hypenation patterns.</td> <td>1</td> </tr> <tr> <td>$text (string) text to process</td> <td>1</td> </tr> <tr> <td>$patterns (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/</td> <td>1</td> </tr> <tr> <td>$mode (boolean) if true enable rasterization, false otherwise.</td> <td>1</td> </tr> <tr> <td>$enable (boolean) if true enable font subsetting by default.</td> <td>1</td> </tr> <tr> <td>$fontfamily (string) property string containing font family names</td> <td>1</td> </tr> <tr> <td>$w (int) Template width in user units (empty string or zero = page width less margins).</td> <td>1</td> </tr> <tr> <td>$h (int) Template height in user units (empty string or zero = page height less margins).</td> <td>1</td> </tr> <tr> <td>$group (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group).</td> <td>1</td> </tr> <tr> <td>$id (string) The ID of XObject Template to print.</td> <td>1</td> </tr> <tr> <td>$x (int) X position in user units (empty string = current x position)</td> <td>1</td> </tr> <tr> <td>$y (int) Y position in user units (empty string = current y position)</td> <td>1</td> </tr> <tr> <td>$w (int) Width in user units (zero = remaining page width)</td> <td>1</td> </tr> <tr> <td>$h (int) Height in user units (zero = remaining page height)</td> <td>1</td> </tr> <tr> <td>$align (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td> <td>1</td> </tr> <tr> <td>$palign (string) Allows to center or align the template on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td> <td>1</td> </tr> <tr> <td>$fitonpage (boolean) If true the template is resized to not exceed page dimensions.</td> <td>1</td> </tr> <tr> <td>$perc (int) percentage of stretching (100 = no stretching)</td> <td>1</td> </tr> <tr> <td>$spacing (float) amount to increase or decrease the space between characters in a text (0 = default spacing)</td> <td>1</td> </tr> <tr> <td>$regions (array) array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions.</td> <td>1</td> </tr> <tr> <td>$region (array) array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right).</td> <td>1</td> </tr> <tr> <td>$key (int) region key</td> <td>1</td> </tr> <tr> <td>$h (float) height of the text/image/object to print in user units</td> <td>1</td> </tr> <tr> <td>$x (float) current X coordinate in user units</td> <td>1</td> </tr> <tr> <td>$y (float) current Y coordinate in user units</td> <td>1</td> </tr> <tr> <td>$file (string) Name of the SVG file or a '@' character followed by the SVG data string.</td> <td>1</td> </tr> <tr> <td>$align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul> If the alignment is an empty string, then the pointer will be restored on the starting SVG position.</td> <td>1</td> </tr> <tr> <td>$svgstyle (array) array of SVG styles to apply</td> <td>1</td> </tr> <tr> <td>$prevsvgstyle (array) array of previous SVG style</td> <td>1</td> </tr> <tr> <td>$x (int) X origin of the bounding box</td> <td>1</td> </tr> <tr> <td>$y (int) Y origin of the bounding box</td> <td>1</td> </tr> <tr> <td>$w (int) width of the bounding box</td> <td>1</td> </tr> <tr> <td>$h (int) height of the bounding box</td> <td>1</td> </tr> <tr> <td>$clip_function (string) clip function</td> <td>1</td> </tr> <tr> <td>$clip_params (array) array of parameters for clipping function</td> <td>1</td> </tr> <tr> <td>$d (string) attribute d of the path SVG element</td> <td>1</td> </tr> <tr> <td>$name (string) Tag name</td> <td>1</td> </tr> <tr> <td>$attribs (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on.</td> <td>1</td> </tr> <tr> <td>$ctm (array) tranformation matrix for clipping mode (starting transformation matrix).</td> <td>1</td> </tr> <tr> <td>$data (string) The second parameter, data, contains the character data as a string.</td> <td>1</td> </tr> <tr> <td>$hcolor (string) HTML color.</td> <td>1</td> </tr> <tr> <td>$defcol (array) Color to return in case of error.</td> <td>1</td> </tr> <tr> <td>$c (array) Array of colors.</td> <td>1</td> </tr> <tr> <td>$color (string) color name or "#RRGGBB"</td> <td>1</td> </tr> <tr> <td>$mqr (boolean) FALSE for off, TRUE for on.</td> <td>1</td> </tr> <tr> <td>$url (string) URL to check.</td> <td>1</td> </tr> <tr> <td>$txt (string) input string</td> <td>1</td> </tr> <tr> <td>$brd (mixed) Indicates if borders must be drawn around the cell block. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))</td> <td>1</td> </tr> <tr> <td>$position (string) multicell position: 'start', 'middle', 'end'</td> <td>1</td> </tr> <tr> <td>$opencell (boolean) True when the cell is left open at the page bottom, false otherwise.</td> <td>1</td> </tr> <tr> <td>$str (string) string to be checked</td> <td>1</td> </tr> <tr> <td>$type (string) Type of file (name of the subdir on the tcpdf cache folder).</td> <td>1</td> </tr> <tr> <td>$file_id (string) TCPDF file_id.</td> <td>1</td> </tr> <tr> <td>$str (string) Input string to convert.</td> <td>1</td> </tr> <tr> <td>$object (object) class object to be cloned</td> <td>1</td> </tr> <tr> <td>$data (string) Data to output.</td> <td>1</td> </tr> <tr> <td>$length (int) Data length in bytes.</td> <td>1</td> </tr> <tr> <td>$replace (array) Array of replacements (array keys are replacement strings, values are alias arrays).</td> <td>1</td> </tr> <tr> <td>$diff (int) If passed, this will be set to the total char number difference between alias and replacements.</td> <td>1</td> </tr> <tr> <td>$date (string) Formatted date-time.</td> <td>1</td> </tr> <tr> <td>$time (int) Time in seconds.</td> <td>1</td> </tr> <tr> <td>$seed (string) starting seed value</td> <td>1</td> </tr> <tr> <td>$str (string) input string</td> <td>1</td> </tr> <tr> <td>$key (string) Encryption key.</td> <td>1</td> </tr> <tr> <td>$text (String) Input text to be encrypted.</td> <td>1</td> </tr> <tr> <td>$last_enc_key (String) Reference to last RC4 key encrypted.</td> <td>1</td> </tr> <tr> <td>$last_enc_key_c (String) Reference to last RC4 computed key.</td> <td>1</td> </tr> <tr> <td>$permissions (Array) the set of permissions (specify the ones you want to block).</td> <td>1</td> </tr> <tr> <td>$bs (string) byte-string to convert</td> <td>1</td> </tr> <tr> <td>$s (string) string to convert</td> <td>1</td> </tr> <tr> <td>$protection (string) 32bit encryption permission value (P value)</td> <td>1</td> </tr> <tr> <td>$name (string) Name object to encode.</td> <td>1</td> </tr> <tr> <td>$spot_colors (array) Reference to spot colors array.</td> <td>1</td> </tr> <tr> <td>$rtl (boolean) True if in Right-To-Left text direction mode, false otherwise.</td> <td>1</td> </tr> <tr> <td>$cssdata (string) string containing CSS definitions.</td> <td>1</td> </tr> <tr> <td>$tagvspaces (array) Array of vertical spaces for tags.</td> <td>1</td> </tr> <tr> <td>$selector (string) CSS selector string</td> <td>1</td> </tr> <tr> <td>$number (int) number to convert</td> <td>1</td> </tr> <tr> <td>$haystack (string) The string to search in.</td> <td>1</td> </tr> <tr> <td>$needle (string) substring to search.</td> <td>1</td> </tr> <tr> <td>$offset (int) May be specified to begin searching an arbitrary number of characters into the string.</td> <td>1</td> </tr> <tr> <td>$file (string) TEX file containing hypenation patterns. TEX pattrns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/</td> <td>1</td> </tr> <tr> <td>$default (string) default style</td> <td>1</td> </tr> <tr> <td>$ta (array) first SVG tranformation matrix</td> <td>1</td> </tr> <tr> <td>$tb (array) second SVG tranformation matrix</td> <td>1</td> </tr> <tr> <td>$attribute (string) transformation</td> <td>1</td> </tr> <tr> <td>$x1 (int) X coordinate of first vector point</td> <td>1</td> </tr> <tr> <td>$y1 (int) Y coordinate of first vector point</td> <td>1</td> </tr> <tr> <td>$x2 (int) X coordinate of second vector point</td> <td>1</td> </tr> <tr> <td>$y2 (int) Y coordinate of second vector point</td> <td>1</td> </tr> <tr> <td>$pattern (string) The regular expression pattern to search for without the modifiers, as a string.</td> <td>1</td> </tr> <tr> <td>$modifiers (string) The modifiers part of the pattern,</td> <td>1</td> </tr> <tr> <td>$subject (string) The input string.</td> <td>1</td> </tr> <tr> <td>$limit (int) If specified, then only substrings up to limit are returned with the rest of the string being placed in the last substring. A limit of -1, 0 or NULL means "no limit" and, as is standard across PHP, you can use NULL to skip to the flags parameter.</td> <td>1</td> </tr> <tr> <td>$flags (int) The flags as specified on the preg_split PHP function.</td> <td>1</td> </tr> <tr> <td>string $filename The full path to the file to open</td> <td>1</td> </tr> <tr> <td>string $mode Acceses type for the file ('r', 'r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+' or 'e')</td> <td>1</td> </tr> <tr> <td>url (string) URL to check.</td> <td>1</td> </tr> <tr> <td>filename (string) Path to the file or directory.</td> <td>1</td> </tr> <tr> <td>$file (string) Name of the file or URL to read.</td> <td>1</td> </tr> <tr> <td>$handle (resource)</td> <td>1</td> </tr> <tr> <td>$f (string) file name.</td> <td>1</td> </tr> <tr> <td>$format (mixed) The format name @see self::$page_format<ul></td> <td>1</td> </tr> <tr> <td>$type (string) valid values are: <ul><li>'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;</li><li>'CropBox' : the visible region of default user space;</li><li>'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;</li><li>'TrimBox' : the intended dimensions of the finished page after trimming;</li><li>'ArtBox' : the page's meaningful content (including potential white space).</li></ul></td> <td>1</td> </tr> <tr> <td>$llx (float) lower-left x coordinate in user units.</td> <td>1</td> </tr> <tr> <td>$lly (float) lower-left y coordinate in user units.</td> <td>1</td> </tr> <tr> <td>$urx (float) upper-right x coordinate in user units.</td> <td>1</td> </tr> <tr> <td>$ury (float) upper-right y coordinate in user units.</td> <td>1</td> </tr> <tr> <td>$points (boolean) If true uses user units as unit of measure, otherwise uses PDF points.</td> <td>1</td> </tr> <tr> <td>$k (float) Scale factor (number of points in user unit).</td> <td>1</td> </tr> <tr> <td>$fontfile (string) Font file (full path).</td> <td>1</td> </tr> <tr> <td>$fonttype (string) Font type. Leave empty for autodetect mode. Valid values are: TrueTypeUnicode, TrueType, Type1, CID0JP = CID-0 Japanese, CID0KR = CID-0 Korean, CID0CS = CID-0 Chinese Simplified, CID0CT = CID-0 Chinese Traditional.</td> <td>1</td> </tr> <tr> <td>$enc (string) Name of the encoding table to use. Leave empty for default mode. Omit this parameter for TrueType Unicode and symbolic fonts like Symbol or ZapfDingBats.</td> <td>1</td> </tr> <tr> <td>$flags (int) Unsigned 32-bit integer containing flags specifying various characteristics of the font (PDF32000:2008 - 9.8.2 Font Descriptor Flags): +1 for fixed font; +4 for symbol or +32 for non-symbol; +64 for italic. Fixed and Italic mode are generally autodetected so you have to set it to 32 = non-symbolic font (default) or 4 = symbolic font.</td> <td>1</td> </tr> <tr> <td>$outpath (string) Output path for generated font files (must be writeable by the web server). Leave empty for default font folder.</td> <td>1</td> </tr> <tr> <td>$platid (int) Platform ID for CMAP table to extract (when building a Unicode font for Windows this value should be 3, for Macintosh should be 1).</td> <td>1</td> </tr> <tr> <td>$encid (int) Encoding ID for CMAP table to extract (when building a Unicode font for Windows this value should be 1, for Macintosh should be 0). When Platform ID is 3, legal values for Encoding ID are: 0=Symbol, 1=Unicode, 2=ShiftJIS, 3=PRC, 4=Big5, 5=Wansung, 6=Johab, 7=Reserved, 8=Reserved, 9=Reserved, 10=UCS-4.</td> <td>1</td> </tr> <tr> <td>$addcbbox (boolean) If true includes the character bounding box information on the php font file.</td> <td>1</td> </tr> <tr> <td>$link (boolean) If true link to system font instead of copying the font data (not transportable) - Note: do not work with Type1 fonts.</td> <td>1</td> </tr> <tr> <td>$table (string) table to check</td> <td>1</td> </tr> <tr> <td>$length (int) length of table in bytes</td> <td>1</td> </tr> <tr> <td>$font (string) TrueType font data.</td> <td>1</td> </tr> <tr> <td>$subsetchars (array) Array of used characters (the glyphs to keep).</td> <td>1</td> </tr> <tr> <td>$cidoffset (int) offset for CID values</td> <td>1</td> </tr> <tr> <td>$map (string) CIDToGIDMap.</td> <td>1</td> </tr> <tr> <td>$cid (int) CID value.</td> <td>1</td> </tr> <tr> <td>$gid (int) GID value.</td> <td>1</td> </tr> <tr> <td>$file (string) Font file name.</td> <td>1</td> </tr> <tr> <td>$fontdir (string) Font directory (set to false fto search on default directories)</td> <td>1</td> </tr> <tr> <td>$size (string) String containing font size value.</td> <td>1</td> </tr> <tr> <td>$ta (array) The input array of UTF8 values.</td> <td>1</td> </tr> <tr> <td>$isunicode (boolean) True for Unicode mode, false otherwise.</td> <td>1</td> </tr> <tr> <td>$strarr (string) The input array of characters.</td> <td>1</td> </tr> <tr> <td>$uniarr (string) The input array of characters.</td> <td>1</td> </tr> <tr> <td>$str (string) string to manipulate.</td> <td>1</td> </tr> <tr> <td>$arr (array) array of unicode values.</td> <td>1</td> </tr> <tr> <td>$str (string) string to manipulate (or empty value).</td> <td>1</td> </tr> <tr> <td>$ta (array) array of characters composing the string.</td> <td>1</td> </tr> <tr> <td>$str (string) string to process</td> <td>1</td> </tr> <tr> <td>$forcertl (bool) if 'R' forces RTL, if 'L' forces LTR</td> <td>1</td> </tr> <tr> <td>$imgfile (string) image file name</td> <td>1</td> </tr> <tr> <td>$iminfo (array) array of image information returned by getimagesize() function.</td> <td>1</td> </tr> <tr> <td>$new_image (image) GD image object</td> <td>1</td> </tr> <tr> <td>$image (image) GD image object.</td> <td>1</td> </tr> <tr> <td>$quality (int) JPEG quality.</td> <td>1</td> </tr> <tr> <td>$filter (string) Filter name.</td> <td>1</td> </tr> <tr> <td>$code (string) code to represent using QRcode</td> <td>1</td> </tr> <tr> <td>$eclevel (string) error level: <ul><li>L : About 7% or less errors can be corrected.</li><li>M : About 15% or less errors can be corrected.</li><li>Q : About 25% or less errors can be corrected.</li><li>H : About 30% or less errors can be corrected.</li></ul></td> <td>1</td> </tr> <tr> <td>$frame (array) array to binarize</td> <td>1</td> </tr> <tr> <td>$string (string) input string to encode</td> <td>1</td> </tr> <tr> <td>$mask (int) masking mode</td> <td>1</td> </tr> <tr> <td>$val (int) value of the character to set</td> <td>1</td> </tr> <tr> <td>$spec (array) array of ECC specification</td> <td>1</td> </tr> <tr> <td>$width (int) frame width</td> <td>1</td> </tr> <tr> <td>$mask (array) masking mode</td> <td>1</td> </tr> <tr> <td>$maskNo (int) mask number</td> <td>1</td> </tr> <tr> <td>$s (int)</td> <td>1</td> </tr> <tr> <td>$d (int)</td> <td>1</td> </tr> <tr> <td>$maskGenOnly (boolean)</td> <td>1</td> </tr> <tr> <td>$pos (int)</td> <td>1</td> </tr> <tr> <td>$items (arrray) input items</td> <td>1</td> </tr> <tr> <td>$data (array) array of input data.</td> <td>1</td> </tr> <tr> <td>$index (int)</td> <td>1</td> </tr> <tr> <td>$parity (int)</td> <td>1</td> </tr> <tr> <td>$c (int) character value</td> <td>1</td> </tr> <tr> <td>$data (array) data to validate</td> <td>1</td> </tr> <tr> <td>$bits (int)</td> <td>1</td> </tr> <tr> <td>$items (array) items</td> <td>1</td> </tr> <tr> <td>$setLength (int) array size</td> <td>1</td> </tr> <tr> <td>$append (array) bitstream to append</td> <td>1</td> </tr> <tr> <td>$bstream (array) original bitstream</td> <td>1</td> </tr> <tr> <td>$srctab (array)</td> <td>1</td> </tr> <tr> <td>$repl (string) value to replace</td> <td>1</td> </tr> <tr> <td>$replLen (int) length of the repl string</td> <td>1</td> </tr> <tr> <td>$size (int) input code length (bytes)</td> <td>1</td> </tr> <tr> <td>$spec (array) an array of ECC specification contains as following: {# of type1 blocks, # of data code, # of ecc code, # of type2 blocks, # of data code}</td> <td>1</td> </tr> <tr> <td>$mask (array)</td> <td>1</td> </tr> <tr> <td>$data (array) data</td> <td>1</td> </tr> <tr> <td>$parity (array) parity</td> <td>1</td> </tr> <tr> <td>$code (string) Code to represent using Datamatrix.</td> <td>1</td> </tr> <tr> <td>$a (int) first number to multiply.</td> <td>1</td> </tr> <tr> <td>$b (int) second number to multiply.</td> <td>1</td> </tr> <tr> <td>$log (array) Log table.</td> <td>1</td> </tr> <tr> <td>$alog (array) Anti-Log table.</td> <td>1</td> </tr> <tr> <td>$gf (array) Number of Factors of the Reed-Solomon polynomial.</td> <td>1</td> </tr> <tr> <td>$wd (array) Array of datacodewords.</td> <td>1</td> </tr> <tr> <td>$nb (int) Number of blocks.</td> <td>1</td> </tr> <tr> <td>$nd (int) Number of data codewords per block.</td> <td>1</td> </tr> <tr> <td>$nc (int) Number of correction codewords per block.</td> <td>1</td> </tr> <tr> <td>$gf (int) numner of fields on log/antilog table (power of 2).</td> <td>1</td> </tr> <tr> <td>$pp (int) The value of its prime modulus polynomial (301 for ECC200).</td> <td>1</td> </tr> <tr> <td>$chr (int) Character (byte) to check.</td> <td>1</td> </tr> <tr> <td>$mode (int) Current encoding mode.</td> <td>1</td> </tr> <tr> <td>$pos (int) current position</td> <td>1</td> </tr> <tr> <td>$mode (int) current encoding mode</td> <td>1</td> </tr> <tr> <td>$mode (int) New encoding mode.</td> <td>1</td> </tr> <tr> <td>$numcw (int) Number of current codewords.</td> <td>1</td> </tr> <tr> <td>$bit (int) Bit.</td> <td>1</td> </tr> <tr> <td>bool $signThenEncrypt</td> <td>1</td> </tr> <tr> <td>string $serviceName Name of the service</td> <td>1</td> </tr> <tr> <td>string $className Class to instantiate</td> <td>1</td> </tr> <tr> <td>ClientInterface $httpClient</td> <td>1</td> </tr> <tr> <td>string $serviceName Name of service to create</td> <td>1</td> </tr> <tr> <td>array|null $scopes If creating an oauth2 service, array of scopes</td> <td>1</td> </tr> <tr> <td>string $apiVersion version of the api call</td> <td>1</td> </tr> <tr> <td>string $serviceName The name of the service of which to get the fully qualified name</td> <td>1</td> </tr> <tr> <td>string $type The type of the service to get (either OAuth1 or OAuth2)</td> <td>1</td> </tr> <tr> <td>array|null $scopes Array of scopes for the service</td> <td>1</td> </tr> <tr> <td>string $serviceName The fully qualified service name</td> <td>1</td> </tr> <tr> <td>array $scopes List of scopes for the service</td> <td>1</td> </tr> <tr> <td>UriInterface $baseApiUri</td> <td>1</td> </tr> <tr> <td>StdOAuth2Token $token</td> <td>1</td> </tr> <tr> <td>bool $stateParameterInAutUrl</td> <td>1</td> </tr> <tr> <td>string $apiVersion</td> <td>1</td> </tr> <tr> <td>array $body Request body if applicable.</td> <td>1</td> </tr> <tr> <td>string $scope</td> <td>1</td> </tr> <tr> <td>CredentialsInterface $credentials credentials</td> <td>1</td> </tr> <tr> <td>ClientInterface $httpClient httpClient</td> <td>1</td> </tr> <tr> <td>TokenStorageInterface $storage storage</td> <td>1</td> </tr> <tr> <td>$scopes scope</td> <td>1</td> </tr> <tr> <td>UriInterface|null $baseApiUri baseApiUri</td> <td>1</td> </tr> <tr> <td>$responseBody responseBody</td> <td>1</td> </tr> <tr> <td>string $code The access code from the callback.</td> <td>1</td> </tr> <tr> <td>int $lifetime</td> <td>1</td> </tr> <tr> <td>array $extraParams</td> <td>1</td> </tr> <tr> <td>SessionInterface $session</td> <td>1</td> </tr> <tr> <td>bool $startSession</td> <td>1</td> </tr> <tr> <td>string $sessionVariableName</td> <td>1</td> </tr> <tr> <td>bool $startSession Whether or not to start the session upon construction.</td> <td>1</td> </tr> <tr> <td>string $sessionVariableName the variable name to use within the _SESSION superglobal</td> <td>1</td> </tr> <tr> <td>Predis $redis An instantiated and connected redis client</td> <td>1</td> </tr> <tr> <td>string $key The key to store the token under in redis</td> <td>1</td> </tr> <tr> <td>string $stateKey The key to store the state under in redis.</td> <td>1</td> </tr> <tr> <td>string $service</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>\Conf $conf Conf object</td> <td>1</td> </tr> <tr> <td>string $keyforprovider Key to manage several providers of the same type. For example 'abc' will be added to 'Google' to defined storage key.</td> <td>1</td> </tr> <tr> <td>array $_server A super-global $_SERVER array</td> <td>1</td> </tr> <tr> <td>string $rawUserInfo</td> <td>1</td> </tr> <tr> <td>$path</td> <td>1</td> </tr> <tr> <td>string $userAgent The UA string the client will use</td> <td>1</td> </tr> <tr> <td>int $redirects Maximum redirects for client</td> <td>1</td> </tr> <tr> <td>int $timeout Request timeout time for client in seconds</td> <td>1</td> </tr> <tr> <td>bool $force</td> <td>1</td> </tr> <tr> <td>string $consumerId</td> <td>1</td> </tr> <tr> <td>string $consumerSecret</td> <td>1</td> </tr> <tr> <td>string $callbackUrl</td> <td>1</td> </tr> <tr> <td>UriInterface|string $path</td> <td>1</td> </tr> <tr> <td>UriInterface $baseApiUri</td> <td>1</td> </tr> <tr> <td>array $additionalParameters</td> <td>1</td> </tr> <tr> <td>array $body Request body if applicable (an associative array will</td> <td>1</td> </tr> <tr> <td>CredentialsInterface $credentials</td> <td>1</td> </tr> <tr> <td>array $signatureData</td> <td>1</td> </tr> <tr> <td>array $body Request body if applicable (key/value pairs)</td> <td>1</td> </tr> <tr> <td>array $extraHeaders Extra headers if applicable.</td> <td>1</td> </tr> <tr> <td>array $extraParameters</td> <td>1</td> </tr> <tr> <td>UriInterface $uri The uri the request is headed</td> <td>1</td> </tr> <tr> <td>array $bodyParams Request body if applicable (key/value pairs)</td> <td>1</td> </tr> <tr> <td>array $scopes</td> <td>1</td> </tr> <tr> <td>string $authorizationEndpoint</td> <td>1</td> </tr> <tr> <td>string $token The request token from the callback.</td> <td>1</td> </tr> <tr> <td>string $verifier</td> <td>1</td> </tr> <tr> <td>string $tokenSecret</td> <td>1</td> </tr> <tr> <td>string $locale The locale code to use (e.g. "fr" or "pt_br" or "en_uk")</td> <td>1</td> </tr> <tr> <td>string $rendererClass Class name of the chart renderer</td> <td>1</td> </tr> <tr> <td>int $options Default options for libxml loader</td> <td>1</td> </tr> <tr> <td>string $pName</td> <td>1</td> </tr> <tr> <td>Worksheet $pWorksheet</td> <td>1</td> </tr> <tr> <td>bool $pLocalOnly</td> <td>1</td> </tr> <tr> <td>null|Worksheet $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope.</td> <td>1</td> </tr> <tr> <td>Worksheet $value</td> <td>1</td> </tr> <tr> <td>null|Worksheet $value</td> <td>1</td> </tr> <tr> <td>string $pNamedRange Named range</td> <td>1</td> </tr> <tr> <td>bool $hasMacros true|false</td> <td>1</td> </tr> <tr> <td>string $macroCode string|null</td> <td>1</td> </tr> <tr> <td>null|string $certificate</td> <td>1</td> </tr> <tr> <td>null|mixed $target</td> <td>1</td> </tr> <tr> <td>null|mixed $xmlData</td> <td>1</td> </tr> <tr> <td>null|mixed $BinObjectsNames</td> <td>1</td> </tr> <tr> <td>null|mixed $BinObjectsData</td> <td>1</td> </tr> <tr> <td>array $unparsedLoadedData</td> <td>1</td> </tr> <tr> <td>mixed $path</td> <td>1</td> </tr> <tr> <td>string $pSheetCodeName Name of the worksheet to check</td> <td>1</td> </tr> <tr> <td>Document\Properties $pValue</td> <td>1</td> </tr> <tr> <td>Document\Security $pValue</td> <td>1</td> </tr> <tr> <td>null|int $sheetIndex Index where sheet should go (0,1,..., or null for last)</td> <td>1</td> </tr> <tr> <td>string $pSheetName Name of the worksheet to check</td> <td>1</td> </tr> <tr> <td>int $pIndex Sheet index</td> <td>1</td> </tr> <tr> <td>string $sheetName Sheet name to modify index for</td> <td>1</td> </tr> <tr> <td>int $newIndex New index for the sheet</td> <td>1</td> </tr> <tr> <td>string $pValue Sheet title</td> <td>1</td> </tr> <tr> <td>Worksheet $pSheet External sheet to add</td> <td>1</td> </tr> <tr> <td>NamedRange $namedRange</td> <td>1</td> </tr> <tr> <td>null|Worksheet $pSheet scope: use null for global scope</td> <td>1</td> </tr> <tr> <td>Style $pCellStyle</td> <td>1</td> </tr> <tr> <td>bool $showHorizontalScroll True if horizonal scroll bar is visible</td> <td>1</td> </tr> <tr> <td>bool $showVerticalScroll True if vertical scroll bar is visible</td> <td>1</td> </tr> <tr> <td>bool $showSheetTabs True if sheet tabs are visible</td> <td>1</td> </tr> <tr> <td>bool $minimized true if workbook window is minimized</td> <td>1</td> </tr> <tr> <td>bool $autoFilterDateGrouping true if workbook window is minimized</td> <td>1</td> </tr> <tr> <td>int $firstSheetIndex First sheet in book view</td> <td>1</td> </tr> <tr> <td>string $visibility visibility status of the workbook</td> <td>1</td> </tr> <tr> <td>int $tabRatio Ratio between the tabs bar and the horizontal scroll bar</td> <td>1</td> </tr> <tr> <td>IComparable[] $pSource Source array to create HashTable from</td> <td>1</td> </tr> <tr> <td>IComparable[] $pSource Optional source array to create HashTable from</td> <td>1</td> </tr> <tr> <td>IComparable $pSource Item to add</td> <td>1</td> </tr> <tr> <td>IComparable $pSource Item to remove</td> <td>1</td> </tr> <tr> <td>string $writerType Example: Xlsx</td> <td>1</td> </tr> <tr> <td>string $readerType Example: Xlsx</td> <td>1</td> </tr> <tr> <td>string $pFilename The name of the spreadsheet file</td> <td>1</td> </tr> <tr> <td>string $pFilename The name of the spreadsheet file to identify</td> <td>1</td> </tr> <tr> <td>string $filename The name of the spreadsheet file</td> <td>1</td> </tr> <tr> <td>string $writerType</td> <td>1</td> </tr> <tr> <td>string $writerClass</td> <td>1</td> </tr> <tr> <td>string $readerType</td> <td>1</td> </tr> <tr> <td>string $readerClass</td> <td>1</td> </tr> <tr> <td>string $author</td> <td>1</td> </tr> <tr> <td>RichText $pValue</td> <td>1</td> </tr> <tr> <td>string $width</td> <td>1</td> </tr> <tr> <td>string $alignment see Style\Alignment::HORIZONTAL_*</td> <td>1</td> </tr> <tr> <td>string $cellAddress Address of the cell we're testing</td> <td>1</td> </tr> <tr> <td>string $pBefore Insert before this cell address (e.g. 'A1')</td> <td>1</td> </tr> <tr> <td>string $pFormula Formula to update</td> <td>1</td> </tr> <tr> <td>string $sheetName Worksheet name/title</td> <td>1</td> </tr> <tr> <td>string $pCellRange Cell range</td> <td>1</td> </tr> <tr> <td>Spreadsheet $spreadsheet Object to update</td> <td>1</td> </tr> <tr> <td>string $oldName Old name (name to replace)</td> <td>1</td> </tr> <tr> <td>string $newName New name</td> <td>1</td> </tr> <tr> <td>string $pCellRange Cell range (e.g. 'B2:D4', 'B:C' or '2:3')</td> <td>1</td> </tr> <tr> <td>string $pCellReference Single cell reference</td> <td>1</td> </tr> <tr> <td>float $pxs</td> <td>1</td> </tr> <tr> <td>float $widthUnits</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement $xml</td> <td>1</td> </tr> <tr> <td>string $styleID</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement $styleData</td> <td>1</td> </tr> <tr> <td>IReadFilter $pValue</td> <td>1</td> </tr> <tr> <td>string $data Data stream to read from</td> <td>1</td> </tr> <tr> <td>int $pos Position to start reading from</td> <td>1</td> </tr> <tr> <td>int $len Record data length</td> <td>1</td> </tr> <tr> <td>int $block Block for which to create decrypto</td> <td>1</td> </tr> <tr> <td>string $valContext MD5 context state</td> <td>1</td> </tr> <tr> <td>string $password Password to check</td> <td>1</td> </tr> <tr> <td>string $docid Document id</td> <td>1</td> </tr> <tr> <td>string $salt_data Salt data</td> <td>1</td> </tr> <tr> <td>string $hashedsalt_data Hashed salt data</td> <td>1</td> </tr> <tr> <td>string $valContext Set to the MD5 context of the value</td> <td>1</td> </tr> <tr> <td>string $formulaStructure The complete binary data for the formula</td> <td>1</td> </tr> <tr> <td>string $formulaData The binary data for the formula itself</td> <td>1</td> </tr> <tr> <td>string $formulaData Formula data</td> <td>1</td> </tr> <tr> <td>string $baseCell Base cell</td> <td>1</td> </tr> <tr> <td>string $arrayData</td> <td>1</td> </tr> <tr> <td>string $valueData</td> <td>1</td> </tr> <tr> <td>string $rgb Encoded RGB value (4 bytes)</td> <td>1</td> </tr> <tr> <td>int $characterCount</td> <td>1</td> </tr> <tr> <td>string $data Binary string that is at least 8 bytes long</td> <td>1</td> </tr> <tr> <td>int $rknum</td> <td>1</td> </tr> <tr> <td>bool $compressed</td> <td>1</td> </tr> <tr> <td>DOMNode $element</td> <td>1</td> </tr> <tr> <td>string $cellContent</td> <td>1</td> </tr> <tr> <td>null|Spreadsheet $spreadsheet</td> <td>1</td> </tr> <tr> <td>DOMDocument $document</td> <td>1</td> </tr> <tr> <td>array $attributeArray</td> <td>1</td> </tr> <tr> <td>string $column</td> <td>1</td> </tr> <tr> <td>int $row</td> <td>1</td> </tr> <tr> <td>array $attributes</td> <td>1</td> </tr> <tr> <td>string $style</td> <td>1</td> </tr> <tr> <td>Style $cellStyle</td> <td>1</td> </tr> <tr> <td>string $styleValue</td> <td>1</td> </tr> <tr> <td>\DOMNode $element</td> <td>1</td> </tr> <tr> <td>string $is</td> <td>1</td> </tr> <tr> <td>string $pValue Input encoding, eg: 'UTF-8'</td> <td>1</td> </tr> <tr> <td>string $delimiter Delimiter, eg: ','</td> <td>1</td> </tr> <tr> <td>string $enclosure Enclosure, defaults to "</td> <td>1</td> </tr> <tr> <td>bool $contiguous</td> <td>1</td> </tr> <tr> <td>string $escapeCharacter</td> <td>1</td> </tr> <tr> <td>ZipArchive $archive</td> <td>1</td> </tr> <tr> <td>Style $docStyle</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement|\stdClass $style</td> <td>1</td> </tr> <tr> <td>Border $docBorder</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement $eleBorder</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement | null $is</td> <td>1</td> </tr> <tr> <td>Spreadsheet $excel</td> <td>1</td> </tr> <tr> <td>mixed $customUITarget</td> <td>1</td> </tr> <tr> <td>mixed $zip</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Drawing $objDrawing</td> <td>1</td> </tr> <tr> <td>\SimpleXMLElement $cellAnchor</td> <td>1</td> </tr> <tr> <td>array $hyperlinks</td> <td>1</td> </tr> <tr> <td>string $xsdBoolean An XML string value of type 'xsd:boolean'</td> <td>1</td> </tr> <tr> <td>ZipArchive $zip Opened zip archive</td> <td>1</td> </tr> <tr> <td>string $data Binary data</td> <td>1</td> </tr> <tr> <td>int $n Number of properties</td> <td>1</td> </tr> <tr> <td>string $key Encryption key/passphrase</td> <td>1</td> </tr> <tr> <td>string $data Data to encrypt/decrypt</td> <td>1</td> </tr> <tr> <td>array $palette Color palette</td> <td>1</td> </tr> <tr> <td>int $version</td> <td>1</td> </tr> <tr> <td>string $data Data to add</td> <td>1</td> </tr> <tr> <td>mixed $xml</td> <td>1</td> </tr> <tr> <td>string $filestream</td> <td>1</td> </tr> <tr> <td>mixed $themeName</td> <td>1</td> </tr> <tr> <td>mixed $colourSchemeName</td> <td>1</td> </tr> <tr> <td>mixed $colourMap</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement $component</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement $chartElements</td> <td>1</td> </tr> <tr> <td>string $chartName</td> <td>1</td> </tr> <tr> <td>Layout $plotArea</td> <td>1</td> </tr> <tr> <td>mixed $plotAttributes</td> <td>1</td> </tr> <tr> <td>string $columnAddress A, B, ... DX, ...</td> <td>1</td> </tr> <tr> <td>array $columnAttributes array of attributes (indexes are attribute name, values are value)</td> <td>1</td> </tr> <tr> <td>int $rowNumber 1, 2, 3, ... 99, ...</td> <td>1</td> </tr> <tr> <td>array $rowAttributes array of attributes (indexes are attribute name, values are value)</td> <td>1</td> </tr> <tr> <td>IReadFilter $readFilter</td> <td>1</td> </tr> <tr> <td>Worksheet $parent The worksheet for this cell collection</td> <td>1</td> </tr> <tr> <td>string $pCoord Coordinate of the cell to check</td> <td>1</td> </tr> <tr> <td>string $pCoord Coordinate of the cell to delete</td> <td>1</td> </tr> <tr> <td>string $row Return the highest column for the specified row,</td> <td>1</td> </tr> <tr> <td>string $column Return the highest row for the specified column,</td> <td>1</td> </tr> <tr> <td>Worksheet $parent The new worksheet that we're copying to</td> <td>1</td> </tr> <tr> <td>string $row Row number to remove</td> <td>1</td> </tr> <tr> <td>string $column Column ID to remove</td> <td>1</td> </tr> <tr> <td>string $pCoord Coordinate of the cell to update</td> <td>1</td> </tr> <tr> <td>string $pCoord Coordinate of the cell</td> <td>1</td> </tr> <tr> <td>Worksheet $parent Enable cell caching for this worksheet</td> <td>1</td> </tr> <tr> <td>HeaderFooterDrawing $image</td> <td>1</td> </tr> <tr> <td>HeaderFooterDrawing[] $images</td> <td>1</td> </tr> <tr> <td>string $column Column name (e.g. A)</td> <td>1</td> </tr> <tr> <td>int $pColumnOffset Column offset within range (starting from 0)</td> <td>1</td> </tr> <tr> <td>AutoFilter\Column|string $pColumn</td> <td>1</td> </tr> <tr> <td>string $fromColumn Column name (e.g. A)</td> <td>1</td> </tr> <tr> <td>string $toColumn Column name (e.g. B)</td> <td>1</td> </tr> <tr> <td>mixed[] $ruleSet</td> <td>1</td> </tr> <tr> <td>mixed[] $monthSet</td> <td>1</td> </tr> <tr> <td>string $dynamicRuleType</td> <td>1</td> </tr> <tr> <td>AutoFilter\Column $filterColumn</td> <td>1</td> </tr> <tr> <td>string $pValue File path</td> <td>1</td> </tr> <tr> <td>bool $pVerifyFile Verify file</td> <td>1</td> </tr> <tr> <td>int $initialValue Numeric row index</td> <td>1</td> </tr> <tr> <td>resource $value</td> <td>1</td> </tr> <tr> <td>string $value see self::RENDERING_*</td> <td>1</td> </tr> <tr> <td>string $value see self::MIMETYPE_*</td> <td>1</td> </tr> <tr> <td>Worksheet $worksheet</td> <td>1</td> </tr> <tr> <td>int $rowIndex</td> <td>1</td> </tr> <tr> <td>string $columnIndex The column that we want to iterate</td> <td>1</td> </tr> <tr> <td>int $rowIndex The row that we want to iterate</td> <td>1</td> </tr> <tr> <td>int $pIndex Numeric row index</td> <td>1</td> </tr> <tr> <td>string $columnIndex</td> <td>1</td> </tr> <tr> <td>bool $pOverrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?</td> <td>1</td> </tr> <tr> <td>string $pValue eg: 'A1'</td> <td>1</td> </tr> <tr> <td>int $height</td> <td>1</td> </tr> <tr> <td>Drawing\Shadow $pValue</td> <td>1</td> </tr> <tr> <td>string $pTitle</td> <td>1</td> </tr> <tr> <td>bool $sorted Also sort the cell collection?</td> <td>1</td> </tr> <tr> <td>Chart $pChart</td> <td>1</td> </tr> <tr> <td>null|int $iChartIndex Index where chart should go (0,1,..., or null for last)</td> <td>1</td> </tr> <tr> <td>string $index Chart index position</td> <td>1</td> </tr> <tr> <td>string $chartName Chart name</td> <td>1</td> </tr> <tr> <td>string $pValue String containing the dimension of this worksheet</td> <td>1</td> </tr> <tr> <td>bool $updateFormulaCellReferences Flag indicating whether cell references in formulae should</td> <td>1</td> </tr> <tr> <td>string $value Sheet state (visible, hidden, veryHidden)</td> <td>1</td> </tr> <tr> <td>PageSetup $pValue</td> <td>1</td> </tr> <tr> <td>PageMargins $pValue</td> <td>1</td> </tr> <tr> <td>HeaderFooter $pValue</td> <td>1</td> </tr> <tr> <td>SheetView $pValue</td> <td>1</td> </tr> <tr> <td>Protection $pValue</td> <td>1</td> </tr> <tr> <td>string $row Return the data highest column for the specified row,</td> <td>1</td> </tr> <tr> <td>string $row Return the highest data column for the specified row,</td> <td>1</td> </tr> <tr> <td>string $dataType Explicit data type, see DataType::TYPE_*</td> <td>1</td> </tr> <tr> <td>string $pCoordinate Coordinate of the cell</td> <td>1</td> </tr> <tr> <td>string $pCoordinate Coordinate of the cell eg: 'A1'</td> <td>1</td> </tr> <tr> <td>int $pRow Numeric index of the row</td> <td>1</td> </tr> <tr> <td>string $pColumn String index of the column eg: 'A'</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate (or range) to get style for, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>$pValue Conditional[]</td> <td>1</td> </tr> <tr> <td>int $columnIndex1 Numeric column coordinate of the cell</td> <td>1</td> </tr> <tr> <td>int $row1 Numeric row coordinate of the cell</td> <td>1</td> </tr> <tr> <td>null|int $columnIndex2 Numeric column coordinate of the range cell</td> <td>1</td> </tr> <tr> <td>null|int $row2 Numeric row coordinate of the range cell</td> <td>1</td> </tr> <tr> <td>Style $pCellStyle Cell style to duplicate</td> <td>1</td> </tr> <tr> <td>Conditional[] $pCellStyle Cell style to duplicate</td> <td>1</td> </tr> <tr> <td>string $pCoordinate Cell coordinate (e.g. A1)</td> <td>1</td> </tr> <tr> <td>int $pBreak Break type (type of Worksheet::BREAK_*)</td> <td>1</td> </tr> <tr> <td>int $break Break type (type of Worksheet::BREAK_*)</td> <td>1</td> </tr> <tr> <td>string $pPassword Password to unlock the protection</td> <td>1</td> </tr> <tr> <td>string $password Password to unlock the protection</td> <td>1</td> </tr> <tr> <td>bool $alreadyHashed If the password has already been hashed, set this to true</td> <td>1</td> </tr> <tr> <td>AutoFilter|string $pValue</td> <td>1</td> </tr> <tr> <td>int $columnIndex2 Numeric column coordinate of the second cell</td> <td>1</td> </tr> <tr> <td>int $row2 Numeric row coordinate of the second cell</td> <td>1</td> </tr> <tr> <td>null|string $cell Position of the split</td> <td>1</td> </tr> <tr> <td>null|string $topLeftCell default position of the right bottom pane</td> <td>1</td> </tr> <tr> <td>int $pBefore Insert before this one</td> <td>1</td> </tr> <tr> <td>string $pBefore Insert before this one, eg: 'A'</td> <td>1</td> </tr> <tr> <td>int $beforeColumnIndex Insert before this one (numeric column coordinate of the cell)</td> <td>1</td> </tr> <tr> <td>int $pRow Remove starting with this one</td> <td>1</td> </tr> <tr> <td>int $pNumRows Number of rows to remove</td> <td>1</td> </tr> <tr> <td>string $pColumn Remove starting with this one, eg: 'A'</td> <td>1</td> </tr> <tr> <td>int $pNumCols Number of columns to remove</td> <td>1</td> </tr> <tr> <td>int $columnIndex Remove starting with this one (numeric column coordinate of the cell)</td> <td>1</td> </tr> <tr> <td>int $numColumns Number of columns to remove</td> <td>1</td> </tr> <tr> <td>bool $pValue Show gridlines (true/false)</td> <td>1</td> </tr> <tr> <td>bool $pValue Print gridlines (true/false)</td> <td>1</td> </tr> <tr> <td>bool $pValue Show row and column headers (true/false)</td> <td>1</td> </tr> <tr> <td>bool $pValue Show summary below (true/false)</td> <td>1</td> </tr> <tr> <td>bool $pValue Show summary right (true/false)</td> <td>1</td> </tr> <tr> <td>Comment[] $pValue</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate to get comment for, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCoordinate Cell (i.e. A1)</td> <td>1</td> </tr> <tr> <td>string $pCoordinate Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'</td> <td>1</td> </tr> <tr> <td>bool $value Right-to-left true/false</td> <td>1</td> </tr> <tr> <td>array $source Source array</td> <td>1</td> </tr> <tr> <td>mixed $nullValue Value in source array that stands for blank cell</td> <td>1</td> </tr> <tr> <td>string $startCell Insert array starting from this cell address as the top left coordinate</td> <td>1</td> </tr> <tr> <td>bool $strictNullComparison Apply strict comparison when testing for null values in the array</td> <td>1</td> </tr> <tr> <td>string $pNamedRange Name of the Named Range</td> <td>1</td> </tr> <tr> <td>string $pRange Range to extract title from</td> <td>1</td> </tr> <tr> <td>bool $returnRange Return range? (see example)</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate to get hyperlink for, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate to insert hyperlink, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate to get data validation for, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCellCoordinate Cell coordinate to insert data validation, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>null|DataValidation $pDataValidation</td> <td>1</td> </tr> <tr> <td>string $range</td> <td>1</td> </tr> <tr> <td>string $pValue Same rule as Title minus space not allowed (but, like Excel, change</td> <td>1</td> </tr> <tr> <td>string $pIndex Character column index</td> <td>1</td> </tr> <tr> <td>Spreadsheet $subject</td> <td>1</td> </tr> <tr> <td>int $pValue see self::PAPERSIZE_*</td> <td>1</td> </tr> <tr> <td>string $pValue see self::ORIENTATION_*</td> <td>1</td> </tr> <tr> <td>bool $pUpdate Update fitToPage so scaling applies rather than fitToHeight / fitToWidth</td> <td>1</td> </tr> <tr> <td>string $pStart eg: 'A'</td> <td>1</td> </tr> <tr> <td>string $pEnd eg: 'B'</td> <td>1</td> </tr> <tr> <td>int $pStart eg: 1</td> <td>1</td> </tr> <tr> <td>int $pEnd eg: 1</td> <td>1</td> </tr> <tr> <td>int $column1 Column 1</td> <td>1</td> </tr> <tr> <td>int $row1 Row 1</td> <td>1</td> </tr> <tr> <td>int $column2 Column 2</td> <td>1</td> </tr> <tr> <td>int $row2 Row 2</td> <td>1</td> </tr> <tr> <td>int $column1 Start Column for the print area</td> <td>1</td> </tr> <tr> <td>int $row1 Start Row for the print area</td> <td>1</td> </tr> <tr> <td>int $column2 End Column for the print area</td> <td>1</td> </tr> <tr> <td>int $row2 End Row for the print area</td> <td>1</td> </tr> <tr> <td>AutoFilter $pParent Autofilter for this column</td> <td>1</td> </tr> <tr> <td>AutoFilter $pParent</td> <td>1</td> </tr> <tr> <td>string $pFilterType</td> <td>1</td> </tr> <tr> <td>string $pJoin And/Or</td> <td>1</td> </tr> <tr> <td>string $pValue Attribute Value</td> <td>1</td> </tr> <tr> <td>Column\Rule $pRule</td> <td>1</td> </tr> <tr> <td>string $pRuleType see self::AUTOFILTER_RULETYPE_*</td> <td>1</td> </tr> <tr> <td>null|mixed $plotType</td> <td>1</td> </tr> <tr> <td>null|mixed $plotGrouping</td> <td>1</td> </tr> <tr> <td>int[] $plotOrder</td> <td>1</td> </tr> <tr> <td>DataSeriesValues[] $plotLabel</td> <td>1</td> </tr> <tr> <td>DataSeriesValues[] $plotCategory</td> <td>1</td> </tr> <tr> <td>DataSeriesValues[] $plotValues</td> <td>1</td> </tr> <tr> <td>null|string $plotDirection</td> <td>1</td> </tr> <tr> <td>string $plotType</td> <td>1</td> </tr> <tr> <td>string $groupingType</td> <td>1</td> </tr> <tr> <td>string $plotDirection</td> <td>1</td> </tr> <tr> <td>null|mixed $caption</td> <td>1</td> </tr> <tr> <td>string $caption</td> <td>1</td> </tr> <tr> <td>string $arrow_selector</td> <td>1</td> </tr> <tr> <td>string $property_selector</td> <td>1</td> </tr> <tr> <td>int $sh_color_alpha</td> <td>1</td> </tr> <tr> <td>string $sh_blur</td> <td>1</td> </tr> <tr> <td>string $position</td> <td>1</td> </tr> <tr> <td>string $position see self::POSITION_*</td> <td>1</td> </tr> <tr> <td>int $positionXL see self::XL_LEGEND_POSITION_*</td> <td>1</td> </tr> <tr> <td>float $angle</td> <td>1</td> </tr> <tr> <td>float $width</td> <td>1</td> </tr> <tr> <td>null|Title $title</td> <td>1</td> </tr> <tr> <td>null|Legend $legend</td> <td>1</td> </tr> <tr> <td>null|PlotArea $plotArea</td> <td>1</td> </tr> <tr> <td>mixed $plotVisibleOnly</td> <td>1</td> </tr> <tr> <td>mixed $displayBlanksAs</td> <td>1</td> </tr> <tr> <td>null|Title $xAxisLabel</td> <td>1</td> </tr> <tr> <td>null|Title $yAxisLabel</td> <td>1</td> </tr> <tr> <td>null|Axis $xAxis</td> <td>1</td> </tr> <tr> <td>null|Axis $yAxis</td> <td>1</td> </tr> <tr> <td>bool $plotVisibleOnly</td> <td>1</td> </tr> <tr> <td>string $displayBlanksAs</td> <td>1</td> </tr> <tr> <td>string $outputDestination Name of the file render to</td> <td>1</td> </tr> <tr> <td>array $layout</td> <td>1</td> </tr> <tr> <td>bool $value Show legend key</td> <td>1</td> </tr> <tr> <td>bool $value Show val</td> <td>1</td> </tr> <tr> <td>bool $value Show cat name</td> <td>1</td> </tr> <tr> <td>bool $value Show series name</td> <td>1</td> </tr> <tr> <td>bool $value Show percentage</td> <td>1</td> </tr> <tr> <td>bool $value Show bubble size</td> <td>1</td> </tr> <tr> <td>bool $value Show leader lines</td> <td>1</td> </tr> <tr> <td>string $dataType</td> <td>1</td> </tr> <tr> <td>null|mixed $formatCode</td> <td>1</td> </tr> <tr> <td>int $pointCount</td> <td>1</td> </tr> <tr> <td>mixed $dataValues</td> <td>1</td> </tr> <tr> <td>null|mixed $marker</td> <td>1</td> </tr> <tr> <td>null|string|string[] $fillColor</td> <td>1</td> </tr> <tr> <td>string $dataType Datatype of this data series</td> <td>1</td> </tr> <tr> <td>string $marker</td> <td>1</td> </tr> <tr> <td>string|string[] $color HEX color or array with HEX colors</td> <td>1</td> </tr> <tr> <td>string $color value for color</td> <td>1</td> </tr> <tr> <td>array $dataValues</td> <td>1</td> </tr> <tr> <td>mixed $format_code</td> <td>1</td> </tr> <tr> <td>string $axis_labels</td> <td>1</td> </tr> <tr> <td>string $horizontal_crosses_value</td> <td>1</td> </tr> <tr> <td>string $horizontal_crosses</td> <td>1</td> </tr> <tr> <td>string $axis_orientation</td> <td>1</td> </tr> <tr> <td>string $major_tmt</td> <td>1</td> </tr> <tr> <td>string $minor_tmt</td> <td>1</td> </tr> <tr> <td>string $minimum</td> <td>1</td> </tr> <tr> <td>string $maximum</td> <td>1</td> </tr> <tr> <td>string $major_unit</td> <td>1</td> </tr> <tr> <td>string $minor_unit</td> <td>1</td> </tr> <tr> <td>string $orientation</td> <td>1</td> </tr> <tr> <td>string $sh_color_alpha</td> <td>1</td> </tr> <tr> <td>float $sh_blur</td> <td>1</td> </tr> <tr> <td>array|string $property</td> <td>1</td> </tr> <tr> <td>Chart $chart</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Chart\Chart $chart</td> <td>1</td> </tr> <tr> <td>string $filename Name of the file render to</td> <td>1</td> </tr> <tr> <td>bool|string $pValue</td> <td>1</td> </tr> <tr> <td>string $pValue see self::HORIZONTAL_*</td> <td>1</td> </tr> <tr> <td>string $pValue see self::VERTICAL_*</td> <td>1</td> </tr> <tr> <td>Spreadsheet|Style $parent</td> <td>1</td> </tr> <tr> <td>null|string $parentPropertyName</td> <td>1</td> </tr> <tr> <td>bool|string $pValue \PhpOffice\PhpSpreadsheet\Style\Font underline type</td> <td>1</td> </tr> <tr> <td>string $pValue Fill type, see self::FILL_*</td> <td>1</td> </tr> <tr> <td>string $pARGB ARGB value for the colour</td> <td>1</td> </tr> <tr> <td>string $pValue see self::COLOR_*</td> <td>1</td> </tr> <tr> <td>string $pValue RGB value</td> <td>1</td> </tr> <tr> <td>int $offset Position within the RGB value to extract</td> <td>1</td> </tr> <tr> <td>string $hex The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)</td> <td>1</td> </tr> <tr> <td>float $adjustPercentage The percentage by which to adjust the colour as a float from -1 to 1</td> <td>1</td> </tr> <tr> <td>int $pIndex Index entry point into the colour array</td> <td>1</td> </tr> <tr> <td>bool $background Flag to indicate whether default background or foreground colour</td> <td>1</td> </tr> <tr> <td>string $pValue see self::FORMAT_*</td> <td>1</td> </tr> <tr> <td>mixed $value Value to format</td> <td>1</td> </tr> <tr> <td>string $format Format code, see = self::FORMAT_*</td> <td>1</td> </tr> <tr> <td>array $callBack Callback function for additional formatting of string</td> <td>1</td> </tr> <tr> <td>int $pValue see self::DIAGONAL_*</td> <td>1</td> </tr> <tr> <td>bool $pAdvanced advanced mode for setting borders</td> <td>1</td> </tr> <tr> <td>Font $font</td> <td>1</td> </tr> <tr> <td>Conditional[] $pValue Array of conditional styles</td> <td>1</td> </tr> <tr> <td>string $pValue Condition type, see self::CONDITION_*</td> <td>1</td> </tr> <tr> <td>string $pValue Conditional operator type, see self::OPERATOR_*</td> <td>1</td> </tr> <tr> <td>string[] $pValue Condition</td> <td>1</td> </tr> <tr> <td>string $pValue Condition</td> <td>1</td> </tr> <tr> <td>Style $pValue</td> <td>1</td> </tr> <tr> <td>int $pTemporaryStorage Temporary storage location</td> <td>1</td> </tr> <tr> <td>string $pTemporaryStorageFolder Temporary storage folder</td> <td>1</td> </tr> <tr> <td>string|string[] $text</td> <td>1</td> </tr> <tr> <td>bool $useUploadTempDir Use File Upload Temporary directory (true or false)</td> <td>1</td> </tr> <tr> <td>string $pFilename Filename</td> <td>1</td> </tr> <tr> <td>string $pPassword Password to hash</td> <td>1</td> </tr> <tr> <td>int $pValue Value in EMU</td> <td>1</td> </tr> <tr> <td>float $pValue Value in cell dimension</td> <td>1</td> </tr> <tr> <td>int $pValue Value in points</td> <td>1</td> </tr> <tr> <td>int $pValue Degrees</td> <td>1</td> </tr> <tr> <td>int $pValue Angle</td> <td>1</td> </tr> <tr> <td>string $p_sFile Path to Windows DIB (BMP) image</td> <td>1</td> </tr> <tr> <td>int $blockId byte offset from beginning of file</td> <td>1</td> </tr> <tr> <td>int|OLE\PPS $blockIdOrPps block id or PPS</td> <td>1</td> </tr> <tr> <td>int $blockId the block id of the first block</td> <td>1</td> </tr> <tr> <td>int $index The index of the PPS from which we are checking</td> <td>1</td> </tr> <tr> <td>int $index the index for the PPS</td> <td>1</td> </tr> <tr> <td>int $position The position from which to start reading</td> <td>1</td> </tr> <tr> <td>int $length The amount of bytes to read (at most)</td> <td>1</td> </tr> <tr> <td>string $ascii The ASCII string to transform</td> <td>1</td> </tr> <tr> <td>int $date A timestamp</td> <td>1</td> </tr> <tr> <td>string $oleTimestamp A binary string with the encoded date</td> <td>1</td> </tr> <tr> <td>$pFilename string Filename</td> <td>1</td> </tr> <tr> <td>int $stream</td> <td>1</td> </tr> <tr> <td>int $bl Sector ID where the stream starts</td> <td>1</td> </tr> <tr> <td>Escher\DggContainer $dggContainer</td> <td>1</td> </tr> <tr> <td>Escher\DgContainer $dgContainer</td> <td>1</td> </tr> <tr> <td>string $pValue see self::AUTOSIZE_METHOD_*</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font $font Font object</td> <td>1</td> </tr> <tr> <td>RichText|string $cellText Text to calculate width</td> <td>1</td> </tr> <tr> <td>int $rotation Rotation angle</td> <td>1</td> </tr> <tr> <td>null|\PhpOffice\PhpSpreadsheet\Style\Font $defaultFont Font object</td> <td>1</td> </tr> <tr> <td>string $text</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font</td> <td>1</td> </tr> <tr> <td>string $columnText</td> <td>1</td> </tr> <tr> <td>int $fontSizeInPoints Font size (in points)</td> <td>1</td> </tr> <tr> <td>int $sizeInInch Font size (in inch)</td> <td>1</td> </tr> <tr> <td>int $sizeInCm Font size (in centimeters)</td> <td>1</td> </tr> <tr> <td>string $name Font name</td> <td>1</td> </tr> <tr> <td>bool $pPixels true = return column width in pixels, false = return in OOXML units</td> <td>1</td> </tr> <tr> <td>string $col The column</td> <td>1</td> </tr> <tr> <td>int $row The row index (1-based)</td> <td>1</td> </tr> <tr> <td>string $startColumn</td> <td>1</td> </tr> <tr> <td>int $startOffsetX Offset within start cell measured in 1/1024 of the cell width</td> <td>1</td> </tr> <tr> <td>string $endColumn</td> <td>1</td> </tr> <tr> <td>int $endOffsetX Offset within end cell measured in 1/1024 of the cell width</td> <td>1</td> </tr> <tr> <td>int $startRow (1-based)</td> <td>1</td> </tr> <tr> <td>int $startOffsetY Offset within start cell measured in 1/256 of the cell height</td> <td>1</td> </tr> <tr> <td>int $endRow (1-based)</td> <td>1</td> </tr> <tr> <td>int $endOffsetY Offset within end cell measured in 1/256 of the cell height</td> <td>1</td> </tr> <tr> <td>string $coordinates E.g. 'A1'</td> <td>1</td> </tr> <tr> <td>int $offsetX Horizontal offset in pixels</td> <td>1</td> </tr> <tr> <td>int $offsetY Vertical offset in pixels</td> <td>1</td> </tr> <tr> <td>int $width Width in pixels</td> <td>1</td> </tr> <tr> <td>int $height Height in pixels</td> <td>1</td> </tr> <tr> <td>int $baseDate Excel base date (1900 or 1904)</td> <td>1</td> </tr> <tr> <td>DateTimeZone|string $timeZone The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions</td> <td>1</td> </tr> <tr> <td>DateTimeZone|string $timeZone The timezone to validate, either as a timezone string or object</td> <td>1</td> </tr> <tr> <td>mixed $dateValue Unix Timestamp or PHP DateTime object or a string</td> <td>1</td> </tr> <tr> <td>DateTimeInterface $dateValue PHP DateTime object</td> <td>1</td> </tr> <tr> <td>int $dateValue Unix Timestamp</td> <td>1</td> </tr> <tr> <td>NumberFormat $pFormat</td> <td>1</td> </tr> <tr> <td>string $pFormatCode</td> <td>1</td> </tr> <tr> <td>string $dateValue Examples: '2009-12-31', '2009-12-31 15:59', '2009-12-31 15:59:10'</td> <td>1</td> </tr> <tr> <td>string $month Month name or abbreviation</td> <td>1</td> </tr> <tr> <td>string $day Day number with an ordinal</td> <td>1</td> </tr> <tr> <td>string $timezone The timezone for finding the adjustment to UST</td> <td>1</td> </tr> <tr> <td>int $timestamp PHP date/time value</td> <td>1</td> </tr> <tr> <td>int $codePage Microsoft Code Page Indentifier</td> <td>1</td> </tr> <tr> <td>string $value Value to unescape</td> <td>1</td> </tr> <tr> <td>string $value Value to escape</td> <td>1</td> </tr> <tr> <td>mixed[] $arrcRuns Details of rich text runs in $value</td> <td>1</td> </tr> <tr> <td>string $to Encoding to convert to, e.g. 'UTF-8'</td> <td>1</td> </tr> <tr> <td>string $from Encoding to convert from, e.g. 'UTF-16LE'</td> <td>1</td> </tr> <tr> <td>string $enc Encoding</td> <td>1</td> </tr> <tr> <td>int $pStart Start offset</td> <td>1</td> </tr> <tr> <td>int $pLength Maximum number of characters in substring</td> <td>1</td> </tr> <tr> <td>string &$operand string value to test</td> <td>1</td> </tr> <tr> <td>string $pValue Character for decimal separator</td> <td>1</td> </tr> <tr> <td>string $pValue Character for thousands separator</td> <td>1</td> </tr> <tr> <td>string $pValue Character for currency code</td> <td>1</td> </tr> <tr> <td>float[] $yValues</td> <td>1</td> </tr> <tr> <td>float[] $xValues</td> <td>1</td> </tr> <tr> <td>mixed $Arg Rectangular matrix</td> <td>1</td> </tr> <tr> <td>mixed $c Int/float/double value</td> <td>1</td> </tr> <tr> <td>mixed $c Diagonal value</td> <td>1</td> </tr> <tr> <td>mixed $n Matrix/Array/Scalar</td> <td>1</td> </tr> <tr> <td>Matrix $B Right hand side</td> <td>1</td> </tr> <tr> <td>matrix $A Rectangular matrix</td> <td>1</td> </tr> <tr> <td>Matrix $B a Matrix with as many rows as A and any number of columns</td> <td>1</td> </tr> <tr> <td>mixed $xr</td> <td>1</td> </tr> <tr> <td>mixed $xi</td> <td>1</td> </tr> <tr> <td>mixed $yr</td> <td>1</td> </tr> <tr> <td>mixed $yi</td> <td>1</td> </tr> <tr> <td>mixed $Arg A Square matrix</td> <td>1</td> </tr> <tr> <td>Matrix $A Rectangular matrix</td> <td>1</td> </tr> <tr> <td>mixed $B a Matrix with as many rows as A and any number of columns</td> <td>1</td> </tr> <tr> <td>Matrix $A Matrix square symmetric positive definite matrix</td> <td>1</td> </tr> <tr> <td>$B Row-equal matrix</td> <td>1</td> </tr> <tr> <td>string $path resource name including scheme, e.g.</td> <td>1</td> </tr> <tr> <td>string $mode only "r" is supported</td> <td>1</td> </tr> <tr> <td>int $options mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH</td> <td>1</td> </tr> <tr> <td>string &$openedPath absolute path of the opened stream (out parameter)</td> <td>1</td> </tr> <tr> <td>int $count maximum number of bytes to read</td> <td>1</td> </tr> <tr> <td>int $offset byte offset</td> <td>1</td> </tr> <tr> <td>int $whence SEEK_SET, SEEK_CUR or SEEK_END</td> <td>1</td> </tr> <tr> <td>int $No The PPS index</td> <td>1</td> </tr> <tr> <td>string $name The PPS name</td> <td>1</td> </tr> <tr> <td>int $type The PPS type. Dir, Root or File</td> <td>1</td> </tr> <tr> <td>int $prev The index of the previous PPS</td> <td>1</td> </tr> <tr> <td>int $next The index of the next PPS</td> <td>1</td> </tr> <tr> <td>int $dir The index of it's first child if this is a Dir or Root PPS</td> <td>1</td> </tr> <tr> <td>string $data The (usually binary) source data of the PPS</td> <td>1</td> </tr> <tr> <td>array $children Array containing children PPS for this PPS</td> <td>1</td> </tr> <tr> <td>array &$raList Reference to the array of PPS's for the whole OLE</td> <td>1</td> </tr> <tr> <td>mixed $to_save</td> <td>1</td> </tr> <tr> <td>mixed $depth</td> <td>1</td> </tr> <tr> <td>string $name The name of the file (in Unicode)</td> <td>1</td> </tr> <tr> <td>string $data The data to append</td> <td>1</td> </tr> <tr> <td>File[] $raChild</td> <td>1</td> </tr> <tr> <td>resource|string $filename the name of the file or stream where to save the OLE container</td> <td>1</td> </tr> <tr> <td>array $raList Reference to an array of PPS's</td> <td>1</td> </tr> <tr> <td>int $i2 The argument</td> <td>1</td> </tr> <tr> <td>int $iSBDcnt</td> <td>1</td> </tr> <tr> <td>int $iBBcnt</td> <td>1</td> </tr> <tr> <td>int $iPPScnt</td> <td>1</td> </tr> <tr> <td>int $iStBlk</td> <td>1</td> </tr> <tr> <td>array $raList Reference to an array with all PPS's</td> <td>1</td> </tr> <tr> <td>int $iSbdSize</td> <td>1</td> </tr> <tr> <td>int $iBsize</td> <td>1</td> </tr> <tr> <td>int $iPpsCnt</td> <td>1</td> </tr> <tr> <td>DggContainer\BstoreContainer $bstoreContainer</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer $parent</td> <td>1</td> </tr> <tr> <td>mixed $child</td> <td>1</td> </tr> <tr> <td>SpgrContainer $parent</td> <td>1</td> </tr> <tr> <td>int $startOffsetX</td> <td>1</td> </tr> <tr> <td>int $startOffsetY</td> <td>1</td> </tr> <tr> <td>int $endOffsetX</td> <td>1</td> </tr> <tr> <td>int $endOffsetY</td> <td>1</td> </tr> <tr> <td>BstoreContainer\BSE $BSE</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer $parent</td> <td>1</td> </tr> <tr> <td>BSE\Blip $blip</td> <td>1</td> </tr> <tr> <td>int $blipType</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE $parent</td> <td>1</td> </tr> <tr> <td>string $creator</td> <td>1</td> </tr> <tr> <td>string $keywords</td> <td>1</td> </tr> <tr> <td>string $category</td> <td>1</td> </tr> <tr> <td>string $company</td> <td>1</td> </tr> <tr> <td>string $manager</td> <td>1</td> </tr> <tr> <td>mixed $propertyValue</td> <td>1</td> </tr> <tr> <td>string $propertyType</td> <td>1</td> </tr> <tr> <td>string $pDataType</td> <td>1</td> </tr> <tr> <td>bool $resetLog Whether the calculation engine logger should be reset or not</td> <td>1</td> </tr> <tr> <td>string $pDataType see DataType::TYPE_*</td> <td>1</td> </tr> <tr> <td>DataValidation $pDataValidation</td> <td>1</td> </tr> <tr> <td>Hyperlink $pHyperlink</td> <td>1</td> </tr> <tr> <td>Cell $a Cell a</td> <td>1</td> </tr> <tr> <td>Cell $b Cell b</td> <td>1</td> </tr> <tr> <td>IValueBinder $binder</td> <td>1</td> </tr> <tr> <td>mixed $pAttributes</td> <td>1</td> </tr> <tr> <td>string $pUrl Url to link the cell to</td> <td>1</td> </tr> <tr> <td>string $pTooltip Tooltip to display on the hyperlink</td> <td>1</td> </tr> <tr> <td>string $coord eg: 'A1' or 'A1:A2' or 'A1:A2,C1:C2'</td> <td>1</td> </tr> <tr> <td>string $pCoordinateString eg: 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCoordinateString e.g. 'A' or '1' or 'A1'</td> <td>1</td> </tr> <tr> <td>string $pCoordinateString e.g. 'A1'</td> <td>1</td> </tr> <tr> <td>string $pRange e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'</td> <td>1</td> </tr> <tr> <td>array $pRange Array containg one or more arrays containing one or two coordinate strings</td> <td>1</td> </tr> <tr> <td>string $pString eg 'A'</td> <td>1</td> </tr> <tr> <td>int $columnIndex Column index (A = 1)</td> <td>1</td> </tr> <tr> <td>string $pRange Range (e.g. A1 or A1:C10 or A1:E10 A20:E25)</td> <td>1</td> </tr> <tr> <td>string $cellBlock A cell range e.g. A4:B5</td> <td>1</td> </tr> <tr> <td>array $pCoordCollection associative array mapping coordinates to values</td> <td>1</td> </tr> <tr> <td>string $cellBlock The original range, for displaying a meaningful error message</td> <td>1</td> </tr> <tr> <td>int $startColumnIndex</td> <td>1</td> </tr> <tr> <td>int $endColumnIndex</td> <td>1</td> </tr> <tr> <td>int $currentRow</td> <td>1</td> </tr> <tr> <td>int $endRow</td> <td>1</td> </tr> <tr> <td>null|RichText|string $pValue Value to sanitize to an Excel string</td> <td>1</td> </tr> <tr> <td>mixed $pValue Value to sanitize to an Excel error code</td> <td>1</td> </tr> <tr> <td>string $value see self::STYLE_*</td> <td>1</td> </tr> <tr> <td>string $compatibilityMode Compatibility Mode</td> <td>1</td> </tr> <tr> <td>string $returnDateType Return Date Format</td> <td>1</td> </tr> <tr> <td>null|mixed $value The value you want converted</td> <td>1</td> </tr> <tr> <td>null|mixed $value The value you want tested</td> <td>1</td> </tr> <tr> <td>mixed $value Array or scalar value</td> <td>1</td> </tr> <tr> <td>int|string $year The year to test</td> <td>1</td> </tr> <tr> <td>int $startDay Day of month of the start date</td> <td>1</td> </tr> <tr> <td>int $startMonth Month of the start date</td> <td>1</td> </tr> <tr> <td>int $startYear Year of the start date</td> <td>1</td> </tr> <tr> <td>int $endDay Day of month of the start date</td> <td>1</td> </tr> <tr> <td>int $endMonth Month of the start date</td> <td>1</td> </tr> <tr> <td>int $endYear Year of the start date</td> <td>1</td> </tr> <tr> <td>bool $methodUS Whether to use the US method or the European method of calculation</td> <td>1</td> </tr> <tr> <td>string $dateValue</td> <td>1</td> </tr> <tr> <td>string $timeValue</td> <td>1</td> </tr> <tr> <td>int $year The value of the year argument can include one to four digits.</td> <td>1</td> </tr> <tr> <td>int $month A positive or negative integer representing the month of the year</td> <td>1</td> </tr> <tr> <td>int $day A positive or negative integer representing the day of the month</td> <td>1</td> </tr> <tr> <td>int $hour A number from 0 (zero) to 32767 representing the hour.</td> <td>1</td> </tr> <tr> <td>int $minute A number from 0 to 32767 representing the minute.</td> <td>1</td> </tr> <tr> <td>int $second A number from 0 to 32767 representing the second.</td> <td>1</td> </tr> <tr> <td>string $dateValue Text that represents a date in a Microsoft Excel date format.</td> <td>1</td> </tr> <tr> <td>string $timeValue A text string that represents a time in any one of the Microsoft</td> <td>1</td> </tr> <tr> <td>mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object</td> <td>1</td> </tr> <tr> <td>mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object</td> <td>1</td> </tr> <tr> <td>\DateTimeImmutable|float|int|string $endDate Excel date serial value (float),</td> <td>1</td> </tr> <tr> <td>\DateTimeImmutable|float|int|string $startDate Excel date serial value (float),</td> <td>1</td> </tr> <tr> <td>bool $method US or European Method</td> <td>1</td> </tr> <tr> <td>int $method Method used for the calculation</td> <td>1</td> </tr> <tr> <td>int $endDays The number of nonweekend and nonholiday days before or after</td> <td>1</td> </tr> <tr> <td>int $dateValue Excel date serial value (float), PHP date timestamp (integer),</td> <td>1</td> </tr> <tr> <td>int $style A number that determines the type of return value</td> <td>1</td> </tr> <tr> <td>int $method Week begins on Sunday or Monday</td> <td>1</td> </tr> <tr> <td>\DateTime $testDate The date for testing</td> <td>1</td> </tr> <tr> <td>int|string $year The year against which we're testing</td> <td>1</td> </tr> <tr> <td>int|string $basis The type of day count:</td> <td>1</td> </tr> <tr> <td>mixed $issue the security's issue date</td> <td>1</td> </tr> <tr> <td>mixed $firstinterest the security's first interest date</td> <td>1</td> </tr> <tr> <td>float $rate the security's annual coupon rate</td> <td>1</td> </tr> <tr> <td>mixed $settlement The security's settlement (or maturity) date</td> <td>1</td> </tr> <tr> <td>float $rate The security's annual coupon rate</td> <td>1</td> </tr> <tr> <td>int $month Number of months in the first year. If month is omitted,</td> <td>1</td> </tr> <tr> <td>float $factor The rate at which the balance declines.</td> <td>1</td> </tr> <tr> <td>float $fractional_dollar Fractional Dollar</td> <td>1</td> </tr> <tr> <td>float $decimal_dollar Decimal Dollar</td> <td>1</td> </tr> <tr> <td>float $nominal_rate Nominal interest rate</td> <td>1</td> </tr> <tr> <td>float $rate The interest rate per period</td> <td>1</td> </tr> <tr> <td>int $nper Total number of payment periods in an annuity</td> <td>1</td> </tr> <tr> <td>float $pmt The payment made each period: it cannot change over the</td> <td>1</td> </tr> <tr> <td>float $pv present Value, or the lump-sum amount that a series of</td> <td>1</td> </tr> <tr> <td>float $principal the present value</td> <td>1</td> </tr> <tr> <td>float[] $schedule an array of interest rates to apply</td> <td>1</td> </tr> <tr> <td>int $investment the amount invested in the security</td> <td>1</td> </tr> <tr> <td>int $redemption the amount to be received at maturity</td> <td>1</td> </tr> <tr> <td>float[] $values An array or a reference to cells that contain numbers for which you want</td> <td>1</td> </tr> <tr> <td>float $guess A number that you guess is close to the result of IRR</td> <td>1</td> </tr> <tr> <td>float[] $values An array or a reference to cells that contain a series of payments and</td> <td>1</td> </tr> <tr> <td>float $finance_rate The interest rate you pay on the money used in the cash flows</td> <td>1</td> </tr> <tr> <td>float $reinvestment_rate The interest rate you receive on the cash flows as you reinvest them</td> <td>1</td> </tr> <tr> <td>float $effect_rate Effective interest rate</td> <td>1</td> </tr> <tr> <td>int $pmt Periodic payment (annuity)</td> <td>1</td> </tr> <tr> <td>int $yield The security's annual yield</td> <td>1</td> </tr> <tr> <td>float $pmt Periodic payment (annuity)</td> <td>1</td> </tr> <tr> <td>float $nper The total number of payment periods in an annuity</td> <td>1</td> </tr> <tr> <td>float $pmt The payment made each period and cannot change over the life</td> <td>1</td> </tr> <tr> <td>float $pv The present value - the total amount that a series of future</td> <td>1</td> </tr> <tr> <td>float $fv The future value, or a cash balance you want to attain after</td> <td>1</td> </tr> <tr> <td>float $guess Your guess for what the rate will be.</td> <td>1</td> </tr> <tr> <td>int $investment The amount invested in the security</td> <td>1</td> </tr> <tr> <td>float $nper The number of periods over which the investment is made</td> <td>1</td> </tr> <tr> <td>mixed $period Period</td> <td>1</td> </tr> <tr> <td>int $price The Treasury bill's price per $100 face value</td> <td>1</td> </tr> <tr> <td>float[] $values A series of cash flow payments</td> <td>1</td> </tr> <tr> <td>mixed[] $dates A series of payment dates</td> <td>1</td> </tr> <tr> <td>float $guess An optional guess at the expected answer</td> <td>1</td> </tr> <tr> <td>float $rate the discount rate to apply to the cash flows</td> <td>1</td> </tr> <tr> <td>float[] $values A series of cash flows that corresponds to a schedule of payments in dates.</td> <td>1</td> </tr> <tr> <td>mixed[] $dates A schedule of payment dates that corresponds to the cash flow payments.</td> <td>1</td> </tr> <tr> <td>Spreadsheet $spreadsheet Injected spreadsheet for working with a PhpSpreadsheet Spreadsheet object,</td> <td>1</td> </tr> <tr> <td>string $returnType Array return type</td> <td>1</td> </tr> <tr> <td>string $worksheetName</td> <td>1</td> </tr> <tr> <td>string $fromWorksheetName</td> <td>1</td> </tr> <tr> <td>string $toWorksheetName</td> <td>1</td> </tr> <tr> <td>mixed $enabled</td> <td>1</td> </tr> <tr> <td>string $locale The locale to use for formula translation, eg: 'en_us'</td> <td>1</td> </tr> <tr> <td>bool $inBraces</td> <td>1</td> </tr> <tr> <td>string[] $from</td> <td>1</td> </tr> <tr> <td>string[] $to</td> <td>1</td> </tr> <tr> <td>bool $resetLog Flag indicating whether the debug log should be reset or not</td> <td>1</td> </tr> <tr> <td>string $cellID Address of the cell to calculate</td> <td>1</td> </tr> <tr> <td>string $formula The formula to parse and calculate</td> <td>1</td> </tr> <tr> <td>string $cellID The ID (e.g. A3) of the cell that we are calculating</td> <td>1</td> </tr> <tr> <td>mixed &$operand1 First matrix operand</td> <td>1</td> </tr> <tr> <td>mixed &$operand2 Second matrix operand</td> <td>1</td> </tr> <tr> <td>int $resize Flag indicating whether the matrices should be resized to match</td> <td>1</td> </tr> <tr> <td>array &$matrix matrix operand</td> <td>1</td> </tr> <tr> <td>null|\PhpOffice\PhpSpreadsheet\Cell\Cell $pCell</td> <td>1</td> </tr> <tr> <td>mixed $tokens</td> <td>1</td> </tr> <tr> <td>string $operation</td> <td>1</td> </tr> <tr> <td>Stack $stack</td> <td>1</td> </tr> <tr> <td>bool $recursingArrays</td> <td>1</td> </tr> <tr> <td>string $str1 First string value for the comparison</td> <td>1</td> </tr> <tr> <td>string $str2 Second string value for the comparison</td> <td>1</td> </tr> <tr> <td>mixed $operation</td> <td>1</td> </tr> <tr> <td>string $matrixFunction</td> <td>1</td> </tr> <tr> <td>mixed $stack</td> <td>1</td> </tr> <tr> <td>string $pFunction Function Name</td> <td>1</td> </tr> <tr> <td>array $args</td> <td>1</td> </tr> <tr> <td>bool $passCellReference</td> <td>1</td> </tr> <tr> <td>array|string $functionCall</td> <td>1</td> </tr> <tr> <td>mixed $logical A value or expression that can be evaluated to TRUE or FALSE</td> <td>1</td> </tr> <tr> <td>mixed $condition Condition to evaluate</td> <td>1</td> </tr> <tr> <td>mixed $returnIfTrue Value to return when condition is true</td> <td>1</td> </tr> <tr> <td>mixed $returnIfFalse Optional value to return when condition is false</td> <td>1</td> </tr> <tr> <td>mixed $arguments Statement arguments</td> <td>1</td> </tr> <tr> <td>mixed $testValue Value to check, is also the value returned when no error</td> <td>1</td> </tr> <tr> <td>mixed $errorpart Value to return when testValue is an error condition</td> <td>1</td> </tr> <tr> <td>mixed $testValue Value to check, is also the value returned when not an NA</td> <td>1</td> </tr> <tr> <td>mixed $napart Value to return when testValue is an NA condition</td> <td>1</td> </tr> <tr> <td>mixed $field Indicates which column is used in the function. Enter the</td> <td>1</td> </tr> <tr> <td>string $pFormula Formula to parse</td> <td>1</td> </tr> <tr> <td>int $pId Token id</td> <td>1</td> </tr> <tr> <td>string $character Value</td> <td>1</td> </tr> <tr> <td>string $characters Value</td> <td>1</td> </tr> <tr> <td>float $value The value to format</td> <td>1</td> </tr> <tr> <td>int $decimals The number of digits to display to the right of the decimal point.</td> <td>1</td> </tr> <tr> <td>int $decimals</td> <td>1</td> </tr> <tr> <td>bool $no_commas</td> <td>1</td> </tr> <tr> <td>string $oldText String to modify</td> <td>1</td> </tr> <tr> <td>string $newText String to replace in defined position</td> <td>1</td> </tr> <tr> <td>string $text Value</td> <td>1</td> </tr> <tr> <td>string $fromText From Value</td> <td>1</td> </tr> <tr> <td>string $toText To Value</td> <td>1</td> </tr> <tr> <td>int $instance Instance Number</td> <td>1</td> </tr> <tr> <td>mixed $testValue Value to check</td> <td>1</td> </tr> <tr> <td>string $format Format mask to use</td> <td>1</td> </tr> <tr> <td>string $decimalSeparator decimal separator, defaults to locale defined value</td> <td>1</td> </tr> <tr> <td>string $groupSeparator group/thosands separator, defaults to locale defined value</td> <td>1</td> </tr> <tr> <td>$value1</td> <td>1</td> </tr> <tr> <td>$value2</td> <td>1</td> </tr> <tr> <td>mixed $delimiter</td> <td>1</td> </tr> <tr> <td>mixed $ignoreEmpty</td> <td>1</td> </tr> <tr> <td>mixed $args</td> <td>1</td> </tr> <tr> <td>mixed $x require 0<=x<=1</td> <td>1</td> </tr> <tr> <td>mixed $x</td> <td>1</td> </tr> <tr> <td>mixed $p</td> <td>1</td> </tr> <tr> <td>mixed $q</td> <td>1</td> </tr> <tr> <td>string $condition the criteria that defines which cells will be checked</td> <td>1</td> </tr> <tr> <td>mixed[] $averageArgs Data values</td> <td>1</td> </tr> <tr> <td>mixed $rMin</td> <td>1</td> </tr> <tr> <td>mixed $rMax</td> <td>1</td> </tr> <tr> <td>float $rMin Minimum value</td> <td>1</td> </tr> <tr> <td>float $rMax Maximum value</td> <td>1</td> </tr> <tr> <td>float $value Number of successes in trials</td> <td>1</td> </tr> <tr> <td>float $trials Number of trials</td> <td>1</td> </tr> <tr> <td>float $alpha</td> <td>1</td> </tr> <tr> <td>null|mixed $xValues array of mixed Data Series X</td> <td>1</td> </tr> <tr> <td>string $condition the criteria that defines which cells will be counted</td> <td>1</td> </tr> <tr> <td>mixed $args Criterias</td> <td>1</td> </tr> <tr> <td>mixed $xValues array of mixed Data Series X</td> <td>1</td> </tr> <tr> <td>float $trials number of Bernoulli trials</td> <td>1</td> </tr> <tr> <td>float $probability probability of a success on each trial</td> <td>1</td> </tr> <tr> <td>float $alpha criterion value</td> <td>1</td> </tr> <tr> <td>float $value Value of the function</td> <td>1</td> </tr> <tr> <td>float $lambda The parameter value</td> <td>1</td> </tr> <tr> <td>float $xValue Value of X for which we want to find Y</td> <td>1</td> </tr> <tr> <td>mixed $xValues of mixed Data Series X</td> <td>1</td> </tr> <tr> <td>float $a Parameter to the distribution</td> <td>1</td> </tr> <tr> <td>float $b Parameter to the distribution</td> <td>1</td> </tr> <tr> <td>float $sampleSuccesses Number of successes in the sample</td> <td>1</td> </tr> <tr> <td>float $sampleNumber Size of the sample</td> <td>1</td> </tr> <tr> <td>float $populationSuccesses Number of successes in the population</td> <td>1</td> </tr> <tr> <td>float $populationNumber Population size</td> <td>1</td> </tr> <tr> <td>int $entry Position (ordered from the largest) in the array or range of data to return</td> <td>1</td> </tr> <tr> <td>float $failures Number of Failures</td> <td>1</td> </tr> <tr> <td>float $successes Threshold number of Successes</td> <td>1</td> </tr> <tr> <td>float $entry Percentile value in the range 0..1, inclusive.</td> <td>1</td> </tr> <tr> <td>int $significance the number of significant digits for the returned percentage value</td> <td>1</td> </tr> <tr> <td>int $numInSet Number of objects in each permutation</td> <td>1</td> </tr> <tr> <td>int $entry Quartile value in the range 1..3, inclusive.</td> <td>1</td> </tr> <tr> <td>int $order Order to sort the values in the value set</td> <td>1</td> </tr> <tr> <td>int $entry Position (ordered from the smallest) in the array or range of data to return</td> <td>1</td> </tr> <tr> <td>float $value Value to normalize</td> <td>1</td> </tr> <tr> <td>float $tails number of tails (1 or 2)</td> <td>1</td> </tr> <tr> <td>float $discard Percentage to discard</td> <td>1</td> </tr> <tr> <td>float $alpha Alpha Parameter</td> <td>1</td> </tr> <tr> <td>float $beta Beta Parameter</td> <td>1</td> </tr> <tr> <td>float $dataSet</td> <td>1</td> </tr> <tr> <td>float $m0 Alpha Parameter</td> <td>1</td> </tr> <tr> <td>float $sigma Beta Parameter</td> <td>1</td> </tr> <tr> <td>string $complexNumber The complex number</td> <td>1</td> </tr> <tr> <td>string $xVal The "number" to pad</td> <td>1</td> </tr> <tr> <td>int $places The length that we want to pad this value</td> <td>1</td> </tr> <tr> <td>int $ord The order of the Bessel function.</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, BIN2HEX uses the</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, BIN2OCT uses the</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, DEC2BIN uses</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, DEC2HEX uses</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, DEC2OCT uses</td> <td>1</td> </tr> <tr> <td>string $x the hexadecimal number you want to convert.</td> <td>1</td> </tr> <tr> <td>string $x The hexadecimal number you want to convert. This number cannot</td> <td>1</td> </tr> <tr> <td>string $x The hexadecimal number you want to convert. Number cannot</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, HEX2OCT</td> <td>1</td> </tr> <tr> <td>string $x The octal number you want to convert. Number may not</td> <td>1</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted, OCT2HEX</td> <td>1</td> </tr> <tr> <td>float $realNumber the real coefficient of the complex number</td> <td>1</td> </tr> <tr> <td>float $imaginary the imaginary coefficient of the complex number</td> <td>1</td> </tr> <tr> <td>string $suffix The suffix for the imaginary component of the complex number.</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the imaginary</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the real coefficient</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the absolute value</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the argument theta</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the conjugate</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the cosine</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the hyperbolic cosine</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the cotangent</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the cosecant</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the hyperbolic cosecant</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the sine</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the hyperbolic sine</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the secant</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the hyperbolic secant</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the tangent</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the square root</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the natural logarithm</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the common logarithm</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the base-2 logarithm</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number for which you want the exponential</td> <td>1</td> </tr> <tr> <td>string $complexNumber the complex number you want to raise to a power</td> <td>1</td> </tr> <tr> <td>float $realNumber the power to which you want to raise the complex number</td> <td>1</td> </tr> <tr> <td>string $complexDividend the complex numerator or dividend</td> <td>1</td> </tr> <tr> <td>string $complexDivisor the complex denominator or divisor</td> <td>1</td> </tr> <tr> <td>string $complexNumber1 the complex number from which to subtract complexNumber2</td> <td>1</td> </tr> <tr> <td>string $complexNumber2 the complex number to subtract from complexNumber1</td> <td>1</td> </tr> <tr> <td>string ...$complexNumbers Series of complex numbers to add</td> <td>1</td> </tr> <tr> <td>string ...$complexNumbers Series of complex numbers to multiply</td> <td>1</td> </tr> <tr> <td>float $a the first number</td> <td>1</td> </tr> <tr> <td>float $b The second number. If omitted, b is assumed to be zero.</td> <td>1</td> </tr> <tr> <td>float $number the value to test against step</td> <td>1</td> </tr> <tr> <td>float $step The threshold value.</td> <td>1</td> </tr> <tr> <td>float $lower lower bound for integrating ERF</td> <td>1</td> </tr> <tr> <td>float $upper upper bound for integrating ERF.</td> <td>1</td> </tr> <tr> <td>float $limit bound for integrating ERF</td> <td>1</td> </tr> <tr> <td>float $x The lower bound for integrating ERFC</td> <td>1</td> </tr> <tr> <td>float $value the value in fromUOM to convert</td> <td>1</td> </tr> <tr> <td>string $fromUOM the units for value</td> <td>1</td> </tr> <tr> <td>string $toUOM the units for the result</td> <td>1</td> </tr> <tr> <td>string $roman</td> <td>1</td> </tr> <tr> <td>array $roman</td> <td>1</td> </tr> <tr> <td>int $sum</td> <td>1</td> </tr> <tr> <td>int $subtract</td> <td>1</td> </tr> <tr> <td>float $xCoordinate the x-coordinate of the point</td> <td>1</td> </tr> <tr> <td>float $yCoordinate the y-coordinate of the point</td> <td>1</td> </tr> <tr> <td>float $number</td> <td>1</td> </tr> <tr> <td>float $radix</td> <td>1</td> </tr> <tr> <td>int $minLength</td> <td>1</td> </tr> <tr> <td>float $number the number you want to round</td> <td>1</td> </tr> <tr> <td>float $significance the multiple to which you want to round</td> <td>1</td> </tr> <tr> <td>int $numInSet Number of objects in each combination</td> <td>1</td> </tr> <tr> <td>int $mode direction to round negative numbers</td> <td>1</td> </tr> <tr> <td>float $number Number to cast to an integer</td> <td>1</td> </tr> <tr> <td>float $number The positive real number for which you want the logarithm</td> <td>1</td> </tr> <tr> <td>float $base The base of the logarithm. If base is omitted, it is assumed to be 10.</td> <td>1</td> </tr> <tr> <td>array $matrixData1 A matrix of values</td> <td>1</td> </tr> <tr> <td>array $matrixData2 A matrix of values</td> <td>1</td> </tr> <tr> <td>int $a Dividend</td> <td>1</td> </tr> <tr> <td>int $b Divisor</td> <td>1</td> </tr> <tr> <td>int $multiple Multiple to which you want to round $number</td> <td>1</td> </tr> <tr> <td>float $x</td> <td>1</td> </tr> <tr> <td>float $y</td> <td>1</td> </tr> <tr> <td>int $min Minimal value</td> <td>1</td> </tr> <tr> <td>int $max Maximal value</td> <td>1</td> </tr> <tr> <td>float $x Input value to the power series</td> <td>1</td> </tr> <tr> <td>float $n Initial power to which you want to raise $x</td> <td>1</td> </tr> <tr> <td>float $m Step by which to increase $n for each term in the series</td> <td>1</td> </tr> <tr> <td>int the number 1 to 11 that specifies which function to</td> <td>1</td> </tr> <tr> <td>mixed $sumArgs</td> <td>1</td> </tr> <tr> <td>int $digits</td> <td>1</td> </tr> <tr> <td>mixed $code</td> <td>1</td> </tr> <tr> <td>mixed $string</td> <td>1</td> </tr> <tr> <td>mixed $file</td> <td>1</td> </tr> <tr> <td>mixed $line</td> <td>1</td> </tr> <tr> <td>mixed $context</td> <td>1</td> </tr> <tr> <td>mixed $row Row number to use in the cell reference</td> <td>1</td> </tr> <tr> <td>mixed $column Column number to use in the cell reference</td> <td>1</td> </tr> <tr> <td>int $relativity Flag indicating the type of reference to return</td> <td>1</td> </tr> <tr> <td>bool $referenceStyle A logical value that specifies the A1 or R1C1 reference style.</td> <td>1</td> </tr> <tr> <td>string $sheetText Optional Name of worksheet to use</td> <td>1</td> </tr> <tr> <td>null|array|string $cellAddress A reference to a range of cells for which you want the column numbers</td> <td>1</td> </tr> <tr> <td>null|array|string $cellAddress An array or array formula, or a reference to a range of cells for which you want the number of columns</td> <td>1</td> </tr> <tr> <td>null|array|string $cellAddress A reference to a range of cells for which you want the row numbers</td> <td>1</td> </tr> <tr> <td>null|array|string $cellAddress An array or array formula, or a reference to a range of cells for which you want the number of rows</td> <td>1</td> </tr> <tr> <td>string $linkURL Value to check, is also the value returned when no error</td> <td>1</td> </tr> <tr> <td>string $displayName Value to return when testValue is an error condition</td> <td>1</td> </tr> <tr> <td>Cell $pCell The cell to set the hyperlink in</td> <td>1</td> </tr> <tr> <td>null|array|string $cellAddress $cellAddress The cell address of the current cell (containing this formula)</td> <td>1</td> </tr> <tr> <td>null|string $cellAddress The reference from which you want to base the offset. Reference must refer to a cell or</td> <td>1</td> </tr> <tr> <td>mixed $rows The number of rows, up or down, that you want the upper-left cell to refer to.</td> <td>1</td> </tr> <tr> <td>mixed $columns The number of columns, to the left or right, that you want the upper-left cell of the result</td> <td>1</td> </tr> <tr> <td>mixed $height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.</td> <td>1</td> </tr> <tr> <td>mixed $width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.</td> <td>1</td> </tr> <tr> <td>mixed $index_num Specifies which value argument is selected.</td> <td>1</td> </tr> <tr> <td>mixed $value1 ... Value1 is required, subsequent values are optional.</td> <td>1</td> </tr> <tr> <td>mixed $lookupValue The value that you want to match in lookup_array</td> <td>1</td> </tr> <tr> <td>mixed $lookupArray The range of cells being searched</td> <td>1</td> </tr> <tr> <td>mixed $matchType The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below.</td> <td>1</td> </tr> <tr> <td>mixed $arrayValues A range of cells or an array constant</td> <td>1</td> </tr> <tr> <td>mixed $rowNum The row in array from which to return a value. If row_num is omitted, column_num is required.</td> <td>1</td> </tr> <tr> <td>mixed $columnNum The column in array from which to return a value. If column_num is omitted, row_num is required.</td> <td>1</td> </tr> <tr> <td>array $matrixData A matrix of values</td> <td>1</td> </tr> <tr> <td>mixed $index_number The column number in table_array from which the matching value must be returned. The first column is 1.</td> <td>1</td> </tr> <tr> <td>mixed $index_number The row number in table_array from which the matching value must be returned. The first row is 1.</td> <td>1</td> </tr> <tr> <td>mixed $lookup_vector The range of cells being searched</td> <td>1</td> </tr> <tr> <td>null|mixed $result_vector The column from which the matching value must be returned</td> <td>1</td> </tr> <tr> <td>string $pTokenType Token type (represented by TOKEN_TYPE_*)</td> <td>1</td> </tr> <tr> <td>string $pTokenSubType Token Subtype (represented by TOKEN_SUBTYPE_*)</td> <td>1</td> </tr> <tr> <td>mixed $type</td> <td>1</td> </tr> <tr> <td>mixed $reference</td> <td>1</td> </tr> <tr> <td>null|string $storeKey will store the result under this alias</td> <td>1</td> </tr> <tr> <td>null|string $onlyIf will only run computation if the matching</td> <td>1</td> </tr> <tr> <td>null|string $onlyIfNot will only run computation if the matching</td> <td>1</td> </tr> <tr> <td>int $n number indicating how far back in the stack we want to look</td> <td>1</td> </tr> <tr> <td>CyclicReferenceStack $stack</td> <td>1</td> </tr> <tr> <td>mixed $value The value to test</td> <td>1</td> </tr> <tr> <td>bool $pValue Pre-Calculate Formulas?</td> <td>1</td> </tr> <tr> <td>string $pFilename Name of the file to save</td> <td>1</td> </tr> <tr> <td>string $pDirectory Disk caching directory</td> <td>1</td> </tr> <tr> <td>string $vAlign Vertical alignment</td> <td>1</td> </tr> <tr> <td>string $hAlign Horizontal alignment</td> <td>1</td> </tr> <tr> <td>int $borderStyle Sheet index</td> <td>1</td> </tr> <tr> <td>bool $pValue Flag indicating whether the sheet navigation block should be generated or not</td> <td>1</td> </tr> <tr> <td>bool $pIncludeStyles Include styles?</td> <td>1</td> </tr> <tr> <td>bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>)</td> <td>1</td> </tr> <tr> <td>bool $generateSurroundingHTML Generate surrounding HTML style? (html { })</td> <td>1</td> </tr> <tr> <td>Alignment $pStyle \PhpOffice\PhpSpreadsheet\Style\Alignment</td> <td>1</td> </tr> <tr> <td>Font $pStyle</td> <td>1</td> </tr> <tr> <td>Borders $pStyle Borders</td> <td>1</td> </tr> <tr> <td>Border $pStyle Border</td> <td>1</td> </tr> <tr> <td>Fill $pStyle Fill</td> <td>1</td> </tr> <tr> <td>Worksheet $pSheet The worksheet for the table we are writing</td> <td>1</td> </tr> <tr> <td>array $pValues Array containing cells in a row</td> <td>1</td> </tr> <tr> <td>int $pRow Row number (0-based)</td> <td>1</td> </tr> <tr> <td>string $cellType eg: 'td'</td> <td>1</td> </tr> <tr> <td>string $pValue Plain formatted value without color</td> <td>1</td> </tr> <tr> <td>string $pFormat Format code</td> <td>1</td> </tr> <tr> <td>string $coordinate</td> <td>1</td> </tr> <tr> <td>string $fontName</td> <td>1</td> </tr> <tr> <td>string $pValue Paper size see PageSetup::PAPERSIZE_*</td> <td>1</td> </tr> <tr> <td>string $pValue Page orientation see PageSetup::ORIENTATION_*</td> <td>1</td> </tr> <tr> <td>string $pValue Temporary storage directory</td> <td>1</td> </tr> <tr> <td>resource $fileHandle</td> <td>1</td> </tr> <tr> <td>string $pValue Delimiter, defaults to ','</td> <td>1</td> </tr> <tr> <td>string $pValue Enclosure, defaults to "</td> <td>1</td> </tr> <tr> <td>string $pValue Line ending, defaults to OS line ending (PHP_EOL)</td> <td>1</td> </tr> <tr> <td>bool $pValue Use UTF-8 byte-order mark? Defaults to false</td> <td>1</td> </tr> <tr> <td>bool $pValue Use separator line? Defaults to false</td> <td>1</td> </tr> <tr> <td>bool $pValue Set the file to be written as a fully Excel compatible csv file</td> <td>1</td> </tr> <tr> <td>resource $pFileHandle PHP filehandle</td> <td>1</td> </tr> <tr> <td>array $pValues Array containing values in a row</td> <td>1</td> </tr> <tr> <td>bool $pValue Office2003 compatibility?</td> <td>1</td> </tr> <tr> <td>Style $style The XF format</td> <td>1</td> </tr> <tr> <td>int $numberFormatIndex Index to format record</td> <td>1</td> </tr> <tr> <td>int $value Font index, note that value 4 does not exist</td> <td>1</td> </tr> <tr> <td>string $borderStyle</td> <td>1</td> </tr> <tr> <td>string $fillType</td> <td>1</td> </tr> <tr> <td>string $hAlign</td> <td>1</td> </tr> <tr> <td>string $vAlign</td> <td>1</td> </tr> <tr> <td>int $textRotation</td> <td>1</td> </tr> <tr> <td>string $locked</td> <td>1</td> </tr> <tr> <td>string $hidden</td> <td>1</td> </tr> <tr> <td>Spreadsheet $spreadsheet The Workbook</td> <td>1</td> </tr> <tr> <td>array $str_table String Table</td> <td>1</td> </tr> <tr> <td>array $colors Colour Table</td> <td>1</td> </tr> <tr> <td>bool $isStyleXf Is it a style XF?</td> <td>1</td> </tr> <tr> <td>string $rgb E.g. 'FF00AA'</td> <td>1</td> </tr> <tr> <td>array $pWorksheetSizes The sizes in bytes of the binary worksheet streams</td> <td>1</td> </tr> <tr> <td>string $name The name in UTF-8</td> <td>1</td> </tr> <tr> <td>string $formulaData The binary formula data</td> <td>1</td> </tr> <tr> <td>int $sheetIndex 1-based sheet index the defined name applies to. 0 = global</td> <td>1</td> </tr> <tr> <td>bool $isBuiltIn Built-in name?</td> <td>1</td> </tr> <tr> <td>string $sheetIndex 1-based sheet index the defined name applies to. 0 = global</td> <td>1</td> </tr> <tr> <td>integer[][] $rangeBounds range boundaries</td> <td>1</td> </tr> <tr> <td>bool $isHidden</td> <td>1</td> </tr> <tr> <td>Worksheet $sheet Worksheet name</td> <td>1</td> </tr> <tr> <td>int $offset Location of worksheet BOF</td> <td>1</td> </tr> <tr> <td>string $format Custom format string</td> <td>1</td> </tr> <tr> <td>int $ifmt Format index code</td> <td>1</td> </tr> <tr> <td>mixed $token the token to convert</td> <td>1</td> </tr> <tr> <td>mixed $num an integer or double for conversion to its ptg value</td> <td>1</td> </tr> <tr> <td>string $string a string for conversion to its ptg value</td> <td>1</td> </tr> <tr> <td>string $token the name of the function for convertion to ptg value</td> <td>1</td> </tr> <tr> <td>int $num_args the number of arguments the function receives</td> <td>1</td> </tr> <tr> <td>string $range An Excel range in the A1:A2</td> <td>1</td> </tr> <tr> <td>int $class</td> <td>1</td> </tr> <tr> <td>string $token an Excel range in the Sheet1!A1:A2 format</td> <td>1</td> </tr> <tr> <td>string $errorCode The error code for conversion to its ptg value</td> <td>1</td> </tr> <tr> <td>string $ext_ref The name of the external reference</td> <td>1</td> </tr> <tr> <td>string $sheet_name Sheet name</td> <td>1</td> </tr> <tr> <td>string $name The name of the worksheet being added</td> <td>1</td> </tr> <tr> <td>int $index The index of the worksheet being added</td> <td>1</td> </tr> <tr> <td>string $cell The Excel cell reference to be packed</td> <td>1</td> </tr> <tr> <td>string $range The Excel range to be packed</td> <td>1</td> </tr> <tr> <td>string $cell the Excel cell reference in A1 format</td> <td>1</td> </tr> <tr> <td>mixed $token the token to check</td> <td>1</td> </tr> <tr> <td>string $formula the formula to parse, without the initial equal</td> <td>1</td> </tr> <tr> <td>mixed $value the value of this node</td> <td>1</td> </tr> <tr> <td>mixed $left the left array (sub-tree) or a final node</td> <td>1</td> </tr> <tr> <td>mixed $right the right array (sub-tree) or a final node</td> <td>1</td> </tr> <tr> <td>array $tree the optional tree to convert</td> <td>1</td> </tr> <tr> <td>string $data binary data to append</td> <td>1</td> </tr> <tr> <td>string $data binary data to write</td> <td>1</td> </tr> <tr> <td>int $type type of BIFF file to write: 0x0005 Workbook,</td> <td>1</td> </tr> <tr> <td>string $data The original binary data to be written</td> <td>1</td> </tr> <tr> <td>int $colorIndex</td> <td>1</td> </tr> <tr> <td>bool $bold</td> <td>1</td> </tr> <tr> <td>string $underline</td> <td>1</td> </tr> <tr> <td>array &$str_table String Table</td> <td>1</td> </tr> <tr> <td>array &$colors Colour Table</td> <td>1</td> </tr> <tr> <td>bool $preCalculateFormulas Flag indicating whether formulas should be calculated or just written</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $phpSheet The worksheet to write</td> <td>1</td> </tr> <tr> <td>string $range E.g. 'A1' or 'A1:B6'</td> <td>1</td> </tr> <tr> <td>int $print Whether to print the headers or not. Defaults to 1 (print).</td> <td>1</td> </tr> <tr> <td>bool $visible</td> <td>1</td> </tr> <tr> <td>bool $symbols_below</td> <td>1</td> </tr> <tr> <td>bool $symbols_right</td> <td>1</td> </tr> <tr> <td>bool $auto_style</td> <td>1</td> </tr> <tr> <td>float $num The number to write</td> <td>1</td> </tr> <tr> <td>mixed $xfIndex The optional XF format</td> <td>1</td> </tr> <tr> <td>int $xfIndex Index to XF record</td> <td>1</td> </tr> <tr> <td>int $xfIndex The XF format index for the cell</td> <td>1</td> </tr> <tr> <td>array $arrcRun Index to Font record and characters beginning</td> <td>1</td> </tr> <tr> <td>string $str The string to write</td> <td>1</td> </tr> <tr> <td>mixed $xfIndex The XF format index for the cell</td> <td>1</td> </tr> <tr> <td>bool $isError Error or Boolean?</td> <td>1</td> </tr> <tr> <td>int $xfIndex</td> <td>1</td> </tr> <tr> <td>string $stringValue</td> <td>1</td> </tr> <tr> <td>string $formula The formula text string</td> <td>1</td> </tr> <tr> <td>mixed $calculatedValue Calculated value</td> <td>1</td> </tr> <tr> <td>int $row Row</td> <td>1</td> </tr> <tr> <td>int $col Column</td> <td>1</td> </tr> <tr> <td>int $row The row to set</td> <td>1</td> </tr> <tr> <td>int $height Height we are giving to the row.</td> <td>1</td> </tr> <tr> <td>int $xfIndex The optional cell style Xf index to apply to the columns</td> <td>1</td> </tr> <tr> <td>bool $hidden The optional hidden attribute</td> <td>1</td> </tr> <tr> <td>int $level The optional outline level for row, in range [0,7]</td> <td>1</td> </tr> <tr> <td>array $col_array This is the only parameter received and is composed of the following:</td> <td>1</td> </tr> <tr> <td>int $row The row we are going to insert the bitmap into</td> <td>1</td> </tr> <tr> <td>int $col The column we are going to insert the bitmap into</td> <td>1</td> </tr> <tr> <td>mixed $bitmap The bitmap filename or GD-image resource</td> <td>1</td> </tr> <tr> <td>int $x the horizontal position (offset) of the image inside the cell</td> <td>1</td> </tr> <tr> <td>int $y the vertical position (offset) of the image inside the cell</td> <td>1</td> </tr> <tr> <td>float $scale_x The horizontal scale</td> <td>1</td> </tr> <tr> <td>float $scale_y The vertical scale</td> <td>1</td> </tr> <tr> <td>int $col_start Col containing upper left corner of object</td> <td>1</td> </tr> <tr> <td>int $row_start Row containing top left corner of object</td> <td>1</td> </tr> <tr> <td>int $x1 Distance to left side of object</td> <td>1</td> </tr> <tr> <td>int $y1 Distance to top of object</td> <td>1</td> </tr> <tr> <td>int $width Width of image frame</td> <td>1</td> </tr> <tr> <td>int $height Height of image frame</td> <td>1</td> </tr> <tr> <td>int $colL Column containing upper left corner of object</td> <td>1</td> </tr> <tr> <td>int $dxL Distance from left side of cell</td> <td>1</td> </tr> <tr> <td>int $rwT Row containing top left corner of object</td> <td>1</td> </tr> <tr> <td>int $dyT Distance from top of cell</td> <td>1</td> </tr> <tr> <td>int $colR Column containing lower right corner of object</td> <td>1</td> </tr> <tr> <td>int $dxR Distance from right of cell</td> <td>1</td> </tr> <tr> <td>int $rwB Row containing bottom right corner of object</td> <td>1</td> </tr> <tr> <td>int $dyB Distance from bottom of cell</td> <td>1</td> </tr> <tr> <td>resource $image The image to process</td> <td>1</td> </tr> <tr> <td>string $bitmap The bitmap to process</td> <td>1</td> </tr> <tr> <td>string $errorCode</td> <td>1</td> </tr> <tr> <td>Conditional $conditional</td> <td>1</td> </tr> <tr> <td>Row $row</td> <td>1</td> </tr> <tr> <td>int $curColumn</td> <td>1</td> </tr> <tr> <td>int $prevColumn</td> <td>1</td> </tr> <tr> <td>XMLWriter $writer</td> <td>1</td> </tr> <tr> <td>Cell $cell</td> <td>1</td> </tr> <tr> <td>Ods $writer</td> <td>1</td> </tr> <tr> <td>string $pSheetname Sheet name</td> <td>1</td> </tr> <tr> <td>int $pSheetId Sheet id</td> <td>1</td> </tr> <tr> <td>int $pRelId Relationship ID</td> <td>1</td> </tr> <tr> <td>string $sheetState Sheet state (visible, hidden, veryHidden)</td> <td>1</td> </tr> <tr> <td>NamedRange $pNamedRange</td> <td>1</td> </tr> <tr> <td>string $pCellReference Cell reference</td> <td>1</td> </tr> <tr> <td>array $pAuthors Array of authors</td> <td>1</td> </tr> <tr> <td>string $pCellReference Cell reference, eg: 'A1'</td> <td>1</td> </tr> <tr> <td>BaseDrawing $pDrawing</td> <td>1</td> </tr> <tr> <td>string $pReference Reference</td> <td>1</td> </tr> <tr> <td>HeaderFooterDrawing $pImage Image</td> <td>1</td> </tr> <tr> <td>string $latinFont</td> <td>1</td> </tr> <tr> <td>array of string $fontSet</td> <td>1</td> </tr> <tr> <td>mixed $calculateCellValues</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Chart\Layout $chartLayout Chart layout</td> <td>1</td> </tr> <tr> <td>string $groupType Chart type</td> <td>1</td> </tr> <tr> <td>GridLines $majorGridlines</td> <td>1</td> </tr> <tr> <td>GridLines $minorGridlines</td> <td>1</td> </tr> <tr> <td>int $val value for idx (default: 3)</td> <td>1</td> </tr> <tr> <td>string $fillColor hex color (default: FF9900)</td> <td>1</td> </tr> <tr> <td>DataSeries $plotGroup</td> <td>1</td> </tr> <tr> <td>bool &$catIsMultiLevelSeries Is category a multi-series category</td> <td>1</td> </tr> <tr> <td>bool &$valIsMultiLevelSeries Is value set a multi-series set</td> <td>1</td> </tr> <tr> <td>string &$plotGroupingType Type of grouping for multi-series values</td> <td>1</td> </tr> <tr> <td>DataSeriesValues $plotSeriesLabel</td> <td>1</td> </tr> <tr> <td>string $dataType Datatype of series values</td> <td>1</td> </tr> <tr> <td>Layout $layout</td> <td>1</td> </tr> <tr> <td>Xlsx $pWriter</td> <td>1</td> </tr> <tr> <td>string[] $pExistingTable Existing table to eventually merge with</td> <td>1</td> </tr> <tr> <td>RichText $pRichText Rich text</td> <td>1</td> </tr> <tr> <td>RichText|string $pRichText text string or Rich text</td> <td>1</td> </tr> <tr> <td>array $stringTable Stringtable</td> <td>1</td> </tr> <tr> <td>int $pWorksheetId</td> <td>1</td> </tr> <tr> <td>int &$chartRef Chart ID</td> <td>1</td> </tr> <tr> <td>int $pId Relationship ID. rId will be prepended!</td> <td>1</td> </tr> <tr> <td>string $pType Relationship type</td> <td>1</td> </tr> <tr> <td>string $pTarget Relationship target</td> <td>1</td> </tr> <tr> <td>string $pTargetMode Relationship target mode</td> <td>1</td> </tr> <tr> <td>$objWriter</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Drawing $drawing</td> <td>1</td> </tr> <tr> <td>$i</td> <td>1</td> </tr> <tr> <td>string $pFile Filename</td> <td>1</td> </tr> <tr> <td>PhpspreadsheetWorksheet $pSheet</td> <td>1</td> </tr> <tr> <td>string[] $pStringTable String table</td> <td>1</td> </tr> <tr> <td>Cell $pCellAddress Cell Address</td> <td>1</td> </tr> <tr> <td>string[] $pFlippedStringTable String table (flipped), for faster index searching</td> <td>1</td> </tr> <tr> <td>Font $pFont Font style</td> <td>1</td> </tr> <tr> <td>Borders $pBorders Borders style</td> <td>1</td> </tr> <tr> <td>Spreadsheet $spreadsheet Workbook</td> <td>1</td> </tr> <tr> <td>string $pName Element name</td> <td>1</td> </tr> <tr> <td>Border $pBorder Border style</td> <td>1</td> </tr> <tr> <td>NumberFormat $pNumberFormat Number Format</td> <td>1</td> </tr> <tr> <td>int $pId Number Format identifier</td> <td>1</td> </tr> <tr> <td>array $config Configuration array</td> <td>1</td> </tr> <tr> <td>float $inches</td> <td>1</td> </tr> <tr> <td>string $orientation Page orientation</td> <td>1</td> </tr> <tr> <td>string $unit Unit measure</td> <td>1</td> </tr> <tr> <td>string $paperSize Paper size</td> <td>1</td> </tr> <tr> <td>ITextElement $pText Rich text element</td> <td>1</td> </tr> <tr> <td>ITextElement[] $textElements Array of elements</td> <td>1</td> </tr> <tr> <td>Font $pFont Font</td> <td>1</td> </tr> <tr> <td>string $original</td> <td>1</td> </tr> <tr> <td>string $html</td> <td>1</td> </tr> <tr> <td>DOMElement $element</td> <td>1</td> </tr> <tr> <td>string $callbackTag</td> <td>1</td> </tr> <tr> <td>array $callbacks</td> <td>1</td> </tr> <tr> <td>string[] $writers</td> <td>1</td> </tr> <tr> <td>IWriter $writer</td> <td>1</td> </tr> <tr> <td>float $epsilon</td> <td>1</td> </tr> <tr> <td>float $nominal</td> <td>1</td> </tr> <tr> <td>float $aer</td> <td>1</td> </tr> <tr> <td>float $periods</td> <td>1</td> </tr> <tr> <td>bool $beginning</td> <td>1</td> </tr> <tr> <td>float $finance_rate</td> <td>1</td> </tr> <tr> <td>float $reinvestment_rate</td> <td>1</td> </tr> <tr> <td>callable $function f(x) callback function</td> <td>1</td> </tr> <tr> <td>array<mixed> $args Parameters to pass to callback function. The initial value for the</td> <td>1</td> </tr> <tr> <td>int|float $target Value of f(x) we a trying to solve for</td> <td>1</td> </tr> <tr> <td>float $tol Tolerance; How close to the actual solution we would like.</td> <td>1</td> </tr> <tr> <td>int $position Which element in the $args array will be changed; also serves as initial guess</td> <td>1</td> </tr> <tr> <td>int $iterations</td> <td>1</td> </tr> <tr> <td>int|float $tol Tolerance; How close to the actual solution we would like.</td> <td>1</td> </tr> <tr> <td>int|float $a The start of the interval</td> <td>1</td> </tr> <tr> <td>int|float $b The end of the interval</td> <td>1</td> </tr> <tr> <td>string $log_destination</td> <td>1</td> </tr> <tr> <td>string $destination_type</td> <td>1</td> </tr> <tr> <td>string $email</td> <td>1</td> </tr> <tr> <td>EmailValidation $emailValidation</td> <td>1</td> </tr> <tr> <td>string $email</td> <td>1</td> </tr> <tr> <td>string $localPart</td> <td>1</td> </tr> <tr> <td>string $parsedDomainPart</td> <td>1</td> </tr> <tr> <td>int $type</td> <td>1</td> </tr> <tr> <td>int $maxGroups</td> <td>1</td> </tr> <tr> <td>bool $hasClosingQuote</td> <td>1</td> </tr> <tr> <td>bool $closingQuote</td> <td>1</td> </tr> <tr> <td>string $email The email you want to validate.</td> <td>1</td> </tr> <tr> <td>EmailLexer $emailLexer The email lexer.</td> <td>1</td> </tr> <tr> <td>string $host A set of DNS records in the format returned by dns_get_record.</td> <td>1</td> </tr> <tr> <td>array $dnsRecord Given DNS record.</td> <td>1</td> </tr> <tr> <td>InvalidEmail[] $errors</td> <td>1</td> </tr> <tr> <td>EmailValidation[] $validations The validations.</td> <td>1</td> </tr> <tr> <td>int $mode The validation mode (one of the constants).</td> <td>1</td> </tr> <tr> <td>\Egulias\EmailValidator\Exception\InvalidEmail|null $possibleError</td> <td>1</td> </tr> <tr> <td>\Egulias\EmailValidator\Exception\InvalidEmail[] $errors</td> <td>1</td> </tr> <tr> <td>bool $result</td> <td>1</td> </tr> <tr> <td>string $input The input to be tokenized.</td> <td>1</td> </tr> <tr> <td>integer $position Position to place the lexical scanner.</td> <td>1</td> </tr> <tr> <td>integer $position</td> <td>1</td> </tr> <tr> <td>integer|string $token</td> <td>1</td> </tr> <tr> <td>string $type The token type to skip until.</td> <td>1</td> </tr> <tr> <td>mixed $value</td> <td>1</td> </tr> <tr> <td>string $input A query string.</td> <td>1</td> </tr> <tr> <td>string $class</td> <td>1</td> </tr> <tr> <td>int $retries</td> <td>1</td> </tr> <tr> <td>array $failedRecipients An array of failures by-reference</td> <td>1</td> </tr> <tr> <td>mixed $search</td> <td>1</td> </tr> <tr> <td>mixed $replace</td> <td>1</td> </tr> <tr> <td>int $maxLineLength - 0 indicates the default length for this encoding</td> <td>1</td> </tr> <tr> <td>int $timeout in second Defaults is for very slow smtp responses</td> <td>1</td> </tr> <tr> <td>int $count</td> <td>1</td> </tr> <tr> <td>array $transports</td> <td>1</td> </tr> <tr> <td>int $limit The limit</td> <td>1</td> </tr> <tr> <td>string|null $encryption SMTP encryption mode:</td> <td>1</td> </tr> <tr> <td>Swift_InputByteStream $is optional input stream</td> <td>1</td> </tr> <tr> <td>Swift_InputByteStream $is stream to write the data to</td> <td>1</td> </tr> <tr> <td>string $dir</td> <td>1</td> </tr> <tr> <td>bool $dotEscape</td> <td>1</td> </tr> <tr> <td>string|Swift_OutputByteStream $body</td> <td>1</td> </tr> <tr> <td>string $charset</td> <td>1</td> </tr> <tr> <td>Swift_Transport_EsmtpHandler[] $extensionHandlers</td> <td>1</td> </tr> <tr> <td>string $localDomain</td> <td>1</td> </tr> <tr> <td>int $timeout seconds</td> <td>1</td> </tr> <tr> <td>string $encryption</td> <td>1</td> </tr> <tr> <td>bool $enabled</td> <td>1</td> </tr> <tr> <td>Swift_Transport_EsmtpHandler[] $handlers</td> <td>1</td> </tr> <tr> <td>Swift_Transport_SmtpAgent $agent to read/write</td> <td>1</td> </tr> <tr> <td>string $command to send</td> <td>1</td> </tr> <tr> <td>int[] $codes expected in response</td> <td>1</td> </tr> <tr> <td>string[] $failedRecipients to collect failures</td> <td>1</td> </tr> <tr> <td>bool $stop to be set true by-reference if the command is now sent</td> <td>1</td> </tr> <tr> <td>string $mode</td> <td>1</td> </tr> <tr> <td>string $encoding The parameter so send with the MAIL FROM command;</td> <td>1</td> </tr> <tr> <td>string $response Message 1 response (message 2)</td> <td>1</td> </tr> <tr> <td>string $client</td> <td>1</td> </tr> <tr> <td>bool $v2 Use version2 of the protocol</td> <td>1</td> </tr> <tr> <td>string $workstation</td> <td>1</td> </tr> <tr> <td>string $lmResponse</td> <td>1</td> </tr> <tr> <td>string $ntlmResponse</td> <td>1</td> </tr> <tr> <td>string $timestamp Epoch timestamp in microseconds</td> <td>1</td> </tr> <tr> <td>string $targetInfo</td> <td>1</td> </tr> <tr> <td>string $challenge NTLM Challenge</td> <td>1</td> </tr> <tr> <td>string $client Random string</td> <td>1</td> </tr> <tr> <td>string $challenge Hex values</td> <td>1</td> </tr> <tr> <td>string $targetInfo Hex values</td> <td>1</td> </tr> <tr> <td>string $value Value we want to put in</td> <td>1</td> </tr> <tr> <td>int $offset start of value</td> <td>1</td> </tr> <tr> <td>bool $is16 Do we 16bit string or not?</td> <td>1</td> </tr> <tr> <td>string $value Securitybuffer in hex</td> <td>1</td> </tr> <tr> <td>int $v</td> <td>1</td> </tr> <tr> <td>int $a</td> <td>1</td> </tr> <tr> <td>int $b</td> <td>1</td> </tr> <tr> <td>int $bytes Length of bytes</td> <td>1</td> </tr> <tr> <td>bool $isHex Did we provided hex value</td> <td>1</td> </tr> <tr> <td>string $value An 8-byte string</td> <td>1</td> </tr> <tr> <td>string $key Encryption key</td> <td>1</td> </tr> <tr> <td>string $msg Message to encrypt</td> <td>1</td> </tr> <tr> <td>string $secret</td> <td>1</td> </tr> <tr> <td>string $ignoredChars</td> <td>1</td> </tr> <tr> <td>int $rate</td> <td>1</td> </tr> <tr> <td>int $mode defaults to {@link BYTES_PER_MINUTE}</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Sleeper $sleeper (only needed in testing)</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Timer $timer (only needed in testing)</td> <td>1</td> </tr> <tr> <td>string $host Hostname or IP. Literal IPv6 addresses should be</td> <td>1</td> </tr> <tr> <td>string $crypto as "tls" or "ssl"</td> <td>1</td> </tr> <tr> <td>int $timeout</td> <td>1</td> </tr> <tr> <td>int $threshold</td> <td>1</td> </tr> <tr> <td>int $sleep time</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Sleeper $sleeper (not needed really)</td> <td>1</td> </tr> <tr> <td>int $threshold</td> <td>1</td> </tr> <tr> <td>int $sleep time</td> <td>1</td> </tr> <tr> <td>string $sender address</td> <td>1</td> </tr> <tr> <td>bool $isHtml</td> <td>1</td> </tr> <tr> <td>int $result from {@see RESULT_PASS, RESULT_FAIL}</td> <td>1</td> </tr> <tr> <td>Swift_StreamFilter $filter if input should be canonicalized</td> <td>1</td> </tr> <tr> <td>int $maxLineLength optional 0 indicates the default of 76 chars</td> <td>1</td> </tr> <tr> <td>int $size number of bytes to read</td> <td>1</td> </tr> <tr> <td>int $maxLineLength optional, 0 indicates the default of 75 bytes</td> <td>1</td> </tr> <tr> <td>Swift_CharacterReaderFactory $factory for loading validators</td> <td>1</td> </tr> <tr> <td>string $charset used in the stream</td> <td>1</td> </tr> <tr> <td>bool $writable if true</td> <td>1</td> </tr> <tr> <td>mixed $stack of bytes in string or array form, optional</td> <td>1</td> </tr> <tr> <td>string|array $addresses</td> <td>1</td> </tr> <tr> <td>string $name optional</td> <td>1</td> </tr> <tr> <td>int $priority</td> <td>1</td> </tr> <tr> <td>array $addresses</td> <td>1</td> </tr> <tr> <td>array $mimeTypes optional</td> <td>1</td> </tr> <tr> <td>array|string|null $addresses</td> <td>1</td> </tr> <tr> <td>array|string $addresses</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMimeEntity[] $children</td> <td>1</td> </tr> <tr> <td>int $compoundLevel For internal use only</td> <td>1</td> </tr> <tr> <td>array $mimeTypes</td> <td>1</td> </tr> <tr> <td>string $disposition</td> <td>1</td> </tr> <tr> <td>int $size</td> <td>1</td> </tr> <tr> <td>string $charset optional</td> <td>1</td> </tr> <tr> <td>bool $delsp</td> <td>1</td> </tr> <tr> <td>int $maxLineLength - 0 indicates the default length for this encoding</td> <td>1</td> </tr> <tr> <td>int $maxLineLength optional, 0 indicates the default of 76 chars</td> <td>1</td> </tr> <tr> <td>int $maxLineLength - 0 means no wrapping will occur</td> <td>1</td> </tr> <tr> <td>bool $canonical if canonicalization transformation should be done</td> <td>1</td> </tr> <tr> <td>int $maxLineLength optional, 0 means no wrapping will occur</td> <td>1</td> </tr> <tr> <td>int $length</td> <td>1</td> </tr> <tr> <td>string $le</td> <td>1</td> </tr> <tr> <td>Swift_StreamFilter $filter if canonicalization should occur</td> <td>1</td> </tr> <tr> <td>bool $dotEscape if dot stuffing workaround must be enabled</td> <td>1</td> </tr> <tr> <td>Swift_OutputByteStream $os output stream</td> <td>1</td> </tr> <tr> <td>Swift_InputByteStream $is input stream</td> <td>1</td> </tr> <tr> <td>int $maxLineLength</td> <td>1</td> </tr> <tr> <td>int $firstLineOffset</td> <td>1</td> </tr> <tr> <td>int $maxLineLength 0 indicates the default length for this encoding</td> <td>1</td> </tr> <tr> <td>int $maxLineLength 0 indicates the default length for this encoding</td> <td>1</td> </tr> <tr> <td>string|string[] $mailboxes</td> <td>1</td> </tr> <tr> <td>string[] $addresses</td> <td>1</td> </tr> <tr> <td>string|string[] $addresses</td> <td>1</td> </tr> <tr> <td>string $displayName as displayed</td> <td>1</td> </tr> <tr> <td>bool $shorten the first line to make remove for header name</td> <td>1</td> </tr> <tr> <td>DateTimeInterface $model</td> <td>1</td> </tr> <tr> <td>string $lang</td> <td>1</td> </tr> <tr> <td>int $lineLength</td> <td>1</td> </tr> <tr> <td>string $string as displayed</td> <td>1</td> </tr> <tr> <td>string $charset of the text</td> <td>1</td> </tr> <tr> <td>bool $shorten the first line to make remove for header name</td> <td>1</td> </tr> <tr> <td>string $token</td> <td>1</td> </tr> <tr> <td>string[] $include additional chars to escape</td> <td>1</td> </tr> <tr> <td>string $usedLength optional</td> <td>1</td> </tr> <tr> <td>string $token token to encode</td> <td>1</td> </tr> <tr> <td>bool $condition</td> <td>1</td> </tr> <tr> <td>string[] $tokens</td> <td>1</td> </tr> <tr> <td>string $value to append</td> <td>1</td> </tr> <tr> <td>bool $encoded</td> <td>1</td> </tr> <tr> <td>bool $firstLine</td> <td>1</td> </tr> <tr> <td>string|array $id</td> <td>1</td> </tr> <tr> <td>string[] $ids</td> <td>1</td> </tr> <tr> <td>array $recipients</td> <td>1</td> </tr> <tr> <td>int $result</td> <td>1</td> </tr> <tr> <td>bool $cancel, optional</td> <td>1</td> </tr> <tr> <td>bool $valid</td> <td>1</td> </tr> <tr> <td>array $successCodes</td> <td>1</td> </tr> <tr> <td>object $source</td> <td>1</td> </tr> <tr> <td>string $search</td> <td>1</td> </tr> <tr> <td>string $replace</td> <td>1</td> </tr> <tr> <td>array $search</td> <td>1</td> </tr> <tr> <td>array $replace</td> <td>1</td> </tr> <tr> <td>int $minReplaces</td> <td>1</td> </tr> <tr> <td>string|array $search</td> <td>1</td> </tr> <tr> <td>string|array $replace</td> <td>1</td> </tr> <tr> <td>string $bytes</td> <td>1</td> </tr> <tr> <td>Swift_InputByteStream $is optional</td> <td>1</td> </tr> <tr> <td>string $path to save to</td> <td>1</td> </tr> <tr> <td>int $position</td> <td>1</td> </tr> <tr> <td>string $canon simple | nofws defaults to simple</td> <td>1</td> </tr> <tr> <td>string|null $signCertificate</td> <td>1</td> </tr> <tr> <td>string|null $signPrivateKey</td> <td>1</td> </tr> <tr> <td>string|null $encryptCertificate</td> <td>1</td> </tr> <tr> <td>string $certificate</td> <td>1</td> </tr> <tr> <td>string|array $privateKey If the key needs an passphrase use array('file-location', 'passphrase') instead</td> <td>1</td> </tr> <tr> <td>int $signOptions Bitwise operator options for openssl_pkcs7_sign()</td> <td>1</td> </tr> <tr> <td>string $extraCerts A file containing intermediate certificates needed by the signing certificate</td> <td>1</td> </tr> <tr> <td>string|array $recipientCerts Either an single X.509 certificate, or an assoc array of X.509 certificates.</td> <td>1</td> </tr> <tr> <td>int $cipher</td> <td>1</td> </tr> <tr> <td>bool $wrap</td> <td>1</td> </tr> <tr> <td>string $passphrase</td> <td>1</td> </tr> <tr> <td>string $hash 'rsa-sha1' or 'rsa-sha256'</td> <td>1</td> </tr> <tr> <td>mixed $len (bool or int)</td> <td>1</td> </tr> <tr> <td>string $name name of the segment to construct</td> <td>1</td> </tr> <tr> <td>string $xml XML tree of the segment</td> <td>1</td> </tr> <tr> <td>string $odf odf</td> <td>1</td> </tr> <tr> <td>string $xml Xml</td> <td>1</td> </tr> <tr> <td>string $key Key</td> <td>1</td> </tr> <tr> <td>string $value Value</td> <td>1</td> </tr> <tr> <td>string $encode Encode</td> <td>1</td> </tr> <tr> <td>string $charset Charset</td> <td>1</td> </tr> <tr> <td>string $prop Prop</td> <td>1</td> </tr> <tr> <td>string $meth Meth</td> <td>1</td> </tr> <tr> <td>array $args Args</td> <td>1</td> </tr> <tr> <td>string $key Name of the variable within the template</td> <td>1</td> </tr> <tr> <td>string $value Replacement value</td> <td>1</td> </tr> <tr> <td>string $filename The name of the odt file</td> <td>1</td> </tr> <tr> <td>string $config Array of config data</td> <td>1</td> </tr> <tr> <td>string $value Replacement value</td> <td>1</td> </tr> <tr> <td>bool $encode If true, special XML characters are encoded</td> <td>1</td> </tr> <tr> <td>string $charset Charset</td> <td>1</td> </tr> <tr> <td>array $tags An array with html tags generated by the getDataFromHtml() function</td> <td>1</td> </tr> <tr> <td>array $customStyles An array of style defenitions that should be included inside the odt file</td> <td>1</td> </tr> <tr> <td>array $fontDeclarations An array of font declarations that should be included inside the odt file</td> <td>1</td> </tr> <tr> <td>bool $encode If true, special XML characters are encoded</td> <td>1</td> </tr> <tr> <td>string $charset Charset. See encode_chars()</td> <td>1</td> </tr> <tr> <td>string $text The text to encode or not</td> <td>1</td> </tr> <tr> <td>string $html A string with html tags</td> <td>1</td> </tr> <tr> <td>string $type 'content', 'styles' or 'meta'</td> <td>1</td> </tr> <tr> <td>Segment $segment Segment</td> <td>1</td> </tr> <tr> <td>string $segment Segment</td> <td>1</td> </tr> <tr> <td>string $file name of the desired file</td> <td>1</td> </tr> <tr> <td>string $file Image file to add into manifest content</td> <td>1</td> </tr> <tr> <td>string $name (optional)</td> <td>1</td> </tr> <tr> <td>string $name Name of ODT file to generate before generating PDF</td> <td>1</td> </tr> <tr> <td>string $configKey Config key</td> <td>1</td> </tr> <tr> <td>string $dir The temporary working directory</td> <td>1</td> </tr> <tr> <td>string $valuename Balise in the template</td> <td>1</td> </tr> <tr> <td>string $text message text</td> <td>1</td> </tr> <tr> <td>array $data array of key value pairs {@type associative}</td> <td>1</td> </tr> <tr> <td>boolean $productionMode When set to false, it will run in</td> <td>1</td> </tr> <tr> <td>bool $refreshCache will update the cache when set to true</td> <td>1</td> </tr> <tr> <td>string ,... $url</td> <td>1</td> </tr> <tr> <td>bool $includeQueryParameters</td> <td>1</td> </tr> <tr> <td>int $version restler version</td> <td>1</td> </tr> <tr> <td>int $version maximum version number supported</td> <td>1</td> </tr> <tr> <td>int $minimum minimum version number supported</td> <td>1</td> </tr> <tr> <td>$className</td> <td>1</td> </tr> <tr> <td>string $className of the authentication class</td> <td>1</td> </tr> <tr> <td>string $resourcePath optional url prefix for mapping</td> <td>1</td> </tr> <tr> <td>string $className name of the service class</td> <td>1</td> </tr> <tr> <td>string $resourcePath optional url prefix for mapping, uses</td> <td>1</td> </tr> <tr> <td>string $className of the error handling class</td> <td>1</td> </tr> <tr> <td>array $classNames array of associative arrays containing</td> <td>1</td> </tr> <tr> <td>array $map array of associative arrays containing</td> <td>1</td> </tr> <tr> <td>string $name name of the hidden property</td> <td>1</td> </tr> <tr> <td>string $filename full path for the file to be served</td> <td>1</td> </tr> <tr> <td>bool $forceDownload should the we download instead of viewing</td> <td>1</td> </tr> <tr> <td>int $expires cache expiry in number of seconds</td> <td>1</td> </tr> <tr> <td>bool $isPublic cache control, is it public or private</td> <td>1</td> </tr> <tr> <td>callable $function</td> <td>1</td> </tr> <tr> <td>bool $singleton</td> <td>1</td> </tr> <tr> <td>array $scope local scope</td> <td>1</td> </tr> <tr> <td>string $stringName</td> <td>1</td> </tr> <tr> <td>string $httpStatusCode http status code</td> <td>1</td> </tr> <tr> <td>string|null $errorMessage error message</td> <td>1</td> </tr> <tr> <td>array $details any extra detail about the exception</td> <td>1</td> </tr> <tr> <td>Exception $previous previous exception if any</td> <td>1</td> </tr> <tr> <td>string $namespace</td> <td>1</td> </tr> <tr> <td>string $eventName name of the event</td> <td>1</td> </tr> <tr> <td>array $params event related data</td> <td>1</td> </tr> <tr> <td>mixed $o given value for finding type</td> <td>1</td> </tr> <tr> <td>bool $appendToModels if an object is found should we append to</td> <td>1</td> </tr> <tr> <td>$route</td> <td>1</td> </tr> <tr> <td>string $resourcePath</td> <td>1</td> </tr> <tr> <td>int $version</td> <td>1</td> </tr> <tr> <td>string $path Requested url path</td> <td>1</td> </tr> <tr> <td>string $httpMethod GET|POST|PUT|PATCH|DELETE etc</td> <td>1</td> </tr> <tr> <td>int $version Api Version number</td> <td>1</td> </tr> <tr> <td>array $data Data collected from the request</td> <td>1</td> </tr> <tr> <td>array $call</td> <td>1</td> </tr> <tr> <td>ReflectionClass $class</td> <td>1</td> </tr> <tr> <td>array $scope</td> <td>1</td> </tr> <tr> <td>array $routes</td> <td>1</td> </tr> <tr> <td>string $type data type as string</td> <td>1</td> </tr> <tr> <td>array|object $from array to extract the value from</td> <td>1</td> </tr> <tr> <td>string|array $key ... pass more to go deeply inside the array</td> <td>1</td> </tr> <tr> <td>string $accept header value</td> <td>1</td> </tr> <tr> <td>string $name name of the static property</td> <td>1</td> </tr> <tr> <td>mixed $value value to set the property to</td> <td>1</td> </tr> <tr> <td>string $url relative path or full url</td> <td>1</td> </tr> <tr> <td>array $params associative array of query parameters</td> <td>1</td> </tr> <tr> <td>array $flashData associative array of properties to be set in $_SESSION for one time use</td> <td>1</td> </tr> <tr> <td>int $status http status code to send the response with ideally 301 or 302</td> <td>1</td> </tr> <tr> <td>bool $isPhpDoc</td> <td>1</td> </tr> <tr> <td>string $comment PhpDoc style comment</td> <td>1</td> </tr> <tr> <td>$param</td> <td>1</td> </tr> <tr> <td>array $embedded</td> <td>1</td> </tr> <tr> <td>$subject</td> <td>1</td> </tr> <tr> <td>$path string absolute or relative path.</td> <td>1</td> </tr> <tr> <td>$key mixed class name considered or a collection of</td> <td>1</td> </tr> <tr> <td>$value mixed optional not required when doing a query on</td> <td>1</td> </tr> <tr> <td>$path string location of php file on the include path</td> <td>1</td> </tr> <tr> <td>$className string class name</td> <td>1</td> </tr> <tr> <td>$className string fully qualified class name.</td> <td>1</td> </tr> <tr> <td>$className string className that can't be found</td> <td>1</td> </tr> <tr> <td>null $loader callable loader optional when the loader is known</td> <td>1</td> </tr> <tr> <td>$className string name of a class to load</td> <td>1</td> </tr> <tr> <td>$loader callable autoLoader method</td> <td>1</td> </tr> <tr> <td>$className string the name of the alias class</td> <td>1</td> </tr> <tr> <td>$currentClass string the current class this alias references</td> <td>1</td> </tr> <tr> <td>$className string class name to discover</td> <td>1</td> </tr> <tr> <td>$currentClass string optional name of current class when</td> <td>1</td> </tr> <tr> <td>$className string The class or interface to verify</td> <td>1</td> </tr> <tr> <td>$mapping string (optional) value for map/seen if found to exist</td> <td>1</td> </tr> <tr> <td>$className string class/interface name to auto load</td> <td>1</td> </tr> <tr> <td>bool $includePlatform Should we consider user alone or should</td> <td>1</td> </tr> <tr> <td>string $string</td> <td>1</td> </tr> <tr> <td>array|string $data</td> <td>1</td> </tr> <tr> <td>array $children</td> <td>1</td> </tr> <tr> <td>$attribute</td> <td>1</td> </tr> <tr> <td>string $method http method to submit the form</td> <td>1</td> </tr> <tr> <td>bool $dataOnly if you want to render the form yourself use this</td> <td>1</td> </tr> <tr> <td>string $prefix used for adjusting the spacing in front of</td> <td>1</td> </tr> <tr> <td>string $indent used for adjusting indentation</td> <td>1</td> </tr> <tr> <td>ValidationInfo $p</td> <td>1</td> </tr> <tr> <td>bool $dataOnly</td> <td>1</td> </tr> <tr> <td>string $method http method for form key</td> <td>1</td> </tr> <tr> <td>string $json</td> <td>1</td> </tr> <tr> <td>array $data resulting data that needs to</td> <td>1</td> </tr> <tr> <td>boolean $humanReadable set to TRUE when restler</td> <td>1</td> </tr> <tr> <td>string $mime MIME type</td> <td>1</td> </tr> <tr> <td>string $extension file extension</td> <td>1</td> </tr> <tr> <td>int $usagePerUnit</td> <td>1</td> </tr> <tr> <td>int $authenticatedUsagePerUnit set it to false to give unlimited access</td> <td>1</td> </tr> <tr> <td>ValidationInfo|null $info</td> <td>1</td> </tr> <tr> <td>mixed $input</td> <td>1</td> </tr> <tr> <td>null $full</td> <td>1</td> </tr> <tr> <td>mixed $object that needs to be converted</td> <td>1</td> </tr> <tr> <td>bool $forceObjectTypeWhenEmpty when set to true outputs</td> <td>1</td> </tr> <tr> <td>bool $caseSensitive</td> <td>1</td> </tr> <tr> <td>array $arr</td> <td>1</td> </tr> <tr> <td>resource $im GD resource to use</td> <td>1</td> </tr> <tr> <td>Imagick $im Image to load from</td> <td>1</td> </tr> <tr> <td>Imagick $im</td> <td>1</td> </tr> <tr> <td>int $lineHeight</td> <td>1</td> </tr> <tr> <td>string $filename Filename to load</td> <td>1</td> </tr> <tr> <td>Imagick $im Image which has format PBM.</td> <td>1</td> </tr> <tr> <td>string $pdfFile</td> <td>1</td> </tr> <tr> <td>int $pageWidth</td> <td>1</td> </tr> <tr> <td>Imagick $im Image to flatten</td> <td>1</td> </tr> <tr> <td>string $filename Path to image filename, or null to create an empty image.</td> <td>1</td> </tr> <tr> <td>boolean $allowOptimisations True (default) to use any library-specific tricks</td> <td>1</td> </tr> <tr> <td>boolean $doubleDensity True for double density (24px) lines, false for single-density (8px) lines.</td> <td>1</td> </tr> <tr> <td>string|null $filename Filename to load from.</td> <td>1</td> </tr> <tr> <td>string $data Image data to use, string of 1's (black) and 0's (white) in row-major order.</td> <td>1</td> </tr> <tr> <td>int $width width of the image</td> <td>1</td> </tr> <tr> <td>int $height height of the image.</td> <td>1</td> </tr> <tr> <td>boolean $highDensity</td> <td>1</td> </tr> <tr> <td>int $lineNo</td> <td>1</td> </tr> <tr> <td>bool $highDensity</td> <td>1</td> </tr> <tr> <td>bool $allowOptimisations</td> <td>1</td> </tr> <tr> <td>array $preferred</td> <td>1</td> </tr> <tr> <td>array $codePageData</td> <td>1</td> </tr> <tr> <td>string $encodingName Name of the encoding</td> <td>1</td> </tr> <tr> <td>string $profileId</td> <td>1</td> </tr> <tr> <td>array $profileData</td> <td>1</td> </tr> <tr> <td>array $choices</td> <td>1</td> </tr> <tr> <td>int $num</td> <td>1</td> </tr> <tr> <td>PrintConnector $connector The PrintConnector to send data to. If not set, output is sent to standard output.</td> <td>1</td> </tr> <tr> <td>CapabilityProfile|null $profile Supported features of this printer. If not set, the "default" CapabilityProfile will be used, which is suitable for Epson printers.</td> <td>1</td> </tr> <tr> <td>string $content The information to encode.</td> <td>1</td> </tr> <tr> <td>int $type The barcode standard to output. Supported values are</td> <td>1</td> </tr> <tr> <td>int $mode Cut mode, either Printer::CUT_FULL or Printer::CUT_PARTIAL. If not specified, `Printer::CUT_FULL` will be used.</td> <td>1</td> </tr> <tr> <td>int $lines number of lines to feed. If not specified, 1 line will be fed.</td> <td>1</td> </tr> <tr> <td>EscposImage $img The image to print.</td> <td>1</td> </tr> <tr> <td>string $content Text or numbers to store in the code</td> <td>1</td> </tr> <tr> <td>int $width Width of a module (pixel) in the printed code.</td> <td>1</td> </tr> <tr> <td>int $heightMultiplier Multiplier for height of a module.</td> <td>1</td> </tr> <tr> <td>int $dataColumnCount Number of data columns to use. 0 (default)</td> <td>1</td> </tr> <tr> <td>float $ec Error correction ratio, from 0.01 to 4.00. Default is 0.10 (10%).</td> <td>1</td> </tr> <tr> <td>int $options Standard code Printer::PDF417_STANDARD with</td> <td>1</td> </tr> <tr> <td>int $pin 0 or 1, for pin 2 or pin 5 kick-out connector respectively.</td> <td>1</td> </tr> <tr> <td>int $on_ms pulse ON time, in milliseconds.</td> <td>1</td> </tr> <tr> <td>int $off_ms pulse OFF time, in milliseconds.</td> <td>1</td> </tr> <tr> <td>string $content The content of the code. Numeric data will be more efficiently compacted.</td> <td>1</td> </tr> <tr> <td>int $ec Error-correction level to use. One of Printer::QR_ECLEVEL_L (default), Printer::QR_ECLEVEL_M, Printer::QR_ECLEVEL_Q or Printer::QR_ECLEVEL_H. Higher error correction results in a less compact code.</td> <td>1</td> </tr> <tr> <td>int $size Pixel size to use. Must be 1-16 (default 3)</td> <td>1</td> </tr> <tr> <td>int $model QR code model to use. Must be one of Printer::QR_MODEL_1, Printer::QR_MODEL_2 (default) or Printer::QR_MICRO (not supported by all printers).</td> <td>1</td> </tr> <tr> <td>int $table The table to select. Available code tables are model-specific.</td> <td>1</td> </tr> <tr> <td>int $mode The mode to use. Default is Printer::MODE_FONT_A, with no special formatting. This has a similar effect to running initialize().</td> <td>1</td> </tr> <tr> <td>bool $on True to enable user-defined character set, false to use built-in characters sets.</td> <td>1</td> </tr> <tr> <td>int $height Height in dots. If not specified, 8 will be used.</td> <td>1</td> </tr> <tr> <td>int $width Bar width in dots. If not specified, 3 will be used.</td> <td>1</td> </tr> <tr> <td>int $position. Use Printer::BARCODE_TEXT_NONE to hide the text (default),</td> <td>1</td> </tr> <tr> <td>boolean $on true for double strike, false for no double strike</td> <td>1</td> </tr> <tr> <td>int $color Color to use. Must be either Printer::COLOR_1 (default), or Printer::COLOR_2.</td> <td>1</td> </tr> <tr> <td>boolean $on true for emphasis, false for no emphasis</td> <td>1</td> </tr> <tr> <td>int $font The font to use. Must be either Printer::FONT_A, Printer::FONT_B, or Printer::FONT_C.</td> <td>1</td> </tr> <tr> <td>int $justification One of Printer::JUSTIFY_LEFT, Printer::JUSTIFY_CENTER, or Printer::JUSTIFY_RIGHT.</td> <td>1</td> </tr> <tr> <td>int|null $height The height of each line, in dots. If not set, the printer</td> <td>1</td> </tr> <tr> <td>int $margin The left margin to set on to the print area, in dots.</td> <td>1</td> </tr> <tr> <td>int $width The width of the page print area, in dots.</td> <td>1</td> </tr> <tr> <td>PrintBuffer $buffer The buffer to use.</td> <td>1</td> </tr> <tr> <td>int $widthMultiplier Multiple of the regular height to use (range 1 - 8)</td> <td>1</td> </tr> <tr> <td>int $heightMultiplier Multiple of the regular height to use (range 1 - 8)</td> <td>1</td> </tr> <tr> <td>int $underline Either true/false, or one of Printer::UNDERLINE_NONE, Printer::UNDERLINE_SINGLE or Printer::UNDERLINE_DOUBLE. Defaults to Printer::UNDERLINE_SINGLE.</td> <td>1</td> </tr> <tr> <td>string $str Text to print</td> <td>1</td> </tr> <tr> <td>string $fn Function to use</td> <td>1</td> </tr> <tr> <td>string $cn Output code type. Affects available data</td> <td>1</td> </tr> <tr> <td>string $m Modifier/variant for function. Often '0' where used.</td> <td>1</td> </tr> <tr> <td>string $m Modifier/variant for function. Usually '0'.</td> <td>1</td> </tr> <tr> <td>string $fn Function number to use, as character.</td> <td>1</td> </tr> <tr> <td>array $inputs</td> <td>1</td> </tr> <tr> <td>boolean $long True to use 4 bytes, false to use 2</td> <td>1</td> </tr> <tr> <td>int $input Input number</td> <td>1</td> </tr> <tr> <td>int $length The number of bytes to output (1 - 4).</td> <td>1</td> </tr> <tr> <td>boolean $test the input to test</td> <td>1</td> </tr> <tr> <td>float $test the input to test</td> <td>1</td> </tr> <tr> <td>float $min the minimum allowable value (inclusive)</td> <td>1</td> </tr> <tr> <td>float $max the maximum allowable value (inclusive)</td> <td>1</td> </tr> <tr> <td>int $min the minimum allowable value (inclusive)</td> <td>1</td> </tr> <tr> <td>int $max the maximum allowable value (inclusive)</td> <td>1</td> </tr> <tr> <td>array $ranges array of two-item min/max ranges.</td> <td>1</td> </tr> <tr> <td>string $test the input to test</td> <td>1</td> </tr> <tr> <td>string $regex valid values for this attribute, as a regex</td> <td>1</td> </tr> <tr> <td>string $argument the name of the parameter being validated</td> <td>1</td> </tr> <tr> <td>int $codePoint Code point to check.</td> <td>1</td> </tr> <tr> <td>array $codePoints Text to print, as list of unicode code points</td> <td>1</td> </tr> <tr> <td>integer $encodingNo Encoding number to use- assumed to exist.</td> <td>1</td> </tr> <tr> <td>string $char Character to check</td> <td>1</td> </tr> <tr> <td>boolean $extended True to allow 128-256 values also (excluded by default)</td> <td>1</td> </tr> <tr> <td>Printer|null $printer New printer</td> <td>1</td> </tr> <tr> <td>string $text Text to print</td> <td>1</td> </tr> <tr> <td>string $text Text to print, already the target encoding.</td> <td>1</td> </tr> <tr> <td>string $font</td> <td>1</td> </tr> <tr> <td>string $ip IP address or hostname to use.</td> <td>1</td> </tr> <tr> <td>string $port The port number to connect on.</td> <td>1</td> </tr> <tr> <td>string $timeout The connection timeout, in seconds.</td> <td>1</td> </tr> <tr> <td>string $command the command to run.</td> <td>1</td> </tr> <tr> <td>string $outputStr variable to fill with standard output.</td> <td>1</td> </tr> <tr> <td>string $errorStr variable to fill with standard error.</td> <td>1</td> </tr> <tr> <td>string $inputStr text to pass to the command's standard input (optional).</td> <td>1</td> </tr> <tr> <td>string $from Source file</td> <td>1</td> </tr> <tr> <td>string $to Destination file</td> <td>1</td> </tr> <tr> <td>string $data Data to print</td> <td>1</td> </tr> <tr> <td>string $filename Destination file</td> <td>1</td> </tr> <tr> <td>string $cmd</td> <td>1</td> </tr> <tr> <td>string $data The data to write</td> <td>1</td> </tr> <tr> <td>int $mode</td> <td>1</td> </tr> <tr> <td>string|null $id</td> <td>1</td> </tr> <tr> <td>array $parameters</td> <td>1</td> </tr> <tr> <td>string|null $domain</td> <td>1</td> </tr> <tr> <td>int $isDst</td> <td>1</td> </tr> <tr> <td>DateTimeZone|string|int|null $object</td> <td>1</td> </tr> <tr> <td>float $hourOffset number of hour of the timezone shift (can be decimal).</td> <td>1</td> </tr> <tr> <td>float $minuteOffset number of total minutes of the timezone shift.</td> <td>1</td> </tr> <tr> <td>float $minutes number of total minutes of the timezone shift.</td> <td>1</td> </tr> <tr> <td>Closure|static|string|false|null $testNow real or mock Carbon instance</td> <td>1</td> </tr> <tr> <td>Closure|null $callback</td> <td>1</td> </tr> <tr> <td>array $cascadeFactors</td> <td>1</td> </tr> <tr> <td>Closure|DateInterval|string|int|null $years</td> <td>1</td> </tr> <tr> <td>int|null $months</td> <td>1</td> </tr> <tr> <td>int|null $weeks</td> <td>1</td> </tr> <tr> <td>int|null $days</td> <td>1</td> </tr> <tr> <td>int|null $hours</td> <td>1</td> </tr> <tr> <td>int|null $minutes</td> <td>1</td> </tr> <tr> <td>int|null $seconds</td> <td>1</td> </tr> <tr> <td>int|null $microseconds</td> <td>1</td> </tr> <tr> <td>int $years</td> <td>1</td> </tr> <tr> <td>int $months</td> <td>1</td> </tr> <tr> <td>int $weeks</td> <td>1</td> </tr> <tr> <td>int $days</td> <td>1</td> </tr> <tr> <td>string $format Format of the $interval input string</td> <td>1</td> </tr> <tr> <td>string|null $interval Input string to convert into an interval</td> <td>1</td> </tr> <tr> <td>string $intervalDefinition</td> <td>1</td> </tr> <tr> <td>string $interval interval string in the given language (may also contain English).</td> <td>1</td> </tr> <tr> <td>string|null $locale if locale is null or not specified, current global locale will be used instead.</td> <td>1</td> </tr> <tr> <td>CarbonPeriod|\DateTimeInterface|Carbon|CarbonImmutable|string $rangeOrRangeStart</td> <td>1</td> </tr> <tr> <td>\DateTimeInterface|Carbon|CarbonImmutable|string|null $rangeEnd</td> <td>1</td> </tr> <tr> <td>mixed|int|DateInterval|string|Closure|null $interval interval or number of the given $unit</td> <td>1</td> </tr> <tr> <td>string|null $unit if specified, $interval must be an integer</td> <td>1</td> </tr> <tr> <td>string|array $name</td> <td>1</td> </tr> <tr> <td>int $value</td> <td>1</td> </tr> <tr> <td>int $weeks Number of weeks to set</td> <td>1</td> </tr> <tr> <td>int $days Number of days to set</td> <td>1</td> </tr> <tr> <td>mixed $syntax</td> <td>1</td> </tr> <tr> <td>mixed $short</td> <td>1</td> </tr> <tr> <td>mixed $parts</td> <td>1</td> </tr> <tr> <td>mixed $options</td> <td>1</td> </tr> <tr> <td>int $parts maximum number of parts to display (default value: -1: no limits)</td> <td>1</td> </tr> <tr> <td>DateTimeInterface|string|int ...$params Start date, [end date or recurrences] and optional settings.</td> <td>1</td> </tr> <tr> <td>bool|int $inverted if a parameter is passed, the passed value casted as 1 or 0 is used</td> <td>1</td> </tr> <tr> <td>DateInterval $first</td> <td>1</td> </tr> <tr> <td>DateInterval $second</td> <td>1</td> </tr> <tr> <td>string $isoName</td> <td>1</td> </tr> <tr> <td>string $nativeName</td> <td>1</td> </tr> <tr> <td>string|null $locale optional initial locale ("en" - english by default)</td> <td>1</td> </tr> <tr> <td>array $directories new directories list</td> <td>1</td> </tr> <tr> <td>string $directory new directory</td> <td>1</td> </tr> <tr> <td>string $directory directory path</td> <td>1</td> </tr> <tr> <td>array $messages</td> <td>1</td> </tr> <tr> <td>CarbonPeriod|DatePeriod $period</td> <td>1</td> </tr> <tr> <td>string $iso</td> <td>1</td> </tr> <tr> <td>\DateInterval $interval</td> <td>1</td> </tr> <tr> <td>string $iso</td> <td>1</td> </tr> <tr> <td>string $dateClass</td> <td>1</td> </tr> <tr> <td>DateInterval|string $interval</td> <td>1</td> </tr> <tr> <td>DateTime|DateTimeInterface|string $start</td> <td>1</td> </tr> <tr> <td>DateTime|DateTimeInterface|string|null $end</td> <td>1</td> </tr> <tr> <td>int $options</td> <td>1</td> </tr> <tr> <td>bool|null $state</td> <td>1</td> </tr> <tr> <td>int|float|null $recurrences</td> <td>1</td> </tr> <tr> <td>DateTime|DateTimeInterface|string $date</td> <td>1</td> </tr> <tr> <td>bool|null $inclusive</td> <td>1</td> </tr> <tr> <td>DateTime|DateTimeInterface|string|null $date</td> <td>1</td> </tr> <tr> <td>bool|null $inclusive</td> <td>1</td> </tr> <tr> <td>int $count steps number to skip (1 by default)</td> <td>1</td> </tr> <tr> <td>callable $callable</td> <td>1</td> </tr> <tr> <td>int $key</td> <td>1</td> </tr> <tr> <td>CarbonInterface $date</td> <td>1</td> </tr> <tr> <td>mixed ...$arguments</td> <td>1</td> </tr> <tr> <td>PhpMethodReflectionFactory $methodReflectionFactory</td> <td>1</td> </tr> <tr> <td>string $methodName</td> <td>1</td> </tr> <tr> <td>callable $macro</td> <td>1</td> </tr> <tr> <td>CarbonInterval $diff</td> <td>1</td> </tr> <tr> <td>DateInterval $diff</td> <td>1</td> </tr> <tr> <td>bool $absolute</td> <td>1</td> </tr> <tr> <td>float|int|string $numbers one or more numbers</td> <td>1</td> </tr> <tr> <td>int $decimals number of decimals precision (6 by default)</td> <td>1</td> </tr> <tr> <td>Closure|null $step</td> <td>1</td> </tr> <tr> <td>bool $negated</td> <td>1</td> </tr> <tr> <td>string $trait</td> <td>1</td> </tr> <tr> <td>static|null $context</td> <td>1</td> </tr> <tr> <td>callable $callable</td> <td>1</td> </tr> <tr> <td>null $translator</td> <td>1</td> </tr> <tr> <td>LocaleAwareInterface|null $translator</td> <td>1</td> </tr> <tr> <td>mixed $translator</td> <td>1</td> </tr> <tr> <td>\Symfony\Component\Translation\MessageCatalogueInterface $catalogue</td> <td>1</td> </tr> <tr> <td>string $word</td> <td>1</td> </tr> <tr> <td>string[] $keys keys to translate.</td> <td>1</td> </tr> <tr> <td>string[] $messages messages bag handling translations.</td> <td>1</td> </tr> <tr> <td>string $key 'to' (to get the translation) or 'from' (to get the detection RegExp pattern).</td> <td>1</td> </tr> <tr> <td>callable $translation</td> <td>1</td> </tr> <tr> <td>int $length</td> <td>1</td> </tr> <tr> <td>string $timeString</td> <td>1</td> </tr> <tr> <td>DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance</td> <td>1</td> </tr> <tr> <td>Closure|null $callback</td> <td>1</td> </tr> <tr> <td>string|\DateTimeZone $tz</td> <td>1</td> </tr> <tr> <td>mixed $date</td> <td>1</td> </tr> <tr> <td>string|array $other</td> <td>1</td> </tr> <tr> <td>DateTimeInterface $date</td> <td>1</td> </tr> <tr> <td>string $format Datetime format</td> <td>1</td> </tr> <tr> <td>DateTimeZone|string|false|null $originalTz</td> <td>1</td> </tr> <tr> <td>array $lastErrors</td> <td>1</td> </tr> <tr> <td>bool $weekday</td> <td>1</td> </tr> <tr> <td>bool $forward</td> <td>1</td> </tr> <tr> <td>string $setter setter name</td> <td>1</td> </tr> <tr> <td>string $field</td> <td>1</td> </tr> <tr> <td>string $setter</td> <td>1</td> </tr> <tr> <td>mixed $object</td> <td>1</td> </tr> <tr> <td>string $getter getter name</td> <td>1</td> </tr> <tr> <td>string $value the immutable type/value</td> <td>1</td> </tr> <tr> <td>string $className</td> <td>1</td> </tr> <tr> <td>mixed $min</td> <td>1</td> </tr> <tr> <td>mixed $max</td> <td>1</td> </tr> <tr> <td>string $expected</td> <td>1</td> </tr> <tr> <td>string $actual</td> <td>1</td> </tr> <tr> <td>int|string|array $kind</td> <td>1</td> </tr> <tr> <td>mixed $int</td> <td>1</td> </tr> <tr> <td>string $function</td> <td>1</td> </tr> <tr> <td>bool $pointsToNextItems</td> <td>1</td> </tr> <tr> <td>array $parameterNames</td> <td>1</td> </tr> <tr> <td>string|null $encodedString</td> <td>1</td> </tr> <tr> <td>bool $hasMore</td> <td>1</td> </tr> <tr> <td>int $default</td> <td>1</td> </tr> <tr> <td>string|array|null $default</td> <td>1</td> </tr> <tr> <td>bool $isNext</td> <td>1</td> </tr> <tr> <td>mixed $parameter</td> <td>1</td> </tr> <tr> <td>string $cursorName</td> <td>1</td> </tr> <tr> <td>int $total</td> <td>1</td> </tr> <tr> <td>bool $unserialize</td> <td>1</td> </tr> <tr> <td>bool $serialize</td> <td>1</td> </tr> <tr> <td>mixed $connection</td> <td>1</td> </tr> <tr> <td>string|null $column</td> <td>1</td> </tr> <tr> <td>string|\Closure|null $aggregate</td> <td>1</td> </tr> <tr> <td>array $arguments</td> <td>1</td> </tr> <tr> <td>string|null $pipeline</td> <td>1</td> </tr> <tr> <td>mixed $traveler</td> <td>1</td> </tr> <tr> <td>dynamic|array $stops</td> <td>1</td> </tr> <tr> <td>\Closure $destination</td> <td>1</td> </tr> <tr> <td>mixed $result</td> <td>1</td> </tr> <tr> <td>array $channels</td> <td>1</td> </tr> <tr> <td>string|null $owner</td> <td>1</td> </tr> <tr> <td>string $owner</td> <td>1</td> </tr> <tr> <td>string|null $namespace</td> <td>1</td> </tr> <tr> <td>string $hint</td> <td>1</td> </tr> <tr> <td>\Countable|int|array $number</td> <td>1</td> </tr> <tr> <td>array $clusterOptions</td> <td>1</td> </tr> <tr> <td>array|null $abilities</td> <td>1</td> </tr> <tr> <td>string $policy</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Authenticatable|mixed $user</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Mail\Factory|\Illuminate\Contracts\Mail\Mailer $mailer</td> <td>1</td> </tr> <tr> <td>string $mailer</td> <td>1</td> </tr> <tr> <td>string|array $environments</td> <td>1</td> </tr> <tr> <td>bool $force</td> <td>1</td> </tr> <tr> <td>string|null $service</td> <td>1</td> </tr> <tr> <td>array $bootstrappers</td> <td>1</td> </tr> <tr> <td>string|resource $contents</td> <td>1</td> </tr> <tr> <td>mixed $options</td> <td>1</td> </tr> <tr> <td>resource $resource</td> <td>1</td> </tr> <tr> <td>string $visibility</td> <td>1</td> </tr> <tr> <td>string|array $paths</td> <td>1</td> </tr> <tr> <td>string $directory</td> <td>1</td> </tr> <tr> <td>array|string $abstracts</td> <td>1</td> </tr> <tr> <td>array|mixed ...$tags</td> <td>1</td> </tr> <tr> <td>string $concrete</td> <td>1</td> </tr> <tr> <td>\Closure|string $implementation</td> <td>1</td> </tr> <tr> <td>string|array $concrete</td> <td>1</td> </tr> <tr> <td>string|null $defaultMethod</td> <td>1</td> </tr> <tr> <td>\Closure|string|array $implementation</td> <td>1</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\Response $response</td> <td>1</td> </tr> <tr> <td>int $delay</td> <td>1</td> </tr> <tr> <td>\Throwable|null $e</td> <td>1</td> </tr> <tr> <td>int $minutes</td> <td>1</td> </tr> <tr> <td>array|string $methods</td> <td>1</td> </tr> <tr> <td>string $controller</td> <td>1</td> </tr> <tr> <td>\Closure|string $routes</td> <td>1</td> </tr> <tr> <td>array|string $content</td> <td>1</td> </tr> <tr> <td>string|array $view</td> <td>1</td> </tr> <tr> <td>string $route</td> <td>1</td> </tr> <tr> <td>string $action</td> <td>1</td> </tr> <tr> <td>mixed $fallback</td> <td>1</td> </tr> <tr> <td>mixed $extra</td> <td>1</td> </tr> <tr> <td>string|array $action</td> <td>1</td> </tr> <tr> <td>string $rootNamespace</td> <td>1</td> </tr> <tr> <td>string|callable $binder</td> <td>1</td> </tr> <tr> <td>string $childType</td> <td>1</td> </tr> <tr> <td>\Closure|string|array|null $listener</td> <td>1</td> </tr> <tr> <td>array $rules</td> <td>1</td> </tr> <tr> <td>array $customAttributes</td> <td>1</td> </tr> <tr> <td>\Closure|string $replacer</td> <td>1</td> </tr> <tr> <td>string|array $attribute</td> <td>1</td> </tr> <tr> <td>string|array $rules</td> <td>1</td> </tr> <tr> <td>string $attribute</td> <td>1</td> </tr> <tr> <td>\Illuminate\Validation\Validator $validator</td> <td>1</td> </tr> <tr> <td>\Symfony\Component\Console\Output\OutputInterface $output</td> <td>1</td> </tr> <tr> <td>\Symfony\Component\Console\Output\OutputInterface|null $output</td> <td>1</td> </tr> <tr> <td>string $id</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Support\MessageBag $bag</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Support\MessageBag $value</td> <td>1</td> </tr> <tr> <td>string|null $unknown</td> <td>1</td> </tr> <tr> <td>bool|null $strict</td> <td>1</td> </tr> <tr> <td>string[] $needles</td> <td>1</td> </tr> <tr> <td>string|null $encoding</td> <td>1</td> </tr> <tr> <td>array<int|string, string> $replace</td> <td>1</td> </tr> <tr> <td>string|string[] $subject</td> <td>1</td> </tr> <tr> <td>string $title</td> <td>1</td> </tr> <tr> <td>string|array $string</td> <td>1</td> </tr> <tr> <td>callable|null $factory</td> <td>1</td> </tr> <tr> <td>array|object $attributes</td> <td>1</td> </tr> <tr> <td>int|null $flags</td> <td>1</td> </tr> <tr> <td>string $json</td> <td>1</td> </tr> <tr> <td>string $comparison</td> <td>1</td> </tr> <tr> <td>mixed $name</td> <td>1</td> </tr> <tr> <td>array $input</td> <td>1</td> </tr> <tr> <td>array $items</td> <td>1</td> </tr> <tr> <td>string|array $extra</td> <td>1</td> </tr> <tr> <td>\Illuminate\Filesystem\Filesystem $files</td> <td>1</td> </tr> <tr> <td>string|null $workingPath</td> <td>1</td> </tr> <tr> <td>array $command</td> <td>1</td> </tr> <tr> <td>array $segments</td> <td>1</td> </tr> <tr> <td>array $parsed</td> <td>1</td> </tr> <tr> <td>string|null $driver</td> <td>1</td> </tr> <tr> <td>string $dateClass</td> <td>1</td> </tr> <tr> <td>object $factory</td> <td>1</td> </tr> <tr> <td>bool $boolean</td> <td>1</td> </tr> <tr> <td>string $messageKey</td> <td>1</td> </tr> <tr> <td>mixed $var</td> <td>1</td> </tr> <tr> <td>bool $syntaxOnly</td> <td>1</td> </tr> <tr> <td>\ReflectionNamedType $type</td> <td>1</td> </tr> <tr> <td>string $className</td> <td>1</td> </tr> <tr> <td>array|string $config</td> <td>1</td> </tr> <tr> <td>string $suffix</td> <td>1</td> </tr> <tr> <td>int $levels</td> <td>1</td> </tr> <tr> <td>string|int $pattern</td> <td>1</td> </tr> <tr> <td>\Closure|string $replace</td> <td>1</td> </tr> <tr> <td>string $allowedTags</td> <td>1</td> </tr> <tr> <td>int|null $offset</td> <td>1</td> </tr> <tr> <td>string|array $path</td> <td>1</td> </tr> <tr> <td>array $components</td> <td>1</td> </tr> <tr> <td>mixed $groups</td> <td>1</td> </tr> <tr> <td>array|mixed $commands</td> <td>1</td> </tr> <tr> <td>string $html</td> <td>1</td> </tr> <tr> <td>array|string|null $name</td> <td>1</td> </tr> <tr> <td>string $argument</td> <td>1</td> </tr> <tr> <td>string $arg</td> <td>1</td> </tr> <tr> <td>string $char</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Bus\QueueingDispatcher $dispatcher</td> <td>1</td> </tr> <tr> <td>\Illuminate\Bus\PendingBatch $pendingBatch</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Events\Dispatcher $dispatcher</td> <td>1</td> </tr> <tr> <td>string $expectedEvent</td> <td>1</td> </tr> <tr> <td>string $expectedListener</td> <td>1</td> </tr> <tr> <td>mixed $listener</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Collection $jobs</td> <td>1</td> </tr> <tr> <td>array|null $channels</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\MailFake $mailer</td> <td>1</td> </tr> <tr> <td>mixed $before</td> <td>1</td> </tr> <tr> <td>\Illuminate\Bus\PendingBatch $batch</td> <td>1</td> </tr> <tr> <td>int $amount</td> <td>1</td> </tr> <tr> <td>string[]|string $eventsToAllow</td> <td>1</td> </tr> <tr> <td>array $eventsToFake</td> <td>1</td> </tr> <tr> <td>array $eventsToAllow</td> <td>1</td> </tr> <tr> <td>string $workerName</td> <td>1</td> </tr> <tr> <td>array|mixed $jobs</td> <td>1</td> </tr> <tr> <td>string $channel</td> <td>1</td> </tr> <tr> <td>mixed $route</td> <td>1</td> </tr> <tr> <td>object|string $name</td> <td>1</td> </tr> <tr> <td>object $mixin</td> <td>1</td> </tr> <tr> <td>bool $replace</td> <td>1</td> </tr> <tr> <td>object|callable $macro</td> <td>1</td> </tr> <tr> <td>array ...$arrays</td> <td>1</td> </tr> <tr> <td>\DateTimeInterface $timeout</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Collection|mixed $keys</td> <td>1</td> </tr> <tr> <td>string|int|array $keys</td> <td>1</td> </tr> <tr> <td>callable|array|string $callback</td> <td>1</td> </tr> <tr> <td>array $comparisons</td> <td>1</td> </tr> <tr> <td>mixed $replacement</td> <td>1</td> </tr> <tr> <td>mixed $item</td> <td>1</td> </tr> <tr> <td>bool $condition</td> <td>1</td> </tr> <tr> <td>iterable ...$arrays</td> <td>1</td> </tr> <tr> <td>string $prepend</td> <td>1</td> </tr> <tr> <td>string|int|null $key</td> <td>1</td> </tr> <tr> <td>bool|false $preserveKeys</td> <td>1</td> </tr> <tr> <td>callable|array|string|null $callback</td> <td>1</td> </tr> <tr> <td>bool|mixed $value</td> <td>1</td> </tr> <tr> <td>array<callable> $pipes</td> <td>1</td> </tr> <tr> <td>string|null $operator</td> <td>1</td> </tr> <tr> <td>callable|string|null $value</td> <td>1</td> </tr> <tr> <td>array $parameters</td> <td>1</td> </tr> <tr> <td>null $default</td> <td>1</td> </tr> <tr> <td>array $array1 Initial array to merge.</td> <td>1</td> </tr> <tr> <td>array ... Variable list of arrays to recursively merge.</td> <td>1</td> </tr> <tr> <td>string $encoding</td> <td>1</td> </tr> <tr> <td>string|null $fallback</td> <td>1</td> </tr> <tr> <td>object $object</td> <td>1</td> </tr> <tr> <td>array|mixed $value</td> <td>1</td> </tr> <tr> <td>bool $strict</td> <td>1</td> </tr> <tr> <td>FolderCollection|array $children</td> <td>1</td> </tr> <tr> <td>$full_name</td> <td>1</td> </tr> <tr> <td>$attributes</td> <td>1</td> </tr> <tr> <td>string|null $sequence uid sequence</td> <td>1</td> </tr> <tr> <td>string $options</td> <td>1</td> </tr> <tr> <td>string $internal_date</td> <td>1</td> </tr> <tr> <td>integer $timeout max 1740 seconds - recommended by rfc2177 §3</td> <td>1</td> </tr> <tr> <td>boolean $auto_reconnect try to reconnect on connection close</td> <td>1</td> </tr> <tr> <td>boolean $attributize</td> <td>1</td> </tr> <tr> <td>$pattern</td> <td>1</td> </tr> <tr> <td>$raw_headers</td> <td>1</td> </tr> <tr> <td>string $text The MIME text</td> <td>1</td> </tr> <tr> <td>$encoded</td> <td>1</td> </tr> <tr> <td>$decoded</td> <td>1</td> </tr> <tr> <td>$values</td> <td>1</td> </tr> <tr> <td>$list</td> <td>1</td> </tr> <tr> <td>$raw_structure</td> <td>1</td> </tr> <tr> <td>string $context</td> <td>1</td> </tr> <tr> <td>int $part_number</td> <td>1</td> </tr> <tr> <td>Message $oMessage</td> <td>1</td> </tr> <tr> <td>Part $part</td> <td>1</td> </tr> <tr> <td>$raw_part</td> <td>1</td> </tr> <tr> <td>integer $part_number</td> <td>1</td> </tr> <tr> <td>$content_type</td> <td>1</td> </tr> <tr> <td>null $fetch_options</td> <td>1</td> </tr> <tr> <td>null $sequence</td> <td>1</td> </tr> <tr> <td>integer|null $msglist</td> <td>1</td> </tr> <tr> <td>integer|null $fetch_options</td> <td>1</td> </tr> <tr> <td>boolean $fetch_flags</td> <td>1</td> </tr> <tr> <td>integer $sequence</td> <td>1</td> </tr> <tr> <td>Structure $structure</td> <td>1</td> </tr> <tr> <td>$string</td> <td>1</td> </tr> <tr> <td>$encoding</td> <td>1</td> </tr> <tr> <td>Folder|null $sent_folder</td> <td>1</td> </tr> <tr> <td>MessageCollection|null $thread</td> <td>1</td> </tr> <tr> <td>Folder|null $folder</td> <td>1</td> </tr> <tr> <td>string $in_reply_to</td> <td>1</td> </tr> <tr> <td>string $message_id</td> <td>1</td> </tr> <tr> <td>Folder $folder</td> <td>1</td> </tr> <tr> <td>int $next_uid</td> <td>1</td> </tr> <tr> <td>string $event</td> <td>1</td> </tr> <tr> <td>bool $expunge</td> <td>1</td> </tr> <tr> <td>null|Message $message</td> <td>1</td> </tr> <tr> <td>$available_flags</td> <td>1</td> </tr> <tr> <td>$attachments</td> <td>1</td> </tr> <tr> <td>$flags</td> <td>1</td> </tr> <tr> <td>$client</td> <td>1</td> </tr> <tr> <td>array $default_config</td> <td>1</td> </tr> <tr> <td>string|bool|null $delimiter</td> <td>1</td> </tr> <tr> <td>$folder_name</td> <td>1</td> </tr> <tr> <td>boolean $hierarchical</td> <td>1</td> </tr> <tr> <td>string|null $parent_folder</td> <td>1</td> </tr> <tr> <td>boolean $force_select</td> <td>1</td> </tr> <tr> <td>$folder</td> <td>1</td> </tr> <tr> <td>integer $timeout</td> <td>1</td> </tr> <tr> <td>null $port</td> <td>1</td> </tr> <tr> <td>string $protocol</td> <td>1</td> </tr> <tr> <td>$transport</td> <td>1</td> </tr> <tr> <td>int $port of IMAP server, default is 143 (993 for ssl)</td> <td>1</td> </tr> <tr> <td>int $timeout timeout in seconds for initiating session</td> <td>1</td> </tr> <tr> <td>int $connection_timeout</td> <td>1</td> </tr> <tr> <td>int|null $port of service server</td> <td>1</td> </tr> <tr> <td>string $folder mailbox / folder name match with wildcards</td> <td>1</td> </tr> <tr> <td>array $flags flags to set, add or remove</td> <td>1</td> </tr> <tr> <td>int|null $port of IMAP server, default is 143 and 993 for ssl</td> <td>1</td> </tr> <tr> <td>string $start</td> <td>1</td> </tr> <tr> <td>string $tag reference tag</td> <td>1</td> </tr> <tr> <td>array|string $tokens to decode</td> <td>1</td> </tr> <tr> <td>string $wantedTag targeted tag</td> <td>1</td> </tr> <tr> <td>bool $dontParse if true only the unparsed line is returned in $tokens</td> <td>1</td> </tr> <tr> <td>string $tag request tag</td> <td>1</td> </tr> <tr> <td>bool $dontParse if true every line is returned unparsed instead of the decoded tokens</td> <td>1</td> </tr> <tr> <td>array $tokens additional parameters to command, use escapeString() to prepare</td> <td>1</td> </tr> <tr> <td>string $tag provide a tag otherwise an autogenerated is returned</td> <td>1</td> </tr> <tr> <td>array $tokens parameters as in sendRequest()</td> <td>1</td> </tr> <tr> <td>bool $dontParse if true unparsed lines are returned instead of tokens</td> <td>1</td> </tr> <tr> <td>string|array $string the literal/-s</td> <td>1</td> </tr> <tr> <td>array $list list with literals or lists as PHP array</td> <td>1</td> </tr> <tr> <td>string $command can be 'EXAMINE' or 'SELECT'</td> <td>1</td> </tr> <tr> <td>string $folder target folder</td> <td>1</td> </tr> <tr> <td>string|array $items items to fetch [RFC822.HEADER, FLAGS, RFC822.TEXT, etc]</td> <td>1</td> </tr> <tr> <td>int|array $from message for items or start message if $to !== null</td> <td>1</td> </tr> <tr> <td>string $sequence</td> <td>1</td> </tr> <tr> <td>$class</td> <td>1</td> </tr> <tr> <td>$events</td> <td>1</td> </tr> <tr> <td>array $items</td> <td>1</td> </tr> <tr> <td>int $total</td> <td>1</td> </tr> <tr> <td>int|null $current_page</td> <td>1</td> </tr> <tr> <td>array $options</td> <td>1</td> </tr> <tr> <td>int|null $page</td> <td>1</td> </tr> <tr> <td>string $page_name</td> <td>1</td> </tr> <tr> <td>boolean $prepaginated</td> <td>1</td> </tr> <tr> <td>null $total</td> <td>1</td> </tr> <tr> <td>callable|bool $callback</td> <td>1</td> </tr> <tr> <td>$parent</td> <td>1</td> </tr> <tr> <td>$criteria</td> <td>1</td> </tr> <tr> <td>array|null $arguments</td> <td>1</td> </tr> <tr> <td>mixed $criteria</td> <td>1</td> </tr> <tr> <td>null $value</td> <td>1</td> </tr> <tr> <td>$criteria string</td> <td>1</td> </tr> <tr> <td>$value mixed</td> <td>1</td> </tr> <tr> <td>$header</td> <td>1</td> </tr> <tr> <td>$country_code</td> <td>1</td> </tr> <tr> <td>int|string $uid</td> <td>1</td> </tr> <tr> <td>array<int, int> $uids</td> <td>1</td> </tr> <tr> <td>string|Carbon $date</td> <td>1</td> </tr> <tr> <td>array $flags</td> <td>1</td> </tr> <tr> <td>string $message_key</td> <td>1</td> </tr> <tr> <td>Message $message</td> <td>1</td> </tr> <tr> <td>int $chunk_size</td> <td>1</td> </tr> <tr> <td>int $start_chunk</td> <td>1</td> </tr> <tr> <td>int $per_page Results you which to receive per page</td> <td>1</td> </tr> <tr> <td>int|null $page The current page you are on (e.g. 0, 1, 2, ...) use `null` to enable auto mode</td> <td>1</td> </tr> <tr> <td>string $page_name The page name / uri parameter used for the generated links and the auto mode</td> <td>1</td> </tr> <tr> <td>int|null $sequence</td> <td>1</td> </tr> <tr> <td>array $query</td> <td>1</td> </tr> <tr> <td>string $raw_query</td> <td>1</td> </tr> <tr> <td>int $fetch_flags</td> <td>1</td> </tr> <tr> <td>Exception $error</td> <td>1</td> </tr> <tr> <td>string $key The key of the item to store.</td> <td>1</td> </tr> <tr> <td>mixed $value The value of the item to store, must be serializable.</td> <td>1</td> </tr> <tr> <td>null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and</td> <td>1</td> </tr> <tr> <td>string $key The unique key of this item in the cache.</td> <td>1</td> </tr> <tr> <td>mixed $default Default value to return if the key does not exist.</td> <td>1</td> </tr> <tr> <td>string $key The unique cache key of the item to delete.</td> <td>1</td> </tr> <tr> <td>iterable $keys A list of keys that can obtained in a single operation.</td> <td>1</td> </tr> <tr> <td>mixed $default Default value to return for keys that do not exist.</td> <td>1</td> </tr> <tr> <td>iterable $values A list of key => value pairs for a multiple-set operation.</td> <td>1</td> </tr> <tr> <td>null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and</td> <td>1</td> </tr> <tr> <td>iterable $keys A list of string-based keys to be deleted.</td> <td>1</td> </tr> <tr> <td>string $key The cache item key.</td> <td>1</td> </tr> <tr> <td>string $type The PHP type of the value being dumped</td> <td>1</td> </tr> <tr> <td>scalar $value The scalar value being dumped</td> <td>1</td> </tr> <tr> <td>string $str The string being dumped</td> <td>1</td> </tr> <tr> <td>bool $bin Whether $str is UTF-8 or binary encoded</td> <td>1</td> </tr> <tr> <td>int $cut The number of characters $str has been cut by</td> <td>1</td> </tr> <tr> <td>callable[]|null $casters A map of casters</td> <td>1</td> </tr> <tr> <td>callable[] $casters A map of casters</td> <td>1</td> </tr> <tr> <td>int $maxItems</td> <td>1</td> </tr> <tr> <td>int $maxString</td> <td>1</td> </tr> <tr> <td>mixed $var Any PHP variable</td> <td>1</td> </tr> <tr> <td>int $filter A bit field of Caster::EXCLUDE_* constants</td> <td>1</td> </tr> <tr> <td>Stub $stub The Stub for the casted object</td> <td>1</td> </tr> <tr> <td>Stub $stub The Stub for the casted resource</td> <td>1</td> </tr> <tr> <td>callable $callback The caster</td> <td>1</td> </tr> <tr> <td>object|resource $obj The object/resource being casted</td> <td>1</td> </tr> <tr> <td>array $a The result of the previous cast for chained casters</td> <td>1</td> </tr> <tr> <td>Stub $stub The Stub for the casted object/resource</td> <td>1</td> </tr> <tr> <td>bool $isNested True if $obj is nested in the dumped structure</td> <td>1</td> </tr> <tr> <td>array $data A array as returned by ClonerInterface::cloneVar()</td> <td>1</td> </tr> <tr> <td>int $maxDepth The max dumped depth level</td> <td>1</td> </tr> <tr> <td>int $maxItemsPerDepth The max number of items dumped per depth level</td> <td>1</td> </tr> <tr> <td>bool $useRefHandles False to hide global ref. handles</td> <td>1</td> </tr> <tr> <td>string|int $key The key to seek to</td> <td>1</td> </tr> <tr> <td>DumperInterface $dumper The dumper being used for dumping</td> <td>1</td> </tr> <tr> <td>Cursor $cursor A cursor used for tracking dumper state position</td> <td>1</td> </tr> <tr> <td>array &$refs A map of all references discovered while dumping</td> <td>1</td> </tr> <tr> <td>mixed $item A Stub object or the original value being dumped</td> <td>1</td> </tr> <tr> <td>DumperInterface $dumper</td> <td>1</td> </tr> <tr> <td>Cursor $parentCursor The cursor of the parent hash</td> <td>1</td> </tr> <tr> <td>array &$refs A map of all references discovered while dumping</td> <td>1</td> </tr> <tr> <td>array $children The children to dump</td> <td>1</td> </tr> <tr> <td>int $hashCut The number of items removed from the original hash</td> <td>1</td> </tr> <tr> <td>string $hashType A Cursor::HASH_* const</td> <td>1</td> </tr> <tr> <td>bool $dumpKeys Whether keys should be dumped or not</td> <td>1</td> </tr> <tr> <td>string A PHP identifier, e.g. a class, method, interface, etc. name</td> <td>1</td> </tr> <tr> <td>callable The callable targeted by the identifier when it is ambiguous or not a real PHP identifier</td> <td>1</td> </tr> <tr> <td>array $a The array containing the properties to filter</td> <td>1</td> </tr> <tr> <td>int $filter A bit field of Caster::EXCLUDE_* constants specifying which properties to filter out</td> <td>1</td> </tr> <tr> <td>string[] $listedProperties List of properties to exclude when Caster::EXCLUDE_VERBOSE is set, and to preserve when Caster::EXCLUDE_NOT_IMPORTANT is set</td> <td>1</td> </tr> <tr> <td>int &$count Set to the number of removed properties</td> <td>1</td> </tr> <tr> <td>object $obj The object to cast</td> <td>1</td> </tr> <tr> <td>\ReflectionClass $reflector The class reflector to use for inspecting the object definition</td> <td>1</td> </tr> <tr> <td>\Exception $prev The exception thrown from the caster</td> <td>1</td> </tr> <tr> <td>Data $data A Data object</td> <td>1</td> </tr> <tr> <td>callable|resource|string $output A line dumper callable, an opened stream or an output path</td> <td>1</td> </tr> <tr> <td>callable|resource|string|null $output A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput</td> <td>1</td> </tr> <tr> <td>string $charset The default character encoding to use for non-UTF8 strings</td> <td>1</td> </tr> <tr> <td>int $flags A bit field of static::DUMP_* constants to fine tune dumps representation</td> <td>1</td> </tr> <tr> <td>string $charset The default character encoding to use for non-UTF8 strings</td> <td>1</td> </tr> <tr> <td>string $pad A string the will be prepended to dumped lines, repeated by nesting level</td> <td>1</td> </tr> <tr> <td>Data $data A Data object</td> <td>1</td> </tr> <tr> <td>callable|resource|string|true|null $output A line dumper callable, an opened stream, an output path or true to return the dump</td> <td>1</td> </tr> <tr> <td>int $depth The recursive depth in the dumped structure for the line being dumped</td> <td>1</td> </tr> <tr> <td>string $line The line to write</td> <td>1</td> </tr> <tr> <td>int $depth The recursive depth in the dumped structure</td> <td>1</td> </tr> <tr> <td>string $indentPad The line indent pad</td> <td>1</td> </tr> <tr> <td>string $s The non-UTF-8 string to convert</td> <td>1</td> </tr> <tr> <td>bool $colors</td> <td>1</td> </tr> <tr> <td>int $maxStringWidth</td> <td>1</td> </tr> <tr> <td>array $styles A map of style names to style definitions</td> <td>1</td> </tr> <tr> <td>string $style The type of style being applied</td> <td>1</td> </tr> <tr> <td>string $value The value being styled</td> <td>1</td> </tr> <tr> <td>array $attr Optional context information</td> <td>1</td> </tr> <tr> <td>array $displayOptions A map of display options to customize the behavior</td> <td>1</td> </tr> <tr> <td>string $header An HTML string</td> <td>1</td> </tr> <tr> <td>string $prefix The prepended HTML string</td> <td>1</td> </tr> <tr> <td>string $suffix The appended HTML string</td> <td>1</td> </tr> <tr> <td>array $headers Specify the headers as injection. Should be PHP _SERVER flavored.</td> <td>1</td> </tr> <tr> <td>string $userAgent Inject the User-Agent header. If null, will use HTTP_USER_AGENT</td> <td>1</td> </tr> <tr> <td>array $httpHeaders The headers to set. If null, then using PHP's _SERVER to extract</td> <td>1</td> </tr> <tr> <td>string $header The name of the header to retrieve. Can be HTTP compliant such as</td> <td>1</td> </tr> <tr> <td>array $cfHeaders List of HTTP headers</td> <td>1</td> </tr> <tr> <td>string $userAgent The user agent string to set.</td> <td>1</td> </tr> <tr> <td>string $type The type. Must be a self::DETECTION_TYPE_* constant. The default</td> <td>1</td> </tr> <tr> <td>string $name</td> <td>1</td> </tr> <tr> <td>array $arguments</td> <td>1</td> </tr> <tr> <td>null $userAgent deprecated</td> <td>1</td> </tr> <tr> <td>null $userAgent deprecated</td> <td>1</td> </tr> <tr> <td>null $httpHeaders deprecated</td> <td>1</td> </tr> <tr> <td>string $userAgent deprecated</td> <td>1</td> </tr> <tr> <td>array $httpHeaders deprecated</td> <td>1</td> </tr> <tr> <td>string $key</td> <td>1</td> </tr> <tr> <td>string $userAgent deprecated</td> <td>1</td> </tr> <tr> <td>string $httpHeaders deprecated</td> <td>1</td> </tr> <tr> <td>$regex</td> <td>1</td> </tr> <tr> <td>string $ver The string version, like "2.6.21.2152";</td> <td>1</td> </tr> <tr> <td>string $propertyName The name of the property. See self::getProperties() array</td> <td>1</td> </tr> <tr> <td>string $type Either self::VERSION_TYPE_STRING to get a string value or</td> <td>1</td> </tr> <tr> <td>string $data unprocessed response data from server</td> <td>1</td> </tr> <tr> <td>string $data unprocessed request data from client</td> <td>1</td> </tr> <tr> <td>string $val The string in which to expand entities.</td> <td>1</td> </tr> <tr> <td>mixed $val The PHP array</td> <td>1</td> </tr> <tr> <td>mixed $val The value to serialize</td> <td>1</td> </tr> <tr> <td>string $name The name (local part) of the XML element</td> <td>1</td> </tr> <tr> <td>string $type The XML schema type (local part) for the element</td> <td>1</td> </tr> <tr> <td>string $name_ns The namespace for the name of the XML element</td> <td>1</td> </tr> <tr> <td>string $type_ns The namespace for the type of the element</td> <td>1</td> </tr> <tr> <td>array $attributes The attributes to serialize as name=>value pairs</td> <td>1</td> </tr> <tr> <td>string $use The WSDL "use" (encoded|literal)</td> <td>1</td> </tr> <tr> <td>boolean $soapval Whether this is called from soapval.</td> <td>1</td> </tr> <tr> <td>string $body the XML of the SOAP body</td> <td>1</td> </tr> <tr> <td>array $namespaces optional the namespaces used in generating the body and headers</td> <td>1</td> </tr> <tr> <td>string $style optional (rpc|document)</td> <td>1</td> </tr> <tr> <td>string $use optional (encoded|literal)</td> <td>1</td> </tr> <tr> <td>string $str The string to format</td> <td>1</td> </tr> <tr> <td>string $prefix The prefix</td> <td>1</td> </tr> <tr> <td>string $ns The namespace</td> <td>1</td> </tr> <tr> <td>mixed $data The variable to var_dump</td> <td>1</td> </tr> <tr> <td>string $faultcode (SOAP-ENV:Client | SOAP-ENV:Server)</td> <td>1</td> </tr> <tr> <td>string $faultactor only used when msg routed between multiple actors</td> <td>1</td> </tr> <tr> <td>string $faultstring human readable error message</td> <td>1</td> </tr> <tr> <td>mixed $faultdetail detail, typically a string or array of string</td> <td>1</td> </tr> <tr> <td>string $schema schema document URI</td> <td>1</td> </tr> <tr> <td>string $xml xml document URI</td> <td>1</td> </tr> <tr> <td>string $namespaces namespaces defined in enclosing XML</td> <td>1</td> </tr> <tr> <td>string $xml path/URL to XML file</td> <td>1</td> </tr> <tr> <td>string $type (schema | xml)</td> <td>1</td> </tr> <tr> <td>string $xml path or URL</td> <td>1</td> </tr> <tr> <td>string $type (schema|xml)</td> <td>1</td> </tr> <tr> <td>string $ename Element name</td> <td>1</td> </tr> <tr> <td>string $type name of defined type</td> <td>1</td> </tr> <tr> <td>string $ns namespace of type</td> <td>1</td> </tr> <tr> <td>string $name name for type instance</td> <td>1</td> </tr> <tr> <td>string $phpType : currently supported are array and struct (php assoc array)</td> <td>1</td> </tr> <tr> <td>array $elements = array ( name = array(name=>'',type=>'') )</td> <td>1</td> </tr> <tr> <td>array $attrs = array(</td> <td>1</td> </tr> <tr> <td>array $arrayType : namespace:name (http://www.w3.org/2001/XMLSchema:string)</td> <td>1</td> </tr> <tr> <td>string $name optional name</td> <td>1</td> </tr> <tr> <td>mixed $type optional type name</td> <td>1</td> </tr> <tr> <td>mixed $value optional value</td> <td>1</td> </tr> <tr> <td>mixed $element_ns optional namespace of value</td> <td>1</td> </tr> <tr> <td>mixed $type_ns optional namespace of type</td> <td>1</td> </tr> <tr> <td>mixed $attributes associative array of attributes to add to element serialization</td> <td>1</td> </tr> <tr> <td>string $use The WSDL use value (encoded|literal)</td> <td>1</td> </tr> <tr> <td>array $curl_options User-specified cURL options</td> <td>1</td> </tr> <tr> <td>boolean $use_curl Whether to try to force cURL use</td> <td>1</td> </tr> <tr> <td>string $value The value of the header</td> <td>1</td> </tr> <tr> <td>integer $connection_timeout set connection timeout in seconds</td> <td>1</td> </tr> <tr> <td>array $digestRequest (keys must be nonce, nc, realm, qop)</td> <td>1</td> </tr> <tr> <td>string $soapaction</td> <td>1</td> </tr> <tr> <td>string $enc encoding style. supported values: gzip, deflate, or both</td> <td>1</td> </tr> <tr> <td>string $proxyhost use an empty string to remove proxy</td> <td>1</td> </tr> <tr> <td>string $proxyauthtype (basic|ntlm)</td> <td>1</td> </tr> <tr> <td>string $data The string to check.</td> <td>1</td> </tr> <tr> <td>string $lb</td> <td>1</td> </tr> <tr> <td>string $data HTTP body</td> <td>1</td> </tr> <tr> <td>string $cookie_str data for HTTP Cookie header</td> <td>1</td> </tr> <tr> <td>string $type the content type, MIME style</td> <td>1</td> </tr> <tr> <td>mixed $charset character set used for encoding (or false)</td> <td>1</td> </tr> <tr> <td>string $cookie_str content of cookie</td> <td>1</td> </tr> <tr> <td>array $cookies array with all cookies</td> <td>1</td> </tr> <tr> <td>boolean $secure is the send-content secure or not?</td> <td>1</td> </tr> <tr> <td>mixed $wsdl file path or URL (string), or wsdl instance (object)</td> <td>1</td> </tr> <tr> <td>string $data usually is the value of $HTTP_RAW_POST_DATA</td> <td>1</td> </tr> <tr> <td>string $data XML string</td> <td>1</td> </tr> <tr> <td>string $operation The operation to be invoked</td> <td>1</td> </tr> <tr> <td>array $request The array of parameter values</td> <td>1</td> </tr> <tr> <td>string $data unprocessed request data from client</td> <td>1</td> </tr> <tr> <td>string $methodname</td> <td>1</td> </tr> <tr> <td>string $in array of input values</td> <td>1</td> </tr> <tr> <td>string $out array of output values</td> <td>1</td> </tr> <tr> <td>string $name the name of the PHP function, class.method or class..method</td> <td>1</td> </tr> <tr> <td>mixed $namespace the element namespace for the method or false</td> <td>1</td> </tr> <tr> <td>mixed $soapaction the soapaction for the method or false</td> <td>1</td> </tr> <tr> <td>mixed $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically</td> <td>1</td> </tr> <tr> <td>mixed $use optional (encoded|literal) or false</td> <td>1</td> </tr> <tr> <td>string $documentation optional Description to include in WSDL</td> <td>1</td> </tr> <tr> <td>string $customResponseTagName optional Name of the outgoing response, default $name . 'Response'</td> <td>1</td> </tr> <tr> <td>string $faultcode</td> <td>1</td> </tr> <tr> <td>string $faultstring</td> <td>1</td> </tr> <tr> <td>string $faultactor</td> <td>1</td> </tr> <tr> <td>string $faultdetail</td> <td>1</td> </tr> <tr> <td>string $serviceName , name of the service</td> <td>1</td> </tr> <tr> <td>mixed $namespace optional 'tns' service namespace or false</td> <td>1</td> </tr> <tr> <td>mixed $endpoint optional URL of service endpoint or false</td> <td>1</td> </tr> <tr> <td>string $style optional (rpc|document) WSDL style (also specified by operation)</td> <td>1</td> </tr> <tr> <td>string $transport optional SOAP transport</td> <td>1</td> </tr> <tr> <td>mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false</td> <td>1</td> </tr> <tr> <td>string $wsdl WSDL document URL</td> <td>1</td> </tr> <tr> <td>array $curl_options user-specified cURL options</td> <td>1</td> </tr> <tr> <td>boolean $use_curl try to use cURL</td> <td>1</td> </tr> <tr> <td>string $wsdl path or URL</td> <td>1</td> </tr> <tr> <td>string $portName WSDL port name</td> <td>1</td> </tr> <tr> <td>string $bindingType eg: soap, smtp, dime (only soap and soap12 are currently supported)</td> <td>1</td> </tr> <tr> <td>string $operation name of operation</td> <td>1</td> </tr> <tr> <td>string $soapAction soapAction for operation</td> <td>1</td> </tr> <tr> <td>string $type the type</td> <td>1</td> </tr> <tr> <td>string $ns namespace (not prefix) of the type</td> <td>1</td> </tr> <tr> <td>mixed $debug whether to put debug=1 in endpoint URL</td> <td>1</td> </tr> <tr> <td>string $type the type (element name) of the wrapper</td> <td>1</td> </tr> <tr> <td>array $parameters the parameter values for the SOAP call</td> <td>1</td> </tr> <tr> <td>string $bindingType (soap|soap12)</td> <td>1</td> </tr> <tr> <td>string $name name of value (part or element)</td> <td>1</td> </tr> <tr> <td>string $type XML schema type of value (type or element)</td> <td>1</td> </tr> <tr> <td>boolean $unqualified a kludge for what should be XML namespace form handling</td> <td>1</td> </tr> <tr> <td>string $phpType currently supported are array and struct (php assoc array)</td> <td>1</td> </tr> <tr> <td>array $elements e.g. array ( name => array(name=>'',type=>'') )</td> <td>1</td> </tr> <tr> <td>array $attrs e.g. array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))</td> <td>1</td> </tr> <tr> <td>string $arrayType as namespace:name (xsd:string)</td> <td>1</td> </tr> <tr> <td>string $name operation (method) name</td> <td>1</td> </tr> <tr> <td>string $namespace optional The namespace for the operation</td> <td>1</td> </tr> <tr> <td>string $soapaction optional The soapaction for the operation</td> <td>1</td> </tr> <tr> <td>string $style (rpc|document) optional The style for the operation Note: when 'document' is specified, parameter and return wrappers are created for you automatically</td> <td>1</td> </tr> <tr> <td>string $use (encoded|literal) optional The use for the parameters (cannot mix right now)</td> <td>1</td> </tr> <tr> <td>string $documentation optional The description to include in the WSDL</td> <td>1</td> </tr> <tr> <td>string $customResponseTagName optional Name of the outgoing response</td> <td>1</td> </tr> <tr> <td>string $xml SOAP message</td> <td>1</td> </tr> <tr> <td>string $encoding character encoding scheme of message</td> <td>1</td> </tr> <tr> <td>string $method method for which XML is parsed (unused?)</td> <td>1</td> </tr> <tr> <td>string $decode_utf8 whether to decode UTF-8 to ISO-8859-1</td> <td>1</td> </tr> <tr> <td>string $value value to decode</td> <td>1</td> </tr> <tr> <td>string $type XML type to decode</td> <td>1</td> </tr> <tr> <td>string $typens XML type namespace to decode</td> <td>1</td> </tr> <tr> <td>integer $pos position in node tree</td> <td>1</td> </tr> <tr> <td>mixed $endpoint SOAP server or WSDL URL (string), or wsdl instance (object)</td> <td>1</td> </tr> <tr> <td>mixed $wsdl optional, set to 'wsdl' or true if using WSDL</td> <td>1</td> </tr> <tr> <td>string $proxyhost optional</td> <td>1</td> </tr> <tr> <td>string $proxyport optional</td> <td>1</td> </tr> <tr> <td>string $proxyusername optional</td> <td>1</td> </tr> <tr> <td>string $proxypassword optional</td> <td>1</td> </tr> <tr> <td>string $portName optional portName in WSDL document</td> <td>1</td> </tr> <tr> <td>string $operation SOAP server URL or path</td> <td>1</td> </tr> <tr> <td>mixed $params An array, associative or simple, of the parameters</td> <td>1</td> </tr> <tr> <td>string $namespace optional method namespace (WSDL can override)</td> <td>1</td> </tr> <tr> <td>string $soapAction optional SOAPAction value (WSDL can override)</td> <td>1</td> </tr> <tr> <td>boolean $rpcParams optional (no longer used)</td> <td>1</td> </tr> <tr> <td>string $style optional (rpc|document) the style to use when serializing parameters (WSDL can override)</td> <td>1</td> </tr> <tr> <td>string $use optional (encoded|literal|literal wrapped) the use when serializing parameters (WSDL can override)</td> <td>1</td> </tr> <tr> <td>string $msg a SOAPx4 soapmsg object</td> <td>1</td> </tr> <tr> <td>string $soapaction SOAPAction value</td> <td>1</td> </tr> <tr> <td>string $data unprocessed response data from server</td> <td>1</td> </tr> <tr> <td>string $endpoint The endpoint URL to use, or empty string or false to prevent override</td> <td>1</td> </tr> <tr> <td>mixed $headers String of XML with SOAP header content, or array of soapval objects for SOAP headers</td> <td>1</td> </tr> <tr> <td>array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)</td> <td>1</td> </tr> <tr> <td>string $enc HTTP encoding</td> <td>1</td> </tr> <tr> <td>boolean $use Whether to try to use cURL</td> <td>1</td> </tr> <tr> <td>boolean $rpcParams</td> <td>1</td> </tr> <tr> <td>string $contentTypeNew</td> <td>1</td> </tr> <tr> <td>string $name Cookie Name</td> <td>1</td> </tr> <tr> <td>string $value Cookie Value</td> <td>1</td> </tr> <tr> <td>array $cookies new cookies with which to update current ones</td> <td>1</td> </tr> <tr> <td>string $cache_dir directory for cache-files</td> <td>1</td> </tr> <tr> <td>integer $cache_lifetime lifetime for caching-files in seconds or 0 for unlimited</td> <td>1</td> </tr> <tr> <td>string $mode The open-mode ("r" or "w") or the file - affects lock-mode</td> <td>1</td> </tr> <tr> <td>wsdl $wsdl_instance The wsdl instance to add</td> <td>1</td> </tr> <tr> <td>mixed $params Build parameters that change the way the email</td> <td>1</td> </tr> <tr> <td>string $name Parameter name</td> <td>1</td> </tr> <tr> <td>string $value Parameter value</td> <td>1</td> </tr> <tr> <td>string $name Parameter name</td> <td>1</td> </tr> <tr> <td>string $data Either a string or</td> <td>1</td> </tr> <tr> <td>bool $isfile If true the first param should be treated</td> <td>1</td> </tr> <tr> <td>bool $append If true the text or file is appended to</td> <td>1</td> </tr> <tr> <td>string $data Either a string or the file name with the</td> <td>1</td> </tr> <tr> <td>bool $isfile A flag that determines whether $data is a</td> <td>1</td> </tr> <tr> <td>string $file The image file name OR image data itself</td> <td>1</td> </tr> <tr> <td>string $c_type The content type</td> <td>1</td> </tr> <tr> <td>string $name The filename of the image.</td> <td>1</td> </tr> <tr> <td>bool $isfile Whether $file is a filename or not.</td> <td>1</td> </tr> <tr> <td>string $content_id Desired Content-ID of MIME part</td> <td>1</td> </tr> <tr> <td>string $file The file name of the file to attach</td> <td>1</td> </tr> <tr> <td>string $c_type The content type</td> <td>1</td> </tr> <tr> <td>string $name The filename of the attachment</td> <td>1</td> </tr> <tr> <td>bool $isfile Whether $file is a filename or not. Defaults to true</td> <td>1</td> </tr> <tr> <td>string $encoding The type of encoding to use. Defaults to base64.</td> <td>1</td> </tr> <tr> <td>string $disposition The content-disposition of this file</td> <td>1</td> </tr> <tr> <td>string $charset The character set of attachment's content.</td> <td>1</td> </tr> <tr> <td>string $language The language of the attachment</td> <td>1</td> </tr> <tr> <td>string $location The RFC 2557.4 location of the attachment</td> <td>1</td> </tr> <tr> <td>string $n_encoding Encoding of the attachment's name in Content-Type</td> <td>1</td> </tr> <tr> <td>string $f_encoding Encoding of the attachment's filename</td> <td>1</td> </tr> <tr> <td>string $description Content-Description header</td> <td>1</td> </tr> <tr> <td>string $h_charset The character set of the headers e.g. filename</td> <td>1</td> </tr> <tr> <td>array $add_headers Additional part headers. Array keys can be in form</td> <td>1</td> </tr> <tr> <td>string $file_name Path of file to process</td> <td>1</td> </tr> <tr> <td>mixed &$obj The object to add the part to, or</td> <td>1</td> </tr> <tr> <td>string $text The text to add.</td> <td>1</td> </tr> <tr> <td>array $value The image information</td> <td>1</td> </tr> <tr> <td>array $value The attachment information</td> <td>1</td> </tr> <tr> <td>string $separation The separation between these two parts.</td> <td>1</td> </tr> <tr> <td>array $params The Build parameters passed to the</td> <td>1</td> </tr> <tr> <td>array $headers The extra headers that should be passed</td> <td>1</td> </tr> <tr> <td>bool $overwrite Overwrite the existing headers with new.</td> <td>1</td> </tr> <tr> <td>array $params The Build parameters passed to the</td> <td>1</td> </tr> <tr> <td>string $filename Output file location</td> <td>1</td> </tr> <tr> <td>array $params The Build parameters passed to the</td> <td>1</td> </tr> <tr> <td>array $headers The extra headers that should be passed</td> <td>1</td> </tr> <tr> <td>bool $overwrite Overwrite the existing headers with new.</td> <td>1</td> </tr> <tr> <td>string $filename Output file location</td> <td>1</td> </tr> <tr> <td>array $params The Build parameters passed to the</td> <td>1</td> </tr> <tr> <td>array $params Build parameters that change the way the email</td> <td>1</td> </tr> <tr> <td>resource $filename Output file where to save the message instead of</td> <td>1</td> </tr> <tr> <td>boolean $skip_head True if you want to return/save only the message</td> <td>1</td> </tr> <tr> <td>bool $overwrite Overwrite already existing headers.</td> <td>1</td> </tr> <tr> <td>bool $overwrite Overwrite the existing headers with new.</td> <td>1</td> </tr> <tr> <td>string $type Type name</td> <td>1</td> </tr> <tr> <td>array $params Hash array of header parameters</td> <td>1</td> </tr> <tr> <td>string $subject String to set the subject to.</td> <td>1</td> </tr> <tr> <td>string $email The email address to use</td> <td>1</td> </tr> <tr> <td>string $recipients A comma-delimited list of recipients</td> <td>1</td> </tr> <tr> <td>array $input The header data to encode</td> <td>1</td> </tr> <tr> <td>array $params Extra build parameters</td> <td>1</td> </tr> <tr> <td>string $filename Filename</td> <td>1</td> </tr> <tr> <td>string $body The body of the mime part if any.</td> <td>1</td> </tr> <tr> <td>array $params An associative array of optional parameters:</td> <td>1</td> </tr> <tr> <td>string $boundary Pre-defined boundary string</td> <td>1</td> </tr> <tr> <td>string $filename Output file location</td> <td>1</td> </tr> <tr> <td>string $fh Output file handle</td> <td>1</td> </tr> <tr> <td>string $body The body of the subpart, if any.</td> <td>1</td> </tr> <tr> <td>array $params The parameters for the subpart, same</td> <td>1</td> </tr> <tr> <td>string $data The data to encode.</td> <td>1</td> </tr> <tr> <td>string $encoding The encoding type to use, 7bit, base64,</td> <td>1</td> </tr> <tr> <td>string $filename Data file location</td> <td>1</td> </tr> <tr> <td>string $encoding The encoding type to use, 7bit, base64,</td> <td>1</td> </tr> <tr> <td>resource $fh Output file handle. If set, data will be</td> <td>1</td> </tr> <tr> <td>string $input The data to encode</td> <td>1</td> </tr> <tr> <td>int $line_max Optional max line length. Should</td> <td>1</td> </tr> <tr> <td>string $name The name of the header-parameter</td> <td>1</td> </tr> <tr> <td>string $value The value of the paramter</td> <td>1</td> </tr> <tr> <td>string $charset The characterset of $value</td> <td>1</td> </tr> <tr> <td>string $language The language used in $value</td> <td>1</td> </tr> <tr> <td>string $encoding Parameter encoding. If not set, parameter value</td> <td>1</td> </tr> <tr> <td>int $maxLength The maximum length of a line. Defauls to 75</td> <td>1</td> </tr> <tr> <td>string $name The parameter name</td> <td>1</td> </tr> <tr> <td>string $value The parameter value</td> <td>1</td> </tr> <tr> <td>string $charset The parameter charset</td> <td>1</td> </tr> <tr> <td>string $encoding Encoding type (quoted-printable or base64)</td> <td>1</td> </tr> <tr> <td>int $maxLength Encoded parameter max length. Default: 76</td> <td>1</td> </tr> <tr> <td>string $eol End-of-line sequence. Default: "\r\n"</td> <td>1</td> </tr> <tr> <td>string $delimiter Delimiter expression string for preg_match()</td> <td>1</td> </tr> <tr> <td>string $string Input string</td> <td>1</td> </tr> <tr> <td>string $value The header data to encode</td> <td>1</td> </tr> <tr> <td>string $str String to encode</td> <td>1</td> </tr> <tr> <td>string $str String to encode</td> <td>1</td> </tr> <tr> <td>string $requestId the request's request ID</td> <td>1</td> </tr> <tr> <td>int $requestDuration the request's duration in milliseconds</td> <td>1</td> </tr> <tr> <td>array<string, mixed>|string $config the API key as a string, or an array containing</td> <td>1</td> </tr> <tr> <td>callable $readBodyChunkCallable a function that will be called</td> <td>1</td> </tr> <tr> <td>array<string, mixed> $config</td> <td>1</td> </tr> <tr> <td>null|string $id the ID of the resource</td> <td>1</td> </tr> <tr> <td>string $header the contents of the signature header sent by</td> <td>1</td> </tr> <tr> <td>string $scheme the signature scheme to look for</td> <td>1</td> </tr> <tr> <td>string $payload the payload to sign</td> <td>1</td> </tr> <tr> <td>string $secret the secret used to generate the signature</td> <td>1</td> </tr> <tr> <td>null|array|string $id the ID of the account to retrieve, or an</td> <td>1</td> </tr> <tr> <td>null|array $clientId</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to retrieve the capabilities</td> <td>1</td> </tr> <tr> <td>string $capabilityId the ID of the capability to retrieve</td> <td>1</td> </tr> <tr> <td>string $capabilityId the ID of the capability to update</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to retrieve the external accounts</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to create the external account</td> <td>1</td> </tr> <tr> <td>string $externalAccountId the ID of the external account to delete</td> <td>1</td> </tr> <tr> <td>string $externalAccountId the ID of the external account to retrieve</td> <td>1</td> </tr> <tr> <td>string $externalAccountId the ID of the external account to update</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to create the login link</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to create the person</td> <td>1</td> </tr> <tr> <td>string $id the ID of the account on which to retrieve the persons</td> <td>1</td> </tr> <tr> <td>string $personId the ID of the person to delete</td> <td>1</td> </tr> <tr> <td>string $personId the ID of the person to retrieve</td> <td>1</td> </tr> <tr> <td>string $personId the ID of the person to update</td> <td>1</td> </tr> <tr> <td>null|string $id the ID of the subscription item on which to create the usage record</td> <td>1</td> </tr> <tr> <td>string $id the ID of the subscription item on which to retrieve the usage record summaries</td> <td>1</td> </tr> <tr> <td>null|string $apiKey</td> <td>1</td> </tr> <tr> <td>null|string $apiBase</td> <td>1</td> </tr> <tr> <td>RequestTelemetry $requestTelemetry</td> <td>1</td> </tr> <tr> <td>ApiResource|array|bool|mixed $d</td> <td>1</td> </tr> <tr> <td>string $rbody a JSON string</td> <td>1</td> </tr> <tr> <td>array $rheaders</td> <td>1</td> </tr> <tr> <td>array $resp</td> <td>1</td> </tr> <tr> <td>array $resp</td> <td>1</td> </tr> <tr> <td>array $errorData</td> <td>1</td> </tr> <tr> <td>bool|string $rbody</td> <td>1</td> </tr> <tr> <td>int $rcode</td> <td>1</td> </tr> <tr> <td>array $rheaders</td> <td>1</td> </tr> <tr> <td>array $resp</td> <td>1</td> </tr> <tr> <td>string $errorCode</td> <td>1</td> </tr> <tr> <td>null|array $appInfo</td> <td>1</td> </tr> <tr> <td>string $disableFunctionsOutput - String value of the 'disable_function' setting, as output by \ini_get('disable_functions')</td> <td>1</td> </tr> <tr> <td>string $functionName - Name of the function we are interesting in seeing whether or not it is disabled</td> <td>1</td> </tr> <tr> <td>null $clientInfo</td> <td>1</td> </tr> <tr> <td>resource $resource</td> <td>1</td> </tr> <tr> <td>HttpClient\ClientInterface $client</td> <td>1</td> </tr> <tr> <td>HttpClient\StreamingClientInterface $client</td> <td>1</td> </tr> <tr> <td>string $id the ID of the transfer on which to create the transfer reversal</td> <td>1</td> </tr> <tr> <td>string $id the ID of the transfer on which to retrieve the transfer reversals</td> <td>1</td> </tr> <tr> <td>string $reversalId the ID of the transfer reversal to retrieve</td> <td>1</td> </tr> <tr> <td>string $reversalId the ID of the transfer reversal to update</td> <td>1</td> </tr> <tr> <td>bool $dirty defaults to true</td> <td>1</td> </tr> <tr> <td>bool $force defaults to false</td> <td>1</td> </tr> <tr> <td>ApiResponse $resp</td> <td>1</td> </tr> <tr> <td>string $id the ID of the credit note on which to retrieve the credit note line items</td> <td>1</td> </tr> <tr> <td>string $payment_method</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to retrieve the customer balance transactions</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to create the customer balance transaction</td> <td>1</td> </tr> <tr> <td>string $balanceTransactionId the ID of the customer balance transaction to retrieve</td> <td>1</td> </tr> <tr> <td>string $balanceTransactionId the ID of the customer balance transaction to update</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer to which the customer cash balance transaction belongs</td> <td>1</td> </tr> <tr> <td>string $cashBalanceTransactionId the ID of the customer cash balance transaction to retrieve</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to retrieve the customer cash balance transactions</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to create the payment source</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to retrieve the payment sources</td> <td>1</td> </tr> <tr> <td>string $sourceId the ID of the payment source to delete</td> <td>1</td> </tr> <tr> <td>string $sourceId the ID of the payment source to retrieve</td> <td>1</td> </tr> <tr> <td>string $sourceId the ID of the payment source to update</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to retrieve the tax ids</td> <td>1</td> </tr> <tr> <td>string $id the ID of the customer on which to create the tax id</td> <td>1</td> </tr> <tr> <td>string $taxIdId the ID of the tax id to delete</td> <td>1</td> </tr> <tr> <td>string $taxIdId the ID of the tax id to retrieve</td> <td>1</td> </tr> <tr> <td>string $sigHeader the contents of the signature header sent by</td> <td>1</td> </tr> <tr> <td>null|array|CaseInsensitiveArray $headers</td> <td>1</td> </tr> <tr> <td>null|array $json</td> <td>1</td> </tr> <tr> <td>string $id the ID of the invoice on which to retrieve the line items</td> <td>1</td> </tr> <tr> <td>\Psr\Log\LoggerInterface|Util\LoggerInterface $logger the logger to which the library</td> <td>1</td> </tr> <tr> <td>string $clientId</td> <td>1</td> </tr> <tr> <td>string $apiVersion the API version to use for requests</td> <td>1</td> </tr> <tr> <td>string $caBundlePath</td> <td>1</td> </tr> <tr> <td>bool $verify</td> <td>1</td> </tr> <tr> <td>null|string $accountId the Stripe account ID to set for connected</td> <td>1</td> </tr> <tr> <td>string $appName The application's name</td> <td>1</td> </tr> <tr> <td>null|string $appVersion The application's version</td> <td>1</td> </tr> <tr> <td>null|string $appUrl The application's URL</td> <td>1</td> </tr> <tr> <td>null|string $appPartnerId The application's partner ID</td> <td>1</td> </tr> <tr> <td>int $maxNetworkRetries Maximum number of request retries</td> <td>1</td> </tr> <tr> <td>bool $enableTelemetry Enables client telemetry.</td> <td>1</td> </tr> <tr> <td>string $id the ID of the application fee on which to create the fee refund</td> <td>1</td> </tr> <tr> <td>string $id the ID of the application fee on which to retrieve the fee refunds</td> <td>1</td> </tr> <tr> <td>string $refundId the ID of the fee refund to retrieve</td> <td>1</td> </tr> <tr> <td>string $refundId the ID of the fee refund to update</td> <td>1</td> </tr> <tr> <td>string $id the ID of the resource to update</td> <td>1</td> </tr> <tr> <td>string $searchUrl</td> <td>1</td> </tr> <tr> <td>null|array|mixed $params The list of parameters to validate</td> <td>1</td> </tr> <tr> <td>callable $readBodyChunkCallable a function that will be called with chunks of bytes from the body if the request is successful</td> <td>1</td> </tr> <tr> <td>null|array|callable $defaultOptions</td> <td>1</td> </tr> <tr> <td>null|\Stripe\Util\RandomGenerator $randomGenerator</td> <td>1</td> </tr> <tr> <td>null|callable $requestStatusCallback</td> <td>1</td> </tr> <tr> <td>callable $determineWriteCallback</td> <td>1</td> </tr> <tr> <td>callable $readBodyChunk</td> <td>1</td> </tr> <tr> <td>string[] $headers</td> <td>1</td> </tr> <tr> <td>null|string $key</td> <td>1</td> </tr> <tr> <td>array<string, string> $headers</td> <td>1</td> </tr> <tr> <td>null|string $base</td> <td>1</td> </tr> <tr> <td>array $resp the response from the Stripe API</td> <td>1</td> </tr> <tr> <td>array|mixed $array</td> <td>1</td> </tr> <tr> <td>mixed|string $value a string to UTF8-encode</td> <td>1</td> </tr> <tr> <td>string $a one of the strings to compare</td> <td>1</td> </tr> <tr> <td>string $b the other string to compare</td> <td>1</td> </tr> <tr> <td>mixed $h</td> <td>1</td> </tr> <tr> <td>null|string $parentKey</td> <td>1</td> </tr> <tr> <td>string $calculatedKey</td> <td>1</td> </tr> <tr> <td>string $key a string to URL-encode</td> <td>1</td> </tr> <tr> <td>float $max (optional)</td> <td>1</td> </tr> <tr> <td>null|string $id</td> <td>1</td> </tr> <tr> <td>null|array|StripeUtilRequestOptions $opts</td> <td>1</td> </tr> <tr> <td>null|string $sigHeader the `Stripe-Signature` HTTP header</td> <td>1</td> </tr> <tr> <td>null|string $sigHeader</td> <td>1</td> </tr> <tr> <td>null|\Stripe\ErrorObject $error</td> <td>1</td> </tr> <tr> <td>null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders</td> <td>1</td> </tr> <tr> <td>null|int $httpStatus</td> <td>1</td> </tr> <tr> <td>null|array<string, mixed> $jsonBody</td> <td>1</td> </tr> <tr> <td>null|string $requestId</td> <td>1</td> </tr> <tr> <td>null|string $stripeCode</td> <td>1</td> </tr> <tr> <td>null|string $declineCode the decline code</td> <td>1</td> </tr> <tr> <td>null|string $declineCode</td> <td>1</td> </tr> <tr> <td>array $request Request data</td> <td>1</td> </tr> <tr> <td>bool $echo</td> <td>1</td> </tr> <tr> <td>bool $sendHeader</td> <td>1</td> </tr> <tr> <td>DebugBar $debugBar</td> <td>1</td> </tr> <tr> <td>RequestIdGeneratorInterface $generator</td> <td>1</td> </tr> <tr> <td>StorageInterface $storage</td> <td>1</td> </tr> <tr> <td>HttpDriverInterface $driver</td> <td>1</td> </tr> <tr> <td>bool $useOpenHandler</td> <td>1</td> </tr> <tr> <td>boolean $delete Whether to delete the data in the session</td> <td>1</td> </tr> <tr> <td>string $ns</td> <td>1</td> </tr> <tr> <td>\DebugBar\DebugBar $debugBar</td> <td>1</td> </tr> <tr> <td>array $options [description]</td> <td>1</td> </tr> <tr> <td>string $name "jquery", "fontawesome", "highlightjs"</td> <td>1</td> </tr> <tr> <td>integer $init</td> <td>1</td> </tr> <tr> <td>boolean $autoShow</td> <td>1</td> </tr> <tr> <td>string|null $nonce</td> <td>1</td> </tr> <tr> <td>array $cssFiles An array of filenames</td> <td>1</td> </tr> <tr> <td>array $jsFiles An array of filenames</td> <td>1</td> </tr> <tr> <td>string $basePath Base path of those files</td> <td>1</td> </tr> <tr> <td>string $baseUrl Base url of those files</td> <td>1</td> </tr> <tr> <td>array $inlineCss An array map of content ID to inline CSS content (not including <style> tag)</td> <td>1</td> </tr> <tr> <td>array $inlineJs An array map of content ID to inline JS content (not including <script> tag)</td> <td>1</td> </tr> <tr> <td>array $inlineHead An array map of content ID to arbitrary inline HTML content (typically</td> <td>1</td> </tr> <tr> <td>string $relativeTo The type of path to which filenames must be relative (path, url or null)</td> <td>1</td> </tr> <tr> <td>string $relativeTo</td> <td>1</td> </tr> <tr> <td>string|array $uri</td> <td>1</td> </tr> <tr> <td>string $root</td> <td>1</td> </tr> <tr> <td>string $type Optionally return only 'css', 'js', or 'inline_head' collection</td> <td>1</td> </tr> <tr> <td>array|null $files Array of asset filenames.</td> <td>1</td> </tr> <tr> <td>array|null $content Array of inline asset content.</td> <td>1</td> </tr> <tr> <td>array|null $files Filenames containing assets</td> <td>1</td> </tr> <tr> <td>array|null $content Inline content to dump</td> <td>1</td> </tr> <tr> <td>bool $useRequireJs</td> <td>1</td> </tr> <tr> <td>boolean $here</td> <td>1</td> </tr> <tr> <td>boolean $initialize</td> <td>1</td> </tr> <tr> <td>boolean $renderStackedData</td> <td>1</td> </tr> <tr> <td>boolean $initialize Whether or not to render the debug bar initialization code</td> <td>1</td> </tr> <tr> <td>boolean $renderStackedData Whether or not to render the stacked data</td> <td>1</td> </tr> <tr> <td>string $varname Debug bar's variable name</td> <td>1</td> </tr> <tr> <td>string $requestId</td> <td>1</td> </tr> <tr> <td>mixed $suffix</td> <td>1</td> </tr> <tr> <td>float $requestStartTime</td> <td>1</td> </tr> <tr> <td>string $name Internal name, used to stop the measure</td> <td>1</td> </tr> <tr> <td>string|null $label Public name</td> <td>1</td> </tr> <tr> <td>string|null $collector The source of the collector</td> <td>1</td> </tr> <tr> <td>float $start</td> <td>1</td> </tr> <tr> <td>float $end</td> <td>1</td> </tr> <tr> <td>\Closure $closure</td> <td>1</td> </tr> <tr> <td>string $mergeProperty</td> <td>1</td> </tr> <tr> <td>boolean $sort</td> <td>1</td> </tr> <tr> <td>bool|string $sort</td> <td>1</td> </tr> <tr> <td>int $line</td> <td>1</td> </tr> <tr> <td>string $xdebugLinkTemplate</td> <td>1</td> </tr> <tr> <td>bool $shouldUseAjax</td> <td>1</td> </tr> <tr> <td>array $xdebugReplacements</td> <td>1</td> </tr> <tr> <td>bool $realUsage</td> <td>1</td> </tr> <tr> <td>mixed $message</td> <td>1</td> </tr> <tr> <td>MessagesAggregateInterface $messages</td> <td>1</td> </tr> <tr> <td>$level</td> <td>1</td> </tr> <tr> <td>bool $chainExceptions</td> <td>1</td> </tr> <tr> <td>mixed $column Number of the column (1-indexed) or name of the column in the result set</td> <td>1</td> </tr> <tr> <td>mixed $param Name of the PHP variable to which the column will be bound.</td> <td>1</td> </tr> <tr> <td>int $type [optional] Data type of the parameter, specified by the PDO::PARAM_*</td> <td>1</td> </tr> <tr> <td>int $maxlen [optional] A hint for pre-allocation.</td> <td>1</td> </tr> <tr> <td>mixed $driverdata [optional] Optional parameter(s) for the driver.</td> <td>1</td> </tr> <tr> <td>mixed $variable Name of the PHP variable to bind to the SQL statement parameter.</td> <td>1</td> </tr> <tr> <td>int $data_type [optional] Explicit data type for the parameter using the PDO::PARAM_*</td> <td>1</td> </tr> <tr> <td>int $length [optional] Length of the data type. To indicate that a parameter is an OUT</td> <td>1</td> </tr> <tr> <td>mixed $driver_options [optional]</td> <td>1</td> </tr> <tr> <td>mixed $value The value to bind to the parameter.</td> <td>1</td> </tr> <tr> <td>int $data_type [optional] Explicit data type for the parameter using the PDO::PARAM_*</td> <td>1</td> </tr> <tr> <td>array $input_parameters [optional] An array of values with as many elements as there</td> <td>1</td> </tr> <tr> <td>\PDO $pdo</td> <td>1</td> </tr> <tr> <td>string $name Optional connection name</td> <td>1</td> </tr> <tr> <td>string|null $connectionName the pdo connection (eg default | read | write)</td> <td>1</td> </tr> <tr> <td>string $statement</td> <td>1</td> </tr> <tr> <td>int $attribute One of the PDO::ATTR_* constants</td> <td>1</td> </tr> <tr> <td>string $name [optional]</td> <td>1</td> </tr> <tr> <td>string $statement This must be a valid SQL statement template for the target DB server.</td> <td>1</td> </tr> <tr> <td>array $driver_options [optional] This array holds one or more key=>value pairs to</td> <td>1</td> </tr> <tr> <td>string $statement</td> <td>1</td> </tr> <tr> <td>int $fetchMode</td> <td>1</td> </tr> <tr> <td>mixed ...$fetchModeArgs</td> <td>1</td> </tr> <tr> <td>string $string The string to be quoted.</td> <td>1</td> </tr> <tr> <td>int $parameter_type [optional] Provides a data type hint for drivers that have</td> <td>1</td> </tr> <tr> <td>int $attribute</td> <td>1</td> </tr> <tr> <td>TracedStatement $stmt</td> <td>1</td> </tr> <tr> <td>$args</td> <td>1</td> </tr> <tr> <td>null|string $preparedId</td> <td>1</td> </tr> <tr> <td>null $startTime</td> <td>1</td> </tr> <tr> <td>null $startMemory</td> <td>1</td> </tr> <tr> <td>\Exception|null $exception</td> <td>1</td> </tr> <tr> <td>int $rowCount</td> <td>1</td> </tr> <tr> <td>float $endTime</td> <td>1</td> </tr> <tr> <td>int $endMemory</td> <td>1</td> </tr> <tr> <td>string $quotationChar</td> <td>1</td> </tr> <tr> <td>LoggerInterface $logger A logger to forward non-query log lines to</td> <td>1</td> </tr> <tr> <td>PropelPDO $conn Bound this collector to a connection only</td> <td>1</td> </tr> <tr> <td>PropelConfiguration $config Apply profiling on a specific config</td> <td>1</td> </tr> <tr> <td>Cache|null $cache</td> <td>1</td> </tr> <tr> <td>Logger|null $logger</td> <td>1</td> </tr> <tr> <td>bool $level</td> <td>1</td> </tr> <tr> <td>bool $bubble</td> <td>1</td> </tr> <tr> <td>Cache $cache</td> <td>1</td> </tr> <tr> <td>Profile $profile</td> <td>1</td> </tr> <tr> <td>LoaderInterface|Environment $loaderOrEnv</td> <td>1</td> </tr> <tr> <td>$debugStackOrEntityManager</td> <td>1</td> </tr> <tr> <td>ConnectionInterface $connection Propel connection</td> <td>1</td> </tr> <tr> <td>array $records</td> <td>1</td> </tr> <tr> <td>boolean $bubble</td> <td>1</td> </tr> <tr> <td>array|\Monolog\LogRecord $record</td> <td>1</td> </tr> <tr> <td>\Twig_Profiler_Profile $profile</td> <td>1</td> </tr> <tr> <td>\Twig_LoaderInterface|\Twig_Environment $loaderOrEnv</td> <td>1</td> </tr> <tr> <td>Twig_Environment $twig</td> <td>1</td> </tr> <tr> <td>TimeDataCollector $timeDataCollector</td> <td>1</td> </tr> <tr> <td>TraceableTwigEnvironment $env</td> <td>1</td> </tr> <tr> <td>Twig_Template $template</td> <td>1</td> </tr> <tr> <td>\DebugBar\DataCollector\TimeDataCollector $timeDataCollector</td> <td>1</td> </tr> <tr> <td>\PDO $pdo The PDO instance</td> <td>1</td> </tr> <tr> <td>string $tableName</td> <td>1</td> </tr> <tr> <td>array $sqlQueries</td> <td>1</td> </tr> <tr> <td>array $queries</td> <td>1</td> </tr> <tr> <td>array $vars</td> <td>1</td> </tr> <tr> <td>integer $max</td> <td>1</td> </tr> <tr> <td>integer $offset</td> <td>1</td> </tr> <tr> <td>Memcached $memcached</td> <td>1</td> </tr> <tr> <td>string $keyNamespace Namespace for Memcached key names (to avoid conflict with other Memcached users).</td> <td>1</td> </tr> <tr> <td>int $expiration Expiration for Memcached entries (see Expiration Times in Memcached documentation).</td> <td>1</td> </tr> <tr> <td>array $keys</td> <td>1</td> </tr> <tr> <td>int $flags</td> <td>1</td> </tr> <tr> <td>\Predis\Client|\Redis $redis Redis Client</td> <td>1</td> </tr> <tr> <td>string $dirname Directories where to store files</td> <td>1</td> </tr> <tr> <td>integer $precision</td> <td>1</td> </tr> <tr> <td>mixed $data The variable to capture.</td> <td>1</td> </tr> <tr> <td>string $capturedData Captured data from captureVar.</td> <td>1</td> </tr> <tr> <td>array $seekPath Pass an array of keys to traverse if you only want to render a subset</td> <td>1</td> </tr> <tr> <td>mixed $data The variable to capture and render.</td> <td>1</td> </tr> <tr> <td>Data $data</td> <td>1</td> </tr> <tr> <td>string $url Root URL for the shop</td> <td>1</td> </tr> <tr> <td>string $key Authentication key</td> <td>1</td> </tr> <tr> <td>mixed $debug Debug mode Activated (true) or deactivated (false)</td> <td>1</td> </tr> <tr> <td>array $request Response elements of CURL request</td> <td>1</td> </tr> <tr> <td>string $url Resource name</td> <td>1</td> </tr> <tr> <td>mixed $curl_params CURL parameters (sent to curl_set_opt)</td> <td>1</td> </tr> <tr> <td>string $title Title</td> <td>1</td> </tr> <tr> <td>string $content Content</td> <td>1</td> </tr> <tr> <td>string $response String from a CURL response</td> <td>1</td> </tr> <tr> <td>array $options Options</td> <td>1</td> </tr> <tr> <td>array $options Array representing resource to get.</td> <td>1</td> </tr> <tr> <td>array $options Array representing resource for head request.</td> <td>1</td> </tr> <tr> <td>array $options Array representing resource to edit.</td> <td>1</td> </tr> <tr> <td>array $options Array representing resource to delete.</td> <td>1</td> </tr> <tr> <td>boolean $debug Enable debug of request on screen</td> <td>1</td> </tr> <tr> <td>array $options Options. If 'categorie' is defined, we filter products on this category id</td> <td>1</td> </tr> <tr> <td>int $parent Id of parent category</td> <td>1</td> </tr> <tr> <td>string $text symbol previous</td> <td>1</td> </tr> <tr> <td>string $text symbol next</td> <td>1</td> </tr> <tr> <td>string $v1 version 1</td> <td>1</td> </tr> <tr> <td>string $v2 version 2</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext to get</td> <td>1</td> </tr> <tr> <td>int $loadresources 1=Load also resources</td> <td>1</td> </tr> <tr> <td>User $user User making the delete</td> <td>1</td> </tr> <tr> <td>int $maxlength Not use here just for declaration method compatibility with parent classes</td> <td>1</td> </tr> <tr> <td>string $classname Not use here just for declaration method compatibility with parent classes</td> <td>1</td> </tr> <tr> <td>int $overwritepicto Not use here just for declaration method compatibility with parent classes</td> <td>1</td> </tr> <tr> <td>int $hidenastatus Not use here just for declaration method compatibility with parent classes</td> <td>1</td> </tr> <tr> <td>int $id Object id</td> <td>1</td> </tr> <tr> <td>string $ref Object ref</td> <td>1</td> </tr> <tr> <td>string $action Action string</td> <td>1</td> </tr> <tr> <td>int $id Id of third party to load</td> <td>1</td> </tr> <tr> <td>string $email Email of third party to load</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of third party to load</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>int $mode Set to 1 to show only customers</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "((t.nom:like:'TheCompany%') or (t.name_alias:like:'TheCompany%')) and (t.datec:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $id Id of thirdparty to update</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id ID of thirdparty to keep (the target third party)</td> <td>1</td> </tr> <tr> <td>int $idtodelete ID of thirdparty to remove (the thirdparty to delete), once data has been merged into the target third party.</td> <td>1</td> </tr> <tr> <td>int $id Thirdparty ID</td> <td>1</td> </tr> <tr> <td>int $id ID of thirdparty</td> <td>1</td> </tr> <tr> <td>int $priceLevel Price level to apply to thirdparty</td> <td>1</td> </tr> <tr> <td>int $mode 0=Array with properties, 1=Array of id.</td> <td>1</td> </tr> <tr> <td>int $id ID of the thirdparty</td> <td>1</td> </tr> <tr> <td>string $filter Filter exceptional discount. "none" will return every discount, "available" returns unapplied discounts, "used" returns applied discounts {@choice none,available,used}</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $notification_id ID of CompanyNotification</td> <td>1</td> </tr> <tr> <td>int $notification_id ID of CompanyNotification</td> <td>1</td> </tr> <tr> <td>int $bankaccount_id ID of CompanyBankAccount</td> <td>1</td> </tr> <tr> <td>int $bankaccount_id ID of CompanyBankAccount</td> <td>1</td> </tr> <tr> <td>int $id Thirdparty id</td> <td>1</td> </tr> <tr> <td>int $companybankid Companybank id</td> <td>1</td> </tr> <tr> <td>string $model Model of document to generate</td> <td>1</td> </tr> <tr> <td>string $site Site key</td> <td>1</td> </tr> <tr> <td>array $request_data Request data</td> <td>1</td> </tr> <tr> <td>int $site Site key</td> <td>1</td> </tr> <tr> <td>int $rowid Id of third party to load (Use 0 to get a specimen record, use null to use other search criteria)</td> <td>1</td> </tr> <tr> <td>string $ref Reference of third party, name (Warning, this can return several records)</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of third party (Warning, this information is a free field not provided by Dolibarr)</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of third party to load</td> <td>1</td> </tr> <tr> <td>string $email Email of third party (Warning, this can return several records)</td> <td>1</td> </tr> <tr> <td>string $ref_alias Name_alias of third party (Warning, this can return several records)</td> <td>1</td> </tr> <tr> <td>string $site Site (example: 'stripe', '...')</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>string $id Id of customer in external system (example: 'cu_xxxxxxxxxxxxx', ...)</td> <td>1</td> </tr> <tr> <td>string $site Site (example: 'stripe', '...')</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>int $id ID of contact</td> <td>1</td> </tr> <tr> <td>string $email Email of contact</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter contacts of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $includecount Count and return also number of elements the contact is used as a link for</td> <td>1</td> </tr> <tr> <td>int $includeroles Includes roles of the contact</td> <td>1</td> </tr> <tr> <td>int $id Id of contact to update</td> <td>1</td> </tr> <tr> <td>int $id Contact ID</td> <td>1</td> </tr> <tr> <td>int $id Id of contact</td> <td>1</td> </tr> <tr> <td>int $id ID of contact</td> <td>1</td> </tr> <tr> <td>int $id Id of contact</td> <td>1</td> </tr> <tr> <td>int $category_id Id of category</td> <td>1</td> </tr> <tr> <td>int $id Id of contact</td> <td>1</td> </tr> <tr> <td>string[]|null $data Data to validate</td> <td>1</td> </tr> <tr> <td>int $socid Id of company. If this is filled, function will return the first entry found (matching $default and $type)</td> <td>1</td> </tr> <tr> <td>int $default If id of company filled, we say if we want first record among all (-1), default record (1) or non default record (0)</td> <td>1</td> </tr> <tr> <td>int $rib RIB id</td> <td>1</td> </tr> <tr> <td>string $resetolddefaultfor Reset if we have already a default value for type = 'ban'</td> <td>1</td> </tr> <tr> <td>int $socid Id of company to get first default payment mode</td> <td>1</td> </tr> <tr> <td>string $type Filter on type ('ban', 'card', ...)</td> <td>1</td> </tr> <tr> <td>string $morewhere More SQL filters (' AND ...')</td> <td>1</td> </tr> <tr> <td>int $id Payment mode ID</td> <td>1</td> </tr> <tr> <td>int $alltypes 1=The default is for all payment types instead of per type</td> <td>1</td> </tr> <tr> <td>User $user Object of user that ask creation</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $no_email 1=Do not send mailing, 0=Ok to receive mailing</td> <td>1</td> </tr> <tr> <td>array $tags Array of tag to affect to contact</td> <td>1</td> </tr> <tr> <td>int $id Id of company (deprecated, use 0 here and call update on an object loaded by a fetch)</td> <td>1</td> </tr> <tr> <td>User $user User who requests the update</td> <td>1</td> </tr> <tr> <td>int $allowmodcodeclient Inclut modif code client et code compta</td> <td>1</td> </tr> <tr> <td>int $allowmodcodefournisseur Inclut modif code fournisseur et code compta fournisseur</td> <td>1</td> </tr> <tr> <td>string $action 'add' or 'update' or 'merge'</td> <td>1</td> </tr> <tr> <td>int $nosyncmember Do not synchronize info of linked member</td> <td>1</td> </tr> <tr> <td>int $is_client Only client third party</td> <td>1</td> </tr> <tr> <td>int $is_supplier Only supplier third party</td> <td>1</td> </tr> <tr> <td>int $id Id of third party to delete</td> <td>1</td> </tr> <tr> <td>User|null $fuser User who ask to delete thirdparty</td> <td>1</td> </tr> <tr> <td>int $call_trigger 0=No, 1=yes</td> <td>1</td> </tr> <tr> <td>float $remise Amount of discount</td> <td>1</td> </tr> <tr> <td>User $user User adding discount</td> <td>1</td> </tr> <tr> <td>string $desc Reason of discount</td> <td>1</td> </tr> <tr> <td>string $vatrate VAT rate (may contain the vat code too). Example: '1.23', '1.23 (ABC)', ...</td> <td>1</td> </tr> <tr> <td>int $discount_type 0 => customer discount, 1 => supplier discount</td> <td>1</td> </tr> <tr> <td>string $price_base_type Price base type 'HT' or 'TTC'</td> <td>1</td> </tr> <tr> <td>?User $user Filter on a user author of discounts</td> <td>1</td> </tr> <tr> <td>string $filter Other filter</td> <td>1</td> </tr> <tr> <td>int $maxvalue Filter on max value for discount</td> <td>1</td> </tr> <tr> <td>int<0,1> $discount_type 0 => customer discount, 1 => supplier discount</td> <td>1</td> </tr> <tr> <td>User $user Object user (not used)</td> <td>1</td> </tr> <tr> <td>int $mode 0=Array with properties, 1=Array of IDs.</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order, separated by comma. Example: 'ASC,DESC';</td> <td>1</td> </tr> <tr> <td>int $price_level Level of price</td> <td>1</td> </tr> <tr> <td>User $user Use making change</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)</td> <td>1</td> </tr> <tr> <td>string $option Target of link ('', 'customer', 'prospect', 'supplier', 'project')</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $noaliasinname 1=Do not add alias into the link ref</td> <td>1</td> </tr> <tr> <td>string $target add attribute target</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)</td> <td>1</td> </tr> <tr> <td>string $option ''=All</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $tag Tag 'a' or 'span'</td> <td>1</td> </tr> <tr> <td>int $addthirdparty 1=Add also a record for thirdparty email, 2=Same than 1 but add text ThirdParty in grey</td> <td>1</td> </tr> <tr> <td>string $mode 'email' or 'mobile'</td> <td>1</td> </tr> <tr> <td>int $hidedisabled 1=Hide contact if disabled</td> <td>1</td> </tr> <tr> <td>string $mode 'email' or 'mobile'</td> <td>1</td> </tr> <tr> <td>string $mode 'label' or 'rum' or 'format'</td> <td>1</td> </tr> <tr> <td>int $type Should be 0 to say customer</td> <td>1</td> </tr> <tr> <td>int $type Should be 1 to say supplier</td> <td>1</td> </tr> <tr> <td>string $type Type of thirdparty ('customer' or 'supplier')</td> <td>1</td> </tr> <tr> <td>int $id Id of thirdparty to set or '' to remove</td> <td>1</td> </tr> <tr> <td>int $idparent Id of thirdparty to check</td> <td>1</td> </tr> <tr> <td>int $idchild Id of thirdparty to compare to</td> <td>1</td> </tr> <tr> <td>int $counter Counter to protect against infinite loops</td> <td>1</td> </tr> <tr> <td>int $company_id ID of company to search parent</td> <td>1</td> </tr> <tr> <td>array $parents List of companies ID found</td> <td>1</td> </tr> <tr> <td>int $idprof 1,2,3,4,5,6 (Example: 1=siren, 2=siret, 3=naf, 4=rcs/rm, 5=eori, 6=idprof6)</td> <td>1</td> </tr> <tr> <td>string $idprof 'idprof1','idprof2','idprof3','idprof4','idprof5','idprof6','email' (Example: idprof1=siren, idprof2=siret, idprof3=naf, idprof4=rcs/rm)</td> <td>1</td> </tr> <tr> <td>string $value Value of profid</td> <td>1</td> </tr> <tr> <td>int $socid Id of thirdparty to exclude (if update)</td> <td>1</td> </tr> <tr> <td>int $idprof 1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm)</td> <td>1</td> </tr> <tr> <td>Societe $soc Object societe</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Object thirdparty</td> <td>1</td> </tr> <tr> <td>int $id Id of thirdparty to load</td> <td>1</td> </tr> <tr> <td>int $categorie_id Id of category</td> <td>1</td> </tr> <tr> <td>Adherent $member Object member</td> <td>1</td> </tr> <tr> <td>string $socname Name of third party to force</td> <td>1</td> </tr> <tr> <td>string $socalias Alias name of third party to force</td> <td>1</td> </tr> <tr> <td>string $customercode Customer code</td> <td>1</td> </tr> <tr> <td>Conf $conf Conf object (possibility to use another entity)</td> <td>1</td> </tr> <tr> <td>int $localTaxNum To get info for only localtax1 or localtax2</td> <td>1</td> </tr> <tr> <td>int|string $status Id or code for prospection status</td> <td>1</td> </tr> <tr> <td>string $mode 'customer' or 'supplier'</td> <td>1</td> </tr> <tr> <td>int $late 0 => all invoice, 1=> only late</td> <td>1</td> </tr> <tr> <td>int $status Id of prospection status</td> <td>1</td> </tr> <tr> <td>string $modele Generator to use. Caller must set it to obj->model_pdf.</td> <td>1</td> </tr> <tr> <td>string $type_categ Category type ('customer' or 'supplier')</td> <td>1</td> </tr> <tr> <td>int[]|int $salesrep User ID or array of user IDs</td> <td>1</td> </tr> <tr> <td>bool $onlyAdd Only add (no delete before)</td> <td>1</td> </tr> <tr> <td>int $typent_id third party type rowid in llx_c_typent</td> <td>1</td> </tr> <tr> <td>int $origin_id Old thirdparty id (will be removed)</td> <td>1</td> </tr> <tr> <td>string $type It can be only 'buy' or 'sell'</td> <td>1</td> </tr> <tr> <td>string $value Accountancy code</td> <td>1</td> </tr> <tr> <td>int $list 0:Return array contains all properties, 1:Return array contains just id</td> <td>1</td> </tr> <tr> <td>string $code Filter on this code of contact type ('SHIPPING', 'BILLING', ...)</td> <td>1</td> </tr> <tr> <td>string $element Filter on this element of default contact type ('facture', 'propal', 'commande' ...)</td> <td>1</td> </tr> <tr> <td>int $soc_origin_id Company to merge the data from</td> <td>1</td> </tr> <tr> <td>User $user Object user making action</td> <td>1</td> </tr> <tr> <td>User $fuser Object user making action</td> <td>1</td> </tr> <tr> <td>int $socid Id of thirdparty</td> <td>1</td> </tr> <tr> <td>int $id Id of action to get</td> <td>1</td> </tr> <tr> <td>string $ref Ref of action to get</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext to get</td> <td>1</td> </tr> <tr> <td>string $email_msgid Email msgid</td> <td>1</td> </tr> <tr> <td>int<0,1> $loadresources 1=Load also resources</td> <td>1</td> </tr> <tr> <td>bool $override Override $this->userownerid when empty. TODO This should be false by default. True is here to fix corrupted data.</td> <td>1</td> </tr> <tr> <td>User $user User making the delete</td> <td>1</td> </tr> <tr> <td>User $user Object user making change</td> <td>1</td> </tr> <tr> <td>int $socid Filter by thirdparty</td> <td>1</td> </tr> <tr> <td>int $fk_element Id of element action is linked to</td> <td>1</td> </tr> <tr> <td>string $elementtype Type of element action is linked to</td> <td>1</td> </tr> <tr> <td>string $filter Other filter</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort on this field</td> <td>1</td> </tr> <tr> <td>string $sortorder ASC or DESC</td> <td>1</td> </tr> <tr> <td>int $limit Limit number of answers</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $load_state_board Load indicator array this->nb</td> <td>1</td> </tr> <tr> <td>int<0,100> $percent Percent</td> <td>1</td> </tr> <tr> <td>int|string $datestart Date start of event</td> <td>1</td> </tr> <tr> <td>int<0,2> $withpicto 0 = No picto, 1 = Include picto into link, 2 = Only picto</td> <td>1</td> </tr> <tr> <td>int $maxlength Max number of characters into label. If negative, use the ref as label.</td> <td>1</td> </tr> <tr> <td>string $classname Force style class on a link</td> <td>1</td> </tr> <tr> <td>string $option '' = Link to action, 'birthday'= Link to contact, 'holiday' = Link to leave</td> <td>1</td> </tr> <tr> <td>int<0,1> $overwritepicto 1 = Overwrite picto with this one</td> <td>1</td> </tr> <tr> <td>int<0,1> $notooltip 1 = Disable tooltip</td> <td>1</td> </tr> <tr> <td>int<-1,1> $save_lastsearch_value -1 = Auto, 0 = No save of lastsearch_values when clicking, 1 = Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>string $titlealt Title alt</td> <td>1</td> </tr> <tr> <td>string $format The format of the export 'vcal', 'ical/ics' or 'rss'</td> <td>1</td> </tr> <tr> <td>string $type The type of the export 'event' or 'journal'</td> <td>1</td> </tr> <tr> <td>integer $cachedelay Do not rebuild file if date older than cachedelay seconds</td> <td>1</td> </tr> <tr> <td>string $filename The name for the exported file.</td> <td>1</td> </tr> <tr> <td>array<string,int|string> $filters Array of filters. Example array('notolderthan'=>99, 'year'=>..., 'idfrom'=>..., 'actiontype'=>'systemauto', 'actioncode'=>'AC_PRODUCT_MODIFY', 'project'=>123, ...)</td> <td>1</td> </tr> <tr> <td>int<0,1> $exportholiday 0 = don't integrate holidays into the export, 1 = integrate holidays into the export</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>string $type Type of reminder 'browser' or 'email'</td> <td>1</td> </tr> <tr> <td>int $fk_user Id of user</td> <td>1</td> </tr> <tr> <td>bool $onlypast true = get only past reminder, false = get all reminders linked to this</td> <td>1</td> </tr> <tr> <td>int $id The id of the event</td> <td>1</td> </tr> <tr> <td>int<0,100> $percent The new percent value for the event</td> <td>1</td> </tr> <tr> <td>int $usermodid The user who modified the percent</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $file File</td> <td>1</td> </tr> <tr> <td>string $uri Url</td> <td>1</td> </tr> <tr> <td>string $usecachefile Full path of a cache file to use a cache file</td> <td>1</td> </tr> <tr> <td>int $delaycache Delay in seconds for cache (by default 3600 secondes)</td> <td>1</td> </tr> <tr> <td>string $type Type ('VTODO', 'VEVENT', 'VFREEBUSY', 'VCALENDAR'...)</td> <td>1</td> </tr> <tr> <td>string $key Key ('DTSTART', ...). Note: Field is never 'DTSTART;TZID=...' because ';...' was before removed and added as another property</td> <td>1</td> </tr> <tr> <td>string $value Value</td> <td>1</td> </tr> <tr> <td>string $text Text</td> <td>1</td> </tr> <tr> <td>string $value string</td> <td>1</td> </tr> <tr> <td>string $ical_date String date</td> <td>1</td> </tr> <tr> <td>string $key Key. Example: 'DTSTART', 'DTSTART;TZID=US-Eastern'</td> <td>1</td> </tr> <tr> <td>string $value Value. Example: '19970714T133000', '19970714T173000Z', '19970714T133000'</td> <td>1</td> </tr> <tr> <td>array $a Operand a</td> <td>1</td> </tr> <tr> <td>array $b Operand b</td> <td>1</td> </tr> <tr> <td>int $id ID of Agenda Events</td> <td>1</td> </tr> <tr> <td>string $user_ids User ids filter field (owners of event). Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'%dol%') and (t.datec:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $id Id of Agenda Event to update</td> <td>1</td> </tr> <tr> <td>int $id Agenda Event ID</td> <td>1</td> </tr> <tr> <td>int|string $id id or code of action type to read</td> <td>1</td> </tr> <tr> <td>string|int $active 1 or 0 to filter on event state active or not ('' by default = no filter)</td> <td>1</td> </tr> <tr> <td>string $idorcode 'id' or 'code' or 'all'</td> <td>1</td> </tr> <tr> <td>string $excludetype Type to exclude ('system' or 'systemauto')</td> <td>1</td> </tr> <tr> <td>int $onlyautoornot 1=Group all type AC_XXX into 1 line AC_MANUAL. 0=Keep details of type, -1 or -2=Keep details and add a combined line per calendar (Default, Auto, BoothConf, ...)</td> <td>1</td> </tr> <tr> <td>string $morefilter Add more SQL filter</td> <td>1</td> </tr> <tr> <td>int $shortlabel 1=Get short label instead of long label</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Picto only</td> <td>1</td> </tr> <tr> <td>float $remise_percent Discount effected on Product</td> <td>1</td> </tr> <tr> <td>int $propalid Id proposal</td> <td>1</td> </tr> <tr> <td>string $desc Description of line</td> <td>1</td> </tr> <tr> <td>float $pu_ht Unit price</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float|string $txtva Force Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Local tax 1 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Local tax 2 rate (deprecated, use instead txtva with code inside)</td> <td>1</td> </tr> <tr> <td>float $remise_percent Pourcentage de remise de la ligne</td> <td>1</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.</td> <td>1</td> </tr> <tr> <td>int $fk_fournprice Id supplier price</td> <td>1</td> </tr> <tr> <td>int $fk_remise_except Id discount if line is from a discount</td> <td>1</td> </tr> <tr> <td>int $rowid Id of line</td> <td>1</td> </tr> <tr> <td>float $pu Unit price (HT or TTC depending on price_base_type)</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>float $remise_percent Discount on line</td> <td>1</td> </tr> <tr> <td>float|string $txtva VAT Rate (Can be '1.23' or '1.23 (ABC)')</td> <td>1</td> </tr> <tr> <td>float $txlocaltax1 Local tax 1 rate</td> <td>1</td> </tr> <tr> <td>float $txlocaltax2 Local tax 2 rate</td> <td>1</td> </tr> <tr> <td>int $id Id of object (for a check)</td> <td>1</td> </tr> <tr> <td>int $forceentity Entity id to force</td> <td>1</td> </tr> <tr> <td>bool $update_prices [=false] Update prices if true</td> <td>1</td> </tr> <tr> <td>bool $update_desc [=false] Update description if true</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of proposal</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of proposal</td> <td>1</td> </tr> <tr> <td>int $forceentity Entity id to force when searching on ref or ref_ext</td> <td>1</td> </tr> <tr> <td>int $only_product Return only physical products</td> <td>1</td> </tr> <tr> <td>int $loadalsotranslation Return translation for products</td> <td>1</td> </tr> <tr> <td>string $sqlforgedfilters Filter on other fields</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $date Date</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $date_end_validity End of validity date</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $id Availability id</td> <td>1</td> </tr> <tr> <td>int $id Input reason id</td> <td>1</td> </tr> <tr> <td>int $status Status (self::STATUS_BILLED or self::STATUS_REFUSED)</td> <td>1</td> </tr> <tr> <td>int $id Id propal</td> <td>1</td> </tr> <tr> <td>int $availability_id Id of new delivery time</td> <td>1</td> </tr> <tr> <td>int $demand_reason_id Id of new source demand</td> <td>1</td> </tr> <tr> <td>string $mode "opened" for proposal to close, "signed" for proposal to invoice</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>string $option Where point the link ('expedition', 'document', ...)</td> <td>1</td> </tr> <tr> <td>string $get_params Parameters added to url</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes -1=Disable, 0=Just add label show notes, 1=Add private note (only internal user), 2=Add public note (internal or external user), 3=Add private (internal user) and public note (internal and external user)</td> <td>1</td> </tr> <tr> <td>string $sqlforgedfilters Filter on other fields</td> <td>1</td> </tr> <tr> <td>int $id ID of commercial proposal</td> <td>1</td> </tr> <tr> <td>int $id ID of order</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter commercial proposals (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'2016-01-01')"</td> <td>1</td> </tr> <tr> <td>int $id Id of commercial proposal</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. d is the alias for proposal lines table, p is the alias for product table. "Syntax example "(p.ref:like:'SO-%') AND (d.date_start:<:'20220101')"</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line to update</td> <td>1</td> </tr> <tr> <td>array $request_data Commercial proposal line data</td> <td>1</td> </tr> <tr> <td>int $lineid Id of line to delete</td> <td>1</td> </tr> <tr> <td>int $id Id of commercial proposal to update</td> <td>1</td> </tr> <tr> <td>int $id Id of commercial proposal to update</td> <td>1</td> </tr> <tr> <td>int $contactid Row key of the contact in the array contact_ids.</td> <td>1</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER).</td> <td>1</td> </tr> <tr> <td>int $id Id of commercial proposal to update</td> <td>1</td> </tr> <tr> <td>int $id Commercial proposal ID</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>int $status Must be 2 (accepted) or 3 (refused) {@min 2}{@max 3}</td> <td>1</td> </tr> <tr> <td>string $note_private Add this mention at end of private note</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $type_element Type target</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>array $arrayquery All element to Query</td> <td>1</td> </tr> <tr> <td>int $withThirdpartyFilter add contact with tridparty filter</td> <td>1</td> </tr> <tr> <td>string $column_to_test column to test</td> <td>1</td> </tr> <tr> <td>string $criteria Use %% as magic characters. For example to find all item like <b>jean, joe, jim</b>, you can input <b>j%%</b>, you can also use ; as separator for value,</td> <td>1</td> </tr> <tr> <td>User $user Object of user making creation</td> <td>1</td> </tr> <tr> <td>User $user Object of user making change</td> <td>1</td> </tr> <tr> <td>int $rowid Id of emailing</td> <td>1</td> </tr> <tr> <td>string $ref Title to search from title</td> <td>1</td> </tr> <tr> <td>int $option1 1=Clone content, 0=Forget content</td> <td>1</td> </tr> <tr> <td>int $option2 1=Clone recipients</td> <td>1</td> </tr> <tr> <td>string $mode Mode ('alreadysent' = Sent success or error, 'alreadysentok' = Sent success, 'alreadysentko' = Sent error)</td> <td>1</td> </tr> <tr> <td>string $desc Desc error</td> <td>1</td> </tr> <tr> <td>array $selected_array à preselectionner</td> <td>1</td> </tr> <tr> <td>string $htmlname select field</td> <td>1</td> </tr> <tr> <td>array $selected_array array of data</td> <td>1</td> </tr> <tr> <td>User $user User action</td> <td>1</td> </tr> <tr> <td>string $htmlname of combo list (example: 'search_sale')</td> <td>1</td> </tr> <tr> <td>array $selected_array selected array</td> <td>1</td> </tr> <tr> <td>array<string,string> $sqlqueryparam array</td> <td>1</td> </tr> <tr> <td>string[] $selected_array array</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select combo field</td> <td>1</td> </tr> <tr> <td>array $selected_array Array</td> <td>1</td> </tr> <tr> <td>string $htmlname select</td> <td>1</td> </tr> <tr> <td>array $options_array to manage</td> <td>1</td> </tr> <tr> <td>array $selected_array to manage</td> <td>1</td> </tr> <tr> <td>int $showempty show empty</td> <td>1</td> </tr> <tr> <td>string $htmlname control name</td> <td>1</td> </tr> <tr> <td>integer $selected default selected</td> <td>1</td> </tr> <tr> <td>integer $showempty empty lines</td> <td>1</td> </tr> <tr> <td>string $type_element Type element. Example: 'mailing'</td> <td>1</td> </tr> <tr> <td>User|null $user User</td> <td>1</td> </tr> <tr> <td>User|null $user Object user</td> <td>1</td> </tr> <tr> <td>int $userid User id</td> <td>1</td> </tr> <tr> <td>int $id If defined, id to used for search</td> <td>1</td> </tr> <tr> <td>string $login If defined, login to used for search</td> <td>1</td> </tr> <tr> <td>string $sid If defined, sid to used for search</td> <td>1</td> </tr> <tr> <td>int $loadpersonalconf 1=also load personal conf of user (in $user->conf->xxx), 0=do not load personal conf.</td> <td>1</td> </tr> <tr> <td>int $entity If a value is >= 0, we force the search on a specific entity. If -1, means search depens on default setup.</td> <td>1</td> </tr> <tr> <td>string $email If defined, email to used for search</td> <td>1</td> </tr> <tr> <td>int $fk_socpeople If defined, id of contact for search</td> <td>1</td> </tr> <tr> <td>int $use_email_oauth2 1=Use also email_oauth2 to fetch on email</td> <td>1</td> </tr> <tr> <td>string $module Module of permission to check</td> <td>1</td> </tr> <tr> <td>string $permlevel1 Permission level1 (Example: 'read', 'write', 'delete')</td> <td>1</td> </tr> <tr> <td>string $permlevel2 Permission level2</td> <td>1</td> </tr> <tr> <td>int $rid Id of permission to add or 0 to add several permissions</td> <td>1</td> </tr> <tr> <td>string $allmodule Add all permissions of module $allmodule or 'allmodules' to include all modules.</td> <td>1</td> </tr> <tr> <td>string $allperms Add all permissions of module $allmodule, subperms $allperms only or '' to include all permissions.</td> <td>1</td> </tr> <tr> <td>int $entity Entity to use</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>int $rid Id of permission to remove (or 0 when using the other filters)</td> <td>1</td> </tr> <tr> <td>string $allmodule Retirer tous les droits du module allmodule</td> <td>1</td> </tr> <tr> <td>string $allperms Retirer tous les droits du module allmodule, perms allperms</td> <td>1</td> </tr> <tr> <td>int|string $entity Entity to use. Example: '1', or '0,1', or '2,3'</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>User $user User than delete</td> <td>1</td> </tr> <tr> <td>User $user Object user doing creation</td> <td>1</td> </tr> <tr> <td>Contact $contact Object for source contact</td> <td>1</td> </tr> <tr> <td>string $login Login to force</td> <td>1</td> </tr> <tr> <td>string $password Password to force</td> <td>1</td> </tr> <tr> <td>Adherent $member Object member source</td> <td>1</td> </tr> <tr> <td>string $login Login to force</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=do not execute triggers, 0 by default</td> <td>1</td> </tr> <tr> <td>int $nosyncmember 0=Synchronize linked member (standard info), 1=Do not synchronize linked member</td> <td>1</td> </tr> <tr> <td>int $nosyncmemberpass 0=Synchronize linked member (password), 1=Do not synchronize linked member</td> <td>1</td> </tr> <tr> <td>int $nosynccontact 0=Synchronize linked contact, 1=Do not synchronize linked contact</td> <td>1</td> </tr> <tr> <td>User $user Object user of user requesting the change (not the user for who we change the password). May be unknown.</td> <td>1</td> </tr> <tr> <td>string $password New password, in clear text or already encrypted (to generate if not provided)</td> <td>1</td> </tr> <tr> <td>int $changelater 0=Default, 1=Save password into pass_temp to change password only after clicking on confirm email</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not launch triggers</td> <td>1</td> </tr> <tr> <td>int $nosyncmember Do not synchronize linked member</td> <td>1</td> </tr> <tr> <td>int $passwordalreadycrypted 0=Value is cleartext password, 1=Value is encrypted value.</td> <td>1</td> </tr> <tr> <td>int $flagdelsessionsbefore 1=Save also the current date to ask to invalidate all other session before this date.</td> <td>1</td> </tr> <tr> <td>User $user Object user that send the email (not the user we send to) @todo object $user is not used !</td> <td>1</td> </tr> <tr> <td>string $password New password</td> <td>1</td> </tr> <tr> <td>int $changelater 0=Send clear passwod into email, 1=Change password only after clicking on confirm email. @todo Add method 2 = Send link to reset password</td> <td>1</td> </tr> <tr> <td>int $group Id of group</td> <td>1</td> </tr> <tr> <td>int $entity Entity</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>int $group Id of group</td> <td>1</td> </tr> <tr> <td>int $entity Entity</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>int $width Width of image</td> <td>1</td> </tr> <tr> <td>int $height Height of image</td> <td>1</td> </tr> <tr> <td>string $cssclass Force a css class</td> <td>1</td> </tr> <tr> <td>string $imagesize 'mini', 'small' or '' (original)</td> <td>1</td> </tr> <tr> <td>array $params Array with options, infologin</td> <td>1</td> </tr> <tr> <td>int $withpictoimg Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small)</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('leave', 'accountancy', 'nolink', )</td> <td>1</td> </tr> <tr> <td>integer $infologin 0=Add default info tooltip, 1=Add complete info tooltip, -1=No info tooltip</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length of visible user name</td> <td>1</td> </tr> <tr> <td>int $hidethirdpartylogo Hide logo of thirdparty if user is external user</td> <td>1</td> </tr> <tr> <td>string $mode ''=Show firstname and lastname, 'firstname'=Show only firstname, 'firstelselast'=Show firstname or lastname if not defined, 'login'=Show login</td> <td>1</td> </tr> <tr> <td>int $withpictoimg Include picto into link (1=picto, -1=photo)</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('leave', 'accountancy', 'nolink', )</td> <td>1</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip on picto and name</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $id Id of user to load</td> <td>1</td> </tr> <tr> <td>string $limitTo Limit to '' or 'active'</td> <td>1</td> </tr> <tr> <td>string $option 'superadmin' = return for entity 0 only</td> <td>1</td> </tr> <tr> <td>int $admin Filter on admin tag</td> <td>1</td> </tr> <tr> <td>Object $ldapuser Ladp User</td> <td>1</td> </tr> <tr> <td>int $deleteafterid Removed all users including the leaf $deleteafterid (and all its child) in user tree.</td> <td>1</td> </tr> <tr> <td>string $filter SQL filter on users. This parameter must not come from user input.</td> <td>1</td> </tr> <tr> <td>int $addcurrentuser 1=Add also current user id to the list.</td> <td>1</td> </tr> <tr> <td>int $id_user id_user entry to update</td> <td>1</td> </tr> <tr> <td>int $protection Deep counter to avoid infinite loop (no more required, a protection is added with array useridfound)</td> <td>1</td> </tr> <tr> <td>string $mode 'email', 'mobile', or 'name'</td> <td>1</td> </tr> <tr> <td>string $mode Mode for link</td> <td>1</td> </tr> <tr> <td>string $typeofurl 'external' or 'internal'</td> <td>1</td> </tr> <tr> <td>string $sortorder sort order</td> <td>1</td> </tr> <tr> <td>string $sortfield sort field</td> <td>1</td> </tr> <tr> <td>int $limit limit page</td> <td>1</td> </tr> <tr> <td>int $offset page</td> <td>1</td> </tr> <tr> <td>bool $entityfilter Activate entity filter</td> <td>1</td> </tr> <tr> <td>string $email The full e-mail (or a part of a e-mail)</td> <td>1</td> </tr> <tr> <td>int $id Id of group to load</td> <td>1</td> </tr> <tr> <td>string $groupname Name of group to load</td> <td>1</td> </tr> <tr> <td>boolean $load_members Load all members of the group</td> <td>1</td> </tr> <tr> <td>int $userid User id to search</td> <td>1</td> </tr> <tr> <td>boolean $load_members Load all members of the group</td> <td>1</td> </tr> <tr> <td>string $excludefilter Filter to exclude. Do not use here a string coming from user input.</td> <td>1</td> </tr> <tr> <td>int $mode 0=Return array of user instance, 1=Return array of users id only</td> <td>1</td> </tr> <tr> <td>int $rid id du droit a ajouter</td> <td>1</td> </tr> <tr> <td>string $allmodule Ajouter tous les droits du module allmodule</td> <td>1</td> </tr> <tr> <td>string $allperms Ajouter tous les droits du module allmodule, perms allperms</td> <td>1</td> </tr> <tr> <td>int $rid id du droit a retirer</td> <td>1</td> </tr> <tr> <td>string $allmodule Retirer tous les droits du module allmodule</td> <td>1</td> </tr> <tr> <td>string $allperms Retirer tous les droits du module allmodule, perms allperms</td> <td>1</td> </tr> <tr> <td>string $moduletag Name of module we want permissions ('' means all)</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=triggers enabled, 1=triggers disabled</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=triggers enabled, 1=triggers disabled</td> <td>1</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small)</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('nolink', 'permissions')</td> <td>1</td> </tr> <tr> <td>int $category Use this param to filter list by category</td> <td>1</td> </tr> <tr> <td>int $id ID of user</td> <td>1</td> </tr> <tr> <td>string $login Login of user</td> <td>1</td> </tr> <tr> <td>string $email Email of user</td> <td>1</td> </tr> <tr> <td>int $includepermissions Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)</td> <td>1</td> </tr> <tr> <td>array $request_data New user data</td> <td>1</td> </tr> <tr> <td>int $id Id of account to update</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id Id of user</td> <td>1</td> </tr> <tr> <td>int $id User ID</td> <td>1</td> </tr> <tr> <td>int $group Group ID</td> <td>1</td> </tr> <tr> <td>int $entity Entity ID (valid only for superadmin in multicompany transverse mode)</td> <td>1</td> </tr> <tr> <td>string $group_ids Groups ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $group ID of group</td> <td>1</td> </tr> <tr> <td>int $load_members Load members list or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $id Account ID</td> <td>1</td> </tr> <tr> <td>Object $object Object to clean</td> <td>1</td> </tr> <tr> <td>array $objectList Array of object to clean</td> <td>1</td> </tr> <tr> <td>array|null $data Data to validate</td> <td>1</td> </tr> <tr> <td>User $user Object user making import</td> <td>1</td> </tr> <tr> <td>string $filter Load a particular dataset only. Index will start to 0.</td> <td>1</td> </tr> <tr> <td>string $model Name of import engine ('csv', ...)</td> <td>1</td> </tr> <tr> <td>string $headerlinefields Array of values for first line of example file</td> <td>1</td> </tr> <tr> <td>string $contentlinevalues Array of values for content line of example file</td> <td>1</td> </tr> <tr> <td>string $datatoimport Dataset to import</td> <td>1</td> </tr> <tr> <td>string $url Url of current page</td> <td>1</td> </tr> <tr> <td>int $nbPages Total of pages results</td> <td>1</td> </tr> <tr> <td>int $currentPage Number of current page</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>int $include_sub_warehouse Include sub warehouses</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 5=Long label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $id Id of warehouse</td> <td>1</td> </tr> <tr> <td>array $TChildWarehouse Array of child warehouses</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>int $fk_product_stock id product_stock for object</td> <td>1</td> </tr> <tr> <td>integer $eatby eat-by date for object - deprecated: a search must be done on batch number</td> <td>1</td> </tr> <tr> <td>integer $sellby sell-by date for object - deprecated: a search must be done on batch number</td> <td>1</td> </tr> <tr> <td>string $batch_number batch number for object</td> <td>1</td> </tr> <tr> <td>int $fk_warehouse filter on warehouse (use it if you don't have $fk_product_stock)</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs database object</td> <td>1</td> </tr> <tr> <td>int $fk_product_stock id product_stock for object</td> <td>1</td> </tr> <tr> <td>int $with_qty 1 = doesn't return line with 0 quantity</td> <td>1</td> </tr> <tr> <td>int $fk_product If set to a product id, get eatby and sellby from table llx_product_lot</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of product</td> <td>1</td> </tr> <tr> <td>int $fk_warehouse Id of warehouse</td> <td>1</td> </tr> <tr> <td>int $qty_min [=NULL] Minimum quantity</td> <td>1</td> </tr> <tr> <td>string $sortfield [=NULL] List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb'</td> <td>1</td> </tr> <tr> <td>string $sortorder [=NULL] Sort order, separated by comma. Example: 'ASC,DESC';</td> <td>1</td> </tr> <tr> <td>User $user that creates</td> <td>1</td> </tr> <tr> <td>int $id ID of customer price</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit page</td> <td>1</td> </tr> <tr> <td>int $offset offset</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter USF.</td> <td>1</td> </tr> <tr> <td>string $sortorder order</td> <td>1</td> </tr> <tr> <td>string $sortfield field</td> <td>1</td> </tr> <tr> <td>int $limit page</td> <td>1</td> </tr> <tr> <td>int $offset offset</td> <td>1</td> </tr> <tr> <td>array $filter Filter for sql request</td> <td>1</td> </tr> <tr> <td>User $user that modifies</td> <td>1</td> </tr> <tr> <td>User $user User that modifies</td> <td>1</td> </tr> <tr> <td>int $forceupdateaffiliate update price on each soc child</td> <td>1</td> </tr> <tr> <td>User $user that deletes</td> <td>1</td> </tr> <tr> <td>int $fromid ID of object to clone</td> <td>1</td> </tr> <tr> <td>User $user User making insert</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>string $valuetotest Value to test</td> <td>1</td> </tr> <tr> <td>string $typefortest Type of barcode (ISBN, EAN, ...)</td> <td>1</td> </tr> <tr> <td>int $id Id of product</td> <td>1</td> </tr> <tr> <td>User $user Object user making update</td> <td>1</td> </tr> <tr> <td>string $action Current action for hookmanager ('add' or 'update')</td> <td>1</td> </tr> <tr> <td>boolean $updatetype Update product type</td> <td>1</td> </tr> <tr> <td>User $user User (object) deleting product</td> <td>1</td> </tr> <tr> <td>string $langtodelete Language code to delete</td> <td>1</td> </tr> <tr> <td>User $user Object user making delete</td> <td>1</td> </tr> <tr> <td>string $type It can be 'buy', 'buy_intra', 'buy_export', 'sell', 'sell_intra' or 'sell_export'</td> <td>1</td> </tr> <tr> <td>string $value Accountancy code</td> <td>1</td> </tr> <tr> <td>User $user User making change</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $rowid Line id to delete</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_seller Seller</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty_buyer Buyer</td> <td>1</td> </tr> <tr> <td>int $pqp Id of product price per quantity if a selection was done of such a price</td> <td>1</td> </tr> <tr> <td>int $prodfournprice Id du tarif = rowid table product_fournisseur_price</td> <td>1</td> </tr> <tr> <td>double $qty Quantity asked or -1 to get first entry found</td> <td>1</td> </tr> <tr> <td>int $product_id Filter on a particular product id</td> <td>1</td> </tr> <tr> <td>string $fourn_ref Filter on a supplier price ref. 'none' to exclude ref in search.</td> <td>1</td> </tr> <tr> <td>int $fk_soc If of supplier</td> <td>1</td> </tr> <tr> <td>double $newprice New price</td> <td>1</td> </tr> <tr> <td>string $newpricebase HT or TTC</td> <td>1</td> </tr> <tr> <td>User $user Object user that make change</td> <td>1</td> </tr> <tr> <td>?double $newvat New VAT Rate (For example 8.5. Should not be a string)</td> <td>1</td> </tr> <tr> <td>double $newminprice New price min</td> <td>1</td> </tr> <tr> <td>int $level 0=standard, >0 = level if multilevel prices</td> <td>1</td> </tr> <tr> <td>int $newnpr 0=Standard vat rate, 1=Special vat rate for French NPR VAT</td> <td>1</td> </tr> <tr> <td>int $newpbq 1 if it has price by quantity</td> <td>1</td> </tr> <tr> <td>int $ignore_autogen Used to avoid infinite loops</td> <td>1</td> </tr> <tr> <td>array $localtaxes_array Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).</td> <td>1</td> </tr> <tr> <td>string $newdefaultvatcode Default vat code</td> <td>1</td> </tr> <tr> <td>string $price_label Price Label</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>int $expression_id Expression</td> <td>1</td> </tr> <tr> <td>int $id Id of product/service to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of product/service to load</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of product/service to load</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of product/service to load</td> <td>1</td> </tr> <tr> <td>int $ignore_expression When module dynamicprices is on, ignores the math expression for calculating price and uses the db value instead</td> <td>1</td> </tr> <tr> <td>int $ignore_price_load Load product without loading $this->multiprices... array (when we are sure we don't need them)</td> <td>1</td> </tr> <tr> <td>int $ignore_lang_load Load product without loading $this->multilangs language arrays (when we are sure we don't need them)</td> <td>1</td> </tr> <tr> <td>int $socid Id thirdparty</td> <td>1</td> </tr> <tr> <td>int $socid Id thirdparty to filter on a thirdparty</td> <td>1</td> </tr> <tr> <td>string $filtrestatut Id status to filter on a status</td> <td>1</td> </tr> <tr> <td>int $forVirtualStock Ignore rights filter for virtual stock calculation. Set when load_stats_commande is used for virtual stock calculation.</td> <td>1</td> </tr> <tr> <td>int $socid Id thirdparty to filter on a thirdparty</td> <td>1</td> </tr> <tr> <td>string $filtrestatut Id of status to filter on status</td> <td>1</td> </tr> <tr> <td>int $forVirtualStock Ignore rights filter for virtual stock calculation.</td> <td>1</td> </tr> <tr> <td>int $socid Id thirdparty to filter on a thirdparty</td> <td>1</td> </tr> <tr> <td>string $filtrestatut [=''] Ids order status separated by comma</td> <td>1</td> </tr> <tr> <td>int $forVirtualStock Ignore rights filter for virtual stock calculation.</td> <td>1</td> </tr> <tr> <td>string $filterShipmentStatus [=''] Ids shipment status separated by comma</td> <td>1</td> </tr> <tr> <td>int $warehouseid Filter by a warehouse. Warning: When a filter on a warehouse is set, it is not possible to calculate an accurate virtual stock because we can't know in which warehouse will be done virtual stock changes.</td> <td>1</td> </tr> <tr> <td>string $sql Request to execute</td> <td>1</td> </tr> <tr> <td>string $mode 'byunit'=number of unit, 'bynumber'=nb of entities</td> <td>1</td> </tr> <tr> <td>int $year Year (0=current year, -1=all years)</td> <td>1</td> </tr> <tr> <td>string $mode 'byunit'=number of unit, 'bynumber'=nb of entities, 'byamount'=amount</td> <td>1</td> </tr> <tr> <td>int $fk_parent Id of parent product (child will no more be linked to it)</td> <td>1</td> </tr> <tr> <td>int $fk_child Id of child product</td> <td>1</td> </tr> <tr> <td>int $fk_parent Id of parent kit product</td> <td>1</td> </tr> <tr> <td>int $fk_child Id of child product</td> <td>1</td> </tr> <tr> <td>User $user User that make link</td> <td>1</td> </tr> <tr> <td>int $id_fourn Supplier id</td> <td>1</td> </tr> <tr> <td>string $ref_fourn Supplier ref</td> <td>1</td> </tr> <tr> <td>float $quantity Quantity minimum for price</td> <td>1</td> </tr> <tr> <td>int $fromId Id product source</td> <td>1</td> </tr> <tr> <td>int $toId Id product target</td> <td>1</td> </tr> <tr> <td>int $fromId Product id</td> <td>1</td> </tr> <tr> <td>int $toId Product id</td> <td>1</td> </tr> <tr> <td>int $fromId Id produit source</td> <td>1</td> </tr> <tr> <td>int $toId Id produit cible</td> <td>1</td> </tr> <tr> <td>array $prod Products array</td> <td>1</td> </tr> <tr> <td>string $compl_path Directory path of parents to add before</td> <td>1</td> </tr> <tr> <td>int $multiply Because each sublevel must be multiplicated by parent nb</td> <td>1</td> </tr> <tr> <td>int $level Init level</td> <td>1</td> </tr> <tr> <td>int $id_parent Id parent</td> <td>1</td> </tr> <tr> <td>int $ignore_stock_load Ignore stock load</td> <td>1</td> </tr> <tr> <td>int $multiply Because each sublevel must be multiplicated by parent nb</td> <td>1</td> </tr> <tr> <td>int $ignore_stock_load Ignore stock load</td> <td>1</td> </tr> <tr> <td>int $mode 0=Both parent and child, -1=Parents only, 1=Children only</td> <td>1</td> </tr> <tr> <td>int $id Id of product to search children of</td> <td>1</td> </tr> <tr> <td>int $firstlevelonly Return only direct child</td> <td>1</td> </tr> <tr> <td>int $level Level of recursing call (start to 1)</td> <td>1</td> </tr> <tr> <td>array $parents Array of all parents of $id</td> <td>1</td> </tr> <tr> <td>string $option Where point the link ('stock', 'composition', 'category', 'supplier', '')</td> <td>1</td> </tr> <tr> <td>int $maxlength Maxlength of ref</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values when clicking</td> <td>1</td> </tr> <tr> <td>int $notooltip No tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss ''=Add more css on link</td> <td>1</td> </tr> <tr> <td>int $add_label 0=Default, 1=Add label into string, >1=Add first chars into string</td> <td>1</td> </tr> <tr> <td>string $sep ' - '=Separator between ref and label if option 'add_label' is set</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $type 0=Sell, 1=Buy, 2=Batch Number management</td> <td>1</td> </tr> <tr> <td>int $status Statut</td> <td>1</td> </tr> <tr> <td>int $type 0=Status "to sell", 1=Status "to buy", 2=Status "to Batch"</td> <td>1</td> </tr> <tr> <td>User $user user asking change</td> <td>1</td> </tr> <tr> <td>int $id_entrepot id of warehouse</td> <td>1</td> </tr> <tr> <td>double $nbpiece nb of units (should be always positive, use $movement to decide if we add or remove)</td> <td>1</td> </tr> <tr> <td>int $movement 0 = add, 1 = remove</td> <td>1</td> </tr> <tr> <td>string $label Label of stock movement</td> <td>1</td> </tr> <tr> <td>double $price Unit price HT of product, used to calculate average weighted price (PMP in french). If 0, average weighted price is not changed.</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>string $origin_element Origin element type</td> <td>1</td> </tr> <tr> <td>int $origin_id Origin id of element</td> <td>1</td> </tr> <tr> <td>int $disablestockchangeforsubproduct Disable stock change for sub-products of kit (useful only if product is a subproduct)</td> <td>1</td> </tr> <tr> <td>Extrafields $extrafields Array of extrafields</td> <td>1</td> </tr> <tr> <td>User $user user asking change</td> <td>1</td> </tr> <tr> <td>int $id_entrepot id of warehouse</td> <td>1</td> </tr> <tr> <td>double $nbpiece nb of units (should be always positive, use $movement to decide if we add or remove)</td> <td>1</td> </tr> <tr> <td>int $movement 0 = add, 1 = remove</td> <td>1</td> </tr> <tr> <td>string $label Label of stock movement</td> <td>1</td> </tr> <tr> <td>double $price Price to use for stock eval</td> <td>1</td> </tr> <tr> <td>int|string $dlc eat-by date</td> <td>1</td> </tr> <tr> <td>int|string $dluo sell-by date</td> <td>1</td> </tr> <tr> <td>string $lot Lot number</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>string $origin_element Origin element type</td> <td>1</td> </tr> <tr> <td>int $origin_id Origin id of element</td> <td>1</td> </tr> <tr> <td>int $disablestockchangeforsubproduct Disable stock change for sub-products of kit (useful only if product is a subproduct)</td> <td>1</td> </tr> <tr> <td>Extrafields $extrafields Array of extrafields</td> <td>1</td> </tr> <tr> <td>boolean $force_update_batch Force update batch</td> <td>1</td> </tr> <tr> <td>string $option '' = Load all stock info, also from closed and internal warehouses, 'nobatch' = do not load batch detail, 'novirtual' = do no load virtual detail</td> <td>1</td> </tr> <tr> <td>int $includedraftpoforvirtual Include draft status of PO for virtual stock calculation</td> <td>1</td> </tr> <tr> <td>int $includedraftpoforvirtual Include draft status and not yet approved Purchase Orders for virtual stock calculation</td> <td>1</td> </tr> <tr> <td>string $batch Lot/serial number</td> <td>1</td> </tr> <tr> <td>string $sdir Target directory</td> <td>1</td> </tr> <tr> <td>string $file Array of file info of file to upload: array('name'=>..., 'tmp_name'=>...)</td> <td>1</td> </tr> <tr> <td>string $dir Directory to scan</td> <td>1</td> </tr> <tr> <td>int $nbmax Number maximum of photos (0=no maximum)</td> <td>1</td> </tr> <tr> <td>string $file Path to image file</td> <td>1</td> </tr> <tr> <td>string $file Path to file</td> <td>1</td> </tr> <tr> <td>Product $object Object product or service</td> <td>1</td> </tr> <tr> <td>string $type Barcode type (ean, isbn, ...)</td> <td>1</td> </tr> <tr> <td>string $type Label type (long or short)</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>int $origin_id Old thirdparty id</td> <td>1</td> </tr> <tr> <td>int $dest_id New thirdparty id</td> <td>1</td> </tr> <tr> <td>User $user User that updates the prices</td> <td>1</td> </tr> <tr> <td>float $baseprice Base price</td> <td>1</td> </tr> <tr> <td>string $price_type Base price type</td> <td>1</td> </tr> <tr> <td>float $price_vat VAT % tax</td> <td>1</td> </tr> <tr> <td>int $npr NPR</td> <td>1</td> </tr> <tr> <td>string $psq ¿?</td> <td>1</td> </tr> <tr> <td>int $id Id of thirdparty to load</td> <td>1</td> </tr> <tr> <td>int $product_id Id object</td> <td>1</td> </tr> <tr> <td>string $lang Lang string code</td> <td>1</td> </tr> <tr> <td>int $product_id product_id</td> <td>1</td> </tr> <tr> <td>string $lang_id language</td> <td>1</td> </tr> <tr> <td>string $batch Add quantity of batch stock in label for product with batch name batch, batch name precedes batch_id. Nothing if ''.</td> <td>1</td> </tr> <tr> <td>string $status warehouse status filter, following comma separated filter options can be used</td> <td>1</td> </tr> <tr> <td>boolean $sumStock sum total stock of a warehouse, default true</td> <td>1</td> </tr> <tr> <td>array $tab warehouse data in $this->cache_warehouses line</td> <td>1</td> </tr> <tr> <td>string $final_label full label with all parents, separated by ' >> ' (completed on each call)</td> <td>1</td> </tr> <tr> <td>string|int|array $selected Id of preselected warehouse ('' or '-1' for no value, 'ifone' and 'ifonenodefault' = select value if one value otherwise no value, '-2' to use the default value from setup)</td> <td>1</td> </tr> <tr> <td>string $filterstatus warehouse status filter, following comma separated filter options can be used</td> <td>1</td> </tr> <tr> <td>int $showstock 1=Show stock count</td> <td>1</td> </tr> <tr> <td>array $events Events to add to select2</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css classes to HTML select</td> <td>1</td> </tr> <tr> <td>int $multiselect 1=Allow multiselect</td> <td>1</td> </tr> <tr> <td>string|int $selected Id of preselected warehouse ('' or '-1' for no value, 'ifone' and 'ifonenodefault' = select value if one value otherwise no value, '-2' to use the default value from setup)</td> <td>1</td> </tr> <tr> <td>array $events Events to add to select2</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css classes to HTML select</td> <td>1</td> </tr> <tr> <td>string $page Page</td> <td>1</td> </tr> <tr> <td>string|int $selected Id of warehouse</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of select html field</td> <td>1</td> </tr> <tr> <td>int $addempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>1</td> </tr> <tr> <td>string $name Name of HTML field</td> <td>1</td> </tr> <tr> <td>string $measuring_style Unit to show: weight, size, surface, volume, time</td> <td>1</td> </tr> <tr> <td>string $default Preselected value</td> <td>1</td> </tr> <tr> <td>int $adddefault Add empty unit called "Default"</td> <td>1</td> </tr> <tr> <td>int $mode 1=Use short label as value, 0=Use rowid</td> <td>1</td> </tr> <tr> <td>string $measuring_style Unit to show: weight, size, surface, volume, time</td> <td>1</td> </tr> <tr> <td>string $default Preselected value</td> <td>1</td> </tr> <tr> <td>int|string $adddefault 1=Add empty unit called "Default", ''=Add empty value</td> <td>1</td> </tr> <tr> <td>int $mode 1=Use short label as value, 0=Use rowid, 2=Use scale (power)</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $selected Preselected value</td> <td>1</td> </tr> <tr> <td>int $mode 1=Use label as value, 0=Use code</td> <td>1</td> </tr> <tr> <td>int $showempty 1=show empty value, 0= no</td> <td>1</td> </tr> <tr> <td>string|int $selected Id of preselected lot stock id ('' for no value, 'ifone'=select value if one value otherwise no value)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select html</td> <td>1</td> </tr> <tr> <td>string $filterstatus lot status filter, following comma separated filter options can be used</td> <td>1</td> </tr> <tr> <td>int $disabled 1=Select is disabled</td> <td>1</td> </tr> <tr> <td>string $empty_label Empty label if needed (only if $empty=1)</td> <td>1</td> </tr> <tr> <td>int $forcecombo 1=Force combo iso ajax select2</td> <td>1</td> </tr> <tr> <td>array $events Events to add to select2</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css classes to HTML select</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of key that is inside attribute "list" of an input text field.</td> <td>1</td> </tr> <tr> <td>array $productIdArray array of product id's from who to get lot numbers. A</td> <td>1</td> </tr> <tr> <td>int $id ID of product</td> <td>1</td> </tr> <tr> <td>int $includestockdata Load also information about stock (slower)</td> <td>1</td> </tr> <tr> <td>bool $includesubproducts Load information about subproducts</td> <td>1</td> </tr> <tr> <td>bool $includeparentid Load also ID of parent product (if product is a variant of a parent product)</td> <td>1</td> </tr> <tr> <td>bool $includetrans Load also the translations of product label and description</td> <td>1</td> </tr> <tr> <td>string $ref Ref of element</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref_ext of element</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of element</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>int $mode Use this param to filter list (0 for all, 1 for only product, 2 for only service)</td> <td>1</td> </tr> <tr> <td>int $category Use this param to filter list by category</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)"</td> <td>1</td> </tr> <tr> <td>bool $ids_only Return only IDs of product instead of all properties (faster, above all if list is long)</td> <td>1</td> </tr> <tr> <td>int $variant_filter Use this param to filter list (0 = all, 1=products without variants, 2=parent of variants, 3=variants only)</td> <td>1</td> </tr> <tr> <td>bool $pagination_data If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0</td> <td>1</td> </tr> <tr> <td>int $includestockdata Load also information about stock (slower)</td> <td>1</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>int $id Id of product to update</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id Product ID</td> <td>1</td> </tr> <tr> <td>int $id Id of parent product/service</td> <td>1</td> </tr> <tr> <td>int $id Id of parent product/service</td> <td>1</td> </tr> <tr> <td>int $subproduct_id Id of child product/service</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $incdec 1=Increase/decrease stock of child when parent stock increase/decrease</td> <td>1</td> </tr> <tr> <td>int $id Id of parent product/service</td> <td>1</td> </tr> <tr> <td>int $subproduct_id Id of child product/service</td> <td>1</td> </tr> <tr> <td>int $id ID of product</td> <td>1</td> </tr> <tr> <td>int $id ID of product</td> <td>1</td> </tr> <tr> <td>string $thirdparty_id Thirdparty id to filter orders of (example '1') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $id ID of Product</td> <td>1</td> </tr> <tr> <td>float $qty Min quantity for which price is valid</td> <td>1</td> </tr> <tr> <td>float $buyprice Purchase price for the quantity min</td> <td>1</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>1</td> </tr> <tr> <td>int $fourn_id Supplier ID</td> <td>1</td> </tr> <tr> <td>int $availability Product availability</td> <td>1</td> </tr> <tr> <td>string $ref_fourn Supplier ref</td> <td>1</td> </tr> <tr> <td>float $tva_tx New VAT Rate (For example 8.5. Should not be a string)</td> <td>1</td> </tr> <tr> <td>string|float $charges costs affering to product</td> <td>1</td> </tr> <tr> <td>float $remise_percent Discount regarding qty (percent)</td> <td>1</td> </tr> <tr> <td>float $remise Discount regarding qty (amount)</td> <td>1</td> </tr> <tr> <td>int $newnpr Set NPR or not</td> <td>1</td> </tr> <tr> <td>int $delivery_time_days Delay in days for delivery (max). May be '' if not defined.</td> <td>1</td> </tr> <tr> <td>array $localtaxes_array Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).</td> <td>1</td> </tr> <tr> <td>string $newdefaultvatcode Default vat code</td> <td>1</td> </tr> <tr> <td>float $multicurrency_buyprice Purchase price for the quantity min in currency</td> <td>1</td> </tr> <tr> <td>float $multicurrency_tx Rate currency</td> <td>1</td> </tr> <tr> <td>string $multicurrency_code Currency code</td> <td>1</td> </tr> <tr> <td>string $desc_fourn Custom description for product_fourn_price</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode</td> <td>1</td> </tr> <tr> <td>int $fk_barcode_type Barcode type</td> <td>1</td> </tr> <tr> <td>int $id Product ID</td> <td>1</td> </tr> <tr> <td>int $priceid purchase price ID</td> <td>1</td> </tr> <tr> <td>int $mode Use this param to filter list (0 for all, 1 for only product, 2 for only service)</td> <td>1</td> </tr> <tr> <td>int $category Use this param to filter list by category of product</td> <td>1</td> </tr> <tr> <td>int $supplier Use this param to filter list by supplier</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)"</td> <td>1</td> </tr> <tr> <td>int $id ID of product</td> <td>1</td> </tr> <tr> <td>string $ref Ref of element</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of element</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of element</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:color)"</td> <td>1</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>int $id ID of Attribute</td> <td>1</td> </tr> <tr> <td>string $ref Reference of Attribute</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of Attribute</td> <td>1</td> </tr> <tr> <td>string $ref Reference of Attribute</td> <td>1</td> </tr> <tr> <td>string $label Label of Attribute</td> <td>1</td> </tr> <tr> <td>string $ref_ext Reference of Attribute</td> <td>1</td> </tr> <tr> <td>int $id ID of Attribute</td> <td>1</td> </tr> <tr> <td>int $id ID of Attribute</td> <td>1</td> </tr> <tr> <td>int $id ID of an Attribute</td> <td>1</td> </tr> <tr> <td>string $ref Ref of an Attribute</td> <td>1</td> </tr> <tr> <td>int $id ID of Attribute</td> <td>1</td> </tr> <tr> <td>string $ref Reference of Attribute value</td> <td>1</td> </tr> <tr> <td>string $value Value of Attribute value</td> <td>1</td> </tr> <tr> <td>int $id ID of Product</td> <td>1</td> </tr> <tr> <td>int $includestock Default value 0. If parameter is set to 1 the response will contain stock data of each variant</td> <td>1</td> </tr> <tr> <td>string $ref Ref of Product</td> <td>1</td> </tr> <tr> <td>float $weight_impact Weight impact of variant</td> <td>1</td> </tr> <tr> <td>float $price_impact Price impact of variant</td> <td>1</td> </tr> <tr> <td>bool $price_impact_is_percent Price impact in percent (true or false)</td> <td>1</td> </tr> <tr> <td>array $features List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...)</td> <td>1</td> </tr> <tr> <td>string $reference Customized reference of variant</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of variant</td> <td>1</td> </tr> <tr> <td>string $ref Ref of Product</td> <td>1</td> </tr> <tr> <td>float $weight_impact Weight impact of variant</td> <td>1</td> </tr> <tr> <td>float $price_impact Price impact of variant</td> <td>1</td> </tr> <tr> <td>bool $price_impact_is_percent Price impact in percent (true or false)</td> <td>1</td> </tr> <tr> <td>array $features List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...)</td> <td>1</td> </tr> <tr> <td>int $id ID of Variant</td> <td>1</td> </tr> <tr> <td>array $request_data Datas</td> <td>1</td> </tr> <tr> <td>int $id ID of Variant</td> <td>1</td> </tr> <tr> <td>int $selected_warehouse_id ID of warehouse</td> <td>1</td> </tr> <tr> <td>array $data Datas to validate</td> <td>1</td> </tr> <tr> <td>int $id ID of product</td> <td>1</td> </tr> <tr> <td>string $ref Ref of element</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of element</td> <td>1</td> </tr> <tr> <td>string $barcode Barcode of element</td> <td>1</td> </tr> <tr> <td>int $includestockdata Load also information about stock (slower)</td> <td>1</td> </tr> <tr> <td>bool $includesubproducts Load information about subproducts (if product is a virtual product)</td> <td>1</td> </tr> <tr> <td>bool $includeparentid Load also ID of parent product (if product is a variant of a parent product)</td> <td>1</td> </tr> <tr> <td>bool $includeifobjectisused Check if product object is used and set property 'is_object_used' with result.</td> <td>1</td> </tr> <tr> <td>bool $includetrans Load also the translations of product label and description</td> <td>1</td> </tr> <tr> <td>string $label label of stock movement</td> <td>1</td> </tr> <tr> <td>string $code_inv label of stock movement</td> <td>1</td> </tr> <tr> <td>int $fk_entrepot Warehouse concerned by stock movement</td> <td>1</td> </tr> <tr> <td>int $direction add or remove qty</td> <td>1</td> </tr> <tr> <td>int $id ID of warehouse</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'WH-%') and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $id Warehouse ID</td> <td>1</td> </tr> <tr> <td>Entrepot $object Object to clean</td> <td>1</td> </tr> <tr> <td>User $user Object user that create the warehouse</td> <td>1</td> </tr> <tr> <td>int $id id of warehouse to modify</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable trigge</td> <td>1</td> </tr> <tr> <td>User $user Object user that made deletion</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=No trigger</td> <td>1</td> </tr> <tr> <td>int $id Warehouse id</td> <td>1</td> </tr> <tr> <td>string $ref Warehouse label</td> <td>1</td> </tr> <tr> <td>int $id warehouse id</td> <td>1</td> </tr> <tr> <td>int $withpicto with pictogram</td> <td>1</td> </tr> <tr> <td>string $option Where the link point to</td> <td>1</td> </tr> <tr> <td>int $showfullpath 0=Show ref only. 1=Show full path instead of Ref (this->fk_parent must be defined)</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>int $id id parent warehouse</td> <td>1</td> </tr> <tr> <td>integer[] $TChildWarehouses array which will contain all children (param by reference)</td> <td>1</td> </tr> <tr> <td>int $productId Product id</td> <td>1</td> </tr> <tr> <td>Product $product Product object</td> <td>1</td> </tr> <tr> <td>bool $alreadyCheckConf [=false] conf hasn't been already checked by default or true not to check conf</td> <td>1</td> </tr> <tr> <td>int $id Id of lot/batch</td> <td>1</td> </tr> <tr> <td>int $product_id Id of product, batch number parameter required</td> <td>1</td> </tr> <tr> <td>string $batch batch number</td> <td>1</td> </tr> <tr> <td>int $status Status</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to</td> <td>1</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $maxlen Max length of visible user name</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of product</td> <td>1</td> </tr> <tr> <td>int $entrepot_id Id of warehouse</td> <td>1</td> </tr> <tr> <td>float $qty Qty of movement (can be <0 or >0 depending on parameter type)</td> <td>1</td> </tr> <tr> <td>int $type Direction of movement:</td> <td>1</td> </tr> <tr> <td>int $price Unit price HT of product, used to calculate average weighted price (AWP or PMP in french). If 0, average weighted price is not changed.</td> <td>1</td> </tr> <tr> <td>string $label Label of stock movement</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>integer|string $datem Force date of movement</td> <td>1</td> </tr> <tr> <td>integer|string $eatby eat-by date. Will be used if lot does not exists yet and will be created.</td> <td>1</td> </tr> <tr> <td>integer|string $sellby sell-by date. Will be used if lot does not exists yet and will be created.</td> <td>1</td> </tr> <tr> <td>string $batch batch number</td> <td>1</td> </tr> <tr> <td>boolean $skip_batch If set to true, stock movement is done without impacting batch record</td> <td>1</td> </tr> <tr> <td>int $id_product_batch Id product_batch (when skip_batch is false and we already know which record of product_batch to use)</td> <td>1</td> </tr> <tr> <td>int $disablestockchangeforsubproduct Disable stock change for sub-products of kit (useful only if product is a subproduct)</td> <td>1</td> </tr> <tr> <td>int $donotcleanemptylines Do not clean lines in stock table with qty=0 (because we want to have this done by the caller)</td> <td>1</td> </tr> <tr> <td>boolean $force_update_batch Allows to add batch stock movement even if $product doesn't use batch anymore</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $idProduct Id product</td> <td>1</td> </tr> <tr> <td>int $entrepot_id Warehouse id</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $type Type</td> <td>1</td> </tr> <tr> <td>int $price Price</td> <td>1</td> </tr> <tr> <td>string $label Label of movement</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>integer|string $datem Force date of movement</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $fk_product Id product</td> <td>1</td> </tr> <tr> <td>int $entrepot_id Warehouse id</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $price Price</td> <td>1</td> </tr> <tr> <td>string $label Label of stock movement</td> <td>1</td> </tr> <tr> <td>int|string $datem Force date of movement</td> <td>1</td> </tr> <tr> <td>int|string $eatby eat-by date</td> <td>1</td> </tr> <tr> <td>int|string $sellby sell-by date</td> <td>1</td> </tr> <tr> <td>string $batch batch number</td> <td>1</td> </tr> <tr> <td>int $id_product_batch Id product_batch</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $fk_product Id product</td> <td>1</td> </tr> <tr> <td>int $entrepot_id Warehouse id</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>int $price Price</td> <td>1</td> </tr> <tr> <td>string $label Label of stock movement</td> <td>1</td> </tr> <tr> <td>integer|string $eatby eat-by date</td> <td>1</td> </tr> <tr> <td>integer|string $sellby sell-by date</td> <td>1</td> </tr> <tr> <td>string $batch batch number</td> <td>1</td> </tr> <tr> <td>integer|string $datem Force date of movement</td> <td>1</td> </tr> <tr> <td>int $id_product_batch Id product_batch</td> <td>1</td> </tr> <tr> <td>string $inventorycode Inventory code</td> <td>1</td> </tr> <tr> <td>int $productidselected Id of product to count</td> <td>1</td> </tr> <tr> <td>integer $datebefore Date limit</td> <td>1</td> </tr> <tr> <td>array|int $dluo Could be either</td> <td>1</td> </tr> <tr> <td>float $qty Quantity of product with batch number. May be a negative amount.</td> <td>1</td> </tr> <tr> <td>int $origin_id Id origin</td> <td>1</td> </tr> <tr> <td>string $origin_type Type origin ('project', 'xxx@MODULENAME', etc)</td> <td>1</td> </tr> <tr> <td>string $origin_element Type of element</td> <td>1</td> </tr> <tr> <td>int $origin_id Id of element</td> <td>1</td> </tr> <tr> <td>int $line_id_object_src Id line of element Source</td> <td>1</td> </tr> <tr> <td>int $line_id_object_origin Id line of element Origin</td> <td>1</td> </tr> <tr> <td>int $withlabel With label</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('' = Tab of stock movement of warehouse, 'movements' = list of movements)</td> <td>1</td> </tr> <tr> <td>int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto</td> <td>1</td> </tr> <tr> <td>int $fk_product Product id</td> <td>1</td> </tr> <tr> <td>string $batch batch number</td> <td>1</td> </tr> <tr> <td>int $id ID of movement</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.product_id:=:1) and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $product_id Id product id {@min 1} {@from body} {@required true}</td> <td>1</td> </tr> <tr> <td>int $warehouse_id Id warehouse {@min 1} {@from body} {@required true}</td> <td>1</td> </tr> <tr> <td>float $qty Qty to add (Use negative value for a stock decrease) {@from body} {@required true}</td> <td>1</td> </tr> <tr> <td>int $type Optionally specify the type of movement. 0=input (stock increase by a stock transfer), 1=output (stock decrease by a stock transfer), 2=output (stock decrease), 3=input (stock increase). {@from body} {@type int}</td> <td>1</td> </tr> <tr> <td>string $lot Lot {@from body}</td> <td>1</td> </tr> <tr> <td>string $movementcode Movement code {@from body}</td> <td>1</td> </tr> <tr> <td>string $movementlabel Movement label {@from body}</td> <td>1</td> </tr> <tr> <td>string $price To update AWP (Average Weighted Price) when you make a stock increase (qty must be higher then 0). {@from body}</td> <td>1</td> </tr> <tr> <td>string $datem Date of movement {@from body} {@type date}</td> <td>1</td> </tr> <tr> <td>string $dlc Eat-by date. {@from body} {@type date}</td> <td>1</td> </tr> <tr> <td>string $dluo Sell-by date. {@from body} {@type date}</td> <td>1</td> </tr> <tr> <td>string $origin_type Origin type (Element of source object, like 'project', 'inventory', ...)</td> <td>1</td> </tr> <tr> <td>int $origin_id Origin id (Id of source object)</td> <td>1</td> </tr> <tr> <td>int $id Stock movement ID</td> <td>1</td> </tr> <tr> <td>MouvementStock $object Object to clean</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>int $fk_product Id product</td> <td>1</td> </tr> <tr> <td>int $fk_entrepot Id warehouse</td> <td>1</td> </tr> <tr> <td>int $fk_product Product from which we want to get limit and desired stock by warehouse</td> <td>1</td> </tr> <tr> <td>int $fk_entrepot Warehouse in which we want to get products limit and desired stock</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset limit</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter USF.</td> <td>1</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto</td> <td>1</td> </tr> <tr> <td>string $title Title of expression</td> <td>1</td> </tr> <tr> <td>Product $product The Product object to get information</td> <td>1</td> </tr> <tr> <td>String $expression The expression to parse</td> <td>1</td> </tr> <tr> <td>array $values Strings to replaces</td> <td>1</td> </tr> <tr> <td>Product $product The Product object to get information</td> <td>1</td> </tr> <tr> <td>ProductFournisseur $product_supplier The Product supplier object to get information</td> <td>1</td> </tr> <tr> <td>array $extra_values Any additional values for expression</td> <td>1</td> </tr> <tr> <td>int $product_id The Product id to get information</td> <td>1</td> </tr> <tr> <td>string $expression The expression to parse</td> <td>1</td> </tr> <tr> <td>string $next_update Next update to write</td> <td>1</td> </tr> <tr> <td>string $last_status Status to write</td> <td>1</td> </tr> <tr> <td>int $remise_percent Discount effected on Product</td> <td>1</td> </tr> <tr> <td>int $supplier_proposalid Id supplier_proposal</td> <td>1</td> </tr> <tr> <td>string $desc Description de la ligne</td> <td>1</td> </tr> <tr> <td>double $pu_ht Prix unitaire</td> <td>1</td> </tr> <tr> <td>double $txtva Taux de tva</td> <td>1</td> </tr> <tr> <td>double $pu_ttc Prix unitaire TTC</td> <td>1</td> </tr> <tr> <td>int $type Type of line (product, service)</td> <td>1</td> </tr> <tr> <td>int $fk_fournprice Id supplier price. If 0, we will take best price. If -1 we keep it empty.</td> <td>1</td> </tr> <tr> <td>string $ref_supplier Supplier price reference</td> <td>1</td> </tr> <tr> <td>string $origin 'order', 'supplier_proposal', ...</td> <td>1</td> </tr> <tr> <td>int $origin_id Id of origin line</td> <td>1</td> </tr> <tr> <td>double $pu_ht_devise Amount in currency</td> <td>1</td> </tr> <tr> <td>int $date_start Date start</td> <td>1</td> </tr> <tr> <td>int $date_end Date end</td> <td>1</td> </tr> <tr> <td>int $rowid Id de la ligne</td> <td>1</td> </tr> <tr> <td>double $pu Unit price (HT or TTC depending on price_base_type)</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>double $remise_percent Discount on line</td> <td>1</td> </tr> <tr> <td>double $txtva VAT rate</td> <td>1</td> </tr> <tr> <td>string $ref_supplier Supplier price reference</td> <td>1</td> </tr> <tr> <td>int $fromid Id of thirdparty</td> <td>1</td> </tr> <tr> <td>int $rowid id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of proposal</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $delivery_date Delivery date</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>int $statut Statut</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $idProductFournPrice id of llx_product_fournisseur_price</td> <td>1</td> </tr> <tr> <td>Product $product contain information to update</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>Product $product Object Product</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $mode "opened" for askprice to close, "signed" for proposal to invoice</td> <td>1</td> </tr> <tr> <td>string $get_params Parameters added to url</td> <td>1</td> </tr> <tr> <td>int $id Supplier proposal ID</td> <td>1</td> </tr> <tr> <td>int $id ID of supplier proposal</td> <td>1</td> </tr> <tr> <td>int $id Id of supplier proposal to update</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter supplier proposals (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>int $limit limit</td> <td>1</td> </tr> <tr> <td>int $id ID of reception</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter receptions of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $id Id of reception to update</td> <td>1</td> </tr> <tr> <td>int $id Id of reception to update</td> <td>1</td> </tr> <tr> <td>int $id Reception ID</td> <td>1</td> </tr> <tr> <td>int $id Reception ID</td> <td>1</td> </tr> <tr> <td>int $id Reception ID</td> <td>1</td> </tr> <tr> <td>int $entrepot_id Id of warehouse</td> <td>1</td> </tr> <tr> <td>int $id Id of source line (supplier order line)</td> <td>1</td> </tr> <tr> <td>float $qty Quantity</td> <td>1</td> </tr> <tr> <td>string $comment Comment for stock movement</td> <td>1</td> </tr> <tr> <td>int $eatby eat-by date</td> <td>1</td> </tr> <tr> <td>int $sellby sell-by date</td> <td>1</td> </tr> <tr> <td>string $batch Lot number</td> <td>1</td> </tr> <tr> <td>double $cost_price Line cost</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>int $option Where point the link</td> <td>1</td> </tr> <tr> <td>int $max Max length to show</td> <td>1</td> </tr> <tr> <td>int $short Use short labels</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=No tooltip</td> <td>1</td> </tr> <tr> <td>Adherent $object Object with the data</td> <td>1</td> </tr> <tr> <td>string $url Mailman URL to be called with patterns</td> <td>1</td> </tr> <tr> <td>string $list Name of mailing-list</td> <td>1</td> </tr> <tr> <td>Adherent $object Object with data (->firstname, ->lastname, ->email and ->login)</td> <td>1</td> </tr> <tr> <td>Adherent $object Object with data (->login)</td> <td>1</td> </tr> <tr> <td>object $object Object with data (->login)</td> <td>1</td> </tr> <tr> <td>string $listes To force mailing-list (string separated with ,)</td> <td>1</td> </tr> <tr> <td>string $listes To force mailing-list (string separated with ,)</td> <td>1</td> </tr> <tr> <td>User $user Object user making export</td> <td>1</td> </tr> <tr> <td>string $filter Load a particular dataset only</td> <td>1</td> </tr> <tr> <td>int $indice Indice of export</td> <td>1</td> </tr> <tr> <td>array $array_selected Filter fields on array of fields to export</td> <td>1</td> </tr> <tr> <td>array $array_filterValue Filter records on array of value for fields</td> <td>1</td> </tr> <tr> <td>string $TypeField Type of Field to filter</td> <td>1</td> </tr> <tr> <td>string $ValueField Value of the field for filter. Must not be ''</td> <td>1</td> </tr> <tr> <td>string $Field Field operand 1</td> <td>1</td> </tr> <tr> <td>string $Value Value operand 2</td> <td>1</td> </tr> <tr> <td>string $Sens Comparison operator</td> <td>1</td> </tr> <tr> <td>string $TypeField Type of Field to filter. Example: Text, Date, List:c_country:label:rowid, List:c_stcom:label:code, Numeric or Number, Boolean</td> <td>1</td> </tr> <tr> <td>string $ValueField Initial value of the field to filter</td> <td>1</td> </tr> <tr> <td>string $TypeField Type of Field to filter</td> <td>1</td> </tr> <tr> <td>User $user User that export</td> <td>1</td> </tr> <tr> <td>string $model Export format</td> <td>1</td> </tr> <tr> <td>string $datatoexport Name of dataset to export</td> <td>1</td> </tr> <tr> <td>array $array_selected Filter on array of fields to export</td> <td>1</td> </tr> <tr> <td>array $array_filterValue Filter on array of fields with a filter</td> <td>1</td> </tr> <tr> <td>string $sqlquery If set, transmit the sql request for select (otherwise, sql request is generated from arrays)</td> <td>1</td> </tr> <tr> <td>string $separator separator to fill $objmodel->separator with the new separator</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $id ID of knowledgerecord</td> <td>1</td> </tr> <tr> <td>int $id ID of knowledgerecord object</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>int $category Use this param to filter list by category</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>int $id Id of knowledgerecord to update</td> <td>1</td> </tr> <tr> <td>int $id KnowledgeRecord ID</td> <td>1</td> </tr> <tr> <td>int $id ID of task</td> <td>1</td> </tr> <tr> <td>int $includetimespent 0=Return only task. 1=Include a summary of time spent, 2=Include details of time spent lines</td> <td>1</td> </tr> <tr> <td>int $id Id of task</td> <td>1</td> </tr> <tr> <td>int $userid Id of user (0 = connected user)</td> <td>1</td> </tr> <tr> <td>int $id Id of task to update</td> <td>1</td> </tr> <tr> <td>int $id Task ID</td> <td>1</td> </tr> <tr> <td>int $id ID of project</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref_Ext of project</td> <td>1</td> </tr> <tr> <td>string $email_msgid Email msgid of project</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter projects of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>int $id Id of project</td> <td>1</td> </tr> <tr> <td>int $includetimespent 0=Return only list of tasks. 1=Include a summary of time spent, 2=Include details of time spent lines</td> <td>1</td> </tr> <tr> <td>int $id Id of project</td> <td>1</td> </tr> <tr> <td>int $userid Id of user (0 = connected user)</td> <td>1</td> </tr> <tr> <td>int $taskid Id of task to update</td> <td>1</td> </tr> <tr> <td>int $id Id of project to update</td> <td>1</td> </tr> <tr> <td>int $id Project ID</td> <td>1</td> </tr> <tr> <td>int $id Project ID</td> <td>1</td> </tr> <tr> <td>User $user User making creation</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User object of making update</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Disable all triggers</td> <td>1</td> </tr> <tr> <td>int $id Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref_ext Ref ext of project</td> <td>1</td> </tr> <tr> <td>int $id Project id</td> <td>1</td> </tr> <tr> <td>string $key Key to substitute</td> <td>1</td> </tr> <tr> <td>bool $fetched [=false] Not already fetched</td> <td>1</td> </tr> <tr> <td>string $type 'propal','order','invoice','order_supplier','invoice_supplier',...</td> <td>1</td> </tr> <tr> <td>string $tablename name of table associated of the type</td> <td>1</td> </tr> <tr> <td>string $datefieldname name of date field for filter</td> <td>1</td> </tr> <tr> <td>int $date_start Start date</td> <td>1</td> </tr> <tr> <td>int $date_end End date</td> <td>1</td> </tr> <tr> <td>string $projectkey Equivalent key to fk_projet for actual type</td> <td>1</td> </tr> <tr> <td>string $type The type of the linked elements (e.g. 'propal', 'order', 'invoice', 'order_supplier', 'invoice_supplier')</td> <td>1</td> </tr> <tr> <td>string $tablename The name of table associated of the type</td> <td>1</td> </tr> <tr> <td>string $projectkey (optional) Equivalent key to fk_projet for actual type</td> <td>1</td> </tr> <tr> <td>User $user User</td> <td>1</td> </tr> <tr> <td>User $user User that validate</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Disable triggers</td> <td>1</td> </tr> <tr> <td>User $user User that close project</td> <td>1</td> </tr> <tr> <td>int $status id status</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto</td> <td>1</td> </tr> <tr> <td>string $option Variant where the link point to ('', 'nolink')</td> <td>1</td> </tr> <tr> <td>int $addlabel 0=Default, 1=Add label into string, >1=Add first chars into string</td> <td>1</td> </tr> <tr> <td>string $moreinpopup Text to add into popup</td> <td>1</td> </tr> <tr> <td>string $sep Separator between ref and label if option addlabel is set</td> <td>1</td> </tr> <tr> <td>string $morecss More css on a link</td> <td>1</td> </tr> <tr> <td>string $save_pageforbacktolist Back to this page 'context:url'</td> <td>1</td> </tr> <tr> <td>User $user Object user to evaluate</td> <td>1</td> </tr> <tr> <td>string $mode Type of permission we want to know: 'read', 'write'</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>int $mode 0=All project I have permission on (assigned to me or public), 1=Projects assigned to me only, 2=Will return list of all projects with no test on contacts</td> <td>1</td> </tr> <tr> <td>int $list 0=Return array, 1=Return string list</td> <td>1</td> </tr> <tr> <td>int $socid 0=No filter on third party, id of third party</td> <td>1</td> </tr> <tr> <td>string $filter additional filter on project (statut, ref, ...)</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>bool $clone_contact Clone contact of project</td> <td>1</td> </tr> <tr> <td>bool $clone_task Clone task of project</td> <td>1</td> </tr> <tr> <td>bool $clone_project_file Clone file of project</td> <td>1</td> </tr> <tr> <td>bool $clone_task_file Clone file of task (if task are copied)</td> <td>1</td> </tr> <tr> <td>bool $clone_note Clone note of project</td> <td>1</td> </tr> <tr> <td>bool $move_date Move task date on clone</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger flag</td> <td>1</td> </tr> <tr> <td>int $newthirdpartyid New thirdparty id</td> <td>1</td> </tr> <tr> <td>integer $old_project_dt_start Old project start date</td> <td>1</td> </tr> <tr> <td>string $projectfield The column name that stores the link with the project</td> <td>1</td> </tr> <tr> <td>string $modele Force template to use ('' by default)</td> <td>1</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>1</td> </tr> <tr> <td>int $origin_id Old thirdparty id</td> <td>1</td> </tr> <tr> <td>int $dest_id New thirdparty id</td> <td>1</td> </tr> <tr> <td>User $user Object user we want project allowed to</td> <td>1</td> </tr> <tr> <td>int $loadRoleMode 1= will test Roles on task; 0 used in delete project action</td> <td>1</td> </tr> <tr> <td>int $wonlostfilter Add a filter on status won/lost</td> <td>1</td> </tr> <tr> <td>int $year Year to scan</td> <td>1</td> </tr> <tr> <td>int $wonlostfilter Add a filter on status won/lost</td> <td>1</td> </tr> <tr> <td>int $endyear End year</td> <td>1</td> </tr> <tr> <td>int $startyear Start year</td> <td>1</td> </tr> <tr> <td>int $cachedelay accept for cache file (0=No read, no save of cache, -1=No read but save)</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $ref ref object</td> <td>1</td> </tr> <tr> <td>int $loadparentdata Also load parent data</td> <td>1</td> </tr> <tr> <td>string $option 'withproject' or ''</td> <td>1</td> </tr> <tr> <td>string $mode Mode 'task', 'time', 'contact', 'note', document' define page to link to.</td> <td>1</td> </tr> <tr> <td>int $addlabel 0=Default, 1=Add label into string, >1=Add first chars into string</td> <td>1</td> </tr> <tr> <td>string $sep Separator between ref and label if option addlabel is set</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>User $usert Object user to limit tasks affected to a particular user</td> <td>1</td> </tr> <tr> <td>User $userp Object user to limit projects of a particular user and public projects</td> <td>1</td> </tr> <tr> <td>int $socid Third party id</td> <td>1</td> </tr> <tr> <td>string $filteronproj Filter on project ref or label</td> <td>1</td> </tr> <tr> <td>string $filteronprojstatus Filter on project status ('-1'=no filter, '0,1'=Draft+Validated only)</td> <td>1</td> </tr> <tr> <td>string $morewherefilter Add more filter into where SQL request (must start with ' AND ...')</td> <td>1</td> </tr> <tr> <td>int $filteronprojuser Filter on user that is a contact of project</td> <td>1</td> </tr> <tr> <td>int $filterontaskuser Filter on user assigned to task</td> <td>1</td> </tr> <tr> <td>?Extrafields $extrafields Show additional column from project or task</td> <td>1</td> </tr> <tr> <td>int $includebilltime Calculate also the time to bill and billed</td> <td>1</td> </tr> <tr> <td>array $search_array_options Array of search filters. Not Used yet.</td> <td>1</td> </tr> <tr> <td>int $loadextras Fetch all Extrafields on each project and task</td> <td>1</td> </tr> <tr> <td>int $loadRoleMode 1= will test Roles on task; 0 used in delete project action</td> <td>1</td> </tr> <tr> <td>User|null $userp Return roles on project for this internal user. If set, usert and taskid must not be defined.</td> <td>1</td> </tr> <tr> <td>User|null $usert Return roles on task for this internal user. If set userp must NOT be defined. -1 means no filter.</td> <td>1</td> </tr> <tr> <td>string $projectid Project id list separated with , to filter on project</td> <td>1</td> </tr> <tr> <td>int $taskid Task id to filter on a task</td> <td>1</td> </tr> <tr> <td>integer $filteronprojstatus Filter on project status if userp is set. Not used if userp not defined.</td> <td>1</td> </tr> <tr> <td>string $source Source</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>string $morewherefilter Add more filter into where SQL request (must start with ' AND ...')</td> <td>1</td> </tr> <tr> <td>User|int $userobj Filter on user. null or 0=No filter</td> <td>1</td> </tr> <tr> <td>User|string $fuser Filter on a dedicated user</td> <td>1</td> </tr> <tr> <td>string $dates Start date (ex 00:00:00)</td> <td>1</td> </tr> <tr> <td>string $datee End date (ex 23:59:59)</td> <td>1</td> </tr> <tr> <td>int $id Id in time spent table</td> <td>1</td> </tr> <tr> <td>User $userobj User object</td> <td>1</td> </tr> <tr> <td>User $user User id</td> <td>1</td> </tr> <tr> <td>User $user User making the clone</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>int $project_id Id of project to attach clone task</td> <td>1</td> </tr> <tr> <td>int $parent_task_id Id of task to attach clone task</td> <td>1</td> </tr> <tr> <td>bool $clone_change_dt recalculate date of task regarding new project start date</td> <td>1</td> </tr> <tr> <td>bool $clone_affectation clone affectation of project</td> <td>1</td> </tr> <tr> <td>bool $clone_time clone time of project</td> <td>1</td> </tr> <tr> <td>bool $clone_file clone file of project</td> <td>1</td> </tr> <tr> <td>bool $clone_note clone note of project</td> <td>1</td> </tr> <tr> <td>bool $clone_prog clone progress of project</td> <td>1</td> </tr> <tr> <td>integer $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>integer $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>1</td> </tr> <tr> <td>int $task_origin_id Task to merge the data from</td> <td>1</td> </tr> <tr> <td>int $id Bookmark Id Loader</td> <td>1</td> </tr> <tr> <td>User $user User deleting</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>int $limit limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>User $user User that modifies</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>int $idline Id of line to delete</td> <td>1</td> </tr> <tr> <td>User $user User making status change</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)</td> <td>1</td> </tr> <tr> <td>string $option On what the link point to ('nolink', ...)</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>?array{type:string,label:string,enabled:int|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $val Array of properties for field to show</td> <td>1</td> </tr> <tr> <td>string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)</td> <td>1</td> </tr> <tr> <td>int<0,1> $nonewbutton Do not show new button</td> <td>1</td> </tr> <tr> <td>array $val Array of properties of field to show</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>mixed $morecss Value for css to define size. May also be a numeric.</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>int $userid id of user we need to get position list</td> <td>1</td> </tr> <tr> <td>string $modele Force template to use ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs object lang a utiliser pour traduction</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide details of lines</td> <td>1</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>1</td> </tr> <tr> <td>int $hideref Hide ref</td> <td>1</td> </tr> <tr> <td>null|array $moreparams Array to provide more information</td> <td>1</td> </tr> <tr> <td>User $user User making the change</td> <td>1</td> </tr> <tr> <td>int $fk_user Id of user we need to get last job</td> <td>1</td> </tr> <tr> <td>int $userid Id of user we need to get job list</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>int $fk_user ID of user we need to get last eval</td> <td>1</td> </tr> <tr> <td>int $fk_object id of Job object (if new job object)</td> <td>1</td> </tr> <tr> <td>SkillRank $currentSkill line of evaluation (skill) we need to clone and add to user skills list</td> <td>1</td> </tr> <tr> <td>int $fk_user id of user linked to skillrank</td> <td>1</td> </tr> <tr> <td>int $offset Offset</td> <td>1</td> </tr> <tr> <td>int $i Rank from which we want to create skilldets (level $i to HRM_MAXRANK will be created)</td> <td>1</td> </tr> <tr> <td>int $code number of code label</td> <td>1</td> </tr> <tr> <td>User $user User object</td> <td>1</td> </tr> <tr> <td>int $notrigger no trigger</td> <td>1</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Reference of fichinter</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of fichinter</td> <td>1</td> </tr> <tr> <td>int $sall sall</td> <td>1</td> </tr> <tr> <td>string $desc Line description</td> <td>1</td> </tr> <tr> <td>integer $duration Duration</td> <td>1</td> </tr> <tr> <td>string $date Date</td> <td>1</td> </tr> <tr> <td>int $rang Position of line</td> <td>1</td> </tr> <tr> <td>double $pu_ht Unit price without tax (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>double $qty Quantity</td> <td>1</td> </tr> <tr> <td>double $txtva Forced VAT rate, otherwise -1</td> <td>1</td> </tr> <tr> <td>int $fk_product Id of predefined product/service</td> <td>1</td> </tr> <tr> <td>double $remise_percent Percentage of discount for line</td> <td>1</td> </tr> <tr> <td>int $fk_remise_except Id discount (not used)</td> <td>1</td> </tr> <tr> <td>double $pu_ttc Unit price with tax (> 0 even for credit note)</td> <td>1</td> </tr> <tr> <td>int $freq Freq</td> <td>1</td> </tr> <tr> <td>string $courant Courant</td> <td>1</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>string $option Where point the link</td> <td>1</td> </tr> <tr> <td>int $max Maxlength of ref</td> <td>1</td> </tr> <tr> <td>int $short 1=Return just URL</td> <td>1</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>1</td> </tr> <tr> <td>int $validate 0 to create in draft, 1 to create and validate fichinter</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>int $socid Id third party for filter. This value must be forced during the new to external user company if user is an external user.</td> <td>1</td> </tr> <tr> <td>string $mode Option ('customer', 'supplier')</td> <td>1</td> </tr> <tr> <td>int $userid Id user for filter (creation user)</td> <td>1</td> </tr> <tr> <td>int $limit Limit for list</td> <td>1</td> </tr> <tr> <td>int $page Page number</td> <td>1</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>1</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>int $id Id of intervention</td> <td>1</td> </tr> <tr> <td>int $id Id of intervention to update</td> <td>1</td> </tr> <tr> <td>int $rowid Id of intervention</td> <td>1</td> </tr> <tr> <td>string $ref Ref of intervention</td> <td>1</td> </tr> <tr> <td>User $user User that set draft</td> <td>1</td> </tr> <tr> <td>string $modele Force model to use ('' to not force)</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Object langs to use for output</td> <td>1</td> </tr> <tr> <td>int $hidedetails Hide details of lines</td> <td>1</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>1</td> </tr> <tr> <td>int $hideref Hide ref</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=_No picto, 1=Includes the picto in the linkn, 2=Picto only</td> <td>1</td> </tr> <tr> <td>string $option Options</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>User $user Object user who define</td> <td>1</td> </tr> <tr> <td>integer $date_delivery date of delivery</td> <td>1</td> </tr> <tr> <td>string $description description</td> <td>1</td> </tr> <tr> <td>int $contractid Description</td> <td>1</td> </tr> <tr> <td>user $user User that do the action</td> <td>1</td> </tr> <tr> <td>int $fichinterid Id of intervention</td> <td>1</td> </tr> <tr> <td>string $desc Line description</td> <td>1</td> </tr> <tr> <td>integer $date_intervention Intervention date</td> <td>1</td> </tr> <tr> <td>int $duration Intervention duration</td> <td>1</td> </tr> <tr> <td>array $array_options Array option</td> <td>1</td> </tr> <tr> <td>int $rowid Line id</td> <td>1</td> </tr> <tr> <td>string $instructions Instruction to generate content</td> <td>1</td> </tr> <tr> <td>string $model Model name ('gpt-3.5-turbo', 'gpt-4-turbo', 'dall-e-3', ...)</td> <td>1</td> </tr> <tr> <td>string $function Code of the feature we want to use ('textgeneration', 'transcription', 'audiotext', 'imagegeneration', 'translation')</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>mixed $contact Contact</td> <td>1</td> </tr> <tr> <td>Societe $societe Object societe</td> <td>1</td> </tr> <tr> <td>Adherent $adherent Member</td> <td>1</td> </tr> <tr> <td>int $activeOnly filter if active</td> <td>1</td> </tr> <tr> <td>string $sortfield field for sorting</td> <td>1</td> </tr> <tr> <td>string $sortorder sorting order</td> <td>1</td> </tr> <tr> <td>int $limit sort limit</td> <td>1</td> </tr> <tr> <td>int $page page to start on</td> <td>1</td> </tr> <tr> <td>string $str String to encode</td> <td>1</td> </tr> <tr> <td>object $object Current object we will set ->properties</td> <td>1</td> </tr> <tr> <td>string $actionparam Action parameters</td> <td>1</td> </tr> <tr> <td>string $messagetext Body</td> <td>1</td> </tr> <tr> <td>string $header Header</td> <td>1</td> </tr> <tr> <td>string $operationslog String with logs of operations done</td> <td>1</td> </tr> <tr> <td>int $mode 0=Mode production, 1=Mode test (read IMAP and try SQL update then rollback), 2=Mode test with no SQL updates</td> <td>1</td> </tr> <tr> <td>Object $mbox Structure</td> <td>1</td> </tr> <tr> <td>string $mid UID email</td> <td>1</td> </tr> <tr> <td>string $destdir Target dir for attachments. Leave blank to parse without writing to disk.</td> <td>1</td> </tr> <tr> <td>Object $mbox Structure</td> <td>1</td> </tr> <tr> <td>string $mid Part no</td> <td>1</td> </tr> <tr> <td>Object $p Object p</td> <td>1</td> </tr> <tr> <td>string $partno Partno</td> <td>1</td> </tr> <tr> <td>string $destdir Target dir for attachments. Leave blank to parse without writing to disk.</td> <td>1</td> </tr> <tr> <td>string $string String to convert</td> <td>1</td> </tr> <tr> <td>string $fromEncoding String encoding</td> <td>1</td> </tr> <tr> <td>string $toEncoding String return encoding</td> <td>1</td> </tr> <tr> <td>string $destdir destination</td> <td>1</td> </tr> <tr> <td>string $filename filename</td> <td>1</td> </tr> <tr> <td>string $content content</td> <td>1</td> </tr> <tr> <td>int|Webklex\PHPIMAP\Message $imapemail UID as int (if native IMAP) or as object (if external library)</td> <td>1</td> </tr> <tr> <td>string $origin_id Id of order</td> <td>1</td> </tr> <tr> <td>string $qty Quantity</td> <td>1</td> </tr> <tr> <td>string $fk_product Id of predefined product</td> <td>1</td> </tr> <tr> <td>string $description Description</td> <td>1</td> </tr> <tr> <td>int $id Id of object to load</td> <td>1</td> </tr> <tr> <td>User $user Object user that validate</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>1</td> </tr> <tr> <td>User $user User who creates</td> <td>1</td> </tr> <tr> <td>int $sending_id Id of the expedition that serves as a model</td> <td>1</td> </tr> <tr> <td>int $id Id of line (livraison line)</td> <td>1</td> </tr> <tr> <td>int $origin_id Origin id</td> <td>1</td> </tr> <tr> <td>float $qty Qty</td> <td>1</td> </tr> <tr> <td>int $lineid Line id</td> <td>1</td> </tr> <tr> <td>User $user User making the deletion</td> <td>1</td> </tr> <tr> <td>string $action Action</td> <td>1</td> </tr> <tr> <td>string $getRef Reference of object</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $track_id Track id, a hash like ref</td> <td>1</td> </tr> <tr> <td>string $email_msgid Email msgid</td> <td>1</td> </tr> <tr> <td>User $user User for action</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset page</td> <td>1</td> </tr> <tr> <td>int $arch Archive or not (not used)</td> <td>1</td> </tr> <tr> <td>string|array $filter Filter for query</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>User $user User that clone</td> <td>1</td> </tr> <tr> <td>string $selected Selected status</td> <td>1</td> </tr> <tr> <td>int $publicgroup 0=No public group, 1=Public group only, -1=All</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $status Id status</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=No tooltip</td> <td>1</td> </tr> <tr> <td>int $progress Progression (0 to 100)</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>1</td> </tr> <tr> <td>User $user Object user</td> <td>1</td> </tr> <tr> <td>int $id_assign_user ID of user assigned</td> <td>1</td> </tr> <tr> <td>int $notrigger Disable trigger</td> <td>1</td> </tr> <tr> <td>User $user User that creates</td> <td>1</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>array $filename_list List of files to attach (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>array $mimetype_list List of MIME type of attached files</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list List of attached file name in message</td> <td>1</td> </tr> <tr> <td>boolean $send_email Whether the message is sent by email</td> <td>1</td> </tr> <tr> <td>int $public_area 0=Default, 1 if we are creating the message from a public area (so we can search contact from email to add it as contact of ticket if TICKET_ASSIGN_CONTACT_TO_MESSAGE is set)</td> <td>1</td> </tr> <tr> <td>User $user User that close</td> <td>1</td> </tr> <tr> <td>int $mode 0=Close solved, 1=Close abandoned</td> <td>1</td> </tr> <tr> <td>string $email Email</td> <td>1</td> </tr> <tr> <td>int $type Type of thirdparties (0=any, 1=customer, 2=prospect, 3=supplier)</td> <td>1</td> </tr> <tr> <td>array $filters Array of couple field name/value to filter the companies with the same name</td> <td>1</td> </tr> <tr> <td>string $clause Clause for filters</td> <td>1</td> </tr> <tr> <td>string $email Email</td> <td>1</td> </tr> <tr> <td>int $socid Limit to a thirdparty</td> <td>1</td> </tr> <tr> <td>string $case Respect case</td> <td>1</td> </tr> <tr> <td>int $id Id of thirdparty to set or '' to remove</td> <td>1</td> </tr> <tr> <td>int $percent Progression percent</td> <td>1</td> </tr> <tr> <td>int $contractid Contract id to link element to</td> <td>1</td> </tr> <tr> <td>int $status Status of user or company array<array{id:int,email:string,firstname:string,lastname:string,libelle:string}></td> <td>1</td> </tr> <tr> <td>int $status Status of user or company</td> <td>1</td> </tr> <tr> <td>int $statusoflink Status of lines to get (-1=all)</td> <td>1</td> </tr> <tr> <td>string $source Source of contact: external or thirdparty (llx_socpeople) or internal (llx_user)</td> <td>1</td> </tr> <tr> <td>int $list 0:Return array contains all properties, 1:Return array contains just id</td> <td>1</td> </tr> <tr> <td>string $code Filter on this code of contact type ('SHIPPING', 'BILLING', ...)</td> <td>1</td> </tr> <tr> <td>int $status Status of user or company</td> <td>1</td> </tr> <tr> <td>Societe $thirdparty Thirdparty</td> <td>1</td> </tr> <tr> <td>string $sdir Directory to scan</td> <td>1</td> </tr> <tr> <td>string $forcetrackid Force trackid used for $keytoavoidconflict into get_attached_files()</td> <td>1</td> </tr> <tr> <td>User $user User for action</td> <td>1</td> </tr> <tr> <td>string $action Action string</td> <td>1</td> </tr> <tr> <td>int $private 1=Message is private (must not be visible by external users)</td> <td>1</td> </tr> <tr> <td>int $public_area 0=Default,</td> <td>1</td> </tr> <tr> <td>string $subject Email subject</td> <td>1</td> </tr> <tr> <td>string $message Email message</td> <td>1</td> </tr> <tr> <td>int $send_internal_cc Receive a copy on internal email (getDolGlobalString('TICKET_NOTIFICATION_EMAIL_FROM')</td> <td>1</td> </tr> <tr> <td>array $array_receiver Array of receiver. Example array('name' => 'John Doe', 'email' => 'john@doe.com', etc...)</td> <td>1</td> </tr> <tr> <td>array $filename_list List of files to attach (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>array $mimetype_list List of MIME type of attached files</td> <td>1</td> </tr> <tr> <td>array $mimefilename_list List of attached file name in message</td> <td>1</td> </tr> <tr> <td>int $mode "opened" for askprice to close, "signed" for proposal to invoice</td> <td>1</td> </tr> <tr> <td>int $id ID of ticket</td> <td>1</td> </tr> <tr> <td>string $ref Reference of ticket</td> <td>1</td> </tr> <tr> <td>string $track_id Track ID of ticket (for public area)</td> <td>1</td> </tr> <tr> <td>int $mode Display mode</td> <td>1</td> </tr> <tr> <td>int $id Object id</td> <td>1</td> </tr> <tr> <td>string $action Type of action</td> <td>1</td> </tr> <tr> <td>User $user User which display</td> <td>1</td> </tr> <tr> <td>string $action Action mode</td> <td>1</td> </tr> <tr> <td>Ticket $object Object ticket</td> <td>1</td> </tr> <tr> <td>boolean $show_private Show private messages</td> <td>1</td> </tr> <tr> <td>boolean $show_user Show user who make action</td> <td>1</td> </tr> <tr> <td>Ticket $object Object ticket</td> <td>1</td> </tr> <tr> <td>boolean $show_private Show private messages</td> <td>1</td> </tr> <tr> <td>boolean $show_user Show user who make action</td> <td>1</td> </tr> <tr> <td>Ticket $object Object ticket</td> <td>1</td> </tr> <tr> <td>Ticket $object Ticket sup</td> <td>1</td> </tr> <tr> <td>array $parameters Parameters</td> <td>1</td> </tr> <tr> <td>Ticket $object Object for action</td> <td>1</td> </tr> <tr> <td>string $action Action string</td> <td>1</td> </tr> <tr> <td>HookManager $hookmanager Hookmanager object</td> <td>1</td> </tr> <tr> <td>int $socid Filter list with thirdparty ID</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101') and (t.fk_statut:=:1)"</td> <td>1</td> </tr> <tr> <td>int $id Id of ticket to update</td> <td>1</td> </tr> <tr> <td>int $id Ticket ID</td> <td>1</td> </tr> <tr> <td>int $socid Id third party</td> <td>1</td> </tr> <tr> <td>mixed $userid Id user for filter or array of user ids</td> <td>1</td> </tr> <tr> <td>int $year Year to scan</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>string $field Field name</td> <td>1</td> </tr> <tr> <td>string|array $value Value to check/clean</td> <td>1</td> </tr> <tr> <td>Object $object Object</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string $cachedir Cache dir</td> <td>1</td> </tr> <tr> <td>boolean $refreshCache Update cache</td> <td>1</td> </tr> <tr> <td>String $properties Comma separated list of properties names</td> <td>1</td> </tr> <tr> <td>Object $object Object to clean</td> <td>1</td> </tr> <tr> <td>string $resource element to check</td> <td>1</td> </tr> <tr> <td>int $resource_id Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).</td> <td>1</td> </tr> <tr> <td>string $dbtablename 'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)</td> <td>1</td> </tr> <tr> <td>string $feature2 Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.</td> <td>1</td> </tr> <tr> <td>string $dbt_keyfield Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)</td> <td>1</td> </tr> <tr> <td>string $dbt_select Field name for select if not rowid. Not used if objectid is null (optional)</td> <td>1</td> </tr> <tr> <td>string $sqlfilters sqlfilter string</td> <td>1</td> </tr> <tr> <td>string $error Error message</td> <td>1</td> </tr> <tr> <td>array $matches Array of found string by regex search.</td> <td>1</td> </tr> <tr> <td>array $m Properties of method</td> <td>1</td> </tr> <tr> <td>string $sqlfilters SQL criteria to filter with. Syntax example "(t.code:=:'CHQ')"</td> <td>1</td> </tr> <tr> <td>int $country To filter on country</td> <td>1</td> </tr> <tr> <td>string $filter To filter the regions by name</td> <td>1</td> </tr> <tr> <td>int $country To filter on country</td> <td>1</td> </tr> <tr> <td>string $filter To filter the states by name</td> <td>1</td> </tr> <tr> <td>string $filter To filter the countries by name</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the label of the countries must be translated to</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the name of the country must be translated to</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>1</td> </tr> <tr> <td>int $limit Number of items per page</td> <td>1</td> </tr> <tr> <td>int $page Page number {@min 0}</td> <td>1</td> </tr> <tr> <td>int $active Delivery times is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>string $sqlfilters SQL criteria to filter with.</td> <td>1</td> </tr> <tr> <td>Object $object Object to clean</td> <td>1</td> </tr> <tr> <td>object $object Object with label to translate</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the name of the object must be translated to</td> <td>1</td> </tr> <tr> <td>string $prefix Prefix for translation key</td> <td>1</td> </tr> <tr> <td>array $dict Array of dictionary for translation</td> <td>1</td> </tr> <tr> <td>string $type To filter on type of event</td> <td>1</td> </tr> <tr> <td>string $module To filter on module</td> <td>1</td> </tr> <tr> <td>string $type To filter on type of contact</td> <td>1</td> </tr> <tr> <td>string $module To filter on module contacts</td> <td>1</td> </tr> <tr> <td>int $active Contact's type is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $active Civility is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $multicurrency Multicurrency rates (0: no multicurrency, 1: last rate, 2: all rates) {@min 0} {@max 2}</td> <td>1</td> </tr> <tr> <td>string $elementtype Type of element ('adherent', 'commande', 'thirdparty', 'facture', 'propal', 'product', ...)</td> <td>1</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'SO-%')"</td> <td>1</td> </tr> <tr> <td>string $attrname extrafield attrname</td> <td>1</td> </tr> <tr> <td>string $elementtype extrafield elementtype</td> <td>1</td> </tr> <tr> <td>string $zipcode To filter on zipcode</td> <td>1</td> </tr> <tr> <td>string $town To filter on city name</td> <td>1</td> </tr> <tr> <td>int $active Town is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $active Shipping methodsm is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the label of the method must be translated to</td> <td>1</td> </tr> <tr> <td>int $active Measuring unit is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $country To filter on country</td> <td>1</td> </tr> <tr> <td>int $active Lega form is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $active Staff is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>int $active Social network is active or not {@min 0} {@max 1}</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the label of the category must be translated to</td> <td>1</td> </tr> <tr> <td>string $lang Code of the language the label of the severity must be translated to</td> <td>1</td> </tr> <tr> <td>int $id ID of establishment</td> <td>1</td> </tr> <tr> <td>string $constantname Name of conf variable to get</td> <td>1</td> </tr> <tr> <td>string $target Can be 'local' or 'default' or Url of the signatures file to use for the test. Must be reachable by the tested Dolibarr.</td> <td>1</td> </tr> <tr> <td>string $modulepart Name of module or area concerned by file download ('facture', ...)</td> <td>1</td> </tr> <tr> <td>string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf)</td> <td>1</td> </tr> <tr> <td>string $modulepart Name of module or area concerned by file download ('thirdparty', 'member', 'proposal', 'supplier_proposal', 'order', 'supplier_order', 'invoice', 'supplier_invoice', 'shipment', 'project', ...)</td> <td>1</td> </tr> <tr> <td>string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf).</td> <td>1</td> </tr> <tr> <td>string $doctemplate Set here the doc template to use for document generation (If not set, use the default template).</td> <td>1</td> </tr> <tr> <td>string $langcode Language code like 'en_US', 'fr_FR', 'es_ES', ... (If not set, use the default language).</td> <td>1</td> </tr> <tr> <td>string $modulepart Name of module or area concerned ('thirdparty', 'member', 'proposal', 'order', 'invoice', 'supplier_invoice', 'shipment', 'project', ...)</td> <td>1</td> </tr> <tr> <td>int $id ID of element</td> <td>1</td> </tr> <tr> <td>string $ref Ref of element</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort criteria ('','fullname','relativename','name','date','size')</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order ('asc' or 'desc')</td> <td>1</td> </tr> <tr> <td>int $id ID of document</td> <td>1</td> </tr> <tr> <td>string $filename Name of file to create ('FA1705-0123.txt')</td> <td>1</td> </tr> <tr> <td>string $modulepart Name of module or area concerned by file upload ('product', 'service', 'invoice', 'proposal', 'project', 'project_task', 'supplier_invoice', 'expensereport', 'member', ...)</td> <td>1</td> </tr> <tr> <td>string $ref Reference of object (This will define subdir automatically and store submitted file into it)</td> <td>1</td> </tr> <tr> <td>string $subdir Subdirectory (Only if ref not provided)</td> <td>1</td> </tr> <tr> <td>string $filecontent File content (string with file content. An empty file will be created if this parameter is not provided)</td> <td>1</td> </tr> <tr> <td>string $fileencoding File encoding (''=no encoding, 'base64'=Base 64)</td> <td>1</td> </tr> <tr> <td>int $overwriteifexists Overwrite file if exists (1 by default)</td> <td>1</td> </tr> <tr> <td>int $createdirifnotexists Create subdirectories if the doesn't exists (1 by default)</td> <td>1</td> </tr> <tr> <td>string $modulepart Name of module or area concerned by file download ('product', ...)</td> <td>1</td> </tr> <tr> <td>string $original_file Relative path with filename, relative to modulepart (for example: PRODUCT-REF-999/IMAGE-999.jpg)</td> <td>1</td> </tr> <tr> <td>string $elementEn Element (english) : "member" (for adherent), "partnership"</td> <td>1</td> </tr> <tr> <td>int $id [=0] ID element</td> <td>1</td> </tr> <tr> <td>int $permissiontoread [=0] Permission to read (0 : access forbidden by default)</td> <td>1</td> </tr> <tr> <td>int $permissiontoadd [=0] Permission to add (0 : access forbidden by default), used by the include of actions_addupdatedelete.inc.php and actions_lineupdown.inc.php</td> <td>1</td> </tr> <tr> <td>int $permissiontodelete [=0] Permission to delete (0 : access forbidden by default)</td> <td>1</td> </tr> <tr> <td>int $permissionnote [=0] Permission to note (0 : access forbidden by default)</td> <td>1</td> </tr> <tr> <td>int $permissiondellink [=0] Permission to delete links (0 : access forbidden by default)</td> <td>1</td> </tr> <tr> <td>Context $context Context object</td> <td>1</td> </tr> <tr> <td>string $keyforbreak [=''] Key for break left block</td> <td>1</td> </tr> <tr> <td>Context $context Context object</td> <td>1</td> </tr> <tr> <td>int $withpictoimg 0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small)</td> <td>1</td> </tr> <tr> <td>int $maxlen Length max label</td> <td>1</td> </tr> <tr> <td>string $option Page for link ('card', 'category', 'subscription', ...)</td> <td>1</td> </tr> <tr> <td>string $mode ''=Show firstname+lastname as label (using default order), 'firstname'=Show only firstname, 'lastname'=Show only lastname, 'login'=Show login, 'ref'=Show ref</td> <td>1</td> </tr> <tr> <td>int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto</td> <td>1</td> </tr> <tr> <td>int $status Id status</td> <td>1</td> </tr> <tr> <td>int $need_subscription 1 if member type need subscription, 0 otherwise</td> <td>1</td> </tr> <tr> <td>int $date_end_subscription Date fin adhesion</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>string $htmlkey HTML id to make banner content unique</td> <td>1</td> </tr> <tr> <td>string $type Type of input : button, checkbox, color, email, hidden, month, number, password, radio, range, tel, text, time, url, week</td> <td>1</td> </tr> <tr> <td>string $value [=''] Value</td> <td>1</td> </tr> <tr> <td>string $label [=''] Label</td> <td>1</td> </tr> <tr> <td>string $addInputLabel [=''] Add label for input</td> <td>1</td> </tr> <tr> <td>string $name Name of html input</td> <td>1</td> </tr> <tr> <td>string $value [=''] Value of input (format : YYYY-MM-DD)</td> <td>1</td> </tr> <tr> <td>string $placeholder [=''] Placeholder for input (keep empty for no label)</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of html select area.</td> <td>1</td> </tr> <tr> <td>array $array Array like array(key => value) or array(key=>array('label'=>..., 'data-...'=>..., 'disabled'=>..., 'css'=>...))</td> <td>1</td> </tr> <tr> <td>string|string[] $id Preselected key or preselected keys for multiselect. Use 'ifone' to autoselect record if there is only one record.</td> <td>1</td> </tr> <tr> <td>int|string $show_empty 0 no empty value allowed, 1 or string to add an empty value into list (If 1: key is -1 and value is '' or ' ', If placeholder string: key is -1 and value is the string), <0 to add an empty value with key that is this value.</td> <td>1</td> </tr> <tr> <td>int $key_in_label 1 to show key into label with format "[key] value"</td> <td>1</td> </tr> <tr> <td>int $value_as_key 1 to use value as key</td> <td>1</td> </tr> <tr> <td>string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container</td> <td>1</td> </tr> <tr> <td>int $translate 1=Translate and encode value</td> <td>1</td> </tr> <tr> <td>int $maxlen Length maximum for labels</td> <td>1</td> </tr> <tr> <td>int $disabled Html select box is disabled</td> <td>1</td> </tr> <tr> <td>string $sort 'ASC' or 'DESC' = Sort on label, '' or 'NONE' or 'POS' = Do not sort, we keep original order</td> <td>1</td> </tr> <tr> <td>string $morecss Add more class to css styles</td> <td>1</td> </tr> <tr> <td>int $addjscombo Add js combo</td> <td>1</td> </tr> <tr> <td>string $moreparamonempty Add more param on the empty option line. Not used if show_empty not set</td> <td>1</td> </tr> <tr> <td>int $disablebademail 1=Check if a not valid email, 2=Check string '---', and if found into value, disable and colorize entry</td> <td>1</td> </tr> <tr> <td>int $nohtmlescape No html escaping.</td> <td>1</td> </tr> <tr> <td>string $modulepart 'propal', 'facture', 'facture_fourn', ...</td> <td>1</td> </tr> <tr> <td>string $modulesubdir Sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module.</td> <td>1</td> </tr> <tr> <td>string $filedir Full path to directory to scan</td> <td>1</td> </tr> <tr> <td>string $filter Filter filenames on this regex string (Example: '\.pdf$')</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css to the download picto</td> <td>1</td> </tr> <tr> <td>int $allfiles 0=Only generated docs, 1=All files</td> <td>1</td> </tr> <tr> <td>string $objectdesc 'ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'. For hard coded custom needs. Try to prefer method using $objectfield instead of $objectdesc.</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of HTML select component</td> <td>1</td> </tr> <tr> <td>int $preselectedvalue Preselected value (ID of element)</td> <td>1</td> </tr> <tr> <td>string $showempty ''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)</td> <td>1</td> </tr> <tr> <td>string $searchkey Search criteria</td> <td>1</td> </tr> <tr> <td>string $placeholder Place holder</td> <td>1</td> </tr> <tr> <td>string $morecss More CSS</td> <td>1</td> </tr> <tr> <td>string $moreparams More params provided to ajax call</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>1</td> </tr> <tr> <td>int $disabled 1=Html component is disabled</td> <td>1</td> </tr> <tr> <td>string $objectfield Object:Field that contains the definition (in table $fields or $extrafields). Example: 'Object:xxx' or 'Module_Object:xxx' or 'Object:options_xxx' or 'Module_Object:options_xxx'</td> <td>1</td> </tr> <tr> <td>string $showempty ''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)</td> <td>1</td> </tr> <tr> <td>array|null $val Array of properties for field to show</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string|array $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $morecss Value for css to define style/length of field. May also be a numeric.</td> <td>1</td> </tr> <tr> <td>CommonObject $object Common object</td> <td>1</td> </tr> <tr> <td>array $val Array of properties of field to show</td> <td>1</td> </tr> <tr> <td>string $key Key of attribute</td> <td>1</td> </tr> <tr> <td>string|string[] $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)</td> <td>1</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>1</td> </tr> <tr> <td>string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>1</td> </tr> <tr> <td>mixed $morecss Value for css to define size. May also be a numeric.</td> <td>1</td> </tr> <tr> <td>array $params Params to construct tooltip data</td> <td>1</td> </tr> <tr> <td>string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)</td> <td>1</td> </tr> <tr> <td>int $max Max length to show</td> <td>1</td> </tr> <tr> <td>int $short Short</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes Add link to notes</td> <td>1</td> </tr> <tr> <td>string $target Attribute target for link</td> <td>1</td> </tr> <tr> <td>int $billed If invoiced</td> <td>1</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $donotshowbilled Do not show billed status after order status</td> <td>1</td> </tr> <tr> <td>string $controller Name</td> <td>1</td> </tr> <tr> <td>string $className Class name</td> <td>1</td> </tr> <tr> <td>bool $addToken Add token hash only if $controller is set</td> <td>1</td> </tr> <tr> <td>bool $addToken Add token hash only if controller is set</td> <td>1</td> </tr> <tr> <td>string $controller Controller</td> <td>1</td> </tr> <tr> <td>string|array $moreParams More parameters</td> <td>1</td> </tr> <tr> <td>array $Tparams Parameters</td> <td>1</td> </tr> <tr> <td>bool $withRequestUri With request URI</td> <td>1</td> </tr> <tr> <td>bool $use_forwarded_host Use formatted host</td> <td>1</td> </tr> <tr> <td>string $menuName Menu name</td> <td>1</td> </tr> <tr> <td>array $errors Errors</td> <td>1</td> </tr> <tr> <td>string|string[] $mesgs Message string or array</td> <td>1</td> </tr> <tr> <td>string $style Which style to use ('mesgs' by default, 'warnings', 'errors')</td> <td>1</td> </tr> <tr> <td>string $mesg Message string</td> <td>1</td> </tr> <tr> <td>array|null $mesgs Message array</td> <td>1</td> </tr> <tr> <td>string $style Which style to use ('mesgs' by default, 'warnings', 'errors')</td> <td>1</td> </tr> <tr> <td>string $login Login</td> <td>1</td> </tr> <tr> <td>DoliDb $db Database handler</td> <td>1</td> </tr> <tr> <td>string $option Where point the link</td> <td>1</td> </tr> <tr> <td>int $max Maxlength of ref</td> <td>1</td> </tr> <tr> <td>int $short 1=Return just URL</td> <td>1</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>1</td> </tr> <tr> <td>string $target Target of link ('', '_self', '_blank', '_parent', '_backoffice', ...)</td> <td>1</td> </tr> <tr> <td>array $arraydata Array of data</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto</td> <td>1</td> </tr> <tr> <td>int $alreadypaid 0=No payment already done, >0=Some payments were already done</td> <td>1</td> </tr> <tr> <td>int $paye Status field paye</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=long label + picto</td> <td>1</td> </tr> <tr> <td>int $alreadypaid 0=No payment already done, >0=Some payments were already done</td> <td>1</td> </tr> <tr> <td>int $type Type invoice. If -1, we use $this->type</td> <td>1</td> </tr> <tr> <td>string $option Where the link point to ('expedition', 'document', ...)</td> <td>1</td> </tr> <tr> <td>string $get_params Parameters added to url</td> <td>1</td> </tr> <tr> <td>int $addlinktonotes -1=Disable, 0=Just add label show notes, 1=Add private note (only internal user), 2=Add public note (internal or external user), 3=Add private (internal user) and public note (internal and external user)</td> <td>1</td> </tr> <tr> <td>string $templateName Template file name (without the .tpl.php)</td> <td>1</td> </tr> <tr> <td>mixed $vars Data to transmit to template</td> <td>1</td> </tr> <tr> <td>string $elementEn Element (english) : "propal", "order", "invoice"</td> <td>1</td> </tr> <tr> <td>Context $context Context object</td> <td>1</td> </tr> <tr> <td>int $calid Calendard id</td> <td>1</td> </tr> <tr> <td>int|boolean $oid Oid</td> <td>1</td> </tr> <tr> <td>int|boolean $ouri Ouri</td> <td>1</td> </tr> <tr> <td>User $user user</td> <td>1</td> </tr> <tr> <td>Translate $langs translation</td> <td>1</td> </tr> <tr> <td>int $calid Calendar id</td> <td>1</td> </tr> <tr> <td>Object $obj Object id</td> <td>1</td> </tr> <tr> <td>int $calendarId Calendar id</td> <td>1</td> </tr> <tr> <td>int $bCalendarData Add calendar data</td> <td>1</td> </tr> <tr> <td>int $no_trigger 0=launch triggers after, 1=disable triggers</td> <td>1</td> </tr> <tr> <td>string $ref Ref of object</td> <td>1</td> </tr> <tr> <td>int $id Id of link element_resources</td> <td>1</td> </tr> <tr> <td>User $user User making the change</td> <td>1</td> </tr> <tr> <td>int $offset Offset page</td> <td>1</td> </tr> <tr> <td>string $element Element</td> <td>1</td> </tr> <tr> <td>int $element_id Id</td> <td>1</td> </tr> <tr> <td>string $resource_type Type</td> <td>1</td> </tr> <tr> <td>string $elementType Element type</td> <td>1</td> </tr> <tr> <td>int $elementId Element id</td> <td>1</td> </tr> <tr> <td>string $get_params Parameters added to url</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 5=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $selected Preselected resource id</td> <td>1</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>1</td> </tr> <tr> <td>array $filter Optional filters criteria (example: 's.rowid <> x')</td> <td>1</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>1</td> </tr> <tr> <td>int $showtype Show third party type in combo list (customer, prospect or supplier)</td> <td>1</td> </tr> <tr> <td>int $forcecombo Force to use combo box</td> <td>1</td> </tr> <tr> <td>array $event Event options. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))</td> <td>1</td> </tr> <tr> <td>array $filterkey Filter on key value</td> <td>1</td> </tr> <tr> <td>int $outputmode 0=HTML select string, 1=Array, 2=without form tag</td> <td>1</td> </tr> <tr> <td>int $limit Limit number of answers, 0 for no limit</td> <td>1</td> </tr> <tr> <td>bool $multiple add [] in the name of element and add 'multiple' attribute</td> <td>1</td> </tr> <tr> <td>string $selected Id du type pre-selectionne</td> <td>1</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>1</td> </tr> <tr> <td>string $filtertype To filter on field type in llx_c_ticket_type (array('code'=>xx,'label'=>zz))</td> <td>1</td> </tr> <tr> <td>int $format 0=id+libelle, 1=code+code, 2=code+libelle, 3=id+code</td> <td>1</td> </tr> <tr> <td>int $empty 1=peut etre vide, 0 sinon</td> <td>1</td> </tr> <tr> <td>int $noadmininfo 0=Add admin info, 1=Disable admin info</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of label</td> <td>1</td> </tr> <tr> <td>int $id Id of object to load</td> <td>1</td> </tr> <tr> <td>string $ref Ref of object</td> <td>1</td> </tr> <tr> <td>int $fk_member fk_member</td> <td>1</td> </tr> <tr> <td>int $fk_soc fk_soc</td> <td>1</td> </tr> <tr> <td>int $offset Offset page</td> <td>1</td> </tr> <tr> <td>User $user Object user that modify</td> <td>1</td> </tr> <tr> <td>string $reasondeclinenote Reason decline</td> <td>1</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>1</td> </tr> <tr> <td>int $id ID of partnership</td> <td>1</td> </tr> <tr> <td>int $id Id of partnership to update</td> <td>1</td> </tr> <tr> <td>int $id Partnership ID</td> <td>1</td> </tr> <tr> <td>int $maxpercall Max per call</td> <td>1</td> </tr> <tr> <td>string $website Partner's website URL</td> <td>1</td> </tr> <tr> <td>int $id ID of category</td> <td>1</td> </tr> <tr> <td>bool $include_childs Include child categories list (true or false)</td> <td>1</td> </tr> <tr> <td>int $id Id of category to update</td> <td>1</td> </tr> <tr> <td>int $id Category ID</td> <td>1</td> </tr> <tr> <td>int $id Object ID</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact', 'project')</td> <td>1</td> </tr> <tr> <td>int $object_id ID of object</td> <td>1</td> </tr> <tr> <td>string $object_ref Reference of object</td> <td>1</td> </tr> <tr> <td>int $id ID of category</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact')</td> <td>1</td> </tr> <tr> <td>int $object_id ID of the object</td> <td>1</td> </tr> <tr> <td>int $id ID of category</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact')</td> <td>1</td> </tr> <tr> <td>string $object_ref Reference of the object</td> <td>1</td> </tr> <tr> <td>Categorie $object Object to clean</td> <td>1</td> </tr> <tr> <td>int $id ID of category</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact', 'project')</td> <td>1</td> </tr> <tr> <td>int $onlyids Return only ids of objects (consume less memory)</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>int $id Id of category</td> <td>1</td> </tr> <tr> <td>string $label Label of category</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('product', '...') or (0, 1, ...)</td> <td>1</td> </tr> <tr> <td>string $ref_ext External reference of object</td> <td>1</td> </tr> <tr> <td>User $user Object user that ask to delete</td> <td>1</td> </tr> <tr> <td>CommonObject $obj Object to link to category</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('product', ...). Use '' to take $obj->element.</td> <td>1</td> </tr> <tr> <td>CommonObject $obj Object</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member')</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member', 'knowledge_management', ...)</td> <td>1</td> </tr> <tr> <td>int $onlyids Return only ids of objects (consume less memory)</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>string $sortfield Sort fields</td> <td>1</td> </tr> <tr> <td>string $sortorder Sort order ('ASC' or 'DESC');</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member')</td> <td>1</td> </tr> <tr> <td>int $object_id Id of the object to search</td> <td>1</td> </tr> <tr> <td>int $id Id of element</td> <td>1</td> </tr> <tr> <td>string $type Type of categories ('customer', 'supplier', 'contact', 'product', 'member', ...)</td> <td>1</td> </tr> <tr> <td>int|string|array $fromid Keep only or Exclude (depending on $include parameter) all categories (including the leaf $fromid) into the tree after this id $fromid.</td> <td>1</td> </tr> <tr> <td>int $include [=0] Removed or 1=Keep only</td> <td>1</td> </tr> <tr> <td>int $type Type of category (0, 1, ...)</td> <td>1</td> </tr> <tr> <td>boolean $parent Just parent categories if true</td> <td>1</td> </tr> <tr> <td>int $type Type of category (0, 1, ...)</td> <td>1</td> </tr> <tr> <td>string $sep Separator</td> <td>1</td> </tr> <tr> <td>string $url Url ('', 'none' or 'urltouse')</td> <td>1</td> </tr> <tr> <td>int $nocolor 0</td> <td>1</td> </tr> <tr> <td>int $addpicto Add picto into link</td> <td>1</td> </tr> <tr> <td>int $id Id of element</td> <td>1</td> </tr> <tr> <td>string|int $type Type of category ('customer', 'supplier', 'contact', 'product', 'member') or (0, 1, 2, ...)</td> <td>1</td> </tr> <tr> <td>string $mode 'id'=Get array of category ids, 'object'=Get array of fetched category instances, 'label'=Get array of category</td> <td>1</td> </tr> <tr> <td>string $nom Name</td> <td>1</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact'). Old mode (0, 1, 2, ...) is deprecated.</td> <td>1</td> </tr> <tr> <td>boolean $exact Exact string search (true/false)</td> <td>1</td> </tr> <tr> <td>boolean $case Case sensitive (true/false)</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto</td> <td>1</td> </tr> <tr> <td>int $maxlength Max length of text</td> <td>1</td> </tr> <tr> <td>string $moreparam More param on URL link</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>string $sdir Root destination directory</td> <td>1</td> </tr> <tr> <td>array $file Uploaded file name</td> <td>1</td> </tr> <tr> <td>string $dir Dir to scan</td> <td>1</td> </tr> <tr> <td>int $nbmax Nombre maximum de photos (0=pas de max)</td> <td>1</td> </tr> <tr> <td>string $file Path to file</td> <td>1</td> </tr> <tr> <td>string $file Path to file</td> <td>1</td> </tr> <tr> <td>Array $searchList A list with the selected categories</td> <td>1</td> </tr> <tr> <td>int $selected Id of preselected section</td> <td>1</td> </tr> <tr> <td>string $select_name Name of HTML select component</td> <td>1</td> </tr> <tr> <td>string $module Module ('ecm', 'medias', ...)</td> <td>1</td> </tr> <tr> <td>array $ids_to_ignore Array of id to ignore</td> <td>1</td> </tr> <tr> <td>string $value '+' or '-' or new number</td> <td>1</td> </tr> <tr> <td>int $id Id of object</td> <td>1</td> </tr> <tr> <td>User $user User that delete</td> <td>1</td> </tr> <tr> <td>string $mode 'all'=delete all, 'databaseonly'=only database entry, 'fileonly' (not implemented)</td> <td>1</td> </tr> <tr> <td>int $deletedirrecursive 1=Agree to delete content recursiveley (otherwise an error will be returned when trying to delete)</td> <td>1</td> </tr> <tr> <td>int $withpicto 0=Pas de picto, 1=Include picto into link, 2=Only picto</td> <td>1</td> </tr> <tr> <td>int $max Max length</td> <td>1</td> </tr> <tr> <td>string $more Add more param on a link</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>int $force Force reload of full arbo even if already loaded</td> <td>1</td> </tr> <tr> <td>int $force Force reload of full arbo even if already loaded in cache $this->cats</td> <td>1</td> </tr> <tr> <td>int $all 0=refresh record using this->id , 1=refresh record using this->entity</td> <td>1</td> </tr> <tr> <td>int $id Id object</td> <td>1</td> </tr> <tr> <td>string $ref Hash of file name (filename+filepath). Not always defined on some version.</td> <td>1</td> </tr> <tr> <td>string $relativepath Relative path of file from document directory. Example: 'path/path2/file' or 'path/path2/*'</td> <td>1</td> </tr> <tr> <td>string $hashoffile Hash of file content. Take the first one found if same file is at different places. This hash will also change if file content is changed.</td> <td>1</td> </tr> <tr> <td>string $hashforshare Hash of file sharing, or 'shared'</td> <td>1</td> </tr> <tr> <td>string $src_object_type src_object_type to search (value of object->table_element)</td> <td>1</td> </tr> <tr> <td>int $src_object_id src_object_id to search</td> <td>1</td> </tr> <tr> <td>int $limit Limit</td> <td>1</td> </tr> <tr> <td>int $offset Offset limit</td> <td>1</td> </tr> <tr> <td>string|array $filter filter array</td> <td>1</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>1</td> </tr> <tr> <td>string $hash hash md5 of blockchain to test</td> <td>1</td> </tr> <tr> <td>int $id Id of object to load</td> <td>1</td> </tr> <tr> <td>string $signature Signature of object to load</td> <td>1</td> </tr> <tr> <td>CommonObject $object object to store</td> <td>1</td> </tr> <tr> <td>string $action action</td> <td>1</td> </tr> <tr> <td>string $amounts amounts</td> <td>1</td> </tr> <tr> <td>?User $fuser User object (forced)</td> <td>1</td> </tr> <tr> <td>string $data Data to serialize</td> <td>1</td> </tr> <tr> <td>int $mode 0=serialize, 1=json_encode</td> <td>1</td> </tr> <tr> <td>string $data Data to unserialize</td> <td>1</td> </tr> <tr> <td>int $mode 0=unserialize, 1=json_decode</td> <td>1</td> </tr> <tr> <td>User $user Object user that create</td> <td>1</td> </tr> <tr> <td>string $forcesignature Force signature (for example '0000000000' when we disabled the module)</td> <td>1</td> </tr> <tr> <td>string $previoushash If previous signature hash is known, we can provide it to avoid to make a search of it in database.</td> <td>1</td> </tr> <tr> <td>int $returnarray 1=Return array of details, 2=Return array of details including keyforsignature, 0=Boolean</td> <td>1</td> </tr> <tr> <td>int $withlock 1=With a lock</td> <td>1</td> </tr> <tr> <td>int $beforeid ID of a record</td> <td>1</td> </tr> <tr> <td>string $element element to search</td> <td>1</td> </tr> <tr> <td>int $fk_object id of object to search</td> <td>1</td> </tr> <tr> <td>int $limit max number of element, 0 for all</td> <td>1</td> </tr> <tr> <td>string $sortfield sort field</td> <td>1</td> </tr> <tr> <td>string $sortorder sort order</td> <td>1</td> </tr> <tr> <td>int $search_fk_user id of user(s)</td> <td>1</td> </tr> <tr> <td>int $search_start start time limit</td> <td>1</td> </tr> <tr> <td>int $search_end end time limit</td> <td>1</td> </tr> <tr> <td>string $search_ref search ref</td> <td>1</td> </tr> <tr> <td>string $search_amount search amount</td> <td>1</td> </tr> <tr> <td>string $search_code search code</td> <td>1</td> </tr> <tr> <td>int $ignoresystem Ignore system events for the test</td> <td>1</td> </tr> <tr> <td>string $objectname Object name</td> <td>1</td> </tr> <tr> <td>string $methodname Method name</td> <td>1</td> </tr> <tr> <td>int $offset Offset ppage</td> <td>1</td> </tr> <tr> <td>int $status Display active or not</td> <td>1</td> </tr> <tr> <td>int $processing Processing or not</td> <td>1</td> </tr> <tr> <td>User $user User that deletes</td> <td>1</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>1</td> </tr> <tr> <td>array $params params to construct tooltip data</td> <td>1</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>1</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>1</td> </tr> <tr> <td>integer $now Date returned by dol_now()</td> <td>1</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>1</td> </tr> <tr> <td>int $processing 0=Not running, 1=Running</td> <td>1</td> </tr> <tr> <td>string $lastResult Value of last result (''=no error, error otherwise)</td> <td>1</td> </tr> <tr> <td>string $mode 'StripeTest' or 'StripeLive'</td> <td>1</td> </tr> <tr> <td>int $fk_soc Id of thirdparty</td> <td>1</td> </tr> <tr> <td>int $entity Id of entity (-1 = current environment)</td> <td>1</td> </tr> <tr> <td>int $status Status</td> <td>1</td> </tr> <tr> <td>CommonObject $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.</td> <td>1</td> </tr> <tr> <td>string $key ''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>int $createifnotlinkedtostripe 1=Create the stripe customer and the link if the thirdparty is not yet linked to a stripe customer</td> <td>1</td> </tr> <tr> <td>string $paymentmethod Payment Method ID</td> <td>1</td> </tr> <tr> <td>string $key ''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>string $reader Reader ID</td> <td>1</td> </tr> <tr> <td>string $key ''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>double $amount Amount</td> <td>1</td> </tr> <tr> <td>string $currency_code Currency code</td> <td>1</td> </tr> <tr> <td>string $tag Tag</td> <td>1</td> </tr> <tr> <td>mixed $object Object to pay with Stripe</td> <td>1</td> </tr> <tr> <td>string $mode automatic=automatic confirmation/payment when conditions are ok, manual=need to call confirm() on intent</td> <td>1</td> </tr> <tr> <td>string $payment_method 'pm_....' (if known)</td> <td>1</td> </tr> <tr> <td>int $off_session If we use an already known payment method to pay when customer is not available during the checkout flow.</td> <td>1</td> </tr> <tr> <td>int $noidempotency_key Do not use the idempotency_key when creating the PaymentIntent</td> <td>1</td> </tr> <tr> <td>int $did ID of an existing line into llx_prelevement_demande (Dolibarr intent). If provided, no new line will be created.</td> <td>1</td> </tr> <tr> <td>Societe $object Object of company to link the Stripe payment mode with</td> <td>1</td> </tr> <tr> <td>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.</td> <td>1</td> </tr> <tr> <td>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.</td> <td>1</td> </tr> <tr> <td>int $amount Amount to pay</td> <td>1</td> </tr> <tr> <td>string $currency EUR, GPB...</td> <td>1</td> </tr> <tr> <td>string $origin Object type to pay (order, invoice, contract...)</td> <td>1</td> </tr> <tr> <td>int $item Object id to pay</td> <td>1</td> </tr> <tr> <td>string $source src_xxxxx or card_xxxxx or pm_xxxxx</td> <td>1</td> </tr> <tr> <td>string $customer Stripe customer ref 'cus_xxxxxxxxxxxxx' via customerStripe()</td> <td>1</td> </tr> <tr> <td>string $account Stripe account ref 'acc_xxxxxxxxxxxxx' via getStripeAccount()</td> <td>1</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>1</td> </tr> <tr> <td>int $usethirdpartyemailforreceiptemail Use thirdparty email as receipt email</td> <td>1</td> </tr> <tr> <td>boolean $capture Set capture flag to true (take payment) or false (wait)</td> <td>1</td> </tr> <tr> <td>array $parameters Parameters</td> <td>1</td> </tr> <tr> <td>string $action Action</td> <td>1</td> </tr> <tr> <td>array $parameters Parameters</td> <td>1</td> </tr> <tr> <td>string $action action</td> <td>1</td> </tr> <tr> <td>string[] $lines</td> <td>1</td> </tr> <tr> <td>array{type: string, fileSvg: string, filePng: string, width: int, height: int} $type</td> <td>1</td> </tr> <tr> <td>list<AlternativeScheme> $alternativeSchemes</td> <td>1</td> </tr> <tr> <td>string $filename the path to the GeoIP2 database file</td> <td>1</td> </tr> <tr> <td>array $locales list of locale codes to use in name property</td> <td>1</td> </tr> <tr> <td>int $accountId your MaxMind account ID</td> <td>1</td> </tr> <tr> <td>string $licenseKey your MaxMind license key</td> <td>1</td> </tr> <tr> <td>array $locales list of locale codes to use in name property</td> <td>1</td> </tr> <tr> <td>array $options array of options. Valid options include:</td> <td>1</td> </tr> <tr> <td>DoliDB $db</td> <td>1</td> </tr> <tr> <td>string $entity</td> <td>1</td> </tr> <tr> <td>string $login</td> <td>1</td> </tr> <tr> <td>string $param_str</td> <td>1</td> </tr> <tr> <td>bool $bool3</td> <td>1</td> </tr> <tr> <td>bool $bool4</td> <td>1</td> </tr> <tr> <td>bool $bool5</td> <td>1</td> </tr> <tr> <td>Conf $conf</td> <td>1</td> </tr> <tr> <td>int<0,1> $shared</td> <td>1</td> </tr> <tr> <td>?CommonObject $currentobject</td> <td>1</td> </tr> <tr> <td>CommonObject $currentobject</td> <td>1</td> </tr> <tr> <td>int $entityid</td> <td>1</td> </tr> <tr> <td>string $entitytotest</td> <td>1</td> </tr> <tr> <td>Node $node A node to analyze</td> <td>1</td> </tr> <tr> <td>string $name function name or fqsn of class::<method></td> <td>1</td> </tr> <tr> <td>Node $node Visited node for which to verify arguments match regex</td> <td>1</td> </tr> <tr> <td>int $argPosition Position of argument to check</td> <td>1</td> </tr> <tr> <td>string $argRegex Regex to validate against argument</td> <td>1</td> </tr> <tr> <td>string $functionName Function name for report</td> <td>1</td> </tr> <tr> <td>string $messageCode Message code to provide in message</td> <td>1</td> </tr> <tr> <td>Node $node A node</td> <td>1</td> </tr> <tr> <td>\Rector\Core\PhpParser\Node\NodeFactory $nodeFactory node factory</td> <td>1</td> </tr> <tr> <td>\PhpParser\Node $node node to be changed</td> <td>1</td> </tr> <tr> <td>string $_destlang Destination lang</td> <td>1</td> </tr> <tr> <td>string $_refLang Ref lang</td> <td>1</td> </tr> <tr> <td>string $_langDir Dir lang</td> <td>1</td> </tr> <tr> <td>string $_limittofile Limit to file</td> <td>1</td> </tr> <tr> <td>string $_apikey Api key</td> <td>1</td> </tr> <tr> <td>string $destPath Target path</td> <td>1</td> </tr> <tr> <td>string $file File</td> <td>1</td> </tr> <tr> <td>string $content Existing content of dest file</td> <td>1</td> </tr> <tr> <td>string $file Target file name translated (xxxx.lang)</td> <td>1</td> </tr> <tr> <td>string $key Key to translate</td> <td>1</td> </tr> <tr> <td>string $value Existing value in source file</td> <td>1</td> </tr> <tr> <td>string $my_destlang Language code (ie: fr_FR)</td> <td>1</td> </tr> <tr> <td>string $lang Language code</td> <td>1</td> </tr> <tr> <td>array $src_texts Array with one value</td> <td>1</td> </tr> <tr> <td>string $src_lang Language code source (us, fr, it, ...)</td> <td>1</td> </tr> <tr> <td>string $dest_lang Language code target (es, de, ...)</td> <td>1</td> </tr> <tr> <td>int $totallate Nb of element late</td> <td>2</td> </tr> <tr> <td>string[] $m</td> <td>2</td> </tr> <tr> <td>string $morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)</td> <td>2</td> </tr> <tr> <td>int $disabledoutputofmessages Clear all messages stored into session without displaying them</td> <td>2</td> </tr> <tr> <td>Product $object Object related to tabs</td> <td>2</td> </tr> <tr> <td>string[] $fieldlist Array of fields</td> <td>2</td> </tr> <tr> <td>stdClass $obj If we show a particular record, obj is filled with record fields</td> <td>2</td> </tr> <tr> <td>string $arg</td> <td>2</td> </tr> <tr> <td>int $id Element id</td> <td>2</td> </tr> <tr> <td>string $ref_ext external reference</td> <td>2</td> </tr> <tr> <td>array $thirdparty Thirdparty</td> <td>2</td> </tr> <tr> <td>array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array of authentication information</td> <td>2</td> </tr> <tr> <td>string $ref Ref of object</td> <td>2</td> </tr> <tr> <td>array $product Product</td> <td>2</td> </tr> <tr> <td>array $actioncomm $actioncomm</td> <td>2</td> </tr> <tr> <td>int $year Year</td> <td>2</td> </tr> <tr> <td>string $currentFolder Current folder</td> <td>2</td> </tr> <tr> <td>integer $number Number</td> <td>2</td> </tr> <tr> <td>string $sCommand Command</td> <td>2</td> </tr> <tr> <td>string $resourceType resource type</td> <td>2</td> </tr> <tr> <td>string $sourceString Source</td> <td>2</td> </tr> <tr> <td>Object $toclean Object to clean</td> <td>2</td> </tr> <tr> <td>string $string String to encode</td> <td>2</td> </tr> <tr> <td>string $content MD content</td> <td>2</td> </tr> <tr> <td>string $replaceimagepath Replace path to image with another path. Example: ('doc/'=>'xxx/aaa/')</td> <td>2</td> </tr> <tr> <td>int $acceptsvg 0=Default (depends on setup), 1=Always accept SVG as image files</td> <td>2</td> </tr> <tr> <td>User|null $fuser User concerned or null for global theme</td> <td>2</td> </tr> <tr> <td>int $edit 1 to add edit form</td> <td>2</td> </tr> <tr> <td>Account $account Account object</td> <td>2</td> </tr> <tr> <td>string $mode Mode</td> <td>2</td> </tr> <tr> <td>string $tablealias Alias of table</td> <td>2</td> </tr> <tr> <td>string $ean EAN to encode</td> <td>2</td> </tr> <tr> <td>string $key rule to use for delta ('0', '1' or 'myownkey')</td> <td>2</td> </tr> <tr> <td>string $chain string to decode</td> <td>2</td> </tr> <tr> <td>Facture $object Invoice object</td> <td>2</td> </tr> <tr> <td>string $name Name of constant</td> <td>2</td> </tr> <tr> <td>string $name Model name</td> <td>2</td> </tr> <tr> <td>string $type Model type</td> <td>2</td> </tr> <tr> <td>string $key Key</td> <td>2</td> </tr> <tr> <td>int $max Max nb of records</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>2</td> </tr> <tr> <td>int $hideref Hide reference</td> <td>2</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>2</td> </tr> <tr> <td>int $issupplierline Is it a line for a supplier object ?</td> <td>2</td> </tr> <tr> <td>string $url Full URL.</td> <td>2</td> </tr> <tr> <td>string $str TIN to check</td> <td>2</td> </tr> <tr> <td>string $file File</td> <td>2</td> </tr> <tr> <td>string $newsection $newsection</td> <td>2</td> </tr> <tr> <td>string $content Content to replace</td> <td>2</td> </tr> <tr> <td>Object $object Object</td> <td>2</td> </tr> <tr> <td>string $extName Extension to differentiate thumb file name ('', '_small', '_mini')</td> <td>2</td> </tr> <tr> <td>string $url Url</td> <td>2</td> </tr> <tr> <td>string $stringcolor String with hex (FFFFFF) or comma RGB ('255,255,255')</td> <td>2</td> </tr> <tr> <td>string $hex color in hex</td> <td>2</td> </tr> <tr> <td>integer $percent 0 to 100</td> <td>2</td> </tr> <tr> <td>bool $returnArray true=return an array instead, false=return string</td> <td>2</td> </tr> <tr> <td>string $module Module name</td> <td>2</td> </tr> <tr> <td>string $objectname Name of object</td> <td>2</td> </tr> <tr> <td>string $newmask New mask</td> <td>2</td> </tr> <tr> <td>string $readdir Directory source (use $destdir when not defined)</td> <td>2</td> </tr> <tr> <td>string $file path of the class</td> <td>2</td> </tr> <tr> <td>string $json Json encoded to PHP Object or Array</td> <td>2</td> </tr> <tr> <td>int $week Week</td> <td>2</td> </tr> <tr> <td>int $date Date GMT</td> <td>2</td> </tr> <tr> <td>int $month Month number</td> <td>2</td> </tr> <tr> <td>int $minLength Minimum number of chars to trigger that Ajax search</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of html select field ('myid' or '.myclass')</td> <td>2</td> </tr> <tr> <td>Object $object Third party object</td> <td>2</td> </tr> <tr> <td>int $nocreatelink 1=Hide create project link</td> <td>2</td> </tr> <tr> <td>string $morehtmlright More html on right of title</td> <td>2</td> </tr> <tr> <td>string $sql $sql modified</td> <td>2</td> </tr> <tr> <td>string $actioncode Action code</td> <td>2</td> </tr> <tr> <td>Societe $fromcompany Third party</td> <td>2</td> </tr> <tr> <td>Website $object Object website</td> <td>2</td> </tr> <tr> <td>WebsitePage $objectpage Object websitepage</td> <td>2</td> </tr> <tr> <td>string $file Filename</td> <td>2</td> </tr> <tr> <td>int $testvirus Do an antivirus test. Move is canceled if a virus is found.</td> <td>2</td> </tr> <tr> <td>int $indexdatabase Index new file into database.</td> <td>2</td> </tr> <tr> <td>string $src_file Source file to check</td> <td>2</td> </tr> <tr> <td>string $dest_file Destination file name (to know the expected type)</td> <td>2</td> </tr> <tr> <td>int $indexdatabase Try to remove also index entries.</td> <td>2</td> </tr> <tr> <td>string $dir Directory name (full real path without ending /)</td> <td>2</td> </tr> <tr> <td>string $mode How file was created ('uploaded', 'generated', ...)</td> <td>2</td> </tr> <tr> <td>string $directory Directory of cache</td> <td>2</td> </tr> <tr> <td>string $filename Name of filecache</td> <td>2</td> </tr> <tr> <td>string $default value to return</td> <td>2</td> </tr> <tr> <td>string $check Type of check/sanitizing</td> <td>2</td> </tr> <tr> <td>int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)</td> <td>2</td> </tr> <tr> <td>mixed $options Options to pass to filter_var when $check is set to 'custom'</td> <td>2</td> </tr> <tr> <td>string $mode '' (prefix for session name) or 'email' (prefix for email id)</td> <td>2</td> </tr> <tr> <td>string $str String to clean</td> <td>2</td> </tr> <tr> <td>int $unaccent 1=Remove also accent (default), 0 do not remove them</td> <td>2</td> </tr> <tr> <td>string $stringtoclean String to clean</td> <td>2</td> </tr> <tr> <td>string $s String to print</td> <td>2</td> </tr> <tr> <td>int $allowiframe Allow iframe tags</td> <td>2</td> </tr> <tr> <td>string $string String to encode</td> <td>2</td> </tr> <tr> <td>string $encoding Character set encoding</td> <td>2</td> </tr> <tr> <td>string $string String to encode</td> <td>2</td> </tr> <tr> <td>string $encoding Character set encodign</td> <td>2</td> </tr> <tr> <td>string $title Title</td> <td>2</td> </tr> <tr> <td>string $picto Add a picto on tab title</td> <td>2</td> </tr> <tr> <td>int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.</td> <td>2</td> </tr> <tr> <td>string $morehtmlright Add more html content on right of tabs title</td> <td>2</td> </tr> <tr> <td>int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.</td> <td>2</td> </tr> <tr> <td>string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page</td> <td>2</td> </tr> <tr> <td>string $ip IP</td> <td>2</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>2</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag</td> <td>2</td> </tr> <tr> <td>int $pictoisfullpath If 1, image path is a full path</td> <td>2</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>2</td> </tr> <tr> <td>integer $float If you have to put the style "float: right"</td> <td>2</td> </tr> <tr> <td>string $other Add more attributes on img</td> <td>2</td> </tr> <tr> <td>string $moreclass Add more CSS classes</td> <td>2</td> </tr> <tr> <td>string $picto Icon to use before title (should be a 32x32 transparent png file)</td> <td>2</td> </tr> <tr> <td>int $pictoisfullpath 1=Icon name is a full absolute url of image</td> <td>2</td> </tr> <tr> <td>int $idprod Id product</td> <td>2</td> </tr> <tr> <td>string $stringtoclean String to clean</td> <td>2</td> </tr> <tr> <td>string $stringtoencode String to encode</td> <td>2</td> </tr> <tr> <td>string $stringtodecode String to decode</td> <td>2</td> </tr> <tr> <td>int $noduplicate 1 means we do not add the message if already present in session stack</td> <td>2</td> </tr> <tr> <td>string $mesgstring Message string or message key</td> <td>2</td> </tr> <tr> <td>string[] $mesgarray Array of message strings or message keys</td> <td>2</td> </tr> <tr> <td>string $mesgstring Error message</td> <td>2</td> </tr> <tr> <td>string[] $mesgarray Error messages array</td> <td>2</td> </tr> <tr> <td>string $modulepart propal, facture, facture_fourn, ...</td> <td>2</td> </tr> <tr> <td>string $param More param on http links</td> <td>2</td> </tr> <tr> <td>string $prefix Prefix used to build the date selector (for instance using Form::selectDate)</td> <td>2</td> </tr> <tr> <td>string $mode Mode</td> <td>2</td> </tr> <tr> <td>string $inc Line number (start to 0, then increased by recursive call)</td> <td>2</td> </tr> <tr> <td>Task[] $lines Array of lines</td> <td>2</td> </tr> <tr> <td>int $restricteditformytask 0=No restriction, 1=Enable add time only if task is a task i am affected to</td> <td>2</td> </tr> <tr> <td>int $preselectedday Preselected day</td> <td>2</td> </tr> <tr> <td>int $restricteditformytask 0=No restriction, 1=Enable add time only if task is assigned to me, 2=Enable add time only if tasks is assigned to me and hide others</td> <td>2</td> </tr> <tr> <td>array $arrayfields Array of additional column</td> <td>2</td> </tr> <tr> <td>Extrafields $extrafields Object extrafields</td> <td>2</td> </tr> <tr> <td>string $inc Line output identificator (start to 0, then increased by recursive call)</td> <td>2</td> </tr> <tr> <td>int $firstdaytoshow First day to show</td> <td>2</td> </tr> <tr> <td>Task[] $lines Array of lines (list of tasks but we will show only if we have a specific role on task)</td> <td>2</td> </tr> <tr> <td>string $period Period of report</td> <td>2</td> </tr> <tr> <td>string $periodlink Link to switch period</td> <td>2</td> </tr> <tr> <td>string $description Description</td> <td>2</td> </tr> <tr> <td>string $exportlink Link for export or ''</td> <td>2</td> </tr> <tr> <td>string $calcmode Calculation mode</td> <td>2</td> </tr> <tr> <td>string $varlink Add a variable into the address of the page</td> <td>2</td> </tr> <tr> <td>Paiement $object Current payment object</td> <td>2</td> </tr> <tr> <td>string $type Type of URL ('free', 'order', 'invoice', 'contractline', 'member' ...)</td> <td>2</td> </tr> <tr> <td>string $ref Ref of object</td> <td>2</td> </tr> <tr> <td>int|float $amount Amount of money to request for</td> <td>2</td> </tr> <tr> <td>Product $product Product object</td> <td>2</td> </tr> <tr> <td>string $scale Scale of unit: '0', '-3', '6', ...</td> <td>2</td> </tr> <tr> <td>int $unit ID of unit (rowid in llx_c_units table)</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Language object</td> <td>2</td> </tr> <tr> <td>int $unit Unit scale key (-3,-2,-1,0,98,99...)</td> <td>2</td> </tr> <tr> <td>string $account General accounting account</td> <td>2</td> </tr> <tr> <td>string $memoryid Memory id of shared area ('main', 'agenda', ...)</td> <td>2</td> </tr> <tr> <td>string $type Tax type, either 'vat', 'localtax1' or 'localtax2'</td> <td>2</td> </tr> <tr> <td>int $y Year</td> <td>2</td> </tr> <tr> <td>string $date_start Start date</td> <td>2</td> </tr> <tr> <td>string $date_end End date</td> <td>2</td> </tr> <tr> <td>int $modetax Not used</td> <td>2</td> </tr> <tr> <td>int $q Quarter</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object lang</td> <td>2</td> </tr> <tr> <td>int $i Current line number</td> <td>2</td> </tr> <tr> <td>CommonObject $object Object</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>2</td> </tr> <tr> <td>string $atarget Target (Example: '' or '_top')</td> <td>2</td> </tr> <tr> <td>int $type_user 0=Menu for backoffice, 1=Menu for front office</td> <td>2</td> </tr> <tr> <td>Menu $menu Object Menu to return back list of menu entries</td> <td>2</td> </tr> <tr> <td>int $noout 1=Disable output (Initialise &$menu only).</td> <td>2</td> </tr> <tr> <td>string $mode 'top', 'topnb', 'left', 'jmobile'</td> <td>2</td> </tr> <tr> <td>int $showmode 0 = hide, 1 = allowed or 2 = not allowed</td> <td>2</td> </tr> <tr> <td>array $menuval All the $menuval array</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>Menu $menu Object Menu to return back list of menu entries</td> <td>2</td> </tr> <tr> <td>int $noout Disable output (Initialise &$menu only).</td> <td>2</td> </tr> <tr> <td>string $forcemainmenu 'x'=Force mainmenu to mainmenu='x'</td> <td>2</td> </tr> <tr> <td>string $forceleftmenu 'all'=Force leftmenu to '' (= all). If value come being '', we change it to value in session and 'none' if not defined in session.</td> <td>2</td> </tr> <tr> <td>array $moredata An array with more data to output</td> <td>2</td> </tr> <tr> <td>int $type_user 0=Menu for backoffice, 1=Menu for front office</td> <td>2</td> </tr> <tr> <td>string $sql SQL Request</td> <td>2</td> </tr> <tr> <td>string $date Date</td> <td>2</td> </tr> <tr> <td>Promise[] $promises</td> <td>2</td> </tr> <tr> <td>string $fileIdentifier</td> <td>2</td> </tr> <tr> <td>$path string path of php file to include into the global context.</td> <td>2</td> </tr> <tr> <td>object|string $class</td> <td>2</td> </tr> <tr> <td>array $replacements</td> <td>2</td> </tr> <tr> <td>mixed $condition</td> <td>2</td> </tr> <tr> <td>\Throwable|string $exception</td> <td>2</td> </tr> <tr> <td>mixed ...$parameters</td> <td>2</td> </tr> <tr> <td>int $timestamp Unix time stamp</td> <td>2</td> </tr> <tr> <td>boolean $utc Whether the time stamp is UTC or local</td> <td>2</td> </tr> <tr> <td>string $datestr ISO 8601 compliant date string</td> <td>2</td> </tr> <tr> <td>string $usec the number of microseconds to sleep</td> <td>2</td> </tr> <tr> <td>array $fieldlist Array of fields</td> <td>2</td> </tr> <tr> <td>Object $obj If we show a particular record, obj is filled with record fields</td> <td>2</td> </tr> <tr> <td>string $tabname Name of SQL table</td> <td>2</td> </tr> <tr> <td>User $username Login</td> <td>2</td> </tr> <tr> <td>int $day Day</td> <td>2</td> </tr> <tr> <td>int $month Month</td> <td>2</td> </tr> <tr> <td>int $year Year</td> <td>2</td> </tr> <tr> <td>int $monthshown Current month shown in calendar view</td> <td>2</td> </tr> <tr> <td>string $style Style to use for this day</td> <td>2</td> </tr> <tr> <td>array $eventarray Array of events</td> <td>2</td> </tr> <tr> <td>int $maxprint Nb of actions to show each day on month view (0 means no limit)</td> <td>2</td> </tr> <tr> <td>int $maxnbofchar Nb of characters to show for event line</td> <td>2</td> </tr> <tr> <td>string $newparam Parameters on current URL</td> <td>2</td> </tr> <tr> <td>int $showinfo Add extended information (used by day view)</td> <td>2</td> </tr> <tr> <td>int $minheight Minimum height for each event. 60px by default.</td> <td>2</td> </tr> <tr> <td>boolean $showheader Show header</td> <td>2</td> </tr> <tr> <td>array $colorsbytype Array with colors by type</td> <td>2</td> </tr> <tr> <td>bool $var true or false for alternat style on tr/td</td> <td>2</td> </tr> <tr> <td>object $a Event A</td> <td>2</td> </tr> <tr> <td>object $b Event B</td> <td>2</td> </tr> <tr> <td>string $head More info into header</td> <td>2</td> </tr> <tr> <td>array $TMergedSkills skill list for display</td> <td>2</td> </tr> <tr> <td>string $statusName name of status</td> <td>2</td> </tr> <tr> <td>string $statusVarNamePrefix a prefix for var ${$statusVarNamePrefix.'badgeStatus'.$statusName}</td> <td>2</td> </tr> <tr> <td>string $commentLabel a comment label</td> <td>2</td> </tr> <tr> <td>string $cssPrefix a css prefix</td> <td>2</td> </tr> <tr> <td>string $tag Full tag</td> <td>2</td> </tr> <tr> <td>string $element Value to test</td> <td>2</td> </tr> <tr> <td>array $val Array of a PR</td> <td>2</td> </tr> <tr> <td>string $message Message</td> <td>2</td> </tr> <tr> <td>string $modele force le modele a utiliser ('' par default)</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database connector</td> <td>2</td> </tr> <tr> <td>Societe $soc Thirdparty object</td> <td>2</td> </tr> <tr> <td>int $entrepot_id Id of warehouse</td> <td>2</td> </tr> <tr> <td>float $qty Quantity</td> <td>2</td> </tr> <tr> <td>string $ref_ext External reference of object</td> <td>2</td> </tr> <tr> <td>User $user Object user that validate</td> <td>2</td> </tr> <tr> <td>string $action Event action code</td> <td>2</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>2</td> </tr> <tr> <td>string $sql Not use here</td> <td>2</td> </tr> <tr> <td>Translate $langs Translate Object</td> <td>2</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto</td> <td>2</td> </tr> <tr> <td>int $status Id statut</td> <td>2</td> </tr> <tr> <td>int $id only this carrier, all if none</td> <td>2</td> </tr> <tr> <td>tcpdf $pdf Object PDF</td> <td>2</td> </tr> <tr> <td>string $modele Force the model to using ('' to not force)</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs object lang to use for translations</td> <td>2</td> </tr> <tr> <td>int $rowid Id line order</td> <td>2</td> </tr> <tr> <td>int $id Id of object</td> <td>2</td> </tr> <tr> <td>array $fields Array of properties of field to show</td> <td>2</td> </tr> <tr> <td>array $parameters Array of parameters</td> <td>2</td> </tr> <tr> <td>double $rate rate value</td> <td>2</td> </tr> <tr> <td>Object $a 1st element to test</td> <td>2</td> </tr> <tr> <td>Object $b 2nd element to test</td> <td>2</td> </tr> <tr> <td>User $user Object user that modify</td> <td>2</td> </tr> <tr> <td>int $status Newsigned status to set (often a constant like self::STATUS_XXX)</td> <td>2</td> </tr> <tr> <td>int $notrigger 1 = Does not execute triggers, 0 = Execute triggers</td> <td>2</td> </tr> <tr> <td>string $triggercode Trigger code to use</td> <td>2</td> </tr> <tr> <td>string $sequence1 the first sequence</td> <td>2</td> </tr> <tr> <td>string $sequence2 the second sequence</td> <td>2</td> </tr> <tr> <td>int $start the starting index</td> <td>2</td> </tr> <tr> <td>int $id Id of contrat to update</td> <td>2</td> </tr> <tr> <td>array $request_data Contractline data</td> <td>2</td> </tr> <tr> <td>int $id Id of contract to activate</td> <td>2</td> </tr> <tr> <td>int $lineid Id of line to activate</td> <td>2</td> </tr> <tr> <td>string $datestart {@from body} Date start {@type timestamp}</td> <td>2</td> </tr> <tr> <td>string $comment {@from body} Comment</td> <td>2</td> </tr> <tr> <td>int $id Contract ID</td> <td>2</td> </tr> <tr> <td>User $user User</td> <td>2</td> </tr> <tr> <td>int $notrigger notrigger</td> <td>2</td> </tr> <tr> <td>stdClass $res Result of request SQL</td> <td>2</td> </tr> <tr> <td>int $i Line Id</td> <td>2</td> </tr> <tr> <td>string $comment A comment typed by user</td> <td>2</td> </tr> <tr> <td>User $user Object User making action</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>2</td> </tr> <tr> <td>string $comment Comment</td> <td>2</td> </tr> <tr> <td>User $user Object User</td> <td>2</td> </tr> <tr> <td>User $user User that creates</td> <td>2</td> </tr> <tr> <td>int $nolines 0=Default to load lines, 1=No lines</td> <td>2</td> </tr> <tr> <td>float $pu_ttc Prix unitaire TTC</td> <td>2</td> </tr> <tr> <td>int $fk_fournprice Fourn price id</td> <td>2</td> </tr> <tr> <td>int $pa_ht Buying price HT</td> <td>2</td> </tr> <tr> <td>string $fk_unit Code of the unit to use. Null to use the default one</td> <td>2</td> </tr> <tr> <td>int $rang Position</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>2</td> </tr> <tr> <td>int $id Id of object</td> <td>2</td> </tr> <tr> <td>string $action Type of action</td> <td>2</td> </tr> <tr> <td>string $action Type of action</td> <td>2</td> </tr> <tr> <td>int $id Id</td> <td>2</td> </tr> <tr> <td>int $numberYears Number of years to scan (0 = all)</td> <td>2</td> </tr> <tr> <td>string $morphy Nature of the adherent (physical or moral)</td> <td>2</td> </tr> <tr> <td>string $mode 'member' or 'thirdparty'</td> <td>2</td> </tr> <tr> <td>int $maxlen length max label</td> <td>2</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>2</td> </tr> <tr> <td>int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto</td> <td>2</td> </tr> <tr> <td>User $user Object user making update</td> <td>2</td> </tr> <tr> <td>int $status Filter on status of type</td> <td>2</td> </tr> <tr> <td>int $status Status id</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>2</td> </tr> <tr> <td>string $test Test string (example: 'cd.statut=0', 'field IS NULL')</td> <td>2</td> </tr> <tr> <td>resource $resultset Resultset of request</td> <td>2</td> </tr> <tr> <td>int $param Date TMS to convert</td> <td>2</td> </tr> <tr> <td>mixed $gm 'gmt'=Input information are GMT values, 'tzserver'=Local to server TZ</td> <td>2</td> </tr> <tr> <td>string $database Database name to create</td> <td>2</td> </tr> <tr> <td>string $charset Charset used to store data</td> <td>2</td> </tr> <tr> <td>string $collation Charset used to sort data</td> <td>2</td> </tr> <tr> <td>string $owner Username of database owner</td> <td>2</td> </tr> <tr> <td>string $sortfield List of sort fields</td> <td>2</td> </tr> <tr> <td>string $value Value to decrypt</td> <td>2</td> </tr> <tr> <td>string $fieldid Field name</td> <td>2</td> </tr> <tr> <td>string $log Add more log to default log line</td> <td>2</td> </tr> <tr> <td>int $limit Maximum number of lines returned (-1=conf->liste_limit, 0=no limit)</td> <td>2</td> </tr> <tr> <td>int $offset Numero of line from where starting fetch</td> <td>2</td> </tr> <tr> <td>string $filter Filter list on a particular value</td> <td>2</td> </tr> <tr> <td>array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> $fields Associative table [field name][table of descriptions]</td> <td>2</td> </tr> <tr> <td>string $field_name Name of field to add</td> <td>2</td> </tr> <tr> <td>string $field_name Name of field to drop</td> <td>2</td> </tr> <tr> <td>string $field_name Name of field to modify</td> <td>2</td> </tr> <tr> <td>string $dolibarr_main_db_name Database name where user must be granted</td> <td>2</td> </tr> <tr> <td>string $string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)</td> <td>2</td> </tr> <tr> <td>bool $gm 1=Input information are GMT values, otherwise local to server TZ</td> <td>2</td> </tr> <tr> <td>string $log Add more log to default log line</td> <td>2</td> </tr> <tr> <td>string $table Name of table</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>2</td> </tr> <tr> <td>int $status Status to set</td> <td>2</td> </tr> <tr> <td>int $active 1=Active only, 0=Not active only, -1=All</td> <td>2</td> </tr> <tr> <td>string $fk_prospectlevel Prospect level</td> <td>2</td> </tr> <tr> <td>int $mode 0=label long, 1=label short, 2=Picto + Label short, 3=Picto, 4=Picto + Label long</td> <td>2</td> </tr> <tr> <td>string $label Label to use for status for added status</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>2</td> </tr> <tr> <td>string $label Label to use for status for added status</td> <td>2</td> </tr> <tr> <td>int $no_email 1=Do not send mailing, 0=Ok to receive mailing</td> <td>2</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>2</td> </tr> <tr> <td>integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, 1 otherwise)</td> <td>2</td> </tr> <tr> <td>int $status Id status</td> <td>2</td> </tr> <tr> <td>int $notrigger Do not execute trigger</td> <td>2</td> </tr> <tr> <td>string $ref Ref of the value</td> <td>2</td> </tr> <tr> <td>string $value Value</td> <td>2</td> </tr> <tr> <td>boolean $renum True to renum all already ordered lines, false to renum only not already ordered lines.</td> <td>2</td> </tr> <tr> <td>string $rowidorder ASC or DESC</td> <td>2</td> </tr> <tr> <td>int $max Max</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>int $dateSelector 1=Show also date range input fields</td> <td>2</td> </tr> <tr> <td>Societe $seller Object thirdparty who sell</td> <td>2</td> </tr> <tr> <td>Societe $buyer Object thirdparty who buy</td> <td>2</td> </tr> <tr> <td>string $defaulttpldir Directory where to find the template</td> <td>2</td> </tr> <tr> <td>string $action Action code</td> <td>2</td> </tr> <tr> <td>Societe $seller Object of seller third party</td> <td>2</td> </tr> <tr> <td>Societe $buyer Object of buyer third party</td> <td>2</td> </tr> <tr> <td>int $dateSelector 1=Show also date range input fields</td> <td>2</td> </tr> <tr> <td>string $defaulttpldir Directory where to find the template</td> <td>2</td> </tr> <tr> <td>string $action GET/POST action</td> <td>2</td> </tr> <tr> <td>CommonObjectLine $line Selected object line to output</td> <td>2</td> </tr> <tr> <td>int $num Number of line (0)</td> <td>2</td> </tr> <tr> <td>int $i I</td> <td>2</td> </tr> <tr> <td>int $dateSelector 1=Show also date range input fields</td> <td>2</td> </tr> <tr> <td>Societe $seller Object of seller third party</td> <td>2</td> </tr> <tr> <td>Societe $buyer Object of buyer third party</td> <td>2</td> </tr> <tr> <td>Extrafields $extrafields Object of extrafields</td> <td>2</td> </tr> <tr> <td>string $defaulttpldir Directory where to find the template (deprecated)</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>int $fk_product_attribute_combination Id of combination</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>int $id Id</td> <td>2</td> </tr> <tr> <td>int $mode 0=field active, 1=field reconcilable</td> <td>2</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>2</td> </tr> <tr> <td>string $mode Mode ('' or 'tmp_')</td> <td>2</td> </tr> <tr> <td>string $mode Mode</td> <td>2</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>2</td> </tr> <tr> <td>string $filter Filter</td> <td>2</td> </tr> <tr> <td>int $date_start Date start</td> <td>2</td> </tr> <tr> <td>int $date_end Date end</td> <td>2</td> </tr> <tr> <td>string $code Code</td> <td>2</td> </tr> <tr> <td>string $label Label</td> <td>2</td> </tr> <tr> <td>User $user User who get infos</td> <td>2</td> </tr> <tr> <td>string $type Type data returned ('view', 'bookkeeping', 'csv')</td> <td>2</td> </tr> <tr> <td>int $date_start Filter 'start date'</td> <td>2</td> </tr> <tr> <td>int $date_end Filter 'end date'</td> <td>2</td> </tr> <tr> <td>string $in_bookkeeping Filter 'in bookkeeping' ('already', 'notyet')</td> <td>2</td> </tr> <tr> <td>array $ids ids array</td> <td>2</td> </tr> <tr> <td>int $notrigger no trigger</td> <td>2</td> </tr> <tr> <td>array $bookkeeping_ids Lettering specific list of bookkeeping id</td> <td>2</td> </tr> <tr> <td>bool $unlettering Do unlettering</td> <td>2</td> </tr> <tr> <td>array $document_ids List of document id</td> <td>2</td> </tr> <tr> <td>string $doc_type Type of document ('customer_invoice' or 'supplier_invoice', ...)</td> <td>2</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>2</td> </tr> <tr> <td>float $qty Quantity</td> <td>2</td> </tr> <tr> <td>int $disable_stock_change Disable stock change on using in MO</td> <td>2</td> </tr> <tr> <td>float $efficiency Efficiency in MO</td> <td>2</td> </tr> <tr> <td>int $position Position of BOM-Line in BOM-Lines</td> <td>2</td> </tr> <tr> <td>string $import_key Import Key</td> <td>2</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>2</td> </tr> <tr> <td>int $fk_default_workstation Default workstation</td> <td>2</td> </tr> <tr> <td>Product $prod Object product</td> <td>2</td> </tr> <tr> <td>array $request_data BOMLine data</td> <td>2</td> </tr> <tr> <td>Expedition $object Object expedition to generate (or id if old method)</td> <td>2</td> </tr> <tr> <td>string $base_subject email subject. Non-translated string.</td> <td>2</td> </tr> <tr> <td>Ticket $object the ticket thet the email refers to</td> <td>2</td> </tr> <tr> <td>Translate $langs the translation object</td> <td>2</td> </tr> <tr> <td>int $multicurrency Return multicurrency_amount instead of amount. -1=Return both.</td> <td>2</td> </tr> <tr> <td>int $multicurrency Return multicurrency_amount instead of amount</td> <td>2</td> </tr> <tr> <td>int $multicurrency Return multicurrency_amount instead of amount</td> <td>2</td> </tr> <tr> <td>User $fuser User asking the direct debit transfer</td> <td>2</td> </tr> <tr> <td>float $amount Amount we request direct debit for</td> <td>2</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>2</td> </tr> <tr> <td>string $sourcetype Source ('facture' or 'supplier_invoice')</td> <td>2</td> </tr> <tr> <td>int $checkduplicateamongall 0=Default (check among open requests only to find if request already exists). 1=Check also among requests completely processed and cancel if at least 1 request exists whatever is its status.</td> <td>2</td> </tr> <tr> <td>User $fuser User asking the direct debit transfer</td> <td>2</td> </tr> <tr> <td>string $sourcetype Source ('facture' or 'supplier_invoice')</td> <td>2</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>2</td> </tr> <tr> <td>User $fuser User making delete</td> <td>2</td> </tr> <tr> <td>int $did ID of request to delete</td> <td>2</td> </tr> <tr> <td>CommonObject $object Object we want to get margin information for</td> <td>2</td> </tr> <tr> <td>string $paramid Key of parameter for id ('id', 'socid')</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of select field</td> <td>2</td> </tr> <tr> <td>bool $multiple add [] in the name of element and add 'multiple' attribute</td> <td>2</td> </tr> <tr> <td>string $action Value for $action</td> <td>2</td> </tr> <tr> <td>string $htmlname Field name in form</td> <td>2</td> </tr> <tr> <td>int[] $exclude Array list of users id to exclude</td> <td>2</td> </tr> <tr> <td>int<0,1> $disabled If select list must be disabled</td> <td>2</td> </tr> <tr> <td>string $force_entity '0' or Ids of environment to force</td> <td>2</td> </tr> <tr> <td>int $maxlength Maximum length of string into list (0=no limit)</td> <td>2</td> </tr> <tr> <td>string $morefilter Add more filters into sql request</td> <td>2</td> </tr> <tr> <td>int $showproperties Show properties of each attendees</td> <td>2</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>2</td> </tr> <tr> <td>string $opt Option (var used for returned value in string option format)</td> <td>2</td> </tr> <tr> <td>string $filterkey Filter key to highlight</td> <td>2</td> </tr> <tr> <td>string $placeholder Placeholder</td> <td>2</td> </tr> <tr> <td>int $addempty Add an empty entry</td> <td>2</td> </tr> <tr> <td>int $selected Id of payment term to preselect by default</td> <td>2</td> </tr> <tr> <td>int $filtertype If > 0, include payment terms with deposit percentage (for objects other than invoices and invoice templates)</td> <td>2</td> </tr> <tr> <td>int $addempty Add an empty entry</td> <td>2</td> </tr> <tr> <td>int $noinfoadmin 0=Add admin info, 1=Disable admin info</td> <td>2</td> </tr> <tr> <td>int $deposit_percent < 0 : deposit_percent input makes no sense (for example, in list filters)</td> <td>2</td> </tr> <tr> <td>int $nooutput 1=Return string, do not send to output</td> <td>2</td> </tr> <tr> <td>int $noadmininfo 0=Add admin info, 1=Disable admin info</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of select zone</td> <td>2</td> </tr> <tr> <td>string $filtre To filter list. This parameter must not come from input of users</td> <td>2</td> </tr> <tr> <td>string $moreattrib To add more attribute on select</td> <td>2</td> </tr> <tr> <td>string $page Page</td> <td>2</td> </tr> <tr> <td>int $page Page</td> <td>2</td> </tr> <tr> <td>int $nooutput No print is done. String is returned.</td> <td>2</td> </tr> <tr> <td>int $addempty 1=Add empty entry</td> <td>2</td> </tr> <tr> <td>string $selected preselected currency code</td> <td>2</td> </tr> <tr> <td>integer $useempty 1=Add empty line</td> <td>2</td> </tr> <tr> <td>integer|string $set_time Pre-selected date (must be a local PHP server timestamp), -1 to keep date not preselected, '' to use current date with 00:00 hour (Parameter 'empty' must be 0 or 2).</td> <td>2</td> </tr> <tr> <td>string $prefix Prefix for fields name</td> <td>2</td> </tr> <tr> <td>int $nooutput Do not output html string but return it</td> <td>2</td> </tr> <tr> <td>int $status Ticket status</td> <td>2</td> </tr> <tr> <td>string $opt Option (var used for returned value in string option format)</td> <td>2</td> </tr> <tr> <td>string $selected Preselected value</td> <td>2</td> </tr> <tr> <td>string $filterkey Filter key to highlight</td> <td>2</td> </tr> <tr> <td>string $selected_input_value Value of preselected input text (for use with ajax)</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of select html</td> <td>2</td> </tr> <tr> <td>int $status Ticket status</td> <td>2</td> </tr> <tr> <td>string $selected Preselected value</td> <td>2</td> </tr> <tr> <td>Object $objecttmp Object to know the table to scan for combo.</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of HTML select component</td> <td>2</td> </tr> <tr> <td>int $preselectedvalue Preselected value (ID of element)</td> <td>2</td> </tr> <tr> <td>string $searchkey Search value</td> <td>2</td> </tr> <tr> <td>string $placeholder Place holder</td> <td>2</td> </tr> <tr> <td>string $moreparams More params provided to ajax call</td> <td>2</td> </tr> <tr> <td>int $forcecombo Force to load all values and output a standard combobox (with no beautification)</td> <td>2</td> </tr> <tr> <td>int $outputmode 0=HTML select string, 1=Array</td> <td>2</td> </tr> <tr> <td>int $disabled 1=Html component is disabled</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>string $filter Add more filter (Universal Search Filter)</td> <td>2</td> </tr> <tr> <td>string $cssclass CSS class</td> <td>2</td> </tr> <tr> <td>int $calljsfunction 0=default. 1=call function initCheckForSelect() after changing status of checkboxes</td> <td>2</td> </tr> <tr> <td>string $selected preselected category</td> <td>2</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)</td> <td>2</td> </tr> <tr> <td>string $selected Id invoice preselected</td> <td>2</td> </tr> <tr> <td>string $projectsListId ''=Automatic filter on project allowed. List of id=Filter on project ids.</td> <td>2</td> </tr> <tr> <td>User $usertofilter User object to use for filtering</td> <td>2</td> </tr> <tr> <td>boolean $compareCharacters true to compare characters, and false to compare lines; this optional parameter defaults to false</td> <td>2</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> $diff the diff array</td> <td>2</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> $diff the diff array</td> <td>2</td> </tr> <tr> <td>string $_val Value</td> <td>2</td> </tr> <tr> <td>boolean $_part To "strip" 'Real name' from address</td> <td>2</td> </tr> <tr> <td>array $args Args</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>2</td> </tr> <tr> <td>int $useempty Set to 1 if we want an empty value</td> <td>2</td> </tr> <tr> <td>int $maxlen Max length of text in combo box</td> <td>2</td> </tr> <tr> <td>int $help Add or not the admin help picto</td> <td>2</td> </tr> <tr> <td>string|array $a Server</td> <td>2</td> </tr> <tr> <td>int $selected Id code pre-selected</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of HTML select field</td> <td>2</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>2</td> </tr> <tr> <td>string $type Type des modeles recherches</td> <td>2</td> </tr> <tr> <td>int $projectid Project id</td> <td>2</td> </tr> <tr> <td>int $mode 0=Return list of tasks and their projects, 1=Return projects and tasks if exists</td> <td>2</td> </tr> <tr> <td>int $disablechildoftaskid 1=Disable task that are child of the provided task id</td> <td>2</td> </tr> <tr> <td>int $offset Offset</td> <td>2</td> </tr> <tr> <td>int $useempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.</td> <td>2</td> </tr> <tr> <td>mixed $object Object analyzed</td> <td>2</td> </tr> <tr> <td>string $showempty '1' or 'text'</td> <td>2</td> </tr> <tr> <td>string $morecss More css</td> <td>2</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>2</td> </tr> <tr> <td>int $id Id of CUnit object to fetch (rowid)</td> <td>2</td> </tr> <tr> <td>string $code Code</td> <td>2</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>2</td> </tr> <tr> <td>string $mode 0= id , short_label=Use short label as value, code=use code</td> <td>2</td> </tr> <tr> <td>string $htmlname select html name</td> <td>2</td> </tr> <tr> <td>string $name Printer name</td> <td>2</td> </tr> <tr> <td>int $type Printer type</td> <td>2</td> </tr> <tr> <td>int $profile Printer profile</td> <td>2</td> </tr> <tr> <td>string $parameter Printer parameter</td> <td>2</td> </tr> <tr> <td>int $printerid Printer id</td> <td>2</td> </tr> <tr> <td>string $name Template name</td> <td>2</td> </tr> <tr> <td>int $template Template</td> <td>2</td> </tr> <tr> <td>int $socid Id third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)</td> <td>2</td> </tr> <tr> <td>int $maxlength Maximum length of label</td> <td>2</td> </tr> <tr> <td>int $option_only Return only html options lines without the select tag</td> <td>2</td> </tr> <tr> <td>int $forcefocus Force focus on field (works with javascript only)</td> <td>2</td> </tr> <tr> <td>int $disabled Disabled</td> <td>2</td> </tr> <tr> <td>int $nooutput No print output. Return it only.</td> <td>2</td> </tr> <tr> <td>int $forceaddid Force to add project id in list, event if not qualified</td> <td>2</td> </tr> <tr> <td>string $morecss More css</td> <td>2</td> </tr> <tr> <td>string $morefilter More filters (Must be a sql sanitized string)</td> <td>2</td> </tr> <tr> <td>string $code code</td> <td>2</td> </tr> <tr> <td>string $label Label</td> <td>2</td> </tr> <tr> <td>int $limit Limit</td> <td>2</td> </tr> <tr> <td>int $offset offset limit</td> <td>2</td> </tr> <tr> <td>string $filter Add a SQL filter to select. Data must not come from user input.</td> <td>2</td> </tr> <tr> <td>int $page Page</td> <td>2</td> </tr> <tr> <td>int $selected Id or code preselected</td> <td>2</td> </tr> <tr> <td>string $htmlname Nom du formulaire select</td> <td>2</td> </tr> <tr> <td>int $empty Add empty value in list</td> <td>2</td> </tr> <tr> <td>int $selected Code state preselected (mus be state id)</td> <td>2</td> </tr> <tr> <td>integer $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show</td> <td>2</td> </tr> <tr> <td>string $htmlname Id of department. If '', we want only the string with <option></td> <td>2</td> </tr> <tr> <td>string $morecss Add more css</td> <td>2</td> </tr> <tr> <td>string $selected Preselected value</td> <td>2</td> </tr> <tr> <td>string $htmlname HTML select name</td> <td>2</td> </tr> <tr> <td>array $fields Array with key of fields to refresh after selection</td> <td>2</td> </tr> <tr> <td>int $fieldsize Field size</td> <td>2</td> </tr> <tr> <td>int $disableautocomplete 1 To disable ajax autocomplete features (browser autocomplete may still occurs)</td> <td>2</td> </tr> <tr> <td>string $moreattrib Add more attribute on HTML input field</td> <td>2</td> </tr> <tr> <td>string $morecss More css</td> <td>2</td> </tr> <tr> <td>int $idprof 1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm)</td> <td>2</td> </tr> <tr> <td>string|array $filter filter array</td> <td>2</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>2</td> </tr> <tr> <td>int $length max length</td> <td>2</td> </tr> <tr> <td>string $expr String</td> <td>2</td> </tr> <tr> <td>string $file File to scan</td> <td>2</td> </tr> <tr> <td>string $htmlname Nom de la zone html</td> <td>2</td> </tr> <tr> <td>int $maxlength Maximum length of label</td> <td>2</td> </tr> <tr> <td>int $noouput 1=Return the output instead of display</td> <td>2</td> </tr> <tr> <td>string $param1 chaine de param1</td> <td>2</td> </tr> <tr> <td>string $param2 chaine de param2</td> <td>2</td> </tr> <tr> <td>string $param3 chaine de param3</td> <td>2</td> </tr> <tr> <td>string $param4 chaine de param4</td> <td>2</td> </tr> <tr> <td>string $param5 chaine de param5</td> <td>2</td> </tr> <tr> <td>string $str string root to translate</td> <td>2</td> </tr> <tr> <td>string $countrycode country code (FR, ...)</td> <td>2</td> </tr> <tr> <td>string $pagecodefrom Page code of src string</td> <td>2</td> </tr> <tr> <td>string $subject Topic/Subject of mail</td> <td>2</td> </tr> <tr> <td>string $attrname Code of attribute</td> <td>2</td> </tr> <tr> <td>string $label label of attribute</td> <td>2</td> </tr> <tr> <td>string $type Type of attribute ('boolean','int','varchar','text','html','date','datetime','price', 'pricecy', 'phone','mail','password','url','select','checkbox','separate',...)</td> <td>2</td> </tr> <tr> <td>int $pos Position of attribute</td> <td>2</td> </tr> <tr> <td>string $size Size/length definition of attribute ('5', '24,8', ...). For float, it contains 2 numeric separated with a comma.</td> <td>2</td> </tr> <tr> <td>string $elementtype Element type. Same value than object->table_element (Example 'member', 'product', 'thirdparty', ...)</td> <td>2</td> </tr> <tr> <td>int $unique Is field unique or not</td> <td>2</td> </tr> <tr> <td>int $required Is field required or not</td> <td>2</td> </tr> <tr> <td>string $default_value Defaulted value (In database. use the default_value feature for default value on screen. Example: '', '0', 'null', 'avalue')</td> <td>2</td> </tr> <tr> <td>array|string $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) )</td> <td>2</td> </tr> <tr> <td>int $alwayseditable Is attribute always editable regardless of the document status</td> <td>2</td> </tr> <tr> <td>string $perms Permission to check</td> <td>2</td> </tr> <tr> <td>string $list Visibility ('0'=never visible, '1'=visible on list+forms, '2'=list only, '3'=form only or 'eval string')</td> <td>2</td> </tr> <tr> <td>string $help Text with help tooltip</td> <td>2</td> </tr> <tr> <td>string $computed Computed value</td> <td>2</td> </tr> <tr> <td>string $entity Entity of extrafields (for multicompany modules)</td> <td>2</td> </tr> <tr> <td>string $langfile Language file</td> <td>2</td> </tr> <tr> <td>string $enabled Condition to have the field enabled or not</td> <td>2</td> </tr> <tr> <td>int $totalizable Is a measure. Must show a total on lists</td> <td>2</td> </tr> <tr> <td>int $printable Is extrafield displayed on PDF</td> <td>2</td> </tr> <tr> <td>array $moreparams More parameters. Example: array('css'=>, 'csslist'=>Css on list, 'cssview'=>...)</td> <td>2</td> </tr> <tr> <td>string $elementtype Element type ('member', 'product', 'thirdparty', 'contact', ...)</td> <td>2</td> </tr> <tr> <td>string $help Help on tooltip</td> <td>2</td> </tr> <tr> <td>string $attrname Name of attribute</td> <td>2</td> </tr> <tr> <td>string $label Label of attribute</td> <td>2</td> </tr> <tr> <td>int $pos Position of attribute</td> <td>2</td> </tr> <tr> <td>int $alwayseditable Is attribute always editable regardless of the document status</td> <td>2</td> </tr> <tr> <td>string $perms Permission to check</td> <td>2</td> </tr> <tr> <td>string $list Visibility</td> <td>2</td> </tr> <tr> <td>string $default Default value (in database. use the default_value feature for default value on screen).</td> <td>2</td> </tr> <tr> <td>string $langfile Language file</td> <td>2</td> </tr> <tr> <td>string $enabled Condition to have the field enabled or not</td> <td>2</td> </tr> <tr> <td>int $totalizable Is extrafield totalizable on list</td> <td>2</td> </tr> <tr> <td>int $printable Is extrafield displayed on PDF</td> <td>2</td> </tr> <tr> <td>boolean $forceload Force load of extra fields whatever is status of cache.</td> <td>2</td> </tr> <tr> <td>string $value Value to show</td> <td>2</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag (only checkbox use html input for output rendering)</td> <td>2</td> </tr> <tr> <td>int $option 0=No option, 1=Add civility</td> <td>2</td> </tr> <tr> <td>string $htmlkey HTML id to make banner content unique</td> <td>2</td> </tr> <tr> <td>Object $object Object (thirdparty, thirdparty of contact for contact, null for a member)</td> <td>2</td> </tr> <tr> <td>string $action Action string</td> <td>2</td> </tr> <tr> <td>array<string,mixed> $params params to construct tooltip data</td> <td>2</td> </tr> <tr> <td>string $field Field selected</td> <td>2</td> </tr> <tr> <td>int $rowid Id of line</td> <td>2</td> </tr> <tr> <td>boolean $fk_parent_line Table with fk_parent_line field or not</td> <td>2</td> </tr> <tr> <td>string $note New value for note</td> <td>2</td> </tr> <tr> <td>int $sourceid Object source id</td> <td>2</td> </tr> <tr> <td>string $sourcetype Object source type</td> <td>2</td> </tr> <tr> <td>int $targetid Object target id</td> <td>2</td> </tr> <tr> <td>string $targettype Object target type</td> <td>2</td> </tr> <tr> <td>User $f_user User that create</td> <td>2</td> </tr> <tr> <td>int $fk_object_where id of object we need to get linked items</td> <td>2</td> </tr> <tr> <td>string $field_where name of field of object we need to get linked items</td> <td>2</td> </tr> <tr> <td>string $restrictlist ''=All lines, 'services'=Restrict to services only (strike line if not)</td> <td>2</td> </tr> <tr> <td>string $defaulttpldir Directory where to find the template</td> <td>2</td> </tr> <tr> <td>string $triggerName trigger's name to execute</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>string $key Key of attribute</td> <td>2</td> </tr> <tr> <td>string $moreparam To add more parameters on html input tag</td> <td>2</td> </tr> <tr> <td>string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>2</td> </tr> <tr> <td>string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names)</td> <td>2</td> </tr> <tr> <td>string|int $morecss Value for css to define style/length of field. May also be a numeric.</td> <td>2</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info Properties of field</td> <td>2</td> </tr> <tr> <td>int<0,1> $notrigger 0=launch triggers after, 1=disable triggers</td> <td>2</td> </tr> <tr> <td>int $id Id object</td> <td>2</td> </tr> <tr> <td>string $ref Ref</td> <td>2</td> </tr> <tr> <td>string $morewhere More SQL filters (' AND ...')</td> <td>2</td> </tr> <tr> <td>int<0,1> $noextrafields 0=Default to load extrafields, 1=No extrafields</td> <td>2</td> </tr> <tr> <td>int $status New status to set (often a constant like self::STATUS_XXX)</td> <td>2</td> </tr> <tr> <td>string $triggercode Trigger code to use</td> <td>2</td> </tr> <tr> <td>string[] $parameters array of parameters to trim</td> <td>2</td> </tr> <tr> <td>string $titre Label of menu to add. The value must already be translated.</td> <td>2</td> </tr> <tr> <td>integer $level Level of menu to add</td> <td>2</td> </tr> <tr> <td>string $target Target link</td> <td>2</td> </tr> <tr> <td>string $mainmenu Main menu ('home', 'companies', 'products', ...)</td> <td>2</td> </tr> <tr> <td>string $leftmenu Left menu ('setup', 'system', 'admintools', ...)</td> <td>2</td> </tr> <tr> <td>int $position Position (not used yet)</td> <td>2</td> </tr> <tr> <td>string $id Id</td> <td>2</td> </tr> <tr> <td>string $idsel Id sel</td> <td>2</td> </tr> <tr> <td>string $classname Class name</td> <td>2</td> </tr> <tr> <td>string $prefix Prefix to title (image or picto)</td> <td>2</td> </tr> <tr> <td>User|null $user User deleting</td> <td>2</td> </tr> <tr> <td>User|null $user User</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Disable triggers</td> <td>2</td> </tr> <tr> <td>string $type If id of company filled, we say if we want record of this type only</td> <td>2</td> </tr> <tr> <td>User|null $user Object user</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Disable triggers</td> <td>2</td> </tr> <tr> <td>CommonInvoice $invoice Object invoice</td> <td>2</td> </tr> <tr> <td>string $myleftmenu Value for leftmenu to filter menu to load (always '')</td> <td>2</td> </tr> <tr> <td>int $type_user 0=Menu for backoffice, 1=Menu for front office</td> <td>2</td> </tr> <tr> <td>string $menu_handler Filter on name of menu_handler used (auguria, eldy...)</td> <td>2</td> </tr> <tr> <td>int $call_trigger 0=no, 1=yes</td> <td>2</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>2</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>2</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>2</td> </tr> <tr> <td>int|string $datestart Date start to scan</td> <td>2</td> </tr> <tr> <td>int|string $dateend Date end to scan</td> <td>2</td> </tr> <tr> <td>int $addjscombo Add js combo</td> <td>2</td> </tr> <tr> <td>string $htmlContent HTML name of WYSIWYG field</td> <td>2</td> </tr> <tr> <td>array $info Attributes array</td> <td>2</td> </tr> <tr> <td>string $str String to convert</td> <td>2</td> </tr> <tr> <td>string $addfileaction Name of action when posting file attachments</td> <td>2</td> </tr> <tr> <td>string $removefileaction Name of action when removing file attachments</td> <td>2</td> </tr> <tr> <td>string $format Format for output ('', 'html', ...)</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Output lang object</td> <td>2</td> </tr> <tr> <td>string $array_key Name of the key for return array</td> <td>2</td> </tr> <tr> <td>float $curY current Y position</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>2</td> </tr> <tr> <td>bool $hideTitle True to hide the first title line</td> <td>2</td> </tr> <tr> <td>callable $callBack a callable function</td> <td>2</td> </tr> <tr> <td>string $urlsource Url of origin page (for return)</td> <td>2</td> </tr> <tr> <td>int $delallowed Remove is allowed (1/0)</td> <td>2</td> </tr> <tr> <td>string $modelselected Model to preselect by default</td> <td>2</td> </tr> <tr> <td>integer $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined)</td> <td>2</td> </tr> <tr> <td>int $notused Not used</td> <td>2</td> </tr> <tr> <td>integer $noform Do not output html form tags</td> <td>2</td> </tr> <tr> <td>string $param More param on http links</td> <td>2</td> </tr> <tr> <td>string $buttonlabel Label on submit button</td> <td>2</td> </tr> <tr> <td>string $codelang Default language code to use on lang combo box if multilang is enabled</td> <td>2</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month</td> <td>2</td> </tr> <tr> <td>int $startmonth month of the fiscal year start min 1 max 12 ; if 1 = january</td> <td>2</td> </tr> <tr> <td>string $sql SQL</td> <td>2</td> </tr> <tr> <td>int $limit Limit</td> <td>2</td> </tr> <tr> <td>string $s Shading</td> <td>2</td> </tr> <tr> <td>string $fileurl Url path to show image if saved onto disk. Never used here.</td> <td>2</td> </tr> <tr> <td>string $name Name</td> <td>2</td> </tr> <tr> <td>string $postoffice Postoffice</td> <td>2</td> </tr> <tr> <td>string $extended Extended</td> <td>2</td> </tr> <tr> <td>string $street Street</td> <td>2</td> </tr> <tr> <td>string $city City</td> <td>2</td> </tr> <tr> <td>string $region Region</td> <td>2</td> </tr> <tr> <td>string $zip Zip</td> <td>2</td> </tr> <tr> <td>string $country Country</td> <td>2</td> </tr> <tr> <td>string $type Type</td> <td>2</td> </tr> <tr> <td>mixed $value Value</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of html select</td> <td>2</td> </tr> <tr> <td>string $user Nom de l'utilisateur autorise</td> <td>2</td> </tr> <tr> <td>string $name Nom de la database</td> <td>2</td> </tr> <tr> <td>string $line SQL request line to convert</td> <td>2</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>2</td> </tr> <tr> <td>SQLite3Result $resultset Resultset of request</td> <td>2</td> </tr> <tr> <td>SQLite3Result $resultset Resulset of requests</td> <td>2</td> </tr> <tr> <td>string $tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql</td> <td>2</td> </tr> <tr> <td>string $table Nom de la table</td> <td>2</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Associative table with description of field to insert [parameter name][parameter value]</td> <td>2</td> </tr> <tr> <td>string $field_position Optional e.g.: "after some_field"</td> <td>2</td> </tr> <tr> <td>string $nameoffield Name of field</td> <td>2</td> </tr> <tr> <td>string $nameofindex Name of index</td> <td>2</td> </tr> <tr> <td>string $subject Field name to test</td> <td>2</td> </tr> <tr> <td>string $pattern SQL pattern to match</td> <td>2</td> </tr> <tr> <td>int $sqlstring 0=the string being tested is a hard coded string, 1=the string is a field</td> <td>2</td> </tr> <tr> <td>int $limit Maximum number of lines returned (-1=conf->liste_limit, 0=no limit)</td> <td>2</td> </tr> <tr> <td>int $offset Numero of line from where starting fetch</td> <td>2</td> </tr> <tr> <td>string $sortfield List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb'</td> <td>2</td> </tr> <tr> <td>int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).</td> <td>2</td> </tr> <tr> <td>resource $resultset Resultset of request</td> <td>2</td> </tr> <tr> <td>resource $resultset Result set of request</td> <td>2</td> </tr> <tr> <td>string $field_name Name of field to add</td> <td>2</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Associative array of description of the field to insert [parameter name][parameter value]</td> <td>2</td> </tr> <tr> <td>string $user Name of database user</td> <td>2</td> </tr> <tr> <td>string $pass Password of database user</td> <td>2</td> </tr> <tr> <td>mysqli_result $resultset Resultset of request</td> <td>2</td> </tr> <tr> <td>mysqli_result|resource|SQLite3Result $resultset Resultset of request</td> <td>2</td> </tr> <tr> <td>string $options Options when enabling module ('', 'noboxes')</td> <td>2</td> </tr> <tr> <td>int $r Dataset index</td> <td>2</td> </tr> <tr> <td>string $options Options when enabling module ('', 'noboxes')</td> <td>2</td> </tr> <tr> <td>string $options Options</td> <td>2</td> </tr> <tr> <td>Workstation $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>int $id ID</td> <td>2</td> </tr> <tr> <td>string $sourcetype Source type</td> <td>2</td> </tr> <tr> <td>string $sql SQL request to use to count</td> <td>2</td> </tr> <tr> <td>Expedition $shipment Shipment object</td> <td>2</td> </tr> <tr> <td>int $deja_regle Amount already paid</td> <td>2</td> </tr> <tr> <td>PaiementFourn $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>int $posy Position depart</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object langs</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>Contrat $contract contract object</td> <td>2</td> </tr> <tr> <td>string $suffixinfilename When output is a file, append this suffix into default log filename.</td> <td>2</td> </tr> <tr> <td>array $content Array containing the info about the message</td> <td>2</td> </tr> <tr> <td>string $suffixinfilename When output is a file, append this suffix into default log filename.</td> <td>2</td> </tr> <tr> <td>Asset $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>Object $object Object to generate</td> <td>2</td> </tr> <tr> <td>TCPDF|TCPDI $pdf Object PDF</td> <td>2</td> </tr> <tr> <td>string $password Password to check</td> <td>2</td> </tr> <tr> <td>Commande $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>Commande $object Object to generate</td> <td>2</td> </tr> <tr> <td>Commande $object Object order</td> <td>2</td> </tr> <tr> <td>Commande $object Object to show</td> <td>2</td> </tr> <tr> <td>Commande $object Object to show</td> <td>2</td> </tr> <tr> <td>Account $object Object Account to generate</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Langs object</td> <td>2</td> </tr> <tr> <td>int $posy Position depart</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object langs</td> <td>2</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>2</td> </tr> <tr> <td>Facture $object Invoice object</td> <td>2</td> </tr> <tr> <td>Translate $langs Translation object</td> <td>2</td> </tr> <tr> <td>Facture $object Object to generate</td> <td>2</td> </tr> <tr> <td>int $heightforfooter Height for footer</td> <td>2</td> </tr> <tr> <td>Facture $object Object to show</td> <td>2</td> </tr> <tr> <td>Facture $object Object to show</td> <td>2</td> </tr> <tr> <td>Facture $object Object to show</td> <td>2</td> </tr> <tr> <td>int $heightforqrinvoice Height for QR invoices</td> <td>2</td> </tr> <tr> <td>RemiseCheque $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>TCPDF $pdf PDF object</td> <td>2</td> </tr> <tr> <td>int $pagenb Page nb</td> <td>2</td> </tr> <tr> <td>Propal $propal Object commercial proposal</td> <td>2</td> </tr> <tr> <td>Propal $object Object to generate</td> <td>2</td> </tr> <tr> <td>Propal $object Object to show</td> <td>2</td> </tr> <tr> <td>Propal $object Object to show</td> <td>2</td> </tr> <tr> <td>Propal $object Object to show</td> <td>2</td> </tr> <tr> <td>Propal $object Object source to build document</td> <td>2</td> </tr> <tr> <td>string $objforref Object for number to search</td> <td>2</td> </tr> <tr> <td>Mo $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>string $textleft Text left</td> <td>2</td> </tr> <tr> <td>string $header Header</td> <td>2</td> </tr> <tr> <td>string $footer Footer</td> <td>2</td> </tr> <tr> <td>string $textright Text right</td> <td>2</td> </tr> <tr> <td>string $file file</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>Societe $societe Third party object</td> <td>2</td> </tr> <tr> <td>Societe|string $objsoc Object third party</td> <td>2</td> </tr> <tr> <td>Societe $soc Object societe</td> <td>2</td> </tr> <tr> <td>int $type 0 = customer/prospect , 1 = supplier</td> <td>2</td> </tr> <tr> <td>integer $maxfilenamelength Max length of value to show</td> <td>2</td> </tr> <tr> <td>int $type Type</td> <td>2</td> </tr> <tr> <td>User $object Object source to build document</td> <td>2</td> </tr> <tr> <td>CommonObject $object user</td> <td>2</td> </tr> <tr> <td>string $code Code to check/correct</td> <td>2</td> </tr> <tr> <td>int $type 0 = product , 1 = service</td> <td>2</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>2</td> </tr> <tr> <td>SupplierProposal $supplier_proposal Object commercial proposal</td> <td>2</td> </tr> <tr> <td>Object $object Object to show</td> <td>2</td> </tr> <tr> <td>Societe|string $objsoc Object third party</td> <td>2</td> </tr> <tr> <td>Task $task Task Object</td> <td>2</td> </tr> <tr> <td>array $contact Contact array</td> <td>2</td> </tr> <tr> <td>array $refdetail Reference array</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>2</td> </tr> <tr> <td>string $srctemplatepath Full path of source filename for generator using a template file</td> <td>2</td> </tr> <tr> <td>Project $object Object to show</td> <td>2</td> </tr> <tr> <td>Evaluation $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>Societe|string $objsoc Object thirdparty</td> <td>2</td> </tr> <tr> <td>Fichinter|string $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>Fichinter $objforref Object for number to search</td> <td>2</td> </tr> <tr> <td>StockTransfer $object Object we need next value for</td> <td>2</td> </tr> <tr> <td>FactureFournisseur $object Object invoice</td> <td>2</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>2</td> </tr> <tr> <td>Delivery $object Object to generate</td> <td>2</td> </tr> <tr> <td>Delivery $object Object to show</td> <td>2</td> </tr> <tr> <td>Delivery $object Object to show</td> <td>2</td> </tr> <tr> <td>Delivery $object Object to show</td> <td>2</td> </tr> <tr> <td>array $param Associative array containing label content and optional parameters</td> <td>2</td> </tr> <tr> <td>array $arrayofrecords Array of record information (array('textleft'=>,'textheader'=>, ..., 'id'=>,'photo'=>)</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Lang object for output language</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object lang to translate values</td> <td>2</td> </tr> <tr> <td>string $startCell starting cell</td> <td>2</td> </tr> <tr> <td>string $file Path of filename to generate</td> <td>2</td> </tr> <tr> <td>string $charset Input AND Output character set</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Output language object</td> <td>2</td> </tr> <tr> <td>string $code Code to check/correct</td> <td>2</td> </tr> <tr> <td>int $thirdparty_type 0 = customer/prospect , 1 = supplier</td> <td>2</td> </tr> <tr> <td>string $type type of barcode (EAN, ISBN, ...)</td> <td>2</td> </tr> <tr> <td>string $code Code to check</td> <td>2</td> </tr> <tr> <td>string $codefortest Code to check syntax</td> <td>2</td> </tr> <tr> <td>string $typefortest Type of barcode (ISBN, EAN, ...)</td> <td>2</td> </tr> <tr> <td>string $encoding Encoding norm</td> <td>2</td> </tr> <tr> <td>string $code Value to encode</td> <td>2</td> </tr> <tr> <td>integer $scale Scale</td> <td>2</td> </tr> <tr> <td>integer $nooutputiferror No output if error</td> <td>2</td> </tr> <tr> <td>string $code Value to encode</td> <td>2</td> </tr> <tr> <td>integer $scale Scale (not used with this engine)</td> <td>2</td> </tr> <tr> <td>integer $nooutputiferror No output if error (not used with this engine)</td> <td>2</td> </tr> <tr> <td>string $datatoimport String code describing import set (ex: 'societe_1')</td> <td>2</td> </tr> <tr> <td>array $headerlinefields Array of fields name</td> <td>2</td> </tr> <tr> <td>array $contentlinevalues Array of lines</td> <td>2</td> </tr> <tr> <td>array $arrayrecord Array of read values: [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=string), [fieldpos+1]...</td> <td>2</td> </tr> <tr> <td>array $array_match_file_to_database Array of target fields where to insert data: [fieldpos] => 's.fieldname', [fieldpos+1]...</td> <td>2</td> </tr> <tr> <td>Object $objimport Object import (contains objimport->array_import_tables, objimport->array_import_fields, objimport->array_import_convertvalue, ...)</td> <td>2</td> </tr> <tr> <td>int $maxfields Max number of fields to use</td> <td>2</td> </tr> <tr> <td>string $importid Import key</td> <td>2</td> </tr> <tr> <td>array $updatekeys Array of keys to use to try to do an update first before insert. This field are defined into the module descriptor.</td> <td>2</td> </tr> <tr> <td>Societe|string $objsoc Object third party</td> <td>2</td> </tr> <tr> <td>CommandeFournisseur $object Object</td> <td>2</td> </tr> <tr> <td>CommandeFournisseur $object Id of object to generate</td> <td>2</td> </tr> <tr> <td>CommandeFournisseur $object Object order</td> <td>2</td> </tr> <tr> <td>CommandeFournisseur $object Object to show</td> <td>2</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>2</td> </tr> <tr> <td>int $maxlen Max length of name</td> <td>2</td> </tr> <tr> <td>string $mode Depreciation mode (economic, accelerated_depreciation, ...)</td> <td>2</td> </tr> <tr> <td>string $status Filter by invoice status : draft | unpaid | paid | cancelled</td> <td>2</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"</td> <td>2</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>2</td> </tr> <tr> <td>array $request_data Datas</td> <td>2</td> </tr> <tr> <td>int $id Id of invoice</td> <td>2</td> </tr> <tr> <td>string $closepaidinvoices {@from body} Close paid invoices {@choice yes,no}</td> <td>2</td> </tr> <tr> <td>string $num_payment {@from body} Payment number (optional)</td> <td>2</td> </tr> <tr> <td>string $chqbank {@from body} Issuer bank name (optional)</td> <td>2</td> </tr> <tr> <td>int $id Id of supplier invoice</td> <td>2</td> </tr> <tr> <td>int $id Id of supplier invoice to update</td> <td>2</td> </tr> <tr> <td>int $lineid Id of the line to delete</td> <td>2</td> </tr> <tr> <td>int $only_product Return only physical products</td> <td>2</td> </tr> <tr> <td>int $idwarehouse Id of warehouse to use for stock decrease</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>2</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>2</td> </tr> <tr> <td>string $ref_supplier Supplier ref</td> <td>2</td> </tr> <tr> <td>int $id Id de la facture a charger</td> <td>2</td> </tr> <tr> <td>int $filtre_statut Filter on shipment status</td> <td>2</td> </tr> <tr> <td>int $fk_bank Id of bank line associated to payment</td> <td>2</td> </tr> <tr> <td>User $user User making the deletion</td> <td>2</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>2</td> </tr> <tr> <td>string $mode 'withlistofinvoices'=Include list of invoices into tooltip</td> <td>2</td> </tr> <tr> <td>string $morecss Add more CSS</td> <td>2</td> </tr> <tr> <td>int $force_thirdparty_id Force thirdparty id</td> <td>2</td> </tr> <tr> <td>int $idremise Id of absolute discount</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>2</td> </tr> <tr> <td>string $close_code Code indicates whether the class has paid in full while payment is incomplete. Not implemented yet.</td> <td>2</td> </tr> <tr> <td>string $close_note Comment informs if the class has been paid while payment is incomplete. Not implemented yet.</td> <td>2</td> </tr> <tr> <td>User $user Object user that validate</td> <td>2</td> </tr> <tr> <td>int $socid Thirdparty id</td> <td>2</td> </tr> <tr> <td>int $max Max length of shown ref</td> <td>2</td> </tr> <tr> <td>int $short 1=Return just URL</td> <td>2</td> </tr> <tr> <td>User $user User that clone</td> <td>2</td> </tr> <tr> <td>int $invertdetail Reverse sign of amounts for lines</td> <td>2</td> </tr> <tr> <td>int $nbdays Delay before due date (or after if delay is negative)</td> <td>2</td> </tr> <tr> <td>string $paymentmode '' or 'all' by default (no filter), or 'LIQ', 'CHQ', CB', ...</td> <td>2</td> </tr> <tr> <td>string $datetouse 'duedate' (default) or 'invoicedate'</td> <td>2</td> </tr> <tr> <td>string $forcerecipient Force email of recipient (for example to send the email to an accountant supervisor instead of the customer)</td> <td>2</td> </tr> <tr> <td>int $rowid Id of object to load</td> <td>2</td> </tr> <tr> <td>string $ref Reference of recurring invoice</td> <td>2</td> </tr> <tr> <td>string $ref_ext External reference of invoice</td> <td>2</td> </tr> <tr> <td>User $user User that delete.</td> <td>2</td> </tr> <tr> <td>string $ret Default value to output</td> <td>2</td> </tr> <tr> <td>int $restrictioninvoiceid 0=All qualified template invoices found. > 0 = restrict action on invoice ID</td> <td>2</td> </tr> <tr> <td>int $forcevalidation 1=Force validation of invoice whatever is template auto_validate flag.</td> <td>2</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>2</td> </tr> <tr> <td>integer $alreadypaid Not used on recurring invoices</td> <td>2</td> </tr> <tr> <td>int $recur Is it a recurring invoice ?</td> <td>2</td> </tr> <tr> <td>int $status Id status (suspended or not)</td> <td>2</td> </tr> <tr> <td>integer $alreadypaid Not used for recurring invoices</td> <td>2</td> </tr> <tr> <td>int $type Type invoice</td> <td>2</td> </tr> <tr> <td>int $validate 0 to create in draft, 1 to create and validate invoice</td> <td>2</td> </tr> <tr> <td>int $validate 0 no document, 1 to generate document</td> <td>2</td> </tr> <tr> <td>string $model model of document generator</td> <td>2</td> </tr> <tr> <td>int $rowid Id of invoice</td> <td>2</td> </tr> <tr> <td>int $is_client Is the thirdparty a client ?</td> <td>2</td> </tr> <tr> <td>int $is_supplier Is the thirdparty a supplier ?</td> <td>2</td> </tr> <tr> <td>string $supplier_reputation Reputation with this product to the defined supplier (empty, FAVORITE, DONOTORDER)</td> <td>2</td> </tr> <tr> <td>string $multicurrency_price_base_type HT or TTC in currency</td> <td>2</td> </tr> <tr> <td>int $type Type of product</td> <td>2</td> </tr> <tr> <td>string $thirdparty_ids Thirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}</td> <td>2</td> </tr> <tr> <td>int $id Order ID</td> <td>2</td> </tr> <tr> <td>string $ref Ref</td> <td>2</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>2</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>2</td> </tr> <tr> <td>User $user User</td> <td>2</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>2</td> </tr> <tr> <td>User $user User that validate</td> <td>2</td> </tr> <tr> <td>int $id Id of order to update</td> <td>2</td> </tr> <tr> <td>array $request_data OrderLine data</td> <td>2</td> </tr> <tr> <td>int $id Id of order to update</td> <td>2</td> </tr> <tr> <td>int $id Id of order to update</td> <td>2</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER).</td> <td>2</td> </tr> <tr> <td>User $user Object user that close</td> <td>2</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>2</td> </tr> <tr> <td>int $special_code Special code (also used by externals modules!)</td> <td>2</td> </tr> <tr> <td>string $label Label</td> <td>2</td> </tr> <tr> <td>int|null $fk_unit Code of the unit to use. Null to use the default one</td> <td>2</td> </tr> <tr> <td>int $loadalsotranslation Return translation for products</td> <td>2</td> </tr> <tr> <td>int $id Id of object (for a check)</td> <td>2</td> </tr> <tr> <td>int $delivery_date Delivery date</td> <td>2</td> </tr> <tr> <td>int $shortlist 0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name)</td> <td>2</td> </tr> <tr> <td>int $draft 0=not draft, 1=draft</td> <td>2</td> </tr> <tr> <td>User $excluser Object user to exclude</td> <td>2</td> </tr> <tr> <td>int $socid Id third party</td> <td>2</td> </tr> <tr> <td>int $limit For pagination</td> <td>2</td> </tr> <tr> <td>int $offset For pagination</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort criteria</td> <td>2</td> </tr> <tr> <td>User $user Object user making the change</td> <td>2</td> </tr> <tr> <td>integer $rang line rank</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>DoliDB $db handler d'acces base de donnee</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>int $socid Id third party for filter. This value must be forced during the new to external user company if user is an external user.</td> <td>2</td> </tr> <tr> <td>string $mode Option ('customer', 'supplier')</td> <td>2</td> </tr> <tr> <td>int $userid Id user for filter (creation user)</td> <td>2</td> </tr> <tr> <td>int $typentid Id typent of thirdpary for filter</td> <td>2</td> </tr> <tr> <td>int $categid Id category of thirdpary for filter</td> <td>2</td> </tr> <tr> <td>int $closepaidcontrib 1=Also close paid contributions to paid, 0=Do nothing more</td> <td>2</td> </tr> <tr> <td>string $mode 'payment_sc'</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto</td> <td>2</td> </tr> <tr> <td>User $user Object user that insert</td> <td>2</td> </tr> <tr> <td>int $id_bank Id bank account</td> <td>2</td> </tr> <tr> <td>User $user User that create</td> <td>2</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>2</td> </tr> <tr> <td>int $id Id object</td> <td>2</td> </tr> <tr> <td>array $request_data data</td> <td>2</td> </tr> <tr> <td>string $label Label {@from body}</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Disable triggers</td> <td>2</td> </tr> <tr> <td>User|null $user User deleting</td> <td>2</td> </tr> <tr> <td>User $user Object user making update</td> <td>2</td> </tr> <tr> <td>int $sign 1 or -1</td> <td>2</td> </tr> <tr> <td>string $option link option</td> <td>2</td> </tr> <tr> <td>int $contact_list 0:Return array contains all properties, 1:Return array contains just id, -1: Do not return contacts/adddesses</td> <td>2</td> </tr> <tr> <td>int $id Id of invoice</td> <td>2</td> </tr> <tr> <td>int $id Id of invoice to update</td> <td>2</td> </tr> <tr> <td>string $datepaye {@from body} Payment date {@type timestamp}</td> <td>2</td> </tr> <tr> <td>string $desc Description de la ligne</td> <td>2</td> </tr> <tr> <td>double $pu_ht Prix unitaire HT (> 0 even for credit note)</td> <td>2</td> </tr> <tr> <td>double $txtva Taux de tva force, sinon -1</td> <td>2</td> </tr> <tr> <td>double $txlocaltax1 Local tax 1 rate (deprecated)</td> <td>2</td> </tr> <tr> <td>double $txlocaltax2 Local tax 2 rate (deprecated)</td> <td>2</td> </tr> <tr> <td>int $fk_remise_except Id remise</td> <td>2</td> </tr> <tr> <td>double $pu_ttc Prix unitaire TTC (> 0 even for credit note)</td> <td>2</td> </tr> <tr> <td>int $date_start_fill 1=Flag to fill start date when generating invoice</td> <td>2</td> </tr> <tr> <td>int $date_end_fill 1=Flag to fill end date when generating invoice</td> <td>2</td> </tr> <tr> <td>int $fk_fournprice Supplier price id (to calculate margin) or ''</td> <td>2</td> </tr> <tr> <td>int $pa_ht Buying price of line (to calculate margin) or ''</td> <td>2</td> </tr> <tr> <td>int $rowid Id of line to update</td> <td>2</td> </tr> <tr> <td>Object $object Object source</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>User $user Object user that modify</td> <td>2</td> </tr> <tr> <td>string $close_code Code set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)</td> <td>2</td> </tr> <tr> <td>string $close_note Comment set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)</td> <td>2</td> </tr> <tr> <td>double $qty Quantity</td> <td>2</td> </tr> <tr> <td>string $origin Depend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be 'orderdet', 'propaldet'..., else 'order','propal,'....</td> <td>2</td> </tr> <tr> <td>int $origin_id Depend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be Id of origin object (aka line id), else object id</td> <td>2</td> </tr> <tr> <td>string $label Label of the line (deprecated, do not use)</td> <td>2</td> </tr> <tr> <td>int $situation_percent Situation advance percentage</td> <td>2</td> </tr> <tr> <td>string $ref_ext External reference of the line</td> <td>2</td> </tr> <tr> <td>int $noupdateafterinsertline No update after insert of line</td> <td>2</td> </tr> <tr> <td>User $user User that set discount</td> <td>2</td> </tr> <tr> <td>double $remise Discount</td> <td>2</td> </tr> <tr> <td>int $socid Id thirdparty</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object lang to use for translation</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>int $mode 0=Label, 1=Picto + label, 2=Picto, 3=Label + Picto</td> <td>2</td> </tr> <tr> <td>string $client_nom customer name</td> <td>2</td> </tr> <tr> <td>int $amount amount of invoice</td> <td>2</td> </tr> <tr> <td>string $code_banque code of bank withdrawal</td> <td>2</td> </tr> <tr> <td>string $code_guichet code of bank's office</td> <td>2</td> </tr> <tr> <td>string $number_key number key of account number</td> <td>2</td> </tr> <tr> <td>string $sourcetype 'salary' for salary, '' for invoices</td> <td>2</td> </tr> <tr> <td>string $mode 'direct-debit' or 'bank-transfer'</td> <td>2</td> </tr> <tr> <td>string $format FRST, RCUR or ALL</td> <td>2</td> </tr> <tr> <td>int|User $user notification user</td> <td>2</td> </tr> <tr> <td>string $action notification action</td> <td>2</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>int $socid Id third party</td> <td>2</td> </tr> <tr> <td>string $type Type of payment mode deposit ('CHQ', 'TRA', ...)</td> <td>2</td> </tr> <tr> <td>User $user Object user</td> <td>2</td> </tr> <tr> <td>User|null $user User making validation</td> <td>2</td> </tr> <tr> <td>int $option 0=No option</td> <td>2</td> </tr> <tr> <td>array $request_data Datas</td> <td>2</td> </tr> <tr> <td>string $filtermode filter mode (AND or OR)</td> <td>2</td> </tr> <tr> <td>int[]|int $categories Category ID or array of Categories IDs</td> <td>2</td> </tr> <tr> <td>bool $also_cancel_consumed_and_produced_lines true if the consumed and produced lines will be deleted (and stocks incremented/decremented back) (false by default)</td> <td>2</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>2</td> </tr> <tr> <td>int $id Id of expense report</td> <td>2</td> </tr> <tr> <td>user $fuser User making change</td> <td>2</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>2</td> </tr> <tr> <td>User $user User</td> <td>2</td> </tr> <tr> <td>int $type Type of line</td> <td>2</td> </tr> <tr> <td>string $seller Seller, but actually he is unknown</td> <td>2</td> </tr> <tr> <td>int $id ID of Expense Report</td> <td>2</td> </tr> <tr> <td>string $user_ids User ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}</td> <td>2</td> </tr> <tr> <td>array $request_data Expense Report data</td> <td>2</td> </tr> <tr> <td>string|resource $input</td> <td>2</td> </tr> <tr> <td>string $newName</td> <td>2</td> </tr> <tr> <td>string $url just the 'basename' of the url</td> <td>2</td> </tr> <tr> <td>mixed $addressbookId</td> <td>2</td> </tr> <tr> <td>array $requestedProperties</td> <td>2</td> </tr> <tr> <td>string|INode $node</td> <td>2</td> </tr> <tr> <td>string|DAV\INode $node</td> <td>2</td> </tr> <tr> <td>mixed $report</td> <td>2</td> </tr> <tr> <td>mixed $path</td> <td>2</td> </tr> <tr> <td>string $path on-disk path</td> <td>2</td> </tr> <tr> <td>array $acl ACL rules</td> <td>2</td> </tr> <tr> <td>string|null $owner principal owner string</td> <td>2</td> </tr> <tr> <td>string $targetName new local file/collection name</td> <td>2</td> </tr> <tr> <td>string $sourcePath Full path to source node</td> <td>2</td> </tr> <tr> <td>INode $sourceNode Source node itself</td> <td>2</td> </tr> <tr> <td>mixed $valueOrCallBack</td> <td>2</td> </tr> <tr> <td>string|string[] $properties</td> <td>2</td> </tr> <tr> <td>string $etag</td> <td>2</td> </tr> <tr> <td>string $uuid</td> <td>2</td> </tr> <tr> <td>string|null $filename</td> <td>2</td> </tr> <tr> <td>string|string[] $hrefs</td> <td>2</td> </tr> <tr> <td>string $title</td> <td>2</td> </tr> <tr> <td>string $element</td> <td>2</td> </tr> <tr> <td>string $fileName</td> <td>2</td> </tr> <tr> <td>int $rangeType</td> <td>2</td> </tr> <tr> <td>int $offset</td> <td>2</td> </tr> <tr> <td>string|resource $calendarData</td> <td>2</td> </tr> <tr> <td>DateTime $start</td> <td>2</td> </tr> <tr> <td>DateTime $end</td> <td>2</td> </tr> <tr> <td>string $href The sharee who is replying (often a mailto: address)</td> <td>2</td> </tr> <tr> <td>int $status One of the SharingPlugin::STATUS_* constants</td> <td>2</td> </tr> <tr> <td>string $calendarUri The url to the calendar thats being shared</td> <td>2</td> </tr> <tr> <td>string $inReplyTo The unique id this message is a response to</td> <td>2</td> </tr> <tr> <td>string $summary A description of the reply</td> <td>2</td> </tr> <tr> <td>string $principalUri</td> <td>2</td> </tr> <tr> <td>string $objectUri</td> <td>2</td> </tr> <tr> <td>string|resource $objectData</td> <td>2</td> </tr> <tr> <td>mixed $calendarId</td> <td>2</td> </tr> <tr> <td>DateTimeInterface $start</td> <td>2</td> </tr> <tr> <td>DateTimeInterface $end</td> <td>2</td> </tr> <tr> <td>Component $vObj</td> <td>2</td> </tr> <tr> <td>int $offset</td> <td>2</td> </tr> <tr> <td>Component $root The root document</td> <td>2</td> </tr> <tr> <td>array $parameters List of parameters</td> <td>2</td> </tr> <tr> <td>string $group The vcard property group</td> <td>2</td> </tr> <tr> <td>mixed $name</td> <td>2</td> </tr> <tr> <td>DateTimeZone $tz</td> <td>2</td> </tr> <tr> <td>int $targetVersion</td> <td>2</td> </tr> <tr> <td>Property\Uri $property the input property</td> <td>2</td> </tr> <tr> <td>string|array|DateTimeInterface $value</td> <td>2</td> </tr> <tr> <td>DateTimeZone $timeZone</td> <td>2</td> </tr> <tr> <td>bool isFloating If set to true, timezones will be ignored</td> <td>2</td> </tr> <tr> <td>int $options parser options, see the OPTIONS constants</td> <td>2</td> </tr> <tr> <td>string $componentName filter by component name</td> <td>2</td> </tr> <tr> <td>int $options any parser options (OPTION constants)</td> <td>2</td> </tr> <tr> <td>string $delimiter</td> <td>2</td> </tr> <tr> <td>bool $prepend Whether to prepend the directories</td> <td>2</td> </tr> <tr> <td>string $packageName</td> <td>2</td> </tr> <tr> <td>LoggerInterface $logger</td> <td>2</td> </tr> <tr> <td>mixed $level</td> <td>2</td> </tr> <tr> <td>$data (string) PDF data to parse.</td> <td>2</td> </tr> <tr> <td>$offset (int) xref offset (if know).</td> <td>2</td> </tr> <tr> <td>$xref (array) previous xref array (if any).</td> <td>2</td> </tr> <tr> <td>$obj_ref (string) Object number and generation number separated by underscore character.</td> <td>2</td> </tr> <tr> <td>$decoding (boolean) If true decode streams.</td> <td>2</td> </tr> <tr> <td>$obj (string) Object value.</td> <td>2</td> </tr> <tr> <td>$sdic (array) Stream's dictionary array.</td> <td>2</td> </tr> <tr> <td>$stream (string) Stream to decode.</td> <td>2</td> </tr> <tr> <td>float Scale factor from user space units to points</td> <td>2</td> </tr> <tr> <td>int $tplidx A valid template-Id</td> <td>2</td> </tr> <tr> <td>string $hash a geohash</td> <td>2</td> </tr> <tr> <td>Point $point</td> <td>2</td> </tr> <tr> <td>$type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.</td> <td>2</td> </tr> <tr> <td>$dpi (int) dot-per-inch resolution used on resize</td> <td>2</td> </tr> <tr> <td>$cfg (array) Array of configuration parameters:</td> <td>2</td> </tr> <tr> <td>$y (float) (float) The value of the ordinate in user units.</td> <td>2</td> </tr> <tr> <td>$type (string) type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>PDF417,a,e,t,s,f,o0,o1,o2,o3,o4,o5,o6 : PDF417 with parameters: a = aspect ratio (width/height); e = error correction level (0-8); t = total number of macro segments; s = macro segment index (0-99998); f = file ID; o0 = File Name (text); o1 = Segment Count (numeric); o2 = Time Stamp (numeric); o3 = Sender (text); o4 = Addressee (text); o5 = File Size (numeric); o6 = Checksum (numeric). NOTES: Parameters t, s and f are required for a Macro Control Block, all other parametrs are optional. To use a comma character ',' on text options, replace it with the character 255: "\xff".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul></td> <td>2</td> </tr> <tr> <td>$w (int) Width of a single rectangle element in user units.</td> <td>2</td> </tr> <tr> <td>$h (int) Height of a single rectangle element in user units.</td> <td>2</td> </tr> <tr> <td>$color (string) Foreground color for bar elements (background is transparent).</td> <td>2</td> </tr> <tr> <td>$page (string) Page content.</td> <td>2</td> </tr> <tr> <td>$w (int) Minimum width of a single bar in user units.</td> <td>2</td> </tr> <tr> <td>$h (int) Height of barcode in user units.</td> <td>2</td> </tr> <tr> <td>$checksum (boolean) if true add a checksum to the code</td> <td>2</td> </tr> <tr> <td>$n (int) object ID</td> <td>2</td> </tr> <tr> <td>$s (string) string to escape.</td> <td>2</td> </tr> <tr> <td>$s (string) string to output.</td> <td>2</td> </tr> <tr> <td>$font (array) Array describing the basic font parameters: (family, style, size).</td> <td>2</td> </tr> <tr> <td>$firstline (boolean) if true prints only the first line and return the remaining string.</td> <td>2</td> </tr> <tr> <td>$firstblock (boolean) if true the string is the starting of a line.</td> <td>2</td> </tr> <tr> <td>$n (int) object number</td> <td>2</td> </tr> <tr> <td>$mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.</td> <td>2</td> </tr> <tr> <td>$orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul></td> <td>2</td> </tr> <tr> <td>$unit (string) User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.</td> <td>2</td> </tr> <tr> <td>$s_x (float) scaling factor for width as percent. 0 is not allowed.</td> <td>2</td> </tr> <tr> <td>$s_y (float) scaling factor for height as percent. 0 is not allowed.</td> <td>2</td> </tr> <tr> <td>$t_y (int) movement to the bottom</td> <td>2</td> </tr> <tr> <td>$angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)</td> <td>2</td> </tr> <tr> <td>$angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)</td> <td>2</td> </tr> <tr> <td>$x0 (float) Abscissa of start point.</td> <td>2</td> </tr> <tr> <td>$y0 (float) Ordinate of start point.</td> <td>2</td> </tr> <tr> <td>$line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>2</td> </tr> <tr> <td>$rx (float) Horizontal radius.</td> <td>2</td> </tr> <tr> <td>$ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.</td> <td>2</td> </tr> <tr> <td>$angle: (float) Angle oriented (anti-clockwise). Default value: 0.</td> <td>2</td> </tr> <tr> <td>$nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.</td> <td>2</td> </tr> <tr> <td>$brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))</td> <td>2</td> </tr> <tr> <td>$p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))</td> <td>2</td> </tr> <tr> <td>$line_style (array) Line style of polygon. Array with keys among the following:</td> <td>2</td> </tr> <tr> <td>$line_style (array) Line style of polygon sides. Array with keys among the following:</td> <td>2</td> </tr> <tr> <td>$circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:</td> <td>2</td> </tr> <tr> <td>$circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>2</td> </tr> <tr> <td>$circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).</td> <td>2</td> </tr> <tr> <td>$layout (string) The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul></td> <td>2</td> </tr> <tr> <td>$mode (string) A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul></td> <td>2</td> </tr> <tr> <td>$round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111").</td> <td>2</td> </tr> <tr> <td>$border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).</td> <td>2</td> </tr> <tr> <td>$resetmargins (boolean) if true reset left, right, top margins and Y position.</td> <td>2</td> </tr> <tr> <td>$keepmargins (boolean) if true overwrites the default page margins with the current margins</td> <td>2</td> </tr> <tr> <td>$tc (array) RGB array color for text.</td> <td>2</td> </tr> <tr> <td>$lc (array) RGB array color for line.</td> <td>2</td> </tr> <tr> <td>$txt (string) Bookmark description.</td> <td>2</td> </tr> <tr> <td>$level (int) Bookmark level (minimum value is 0).</td> <td>2</td> </tr> <tr> <td>$y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).</td> <td>2</td> </tr> <tr> <td>$style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic.</td> <td>2</td> </tr> <tr> <td>$color (array) RGB color array (values from 0 to 255).</td> <td>2</td> </tr> <tr> <td>$x (float) X position in user units of the bookmark on the selected page (default = -1 = current position;).</td> <td>2</td> </tr> <tr> <td>$link (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).</td> <td>2</td> </tr> <tr> <td>$script (string) Javascript code</td> <td>2</td> </tr> <tr> <td>$values (array) array containing the list of values.</td> <td>2</td> </tr> <tr> <td>$name (string) spot color name (if any)</td> <td>2</td> </tr> <tr> <td>$name (string) Spot color name (if any).</td> <td>2</td> </tr> <tr> <td>$fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.</td> <td>2</td> </tr> <tr> <td>$fontsize (float) Font size in points. The default value is the current size.</td> <td>2</td> </tr> <tr> <td>$getarray (boolean) if true returns an array of characters widths, if false returns the total length.</td> <td>2</td> </tr> <tr> <td>$char (int) The char code whose length is to be returned</td> <td>2</td> </tr> <tr> <td>$fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.</td> <td>2</td> </tr> <tr> <td>$subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.</td> <td>2</td> </tr> <tr> <td>$out (boolean) if true output the font size command, otherwise only set the font properties.</td> <td>2</td> </tr> <tr> <td>$font (string) font name</td> <td>2</td> </tr> <tr> <td>$style (string) font style</td> <td>2</td> </tr> <tr> <td>$size (float) The size (in points)</td> <td>2</td> </tr> <tr> <td>$font (string) Font name (family name).</td> <td>2</td> </tr> <tr> <td>$style (string) Font style.</td> <td>2</td> </tr> <tr> <td>$link (mixed) URL or identifier returned by AddLink()</td> <td>2</td> </tr> <tr> <td>$spaces (int) number of spaces on the text to link</td> <td>2</td> </tr> <tr> <td>$ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.</td> <td>2</td> </tr> <tr> <td>$valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul></td> <td>2</td> </tr> <tr> <td>$txt (string) String to print. Default value: empty string.</td> <td>2</td> </tr> <tr> <td>$calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul></td> <td>2</td> </tr> <tr> <td>$x (float) abscissa of the registration mark center.</td> <td>2</td> </tr> <tr> <td>$y (float) ordinate of the registration mark center.</td> <td>2</td> </tr> <tr> <td>$r (float) radius of the crop mark.</td> <td>2</td> </tr> <tr> <td>$col1 (array) first color (Grayscale, RGB or CMYK components).</td> <td>2</td> </tr> <tr> <td>$col2 (array) second color (Grayscale, RGB or CMYK components).</td> <td>2</td> </tr> <tr> <td>$antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.</td> <td>2</td> </tr> <tr> <td>$h (float) Cell minimum height. The cell extends automatically if needed.</td> <td>2</td> </tr> <tr> <td>$reseth (boolean) if true reset the last cell height (default true).</td> <td>2</td> </tr> <tr> <td>$autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.</td> <td>2</td> </tr> <tr> <td>$txt (string) String for calculating his height</td> <td>2</td> </tr> <tr> <td>$autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).</td> <td>2</td> </tr> <tr> <td>$cellpadding (float) Internal cell padding, if empty uses default cell padding.</td> <td>2</td> </tr> <tr> <td>$xc (float) abscissa of the center.</td> <td>2</td> </tr> <tr> <td>$yc (float) ordinate of the center.</td> <td>2</td> </tr> <tr> <td>$a (float) start angle (in degrees).</td> <td>2</td> </tr> <tr> <td>$b (float) end angle (in degrees).</td> <td>2</td> </tr> <tr> <td>$fitonpage (boolean) if true the image is resized to not exceed page dimensions.</td> <td>2</td> </tr> <tr> <td>$style (array) array of options:<ul></td> <td>2</td> </tr> <tr> <td>$align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td> <td>2</td> </tr> <tr> <td>$html (string) htmlcode to fix</td> <td>2</td> </tr> <tr> <td>$default_css (string) CSS commands to add</td> <td>2</td> </tr> <tr> <td>$tagvs (array) parameters for setHtmlVSpace method</td> <td>2</td> </tr> <tr> <td>$tidy_options (array) options for tidy_parse_string function</td> <td>2</td> </tr> <tr> <td>$refsize (float) Reference font size in points.</td> <td>2</td> </tr> <tr> <td>$defaultunit (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).</td> <td>2</td> </tr> <tr> <td>$data (string) serialized data</td> <td>2</td> </tr> <tr> <td>$align (string) Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td> <td>2</td> </tr> <tr> <td>$dom (array) html dom array</td> <td>2</td> </tr> <tr> <td>$key (int) current element id</td> <td>2</td> </tr> <tr> <td>$data (string) data</td> <td>2</td> </tr> <tr> <td>$data (array) image data</td> <td>2</td> </tr> <tr> <td>$data (array) font data</td> <td>2</td> </tr> <tr> <td>$page (int) page number where this TOC should be inserted (leave empty for current page).</td> <td>2</td> </tr> <tr> <td>$toc_name (string) name to use for TOC bookmark.</td> <td>2</td> </tr> <tr> <td>$style (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.</td> <td>2</td> </tr> <tr> <td>$dictionary (array) Array of words to be returned without applying the hyphenation algorithm.</td> <td>2</td> </tr> <tr> <td>$leftmin (int) Minimum number of character to leave on the left of the word without applying the hyphens.</td> <td>2</td> </tr> <tr> <td>$rightmin (int) Minimum number of character to leave on the right of the word without applying the hyphens.</td> <td>2</td> </tr> <tr> <td>$charmin (int) Minimum word length to apply the hyphenation algorithm.</td> <td>2</td> </tr> <tr> <td>$charmax (int) Maximum length of broken piece of word.</td> <td>2</td> </tr> <tr> <td>$tm (array) original SVG transformation matrix</td> <td>2</td> </tr> <tr> <td>$style (string) Style of rendering. Possible values are:</td> <td>2</td> </tr> <tr> <td>$name (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.</td> <td>2</td> </tr> <tr> <td>$spotc (array) Reference to an array of spot colors.</td> <td>2</td> </tr> <tr> <td>$key (string) encryption key</td> <td>2</td> </tr> <tr> <td>$text (String) input text to be encrypted</td> <td>2</td> </tr> <tr> <td>$num (int) page number</td> <td>2</td> </tr> <tr> <td>$dom (array) array of HTML tags and properties</td> <td>2</td> </tr> <tr> <td>$key (int) key of the current HTML tag</td> <td>2</td> </tr> <tr> <td>$css (array) array of CSS properties</td> <td>2</td> </tr> <tr> <td>$length (int)</td> <td>2</td> </tr> <tr> <td>$pagedim (array) Array of page dimensions.</td> <td>2</td> </tr> <tr> <td>$setbom (boolean) if true set the Byte Order Mark (BOM = 0xFEFF)</td> <td>2</td> </tr> <tr> <td>$start (int) the starting element of $strarr.</td> <td>2</td> </tr> <tr> <td>$end (int) first element that will not be returned.</td> <td>2</td> </tr> <tr> <td>$uch (string) character string to process.</td> <td>2</td> </tr> <tr> <td>$setbom (bool) if true set the Byte Order Mark (BOM = 0xFEFF)</td> <td>2</td> </tr> <tr> <td>$forcertl (bool) if true forces RTL text direction</td> <td>2</td> </tr> <tr> <td>$image (image) Image object.</td> <td>2</td> </tr> <tr> <td>$tempfile (string) Temporary file name.</td> <td>2</td> </tr> <tr> <td>$file (string) image file to parse</td> <td>2</td> </tr> <tr> <td>$at (array) x,y position</td> <td>2</td> </tr> <tr> <td>$width (int) width</td> <td>2</td> </tr> <tr> <td>$maskNo (int)</td> <td>2</td> </tr> <tr> <td>$level (int)</td> <td>2</td> </tr> <tr> <td>$str (string) string</td> <td>2</td> </tr> <tr> <td>$pos (int) characted position</td> <td>2</td> </tr> <tr> <td>$mode (int)</td> <td>2</td> </tr> <tr> <td>$bstream (array)</td> <td>2</td> </tr> <tr> <td>$mode (int) encoding mode.</td> <td>2</td> </tr> <tr> <td>$size (int) size of data (byte).</td> <td>2</td> </tr> <tr> <td>$items (int)</td> <td>2</td> </tr> <tr> <td>$bits (int) number of bits</td> <td>2</td> </tr> <tr> <td>$num (int) number</td> <td>2</td> </tr> <tr> <td>$size (int) size</td> <td>2</td> </tr> <tr> <td>$data (array) bytes</td> <td>2</td> </tr> <tr> <td>$mode (int) encoding mode</td> <td>2</td> </tr> <tr> <td>$ox (int) X center coordinate of the pattern</td> <td>2</td> </tr> <tr> <td>$oy (int) Y center coordinate of the pattern</td> <td>2</td> </tr> <tr> <td>$symsize (int) symbol size, bits</td> <td>2</td> </tr> <tr> <td>$gfpoly (int) Field generator polynomial coefficients</td> <td>2</td> </tr> <tr> <td>$fcr (int) first root of RS code generator polynomial, index form</td> <td>2</td> </tr> <tr> <td>$prim (int) primitive element to generate polynomial roots</td> <td>2</td> </tr> <tr> <td>$nroots (int) RS code generator polynomial degree (number of roots)</td> <td>2</td> </tr> <tr> <td>$pad (int) padding bytes at front of shortened block</td> <td>2</td> </tr> <tr> <td>$rs (array) RS values</td> <td>2</td> </tr> <tr> <td>$cwpad (int) Pad codeword.</td> <td>2</td> </tr> <tr> <td>$cwpos (int) Number of data codewords from the beginning of encoded data.</td> <td>2</td> </tr> <tr> <td>$data (string) data to encode</td> <td>2</td> </tr> <tr> <td>$row (int) Row number.</td> <td>2</td> </tr> <tr> <td>$col (int) Column number.</td> <td>2</td> </tr> <tr> <td>string $serviceName The fully qualified service name</td> <td>2</td> </tr> <tr> <td>array $scopes</td> <td>2</td> </tr> <tr> <td>ClientInterface $httpClient</td> <td>2</td> </tr> <tr> <td>array $extraHeaders Extra headers if applicable. These will override service-specific</td> <td>2</td> </tr> <tr> <td>string $namespace The prefixed namespace this instance will load</td> <td>2</td> </tr> <tr> <td>string $path The filesystem path to the root of the namespace</td> <td>2</td> </tr> <tr> <td>string $class The class name to load</td> <td>2</td> </tr> <tr> <td>array $extraParams</td> <td>2</td> </tr> <tr> <td>int $endOfLife</td> <td>2</td> </tr> <tr> <td>int $lifetime</td> <td>2</td> </tr> <tr> <td>string $stateVariableName</td> <td>2</td> </tr> <tr> <td>string $var</td> <td>2</td> </tr> <tr> <td>string $absoluteUri</td> <td>2</td> </tr> <tr> <td>string $port</td> <td>2</td> </tr> <tr> <td>array $parameters</td> <td>2</td> </tr> <tr> <td>string $accessTokenSecret</td> <td>2</td> </tr> <tr> <td>string $requestTokenSecret</td> <td>2</td> </tr> <tr> <td>string $requestToken</td> <td>2</td> </tr> <tr> <td>string $algorithm</td> <td>2</td> </tr> <tr> <td>UriInterface $uri</td> <td>2</td> </tr> <tr> <td>array $params</td> <td>2</td> </tr> <tr> <td>CacheInterface $cache</td> <td>2</td> </tr> <tr> <td>string $pRange</td> <td>2</td> </tr> <tr> <td>null|Worksheet $pSheet Scope. Use null for global scope</td> <td>2</td> </tr> <tr> <td>string $what</td> <td>2</td> </tr> <tr> <td>string $pName Sheet name</td> <td>2</td> </tr> <tr> <td>null|int $iSheetIndex Index where sheet should go (0,1,..., or null for last)</td> <td>2</td> </tr> <tr> <td>int $pIndex Active sheet index</td> <td>2</td> </tr> <tr> <td>string $namedRange</td> <td>2</td> </tr> <tr> <td>Style $style</td> <td>2</td> </tr> <tr> <td>Style $pStyle</td> <td>2</td> </tr> <tr> <td>string $pHashCode</td> <td>2</td> </tr> <tr> <td>array[] $phpSpreadsheetFunctions</td> <td>2</td> </tr> <tr> <td>string $a First column to test (e.g. 'AA')</td> <td>2</td> </tr> <tr> <td>string $b Second column to test (e.g. 'Z')</td> <td>2</td> </tr> <tr> <td>string $a First cell to test (e.g. 'AA1')</td> <td>2</td> </tr> <tr> <td>string $b Second cell to test (e.g. 'Z1')</td> <td>2</td> </tr> <tr> <td>int $pNumRows Number of rows to insert</td> <td>2</td> </tr> <tr> <td>array $namespaces</td> <td>2</td> </tr> <tr> <td>string $column Column address (as a string value like "A", or "IV")</td> <td>2</td> </tr> <tr> <td>int $row Row number</td> <td>2</td> </tr> <tr> <td>string $worksheetName Optional worksheet name</td> <td>2</td> </tr> <tr> <td>string $additionalData Additional binary data going with the formula</td> <td>2</td> </tr> <tr> <td>array $tokens</td> <td>2</td> </tr> <tr> <td>string $cellAddressStructure</td> <td>2</td> </tr> <tr> <td>string $pValue Input encoding, eg: 'ANSI'</td> <td>2</td> </tr> <tr> <td>int $row</td> <td>2</td> </tr> <tr> <td>string $column</td> <td>2</td> </tr> <tr> <td>string $content</td> <td>2</td> </tr> <tr> <td>mixed $object</td> <td>2</td> </tr> <tr> <td>int $color Indexed color</td> <td>2</td> </tr> <tr> <td>int $color</td> <td>2</td> </tr> <tr> <td>bool $readDataOnly</td> <td>2</td> </tr> <tr> <td>Cell $cell Cell to update</td> <td>2</td> </tr> <tr> <td>string $location</td> <td>2</td> </tr> <tr> <td>string $pRange Cell range (i.e. A1:E10)</td> <td>2</td> </tr> <tr> <td>mixed[] $dataSet</td> <td>2</td> </tr> <tr> <td>Worksheet $subject The worksheet to iterate over</td> <td>2</td> </tr> <tr> <td>int $row The row number to set the current pointer at</td> <td>2</td> </tr> <tr> <td>Worksheet $worksheet The worksheet to iterate over</td> <td>2</td> </tr> <tr> <td>string $column The column address to set the current pointer at</td> <td>2</td> </tr> <tr> <td>Worksheet $parent</td> <td>2</td> </tr> <tr> <td>Worksheet $pValue</td> <td>2</td> </tr> <tr> <td>null|Hyperlink $pHyperlink</td> <td>2</td> </tr> <tr> <td>Spreadsheet $parent</td> <td>2</td> </tr> <tr> <td>string $pValue The string to check</td> <td>2</td> </tr> <tr> <td>bool $validate False to skip validation of new title. WARNING: This should only be set</td> <td>2</td> </tr> <tr> <td>string $column Return the highest data row for the specified column,</td> <td>2</td> </tr> <tr> <td>mixed $pValue Value of the cell</td> <td>2</td> </tr> <tr> <td>mixed $value Value of the cell</td> <td>2</td> </tr> <tr> <td>string $pDataType Explicit data type, see DataType::TYPE_*</td> <td>2</td> </tr> <tr> <td>bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't</td> <td>2</td> </tr> <tr> <td>bool $create</td> <td>2</td> </tr> <tr> <td>string $pRange Cell range (e.g. A1:E1)</td> <td>2</td> </tr> <tr> <td>string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1)</td> <td>2</td> </tr> <tr> <td>bool $pUpdate Update fitToPage so it applies rather than scaling</td> <td>2</td> </tr> <tr> <td>array $pValue Containing start column and end column, empty array if option unset</td> <td>2</td> </tr> <tr> <td>string $method Determines the method used when setting multiple print areas</td> <td>2</td> </tr> <tr> <td>string $pColumn Column (e.g. A)</td> <td>2</td> </tr> <tr> <td>string[] $attributes</td> <td>2</td> </tr> <tr> <td>string $pName Attribute Name</td> <td>2</td> </tr> <tr> <td>int $pIndex Rule index in the ruleset array</td> <td>2</td> </tr> <tr> <td>Column $pParent</td> <td>2</td> </tr> <tr> <td>string|string[] $pValue</td> <td>2</td> </tr> <tr> <td>string $pOperator see self::AUTOFILTER_COLUMN_RULE_*</td> <td>2</td> </tr> <tr> <td>string $pGrouping</td> <td>2</td> </tr> <tr> <td>bool $smoothLine</td> <td>2</td> </tr> <tr> <td>null|string $plotStyle</td> <td>2</td> </tr> <tr> <td>float $line_width</td> <td>2</td> </tr> <tr> <td>string $compound_type</td> <td>2</td> </tr> <tr> <td>string $dash_type</td> <td>2</td> </tr> <tr> <td>string $cap_type</td> <td>2</td> </tr> <tr> <td>string $join_type</td> <td>2</td> </tr> <tr> <td>string $head_arrow_type</td> <td>2</td> </tr> <tr> <td>string $head_arrow_size</td> <td>2</td> </tr> <tr> <td>string $end_arrow_type</td> <td>2</td> </tr> <tr> <td>string $end_arrow_size</td> <td>2</td> </tr> <tr> <td>array|string $elements</td> <td>2</td> </tr> <tr> <td>string $color_value</td> <td>2</td> </tr> <tr> <td>int $color_alpha</td> <td>2</td> </tr> <tr> <td>string $color_type</td> <td>2</td> </tr> <tr> <td>int $sh_presets</td> <td>2</td> </tr> <tr> <td>string $sh_color_value</td> <td>2</td> </tr> <tr> <td>string $sh_color_type</td> <td>2</td> </tr> <tr> <td>int $sh_angle</td> <td>2</td> </tr> <tr> <td>float $sh_distance</td> <td>2</td> </tr> <tr> <td>int $shadow_presets</td> <td>2</td> </tr> <tr> <td>array $properties_map</td> <td>2</td> </tr> <tr> <td>mixed &$reference</td> <td>2</td> </tr> <tr> <td>float $blur</td> <td>2</td> </tr> <tr> <td>int $angle</td> <td>2</td> </tr> <tr> <td>float $distance</td> <td>2</td> </tr> <tr> <td>string|string[] $elements</td> <td>2</td> </tr> <tr> <td>bool $overlay</td> <td>2</td> </tr> <tr> <td>null|GridLines $majorGridlines</td> <td>2</td> </tr> <tr> <td>null|GridLines $minorGridlines</td> <td>2</td> </tr> <tr> <td>Title $title</td> <td>2</td> </tr> <tr> <td>Legend $legend</td> <td>2</td> </tr> <tr> <td>Title $label</td> <td>2</td> </tr> <tr> <td>DataSeries[] $plotSeries</td> <td>2</td> </tr> <tr> <td>string $dataSource</td> <td>2</td> </tr> <tr> <td>string $formatCode</td> <td>2</td> </tr> <tr> <td>string $arrow</td> <td>2</td> </tr> <tr> <td>string $pValue see self::PROTECTION_*</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook</td> <td>2</td> </tr> <tr> <td>int $rotation</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font $font The workbooks default font</td> <td>2</td> </tr> <tr> <td>Worksheet $sheet The sheet</td> <td>2</td> </tr> <tr> <td>float|int $excelTimestamp MS Excel serialized date/time value</td> <td>2</td> </tr> <tr> <td>null|DateTimeZone|string $timeZone The timezone to assume for the Excel timestamp,</td> <td>2</td> </tr> <tr> <td>int $hours</td> <td>2</td> </tr> <tr> <td>int $minutes</td> <td>2</td> </tr> <tr> <td>Cell $pCell</td> <td>2</td> </tr> <tr> <td>string $timezone Time zone (e.g. 'Europe/London')</td> <td>2</td> </tr> <tr> <td>int $order Order of Polynomial for this regression</td> <td>2</td> </tr> <tr> <td>int $i Row position</td> <td>2</td> </tr> <tr> <td>int $j Column position</td> <td>2</td> </tr> <tr> <td>int $i0 Initial row index</td> <td>2</td> </tr> <tr> <td>int $iF Final row index</td> <td>2</td> </tr> <tr> <td>int $j0 Initial column index</td> <td>2</td> </tr> <tr> <td>int $jF Final column index</td> <td>2</td> </tr> <tr> <td>int $m Row dimension</td> <td>2</td> </tr> <tr> <td>int $n Column dimension</td> <td>2</td> </tr> <tr> <td>int $time_1st A timestamp</td> <td>2</td> </tr> <tr> <td>int $time_2nd A timestamp</td> <td>2</td> </tr> <tr> <td>array &$raList Reference to array of PPS's</td> <td>2</td> </tr> <tr> <td>string $value eg: 'A1'</td> <td>2</td> </tr> <tr> <td>int|string $time</td> <td>2</td> </tr> <tr> <td>Cell $cell Cell to check the value</td> <td>2</td> </tr> <tr> <td>mixed $pValue</td> <td>2</td> </tr> <tr> <td>array $array Array to be flattened</td> <td>2</td> </tr> <tr> <td>mixed $cellReference The cell to check</td> <td>2</td> </tr> <tr> <td>int $adjustmentMonths The number of months before or after start_date.</td> <td>2</td> </tr> <tr> <td>float $par The security's par value.</td> <td>2</td> </tr> <tr> <td>int $frequency the number of coupon payments per year.</td> <td>2</td> </tr> <tr> <td>float $cost The cost of the asset</td> <td>2</td> </tr> <tr> <td>mixed $purchased Date of the purchase of the asset</td> <td>2</td> </tr> <tr> <td>mixed $firstPeriod Date of the end of the first period</td> <td>2</td> </tr> <tr> <td>mixed $salvage The salvage value at the end of the life of the asset</td> <td>2</td> </tr> <tr> <td>float $period The period</td> <td>2</td> </tr> <tr> <td>float $rate Rate of depreciation</td> <td>2</td> </tr> <tr> <td>float $rate The Interest rate</td> <td>2</td> </tr> <tr> <td>int $nper The total number of payment periods</td> <td>2</td> </tr> <tr> <td>int $start The first period in the calculation.</td> <td>2</td> </tr> <tr> <td>int $end the last period in the calculation</td> <td>2</td> </tr> <tr> <td>float $cost Initial cost of the asset</td> <td>2</td> </tr> <tr> <td>float $salvage Value at the end of the depreciation.</td> <td>2</td> </tr> <tr> <td>int $life Number of periods over which the asset is depreciated.</td> <td>2</td> </tr> <tr> <td>int $period The period for which you want to calculate the</td> <td>2</td> </tr> <tr> <td>int $fraction Fraction</td> <td>2</td> </tr> <tr> <td>int $npery Number of compounding payments per year</td> <td>2</td> </tr> <tr> <td>int $per Period for which we want to find the interest</td> <td>2</td> </tr> <tr> <td>int $discount The security's discount rate</td> <td>2</td> </tr> <tr> <td>int $rate The security's interest rate at date of issue</td> <td>2</td> </tr> <tr> <td>mixed $cost Initial cost of the asset</td> <td>2</td> </tr> <tr> <td>mixed $salvage Value at the end of the depreciation</td> <td>2</td> </tr> <tr> <td>mixed $life Number of periods over which the asset is depreciated</td> <td>2</td> </tr> <tr> <td>int $discount The Treasury bill's discount rate</td> <td>2</td> </tr> <tr> <td>string $fromSeparator</td> <td>2</td> </tr> <tr> <td>string $toSeparator</td> <td>2</td> </tr> <tr> <td>string $formula Formula to parse</td> <td>2</td> </tr> <tr> <td>string $cellReference</td> <td>2</td> </tr> <tr> <td>mixed &$matrix1 First matrix operand</td> <td>2</td> </tr> <tr> <td>mixed &$matrix2 Second matrix operand</td> <td>2</td> </tr> <tr> <td>int $matrix1Rows Row size of first matrix operand</td> <td>2</td> </tr> <tr> <td>int $matrix1Columns Column size of first matrix operand</td> <td>2</td> </tr> <tr> <td>int $matrix2Rows Row size of second matrix operand</td> <td>2</td> </tr> <tr> <td>int $matrix2Columns Column size of second matrix operand</td> <td>2</td> </tr> <tr> <td>mixed $value First matrix operand</td> <td>2</td> </tr> <tr> <td>null|string $cellID</td> <td>2</td> </tr> <tr> <td>mixed $operand1</td> <td>2</td> </tr> <tr> <td>mixed $operand2</td> <td>2</td> </tr> <tr> <td>string &$pRange String based range representation</td> <td>2</td> </tr> <tr> <td>bool $resetLog Flag indicating whether calculation log should be reset or not</td> <td>2</td> </tr> <tr> <td>mixed $stringValue Value to check</td> <td>2</td> </tr> <tr> <td>string $needle The string to look for</td> <td>2</td> </tr> <tr> <td>string $haystack The string in which to look</td> <td>2</td> </tr> <tr> <td>int $offset Offset within $haystack</td> <td>2</td> </tr> <tr> <td>int $start Start character</td> <td>2</td> </tr> <tr> <td>mixed $p require p>0</td> <td>2</td> </tr> <tr> <td>mixed $q require q>0</td> <td>2</td> </tr> <tr> <td>mixed $arg</td> <td>2</td> </tr> <tr> <td>float $value Value at which you want to evaluate the distribution</td> <td>2</td> </tr> <tr> <td>float $probability Probability at which you want to evaluate the distribution</td> <td>2</td> </tr> <tr> <td>float $probability Probability of success on each trial</td> <td>2</td> </tr> <tr> <td>float $value Value for the function</td> <td>2</td> </tr> <tr> <td>float $probability Probability for the function</td> <td>2</td> </tr> <tr> <td>mixed[] $newValues Values of X for which we want to find Y</td> <td>2</td> </tr> <tr> <td>array ...$args Data Series</td> <td>2</td> </tr> <tr> <td>null|mixed[] $xValues Data Series X</td> <td>2</td> </tr> <tr> <td>bool $stats a logical value specifying whether to return additional regression statistics</td> <td>2</td> </tr> <tr> <td>float $probability</td> <td>2</td> </tr> <tr> <td>float $mean</td> <td>2</td> </tr> <tr> <td>float $stdDev</td> <td>2</td> </tr> <tr> <td>mixed $args Data range and criterias</td> <td>2</td> </tr> <tr> <td>float[] $valueSet An array of, or a reference to, a list of numbers</td> <td>2</td> </tr> <tr> <td>int $value the number whose rank you want to find</td> <td>2</td> </tr> <tr> <td>int $numObjs Number of different objects</td> <td>2</td> </tr> <tr> <td>int $places The number of characters to use. If places is omitted,</td> <td>2</td> </tr> <tr> <td>string $x The octal number you want to convert. Number may not contain</td> <td>2</td> </tr> <tr> <td>int $shiftAmount</td> <td>2</td> </tr> <tr> <td>string $group The group whose units of measure you want to retrieve</td> <td>2</td> </tr> <tr> <td>float $factVal Factorial Value</td> <td>2</td> </tr> <tr> <td>array $matrixValues A matrix of values</td> <td>2</td> </tr> <tr> <td>int $digits Number of digits to which you want to round $number</td> <td>2</td> </tr> <tr> <td>string $condition the criteria that defines which cells will be summed</td> <td>2</td> </tr> <tr> <td>mixed $lookup_array The range of cells being searched</td> <td>2</td> </tr> <tr> <td>mixed $not_exact_match determines if you are looking for an exact match based on lookup_value</td> <td>2</td> </tr> <tr> <td>string $coordinates Cell coordinates</td> <td>2</td> </tr> <tr> <td>Spreadsheet $spreadsheet Spreadsheet object</td> <td>2</td> </tr> <tr> <td>string $pPartName Writer part name</td> <td>2</td> </tr> <tr> <td>int $str_total Total number of strings</td> <td>2</td> </tr> <tr> <td>int $str_unique Total number of unique strings</td> <td>2</td> </tr> <tr> <td>Parser $parser The formula parser created for the Workbook</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher $pValue</td> <td>2</td> </tr> <tr> <td>string $cell An Excel cell reference</td> <td>2</td> </tr> <tr> <td>string $str The string</td> <td>2</td> </tr> <tr> <td>mixed $xfIndex The XF format index</td> <td>2</td> </tr> <tr> <td>bool $recalcRequired Indicate whether formulas should be recalculated before writing</td> <td>2</td> </tr> <tr> <td>Comment $pComment Comment</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Chart\Chart $pChart</td> <td>2</td> </tr> <tr> <td>int $pRelationId</td> <td>2</td> </tr> <tr> <td>null|int $hlinkClickId</td> <td>2</td> </tr> <tr> <td>PlotArea $plotArea</td> <td>2</td> </tr> <tr> <td>Title $xAxisLabel</td> <td>2</td> </tr> <tr> <td>Title $yAxisLabel</td> <td>2</td> </tr> <tr> <td>Axis $xAxis</td> <td>2</td> </tr> <tr> <td>Axis $yAxis</td> <td>2</td> </tr> <tr> <td>string $id1</td> <td>2</td> </tr> <tr> <td>string $id2</td> <td>2</td> </tr> <tr> <td>bool $isMultiLevelSeries</td> <td>2</td> </tr> <tr> <td>string $groupType Type of plot for dataseries</td> <td>2</td> </tr> <tr> <td>DataSeriesValues $plotSeriesValues</td> <td>2</td> </tr> <tr> <td>string[] $pStringTable</td> <td>2</td> </tr> <tr> <td>string $prefix Optional Namespace prefix</td> <td>2</td> </tr> <tr> <td>string $pPartname Part name</td> <td>2</td> </tr> <tr> <td>string $pContentType Content type</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Style $pStyle Style</td> <td>2</td> </tr> <tr> <td>$text string Text</td> <td>2</td> </tr> <tr> <td>float $callStartTime</td> <td>2</td> </tr> <tr> <td>int $period</td> <td>2</td> </tr> <tr> <td>int $periods</td> <td>2</td> </tr> <tr> <td>float $initial_guess</td> <td>2</td> </tr> <tr> <td>string $addressLiteral</td> <td>2</td> </tr> <tr> <td>scalar $prevToken</td> <td>2</td> </tr> <tr> <td>scalar $postToken</td> <td>2</td> </tr> <tr> <td>integer $token</td> <td>2</td> </tr> <tr> <td>mixed $callable A valid PHP callable that will be called when autoloading the first Swift class</td> <td>2</td> </tr> <tr> <td>int[] $bytes</td> <td>2</td> </tr> <tr> <td>int $size</td> <td>2</td> </tr> <tr> <td>Swift_OutputByteStream $os output stream to read from</td> <td>2</td> </tr> <tr> <td>int $firstLineOffset if first line needs to be shorter</td> <td>2</td> </tr> <tr> <td>string $lookup</td> <td>2</td> </tr> <tr> <td>Swift_Transport[] $transports</td> <td>2</td> </tr> <tr> <td>int $port</td> <td>2</td> </tr> <tr> <td>Swift_InputByteStream $is</td> <td>2</td> </tr> <tr> <td>mixed $buffer</td> <td>2</td> </tr> <tr> <td>string $contentType</td> <td>2</td> </tr> <tr> <td>bool $pipeline Do not wait for response</td> <td>2</td> </tr> <tr> <td>string $address the address, if command is RCPT TO</td> <td>2</td> </tr> <tr> <td>string $localDomain</td> <td>2</td> </tr> <tr> <td>string $param</td> <td>2</td> </tr> <tr> <td>string[] $replacements</td> <td>2</td> </tr> <tr> <td>int $sequence of last write to scan from</td> <td>2</td> </tr> <tr> <td>Swift_Transport_SmtpAgent $agent to read/write</td> <td>2</td> </tr> <tr> <td>Swift_Transport_Esmtp_Authenticator[] $authenticators</td> <td>2</td> </tr> <tr> <td>string $timestamp</td> <td>2</td> </tr> <tr> <td>string $client Random bytes</td> <td>2</td> </tr> <tr> <td>mixed $replacements Array or Swift_Plugins_Decorator_Replacements</td> <td>2</td> </tr> <tr> <td>mixed $recipient</td> <td>2</td> </tr> <tr> <td>int $result from {@link RESULT_PASS, RESULT_FAIL}</td> <td>2</td> </tr> <tr> <td>string $string to encode</td> <td>2</td> </tr> <tr> <td>int $maxLineLength optional, 0 indicates the default of 76 bytes</td> <td>2</td> </tr> <tr> <td>string $idRight</td> <td>2</td> </tr> <tr> <td>string|array $ids</td> <td>2</td> </tr> <tr> <td>mixed $body</td> <td>2</td> </tr> <tr> <td>string $boundary</td> <td>2</td> </tr> <tr> <td>Swift_OutputByteStream $os to read from</td> <td>2</td> </tr> <tr> <td>Swift_InputByteStream $is to write to</td> <td>2</td> </tr> <tr> <td>string $string string to encode</td> <td>2</td> </tr> <tr> <td>int $maxLineLength ignored</td> <td>2</td> </tr> <tr> <td>int $maxLineLength ignored</td> <td>2</td> </tr> <tr> <td>string $name of Header</td> <td>2</td> </tr> <tr> <td>string $string The string to tokenize</td> <td>2</td> </tr> <tr> <td>string $command That will be executed</td> <td>2</td> </tr> <tr> <td>array $successCodes That are needed</td> <td>2</td> </tr> <tr> <td>bool $valid If the response is valid</td> <td>2</td> </tr> <tr> <td>string $target method</td> <td>2</td> </tr> <tr> <td>array $buffer</td> <td>2</td> </tr> <tr> <td>int $time</td> <td>2</td> </tr> <tr> <td>string $privateKey</td> <td>2</td> </tr> <tr> <td>string $domainName</td> <td>2</td> </tr> <tr> <td>string $selector</td> <td>2</td> </tr> <tr> <td>string $hash</td> <td>2</td> </tr> <tr> <td>string $identity</td> <td>2</td> </tr> <tr> <td>string $canon</td> <td>2</td> </tr> <tr> <td>int $time A timestamp</td> <td>2</td> </tr> <tr> <td>string $key name of the variable within the template</td> <td>2</td> </tr> <tr> <td>string $value path to the picture</td> <td>2</td> </tr> <tr> <td>bool $encode If true, special XML characters are encoded</td> <td>2</td> </tr> <tr> <td>string $charset Charset</td> <td>2</td> </tr> <tr> <td>string $text The text to check</td> <td>2</td> </tr> <tr> <td>mixed $result can be a primitive or array or object</td> <td>2</td> </tr> <tr> <td>RestException $exception exception that has reasons for failure</td> <td>2</td> </tr> <tr> <td>string ,... $formatName class name of the format class that</td> <td>2</td> </tr> <tr> <td>string $id user id as identified by the authentication classes</td> <td>2</td> </tr> <tr> <td>$id</td> <td>2</td> </tr> <tr> <td>string $name</td> <td>2</td> </tr> <tr> <td>bool $ignoreErrors</td> <td>2</td> </tr> <tr> <td>bool $isAuthenticated passes true when the authentication is</td> <td>2</td> </tr> <tr> <td>$responseData</td> <td>2</td> </tr> <tr> <td>$data</td> <td>2</td> </tr> <tr> <td>string $fromPath</td> <td>2</td> </tr> <tr> <td>string $usingPath</td> <td>2</td> </tr> <tr> <td>string $char</td> <td>2</td> </tr> <tr> <td>bool $ignoreErrors</td> <td>2</td> </tr> <tr> <td>$comment</td> <td>2</td> </tr> <tr> <td>array $value</td> <td>2</td> </tr> <tr> <td>string $action relative path from the web root. When set to null</td> <td>2</td> </tr> <tr> <td>string $stream A stream resource with data</td> <td>2</td> </tr> <tr> <td>array $data</td> <td>2</td> </tr> <tr> <td>string|null $filename The filename to load from</td> <td>2</td> </tr> <tr> <td>boolean $highDensityVertical</td> <td>2</td> </tr> <tr> <td>string $featureName</td> <td>2</td> </tr> <tr> <td>string $profileName</td> <td>2</td> </tr> <tr> <td>EscposImage $img The image to print</td> <td>2</td> </tr> <tr> <td>int $lines Number of lines to feed</td> <td>2</td> </tr> <tr> <td>boolean $on True to enable, false to disable.</td> <td>2</td> </tr> <tr> <td>string $str Text to print, as UTF-8</td> <td>2</td> </tr> <tr> <td>string $data Data to send.</td> <td>2</td> </tr> <tr> <td>int $test the input to test</td> <td>2</td> </tr> <tr> <td>string $dest</td> <td>2</td> </tr> <tr> <td>string $data Print data</td> <td>2</td> </tr> <tr> <td>string $len Length of data to read.</td> <td>2</td> </tr> <tr> <td>DateTimeZone|string|int|null $object original value to get CarbonTimeZone from it.</td> <td>2</td> </tr> <tr> <td>DateTimeZone|string|int|null $objectDump dump of the object for error messages.</td> <td>2</td> </tr> <tr> <td>bool $dst</td> <td>2</td> </tr> <tr> <td>DateTimeInterface|string|null $time</td> <td>2</td> </tr> <tr> <td>string $name</td> <td>2</td> </tr> <tr> <td>string|array $dump</td> <td>2</td> </tr> <tr> <td>int $value amount to add to the input unit</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|null $date</td> <td>2</td> </tr> <tr> <td>Carbon|\DateTimeInterface|string|null $referenceTime</td> <td>2</td> </tr> <tr> <td>array $formats</td> <td>2</td> </tr> <tr> <td>Carbon|\Carbon\CarbonPeriod|\Carbon\CarbonInterval|\DateInterval|\DatePeriod|DateTimeInterface|string|null $date</td> <td>2</td> </tr> <tr> <td>string $modifier</td> <td>2</td> </tr> <tr> <td>string $format Datetime format</td> <td>2</td> </tr> <tr> <td>string $time</td> <td>2</td> </tr> <tr> <td>DateTimeZone|string|false|null $tz optional timezone</td> <td>2</td> </tr> <tr> <td>string|null $locale locale to be used for LTS, LT, LL, LLL, etc. macro-formats (en by fault, unneeded if no such macro-format in use)</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface $translator optional custom translator to use for macro-formats</td> <td>2</td> </tr> <tr> <td>string $format Datetime ISO format</td> <td>2</td> </tr> <tr> <td>string $time</td> <td>2</td> </tr> <tr> <td>int|null $value new value for day of year if using as setter.</td> <td>2</td> </tr> <tr> <td>CarbonInterval $ci An interval to traverse by</td> <td>2</td> </tr> <tr> <td>int $weekEndsAt optional start allow you to specify the day of week to use to end the week</td> <td>2</td> </tr> <tr> <td>string $locale locale ex. en</td> <td>2</td> </tr> <tr> <td>callable $func</td> <td>2</td> </tr> <tr> <td>int $parts maximum number of parts to display (default value: 1: single unit)</td> <td>2</td> </tr> <tr> <td>int $priority marco with higher priority is tried first</td> <td>2</td> </tr> <tr> <td>string $key date property</td> <td>2</td> </tr> <tr> <td>string $separator string to place between hours and minutes (":" by default)</td> <td>2</td> </tr> <tr> <td>string $unit Carbon unit name</td> <td>2</td> </tr> <tr> <td>int $length Length of the output (2 by default)</td> <td>2</td> </tr> <tr> <td>string $padString String to use for padding ("0" by default)</td> <td>2</td> </tr> <tr> <td>int $padType Side(s) to pad (STR_PAD_LEFT by default)</td> <td>2</td> </tr> <tr> <td>string $unitPrecision "minute", "second", "millisecond" or "microsecond"</td> <td>2</td> </tr> <tr> <td>string $keySuffix "", "_short" or "_min"</td> <td>2</td> </tr> <tr> <td>string $keySuffix "" or "_short"</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface $translator an optional translator to use</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface $translator the translator to use</td> <td>2</td> </tr> <tr> <td>DateTimeInterface $date</td> <td>2</td> </tr> <tr> <td>string $tester day name, month name, hour, date, etc. as string</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day.</td> <td>2</td> </tr> <tr> <td>string $unit The unit to test.</td> <td>2</td> </tr> <tr> <td>string $format date formats to compare.</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|string|null $date instance to compare with or null to use current day.</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date.</td> <td>2</td> </tr> <tr> <td>bool $ofSameYear Check if it is the same month in the same year.</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|string|null $date The instance to compare with or null to use current day.</td> <td>2</td> </tr> <tr> <td>bool $ofSameYear Check if it is the same month in the same year.</td> <td>2</td> </tr> <tr> <td>string $unit singular unit string</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|null $date instance to compare with or null to use current day.</td> <td>2</td> </tr> <tr> <td>string $format</td> <td>2</td> </tr> <tr> <td>string|null $originalFormat provide context if a chunk has been passed alone</td> <td>2</td> </tr> <tr> <td>string ...$fallbackLocales</td> <td>2</td> </tr> <tr> <td>bool $isLower if true, returns lowercase variant if available in the current locale.</td> <td>2</td> </tr> <tr> <td>string $key</td> <td>2</td> </tr> <tr> <td>string|null $period</td> <td>2</td> </tr> <tr> <td>string $time date/time string in the given language (may also contain English).</td> <td>2</td> </tr> <tr> <td>string|null $locale if locale is null or not specified, current global locale will be</td> <td>2</td> </tr> <tr> <td>DateTimeZone|string|null $tz optional timezone for the new instance.</td> <td>2</td> </tr> <tr> <td>\DateTimeInterface|Carbon|CarbonImmutable|null $end period end date</td> <td>2</td> </tr> <tr> <td>int|\DateInterval|string|null $interval period default interval or number of the given $unit</td> <td>2</td> </tr> <tr> <td>string|null $unit if specified, $interval must be an integer</td> <td>2</td> </tr> <tr> <td>string $function</td> <td>2</td> </tr> <tr> <td>string|array $name</td> <td>2</td> </tr> <tr> <td>Carbon|DateTimeInterface $date</td> <td>2</td> </tr> <tr> <td>int $humanDiffOptions</td> <td>2</td> </tr> <tr> <td>int $week</td> <td>2</td> </tr> <tr> <td>int $hour midday hour</td> <td>2</td> </tr> <tr> <td>Closure|static|string|false|null $testNow real or mock Carbon instance</td> <td>2</td> </tr> <tr> <td>string|Closure|null $format</td> <td>2</td> </tr> <tr> <td>string $unit year, month, day, hour, minute, second or microsecond</td> <td>2</td> </tr> <tr> <td>int $value new value for given unit</td> <td>2</td> </tr> <tr> <td>int $value new value for the input unit</td> <td>2</td> </tr> <tr> <td>bool $utf8</td> <td>2</td> </tr> <tr> <td>int|string $day week end day (or 'auto' to get the day before the first day of week</td> <td>2</td> </tr> <tr> <td>int|string $day week start day (or 'auto' to get the first day of week from Carbon::getLocale() culture).</td> <td>2</td> </tr> <tr> <td>array $days</td> <td>2</td> </tr> <tr> <td>array $settings</td> <td>2</td> </tr> <tr> <td>int $value amount to subtract to the input unit</td> <td>2</td> </tr> <tr> <td>int $value</td> <td>2</td> </tr> <tr> <td>bool|null $overflow</td> <td>2</td> </tr> <tr> <td>bool $keepOffset Pass true to keep the date offset. Else forced to UTC.</td> <td>2</td> </tr> <tr> <td>\DateTimeInterface|Carbon|CarbonImmutable|int|null $end period end date or recurrences count if int</td> <td>2</td> </tr> <tr> <td>int|\DateInterval|string|null $interval period default interval or number of the given $unit</td> <td>2</td> </tr> <tr> <td>string|null $unit if specified, $interval must be an integer</td> <td>2</td> </tr> <tr> <td>bool $extended</td> <td>2</td> </tr> <tr> <td>string $key</td> <td>2</td> </tr> <tr> <td>array $parameters</td> <td>2</td> </tr> <tr> <td>string|int|float|null $number</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface|null $translator</td> <td>2</td> </tr> <tr> <td>bool $altNumbers</td> <td>2</td> </tr> <tr> <td>string $timeString date/time/duration string to translate (may also contain English)</td> <td>2</td> </tr> <tr> <td>string|null $from input locale of the $timeString parameter (`Carbon::getLocale()` by default)</td> <td>2</td> </tr> <tr> <td>string|null $to output locale of the result returned (`"en"` by default)</td> <td>2</td> </tr> <tr> <td>int $mode specify what to translate with options:</td> <td>2</td> </tr> <tr> <td>string $timeString time string to translate</td> <td>2</td> </tr> <tr> <td>string|null $to output locale of the result returned ("en" by default)</td> <td>2</td> </tr> <tr> <td>string $key</td> <td>2</td> </tr> <tr> <td>array $parameters</td> <td>2</td> </tr> <tr> <td>null $number</td> <td>2</td> </tr> <tr> <td>bool $monthsOverflow</td> <td>2</td> </tr> <tr> <td>bool $strictModeEnabled</td> <td>2</td> </tr> <tr> <td>bool $yearsOverflow</td> <td>2</td> </tr> <tr> <td>int|null $minuteOffset</td> <td>2</td> </tr> <tr> <td>\DateTimeZone|string $tzName</td> <td>2</td> </tr> <tr> <td>int $years</td> <td>2</td> </tr> <tr> <td>int $months</td> <td>2</td> </tr> <tr> <td>int|float $weeks</td> <td>2</td> </tr> <tr> <td>int|float $days</td> <td>2</td> </tr> <tr> <td>int|float $hours</td> <td>2</td> </tr> <tr> <td>int|float $minutes</td> <td>2</td> </tr> <tr> <td>int|float $seconds</td> <td>2</td> </tr> <tr> <td>int|float $microseconds</td> <td>2</td> </tr> <tr> <td>float|int $factor</td> <td>2</td> </tr> <tr> <td>float|int $divider</td> <td>2</td> </tr> <tr> <td>bool $equal Indicates if an equal to comparison should be done</td> <td>2</td> </tr> <tr> <td>string $function</td> <td>2</td> </tr> <tr> <td>string $prefix prefix required to filter result</td> <td>2</td> </tr> <tr> <td>int|null $options</td> <td>2</td> </tr> <tr> <td>callable|string $filter</td> <td>2</td> </tr> <tr> <td>\DateTimeZone|string $timezone</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon|\Carbon\CarbonPeriod|\Carbon\CarbonInterval|\DateInterval|\DatePeriod|\DateTimeInterface|string|null $date</td> <td>2</td> </tr> <tr> <td>\Carbon\Carbon $current</td> <td>2</td> </tr> <tr> <td>DateTimeInterface $dateTime</td> <td>2</td> </tr> <tr> <td>DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance</td> <td>2</td> </tr> <tr> <td>Carbon|DateTimeInterface|string|null $date</td> <td>2</td> </tr> <tr> <td>mixed $value</td> <td>2</td> </tr> <tr> <td>string $parameterName</td> <td>2</td> </tr> <tr> <td>int|null $currentPage</td> <td>2</td> </tr> <tr> <td>int $currentPage</td> <td>2</td> </tr> <tr> <td>int $end</td> <td>2</td> </tr> <tr> <td>string $default</td> <td>2</td> </tr> <tr> <td>string $pageName</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Collection $collection</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator</td> <td>2</td> </tr> <tr> <td>int $window</td> <td>2</td> </tr> <tr> <td>string|null $locale</td> <td>2</td> </tr> <tr> <td>array|string $channels</td> <td>2</td> </tr> <tr> <td>string $field</td> <td>2</td> </tr> <tr> <td>array $extraConditions</td> <td>2</td> </tr> <tr> <td>mixed $identifier</td> <td>2</td> </tr> <tr> <td>string $text</td> <td>2</td> </tr> <tr> <td>\Closure|string|null $callback</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Queue\Factory $queue</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\ServiceProvider|string $provider</td> <td>2</td> </tr> <tr> <td>array $pipes</td> <td>2</td> </tr> <tr> <td>string $data</td> <td>2</td> </tr> <tr> <td>bool $recursive</td> <td>2</td> </tr> <tr> <td>string $alias</td> <td>2</td> </tr> <tr> <td>string $tag</td> <td>2</td> </tr> <tr> <td>bool $shared</td> <td>2</td> </tr> <tr> <td>mixed $instance</td> <td>2</td> </tr> <tr> <td>\Closure|string $abstract</td> <td>2</td> </tr> <tr> <td>bool $escape</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Support\MessageProvider|array $messages</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\Request $request</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Support\Arrayable|array $data</td> <td>2</td> </tr> <tr> <td>array $mergeData</td> <td>2</td> </tr> <tr> <td>array|string $views</td> <td>2</td> </tr> <tr> <td>string|array $hints</td> <td>2</td> </tr> <tr> <td>array $jobs</td> <td>2</td> </tr> <tr> <td>bool $httpOnly</td> <td>2</td> </tr> <tr> <td>bool $raw</td> <td>2</td> </tr> <tr> <td>string|null $sameSite</td> <td>2</td> </tr> <tr> <td>\Illuminate\Routing\Route $route</td> <td>2</td> </tr> <tr> <td>string $callback</td> <td>2</td> </tr> <tr> <td>string|null $disposition</td> <td>2</td> </tr> <tr> <td>\SplFileInfo|string $file</td> <td>2</td> </tr> <tr> <td>bool $absolute</td> <td>2</td> </tr> <tr> <td>string|null $field</td> <td>2</td> </tr> <tr> <td>\Closure|string|array $events</td> <td>2</td> </tr> <tr> <td>object|string $subscriber</td> <td>2</td> </tr> <tr> <td>bool $halt</td> <td>2</td> </tr> <tr> <td>\Closure|string $extension</td> <td>2</td> </tr> <tr> <td>string|null $message</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Console\Output\OutputInterface|null $outputBuffer</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\Console\Input\InputInterface $input</td> <td>2</td> </tr> <tr> <td>bool $destroy</td> <td>2</td> </tr> <tr> <td>string $url</td> <td>2</td> </tr> <tr> <td>string $language</td> <td>2</td> </tr> <tr> <td>string $cap</td> <td>2</td> </tr> <tr> <td>int $words</td> <td>2</td> </tr> <tr> <td>string $character</td> <td>2</td> </tr> <tr> <td>int $index</td> <td>2</td> </tr> <tr> <td>string|null $default</td> <td>2</td> </tr> <tr> <td>string|string[] $search</td> <td>2</td> </tr> <tr> <td>string|string[] $replace</td> <td>2</td> </tr> <tr> <td>string|array<string> $search</td> <td>2</td> </tr> <tr> <td>bool $caseSensitive</td> <td>2</td> </tr> <tr> <td>string $separator</td> <td>2</td> </tr> <tr> <td>string|null $language</td> <td>2</td> </tr> <tr> <td>string $needle</td> <td>2</td> </tr> <tr> <td>string|array $replace</td> <td>2</td> </tr> <tr> <td>array|int $offset</td> <td>2</td> </tr> <tr> <td>array|int|null $length</td> <td>2</td> </tr> <tr> <td>array|mixed $keys</td> <td>2</td> </tr> <tr> <td>array $needles</td> <td>2</td> </tr> <tr> <td>array|string $paths</td> <td>2</td> </tr> <tr> <td>array $paths</td> <td>2</td> </tr> <tr> <td>string|null $provider</td> <td>2</td> </tr> <tr> <td>string|null $group</td> <td>2</td> </tr> <tr> <td>array|string $jobsToFake</td> <td>2</td> </tr> <tr> <td>mixed $job</td> <td>2</td> </tr> <tr> <td>array|string $eventsToFake</td> <td>2</td> </tr> <tr> <td>string|\Closure $event</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\BusFake $bus</td> <td>2</td> </tr> <tr> <td>int $expectedCount</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Mail\Mailable $mailable</td> <td>2</td> </tr> <tr> <td>string $jobId</td> <td>2</td> </tr> <tr> <td>string|null $disk</td> <td>2</td> </tr> <tr> <td>array $args</td> <td>2</td> </tr> <tr> <td>mixed $source</td> <td>2</td> </tr> <tr> <td>callable|string $countBy</td> <td>2</td> </tr> <tr> <td>callable|null|int $callback</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Enumerable $collection</td> <td>2</td> </tr> <tr> <td>int $number</td> <td>2</td> </tr> <tr> <td>array|static $value</td> <td>2</td> </tr> <tr> <td>mixed ...$lists</td> <td>2</td> </tr> <tr> <td>mixed ...$args</td> <td>2</td> </tr> <tr> <td>string|callable $key</td> <td>2</td> </tr> <tr> <td>string|string[] $type</td> <td>2</td> </tr> <tr> <td>callable|string $key</td> <td>2</td> </tr> <tr> <td>callable|mixed $callback</td> <td>2</td> </tr> <tr> <td>string|array|int|null $value</td> <td>2</td> </tr> <tr> <td>string|int $key</td> <td>2</td> </tr> <tr> <td>mixed ...$initial</td> <td>2</td> </tr> <tr> <td>array|string $config</td> <td>2</td> </tr> <tr> <td>array|mixed $value</td> <td>2</td> </tr> <tr> <td>string $folder_name</td> <td>2</td> </tr> <tr> <td>$delimiter</td> <td>2</td> </tr> <tr> <td>string $new_name</td> <td>2</td> </tr> <tr> <td>$str</td> <td>2</td> </tr> <tr> <td>string $from</td> <td>2</td> </tr> <tr> <td>string $to</td> <td>2</td> </tr> <tr> <td>object|string $structure</td> <td>2</td> </tr> <tr> <td>object $header</td> <td>2</td> </tr> <tr> <td>Header $header</td> <td>2</td> </tr> <tr> <td>string|null $mask</td> <td>2</td> </tr> <tr> <td>string $raw_body</td> <td>2</td> </tr> <tr> <td>array $raw_flags</td> <td>2</td> </tr> <tr> <td>Part $part</td> <td>2</td> </tr> <tr> <td>int $sequence</td> <td>2</td> </tr> <tr> <td>MessageCollection $thread</td> <td>2</td> </tr> <tr> <td>Folder $primary_folder</td> <td>2</td> </tr> <tr> <td>Folder $secondary_folder</td> <td>2</td> </tr> <tr> <td>Folder $sent_folder</td> <td>2</td> </tr> <tr> <td>$folder_path</td> <td>2</td> </tr> <tr> <td>$msgn</td> <td>2</td> </tr> <tr> <td>$uid</td> <td>2</td> </tr> <tr> <td>string $folder</td> <td>2</td> </tr> <tr> <td>mixed $encryption Connection encryption method</td> <td>2</td> </tr> <tr> <td>string $folder examine this folder</td> <td>2</td> </tr> <tr> <td>string $sequence uid sequence</td> <td>2</td> </tr> <tr> <td>string $folder mailbox name match with wildcards</td> <td>2</td> </tr> <tr> <td>array $flags flags to set, add or remove - see $mode</td> <td>2</td> </tr> <tr> <td>$event</td> <td>2</td> </tr> <tr> <td>int $per_page</td> <td>2</td> </tr> <tr> <td>Closure $closure</td> <td>2</td> </tr> <tr> <td>$messageId</td> <td>2</td> </tr> <tr> <td>Collection $available_messages</td> <td>2</td> </tr> <tr> <td>integer $msglist</td> <td>2</td> </tr> <tr> <td>int $page</td> <td>2</td> </tr> <tr> <td>boolean $fetch_options</td> <td>2</td> </tr> <tr> <td>string $fetch_order</td> <td>2</td> </tr> <tr> <td>mixed $var Any PHP variable</td> <td>2</td> </tr> <tr> <td>int $type A Cursor::HASH_* const for the type of hash</td> <td>2</td> </tr> <tr> <td>string $class The object class, resource type or array count</td> <td>2</td> </tr> <tr> <td>int $cut The number of items the hash has been cut by</td> <td>2</td> </tr> <tr> <td>bool $isNested True if the object is nested in the dumped structure</td> <td>2</td> </tr> <tr> <td>string $userAgent</td> <td>2</td> </tr> <tr> <td>string $data The data of the attachment</td> <td>2</td> </tr> <tr> <td>string $filename The filename of the attachment (default is empty string)</td> <td>2</td> </tr> <tr> <td>string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)</td> <td>2</td> </tr> <tr> <td>string $cid The content-id (cid) of the attachment (default is false)</td> <td>2</td> </tr> <tr> <td>array $headers The HTTP headers</td> <td>2</td> </tr> <tr> <td>int $level Debug level 0-9, where 0 turns off</td> <td>2</td> </tr> <tr> <td>mixed $headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array</td> <td>2</td> </tr> <tr> <td>string $qname qname</td> <td>2</td> </tr> <tr> <td>string $str The prefixed string</td> <td>2</td> </tr> <tr> <td>string $type name of type</td> <td>2</td> </tr> <tr> <td>string $typeClass (complexType|simpleType|attribute)</td> <td>2</td> </tr> <tr> <td>string $compositor (all|sequence|choice)</td> <td>2</td> </tr> <tr> <td>string $typeClass (should always be simpleType)</td> <td>2</td> </tr> <tr> <td>string $phpType (should always be scalar)</td> <td>2</td> </tr> <tr> <td>array $enumeration array of values</td> <td>2</td> </tr> <tr> <td>array $attrs attributes that must include name and type</td> <td>2</td> </tr> <tr> <td>string $url The URL to which to connect</td> <td>2</td> </tr> <tr> <td>mixed $option The cURL option (always integer?)</td> <td>2</td> </tr> <tr> <td>mixed $value The cURL option value</td> <td>2</td> </tr> <tr> <td>string $name The name of the header</td> <td>2</td> </tr> <tr> <td>array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)</td> <td>2</td> </tr> <tr> <td>array $headers The HTTP headers</td> <td>2</td> </tr> <tr> <td>array $in assoc array of input values: key = param name, value = param type</td> <td>2</td> </tr> <tr> <td>array $out assoc array of output values: key = param name, value = param type</td> <td>2</td> </tr> <tr> <td>string $proxyhost</td> <td>2</td> </tr> <tr> <td>integer $timeout set the connection timeout</td> <td>2</td> </tr> <tr> <td>integer $response_timeout set the response timeout</td> <td>2</td> </tr> <tr> <td>string $bindingType type of binding eg: soap, soap12</td> <td>2</td> </tr> <tr> <td>string $direction (input|output)</td> <td>2</td> </tr> <tr> <td>mixed $parameters parameter value(s)</td> <td>2</td> </tr> <tr> <td>string $use use for part (encoded|literal)</td> <td>2</td> </tr> <tr> <td>string $encodingStyle SOAP encoding style for the value (if different than the enclosing style)</td> <td>2</td> </tr> <tr> <td>array $typeDef our internal representation of an XML schema type (or element)</td> <td>2</td> </tr> <tr> <td>string $ns the namespace of the type</td> <td>2</td> </tr> <tr> <td>string $uqType the local part of the type</td> <td>2</td> </tr> <tr> <td>string $filename The Filename of the Cache to lock</td> <td>2</td> </tr> <tr> <td>object &$obj The mimePart to add the image to</td> <td>2</td> </tr> <tr> <td>array $xtra_headers Assoc array with any extra headers (optional)</td> <td>2</td> </tr> <tr> <td>bool $skip_content Don't return content headers: Content-Type,</td> <td>2</td> </tr> <tr> <td>string $name The header name</td> <td>2</td> </tr> <tr> <td>string $value The header data to encode</td> <td>2</td> </tr> <tr> <td>string $charset Character set name</td> <td>2</td> </tr> <tr> <td>string $encoding Encoding name (base64 or quoted-printable)</td> <td>2</td> </tr> <tr> <td>mixed $data Object</td> <td>2</td> </tr> <tr> <td>$message A text error message</td> <td>2</td> </tr> <tr> <td>string $boundary Pre-defined boundary string</td> <td>2</td> </tr> <tr> <td>boolean $skip_head True if you don't want to save headers</td> <td>2</td> </tr> <tr> <td>string $charset Character set name</td> <td>2</td> </tr> <tr> <td>string $encoding Encoding name (base64 or quoted-printable)</td> <td>2</td> </tr> <tr> <td>int $prefix_len Prefix length. Default: 0</td> <td>2</td> </tr> <tr> <td>string $eol End-of-line sequence. Default: "\r\n"</td> <td>2</td> </tr> <tr> <td>array $matches Preg_replace's matches array</td> <td>2</td> </tr> <tr> <td>\Stripe\Util\RequestOptions $opts</td> <td>2</td> </tr> <tr> <td>string $header the signature header</td> <td>2</td> </tr> <tr> <td>string $payload the payload sent by Stripe</td> <td>2</td> </tr> <tr> <td>string $secret secret used to generate the signature</td> <td>2</td> </tr> <tr> <td>int $tolerance maximum difference allowed between the header's</td> <td>2</td> </tr> <tr> <td>array $filters the filters</td> <td>2</td> </tr> <tr> <td>string $id the ID of the account to which the capability belongs</td> <td>2</td> </tr> <tr> <td>string $method</td> <td>2</td> </tr> <tr> <td>string $url</td> <td>2</td> </tr> <tr> <td>null|array $headers</td> <td>2</td> </tr> <tr> <td>int $rcode</td> <td>2</td> </tr> <tr> <td>string $rbody</td> <td>2</td> </tr> <tr> <td>int $rcode</td> <td>2</td> </tr> <tr> <td>array $rheaders</td> <td>2</td> </tr> <tr> <td>string $apiKey</td> <td>2</td> </tr> <tr> <td>string $id the ID of the transfer to which the transfer reversal belongs</td> <td>2</td> </tr> <tr> <td>mixed $obj</td> <td>2</td> </tr> <tr> <td>string $id the ID of the customer to which the cash balance belongs</td> <td>2</td> </tr> <tr> <td>mixed $cashBalanceId</td> <td>2</td> </tr> <tr> <td>string $id the ID of the customer to which the customer balance transaction belongs</td> <td>2</td> </tr> <tr> <td>string $id the ID of the customer to which the tax id belongs</td> <td>2</td> </tr> <tr> <td>string $id the ID of the application fee to which the fee refund belongs</td> <td>2</td> </tr> <tr> <td>array|string $id the ID of the API resource to retrieve,</td> <td>2</td> </tr> <tr> <td>callable $readBodyChunk function that will receive chunks of data from a successful request body</td> <td>2</td> </tr> <tr> <td>string $method The HTTP method being used</td> <td>2</td> </tr> <tr> <td>string $absUrl The URL being requested, including domain and protocol</td> <td>2</td> </tr> <tr> <td>array $headers Headers to be used in the request (full strings, not KV pairs)</td> <td>2</td> </tr> <tr> <td>array $params KV pairs for parameters. Can be nested for arrays and hashes</td> <td>2</td> </tr> <tr> <td>bool $hasFile Whether or not $params references a file (via an @ prefix or</td> <td>2</td> </tr> <tr> <td>bool $enable</td> <td>2</td> </tr> <tr> <td>array $opts</td> <td>2</td> </tr> <tr> <td>array $opts cURL options</td> <td>2</td> </tr> <tr> <td>string $absUrl</td> <td>2</td> </tr> <tr> <td>int $errno</td> <td>2</td> </tr> <tr> <td>array|\Stripe\Util\CaseInsensitiveArray $rheaders</td> <td>2</td> </tr> <tr> <td>null|array|RequestOptions|string $options a key => value array</td> <td>2</td> </tr> <tr> <td>bool $strict when true, forbid string form and arbitrary keys in array form</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeClientInterface $client</td> <td>2</td> </tr> <tr> <td>null|string $httpBody</td> <td>2</td> </tr> <tr> <td>null|string $stripeParam the parameter related to the error</td> <td>2</td> </tr> <tr> <td>null|string $stripeParam</td> <td>2</td> </tr> <tr> <td>$request</td> <td>2</td> </tr> <tr> <td>DataCollectorInterface $collector</td> <td>2</td> </tr> <tr> <td>integer $maxHeaderLength</td> <td>2</td> </tr> <tr> <td>string $type 'css', 'js', 'inline_css', 'inline_js', 'inline_head', or null for all</td> <td>2</td> </tr> <tr> <td>boolean $here Set position of HTML. True if is to current position or false for end file</td> <td>2</td> </tr> <tr> <td>boolean $initialize Whether to render the de bug bar initialization code</td> <td>2</td> </tr> <tr> <td>bool $renderStackedData</td> <td>2</td> </tr> <tr> <td>bool $head</td> <td>2</td> </tr> <tr> <td>string|null $collector</td> <td>2</td> </tr> <tr> <td>$message</td> <td>2</td> </tr> <tr> <td>array $context</td> <td>2</td> </tr> <tr> <td>\Throwable $e</td> <td>2</td> </tr> <tr> <td>mixed $parameter Parameter identifier. For a prepared statement using named</td> <td>2</td> </tr> <tr> <td>TimeDataCollector $timeCollector</td> <td>2</td> </tr> <tr> <td>string $sql</td> <td>2</td> </tr> <tr> <td>Logger $logger</td> <td>2</td> </tr> <tr> <td>array $meta</td> <td>2</td> </tr> <tr> <td>float $seconds</td> <td>2</td> </tr> <tr> <td>string $size</td> <td>2</td> </tr> <tr> <td>int $notrigger false=launch triggers after, true=disable triggers</td> <td>2</td> </tr> <tr> <td>User $user User to check</td> <td>2</td> </tr> <tr> <td>string $features Features to check (in most cases, it's module name)</td> <td>2</td> </tr> <tr> <td>int $objectid Object ID if we want to check permission on a particular record (optional)</td> <td>2</td> </tr> <tr> <td>string $dbtablename Table name where object is stored. Not used if objectid is null (optional)</td> <td>2</td> </tr> <tr> <td>string $feature2 Feature to check (second level of permission)</td> <td>2</td> </tr> <tr> <td>string $dbt_keyfield Field name for socid foreign key if not fk_soc. (optional)</td> <td>2</td> </tr> <tr> <td>string $dbt_select Field name for select if not rowid. (optional)</td> <td>2</td> </tr> <tr> <td>int $id Id of thirdparty</td> <td>2</td> </tr> <tr> <td>int $representative_id Id of representative</td> <td>2</td> </tr> <tr> <td>int $id ID of thirdparty</td> <td>2</td> </tr> <tr> <td>int $category_id Id of category</td> <td>2</td> </tr> <tr> <td>int $id Id of thirdparty</td> <td>2</td> </tr> <tr> <td>int $id ID of thirdparty</td> <td>2</td> </tr> <tr> <td>string $site Site key</td> <td>2</td> </tr> <tr> <td>int $id Id of third party</td> <td>2</td> </tr> <tr> <td>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.</td> <td>2</td> </tr> <tr> <td>int $includecount Count and return also number of elements the contact is used as a link for</td> <td>2</td> </tr> <tr> <td>int $includeroles Includes roles of the contact</td> <td>2</td> </tr> <tr> <td>array $request_data Request datas</td> <td>2</td> </tr> <tr> <td>string $ref Ref of record</td> <td>2</td> </tr> <tr> <td>boolean $displayriblabel Prepend or Hide Label</td> <td>2</td> </tr> <tr> <td>float $remise Value in % of the discount</td> <td>2</td> </tr> <tr> <td>string $note Note/Reason for changing the discount</td> <td>2</td> </tr> <tr> <td>User $user User who sets the discount</td> <td>2</td> </tr> <tr> <td>int $commid Id of user</td> <td>2</td> </tr> <tr> <td>int $rowid id of contact</td> <td>2</td> </tr> <tr> <td>string $mode 'customer' or 'supplier'</td> <td>2</td> </tr> <tr> <td>int<0,7> $mode 0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Picto+Long label, 7=Very short label+Picto</td> <td>2</td> </tr> <tr> <td>int<0,1> $hidenastatus 1=Show nothing if status is "Not applicable"</td> <td>2</td> </tr> <tr> <td>int $status Id status</td> <td>2</td> </tr> <tr> <td>int $idproduct Product Id to add</td> <td>2</td> </tr> <tr> <td>float $qty Quantity</td> <td>2</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>2</td> </tr> <tr> <td>int $socid Id third party</td> <td>2</td> </tr> <tr> <td>int $idremise Id of fixed discount</td> <td>2</td> </tr> <tr> <td>int $info_bits Bits for type of lines</td> <td>2</td> </tr> <tr> <td>int $pa_ht Buying price without tax</td> <td>2</td> </tr> <tr> <td>int|string $date_start Start date of the line</td> <td>2</td> </tr> <tr> <td>int|string $date_end End date of the line</td> <td>2</td> </tr> <tr> <td>string $desc Description</td> <td>2</td> </tr> <tr> <td>int $info_bits Miscellaneous information</td> <td>2</td> </tr> <tr> <td>int $type 0/1=Product/service</td> <td>2</td> </tr> <tr> <td>User $user User that create</td> <td>2</td> </tr> <tr> <td>int $socid Id of thirdparty</td> <td>2</td> </tr> <tr> <td>User $user Object user that validate</td> <td>2</td> </tr> <tr> <td>string $ref_client Customer reference</td> <td>2</td> </tr> <tr> <td>int $shortlist 0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name)</td> <td>2</td> </tr> <tr> <td>int $draft 0=not draft, 1=draft</td> <td>2</td> </tr> <tr> <td>int $notcurrentuser 0=all user, 1=not current user</td> <td>2</td> </tr> <tr> <td>int $socid Id third party</td> <td>2</td> </tr> <tr> <td>int $limit For pagination</td> <td>2</td> </tr> <tr> <td>int $offset For pagination</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort criteria</td> <td>2</td> </tr> <tr> <td>User $user Object user that delete</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>2</td> </tr> <tr> <td>int $id Proposal id</td> <td>2</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>2</td> </tr> <tr> <td>int $rowid Propal line id</td> <td>2</td> </tr> <tr> <td>int $id Id of commercial proposal to update</td> <td>2</td> </tr> <tr> <td>array $request_data Commercial proposal line data</td> <td>2</td> </tr> <tr> <td>int $id Id of commercial proposal to update</td> <td>2</td> </tr> <tr> <td>array $arrayquery All element to Query</td> <td>2</td> </tr> <tr> <td>User $user Object user qui valide</td> <td>2</td> </tr> <tr> <td>string $htmlname of html select object</td> <td>2</td> </tr> <tr> <td>array $selected_array or Code or Label of preselected country</td> <td>2</td> </tr> <tr> <td>string $htmlname control name</td> <td>2</td> </tr> <tr> <td>string $moduletag Limit permission for a particular module ('' by default means load all permissions)</td> <td>2</td> </tr> <tr> <td>int $forcereload Force reload of permissions even if they were already loaded (ignore cache)</td> <td>2</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip on picto and name</td> <td>2</td> </tr> <tr> <td>int $entity Entity to use</td> <td>2</td> </tr> <tr> <td>User $user Object user that save</td> <td>2</td> </tr> <tr> <td>int $id Id of profil to load</td> <td>2</td> </tr> <tr> <td>string $targetmodule Name of directory where canvas is stored</td> <td>2</td> </tr> <tr> <td>string $canvas Name of canvas</td> <td>2</td> </tr> <tr> <td>string $card Name of tab (sub-canvas)</td> <td>2</td> </tr> <tr> <td>int $forceupdateaffiliate update price on each soc child</td> <td>2</td> </tr> <tr> <td>int $level price level to change</td> <td>2</td> </tr> <tr> <td>int $socid Id thirdparty to filter on a thirdparty</td> <td>2</td> </tr> <tr> <td>string $filtrestatut Id status to filter on a status</td> <td>2</td> </tr> <tr> <td>int $forVirtualStock Ignore rights filter for virtual stock calculation.</td> <td>2</td> </tr> <tr> <td>int $id_pere Id of parent product/service</td> <td>2</td> </tr> <tr> <td>int $id_fils Id of child product/service</td> <td>2</td> </tr> <tr> <td>float $qty Quantity</td> <td>2</td> </tr> <tr> <td>int $incdec 1=Increase/decrease stock of child when parent stock increase/decrease</td> <td>2</td> </tr> <tr> <td>string $modele Force model to use ('' to not force)</td> <td>2</td> </tr> <tr> <td>Translate $outputlangs Object langs to use for output</td> <td>2</td> </tr> <tr> <td>int $hidedetails Hide details of lines</td> <td>2</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>2</td> </tr> <tr> <td>int $hideref Hide ref</td> <td>2</td> </tr> <tr> <td>int $dateofvirtualstock Date of virtual stock</td> <td>2</td> </tr> <tr> <td>int $fk_product Add quantity of stock in label for product with id fk_product. Nothing if 0.</td> <td>2</td> </tr> <tr> <td>array $exclude warehouses ids to exclude</td> <td>2</td> </tr> <tr> <td>bool|int $stockMin [=false] Value of minimum stock to filter (only warehouse with stock > stockMin are loaded) or false not not filter by minimum stock</td> <td>2</td> </tr> <tr> <td>string $htmlname Name of html select html</td> <td>2</td> </tr> <tr> <td>int $empty 1=Can be empty, 0 if not</td> <td>2</td> </tr> <tr> <td>int $disabled 1=Select is disabled</td> <td>2</td> </tr> <tr> <td>int $fk_product Add quantity of stock in label for product with id fk_product. Nothing if 0.</td> <td>2</td> </tr> <tr> <td>string $empty_label Empty label if needed (only if $empty=1)</td> <td>2</td> </tr> <tr> <td>int $forcecombo 1=Force combo iso ajax select2</td> <td>2</td> </tr> <tr> <td>array $exclude Warehouses ids to exclude</td> <td>2</td> </tr> <tr> <td>int $showfullpath 1=Show full path of name (parent ref into label), 0=Show only ref of current warehouse</td> <td>2</td> </tr> <tr> <td>string $name Name of HTML field</td> <td>2</td> </tr> <tr> <td>int $empty 1=Can be empty, 0 if not</td> <td>2</td> </tr> <tr> <td>int $fk_product show lot numbers of product with id fk_product. All from objectLines if 0.</td> <td>2</td> </tr> <tr> <td>int $fk_entrepot filter lot numbers for warehouse with id fk_entrepot. All if 0.</td> <td>2</td> </tr> <tr> <td>array $objectLines Only cache lot numbers for products in lines of object. If no lines only for fk_product. If no fk_product, all.</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>int $limit Limit for list</td> <td>2</td> </tr> <tr> <td>int $page Page number</td> <td>2</td> </tr> <tr> <td>int $id ID of product</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>2</td> </tr> <tr> <td>int $limit Limit for list</td> <td>2</td> </tr> <tr> <td>int $page Page number</td> <td>2</td> </tr> <tr> <td>int $id ID of Attribute</td> <td>2</td> </tr> <tr> <td>array $request_data Datas</td> <td>2</td> </tr> <tr> <td>string $ref Ref of Attribute value</td> <td>2</td> </tr> <tr> <td>int $id ID of Product</td> <td>2</td> </tr> <tr> <td>int $category Use this param to filter list by category</td> <td>2</td> </tr> <tr> <td>int $id Id of warehouse to update</td> <td>2</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>2</td> </tr> <tr> <td>int $sellBy Sell by date</td> <td>2</td> </tr> <tr> <td>int $eatBy Eat by date</td> <td>2</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)</td> <td>2</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>2</td> </tr> <tr> <td>int $donotcleanemptylines Do not clean lines that remains in stock table with qty=0 (because we want to have this done by the caller)</td> <td>2</td> </tr> <tr> <td>array $extra_values Any additional values for expression</td> <td>2</td> </tr> <tr> <td>User|null $user User that modifies</td> <td>2</td> </tr> <tr> <td>int $rowid Row id of global variable</td> <td>2</td> </tr> <tr> <td>User|null $user User that modifies</td> <td>2</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>2</td> </tr> <tr> <td>int $fk_unit Id of the unit to use.</td> <td>2</td> </tr> <tr> <td>double $remise Amount discount</td> <td>2</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>2</td> </tr> <tr> <td>string $option Where point the link ('compta', 'expedition', 'document', ...)</td> <td>2</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto</td> <td>2</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>2</td> </tr> <tr> <td>integer $delivery_date Delivery date</td> <td>2</td> </tr> <tr> <td>Adherent $object Object with data (->email, ->pass, ->element, ->type)</td> <td>2</td> </tr> <tr> <td>string $NameField Name of the field to filter</td> <td>2</td> </tr> <tr> <td>int $limit Limit results</td> <td>2</td> </tr> <tr> <td>datetime $date Date (YYYY-MM-DD HH:MI:SS in GMT)</td> <td>2</td> </tr> <tr> <td>int $duration Duration in seconds (3600 = 1h)</td> <td>2</td> </tr> <tr> <td>int $user_id User (Use 0 for connected user)</td> <td>2</td> </tr> <tr> <td>string $note Note</td> <td>2</td> </tr> <tr> <td>string $ref Ref of project</td> <td>2</td> </tr> <tr> <td>int $id Id of project to update</td> <td>2</td> </tr> <tr> <td>array $request_data Projectline data</td> <td>2</td> </tr> <tr> <td>string $tableName Table of the element to update</td> <td>2</td> </tr> <tr> <td>int $elementSelectId Key-rowid of the line of the element to update</td> <td>2</td> </tr> <tr> <td>int $datestart First day of week (use dol_get_first_day to find this date)</td> <td>2</td> </tr> <tr> <td>int $taskid Filter on a task id</td> <td>2</td> </tr> <tr> <td>int $userid Time spent by a particular user</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>2</td> </tr> <tr> <td>int $origin_id Old task id</td> <td>2</td> </tr> <tr> <td>int $dest_id New task id</td> <td>2</td> </tr> <tr> <td>string $morewherefilter Add more filter into where SQL request (must start with ' AND ...')</td> <td>2</td> </tr> <tr> <td>int $status Id status</td> <td>2</td> </tr> <tr> <td>User $user Object user who delete</td> <td>2</td> </tr> <tr> <td>int $notrigger Disable trigger</td> <td>2</td> </tr> <tr> <td>int $id Intervention ID</td> <td>2</td> </tr> <tr> <td>User $user Object user who modify</td> <td>2</td> </tr> <tr> <td>string $subject Subject</td> <td>2</td> </tr> <tr> <td>array $array_options Array options</td> <td>2</td> </tr> <tr> <td>int $id ID of ticket</td> <td>2</td> </tr> <tr> <td>string $track_id Tracking ID of ticket</td> <td>2</td> </tr> <tr> <td>string $ref Reference for ticket</td> <td>2</td> </tr> <tr> <td>string $login User login</td> <td>2</td> </tr> <tr> <td>string $password User password</td> <td>2</td> </tr> <tr> <td>string $entity Entity (when multicompany module is used). '' means 1=first company.</td> <td>2</td> </tr> <tr> <td>int $reset Reset token (0=get current token, 1=ask a new token and canceled old token. This means access using current existing API token of user will fails: new token will be required for new access)</td> <td>2</td> </tr> <tr> <td>string $sqlfilters SQL criteria to filter with. Syntax example "(t.code:=:'OrderByWWW')"</td> <td>2</td> </tr> <tr> <td>int $id ID of region</td> <td>2</td> </tr> <tr> <td>string $code Code of region</td> <td>2</td> </tr> <tr> <td>int $id ID of state</td> <td>2</td> </tr> <tr> <td>string $code Code of state</td> <td>2</td> </tr> <tr> <td>int $id ID of country</td> <td>2</td> </tr> <tr> <td>string $code Code of country (2 characters)</td> <td>2</td> </tr> <tr> <td>string $iso ISO of country (3 characters)</td> <td>2</td> </tr> <tr> <td>string $module To filter on module events</td> <td>2</td> </tr> <tr> <td>int $active Event's type is active or not {@min 0} {@max 1}</td> <td>2</td> </tr> <tr> <td>string $lang Code of the language the label of the civility must be translated to</td> <td>2</td> </tr> <tr> <td>array $request_data Request datas</td> <td>2</td> </tr> <tr> <td>string $sqlfilters SQL criteria to filter. Syntax example "(t.code:=:'CHQ')"</td> <td>2</td> </tr> <tr> <td>string $lang Code of the language the label of the type must be translated to</td> <td>2</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>2</td> </tr> <tr> <td>int $addlinktonotes 1=Add link to notes</td> <td>2</td> </tr> <tr> <td>string $id [=''] Id</td> <td>2</td> </tr> <tr> <td>string $morecss [=''] Class</td> <td>2</td> </tr> <tr> <td>string $moreparam [=''] Add attributes (checked, required, etc)</td> <td>2</td> </tr> <tr> <td>string $option On what the link point to ('nolink', ...)</td> <td>2</td> </tr> <tr> <td>array $arraydata Array of data</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>int $status Id status</td> <td>2</td> </tr> <tr> <td>string $path Path</td> <td>2</td> </tr> <tr> <td>string $controller Controller name</td> <td>2</td> </tr> <tr> <td>string|array $moreParams More parameters</td> <td>2</td> </tr> <tr> <td>array $params ex option, infologin</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>2</td> </tr> <tr> <td>array $parameters Parameters</td> <td>2</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>2</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>2</td> </tr> <tr> <td>int $limit Limit page</td> <td>2</td> </tr> <tr> <td>string|array $filter Filter USF.</td> <td>2</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact')</td> <td>2</td> </tr> <tr> <td>int $id ID of category</td> <td>2</td> </tr> <tr> <td>string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact')</td> <td>2</td> </tr> <tr> <td>int $id_categ id_categ entry to update</td> <td>2</td> </tr> <tr> <td>int $protection Deep counter to avoid infinite loop</td> <td>2</td> </tr> <tr> <td>string $type The category type (e.g Categorie::TYPE_WAREHOUSE)</td> <td>2</td> </tr> <tr> <td>string $rowIdName The name of the row id inside the whole sql query (e.g. "e.rowid")</td> <td>2</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 5=Long label + Picto</td> <td>2</td> </tr> <tr> <td>string $block new block to chain</td> <td>2</td> </tr> <tr> <td>string $userlogin User login</td> <td>2</td> </tr> <tr> <td>string $description Description</td> <td>2</td> </tr> <tr> <td>string $customer Stripe customer ref 'cus_xxxxxxxxxxxxx' via customerStripe()</td> <td>2</td> </tr> <tr> <td>string $key ''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect</td> <td>2</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>2</td> </tr> <tr> <td>int $usethirdpartyemailforreceiptemail 1=use thirdparty email for receipt</td> <td>2</td> </tr> <tr> <td>boolean $confirmnow false=default, true=try to confirm immediately after create (if conditions are ok)</td> <td>2</td> </tr> <tr> <td>\Stripe\Customer $cu Object stripe customer.</td> <td>2</td> </tr> <tr> <td>CompanyPaymentMode $object Object companypaymentmode to check, or create on stripe (create on stripe also update the societe_rib table for current entity)</td> <td>2</td> </tr> <tr> <td>string $stripeacc ''=Use common API. If not '', it is the Stripe connect account 'acc_....' to use Stripe connect</td> <td>2</td> </tr> <tr> <td>int $status Status (0=test, 1=live)</td> <td>2</td> </tr> <tr> <td>string $ipAddress an IPv4 or IPv6 address to lookup</td> <td>2</td> </tr> <tr> <td>bool $bool1</td> <td>2</td> </tr> <tr> <td>bool $bool2</td> <td>2</td> </tr> <tr> <td>int $id</td> <td>2</td> </tr> <tr> <td>Node $node A node to analyze</td> <td>2</td> </tr> <tr> <td>\PhpParser\Node\Expr\PropertyFetch $node node</td> <td>2</td> </tr> <tr> <td>string $my_destlang Target language code</td> <td>2</td> </tr> <tr> <td>string $line Line found into file</td> <td>2</td> </tr> <tr> <td>string $title Title</td> <td>3</td> </tr> <tr> <td>string $tabname Name of SQL table</td> <td>3</td> </tr> <tr> <td>string $context 'add'=Output field for the "add form", 'edit'=Output field for the "edit form", 'hide'=Output field for the "add form" but we don't want it to be rendered</td> <td>3</td> </tr> <tr> <td>string $id internal id</td> <td>3</td> </tr> <tr> <td>string $ref internal reference</td> <td>3</td> </tr> <tr> <td>string $ref Ref</td> <td>3</td> </tr> <tr> <td>string $ref_ext Ref_ext</td> <td>3</td> </tr> <tr> <td>int $idthirdparty Id thirdparty</td> <td>3</td> </tr> <tr> <td>string $ref_ext Ref external of object</td> <td>3</td> </tr> <tr> <td>string $sCommand Command</td> <td>3</td> </tr> <tr> <td>mixed $object Any object</td> <td>3</td> </tr> <tr> <td>string $labelofobject Label of object</td> <td>3</td> </tr> <tr> <td>int $level Level</td> <td>3</td> </tr> <tr> <td>int $count Count</td> <td>3</td> </tr> <tr> <td>string $tablepath Path of all tables ('t' or 't,contract' or 't,contract,societe'...)</td> <td>3</td> </tr> <tr> <td>string $code Code</td> <td>3</td> </tr> <tr> <td>int $socid (Optional) Show only results from the supplier with this id</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>string $newsection $newsection</td> <td>3</td> </tr> <tr> <td>string $str String to clean</td> <td>3</td> </tr> <tr> <td>Translate $langs Output language</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>string $destdir Directory</td> <td>3</td> </tr> <tr> <td>int $day Day</td> <td>3</td> </tr> <tr> <td>int $month Month</td> <td>3</td> </tr> <tr> <td>string $backtopage Url to go once contact is created</td> <td>3</td> </tr> <tr> <td>string $file Full path of filename to generate</td> <td>3</td> </tr> <tr> <td>string $content Content of file</td> <td>3</td> </tr> <tr> <td>int $nophperrors Disable all PHP output errors</td> <td>3</td> </tr> <tr> <td>CommonObject $object Object</td> <td>3</td> </tr> <tr> <td>string $trackid Track id (used to prefix name of session vars to avoid conflict)</td> <td>3</td> </tr> <tr> <td>string $haystack haystack</td> <td>3</td> </tr> <tr> <td>string $needle needle</td> <td>3</td> </tr> <tr> <td>CommonObject $object Dolibarr common object</td> <td>3</td> </tr> <tr> <td>string $module Override object element, for example to use 'mycompany' instead of 'societe'</td> <td>3</td> </tr> <tr> <td>int $forobject Return the more complete path for the given object instead of for the module only.</td> <td>3</td> </tr> <tr> <td>string $name Name of database</td> <td>3</td> </tr> <tr> <td>string $stringtoescape String to escape</td> <td>3</td> </tr> <tr> <td>string $s String to print</td> <td>3</td> </tr> <tr> <td>string $picto Name of image file to show ('filenew', ...)</td> <td>3</td> </tr> <tr> <td>int $selected Selected</td> <td>3</td> </tr> <tr> <td>int $use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.</td> <td>3</td> </tr> <tr> <td>string $str String to check</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>string $idsel Text</td> <td>3</td> </tr> <tr> <td>string $classname String to add a css class</td> <td>3</td> </tr> <tr> <td>string $text Text</td> <td>3</td> </tr> <tr> <td>string $url Url</td> <td>3</td> </tr> <tr> <td>string $id Id</td> <td>3</td> </tr> <tr> <td>string $idsel Id sel</td> <td>3</td> </tr> <tr> <td>string $classname Class name</td> <td>3</td> </tr> <tr> <td>string $atarget Target</td> <td>3</td> </tr> <tr> <td>string $filename Short file name of PDF output file</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>int $level Level</td> <td>3</td> </tr> <tr> <td>string $title Title</td> <td>3</td> </tr> <tr> <td>Translate $outputlangs Object lang a utiliser pour traduction</td> <td>3</td> </tr> <tr> <td>User $user Object du user qui cree</td> <td>3</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>3</td> </tr> <tr> <td>int $id Id of object to load</td> <td>3</td> </tr> <tr> <td>CommonObject $object Object</td> <td>3</td> </tr> <tr> <td>User $user Object user</td> <td>3</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>3</td> </tr> <tr> <td>string $tab_top Top position of table</td> <td>3</td> </tr> <tr> <td>string $tab_height Height of table (rectangle)</td> <td>3</td> </tr> <tr> <td>User $user User that modify</td> <td>3</td> </tr> <tr> <td>int $socid Id third party for filter</td> <td>3</td> </tr> <tr> <td>string $mode Option (not used)</td> <td>3</td> </tr> <tr> <td>int $userid Id user for filter (creation user)</td> <td>3</td> </tr> <tr> <td>int $id Id object</td> <td>3</td> </tr> <tr> <td>string $ref Ref</td> <td>3</td> </tr> <tr> <td>int $notrigger 0=launch triggers, 1=disable triggers</td> <td>3</td> </tr> <tr> <td>string $fieldValue value of attribute</td> <td>3</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handle</td> <td>3</td> </tr> <tr> <td>Societe $soc Thirdparty object</td> <td>3</td> </tr> <tr> <td>string $desc Description of line</td> <td>3</td> </tr> <tr> <td>User $user Object user</td> <td>3</td> </tr> <tr> <td>int $id Object id</td> <td>3</td> </tr> <tr> <td>int $id Id</td> <td>3</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.import_key:<:'20160101')"</td> <td>3</td> </tr> <tr> <td>string $text Content of message (not html entities encoded)</td> <td>3</td> </tr> <tr> <td>string $subject Subject of message</td> <td>3</td> </tr> <tr> <td>array $filename_list Array of attached files</td> <td>3</td> </tr> <tr> <td>array $mimetype_list Array of mime types of attached files</td> <td>3</td> </tr> <tr> <td>array $mimefilename_list Array of public names of attached files</td> <td>3</td> </tr> <tr> <td>string $addr_cc Email cc</td> <td>3</td> </tr> <tr> <td>string $addr_bcc Email bcc</td> <td>3</td> </tr> <tr> <td>int $deliveryreceipt Ask a delivery receipt</td> <td>3</td> </tr> <tr> <td>int $msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection</td> <td>3</td> </tr> <tr> <td>string $errors_to errors to</td> <td>3</td> </tr> <tr> <td>string $moreinheader Add more html headers</td> <td>3</td> </tr> <tr> <td>int $notrigger 1=disable trigger UPDATE (when called by create)</td> <td>3</td> </tr> <tr> <td>User $user User making change</td> <td>3</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>3</td> </tr> <tr> <td>int $notrigger 1=do not execute triggers, 0 otherwise</td> <td>3</td> </tr> <tr> <td>string $textinlog Add a small text into log. '' by default.</td> <td>3</td> </tr> <tr> <td>DoliDB $db Handler access base de donnees</td> <td>3</td> </tr> <tr> <td>User $user User making payment</td> <td>3</td> </tr> <tr> <td>User $user Object user</td> <td>3</td> </tr> <tr> <td>int $notrigger disable line update trigger</td> <td>3</td> </tr> <tr> <td>int $position Position</td> <td>3</td> </tr> <tr> <td>int $status Id status</td> <td>3</td> </tr> <tr> <td>User $user Object user</td> <td>3</td> </tr> <tr> <td>DoliDB $db handler</td> <td>3</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>3</td> </tr> <tr> <td>User $user User that creates</td> <td>3</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>3</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>3</td> </tr> <tr> <td>array $archiveFileList [=array()] Archive file list : array of ['path', 'name']</td> <td>3</td> </tr> <tr> <td>int $withAttachment [=0] Not add files or 1 to have attached in an archive</td> <td>3</td> </tr> <tr> <td>string $sdir Directory to scan</td> <td>3</td> </tr> <tr> <td>int $id Id of BOM to update</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>Societe $soc Thirdparty object</td> <td>3</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=long label + picto</td> <td>3</td> </tr> <tr> <td>int $socid Id of thirdparty</td> <td>3</td> </tr> <tr> <td>int $outputmode 0=HTML select string, 1=Array</td> <td>3</td> </tr> <tr> <td>string $htmlname Nom de la zone select</td> <td>3</td> </tr> <tr> <td>string $morecss Add more CSS on select tag</td> <td>3</td> </tr> <tr> <td>int $active Active or not, -1 = all</td> <td>3</td> </tr> <tr> <td>string $morecss More CSS</td> <td>3</td> </tr> <tr> <td>int $limit Limit on number of returned lines</td> <td>3</td> </tr> <tr> <td>string|int<0,1> $showempty '' to not show empty line. Translation key to show an empty line. '1' show empty line with no text.</td> <td>3</td> </tr> <tr> <td>int $maxlength Maximum length of label</td> <td>3</td> </tr> <tr> <td>int $option_only Return only html options lines without the select tag</td> <td>3</td> </tr> <tr> <td>string $show_empty Add an empty line ('1' or string to show for empty line)</td> <td>3</td> </tr> <tr> <td>int $forcefocus Force focus on field (works with javascript only)</td> <td>3</td> </tr> <tr> <td>int $disabled Disabled</td> <td>3</td> </tr> <tr> <td>string $selected Preselected type</td> <td>3</td> </tr> <tr> <td>string $selected Preselected value</td> <td>3</td> </tr> <tr> <td>int $short Use short labels</td> <td>3</td> </tr> <tr> <td>string $hmlname Name of HTML select element</td> <td>3</td> </tr> <tr> <td>string $selected Id modele pre-selectionne</td> <td>3</td> </tr> <tr> <td>string $morecss More CSS</td> <td>3</td> </tr> <tr> <td>string $morecss More css</td> <td>3</td> </tr> <tr> <td>string $htmlname Name of select zone</td> <td>3</td> </tr> <tr> <td>string $selected Selected value</td> <td>3</td> </tr> <tr> <td>string $moreattrib More attributes on HTML select tag</td> <td>3</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>3</td> </tr> <tr> <td>string $filtermode filter mode (AND or OR)</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>3</td> </tr> <tr> <td>string $string to validate</td> <td>3</td> </tr> <tr> <td>string $key Key to translate</td> <td>3</td> </tr> <tr> <td>int $unique Is field unique or not</td> <td>3</td> </tr> <tr> <td>int $required Is field required or not</td> <td>3</td> </tr> <tr> <td>string $computed Computed value</td> <td>3</td> </tr> <tr> <td>array $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...)</td> <td>3</td> </tr> <tr> <td>string $key Key of attribute</td> <td>3</td> </tr> <tr> <td>string $outputdir Output directory for pdf file</td> <td>3</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>3</td> </tr> <tr> <td>int $rang Position</td> <td>3</td> </tr> <tr> <td>string $table_element name of association table</td> <td>3</td> </tr> <tr> <td>int $id Id of record</td> <td>3</td> </tr> <tr> <td>User $user User making creation</td> <td>3</td> </tr> <tr> <td>User $user User making update</td> <td>3</td> </tr> <tr> <td>int $id Id of record to load</td> <td>3</td> </tr> <tr> <td>User $user Object user that create</td> <td>3</td> </tr> <tr> <td>CommonObject $object Main object to use as data source</td> <td>3</td> </tr> <tr> <td>int $year year number</td> <td>3</td> </tr> <tr> <td>string $file Image file name to use to save onto disk (also used as javascript unique id)</td> <td>3</td> </tr> <tr> <td>User $user User that load</td> <td>3</td> </tr> <tr> <td>string $type Type of database (mysql, pgsql...). Not used.</td> <td>3</td> </tr> <tr> <td>string $database Name of database</td> <td>3</td> </tr> <tr> <td>string $query SQL query string</td> <td>3</td> </tr> <tr> <td>string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)</td> <td>3</td> </tr> <tr> <td>string $fieldid Field name</td> <td>3</td> </tr> <tr> <td>string $value Value to decrypt</td> <td>3</td> </tr> <tr> <td>string $database Database name to create</td> <td>3</td> </tr> <tr> <td>string $charset Charset used to store data</td> <td>3</td> </tr> <tr> <td>string $collation Charset used to sort data</td> <td>3</td> </tr> <tr> <td>string $owner Username of database owner</td> <td>3</td> </tr> <tr> <td>string $table Name of table</td> <td>3</td> </tr> <tr> <td>array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> $fields Tableau associatif [nom champ][tableau des descriptions]</td> <td>3</td> </tr> <tr> <td>string $primary_key Nom du champ qui sera la clef primaire</td> <td>3</td> </tr> <tr> <td>string $type Type de la table</td> <td>3</td> </tr> <tr> <td>array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur</td> <td>3</td> </tr> <tr> <td>array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext</td> <td>3</td> </tr> <tr> <td>array $keys Tableau des champs cles noms => valeur</td> <td>3</td> </tr> <tr> <td>string $table Name of table</td> <td>3</td> </tr> <tr> <td>string $field Optionnel : Name of field if we want description of field</td> <td>3</td> </tr> <tr> <td>string $field_name Name of field to modify</td> <td>3</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $field_desc Array with description of field format</td> <td>3</td> </tr> <tr> <td>string $field_name Name of field to drop</td> <td>3</td> </tr> <tr> <td>string $dolibarr_main_db_name Database name where user must be granted</td> <td>3</td> </tr> <tr> <td>mysqli_result $resultset Curseur de la requete voulue</td> <td>3</td> </tr> <tr> <td>string $sql Requete sql de comptage</td> <td>3</td> </tr> <tr> <td>Societe $objsoc Third party object</td> <td>3</td> </tr> <tr> <td>Expedition $object Object to show</td> <td>3</td> </tr> <tr> <td>Expedition $object Object to show</td> <td>3</td> </tr> <tr> <td>Translate $outputlangs langs</td> <td>3</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>3</td> </tr> <tr> <td>int $showaddress 0=no, 1=yes</td> <td>3</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>3</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text</td> <td>3</td> </tr> <tr> <td>Societe $objsoc Object thirdparty</td> <td>3</td> </tr> <tr> <td>Product $objprod Object product</td> <td>3</td> </tr> <tr> <td>Object $object Object to show</td> <td>3</td> </tr> <tr> <td>string $password Password to check</td> <td>3</td> </tr> <tr> <td>Conf $conf Handler de conf</td> <td>3</td> </tr> <tr> <td>Translate $langs Handler de langue</td> <td>3</td> </tr> <tr> <td>User $user Handler du user connected</td> <td>3</td> </tr> <tr> <td>Commande $object Object to show</td> <td>3</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>3</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>3</td> </tr> <tr> <td>Commande $object Object source to build document</td> <td>3</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>3</td> </tr> <tr> <td>Facture $objforref Object for number to search</td> <td>3</td> </tr> <tr> <td>int $deja_regle Amount already paid (in the currency of invoice)</td> <td>3</td> </tr> <tr> <td>int $posy Position y in PDF</td> <td>3</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>3</td> </tr> <tr> <td>Propal $object Object proposal</td> <td>3</td> </tr> <tr> <td>Adherent $object Object we need next value for</td> <td>3</td> </tr> <tr> <td>Translate $outputlangs translation object</td> <td>3</td> </tr> <tr> <td>string $array_key key for array</td> <td>3</td> </tr> <tr> <td>string $module module</td> <td>3</td> </tr> <tr> <td>DoliDB $db Database object</td> <td>3</td> </tr> <tr> <td>Societe $soc Object third party</td> <td>3</td> </tr> <tr> <td>int $type 0 = customer/prospect , 1 = supplier</td> <td>3</td> </tr> <tr> <td>string $code Code a verifier</td> <td>3</td> </tr> <tr> <td>DoliDB $dbs Database handler</td> <td>3</td> </tr> <tr> <td>int $type -1=Nothing, 0=Customer, 1=Supplier</td> <td>3</td> </tr> <tr> <td>Product|string $objproduct Object product</td> <td>3</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>3</td> </tr> <tr> <td>CommandeFournisseur $object Object to show</td> <td>3</td> </tr> <tr> <td>CommandeFournisseur $object Object to show</td> <td>3</td> </tr> <tr> <td>Project $object Object project a generer</td> <td>3</td> </tr> <tr> <td>Project $object Object to show</td> <td>3</td> </tr> <tr> <td>TCPDF $pdf PDF reference</td> <td>3</td> </tr> <tr> <td>string $newvalue String to clean</td> <td>3</td> </tr> <tr> <td>Translate $outputlangs Object lang to translate values</td> <td>3</td> </tr> <tr> <td>int $max Maximum number of records to load</td> <td>3</td> </tr> <tr> <td>int $nooutput No print, only return string</td> <td>3</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>3</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>3</td> </tr> <tr> <td>int $limit Limit for list</td> <td>3</td> </tr> <tr> <td>int $page Page number</td> <td>3</td> </tr> <tr> <td>array $request_data InvoiceLine data</td> <td>3</td> </tr> <tr> <td>array $data Datas to validate</td> <td>3</td> </tr> <tr> <td>int $addlinktonotes Add link to show notes</td> <td>3</td> </tr> <tr> <td>string $comment Comment</td> <td>3</td> </tr> <tr> <td>User $user Object utilisateur qui modifie</td> <td>3</td> </tr> <tr> <td>Societe $soc object company</td> <td>3</td> </tr> <tr> <td>string $close_code Code of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)</td> <td>3</td> </tr> <tr> <td>string $close_note Comment</td> <td>3</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>3</td> </tr> <tr> <td>string $option Where point the link</td> <td>3</td> </tr> <tr> <td>int $max Maxlength of ref</td> <td>3</td> </tr> <tr> <td>int $frequency value of frequency</td> <td>3</td> </tr> <tr> <td>string $unit unit of frequency (d, m, y)</td> <td>3</td> </tr> <tr> <td>datetime $date date of execution</td> <td>3</td> </tr> <tr> <td>int $increment_nb_gen_done 0 do nothing more, >0 increment nb_gen_done</td> <td>3</td> </tr> <tr> <td>int $nb number of maximum period</td> <td>3</td> </tr> <tr> <td>int $rowid Id of third party to load</td> <td>3</td> </tr> <tr> <td>string $ref Reference of third party, name (Warning, this can return several records)</td> <td>3</td> </tr> <tr> <td>string $ref_ext External reference of third party (Warning, this information is a free field not provided by Dolibarr)</td> <td>3</td> </tr> <tr> <td>string $barcode Barcode of third party to load</td> <td>3</td> </tr> <tr> <td>string $email Email of third party (Warning, this can return several records)</td> <td>3</td> </tr> <tr> <td>string $ref_alias Name_alias of third party (Warning, this can return several records)</td> <td>3</td> </tr> <tr> <td>int $id Order ID</td> <td>3</td> </tr> <tr> <td>int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id</td> <td>3</td> </tr> <tr> <td>int $id ID of order</td> <td>3</td> </tr> <tr> <td>int $contactid Id of contact to add</td> <td>3</td> </tr> <tr> <td>string $type Type of the contact (BILLING, SHIPPING, CUSTOMER)</td> <td>3</td> </tr> <tr> <td>int $id Id of the order</td> <td>3</td> </tr> <tr> <td>int $id Order ID</td> <td>3</td> </tr> <tr> <td>Object $object Object to clean</td> <td>3</td> </tr> <tr> <td>Societe $soc Object thirdparty</td> <td>3</td> </tr> <tr> <td>int $year Year to scan</td> <td>3</td> </tr> <tr> <td>User $user User making payment</td> <td>3</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto</td> <td>3</td> </tr> <tr> <td>string $ref Ref</td> <td>3</td> </tr> <tr> <td>int $id id object</td> <td>3</td> </tr> <tr> <td>int $id ID of account</td> <td>3</td> </tr> <tr> <td>double $qty Quantite</td> <td>3</td> </tr> <tr> <td>int $special_code Special code</td> <td>3</td> </tr> <tr> <td>string $label Label of the line</td> <td>3</td> </tr> <tr> <td>string $fk_unit Unit</td> <td>3</td> </tr> <tr> <td>int $notrigger disable line update trigger</td> <td>3</td> </tr> <tr> <td>User $user Object user that create</td> <td>3</td> </tr> <tr> <td>double $txlocaltax1 Local tax 1 rate</td> <td>3</td> </tr> <tr> <td>double $txlocaltax2 Local tax 2 rate</td> <td>3</td> </tr> <tr> <td>int $fk_parent_line Id of parent line (0 in most cases, used by modules adding sublevels into lines).</td> <td>3</td> </tr> <tr> <td>int $skip_update_total Keep fields total_xxx to 0 (used for special lines by some modules)</td> <td>3</td> </tr> <tr> <td>int $pa_ht Price (without tax) of product when it was bought</td> <td>3</td> </tr> <tr> <td>string $type 'direct-debit' or 'bank-transfer'</td> <td>3</td> </tr> <tr> <td>int $fk_bank_account Bank account ID the receipt is generated for. Will use the ID into the setup of module Direct Debit or Credit Transfer if 0.</td> <td>3</td> </tr> <tr> <td>string $email_msgid Email msgid</td> <td>3</td> </tr> <tr> <td>string $note Complete private note with this note</td> <td>3</td> </tr> <tr> <td>int $limit Limit</td> <td>3</td> </tr> <tr> <td>int $id Id of Expense Report to update</td> <td>3</td> </tr> <tr> <td>resource|string|callable $body</td> <td>3</td> </tr> <tr> <td>string[] $paths</td> <td>3</td> </tr> <tr> <td>string $reportName</td> <td>3</td> </tr> <tr> <td>int $depth</td> <td>3</td> </tr> <tr> <td>int $status</td> <td>3</td> </tr> <tr> <td>string $uri</td> <td>3</td> </tr> <tr> <td>Exception $e</td> <td>3</td> </tr> <tr> <td>1|0 $depth</td> <td>3</td> </tr> <tr> <td>string $methodName</td> <td>3</td> </tr> <tr> <td>string $href</td> <td>3</td> </tr> <tr> <td>string $assetName</td> <td>3</td> </tr> <tr> <td>string $destination</td> <td>3</td> </tr> <tr> <td>mixed $subscriptionId</td> <td>3</td> </tr> <tr> <td>mixed $objects</td> <td>3</td> </tr> <tr> <td>int $options</td> <td>3</td> </tr> <tr> <td>string|array|null $value</td> <td>3</td> </tr> <tr> <td>resource $input</td> <td>3</td> </tr> <tr> <td>resource|string $input</td> <td>3</td> </tr> <tr> <td>$startxref (int) Offset at which the xref section starts.</td> <td>3</td> </tr> <tr> <td>$align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td> <td>3</td> </tr> <tr> <td>$x (float) The value of the abscissa in user units.</td> <td>3</td> </tr> <tr> <td>$rtloff (boolean) if true always uses the page top-left corner as origin of axis.</td> <td>3</td> </tr> <tr> <td>$w (int) Width of a single rectangle element in pixels.</td> <td>3</td> </tr> <tr> <td>$h (int) Height of a single rectangle element in pixels.</td> <td>3</td> </tr> <tr> <td>$w (int) Width of a single bar element in pixels.</td> <td>3</td> </tr> <tr> <td>$h (int) Height of a single bar element in pixels.</td> <td>3</td> </tr> <tr> <td>$font (array) font data</td> <td>3</td> </tr> <tr> <td>$orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td> <td>3</td> </tr> <tr> <td>$x (int) abscissa of the point. Default is current x position</td> <td>3</td> </tr> <tr> <td>$y (int) ordinate of the point. Default is current y position</td> <td>3</td> </tr> <tr> <td>$x (int) abscissa of the skewing center. default is current x position</td> <td>3</td> </tr> <tr> <td>$y (int) ordinate of the skewing center. default is current y position</td> <td>3</td> </tr> <tr> <td>$x1 (float) Abscissa of control point 1.</td> <td>3</td> </tr> <tr> <td>$y1 (float) Ordinate of control point 1.</td> <td>3</td> </tr> <tr> <td>$x2 (float) Abscissa of control point 2.</td> <td>3</td> </tr> <tr> <td>$y2 (float) Ordinate of control point 2.</td> <td>3</td> </tr> <tr> <td>$fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).</td> <td>3</td> </tr> <tr> <td>$margin (float) The margin.</td> <td>3</td> </tr> <tr> <td>$page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.</td> <td>3</td> </tr> <tr> <td>$w (float) Width of the rectangle</td> <td>3</td> </tr> <tr> <td>$h (float) Height of the rectangle</td> <td>3</td> </tr> <tr> <td>$type (string) Type of object affected by this color: ('draw', 'fill', 'text').</td> <td>3</td> </tr> <tr> <td>$tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).</td> <td>3</td> </tr> <tr> <td>$color (array) Array of colors (1, 3 or 4 values).</td> <td>3</td> </tr> <tr> <td>$w (float) Width of the signature area.</td> <td>3</td> </tr> <tr> <td>$h (float) Height of the signature area.</td> <td>3</td> </tr> <tr> <td>$page (int) option page number (if < 0 the current page is used).</td> <td>3</td> </tr> <tr> <td>$name (string) Name of the signature.</td> <td>3</td> </tr> <tr> <td>$txt (string) String to print</td> <td>3</td> </tr> <tr> <td>$ignore_min_height (boolean) if true ignore automatic minimum height value.</td> <td>3</td> </tr> <tr> <td>$h (float) Cell height. Default value: 0.</td> <td>3</td> </tr> <tr> <td>$w (float) Cell width. If 0, the cell extends up to the right margin.</td> <td>3</td> </tr> <tr> <td>$w (float) Width of cells. If 0, they extend up to the right margin of the page.</td> <td>3</td> </tr> <tr> <td>$reseth (boolean) if true reset the last cell height (default false).</td> <td>3</td> </tr> <tr> <td>$width (float) width of the containing element</td> <td>3</td> </tr> <tr> <td>$cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).</td> <td>3</td> </tr> <tr> <td>$image (string) image key</td> <td>3</td> </tr> <tr> <td>$font (string) font key</td> <td>3</td> </tr> <tr> <td>$str (string) string to trim</td> <td>3</td> </tr> <tr> <td>$replace (string) string that replace spaces.</td> <td>3</td> </tr> <tr> <td>$parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.</td> <td>3</td> </tr> <tr> <td>$unicode (boolean) True if we are in unicode mode, false otherwise.</td> <td>3</td> </tr> <tr> <td>$str (string) String from where to extract value.</td> <td>3</td> </tr> <tr> <td>$offset (int) Point from where to read the data.</td> <td>3</td> </tr> <tr> <td>$c (int) UTF-8 value</td> <td>3</td> </tr> <tr> <td>$unicode (array) array containing UTF-8 unicode values</td> <td>3</td> </tr> <tr> <td>$str (string) string to process.</td> <td>3</td> </tr> <tr> <td>$isunicode (boolean) True when the documetn is in Unicode mode, false otherwise.</td> <td>3</td> </tr> <tr> <td>$isunicode (boolean) True if the document is in Unicode mode, false otherwise.</td> <td>3</td> </tr> <tr> <td>$frame (array)</td> <td>3</td> </tr> <tr> <td>$bitstream (array) original bitstream</td> <td>3</td> </tr> <tr> <td>UriInterface|null $baseApiUri</td> <td>3</td> </tr> <tr> <td>string|UriInterface $path</td> <td>3</td> </tr> <tr> <td>string $method HTTP method</td> <td>3</td> </tr> <tr> <td>string $state</td> <td>3</td> </tr> <tr> <td>string $accessToken</td> <td>3</td> </tr> <tr> <td>string $refreshToken</td> <td>3</td> </tr> <tr> <td>int $port</td> <td>3</td> </tr> <tr> <td>string $fragment</td> <td>3</td> </tr> <tr> <td>UriInterface $endpoint</td> <td>3</td> </tr> <tr> <td>mixed $requestBody</td> <td>3</td> </tr> <tr> <td>array $extraHeaders</td> <td>3</td> </tr> <tr> <td>string $method</td> <td>3</td> </tr> <tr> <td>bool $state</td> <td>3</td> </tr> <tr> <td>int $pIndex</td> <td>3</td> </tr> <tr> <td>int $pIndex Index to cellXf</td> <td>3</td> </tr> <tr> <td>int $pNumCols Number of columns to insert</td> <td>3</td> </tr> <tr> <td>int $pNumCols Number of columns to increment</td> <td>3</td> </tr> <tr> <td>int $pNumRows Number of rows to increment</td> <td>3</td> </tr> <tr> <td>string $value UTF-8 encoded string</td> <td>3</td> </tr> <tr> <td>string $line</td> <td>3</td> </tr> <tr> <td>int $code</td> <td>3</td> </tr> <tr> <td>string $pColumn Column name (e.g. A)</td> <td>3</td> </tr> <tr> <td>int $endRow Optionally, the row number at which to stop iterating</td> <td>3</td> </tr> <tr> <td>int $endRow The row number at which to stop iterating</td> <td>3</td> </tr> <tr> <td>string $endColumn Optionally, the column address at which to stop iterating</td> <td>3</td> </tr> <tr> <td>string $endColumn The column address at which to stop iterating</td> <td>3</td> </tr> <tr> <td>int $width</td> <td>3</td> </tr> <tr> <td>string $pCoordinate Coordinate of the cell, eg: 'A1'</td> <td>3</td> </tr> <tr> <td>string $pRange Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")</td> <td>3</td> </tr> <tr> <td>array $pValue</td> <td>3</td> </tr> <tr> <td>mixed $nullValue Value returned in the array entry if a cell doesn't exist</td> <td>3</td> </tr> <tr> <td>bool $calculateFormulas Should formulas be calculated?</td> <td>3</td> </tr> <tr> <td>bool $formatData Should formatting be applied to cell values?</td> <td>3</td> </tr> <tr> <td>bool $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero</td> <td>3</td> </tr> <tr> <td>null|int $pValue</td> <td>3</td> </tr> <tr> <td>int $index Identifier for a specific print area range if several ranges have been set</td> <td>3</td> </tr> <tr> <td>null|Layout $layout</td> <td>3</td> </tr> <tr> <td>string $parameter</td> <td>3</td> </tr> <tr> <td>string $cell</td> <td>3</td> </tr> <tr> <td>int $pValue Value in pixels</td> <td>3</td> </tr> <tr> <td>resource $fh file handle</td> <td>3</td> </tr> <tr> <td>int $index The index for the PPS</td> <td>3</td> </tr> <tr> <td>Matrix $B Matrix B</td> <td>3</td> </tr> <tr> <td>string $subject</td> <td>3</td> </tr> <tr> <td>mixed $pValue Value</td> <td>3</td> </tr> <tr> <td>Cell $pCell The current cell (containing this formula)</td> <td>3</td> </tr> <tr> <td>mixed $endDate Excel date serial value (float), PHP date timestamp (integer),</td> <td>3</td> </tr> <tr> <td>mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),</td> <td>3</td> </tr> <tr> <td>mixed $issue The security's issue date</td> <td>3</td> </tr> <tr> <td>int $price The security's price per $100 face value</td> <td>3</td> </tr> <tr> <td>int $redemption The security's redemption value per $100 face value</td> <td>3</td> </tr> <tr> <td>mixed $settlement The Treasury bill's settlement date.</td> <td>3</td> </tr> <tr> <td>mixed $maturity The Treasury bill's maturity date.</td> <td>3</td> </tr> <tr> <td>null|Cell $pCell</td> <td>3</td> </tr> <tr> <td>Worksheet $pSheet Worksheet</td> <td>3</td> </tr> <tr> <td>string $mixedCaseString</td> <td>3</td> </tr> <tr> <td>mixed $k</td> <td>3</td> </tr> <tr> <td>mixed $aArgs Data values</td> <td>3</td> </tr> <tr> <td>float $alpha Parameter to the distribution</td> <td>3</td> </tr> <tr> <td>float $beta Parameter to the distribution</td> <td>3</td> </tr> <tr> <td>mixed $yValues array of mixed Data Series Y</td> <td>3</td> </tr> <tr> <td>int $ord The order of the Bessel function. If n is not an integer, it is truncated.</td> <td>3</td> </tr> <tr> <td>string $x The binary number (as a string) that you want to convert. The number</td> <td>3</td> </tr> <tr> <td>string $x The decimal integer you want to convert. If number is negative,</td> <td>3</td> </tr> <tr> <td>int $number1</td> <td>3</td> </tr> <tr> <td>int $number2</td> <td>3</td> </tr> <tr> <td>float $significance Significance</td> <td>3</td> </tr> <tr> <td>array of mixed Data Series</td> <td>3</td> </tr> <tr> <td>float $number Number</td> <td>3</td> </tr> <tr> <td>mixed[] $matrixData1 Matrix #1</td> <td>3</td> </tr> <tr> <td>mixed[] $matrixData2 Matrix #2</td> <td>3</td> </tr> <tr> <td>mixed $lookup_value The value that you want to match in lookup_array</td> <td>3</td> </tr> <tr> <td>Spreadsheet $spreadsheet PhpSpreadsheet object</td> <td>3</td> </tr> <tr> <td>Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet</td> <td>3</td> </tr> <tr> <td>int $row Row index (0-based)</td> <td>3</td> </tr> <tr> <td>int $col Column index (0-based)</td> <td>3</td> </tr> <tr> <td>int $pSheetId</td> <td>3</td> </tr> <tr> <td>bool $includeCharts Flag indicating if we should include drawing details for charts</td> <td>3</td> </tr> <tr> <td>bool $includeCharts Flag indicating if we should write charts</td> <td>3</td> </tr> <tr> <td>Fill $pFill Fill style</td> <td>3</td> </tr> <tr> <td>int $level</td> <td>3</td> </tr> <tr> <td>mixed $ignoredChars</td> <td>3</td> </tr> <tr> <td>string $chars</td> <td>3</td> </tr> <tr> <td>int $charOffset</td> <td>3</td> </tr> <tr> <td>Swift_Mime_SimpleMessage $message The message to store</td> <td>3</td> </tr> <tr> <td>Swift_Transport $transport A transport instance</td> <td>3</td> </tr> <tr> <td>string[] $failedRecipients An array of failures by-reference</td> <td>3</td> </tr> <tr> <td>string|Swift_OutputByteStream $data</td> <td>3</td> </tr> <tr> <td>string $filename</td> <td>3</td> </tr> <tr> <td>int $code</td> <td>3</td> </tr> <tr> <td>int $byteOffset</td> <td>3</td> </tr> <tr> <td>string $command</td> <td>3</td> </tr> <tr> <td>int[] $codes</td> <td>3</td> </tr> <tr> <td>string[] $failures An array of failures by-reference</td> <td>3</td> </tr> <tr> <td>string[] $parameters</td> <td>3</td> </tr> <tr> <td>string $challenge</td> <td>3</td> </tr> <tr> <td>int $size</td> <td>3</td> </tr> <tr> <td>int $timePassed</td> <td>3</td> </tr> <tr> <td>Swift_CharacterStream $charStream to use for reading characters</td> <td>3</td> </tr> <tr> <td>int $firstLineOffset optional</td> <td>3</td> </tr> <tr> <td>int $firstLineOffset</td> <td>3</td> </tr> <tr> <td>string|null $charset</td> <td>3</td> </tr> <tr> <td>array $params</td> <td>3</td> </tr> <tr> <td>string $name</td> <td>3</td> </tr> <tr> <td>int $index</td> <td>3</td> </tr> <tr> <td>mixed $model</td> <td>3</td> </tr> <tr> <td>int $firstLineOffset</td> <td>3</td> </tr> <tr> <td>int $firstLineOffset ignored</td> <td>3</td> </tr> <tr> <td>int $firstLineOffset ignored</td> <td>3</td> </tr> <tr> <td>string[] $mailboxes</td> <td>3</td> </tr> <tr> <td>string $model</td> <td>3</td> </tr> <tr> <td>string $buffer</td> <td>3</td> </tr> <tr> <td>Swift_InputByteStream $is to write the data to</td> <td>3</td> </tr> <tr> <td>bool $debug</td> <td>3</td> </tr> <tr> <td>string $header_name</td> <td>3</td> </tr> <tr> <td>string $headerName</td> <td>3</td> </tr> <tr> <td>string $value String to convert</td> <td>3</td> </tr> <tr> <td>string $filename the name of the archive to open</td> <td>3</td> </tr> <tr> <td>string $name the name of the file to extract</td> <td>3</td> </tr> <tr> <td>string $contents the content of the file</td> <td>3</td> </tr> <tr> <td>string $filename the path to the file we want to add</td> <td>3</td> </tr> <tr> <td>mixed $data</td> <td>3</td> </tr> <tr> <td>boolean $humanReadable</td> <td>3</td> </tr> <tr> <td>string $mime</td> <td>3</td> </tr> <tr> <td>int $size Size modifier for the image. Must be either `Printer::IMG_DEFAULT`</td> <td>3</td> </tr> <tr> <td>string $argument the name of the invalid parameter</td> <td>3</td> </tr> <tr> <td>int $value</td> <td>3</td> </tr> <tr> <td>string $target</td> <td>3</td> </tr> <tr> <td>int|float $value</td> <td>3</td> </tr> <tr> <td>string $unit</td> <td>3</td> </tr> <tr> <td>string|null $rounding Optional rounding 'floor', 'ceil', 'round' using the period interval.</td> <td>3</td> </tr> <tr> <td>callable|string $keyBy</td> <td>3</td> </tr> <tr> <td>string $unit</td> <td>3</td> </tr> <tr> <td>\Carbon\CarbonPeriod|\DatePeriod|string $period</td> <td>3</td> </tr> <tr> <td>array $options (path, query, fragment, pageName)</td> <td>3</td> </tr> <tr> <td>array $keys</td> <td>3</td> </tr> <tr> <td>\Illuminate\Pagination\Cursor|null $cursor</td> <td>3</td> </tr> <tr> <td>\ArrayAccess|\stdClass $item</td> <td>3</td> </tr> <tr> <td>mixed $object</td> <td>3</td> </tr> <tr> <td>array $payload</td> <td>3</td> </tr> <tr> <td>\DateTimeInterface|\DateInterval|int|null $ttl</td> <td>3</td> </tr> <tr> <td>string $group</td> <td>3</td> </tr> <tr> <td>array $replace</td> <td>3</td> </tr> <tr> <td>string $token</td> <td>3</td> </tr> <tr> <td>bool $remember</td> <td>3</td> </tr> <tr> <td>\Closure|null $callback</td> <td>3</td> </tr> <tr> <td>iterable|string $abilities</td> <td>3</td> </tr> <tr> <td>object|array|string $address</td> <td>3</td> </tr> <tr> <td>string $provider</td> <td>3</td> </tr> <tr> <td>\Illuminate\Support\Collection|array $jobs</td> <td>3</td> </tr> <tr> <td>string $hashedValue</td> <td>3</td> </tr> <tr> <td>\Closure|string $callback</td> <td>3</td> </tr> <tr> <td>string|null $domain</td> <td>3</td> </tr> <tr> <td>string $eventName</td> <td>3</td> </tr> <tr> <td>string $rule</td> <td>3</td> </tr> <tr> <td>string|array $keys</td> <td>3</td> </tr> <tr> <td>string|string[] $needles</td> <td>3</td> </tr> <tr> <td>string|array $pattern</td> <td>3</td> </tr> <tr> <td>string $encoding</td> <td>3</td> </tr> <tr> <td>int|array|\Countable $count</td> <td>3</td> </tr> <tr> <td>string $prefix</td> <td>3</td> </tr> <tr> <td>string $delimiter</td> <td>3</td> </tr> <tr> <td>callable $callable</td> <td>3</td> </tr> <tr> <td>string $characters</td> <td>3</td> </tr> <tr> <td>array $chain</td> <td>3</td> </tr> <tr> <td>string|\Closure $job</td> <td>3</td> </tr> <tr> <td>string|\Closure $notification</td> <td>3</td> </tr> <tr> <td>int $from</td> <td>3</td> </tr> <tr> <td>int $to</td> <td>3</td> </tr> <tr> <td>array|callable|string $groupBy</td> <td>3</td> </tr> <tr> <td>bool $preserveKeys</td> <td>3</td> </tr> <tr> <td>string|null $glue</td> <td>3</td> </tr> <tr> <td>string $glue</td> <td>3</td> </tr> <tr> <td>string $finalGlue</td> <td>3</td> </tr> <tr> <td>iterable $source</td> <td>3</td> </tr> <tr> <td>mixed ...$items</td> <td>3</td> </tr> <tr> <td>mixed $initial</td> <td>3</td> </tr> <tr> <td>boolean $strict</td> <td>3</td> </tr> <tr> <td>string $raw_header</td> <td>3</td> </tr> <tr> <td>int $uid</td> <td>3</td> </tr> <tr> <td>boolean $fetch_body</td> <td>3</td> </tr> <tr> <td>$option</td> <td>3</td> </tr> <tr> <td>string $folder_path</td> <td>3</td> </tr> <tr> <td>$config</td> <td>3</td> </tr> <tr> <td>$section</td> <td>3</td> </tr> <tr> <td>bool $cert_validation set to false to skip SSL certificate validation</td> <td>3</td> </tr> <tr> <td>string $password password</td> <td>3</td> </tr> <tr> <td>string $token access token</td> <td>3</td> </tr> <tr> <td>string $folder change to this folder</td> <td>3</td> </tr> <tr> <td>int|null $id message number</td> <td>3</td> </tr> <tr> <td>string $id uid</td> <td>3</td> </tr> <tr> <td>string $reference mailbox reference for list</td> <td>3</td> </tr> <tr> <td>int $from message for items or start message if $to !== null</td> <td>3</td> </tr> <tr> <td>string|null $mode '+' to add flags, '-' to remove flags, everything else sets the flags as given</td> <td>3</td> </tr> <tr> <td>bool $silent if false the return values are the new flags for the wanted messages</td> <td>3</td> </tr> <tr> <td>string $folder name of target folder</td> <td>3</td> </tr> <tr> <td>string $message full message content</td> <td>3</td> </tr> <tr> <td>array $flags flags for new message</td> <td>3</td> </tr> <tr> <td>string $date date for new message</td> <td>3</td> </tr> <tr> <td>string $old old name</td> <td>3</td> </tr> <tr> <td>string $new new name</td> <td>3</td> </tr> <tr> <td>$username</td> <td>3</td> </tr> <tr> <td>string $host hostname or IP address of IMAP server</td> <td>3</td> </tr> <tr> <td>Cursor $cursor The Cursor position in the dump</td> <td>3</td> </tr> <tr> <td>Cursor $cursor The Cursor position in the dump</td> <td>3</td> </tr> <tr> <td>bool $hasChild When the dump of the hash has child item</td> <td>3</td> </tr> <tr> <td>string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)</td> <td>3</td> </tr> <tr> <td>array $attrs associative array of attributes</td> <td>3</td> </tr> <tr> <td>string $data element content</td> <td>3</td> </tr> <tr> <td>string $data message data</td> <td>3</td> </tr> <tr> <td>integer $timeout set connection timeout in seconds</td> <td>3</td> </tr> <tr> <td>array $cookies cookies to send</td> <td>3</td> </tr> <tr> <td>string $authtype (basic|digest|certificate|ntlm)</td> <td>3</td> </tr> <tr> <td>string $proxyport</td> <td>3</td> </tr> <tr> <td>string $proxyusername</td> <td>3</td> </tr> <tr> <td>string $proxypassword</td> <td>3</td> </tr> <tr> <td>string $operation operation name</td> <td>3</td> </tr> <tr> <td>mixed $value a native PHP value (parameter value)</td> <td>3</td> </tr> <tr> <td>resource $parser XML parser object</td> <td>3</td> </tr> <tr> <td>string $wsdl The URL of the wsdl instance</td> <td>3</td> </tr> <tr> <td>mixed &$obj The object to add the part to, or</td> <td>3</td> </tr> <tr> <td>string $email The email direction to add</td> <td>3</td> </tr> <tr> <td>bool $partial defaults to false</td> <td>3</td> </tr> <tr> <td>string $id the ID of the account to which the external account belongs</td> <td>3</td> </tr> <tr> <td>string $id the ID of the account to which the person belongs</td> <td>3</td> </tr> <tr> <td>string $id the ID of the customer to which the payment source belongs</td> <td>3</td> </tr> <tr> <td>int $numRetries</td> <td>3</td> </tr> <tr> <td>null|int $httpStatus the HTTP status code</td> <td>3</td> </tr> <tr> <td>null|array $jsonBody the JSON deserialized body</td> <td>3</td> </tr> <tr> <td>null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array</td> <td>3</td> </tr> <tr> <td>null|string $stripeCode the Stripe error code</td> <td>3</td> </tr> <tr> <td>string $baseUrl</td> <td>3</td> </tr> <tr> <td>string $basePath</td> <td>3</td> </tr> <tr> <td>boolean $bind</td> <td>3</td> </tr> <tr> <td>DataFormatterInterface $formater</td> <td>3</td> </tr> <tr> <td>DebugBarVarDumper $varDumper</td> <td>3</td> </tr> <tr> <td>TraceablePDO $pdo</td> <td>3</td> </tr> <tr> <td>int $category_id Id of category</td> <td>3</td> </tr> <tr> <td>string $mode 'customer' or 'supplier'</td> <td>3</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>3</td> </tr> <tr> <td>int $limit Limit for list</td> <td>3</td> </tr> <tr> <td>int $page Page number</td> <td>3</td> </tr> <tr> <td>int $notrigger 1=Disable triggers</td> <td>3</td> </tr> <tr> <td>int<0,1> $notrigger 1 = disable triggers, 0 = enable triggers</td> <td>3</td> </tr> <tr> <td>User $user Object user that modify</td> <td>3</td> </tr> <tr> <td>int $status Status</td> <td>3</td> </tr> <tr> <td>string $note Comment</td> <td>3</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>3</td> </tr> <tr> <td>int $id Commercial proposal ID</td> <td>3</td> </tr> <tr> <td>int $id Id object</td> <td>3</td> </tr> <tr> <td>int $mode 0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Picto+Long label, 7=Very short label+Picto</td> <td>3</td> </tr> <tr> <td>int $includepermissions Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)</td> <td>3</td> </tr> <tr> <td>int $notrigger triggers after, 1=disable triggers</td> <td>3</td> </tr> <tr> <td>int $dateofvirtualstock Date of virtual stock</td> <td>3</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>3</td> </tr> <tr> <td>int $includestockdata Load also information about stock (slower)</td> <td>3</td> </tr> <tr> <td>bool $includesubproducts Load information about subproducts</td> <td>3</td> </tr> <tr> <td>bool $includeparentid Load also ID of parent product (if product is a variant of a parent product)</td> <td>3</td> </tr> <tr> <td>bool $includetrans Load also the translations of product label and description</td> <td>3</td> </tr> <tr> <td>int $id ID of Attribute value</td> <td>3</td> </tr> <tr> <td>string $modele force le modele a utiliser ('' to not force)</td> <td>3</td> </tr> <tr> <td>string $onlyFieldName [=''] check all fields by default or only one field name ("sellby", "eatby")</td> <td>3</td> </tr> <tr> <td>int $timespent_id Time spent ID (llx_element_time.rowid)</td> <td>3</td> </tr> <tr> <td>User $user Object user that modify</td> <td>3</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>3</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>3</td> </tr> <tr> <td>int $active Payment type is active or not {@min 0} {@max 1}</td> <td>3</td> </tr> <tr> <td>string $lang Code of the language the name of the country must be translated to</td> <td>3</td> </tr> <tr> <td>string $attrname extrafield attrname</td> <td>3</td> </tr> <tr> <td>string $elementtype extrafield elementtype</td> <td>3</td> </tr> <tr> <td>array $params Params to construct tooltip data</td> <td>3</td> </tr> <tr> <td>string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)</td> <td>3</td> </tr> <tr> <td>User|null $user User that modifies</td> <td>3</td> </tr> <tr> <td>string $ipAddress IPv4 or IPv6 address as a string. If no</td> <td>3</td> </tr> <tr> <td>Node $node A node</td> <td>3</td> </tr> <tr> <td>Node $node A node</td> <td>3</td> </tr> <tr> <td>Node $node Node to be parsed</td> <td>3</td> </tr> <tr> <td>int $id Id</td> <td>4</td> </tr> <tr> <td>string $resourceType Resource type</td> <td>4</td> </tr> <tr> <td>string $encoding Encoding</td> <td>4</td> </tr> <tr> <td>string $value Value</td> <td>4</td> </tr> <tr> <td>mixed $elements PHP Object to json encode</td> <td>4</td> </tr> <tr> <td>int $month Month</td> <td>4</td> </tr> <tr> <td>bool|int|string $gm False or 0 or 'tzserver' = Return date to compare with server TZ,</td> <td>4</td> </tr> <tr> <td>int $year Year number</td> <td>4</td> </tr> <tr> <td>string $pass Password</td> <td>4</td> </tr> <tr> <td>string $morecss More CSS</td> <td>4</td> </tr> <tr> <td>string $moreatt Add more attribute on img tag (For example 'style="float: right"')</td> <td>4</td> </tr> <tr> <td>string $parent Id of parent task to show (0 to show all)</td> <td>4</td> </tr> <tr> <td>User|null $fuser Restrict list to user if defined</td> <td>4</td> </tr> <tr> <td>int $level Level (start to 0, then increased/decrease by recursive call)</td> <td>4</td> </tr> <tr> <td>string $projectsrole Array of roles user has on project</td> <td>4</td> </tr> <tr> <td>string $tasksrole Array of roles user has on task</td> <td>4</td> </tr> <tr> <td>string $mine Show only task lines I am assigned to</td> <td>4</td> </tr> <tr> <td>array $isavailable Array with data that say if user is available for several days for morning and afternoon</td> <td>4</td> </tr> <tr> <td>int $oldprojectforbreak Old project id of last project break</td> <td>4</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>4</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>4</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>4</td> </tr> <tr> <td>mixed $target</td> <td>4</td> </tr> <tr> <td>stdClass $a First module</td> <td>4</td> </tr> <tr> <td>stdClass $b Second module</td> <td>4</td> </tr> <tr> <td>GeoIP $gi</td> <td>4</td> </tr> <tr> <td>int $lineid Id of line to delete</td> <td>4</td> </tr> <tr> <td>int $notrigger Disabled triggers</td> <td>4</td> </tr> <tr> <td>int $noextrafields 0=Default to load extrafields, 1=No extrafields</td> <td>4</td> </tr> <tr> <td>string $fieldKey Key of attribute</td> <td>4</td> </tr> <tr> <td>SimpleXMLElement $declaration Reference declaration</td> <td>4</td> </tr> <tr> <td>User $user User that create</td> <td>4</td> </tr> <tr> <td>string $targetmodule Name of directory of module where canvas is stored</td> <td>4</td> </tr> <tr> <td>string $canvas Name of canvas</td> <td>4</td> </tr> <tr> <td>string $card Name of tab (sub-canvas)</td> <td>4</td> </tr> <tr> <td>array|null $data Data to validate</td> <td>4</td> </tr> <tr> <td>User $user User making update</td> <td>4</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>4</td> </tr> <tr> <td>array $info Info array loaded by _load_ldap_info</td> <td>4</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>4</td> </tr> <tr> <td>int $category Use this param to filter list by category</td> <td>4</td> </tr> <tr> <td>User $user User that delete</td> <td>4</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>4</td> </tr> <tr> <td>string $table Name of table</td> <td>4</td> </tr> <tr> <td>string $table Name of table</td> <td>4</td> </tr> <tr> <td>string $table Name of table</td> <td>4</td> </tr> <tr> <td>User $user Object user making change</td> <td>4</td> </tr> <tr> <td>User $user Object user making change</td> <td>4</td> </tr> <tr> <td>string $moretitle Add more text to title tooltip</td> <td>4</td> </tr> <tr> <td>int $notrigger Do not execute trigger</td> <td>4</td> </tr> <tr> <td>array $arrayrecord Array of read values: [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=string), [fieldpos+1]...</td> <td>4</td> </tr> <tr> <td>array $listfields Fields list to add</td> <td>4</td> </tr> <tr> <td>int $record_key Record key</td> <td>4</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>4</td> </tr> <tr> <td>array<array{method:string,url:string,htmlname:string,params:array<string,string>}> $events Event options. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))</td> <td>4</td> </tr> <tr> <td>string $morecss More CSS</td> <td>4</td> </tr> <tr> <td>string $htmlname name of HTML select list</td> <td>4</td> </tr> <tr> <td>int $forcecombo Force to use combo box</td> <td>4</td> </tr> <tr> <td>string $morecss Add more css on select</td> <td>4</td> </tr> <tr> <td>string $morecss More css added to the select component</td> <td>4</td> </tr> <tr> <td>string $name Name of property</td> <td>4</td> </tr> <tr> <td>string $htmlname Name of field in form</td> <td>4</td> </tr> <tr> <td>int $showempty Add an empty field</td> <td>4</td> </tr> <tr> <td>string $a Server</td> <td>4</td> </tr> <tr> <td>string $morecss More CSS</td> <td>4</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>4</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>4</td> </tr> <tr> <td>Translate $langs Language object for translation of civility (used only if option is 1)</td> <td>4</td> </tr> <tr> <td>int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname</td> <td>4</td> </tr> <tr> <td>int $maxlen Maximum length</td> <td>4</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=execute triggers</td> <td>4</td> </tr> <tr> <td>string $trigger If defined, call also the trigger (for example COMPANY_MODIFY)</td> <td>4</td> </tr> <tr> <td>User $userused Object user</td> <td>4</td> </tr> <tr> <td>string $filtermode No more used</td> <td>4</td> </tr> <tr> <td>int $offset Offset</td> <td>4</td> </tr> <tr> <td>string $dn DN entry key</td> <td>4</td> </tr> <tr> <td>string $array_key Name of the key for return array</td> <td>4</td> </tr> <tr> <td>TCPDI|TCPDF $pdf Pdf object</td> <td>4</td> </tr> <tr> <td>string $colKey the column key</td> <td>4</td> </tr> <tr> <td>int $endyear Start year</td> <td>4</td> </tr> <tr> <td>int $startyear End year</td> <td>4</td> </tr> <tr> <td>int $cachedelay Delay we accept for cache file (0=No read, no save of cache, -1=No read but save)</td> <td>4</td> </tr> <tr> <td>int $limit Limit</td> <td>4</td> </tr> <tr> <td>int $mailing_id Id of emailing</td> <td>4</td> </tr> <tr> <td>Societe $objsoc Object thirdparty</td> <td>4</td> </tr> <tr> <td>string $code Code to check/correct</td> <td>4</td> </tr> <tr> <td>Product $product Object product</td> <td>4</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>4</td> </tr> <tr> <td>string $srctemplatepath Full path of source filename for generator using a template file</td> <td>4</td> </tr> <tr> <td>Don $don Donation object</td> <td>4</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>4</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>4</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>4</td> </tr> <tr> <td>Societe $soc Third party object</td> <td>4</td> </tr> <tr> <td>Translate $outputlangs Output langs</td> <td>4</td> </tr> <tr> <td>string $type 'customer' or 'supplier'</td> <td>4</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>4</td> </tr> <tr> <td>array $file file array</td> <td>4</td> </tr> <tr> <td>string $file Path of filename</td> <td>4</td> </tr> <tr> <td>array $head Array with properties of box title</td> <td>4</td> </tr> <tr> <td>array $contents Array with properties of box lines</td> <td>4</td> </tr> <tr> <td>int $asset_id Asset ID to set</td> <td>4</td> </tr> <tr> <td>int $asset_model_id Asset model ID to set</td> <td>4</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>4</td> </tr> <tr> <td>string $option Sur quoi pointe le lien</td> <td>4</td> </tr> <tr> <td>User $user User</td> <td>4</td> </tr> <tr> <td>int $notrigger No trigger</td> <td>4</td> </tr> <tr> <td>int $short 1=Return just URL</td> <td>4</td> </tr> <tr> <td>string $idprof1 Prof id 1 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>string $idprof2 Prof id 2 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>string $idprof3 Prof id 3 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>string $idprof4 Prof id 4 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>string $idprof5 Prof id 5 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>string $idprof6 Prof id 6 of third party (Warning, this can return several records)</td> <td>4</td> </tr> <tr> <td>array $request_data Datas</td> <td>4</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>4</td> </tr> <tr> <td>int $maxlen Longueur max libelle</td> <td>4</td> </tr> <tr> <td>int $line_id ID of account line</td> <td>4</td> </tr> <tr> <td>int $id Id of object to load</td> <td>4</td> </tr> <tr> <td>int $id Id of line to change</td> <td>4</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>4</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>4</td> </tr> <tr> <td>int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses</td> <td>4</td> </tr> <tr> <td>int $id Id of invoice</td> <td>4</td> </tr> <tr> <td>int $fk_product Product/Service ID predefined</td> <td>4</td> </tr> <tr> <td>int $rang Position of line</td> <td>4</td> </tr> <tr> <td>int $fk_fournprice Id of origin supplier price</td> <td>4</td> </tr> <tr> <td>int $notrigger Disable the trigger</td> <td>4</td> </tr> <tr> <td>string|array $filter Filter USF.</td> <td>4</td> </tr> <tr> <td>string $filtermode Filter mode (AND or OR)</td> <td>4</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>4</td> </tr> <tr> <td>string|int $status</td> <td>4</td> </tr> <tr> <td>resource $curlHandle</td> <td>4</td> </tr> <tr> <td>string $output</td> <td>4</td> </tr> <tr> <td>string|resource $data</td> <td>4</td> </tr> <tr> <td>array $properties</td> <td>4</td> </tr> <tr> <td>string $addressBookId</td> <td>4</td> </tr> <tr> <td>mixed $addressBookId</td> <td>4</td> </tr> <tr> <td>string $prefixPath</td> <td>4</td> </tr> <tr> <td>string $haystack</td> <td>4</td> </tr> <tr> <td>string $needle</td> <td>4</td> </tr> <tr> <td>array $propertyNames</td> <td>4</td> </tr> <tr> <td>string $tempLocation</td> <td>4</td> </tr> <tr> <td>bool $returnChildLocks</td> <td>4</td> </tr> <tr> <td>string $body</td> <td>4</td> </tr> <tr> <td>\Sabre\DAV\Xml\Element\Sharee[] $sharees</td> <td>4</td> </tr> <tr> <td>string $uid</td> <td>4</td> </tr> <tr> <td>string $calendarUri</td> <td>4</td> </tr> <tr> <td>string $description</td> <td>4</td> </tr> <tr> <td>int $offset</td> <td>4</td> </tr> <tr> <td>string $name</td> <td>4</td> </tr> <tr> <td>string|array $value</td> <td>4</td> </tr> <tr> <td>VCalendar $existingObject</td> <td>4</td> </tr> <tr> <td>string|array $rrule</td> <td>4</td> </tr> <tr> <td>string $packageName</td> <td>4</td> </tr> <tr> <td>$xref (array) Previous xref array (if any).</td> <td>4</td> </tr> <tr> <td>$offset (int) Object offset.</td> <td>4</td> </tr> <tr> <td>$msg (string) The error message</td> <td>4</td> </tr> <tr> <td>$w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.</td> <td>4</td> </tr> <tr> <td>$h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.</td> <td>4</td> </tr> <tr> <td>$palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td> <td>4</td> </tr> <tr> <td>$color (string) Foreground color (in SVG format) for bar elements (background is transparent).</td> <td>4</td> </tr> <tr> <td>$color (array) RGB (0-255) foreground color for bar elements (background is transparent).</td> <td>4</td> </tr> <tr> <td>$x (int) abscissa of the scaling center. Default is current x position</td> <td>4</td> </tr> <tr> <td>$y (int) ordinate of the scaling center. Default is current y position</td> <td>4</td> </tr> <tr> <td>$x (float) Abscissa of upper-left corner.</td> <td>4</td> </tr> <tr> <td>$y (float) Ordinate of upper-left corner.</td> <td>4</td> </tr> <tr> <td>$w (float) Width.</td> <td>4</td> </tr> <tr> <td>$h (float) Height.</td> <td>4</td> </tr> <tr> <td>$x3 (float) Abscissa of end point.</td> <td>4</td> </tr> <tr> <td>$y3 (float) Ordinate of end point.</td> <td>4</td> </tr> <tr> <td>$x0 (float) Abscissa of center point.</td> <td>4</td> </tr> <tr> <td>$y0 (float) Ordinate of center point.</td> <td>4</td> </tr> <tr> <td>$pagenum (int) page number (empty = current page)</td> <td>4</td> </tr> <tr> <td>$h (int) height</td> <td>4</td> </tr> <tr> <td>$ret (boolean) If true do not send the PDF command.</td> <td>4</td> </tr> <tr> <td>$col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).</td> <td>4</td> </tr> <tr> <td>$col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).</td> <td>4</td> </tr> <tr> <td>$col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).</td> <td>4</td> </tr> <tr> <td>$col4 (float) KEY (BLACK) color for CMYK (0-100).</td> <td>4</td> </tr> <tr> <td>$ret (boolean) If true do not send the command.</td> <td>4</td> </tr> <tr> <td>$align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul></td> <td>4</td> </tr> <tr> <td>$x (float) abscissa of the top left corner of the rectangle.</td> <td>4</td> </tr> <tr> <td>$page (int) page number</td> <td>4</td> </tr> <tr> <td>$str (string) string from where to extract value</td> <td>4</td> </tr> <tr> <td>$offset (int) point from where to read the data</td> <td>4</td> </tr> <tr> <td>$width (int)</td> <td>4</td> </tr> <tr> <td>$data (array)</td> <td>4</td> </tr> <tr> <td>string $responseBody</td> <td>4</td> </tr> <tr> <td>string $scheme</td> <td>4</td> </tr> <tr> <td>string $query</td> <td>4</td> </tr> <tr> <td>string $userInfo</td> <td>4</td> </tr> <tr> <td>string $pBefore Insert before this one</td> <td>4</td> </tr> <tr> <td>SimpleXMLElement $styleAttributes</td> <td>4</td> </tr> <tr> <td>$styleID</td> <td>4</td> </tr> <tr> <td>string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas</td> <td>4</td> </tr> <tr> <td>int $index</td> <td>4</td> </tr> <tr> <td>int $pos</td> <td>4</td> </tr> <tr> <td>bool $pAlreadyHashed If the password has already been hashed, set this to true</td> <td>4</td> </tr> <tr> <td>int $columnIndex2 Numeric column coordinate of the last cell</td> <td>4</td> </tr> <tr> <td>int $row2 Numeric row coordinate of the last cell</td> <td>4</td> </tr> <tr> <td>int $index Identifier for a specific print area range allowing several ranges to be set</td> <td>4</td> </tr> <tr> <td>int $xOffset</td> <td>4</td> </tr> <tr> <td>int $yOffset</td> <td>4</td> </tr> <tr> <td>string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE</td> <td>4</td> </tr> <tr> <td>bool $hex Flag indicating whether the component should be returned as a hex or a</td> <td>4</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font $font</td> <td>4</td> </tr> <tr> <td>int $property The number specifies the option</td> <td>4</td> </tr> <tr> <td>Cell $cell Cell to bind value to</td> <td>4</td> </tr> <tr> <td>mixed $value Value to bind in cell</td> <td>4</td> </tr> <tr> <td>string $pRange Cell range (e.g. A1:A1)</td> <td>4</td> </tr> <tr> <td>mixed $startDate Excel date serial value (float), PHP date timestamp (integer),</td> <td>4</td> </tr> <tr> <td>int $type A number 0 or 1 and indicates when payments are due:</td> <td>4</td> </tr> <tr> <td>int $nper Number of periods</td> <td>4</td> </tr> <tr> <td>string $formula</td> <td>4</td> </tr> <tr> <td>Cell $pCell Cell to calculate</td> <td>4</td> </tr> <tr> <td>string $value Value</td> <td>4</td> </tr> <tr> <td>int $chars Number of characters</td> <td>4</td> </tr> <tr> <td>float $degrees degrees of freedom</td> <td>4</td> </tr> <tr> <td>float $stdDev Standard Deviation</td> <td>4</td> </tr> <tr> <td>bool $const a logical value specifying whether to force the intersect to equal 0</td> <td>4</td> </tr> <tr> <td>float $mean Mean Value</td> <td>4</td> </tr> <tr> <td>float $x The value at which to evaluate the function.</td> <td>4</td> </tr> <tr> <td>int $number</td> <td>4</td> </tr> <tr> <td>string $pFilename Name of the file to save as</td> <td>4</td> </tr> <tr> <td>int $row Zero indexed row</td> <td>4</td> </tr> <tr> <td>int $col Zero indexed column</td> <td>4</td> </tr> <tr> <td>int $row1 Start row</td> <td>4</td> </tr> <tr> <td>int $col1 Start column</td> <td>4</td> </tr> <tr> <td>int $row2 End row</td> <td>4</td> </tr> <tr> <td>int $col2 End column</td> <td>4</td> </tr> <tr> <td>string $pText Text</td> <td>4</td> </tr> <tr> <td>float $payment</td> <td>4</td> </tr> <tr> <td>int $startOffset</td> <td>4</td> </tr> <tr> <td>array $currentMap</td> <td>4</td> </tr> <tr> <td>string $itemName</td> <td>4</td> </tr> <tr> <td>string $contentType</td> <td>4</td> </tr> <tr> <td>int $limit</td> <td>4</td> </tr> <tr> <td>string $contentType optional</td> <td>4</td> </tr> <tr> <td>string $domain</td> <td>4</td> </tr> <tr> <td>string $esmtpKeyword to compare with</td> <td>4</td> </tr> <tr> <td>string $response</td> <td>4</td> </tr> <tr> <td>string $entry</td> <td>4</td> </tr> <tr> <td>mixed $addresses</td> <td>4</td> </tr> <tr> <td>string $name optional</td> <td>4</td> </tr> <tr> <td>bool $ignoreErrors</td> <td>4</td> </tr> <tr> <td>array|object $data</td> <td>4</td> </tr> <tr> <td>bool $debug</td> <td>4</td> </tr> <tr> <td>array $data</td> <td>4</td> </tr> <tr> <td>DateTimeInterface|null $date</td> <td>4</td> </tr> <tr> <td>string|int|DateTimeZone $value</td> <td>4</td> </tr> <tr> <td>string|DateInterval|Closure|CarbonConverterInterface $unit</td> <td>4</td> </tr> <tr> <td>int $value</td> <td>4</td> </tr> <tr> <td>bool|null $overflow</td> <td>4</td> </tr> <tr> <td>int $value</td> <td>4</td> </tr> <tr> <td>bool|null $overflow</td> <td>4</td> </tr> <tr> <td>int $parts maximum number of parts to display (default value: 1: single part)</td> <td>4</td> </tr> <tr> <td>bool $equal Indicates if an equal to comparison should be done</td> <td>4</td> </tr> <tr> <td>string $locale</td> <td>4</td> </tr> <tr> <td>float|int|string $timestamp</td> <td>4</td> </tr> <tr> <td>\DateTimeZone|string|null $tz</td> <td>4</td> </tr> <tr> <td>float|int|string $timestamp</td> <td>4</td> </tr> <tr> <td>int $humanDiffOption</td> <td>4</td> </tr> <tr> <td>string $unit</td> <td>4</td> </tr> <tr> <td>array<int, mixed> $params</td> <td>4</td> </tr> <tr> <td>string|null $locale current locale used if null</td> <td>4</td> </tr> <tr> <td>int $precision</td> <td>4</td> </tr> <tr> <td>string|null $context whole format string</td> <td>4</td> </tr> <tr> <td>string|null $defaultValue default value if translation missing</td> <td>4</td> </tr> <tr> <td>string $key key to find</td> <td>4</td> </tr> <tr> <td>string|null $locale current locale used if null</td> <td>4</td> </tr> <tr> <td>string|null $default default value if translation returns the key</td> <td>4</td> </tr> <tr> <td>bool $checkMicroseconds check time at microseconds precision</td> <td>4</td> </tr> <tr> <td>int|null $week</td> <td>4</td> </tr> <tr> <td>int|null $dayOfYear</td> <td>4</td> </tr> <tr> <td>int|null $year if null, act as a getter, if not null, set the year and return current instance.</td> <td>4</td> </tr> <tr> <td>int|null $value new value for weekday if using as setter.</td> <td>4</td> </tr> <tr> <td>string $name</td> <td>4</td> </tr> <tr> <td>mixed $var</td> <td>4</td> </tr> <tr> <td>string|int|null $modifier</td> <td>4</td> </tr> <tr> <td>string|DateTimeInterface|null $time</td> <td>4</td> </tr> <tr> <td>string $function</td> <td>4</td> </tr> <tr> <td>Carbon|DateTimeInterface $date now if null</td> <td>4</td> </tr> <tr> <td>int $hour</td> <td>4</td> </tr> <tr> <td>int $minute</td> <td>4</td> </tr> <tr> <td>int $second</td> <td>4</td> </tr> <tr> <td>string $locale</td> <td>4</td> </tr> <tr> <td>float|int|string $unixTimestamp</td> <td>4</td> </tr> <tr> <td>CarbonInterval|DateInterval|mixed $interval1</td> <td>4</td> </tr> <tr> <td>CarbonInterval|DateInterval|mixed $interval2</td> <td>4</td> </tr> <tr> <td>array $messages</td> <td>4</td> </tr> <tr> <td>array $filters</td> <td>4</td> </tr> <tr> <td>string $unit</td> <td>4</td> </tr> <tr> <td>int $start</td> <td>4</td> </tr> <tr> <td>string|null $fragment</td> <td>4</td> </tr> <tr> <td>array|string|null $key</td> <td>4</td> </tr> <tr> <td>string|null $value</td> <td>4</td> </tr> <tr> <td>string $view</td> <td>4</td> </tr> <tr> <td>\Illuminate\Contracts\Foundation\Application $app</td> <td>4</td> </tr> <tr> <td>string $payload</td> <td>4</td> </tr> <tr> <td>array|string $key</td> <td>4</td> </tr> <tr> <td>int $seconds</td> <td>4</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Authenticatable $user</td> <td>4</td> </tr> <tr> <td>mixed $users</td> <td>4</td> </tr> <tr> <td>mixed $callback</td> <td>4</td> </tr> <tr> <td>array $map</td> <td>4</td> </tr> <tr> <td>string $from</td> <td>4</td> </tr> <tr> <td>string $to</td> <td>4</td> </tr> <tr> <td>string|null $directory</td> <td>4</td> </tr> <tr> <td>\Closure|string|null $concrete</td> <td>4</td> </tr> <tr> <td>\Closure $closure</td> <td>4</td> </tr> <tr> <td>string $type</td> <td>4</td> </tr> <tr> <td>string|null $path</td> <td>4</td> </tr> <tr> <td>mixed $parameters</td> <td>4</td> </tr> <tr> <td>string|object $event</td> <td>4</td> </tr> <tr> <td>\Throwable $e</td> <td>4</td> </tr> <tr> <td>string $end</td> <td>4</td> </tr> <tr> <td>string $replace</td> <td>4</td> </tr> <tr> <td>string $offset</td> <td>4</td> </tr> <tr> <td>\Illuminate\Contracts\Container\Container $container</td> <td>4</td> </tr> <tr> <td>string $driver</td> <td>4</td> </tr> <tr> <td>array|string $keys</td> <td>4</td> </tr> <tr> <td>\ReflectionParameter $parameter</td> <td>4</td> </tr> <tr> <td>array $url</td> <td>4</td> </tr> <tr> <td>string $mailable</td> <td>4</td> </tr> <tr> <td>string|array $value</td> <td>4</td> </tr> <tr> <td>int|null $number</td> <td>4</td> </tr> <tr> <td>int|null $seed</td> <td>4</td> </tr> <tr> <td>\ArrayAccess|array $array</td> <td>4</td> </tr> <tr> <td>array $arguments</td> <td>4</td> </tr> <tr> <td>$mask</td> <td>4</td> </tr> <tr> <td>integer $uid</td> <td>4</td> </tr> <tr> <td>string|array $flag</td> <td>4</td> </tr> <tr> <td>string $quota_root</td> <td>4</td> </tr> <tr> <td>string $soapmsg The SOAP payload</td> <td>4</td> </tr> <tr> <td>string $string debug data</td> <td>4</td> </tr> <tr> <td>string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)</td> <td>4</td> </tr> <tr> <td>integer $response_timeout set response timeout in seconds</td> <td>4</td> </tr> <tr> <td>callable $readBodyChunkCallable</td> <td>4</td> </tr> <tr> <td>null|string $nestedId</td> <td>4</td> </tr> <tr> <td>string $method HTTP method ('get', 'post', etc.)</td> <td>4</td> </tr> <tr> <td>string $url URL for the request</td> <td>4</td> </tr> <tr> <td>array $params list of parameters for the request</td> <td>4</td> </tr> <tr> <td>string $message the exception message</td> <td>4</td> </tr> <tr> <td>null|string $httpBody the HTTP body as a string</td> <td>4</td> </tr> <tr> <td>string $targetFilename</td> <td>4</td> </tr> <tr> <td>mixed $key</td> <td>4</td> </tr> <tr> <td>int $id ID of the thirdparty</td> <td>4</td> </tr> <tr> <td>string $label ???</td> <td>4</td> </tr> <tr> <td>int $withpicto Add picto into link</td> <td>4</td> </tr> <tr> <td>string $orderBy [='e.ref'] Order by</td> <td>4</td> </tr> <tr> <td>int $status Id status</td> <td>4</td> </tr> <tr> <td>int $id Task ID</td> <td>4</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>4</td> </tr> <tr> <td>array $data Data to validate</td> <td>4</td> </tr> <tr> <td>DoliDb $db Database handler</td> <td>4</td> </tr> <tr> <td>BinaryOpManipulator $binaryOpManipulator The $binaryOpManipulator</td> <td>4</td> </tr> <tr> <td>BooleanAnd $booleanAnd A BooleandAnd</td> <td>4</td> </tr> <tr> <td>int $id Id of object</td> <td>5</td> </tr> <tr> <td>int $socid (Optional) Show only results from the customer with this id</td> <td>5</td> </tr> <tr> <td>string $morecss More CSS</td> <td>5</td> </tr> <tr> <td>string $host Address of database server</td> <td>5</td> </tr> <tr> <td>int $port Port of database server</td> <td>5</td> </tr> <tr> <td>string $file</td> <td>5</td> </tr> <tr> <td>int $delivery_date Delivery date</td> <td>5</td> </tr> <tr> <td>object $object common object</td> <td>5</td> </tr> <tr> <td>int $lineid Id of line to delete</td> <td>5</td> </tr> <tr> <td>int $year year for stats</td> <td>5</td> </tr> <tr> <td>User $user User that deletes</td> <td>5</td> </tr> <tr> <td>array $params Params to construct tooltip data</td> <td>5</td> </tr> <tr> <td>CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)</td> <td>5</td> </tr> <tr> <td>array $parameters Hook metadatas (context, etc...)</td> <td>5</td> </tr> <tr> <td>string $action Current action (if set). Generally create or edit or null</td> <td>5</td> </tr> <tr> <td>HookManager $hookmanager Hook manager propagated to allow calling another hook</td> <td>5</td> </tr> <tr> <td>User $user User making the deletion</td> <td>5</td> </tr> <tr> <td>string $modele Force model to use ('' to not force)</td> <td>5</td> </tr> <tr> <td>int $info_bits Bits of type of lines</td> <td>5</td> </tr> <tr> <td>Societe $objsoc third party object</td> <td>5</td> </tr> <tr> <td>array $request_data Request data</td> <td>5</td> </tr> <tr> <td>int $mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)</td> <td>5</td> </tr> <tr> <td>int $origin_id Old thirdparty id</td> <td>5</td> </tr> <tr> <td>int $dest_id New thirdparty id</td> <td>5</td> </tr> <tr> <td>string $fieldorvalue Field name or value to encrypt</td> <td>5</td> </tr> <tr> <td>int $withQuotes Return string including the SQL simple quotes. This param must always be 1 (Value 0 is bugged and deprecated).</td> <td>5</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>5</td> </tr> <tr> <td>string $action Event action code</td> <td>5</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto</td> <td>5</td> </tr> <tr> <td>string $htmlname Name of HTML select</td> <td>5</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>5</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>5</td> </tr> <tr> <td>int $id Id of record</td> <td>5</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>5</td> </tr> <tr> <td>string $table Name of table</td> <td>5</td> </tr> <tr> <td>int $mailing_id Id of mailing. No need to use it.</td> <td>5</td> </tr> <tr> <td>Societe $objsoc Object thirdparty</td> <td>5</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>5</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>5</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>5</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>5</td> </tr> <tr> <td>string $titlekey Translation key to show as title of document</td> <td>5</td> </tr> <tr> <td>Translate $outputlangs Lang object for output language</td> <td>5</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>5</td> </tr> <tr> <td>Facture $invoice Object invoice</td> <td>5</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>5</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>5</td> </tr> <tr> <td>Translate $langs Output language</td> <td>5</td> </tr> <tr> <td>DoliDB $db Handler access base</td> <td>5</td> </tr> <tr> <td>array $array_export_fields_label Array with list of label of fields</td> <td>5</td> </tr> <tr> <td>array $array_selected_sorted Array with list of field to export</td> <td>5</td> </tr> <tr> <td>Translate $outputlangs Object lang to translate values</td> <td>5</td> </tr> <tr> <td>array $array_types Array with types of fields</td> <td>5</td> </tr> <tr> <td>array $array_selected_sorted Array with list of field to export</td> <td>5</td> </tr> <tr> <td>Resource $objp A record from a fetch with all fields from select</td> <td>5</td> </tr> <tr> <td>array $array_types Array with types of fields</td> <td>5</td> </tr> <tr> <td>User $user Object user</td> <td>5</td> </tr> <tr> <td>double $remise_percent Percentage discount of the line</td> <td>5</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>5</td> </tr> <tr> <td>int $id Order ID</td> <td>5</td> </tr> <tr> <td>int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id</td> <td>5</td> </tr> <tr> <td>User $user Object user making change</td> <td>5</td> </tr> <tr> <td>User $user Object user making change</td> <td>5</td> </tr> <tr> <td>double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, 1 otherwise)</td> <td>5</td> </tr> <tr> <td>string $option On what the link point to</td> <td>5</td> </tr> <tr> <td>integer $notooltip 1=Disable tooltip</td> <td>5</td> </tr> <tr> <td>array|null $data Data to validate</td> <td>5</td> </tr> <tr> <td>int $fk_parent_line Id of parent line</td> <td>5</td> </tr> <tr> <td>User $user Object user that close</td> <td>5</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>5</td> </tr> <tr> <td>string $cardData</td> <td>5</td> </tr> <tr> <td>string $path</td> <td>5</td> </tr> <tr> <td>bool $modified should be set to true, if this event handler</td> <td>5</td> </tr> <tr> <td>resource|string $data</td> <td>5</td> </tr> <tr> <td>string $name Name of the file</td> <td>5</td> </tr> <tr> <td>resource|string $data Initial payload</td> <td>5</td> </tr> <tr> <td>string $name The new name</td> <td>5</td> </tr> <tr> <td>Sharee[] $sharees</td> <td>5</td> </tr> <tr> <td>bool $value</td> <td>5</td> </tr> <tr> <td>string $calendarId</td> <td>5</td> </tr> <tr> <td>mixed $input</td> <td>5</td> </tr> <tr> <td>$format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().</td> <td>5</td> </tr> <tr> <td>$w (int) width</td> <td>5</td> </tr> <tr> <td>$opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.</td> <td>5</td> </tr> <tr> <td>$js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td> <td>5</td> </tr> <tr> <td>$name (string) Name of the spot color.</td> <td>5</td> </tr> <tr> <td>$stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.</td> <td>5</td> </tr> <tr> <td>$y (float) ordinate of the top left corner of the rectangle.</td> <td>5</td> </tr> <tr> <td>$w (float) width of the rectangle.</td> <td>5</td> </tr> <tr> <td>$h (float) height of the rectangle.</td> <td>5</td> </tr> <tr> <td>$frame (array) frame</td> <td>5</td> </tr> <tr> <td>CredentialsInterface $credentials</td> <td>5</td> </tr> <tr> <td>TokenStorageInterface $storage</td> <td>5</td> </tr> <tr> <td>TokenInterface $token</td> <td>5</td> </tr> <tr> <td>array $headers</td> <td>5</td> </tr> <tr> <td>string $method</td> <td>5</td> </tr> <tr> <td>string $token</td> <td>5</td> </tr> <tr> <td>int $pValue Sheet index</td> <td>5</td> </tr> <tr> <td>mixed $index</td> <td>5</td> </tr> <tr> <td>int $columnIndex1 Numeric column coordinate of the first cell</td> <td>5</td> </tr> <tr> <td>int $row1 Numeric row coordinate of the first cell</td> <td>5</td> </tr> <tr> <td>Color $pValue</td> <td>5</td> </tr> <tr> <td>string $property</td> <td>5</td> </tr> <tr> <td>int $month</td> <td>5</td> </tr> <tr> <td>int $seconds</td> <td>5</td> </tr> <tr> <td>string $pValue UTF-8 encoded string</td> <td>5</td> </tr> <tr> <td>mixed $frequency the number of coupon payments per year.</td> <td>5</td> </tr> <tr> <td>int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period</td> <td>5</td> </tr> <tr> <td>string $url URL string</td> <td>5</td> </tr> <tr> <td>string $extension</td> <td>5</td> </tr> <tr> <td>int $periods</td> <td>5</td> </tr> <tr> <td>string $command</td> <td>5</td> </tr> <tr> <td>string $nsKey</td> <td>5</td> </tr> <tr> <td>string $itemKey</td> <td>5</td> </tr> <tr> <td>string|null $locale</td> <td>5</td> </tr> <tr> <td>string $className The $className::instance() method will be called to cast the current object.</td> <td>5</td> </tr> <tr> <td>object|string $mixin</td> <td>5</td> </tr> <tr> <td>int $microseconds</td> <td>5</td> </tr> <tr> <td>string|DateInterval $unit</td> <td>5</td> </tr> <tr> <td>mixed $period</td> <td>5</td> </tr> <tr> <td>int $perPage</td> <td>5</td> </tr> <tr> <td>int $page</td> <td>5</td> </tr> <tr> <td>string $relation</td> <td>5</td> </tr> <tr> <td>array $relations</td> <td>5</td> </tr> <tr> <td>\Closure $resolver</td> <td>5</td> </tr> <tr> <td>int $onEachSide</td> <td>5</td> </tr> <tr> <td>mixed $id</td> <td>5</td> </tr> <tr> <td>\Illuminate\Http\Request $request</td> <td>5</td> </tr> <tr> <td>string $namespace</td> <td>5</td> </tr> <tr> <td>array $config</td> <td>5</td> </tr> <tr> <td>mixed $handler</td> <td>5</td> </tr> <tr> <td>string $format</td> <td>5</td> </tr> <tr> <td>mixed $payload</td> <td>5</td> </tr> <tr> <td>string $haystack</td> <td>5</td> </tr> <tr> <td>mixed $keys</td> <td>5</td> </tr> <tr> <td>int $step</td> <td>5</td> </tr> <tr> <td>int $numberOfGroups</td> <td>5</td> </tr> <tr> <td>string|callable|null $key</td> <td>5</td> </tr> <tr> <td>array $config</td> <td>5</td> </tr> <tr> <td>Client $client</td> <td>5</td> </tr> <tr> <td>int|null $msglist</td> <td>5</td> </tr> <tr> <td>null|array|string|Util\RequestOptions $opts</td> <td>5</td> </tr> <tr> <td>boolean $enabled</td> <td>5</td> </tr> <tr> <td>string $action Type of action</td> <td>5</td> </tr> <tr> <td>integer $id Id of object</td> <td>5</td> </tr> <tr> <td>int $id Id of thirdparty</td> <td>5</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>5</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>5</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>5</td> </tr> <tr> <td>int $page Page number {@min 0}</td> <td>5</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>5</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>5</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>6</td> </tr> <tr> <td>int $maxCount (Optional) The maximum count of elements inside the table</td> <td>6</td> </tr> <tr> <td>object $object Object related to tabs</td> <td>6</td> </tr> <tr> <td>int $year Year</td> <td>6</td> </tr> <tr> <td>string $pathoffile Path of file</td> <td>6</td> </tr> <tr> <td>string $other Add more attributes on img</td> <td>6</td> </tr> <tr> <td>int $showmode 0 = hide, 1 = allowed or 2 = not allowed</td> <td>6</td> </tr> <tr> <td>Translate $langs Language</td> <td>6</td> </tr> <tr> <td>string $action Action code</td> <td>6</td> </tr> <tr> <td>Object $object Object to show</td> <td>6</td> </tr> <tr> <td>int $notrigger 1 = disable triggers</td> <td>6</td> </tr> <tr> <td>array $data Array of data to validate</td> <td>6</td> </tr> <tr> <td>int $id Id object</td> <td>6</td> </tr> <tr> <td>int $status Id status</td> <td>6</td> </tr> <tr> <td>int $notrigger 0=no, 1=yes (no update trigger)</td> <td>6</td> </tr> <tr> <td>int $lineid Id of line to update</td> <td>6</td> </tr> <tr> <td>string $dirmodule Name of directory of module</td> <td>6</td> </tr> <tr> <td>int $id_bank Id if bank</td> <td>6</td> </tr> <tr> <td>User $user User that modify</td> <td>6</td> </tr> <tr> <td>Object $object Object</td> <td>6</td> </tr> <tr> <td>string $htmlname Name of select html field</td> <td>6</td> </tr> <tr> <td>string $dn DN entry key</td> <td>6</td> </tr> <tr> <td>array $info Attributes array</td> <td>6</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>6</td> </tr> <tr> <td>Translate $outputlangs Language object for output</td> <td>6</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>6</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>6</td> </tr> <tr> <td>Productlot $object Object we need next value for</td> <td>6</td> </tr> <tr> <td>Societe $objsoc Object thirdparty</td> <td>6</td> </tr> <tr> <td>string $srctemplatepath Full path of source filename for generator using a template file</td> <td>6</td> </tr> <tr> <td>int $posy Position y in PDF</td> <td>6</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>6</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>6</td> </tr> <tr> <td>Translate $outputlangs Output language object</td> <td>6</td> </tr> <tr> <td>string $key Key of driver</td> <td>6</td> </tr> <tr> <td>string $key Key</td> <td>6</td> </tr> <tr> <td>int $idwarehouse Warehouse ID</td> <td>6</td> </tr> <tr> <td>int $notrigger Disable all triggers</td> <td>6</td> </tr> <tr> <td>User $user Object user that change status</td> <td>6</td> </tr> <tr> <td>int $type Type of line (0=product, 1=service)</td> <td>6</td> </tr> <tr> <td>int|null $fk_unit Code of the unit to use. Null to use the default one</td> <td>6</td> </tr> <tr> <td>int $idwarehouse Id warehouse to use for stock change.</td> <td>6</td> </tr> <tr> <td>User $user Object user that make creation</td> <td>6</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)</td> <td>6</td> </tr> <tr> <td>int $maxlen Max length of visible user name</td> <td>6</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>6</td> </tr> <tr> <td>double $pu_ht_devise Unit price in currency</td> <td>6</td> </tr> <tr> <td>int $special_code Special code (also used by externals modules!)</td> <td>6</td> </tr> <tr> <td>User $fuser User</td> <td>6</td> </tr> <tr> <td>string|string[] $value</td> <td>6</td> </tr> <tr> <td>string $test</td> <td>6</td> </tr> <tr> <td>string $principalPrefix</td> <td>6</td> </tr> <tr> <td>string $realm</td> <td>6</td> </tr> <tr> <td>string $label</td> <td>6</td> </tr> <tr> <td>$x (float) Abscissa of the upper-left corner.</td> <td>6</td> </tr> <tr> <td>$y (float) Ordinate of the upper-left corner.</td> <td>6</td> </tr> <tr> <td>$x (int) X coordinate</td> <td>6</td> </tr> <tr> <td>$y (int) Y coordinate</td> <td>6</td> </tr> <tr> <td>$name (string) field name</td> <td>6</td> </tr> <tr> <td>$currentfont (array) Reference to current font array.</td> <td>6</td> </tr> <tr> <td>$level (int) error correction level</td> <td>6</td> </tr> <tr> <td>$inputitem (array)</td> <td>6</td> </tr> <tr> <td>$items (array)</td> <td>6</td> </tr> <tr> <td>$marr (array) Array of symbols.</td> <td>6</td> </tr> <tr> <td>$chr (int) Char byte.</td> <td>6</td> </tr> <tr> <td>mixed $cellValue</td> <td>6</td> </tr> <tr> <td>int $startRow The row number at which to start iterating</td> <td>6</td> </tr> <tr> <td>string $startColumn The column address at which to start iterating</td> <td>6</td> </tr> <tr> <td>string $pCoordinate eg: 'A1'</td> <td>6</td> </tr> <tr> <td>float $xValue X-Value</td> <td>6</td> </tr> <tr> <td>float $yValue Y-Value</td> <td>6</td> </tr> <tr> <td>float $rate Interest rate per period</td> <td>6</td> </tr> <tr> <td>bool $cumulative</td> <td>6</td> </tr> <tr> <td>mixed[] $xValues Data Series X</td> <td>6</td> </tr> <tr> <td>float $angle Number</td> <td>6</td> </tr> <tr> <td>float $present_value</td> <td>6</td> </tr> <tr> <td>float $future_value</td> <td>6</td> </tr> <tr> <td>bool $beginning adjust the payment to the beginning or end of the period</td> <td>6</td> </tr> <tr> <td>array<float> $values</td> <td>6</td> </tr> <tr> <td>array $options</td> <td>6</td> </tr> <tr> <td>string $time</td> <td>6</td> </tr> <tr> <td>string $name optional</td> <td>6</td> </tr> <tr> <td>string $localname the local path to the file in the archive</td> <td>6</td> </tr> <tr> <td>string $source the name of the function calling this</td> <td>6</td> </tr> <tr> <td>string $method magic method name called</td> <td>6</td> </tr> <tr> <td>array $parameters parameters list</td> <td>6</td> </tr> <tr> <td>DateTimeZone|string|null $tz</td> <td>6</td> </tr> <tr> <td>string $valueUnit unit name to modify</td> <td>6</td> </tr> <tr> <td>string $overflowUnit unit name to not overflow</td> <td>6</td> </tr> <tr> <td>float|int $precision</td> <td>6</td> </tr> <tr> <td>string $format Datetime format</td> <td>6</td> </tr> <tr> <td>Closure $callback</td> <td>6</td> </tr> <tr> <td>object|callable $macro</td> <td>6</td> </tr> <tr> <td>string|null $context whole format string</td> <td>6</td> </tr> <tr> <td>int $nth</td> <td>6</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface $translator</td> <td>6</td> </tr> <tr> <td>float|int|string|DateInterval|null $precision</td> <td>6</td> </tr> <tr> <td>\Illuminate\Database\Eloquent\Model $model</td> <td>6</td> </tr> <tr> <td>string $locale</td> <td>6</td> </tr> <tr> <td>\Illuminate\Contracts\Mail\Mailable|string|array $view</td> <td>6</td> </tr> <tr> <td>string $queue</td> <td>6</td> </tr> <tr> <td>\Illuminate\Support\Collection|array|mixed $notifiables</td> <td>6</td> </tr> <tr> <td>mixed $notification</td> <td>6</td> </tr> <tr> <td>string $pad</td> <td>6</td> </tr> <tr> <td>int $flags</td> <td>6</td> </tr> <tr> <td>string|array $needles</td> <td>6</td> </tr> <tr> <td>array $expectedChain</td> <td>6</td> </tr> <tr> <td>mixed $notifiable</td> <td>6</td> </tr> <tr> <td>iterable $array</td> <td>6</td> </tr> <tr> <td>string $user username</td> <td>6</td> </tr> <tr> <td>string $rfc</td> <td>6</td> </tr> <tr> <td>string $folder destination folder</td> <td>6</td> </tr> <tr> <td>$from</td> <td>6</td> </tr> <tr> <td>array<string> $messages List of message identifiers</td> <td>6</td> </tr> <tr> <td>string $folder Destination folder</td> <td>6</td> </tr> <tr> <td>bool $uid Set to true if you pass message unique identifiers instead of numbers</td> <td>6</td> </tr> <tr> <td>string $parser XML parser object</td> <td>6</td> </tr> <tr> <td>string $name element name</td> <td>6</td> </tr> <tr> <td>string $_id</td> <td>6</td> </tr> <tr> <td>null|array $_params</td> <td>6</td> </tr> <tr> <td>null|array|string $_options</td> <td>6</td> </tr> <tr> <td>string $method the HTTP method</td> <td>6</td> </tr> <tr> <td>string $path the path of the request</td> <td>6</td> </tr> <tr> <td>array $params the parameters of the request</td> <td>6</td> </tr> <tr> <td>null|array $opts</td> <td>6</td> </tr> <tr> <td>string $nestedPath</td> <td>6</td> </tr> <tr> <td>int $active Payment term is active or not {@min 0} {@max 1}</td> <td>6</td> </tr> <tr> <td>resource $connect_id Connection handler</td> <td>7</td> </tr> <tr> <td>int $entitytotest Number of instance (always 1 if module multicompany not enabled)</td> <td>7</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>7</td> </tr> <tr> <td>User $user Object user that modify</td> <td>7</td> </tr> <tr> <td>array $request_data Datas</td> <td>7</td> </tr> <tr> <td>User $user User that modifies</td> <td>7</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>7</td> </tr> <tr> <td>int $year Year</td> <td>7</td> </tr> <tr> <td>int $limit Limit for list</td> <td>7</td> </tr> <tr> <td>int $page Page number</td> <td>7</td> </tr> <tr> <td>User $user User object</td> <td>7</td> </tr> <tr> <td>User $user Object of user making payment</td> <td>7</td> </tr> <tr> <td>string $label Label to use in bank record</td> <td>7</td> </tr> <tr> <td>int $accountid Id of bank account to do link with</td> <td>7</td> </tr> <tr> <td>string $emetteur_nom Name of transmitter</td> <td>7</td> </tr> <tr> <td>string $emetteur_banque Name of bank</td> <td>7</td> </tr> <tr> <td>User $user User that create</td> <td>7</td> </tr> <tr> <td>int $id Id object</td> <td>7</td> </tr> <tr> <td>User $user User that delete</td> <td>7</td> </tr> <tr> <td>User $user Object user</td> <td>7</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>7</td> </tr> <tr> <td>conf $conf Object conf</td> <td>7</td> </tr> <tr> <td>array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field</td> <td>7</td> </tr> <tr> <td>string $table Name of table</td> <td>7</td> </tr> <tr> <td>string $options Options when enabling module ('', 'newboxdefonly', 'noboxes')</td> <td>7</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>7</td> </tr> <tr> <td>User $user Object user</td> <td>7</td> </tr> <tr> <td>string $option ''=Create a specimen invoice with lines, 'nolines'=No lines</td> <td>7</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>7</td> </tr> <tr> <td>User $user User that creates</td> <td>7</td> </tr> <tr> <td>string $ref_ext External reference of object</td> <td>7</td> </tr> <tr> <td>int $id Id of order</td> <td>7</td> </tr> <tr> <td>int $syncLevel</td> <td>7</td> </tr> <tr> <td>int $limit</td> <td>7</td> </tr> <tr> <td>string $header</td> <td>7</td> </tr> <tr> <td>string $calendarData</td> <td>7</td> </tr> <tr> <td>string $str</td> <td>7</td> </tr> <tr> <td>$link (mixed) URL or identifier returned by AddLink().</td> <td>7</td> </tr> <tr> <td>$code (string) code to print</td> <td>7</td> </tr> <tr> <td>$fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).</td> <td>7</td> </tr> <tr> <td>$version (int)</td> <td>7</td> </tr> <tr> <td>$nrow (int) Number of rows.</td> <td>7</td> </tr> <tr> <td>$ncol (int) Number of columns.</td> <td>7</td> </tr> <tr> <td>array $_server</td> <td>7</td> </tr> <tr> <td>Worksheet $sheet</td> <td>7</td> </tr> <tr> <td>int $alpha</td> <td>7</td> </tr> <tr> <td>float $size</td> <td>7</td> </tr> <tr> <td>int $year</td> <td>7</td> </tr> <tr> <td>int $day</td> <td>7</td> </tr> <tr> <td>mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),</td> <td>7</td> </tr> <tr> <td>float $fv Future Value</td> <td>7</td> </tr> <tr> <td>int $colorIndex Color index</td> <td>7</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet</td> <td>7</td> </tr> <tr> <td>string[] $failedRecipients An array of failures by-reference</td> <td>7</td> </tr> <tr> <td>$input</td> <td>7</td> </tr> <tr> <td>int|array $syntax if array passed, parameters will be extracted from it, the array may contains:</td> <td>7</td> </tr> <tr> <td>bool $short displays short format of time units</td> <td>7</td> </tr> <tr> <td>int $options human diff options</td> <td>7</td> </tr> <tr> <td>DateInterval $interval</td> <td>7</td> </tr> <tr> <td>string $class</td> <td>7</td> </tr> <tr> <td>array $attributes</td> <td>7</td> </tr> <tr> <td>array $values</td> <td>7</td> </tr> <tr> <td>array $credentials</td> <td>7</td> </tr> <tr> <td>string $ability</td> <td>7</td> </tr> <tr> <td>bool|null $secure</td> <td>7</td> </tr> <tr> <td>string $uri</td> <td>7</td> </tr> <tr> <td>array|string|callable $action</td> <td>7</td> </tr> <tr> <td>int $length</td> <td>7</td> </tr> <tr> <td>string|\Closure $command</td> <td>7</td> </tr> <tr> <td>string $job</td> <td>7</td> </tr> <tr> <td>string $notification</td> <td>7</td> </tr> <tr> <td>bool $descending</td> <td>7</td> </tr> <tr> <td>array $values</td> <td>7</td> </tr> <tr> <td>array|string $_id</td> <td>7</td> </tr> <tr> <td>null|array|string $_opts</td> <td>7</td> </tr> <tr> <td>array|\Stripe\Util\RequestOptions $opts the special modifiers of the request</td> <td>7</td> </tr> <tr> <td>array $request_data Request data</td> <td>7</td> </tr> <tr> <td>string $mode 'byunit'=number of unit, 'bynumber'=nb of entities</td> <td>7</td> </tr> <tr> <td>int $year Year to scan</td> <td>7</td> </tr> <tr> <td>string $usertotest Login</td> <td>8</td> </tr> <tr> <td>string $passwordtotest Password</td> <td>8</td> </tr> <tr> <td>resource $stream</td> <td>8</td> </tr> <tr> <td>string $pattern</td> <td>8</td> </tr> <tr> <td>string|array $key</td> <td>8</td> </tr> <tr> <td>string $ref Ref of object</td> <td>8</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>8</td> </tr> <tr> <td>Translate $outputlangsbis Langs object bis</td> <td>8</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>8</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>8</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>8</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>8</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>8</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>8</td> </tr> <tr> <td>Translate $outputlangs Object langs to use for output</td> <td>8</td> </tr> <tr> <td>User $user User that create</td> <td>8</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto</td> <td>8</td> </tr> <tr> <td>string $stringtoencode String to escape</td> <td>8</td> </tr> <tr> <td>string $filter Filter list on a particular value</td> <td>8</td> </tr> <tr> <td>string $mode 'next' for next value or 'last' for last value</td> <td>8</td> </tr> <tr> <td>string $page Page</td> <td>8</td> </tr> <tr> <td>int $id ID</td> <td>8</td> </tr> <tr> <td>Societe $objsoc Object third party</td> <td>8</td> </tr> <tr> <td>Societe|string $objsoc Object thirdparty</td> <td>8</td> </tr> <tr> <td>array $head Array with properties of box title</td> <td>8</td> </tr> <tr> <td>array $contents Array with properties of box lines</td> <td>8</td> </tr> <tr> <td>int $nooutput No print, only return string</td> <td>8</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>8</td> </tr> <tr> <td>int $notrigger Disable triggers</td> <td>8</td> </tr> <tr> <td>string $ref Ref of object</td> <td>8</td> </tr> <tr> <td>string $name</td> <td>8</td> </tr> <tr> <td>string $principal</td> <td>8</td> </tr> <tr> <td>string $syncToken</td> <td>8</td> </tr> <tr> <td>string $cardUri</td> <td>8</td> </tr> <tr> <td>string $source</td> <td>8</td> </tr> <tr> <td>string $color</td> <td>8</td> </tr> <tr> <td>Geometry $geometry</td> <td>8</td> </tr> <tr> <td>$fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).</td> <td>8</td> </tr> <tr> <td>$prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td> <td>8</td> </tr> <tr> <td>$x (float) Abscissa of the upper-left corner of the rectangle</td> <td>8</td> </tr> <tr> <td>$y (float) Ordinate of the upper-left corner of the rectangle</td> <td>8</td> </tr> <tr> <td>string $service</td> <td>8</td> </tr> <tr> <td>string $host</td> <td>8</td> </tr> <tr> <td>string $pBefore Insert/Delete before this cell address (e.g. 'A1')</td> <td>8</td> </tr> <tr> <td>int $row Numeric row coordinate of the cell</td> <td>8</td> </tr> <tr> <td>int $value</td> <td>8</td> </tr> <tr> <td>float $pv Present Value</td> <td>8</td> </tr> <tr> <td>mixed $args Data values</td> <td>8</td> </tr> <tr> <td>mixed[] $yValues Data Series Y</td> <td>8</td> </tr> <tr> <td>XMLWriter $objWriter</td> <td>8</td> </tr> <tr> <td>int $mode</td> <td>8</td> </tr> <tr> <td>int $weekStartsAt optional start allow you to specify the day of week to use to start the week</td> <td>8</td> </tr> <tr> <td>int|null $hour</td> <td>8</td> </tr> <tr> <td>int|null $minute</td> <td>8</td> </tr> <tr> <td>int|null $second</td> <td>8</td> </tr> <tr> <td>DateTimeZone|string|false|null $tz</td> <td>8</td> </tr> <tr> <td>Carbon|\DateTimeInterface|string|array|null $other if array passed, will be used as parameters array, see $syntax below;</td> <td>8</td> </tr> <tr> <td>int|array $syntax if array passed, parameters will be extracted from it, the array may contains:</td> <td>8</td> </tr> <tr> <td>bool $short displays short format of time units</td> <td>8</td> </tr> <tr> <td>int $parts maximum number of parts to display (default value: 1: single unit)</td> <td>8</td> </tr> <tr> <td>int $options human diff options</td> <td>8</td> </tr> <tr> <td>int|null $dayOfWeek</td> <td>8</td> </tr> <tr> <td>int|null $dayOfWeek day of the week default null</td> <td>8</td> </tr> <tr> <td>int $dayOfWeek</td> <td>8</td> </tr> <tr> <td>int|null $dayOfWeek first date of week from 0 (Sunday) to 6 (Saturday)</td> <td>8</td> </tr> <tr> <td>int|null $dayOfYear first day of year included in the week #1</td> <td>8</td> </tr> <tr> <td>callable $callback</td> <td>8</td> </tr> <tr> <td>DateTimeZone|string $value</td> <td>8</td> </tr> <tr> <td>string $unitPrecision</td> <td>8</td> </tr> <tr> <td>string|null $view</td> <td>8</td> </tr> <tr> <td>callable|string $callback</td> <td>8</td> </tr> <tr> <td>array|mixed $arguments</td> <td>8</td> </tr> <tr> <td>string|null $format</td> <td>8</td> </tr> <tr> <td>string|object $job</td> <td>8</td> </tr> <tr> <td>int $offset</td> <td>8</td> </tr> <tr> <td>int $depth</td> <td>8</td> </tr> <tr> <td>callable|int|null $callback</td> <td>8</td> </tr> <tr> <td>string|\Closure $mailable</td> <td>8</td> </tr> <tr> <td>int $size</td> <td>8</td> </tr> <tr> <td>boolean $expunge</td> <td>8</td> </tr> <tr> <td>int $socid Limit count on a particular third party id</td> <td>8</td> </tr> <tr> <td>int $filteronproducttype 0=To filter on product only, 1=To filter on services only</td> <td>8</td> </tr> <tr> <td>int $year Year (0=last 12 month, -1=all years)</td> <td>8</td> </tr> <tr> <td>string $morefilter More sql filters</td> <td>8</td> </tr> <tr> <td>string $ipAddress an IPv4 or IPv6 address as a string</td> <td>8</td> </tr> <tr> <td>Translate $outputlangs langs</td> <td>9</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>9</td> </tr> <tr> <td>int $max Maximum number of records to load</td> <td>9</td> </tr> <tr> <td>User $user User that creates</td> <td>9</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>9</td> </tr> <tr> <td>Translate $outputlangs Output language</td> <td>9</td> </tr> <tr> <td>Facture $object Object invoice</td> <td>9</td> </tr> <tr> <td>int $type Type of third party (1:customer, 2:supplier, -1:autodetect)</td> <td>9</td> </tr> <tr> <td>User $user User making the clone</td> <td>9</td> </tr> <tr> <td>mixed $addressBookId</td> <td>9</td> </tr> <tr> <td>string $input</td> <td>9</td> </tr> <tr> <td>string $url</td> <td>9</td> </tr> <tr> <td>$y (int) Y position</td> <td>9</td> </tr> <tr> <td>$size (int)</td> <td>9</td> </tr> <tr> <td>$spec (array)</td> <td>9</td> </tr> <tr> <td>Worksheet $pSheet</td> <td>9</td> </tr> <tr> <td>int $beforeRow Number of the row we're inserting/deleting before</td> <td>9</td> </tr> <tr> <td>int $beforeColumnIndex Index number of the column we're inserting/deleting before</td> <td>9</td> </tr> <tr> <td>Worksheet $pSheet The worksheet that we're editing</td> <td>9</td> </tr> <tr> <td>$value</td> <td>9</td> </tr> <tr> <td>int $columnIndex Numeric column coordinate of the cell</td> <td>9</td> </tr> <tr> <td>bool $isConditional Flag indicating if this is a conditional style or not</td> <td>9</td> </tr> <tr> <td>array $pStyles Array containing style information</td> <td>9</td> </tr> <tr> <td>int $dp Number of places of decimal precision to return</td> <td>9</td> </tr> <tr> <td>float $number Number to round</td> <td>9</td> </tr> <tr> <td>float $rate</td> <td>9</td> </tr> <tr> <td>string $key</td> <td>9</td> </tr> <tr> <td>String $input</td> <td>9</td> </tr> <tr> <td>string $time</td> <td>9</td> </tr> <tr> <td>int $count</td> <td>9</td> </tr> <tr> <td>string $batchId</td> <td>9</td> </tr> <tr> <td>string $string</td> <td>9</td> </tr> <tr> <td>int $limit</td> <td>9</td> </tr> <tr> <td>string|array|null $key</td> <td>9</td> </tr> <tr> <td>array|int $uids</td> <td>9</td> </tr> <tr> <td>User $user User that deletes</td> <td>9</td> </tr> <tr> <td>int $year Year</td> <td>10</td> </tr> <tr> <td>User $user User that modifies</td> <td>10</td> </tr> <tr> <td>int $origin_id Old product id</td> <td>10</td> </tr> <tr> <td>int $dest_id New product id</td> <td>10</td> </tr> <tr> <td>string $price_base_type HT or TTC</td> <td>10</td> </tr> <tr> <td>int[]|int $categories Category or categories IDs</td> <td>10</td> </tr> <tr> <td>string $database Name of database</td> <td>10</td> </tr> <tr> <td>string $table Name of table filter ('xxx%')</td> <td>10</td> </tr> <tr> <td>User $user User that deletes</td> <td>10</td> </tr> <tr> <td>int $deja_regle Montant deja regle</td> <td>10</td> </tr> <tr> <td>string $date</td> <td>10</td> </tr> <tr> <td>array $context</td> <td>10</td> </tr> <tr> <td>$border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))</td> <td>10</td> </tr> <tr> <td>$x (int) X position</td> <td>10</td> </tr> <tr> <td>int $pNumRows Number of rows to insert/delete (negative values indicate deletion)</td> <td>10</td> </tr> <tr> <td>int $pNumCols Number of columns to insert/delete (negative values indicate deletion)</td> <td>10</td> </tr> <tr> <td>float $pValue</td> <td>10</td> </tr> <tr> <td>bool $isSupervisor Flag indicating if this is a supervisor or not</td> <td>10</td> </tr> <tr> <td>array $array</td> <td>10</td> </tr> <tr> <td>mixed $B Matrix/Array</td> <td>10</td> </tr> <tr> <td>string $className</td> <td>10</td> </tr> <tr> <td>string $bytes</td> <td>10</td> </tr> <tr> <td>string $unit</td> <td>10</td> </tr> <tr> <td>int|null $year</td> <td>10</td> </tr> <tr> <td>int|null $month</td> <td>10</td> </tr> <tr> <td>int|null $day</td> <td>10</td> </tr> <tr> <td>string $method</td> <td>10</td> </tr> <tr> <td>mixed $date</td> <td>10</td> </tr> <tr> <td>string $event</td> <td>10</td> </tr> <tr> <td>\DateTimeInterface|\DateInterval|int $delay</td> <td>10</td> </tr> <tr> <td>int|null $length</td> <td>10</td> </tr> <tr> <td>int|null $to if null only one message ($from) is fetched, else it's the</td> <td>10</td> </tr> <tr> <td>string $title Title</td> <td>11</td> </tr> <tr> <td>string $head Head array</td> <td>11</td> </tr> <tr> <td>int $disablejs More content into html header</td> <td>11</td> </tr> <tr> <td>int $disablehead More content into html header</td> <td>11</td> </tr> <tr> <td>array $arrayofjs Array of complementary js files</td> <td>11</td> </tr> <tr> <td>array $arrayofcss Array of complementary css files</td> <td>11</td> </tr> <tr> <td>int $type_user Type of targeted user for menu</td> <td>11</td> </tr> <tr> <td>int $id Id object</td> <td>11</td> </tr> <tr> <td>User $user Object user</td> <td>11</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>11</td> </tr> <tr> <td>$version (int) version</td> <td>11</td> </tr> <tr> <td>string $subData</td> <td>11</td> </tr> <tr> <td>float[] $yValues The set of Y-values for this regression</td> <td>11</td> </tr> <tr> <td>float[] $xValues The set of X-values for this regression</td> <td>11</td> </tr> <tr> <td>bool $const</td> <td>11</td> </tr> <tr> <td>string $unit</td> <td>11</td> </tr> <tr> <td>mixed $text</td> <td>11</td> </tr> <tr> <td>null|array|string $options</td> <td>11</td> </tr> <tr> <td>int $id ID of thirdparty</td> <td>11</td> </tr> <tr> <td>int $socid Id societe</td> <td>11</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>12</td> </tr> <tr> <td>Object $object Object related to tabs</td> <td>12</td> </tr> <tr> <td>int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)</td> <td>12</td> </tr> <tr> <td>string $mainmenu Main menu</td> <td>12</td> </tr> <tr> <td>Menu $newmenu Object Menu to return back list of menu entries</td> <td>12</td> </tr> <tr> <td>int $usemenuhider Use menu hider</td> <td>12</td> </tr> <tr> <td>string $leftmenu Left menu</td> <td>12</td> </tr> <tr> <td>string|null $key</td> <td>12</td> </tr> <tr> <td>int $times</td> <td>12</td> </tr> <tr> <td>array $array_options extrafields array</td> <td>12</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>12</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>12</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>12</td> </tr> <tr> <td>int $limit Limit for list</td> <td>12</td> </tr> <tr> <td>int $page Page number</td> <td>12</td> </tr> <tr> <td>array $data Array with data to verify</td> <td>12</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto</td> <td>12</td> </tr> <tr> <td>User $user User that delete</td> <td>12</td> </tr> <tr> <td>int $rowid Id of line</td> <td>12</td> </tr> <tr> <td>int $nexY Y</td> <td>12</td> </tr> <tr> <td>int $posy Y</td> <td>12</td> </tr> <tr> <td>resource $data</td> <td>12</td> </tr> <tr> <td>mixed $calendarId</td> <td>12</td> </tr> <tr> <td>Xml\Writer $writer XML writer</td> <td>12</td> </tr> <tr> <td>$data (string) Data to decode.</td> <td>12</td> </tr> <tr> <td>int $length</td> <td>12</td> </tr> <tr> <td>int|string $field Indicates which column is used in the function. Enter the</td> <td>12</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|mixed $date1</td> <td>12</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|mixed $date2</td> <td>12</td> </tr> <tr> <td>float|int|string|\DateInterval|null $precision</td> <td>12</td> </tr> <tr> <td>CarbonInterval|DateInterval|mixed $interval</td> <td>12</td> </tr> <tr> <td>array $params</td> <td>12</td> </tr> <tr> <td>array $options</td> <td>12</td> </tr> <tr> <td>int $status</td> <td>12</td> </tr> <tr> <td>mixed $values</td> <td>12</td> </tr> <tr> <td>string $folder folder name</td> <td>12</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>13</td> </tr> <tr> <td>string $subject</td> <td>13</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"</td> <td>13</td> </tr> <tr> <td>array $request_data Request data</td> <td>13</td> </tr> <tr> <td>array $request_data Datas</td> <td>13</td> </tr> <tr> <td>array $request_data Request datas</td> <td>13</td> </tr> <tr> <td>int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto</td> <td>13</td> </tr> <tr> <td>CommonObject $object Object we need next value for</td> <td>13</td> </tr> <tr> <td>int $options</td> <td>13</td> </tr> <tr> <td>$style (string) Style of rendering. See the getPathPaintOperator() function for more information.</td> <td>13</td> </tr> <tr> <td>mixed $maturity The security's maturity date.</td> <td>13</td> </tr> <tr> <td>mixed[] $criteria The range of cells that contains the conditions you specify.</td> <td>13</td> </tr> <tr> <td>string $locale locale ex. en</td> <td>13</td> </tr> <tr> <td>string $abstract</td> <td>13</td> </tr> <tr> <td>int $i Current line number</td> <td>14</td> </tr> <tr> <td>Translate $outputlangs Object langs for output</td> <td>14</td> </tr> <tr> <td>int $limit Limit for list</td> <td>14</td> </tr> <tr> <td>int $page Page number</td> <td>14</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>14</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>14</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>14</td> </tr> <tr> <td>int $dp Number of places of decimal precision to display</td> <td>14</td> </tr> <tr> <td>mixed $settlement The security's settlement date.</td> <td>14</td> </tr> <tr> <td>mixed[] $database The range of cells that makes up the list or database.</td> <td>14</td> </tr> <tr> <td>int $code</td> <td>14</td> </tr> <tr> <td>Throwable|null $previous</td> <td>14</td> </tr> <tr> <td>mixed $command</td> <td>14</td> </tr> <tr> <td>array $headers</td> <td>14</td> </tr> <tr> <td>string $command</td> <td>14</td> </tr> <tr> <td>string $search</td> <td>14</td> </tr> <tr> <td>bool $strict</td> <td>14</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>15</td> </tr> <tr> <td>Object $object Object</td> <td>15</td> </tr> <tr> <td>string $options Options when enabling module ('', 'noboxes')</td> <td>15</td> </tr> <tr> <td>int $hidetop 1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title</td> <td>15</td> </tr> <tr> <td>array $params params to construct tooltip data</td> <td>15</td> </tr> <tr> <td>int $status Id status</td> <td>15</td> </tr> <tr> <td>string $option On what the link point to ('nolink', ...)</td> <td>15</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>15</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>15</td> </tr> <tr> <td>int $posy Position depart</td> <td>15</td> </tr> <tr> <td>$code (string) code to represent.</td> <td>15</td> </tr> <tr> <td>float $value</td> <td>15</td> </tr> <tr> <td>mixed $value Value to check</td> <td>15</td> </tr> <tr> <td>string $address</td> <td>15</td> </tr> <tr> <td>User $user User making the clone</td> <td>16</td> </tr> <tr> <td>string $propertyName</td> <td>16</td> </tr> <tr> <td>string $password</td> <td>16</td> </tr> <tr> <td>array $data</td> <td>16</td> </tr> <tr> <td>\Closure $callback</td> <td>16</td> </tr> <tr> <td>string|null $queue</td> <td>16</td> </tr> <tr> <td>string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.</td> <td>17</td> </tr> <tr> <td>string $filename</td> <td>17</td> </tr> <tr> <td>int $hidetop Hide top bar of array</td> <td>17</td> </tr> <tr> <td>string $type</td> <td>17</td> </tr> <tr> <td>mixed $calendarId</td> <td>17</td> </tr> <tr> <td>mixed[] $context</td> <td>17</td> </tr> <tr> <td>string $data</td> <td>17</td> </tr> <tr> <td>int $basis The type of day count to use.</td> <td>17</td> </tr> <tr> <td>$name</td> <td>17</td> </tr> <tr> <td>ValidationInfo $info</td> <td>17</td> </tr> <tr> <td>callable|string|null $callback</td> <td>17</td> </tr> <tr> <td>int $page Page number (starting from zero)</td> <td>17</td> </tr> <tr> <td>string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"</td> <td>17</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>18</td> </tr> <tr> <td>string $val</td> <td>18</td> </tr> <tr> <td>array $params ex option, infologin</td> <td>18</td> </tr> <tr> <td>Object $object Object we need next value for</td> <td>18</td> </tr> <tr> <td>string $objectUri</td> <td>18</td> </tr> <tr> <td>string $username</td> <td>18</td> </tr> <tr> <td>bool $value</td> <td>18</td> </tr> <tr> <td>string $format</td> <td>18</td> </tr> <tr> <td>mixed $data</td> <td>18</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>19</td> </tr> <tr> <td>int $nexY Y (not used)</td> <td>19</td> </tr> <tr> <td>Translate $outputlangsbis Object lang for output bis</td> <td>19</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>19</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)</td> <td>19</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>19</td> </tr> <tr> <td>Translate $outputlangs Lang object to use for output</td> <td>19</td> </tr> <tr> <td>CommonObject $object Object we need next value for</td> <td>19</td> </tr> <tr> <td>string|null $name</td> <td>19</td> </tr> <tr> <td>mixed $operator</td> <td>19</td> </tr> <tr> <td>Translate $outputlangs Object langs</td> <td>20</td> </tr> <tr> <td>string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names</td> <td>20</td> </tr> <tr> <td>array $objectLines data</td> <td>20</td> </tr> <tr> <td>resource $exportFile [=null] File resource to export or print if null</td> <td>20</td> </tr> <tr> <td>string $pValue</td> <td>20</td> </tr> <tr> <td>string $currency Currency code</td> <td>21</td> </tr> <tr> <td>string $message</td> <td>21</td> </tr> <tr> <td>int $pValue</td> <td>21</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>22</td> </tr> <tr> <td>array $array</td> <td>22</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>22</td> </tr> <tr> <td>PhpspreadsheetWorksheet $pSheet Worksheet</td> <td>22</td> </tr> <tr> <td>int $limit Number of items per page</td> <td>22</td> </tr> <tr> <td>int $year Year to scan</td> <td>23</td> </tr> <tr> <td>DateTimeZone|string|null $tz</td> <td>23</td> </tr> <tr> <td>string $param More parameters</td> <td>24</td> </tr> <tr> <td>bool $uid set to true if passing a unique id</td> <td>24</td> </tr> <tr> <td>mixed $value</td> <td>25</td> </tr> <tr> <td>mixed $default</td> <td>25</td> </tr> <tr> <td>int $idline Id of line to delete</td> <td>25</td> </tr> <tr> <td>User $user User making status change</td> <td>25</td> </tr> <tr> <td>string $string</td> <td>25</td> </tr> <tr> <td>int $options</td> <td>25</td> </tr> <tr> <td>string $method</td> <td>25</td> </tr> <tr> <td>int $limit limit</td> <td>26</td> </tr> <tr> <td>string $filtermode No more used</td> <td>26</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>26</td> </tr> <tr> <td>User $user User that modify</td> <td>26</td> </tr> <tr> <td>int $origin_id Old thirdparty id</td> <td>26</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>26</td> </tr> <tr> <td>float|int $tab_top Top position of table</td> <td>26</td> </tr> <tr> <td>float|int $tab_height Height of table (rectangle)</td> <td>26</td> </tr> <tr> <td>string $message</td> <td>26</td> </tr> <tr> <td>string $itemKey</td> <td>26</td> </tr> <tr> <td>TCPDF $pdf PDF</td> <td>27</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>27</td> </tr> <tr> <td>int $hidefreetext 1=Hide free text</td> <td>27</td> </tr> <tr> <td>int $dest_id New thirdparty id</td> <td>27</td> </tr> <tr> <td>Object $object Object to clean</td> <td>27</td> </tr> <tr> <td>callable|null $default</td> <td>27</td> </tr> <tr> <td>string $sortorder Sort Order</td> <td>28</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>28</td> </tr> <tr> <td>int $offset Offset</td> <td>28</td> </tr> <tr> <td>int $showaddress 0=no, 1=yes</td> <td>28</td> </tr> <tr> <td>DoliDB $dbs Database handler, because function is static we name it $dbs not $db to avoid breaking coding test</td> <td>28</td> </tr> <tr> <td>string $sortfield Sort field</td> <td>28</td> </tr> <tr> <td>string $sortorder Sort order</td> <td>28</td> </tr> <tr> <td>string $filter Filter as an Universal Search string.</td> <td>29</td> </tr> <tr> <td>User $user User that delete</td> <td>29</td> </tr> <tr> <td>int $id Id of object</td> <td>29</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>29</td> </tr> <tr> <td>Conf $conf Object conf</td> <td>30</td> </tr> <tr> <td>Translate $outputlangs object lang a utiliser pour traduction</td> <td>30</td> </tr> <tr> <td>string $modele Force template to use ('' to not force)</td> <td>30</td> </tr> <tr> <td>string $principalUri</td> <td>30</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>31</td> </tr> <tr> <td>int $hidebottom Hide bottom bar of array</td> <td>31</td> </tr> <tr> <td>int $format 0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month</td> <td>31</td> </tr> <tr> <td>array $parameters</td> <td>31</td> </tr> <tr> <td>mixed ...$args Data values</td> <td>31</td> </tr> <tr> <td>Translate $outputlangs Object lang for output</td> <td>32</td> </tr> <tr> <td>int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)</td> <td>32</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>32</td> </tr> <tr> <td>string $nsKey</td> <td>32</td> </tr> <tr> <td>User $user User that creates</td> <td>33</td> </tr> <tr> <td>int $fromid Id of object to clone</td> <td>33</td> </tr> <tr> <td>string $option On what the link point to ('nolink', ...)</td> <td>33</td> </tr> <tr> <td>string $name</td> <td>33</td> </tr> <tr> <td>string $charset</td> <td>33</td> </tr> <tr> <td>int $notooltip 1=Disable tooltip</td> <td>34</td> </tr> <tr> <td>Translate $langs Object langs</td> <td>35</td> </tr> <tr> <td>User $user User that deletes</td> <td>35</td> </tr> <tr> <td>string $path</td> <td>35</td> </tr> <tr> <td>array $authentication Array of authentication information</td> <td>36</td> </tr> <tr> <td>\Carbon\Carbon|\DateTimeInterface|mixed $date</td> <td>36</td> </tr> <tr> <td>string $ref Ref</td> <td>37</td> </tr> <tr> <td>int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking</td> <td>37</td> </tr> <tr> <td>null|array $moreparams Array to provide more information</td> <td>37</td> </tr> <tr> <td>int $hidedetails Do not show line details</td> <td>37</td> </tr> <tr> <td>int $hidedesc Do not show desc</td> <td>37</td> </tr> <tr> <td>int $hideref Do not show ref</td> <td>37</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>37</td> </tr> <tr> <td>string $param More parameters</td> <td>37</td> </tr> <tr> <td>string $morecss Add more css on link</td> <td>38</td> </tr> <tr> <td>Translate $outputlangs Lang output object</td> <td>38</td> </tr> <tr> <td>int $id Id object</td> <td>39</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>40</td> </tr> <tr> <td>string $uri</td> <td>40</td> </tr> <tr> <td>string $srctemplatepath Full path of source filename for generator using a template file</td> <td>41</td> </tr> <tr> <td>Spreadsheet $spreadsheet</td> <td>42</td> </tr> <tr> <td>string $value</td> <td>42</td> </tr> <tr> <td>Translate $outputlangs Langs object</td> <td>44</td> </tr> <tr> <td>integer $maxfilenamelength Max length of value to show</td> <td>45</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0= execute triggers</td> <td>45</td> </tr> <tr> <td>int $hidedetails Hide details of lines</td> <td>46</td> </tr> <tr> <td>int $hidedesc Hide description</td> <td>46</td> </tr> <tr> <td>int $hideref Hide ref</td> <td>46</td> </tr> <tr> <td>string $pFilename</td> <td>46</td> </tr> <tr> <td>string $parentId</td> <td>46</td> </tr> <tr> <td>User $user User that creates</td> <td>47</td> </tr> <tr> <td>User $user User that modifies</td> <td>47</td> </tr> <tr> <td>mixed $key</td> <td>47</td> </tr> <tr> <td>int $max Maximum number of records to load</td> <td>48</td> </tr> <tr> <td>array $head Array with properties of box title</td> <td>48</td> </tr> <tr> <td>array $contents Array with properties of box lines</td> <td>48</td> </tr> <tr> <td>mixed $items</td> <td>48</td> </tr> <tr> <td>callable|null $callback</td> <td>49</td> </tr> <tr> <td>int $nooutput No print, only return string</td> <td>49</td> </tr> <tr> <td>bool $pValue</td> <td>51</td> </tr> <tr> <td>array $arraydata Array of data</td> <td>52</td> </tr> <tr> <td>int $status Id status</td> <td>53</td> </tr> <tr> <td>string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)</td> <td>54</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>61</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>63</td> </tr> <tr> <td>string $options Options when enabling module ('', 'noboxes')</td> <td>63</td> </tr> <tr> <td>string $path</td> <td>64</td> </tr> <tr> <td>string $value</td> <td>67</td> </tr> <tr> <td>XMLWriter $objWriter XML Writer</td> <td>68</td> </tr> <tr> <td>\Carbon\CarbonInterface|\DateTimeInterface|string|null $date</td> <td>71</td> </tr> <tr> <td>bool $absolute Get the absolute of the difference</td> <td>71</td> </tr> <tr> <td>int $notrigger 1=Does not execute triggers, 0=Execute triggers</td> <td>76</td> </tr> <tr> <td>TCPDF $pdf Object PDF</td> <td>77</td> </tr> <tr> <td>User $user Object user that modify</td> <td>81</td> </tr> <tr> <td>callable $callback</td> <td>85</td> </tr> <tr> <td>string $key</td> <td>86</td> </tr> <tr> <td>int $notrigger 0=launch triggers after, 1=disable triggers</td> <td>88</td> </tr> <tr> <td>Translate $langs Lang object to use for output</td> <td>88</td> </tr> <tr> <td>mixed $value</td> <td>115</td> </tr> <tr> <td>int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto</td> <td>126</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>127</td> </tr> <tr> <td>null|array|string $opts</td> <td>143</td> </tr> <tr> <td>string $name</td> <td>147</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>203</td> </tr> <tr> <td>string $id</td> <td>254</td> </tr> <tr> <td>null|array|\Stripe\Util\RequestOptions $opts</td> <td>394</td> </tr> <tr> <td>null|array $params</td> <td>545</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@pre</td> <td>* // store current object</td> <td>1</td> </tr> <tr> <td rowspan="5" style="vertical-align: top;">@private</td> <td>array</td> <td>1</td> </tr> <tr> <td>string</td> <td>1</td> </tr> <tr> <td>integer</td> <td>2</td> </tr> <tr> <td>static</td> <td>2</td> </tr> <tr> <td>*/</td> <td>9</td> </tr> <tr> <td rowspan="1418" style="vertical-align: top;">@property</td> <td>int $year</td> <td>1</td> </tr> <tr> <td>int $yearIso</td> <td>1</td> </tr> <tr> <td>int $month</td> <td>1</td> </tr> <tr> <td>int $day</td> <td>1</td> </tr> <tr> <td>int $hour</td> <td>1</td> </tr> <tr> <td>int $minute</td> <td>1</td> </tr> <tr> <td>int $second</td> <td>1</td> </tr> <tr> <td>int $micro</td> <td>1</td> </tr> <tr> <td>int $microsecond</td> <td>1</td> </tr> <tr> <td>int|float|string $timestamp seconds since the Unix Epoch</td> <td>1</td> </tr> <tr> <td>string $englishDayOfWeek the day of week in English</td> <td>1</td> </tr> <tr> <td>string $shortEnglishDayOfWeek the abbreviated day of week in English</td> <td>1</td> </tr> <tr> <td>string $englishMonth the month in English</td> <td>1</td> </tr> <tr> <td>string $shortEnglishMonth the abbreviated month in English</td> <td>1</td> </tr> <tr> <td>int $milliseconds</td> <td>1</td> </tr> <tr> <td>int $millisecond</td> <td>1</td> </tr> <tr> <td>int $milli</td> <td>1</td> </tr> <tr> <td>int $week 1 through 53</td> <td>1</td> </tr> <tr> <td>int $isoWeek 1 through 53</td> <td>1</td> </tr> <tr> <td>int $weekYear year according to week format</td> <td>1</td> </tr> <tr> <td>int $isoWeekYear year according to ISO week format</td> <td>1</td> </tr> <tr> <td>int $dayOfYear 1 through 366</td> <td>1</td> </tr> <tr> <td>int $age does a diffInYears() with default parameters</td> <td>1</td> </tr> <tr> <td>int $offset the timezone offset in seconds from UTC</td> <td>1</td> </tr> <tr> <td>int $offsetMinutes the timezone offset in minutes from UTC</td> <td>1</td> </tr> <tr> <td>int $offsetHours the timezone offset in hours from UTC</td> <td>1</td> </tr> <tr> <td>CarbonTimeZone $timezone the current timezone</td> <td>1</td> </tr> <tr> <td>CarbonTimeZone $tz alias of $timezone</td> <td>1</td> </tr> <tr> <td>int $years Total years of the current interval.</td> <td>1</td> </tr> <tr> <td>int $months Total months of the current interval.</td> <td>1</td> </tr> <tr> <td>int $weeks Total weeks of the current interval calculated from the days.</td> <td>1</td> </tr> <tr> <td>int $dayz Total days of the current interval (weeks * 7 + days).</td> <td>1</td> </tr> <tr> <td>int $hours Total hours of the current interval.</td> <td>1</td> </tr> <tr> <td>int $minutes Total minutes of the current interval.</td> <td>1</td> </tr> <tr> <td>int $seconds Total seconds of the current interval.</td> <td>1</td> </tr> <tr> <td>int $microseconds Total microseconds of the current interval.</td> <td>1</td> </tr> <tr> <td>int $milliseconds Total microseconds of the current interval.</td> <td>1</td> </tr> <tr> <td>int $microExcludeMilli Remaining microseconds without the milliseconds.</td> <td>1</td> </tr> <tr> <td>int $dayzExcludeWeeks Total days remaining in the final week of the current instance (days % 7).</td> <td>1</td> </tr> <tr> <td>int $daysExcludeWeeks alias of dayzExcludeWeeks</td> <td>1</td> </tr> <tr> <td>int $year</td> <td>1</td> </tr> <tr> <td>int $yearIso</td> <td>1</td> </tr> <tr> <td>int $month</td> <td>1</td> </tr> <tr> <td>int $day</td> <td>1</td> </tr> <tr> <td>int $hour</td> <td>1</td> </tr> <tr> <td>int $minute</td> <td>1</td> </tr> <tr> <td>int $second</td> <td>1</td> </tr> <tr> <td>int $micro</td> <td>1</td> </tr> <tr> <td>int $microsecond</td> <td>1</td> </tr> <tr> <td>int|float|string $timestamp seconds since the Unix Epoch</td> <td>1</td> </tr> <tr> <td>string $englishDayOfWeek the day of week in English</td> <td>1</td> </tr> <tr> <td>string $shortEnglishDayOfWeek the abbreviated day of week in English</td> <td>1</td> </tr> <tr> <td>string $englishMonth the month in English</td> <td>1</td> </tr> <tr> <td>string $shortEnglishMonth the abbreviated month in English</td> <td>1</td> </tr> <tr> <td>int $milliseconds</td> <td>1</td> </tr> <tr> <td>int $millisecond</td> <td>1</td> </tr> <tr> <td>int $milli</td> <td>1</td> </tr> <tr> <td>int $week 1 through 53</td> <td>1</td> </tr> <tr> <td>int $isoWeek 1 through 53</td> <td>1</td> </tr> <tr> <td>int $weekYear year according to week format</td> <td>1</td> </tr> <tr> <td>int $isoWeekYear year according to ISO week format</td> <td>1</td> </tr> <tr> <td>int $dayOfYear 1 through 366</td> <td>1</td> </tr> <tr> <td>int $age does a diffInYears() with default parameters</td> <td>1</td> </tr> <tr> <td>int $offset the timezone offset in seconds from UTC</td> <td>1</td> </tr> <tr> <td>int $offsetMinutes the timezone offset in minutes from UTC</td> <td>1</td> </tr> <tr> <td>int $offsetHours the timezone offset in hours from UTC</td> <td>1</td> </tr> <tr> <td>CarbonTimeZone $timezone the current timezone</td> <td>1</td> </tr> <tr> <td>CarbonTimeZone $tz alias of $timezone</td> <td>1</td> </tr> <tr> <td>integer part_number</td> <td>1</td> </tr> <tr> <td>integer size</td> <td>1</td> </tr> <tr> <td>string content</td> <td>1</td> </tr> <tr> <td>string type</td> <td>1</td> </tr> <tr> <td>string content_type</td> <td>1</td> </tr> <tr> <td>string id</td> <td>1</td> </tr> <tr> <td>string name</td> <td>1</td> </tr> <tr> <td>string disposition</td> <td>1</td> </tr> <tr> <td>string img_src</td> <td>1</td> </tr> <tr> <td>integer msglist</td> <td>1</td> </tr> <tr> <td>integer uid</td> <td>1</td> </tr> <tr> <td>integer msgn</td> <td>1</td> </tr> <tr> <td>Attribute subject</td> <td>1</td> </tr> <tr> <td>Attribute message_id</td> <td>1</td> </tr> <tr> <td>Attribute message_no</td> <td>1</td> </tr> <tr> <td>Attribute references</td> <td>1</td> </tr> <tr> <td>Attribute date</td> <td>1</td> </tr> <tr> <td>Attribute from</td> <td>1</td> </tr> <tr> <td>Attribute to</td> <td>1</td> </tr> <tr> <td>Attribute cc</td> <td>1</td> </tr> <tr> <td>Attribute bcc</td> <td>1</td> </tr> <tr> <td>Attribute reply_to</td> <td>1</td> </tr> <tr> <td>Attribute in_reply_to</td> <td>1</td> </tr> <tr> <td>Attribute sender</td> <td>1</td> </tr> <tr> <td>null|array|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.</td> <td>1</td> </tr> <tr> <td>int $daysInYear</td> <td>1</td> </tr> <tr> <td>int $dayOfWeek</td> <td>1</td> </tr> <tr> <td>int $dayOfYear</td> <td>1</td> </tr> <tr> <td>DoliDB $db</td> <td>2</td> </tr> <tr> <td>bool|null _authenticated</td> <td>2</td> </tr> <tr> <td>bool _authVerified</td> <td>2</td> </tr> <tr> <td>Tags parent parent tag</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $account The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.</td> <td>2</td> </tr> <tr> <td>null|string $address_city City/District/Suburb/Town/Village.</td> <td>2</td> </tr> <tr> <td>null|string $address_country Billing address country, if provided when creating card.</td> <td>2</td> </tr> <tr> <td>null|string $address_line1 Address line 1 (Street address/PO Box/Company name).</td> <td>2</td> </tr> <tr> <td>null|string $address_line1_check If <code>address_line1</code> was provided, results of the check: <code>pass</code>, <code>fail</code>, <code>unavailable</code>, or <code>unchecked</code>.</td> <td>2</td> </tr> <tr> <td>null|string $address_line2 Address line 2 (Apartment/Suite/Unit/Building).</td> <td>2</td> </tr> <tr> <td>null|string $address_state State/County/Province/Region.</td> <td>2</td> </tr> <tr> <td>null|string $address_zip ZIP or postal code.</td> <td>2</td> </tr> <tr> <td>null|string $address_zip_check If <code>address_zip</code> was provided, results of the check: <code>pass</code>, <code>fail</code>, <code>unavailable</code>, or <code>unchecked</code>.</td> <td>2</td> </tr> <tr> <td>null|string[] $available_payout_methods A set of available payout methods for this card. Only values from this set should be passed as the <code>method</code> when creating a payout.</td> <td>2</td> </tr> <tr> <td>string $brand Card brand. Can be <code>American Express</code>, <code>Diners Club</code>, <code>Discover</code>, <code>JCB</code>, <code>MasterCard</code>, <code>UnionPay</code>, <code>Visa</code>, or <code>Unknown</code>.</td> <td>2</td> </tr> <tr> <td>null|string $country Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.</td> <td>2</td> </tr> <tr> <td>null|string $currency Three-letter <a href="https://stripe.com/docs/payouts">ISO code for currency</a>. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.</td> <td>2</td> </tr> <tr> <td>null|string $cvc_check If a CVC was provided, results of the check: <code>pass</code>, <code>fail</code>, <code>unavailable</code>, or <code>unchecked</code>. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see <a href="https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge">Check if a card is valid without a charge</a>.</td> <td>2</td> </tr> <tr> <td>null|bool $default_for_currency Whether this card is the default external account for its currency.</td> <td>2</td> </tr> <tr> <td>null|string $dynamic_last4 (For tokenized numbers only.) The last four digits of the device account number.</td> <td>2</td> </tr> <tr> <td>int $exp_month Two-digit number representing the card's expiration month.</td> <td>2</td> </tr> <tr> <td>int $exp_year Four-digit number representing the card's expiration year.</td> <td>2</td> </tr> <tr> <td>null|string $fingerprint <p>Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.</p><p><em>Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.</em></p></td> <td>2</td> </tr> <tr> <td>string $funding Card funding type. Can be <code>credit</code>, <code>debit</code>, <code>prepaid</code>, or <code>unknown</code>.</td> <td>2</td> </tr> <tr> <td>string $last4 The last four digits of the card.</td> <td>2</td> </tr> <tr> <td>null|string $name Cardholder name.</td> <td>2</td> </tr> <tr> <td>null|string $status For external accounts, possible values are <code>new</code> and <code>errored</code>. If a transfer fails, the status is set to <code>errored</code> and transfers are stopped until account details are updated.</td> <td>2</td> </tr> <tr> <td>null|string $tokenization_method If the card number is tokenized, this is the method that was used. Can be <code>android_pay</code> (includes Google Pay), <code>apple_pay</code>, <code>masterpass</code>, <code>visa_checkout</code>, or null.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $affirm</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $afterpay_clearpay</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $bacs_debit</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $blik</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $boleto</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $customer_balance</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $fpx</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $grabpay</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $interac_present</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $konbini</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $link</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $oxxo</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $paynow</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $pix</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $promptpay</td> <td>2</td> </tr> <tr> <td>string $type The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $us_bank_account</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $wechat_pay</td> <td>2</td> </tr> <tr> <td>string $id Unique identifier for the object. Represented as the ISO country code for this country.</td> <td>2</td> </tr> <tr> <td>string $default_currency The default currency for this country. This applies to both payment methods and bank accounts.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $supported_bank_account_currencies Currencies that can be accepted in the specific country (for transfers).</td> <td>2</td> </tr> <tr> <td>string[] $supported_payment_currencies Currencies that can be accepted in the specified country (for payments).</td> <td>2</td> </tr> <tr> <td>string[] $supported_payment_methods Payment methods available in the specified country. You may need to enable some payment methods (e.g., <a href="https://stripe.com/docs/ach">ACH</a>) on your account before they appear in this list. The <code>stripe</code> payment method refers to <a href="https://stripe.com/docs/connect/destination-charges">charging through your platform</a>.</td> <td>2</td> </tr> <tr> <td>string[] $supported_transfer_countries Countries that can accept transfers from the specified country.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $verification_fields</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect Application that created the subscription.</td> <td>2</td> </tr> <tr> <td>null|float $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.</td> <td>2</td> </tr> <tr> <td>int $billing_cycle_anchor Determines the date of the first full invoice, and, for plans with <code>month</code> or <code>year</code> intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period</td> <td>2</td> </tr> <tr> <td>null|int $cancel_at A date in the future at which the subscription will automatically get canceled</td> <td>2</td> </tr> <tr> <td>bool $cancel_at_period_end If the subscription has been canceled with the <code>at_period_end</code> flag set to <code>true</code>, <code>cancel_at_period_end</code> on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.</td> <td>2</td> </tr> <tr> <td>null|int $canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with <code>cancel_at_period_end</code>, <code>canceled_at</code> will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.</td> <td>2</td> </tr> <tr> <td>string $collection_method Either <code>charge_automatically</code>, or <code>send_invoice</code>. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as <code>active</code>.</td> <td>2</td> </tr> <tr> <td>int $current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.</td> <td>2</td> </tr> <tr> <td>int $current_period_start Start of the current period that the subscription has been invoiced for.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer ID of the customer who owns the subscription.</td> <td>2</td> </tr> <tr> <td>null|int $days_until_due Number of days a customer has to pay invoices generated by this subscription. This value will be <code>null</code> for subscriptions where <code>collection_method=charge_automatically</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over <code>default_source</code>. If neither are set, invoices will use the customer's <a href="https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method</a> or <a href="https://stripe.com/docs/api/customers/object#customer_object-default_source">default_source</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If <code>default_payment_method</code> is also set, <code>default_payment_method</code> will take precedence. If neither are set, invoices will use the customer's <a href="https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method</a> or <a href="https://stripe.com/docs/api/customers/object#customer_object-default_source">default_source</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\TaxRate[] $default_tax_rates The tax rates that will apply to any subscription item that does not have <code>tax_rates</code> set. Invoices created will have their <code>default_tax_rates</code> populated from the subscription.</td> <td>2</td> </tr> <tr> <td>null|string $description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Discount $discount Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.</td> <td>2</td> </tr> <tr> <td>null|int $ended_at If the subscription has ended, the date the subscription ended.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SubscriptionItem> $items List of subscription items, each with an attached price.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $latest_invoice The most recent invoice this subscription has generated.</td> <td>2</td> </tr> <tr> <td>null|int $next_pending_invoice_item_invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at <code>pending_invoice_item_interval</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $pause_collection If specified, payment collection for this subscription will be paused.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_settings Payment settings passed on to invoices created by the subscription.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $pending_invoice_item_interval Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling <a href="https://stripe.com/docs/api#create_invoice">Create an invoice</a> for the given subscription at the specified interval.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\SetupIntent $pending_setup_intent You can use this <a href="https://stripe.com/docs/api/setup_intents">SetupIntent</a> to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the <a href="https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2">SCA Migration Guide</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $pending_update If specified, <a href="https://stripe.com/docs/billing/subscriptions/pending-updates">pending updates</a> that will be applied to the subscription once the <code>latest_invoice</code> has been paid.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\SubscriptionSchedule $schedule The schedule attached to the subscription</td> <td>2</td> </tr> <tr> <td>int $start_date Date when the subscription was first created. The date might differ from the <code>created</code> date due to backdating.</td> <td>2</td> </tr> <tr> <td>string $status <p>Possible values are <code>incomplete</code>, <code>incomplete_expired</code>, <code>trialing</code>, <code>active</code>, <code>past_due</code>, <code>canceled</code>, or <code>unpaid</code>.</p><p>For <code>collection_method=charge_automatically</code> a subscription moves into <code>incomplete</code> if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an <code>active</code> state. If the first invoice is not paid within 23 hours, the subscription transitions to <code>incomplete_expired</code>. This is a terminal state, the open invoice will be voided and no further invoices will be generated.</p><p>A subscription that is currently in a trial period is <code>trialing</code> and moves to <code>active</code> when the trial period is over.</p><p>If subscription <code>collection_method=charge_automatically</code> it becomes <code>past_due</code> when payment to renew it fails and <code>canceled</code> or <code>unpaid</code> (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.</p><p>If subscription <code>collection_method=send_invoice</code> it becomes <code>past_due</code> when its invoice is not paid by the due date, and <code>canceled</code> or <code>unpaid</code> if it is still not paid by an additional deadline after that. Note that when a subscription has a status of <code>unpaid</code>, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.</p></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription belongs to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.</td> <td>2</td> </tr> <tr> <td>null|int $trial_end If the subscription has a trial, the end of that trial.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $trial_settings Settings related to subscription trials.</td> <td>2</td> </tr> <tr> <td>null|int $trial_start If the subscription has a trial, the beginning of that trial.</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\AccountLinkService $accountLinks</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\AccountService $accounts</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ApplePayDomainService $applePayDomains</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ApplicationFeeService $applicationFees</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Apps\AppsServiceFactory $apps</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\BalanceService $balance</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\BalanceTransactionService $balanceTransactions</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\BillingPortal\BillingPortalServiceFactory $billingPortal</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ChargeService $charges</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Checkout\CheckoutServiceFactory $checkout</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\CountrySpecService $countrySpecs</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\CouponService $coupons</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\CreditNoteService $creditNotes</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\CustomerService $customers</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\DisputeService $disputes</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\EphemeralKeyService $ephemeralKeys</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\EventService $events</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ExchangeRateService $exchangeRates</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\FileLinkService $fileLinks</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\FileService $files</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\FinancialConnections\FinancialConnectionsServiceFactory $financialConnections</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Identity\IdentityServiceFactory $identity</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\InvoiceItemService $invoiceItems</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\InvoiceService $invoices</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Issuing\IssuingServiceFactory $issuing</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\MandateService $mandates</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\OAuthService $oauth</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PaymentIntentService $paymentIntents</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PaymentLinkService $paymentLinks</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PaymentMethodService $paymentMethods</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PayoutService $payouts</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PlanService $plans</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PriceService $prices</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ProductService $products</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\PromotionCodeService $promotionCodes</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\QuoteService $quotes</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Radar\RadarServiceFactory $radar</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\RefundService $refunds</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Reporting\ReportingServiceFactory $reporting</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ReviewService $reviews</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SetupAttemptService $setupAttempts</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SetupIntentService $setupIntents</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\ShippingRateService $shippingRates</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Sigma\SigmaServiceFactory $sigma</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SourceService $sources</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SubscriptionItemService $subscriptionItems</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SubscriptionScheduleService $subscriptionSchedules</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\SubscriptionService $subscriptions</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TaxCodeService $taxCodes</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TaxRateService $taxRates</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Terminal\TerminalServiceFactory $terminal</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TestHelpers\TestHelpersServiceFactory $testHelpers</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TokenService $tokens</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TopupService $topups</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\TransferService $transfers</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\Treasury\TreasuryServiceFactory $treasury</td> <td>2</td> </tr> <tr> <td>\Stripe\Service\WebhookEndpointService $webhookEndpoints</td> <td>2</td> </tr> <tr> <td>int $expires Time at which the key will expire. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string $secret The key's secret. You can use this value to make authorized requests to the Stripe API.</td> <td>2</td> </tr> <tr> <td>int $amount Amount (in %s) to be transferred to your bank account or debit card.</td> <td>2</td> </tr> <tr> <td>int $arrival_date Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.</td> <td>2</td> </tr> <tr> <td>bool $automatic Returns <code>true</code> if the payout was created by an <a href="https://stripe.com/docs/payouts#payout-schedule">automated payout schedule</a>, and <code>false</code> if it was <a href="https://stripe.com/docs/payouts#manual-payouts">requested manually</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BankAccount|\Stripe\Card $destination ID of the bank account or card the payout was sent to.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.</td> <td>2</td> </tr> <tr> <td>null|string $failure_code Error code explaining reason for payout failure if available. See <a href="https://stripe.com/docs/api#payout_failures">Types of payout failures</a> for a list of failure codes.</td> <td>2</td> </tr> <tr> <td>null|string $failure_message Message to user further explaining reason for payout failure if available.</td> <td>2</td> </tr> <tr> <td>string $method The method used to send this payout, which can be <code>standard</code> or <code>instant</code>. <code>instant</code> is only supported for payouts to debit cards. (See <a href="https://stripe.com/blog/instant-payouts-for-marketplaces">Instant payouts for marketplaces</a> for more information.)</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Payout $original_payout If the payout reverses another, this is the ID of the original payout.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Payout $reversed_by If the payout was reversed, this is the ID of the payout that reverses this payout.</td> <td>2</td> </tr> <tr> <td>string $source_type The source balance this payout came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.</td> <td>2</td> </tr> <tr> <td>string $status Current status of the payout: <code>paid</code>, <code>pending</code>, <code>in_transit</code>, <code>canceled</code> or <code>failed</code>. A payout is <code>pending</code> until it is submitted to the bank, when it becomes <code>in_transit</code>. The status then changes to <code>paid</code> if the transaction goes through, or to <code>failed</code> or <code>canceled</code> (within 5 business days). Some failed payouts may initially show as <code>paid</code> but then change to <code>failed</code>.</td> <td>2</td> </tr> <tr> <td>string $type Can be <code>bank_account</code> or <code>card</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $charge ID of the charge that was refunded.</td> <td>2</td> </tr> <tr> <td>null|string $description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.</td> <td>2</td> </tr> <tr> <td>null|string $failure_reason If the refund failed, the reason for refund failure if known. Possible values are <code>lost_or_stolen_card</code>, <code>expired_or_canceled_card</code>, <code>charge_for_pending_refund_disputed</code>, <code>insufficient_funds</code>, <code>declined</code>, <code>merchant_request</code> or <code>unknown</code>.</td> <td>2</td> </tr> <tr> <td>null|string $instructions_email Email to which refund instructions, if required, are sent to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $next_action</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was refunded.</td> <td>2</td> </tr> <tr> <td>null|string $reason Reason for the refund, either user-provided (<code>duplicate</code>, <code>fraudulent</code>, or <code>requested_by_customer</code>) or generated by Stripe internally (<code>expired_uncaptured_charge</code>).</td> <td>2</td> </tr> <tr> <td>null|string $receipt_number This is the transaction number that appears on email receipts sent for this refund.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TransferReversal $source_transfer_reversal The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.</td> <td>2</td> </tr> <tr> <td>null|string $status Status of the refund. For credit card refunds, this can be <code>pending</code>, <code>succeeded</code>, or <code>failed</code>. For other types of refunds, it can be <code>pending</code>, <code>requires_action</code>, <code>succeeded</code>, <code>failed</code>, or <code>canceled</code>. Refer to our <a href="https://stripe.com/docs/refunds#failed-refunds">refunds</a> documentation for more details.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TransferReversal $transfer_reversal If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.</td> <td>2</td> </tr> <tr> <td>null|string $account The connected account that originated the event.</td> <td>2</td> </tr> <tr> <td>null|string $api_version The Stripe API version used to render <code>data</code>. <em>Note: This property is populated only for events on or after October 31, 2014</em>.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $data</td> <td>2</td> </tr> <tr> <td>int $pending_webhooks Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $request Information on the API request that instigated the event.</td> <td>2</td> </tr> <tr> <td>string $type Description of the event (e.g., <code>invoice.created</code> or <code>charge.refunded</code>).</td> <td>2</td> </tr> <tr> <td>null|string $country Two-letter ISO code representing the country of the tax ID.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer ID of the customer.</td> <td>2</td> </tr> <tr> <td>string $type Type of the tax ID, one of <code>ae_trn</code>, <code>au_abn</code>, <code>au_arn</code>, <code>bg_uic</code>, <code>br_cnpj</code>, <code>br_cpf</code>, <code>ca_bn</code>, <code>ca_gst_hst</code>, <code>ca_pst_bc</code>, <code>ca_pst_mb</code>, <code>ca_pst_sk</code>, <code>ca_qst</code>, <code>ch_vat</code>, <code>cl_tin</code>, <code>eg_tin</code>, <code>es_cif</code>, <code>eu_oss_vat</code>, <code>eu_vat</code>, <code>gb_vat</code>, <code>ge_vat</code>, <code>hk_br</code>, <code>hu_tin</code>, <code>id_npwp</code>, <code>il_vat</code>, <code>in_gst</code>, <code>is_vat</code>, <code>jp_cn</code>, <code>jp_rn</code>, <code>jp_trn</code>, <code>ke_pin</code>, <code>kr_brn</code>, <code>li_uid</code>, <code>mx_rfc</code>, <code>my_frp</code>, <code>my_itn</code>, <code>my_sst</code>, <code>no_vat</code>, <code>nz_gst</code>, <code>ph_tin</code>, <code>ru_inn</code>, <code>ru_kpp</code>, <code>sa_vat</code>, <code>sg_gst</code>, <code>sg_uen</code>, <code>si_tin</code>, <code>th_vat</code>, <code>tr_tin</code>, <code>tw_vat</code>, <code>ua_vat</code>, <code>us_ein</code>, or <code>za_vat</code>. Note that some legacy tax IDs have type <code>unknown</code></td> <td>2</td> </tr> <tr> <td>string $value Value of the tax ID.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $verification Tax ID verification information.</td> <td>2</td> </tr> <tr> <td>int $amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a> (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or <a href="https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts">equivalent in charge currency</a>. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).</td> <td>2</td> </tr> <tr> <td>int $amount_capturable Amount that can be captured from this PaymentIntent.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $amount_details</td> <td>2</td> </tr> <tr> <td>int $amount_received Amount that was collected by this PaymentIntent.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect application that created the PaymentIntent.</td> <td>2</td> </tr> <tr> <td>null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $automatic_payment_methods Settings to configure compatible payment methods from the <a href="https://dashboard.stripe.com/settings/payment_methods">Stripe Dashboard</a></td> <td>2</td> </tr> <tr> <td>null|int $canceled_at Populated when <code>status</code> is <code>canceled</code>, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string $cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (<code>duplicate</code>, <code>fraudulent</code>, <code>requested_by_customer</code>, or <code>abandoned</code>) or generated by Stripe internally (<code>failed_invoice</code>, <code>void_invoice</code>, or <code>automatic</code>).</td> <td>2</td> </tr> <tr> <td>string $capture_method Controls when the funds will be captured from the customer's account.</td> <td>2</td> </tr> <tr> <td>null|string $client_secret <p>The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.</p><p>The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.</p><p>Refer to our docs to <a href="https://stripe.com/docs/payments/accept-a-payment?ui=elements">accept a payment</a> and learn about how <code>client_secret</code> should be handled.</p></td> <td>2</td> </tr> <tr> <td>string $confirmation_method</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer <p>ID of the Customer this PaymentIntent belongs to, if one exists.</p><p>Payment methods attached to other Customers cannot be used with this PaymentIntent.</p><p>If present in combination with <a href="https://stripe.com/docs/api#payment_intent_object-setup_future_usage">setup_future_usage</a>, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.</p></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice ID of the invoice that created this PaymentIntent, if it exists.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $latest_charge The latest charge created by this payment intent.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the <a href="https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata">documentation</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a> for details.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used in this PaymentIntent.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this PaymentIntent.</td> <td>2</td> </tr> <tr> <td>string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $processing If present, this property tells you about the processing state of the payment.</td> <td>2</td> </tr> <tr> <td>null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. If <code>receipt_email</code> is specified for a payment in live mode, a receipt will be sent regardless of your <a href="https://dashboard.stripe.com/account/emails">email settings</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any.</td> <td>2</td> </tr> <tr> <td>null|string $setup_future_usage <p>Indicates that you intend to make future payments with this PaymentIntent's payment method.</p><p>Providing this parameter will <a href="https://stripe.com/docs/payments/save-during-payment">attach the payment method</a> to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be <a href="https://stripe.com/docs/api/payment_methods/attach">attached</a> to a Customer after the transaction completes.</p><p>When processing card payments, Stripe also uses <code>setup_future_usage</code> to dynamically optimize your payment flow and comply with regional legislation and network rules, such as <a href="https://stripe.com/docs/strong-customer-authentication">SCA</a>.</p></td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping Shipping information for this PaymentIntent.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor_suffix Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.</td> <td>2</td> </tr> <tr> <td>string $status Status of this PaymentIntent, one of <code>requires_payment_method</code>, <code>requires_confirmation</code>, <code>requires_action</code>, <code>processing</code>, <code>requires_capture</code>, <code>canceled</code>, or <code>succeeded</code>. Read more about each PaymentIntent <a href="https://stripe.com/docs/payments/intents#intent-statuses">status</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a> for details.</td> <td>2</td> </tr> <tr> <td>null|string $transfer_group A string that identifies the resulting payment as part of a group. See the PaymentIntents <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a> for details.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application">application</a> on the SetupIntent at the time of this confirmation.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer">customer</a> on the SetupIntent at the time of this confirmation.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of">on_behalf_of</a> on the SetupIntent at the time of this confirmation.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $setup_error The error encountered during this attempt to confirm the SetupIntent, if any.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to.</td> <td>2</td> </tr> <tr> <td>string $status Status of this SetupAttempt, one of <code>requires_confirmation</code>, <code>requires_action</code>, <code>processing</code>, <code>succeeded</code>, <code>failed</code>, or <code>abandoned</code>.</td> <td>2</td> </tr> <tr> <td>string $usage The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage">usage</a> on the SetupIntent at the time of this confirmation, one of <code>off_session</code> or <code>on_session</code>.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the payment link's <code>url</code> is active. If <code>false</code>, customers visiting the URL will be shown a page saying that the link has been deactivated.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $after_completion</td> <td>2</td> </tr> <tr> <td>bool $allow_promotion_codes Whether user redeemable promotion codes are enabled.</td> <td>2</td> </tr> <tr> <td>null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.</td> <td>2</td> </tr> <tr> <td>null|float $application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.</td> <td>2</td> </tr> <tr> <td>string $billing_address_collection Configuration for collecting the customer's billing address.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $consent_collection When set, provides configuration to gather active consent from customers.</td> <td>2</td> </tr> <tr> <td>string $customer_creation Configuration for Customer creation during checkout.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $invoice_creation Configuration for creating invoice for payment mode payment links.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout.</td> <td>2</td> </tr> <tr> <td>string $payment_method_collection Configuration for collecting a payment method during checkout.</td> <td>2</td> </tr> <tr> <td>null|string[] $payment_method_types The list of payment method types that customers can use. When <code>null</code>, Stripe will dynamically show relevant payment methods you've enabled in your <a href="https://dashboard.stripe.com/settings/payment_methods">payment method settings</a>.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $phone_number_collection</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_address_collection Configuration for collecting the customer's shipping address.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $shipping_options The shipping rate options applied to the session.</td> <td>2</td> </tr> <tr> <td>string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use <code>subscription_data</code>.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $tax_id_collection</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.</td> <td>2</td> </tr> <tr> <td>string $url The public URL that can be shared with customers.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\BankAccount $bank_account <p>These bank accounts are payment methods on <code>Customer</code> objects.</p><p>On the other hand <a href="https://stripe.com/docs/api#external_accounts">External Accounts</a> are transfer destinations on <code>Account</code> objects for <a href="https://stripe.com/docs/connect/custom-accounts">Custom accounts</a>. They can be bank accounts or debit cards as well, and are documented in the links above.</p><p>Related guide: <a href="https://stripe.com/docs/payments/bank-debits-transfers">Bank Debits and Transfers</a>.</p></td> <td>2</td> </tr> <tr> <td>null|\Stripe\Card $card <p>You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.</p><p>Related guide: <a href="https://stripe.com/docs/sources/cards">Card Payments with Sources</a>.</p></td> <td>2</td> </tr> <tr> <td>null|string $client_ip IP address of the client that generated the token.</td> <td>2</td> </tr> <tr> <td>string $type Type of the token: <code>account</code>, <code>bank_account</code>, <code>card</code>, or <code>pii</code>.</td> <td>2</td> </tr> <tr> <td>bool $used Whether this token has already been used (tokens can be used only once).</td> <td>2</td> </tr> <tr> <td>null|string $checkout_session The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.</td> <td>2</td> </tr> <tr> <td>\Stripe\Coupon $coupon Hash describing the coupon applied to create this discount.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer The ID of the customer associated with this discount.</td> <td>2</td> </tr> <tr> <td>null|int $end If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.</td> <td>2</td> </tr> <tr> <td>string $id The ID of the discount object.</td> <td>2</td> </tr> <tr> <td>null|string $invoice The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.</td> <td>2</td> </tr> <tr> <td>null|string $invoice_item The invoice item id (or invoice line item id for invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.</td> <td>2</td> </tr> <tr> <td>string $object String representing the object’s type. Objects of the same type share the same value.</td> <td>2</td> </tr> <tr> <td>null|string $promotion_code The promotion code applied to create this discount.</td> <td>2</td> </tr> <tr> <td>int $start Date that the coupon was applied.</td> <td>2</td> </tr> <tr> <td>null|string $subscription The subscription that this coupon is applied to, if it is applied to a particular subscription.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the product is currently available for purchase.</td> <td>2</td> </tr> <tr> <td>null|string[] $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., <code>["color", "size"]</code>).</td> <td>2</td> </tr> <tr> <td>null|string $caption A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of <code>type=good</code>.</td> <td>2</td> </tr> <tr> <td>null|string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of <code>type=good</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Price $default_price The ID of the <a href="https://stripe.com/docs/api/prices">Price</a> object that is the default price for this product.</td> <td>2</td> </tr> <tr> <td>null|string $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.</td> <td>2</td> </tr> <tr> <td>string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.</td> <td>2</td> </tr> <tr> <td>string $name The product's name, meant to be displayable to the customer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.</td> <td>2</td> </tr> <tr> <td>null|bool $shippable Whether this product is shipped (i.e., physical goods).</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID.</td> <td>2</td> </tr> <tr> <td>string $type The type of the product. The product is either of type <code>good</code>, which is eligible for use with Orders and SKUs, or <code>service</code>, which is eligible for use with Subscriptions and Plans.</td> <td>2</td> </tr> <tr> <td>null|string $unit_label A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.</td> <td>2</td> </tr> <tr> <td>null|string $url A URL of a publicly-accessible webpage for this product.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $alternate_statement_descriptors</td> <td>2</td> </tr> <tr> <td>int $amount Amount intended to be collected by this payment. A positive integer representing how much to charge in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a> (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or <a href="https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts">equivalent in charge currency</a>. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).</td> <td>2</td> </tr> <tr> <td>int $amount_captured Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).</td> <td>2</td> </tr> <tr> <td>int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect application that created the charge.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\ApplicationFee $application_fee The application fee (if any) for the charge. <a href="https://stripe.com/docs/connect/direct-charges#collecting-fees">See the Connect documentation</a> for details.</td> <td>2</td> </tr> <tr> <td>null|int $application_fee_amount The amount of the application fee (if any) requested for the charge. <a href="https://stripe.com/docs/connect/direct-charges#collecting-fees">See the Connect documentation</a> for details.</td> <td>2</td> </tr> <tr> <td>null|string $authorization_code Authorization code on the charge.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).</td> <td>2</td> </tr> <tr> <td>null|string $calculated_statement_descriptor The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.</td> <td>2</td> </tr> <tr> <td>bool $captured If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer ID of the customer this charge is for if one exists.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $destination ID of an existing, connected Stripe account to transfer funds to if <code>transfer_data</code> was specified in the charge request.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Dispute $dispute Details about the dispute if the charge has been disputed.</td> <td>2</td> </tr> <tr> <td>bool $disputed Whether the charge has been disputed.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $failure_balance_transaction ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.</td> <td>2</td> </tr> <tr> <td>null|string $failure_code Error code explaining reason for charge failure if available (see <a href="https://stripe.com/docs/error-codes">the errors section</a> for a list of codes).</td> <td>2</td> </tr> <tr> <td>null|string $failure_message Message to user further explaining reason for charge failure if available.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $fraud_details Information on fraud assessments for the charge.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice ID of the invoice this charge is for if one exists.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $level3</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the <a href="https://stripe.com/docs/connect/charges-transfers">Connect documentation</a> for details.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $outcome Details about whether the payment was accepted, and why. See <a href="https://stripe.com/docs/declines">understanding declines</a> for details.</td> <td>2</td> </tr> <tr> <td>bool $paid <code>true</code> if the charge succeeded, or was successfully authorized for later capture.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent associated with this charge, if one exists.</td> <td>2</td> </tr> <tr> <td>null|string $payment_method ID of the payment method used in this charge.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_method_details Details about the payment method at the time of the transaction.</td> <td>2</td> </tr> <tr> <td>null|string $receipt_email This is the email address that the receipt for this charge was sent to.</td> <td>2</td> </tr> <tr> <td>null|string $receipt_number This is the transaction number that appears on email receipts sent for this charge. This attribute will be <code>null</code> until a receipt has been sent.</td> <td>2</td> </tr> <tr> <td>null|string $receipt_url This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.</td> <td>2</td> </tr> <tr> <td>bool $refunded Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\Refund> $refunds A list of refunds that have been applied to the charge.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Review $review ID of the review associated with this charge if one exists.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping Shipping information for the charge.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to <code>payment_method</code> or <code>payment_method_details</code> instead.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Transfer $source_transfer The transfer ID which created this charge. Only present if the charge came from another Stripe account. <a href="https://stripe.com/docs/connect/destination-charges">See the Connect documentation</a> for details.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor For card charges, use <code>statement_descriptor_suffix</code> instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor_suffix Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.</td> <td>2</td> </tr> <tr> <td>string $status The status of the payment is either <code>succeeded</code>, <code>pending</code>, or <code>failed</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Transfer $transfer ID of the transfer to the <code>destination</code> account (only applicable if the charge was created using the <code>destination</code> parameter).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data An optional dictionary including the account to automatically transfer to as part of a destination charge. <a href="https://stripe.com/docs/connect/destination-charges">See the Connect documentation</a> for details.</td> <td>2</td> </tr> <tr> <td>string $error</td> <td>2</td> </tr> <tr> <td>string $error_description</td> <td>2</td> </tr> <tr> <td>null|string $billing_zip The ZIP or postal code of the card used, if applicable.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $charge The charge associated with this review.</td> <td>2</td> </tr> <tr> <td>null|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, <code>disputed</code>, or <code>redacted</code>.</td> <td>2</td> </tr> <tr> <td>null|string $ip_address The IP address where the payment originated.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $ip_address_location Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.</td> <td>2</td> </tr> <tr> <td>bool $open If <code>true</code>, the review needs action.</td> <td>2</td> </tr> <tr> <td>string $opened_reason The reason the review was opened. One of <code>rule</code> or <code>manual</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.</td> <td>2</td> </tr> <tr> <td>string $reason The reason the review is currently open or closed. One of <code>rule</code>, <code>manual</code>, <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, <code>disputed</code>, or <code>redacted</code>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.</td> <td>2</td> </tr> <tr> <td>int $amount Amount transferred.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.</td> <td>2</td> </tr> <tr> <td>null|int $expected_availability_date Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.</td> <td>2</td> </tr> <tr> <td>null|string $failure_code Error code explaining reason for top-up failure if available (see <a href="https://stripe.com/docs/api#errors">the errors section</a> for a list of codes).</td> <td>2</td> </tr> <tr> <td>null|string $failure_message Message to user further explaining reason for top-up failure if available.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Source $source For most Stripe users, the source of every top-up is a bank account. This hash is then the <a href="https://stripe.com/docs/api#source_object">source object</a> describing that bank account.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.</td> <td>2</td> </tr> <tr> <td>string $status The status of the top-up is either <code>canceled</code>, <code>failed</code>, <code>pending</code>, <code>reversed</code>, or <code>succeeded</code>.</td> <td>2</td> </tr> <tr> <td>null|string $transfer_group A string that identifies this top-up as part of a group.</td> <td>2</td> </tr> <tr> <td>int $expires_at The timestamp at which this account link will expire.</td> <td>2</td> </tr> <tr> <td>string $url The URL for the account link.</td> <td>2</td> </tr> <tr> <td>int $amount_reversed</td> <td>2</td> </tr> <tr> <td>string $balance_transaction</td> <td>2</td> </tr> <tr> <td>string $bank_account</td> <td>2</td> </tr> <tr> <td>string $card</td> <td>2</td> </tr> <tr> <td>int $date</td> <td>2</td> </tr> <tr> <td>string $description</td> <td>2</td> </tr> <tr> <td>string $destination</td> <td>2</td> </tr> <tr> <td>string $failure_code</td> <td>2</td> </tr> <tr> <td>string $failure_message</td> <td>2</td> </tr> <tr> <td>bool $livemode</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $metadata</td> <td>2</td> </tr> <tr> <td>string $method</td> <td>2</td> </tr> <tr> <td>string $recipient</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection $reversals</td> <td>2</td> </tr> <tr> <td>bool $reversed</td> <td>2</td> </tr> <tr> <td>string $source_type</td> <td>2</td> </tr> <tr> <td>string $statement_descriptor</td> <td>2</td> </tr> <tr> <td>string $status</td> <td>2</td> </tr> <tr> <td>string $next_page</td> <td>2</td> </tr> <tr> <td>int $total_count</td> <td>2</td> </tr> <tr> <td>null|int $expires_at The time at which the file expires and is no longer available in epoch seconds.</td> <td>2</td> </tr> <tr> <td>null|string $filename A filename for the file, suitable for saving to a filesystem.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\FileLink> $links A list of <a href="https://stripe.com/docs/api#file_links">file links</a> that point at this file.</td> <td>2</td> </tr> <tr> <td>string $purpose The <a href="https://stripe.com/docs/file-upload#uploading-a-file">purpose</a> of the uploaded file.</td> <td>2</td> </tr> <tr> <td>int $size The size in bytes of the file object.</td> <td>2</td> </tr> <tr> <td>null|string $title A user friendly title for the document.</td> <td>2</td> </tr> <tr> <td>null|string $type The type of the file returned (e.g., <code>csv</code>, <code>pdf</code>, <code>jpg</code>, or <code>png</code>).</td> <td>2</td> </tr> <tr> <td>null|string $url The URL from which the file can be downloaded using your live secret API key.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $bank_transfer</td> <td>2</td> </tr> <tr> <td>string $funding_type The <code>funding_type</code> of the returned instructions</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $business_profile Business information about the account.</td> <td>2</td> </tr> <tr> <td>null|string $business_type The business type.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $capabilities</td> <td>2</td> </tr> <tr> <td>null|bool $charges_enabled Whether the account can create live charges.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $company</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $controller</td> <td>2</td> </tr> <tr> <td>null|string $country The account's country.</td> <td>2</td> </tr> <tr> <td>null|int $created Time at which the account was connected. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string $default_currency Three-letter ISO currency code representing the default currency for the account. This must be a currency that <a href="https://stripe.com/docs/payouts">Stripe supports in the account's country</a>.</td> <td>2</td> </tr> <tr> <td>null|bool $details_submitted Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.</td> <td>2</td> </tr> <tr> <td>null|string $email An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card> $external_accounts External accounts (bank accounts and debit cards) currently attached to this account</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Person $individual <p>This is an object representing a person associated with a Stripe account.</p><p>A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the <a href="https://stripe.com/docs/connect/standard-accounts">Standard onboarding</a> or <a href="https://stripe.com/docs/connect/express-accounts">Express onboarding documentation</a> for information about platform pre-filling and account onboarding steps.</p><p>Related guide: <a href="https://stripe.com/docs/connect/identity-verification-api#person-information">Handling Identity Verification with the API</a>.</p></td> <td>2</td> </tr> <tr> <td>null|bool $payouts_enabled Whether Stripe can send payouts to this account.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $settings Options for customizing how the account functions within Stripe.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $tos_acceptance</td> <td>2</td> </tr> <tr> <td>null|string $type The Stripe account type. Can be <code>standard</code>, <code>express</code>, or <code>custom</code>.</td> <td>2</td> </tr> <tr> <td>string $description A detailed description of which types of products the tax code represents.</td> <td>2</td> </tr> <tr> <td>string $name A short name for the tax code.</td> <td>2</td> </tr> <tr> <td>null|string $account The account the person is associated with.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $address</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $dob</td> <td>2</td> </tr> <tr> <td>null|string $email The person's email address.</td> <td>2</td> </tr> <tr> <td>null|string $first_name The person's first name.</td> <td>2</td> </tr> <tr> <td>null|string $first_name_kana The Kana variation of the person's first name (Japan only).</td> <td>2</td> </tr> <tr> <td>null|string $first_name_kanji The Kanji variation of the person's first name (Japan only).</td> <td>2</td> </tr> <tr> <td>null|string[] $full_name_aliases A list of alternate names or aliases that the person is known by.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.</td> <td>2</td> </tr> <tr> <td>null|string $gender The person's gender (International regulations require either "male" or "female").</td> <td>2</td> </tr> <tr> <td>null|bool $id_number_provided Whether the person's <code>id_number</code> was provided.</td> <td>2</td> </tr> <tr> <td>null|bool $id_number_secondary_provided Whether the person's <code>id_number_secondary</code> was provided.</td> <td>2</td> </tr> <tr> <td>null|string $last_name The person's last name.</td> <td>2</td> </tr> <tr> <td>null|string $last_name_kana The Kana variation of the person's last name (Japan only).</td> <td>2</td> </tr> <tr> <td>null|string $last_name_kanji The Kanji variation of the person's last name (Japan only).</td> <td>2</td> </tr> <tr> <td>null|string $maiden_name The person's maiden name.</td> <td>2</td> </tr> <tr> <td>null|string $nationality The country where the person is a national.</td> <td>2</td> </tr> <tr> <td>null|string $phone The person's phone number.</td> <td>2</td> </tr> <tr> <td>null|string $political_exposure Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $registered_address</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $relationship</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when.</td> <td>2</td> </tr> <tr> <td>null|bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $verification</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $ach_credit_transfer</td> <td>2</td> </tr> <tr> <td>string $customer_data</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period</td> <td>2</td> </tr> <tr> <td>\Stripe\Plan $plan <p>You can now model subscriptions more flexibly using the <a href="https://stripe.com/docs/api#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p><p>Plans define the base price, currency, and billing cycle for recurring purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a> and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.</p></td> <td>2</td> </tr> <tr> <td>\Stripe\Price $price <p>Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>, <a href="https://stripe.com/docs/billing/invoices/create">create an invoice</a>, and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.</p></td> <td>2</td> </tr> <tr> <td>null|int $quantity The <a href="https://stripe.com/docs/subscriptions/quantities">quantity</a> of the plan to which the customer should be subscribed.</td> <td>2</td> </tr> <tr> <td>string $subscription The <code>subscription</code> this <code>subscription_item</code> belongs to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this <code>subscription_item</code>. When set, the <code>default_tax_rates</code> on the subscription do not apply to this <code>subscription_item</code>.</td> <td>2</td> </tr> <tr> <td>int $amount Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).</td> <td>2</td> </tr> <tr> <td>\Stripe\BalanceTransaction[] $balance_transactions List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Charge $charge ID of the charge that was disputed.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $evidence_details</td> <td>2</td> </tr> <tr> <td>bool $is_charge_refundable If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.</td> <td>2</td> </tr> <tr> <td>null|string $network_reason_code Network-dependent reason code for the dispute.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was disputed.</td> <td>2</td> </tr> <tr> <td>string $reason Reason given by cardholder for dispute. Possible values are <code>bank_cannot_process</code>, <code>check_returned</code>, <code>credit_not_processed</code>, <code>customer_initiated</code>, <code>debit_not_authorized</code>, <code>duplicate</code>, <code>fraudulent</code>, <code>general</code>, <code>incorrect_account_details</code>, <code>insufficient_funds</code>, <code>product_not_received</code>, <code>product_unacceptable</code>, <code>subscription_canceled</code>, or <code>unrecognized</code>. Read more about <a href="https://stripe.com/docs/disputes/categories">dispute reasons</a>.</td> <td>2</td> </tr> <tr> <td>string $status Current status of dispute. Possible values are <code>warning_needs_response</code>, <code>warning_under_review</code>, <code>warning_closed</code>, <code>needs_response</code>, <code>under_review</code>, <code>charge_refunded</code>, <code>won</code>, or <code>lost</code>.</td> <td>2</td> </tr> <tr> <td>int $amount Amount (in the <code>currency</code> specified) of the invoice item. This should always be equal to <code>unit_amount * quantity</code>.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer The ID of the customer who will be billed when this invoice item is billed.</td> <td>2</td> </tr> <tr> <td>int $date Time at which the object was created. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>bool $discountable If true, discounts will apply to this invoice item. Always false for prorations.</td> <td>2</td> </tr> <tr> <td>null|(string|\Stripe\Discount)[] $discounts The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use <code>expand[]=discounts</code> to expand each discount.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice The ID of the invoice this invoice item belongs to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Plan $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Price $price The price of the invoice item.</td> <td>2</td> </tr> <tr> <td>bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.</td> <td>2</td> </tr> <tr> <td>int $quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Subscription $subscription The subscription that this invoice item has been created for, if any.</td> <td>2</td> </tr> <tr> <td>null|string $subscription_item The subscription item that this invoice item has been created for, if any.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the invoice item. When set, the <code>default_tax_rates</code> on the invoice do not apply to this invoice item.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice item belongs to.</td> <td>2</td> </tr> <tr> <td>null|int $unit_amount Unit amount (in the <code>currency</code> specified) of the invoice item.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect application that created the SetupIntent.</td> <td>2</td> </tr> <tr> <td>null|string $cancellation_reason Reason for cancellation of this SetupIntent, one of <code>abandoned</code>, <code>requested_by_customer</code>, or <code>duplicate</code>.</td> <td>2</td> </tr> <tr> <td>null|string $client_secret <p>The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.</p><p>The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.</p></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer <p>ID of the Customer this SetupIntent belongs to, if one exists.</p><p>If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.</p></td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $last_setup_error The error encountered in the previous SetupIntent confirmation.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\SetupAttempt $latest_attempt The most recent SetupAttempt for this SetupIntent.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Mandate $mandate ID of the multi use Mandate generated by the SetupIntent.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account (if any) for which the setup is intended.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupIntent.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this SetupIntent.</td> <td>2</td> </tr> <tr> <td>string[] $payment_method_types The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Mandate $single_use_mandate ID of the single_use Mandate generated by the SetupIntent.</td> <td>2</td> </tr> <tr> <td>string $status <a href="https://stripe.com/docs/payments/intents#intent-statuses">Status</a> of this SetupIntent, one of <code>requires_payment_method</code>, <code>requires_confirmation</code>, <code>requires_action</code>, <code>processing</code>, <code>canceled</code>, or <code>succeeded</code>.</td> <td>2</td> </tr> <tr> <td>string $usage <p>Indicates how the payment method is intended to be used in the future.</p><p>Use <code>on_session</code> if you intend to only reuse the payment method when the customer is in your checkout flow. Use <code>off_session</code> if your customer may or may not be in your checkout flow. If not provided, this value defaults to <code>off_session</code>.</p></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Transfer $transfer ID of the transfer that was reversed.</td> <td>2</td> </tr> <tr> <td>int $amount Amount in %s to be transferred.</td> <td>2</td> </tr> <tr> <td>int $amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this transfer on your account balance.</td> <td>2</td> </tr> <tr> <td>int $created Time that this record of the transfer was first created.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $destination ID of the Stripe account the transfer was sent to.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TransferReversal> $reversals A list of reversals that have been applied to the transfer.</td> <td>2</td> </tr> <tr> <td>bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.</td> <td>2</td> </tr> <tr> <td>null|string $source_type The source balance this transfer came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.</td> <td>2</td> </tr> <tr> <td>int $amount The integer amount in %s representing the total amount of the credit note, including tax.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer ID of the customer.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\CustomerBalanceTransaction $customer_balance_transaction Customer balance transaction related to this credit note.</td> <td>2</td> </tr> <tr> <td>int $discount_amount The integer amount in %s representing the total amount of discount that was credited.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Invoice $invoice ID of the invoice.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CreditNoteLineItem> $lines Line items that make up the credit note</td> <td>2</td> </tr> <tr> <td>null|string $memo Customer-facing text that appears on the credit note PDF.</td> <td>2</td> </tr> <tr> <td>string $number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.</td> <td>2</td> </tr> <tr> <td>null|int $out_of_band_amount Amount that was credited outside of Stripe.</td> <td>2</td> </tr> <tr> <td>string $pdf The link to download the PDF of the credit note.</td> <td>2</td> </tr> <tr> <td>null|string $reason Reason for issuing this credit note, one of <code>duplicate</code>, <code>fraudulent</code>, <code>order_change</code>, or <code>product_unsatisfactory</code></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Refund $refund Refund related to this credit note.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_cost The details of the cost of shipping, including the ShippingRate applied to the invoice.</td> <td>2</td> </tr> <tr> <td>string $status Status of this credit note, one of <code>issued</code> or <code>void</code>. Learn more about <a href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</td> <td>2</td> </tr> <tr> <td>int $subtotal The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts.</td> <td>2</td> </tr> <tr> <td>null|int $subtotal_excluding_tax The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items.</td> <td>2</td> </tr> <tr> <td>int $total The integer amount in %s representing the total amount of the credit note, including tax and all discount.</td> <td>2</td> </tr> <tr> <td>null|int $total_excluding_tax The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts.</td> <td>2</td> </tr> <tr> <td>string $type Type of this credit note, one of <code>pre_payment</code> or <code>post_payment</code>. A <code>pre_payment</code> credit note means it was issued when the invoice was open. A <code>post_payment</code> credit note means it was issued when the invoice was paid.</td> <td>2</td> </tr> <tr> <td>null|int $voided_at The time that the credit note was voided.</td> <td>2</td> </tr> <tr> <td>string $charge For card errors, the ID of the failed charge.</td> <td>2</td> </tr> <tr> <td>string $code For some errors that could be handled</td> <td>2</td> </tr> <tr> <td>string $decline_code For card errors resulting from a card issuer</td> <td>2</td> </tr> <tr> <td>string $doc_url A URL to more information about the error code</td> <td>2</td> </tr> <tr> <td>string $message A human-readable message providing more details</td> <td>2</td> </tr> <tr> <td>string $param If the error is parameter-specific, the parameter</td> <td>2</td> </tr> <tr> <td>PaymentIntent $payment_intent The PaymentIntent object for errors</td> <td>2</td> </tr> <tr> <td>PaymentMethod $payment_method The PaymentMethod object for errors</td> <td>2</td> </tr> <tr> <td>string $payment_method_type If the error is specific to the type</td> <td>2</td> </tr> <tr> <td>string $request_log_url A URL to the request log entry in your</td> <td>2</td> </tr> <tr> <td>SetupIntent $setup_intent The SetupIntent object for errors</td> <td>2</td> </tr> <tr> <td>StripeObject $source The source object for errors returned on a</td> <td>2</td> </tr> <tr> <td>string $type The type of error returned. One of `api_error`,</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $address The customer's address.</td> <td>2</td> </tr> <tr> <td>null|int $balance Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\CashBalance $cash_balance The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.</td> <td>2</td> </tr> <tr> <td>null|string $currency Three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> the customer can be charged in for recurring billing purposes.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source <p>ID of the default payment source for the customer.</p><p>If you are using payment methods created via the PaymentMethods API, see the <a href="https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method</a> field instead.</p></td> <td>2</td> </tr> <tr> <td>null|bool $delinquent <p>When the customer's latest invoice is billed by charging automatically, <code>delinquent</code> is <code>true</code> if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, <code>delinquent</code> is <code>true</code> if the invoice isn't paid by its due date.</p><p>If an invoice is marked uncollectible by <a href="https://stripe.com/docs/billing/automatic-collection">dunning</a>, <code>delinquent</code> doesn't get reset to <code>false</code>.</p></td> <td>2</td> </tr> <tr> <td>null|\Stripe\Discount $discount Describes the current discount active on the customer, if there is one.</td> <td>2</td> </tr> <tr> <td>null|string $email The customer's email address.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $invoice_credit_balance The current multi-currency balances, if any, being stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that will be added to their next invoice denominated in that currency. These balances do not refer to any unpaid invoices. They solely track amounts that have yet to be successfully applied to any invoice. A balance in a particular currency is only applied to any invoice as an invoice in that currency is finalized.</td> <td>2</td> </tr> <tr> <td>null|string $invoice_prefix The prefix for the customer used to generate unique invoice numbers.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $invoice_settings</td> <td>2</td> </tr> <tr> <td>null|string $name The customer's full name or business name.</td> <td>2</td> </tr> <tr> <td>null|int $next_invoice_sequence The suffix of the customer's next invoice number, e.g., 0001.</td> <td>2</td> </tr> <tr> <td>null|string $phone The customer's phone number.</td> <td>2</td> </tr> <tr> <td>null|string[] $preferred_locales The customer's preferred locales (languages), ordered by preference.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source> $sources The customer's payment sources, if any.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\Subscription> $subscriptions The customer's current subscriptions, if any.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $tax</td> <td>2</td> </tr> <tr> <td>null|string $tax_exempt Describes the customer's tax exemption status. One of <code>none</code>, <code>exempt</code>, or <code>reverse</code>. When set to <code>reverse</code>, invoice and receipt PDFs include the text <strong>"Reverse charge"</strong>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\TaxId> $tax_ids The customer's tax IDs.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this customer belongs to.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\ApplicationFee $fee ID of the application fee that was refunded.</td> <td>2</td> </tr> <tr> <td>string $id The identifier for the capability.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Account $account The account for which the capability enables functionality.</td> <td>2</td> </tr> <tr> <td>bool $requested Whether the capability has been requested.</td> <td>2</td> </tr> <tr> <td>null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>string $status The status of the capability. Can be <code>active</code>, <code>inactive</code>, <code>pending</code>, or <code>unrequested</code>.</td> <td>2</td> </tr> <tr> <td>int $amount The amount, in %s.</td> <td>2</td> </tr> <tr> <td>null|int $amount_excluding_tax The integer amount in %s representing the amount for this line item, excluding all tax and discounts.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item.</td> <td>2</td> </tr> <tr> <td>bool $discountable If true, discounts will apply to this line item. Always false for prorations.</td> <td>2</td> </tr> <tr> <td>null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use <code>expand[]=discounts</code> to expand each discount.</td> <td>2</td> </tr> <tr> <td>null|string $invoice_item The ID of the <a href="https://stripe.com/docs/api/invoiceitems">invoice item</a> associated with this line item if any.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with <code>type=subscription</code> this will reflect the metadata of the subscription that caused the line item to be created.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Price $price The price of the line item.</td> <td>2</td> </tr> <tr> <td>bool $proration Whether this is a proration.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $proration_details Additional details for proration line items</td> <td>2</td> </tr> <tr> <td>null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration.</td> <td>2</td> </tr> <tr> <td>null|string $subscription The subscription that the invoice item pertains to, if any.</td> <td>2</td> </tr> <tr> <td>null|string $subscription_item The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item</td> <td>2</td> </tr> <tr> <td>null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.</td> <td>2</td> </tr> <tr> <td>string $type A string identifying the type of the source of this line item, either an <code>invoiceitem</code> or a <code>subscription</code>.</td> <td>2</td> </tr> <tr> <td>null|string $unit_amount_excluding_tax The amount in %s representing the unit amount for this line item, excluding all tax and discounts.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the price can be used for new purchases.</td> <td>2</td> </tr> <tr> <td>string $billing_scheme Describes how to compute the price per period. Either <code>per_unit</code> or <code>tiered</code>. <code>per_unit</code> indicates that the fixed amount (specified in <code>unit_amount</code> or <code>unit_amount_decimal</code>) will be charged per unit in <code>quantity</code> (for prices with <code>usage_type=licensed</code>), or per unit of total usage (for prices with <code>usage_type=metered</code>). <code>tiered</code> indicates that the unit pricing will be computed using a tiering strategy as defined using the <code>tiers</code> and <code>tiers_mode</code> attributes.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $currency_options Prices defined in each available currency option. Each key must be a three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> and a <a href="https://stripe.com/docs/currencies">supported currency</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.</td> <td>2</td> </tr> <tr> <td>null|string $lookup_key A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.</td> <td>2</td> </tr> <tr> <td>null|string $nickname A brief description of the price, hidden from customers.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Product $product The ID of the product this price is associated with.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $recurring The recurring components of a price such as <code>interval</code> and <code>usage_type</code>.</td> <td>2</td> </tr> <tr> <td>null|string $tax_behavior Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of <code>inclusive</code>, <code>exclusive</code>, or <code>unspecified</code>. Once specified as either <code>inclusive</code> or <code>exclusive</code>, it cannot be changed.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with <code>tiers</code>.</td> <td>2</td> </tr> <tr> <td>string $type One of <code>one_time</code> or <code>recurring</code> depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.</td> <td>2</td> </tr> <tr> <td>null|int $unit_amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if <code>billing_scheme=per_unit</code>.</td> <td>2</td> </tr> <tr> <td>null|string $unit_amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if <code>billing_scheme=per_unit</code>.</td> <td>2</td> </tr> <tr> <td>int $amount_total Total after discounts and taxes are applied.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect Application that created the quote.</td> <td>2</td> </tr> <tr> <td>null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.</td> <td>2</td> </tr> <tr> <td>null|float $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.</td> <td>2</td> </tr> <tr> <td>string $collection_method Either <code>charge_automatically</code>, or <code>send_invoice</code>. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as <code>active</code>. Defaults to <code>charge_automatically</code>.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $computed</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.</td> <td>2</td> </tr> <tr> <td>null|(string|\Stripe\TaxRate)[] $default_tax_rates The tax rates applied to this quote.</td> <td>2</td> </tr> <tr> <td>null|string $description A description that will be displayed on the quote PDF.</td> <td>2</td> </tr> <tr> <td>(string|\Stripe\Discount)[] $discounts The discounts applied to this quote.</td> <td>2</td> </tr> <tr> <td>int $expires_at The date on which the quote will be canceled if in <code>open</code> or <code>draft</code> status. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string $footer A footer that will be displayed on the quote PDF.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $from_quote Details of the quote that was cloned. See the <a href="https://stripe.com/docs/quotes/clone">cloning documentation</a> for more details.</td> <td>2</td> </tr> <tr> <td>null|string $header A header that will be displayed on the quote PDF.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice The invoice that was created from this quote.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $invoice_settings All invoices will be billed using the specified settings.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\LineItem> $line_items A list of items the customer is being quoted for.</td> <td>2</td> </tr> <tr> <td>null|string $number A unique number that identifies this particular quote. This number is assigned once the quote is <a href="https://stripe.com/docs/quotes/overview#finalize">finalized</a>.</td> <td>2</td> </tr> <tr> <td>string $status The status of the quote.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Subscription $subscription The subscription that was created or updated from this quote.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $subscription_data</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\SubscriptionSchedule $subscription_schedule The subscription schedule that was created or updated from this quote.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this quote belongs to.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $total_details</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.</td> <td>2</td> </tr> <tr> <td>null|string $api_version The API version events are rendered as for this webhook endpoint.</td> <td>2</td> </tr> <tr> <td>null|string $application The ID of the associated Connect application.</td> <td>2</td> </tr> <tr> <td>null|string $description An optional description of what the webhook is used for.</td> <td>2</td> </tr> <tr> <td>string[] $enabled_events The list of events to enable for this endpoint. <code>['*']</code> indicates that all events are enabled, except those that require explicit selection.</td> <td>2</td> </tr> <tr> <td>null|string $secret The endpoint's secret, used to generate <a href="https://stripe.com/docs/webhooks/signatures">webhook signatures</a>. Only returned at creation.</td> <td>2</td> </tr> <tr> <td>string $status The status of the webhook. It can be <code>enabled</code> or <code>disabled</code>.</td> <td>2</td> </tr> <tr> <td>string $url The URL of the webhook endpoint.</td> <td>2</td> </tr> <tr> <td>null|string $id Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See <a href="https://stripe.com/docs/api/invoices/upcoming">Retrieve an upcoming invoice</a> for more details.</td> <td>2</td> </tr> <tr> <td>null|string $account_country The country of the business associated with this invoice, most often the business creating the invoice.</td> <td>2</td> </tr> <tr> <td>null|string $account_name The public name of the business associated with this invoice, most often the business creating the invoice.</td> <td>2</td> </tr> <tr> <td>null|(string|\Stripe\TaxId)[] $account_tax_ids The account tax IDs associated with the invoice. Only editable when the invoice is a draft.</td> <td>2</td> </tr> <tr> <td>int $amount_due Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the <code>amount_due</code> may be 0. If there is a positive <code>starting_balance</code> for the invoice (the customer owes money), the <code>amount_due</code> will also take that into account. The charge that gets generated for the invoice will be for the amount specified in <code>amount_due</code>.</td> <td>2</td> </tr> <tr> <td>int $amount_paid The amount, in %s, that was paid.</td> <td>2</td> </tr> <tr> <td>int $amount_remaining The difference between amount_due and amount_paid, in %s.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect Application that created the invoice.</td> <td>2</td> </tr> <tr> <td>null|int $application_fee_amount The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.</td> <td>2</td> </tr> <tr> <td>int $attempt_count Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.</td> <td>2</td> </tr> <tr> <td>bool $attempted Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the <code>invoice.created</code> webhook, for example, so you might not want to display that invoice as unpaid to your users.</td> <td>2</td> </tr> <tr> <td>null|bool $auto_advance Controls whether Stripe will perform <a href="https://stripe.com/docs/billing/invoices/workflow/#auto_advance">automatic collection</a> of the invoice. When <code>false</code>, the invoice's state will not automatically advance without an explicit action.</td> <td>2</td> </tr> <tr> <td>null|string $billing_reason Indicates the reason why the invoice was created. <code>subscription_cycle</code> indicates an invoice created by a subscription advancing into a new period. <code>subscription_create</code> indicates an invoice created due to creating a subscription. <code>subscription_update</code> indicates an invoice created due to updating a subscription. <code>subscription</code> is set for all old invoices to indicate either a change to a subscription or a period advancement. <code>manual</code> is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The <code>upcoming</code> value is reserved for simulated invoices per the upcoming invoice endpoint. <code>subscription_threshold</code> indicates an invoice created due to a billing threshold being reached.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $charge ID of the latest charge generated for this invoice, if any.</td> <td>2</td> </tr> <tr> <td>string $collection_method Either <code>charge_automatically</code>, or <code>send_invoice</code>. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $custom_fields Custom fields displayed on the invoice.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The ID of the customer who will be billed.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $customer_address The customer's address. Until the invoice is finalized, this field will equal <code>customer.address</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|string $customer_email The customer's email. Until the invoice is finalized, this field will equal <code>customer.email</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|string $customer_name The customer's name. Until the invoice is finalized, this field will equal <code>customer.name</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|string $customer_phone The customer's phone number. Until the invoice is finalized, this field will equal <code>customer.phone</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $customer_shipping The customer's shipping information. Until the invoice is finalized, this field will equal <code>customer.shipping</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|string $customer_tax_exempt The customer's tax exempt status. Until the invoice is finalized, this field will equal <code>customer.tax_exempt</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $customer_tax_ids The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as <code>customer.tax_ids</code>. Once the invoice is finalized, this field will no longer be updated.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.</td> <td>2</td> </tr> <tr> <td>\Stripe\TaxRate[] $default_tax_rates The tax rates applied to this invoice, if any.</td> <td>2</td> </tr> <tr> <td>null|string $description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Discount $discount Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.</td> <td>2</td> </tr> <tr> <td>null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use <code>expand[]=discounts</code> to expand each discount.</td> <td>2</td> </tr> <tr> <td>null|int $due_date The date on which payment for this invoice is due. This value will be <code>null</code> for invoices where <code>collection_method=charge_automatically</code>.</td> <td>2</td> </tr> <tr> <td>null|int $ending_balance Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.</td> <td>2</td> </tr> <tr> <td>null|string $footer Footer displayed on the invoice.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $from_invoice Details of the invoice that was cloned. See the <a href="https://stripe.com/docs/invoicing/invoice-revisions">revision documentation</a> for more details.</td> <td>2</td> </tr> <tr> <td>null|string $hosted_invoice_url The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.</td> <td>2</td> </tr> <tr> <td>null|string $invoice_pdf The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $latest_revision The ID of the most recent non-draft revision of this invoice</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\InvoiceLineItem> $lines The individual line items that make up the invoice. <code>lines</code> is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.</td> <td>2</td> </tr> <tr> <td>null|int $next_payment_attempt The time at which payment will next be attempted. This value will be <code>null</code> for invoices where <code>collection_method=send_invoice</code>.</td> <td>2</td> </tr> <tr> <td>null|string $number A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the <a href="https://stripe.com/docs/billing/invoices/connect">Invoices with Connect</a> documentation for details.</td> <td>2</td> </tr> <tr> <td>bool $paid Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.</td> <td>2</td> </tr> <tr> <td>bool $paid_out_of_band Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $payment_settings</td> <td>2</td> </tr> <tr> <td>int $period_end End of the usage period during which invoice items were added to this invoice.</td> <td>2</td> </tr> <tr> <td>int $period_start Start of the usage period during which invoice items were added to this invoice.</td> <td>2</td> </tr> <tr> <td>int $post_payment_credit_notes_amount Total amount of all post-payment credit notes issued for this invoice.</td> <td>2</td> </tr> <tr> <td>int $pre_payment_credit_notes_amount Total amount of all pre-payment credit notes issued for this invoice.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Quote $quote The quote this invoice was generated from.</td> <td>2</td> </tr> <tr> <td>null|string $receipt_number This is the transaction number that appears on email receipts sent for this invoice.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $rendering_options Options for invoice PDF rendering.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_details Shipping details for the invoice. The Invoice PDF will use the <code>shipping_details</code> value if it is set, otherwise the PDF will render the shipping address from the customer.</td> <td>2</td> </tr> <tr> <td>int $starting_balance Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor Extra information about an invoice for the customer's credit card statement.</td> <td>2</td> </tr> <tr> <td>null|string $status The status of the invoice, one of <code>draft</code>, <code>open</code>, <code>paid</code>, <code>uncollectible</code>, or <code>void</code>. <a href="https://stripe.com/docs/billing/invoices/workflow#workflow-overview">Learn more</a></td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Subscription $subscription The subscription that this invoice was prepared for, if any.</td> <td>2</td> </tr> <tr> <td>null|int $subscription_proration_date Only set for upcoming invoices that preview prorations. The time used to calculate prorations.</td> <td>2</td> </tr> <tr> <td>int $subtotal Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated</td> <td>2</td> </tr> <tr> <td>null|int $subtotal_excluding_tax The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated</td> <td>2</td> </tr> <tr> <td>null|int $tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice belongs to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $threshold_reason</td> <td>2</td> </tr> <tr> <td>int $total Total after discounts and taxes.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $total_discount_amounts The aggregate amounts calculated per discount across all line items.</td> <td>2</td> </tr> <tr> <td>null|int $total_excluding_tax The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transfer_data The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.</td> <td>2</td> </tr> <tr> <td>null|int $webhooks_delivered_at Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have <a href="https://stripe.com/docs/billing/webhooks#understand">been exhausted</a>. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a href="https://stripe.com/docs/api#payouts">Payouts API</a>. The available balance for each currency and payment type can be found in the <code>source_types</code> property.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the <code>source_types</code> property.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $instant_available Funds that can be paid out using Instant Payouts.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $issuing</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the <code>source_types</code> property.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.</td> <td>2</td> </tr> <tr> <td>string $code The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.</td> <td>2</td> </tr> <tr> <td>\Stripe\Coupon $coupon A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to <a href="https://stripe.com/docs/api#subscriptions">subscriptions</a>, <a href="https://stripe.com/docs/api#invoices">invoices</a>, <a href="https://stripe.com/docs/api/checkout/sessions">checkout sessions</a>, <a href="https://stripe.com/docs/api#quotes">quotes</a>, and more. Coupons do not work with conventional one-off <a href="https://stripe.com/docs/api#create_charge">charges</a> or <a href="https://stripe.com/docs/api/payment_intents">payment intents</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The customer that this promotion code can be used by.</td> <td>2</td> </tr> <tr> <td>null|int $expires_at Date at which the promotion code can no longer be redeemed.</td> <td>2</td> </tr> <tr> <td>null|int $max_redemptions Maximum number of times this promotion code can be redeemed.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $restrictions</td> <td>2</td> </tr> <tr> <td>int $times_redeemed Number of times this promotion code has been used.</td> <td>2</td> </tr> <tr> <td>int $quantity The usage quantity for the specified date.</td> <td>2</td> </tr> <tr> <td>string $subscription_item The ID of the subscription item this usage record contains data for.</td> <td>2</td> </tr> <tr> <td>int $timestamp The timestamp when this usage occurred.</td> <td>2</td> </tr> <tr> <td>int $amount_discount Total discount amount applied. If no discounts were applied, defaults to 0.</td> <td>2</td> </tr> <tr> <td>int $amount_tax Total tax amount applied. If no tax was applied, defaults to 0.</td> <td>2</td> </tr> <tr> <td>int $amount_total Total after discounts and taxes.</td> <td>2</td> </tr> <tr> <td>string $description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $discounts The discounts applied to the line item.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Price $price The price used to generate the line item.</td> <td>2</td> </tr> <tr> <td>null|int $quantity The quantity of products being purchased.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $taxes The taxes applied to the line item.</td> <td>2</td> </tr> <tr> <td>int $amount The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.</td> <td>2</td> </tr> <tr> <td>null|int $amount_excluding_tax The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts.</td> <td>2</td> </tr> <tr> <td>null|string $description Description of the item being credited.</td> <td>2</td> </tr> <tr> <td>int $discount_amount The integer amount in %s representing the discount being credited for this line item.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item</td> <td>2</td> </tr> <tr> <td>null|string $invoice_line_item ID of the invoice line item being credited</td> <td>2</td> </tr> <tr> <td>null|int $quantity The number of units of product being credited.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item</td> <td>2</td> </tr> <tr> <td>\Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.</td> <td>2</td> </tr> <tr> <td>string $type The type of the credit note line item, one of <code>invoice_line_item</code> or <code>custom_line_item</code>. When the type is <code>invoice_line_item</code> there is an additional <code>invoice_line_item</code> property on the resource the value of which is the id of the credited line item on the invoice.</td> <td>2</td> </tr> <tr> <td>null|int $unit_amount The cost of each unit of product being credited.</td> <td>2</td> </tr> <tr> <td>null|string $unit_amount_excluding_tax The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts.</td> <td>2</td> </tr> <tr> <td>int $amount The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's <code>balance</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer The ID of the customer the transaction belongs to.</td> <td>2</td> </tr> <tr> <td>int $ending_balance The customer's <code>balance</code> after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction.</td> <td>2</td> </tr> <tr> <td>string $type Transaction type: <code>adjustment</code>, <code>applied_to_invoice</code>, <code>credit_note</code>, <code>initial</code>, <code>invoice_overpaid</code>, <code>invoice_too_large</code>, <code>invoice_too_small</code>, <code>unspent_receiver_credit</code>, or <code>unapplied_from_invoice</code>. See the <a href="https://stripe.com/docs/billing/customer/balance#types">Customer Balance page</a> to learn more about transaction types.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the shipping rate can be used for new purchases. Defaults to <code>true</code>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.</td> <td>2</td> </tr> <tr> <td>null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $fixed_amount</td> <td>2</td> </tr> <tr> <td>null|string $tax_behavior Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of <code>inclusive</code>, <code>exclusive</code>, or <code>unspecified</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID. The Shipping tax code is <code>txcd_92010001</code>.</td> <td>2</td> </tr> <tr> <td>string $type The type of calculation to use on the shipping rate. Can only be <code>fixed_amount</code> for now.</td> <td>2</td> </tr> <tr> <td>string $id Unique identifier for the object. Represented as the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> in lowercase.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $rates Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $ach_credit_transfer</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $ach_debit</td> <td>2</td> </tr> <tr> <td>null|int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for <code>single_use</code> sources.</td> <td>2</td> </tr> <tr> <td>string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $code_verification</td> <td>2</td> </tr> <tr> <td>null|string $currency Three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> associated with the source. This is the currency for which the source will be chargeable once ready. Required for <code>single_use</code> sources.</td> <td>2</td> </tr> <tr> <td>null|string $customer The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.</td> <td>2</td> </tr> <tr> <td>string $flow The authentication <code>flow</code> of the source. <code>flow</code> is one of <code>redirect</code>, <code>receiver</code>, <code>code_verification</code>, <code>none</code>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $multibanco</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $owner Information about the owner of the payment instrument that may be used or required by particular source types.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $receiver</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $redirect</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $sepa_credit_transfer</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $source_order</td> <td>2</td> </tr> <tr> <td>null|string $statement_descriptor Extra information about a source. This will appear on your customer's statement every time you charge the source.</td> <td>2</td> </tr> <tr> <td>string $status The status of the source, one of <code>canceled</code>, <code>chargeable</code>, <code>consumed</code>, <code>failed</code>, or <code>pending</code>. Only <code>chargeable</code> sources can be used to create a charge.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $three_d_secure</td> <td>2</td> </tr> <tr> <td>string $type The <code>type</code> of the source. The <code>type</code> is a payment method, one of <code>ach_credit_transfer</code>, <code>ach_debit</code>, <code>alipay</code>, <code>bancontact</code>, <code>card</code>, <code>card_present</code>, <code>eps</code>, <code>giropay</code>, <code>ideal</code>, <code>multibanco</code>, <code>klarna</code>, <code>p24</code>, <code>sepa_debit</code>, <code>sofort</code>, <code>three_d_secure</code>, or <code>wechat</code>. An additional hash is included on the source with a name matching this value. It contains additional information specific to the <a href="https://stripe.com/docs/sources">payment method</a> used.</td> <td>2</td> </tr> <tr> <td>null|string $usage Either <code>reusable</code> or <code>single_use</code>. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $wechat</td> <td>2</td> </tr> <tr> <td>int $amount Gross amount of the transaction, in %s.</td> <td>2</td> </tr> <tr> <td>int $available_on The date the transaction's net funds will become available in the Stripe balance.</td> <td>2</td> </tr> <tr> <td>null|float $exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the <code>amount</code> in currency A, times <code>exchange_rate</code>, would be the <code>amount</code> in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's <code>amount</code> would be <code>1000</code> and <code>currency</code> would be <code>eur</code>. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's <code>amount</code> would be <code>1234</code>, <code>currency</code> would be <code>usd</code>, and <code>exchange_rate</code> would be <code>1.234</code>.</td> <td>2</td> </tr> <tr> <td>int $fee Fees (in %s) paid for this transaction.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in %s) paid for this transaction.</td> <td>2</td> </tr> <tr> <td>int $net Net amount of the transaction, in %s.</td> <td>2</td> </tr> <tr> <td>string $reporting_category <a href="https://stripe.com/docs/reports/reporting-categories">Learn more</a> about how reporting categories can help you understand balance transactions from an accounting perspective.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $source The Stripe object to which this transaction is related.</td> <td>2</td> </tr> <tr> <td>string $status If the transaction's net funds are available in the Stripe balance yet. Either <code>available</code> or <code>pending</code>.</td> <td>2</td> </tr> <tr> <td>string $type Transaction type: <code>adjustment</code>, <code>advance</code>, <code>advance_funding</code>, <code>anticipation_repayment</code>, <code>application_fee</code>, <code>application_fee_refund</code>, <code>charge</code>, <code>connect_collection_transfer</code>, <code>contribution</code>, <code>issuing_authorization_hold</code>, <code>issuing_authorization_release</code>, <code>issuing_dispute</code>, <code>issuing_transaction</code>, <code>payment</code>, <code>payment_failure_refund</code>, <code>payment_refund</code>, <code>payout</code>, <code>payout_cancel</code>, <code>payout_failure</code>, <code>refund</code>, <code>refund_failure</code>, <code>reserve_transaction</code>, <code>reserved_funds</code>, <code>stripe_fee</code>, <code>stripe_fx_fee</code>, <code>tax_fee</code>, <code>topup</code>, <code>topup_reversal</code>, <code>transfer</code>, <code>transfer_cancel</code>, <code>transfer_failure</code>, or <code>transfer_refund</code>. <a href="https://stripe.com/docs/reports/balance-transaction-types">Learn more</a> about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider <code>reporting_category</code> instead.</td> <td>2</td> </tr> <tr> <td>bool $active Defaults to <code>true</code>. When set to <code>false</code>, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.</td> <td>2</td> </tr> <tr> <td>null|string $country Two-letter country code (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).</td> <td>2</td> </tr> <tr> <td>null|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.</td> <td>2</td> </tr> <tr> <td>string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.</td> <td>2</td> </tr> <tr> <td>bool $inclusive This specifies if the tax rate is inclusive or exclusive.</td> <td>2</td> </tr> <tr> <td>null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.</td> <td>2</td> </tr> <tr> <td>float $percentage This represents the tax rate percent out of 100.</td> <td>2</td> </tr> <tr> <td>null|string $state <a href="https://en.wikipedia.org/wiki/ISO_3166-2:US">ISO 3166-2 subdivision code</a>, without country prefix. For example, "NY" for New York, United States.</td> <td>2</td> </tr> <tr> <td>null|string $tax_type The high-level tax type, such as <code>vat</code> or <code>sales_tax</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Account $account The ID of the account that the bank account is associated with.</td> <td>2</td> </tr> <tr> <td>null|string $account_holder_name The name of the person or business that owns the bank account.</td> <td>2</td> </tr> <tr> <td>null|string $account_holder_type The type of entity that holds the account. This can be either <code>individual</code> or <code>company</code>.</td> <td>2</td> </tr> <tr> <td>null|string $account_type The bank account type. This can only be <code>checking</code> or <code>savings</code> in most countries. In Japan, this can only be <code>futsu</code> or <code>toza</code>.</td> <td>2</td> </tr> <tr> <td>null|string[] $available_payout_methods A set of available payout methods for this bank account. Only values from this set should be passed as the <code>method</code> when creating a payout.</td> <td>2</td> </tr> <tr> <td>null|string $bank_name Name of the bank associated with the routing number (e.g., <code>WELLS FARGO</code>).</td> <td>2</td> </tr> <tr> <td>string $country Two-letter ISO code representing the country the bank account is located in.</td> <td>2</td> </tr> <tr> <td>string $currency Three-letter <a href="https://stripe.com/docs/payouts">ISO code for the currency</a> paid out to the bank account.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The ID of the customer that the bank account is associated with.</td> <td>2</td> </tr> <tr> <td>null|bool $default_for_currency Whether this bank account is the default external account for its currency.</td> <td>2</td> </tr> <tr> <td>null|string $fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.</td> <td>2</td> </tr> <tr> <td>string $last4 The last four digits of the bank account number.</td> <td>2</td> </tr> <tr> <td>null|string $routing_number The routing transit number for the bank account.</td> <td>2</td> </tr> <tr> <td>string $status <p>For bank accounts, possible values are <code>new</code>, <code>validated</code>, <code>verified</code>, <code>verification_failed</code>, or <code>errored</code>. A bank account that hasn't had any activity or validation performed is <code>new</code>. If Stripe can determine that the bank account exists, its status will be <code>validated</code>. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be <code>verified</code>. If the verification failed for any reason, such as microdeposit failure, the status will be <code>verification_failed</code>. If a transfer sent to this bank account fails, we'll set the status to <code>errored</code> and will not continue to send transfers until the bank details are updated.</p><p>For external accounts, possible values are <code>new</code> and <code>errored</code>. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to <code>errored</code> and transfers are stopped until account details are updated.</p></td> <td>2</td> </tr> <tr> <td>string $url The URL for the login link.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>2</td> </tr> <tr> <td>string $customer The ID of the customer whose cash balance this object represents.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $settings</td> <td>2</td> </tr> <tr> <td>null|int $amount_off Amount (in the <code>currency</code> specified) that will be taken off the subtotal of any invoices for this customer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $applies_to</td> <td>2</td> </tr> <tr> <td>null|string $currency If <code>amount_off</code> has been set, the three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> of the amount to take off.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> and a <a href="https://stripe.com/docs/currencies">supported currency</a>.</td> <td>2</td> </tr> <tr> <td>string $duration One of <code>forever</code>, <code>once</code>, and <code>repeating</code>. Describes how long a customer who applies this coupon will get the discount.</td> <td>2</td> </tr> <tr> <td>null|int $duration_in_months If <code>duration</code> is <code>repeating</code>, the number of months the coupon applies. Null if coupon <code>duration</code> is <code>forever</code> or <code>once</code>.</td> <td>2</td> </tr> <tr> <td>null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.</td> <td>2</td> </tr> <tr> <td>null|string $name Name of the coupon displayed to customers on for instance invoices or receipts.</td> <td>2</td> </tr> <tr> <td>null|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.</td> <td>2</td> </tr> <tr> <td>null|int $redeem_by Date after which the coupon can no longer be redeemed.</td> <td>2</td> </tr> <tr> <td>int $times_redeemed Number of times this coupon has been applied to a customer.</td> <td>2</td> </tr> <tr> <td>bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $customer_acceptance</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $multi_use</td> <td>2</td> </tr> <tr> <td>string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $single_use</td> <td>2</td> </tr> <tr> <td>string $status The status of the mandate, which indicates whether it can be used to initiate a payment.</td> <td>2</td> </tr> <tr> <td>string $type The type of the mandate.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect Application that created the schedule.</td> <td>2</td> </tr> <tr> <td>null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is <code>active</code>.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $default_settings</td> <td>2</td> </tr> <tr> <td>string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are <code>release</code> or <code>cancel</code> with the default being <code>release</code>. <code>release</code> will end the subscription schedule and keep the underlying subscription running.<code>cancel</code> will end the subscription schedule and cancel the underlying subscription.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.</td> <td>2</td> </tr> <tr> <td>null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).</td> <td>2</td> </tr> <tr> <td>string $status The present status of the subscription schedule. Possible values are <code>not_started</code>, <code>active</code>, <code>completed</code>, <code>released</code>, and <code>canceled</code>. You can read more about the different states in our <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">behavior guide</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.</td> <td>2</td> </tr> <tr> <td>null|string $invoice The invoice in which this usage period has been billed for.</td> <td>2</td> </tr> <tr> <td>string $subscription_item The ID of the subscription item this summary is describing.</td> <td>2</td> </tr> <tr> <td>int $total_usage The total usage within this usage period.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the plan can be used for new purchases.</td> <td>2</td> </tr> <tr> <td>null|string $aggregate_usage Specifies a usage aggregation strategy for plans of <code>usage_type=metered</code>. Allowed values are <code>sum</code> for summing up all usage during a period, <code>last_during_period</code> for using the last usage record reported within a period, <code>last_ever</code> for using the last usage record ever (across period bounds) or <code>max</code> which uses the usage record with the maximum reported usage during a period. Defaults to <code>sum</code>.</td> <td>2</td> </tr> <tr> <td>null|int $amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if <code>billing_scheme=per_unit</code>.</td> <td>2</td> </tr> <tr> <td>null|string $amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if <code>billing_scheme=per_unit</code>.</td> <td>2</td> </tr> <tr> <td>string $billing_scheme Describes how to compute the price per period. Either <code>per_unit</code> or <code>tiered</code>. <code>per_unit</code> indicates that the fixed amount (specified in <code>amount</code>) will be charged per unit in <code>quantity</code> (for plans with <code>usage_type=licensed</code>), or per unit of total usage (for plans with <code>usage_type=metered</code>). <code>tiered</code> indicates that the unit pricing will be computed using a tiering strategy as defined using the <code>tiers</code> and <code>tiers_mode</code> attributes.</td> <td>2</td> </tr> <tr> <td>string $interval The frequency at which a subscription is billed. One of <code>day</code>, <code>week</code>, <code>month</code> or <code>year</code>.</td> <td>2</td> </tr> <tr> <td>int $interval_count The number of intervals (specified in the <code>interval</code> attribute) between subscription billings. For example, <code>interval=month</code> and <code>interval_count=3</code> bills every 3 months.</td> <td>2</td> </tr> <tr> <td>null|string $nickname A brief description of the plan, hidden from customers.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Product $product The product whose pricing this plan determines.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with <code>tiers</code>.</td> <td>2</td> </tr> <tr> <td>null|int $trial_period_days Default number of trial days when subscribing a customer to this plan using <a href="https://stripe.com/docs/api#create_subscription-trial_from_plan"><code>trial_from_plan=true</code></a>.</td> <td>2</td> </tr> <tr> <td>string $usage_type Configures how the quantity per period should be determined. Can be either <code>metered</code> or <code>licensed</code>. <code>licensed</code> automatically bills the <code>quantity</code> set when adding it to a subscription. <code>metered</code> aggregates the total usage based on usage records. Defaults to <code>licensed</code>.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Account $account ID of the Stripe account this fee was taken from.</td> <td>2</td> </tr> <tr> <td>int $amount Amount earned, in %s.</td> <td>2</td> </tr> <tr> <td>int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)</td> <td>2</td> </tr> <tr> <td>string|\Stripe\StripeObject $application ID of the Connect application that earned the fee.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Charge $charge ID of the charge that the application fee was taken from.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Charge $originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the <code>destination</code> parameter.</td> <td>2</td> </tr> <tr> <td>bool $refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\StripeObject> $refunds A list of refunds that have been applied to the fee.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $applied_to_payment</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Customer $customer The customer whose available cash balance changed as a result of this transaction.</td> <td>2</td> </tr> <tr> <td>int $ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $funded</td> <td>2</td> </tr> <tr> <td>int $net_amount The amount by which the cash balance changed, represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $refunded_from_payment</td> <td>2</td> </tr> <tr> <td>string $type The type of the cash balance transaction. One of <code>applied_to_payment</code>, <code>unapplied_from_payment</code>, <code>refunded_from_payment</code>, <code>funded</code>, <code>return_initiated</code>, or <code>return_canceled</code>. New types may be added in future. See <a href="https://stripe.com/docs/payments/customer-balance#types">Customer Balance</a> to learn more about these types.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $unapplied_from_payment</td> <td>2</td> </tr> <tr> <td>string $domain_name</td> <td>2</td> </tr> <tr> <td>bool $expired Whether this link is already expired.</td> <td>2</td> </tr> <tr> <td>null|int $expires_at Time at which the link expires.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\File $file The file object this link points to.</td> <td>2</td> </tr> <tr> <td>null|string $url The publicly accessible URL to download the file.</td> <td>2</td> </tr> <tr> <td>null|string $error If something should go wrong during the run, a message about the failure (populated when <code>status=failed</code>).</td> <td>2</td> </tr> <tr> <td>bool $livemode <code>true</code> if the report is run on live mode data and <code>false</code> if it is run on test mode data.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $parameters</td> <td>2</td> </tr> <tr> <td>string $report_type The ID of the <a href="https://stripe.com/docs/reports/report-types">report type</a> to run, such as <code>"balance.summary.1"</code>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\File $result The file object representing the result of the report run (populated when <code>status=succeeded</code>).</td> <td>2</td> </tr> <tr> <td>string $status Status of this report run. This will be <code>pending</code> when the run is initially created. When the run finishes, this will be set to <code>succeeded</code> and the <code>result</code> field will be populated. Rarely, we may encounter an error, at which point this will be set to <code>failed</code> and the <code>error</code> field will be populated.</td> <td>2</td> </tr> <tr> <td>null|int $succeeded_at Timestamp at which this run successfully finished (populated when <code>status=succeeded</code>). Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>string $id The <a href="https://stripe.com/docs/reporting/statements/api#available-report-types">ID of the Report Type</a>, such as <code>balance.summary.1</code>.</td> <td>2</td> </tr> <tr> <td>int $data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>int $data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>null|string[] $default_columns List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the <code>columns</code> parameter, this will be null.)</td> <td>2</td> </tr> <tr> <td>string $name Human-readable name of the Report Type</td> <td>2</td> </tr> <tr> <td>int $updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.</td> <td>2</td> </tr> <tr> <td>int $version Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.</td> <td>2</td> </tr> <tr> <td>null|string $client_secret The short-lived client secret used by Stripe.js to <a href="https://stripe.com/docs/js/identity/modal">show a verification modal</a> inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on <a href="https://stripe.com/docs/identity/verification-sessions#client-secret">passing the client secret to the frontend</a> to learn more.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $last_error If present, this property tells you the last error encountered when processing the verification.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Identity\VerificationReport $last_verification_report ID of the most recent VerificationReport. <a href="https://stripe.com/docs/identity/verification-sessions#results">Learn more about accessing detailed verification results.</a></td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $redaction Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.</td> <td>2</td> </tr> <tr> <td>string $status Status of this VerificationSession. <a href="https://stripe.com/docs/identity/how-sessions-work">Learn more about the lifecycle of sessions</a>.</td> <td>2</td> </tr> <tr> <td>string $type The type of <a href="https://stripe.com/docs/identity/verification-checks">verification check</a> to be performed.</td> <td>2</td> </tr> <tr> <td>null|string $url The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on <a href="https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect">verifying identity documents</a> to learn how to redirect users to Stripe.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $verified_outputs The user’s verified data.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $document Result from a document check</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $id_number Result from an id_number check</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $selfie Result from a selfie check</td> <td>2</td> </tr> <tr> <td>string $type Type of report.</td> <td>2</td> </tr> <tr> <td>null|string $verification_session ID of the VerificationSession that created this report.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $account_holder The account holder for whom accounts are collected in this session.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FinancialConnections\Account> $accounts The accounts that were collected as part of this Session.</td> <td>2</td> </tr> <tr> <td>string $client_secret A value that will be passed to the client to launch the authentication flow.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $filters</td> <td>2</td> </tr> <tr> <td>string[] $permissions Permissions requested for accounts collected during this session.</td> <td>2</td> </tr> <tr> <td>null|string $return_url For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $account_holder The account holder that this account belongs to.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $balance The most recent information about the account's balance.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $balance_refresh The state of the most recent attempt to refresh the account balance.</td> <td>2</td> </tr> <tr> <td>string $category The type of the account. Account category is further divided in <code>subcategory</code>.</td> <td>2</td> </tr> <tr> <td>null|string $display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution.</td> <td>2</td> </tr> <tr> <td>string $institution_name The name of the institution that holds this account.</td> <td>2</td> </tr> <tr> <td>null|string $last4 The last 4 digits of the account number. If present, this will be 4 numeric characters.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\FinancialConnections\AccountOwnership $ownership The most recent information about the account's owners.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $ownership_refresh The state of the most recent attempt to refresh the account owners.</td> <td>2</td> </tr> <tr> <td>null|string[] $permissions The list of permissions granted by this account.</td> <td>2</td> </tr> <tr> <td>string $status The status of the link to the account.</td> <td>2</td> </tr> <tr> <td>string $subcategory <p>If <code>category</code> is <code>cash</code>, one of:</p><p>- <code>checking</code> - <code>savings</code> - <code>other</code></p><p>If <code>category</code> is <code>credit</code>, one of:</p><p>- <code>mortgage</code> - <code>line_of_credit</code> - <code>credit_card</code> - <code>other</code></p><p>If <code>category</code> is <code>investment</code> or <code>other</code>, this will be <code>other</code>.</p></td> <td>2</td> </tr> <tr> <td>string[] $supported_payment_method_types The <a href="https://stripe.com/docs/api/payment_methods/object#payment_method_object-type">PaymentMethod type</a>(s) that can be created from this account.</td> <td>2</td> </tr> <tr> <td>null|string $email The email address of the owner.</td> <td>2</td> </tr> <tr> <td>string $name The full name of the owner.</td> <td>2</td> </tr> <tr> <td>string $ownership The ownership object that this owner belongs to.</td> <td>2</td> </tr> <tr> <td>null|string $phone The raw phone number of the owner.</td> <td>2</td> </tr> <tr> <td>null|string $raw_address The raw physical address of the owner.</td> <td>2</td> </tr> <tr> <td>null|int $refreshed_at The timestamp of the refresh that updated this owner.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FinancialConnections\AccountOwner> $owners A paginated list of owners for this account.</td> <td>2</td> </tr> <tr> <td>int $deletes_after Time at which this clock is scheduled to auto delete.</td> <td>2</td> </tr> <tr> <td>int $frozen_time Time at which all objects belonging to this clock are frozen.</td> <td>2</td> </tr> <tr> <td>null|string $name The custom name supplied at creation.</td> <td>2</td> </tr> <tr> <td>string $status The status of the Test Clock.</td> <td>2</td> </tr> <tr> <td>string $brand The brand of the card.</td> <td>2</td> </tr> <tr> <td>null|string $cancellation_reason The reason why the card was canceled.</td> <td>2</td> </tr> <tr> <td>\Stripe\Issuing\Cardholder $cardholder <p>An Issuing <code>Cardholder</code> object represents an individual or business entity who is <a href="https://stripe.com/docs/issuing">issued</a> cards.</p><p>Related guide: <a href="https://stripe.com/docs/issuing/cards#create-cardholder">How to create a Cardholder</a></p></td> <td>2</td> </tr> <tr> <td>string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Supported currencies are <code>usd</code> in the US, <code>eur</code> in the EU, and <code>gbp</code> in the UK.</td> <td>2</td> </tr> <tr> <td>null|string $cvc The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with <a href="https://stripe.com/docs/api/expanding_objects">the <code>expand</code> parameter</a>. Additionally, it's only available via the <a href="https://stripe.com/docs/api/issuing/cards/retrieve">"Retrieve a card" endpoint</a>, not via "List all cards" or any other endpoint.</td> <td>2</td> </tr> <tr> <td>int $exp_month The expiration month of the card.</td> <td>2</td> </tr> <tr> <td>int $exp_year The expiration year of the card.</td> <td>2</td> </tr> <tr> <td>null|string $financial_account The financial account this card is attached to.</td> <td>2</td> </tr> <tr> <td>string $last4 The last 4 digits of the card number.</td> <td>2</td> </tr> <tr> <td>null|string $number The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with <a href="https://stripe.com/docs/api/expanding_objects">the <code>expand</code> parameter</a>. Additionally, it's only available via the <a href="https://stripe.com/docs/api/issuing/cards/retrieve">"Retrieve a card" endpoint</a>, not via "List all cards" or any other endpoint.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Card $replaced_by The latest card that replaces this card, if any.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Card $replacement_for The card this card replaces, if any.</td> <td>2</td> </tr> <tr> <td>null|string $replacement_reason The reason why the previous card needed to be replaced.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping Where and how the card will be shipped.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $spending_controls</td> <td>2</td> </tr> <tr> <td>string $status Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to <code>inactive</code>.</td> <td>2</td> </tr> <tr> <td>string $type The type of the card.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $wallets Information relating to digital wallets (like Apple Pay and Google Pay).</td> <td>2</td> </tr> <tr> <td>int $amount The transaction amount, which will be reflected in your balance. This amount is in your currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Authorization $authorization The <code>Authorization</code> object that led to this transaction.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction ID of the <a href="https://stripe.com/docs/api/balance_transactions">balance transaction</a> associated with this transaction.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Issuing\Card $card The card used to make this transaction.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this transaction belongs.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Dispute $dispute If you've disputed the transaction, the ID of the dispute.</td> <td>2</td> </tr> <tr> <td>int $merchant_amount The amount that the merchant will receive, denominated in <code>merchant_currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. It will be different from <code>amount</code> if the merchant is taking payment in a different currency.</td> <td>2</td> </tr> <tr> <td>string $merchant_currency The currency with which the merchant is taking payment.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $purchase_details Additional purchase information that is optionally provided by the merchant.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $treasury <a href="https://stripe.com/docs/api/treasury">Treasury</a> details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts</td> <td>2</td> </tr> <tr> <td>string $type The nature of the transaction.</td> <td>2</td> </tr> <tr> <td>null|string $wallet The digital wallet used for this transaction. One of <code>apple_pay</code>, <code>google_pay</code>, or <code>samsung_pay</code>.</td> <td>2</td> </tr> <tr> <td>Card $card</td> <td>2</td> </tr> <tr> <td>string $cvc</td> <td>2</td> </tr> <tr> <td>int $exp_month</td> <td>2</td> </tr> <tr> <td>int $exp_year</td> <td>2</td> </tr> <tr> <td>string $number</td> <td>2</td> </tr> <tr> <td>int $amount Disputed amount in the card's currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. Usually the amount of the <code>transaction</code>, but can differ (usually because of currency fluctuation).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with the dispute.</td> <td>2</td> </tr> <tr> <td>string $currency The currency the <code>transaction</code> was made in.</td> <td>2</td> </tr> <tr> <td>string $status Current status of the dispute.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Issuing\Transaction $transaction The transaction being disputed.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $treasury <a href="https://stripe.com/docs/api/treasury">Treasury</a> details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $billing</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $company Additional information about a <code>company</code> cardholder.</td> <td>2</td> </tr> <tr> <td>null|string $email The cardholder's email address.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $individual Additional information about an <code>individual</code> cardholder.</td> <td>2</td> </tr> <tr> <td>string $name The cardholder's name. This will be printed on cards issued to them.</td> <td>2</td> </tr> <tr> <td>null|string $phone_number The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the <a href="https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied">3D Secure documentation</a> for more details.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $requirements</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $spending_controls Rules that control spending across this cardholder's cards. Refer to our <a href="https://stripe.com/docs/issuing/controls/spending-controls">documentation</a> for more details.</td> <td>2</td> </tr> <tr> <td>string $status Specifies whether to permit authorizations on this cardholder's cards.</td> <td>2</td> </tr> <tr> <td>string $type One of <code>individual</code> or <code>company</code>.</td> <td>2</td> </tr> <tr> <td>int $amount The total amount that was authorized or rejected. This amount is in the card's currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>2</td> </tr> <tr> <td>bool $approved Whether the authorization has been approved.</td> <td>2</td> </tr> <tr> <td>string $authorization_method How the card details were provided.</td> <td>2</td> </tr> <tr> <td>\Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization.</td> <td>2</td> </tr> <tr> <td>\Stripe\Issuing\Card $card You can <a href="https://stripe.com/docs/issuing/cards">create physical or virtual cards</a> that are issued to cardholders.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this authorization belongs.</td> <td>2</td> </tr> <tr> <td>int $merchant_amount The total amount that was authorized or rejected. This amount is in the <code>merchant_currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>2</td> </tr> <tr> <td>string $merchant_currency The currency that was presented to the cardholder for the authorization. Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $network_data Details about the authorization, such as identifiers, set by the card network.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $pending_request The pending authorization request. This field will only be non-null during an <code>issuing_authorization.request</code> webhook.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $request_history History of every time a <code>pending_request</code> authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.</td> <td>2</td> </tr> <tr> <td>string $status The current status of the authorization in its lifecycle.</td> <td>2</td> </tr> <tr> <td>\Stripe\Issuing\Transaction[] $transactions List of <a href="https://stripe.com/docs/api/issuing/transactions">transactions</a> associated with this authorization.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $treasury <a href="https://stripe.com/docs/api/treasury">Treasury</a> details related to this authorization if it was created on a <a href="https://stripe.com/docs/api/treasury/financial_accounts">FinancialAccount</a>.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $verification_data</td> <td>2</td> </tr> <tr> <td>null|string $wallet The digital wallet used for this transaction. One of <code>apple_pay</code>, <code>google_pay</code>, or <code>samsung_pay</code>. Will populate as <code>null</code> when no digital wallet was utilized.</td> <td>2</td> </tr> <tr> <td>null|string $location The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see <a href="https://stripe.com/docs/terminal/fleet/locations#connection-tokens">the docs on scoping connection tokens</a>.</td> <td>2</td> </tr> <tr> <td>string $secret Your application should pass this token to the Stripe Terminal SDK.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $bbpos_wisepos_e</td> <td>2</td> </tr> <tr> <td>null|bool $is_account_default Whether this Configuration is the default for your account</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $tipping</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $verifone_p400</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $action The most recent action performed by the reader.</td> <td>2</td> </tr> <tr> <td>null|string $device_sw_version The current software version of the reader.</td> <td>2</td> </tr> <tr> <td>string $device_type Type of reader, one of <code>bbpos_wisepad3</code>, <code>stripe_m2</code>, <code>bbpos_chipper2x</code>, <code>bbpos_wisepos_e</code>, <code>verifone_P400</code>, or <code>simulated_wisepos_e</code>.</td> <td>2</td> </tr> <tr> <td>null|string $ip_address The local IP address of the reader.</td> <td>2</td> </tr> <tr> <td>string $label Custom label given to the reader for easier identification.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Terminal\Location $location The location identifier of the reader.</td> <td>2</td> </tr> <tr> <td>string $serial_number Serial number of the reader.</td> <td>2</td> </tr> <tr> <td>null|string $status The networking status of the reader.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $address</td> <td>2</td> </tr> <tr> <td>null|string $configuration_overrides The ID of a configuration that will be used to customize all readers in this location.</td> <td>2</td> </tr> <tr> <td>string $display_name The display name of the location.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\BillingPortal\Configuration $configuration The configuration used by this session, describing the features available.</td> <td>2</td> </tr> <tr> <td>string $customer The ID of the customer for this session.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $flow Information about a specific flow for the customer to go through. See the <a href="https://stripe.com/docs/customer-management/portal-deep-links">docs</a> to learn more about using customer portal deep links and flows.</td> <td>2</td> </tr> <tr> <td>null|string $locale The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s <code>preferred_locales</code> or browser’s locale is used.</td> <td>2</td> </tr> <tr> <td>null|string $on_behalf_of The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this <code>on_behalf_of</code> account appear in the portal. For more information, see the <a href="https://stripe.com/docs/connect/charges-transfers#on-behalf-of">docs</a>. Use the <a href="https://stripe.com/docs/api/accounts/object#account_object-settings-branding">Accounts API</a> to modify the <code>on_behalf_of</code> account's branding settings, which the portal displays.</td> <td>2</td> </tr> <tr> <td>null|string $return_url The URL to redirect customers to when they click on the portal's link to return to your website.</td> <td>2</td> </tr> <tr> <td>string $url The short-lived URL of the session that gives customers access to the customer portal.</td> <td>2</td> </tr> <tr> <td>bool $active Whether the configuration is active and can be used to create portal sessions.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\StripeObject $application ID of the Connect Application that created the configuration.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $business_profile</td> <td>2</td> </tr> <tr> <td>null|string $default_return_url The default URL to redirect customers to when they click on the portal's link to return to your website. This can be <a href="https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url">overriden</a> when creating the session.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $features</td> <td>2</td> </tr> <tr> <td>bool $is_default Whether the configuration is the default. If <code>true</code>, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $login_page</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $after_expiration When set, provides configuration for actions to take if this Checkout Session expires.</td> <td>2</td> </tr> <tr> <td>null|bool $allow_promotion_codes Enables user redeemable promotion codes.</td> <td>2</td> </tr> <tr> <td>null|int $amount_subtotal Total of all items before discounts or taxes are applied.</td> <td>2</td> </tr> <tr> <td>null|int $amount_total Total of all items after discounts and taxes are applied.</td> <td>2</td> </tr> <tr> <td>null|string $billing_address_collection Describes whether Checkout should collect the customer's billing address.</td> <td>2</td> </tr> <tr> <td>null|string $cancel_url If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.</td> <td>2</td> </tr> <tr> <td>null|string $client_reference_id A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $consent Results of <code>consent_collection</code> for this session.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $consent_collection When set, provides configuration for the Checkout Session to gather active consent from customers.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Customer $customer The ID of the customer for this Session. For Checkout Sessions in <code>payment</code> or <code>subscription</code> mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.</td> <td>2</td> </tr> <tr> <td>null|string $customer_creation Configure whether a Checkout Session creates a Customer when the Checkout Session completes.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $customer_details The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in <code>setup</code> mode.</td> <td>2</td> </tr> <tr> <td>null|string $customer_email If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the <code>customer</code> attribute.</td> <td>2</td> </tr> <tr> <td>int $expires_at The timestamp at which the Checkout Session will expire.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Invoice $invoice ID of the invoice created by the Checkout Session, if it exists.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $invoice_creation Details on the state of invoice creation for the Checkout Session.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\LineItem> $line_items The line items purchased by the customer.</td> <td>2</td> </tr> <tr> <td>null|string $locale The IETF language tag of the locale Checkout is displayed in. If blank or <code>auto</code>, the browser's locale is used.</td> <td>2</td> </tr> <tr> <td>string $mode The mode of the Checkout Session.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent The ID of the PaymentIntent for Checkout Sessions in <code>payment</code> mode.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentLink $payment_link The ID of the Payment Link that created this Session.</td> <td>2</td> </tr> <tr> <td>null|string $payment_method_collection Configure whether a Checkout Session should collect a payment method.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.</td> <td>2</td> </tr> <tr> <td>string[] $payment_method_types A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.</td> <td>2</td> </tr> <tr> <td>string $payment_status The payment status of the Checkout Session, one of <code>paid</code>, <code>unpaid</code>, or <code>no_payment_required</code>. You can use this value to decide when to fulfill your customer's order.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $phone_number_collection</td> <td>2</td> </tr> <tr> <td>null|string $recovered_from The ID of the original expired Checkout Session that triggered the recovery flow.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\SetupIntent $setup_intent The ID of the SetupIntent for Checkout Sessions in <code>setup</code> mode.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_address_collection When set, provides configuration for Checkout to collect a shipping address from a customer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $shipping_details Shipping information for this Checkout Session.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $shipping_options The shipping rate options applied to this Session.</td> <td>2</td> </tr> <tr> <td>null|string $status The status of the Checkout Session, one of <code>open</code>, <code>complete</code>, or <code>expired</code>.</td> <td>2</td> </tr> <tr> <td>null|string $submit_type Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. <code>submit_type</code> can only be specified on Checkout Sessions in <code>payment</code> mode, but not Checkout Sessions in <code>subscription</code> or <code>setup</code> mode.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\Subscription $subscription The ID of the subscription for Checkout Sessions in <code>subscription</code> mode.</td> <td>2</td> </tr> <tr> <td>string $success_url The URL the customer will be directed to after the payment or subscription creation is successful.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $tax_id_collection</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $total_details Tax and discount details for the computed total amount.</td> <td>2</td> </tr> <tr> <td>null|string $url The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using <a href="https://stripe.com/docs/payments/checkout/custom-domains">Custom Domains</a>, the URL will use your subdomain. Otherwise, it’ll use <code>checkout.stripe.com.</code> This value is only present when the session is active.</td> <td>2</td> </tr> <tr> <td>int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $error</td> <td>2</td> </tr> <tr> <td>null|\Stripe\File $file The file object representing the results of the query.</td> <td>2</td> </tr> <tr> <td>int $result_available_until Time at which the result expires and is no longer available for download.</td> <td>2</td> </tr> <tr> <td>string $sql SQL for the query.</td> <td>2</td> </tr> <tr> <td>string $status The query's execution status, which will be <code>completed</code> for successful runs, and <code>canceled</code>, <code>failed</code>, or <code>timed_out</code> otherwise.</td> <td>2</td> </tr> <tr> <td>string $title Title of the query.</td> <td>2</td> </tr> <tr> <td>AccountLinkService $accountLinks</td> <td>2</td> </tr> <tr> <td>ApplePayDomainService $applePayDomains</td> <td>2</td> </tr> <tr> <td>ApplicationFeeService $applicationFees</td> <td>2</td> </tr> <tr> <td>Apps\AppsServiceFactory $apps</td> <td>2</td> </tr> <tr> <td>BalanceService $balance</td> <td>2</td> </tr> <tr> <td>BalanceTransactionService $balanceTransactions</td> <td>2</td> </tr> <tr> <td>BillingPortal\BillingPortalServiceFactory $billingPortal</td> <td>2</td> </tr> <tr> <td>ChargeService $charges</td> <td>2</td> </tr> <tr> <td>Checkout\CheckoutServiceFactory $checkout</td> <td>2</td> </tr> <tr> <td>CountrySpecService $countrySpecs</td> <td>2</td> </tr> <tr> <td>CouponService $coupons</td> <td>2</td> </tr> <tr> <td>CreditNoteService $creditNotes</td> <td>2</td> </tr> <tr> <td>EphemeralKeyService $ephemeralKeys</td> <td>2</td> </tr> <tr> <td>EventService $events</td> <td>2</td> </tr> <tr> <td>ExchangeRateService $exchangeRates</td> <td>2</td> </tr> <tr> <td>FileLinkService $fileLinks</td> <td>2</td> </tr> <tr> <td>FileService $files</td> <td>2</td> </tr> <tr> <td>FinancialConnections\FinancialConnectionsServiceFactory $financialConnections</td> <td>2</td> </tr> <tr> <td>Identity\IdentityServiceFactory $identity</td> <td>2</td> </tr> <tr> <td>InvoiceItemService $invoiceItems</td> <td>2</td> </tr> <tr> <td>InvoiceService $invoices</td> <td>2</td> </tr> <tr> <td>MandateService $mandates</td> <td>2</td> </tr> <tr> <td>OAuthService $oauth</td> <td>2</td> </tr> <tr> <td>PaymentIntentService $paymentIntents</td> <td>2</td> </tr> <tr> <td>PaymentLinkService $paymentLinks</td> <td>2</td> </tr> <tr> <td>PaymentMethodService $paymentMethods</td> <td>2</td> </tr> <tr> <td>PayoutService $payouts</td> <td>2</td> </tr> <tr> <td>PlanService $plans</td> <td>2</td> </tr> <tr> <td>PriceService $prices</td> <td>2</td> </tr> <tr> <td>ProductService $products</td> <td>2</td> </tr> <tr> <td>PromotionCodeService $promotionCodes</td> <td>2</td> </tr> <tr> <td>QuoteService $quotes</td> <td>2</td> </tr> <tr> <td>Radar\RadarServiceFactory $radar</td> <td>2</td> </tr> <tr> <td>Reporting\ReportingServiceFactory $reporting</td> <td>2</td> </tr> <tr> <td>ReviewService $reviews</td> <td>2</td> </tr> <tr> <td>SetupAttemptService $setupAttempts</td> <td>2</td> </tr> <tr> <td>SetupIntentService $setupIntents</td> <td>2</td> </tr> <tr> <td>ShippingRateService $shippingRates</td> <td>2</td> </tr> <tr> <td>Sigma\SigmaServiceFactory $sigma</td> <td>2</td> </tr> <tr> <td>SourceService $sources</td> <td>2</td> </tr> <tr> <td>SubscriptionItemService $subscriptionItems</td> <td>2</td> </tr> <tr> <td>SubscriptionService $subscriptions</td> <td>2</td> </tr> <tr> <td>SubscriptionScheduleService $subscriptionSchedules</td> <td>2</td> </tr> <tr> <td>TaxCodeService $taxCodes</td> <td>2</td> </tr> <tr> <td>TaxRateService $taxRates</td> <td>2</td> </tr> <tr> <td>TestHelpers\TestHelpersServiceFactory $testHelpers</td> <td>2</td> </tr> <tr> <td>TokenService $tokens</td> <td>2</td> </tr> <tr> <td>TopupService $topups</td> <td>2</td> </tr> <tr> <td>TransferService $transfers</td> <td>2</td> </tr> <tr> <td>WebhookEndpointService $webhookEndpoints</td> <td>2</td> </tr> <tr> <td>ReportRunService $reportRuns</td> <td>2</td> </tr> <tr> <td>ReportTypeService $reportTypes</td> <td>2</td> </tr> <tr> <td>VerificationReportService $verificationReports</td> <td>2</td> </tr> <tr> <td>VerificationSessionService $verificationSessions</td> <td>2</td> </tr> <tr> <td>TestClockService $testClocks</td> <td>2</td> </tr> <tr> <td>AuthorizationService $authorizations</td> <td>2</td> </tr> <tr> <td>CardholderService $cardholders</td> <td>2</td> </tr> <tr> <td>ConnectionTokenService $connectionTokens</td> <td>2</td> </tr> <tr> <td>LocationService $locations</td> <td>2</td> </tr> <tr> <td>ScheduledQueryRunService $scheduledQueryRuns</td> <td>2</td> </tr> <tr> <td>CreditReversalService $creditReversals</td> <td>2</td> </tr> <tr> <td>DebitReversalService $debitReversals</td> <td>2</td> </tr> <tr> <td>FinancialAccountService $financialAccounts</td> <td>2</td> </tr> <tr> <td>TransactionEntryService $transactionEntries</td> <td>2</td> </tr> <tr> <td>EarlyFraudWarningService $earlyFraudWarnings</td> <td>2</td> </tr> <tr> <td>ValueListItemService $valueListItems</td> <td>2</td> </tr> <tr> <td>ValueListService $valueLists</td> <td>2</td> </tr> <tr> <td>SecretService $secrets</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.</td> <td>2</td> </tr> <tr> <td>null|string $flow ID of the flow that created the Transaction.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $flow_details Details of the flow that created the Transaction.</td> <td>2</td> </tr> <tr> <td>string $flow_type Type of the flow that created the Transaction.</td> <td>2</td> </tr> <tr> <td>string $status Status of the Transaction.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $card_issuing Toggle settings for enabling/disabling a feature</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $deposit_insurance Toggle settings for enabling/disabling a feature</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $financial_addresses Settings related to Financial Addresses features on a Financial Account</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $inbound_transfers InboundTransfers contains inbound transfers features for a FinancialAccount.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $intra_stripe_flows Toggle settings for enabling/disabling a feature</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $outbound_payments Settings related to Outbound Payments features on a Financial Account</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $outbound_transfers OutboundTransfers contains outbound transfers features for a FinancialAccount.</td> <td>2</td> </tr> <tr> <td>null|string $failure_code Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.</td> <td>2</td> </tr> <tr> <td>null|string $financial_account The FinancialAccount that funds were pulled from.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $initiating_payment_method_details</td> <td>2</td> </tr> <tr> <td>string $network The network used for the ReceivedDebit.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedDebit might be reversed.</td> <td>2</td> </tr> <tr> <td>string $status Status of the ReceivedDebit. ReceivedDebits are created with a status of either <code>succeeded</code> (approved) or <code>failed</code> (declined). The failure reason can be found under the <code>failure_code</code>.</td> <td>2</td> </tr> <tr> <td>null|string $financial_account The FinancialAccount to reverse funds from.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $linked_flows Other flows linked to a DebitReversal.</td> <td>2</td> </tr> <tr> <td>string $received_debit The ReceivedDebit being reversed.</td> <td>2</td> </tr> <tr> <td>string $status Status of the DebitReversal</td> <td>2</td> </tr> <tr> <td>null|string $customer ID of the <a href="https://stripe.com/docs/api/customers">customer</a> to whom an OutboundPayment is sent.</td> <td>2</td> </tr> <tr> <td>null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using <code>destination_payment_method_data</code>.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $end_user_details Details about the end user.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is <code>returned</code>.</td> <td>2</td> </tr> <tr> <td>string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).</td> <td>2</td> </tr> <tr> <td>string $status Current status of the OutboundPayment: <code>processing</code>, <code>failed</code>, <code>posted</code>, <code>returned</code>, <code>canceled</code>. An OutboundPayment is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundPayment has been "confirmed" and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundPayment fails to arrive at its destination, its status will change to <code>returned</code>.</td> <td>2</td> </tr> <tr> <td>int $effective_at When the TransactionEntry will impact the FinancialAccount's balance.</td> <td>2</td> </tr> <tr> <td>null|string $flow Token of the flow associated with the TransactionEntry.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $flow_details Details of the flow associated with the TransactionEntry.</td> <td>2</td> </tr> <tr> <td>string $flow_type Type of the flow associated with the TransactionEntry.</td> <td>2</td> </tr> <tr> <td>string $type The specific money movement that generated the TransactionEntry.</td> <td>2</td> </tr> <tr> <td>null|string $failure_code Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.</td> <td>2</td> </tr> <tr> <td>null|string $financial_account The FinancialAccount that received the funds.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $initiating_payment_method_details</td> <td>2</td> </tr> <tr> <td>string $network The rails used to send the funds.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedCredit may be reversed.</td> <td>2</td> </tr> <tr> <td>string $status Status of the ReceivedCredit. ReceivedCredits are created either <code>succeeded</code> (approved) or <code>failed</code> (declined). If a ReceivedCredit is declined, the failure reason can be found in the <code>failure_code</code> field.</td> <td>2</td> </tr> <tr> <td>string $financial_account The FinancialAccount to reverse funds from.</td> <td>2</td> </tr> <tr> <td>string $received_credit The ReceivedCredit being reversed.</td> <td>2</td> </tr> <tr> <td>string $status Status of the CreditReversal</td> <td>2</td> </tr> <tr> <td>bool $cancelable Returns <code>true</code> if the InboundTransfer is able to be canceled.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $failure_details Details about this InboundTransfer's failure. Only set when status is <code>failed</code>.</td> <td>2</td> </tr> <tr> <td>string $financial_account The FinancialAccount that received the funds.</td> <td>2</td> </tr> <tr> <td>string $origin_payment_method The origin payment method to be debited for an InboundTransfer.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer.</td> <td>2</td> </tr> <tr> <td>null|bool $returned Returns <code>true</code> if the funds for an InboundTransfer were returned after the InboundTransfer went to the <code>succeeded</code> state.</td> <td>2</td> </tr> <tr> <td>string $statement_descriptor Statement descriptor shown when funds are debited from the source. Not all payment networks support <code>statement_descriptor</code>.</td> <td>2</td> </tr> <tr> <td>string $status Status of the InboundTransfer: <code>processing</code>, <code>succeeded</code>, <code>failed</code>, and <code>canceled</code>. An InboundTransfer is <code>processing</code> if it is created and pending. The status changes to <code>succeeded</code> once the funds have been "confirmed" and a <code>transaction</code> is created and posted. The status changes to <code>failed</code> if the transfer fails.</td> <td>2</td> </tr> <tr> <td>null|string[] $active_features The array of paths to active Features in the Features hash.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $balance Balance information for the FinancialAccount</td> <td>2</td> </tr> <tr> <td>string $country Two-letter country code (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).</td> <td>2</td> </tr> <tr> <td>null|\Stripe\Treasury\FinancialAccountFeatures $features Encodes whether a FinancialAccount has access to a particular Feature, with a <code>status</code> enum and associated <code>status_details</code>. Stripe or the platform can control Features via the requested field.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject[] $financial_addresses The set of credentials that resolve to a FinancialAccount.</td> <td>2</td> </tr> <tr> <td>null|string[] $pending_features The array of paths to pending Features in the Features hash.</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $platform_restrictions The set of functionalities that the platform can restrict on the FinancialAccount.</td> <td>2</td> </tr> <tr> <td>null|string[] $restricted_features The array of paths to restricted Features in the Features hash.</td> <td>2</td> </tr> <tr> <td>string $status The enum specifying what state the account is in.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $status_details</td> <td>2</td> </tr> <tr> <td>string[] $supported_currencies The currencies the FinancialAccount can hold a balance in. Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase.</td> <td>2</td> </tr> <tr> <td>null|string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $destination_payment_method_details</td> <td>2</td> </tr> <tr> <td>null|\Stripe\StripeObject $returned_details Details about a returned OutboundTransfer. Only set when the status is <code>returned</code>.</td> <td>2</td> </tr> <tr> <td>string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account.</td> <td>2</td> </tr> <tr> <td>string $status Current status of the OutboundTransfer: <code>processing</code>, <code>failed</code>, <code>canceled</code>, <code>posted</code>, <code>returned</code>. An OutboundTransfer is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundTransfer has been "confirmed" and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundTransfer fails to arrive at its destination, its status will change to <code>returned</code>.</td> <td>2</td> </tr> <tr> <td>string $created_by The name or email address of the user who added this item to the value list.</td> <td>2</td> </tr> <tr> <td>string $value The value of the item.</td> <td>2</td> </tr> <tr> <td>string $value_list The identifier of the value list this item belongs to.</td> <td>2</td> </tr> <tr> <td>string $alias The name of the value list for use in rules.</td> <td>2</td> </tr> <tr> <td>string $created_by The name or email address of the user who created this value list.</td> <td>2</td> </tr> <tr> <td>string $item_type The type of items in the value list. One of <code>card_fingerprint</code>, <code>card_bin</code>, <code>email</code>, <code>ip_address</code>, <code>country</code>, <code>string</code>, <code>case_sensitive_string</code>, or <code>customer_id</code>.</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Radar\ValueListItem> $list_items List of items contained within this value list.</td> <td>2</td> </tr> <tr> <td>string $name The name of the value list.</td> <td>2</td> </tr> <tr> <td>bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.</td> <td>2</td> </tr> <tr> <td>string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded.</td> <td>2</td> </tr> <tr> <td>string $fraud_type The type of fraud labelled by the issuer. One of <code>card_never_received</code>, <code>fraudulent_card_application</code>, <code>made_with_counterfeit_card</code>, <code>made_with_lost_card</code>, <code>made_with_stolen_card</code>, <code>misc</code>, <code>unauthorized_use_of_card</code>.</td> <td>2</td> </tr> <tr> <td>null|string|\Stripe\PaymentIntent $payment_intent ID of the Payment Intent this early fraud warning is for, optionally expanded.</td> <td>2</td> </tr> <tr> <td>null|int $expires_at The Unix timestamp for the expiry time of the secret, after which the secret deletes.</td> <td>2</td> </tr> <tr> <td>string $name A name for the secret that's unique within the scope.</td> <td>2</td> </tr> <tr> <td>null|string $payload The plaintext secret value to be stored.</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject $scope</td> <td>2</td> </tr> <tr> <td>int $year</td> <td>2</td> </tr> <tr> <td>int $yearIso</td> <td>2</td> </tr> <tr> <td>int $month</td> <td>2</td> </tr> <tr> <td>int $day</td> <td>2</td> </tr> <tr> <td>int $hour</td> <td>2</td> </tr> <tr> <td>int $minute</td> <td>2</td> </tr> <tr> <td>int $second</td> <td>2</td> </tr> <tr> <td>int $micro</td> <td>2</td> </tr> <tr> <td>int $microsecond</td> <td>2</td> </tr> <tr> <td>int|float|string $timestamp seconds since the Unix Epoch</td> <td>2</td> </tr> <tr> <td>string $englishDayOfWeek the day of week in English</td> <td>2</td> </tr> <tr> <td>string $shortEnglishDayOfWeek the abbreviated day of week in English</td> <td>2</td> </tr> <tr> <td>string $englishMonth the month in English</td> <td>2</td> </tr> <tr> <td>string $shortEnglishMonth the abbreviated month in English</td> <td>2</td> </tr> <tr> <td>int $milliseconds</td> <td>2</td> </tr> <tr> <td>int $millisecond</td> <td>2</td> </tr> <tr> <td>int $milli</td> <td>2</td> </tr> <tr> <td>int $week 1 through 53</td> <td>2</td> </tr> <tr> <td>int $isoWeek 1 through 53</td> <td>2</td> </tr> <tr> <td>int $weekYear year according to week format</td> <td>2</td> </tr> <tr> <td>int $isoWeekYear year according to ISO week format</td> <td>2</td> </tr> <tr> <td>int $dayOfYear 1 through 366</td> <td>2</td> </tr> <tr> <td>int $age does a diffInYears() with default parameters</td> <td>2</td> </tr> <tr> <td>int $offset the timezone offset in seconds from UTC</td> <td>2</td> </tr> <tr> <td>int $offsetMinutes the timezone offset in minutes from UTC</td> <td>2</td> </tr> <tr> <td>int $offsetHours the timezone offset in hours from UTC</td> <td>2</td> </tr> <tr> <td>CarbonTimeZone $timezone the current timezone</td> <td>2</td> </tr> <tr> <td>CarbonTimeZone $tz alias of $timezone</td> <td>2</td> </tr> <tr> <td>int $month</td> <td>2</td> </tr> <tr> <td>int $daysInMonth</td> <td>2</td> </tr> <tr> <td>int $quarter</td> <td>2</td> </tr> <tr> <td>int $year</td> <td>3</td> </tr> <tr> <td>null|\Stripe\StripeObject $acss_debit</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $alipay</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $au_becs_debit</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $bancontact</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $billing_details</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $card</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $card_present</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $eps</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $giropay</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $ideal</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $klarna</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $p24</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $radar_options Options to configure Radar. See <a href="https://stripe.com/docs/radar/radar-session">Radar Session</a> for more information.</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $sepa_debit</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $sofort</td> <td>4</td> </tr> <tr> <td>null|bool $attach_to_self <p>If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.</p><p>It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.</p></td> <td>4</td> </tr> <tr> <td>null|string[] $flow_directions <p>Indicates the directions of money movement for which this payment method is intended to be used.</p><p>Include <code>inbound</code> if you intend to use the payment method as the origin to pull funds from. Include <code>outbound</code> if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.</p></td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $payment_method_details</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject[] $custom_fields Collect additional information from your customer using custom fields. Up to 2 fields are supported.</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $custom_text</td> <td>4</td> </tr> <tr> <td>null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the <a href="https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts">Connect documentation</a> for details.</td> <td>4</td> </tr> <tr> <td>int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.</td> <td>4</td> </tr> <tr> <td>null|string $transfer_group A string that identifies this transaction as part of a group. See the <a href="https://stripe.com/docs/connect/charges-transfers#transfer-options">Connect documentation</a> for details.</td> <td>4</td> </tr> <tr> <td>int $amount</td> <td>4</td> </tr> <tr> <td>int $created</td> <td>4</td> </tr> <tr> <td>string $currency</td> <td>4</td> </tr> <tr> <td>string $type</td> <td>4</td> </tr> <tr> <td>string $url</td> <td>4</td> </tr> <tr> <td>bool $has_more</td> <td>4</td> </tr> <tr> <td>TStripeObject[] $data</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $future_requirements</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $requirements</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $evidence</td> <td>4</td> </tr> <tr> <td>null|string $unit_amount_decimal Same as <code>unit_amount</code>, but contains a decimal value with at most 12 decimal places.</td> <td>4</td> </tr> <tr> <td>int $amount_shipping This is the sum of all the shipping amounts.</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires <code>billing_scheme</code> to be set to <code>tiered</code>. See also the documentation for <code>billing_scheme</code>.</td> <td>4</td> </tr> <tr> <td>null|string $tiers_mode Defines if the tiering price should be <code>graduated</code> or <code>volume</code> based. In <code>volume</code>-based tiering, the maximum quantity within a period determines the per unit price. In <code>graduated</code> tiering, pricing can change as the quantity grows.</td> <td>4</td> </tr> <tr> <td>int $amount_subtotal Total before any discounts or taxes are applied.</td> <td>4</td> </tr> <tr> <td>null|string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $options</td> <td>4</td> </tr> <tr> <td>null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in <code>currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $merchant_data</td> <td>4</td> </tr> <tr> <td>AccountService $accounts</td> <td>4</td> </tr> <tr> <td>CustomerService $customers</td> <td>4</td> </tr> <tr> <td>DisputeService $disputes</td> <td>4</td> </tr> <tr> <td>Issuing\IssuingServiceFactory $issuing</td> <td>4</td> </tr> <tr> <td>RefundService $refunds</td> <td>4</td> </tr> <tr> <td>Terminal\TerminalServiceFactory $terminal</td> <td>4</td> </tr> <tr> <td>Treasury\TreasuryServiceFactory $treasury</td> <td>4</td> </tr> <tr> <td>CardService $cards</td> <td>4</td> </tr> <tr> <td>ReaderService $readers</td> <td>4</td> </tr> <tr> <td>InboundTransferService $inboundTransfers</td> <td>4</td> </tr> <tr> <td>OutboundPaymentService $outboundPayments</td> <td>4</td> </tr> <tr> <td>OutboundTransferService $outboundTransfers</td> <td>4</td> </tr> <tr> <td>ReceivedCreditService $receivedCredits</td> <td>4</td> </tr> <tr> <td>ReceivedDebitService $receivedDebits</td> <td>4</td> </tr> <tr> <td>TransactionService $transactions</td> <td>4</td> </tr> <tr> <td>ConfigurationService $configurations</td> <td>4</td> </tr> <tr> <td>\Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance</td> <td>4</td> </tr> <tr> <td>string $financial_account The FinancialAccount associated with this object.</td> <td>4</td> </tr> <tr> <td>string $network The rails used to reverse the funds.</td> <td>4</td> </tr> <tr> <td>bool $cancelable Returns <code>true</code> if the object can be canceled, and <code>false</code> otherwise.</td> <td>4</td> </tr> <tr> <td>int $expected_arrival_date The date when funds are expected to arrive in the destination account.</td> <td>4</td> </tr> <tr> <td>string $financial_account The FinancialAccount that funds were pulled from.</td> <td>4</td> </tr> <tr> <td>int $amount Amount, in %s.</td> <td>6</td> </tr> <tr> <td>null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.</td> <td>6</td> </tr> <tr> <td>string $id</td> <td>6</td> </tr> <tr> <td>\Stripe\StripeObject $period</td> <td>6</td> </tr> <tr> <td>SessionService $sessions</td> <td>6</td> </tr> <tr> <td>string $description An arbitrary string attached to the object. Often useful for displaying to users.</td> <td>6</td> </tr> <tr> <td>\Stripe\StripeObject $linked_flows</td> <td>6</td> </tr> <tr> <td>string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.</td> <td>6</td> </tr> <tr> <td>\Stripe\StripeObject $automatic_tax</td> <td>10</td> </tr> <tr> <td>string $object</td> <td>10</td> </tr> <tr> <td>null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.</td> <td>10</td> </tr> <tr> <td>null|string $hosted_regulatory_receipt_url A <a href="https://stripe.com/docs/treasury/moving-money/regulatory-receipts">hosted transaction receipt</a> URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.</td> <td>14</td> </tr> <tr> <td>\Stripe\StripeObject $status_transitions</td> <td>16</td> </tr> <tr> <td>int $amount Amount (in cents) transferred.</td> <td>16</td> </tr> <tr> <td>null|string $description An arbitrary string attached to the object. Often useful for displaying to users.</td> <td>28</td> </tr> <tr> <td>null|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.</td> <td>47</td> </tr> <tr> <td>\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.</td> <td>54</td> </tr> <tr> <td>string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.</td> <td>68</td> </tr> <tr> <td>int $created Time at which the object was created. Measured in seconds since the Unix epoch.</td> <td>142</td> </tr> <tr> <td>bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.</td> <td>152</td> </tr> <tr> <td>string $id Unique identifier for the object.</td> <td>172</td> </tr> <tr> <td>string $object String representing the object's type. Objects of the same type share the same value.</td> <td>196</td> </tr> <tr> <td rowspan="119" style="vertical-align: top;">@protected</td> <td>* @since 1.53.0.TC010</td> <td>1</td> </tr> <tr> <td>* @since 1.53.0.TC016</td> <td>1</td> </tr> <tr> <td>* @since 5.0.005 (2010-05-11)</td> <td>1</td> </tr> <tr> <td>* @since 5.0.005 (2010-05-12)</td> <td>1</td> </tr> <tr> <td>* @since 2.8.000 (2008-03-19)</td> <td>1</td> </tr> <tr> <td>* @since 3.0.014 (2008-05-23)</td> <td>1</td> </tr> <tr> <td>* @since 3.2.000 (2008-06-26)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.007 (2010-08-18)</td> <td>1</td> </tr> <tr> <td>* @since 4.0.014 (2008-07-29)</td> <td>1</td> </tr> <tr> <td>* @since 4.0.021 (2008-08-24)</td> <td>1</td> </tr> <tr> <td>* @since 4.0.028 (2008-09-26)</td> <td>1</td> </tr> <tr> <td>* @since 4.1.000 (2008-10-18)</td> <td>1</td> </tr> <tr> <td>* @since 4.8.005 (2009-09-17)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.001 (2008-10-30)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.007 (2008-11-12)</td> <td>1</td> </tr> <tr> <td>* @since 4.4.000 (2008-12-07)</td> <td>1</td> </tr> <tr> <td>* @since 4.4.001 (2008-12-08)</td> <td>1</td> </tr> <tr> <td>* @since 4.4.002 (2008-12-09)</td> <td>1</td> </tr> <tr> <td>* @since 4.5.025 (2009-03-10)</td> <td>1</td> </tr> <tr> <td>* @since 5.3.011 (2010-06-16)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.101 (2011-07-06)</td> <td>1</td> </tr> <tr> <td>* @since 4.6.006 (2009-04-28)</td> <td>1</td> </tr> <tr> <td>* @since 5.5.011 (2010-07-09)</td> <td>1</td> </tr> <tr> <td>* @since 4.6.022 (2009-06-23)</td> <td>1</td> </tr> <tr> <td>* @since 4.7.000 (2009-08-29)</td> <td>1</td> </tr> <tr> <td>* @since 4.8.027 (2010-01-25)</td> <td>1</td> </tr> <tr> <td>* @since 5.0.000 (2010-04-22)</td> <td>1</td> </tr> <tr> <td>* @since 5.3.002 (2010-06-07)</td> <td>1</td> </tr> <tr> <td>* @since 5.5.008 (2010-07-02)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.003 (2010-10-14)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.102 (2011-07-13)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.204 (2013-01-23)</td> <td>1</td> </tr> <tr> <td>* @since 5.0.000 (2010-05-05)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.022 (2010-08-31)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.013 (2010-08-23)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.121 (2011-09-28)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.121 (2011-09-27)</td> <td>1</td> </tr> <tr> <td>* @since 6.2.26 (2019-03-12)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.128 (2011-10-06)</td> <td>1</td> </tr> <tr> <td>* @since 6.3.0 (2019-09-19)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.1632 (2012-06-05)</td> <td>1</td> </tr> <tr> <td>comment - only for authenticated users</td> <td>1</td> </tr> <tr> <td>* @since 5.5.009 (2010-07-05)</td> <td>1</td> </tr> <tr> <td>* @since 1.0.000 (2011-06-26)</td> <td>1</td> </tr> <tr> <td>* @author Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira</td> <td>1</td> </tr> <tr> <td>* @see startTemplate(), endTemplate(), printTemplate()</td> <td>1</td> </tr> <tr> <td>* @see getPageSizeFromFormat(), setPageFormat()</td> <td>1</td> </tr> <tr> <td>* @since 5.8.009 (2010-08-20)</td> <td>1</td> </tr> <tr> <td>* @since 4.8.008 (2009-09-29)</td> <td>1</td> </tr> <tr> <td>* @since 4.9.008 (2009-09-29)</td> <td>1</td> </tr> <tr> <td>* @since 4.6.028 (2009-08-25)</td> <td>1</td> </tr> <tr> <td>* @since 3.0.015 (2008-06-06)</td> <td>1</td> </tr> <tr> <td>* @since 2.1.000 (2008-01-07)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.119 (2011-09-19)</td> <td>1</td> </tr> <tr> <td>* @author Olivier Plathey, Nicola Asuni</td> <td>1</td> </tr> <tr> <td>* @author Denis Van Nuffelen, Nicola Asuni</td> <td>1</td> </tr> <tr> <td>* @since 5.9.091 (2011-06-15)</td> <td>1</td> </tr> <tr> <td>* @since 4.5.030 (2009-03-25)</td> <td>1</td> </tr> <tr> <td>* @see Annotation()</td> <td>1</td> </tr> <tr> <td>* @author Richard Stockinger</td> <td>1</td> </tr> <tr> <td>* @since 1.0</td> <td>1</td> </tr> <tr> <td>* @since 5.9.167 (2012-06-22)</td> <td>1</td> </tr> <tr> <td>* @see SetLineStyle()</td> <td>1</td> </tr> <tr> <td>* @since 3.2.000 (2008-06-20)</td> <td>1</td> </tr> <tr> <td>static</td> <td>1</td> </tr> <tr> <td>* @since 4.4.004 (2008-12-10)</td> <td>1</td> </tr> <tr> <td>* @since 5.5.000 (2010-06-22)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.003 (2010-10-13)</td> <td>1</td> </tr> <tr> <td>* @since 2.8.000 (2007-03-29)</td> <td>2</td> </tr> <tr> <td>* @since 1.53.0.TC013</td> <td>2</td> </tr> <tr> <td>* @since 2.0.000</td> <td>2</td> </tr> <tr> <td>* @since 4.6.021 (2009-07-20)</td> <td>2</td> </tr> <tr> <td>* @since 4.0.013 (2008-07-28)</td> <td>2</td> </tr> <tr> <td>* @since 4.0.024 (2008-09-12)</td> <td>2</td> </tr> <tr> <td>* @since 4.4.003 (2008-12-09)</td> <td>2</td> </tr> <tr> <td>* @since 4.5.029 (2009-03-19)</td> <td>2</td> </tr> <tr> <td>* @since 4.5.030 (2009-03-20)</td> <td>2</td> </tr> <tr> <td>* @since 6.0.085 (2014-06-19)</td> <td>2</td> </tr> <tr> <td>* @since 4.8.006 (2009-09-23)</td> <td>2</td> </tr> <tr> <td>* @since 5.8.000 (2010-08-11)</td> <td>2</td> </tr> <tr> <td>* @since 5.0.000 (2010-04-26)</td> <td>2</td> </tr> <tr> <td>* @since 5.8.017 (2010-08-24)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.000 (2010-09-29)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.097 (2011-06-23)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.152 (2012-03-22)</td> <td>2</td> </tr> <tr> <td>* @since 1.0.003 (2013-03-16)</td> <td>2</td> </tr> <tr> <td>* @since 1.0.000 (2011-06-22)</td> <td>2</td> </tr> <tr> <td>* @since 4.3.007 (2008-12-04)</td> <td>2</td> </tr> <tr> <td>* @since 4.9.015 (2010-04-19)</td> <td>2</td> </tr> <tr> <td>* @since 4.9.019 (2010-04-26)</td> <td>2</td> </tr> <tr> <td>* @author Johannes G\FCntert, Nicola Asuni</td> <td>2</td> </tr> <tr> <td>* @since 4.0.012 (2008-07-24)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.000 (2010-10-02)</td> <td>2</td> </tr> <tr> <td>* @since 5.8.014 (2010-08-23)</td> <td>3</td> </tr> <tr> <td>* @since 3.1.000 (2008-06-09)</td> <td>3</td> </tr> <tr> <td>* @since 5.7.000 (2010-08-03)</td> <td>3</td> </tr> <tr> <td>* @since 3.2.000 (2008-07-01)</td> <td>3</td> </tr> <tr> <td>* @since 4.2.010 (2008-11-14)</td> <td>3</td> </tr> <tr> <td>* @since 4.6.005 (2009-04-24)</td> <td>3</td> </tr> <tr> <td>* @since 4.9.008 (2010-04-03)</td> <td>3</td> </tr> <tr> <td>* @since 5.9.006 (2010-10-19)</td> <td>3</td> </tr> <tr> <td>* @since 5.7.000 (2010-08-02)</td> <td>3</td> </tr> <tr> <td>* @since 4.0.006 (2008-07-16)</td> <td>4</td> </tr> <tr> <td>* @since 4.2.000 (2008-10-29)</td> <td>4</td> </tr> <tr> <td>* @since 5.9.152 (2012-03-23)</td> <td>4</td> </tr> <tr> <td>* @since 1.0.000 (2011-06-20)</td> <td>4</td> </tr> <tr> <td>* @since 1.0.000 (2011-05-24)</td> <td>4</td> </tr> <tr> <td>* @since 2.1.002 (2008-02-12)</td> <td>5</td> </tr> <tr> <td>* @since 4.8.001 (2009-09-09)</td> <td>5</td> </tr> <tr> <td>* @since 4.9.001 (2010-03-28)</td> <td>5</td> </tr> <tr> <td>* @since 2.1.000 (2008-01-08)</td> <td>5</td> </tr> <tr> <td>* @since 2.0.000 (2008-01-02)</td> <td>6</td> </tr> <tr> <td>* @since 4.8.000 (2009-09-07)</td> <td>6</td> </tr> <tr> <td>* @since 4.5.000 (2009-01-02)</td> <td>8</td> </tr> <tr> <td>* @since 3.0.000 (2008-03-27)</td> <td>10</td> </tr> <tr> <td>* @since 4.5.000 (2008-12-31)</td> <td>10</td> </tr> <tr> <td>* @since 5.0.000 (2010-05-02)</td> <td>11</td> </tr> <tr> <td>* @author Nicola Asuni</td> <td>11</td> </tr> <tr> <td>*/</td> <td>227</td> </tr> <tr> <td rowspan="93" style="vertical-align: top;">@public</td> <td>array</td> <td>1</td> </tr> <tr> <td>- available for all</td> <td>1</td> </tr> <tr> <td>* @since 4.5.016 (2009-02-24)</td> <td>1</td> </tr> <tr> <td>* @see setImageScale(), getImageScale()</td> <td>1</td> </tr> <tr> <td>* @since 2.0.000 (2008-01-02)</td> <td>1</td> </tr> <tr> <td>* @see getPageSizeFromFormat(), setPageFormat()</td> <td>1</td> </tr> <tr> <td>* @since 1.53.0.TC016</td> <td>1</td> </tr> <tr> <td>* @since 4.6.016 (2009-06-15)</td> <td>1</td> </tr> <tr> <td>* @since 2.0.000 (2008-01-03)</td> <td>1</td> </tr> <tr> <td>* @since 4.8.014 (2009-11-04)</td> <td>1</td> </tr> <tr> <td>* @since 1.53.0.TC034</td> <td>1</td> </tr> <tr> <td>* @since 4.0.017 (2008-08-05)</td> <td>1</td> </tr> <tr> <td>* @since 4.5.027 (2009-03-16)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.088</td> <td>1</td> </tr> <tr> <td>* @since 5.9.121 (2011-09-28)</td> <td>1</td> </tr> <tr> <td>* @since 2.0.000 (2008-01-04)</td> <td>1</td> </tr> <tr> <td>* @since 4.9.019 (2010-04-22)</td> <td>1</td> </tr> <tr> <td>* @author Christian Deligant, Nicola Asuni</td> <td>1</td> </tr> <tr> <td>* @since 4.0.016 (2008-07-30)</td> <td>1</td> </tr> <tr> <td>* @since 2.1.002 (2008-02-12)</td> <td>1</td> </tr> <tr> <td>* @author Johannes G\FCntert, Nicola Asuni</td> <td>1</td> </tr> <tr> <td>* @since 6.0.038 (2013-09-30)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.000 (2010-09-28)</td> <td>1</td> </tr> <tr> <td>* @since 2.0.0001 (2008-01-07)</td> <td>1</td> </tr> <tr> <td>* @author Richard Stockinger</td> <td>1</td> </tr> <tr> <td>* @since 4.5.025</td> <td>1</td> </tr> <tr> <td>* @since 4.0.018 (2008-08-06)</td> <td>1</td> </tr> <tr> <td>* @since 4.3.003 (2008-11-18)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.005 (2008-11-06)</td> <td>1</td> </tr> <tr> <td>* @since 4.5.011</td> <td>1</td> </tr> <tr> <td>* @since 5.9.017 (2010-11-16)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.010 (2010-10-27)</td> <td>1</td> </tr> <tr> <td>* @since 4.0.028 (2008-09-26)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.000 (2008-10-29)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.001 (2008-10-30)</td> <td>1</td> </tr> <tr> <td>* @since 4.2.007 (2008-11-12)</td> <td>1</td> </tr> <tr> <td>* @since 4.4.003 (2008-12-09)</td> <td>1</td> </tr> <tr> <td>* @since 4.4.004 (2008-12-10)</td> <td>1</td> </tr> <tr> <td>* @since 4.6.004 (2009-04-23)</td> <td>1</td> </tr> <tr> <td>* @since 4.9.015 (2010-04-20)</td> <td>1</td> </tr> <tr> <td>* @since 5.9.072 (2011-04-26)</td> <td>1</td> </tr> <tr> <td>* @since 5.5.011 (2010-07-08)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.018 (2010-08-25)</td> <td>1</td> </tr> <tr> <td>* @since 4.9.008 (2009-04-02)</td> <td>1</td> </tr> <tr> <td>* @since 5.0.000 (2010-04-27)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.002 (2010-08-14)</td> <td>1</td> </tr> <tr> <td>* @since 5.8.004 (2010-08-17)</td> <td>1</td> </tr> <tr> <td>* @since 1.0.000</td> <td>1</td> </tr> <tr> <td>* @since 1.0.000 (2011-05-23)</td> <td>2</td> </tr> <tr> <td>* @since 3.0.015 (2008-06-06)</td> <td>2</td> </tr> <tr> <td>* @see SetLineStyle()</td> <td>2</td> </tr> <tr> <td>* @since 2.1.000 (2008-01-09)</td> <td>2</td> </tr> <tr> <td>* @since 5.0.001 (2010-05-06)</td> <td>2</td> </tr> <tr> <td>* @since 4.2.010 (2008-11-14)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.125 (2011-10-03)</td> <td>2</td> </tr> <tr> <td>* @since 3.1.000 (2008-06-11)</td> <td>2</td> </tr> <tr> <td>* @since 3.1.000 (2008-6-11)</td> <td>2</td> </tr> <tr> <td>* @since 2.4.000 (2008-03-06)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.153 (2012-03-28)</td> <td>2</td> </tr> <tr> <td>* @since 4.5.000 (2009-01-02)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.102 (2011-07-13)</td> <td>2</td> </tr> <tr> <td>* @since 3.0.014 (2008-06-04)</td> <td>2</td> </tr> <tr> <td>* @since 3.1.000 (2008-06-09)</td> <td>2</td> </tr> <tr> <td>* @since 4.3.008 (2008-12-05)</td> <td>2</td> </tr> <tr> <td>* @since 5.9.000 (2010-10-04)</td> <td>2</td> </tr> <tr> <td>* @since 5.3.002 (2010-06-07)</td> <td>2</td> </tr> <tr> <td>* @since 1.0.000 (2011-05-24)</td> <td>3</td> </tr> <tr> <td>* @since 1.0.000 (2011-06-26)</td> <td>3</td> </tr> <tr> <td>* @since 5.9.186 (2012-09-13)</td> <td>3</td> </tr> <tr> <td>* @since 1.4</td> <td>3</td> </tr> <tr> <td>* @since 3.2.000 (2008-06-23)</td> <td>3</td> </tr> <tr> <td>* @since 4.5.029 (2009-03-19)</td> <td>3</td> </tr> <tr> <td>* @since 4.9.001 (2010-03-28)</td> <td>3</td> </tr> <tr> <td>* @since 5.8.000 (2010-08-11)</td> <td>3</td> </tr> <tr> <td>* @since 5.8.017 (2010-08-24)</td> <td>3</td> </tr> <tr> <td>* @since 1.1</td> <td>4</td> </tr> <tr> <td>* @since 4.0.024 (2008-09-12)</td> <td>4</td> </tr> <tr> <td>* @since 1.3</td> <td>4</td> </tr> <tr> <td>* @since 5.9.000 (2010-09-29)</td> <td>4</td> </tr> <tr> <td>* @since 5.9.003 (2010-10-13)</td> <td>4</td> </tr> <tr> <td>* @since 5.9.000 (2010-10-03)</td> <td>6</td> </tr> <tr> <td>* @since 1.5.2</td> <td>6</td> </tr> <tr> <td>* @since 3.0.000 (2008-03-27)</td> <td>6</td> </tr> <tr> <td>* @since 4.0.012 (2008-07-24)</td> <td>7</td> </tr> <tr> <td>* @since 2.1.000 (2008-01-08)</td> <td>7</td> </tr> <tr> <td>* @since 1.5</td> <td>7</td> </tr> <tr> <td>* @since 5.9.152 (2012-03-23)</td> <td>8</td> </tr> <tr> <td>* @since 1.2</td> <td>11</td> </tr> <tr> <td>* @since 1.0</td> <td>18</td> </tr> <tr> <td>* @author Nicola Asuni</td> <td>18</td> </tr> <tr> <td>* @since 2.1.000 (2008-01-07)</td> <td>21</td> </tr> <tr> <td>*/</td> <td>85</td> </tr> <tr> <td>static</td> <td>126</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@remarks</td> <td>backupGlobals must be disabled to have db,conf,user and lang not erased.</td> <td>1</td> </tr> <tr> <td rowspan="4" style="vertical-align: top;">@requires</td> <td>extension redis</td> <td>1</td> </tr> <tr> <td>extension pdo_sqlite</td> <td>1</td> </tr> <tr> <td>function Twig\Template::getSourceContext</td> <td>1</td> </tr> <tr> <td>PHP 7.0</td> <td>4</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@retrun</td> <td>array The height and width of the template</td> <td>1</td> </tr> <tr> <td rowspan="4587" style="vertical-align: top;">@return</td> <td>bool True if success, false if failed</td> <td>1</td> </tr> <tr> <td>string Return img tag of weather</td> <td>1</td> </tr> <tr> <td>stdClass Return img tag of weather</td> <td>1</td> </tr> <tr> <td>string New value</td> <td>1</td> </tr> <tr> <td>int >0 if there is an injection, 0 if none</td> <td>1</td> </tr> <tr> <td>boolean True if there is no injection.</td> <td>1</td> </tr> <tr> <td>string HTML content</td> <td>1</td> </tr> <tr> <td>string HTML output</td> <td>1</td> </tr> <tr> <td>array{helpbaseurl:string,helppage:string,mode:string} Array of help urls</td> <td>1</td> </tr> <tr> <td>array Returns an array of tabs</td> <td>1</td> </tr> <tr> <td>array Tabs for the opensurvey section</td> <td>1</td> </tr> <tr> <td>string URL to use</td> <td>1</td> </tr> <tr> <td>bool True if key exists and return a non empty value</td> <td>1</td> </tr> <tr> <td>string L'url pour le sondage</td> <td>1</td> </tr> <tr> <td>string Html code with balance</td> <td>1</td> </tr> <tr> <td>bool If class could be loaded</td> <td>1</td> </tr> <tr> <td>int<-1,1> -1 if Item A before Item B, 0 if same, 1 if later.</td> <td>1</td> </tr> <tr> <td>string A string label to describe a record into llx_bank_url</td> <td>1</td> </tr> <tr> <td>integer Return integer <0 if KO, 0=Bad version, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>boolean True if child exists</td> <td>1</td> </tr> <tr> <td>array{result:array{result_code:string,result_label:string},id?:int} Array result</td> <td>1</td> </tr> <tr> <td>array Array of data</td> <td>1</td> </tr> <tr> <td>integer Timestamp</td> <td>1</td> </tr> <tr> <td>string Error node</td> <td>1</td> </tr> <tr> <td>string Combined path</td> <td>1</td> </tr> <tr> <td>string Config</td> <td>1</td> </tr> <tr> <td>string Full url</td> <td>1</td> </tr> <tr> <td>string String without extension</td> <td>1</td> </tr> <tr> <td>string Parent folder</td> <td>1</td> </tr> <tr> <td>string ''=success, error message otherwise</td> <td>1</td> </tr> <tr> <td>string real path</td> <td>1</td> </tr> <tr> <td>string Path</td> <td>1</td> </tr> <tr> <td>string current folder</td> <td>1</td> </tr> <tr> <td>bool|-1 Returns true if the file contains insecure HTML code at the beginning, or -1 if error</td> <td>1</td> </tr> <tr> <td>bool|-1 Returns true if the file is valid, false if the file is invalid, -1 if error.</td> <td>1</td> </tr> <tr> <td>void (direct print)</td> <td>1</td> </tr> <tr> <td>int<-1,1></td> <td>1</td> </tr> <tr> <td>string Encoded string</td> <td>1</td> </tr> <tr> <td>string|false Text of the number</td> <td>1</td> </tr> <tr> <td>string|int Text of the number or -1 in case TOO LONG (more than 1000000000000.99)</td> <td>1</td> </tr> <tr> <td>array Array with remaining capital, interest, and mensuality for each remaining terms</td> <td>1</td> </tr> <tr> <td>array Array of default values</td> <td>1</td> </tr> <tr> <td>string Return list of image formats</td> <td>1</td> </tr> <tr> <td>int -1=Not image filename, 0=Image filename but format not supported for conversion by PHP, 1=Image filename with format supported by this PHP</td> <td>1</td> </tr> <tr> <td>array array('width'=>width, 'height'=>height)</td> <td>1</td> </tr> <tr> <td>string File name if OK, error message if KO</td> <td>1</td> </tr> <tr> <td>boolean Success or not</td> <td>1</td> </tr> <tr> <td>bool : true on success or false on failure or gd img if $fileDest is false.</td> <td>1</td> </tr> <tr> <td>string|0 Full path of thumb or '' if it fails or 'Error...' if it fails, or 0 if it fails to detect the type of image</td> <td>1</td> </tr> <tr> <td>array Array of tabs to show</td> <td>1</td> </tr> <tr> <td>int Error code</td> <td>1</td> </tr> <tr> <td>array Array of tabs</td> <td>1</td> </tr> <tr> <td>array Array of tabs to shoc</td> <td>1</td> </tr> <tr> <td>boolean True if information are valid, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if information are valid, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if information are valid, false otherwise</td> <td>1</td> </tr> <tr> <td>string Key</td> <td>1</td> </tr> <tr> <td>string Return user or group of web server</td> <td>1</td> </tr> <tr> <td>string Login or '' or '--bad-login-validity--'</td> <td>1</td> </tr> <tr> <td>string Salt string</td> <td>1</td> </tr> <tr> <td>string New value for password</td> <td>1</td> </tr> <tr> <td>string HTML javascript code to set a password</td> <td>1</td> </tr> <tr> <td>array Array of measures</td> <td>1</td> </tr> <tr> <td>array Array of xaxis</td> <td>1</td> </tr> <tr> <td>array Array of groupby</td> <td>1</td> </tr> <tr> <td>array{encoding:string,bars:string,text:string}|string $bars array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info) or string with error message</td> <td>1</td> </tr> <tr> <td>int<0,9> EAN Sum</td> <td>1</td> </tr> <tr> <td>string Encoded EAN</td> <td>1</td> </tr> <tr> <td>string|void</td> <td>1</td> </tr> <tr> <td>string decoded string</td> <td>1</td> </tr> <tr> <td>string Random string</td> <td>1</td> </tr> <tr> <td>string Hash of string</td> <td>1</td> </tr> <tr> <td>bool True if the computed hash is the same as the given one</td> <td>1</td> </tr> <tr> <td>string Hash of password</td> <td>1</td> </tr> <tr> <td>int If mode = 0 (default): Always 1, die process if not allowed. If mode = 1: Return 0 if access not allowed.</td> <td>1</td> </tr> <tr> <td>bool True if user has access, False otherwise</td> <td>1</td> </tr> <tr> <td>array Array with all max size for file upload</td> <td>1</td> </tr> <tr> <td>string A HTML table that contains a pie chart of customers or supplier invoices</td> <td>1</td> </tr> <tr> <td>string A HTML table that contains a list with latest edited customer invoices</td> <td>1</td> </tr> <tr> <td>string A HTML table that contains a list with latest edited supplier invoices</td> <td>1</td> </tr> <tr> <td>array [</td> <td>1</td> </tr> <tr> <td>string Chaine version</td> <td>1</td> </tr> <tr> <td>int -4,-3,-2,-1 if versionarray1<versionarray2 (value depends on level of difference)</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Value of constant</td> <td>1</td> </tr> <tr> <td>array Array of tabs to show</td> <td>1</td> </tr> <tr> <td>array<string,array{login:string,age:int,creation:int,modification:int,raw:string}> Array list of sessions</td> <td>1</td> </tr> <tr> <td>array{nbmodules?:int,errors:string[],nbperms?:int} array('nbmodules'=>nb modules activated with success, 'errors=>array of error messages, 'nbperms'=>Nb permission added);</td> <td>1</td> </tr> <tr> <td>string Error message or '';</td> <td>1</td> </tr> <tr> <td>string HTML string with warning</td> <td>1</td> </tr> <tr> <td>array Array with PHP infos</td> <td>1</td> </tr> <tr> <td>string String encoded</td> <td>1</td> </tr> <tr> <td>string String converted</td> <td>1</td> </tr> <tr> <td>array Array of head</td> <td>1</td> </tr> <tr> <td>string $out Html content</td> <td>1</td> </tr> <tr> <td>string Returns "" when a session is not found or (serialized)string if session exists</td> <td>1</td> </tr> <tr> <td>boolean Always true</td> <td>1</td> </tr> <tr> <td>boolean Always returns true.</td> <td>1</td> </tr> <tr> <td>boolean true if the DELETE query succeeded.</td> <td>1</td> </tr> <tr> <td>int 0</td> <td>1</td> </tr> <tr> <td>array Returns an associative array containing the response from the server array('http_code'=>http response code, 'content'=>response, 'curl_error_no'=>errno, 'curl_error_msg'=>errmsg...)</td> <td>1</td> </tr> <tr> <td>string Error message or ''</td> <td>1</td> </tr> <tr> <td>string Returns domaine name</td> <td>1</td> </tr> <tr> <td>string Returns root url</td> <td>1</td> </tr> <tr> <td>string Returns text without HTML comments</td> <td>1</td> </tr> <tr> <td>array{0:int,1:int,2:int} array(0 or 1 if at least one of this level after, 0 or 1 if at least one of higher level after, nbofdirinsub, nbofdocinsub)</td> <td>1</td> </tr> <tr> <td>array Array of tabs to show</td> <td>1</td> </tr> <tr> <td>array Tabs for the payment section</td> <td>1</td> </tr> <tr> <td>boolean True if OK, false if KO</td> <td>1</td> </tr> <tr> <td>array Array of tabs to show</td> <td>1</td> </tr> <tr> <td>bool True if the string passes the Luhn algorithm check, False otherwise</td> <td>1</td> </tr> <tr> <td>int<-4,3> 1 if NIF ok, 2 if CIF ok, 3 if NIE ok, -1 if NIF bad, -2 if CIF bad, -3 if NIE bad, -4 if unexpected bad</td> <td>1</td> </tr> <tr> <td>array Result of connect</td> <td>1</td> </tr> <tr> <td>int 1=directory, 0=not a directory</td> <td>1</td> </tr> <tr> <td>boolean Result of closing</td> <td>1</td> </tr> <tr> <td>array Array of head entries</td> <td>1</td> </tr> <tr> <td>array Array of head entries</td> <td>1</td> </tr> <tr> <td>string Result string without php code</td> <td>1</td> </tr> <tr> <td>string Result string with php code only</td> <td>1</td> </tr> <tr> <td>string html content</td> <td>1</td> </tr> <tr> <td>string Replacement of all smiley strings with their utf8 code</td> <td>1</td> </tr> <tr> <td>int HTML img content or '' if no image found</td> <td>1</td> </tr> <tr> <td>string HTML img content or '' if no image found</td> <td>1</td> </tr> <tr> <td>array Array with results of search</td> <td>1</td> </tr> <tr> <td>string Unescaped string</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of directories that can contain module descriptors ($key==value)</td> <td>1</td> </tr> <tr> <td>string Default paper format code</td> <td>1</td> </tr> <tr> <td>string Return email tracker string</td> <td>1</td> </tr> <tr> <td>int -1 if error (function not available), 0=Not valid, 1=Valid</td> <td>1</td> </tr> <tr> <td>int 1=Check is OK, 0=Check is KO</td> <td>1</td> </tr> <tr> <td>int 1=Check is OK, 0=Check is KO</td> <td>1</td> </tr> <tr> <td>string Cleaned url</td> <td>1</td> </tr> <tr> <td>string Return email with hidden parts or '';</td> <td>1</td> </tr> <tr> <td>string New value (numeric) or error message</td> <td>1</td> </tr> <tr> <td>string Return part of string</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 or error string if KO, 0 if OK</td> <td>1</td> </tr> <tr> <td>string x</td> <td>1</td> </tr> <tr> <td>string bin</td> <td>1</td> </tr> <tr> <td>string Number of week</td> <td>1</td> </tr> <tr> <td>float Masse convertie</td> <td>1</td> </tr> <tr> <td>string Formatted reduction</td> <td>1</td> </tr> <tr> <td>string OS version</td> <td>1</td> </tr> <tr> <td>string Dolibarr version</td> <td>1</td> </tr> <tr> <td>string Web server version</td> <td>1</td> </tr> <tr> <td>array|int 0 if no module is activated, or array(key=>label). For modules that need directory scan, key is completed with ":filename".</td> <td>1</td> </tr> <tr> <td>int 0 if not valid or reserved range, 1 if valid and public IP, 2 if valid and private range IP</td> <td>1</td> </tr> <tr> <td>string Login</td> <td>1</td> </tr> <tr> <td>string URL of link to object id/type</td> <td>1</td> </tr> <tr> <td>int Nb of records fixed/deleted</td> <td>1</td> </tr> <tr> <td>string RGB hex value (without # before). For example: 'FF00FF', '01FF02'</td> <td>1</td> </tr> <tr> <td>array RGB hex value (without # before). For example: FF00FF</td> <td>1</td> </tr> <tr> <td>string New string of color</td> <td>1</td> </tr> <tr> <td>string New color with format '#AA1122'</td> <td>1</td> </tr> <tr> <td>array Array of combinations</td> <td>1</td> </tr> <tr> <td>string Directory name</td> <td>1</td> </tr> <tr> <td>string A color string '12'</td> <td>1</td> </tr> <tr> <td>string A color string '123456'</td> <td>1</td> </tr> <tr> <td>string String</td> <td>1</td> </tr> <tr> <td>string Chain with formatted upright</td> <td>1</td> </tr> <tr> <td>boolean|array If false, then check was successful, otherwise an array(message,line) of errors is returned.</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if no Return if we accept link added from the media browser into HTML field for public usage</td> <td>1</td> </tr> <tr> <td>string String without global parenthesis</td> <td>1</td> </tr> <tr> <td>array Array of Emojis in hexadecimal</td> <td>1</td> </tr> <tr> <td>string Sanitized string</td> <td>1</td> </tr> <tr> <td>string String Payment reference number or RF creditor reference</td> <td>1</td> </tr> <tr> <td>string String String for FI/RF Payment barcode</td> <td>1</td> </tr> <tr> <td>int<-7,-1>|CommonObject Return integer <=0 if KO, Object if OK</td> <td>1</td> </tr> <tr> <td>array|int Return integer <=0 if KO, array if OK</td> <td>1</td> </tr> <tr> <td>int 1 if OK , -1 if KO</td> <td>1</td> </tr> <tr> <td>int less 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 if OK,-1 if KO</td> <td>1</td> </tr> <tr> <td>array<string,bool|int|float|string|mixed[]> The resulting associative array.</td> <td>1</td> </tr> <tr> <td>int 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string Return the lines between first line with $start and $end. "" if not found.</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int Returns the number of replacements made in the file.</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|void Return int < 0 if error, return nothing on success</td> <td>1</td> </tr> <tr> <td>int<-1,1> -1 if KO, 1 if OK, 0 if nothing change</td> <td>1</td> </tr> <tr> <td>string Formatted value</td> <td>1</td> </tr> <tr> <td>mixed Object or Array</td> <td>1</td> </tr> <tr> <td>mixed Object or Array or false on error</td> <td>1</td> </tr> <tr> <td>string Formatted value</td> <td>1</td> </tr> <tr> <td>string UTF-8 character</td> <td>1</td> </tr> <tr> <td>string UTF-16 character</td> <td>1</td> </tr> <tr> <td>array Tabs of the module</td> <td>1</td> </tr> <tr> <td>array Array of services</td> <td>1</td> </tr> <tr> <td>array<int,string> Array with timezone values</td> <td>1</td> </tr> <tr> <td>string PHP server timezone string ('Europe/Paris')</td> <td>1</td> </tr> <tr> <td>float An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer). Note some countries use half and even quarter hours.</td> <td>1</td> </tr> <tr> <td>int New timestamp</td> <td>1</td> </tr> <tr> <td>int Time into seconds</td> <td>1</td> </tr> <tr> <td>string Formatted text of duration</td> <td>1</td> </tr> <tr> <td>int $result</td> <td>1</td> </tr> <tr> <td>string $sqldate String with SQL filter</td> <td>1</td> </tr> <tr> <td>int Date as a timestamp</td> <td>1</td> </tr> <tr> <td>array Previous year,month,day</td> <td>1</td> </tr> <tr> <td>array Next year,month,day</td> <td>1</td> </tr> <tr> <td>array Previous year,month</td> <td>1</td> </tr> <tr> <td>array Next year,month</td> <td>1</td> </tr> <tr> <td>array Previous year,month,day</td> <td>1</td> </tr> <tr> <td>array Next year,month,day</td> <td>1</td> </tr> <tr> <td>int Date for last hour of a given date</td> <td>1</td> </tr> <tr> <td>int Date for first hour of a given date</td> <td>1</td> </tr> <tr> <td>array year,month,week,first_day,first_month,first_year,prev_day,prev_month,prev_year</td> <td>1</td> </tr> <tr> <td>int GMT Date of easter day</td> <td>1</td> </tr> <tr> <td>int|string Number of non working days or error message string if error</td> <td>1</td> </tr> <tr> <td>int Number of days</td> <td>1</td> </tr> <tr> <td>int|string Number of days or hours or string if error</td> <td>1</td> </tr> <tr> <td>array<int<1,12>,string> String of months in normal or short string format</td> <td>1</td> </tr> <tr> <td>string[] Week numbers (week 1 is '01')</td> <td>1</td> </tr> <tr> <td>string[] First day of week (day 1 is '01')</td> <td>1</td> </tr> <tr> <td>string[] Last day of week (day 1 is '01')</td> <td>1</td> </tr> <tr> <td>string Week number as two digits (week 1 is '01')</td> <td>1</td> </tr> <tr> <td>string Script</td> <td>1</td> </tr> <tr> <td>string Script</td> <td>1</td> </tr> <tr> <td>string Return html string to convert a select field into a combo, or '' if feature has been disabled for some reason.</td> <td>1</td> </tr> <tr> <td>string Return JS string to manage event</td> <td>1</td> </tr> <tr> <td>string html for button on/off</td> <td>1</td> </tr> <tr> <td>int|string|array{id:int,code:string,label:string} Integer with country id or String with country code or translated country name or Array('id','code','label') or 'NotDefined'</td> <td>1</td> </tr> <tr> <td>string|array{id:int,code:string,label:string}|array{id:int,code:string,label:string,region_code:string,region:string} String with state code or state name or Array('id','code','label')/Array('id','code','label','region_code','region')</td> <td>1</td> </tr> <tr> <td>string Label translated of currency</td> <td>1</td> </tr> <tr> <td>string Value of the juridical status</td> <td>1</td> </tr> <tr> <td>array Array of countries code in EEC</td> <td>1</td> </tr> <tr> <td>boolean true = country inside EEC, false = country outside EEC</td> <td>1</td> </tr> <tr> <td>string|void Return html part or void if noprint is 1</td> <td>1</td> </tr> <tr> <td>string|void Return html part or void if noprint is 1</td> <td>1</td> </tr> <tr> <td>string Url string</td> <td>1</td> </tr> <tr> <td>boolean True if OK</td> <td>1</td> </tr> <tr> <td>int Error or not</td> <td>1</td> </tr> <tr> <td>string Basename of input</td> <td>1</td> </tr> <tr> <td>array<array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string}> Array of array('name'=>'xxx','fullname'=>'/abc/xxx','date'=>'yyy','size'=>99,'type'=>'dir|file',...)></td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,label:string,name:string,path:string,level1name:string,fullname:string,fullpath_orig:string,date_c:string,date_m:string,type:string,keywords:string,cover:string,position:int,acl:string,share:string,description:string}> Array of array('name'=>'xxx','fullname'=>'/abc/xxx','date'=>'yyy','size'=>99,'type'=>'dir|file',...)</td> <td>1</td> </tr> <tr> <td>int 1, 0, 1</td> <td>1</td> </tr> <tr> <td>boolean True if it's a directory, False if not found</td> <td>1</td> </tr> <tr> <td>boolean True or false</td> <td>1</td> </tr> <tr> <td>boolean True if the path looks like a URI, else false.</td> <td>1</td> </tr> <tr> <td>boolean True if dir is empty or non-existing, False if it contains files</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Number of lines in files if OK</td> <td>1</td> </tr> <tr> <td>integer File size</td> <td>1</td> </tr> <tr> <td>int Time of file</td> <td>1</td> </tr> <tr> <td>integer File permissions</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, 0 if nothing done (dest file already exists), >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, 0 if nothing done (dest file already exists and overwriteifexists=0), >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, 0 if nothing done (all files already exists and overwriteifexists=0), >0 if OK</td> <td>1</td> </tr> <tr> <td>boolean True if OK, false if KO</td> <td>1</td> </tr> <tr> <td>boolean True if OK, false if KO</td> <td>1</td> </tr> <tr> <td>string Filename sanitized</td> <td>1</td> </tr> <tr> <td>int|string 1 if OK, 2 if OK and .noexe appended, <0 or string if KO</td> <td>1</td> </tr> <tr> <td>boolean True if no error (file is deleted or if glob is used and there's nothing to delete), False if error</td> <td>1</td> </tr> <tr> <td>boolean True if success, false if error</td> <td>1</td> </tr> <tr> <td>int Number of files and directory we try to remove. NB really removed is returned into var by reference $countdeleted.</td> <td>1</td> </tr> <tr> <td>int 0 if error, 1 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if do nothing, >0 if we update meta file too, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array array('error'=>'Error code') or array() if no error</td> <td>1</td> </tr> <tr> <td>null|array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string} null if none or Array with properties (full path, date, ...) of the most recent file</td> <td>1</td> </tr> <tr> <td>mixed Array with access information : 'accessallowed' & 'sqlprotectagainstexternals' & 'original_file' (as a full path name)</td> <td>1</td> </tr> <tr> <td>boolean 0 no refresh 1 if refresh needed</td> <td>1</td> </tr> <tr> <td>mixed Unserialise from file</td> <td>1</td> </tr> <tr> <td>string Path of file relative to DOL_DATA_ROOT</td> <td>1</td> </tr> <tr> <td>array Array of filenames</td> <td>1</td> </tr> <tr> <td>string Js script to display</td> <td>1</td> </tr> <tr> <td>bool Returns true if successful, false otherwise.</td> <td>1</td> </tr> <tr> <td>string|null The path of the relative directory of the module</td> <td>1</td> </tr> <tr> <td>string|null The path of the relative temp directory of the module</td> <td>1</td> </tr> <tr> <td>string|null The path of the relative version directory of the module</td> <td>1</td> </tr> <tr> <td>boolean True if module is enabled</td> <td>1</td> </tr> <tr> <td>DoliDB A DoliDB instance</td> <td>1</td> </tr> <tr> <td>string Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )</td> <td>1</td> </tr> <tr> <td>int Entity id to use ( eg. entity = '.setEntity($object) )</td> <td>1</td> </tr> <tr> <td>boolean True if key is used to store a secret</td> <td>1</td> </tr> <tr> <td>string Column in Excel format</td> <td>1</td> </tr> <tr> <td>array{browsername:string,browserversion:string,browseros:string,browserua:string,layout:string,phone:string,tablet:bool} Check function documentation</td> <td>1</td> </tr> <tr> <td>boolean True if we have just submit a POST or GET request with the parameter provided (even if param is empty)</td> <td>1</td> </tr> <tr> <td>bool True if we have just submit a POST or GET request with the parameter provided (even if param is empty)</td> <td>1</td> </tr> <tr> <td>string|array Value found (string or array), or '' if check fails</td> <td>1</td> </tr> <tr> <td>int Value converted into integer</td> <td>1</td> </tr> <tr> <td>float Value converted into float</td> <td>1</td> </tr> <tr> <td>bool True if load is a success, False if it fails</td> <td>1</td> </tr> <tr> <td>string Full filesystem path (if path=0) or '' if file not found, Full url path (if mode=1)</td> <td>1</td> </tr> <tr> <td>array<string,mixed> Hash for retrieved values (key=name)</td> <td>1</td> </tr> <tr> <td>T Clone object</td> <td>1</td> </tr> <tr> <td>int New size after optimizing</td> <td>1</td> </tr> <tr> <td>string Cleaned string</td> <td>1</td> </tr> <tr> <td>string Cleaned string</td> <td>1</td> </tr> <tr> <td>string Cleaned string</td> <td>1</td> </tr> <tr> <td>string Escaped string. Both ' and " are escaped into ' if they are escaped.</td> <td>1</td> </tr> <tr> <td>string Escaped string for JSON content.</td> <td>1</td> </tr> <tr> <td>string Escaped string for PHP content.</td> <td>1</td> </tr> <tr> <td>string Escaped string for XML content.</td> <td>1</td> </tr> <tr> <td>string String ready for HTML output (sanitized and escape)</td> <td>1</td> </tr> <tr> <td>string String ready for HTML output into a textarea</td> <td>1</td> </tr> <tr> <td>string Escaped string</td> <td>1</td> </tr> <tr> <td>string HTML and JavaScript code for the button and the dialog</td> <td>1</td> </tr> <tr> <td>string HTML component with button</td> <td>1</td> </tr> <tr> <td>string String to add class onto HTML element</td> <td>1</td> </tr> <tr> <td>string Formatted string</td> <td>1</td> </tr> <tr> <td>string A formatted string</td> <td>1</td> </tr> <tr> <td>string Formatted date or '' if time is null</td> <td>1</td> </tr> <tr> <td>array{}|array{seconds:int<0,59>,minutes:int<0,59>,hours:int<0,23>,mday:int<1,31>,wday:int<0,6>,mon:int<1,12>,year:int<0,9999>,yday:int<0,366>,0:int} Array of information</td> <td>1</td> </tr> <tr> <td>int|string Date as a timestamp, '' if error</td> <td>1</td> </tr> <tr> <td>int $date Timestamp</td> <td>1</td> </tr> <tr> <td>string Link</td> <td>1</td> </tr> <tr> <td>string HTML Link</td> <td>1</td> </tr> <tr> <td>string HTML Link</td> <td>1</td> </tr> <tr> <td>array<string,array{rowid:int,label:string,url:string,icon:string,active:int}> Array of Social Networks Dictionary</td> <td>1</td> </tr> <tr> <td>string HTML Link</td> <td>1</td> </tr> <tr> <td>string Formatted profID</td> <td>1</td> </tr> <tr> <td>string Formatted phone number</td> <td>1</td> </tr> <tr> <td>string Formatted IP, with country if GeoIP module is enabled</td> <td>1</td> </tr> <tr> <td>string Ip of remote user.</td> <td>1</td> </tr> <tr> <td>boolean True if user is using HTTPS</td> <td>1</td> </tr> <tr> <td>string Country code ('us', 'fr', ...)</td> <td>1</td> </tr> <tr> <td>string Country code (fr, es, it, us, ...)</td> <td>1</td> </tr> <tr> <td>string|void Nothing if noprint is 0, formatted address if noprint is 1</td> <td>1</td> </tr> <tr> <td>boolean true if email syntax is OK, false if KO or empty string</td> <td>1</td> </tr> <tr> <td>int -1 if error (function not available), 0=Not valid, 1=Valid</td> <td>1</td> </tr> <tr> <td>boolean true if phone syntax is OK, false if KO or empty string</td> <td>1</td> </tr> <tr> <td>string Return first chars.</td> <td>1</td> </tr> <tr> <td>int Length of string</td> <td>1</td> </tr> <tr> <td>string substring</td> <td>1</td> </tr> <tr> <td>string Truncated string. WARNING: length is never higher than $size if $nodot is set, but can be 3 chars higher otherwise.</td> <td>1</td> </tr> <tr> <td>string Pïcto for the key</td> <td>1</td> </tr> <tr> <td>string Return img tag</td> <td>1</td> </tr> <tr> <td>string Return img tag</td> <td>1</td> </tr> <tr> <td>string Return an img tag</td> <td>1</td> </tr> <tr> <td>string Retourne tag img</td> <td>1</td> </tr> <tr> <td>string Retourne tag img</td> <td>1</td> </tr> <tr> <td>string Return tag img</td> <td>1</td> </tr> <tr> <td>string String with info text</td> <td>1</td> </tr> <tr> <td>string String with formatted amounts ('19,6' or '19,6%' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')</td> <td>1</td> </tr> <tr> <td>string String with formatted amount</td> <td>1</td> </tr> <tr> <td>string Amount with universal numeric format (Example: '99.99999'), or error message.</td> <td>1</td> </tr> <tr> <td>string String to show dimensions</td> <td>1</td> </tr> <tr> <td>int<0,0>|string 0 if not found, localtax rate if found</td> <td>1</td> </tr> <tr> <td>boolean True if LocalTax have multiple values, False if not</td> <td>1</td> </tr> <tr> <td>string Values of localtax (Can be '20', '-19:-15:-9') or 'Error'</td> <td>1</td> </tr> <tr> <td>array{}|array{rowid:int,code:string,rate:float,localtax1:float,localtax1_type:string,localtax2:float,localtax2_type:string,npr:float,accountancy_code_sell:string,accountancy_code_buy:string} array('rowid'=> , 'code'=> ...)</td> <td>1</td> </tr> <tr> <td>array{}|array{0:string,1:float,2:string,3:string}|array{0:string,1:float,2:string,3:float,4:string,5:string} array(localtax_type1(1-6 or 0 if not found), rate localtax1, localtax_type2, rate localtax2, accountancycodecust, accountancycodesupp)</td> <td>1</td> </tr> <tr> <td>float|string Vat rate to use with format 5.0 or '5.0 (XXX)'</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Vat rate if OK</td> <td>1</td> </tr> <tr> <td>float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it</td> <td>1</td> </tr> <tr> <td>float 0 or 1</td> <td>1</td> </tr> <tr> <td>int localtax, -1 if it can not be determined</td> <td>1</td> </tr> <tr> <td>string HTML string</td> <td>1</td> </tr> <tr> <td>string Dir to use ending. Example '' or '1/' or '1/2/'</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 = already exists, > 0 if OK</td> <td>1</td> </tr> <tr> <td>string Chaine avec picto obligatoire</td> <td>1</td> </tr> <tr> <td>string String cleaned</td> <td>1</td> </tr> <tr> <td>string Output text</td> <td>1</td> </tr> <tr> <td>string HTML sanitized</td> <td>1</td> </tr> <tr> <td>string $ret Encoded string</td> <td>1</td> </tr> <tr> <td>int|string 0 if bad iso, 1 if good iso, Or the clean string if $clean is 1</td> <td>1</td> </tr> <tr> <td>int Number of lines</td> <td>1</td> </tr> <tr> <td>int Number of lines</td> <td>1</td> </tr> <tr> <td>boolean true/false</td> <td>1</td> </tr> <tr> <td>string Text 1 + new line + Text2</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of substitutions</td> <td>1</td> </tr> <tr> <td>string Output string after substitutions</td> <td>1</td> </tr> <tr> <td>string String</td> <td>1</td> </tr> <tr> <td>string Firstname + lastname or Lastname + firstname</td> <td>1</td> </tr> <tr> <td>string Return html output</td> <td>1</td> </tr> <tr> <td>string Return html output</td> <td>1</td> </tr> <tr> <td>array<string|int,mixed> Return the sorted array (the source array is not modified !)</td> <td>1</td> </tr> <tr> <td>boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special non utf8 char or Binary)</td> <td>1</td> </tr> <tr> <td>boolean True if string is valid UTF8 string, false if corrupted</td> <td>1</td> </tr> <tr> <td>boolean True if string is ASCII, False if not (byte value > 0x7F)</td> <td>1</td> </tr> <tr> <td>string Encoded string (UTF-8, ISO-8859-1)</td> <td>1</td> </tr> <tr> <td>int<-1,max>|string ID of code if OK, 0 if key empty, -1 if KO</td> <td>1</td> </tr> <tr> <td>boolean|string True or False, text if bad usage.</td> <td>1</td> </tr> <tr> <td>boolean True or False. Note: It returns also True if $strToEvaluate is ''. False if error</td> <td>1</td> </tr> <tr> <td>void|string Nothing or return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)).</td> <td>1</td> </tr> <tr> <td>boolean Return true of variable is not empty</td> <td>1</td> </tr> <tr> <td>string HTML img string with flag.</td> <td>1</td> </tr> <tr> <td>?string Value of locale like 'en_US', 'fr_FR', ... or null if not found</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of data exploded</td> <td>1</td> </tr> <tr> <td>string $res The statement to append to the SQL query</td> <td>1</td> </tr> <tr> <td>string New file name (full or relative path, including the thumbs/). May be the original path if no thumb can exists.</td> <td>1</td> </tr> <tr> <td>string|array{}|array{target:string,css:string,url:string,mime:string} Output string with href link or array with all components of link</td> <td>1</td> </tr> <tr> <td>int<0,1> 1 If allowed, 0 otherwise</td> <td>1</td> </tr> <tr> <td>string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)</td> <td>1</td> </tr> <tr> <td>string The value of field $field. This also set $dictvalues cache.</td> <td>1</td> </tr> <tr> <td>int<-1,1> -1 : Error with argument passed |0 : color is dark | 1 : color is light</td> <td>1</td> </tr> <tr> <td>int<0,2> 0=Hide, 1=Show, 2=Show gray</td> <td>1</td> </tr> <tr> <td>int Value rounded.</td> <td>1</td> </tr> <tr> <td>string Html badge</td> <td>1</td> </tr> <tr> <td>string Html status string</td> <td>1</td> </tr> <tr> <td>string html button</td> <td>1</td> </tr> <tr> <td>string html of title separator</td> <td>1</td> </tr> <tr> <td>string html output</td> <td>1</td> </tr> <tr> <td>string html button</td> <td>1</td> </tr> <tr> <td>array{module:string,element:string,table_element:string,subelement:string,classpath:string,classfile:string,classname:string,dir_output:string} array('module'=>, 'classpath'=>, 'element'=>, 'subelement'=>, 'classfile'=>, 'classname'=>, 'dir_output'=>)</td> <td>1</td> </tr> <tr> <td>int<-1,0>|object object || 0 || <0 if error</td> <td>1</td> </tr> <tr> <td>boolean True if yes, False if no</td> <td>1</td> </tr> <tr> <td>string The string to print for the button</td> <td>1</td> </tr> <tr> <td>mixed The decoded object.</td> <td>1</td> </tr> <tr> <td>string Return forged SQL string</td> <td>1</td> </tr> <tr> <td>string[] Array of AND</td> <td>1</td> </tr> <tr> <td>boolean True if valid, False if not valid ($error returned parameter is filled with the reason in such a case)</td> <td>1</td> </tr> <tr> <td>string Forged criteria. Example: "" or "()"</td> <td>1</td> </tr> <tr> <td>string Forged criteria. Example: "t.field LIKE 'abc%'"</td> <td>1</td> </tr> <tr> <td>string String with timeline icon</td> <td>1</td> </tr> <tr> <td>array<int,stdClass> Array of documents in index table</td> <td>1</td> </tr> <tr> <td>string|void Return html part or void if noprint is 1</td> <td>1</td> </tr> <tr> <td>int|string Date as a timestamp, '' or false if error</td> <td>1</td> </tr> <tr> <td>string Portion of URL with query parameters for the specified date</td> <td>1</td> </tr> <tr> <td>void This function terminates script execution after outputting the error page.</td> <td>1</td> </tr> <tr> <td>int Nb of tasks shown</td> <td>1</td> </tr> <tr> <td>int 1 if there is</td> <td>1</td> </tr> <tr> <td>int -1 if ko 0 if ok</td> <td>1</td> </tr> <tr> <td>array head</td> <td>1</td> </tr> <tr> <td>array Tabs for the salaries section</td> <td>1</td> </tr> <tr> <td>array Tabs for the Bankline section</td> <td>1</td> </tr> <tr> <td>array Array of valid payment method</td> <td>1</td> </tr> <tr> <td>string Url string</td> <td>1</td> </tr> <tr> <td>array Array of tabs to show</td> <td>1</td> </tr> <tr> <td>integer NB of lines shown into array</td> <td>1</td> </tr> <tr> <td>integer NB of lines shown into array</td> <td>1</td> </tr> <tr> <td>string Unit string</td> <td>1</td> </tr> <tr> <td>string|-1 Unit string if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int Squared unit key (-6,-4,-2,0,98,99...)</td> <td>1</td> </tr> <tr> <td>int Cubed unit key (-9,-6,-3,0,88,89...)</td> <td>1</td> </tr> <tr> <td>User Return user object identified by login/pass/entity into authentication array</td> <td>1</td> </tr> <tr> <td>boolean True of False</td> <td>1</td> </tr> <tr> <td>string String without zero on the right</td> <td>1</td> </tr> <tr> <td>array Dates of periodicity by default</td> <td>1</td> </tr> <tr> <td>array Period of fiscal year : [date_start, date_end]</td> <td>1</td> </tr> <tr> <td>array head array with tabs</td> <td>1</td> </tr> <tr> <td>array Array of tabs</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing is done, Nb of bytes written if OK</td> <td>1</td> </tr> <tr> <td>int|mixed Return integer <0 if KO, data if OK, null if not found into cache or no caching feature enabled</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Memoy address of shared memory for key</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Caching not available, Nb of bytes written if OK</td> <td>1</td> </tr> <tr> <td>int|null Return integer <0 if KO, data if OK, null if no cache enabled or not found</td> <td>1</td> </tr> <tr> <td>array|int Array with details of VATs (per third parties), -1 if no accountancy module, -2 if not yet developed, -3 if error</td> <td>1</td> </tr> <tr> <td>array|int Array with details of VATs (per rate), -1 if no accountancy module, -2 if not yet developed, -3 if error</td> <td>1</td> </tr> <tr> <td>array Array('width'=>w,'height'=>h,'unit'=>u);</td> <td>1</td> </tr> <tr> <td>TCPDF|TCPDI PDF object</td> <td>1</td> </tr> <tr> <td>string Name of font to use</td> <td>1</td> </tr> <tr> <td>int Size of font to use</td> <td>1</td> </tr> <tr> <td>int Height</td> <td>1</td> </tr> <tr> <td>string String with name of thirdparty (+ alias if requested)</td> <td>1</td> </tr> <tr> <td>string|int String with full address or -1 if KO</td> <td>1</td> </tr> <tr> <td>array Array of substitutions</td> <td>1</td> </tr> <tr> <td>float The Y PDF position</td> <td>1</td> </tr> <tr> <td>int Return height of bottom margin including footer text</td> <td>1</td> </tr> <tr> <td>float The Y PDF position</td> <td>1</td> </tr> <tr> <td>string Value for unit cell</td> <td>1</td> </tr> <tr> <td>string Return total of line excl tax</td> <td>1</td> </tr> <tr> <td>string Return total of line incl tax</td> <td>1</td> </tr> <tr> <td>array Linked objects</td> <td>1</td> </tr> <tr> <td>array Height and width to use to output image (in pdf user unit, so mm)</td> <td>1</td> </tr> <tr> <td>float|string Return total of line excl tax</td> <td>1</td> </tr> <tr> <td>int 0=Hide, 1=Show, 2=Show gray</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string String without separators</td> <td>1</td> </tr> <tr> <td>string|false Login if OK, false otherwise</td> <td>1</td> </tr> <tr> <td>Object object.login & object.password</td> <td>1</td> </tr> <tr> <td>string|false Login if OK, false if KO</td> <td>1</td> </tr> <tr> <td>bool true if Ok false else</td> <td>1</td> </tr> <tr> <td>array Returns an array with list of tab entries</td> <td>1</td> </tr> <tr> <td>int Amount</td> <td>1</td> </tr> <tr> <td>string Url string</td> <td>1</td> </tr> <tr> <td>array Array of head</td> <td>1</td> </tr> <tr> <td>bool|DateTime</td> <td>1</td> </tr> <tr> <td>array<int, mixed></td> <td>1</td> </tr> <tr> <td>\Sabre\Event\Promise</td> <td>1</td> </tr> <tr> <td>If the optional split_length parameter is specified, the returned array will be broken down into chunks with each being split_length in length, otherwise each chunk will be one character in length. FALSE is returned if split_length is less than 1. If the split_length length exceeds the length of string , the entire string is returned as the first (and only) array element.</td> <td>1</td> </tr> <tr> <td>string data deflated</td> <td>1</td> </tr> <tr> <td>string '' or value of entity into table</td> <td>1</td> </tr> <tr> <td>bool true if the rss feed is inside the box/widget list, otherwise false</td> <td>1</td> </tr> <tr> <td>array<array<int,string>> Array of tabs</td> <td>1</td> </tr> <tr> <td>string New color</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same time slot</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same percentage</td> <td>1</td> </tr> <tr> <td>array Array of head</td> <td>1</td> </tr> <tr> <td>array Array of head</td> <td>1</td> </tr> <tr> <td>bool false if Ko true else</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if Ko or Id of object</td> <td>1</td> </tr> <tr> <td>boolean True = There is some dispatching to do, False = All dispatching is done (may be we receive more) or is not required</td> <td>1</td> </tr> <tr> <td>string Array of id of orders with all dispatching already done or not required</td> <td>1</td> </tr> <tr> <td>array|integer[]</td> <td>1</td> </tr> <tr> <td>string Table name of field</td> <td>1</td> </tr> <tr> <td>boolean True to tell to make a group by sub-total</td> <td>1</td> </tr> <tr> <td>array Element array sorted</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return compare result</td> <td>1</td> </tr> <tr> <td>string (ul list in html )</td> <td>1</td> </tr> <tr> <td>array<int,stdClass></td> <td>1</td> </tr> <tr> <td>stdClass[]</td> <td>1</td> </tr> <tr> <td>string string result</td> <td>1</td> </tr> <tr> <td>array<array<int,string>> Array of tabs</td> <td>1</td> </tr> <tr> <td>array<object>|int Object by groiup, -1 if error (empty or bad argument)</td> <td>1</td> </tr> <tr> <td>string No return (a redirect is done) if OK, or Error message if KO</td> <td>1</td> </tr> <tr> <td>array Array</td> <td>1</td> </tr> <tr> <td>array The NVP Collection object of the GetExpressCheckoutDetails Call Response.</td> <td>1</td> </tr> <tr> <td>array The NVP Collection object of the DoDirectPayment Call Response.</td> <td>1</td> </tr> <tr> <td>array returns an associative array containing the response from the server.</td> <td>1</td> </tr> <tr> <td>array nvpArray = Associative Array</td> <td>1</td> </tr> <tr> <td>array Array of errors</td> <td>1</td> </tr> <tr> <td>array|false Array of parts of the message|false if error</td> <td>1</td> </tr> <tr> <td>object|boolean Definition of message|false in case of error</td> <td>1</td> </tr> <tr> <td>array<array{type:string,filename:string,pos:int}> type, filename, pos</td> <td>1</td> </tr> <tr> <td>mixed data</td> <td>1</td> </tr> <tr> <td>string|-1 Return the path to the saved file, or -1 if error</td> <td>1</td> </tr> <tr> <td>string Decoded message</td> <td>1</td> </tr> <tr> <td>Luracast\Restler\AutoLoader</td> <td>1</td> </tr> <tr> <td>bool True if login ok, false if not</td> <td>1</td> </tr> <tr> <td>array Array of margin info (buying price, marge rate, marque rate)</td> <td>1</td> </tr> <tr> <td>string String formatted</td> <td>1</td> </tr> <tr> <td>int 1 if OK, -1 if ERROR</td> <td>1</td> </tr> <tr> <td>int Int <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Int <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>boolean True of false</td> <td>1</td> </tr> <tr> <td>boolean True of false</td> <td>1</td> </tr> <tr> <td>string Formatted string</td> <td>1</td> </tr> <tr> <td>array{name:string,email:string}</td> <td>1</td> </tr> <tr> <td>bool True if license was updated</td> <td>1</td> </tr> <tr> <td>string|null Field name</td> <td>1</td> </tr> <tr> <td>string Formatted size</td> <td>1</td> </tr> <tr> <td>int <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>string[] Array of output</td> <td>1</td> </tr> <tr> <td>void The entry parameter $substitutionarray is modified</td> <td>1</td> </tr> <tr> <td>string Label translated in UTF8 (but without entities)</td> <td>1</td> </tr> <tr> <td>GeoIP</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>string Free reference for expedition</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si erreur, id expedition creee si ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, line_id if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>string Return select zone</td> <td>1</td> </tr> <tr> <td>string Url lien</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, number of emails added if ok</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if deletion done but failed to delete files, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Nb of recipients or -1 if KO</td> <td>1</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Next free value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if deletion done but failed to delete files, <0 if KO</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already open, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, line id >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of shipment objects</td> <td>1</td> </tr> <tr> <td>int ID of shipment created</td> <td>1</td> </tr> <tr> <td>mixed Helper string</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of record (>0) if OK</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int|array -1 if KO, array of ExpeditionLineBatch if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int ID of myobject</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, ID of created object if OK</td> <td>1</td> </tr> <tr> <td>array Array of warehouse objects</td> <td>1</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>1</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>1</td> </tr> <tr> <td>int ID of Currency</td> <td>1</td> </tr> <tr> <td>Object The updated Currency</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>bool false if KO, true if OK</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK, 2 if label found and OK</td> <td>1</td> </tr> <tr> <td>int 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>array [0] => id currency</td> <td>1</td> </tr> <tr> <td>float|false amount converted or false if conversion fails</td> <td>1</td> </tr> <tr> <td>float|bool Rate of currency or false if error</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 0 if nothing, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK, if mode = "cron" OK is 0</td> <td>1</td> </tr> <tr> <td>boolean True if exists, false if not exists</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of line's rowid or <0 if error</td> <td>1</td> </tr> <tr> <td>array|int Array of contracts id or <0 if error</td> <td>1</td> </tr> <tr> <td>array Liste des id contacts prestation</td> <td>1</td> </tr> <tr> <td>array|int Array o tickets or <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 = no doc generated, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int New id of clone</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>array<array<int>> array of diff</td> <td>1</td> </tr> <tr> <td>array Array of contract objects</td> <td>1</td> </tr> <tr> <td>int ID of contrat</td> <td>1</td> </tr> <tr> <td>string|false Return a well-formed XML string based on SimpleXML element, false or 0 if error</td> <td>1</td> </tr> <tr> <td>string|false Return a well-formed XML string based on SimpleXML element, false or 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Number</td> <td>1</td> </tr> <tr> <td>string free reference for contract</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found or if two records found for same ref, Id of contract if OK</td> <td>1</td> </tr> <tr> <td>array|int Return array of contract lines</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of contract if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>Object[]</td> <td>1</td> </tr> <tr> <td>string Label if status</td> <td>1</td> </tr> <tr> <td>int Number of votes</td> <td>1</td> </tr> <tr> <td>string Holiday free reference</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK, 2 if no result</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 1 if OK, 2 if no result</td> <td>1</td> </tr> <tr> <td>boolean False = New range overlap an existing holiday, True = no overlapping (is never on holiday during checked period).</td> <td>1</td> </tr> <tr> <td>array array('morning'=> ,'afternoon'=> ), Boolean is true if user is available for day timestamp.</td> <td>1</td> </tr> <tr> <td>string Show select of status</td> <td>1</td> </tr> <tr> <td>boolean ok or ko</td> <td>1</td> </tr> <tr> <td>string|int<min,0> Value of parameter. Example: 'YYYYMMDDHHMMSS' or < 0 if error</td> <td>1</td> </tr> <tr> <td>int 0=Nothing done, 1=OK, -1=KO</td> <td>1</td> </tr> <tr> <td>float|null Balance of annual leave if OK, null if KO.</td> <td>1</td> </tr> <tr> <td>array|string|int Return an array</td> <td>1</td> </tr> <tr> <td>array|int Array of user ids or -1 if error</td> <td>1</td> </tr> <tr> <td>int Id of record added, 0 if nothing done, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int -1 si erreur, 1 si OK et 2 si pas de résultat</td> <td>1</td> </tr> <tr> <td>array Return array with list of types</td> <td>1</td> </tr> <tr> <td>array Array of nb each month</td> <td>1</td> </tr> <tr> <td>array Array of nb each year</td> <td>1</td> </tr> <tr> <td>array Array with nb, total amount, average for each year</td> <td>1</td> </tr> <tr> <td>array<int|string,array{label:string,members_draft:int,members_pending:int,members_uptodate:int,members_expired:int,members_excluded:int,members_resiliated:int,all?:float|int,total_adhtype:float|int}> Array with total of draft, pending, uptodate, expired, resiliated for each member type</td> <td>1</td> </tr> <tr> <td>array<string,array{label:string,members_draft:int,members_pending:0,members_uptodate:int,members_expired:int,members_excluded:int,members_resiliated:int,all?:float|int,total_adhtag:float|int}> Array with total of draft, pending, uptodate, expired, resiliated for each member tag</td> <td>1</td> </tr> <tr> <td>string Value of input text string with substitutions done</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=nothing to do, >0 if OK</td> <td>1</td> </tr> <tr> <td>string|int Clear password if change ok, 0 if no change, <0 if error</td> <td>1</td> </tr> <tr> <td>int 1=OK, -1=KO</td> <td>1</td> </tr> <tr> <td>int 1=OK, -1=KO</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if not found, <0 if KO</td> <td>1</td> </tr> <tr> <td>int rowid of record added, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Translated name of civility (translated with transnoentitiesnoconv)</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>boolean True if late, False if not late</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, 0 if not found, < 0 if KO</td> <td>1</td> </tr> <tr> <td>array List of types of members</td> <td>1</td> </tr> <tr> <td>array Array of membership type</td> <td>1</td> </tr> <tr> <td>mixed Array of members or -1 on error</td> <td>1</td> </tr> <tr> <td>array Array of member objects</td> <td>1</td> </tr> <tr> <td>int ID of member</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>array Array of member type objects</td> <td>1</td> </tr> <tr> <td>int ID of member type</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id subscription created if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, =0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>resource resource defined if OK, null if KO</td> <td>1</td> </tr> <tr> <td>string SQL request line converted</td> <td>1</td> </tr> <tr> <td>int Number of lines</td> <td>1</td> </tr> <tr> <td>string String escaped</td> <td>1</td> </tr> <tr> <td>resource Resultset of answer</td> <td>1</td> </tr> <tr> <td>resource Database access handler</td> <td>1</td> </tr> <tr> <td>int Nb of lines</td> <td>1</td> </tr> <tr> <td>resource Resource</td> <td>1</td> </tr> <tr> <td>Object Object result line or false if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>boolean true if OK, false if KO</td> <td>1</td> </tr> <tr> <td>array Array of collected data</td> <td>1</td> </tr> <tr> <td>array<array{time:int}> A list of messages ordered by time.</td> <td>1</td> </tr> <tr> <td>array Array of details to render the widget.</td> <td>1</td> </tr> <tr> <td>string The widget name.</td> <td>1</td> </tr> <tr> <td>string Error name.</td> <td>1</td> </tr> <tr> <td>string Name</td> <td>1</td> </tr> <tr> <td>array Array of collected data</td> <td>1</td> </tr> <tr> <td>string HTML string</td> <td>1</td> </tr> <tr> <td>string Name</td> <td>1</td> </tr> <tr> <td>array Array</td> <td>1</td> </tr> <tr> <td>array{nb_of_hooks:int,hooks:array<string,array{contexts:string}>} Array of collected data</td> <td>1</td> </tr> <tr> <td>array<string,array{icon?:string,widget?:string,map:string,default:int|string}> Array</td> <td>1</td> </tr> <tr> <td>array Array of collected data</td> <td>1</td> </tr> <tr> <td>array Lines of logs</td> <td>1</td> </tr> <tr> <td>array Array of log level</td> <td>1</td> </tr> <tr> <td>array Array of collected data</td> <td>1</td> </tr> <tr> <td>array Array of config</td> <td>1</td> </tr> <tr> <td>array Array</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array Attributes info table</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO or if two records found for same ref or idprof, 0 if not found.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>string Translated name of civility</td> <td>1</td> </tr> <tr> <td>string Label translated</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Nb of roles found if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of contact roles or -1</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>double mensuality</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, Date > 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of id</td> <td>1</td> </tr> <tr> <td>int Return integer <0 error , >=0 no error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, >0 if ok</td> <td>1</td> </tr> <tr> <td>integer|null</td> <td>1</td> </tr> <tr> <td>string Libelle du statut</td> <td>1</td> </tr> <tr> <td>-1|1 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>-1|ProductCombination2ValuePair[] -1 if KO, array of ProductCombination2ValuePair if OK</td> <td>1</td> </tr> <tr> <td>-1|1 -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO, Id of new variant if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <1 KO, >1 OK</td> <td>1</td> </tr> <tr> <td>ProductAttribute[]</td> <td>1</td> </tr> <tr> <td>int<min,-1>|1 <0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int >=0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,max> -1 if K0, nb of variants using this attribute</td> <td>1</td> </tr> <tr> <td>-1|0|1 Return -1 if KO, 0 if not used, 1 if used</td> <td>1</td> </tr> <tr> <td>int Value of position in table of attributes</td> <td>1</td> </tr> <tr> <td>int Max value of position in table of attributes</td> <td>1</td> </tr> <tr> <td>-1|1 -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>-1|1 -1 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if product ID is not ID of a variant product (so parent not found), >0 if OK (ID of parent)</td> <td>1</td> </tr> <tr> <td>int|ProductCombination[] Return integer <0 KO</td> <td>1</td> </tr> <tr> <td>int Nb of record</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>false|ProductCombination False if not found</td> <td>1</td> </tr> <tr> <td>array<object{id:int,ref:string,label:string,values:ProductAttributeValue[]}> Array of attributes</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 KO, >0 OK</td> <td>1</td> </tr> <tr> <td>int >0 OK <0 KO</td> <td>1</td> </tr> <tr> <td>string combination label</td> <td>1</td> </tr> <tr> <td>mixed self[] | -1 on KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO, >0 OK</td> <td>1</td> </tr> <tr> <td>ProductCombinationLevel</td> <td>1</td> </tr> <tr> <td>ProductAttributeValue[]|stdClass[] Array of object</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO, =0 if No, =1 if Yes</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of record if OK and found</td> <td>1</td> </tr> <tr> <td>int if KO, Id of line if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, Id of record if OK and found</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO (-2 = duplicate), >0 if OK</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>array|int Array of accounting accounts suggested or < 0 if technical error.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Number of lines if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Result</td> <td>1</td> </tr> <tr> <td>int Result</td> <td>1</td> </tr> <tr> <td>int<1, max>|-1 Return next movement number or -1 if error</td> <td>1</td> </tr> <tr> <td>int Result</td> <td>1</td> </tr> <tr> <td>int int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string|int String with HTML select or -1 if KO</td> <td>1</td> </tr> <tr> <td>array|int Array with root account information (max 2 upper level), <0 if KO</td> <td>1</td> </tr> <tr> <td>string|int Account desc or -1 if KO</td> <td>1</td> </tr> <tr> <td>string|null SQL filter or null if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, == 0 if No, == 1 if Yes</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, == 0 if No, == 1 if date is valid for a transfer</td> <td>1</td> </tr> <tr> <td>array<array{id:int,label:string,date_start:string,date_end:string,status:int}>|int Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...]</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...]</td> <td>1</td> </tr> <tr> <td>int int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Accounting result</td> <td>1</td> </tr> <tr> <td>int int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>integer Return integer <0 if KO, >= 0 if OK</td> <td>1</td> </tr> <tr> <td>array|integer Result in table (array), -1 if KO</td> <td>1</td> </tr> <tr> <td>array<array{code:string,label:string,formula:string,position:string,category_type:string,sens:string,bc:string}>|int Array of groups or -1 if error</td> <td>1</td> </tr> <tr> <td>array|int Array of accounting accounts or -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of record if OK and found</td> <td>1</td> </tr> <tr> <td>string Label of type</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array Accounting account infos</td> <td>1</td> </tr> <tr> <td>int 1 OK, <0 error</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if error otherwise all linked lines by block</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if error otherwise all fk_doc by doc_type</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if error otherwise all all bank ids from list of document ids of a type</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if error otherwise all linked document ids by group and type [ [ 'doc_type' => [ doc_id, ... ], ... ], ... ]</td> <td>1</td> </tr> <tr> <td>array List of element ids grouped by link or element in common</td> <td>1</td> </tr> <tr> <td>string Format code</td> <td>1</td> </tr> <tr> <td>string MIME type.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 OK. The property ->generatedfile is also filled.</td> <td>1</td> </tr> <tr> <td>string String encoded in Windows-1251 charset</td> <td>1</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of updated BOM-Line if OK</td> <td>1</td> </tr> <tr> <td>string BOM free reference</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, >0 if OK, or printable error result from hook</td> <td>1</td> </tr> <tr> <td>int ID of bom</td> <td>1</td> </tr> <tr> <td>object|bool</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Version of trigger file</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if no trigger ran: 0 || if OK: >0</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>1</td> </tr> <tr> <td>int if KO: <0, if no trigger ran: 0, if OK: >0</td> <td>1</td> </tr> <tr> <td>bool True if event text is a coded structured string</td> <td>1</td> </tr> <tr> <td>bool True if the amounts are equal (rounded on total amount)</td> <td>1</td> </tr> <tr> <td>array Array of events managed by notification module</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>1</td> </tr> <tr> <td>float Remain of amount to pay</td> <td>1</td> </tr> <tr> <td>float Return integer <0 and set ->error if KO, Sum of deposits amount otherwise</td> <td>1</td> </tr> <tr> <td>float Return integer <0 and set ->error if KO, Sum of credit notes and deposits amount otherwise</td> <td>1</td> </tr> <tr> <td>float Return integer <0 if KO, Sum of credit notes and deposits amount otherwise</td> <td>1</td> </tr> <tr> <td>array Array of credit note ids</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si KO, 0 if no invoice replaces it, id of invoice otherwise</td> <td>1</td> </tr> <tr> <td>array<array{amount:int|float,date:int,num:string,ref:string,ref_ext?:string,fk_bank_line?:int}> Array with list of payments</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if no, >0 if yes</td> <td>1</td> </tr> <tr> <td>string Label of type of invoice</td> <td>1</td> </tr> <tr> <td>string|int Label of invoice subtype or -1 if error</td> <td>1</td> </tr> <tr> <td>array Array of subtypes</td> <td>1</td> </tr> <tr> <td>int|string Date limit of payment if OK, <0 or string if KO</td> <td>1</td> </tr> <tr> <td>string String for EPC QR Code</td> <td>1</td> </tr> <tr> <td>string String for ZATCA QR Code</td> <td>1</td> </tr> <tr> <td>string String for Switzerland QR Code if QR-Bill</td> <td>1</td> </tr> <tr> <td>array Array with info</td> <td>1</td> </tr> <tr> <td>string HTML edit field</td> <td>1</td> </tr> <tr> <td>string HTML edit field</td> <td>1</td> </tr> <tr> <td>string HTML code for the edit of alternative language</td> <td>1</td> </tr> <tr> <td>string HTML edit in place</td> <td>1</td> </tr> <tr> <td>string Code html du tooltip (texte+picto)</td> <td>1</td> </tr> <tr> <td>string HTML code of text, picto, tooltip</td> <td>1</td> </tr> <tr> <td>string|void Select list</td> <td>1</td> </tr> <tr> <td>string HTML string with select</td> <td>1</td> </tr> <tr> <td>string HTML string with select and input</td> <td>1</td> </tr> <tr> <td>string HTML string with select box for thirdparty.</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, HTML with select string if OK.</td> <td>1</td> </tr> <tr> <td>array<int,array{key:int,value:string,label:string,labelhtml:string}>|string HTML string with</td> <td>1</td> </tr> <tr> <td>int|string|array<int,array{key:int,value:string,label:string,labelhtml:string}> Return integer <0 if KO, HTML with select string if OK.</td> <td>1</td> </tr> <tr> <td>int Return number of qualifed lines in list</td> <td>1</td> </tr> <tr> <td>string|array<int,string|array{id:int,label:string,labelhtml:string,color:string,picto:string}> HTML select string</td> <td>1</td> </tr> <tr> <td>array|string Array of keys for json</td> <td>1</td> </tr> <tr> <td>string String for the HTML select component</td> <td>1</td> </tr> <tr> <td>string|void String for the HTML select component</td> <td>1</td> </tr> <tr> <td>string Code of HTML select to chose tax or not</td> <td>1</td> </tr> <tr> <td>string HTML select</td> <td>1</td> </tr> <tr> <td>int|string If noouput=0: Return integer <0 if error, Num of bank account found if OK (0, 1, 2, ...), If nooutput=1: Return a HTML select string.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, Num of establishment found if OK (0, 1, 2, ...)</td> <td>1</td> </tr> <tr> <td>string|array<int,string>|array<int,array{id:int,fulllabel:string,color:string,picto:string}>|array<int,array{rowid:int,id:int,fk_parent:int,label:string,description:string,color:string,position:string,visible:int,ref_ext:string,picto:string,fullpath:string,fulllabel:string}> String list or Array of categories</td> <td>1</td> </tr> <tr> <td>string HTML ajax code if a confirm ajax popup is required, Pure HTML code if it's an html form</td> <td>1</td> </tr> <tr> <td>string Return html content</td> <td>1</td> </tr> <tr> <td>string HTML output or ''</td> <td>1</td> </tr> <tr> <td>string HTML output or ''</td> <td>1</td> </tr> <tr> <td>string HTML output or ''</td> <td>1</td> </tr> <tr> <td>int Nb of loaded lines, 0 if already loaded, <0 if KO</td> <td>1</td> </tr> <tr> <td>string '' or HTML component string if nooutput is 1</td> <td>1</td> </tr> <tr> <td>string Html for selectDate</td> <td>1</td> </tr> <tr> <td>string Html for selectDate</td> <td>1</td> </tr> <tr> <td>string HTML component</td> <td>1</td> </tr> <tr> <td>array|string Array of keys for json or HTML component</td> <td>1</td> </tr> <tr> <td>array|string Array of keys for json or HTML string component</td> <td>1</td> </tr> <tr> <td>string Return HTML string</td> <td>1</td> </tr> <tr> <td>string HTML select string.</td> <td>1</td> </tr> <tr> <td>string HTML select string</td> <td>1</td> </tr> <tr> <td>string HTML select string</td> <td>1</td> </tr> <tr> <td>string HTML multiselect string</td> <td>1</td> </tr> <tr> <td>string HTML multiselect string</td> <td>1</td> </tr> <tr> <td>string String with categories</td> <td>1</td> </tr> <tr> <td>int Return Number of different types</td> <td>1</td> </tr> <tr> <td>string HTML block</td> <td>1</td> </tr> <tr> <td>string See option</td> <td>1</td> </tr> <tr> <td>string Portion HTML with ref + navigation buttons</td> <td>1</td> </tr> <tr> <td>string HTML code to output barcode</td> <td>1</td> </tr> <tr> <td>string HTML code to output photo</td> <td>1</td> </tr> <tr> <td>string HTML Componont to select a group</td> <td>1</td> </tr> <tr> <td>string HTML Select Invoice</td> <td>1</td> </tr> <tr> <td>int Nbr of project if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>string HTML component for advanced search</td> <td>1</td> </tr> <tr> <td>string Html code with the buttons</td> <td>1</td> </tr> <tr> <td>string String for the HTML select component</td> <td>1</td> </tr> <tr> <td>mixed Value for replacement property</td> <td>1</td> </tr> <tr> <td>array<string,string> Mapping of deprecated properties</td> <td>1</td> </tr> <tr> <td>array<string,string> Mapping of deprecated methods</td> <td>1</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> Array of diff</td> <td>1</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> Array of diff</td> <td>1</td> </tr> <tr> <td>array<array{0:string,1:int<0,2>}> array of diff</td> <td>1</td> </tr> <tr> <td>string String</td> <td>1</td> </tr> <tr> <td>string HTML string</td> <td>1</td> </tr> <tr> <td>int Delivery receipt</td> <td>1</td> </tr> <tr> <td>string Track id</td> <td>1</td> </tr> <tr> <td>string moreInHeader</td> <td>1</td> </tr> <tr> <td>string Errors to</td> <td>1</td> </tr> <tr> <td>mixed $_retVal Boolean indicating success or failure on connection</td> <td>1</td> </tr> <tr> <td>boolean|null $_retVal Boolean indicating success or failure of authentication</td> <td>1</td> </tr> <tr> <td>boolean|null Result</td> <td>1</td> </tr> <tr> <td>int $_strHost Host Name or IP of the Mail Server to use</td> <td>1</td> </tr> <tr> <td>string $_strHost Host Name or IP of the Mail Server to use</td> <td>1</td> </tr> <tr> <td>int Port Number of the Mail Server to use</td> <td>1</td> </tr> <tr> <td>string User Name for authentication on Mail Server</td> <td>1</td> </tr> <tr> <td>string User Password for authentication on Mail Server</td> <td>1</td> </tr> <tr> <td>string User token for OAUTH2</td> <td>1</td> </tr> <tr> <td>string $_smtpsCharSet Character set used for current message</td> <td>1</td> </tr> <tr> <td>string $_smtpsTransEncode Content-Transfer-Encoding</td> <td>1</td> </tr> <tr> <td>string Content-Transfer-Encoding</td> <td>1</td> </tr> <tr> <td>string Address from which mail will be sent</td> <td>1</td> </tr> <tr> <td>string Address from which mail will be the reply-to</td> <td>1</td> </tr> <tr> <td>string Msg-Id of email we reply to</td> <td>1</td> </tr> <tr> <td>string List of Msg-Id</td> <td>1</td> </tr> <tr> <td>array{org:string,real?:string,addr:string,user:string,host:string} An array of the various parts of an email address</td> <td>1</td> </tr> <tr> <td>array Returns an array of bares addresses</td> <td>1</td> </tr> <tr> <td>string|false Array of emaill address</td> <td>1</td> </tr> <tr> <td>string TO Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string CC Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string BCC Address[es] inwhich to send mail to</td> <td>1</td> </tr> <tr> <td>string Message Subject</td> <td>1</td> </tr> <tr> <td>string Complete message header</td> <td>1</td> </tr> <tr> <td>string Message Content</td> <td>1</td> </tr> <tr> <td>string|boolean</td> <td>1</td> </tr> <tr> <td>boolean MD5flag</td> <td>1</td> </tr> <tr> <td>array $_msgContent Message X-Header Content</td> <td>1</td> </tr> <tr> <td>string $_smtpsBoundary MIME message Boundary</td> <td>1</td> </tr> <tr> <td>boolean|null True or false</td> <td>1</td> </tr> <tr> <td>string $_errMsg Error Message</td> <td>1</td> </tr> <tr> <td>string A HTML filter box (Note: selected results can get with GETPOST("search_category_".$type."_list"))</td> <td>1</td> </tr> <tr> <td>string formatted url(), either as a link or base64-encoded</td> <td>1</td> </tr> <tr> <td>array|null lessphp cache structure</td> <td>1</td> </tr> <tr> <td>NULL|stdclass</td> <td>1</td> </tr> <tr> <td>boolean True if SMS sent, false otherwise</td> <td>1</td> </tr> <tr> <td>false|string false if KO, string of url if OK</td> <td>1</td> </tr> <tr> <td>boolean|void True if success, False if error</td> <td>1</td> </tr> <tr> <td>array Array of servers</td> <td>1</td> </tr> <tr> <td>string|false Endpoint, of false if error</td> <td>1</td> </tr> <tr> <td>string|false First endpoint OpenID server found. False if it failed to found.</td> <td>1</td> </tr> <tr> <td>string HTML component</td> <td>1</td> </tr> <tr> <td>string HTML select list</td> <td>1</td> </tr> <tr> <td>string Html combo list code</td> <td>1</td> </tr> <tr> <td>string Html combo list code</td> <td>1</td> </tr> <tr> <td>string Show color string</td> <td>1</td> </tr> <tr> <td>array array('selectboxlist'=>, 'boxactivated'=>, 'boxlista'=>, 'boxlistb'=>)</td> <td>1</td> </tr> <tr> <td>string See option</td> <td>1</td> </tr> <tr> <td>string[] Array with list of zones</td> <td>1</td> </tr> <tr> <td>array Array of boxes</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, > 0 if OK</td> <td>1</td> </tr> <tr> <td>string Coordinates</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, Id of code if OK (or $code if $mode is different from '', 'short_label' or 'code')</td> <td>1</td> </tr> <tr> <td>double</td> <td>1</td> </tr> <tr> <td>float|int Scale of unit</td> <td>1</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>1</td> </tr> <tr> <td>void|int 0 if OK; >0 if KO</td> <td>1</td> </tr> <tr> <td>string Return html content</td> <td>1</td> </tr> <tr> <td>int|string|array HTML string or array of option or <0 if KO</td> <td>1</td> </tr> <tr> <td>int|string Nbr of tasks if OK, <0 if KO. If nooutput=1: Return a HTML select string.</td> <td>1</td> </tr> <tr> <td>int|string The HTML select list of element or '' if nothing or -1 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|string The HTML select list of element or '' if nothing or -1 if KO</td> <td>1</td> </tr> <tr> <td>string HTML Select</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, >= 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, >= 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of types</td> <td>1</td> </tr> <tr> <td>array Array of types d'effectifs</td> <td>1</td> </tr> <tr> <td>string String with HTML select</td> <td>1</td> </tr> <tr> <td>string String with HTML select</td> <td>1</td> </tr> <tr> <td>int The selected third party ID</td> <td>1</td> </tr> <tr> <td>string|void Depending on $output param, return the HTML select list (recommended method) or nothing</td> <td>1</td> </tr> <tr> <td>string String with contacts roles</td> <td>1</td> </tr> <tr> <td>string HTML string with prof id</td> <td>1</td> </tr> <tr> <td>string HTML string</td> <td>1</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of code if OK</td> <td>1</td> </tr> <tr> <td>boolean Validity is ok or not</td> <td>1</td> </tr> <tr> <td>boolean|array Output</td> <td>1</td> </tr> <tr> <td>string|false Output or false if error</td> <td>1</td> </tr> <tr> <td>mixed Stack</td> <td>1</td> </tr> <tr> <td>mixed Stack</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO (-98 if error, -99 if virus), 0 if OK</td> <td>1</td> </tr> <tr> <td>string Full command line to run</td> <td>1</td> </tr> <tr> <td>int|string If nooutput = 0: Nbr of contract if OK, <0 if KO, If nooutput = 1: The HTML select string</td> <td>1</td> </tr> <tr> <td>string|void html string</td> <td>1</td> </tr> <tr> <td>string Language code used (en_US, en_AU, fr_FR, ...)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already loaded or loading not required, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 0, 1, 2...</td> <td>1</td> </tr> <tr> <td>string Translated string (translated with transnoentitiesnoconv)</td> <td>1</td> </tr> <tr> <td>string Translated string (encoded into HTML entities and UTF8)</td> <td>1</td> </tr> <tr> <td>string Translated string (encoded into UTF8)</td> <td>1</td> </tr> <tr> <td>string Translated string</td> <td>1</td> </tr> <tr> <td>string Converted string</td> <td>1</td> </tr> <tr> <td>array List of languages</td> <td>1</td> </tr> <tr> <td>boolean true if exists and readable</td> <td>1</td> </tr> <tr> <td>string Label translated in UTF8 (but without entities)</td> <td>1</td> </tr> <tr> <td>string|int Label in UTF8 (but without entities) or -1 if error</td> <td>1</td> </tr> <tr> <td>string Amount + Currency symbol encoded into UTF8</td> <td>1</td> </tr> <tr> <td>string Currency symbol encoded into UTF8</td> <td>1</td> </tr> <tr> <td>int Nb of loaded lines, 0 if already loaded, <0 if KO</td> <td>1</td> </tr> <tr> <td>array Array of translation keys lang_key => string_translation_loaded</td> <td>1</td> </tr> <tr> <td>int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>array array('result'=>...,'output'=>...,'error'=>...). result = 0 means OK.</td> <td>1</td> </tr> <tr> <td>int 0 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>string HTML select</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if nothing is done, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if nothing is done, 1 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <=0 if KO</td> <td>1</td> </tr> <tr> <td>array{}|array{label:array<string,string>,type:array<string,string>,size:array<string,string>,default:array<string,string>,computed:array<string,string>,unique:array<string,int>,required:array<string,int>,param:array<string,mixed>,perms:array<string,mixed[]>,list:array<string,int>|array<string,string>,pos:array<string,int>,totalizable:array<string,int>,help:array<string,string>,printable:array<string,int>,enabled:array<string,int>,langfile:array<string,string>,css:array<string,string>,csslist:array<string,string>,hidden:array<string,int>,mandatoryfieldsofotherentities?:array<string,string>,loaded?:int,count:int} Array of attributes keys+label for all extra fields. Note: count set as present to avoid static analysis notices</td> <td>1</td> </tr> <tr> <td>string HTML code with line for separator</td> <td>1</td> </tr> <tr> <td>int 1 if array_options set, 0 if no value, -1 if error (field required missing for example)</td> <td>1</td> </tr> <tr> <td>array|int array_options set or 0 if no value</td> <td>1</td> </tr> <tr> <td>boolean True is value is an empty value, not allowed for a mandatory field.</td> <td>1</td> </tr> <tr> <td>float value value after conversion</td> <td>1</td> </tr> <tr> <td>int Height chars</td> <td>1</td> </tr> <tr> <td>array Array of attributes keys+label for all extra fields.</td> <td>1</td> </tr> <tr> <td>string HTML select field</td> <td>1</td> </tr> <tr> <td>string Cleaned action type ('create', 'view', 'edit', 'list')</td> <td>1</td> </tr> <tr> <td>int 0=Canvas template file does not exist, 1=Canvas template file exists</td> <td>1</td> </tr> <tr> <td>boolean Return if canvas contains actions (old feature. now actions should be inside hooks)</td> <td>1</td> </tr> <tr> <td>mixed Return return code of doActions of canvas</td> <td>1</td> </tr> <tr> <td>string URL</td> <td>1</td> </tr> <tr> <td>array Array of objects</td> <td>1</td> </tr> <tr> <td>boolean True if OK, False if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK, nb of error if errors</td> <td>1</td> </tr> <tr> <td>array<string,string></td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK but not found, >0 if OK and exists</td> <td>1</td> </tr> <tr> <td>array<string,string> Data to show in tooltip</td> <td>1</td> </tr> <tr> <td>string String with errors</td> <td>1</td> </tr> <tr> <td>string Customer ref formatted</td> <td>1</td> </tr> <tr> <td>string Supplier ref formatted</td> <td>1</td> </tr> <tr> <td>string|-1 Returns the link, or an empty string if no link was found, or -1 if error.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already added or code not valid, >0 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >= 0 if OK</td> <td>1</td> </tr> <tr> <td>array<int,array{parentId:int,source:string,socid:int,id:int,nom:string,civility:string,lastname:string,firstname:string,email:string,login:string,photo:string,statuscontact:int,rowid:int,code:string,libelle:string,status:string,fk_c_type_contact:int}>|int<-1,-1> Array of contacts, -1 if error</td> <td>1</td> </tr> <tr> <td>int[]|null List of id for such contacts, or null if error</td> <td>1</td> </tr> <tr> <td>int<-1,1> >1 = OK, 0 = Not found or table_ref_field not defined, <0 = KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1>|false Return -1 or false if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-2,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-2,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int[] Array of id of contacts (if source=external or internal)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int[] Array with list of children lines id</td> <td>1</td> </tr> <tr> <td>int Value of rang in table of lines</td> <td>1</td> </tr> <tr> <td>int Rowid of the line</td> <td>1</td> </tr> <tr> <td>int Max value of rang in table of lines</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Special code</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not used, >0 if already used</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no predefined products, nb of lines with predefined products if found</td> <td>1</td> </tr> <tr> <td>float|null Total amount of discount, or null if $table_element_line is empty</td> <td>1</td> </tr> <tr> <td>array{weight:int|float,volume:int|float,ordered:int|float,toship:int|float} array('weight'=>...,'volume'=>...)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>string|string[] Default value (can be an array if the GETPOST return an array)</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 if array_options set, 0 if no value, -1 if error (field required missing for example)</td> <td>1</td> </tr> <tr> <td>int<-1,1> >0 if OK, 0 if not found, <0 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> -1=error, O=did nothing, 1=OK</td> <td>1</td> </tr> <tr> <td>int -1=error, O=did nothing, 1=OK</td> <td>1</td> </tr> <tr> <td>string Error message of validation ('' if no error)</td> <td>1</td> </tr> <tr> <td>bool return false if fail true on success, see $this->error for error message</td> <td>1</td> </tr> <tr> <td>string String with html content to show</td> <td>1</td> </tr> <tr> <td>string JavaScript code to manage dependency</td> <td>1</td> </tr> <tr> <td>null|int|stdClass Object of permission for the module</td> <td>1</td> </tr> <tr> <td>bool True if success, False if error</td> <td>1</td> </tr> <tr> <td>bool True if success, False if error</td> <td>1</td> </tr> <tr> <td>float|int<-1,-1> Return buy price if OK, integer <0 if KO</td> <td>1</td> </tr> <tr> <td>array{dir:string,file:string,originalfile:string,altfile:string,email:string,capture:string} Array of data to show photo</td> <td>1</td> </tr> <tr> <td>string Html code to show photo. Number of photos shown is saved in this->nbphoto</td> <td>1</td> </tr> <tr> <td>bool true if array</td> <td>1</td> </tr> <tr> <td>bool true if date</td> <td>1</td> </tr> <tr> <td>bool true if field of type duration</td> <td>1</td> </tr> <tr> <td>bool true if integer</td> <td>1</td> </tr> <tr> <td>bool true if float</td> <td>1</td> </tr> <tr> <td>bool true if type text</td> <td>1</td> </tr> <tr> <td>bool true if it can be null</td> <td>1</td> </tr> <tr> <td>bool true if forced to null</td> <td>1</td> </tr> <tr> <td>array<string,null|int|float|string> Array with all values of each property to update</td> <td>1</td> </tr> <tr> <td>string List of alias fields</td> <td>1</td> </tr> <tr> <td>int<-1,max> Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int<-4,1> Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, 0=Nothing done because object has child, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<0,max>|-1 Returns the number of comments if OK, -1 if error</td> <td>1</td> </tr> <tr> <td>int Array of category objects or < 0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if error, > 0 if ok</td> <td>1</td> </tr> <tr> <td>bool True if OK, False if KO</td> <td>1</td> </tr> <tr> <td>int Nb of triggers ran if no error, -Nb of triggers with errors otherwise.</td> <td>1</td> </tr> <tr> <td>array Array list of triggers</td> <td>1</td> </tr> <tr> <td>string|void String of HTML component</td> <td>1</td> </tr> <tr> <td>int Result</td> <td>1</td> </tr> <tr> <td>int Number of visible (gray or not) menu entries</td> <td>1</td> </tr> <tr> <td>string|int Return integer <0 if KO, label if OK (Example: 'long', 'short' or 'unitCODE')</td> <td>1</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>string Message</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, > 0 if OK (ID of newly created company notification information)</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, array of notifications to send if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, or number of changes if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, =0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-2,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-3,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-3,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|float Return integer <0 if KO, amount otherwise</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|float Return integer <0 if KO, Sum of credit notes and deposits amount otherwise</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Sum of credit notes and excess received amount otherwise</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Sum of credit notes and deposits amount otherwise</td> <td>1</td> </tr> <tr> <td>int<0,1></td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of record if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,prefix:string}> Return array with menu entries for top menu</td> <td>1</td> </tr> <tr> <td>Menu Menu array for particular mainmenu value or full tabArray</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int >= 0 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int 1 if ok, 0 if no records, -1 if error</td> <td>1</td> </tr> <tr> <td>int Nb of links, -1 if error</td> <td>1</td> </tr> <tr> <td>int 1 if ok, 0 if no record found, -1 if error</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Number of entries</td> <td>1</td> </tr> <tr> <td>string Number of movements</td> <td>1</td> </tr> <tr> <td>string Html component</td> <td>1</td> </tr> <tr> <td>string The HTML select component</td> <td>1</td> </tr> <tr> <td>string HTML select component with list of type of containers</td> <td>1</td> </tr> <tr> <td>string HTML select component with list of block containers</td> <td>1</td> </tr> <tr> <td>string HTML for model page boxes</td> <td>1</td> </tr> <tr> <td>string String cancatenated</td> <td>1</td> </tr> <tr> <td>string A summary description</td> <td>1</td> </tr> <tr> <td>string A URL to a image from a ATOM feed when found, otherwise a empty string</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if bind anonymous: 1 || if bind auth: 2</td> <td>1</td> </tr> <tr> <td>int version</td> <td>1</td> </tr> <tr> <td>string Content of file</td> <td>1</td> </tr> <tr> <td>int|array if KO: <=0 || if OK: array</td> <td>1</td> </tr> <tr> <td>array|boolean</td> <td>1</td> </tr> <tr> <td>array|int if KO: <0 || if OK: array of [id_record][ldap_field]=value</td> <td>1</td> </tr> <tr> <td>string Little endian</td> <td>1</td> </tr> <tr> <td>int|string if SID OK: SID string, if KO: -1</td> <td>1</td> </tr> <tr> <td>string Textual SID</td> <td>1</td> </tr> <tr> <td>array|int Array with answers (lowercase key - value)</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if OK: > 0</td> <td>1</td> </tr> <tr> <td>string Login</td> <td>1</td> </tr> <tr> <td>string Sam string</td> <td>1</td> </tr> <tr> <td>integer Unix timestamp</td> <td>1</td> </tr> <tr> <td>int gid number</td> <td>1</td> </tr> <tr> <td>array{paths:string[],names:string[],mimes:string[]}</td> <td>1</td> </tr> <tr> <td>string Form to show</td> <td>1</td> </tr> <tr> <td>string Text for topic</td> <td>1</td> </tr> <tr> <td>string HTML code to ask AI instruction and autofill result</td> <td>1</td> </tr> <tr> <td>string HTML for model email boxes</td> <td>1</td> </tr> <tr> <td>ModelMail|int<-1,-1> One instance of ModelMail or < 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO,</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, nb of records found if OK</td> <td>1</td> </tr> <tr> <td>array Array of substitution values for emails.</td> <td>1</td> </tr> <tr> <td>array Array of substitution key->code</td> <td>1</td> </tr> <tr> <td>array Substitution array</td> <td>1</td> </tr> <tr> <td>int Return compare result</td> <td>1</td> </tr> <tr> <td>float width in mm</td> <td>1</td> </tr> <tr> <td>float X position in mm</td> <td>1</td> </tr> <tr> <td>int rank on success and -1 on error</td> <td>1</td> </tr> <tr> <td>int new rank on success and -1 on error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >= if OK</td> <td>1</td> </tr> <tr> <td>string Html string</td> <td>1</td> </tr> <tr> <td>boolean true if column on</td> <td>1</td> </tr> <tr> <td>float Height of col tab titles</td> <td>1</td> </tr> <tr> <td>string HTML select with status</td> <td>1</td> </tr> <tr> <td>string Select html</td> <td>1</td> </tr> <tr> <td>string attribute string</td> <td>1</td> </tr> <tr> <td>int|null Return -1 if KO, 1 if OK, null if no items</td> <td>1</td> </tr> <tr> <td>string the html output for an setup item</td> <td>1</td> </tr> <tr> <td>array $arrayofparameters for /core/actions_setmoduleoptions.inc.php</td> <td>1</td> </tr> <tr> <td>FormSetupItem the new setup item created</td> <td>1</td> </tr> <tr> <td>int|void new max rank</td> <td>1</td> </tr> <tr> <td>int rank on success and -1 on error</td> <td>1</td> </tr> <tr> <td>int Return compare result</td> <td>1</td> </tr> <tr> <td>int -1 if KO, 0 nothing to do , 1 if OK</td> <td>1</td> </tr> <tr> <td>false|int|string</td> <td>1</td> </tr> <tr> <td>bool|string Generate the output html for this item</td> <td>1</td> </tr> <tr> <td>int<0,1> 0 or 1</td> <td>1</td> </tr> <tr> <td>int<-1,1> For 'addreplace' hooks (doActions, formConfirm, formObjectOptions, pdf_xxx,...): Return 0 if we want to keep standard actions, >0 if we want to stop/replace standard actions, <0 if KO. Things to print are returned into ->resprints and set into ->resPrint. Things to return are returned into ->results by hook and set into ->resArray for caller.</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, >0 if OK, or string if $noouput=1</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, number of shown files if OK</td> <td>1</td> </tr> <tr> <td>string|int Output string with HTML array of documents (might be empty string)</td> <td>1</td> </tr> <tr> <td>string Output string with HTML link of documents (might be empty string). This also fill the array ->infofiles</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, nb of files shown if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, nb of files shown if OK</td> <td>1</td> </tr> <tr> <td>int Number of links</td> <td>1</td> </tr> <tr> <td>string $out Output string with HTML</td> <td>1</td> </tr> <tr> <td>string HTML code for the select list if OK, empty if KO</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int}> Array of values</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of values by month</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array<string|int|float>> Array of values</td> <td>1</td> </tr> <tr> <td>array<array<int|float>> Array of values</td> <td>1</td> </tr> <tr> <td>array Array with nb, total amount, average for each year</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of nb each month</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of average each month</td> <td>1</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of total of product refs each month</td> <td>1</td> </tr> <tr> <td>array<int,array{0:int,1:int}> Array of sum of amounts</td> <td>1</td> </tr> <tr> <td>string incoterms info</td> <td>1</td> </tr> <tr> <td>string|boolean Incoterms info or false</td> <td>1</td> </tr> <tr> <td>string|int String with HTML select, or -1 if error</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> String with HTML select, or -1 if error</td> <td>1</td> </tr> <tr> <td>void|string HTML component with the select</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> HTML edit field, or -1 if error</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> String with HTML select, or -1 if error</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> String with HTML select, or -1 if error</td> <td>1</td> </tr> <tr> <td>string|array<string,string>|int<-1,-1> HTML select component || array of select options || - 1 if error</td> <td>1</td> </tr> <tr> <td>string Error</td> <td>1</td> </tr> <tr> <td>int Min value of all data</td> <td>1</td> </tr> <tr> <td>int Max value of all data</td> <td>1</td> </tr> <tr> <td>double Max value of all data</td> <td>1</td> </tr> <tr> <td>mixed|boolean</td> <td>1</td> </tr> <tr> <td>float|int HTML string to total value</td> <td>1</td> </tr> <tr> <td>string HTML string to show graph</td> <td>1</td> </tr> <tr> <td>int Value of width or height to use by default</td> <td>1</td> </tr> <tr> <td>string Version of datafile</td> <td>1</td> </tr> <tr> <td>string Filename</td> <td>1</td> </tr> <tr> <td>string String</td> <td>1</td> </tr> <tr> <td>array Centroid</td> <td>1</td> </tr> <tr> <td>string X space Y</td> <td>1</td> </tr> <tr> <td>string Class : num points</td> <td>1</td> </tr> <tr> <td>mixed Value key</td> <td>1</td> </tr> <tr> <td>bool True if mail sent, false otherwise. Negative int if error in hook. String if incorrect send mode.</td> <td>1</td> </tr> <tr> <td>string string encoded</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, encoded string if OK</td> <td>1</td> </tr> <tr> <td>string Completed string</td> <td>1</td> </tr> <tr> <td>string headers</td> <td>1</td> </tr> <tr> <td>string mime headers</td> <td>1</td> </tr> <tr> <td>string String content</td> <td>1</td> </tr> <tr> <td>string|int String with files encoded</td> <td>1</td> </tr> <tr> <td>string Chaine images encodees</td> <td>1</td> </tr> <tr> <td>int Socket id if ok, 0 if KO</td> <td>1</td> </tr> <tr> <td>boolean true if success</td> <td>1</td> </tr> <tr> <td>string If format 0: '<john@doe.com>' or 'John Doe <john@doe.com>' or '=?UTF-8?B?Sm9obiBEb2U=?= <john@doe.com>'</td> <td>1</td> </tr> <tr> <td>array array(email => name)</td> <td>1</td> </tr> <tr> <td>string Return HTML select string with list of languages</td> <td>1</td> </tr> <tr> <td>integer|void</td> <td>1</td> </tr> <tr> <td>string Return HTML output</td> <td>1</td> </tr> <tr> <td>string The combo HTML select component</td> <td>1</td> </tr> <tr> <td>int|string 0 or nb of top menu entries if $mode = 'topnb', string inc ase of bad parameter</td> <td>1</td> </tr> <tr> <td>SQLite3|false Database access handler</td> <td>1</td> </tr> <tr> <td>false|SQLite3Result Resultset of answer</td> <td>1</td> </tr> <tr> <td>false|object Object result line or false if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>string Error text</td> <td>1</td> </tr> <tr> <td>false|SQLite3Result Resource defined if OK, null if KO</td> <td>1</td> </tr> <tr> <td>bool|SQLite3Result Resource</td> <td>1</td> </tr> <tr> <td>array List of Charset</td> <td>1</td> </tr> <tr> <td>array List of Collation</td> <td>1</td> </tr> <tr> <td>int Formatted date</td> <td>1</td> </tr> <tr> <td>int Nb of days in year</td> <td>1</td> </tr> <tr> <td>int ??? Week number in year</td> <td>1</td> </tr> <tr> <td>string The DB prefix</td> <td>1</td> </tr> <tr> <td>string lasterrno</td> <td>1</td> </tr> <tr> <td>int 1 if validation is OK or transaction level no started, 0 if ERROR</td> <td>1</td> </tr> <tr> <td>string[] Version array</td> <td>1</td> </tr> <tr> <td>string Last query</td> <td>1</td> </tr> <tr> <td>string String to provide syntax of a sort sql string</td> <td>1</td> </tr> <tr> <td>string Last error</td> <td>1</td> </tr> <tr> <td>int|'' Date TMS or ''</td> <td>1</td> </tr> <tr> <td>string lastqueryerror</td> <td>1</td> </tr> <tr> <td>bool|int|object False on failure, 0 on empty, object on success</td> <td>1</td> </tr> <tr> <td>bool|array Result</td> <td>1</td> </tr> <tr> <td>string SQL request line converted</td> <td>1</td> </tr> <tr> <td>bool true if OK, false if KO</td> <td>1</td> </tr> <tr> <td>false|resource Database access handler</td> <td>1</td> </tr> <tr> <td>boolean True if disconnect successful, false otherwise</td> <td>1</td> </tr> <tr> <td>bool|resource Resultset of answer</td> <td>1</td> </tr> <tr> <td>false|object Object result line or false if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>int Nb of lines, -1 on error</td> <td>1</td> </tr> <tr> <td>string chaine format SQL</td> <td>1</td> </tr> <tr> <td>false|resource Resource defined if OK, null if KO</td> <td>1</td> </tr> <tr> <td>false|resource Resultset x (x->attname)</td> <td>1</td> </tr> <tr> <td>mysqli|mysqliDoli|false Database access object</td> <td>1</td> </tr> <tr> <td>false|mysqli_result Resultset of answer</td> <td>1</td> </tr> <tr> <td>object|null Object result line or null if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>array|null Array or null if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>array|null|int Array or null if KO or end of cursor or 0 if resultset is bool</td> <td>1</td> </tr> <tr> <td>int Nb of lines</td> <td>1</td> </tr> <tr> <td>int Number of lines</td> <td>1</td> </tr> <tr> <td>int|string Id of row</td> <td>1</td> </tr> <tr> <td>null|mysqli_result Resource defined if OK, null if KO</td> <td>1</td> </tr> <tr> <td>bool|mysqli_result Resultset x (x->Field, x->Type, ...)</td> <td>1</td> </tr> <tr> <td>array Array</td> <td>1</td> </tr> <tr> <td>string Date in a string YYYYMMDDHHMMSS</td> <td>1</td> </tr> <tr> <td>int 1 if transaction successfully opened or already opened, 0 if error</td> <td>1</td> </tr> <tr> <td>bool|SQLite3Result|mysqli_result|resource Resource result of the query to create database if OK, null if KO</td> <td>1</td> </tr> <tr> <td>string SQL request line converted</td> <td>1</td> </tr> <tr> <td>int Number of lines</td> <td>1</td> </tr> <tr> <td>array|null|false Result with row</td> <td>1</td> </tr> <tr> <td>int 1 if cancellation ok or transaction not open, 0 if error</td> <td>1</td> </tr> <tr> <td>bool|mysqli_result|resource Resultset of answer or false</td> <td>1</td> </tr> <tr> <td>false|resource|mysqli|mysqliDoli|PgSql\Connection|SQLite3 Database access handler</td> <td>1</td> </tr> <tr> <td>int Nb of lines</td> <td>1</td> </tr> <tr> <td>bool|resource|mysqli_result|SQLite3Result Resource</td> <td>1</td> </tr> <tr> <td>Object|false Object result line or false if KO or end of cursor</td> <td>1</td> </tr> <tr> <td>boolean true if OK, false if KO</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string Translated module name</td> <td>1</td> </tr> <tr> <td>string Translated module description</td> <td>1</td> </tr> <tr> <td>string Long description of a module from README.md of from property.</td> <td>1</td> </tr> <tr> <td>string Path of file if a README file was found.</td> <td>1</td> </tr> <tr> <td>string Content of ChangeLog</td> <td>1</td> </tr> <tr> <td>string Publisher name</td> <td>1</td> </tr> <tr> <td>string Publisher url</td> <td>1</td> </tr> <tr> <td>string Module version</td> <td>1</td> </tr> <tr> <td>string Module position (an external module should never return a value lower than 100000. 1-100000 are reserved for core)</td> <td>1</td> </tr> <tr> <td>string 'core', 'external' or 'unknown'</td> <td>1</td> </tr> <tr> <td>string[] Language files list</td> <td>1</td> </tr> <tr> <td>string Translated databaset label</td> <td>1</td> </tr> <tr> <td>string Translated dataset label</td> <td>1</td> </tr> <tr> <td>int|string Date of last activation or '' if module was never activated</td> <td>1</td> </tr> <tr> <td>array Array array('authorid'=>Id of last activation user, 'lastactivationdate'=>Date of last activation)</td> <td>1</td> </tr> <tr> <td>int<0,1> Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Error count (0 if ok)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK</td> <td>1</td> </tr> <tr> <td>int Error count (0 if OK)</td> <td>1</td> </tr> <tr> <td>int Error count (0 if OK)</td> <td>1</td> </tr> <tr> <td>int Error count (0 if OK)</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string HTML code of Kanban view</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if Error, 0 == no update needed, >0 if need update</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>boolean True if already used, otherwise False</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string Return translation of module label. Try translation of $this->name then translation of 'MailingModuleDesc'.$this->name, or $this->desc if not found</td> <td>1</td> </tr> <tr> <td>integer Example</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 si erreur, nb destinataires si ok</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if error, nb added if OK</td> <td>1</td> </tr> <tr> <td>string[] Array with SQL requests</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 si erreur, nb ajout si ok</td> <td>1</td> </tr> <tr> <td>int|string Nb of recipient, or <0 if error, or '' if NA</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si erreur, nb ajout si ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, number of emails added if ok</td> <td>1</td> </tr> <tr> <td>int Position for suite</td> <td>1</td> </tr> <tr> <td>string|int String if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string amount in letters</td> <td>1</td> </tr> <tr> <td>Translate $outputlangs Lang object for output language</td> <td>1</td> </tr> <tr> <td>string Label for payment type</td> <td>1</td> </tr> <tr> <td>string Contents of the file</td> <td>1</td> </tr> <tr> <td>int Return code</td> <td>1</td> </tr> <tr> <td>bool true if ok</td> <td>1</td> </tr> <tr> <td>bool True if ok.</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string Description of module</td> <td>1</td> </tr> <tr> <td>int 0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>bool False if the number doesn't match the maximum consecutive value allowed.</td> <td>1</td> </tr> <tr> <td>int 1 if OK, <=0 if KO</td> <td>1</td> </tr> <tr> <td>int Position pour suite</td> <td>1</td> </tr> <tr> <td>string|int Value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string Next free value</td> <td>1</td> </tr> <tr> <td>string|int<-1,0> Next ref value or last ref if $mode is 'last', -1 or 0 if KO</td> <td>1</td> </tr> <tr> <td>string|int<-1,0> Next free value, -1 or 0 if error</td> <td>1</td> </tr> <tr> <td>string|0 Next free value, 0 if KO</td> <td>1</td> </tr> <tr> <td>SwissQrBill\QrBill|bool The valid SwissQR object, or false</td> <td>1</td> </tr> <tr> <td>int Height in mm of the bottom-page QR invoice. Can be zero if not on right page; not enabled</td> <td>1</td> </tr> <tr> <td>bool True for for success</td> <td>1</td> </tr> <tr> <td>array top shift of linked object lines</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int 1=ok, 0=ko</td> <td>1</td> </tr> <tr> <td>string|-1 Next value, -1 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Next free value, -1 if KO</td> <td>1</td> </tr> <tr> <td>int Position for continuation</td> <td>1</td> </tr> <tr> <td>string|-1 Next free value, -1 if KO</td> <td>1</td> </tr> <tr> <td>string next value</td> <td>1</td> </tr> <tr> <td>string Example.</td> <td>1</td> </tr> <tr> <td>string|int Next ref value or last ref if $mode is 'last'</td> <td>1</td> </tr> <tr> <td>string[] List of printers (URIs)</td> <td>1</td> </tr> <tr> <td>stdClass List of attributes</td> <td>1</td> </tr> <tr> <td>array list of printers</td> <td>1</td> </tr> <tr> <td>array status array</td> <td>1</td> </tr> <tr> <td>array<string,string> List of drivers</td> <td>1</td> </tr> <tr> <td>string Return translation of key PrintingModuleDescXXX where XXX is module name, or $this->desc if not exists</td> <td>1</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>int<-1,1> >=0 if success, -1 if failure</td> <td>1</td> </tr> <tr> <td>string Description of module</td> <td>1</td> </tr> <tr> <td>string Description of module</td> <td>1</td> </tr> <tr> <td>int 0 if OK but not available, >0 if OK and available, <0 if KO</td> <td>1</td> </tr> <tr> <td>int 0 si OK, <0 si KO</td> <td>1</td> </tr> <tr> <td>string Return string example</td> <td>1</td> </tr> <tr> <td>int 0 if OK</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, '' if module not configured, -1 if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK</td> <td>1</td> </tr> <tr> <td>int 0=no, 1=yes</td> <td>1</td> </tr> <tr> <td>string|0 Value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string Next free value</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>array Return a substitution array</td> <td>1</td> </tr> <tr> <td>int 1</td> <td>1</td> </tr> <tr> <td>float Return topshift value</td> <td>1</td> </tr> <tr> <td>string Value if KO, <0 if KO</td> <td>1</td> </tr> <tr> <td>string Next free value</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>1</td> </tr> <tr> <td>boolean true if at least one line has batch set, false if not</td> <td>1</td> </tr> <tr> <td>string Example</td> <td>1</td> </tr> <tr> <td>string Next free value</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string Next free value</td> <td>1</td> </tr> <tr> <td>int Position of cursor after output</td> <td>1</td> </tr> <tr> <td>int Return height of bottom margin including footer text</td> <td>1</td> </tr> <tr> <td>array List of templates</td> <td>1</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string Letter</td> <td>1</td> </tr> <tr> <td>int 1 if success -1 if failed</td> <td>1</td> </tr> <tr> <td>int 1 if ok</td> <td>1</td> </tr> <tr> <td>int|string Coordinate or if KO: -1</td> <td>1</td> </tr> <tr> <td>string Picto string</td> <td>1</td> </tr> <tr> <td>array List of templates (same content than array this->driverlabel)</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Description</td> <td>1</td> </tr> <tr> <td>string Driver version</td> <td>1</td> </tr> <tr> <td>string Label of library</td> <td>1</td> </tr> <tr> <td>string Version of library</td> <td>1</td> </tr> <tr> <td>array List of templates</td> <td>1</td> </tr> <tr> <td>boolean true if model can be used</td> <td>1</td> </tr> <tr> <td>string Value</td> <td>1</td> </tr> <tr> <td>string Value if OK, '' if module not configured, <0 if KO</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> Value if OK, '' if module not configured, <0 if KO</td> <td>1</td> </tr> <tr> <td>boolean true if module can be used</td> <td>1</td> </tr> <tr> <td>string tcpdf encoding type</td> <td>1</td> </tr> <tr> <td>string Code of driver</td> <td>1</td> </tr> <tr> <td>string Description</td> <td>1</td> </tr> <tr> <td>string Driver suffix</td> <td>1</td> </tr> <tr> <td>string Driver version</td> <td>1</td> </tr> <tr> <td>string Label of external lib</td> <td>1</td> </tr> <tr> <td>string Version of external lib</td> <td>1</td> </tr> <tr> <td>string Element name or table element as default</td> <td>1</td> </tr> <tr> <td>string Value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string Error message</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if NO, 1 if Yes</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created line if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO otherwise array with general depreciation info</td> <td>1</td> </tr> <tr> <td>string Rate of the provided mode option</td> <td>1</td> </tr> <tr> <td>int ID of supplier invoice</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO, 0 if not found</td> <td>1</td> </tr> <tr> <td>string Chain with URL</td> <td>1</td> </tr> <tr> <td>string|int free reference for the invoice. '', -1 or -2 if error.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already billed, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if Ok, <0 if Ko</td> <td>1</td> </tr> <tr> <td>int >0 if Ok, <0 if Ko</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of supplier order if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of lines</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if error, > 0 if ok</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 = no doc generated, > 0 if OK</td> <td>1</td> </tr> <tr> <td>string Translated string</td> <td>1</td> </tr> <tr> <td>bool True if object is delayed</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not applicable, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, -2 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int id of created payment, < 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>array|int Array of supplier invoice id | <0 si ko</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>string 'dolibarr' if standard comportment or paid in dolibarr currency, 'customer' if payment received from multicurrency inputs</td> <td>1</td> </tr> <tr> <td>int Id invoice created if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK, 0 if not found</td> <td>1</td> </tr> <tr> <td>int 1 si ok, < 0 si erreur</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, =0 if nothing to do, >0 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Table of invoices ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1)</td> <td>1</td> </tr> <tr> <td>array|int Table of invoices ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>)</td> <td>1</td> </tr> <tr> <td>array{picto:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}</td> <td>1</td> </tr> <tr> <td>string|-1 Returns free reference or last reference, or '' or -1 if error</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO; 0 NOT FOUND; 1 OK</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of invoice created if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of line if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of line if OK</td> <td>1</td> </tr> <tr> <td>string False by default, True if maximum number of generation is reached</td> <td>1</td> </tr> <tr> <td>int Nb of orders for current supplier</td> <td>1</td> </tr> <tr> <td>int Nb of ref prices, or <0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of suppliers</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if error, > 0 if ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of ProductFournisseur with new properties to define supplier price</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Not found of no product id provided, >0 if OK</td> <td>1</td> </tr> <tr> <td>string String with supplier price</td> <td>1</td> </tr> <tr> <td>string String with supplier price</td> <td>1</td> </tr> <tr> <td>array|int Array of Log prices</td> <td>1</td> </tr> <tr> <td>string HTML String with supplier price</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 NOK > 0 OK</td> <td>1</td> </tr> <tr> <td>array Array of order objects</td> <td>1</td> </tr> <tr> <td>int ID of supplier order</td> <td>1</td> </tr> <tr> <td>array Array of result</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of payment if OK</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int 0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of created donation if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Summ of donations</td> <td>1</td> </tr> <tr> <td>float|int<-2,-1> Return integer <0 if KO, > remaining amount to pay if OK</td> <td>1</td> </tr> <tr> <td>Object|false Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>string Order free reference</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing is done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Nbr of product lines if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Nbr of service lines if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Nb of shipment found if OK</td> <td>1</td> </tr> <tr> <td>int Nb of shipments</td> <td>1</td> </tr> <tr> <td>int 0 si OK, <0 si KO</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if nothing to do, <0 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>int|array -1 if KO, array with result if OK</td> <td>1</td> </tr> <tr> <td>int >0 if ok, <0 if ko</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already billed, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>bool true if late, false if not</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>1</td> </tr> <tr> <td>mixed New object created, <0 if KO</td> <td>1</td> </tr> <tr> <td>array data</td> <td>1</td> </tr> <tr> <td>array ID of hook</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int|float Returns -1 when error (Note: could be mistaken with an amount)</td> <td>1</td> </tr> <tr> <td>string String with link</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, rowid in tva table if OK</td> <td>1</td> </tr> <tr> <td>string Chaine with URL</td> <td>1</td> </tr> <tr> <td>string Libelle</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>BankCateg[]</td> <td>1</td> </tr> <tr> <td>array List of account objects</td> <td>1</td> </tr> <tr> <td>int ID of account</td> <td>1</td> </tr> <tr> <td>array Array of AccountLine objects</td> <td>1</td> </tr> <tr> <td>int ID of line</td> <td>1</td> </tr> <tr> <td>array Array of links</td> <td>1</td> </tr> <tr> <td>int 1 if need to be concialiated, < 0 otherwise.</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id line if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of links array('url'=>, 'url_id'=>, 'label'=>, 'type'=> 'fk_bank'=> ) or -1 on error</td> <td>1</td> </tr> <tr> <td>int Rowid of added entry, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>boolean True is the deletion is ok, false if not</td> <td>1</td> </tr> <tr> <td>string Error string</td> <td>1</td> </tr> <tr> <td>float|-1 current balance (value date <= today), or -1 if error</td> <td>1</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>1</td> </tr> <tr> <td>int Nb of account we can reconciliate</td> <td>1</td> </tr> <tr> <td>int 1 if correct, <=0 if wrong</td> <td>1</td> </tr> <tr> <td>int 0=No bank code need + Account number is enough</td> <td>1</td> </tr> <tr> <td>int 1 = mandatory / 0 = Not mandatory</td> <td>1</td> </tr> <tr> <td>array Array of fields to show</td> <td>1</td> </tr> <tr> <td>bool True=SQL success, False=SQL error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK but not found, >0 if OK and found</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, rowid of the line if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of values</td> <td>1</td> </tr> <tr> <td>array Array with amount by year</td> <td>1</td> </tr> <tr> <td>int ID of invoice</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>array Array of lines</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of invoice created if OK</td> <td>1</td> </tr> <tr> <td>string html formatted string</td> <td>1</td> </tr> <tr> <td>int New id of clone</td> <td>1</td> </tr> <tr> <td>Facture|null The deposit created, or null if error (populates $origin->error in this case)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Refused, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done because invoice is not a draft, >0 if OK</td> <td>1</td> </tr> <tr> <td>bool false if KO, true if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>bool false if KO, true if OK</td> <td>1</td> </tr> <tr> <td>array|int -1 if KO, array with result if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of invoices ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1)</td> <td>1</td> </tr> <tr> <td>array|int Array of invoices ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>)</td> <td>1</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>1</td> </tr> <tr> <td>array Liste des id contacts livraison</td> <td>1</td> </tr> <tr> <td>int >= 1 if OK, -1 if error</td> <td>1</td> </tr> <tr> <td>mixed -1 if error, array of previous situations</td> <td>1</td> </tr> <tr> <td>bool Last of the cycle status</td> <td>1</td> </tr> <tr> <td>float or -1 if not available</td> <td>1</td> </tr> <tr> <td>array return array</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>float|int Reurrn previous situation percent, 0 or -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, rowid in localtax table if OK</td> <td>1</td> </tr> <tr> <td>int Return >=0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>array Array List of invoices related to the withdrawal line</td> <td>1</td> </tr> <tr> <td>integer Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>null|string Return status label (or null if $mode != 0, 1, 2, 3 or 4)</td> <td>1</td> </tr> <tr> <td>string Error string</td> <td>1</td> </tr> <tr> <td>array Array(Id of invoices/salary, Amount to pay)</td> <td>1</td> </tr> <tr> <td>double Return integer <O if KO, Total amount</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, No of invoice included into file if OK</td> <td>1</td> </tr> <tr> <td>string URL of target</td> <td>1</td> </tr> <tr> <td>string RUM number</td> <td>1</td> </tr> <tr> <td>string Return string with SEPA part DrctDbtTxInf</td> <td>1</td> </tr> <tr> <td>string String with SEPA Sender</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>int 1 if OK, O if K0</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int 0 en cas de success</td> <td>1</td> </tr> <tr> <td>int Id of negative payment line created</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int id of created payment, < 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, bank_line_id if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK</td> <td>1</td> </tr> <tr> <td>int|array Return integer <0 if KO or array of invoice id</td> <td>1</td> </tr> <tr> <td>int|array Array of amount of payments</td> <td>1</td> </tr> <tr> <td>string 'dolibarr' if standard comportment or paid in main currency, 'customer' if payment received from multicurrency inputs</td> <td>1</td> </tr> <tr> <td>boolean True if payment is reconciled</td> <td>1</td> </tr> <tr> <td>array Array of values by month</td> <td>1</td> </tr> <tr> <td>array List of salary objects</td> <td>1</td> </tr> <tr> <td>Object Salary object</td> <td>1</td> </tr> <tr> <td>int ID of salary</td> <td>1</td> </tr> <tr> <td>array List of paymentsalary objects</td> <td>1</td> </tr> <tr> <td>Object PaymentSalary object</td> <td>1</td> </tr> <tr> <td>int ID of paymentsalary</td> <td>1</td> </tr> <tr> <td>Object PaymentSalary object</td> <td>1</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>int ID of jobposition</td> <td>1</td> </tr> <tr> <td>int ID of candidature</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already exists, ID of created object if OK</td> <td>1</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>string Path to file with zip or '' if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of new website if OK</td> <td>1</td> </tr> <tr> <td>boolean True if web site is a multilanguage web site</td> <td>1</td> </tr> <tr> <td>string HTML select component</td> <td>1</td> </tr> <tr> <td>int 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int|false</td> <td>1</td> </tr> <tr> <td>array empty if KO, array if OK</td> <td>1</td> </tr> <tr> <td>array|int<-1,-1> -1 if KO, array if OK</td> <td>1</td> </tr> <tr> <td>int Return 0 if we can replace, <0 if not (-2=not writable)</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>WebSitePage[]|int<-1,-1> int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>int int <0 if KO, array of pages if OK</td> <td>1</td> </tr> <tr> <td>mixed New object created, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>array Array of lines</td> <td>1</td> </tr> <tr> <td>int Number of movements</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>string MO free reference</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int array of lines if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>Mo[]|int array if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>Mo[]|int[]|int array of MOs if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>Mo|int MO object if OK, -1 if KO, 0 if not exist</td> <td>1</td> </tr> <tr> <td>int New id of clone</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if OK, >0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string|int<-2,-1> free ref, or <0 if error</td> <td>1</td> </tr> <tr> <td>array{picto:string,ref?:string,total_ht?:string,total_tva?:string,total_ttc?:string}</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>boolean True=applied, False=not applied</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of user ids, <0 if KO</td> <td>1</td> </tr> <tr> <td>boolean True if late, False if not late</td> <td>1</td> </tr> <tr> <td>int Amount of payment already done, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, total ttc if OK</td> <td>1</td> </tr> <tr> <td>float Amount</td> <td>1</td> </tr> <tr> <td>array Array with ExpenseReportRule</td> <td>1</td> </tr> <tr> <td>array Array of Expense Report objects</td> <td>1</td> </tr> <tr> <td>int ID of Expense Report</td> <td>1</td> </tr> <tr> <td>array List of paymentExpenseReport objects</td> <td>1</td> </tr> <tr> <td>object PaymentExpenseReport object</td> <td>1</td> </tr> <tr> <td>int ID of paymentExpenseReport</td> <td>1</td> </tr> <tr> <td>array of category</td> <td>1</td> </tr> <tr> <td>boolean|array</td> <td>1</td> </tr> <tr> <td>int Max nb</td> <td>1</td> </tr> <tr> <td>array|string|null</td> <td>1</td> </tr> <tr> <td>resource|string</td> <td>1</td> </tr> <tr> <td>AddressBook</td> <td>1</td> </tr> <tr> <td>Card</td> <td>1</td> </tr> <tr> <td>int Last insert id</td> <td>1</td> </tr> <tr> <td>array This method returns an array structure similar to</td> <td>1</td> </tr> <tr> <td>ServerPlugin</td> <td>1</td> </tr> <tr> <td>int[]|null</td> <td>1</td> </tr> <tr> <td>\Iterator</td> <td>1</td> </tr> <tr> <td>callable|string</td> <td>1</td> </tr> <tr> <td>INode|null</td> <td>1</td> </tr> <tr> <td>LockInfo</td> <td>1</td> </tr> <tr> <td>string[]|null</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\Xml\Element\Response[]</td> <td>1</td> </tr> <tr> <td>\Sabre\CalDAV\ICalendarObject</td> <td>1</td> </tr> <tr> <td>Calendar</td> <td>1</td> </tr> <tr> <td>VObject\Component\VCalendar</td> <td>1</td> </tr> <tr> <td>User</td> <td>1</td> </tr> <tr> <td>NotificationInterface[]</td> <td>1</td> </tr> <tr> <td>Property</td> <td>1</td> </tr> <tr> <td>Property|null</td> <td>1</td> </tr> <tr> <td>Component/VCalendar</td> <td>1</td> </tr> <tr> <td>DateInterval|string</td> <td>1</td> </tr> <tr> <td>DateTimeImmutable|DateInterval</td> <td>1</td> </tr> <tr> <td>Property\Uri</td> <td>1</td> </tr> <tr> <td>Property\Binary|null</td> <td>1</td> </tr> <tr> <td>Message[]</td> <td>1</td> </tr> <tr> <td>mixed bool|string</td> <td>1</td> </tr> <tr> <td>VEvent</td> <td>1</td> </tr> <tr> <td>\DateTimeImmutable</td> <td>1</td> </tr> <tr> <td>\DateTimeImmutable[]</td> <td>1</td> </tr> <tr> <td>\DateTime[]</td> <td>1</td> </tr> <tr> <td>\DateInterval</td> <td>1</td> </tr> <tr> <td>VObject\Component[]</td> <td>1</td> </tr> <tr> <td>VObject\Component|null</td> <td>1</td> </tr> <tr> <td>\DateTimeZone</td> <td>1</td> </tr> <tr> <td>VCard</td> <td>1</td> </tr> <tr> <td>\Sabre\VObject\Component</td> <td>1</td> </tr> <tr> <td>\Sabre\VObject\Property</td> <td>1</td> </tr> <tr> <td>string|string[]</td> <td>1</td> </tr> <tr> <td>float|null</td> <td>1</td> </tr> <tr> <td>string[] Array of classname => path</td> <td>1</td> </tr> <tr> <td>true|null True if loaded, null otherwise</td> <td>1</td> </tr> <tr> <td>string|false The path if found, false otherwise</td> <td>1</td> </tr> <tr> <td>self[]</td> <td>1</td> </tr> <tr> <td>string Version constraint usable with composer/semver</td> <td>1</td> </tr> <tr> <td>string|null If the package is being replaced or provided but is not really installed, null will be returned as reference</td> <td>1</td> </tr> <tr> <td>string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path.</td> <td>1</td> </tr> <tr> <td>fpdi_pdf_parser</td> <td>1</td> </tr> <tr> <td>int Index of imported page - to use with fpdf_tpl::useTemplate()</td> <td>1</td> </tr> <tr> <td>string Steam content</td> <td>1</td> </tr> <tr> <td>int Offset of the object in $this->pdfdata.</td> <td>1</td> </tr> <tr> <td>int The ID of new created Template</td> <td>1</td> </tr> <tr> <td>mixed If a template is opened, the ID is returned. If not a false is returned.</td> <td>1</td> </tr> <tr> <td>array The height and width of the template</td> <td>1</td> </tr> <tr> <td>string The WKB string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>string The Extended-WKB binary string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>string The georss string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>string Does a reverse geocode of the geometry</td> <td>1</td> </tr> <tr> <td>string The KML string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>object Geometry</td> <td>1</td> </tr> <tr> <td>string The GeoJSON string</td> <td>1</td> </tr> <tr> <td>string the geohash or null when the $geometry is not a Point</td> <td>1</td> </tr> <tr> <td>Point the converted geohash</td> <td>1</td> </tr> <tr> <td>string geohash</td> <td>1</td> </tr> <tr> <td>string the geohash of the adjacent cell</td> <td>1</td> </tr> <tr> <td>string The WKT string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>string The Extended-WKT string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>string The GPX string representation of the input geometries</td> <td>1</td> </tr> <tr> <td>float The X coordinate</td> <td>1</td> </tr> <tr> <td>float The Y coordinate</td> <td>1</td> </tr> <tr> <td>float The Z coordinate or NULL is not a 3D point</td> <td>1</td> </tr> <tr> <td>array($w, $h, $x, $y)</td> <td>1</td> </tr> <tr> <td>image information</td> <td>1</td> </tr> <tr> <td>true in case of success, false otherwise</td> <td>1</td> </tr> <tr> <td>replaced page content.</td> <td>1</td> </tr> <tr> <td>int object ID</td> <td>1</td> </tr> <tr> <td>array barcode array</td> <td>1</td> </tr> <tr> <td>encoded string.</td> <td>1</td> </tr> <tr> <td>char checksum.</td> <td>1</td> </tr> <tr> <td>string checksum code.</td> <td>1</td> </tr> <tr> <td>int checksum.</td> <td>1</td> </tr> <tr> <td>array sequence</td> <td>1</td> </tr> <tr> <td>string XObjects dictionary</td> <td>1</td> </tr> <tr> <td>(int) The object ID.</td> <td>1</td> </tr> <tr> <td>string for viewer preferences</td> <td>1</td> </tr> <tr> <td>int object number</td> <td>1</td> </tr> <tr> <td>string the starting object string</td> <td>1</td> </tr> <tr> <td>(int) Creation timestamp in seconds.</td> <td>1</td> </tr> <tr> <td>(int) Modfication timestamp in seconds.</td> <td>1</td> </tr> <tr> <td>the number of cells used or the remaining text if $firstline = true;</td> <td>1</td> </tr> <tr> <td>float value in user's unit</td> <td>1</td> </tr> <tr> <td>string converted text string</td> <td>1</td> </tr> <tr> <td>int object key</td> <td>1</td> </tr> <tr> <td>encrypted string</td> <td>1</td> </tr> <tr> <td>int 11 bit Frame Check Sequence as integer (decimal base)</td> <td>1</td> </tr> <tr> <td>int reversed value</td> <td>1</td> </tr> <tr> <td>string U value</td> <td>1</td> </tr> <tr> <td>array requested table</td> <td>1</td> </tr> <tr> <td>string UE value</td> <td>1</td> </tr> <tr> <td>string O value</td> <td>1</td> </tr> <tr> <td>string OE value</td> <td>1</td> </tr> <tr> <td>string password</td> <td>1</td> </tr> <tr> <td>int Line width</td> <td>1</td> </tr> <tr> <td>array bounding box coordinates (x min, y min, x max, y max)</td> <td>1</td> </tr> <tr> <td>last cell height</td> <td>1</td> </tr> <tr> <td>float adjusting factor to convert pixels to user units.</td> <td>1</td> </tr> <tr> <td>array of page dimensions.</td> <td>1</td> </tr> <tr> <td>int page width.</td> <td>1</td> </tr> <tr> <td>int page height.</td> <td>1</td> </tr> <tr> <td>int page break margin.</td> <td>1</td> </tr> <tr> <td>int scale factor.</td> <td>1</td> </tr> <tr> <td>array of padding values</td> <td>1</td> </tr> <tr> <td>array of margin values</td> <td>1</td> </tr> <tr> <td>array of adjustments</td> <td>1</td> </tr> <tr> <td>boolean auto-page-break mode</td> <td>1</td> </tr> <tr> <td>int number of pages</td> <td>1</td> </tr> <tr> <td>(string) Stripped named destination identifier or false in case of error.</td> <td>1</td> </tr> <tr> <td>(array) Named Destination array.</td> <td>1</td> </tr> <tr> <td>array()</td> <td>1</td> </tr> <tr> <td>int internal object ID</td> <td>1</td> </tr> <tr> <td>true if we are not in page header nor in page footer, false otherwise.</td> <td>1</td> </tr> <tr> <td>array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td> <td>1</td> </tr> <tr> <td>(array) Spot colors array.</td> <td>1</td> </tr> <tr> <td>(string) PDF color command.</td> <td>1</td> </tr> <tr> <td>(string) The PDF command.</td> <td>1</td> </tr> <tr> <td>(string) Empty string.</td> <td>1</td> </tr> <tr> <td>int number of characters</td> <td>1</td> </tr> <tr> <td>array containing the font data, or false in case of error.</td> <td>1</td> </tr> <tr> <td>(array) Array defining page and rectangle coordinates of signature appearance.</td> <td>1</td> </tr> <tr> <td>float Absolute measure.</td> <td>1</td> </tr> <tr> <td>mixed array(xMin, yMin, xMax, yMax) or FALSE if not defined.</td> <td>1</td> </tr> <tr> <td>int font descent</td> <td>1</td> </tr> <tr> <td>int font ascent</td> <td>1</td> </tr> <tr> <td>(boolean) true if the char is defined, false otherwise.</td> <td>1</td> </tr> <tr> <td>(string) Processed text.</td> <td>1</td> </tr> <tr> <td>(string) Timestamped digital signature</td> <td>1</td> </tr> <tr> <td>current page in the group</td> <td>1</td> </tr> <tr> <td>the number of extgstates</td> <td>1</td> </tr> <tr> <td>boolean true in case of page break, false otherwise.</td> <td>1</td> </tr> <tr> <td>string containing cell code</td> <td>1</td> </tr> <tr> <td>int the replaced char or the old char in case the new char i not defined</td> <td>1</td> </tr> <tr> <td>string containing cell border code</td> <td>1</td> </tr> <tr> <td>int Return the number of cells or 1 for html mode.</td> <td>1</td> </tr> <tr> <td>mixed Return the number of cells or the remaining string if $firstline = true.</td> <td>1</td> </tr> <tr> <td>int Return the remaining width</td> <td>1</td> </tr> <tr> <td>current font size</td> <td>1</td> </tr> <tr> <td>current font size in points unit</td> <td>1</td> </tr> <tr> <td>string current font family name</td> <td>1</td> </tr> <tr> <td>string current font style</td> <td>1</td> </tr> <tr> <td>int with in user units</td> <td>1</td> </tr> <tr> <td>int sash style (return -1 in case of none or hidden border)</td> <td>1</td> </tr> <tr> <td>array containing border properties</td> <td>1</td> </tr> <tr> <td>array of cell paddings</td> <td>1</td> </tr> <tr> <td>array of cell margins</td> <td>1</td> </tr> <tr> <td>array of border spacings</td> <td>1</td> </tr> <tr> <td>float quantity to increases or decreases the space between characters in a text.</td> <td>1</td> </tr> <tr> <td>float font stretching percentage</td> <td>1</td> </tr> <tr> <td>string containing serialized data</td> <td>1</td> </tr> <tr> <td>array containing unserialized data</td> <td>1</td> </tr> <tr> <td>array containing top-left border coordinates</td> <td>1</td> </tr> <tr> <td>float value in user's unit or point if $points=true</td> <td>1</td> </tr> <tr> <td>array of graphic variables</td> <td>1</td> </tr> <tr> <td>string buffer content</td> <td>1</td> </tr> <tr> <td>string page buffer content or false in case of error</td> <td>1</td> </tr> <tr> <td>int image index number</td> <td>1</td> </tr> <tr> <td>string image buffer content or false in case of error</td> <td>1</td> </tr> <tr> <td>string font buffer content or false in case of error</td> <td>1</td> </tr> <tr> <td>TCPDF object.</td> <td>1</td> </tr> <tr> <td>int current column number</td> <td>1</td> </tr> <tr> <td>int number of columns</td> <td>1</td> </tr> <tr> <td>Array of parameters.</td> <td>1</td> </tr> <tr> <td>boolean default font subsetting state.</td> <td>1</td> </tr> <tr> <td>left trimmed string</td> <td>1</td> </tr> <tr> <td>right trimmed string</td> <td>1</td> </tr> <tr> <td>trimmed string</td> <td>1</td> </tr> <tr> <td>true for unicode font, false otherwise.</td> <td>1</td> </tr> <tr> <td>string normalized font name</td> <td>1</td> </tr> <tr> <td>float stretching value</td> <td>1</td> </tr> <tr> <td>int font spacing (tracking) value</td> <td>1</td> </tr> <tr> <td>array of no-write page regions</td> <td>1</td> </tr> <tr> <td>array($x, $y)</td> <td>1</td> </tr> <tr> <td>array transformation matrix</td> <td>1</td> </tr> <tr> <td>object style</td> <td>1</td> </tr> <tr> <td>array of container box measures (x, y, w, h)</td> <td>1</td> </tr> <tr> <td>(array) Spot color array or false if not defined.</td> <td>1</td> </tr> <tr> <td>array RGB or CMYK color, or false in case of error.</td> <td>1</td> </tr> <tr> <td>(string) The color array representation.</td> <td>1</td> </tr> <tr> <td>TCPDF version string</td> <td>1</td> </tr> <tr> <td>TCPDF producer string</td> <td>1</td> </tr> <tr> <td>Returns 0 if magic quotes runtime is off or get_magic_quotes_runtime doesn't exist, 1 otherwise.</td> <td>1</td> </tr> <tr> <td>Boolean true if the URl exist, false otherwise.</td> <td>1</td> </tr> <tr> <td>string without SHY characters.</td> <td>1</td> </tr> <tr> <td>border mode array</td> <td>1</td> </tr> <tr> <td>boolean true if string is empty</td> <td>1</td> </tr> <tr> <td>string filename.</td> <td>1</td> </tr> <tr> <td>converted string</td> <td>1</td> </tr> <tr> <td>cloned object</td> <td>1</td> </tr> <tr> <td>replaced page content and updated $diff parameter as array.</td> <td>1</td> </tr> <tr> <td>int seconds.</td> <td>1</td> </tr> <tr> <td>string containing random data</td> <td>1</td> </tr> <tr> <td>String MD5 encrypted binary string</td> <td>1</td> </tr> <tr> <td>byte string</td> <td>1</td> </tr> <tr> <td>(string) Encoded name object.</td> <td>1</td> </tr> <tr> <td>array of annotation properties</td> <td>1</td> </tr> <tr> <td>An array where the keys are the CSS selectors and the values are the CSS properties.</td> <td>1</td> </tr> <tr> <td>true if the selector is valid, false otherwise</td> <td>1</td> </tr> <tr> <td>array containing CSS properties</td> <td>1</td> </tr> <tr> <td>string containing merged CSS properties</td> <td>1</td> </tr> <tr> <td>string roman representation of the specified number</td> <td>1</td> </tr> <tr> <td>Returns the position where the needle exists. Returns FALSE if the needle was not found.</td> <td>1</td> </tr> <tr> <td>array of hyphenation patterns</td> <td>1</td> </tr> <tr> <td>transformation array</td> <td>1</td> </tr> <tr> <td>array of transformations</td> <td>1</td> </tr> <tr> <td>Returns an array containing substrings of subject split along boundaries matched by pattern.modifier</td> <td>1</td> </tr> <tr> <td>resource Returns a file pointer resource on success, or FALSE on error.</td> <td>1</td> </tr> <tr> <td>Returns TRUE if the URL exists; FALSE otherwise.</td> <td>1</td> </tr> <tr> <td>Returns TRUE if the file or directory specified by filename exists; FALSE otherwise.</td> <td>1</td> </tr> <tr> <td>The function returns the read data or FALSE on failure.</td> <td>1</td> </tr> <tr> <td>int 32 bit value</td> <td>1</td> </tr> <tr> <td>int 8 bit value</td> <td>1</td> </tr> <tr> <td>Returns the read string or FALSE in case of error.</td> <td>1</td> </tr> <tr> <td>4-byte integer</td> <td>1</td> </tr> <tr> <td>array containing page width and height in points</td> <td>1</td> </tr> <tr> <td>(string) Canonical page layout name.</td> <td>1</td> </tr> <tr> <td>(string) Canonical page mode name.</td> <td>1</td> </tr> <tr> <td>(string) TCPDF font name or boolean false in case of error.</td> <td>1</td> </tr> <tr> <td>int checksum</td> <td>1</td> </tr> <tr> <td>(string) A subset of TrueType font data without the unused glyphs.</td> <td>1</td> </tr> <tr> <td>PDF command string for font widths</td> <td>1</td> </tr> <tr> <td>(string) CIDToGIDMap.</td> <td>1</td> </tr> <tr> <td>string Font full path or empty string</td> <td>1</td> </tr> <tr> <td>Return array of unicode characters</td> <td>1</td> </tr> <tr> <td>array containing codepoints (UTF-8 characters values)</td> <td>1</td> </tr> <tr> <td>array of unicode chars</td> <td>1</td> </tr> <tr> <td>string image type</td> <td>1</td> </tr> <tr> <td>(array) Array of available filter decoders.</td> <td>1</td> </tr> <tr> <td>array frame in binary form</td> <td>1</td> </tr> <tr> <td>value at specified position</td> <td>1</td> </tr> <tr> <td>array of x,y coordinates</td> <td>1</td> </tr> <tr> <td>0 in case of success, -1 in case of error</td> <td>1</td> </tr> <tr> <td>array rsblocks</td> <td>1</td> </tr> <tr> <td>int blacks</td> <td>1</td> </tr> <tr> <td>array bitmask</td> <td>1</td> </tr> <tr> <td>int b</td> <td>1</td> </tr> <tr> <td>array mask</td> <td>1</td> </tr> <tr> <td>array best mask</td> <td>1</td> </tr> <tr> <td>int mode</td> <td>1</td> </tr> <tr> <td>(int)</td> <td>1</td> </tr> <tr> <td>items</td> <td>1</td> </tr> <tr> <td>int parity</td> <td>1</td> </tr> <tr> <td>value</td> <td>1</td> </tr> <tr> <td>boolean true in case of valid data, false otherwise</td> <td>1</td> </tr> <tr> <td>int bits</td> <td>1</td> </tr> <tr> <td>int version</td> <td>1</td> </tr> <tr> <td>int size</td> <td>1</td> </tr> <tr> <td>array of items and total bits</td> <td>1</td> </tr> <tr> <td>array of bytes</td> <td>1</td> </tr> <tr> <td>array srctab</td> <td>1</td> </tr> <tr> <td>int maximum size (bytes)</td> <td>1</td> </tr> <tr> <td>int ECC size (bytes)</td> <td>1</td> </tr> <tr> <td>int width</td> <td>1</td> </tr> <tr> <td>int number of remainder bits</td> <td>1</td> </tr> <tr> <td>int version number</td> <td>1</td> </tr> <tr> <td>int the size of the appropriate length indicator (bits).</td> <td>1</td> </tr> <tr> <td>int the maximum length (bytes)</td> <td>1</td> </tr> <tr> <td>array spec</td> <td>1</td> </tr> <tr> <td>BCH encoded version information pattern</td> <td>1</td> </tr> <tr> <td>BCH encoded format information pattern</td> <td>1</td> </tr> <tr> <td>int X osition</td> <td>1</td> </tr> <tr> <td>parity array</td> <td>1</td> </tr> <tr> <td>int product</td> <td>1</td> </tr> <tr> <td>array data codewords + error codewords</td> <td>1</td> </tr> <tr> <td>boolean true if the char is of the selected mode.</td> <td>1</td> </tr> <tr> <td>int encoding mode</td> <td>1</td> </tr> <tr> <td>(int) Switch codeword.</td> <td>1</td> </tr> <tr> <td>number of data codewords in matrix</td> <td>1</td> </tr> <tr> <td>array of codewords</td> <td>1</td> </tr> <tr> <td>string The fully qualified name of the service</td> <td>1</td> </tr> <tr> <td>array List of resolved scopes</td> <td>1</td> </tr> <tr> <td>StdOAuth2Token</td> <td>1</td> </tr> <tr> <td>Session</td> <td>1</td> </tr> <tr> <td>Predis $redis</td> <td>1</td> </tr> <tr> <td>string $key</td> <td>1</td> </tr> <tr> <td>string String for the tenant used to create the token</td> <td>1</td> </tr> <tr> <td>string the URI string with user protected info masked</td> <td>1</td> </tr> <tr> <td>string The full URI without masking user info</td> <td>1</td> </tr> <tr> <td>string The relative URI</td> <td>1</td> </tr> <tr> <td>UriInterface|null</td> <td>1</td> </tr> <tr> <td>string Returns http or https depending on the URI scheme</td> <td>1</td> </tr> <tr> <td>CurlClient</td> <td>1</td> </tr> <tr> <td>null|string Class name of the chart renderer</td> <td>1</td> </tr> <tr> <td>int Default options for libxml loader</td> <td>1</td> </tr> <tr> <td>bool $state</td> <td>1</td> </tr> <tr> <td>CacheInterface</td> <td>1</td> </tr> <tr> <td>NamedRange</td> <td>1</td> </tr> <tr> <td>bool true|false</td> <td>1</td> </tr> <tr> <td>null|array</td> <td>1</td> </tr> <tr> <td>Document\Properties</td> <td>1</td> </tr> <tr> <td>Document\Security</td> <td>1</td> </tr> <tr> <td>Worksheet[]</td> <td>1</td> </tr> <tr> <td>int index</td> <td>1</td> </tr> <tr> <td>int New sheet index</td> <td>1</td> </tr> <tr> <td>int Active sheet index</td> <td>1</td> </tr> <tr> <td>NamedRange[]</td> <td>1</td> </tr> <tr> <td>null|NamedRange</td> <td>1</td> </tr> <tr> <td>bool True if horizonal scroll bar is visible</td> <td>1</td> </tr> <tr> <td>bool True if vertical scroll bar is visible</td> <td>1</td> </tr> <tr> <td>bool True if the sheet tabs are visible</td> <td>1</td> </tr> <tr> <td>int First sheet in book view</td> <td>1</td> </tr> <tr> <td>string Visible status</td> <td>1</td> </tr> <tr> <td>int Ratio between the workbook tabs bar and the horizontal scroll bar</td> <td>1</td> </tr> <tr> <td>int Index</td> <td>1</td> </tr> <tr> <td>IComparable[]</td> <td>1</td> </tr> <tr> <td>Writer\IWriter</td> <td>1</td> </tr> <tr> <td>Style\Color</td> <td>1</td> </tr> <tr> <td>ReferenceHelper</td> <td>1</td> </tr> <tr> <td>string Updated formula</td> <td>1</td> </tr> <tr> <td>string Updated cell reference</td> <td>1</td> </tr> <tr> <td>false|\SimpleXMLElement</td> <td>1</td> </tr> <tr> <td>IReadFilter</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Spreadsheet</td> <td>1</td> </tr> <tr> <td>string Record data</td> <td>1</td> </tr> <tr> <td>Xls\RC4</td> <td>1</td> </tr> <tr> <td>bool Success</td> <td>1</td> </tr> <tr> <td>string The string contents as UTF-8</td> <td>1</td> </tr> <tr> <td>string Cell range address</td> <td>1</td> </tr> <tr> <td>bool Boolean value</td> <td>1</td> </tr> <tr> <td>string basename of the used excel workbook</td> <td>1</td> </tr> <tr> <td>BSE|BstoreContainer|DgContainer|DggContainer|\PhpOffice\PhpSpreadsheet\Shared\Escher|SpContainer|SpgrContainer</td> <td>1</td> </tr> <tr> <td>array RGB color value, example: ['rgb' => 'FF0000']</td> <td>1</td> </tr> <tr> <td>null|bool|float|int|string</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Chart\Chart</td> <td>1</td> </tr> <tr> <td>string Unique Reference</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Cell\Cell Cell that was found, or null if not found</td> <td>1</td> </tr> <tr> <td>\Generator|string[]</td> <td>1</td> </tr> <tr> <td>HeaderFooterDrawing[]</td> <td>1</td> </tr> <tr> <td>AutoFilter\Column[]</td> <td>1</td> </tr> <tr> <td>int The column offset within the autofilter range</td> <td>1</td> </tr> <tr> <td>int The offset of the specified column within the autofilter range</td> <td>1</td> </tr> <tr> <td>Row</td> <td>1</td> </tr> <tr> <td>RowCellIterator</td> <td>1</td> </tr> <tr> <td>null|\PhpOffice\PhpSpreadsheet\Cell\Cell</td> <td>1</td> </tr> <tr> <td>ColumnCellIterator</td> <td>1</td> </tr> <tr> <td>Drawing\Shadow</td> <td>1</td> </tr> <tr> <td>null|Hyperlink</td> <td>1</td> </tr> <tr> <td>RowDimension[]</td> <td>1</td> </tr> <tr> <td>ColumnDimension[]</td> <td>1</td> </tr> <tr> <td>BaseDrawing[]</td> <td>1</td> </tr> <tr> <td>Chart[]</td> <td>1</td> </tr> <tr> <td>Chart</td> <td>1</td> </tr> <tr> <td>int The number of charts</td> <td>1</td> </tr> <tr> <td>string[] The names of charts</td> <td>1</td> </tr> <tr> <td>string String containing the dimension of this worksheet</td> <td>1</td> </tr> <tr> <td>string String containing the dimension of this worksheet that actually contain data</td> <td>1</td> </tr> <tr> <td>string Sheet state (visible, hidden, veryHidden)</td> <td>1</td> </tr> <tr> <td>PageSetup</td> <td>1</td> </tr> <tr> <td>PageMargins</td> <td>1</td> </tr> <tr> <td>HeaderFooter</td> <td>1</td> </tr> <tr> <td>SheetView</td> <td>1</td> </tr> <tr> <td>string Highest column name that contains data</td> <td>1</td> </tr> <tr> <td>int Highest row number that contains data</td> <td>1</td> </tr> <tr> <td>Cell Cell that was created</td> <td>1</td> </tr> <tr> <td>Comment[]</td> <td>1</td> </tr> <tr> <td>string Example: 'A1'</td> <td>1</td> </tr> <tr> <td>RowIterator</td> <td>1</td> </tr> <tr> <td>ColumnIterator</td> <td>1</td> </tr> <tr> <td>Hyperlink[]</td> <td>1</td> </tr> <tr> <td>DataValidation[]</td> <td>1</td> </tr> <tr> <td>string Adjusted range value</td> <td>1</td> </tr> <tr> <td>Column\Rule[]</td> <td>1</td> </tr> <tr> <td>Legend</td> <td>1</td> </tr> <tr> <td>PlotArea</td> <td>1</td> </tr> <tr> <td>DataSeries</td> <td>1</td> </tr> <tr> <td>string|string[] HEX color or array with HEX colors</td> <td>1</td> </tr> <tr> <td>bool true if validation was successful</td> <td>1</td> </tr> <tr> <td>null|bool</td> <td>1</td> </tr> <tr> <td>null|array|int|string</td> <td>1</td> </tr> <tr> <td>string The extracted colour component</td> <td>1</td> </tr> <tr> <td>string The red colour component</td> <td>1</td> </tr> <tr> <td>string The green colour component</td> <td>1</td> </tr> <tr> <td>string The blue colour component</td> <td>1</td> </tr> <tr> <td>string The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)</td> <td>1</td> </tr> <tr> <td>bool|int</td> <td>1</td> </tr> <tr> <td>string Formatted string</td> <td>1</td> </tr> <tr> <td>bool Use File Upload Temporary directory (true or false)</td> <td>1</td> </tr> <tr> <td>string Hashed password</td> <td>1</td> </tr> <tr> <td>int Value in EMU</td> <td>1</td> </tr> <tr> <td>int Value in cell dimension</td> <td>1</td> </tr> <tr> <td>float Value in points</td> <td>1</td> </tr> <tr> <td>int Angle</td> <td>1</td> </tr> <tr> <td>int Degrees</td> <td>1</td> </tr> <tr> <td>resource read-only stream</td> <td>1</td> </tr> <tr> <td>bool Whether the PPS tree for the given PPS is complete</td> <td>1</td> </tr> <tr> <td>bool true if it's a File PPS, false otherwise</td> <td>1</td> </tr> <tr> <td>bool true if it's a Root PPS, false otherwise</td> <td>1</td> </tr> <tr> <td>int The total number of PPS's found in the OLE container</td> <td>1</td> </tr> <tr> <td>string The binary string containing the data requested</td> <td>1</td> </tr> <tr> <td>int The amount of bytes in data the PPS has</td> <td>1</td> </tr> <tr> <td>string The string in Unicode</td> <td>1</td> </tr> <tr> <td>string The string for the OLE container</td> <td>1</td> </tr> <tr> <td>int The Unix timestamp corresponding to the string</td> <td>1</td> </tr> <tr> <td>string Data for standard stream</td> <td>1</td> </tr> <tr> <td>int Column width</td> <td>1</td> </tr> <tr> <td>int Text width in pixels (no padding added)</td> <td>1</td> </tr> <tr> <td>int Font size (in pixels)</td> <td>1</td> </tr> <tr> <td>int Size (in pixels)</td> <td>1</td> </tr> <tr> <td>float Size (in pixels)</td> <td>1</td> </tr> <tr> <td>string Path to TrueType font file</td> <td>1</td> </tr> <tr> <td>int Character set code</td> <td>1</td> </tr> <tr> <td>mixed Column width</td> <td>1</td> </tr> <tr> <td>float Row height in points</td> <td>1</td> </tr> <tr> <td>int Horizontal measured in pixels</td> <td>1</td> </tr> <tr> <td>int Vertical distance measured in pixels</td> <td>1</td> </tr> <tr> <td>int Excel base date (1900 or 1904)</td> <td>1</td> </tr> <tr> <td>DateTimeZone The timezone being used as default for Excel timestamp to PHP DateTime object</td> <td>1</td> </tr> <tr> <td>\DateTime PHP date/time object</td> <td>1</td> </tr> <tr> <td>int Unix timetamp for this date/time</td> <td>1</td> </tr> <tr> <td>bool|float Excel date/time value</td> <td>1</td> </tr> <tr> <td>float Excel date/time value</td> <td>1</td> </tr> <tr> <td>false|float Excel date/time serial value</td> <td>1</td> </tr> <tr> <td>int|string Month number (1 - 12), or the original string argument if it isn't a valid month name</td> <td>1</td> </tr> <tr> <td>int|string The integer value with any ordinal stripped, or the original string argument if it isn't a valid numeric</td> <td>1</td> </tr> <tr> <td>string Timezone (e.g. 'Europe/London')</td> <td>1</td> </tr> <tr> <td>int Number of seconds for timezone adjustment</td> <td>1</td> </tr> <tr> <td>string Code Page Name</td> <td>1</td> </tr> <tr> <td>int Character count</td> <td>1</td> </tr> <tr> <td>string UTF-8 encoded string</td> <td>1</td> </tr> <tr> <td>mixed string or only the leading numeric part of the string</td> <td>1</td> </tr> <tr> <td>bool Y-Value</td> <td>1</td> </tr> <tr> <td>bool X-Value</td> <td>1</td> </tr> <tr> <td>float[] X-Values</td> <td>1</td> </tr> <tr> <td>float[]</td> <td>1</td> </tr> <tr> <td>Matrix U</td> <td>1</td> </tr> <tr> <td>array diagonal of S</td> <td>1</td> </tr> <tr> <td>Matrix S</td> <td>1</td> </tr> <tr> <td>float max(S)</td> <td>1</td> </tr> <tr> <td>float max(S)/min(S)</td> <td>1</td> </tr> <tr> <td>int Number of nonnegligible singular values</td> <td>1</td> </tr> <tr> <td>array Matrix array</td> <td>1</td> </tr> <tr> <td>int Row dimension</td> <td>1</td> </tr> <tr> <td>int Column dimension</td> <td>1</td> </tr> <tr> <td>Matrix Identity matrix</td> <td>1</td> </tr> <tr> <td>Matrix Diagonal matrix</td> <td>1</td> </tr> <tr> <td>Matrix Transposed matrix</td> <td>1</td> </tr> <tr> <td>float Sum of diagonal elements</td> <td>1</td> </tr> <tr> <td>Matrix Unary minus matrix</td> <td>1</td> </tr> <tr> <td>Matrix Matrix Cij</td> <td>1</td> </tr> <tr> <td>Matrix Product</td> <td>1</td> </tr> <tr> <td>Matrix ... Solution if A is square, least squares solution otherwise</td> <td>1</td> </tr> <tr> <td>Matrix ... Inverse(A) if A is square, pseudoinverse otherwise.</td> <td>1</td> </tr> <tr> <td>float Determinant</td> <td>1</td> </tr> <tr> <td>bool true if R, and hence A, has full rank, else false</td> <td>1</td> </tr> <tr> <td>Matrix Lower trapezoidal matrix whose columns define the reflections</td> <td>1</td> </tr> <tr> <td>Matrix upper triangular factor</td> <td>1</td> </tr> <tr> <td>Matrix orthogonal factor</td> <td>1</td> </tr> <tr> <td>Matrix matrix that minimizes the two norm of Q*R*X-B</td> <td>1</td> </tr> <tr> <td>array real(diag(D))</td> <td>1</td> </tr> <tr> <td>array imag(diag(D))</td> <td>1</td> </tr> <tr> <td>Matrix D</td> <td>1</td> </tr> <tr> <td>Matrix Lower triangular factor</td> <td>1</td> </tr> <tr> <td>Matrix Upper triangular factor</td> <td>1</td> </tr> <tr> <td>array Pivot vector</td> <td>1</td> </tr> <tr> <td>bool true if U, and hence A, is nonsingular</td> <td>1</td> </tr> <tr> <td>array d matrix deterninat</td> <td>1</td> </tr> <tr> <td>Matrix X so that L*U*X = B(piv,:)</td> <td>1</td> </tr> <tr> <td>Matrix Lower triangular matrix</td> <td>1</td> </tr> <tr> <td>Matrix L * L' * X = B</td> <td>1</td> </tr> <tr> <td>bool TRUE if the file pointer is at EOF; otherwise FALSE</td> <td>1</td> </tr> <tr> <td>int The amount of data (in bytes)</td> <td>1</td> </tr> <tr> <td>string The binary string</td> <td>1</td> </tr> <tr> <td>int The index for this PPS</td> <td>1</td> </tr> <tr> <td>float[] The array of numbers</td> <td>1</td> </tr> <tr> <td>DggContainer\BstoreContainer</td> <td>1</td> </tr> <tr> <td>null|\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer</td> <td>1</td> </tr> <tr> <td>SpgrContainer\SpContainer[]</td> <td>1</td> </tr> <tr> <td>SpgrContainer</td> <td>1</td> </tr> <tr> <td>int Nesting level</td> <td>1</td> </tr> <tr> <td>BstoreContainer\BSE[]</td> <td>1</td> </tr> <tr> <td>BSE\Blip</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE $parent</td> <td>1</td> </tr> <tr> <td>array of string</td> <td>1</td> </tr> <tr> <td>int Result of comparison (always -1 or 1, never zero!)</td> <td>1</td> </tr> <tr> <td>IValueBinder</td> <td>1</td> </tr> <tr> <td>bool Whether the coordinate represents a range of cells</td> <td>1</td> </tr> <tr> <td>string[] Array containing column and row (indexes 0 and 1)</td> <td>1</td> </tr> <tr> <td>string Absolute coordinate e.g. '$A' or '$1' or '$A$1'</td> <td>1</td> </tr> <tr> <td>string Absolute coordinate e.g. '$A$1'</td> <td>1</td> </tr> <tr> <td>array Array containing one or more arrays containing one or two coordinate strings</td> <td>1</td> </tr> <tr> <td>string String representation of $pRange</td> <td>1</td> </tr> <tr> <td>array Range dimension (width, height)</td> <td>1</td> </tr> <tr> <td>int Column index (A = 1)</td> <td>1</td> </tr> <tr> <td>array Array containing single cell references</td> <td>1</td> </tr> <tr> <td>array All individual cells in that range</td> <td>1</td> </tr> <tr> <td>array associative array mapping coordinate ranges to valuea</td> <td>1</td> </tr> <tr> <td>null|RichText|string Sanitized value</td> <td>1</td> </tr> <tr> <td>string Sanitized value</td> <td>1</td> </tr> <tr> <td>string Compatibility Mode</td> <td>1</td> </tr> <tr> <td>bool (Success or Failure)</td> <td>1</td> </tr> <tr> <td>string Return Date Format</td> <td>1</td> </tr> <tr> <td>string #N/A!</td> <td>1</td> </tr> <tr> <td>string #NUM!</td> <td>1</td> </tr> <tr> <td>string #NAME?</td> <td>1</td> </tr> <tr> <td>string #REF!</td> <td>1</td> </tr> <tr> <td>string #NULL!</td> <td>1</td> </tr> <tr> <td>string #VALUE!</td> <td>1</td> </tr> <tr> <td>bool TRUE if the year is a leap year, otherwise FALSE</td> <td>1</td> </tr> <tr> <td>int Number of days between the start date and the end date</td> <td>1</td> </tr> <tr> <td>int|string Number of days between start date and end date or an error</td> <td>1</td> </tr> <tr> <td>int|string Number of days between start date and end date</td> <td>1</td> </tr> <tr> <td>float|string fraction of the year, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Day of the month</td> <td>1</td> </tr> <tr> <td>int|string Day of the week value</td> <td>1</td> </tr> <tr> <td>int|string Month of the year</td> <td>1</td> </tr> <tr> <td>int|string Year</td> <td>1</td> </tr> <tr> <td>int|string Hour</td> <td>1</td> </tr> <tr> <td>int|string Minute</td> <td>1</td> </tr> <tr> <td>int|string Second</td> <td>1</td> </tr> <tr> <td>int|string Result, or a string containing an error</td> <td>1</td> </tr> <tr> <td>Logger</td> <td>1</td> </tr> <tr> <td>string locale-specific translation of TRUE</td> <td>1</td> </tr> <tr> <td>string locale-specific translation of FALSE</td> <td>1</td> </tr> <tr> <td>string $returnType Array return type</td> <td>1</td> </tr> <tr> <td>int[] An array comprising the number of rows, and number of columns</td> <td>1</td> </tr> <tr> <td>false|string False indicates an error</td> <td>1</td> </tr> <tr> <td>array of Category</td> <td>1</td> </tr> <tr> <td>bool True</td> <td>1</td> </tr> <tr> <td>bool False</td> <td>1</td> </tr> <tr> <td>bool|string the logical AND of the arguments</td> <td>1</td> </tr> <tr> <td>bool|string the logical OR of the arguments</td> <td>1</td> </tr> <tr> <td>bool|string the logical XOR of the arguments</td> <td>1</td> </tr> <tr> <td>bool|string the boolean inverse of the argument</td> <td>1</td> </tr> <tr> <td>mixed The value of returnIfTrue or returnIfFalse determined by condition</td> <td>1</td> </tr> <tr> <td>mixed The value of matched expression</td> <td>1</td> </tr> <tr> <td>FormulaToken[]</td> <td>1</td> </tr> <tr> <td>float 0 if x<0, p<=0, q<=0 or p+q>2.55E305 and 1 if x>1 to avoid errors and over/underflow</td> <td>1</td> </tr> <tr> <td>float 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow</td> <td>1</td> </tr> <tr> <td>float MAX_VALUE for x < 0.0 or when overflow would occur, i.e. x > 2.55E305</td> <td>1</td> </tr> <tr> <td>int|mixed</td> <td>1</td> </tr> <tr> <td>bool|float|string</td> <td>1</td> </tr> <tr> <td>int|string Number of permutations, or a string containing an error</td> <td>1</td> </tr> <tr> <td>float|string Standardized value, or a string containing an error</td> <td>1</td> </tr> <tr> <td>mixed[] Indexed on "real", "imaginary" and "suffix"</td> <td>1</td> </tr> <tr> <td>string The padded "number"</td> <td>1</td> </tr> <tr> <td>int|string the arabic numberal contrived from the roman numeral</td> <td>1</td> </tr> <tr> <td>float|string the inverse tangent of the specified x- and y-coordinates, or a string containing an error</td> <td>1</td> </tr> <tr> <td>string the text representation with the given radix (base)</td> <td>1</td> </tr> <tr> <td>int|string Number of combinations, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Factorial, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Double Factorial, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|mixed|string Greatest Common Divisor, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Integer value, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Lowest Common Multiplier, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int|string Remainder, or a string containing an error</td> <td>1</td> </tr> <tr> <td>int Random number</td> <td>1</td> </tr> <tr> <td>int|string sign value, or a string containing an error</td> <td>1</td> </tr> <tr> <td>float|string Square Root of Number * Pi, or a string containing an error</td> <td>1</td> </tr> <tr> <td>float|string Truncated value, or a string containing an error</td> <td>1</td> </tr> <tr> <td>float|string The secant of the angle</td> <td>1</td> </tr> <tr> <td>float|string The hyperbolic secant of the angle</td> <td>1</td> </tr> <tr> <td>float|string The cosecant of the angle</td> <td>1</td> </tr> <tr> <td>float|string The hyperbolic cosecant of the angle</td> <td>1</td> </tr> <tr> <td>float|string The cotangent of the angle</td> <td>1</td> </tr> <tr> <td>float|string The hyperbolic cotangent of the angle</td> <td>1</td> </tr> <tr> <td>float|string The arccotangent of the number</td> <td>1</td> </tr> <tr> <td>float|string The hyperbolic arccotangent of the number</td> <td>1</td> </tr> <tr> <td>int|int[]</td> <td>1</td> </tr> <tr> <td>int The number of columns in cellAddress</td> <td>1</td> </tr> <tr> <td>int or array of integer</td> <td>1</td> </tr> <tr> <td>int The number of rows in cellAddress</td> <td>1</td> </tr> <tr> <td>mixed The value of $displayName (or $linkURL if $displayName was blank)</td> <td>1</td> </tr> <tr> <td>mixed The cells referenced by cellAddress</td> <td>1</td> </tr> <tr> <td>string A reference to a cell or range of cells</td> <td>1</td> </tr> <tr> <td>mixed The selected value</td> <td>1</td> </tr> <tr> <td>int|string The relative position of the found item</td> <td>1</td> </tr> <tr> <td>mixed the value of a specified cell or array of cells</td> <td>1</td> </tr> <tr> <td>null|Ods\WriterPart</td> <td>1</td> </tr> <tr> <td>ZipArchive</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart</td> <td>1</td> </tr> <tr> <td>string The XF record</td> <td>1</td> </tr> <tr> <td>int Index to XF record</td> <td>1</td> </tr> <tr> <td>int Index to FONT record</td> <td>1</td> </tr> <tr> <td>int Color index</td> <td>1</td> </tr> <tr> <td>string Binary data for workbook stream</td> <td>1</td> </tr> <tr> <td>string The packed ptg for the function</td> <td>1</td> </tr> <tr> <td>mixed the packed ptgArea3d token on success</td> <td>1</td> </tr> <tr> <td>string The cell in packed() format with the corresponding ptg</td> <td>1</td> </tr> <tr> <td>mixed the packed ptgRef3d token on success</td> <td>1</td> </tr> <tr> <td>string The error code ptgErr</td> <td>1</td> </tr> <tr> <td>mixed The reference index in packed() format on success</td> <td>1</td> </tr> <tr> <td>int The sheet index, -1 if the sheet was not found</td> <td>1</td> </tr> <tr> <td>array Array containing the row and column in packed() format</td> <td>1</td> </tr> <tr> <td>array Array containing (row1,col1,row2,col2) in packed() format</td> <td>1</td> </tr> <tr> <td>mixed The checked token or false on failure</td> <td>1</td> </tr> <tr> <td>array The parsed ptg'd tree</td> <td>1</td> </tr> <tr> <td>array A tree</td> <td>1</td> </tr> <tr> <td>string The tree in reverse polish notation</td> <td>1</td> </tr> <tr> <td>string A very convenient string of continue blocks</td> <td>1</td> </tr> <tr> <td>string The data</td> <td>1</td> </tr> <tr> <td>Ods</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Drawing[] All drawings in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>XMLWriter XML Writer</td> <td>1</td> </tr> <tr> <td>Xlsx</td> <td>1</td> </tr> <tr> <td>string[] String table for worksheet</td> <td>1</td> </tr> <tr> <td>string Mime Type</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Style[] All styles in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>Conditional[] All conditional styles in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>Fill[] All fills in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>Font[] All fonts in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>Borders[] All borders in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>NumberFormat[] All number formats in PhpSpreadsheet</td> <td>1</td> </tr> <tr> <td>\Mpdf\Mpdf implementation</td> <td>1</td> </tr> <tr> <td>\Dompdf\Dompdf implementation</td> <td>1</td> </tr> <tr> <td>\TCPDF implementation</td> <td>1</td> </tr> <tr> <td>TextElement</td> <td>1</td> </tr> <tr> <td>Run</td> <td>1</td> </tr> <tr> <td>ITextElement[]</td> <td>1</td> </tr> <tr> <td>ITextElement</td> <td>1</td> </tr> <tr> <td>string[] [$name => $path]</td> <td>1</td> </tr> <tr> <td>Warning\Warning[]</td> <td>1</td> </tr> <tr> <td>\Egulias\EmailValidator\Warning\Warning[]</td> <td>1</td> </tr> <tr> <td>Warning[]</td> <td>1</td> </tr> <tr> <td>bool True on success.</td> <td>1</td> </tr> <tr> <td>bool True if valid.</td> <td>1</td> </tr> <tr> <td>InvalidEmail[]</td> <td>1</td> </tr> <tr> <td>\Egulias\EmailValidator\Exception\InvalidEmail[]</td> <td>1</td> </tr> <tr> <td>MultipleErrors|null</td> <td>1</td> </tr> <tr> <td>int The number of successful recipients. Can be 0 which indicates failure</td> <td>1</td> </tr> <tr> <td>Swift_Mime_EmbeddedFile</td> <td>1</td> </tr> <tr> <td>bool TRUE if the transport is alive</td> <td>1</td> </tr> <tr> <td>bool|null a boolean if pipelining is explicitly enabled or disabled,</td> <td>1</td> </tr> <tr> <td>Swift_Transport_EsmtpHandler[]</td> <td>1</td> </tr> <tr> <td>Swift_Transport[]</td> <td>1</td> </tr> <tr> <td>Swift_Spool</td> <td>1</td> </tr> <tr> <td>Swift_Transport_Esmtp_Authenticator[]</td> <td>1</td> </tr> <tr> <td>bool true if authentication worked (returning false is deprecated, throw a Swift_TransportException instead)</td> <td>1</td> </tr> <tr> <td>string SMTP Response</td> <td>1</td> </tr> <tr> <td>array our response parsed</td> <td>1</td> </tr> <tr> <td>array array with length and offset</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMessage[]</td> <td>1</td> </tr> <tr> <td>int count</td> <td>1</td> </tr> <tr> <td>Swift_Mime_Headers_ParameterizedHeader</td> <td>1</td> </tr> <tr> <td>Swift_Mime_Header|null</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleHeaderSet</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMimeEntity[]</td> <td>1</td> </tr> <tr> <td>Swift_KeyCache</td> <td>1</td> </tr> <tr> <td>Swift_IdGenerator</td> <td>1</td> </tr> <tr> <td>Swift_Mime_HeaderEncoder</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMessage</td> <td>1</td> </tr> <tr> <td>Swift_TransportException</td> <td>1</td> </tr> <tr> <td>Swift_MimePart</td> <td>1</td> </tr> <tr> <td>string String in ODTsyntax format</td> <td>1</td> </tr> <tr> <td>string The converted text</td> <td>1</td> </tr> <tr> <td>string The requested variable of configuration</td> <td>1</td> </tr> <tr> <td>string le chemin vers le fichier temporaire de travail</td> <td>1</td> </tr> <tr> <td>string The value inside the balise</td> <td>1</td> </tr> <tr> <td>bool true if openning has succeeded</td> <td>1</td> </tr> <tr> <td>string the content of the file in a string</td> <td>1</td> </tr> <tr> <td>bool true</td> <td>1</td> </tr> <tr> <td>mixed data which can be serialized by <b>json_encode</b>,</td> <td>1</td> </tr> <tr> <td>string api path</td> <td>1</td> </tr> <tr> <td>iFormat any class that implements iFormat</td> <td>1</td> </tr> <tr> <td>array php data</td> <td>1</td> </tr> <tr> <td>iFormat</td> <td>1</td> </tr> <tr> <td>null|mixed</td> <td>1</td> </tr> <tr> <td>string|boolean returns the class name or false</td> <td>1</td> </tr> <tr> <td>array details array</td> <td>1</td> </tr> <tr> <td>null|stdClass</td> <td>1</td> </tr> <tr> <td>\stdClass</td> <td>1</td> </tr> <tr> <td>boolean True if the user should be able to view this API's docs</td> <td>1</td> </tr> <tr> <td>bool true or false</td> <td>1</td> </tr> <tr> <td>null|mixed null when not found, value otherwise</td> <td>1</td> </tr> <tr> <td>array with 2 strings first is the common string and second is the remaining in $fromPath</td> <td>1</td> </tr> <tr> <td>string which will be one of the following</td> <td>1</td> </tr> <tr> <td>array sorted by the priority</td> <td>1</td> </tr> <tr> <td>array associative array with the extracted values</td> <td>1</td> </tr> <tr> <td>string comments with out the tags</td> <td>1</td> </tr> <tr> <td>bool false if the path cannot be resolved</td> <td>1</td> </tr> <tr> <td>callable the one true auto loader.</td> <td>1</td> </tr> <tr> <td>mixed The known value for the key or false if key has no value</td> <td>1</td> </tr> <tr> <td>bool|mixed returns reference obtained from the include or false</td> <td>1</td> </tr> <tr> <td>bool false unless className now exists</td> <td>1</td> </tr> <tr> <td>bool false unless className exists</td> <td>1</td> </tr> <tr> <td>bool|mixed resolved include reference or false</td> <td>1</td> </tr> <tr> <td>bool whether the class/interface exists without calling auto loader</td> <td>1</td> </tr> <tr> <td>mixed|null the reference from the include or null</td> <td>1</td> </tr> <tr> <td>Tags|null</td> <td>1</td> </tr> <tr> <td>string generated form key</td> <td>1</td> </tr> <tr> <td>boolean true when api access is allowed false otherwise</td> <td>1</td> </tr> <tr> <td>string formatted json</td> <td>1</td> </tr> <tr> <td>bool false as HTML format is write only</td> <td>1</td> </tr> <tr> <td>string PHP source code to reproduce the configuration</td> <td>1</td> </tr> <tr> <td>array|bool|float|int|mixed|null|number|string</td> <td>1</td> </tr> <tr> <td>iValueObject</td> <td>1</td> </tr> <tr> <td>boolean false in case of failure or fixed value in the expected</td> <td>1</td> </tr> <tr> <td>Imagick Loaded image</td> <td>1</td> </tr> <tr> <td>string raster data from the image</td> <td>1</td> </tr> <tr> <td>array Array of images, retrieved from the PDF file.</td> <td>1</td> </tr> <tr> <td>Imagick Flattened image</td> <td>1</td> </tr> <tr> <td>int height of the image in pixels</td> <td>1</td> </tr> <tr> <td>int Width of the image</td> <td>1</td> </tr> <tr> <td>string The image in raster format.</td> <td>1</td> </tr> <tr> <td>string[] an array, one item per line of output. All lines will be of equal size.</td> <td>1</td> </tr> <tr> <td>NULL|string</td> <td>1</td> </tr> <tr> <td>boolean True if GD is loaded, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if Imagick is loaded, false otherwise</td> <td>1</td> </tr> <tr> <td>EscposImage</td> <td>1</td> </tr> <tr> <td>array Data for this encoding.</td> <td>1</td> </tr> <tr> <td>string|null Iconv encoding name, or null if not set.</td> <td>1</td> </tr> <tr> <td>string Unique identifier of the code page.</td> <td>1</td> </tr> <tr> <td>string Name of the code page.</td> <td>1</td> </tr> <tr> <td>string|null Notes on the code page, or null if not set.</td> <td>1</td> </tr> <tr> <td>boolean True if we can encode with this code page (ie, we know what data it holds).</td> <td>1</td> </tr> <tr> <td>array 128-entry array of code points</td> <td>1</td> </tr> <tr> <td>string Hash of the code page data structure, to identify it for caching.</td> <td>1</td> </tr> <tr> <td>array Associative array of CodePage objects, indicating which encodings the printer supports.</td> <td>1</td> </tr> <tr> <td>mixed feature value.</td> <td>1</td> </tr> <tr> <td>string ID of the profile.</td> <td>1</td> </tr> <tr> <td>string Name of the printer.</td> <td>1</td> </tr> <tr> <td>boolean True if Barcode B command is supported, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if Bit Image Raster command is supported, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if Graphics command is supported, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if PDF417 code command is supported, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if QR code command is supported, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if Star mode commands are supported, false otherwise</td> <td>1</td> </tr> <tr> <td>string Vendor of this printer.</td> <td>1</td> </tr> <tr> <td>array Three most similar feature names that do exist.</td> <td>1</td> </tr> <tr> <td>array Names of all profiles that exist.</td> <td>1</td> </tr> <tr> <td>CapabilityProfile The CapabilityProfile that was requested.</td> <td>1</td> </tr> <tr> <td>array Three similar profile names that do exist, plus 'simple' and 'default' for good measure.</td> <td>1</td> </tr> <tr> <td>PrintBuffer</td> <td>1</td> </tr> <tr> <td>PrintConnector</td> <td>1</td> </tr> <tr> <td>CapabilityProfile</td> <td>1</td> </tr> <tr> <td>boolean|integer Code page number, or FALSE if the text is not</td> <td>1</td> </tr> <tr> <td>boolean True if the character is printable, false if it is not.</td> <td>1</td> </tr> <tr> <td>string Current platform. Separated out for testing purposes.</td> <td>1</td> </tr> <tr> <td>boolean True if copy was successful, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean True if write was successful, false otherwise</td> <td>1</td> </tr> <tr> <td>array A list of printer names installed on this system. Any item</td> <td>1</td> </tr> <tr> <td>string the string, up to the first space, or the whole string if it contains no spaces.</td> <td>1</td> </tr> <tr> <td>int|float|null</td> <td>1</td> </tr> <tr> <td>\Generator</td> <td>1</td> </tr> <tr> <td>\Carbon\CarbonInterface</td> <td>1</td> </tr> <tr> <td>Macro</td> <td>1</td> </tr> <tr> <td>array 0-index is integer part, 1-index is decimal part digits</td> <td>1</td> </tr> <tr> <td>Closure</td> <td>1</td> </tr> <tr> <td>Carbon|CarbonImmutable</td> <td>1</td> </tr> <tr> <td>LocaleAwareInterface|null</td> <td>1</td> </tr> <tr> <td>\Carbon\CarbonImmutable|\Carbon\Carbon|null</td> <td>1</td> </tr> <tr> <td>DateTimeInterface|false</td> <td>1</td> </tr> <tr> <td>class-string<CarbonImmutable></td> <td>1</td> </tr> <tr> <td>class-string<T></td> <td>1</td> </tr> <tr> <td>T|null</td> <td>1</td> </tr> <tr> <td>static[]</td> <td>1</td> </tr> <tr> <td>\Illuminate\Pagination\Cursor</td> <td>1</td> </tr> <tr> <td>\Illuminate\Database\Eloquent\Builder|void</td> <td>1</td> </tr> <tr> <td>string|\Illuminate\Contracts\Database\Eloquent\CastsAttributes|\Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Broadcasting\Broadcaster</td> <td>1</td> </tr> <tr> <td>\Illuminate\Broadcasting\Channel|\Illuminate\Broadcasting\Channel[]|string[]|string</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Cache\Repository</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Cache\Store</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard</td> <td>1</td> </tr> <tr> <td>int|string|null</td> <td>1</td> </tr> <tr> <td>resource|null The path resource or null on failure.</td> <td>1</td> </tr> <tr> <td>iterable</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Container\ContextualBindingBuilder</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Support\Htmlable|string</td> <td>1</td> </tr> <tr> <td>\Illuminate\Routing\PendingResourceRegistration</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Validation\Validator</td> <td>1</td> </tr> <tr> <td>\SessionHandlerInterface</td> <td>1</td> </tr> <tr> <td>\DateTimeInterface|int</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Stringable</td> <td>1</td> </tr> <tr> <td>array<int, string|null></td> <td>1</td> </tr> <tr> <td>\Dotenv\Repository\RepositoryInterface</td> <td>1</td> </tr> <tr> <td>\Doctrine\Inflector\Inflector</td> <td>1</td> </tr> <tr> <td>\Symfony\Component\Process\Process</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\HtmlString</td> <td>1</td> </tr> <tr> <td>never</td> <td>1</td> </tr> <tr> <td>$this|\Illuminate\Support\HigherOrderTapProxy</td> <td>1</td> </tr> <tr> <td>\Illuminate\Foundation\Bus\PendingChain</td> <td>1</td> </tr> <tr> <td>\Illuminate\Bus\Batch[]</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\MailFake</td> <td>1</td> </tr> <tr> <td>string|array|null</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\QueueFake</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\BusFake</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\NotificationFake</td> <td>1</td> </tr> <tr> <td>\Illuminate\Notifications\AnonymousNotifiable</td> <td>1</td> </tr> <tr> <td>\Mockery\Expectation</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\LazyCollection</td> <td>1</td> </tr> <tr> <td>\CachingIterator</td> <td>1</td> </tr> <tr> <td>callable</td> <td>1</td> </tr> <tr> <td>Carbon|null</td> <td>1</td> </tr> <tr> <td>Attribute|null</td> <td>1</td> </tr> <tr> <td>array The decoded elements are returned in an array of objects, where each</td> <td>1</td> </tr> <tr> <td>Part[]</td> <td>1</td> </tr> <tr> <td>MessageCollection|null</td> <td>1</td> </tr> <tr> <td>null|Message</td> <td>1</td> </tr> <tr> <td>Header</td> <td>1</td> </tr> <tr> <td>Structure|null</td> <td>1</td> </tr> <tr> <td>bool|Protocol|ProtocolInterface</td> <td>1</td> </tr> <tr> <td>FolderCollection</td> <td>1</td> </tr> <tr> <td>false|object</td> <td>1</td> </tr> <tr> <td>LegacyProtocol</td> <td>1</td> </tr> <tr> <td>resource|boolean The socket created.</td> <td>1</td> </tr> <tr> <td>array mailboxes that matched $folder as array(globalName => array('delim' => .., 'flags' => ..))</td> <td>1</td> </tr> <tr> <td>void|null|bool|array tokens if success, false if error, null if bad request</td> <td>1</td> </tr> <tr> <td>void|null|bool|array response as in readResponse()</td> <td>1</td> </tr> <tr> <td>string|array escape literals, literals with newline ar returned</td> <td>1</td> </tr> <tr> <td>string escaped list for imap</td> <td>1</td> </tr> <tr> <td>string|array if only one item of one message is fetched it's returned as string</td> <td>1</td> </tr> <tr> <td>Event</td> <td>1</td> </tr> <tr> <td>mixed The value of the item from the cache, or $default in case of cache miss.</td> <td>1</td> </tr> <tr> <td>bool True if the item was successfully removed. False if there was an error.</td> <td>1</td> </tr> <tr> <td>iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.</td> <td>1</td> </tr> <tr> <td>bool True if the items were successfully removed. False if there was an error.</td> <td>1</td> </tr> <tr> <td>array The cloned variable represented in an array</td> <td>1</td> </tr> <tr> <td>array The object casted as array</td> <td>1</td> </tr> <tr> <td>array The resource casted as array</td> <td>1</td> </tr> <tr> <td>array The casted object/resource</td> <td>1</td> </tr> <tr> <td>array The raw data structure</td> <td>1</td> </tr> <tr> <td>self|null A clone of $this of null if the key is not set</td> <td>1</td> </tr> <tr> <td>int The final number of removed items</td> <td>1</td> </tr> <tr> <td>array The filtered array</td> <td>1</td> </tr> <tr> <td>array The array-cast of the object, with prefixed dynamic properties</td> <td>1</td> </tr> <tr> <td>callable|resource|string The previous output destination</td> <td>1</td> </tr> <tr> <td>string The previous charset</td> <td>1</td> </tr> <tr> <td>string The indent pad</td> <td>1</td> </tr> <tr> <td>string|null The dump as string when $output is true</td> <td>1</td> </tr> <tr> <td>string The string converted to UTF-8</td> <td>1</td> </tr> <tr> <td>string The value with style decoration</td> <td>1</td> </tr> <tr> <td>bool Tells if the current output stream supports ANSI colors or not</td> <td>1</td> </tr> <tr> <td>string The version number in semantic version format.</td> <td>1</td> </tr> <tr> <td>string|null The value of the header.</td> <td>1</td> </tr> <tr> <td>array List of HTTP headers.</td> <td>1</td> </tr> <tr> <td>boolean If there were CloudFront headers to be set</td> <td>1</td> </tr> <tr> <td>string|null The user agent if it's set.</td> <td>1</td> </tr> <tr> <td>array List of phone devices.</td> <td>1</td> </tr> <tr> <td>array List of tablet devices.</td> <td>1</td> </tr> <tr> <td>array List of user agents.</td> <td>1</td> </tr> <tr> <td>array List of browsers / user agents.</td> <td>1</td> </tr> <tr> <td>array List of utilities.</td> <td>1</td> </tr> <tr> <td>array All the rules (but not extended).</td> <td>1</td> </tr> <tr> <td>array All the rules + extended.</td> <td>1</td> </tr> <tr> <td>array The list of mobile operating systems.</td> <td>1</td> </tr> <tr> <td>bool|int|null</td> <td>1</td> </tr> <tr> <td>string|float|false The version of the property we are trying to extract.</td> <td>1</td> </tr> <tr> <td>string One of the self::MOBILE_GRADE_* constants.</td> <td>1</td> </tr> <tr> <td>integer Debug level 0-9, where 0 turns off</td> <td>1</td> </tr> <tr> <td>int Debug level 0-9, where 0 turns off</td> <td>1</td> </tr> <tr> <td>string data as an XML comment</td> <td>1</td> </tr> <tr> <td>false|string error string or false</td> <td>1</td> </tr> <tr> <td>string (arraySimple|arrayStruct)</td> <td>1</td> </tr> <tr> <td>string The serialized element, possibly with child elements</td> <td>1</td> </tr> <tr> <td>string the message</td> <td>1</td> </tr> <tr> <td>string The formatted string</td> <td>1</td> </tr> <tr> <td>string contracted qname</td> <td>1</td> </tr> <tr> <td>string expanded qname</td> <td>1</td> </tr> <tr> <td>string The local part</td> <td>1</td> </tr> <tr> <td>false|string The prefix or false if there is no prefix</td> <td>1</td> </tr> <tr> <td>mixed The namespace, false if no namespace has the specified prefix</td> <td>1</td> </tr> <tr> <td>false|string The prefix, false if the namespace has no prefixes</td> <td>1</td> </tr> <tr> <td>string The time in ODBC canonical form with microseconds</td> <td>1</td> </tr> <tr> <td>string The output of var_dump</td> <td>1</td> </tr> <tr> <td>string The serialization of the fault instance.</td> <td>1</td> </tr> <tr> <td>string A type name for an unnamed type</td> <td>1</td> </tr> <tr> <td>string XML data</td> <td>1</td> </tr> <tr> <td>string I/O method to use (socket|curl|unknown)</td> <td>1</td> </tr> <tr> <td>boolean true if connected, false if not</td> <td>1</td> </tr> <tr> <td>boolean true if OK, false if problem</td> <td>1</td> </tr> <tr> <td>string the response (also sets member variables like incoming_payload)</td> <td>1</td> </tr> <tr> <td>boolean whether the request was honored by this method.</td> <td>1</td> </tr> <tr> <td>array with data of that cookie</td> <td>1</td> </tr> <tr> <td>string for Cookie-HTTP-Header</td> <td>1</td> </tr> <tr> <td>boolean Whether the operation was found</td> <td>1</td> </tr> <tr> <td>false|void void or false on error</td> <td>1</td> </tr> <tr> <td>string serialization of WSDL</td> <td>1</td> </tr> <tr> <td>boolean whether they parameters are unwrapped (and should be wrapped)</td> <td>1</td> </tr> <tr> <td>string XML or empty if no Header</td> <td>1</td> </tr> <tr> <td>mixed PHP value</td> <td>1</td> </tr> <tr> <td>mixed PHP value</td> <td>1</td> </tr> <tr> <td>mixed response from SOAP call, normally an associative array mirroring the structure of the XML response, false for certain fatal errors</td> <td>1</td> </tr> <tr> <td>array|false array of data pertaining to the operation, false on error or no data</td> <td>1</td> </tr> <tr> <td>mixed native PHP types.</td> <td>1</td> </tr> <tr> <td>mixed value of the message, decoded into a PHP type</td> <td>1</td> </tr> <tr> <td>object soap_proxy object</td> <td>1</td> </tr> <tr> <td>boolean if cookie-set was successful returns true, else false</td> <td>1</td> </tr> <tr> <td>array with all internal cookies</td> <td>1</td> </tr> <tr> <td>string The filename used to cache the instance</td> <td>1</td> </tr> <tr> <td>object wsdl The cached wsdl instance, null if the instance is not in the cache</td> <td>1</td> </tr> <tr> <td>boolean Lock successfully obtained ?!</td> <td>1</td> </tr> <tr> <td>boolean WSDL successfully cached</td> <td>1</td> </tr> <tr> <td>boolean Lock successfully released</td> <td>1</td> </tr> <tr> <td>boolean Whether there was an instance to remove</td> <td>1</td> </tr> <tr> <td>mixed Parameter value</td> <td>1</td> </tr> <tr> <td>mixed True on success or PEAR_Error object</td> <td>1</td> </tr> <tr> <td>string Text body</td> <td>1</td> </tr> <tr> <td>string HTML body</td> <td>1</td> </tr> <tr> <td>mixed True on success or PEAR_Error object</td> <td>1</td> </tr> <tr> <td>string Contents of $file_name</td> <td>1</td> </tr> <tr> <td>object The text mimePart object</td> <td>1</td> </tr> <tr> <td>object The html mimePart object</td> <td>1</td> </tr> <tr> <td>object The multipart/mixed mimePart object</td> <td>1</td> </tr> <tr> <td>mixed The complete e-mail or PEAR error object</td> <td>1</td> </tr> <tr> <td>mixed The e-mail body or PEAR error object</td> <td>1</td> </tr> <tr> <td>mixed The MIME message content string, null or PEAR error object</td> <td>1</td> </tr> <tr> <td>array Assoc array with the mime headers</td> <td>1</td> </tr> <tr> <td>string Plain text headers</td> <td>1</td> </tr> <tr> <td>string Encoded data</td> <td>1</td> </tr> <tr> <td>array Encoded data</td> <td>1</td> </tr> <tr> <td>string Basename</td> <td>1</td> </tr> <tr> <td>array Headers array</td> <td>1</td> </tr> <tr> <td>An associative array containing two elements,</td> <td>1</td> </tr> <tr> <td>array An associative array containing message headers</td> <td>1</td> </tr> <tr> <td>array True on sucess or PEAR error object</td> <td>1</td> </tr> <tr> <td>Mail_mimePart A reference to the part you just added. In PHP4, it is</td> <td>1</td> </tr> <tr> <td>string Encoded data or PEAR error object</td> <td>1</td> </tr> <tr> <td>string Encoded data</td> <td>1</td> </tr> <tr> <td>string Parameter line</td> <td>1</td> </tr> <tr> <td>array String tokens array</td> <td>1</td> </tr> <tr> <td>string Encoded header data</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentMethod the attached payment method</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentMethod the detached payment method</td> <td>1</td> </tr> <tr> <td>\Stripe\Subscription the updated subscription</td> <td>1</td> </tr> <tr> <td>\Stripe\Subscription the canceled subscription</td> <td>1</td> </tr> <tr> <td>\Stripe\Subscription the resumed subscription</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Subscription> the subscription search results</td> <td>1</td> </tr> <tr> <td>\Stripe\EphemeralKey the created key</td> <td>1</td> </tr> <tr> <td>\Stripe\Payout the reversed payout</td> <td>1</td> </tr> <tr> <td>\Stripe\Payout the canceled payout</td> <td>1</td> </tr> <tr> <td>\Stripe\Refund the canceled refund</td> <td>1</td> </tr> <tr> <td>string the API URL for this tax id</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the applied payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the canceled payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the captured payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the confirmed payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the incremented payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent the verified payment intent</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<PaymentIntent> the payment intent search results</td> <td>1</td> </tr> <tr> <td>\Stripe\Util\Set A list of fields that can be their own type of</td> <td>1</td> </tr> <tr> <td>ApiResource the refreshed resource</td> <td>1</td> </tr> <tr> <td>string the endpoint URL for the given class</td> <td>1</td> </tr> <tr> <td>string the instance endpoint URL for the given class</td> <td>1</td> </tr> <tr> <td>string the full API URL for this API resource</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Product> the product search results</td> <td>1</td> </tr> <tr> <td>\Stripe\Charge the captured charge</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Charge> the charge search results</td> <td>1</td> </tr> <tr> <td>\Stripe\Review the approved review</td> <td>1</td> </tr> <tr> <td>\Stripe\Topup the canceled topup</td> <td>1</td> </tr> <tr> <td>int the timestamp contained in the header, or -1 if no valid</td> <td>1</td> </tr> <tr> <td>array the list of signatures matching the provided scheme</td> <td>1</td> </tr> <tr> <td>string the signature as a string</td> <td>1</td> </tr> <tr> <td>SearchResult</td> <td>1</td> </tr> <tr> <td>\Stripe\File the created file</td> <td>1</td> </tr> <tr> <td>\Stripe\Account the rejected account</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Capability> the list of capabilities</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card> the list of external accounts (BankAccount or Card)</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Person> the list of persons</td> <td>1</td> </tr> <tr> <td>string the endpoint associated with this singleton API resource</td> <td>1</td> </tr> <tr> <td>string the endpoint associated with this singleton class</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\UsageRecordSummary> the list of usage record summaries</td> <td>1</td> </tr> <tr> <td>\Stripe\Dispute the closed dispute</td> <td>1</td> </tr> <tr> <td>ApiResource|array|mixed|string</td> <td>1</td> </tr> <tr> <td>array tuple containing (ApiReponse, API key)</td> <td>1</td> </tr> <tr> <td>Exception\ApiErrorException</td> <td>1</td> </tr> <tr> <td>Exception\OAuth\OAuthErrorException</td> <td>1</td> </tr> <tr> <td>\CURLFile|string</td> <td>1</td> </tr> <tr> <td>HttpClient\ClientInterface</td> <td>1</td> </tr> <tr> <td>HttpClient\StreamingClientInterface</td> <td>1</td> </tr> <tr> <td>\Stripe\SetupIntent the canceled setup intent</td> <td>1</td> </tr> <tr> <td>\Stripe\SetupIntent the confirmed setup intent</td> <td>1</td> </tr> <tr> <td>\Stripe\SetupIntent the verified setup intent</td> <td>1</td> </tr> <tr> <td>TransferReversal the saved reversal</td> <td>1</td> </tr> <tr> <td>string the API URL for this Stripe transfer reversal</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TransferReversal> the list of transfer reversals</td> <td>1</td> </tr> <tr> <td>Util\Set Set of additive parameters</td> <td>1</td> </tr> <tr> <td>Util\Set Attributes that should not be sent to the API because</td> <td>1</td> </tr> <tr> <td>static the object constructed from the given values</td> <td>1</td> </tr> <tr> <td>array a recursive mapping of attributes to values for this object,</td> <td>1</td> </tr> <tr> <td>array the associative array</td> <td>1</td> </tr> <tr> <td>string the JSON representation of the Stripe object</td> <td>1</td> </tr> <tr> <td>null|ApiResponse The last response from the Stripe API</td> <td>1</td> </tr> <tr> <td>bool whether the resource is deleted</td> <td>1</td> </tr> <tr> <td>\Stripe\CreditNote the previewed credit note</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CreditNoteLineItem> list of CreditNoteLineItems</td> <td>1</td> </tr> <tr> <td>\Stripe\CreditNote the voided credit note</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CreditNoteLineItem> the list of credit note line items</td> <td>1</td> </tr> <tr> <td>\Stripe\Customer the updated customer</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\PaymentMethod> list of PaymentMethods</td> <td>1</td> </tr> <tr> <td>\Stripe\Customer the retrieved customer</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Customer> the customer search results</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CustomerBalanceTransaction> the list of customer balance transactions</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CustomerCashBalanceTransaction> the list of customer cash balance transactions</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card|\Stripe\Source> the list of payment sources (BankAccount, Card or Source)</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TaxId> the list of tax ids</td> <td>1</td> </tr> <tr> <td>ApplicationFeeRefund the saved refund</td> <td>1</td> </tr> <tr> <td>string the API URL for this Stripe refund</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Price> the price search results</td> <td>1</td> </tr> <tr> <td>Event the Event instance</td> <td>1</td> </tr> <tr> <td>\Stripe\Quote the accepted quote</td> <td>1</td> </tr> <tr> <td>\Stripe\Quote the canceled quote</td> <td>1</td> </tr> <tr> <td>\Stripe\Quote the finalized quote</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the uncollectible invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the finalized invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the paid invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the sent invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the upcoming invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\InvoiceLineItem> list of InvoiceLineItems</td> <td>1</td> </tr> <tr> <td>\Stripe\Invoice the voided invoice</td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<Invoice> the invoice search results</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\LineItem> the list of line items</td> <td>1</td> </tr> <tr> <td>\Stripe\Source the detached source</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SourceTransaction> list of SourceTransactions</td> <td>1</td> </tr> <tr> <td>\Stripe\Source the verified source</td> <td>1</td> </tr> <tr> <td>BankAccount the verified bank account</td> <td>1</td> </tr> <tr> <td>string the client_id used for Connect requests</td> <td>1</td> </tr> <tr> <td>string the API key used for requests</td> <td>1</td> </tr> <tr> <td>Util\LoggerInterface the logger to which the library will</td> <td>1</td> </tr> <tr> <td>string The API version used for requests. null if we're using the</td> <td>1</td> </tr> <tr> <td>null|string The Stripe account ID for connected account</td> <td>1</td> </tr> <tr> <td>null|array The application's information</td> <td>1</td> </tr> <tr> <td>int Maximum number of request retries</td> <td>1</td> </tr> <tr> <td>float Maximum delay between retries, in seconds</td> <td>1</td> </tr> <tr> <td>float Maximum delay between retries, in seconds, that will be respected from the Stripe API</td> <td>1</td> </tr> <tr> <td>float Initial delay between retries, in seconds</td> <td>1</td> </tr> <tr> <td>bool Whether client telemetry is enabled</td> <td>1</td> </tr> <tr> <td>\Stripe\SubscriptionSchedule the canceled subscription schedule</td> <td>1</td> </tr> <tr> <td>\Stripe\SubscriptionSchedule the released subscription schedule</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ApplicationFeeRefund> the list of fee refunds</td> <td>1</td> </tr> <tr> <td>string The class URL for this resource. It needs to be special</td> <td>1</td> </tr> <tr> <td>static the updated resource</td> <td>1</td> </tr> <tr> <td>static the saved resource</td> <td>1</td> </tr> <tr> <td>static the created resource</td> <td>1</td> </tr> <tr> <td>static the deleted resource</td> <td>1</td> </tr> <tr> <td>null|callable</td> <td>1</td> </tr> <tr> <td>\Stripe\Identity\VerificationSession the redacted verification session</td> <td>1</td> </tr> <tr> <td>\Stripe\Identity\VerificationSession the canceled verification session</td> <td>1</td> </tr> <tr> <td>ArrayIterator</td> <td>1</td> </tr> <tr> <td>array|StripeObject</td> <td>1</td> </tr> <tr> <td>bool true if the given object is a list</td> <td>1</td> </tr> <tr> <td>mixed|string the UTF8-encoded string, or the object passed in if</td> <td>1</td> </tr> <tr> <td>bool true if the strings are equal, false otherwise</td> <td>1</td> </tr> <tr> <td>string the URL-encoded string</td> <td>1</td> </tr> <tr> <td>int current time in millis</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FinancialConnections\AccountOwner> list of BankConnectionsResourceOwners</td> <td>1</td> </tr> <tr> <td>\Stripe\FinancialConnections\Account the disconnected account</td> <td>1</td> </tr> <tr> <td>\Stripe\FinancialConnections\Account the refreshed account</td> <td>1</td> </tr> <tr> <td>\Stripe\TestHelpers\TestClock the advanced test clock</td> <td>1</td> </tr> <tr> <td>\Stripe\Issuing\Dispute the submited dispute</td> <td>1</td> </tr> <tr> <td>\Stripe\Issuing\Authorization the declined authorization</td> <td>1</td> </tr> <tr> <td>\Stripe\Issuing\Authorization the approved authorization</td> <td>1</td> </tr> <tr> <td>\Stripe\Terminal\Reader the canceled reader</td> <td>1</td> </tr> <tr> <td>\Stripe\Terminal\Reader the refunded reader</td> <td>1</td> </tr> <tr> <td>\Stripe\Terminal\Reader the seted reader</td> <td>1</td> </tr> <tr> <td>\Stripe\Checkout\Session the expired session</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Topup></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Price></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Price></td> <td>1</td> </tr> <tr> <td>\Stripe\StripeObject the object returned by Stripe's Connect API</td> <td>1</td> </tr> <tr> <td>\Stripe\Util\RequestOptions</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Dispute></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\PaymentIntent></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\PaymentIntent></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Capability></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Account></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Person></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TransferReversal></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Transfer></td> <td>1</td> </tr> <tr> <td>\Stripe\AccountLink</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FileLink></td> <td>1</td> </tr> <tr> <td>\Stripe\TaxCode</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TaxCode></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ApplicationFeeRefund></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ApplicationFee></td> <td>1</td> </tr> <tr> <td>\Stripe\ApplicationFee</td> <td>1</td> </tr> <tr> <td>\Stripe\StripeClientInterface</td> <td>1</td> </tr> <tr> <td>\Stripe\StripeStreamingClientInterface</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SubscriptionSchedule></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ApplePayDomain></td> <td>1</td> </tr> <tr> <td>\Stripe\Balance</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\PromotionCode></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Subscription></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Subscription></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Event></td> <td>1</td> </tr> <tr> <td>\Stripe\Event</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\File></td> <td>1</td> </tr> <tr> <td>\Stripe\BalanceTransaction</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BalanceTransaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\PaymentLink></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Review></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SourceTransaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\WebhookEndpoint></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SetupAttempt></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CreditNote></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ShippingRate></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Refund></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Quote></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Coupon></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Product></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Product></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SubscriptionItem></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\UsageRecordSummary></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\InvoiceItem></td> <td>1</td> </tr> <tr> <td>\Stripe\Mandate</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Plan></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\SetupIntent></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\ExchangeRate></td> <td>1</td> </tr> <tr> <td>\Stripe\ExchangeRate</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CustomerBalanceTransaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Customer></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CustomerCashBalanceTransaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card|\Stripe\Source></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TaxId></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Customer></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TaxRate></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Invoice></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Invoice></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Charge></td> <td>1</td> </tr> <tr> <td>\Stripe\SearchResult<\Stripe\Charge></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Payout></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CountrySpec></td> <td>1</td> </tr> <tr> <td>\Stripe\CountrySpec</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Reporting\ReportRun></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Reporting\ReportType></td> <td>1</td> </tr> <tr> <td>\Stripe\Reporting\ReportType</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Identity\VerificationSession></td> <td>1</td> </tr> <tr> <td>\Stripe\Identity\VerificationReport</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Identity\VerificationReport></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FinancialConnections\AccountOwner></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\FinancialConnections\Account></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\TestHelpers\TestClock></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Issuing\Dispute></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Issuing\Card></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Issuing\Transaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Issuing\Cardholder></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Issuing\Authorization></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Terminal\Configuration></td> <td>1</td> </tr> <tr> <td>\Stripe\Terminal\ConnectionToken</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Terminal\Location></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Terminal\Reader></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\BillingPortal\Configuration></td> <td>1</td> </tr> <tr> <td>\Stripe\BillingPortal\Session</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Checkout\Session></td> <td>1</td> </tr> <tr> <td>\Stripe\Sigma\ScheduledQueryRun</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Sigma\ScheduledQueryRun></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\ReceivedCredit></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\TransactionEntry></td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\TransactionEntry</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\InboundTransfer></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\OutboundPayment></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\CreditReversal></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\FinancialAccount></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\Transaction></td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\Transaction</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\ReceivedDebit></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\OutboundTransfer></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Treasury\DebitReversal></td> <td>1</td> </tr> <tr> <td>\Stripe\Radar\EarlyFraudWarning</td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Radar\EarlyFraudWarning></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Radar\ValueList></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Radar\ValueListItem></td> <td>1</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\Apps\Secret></td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\OutboundPayment the canceled outbound payment</td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\InboundTransfer the canceled inbound transfer</td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\FinancialAccount the retrieved financial account</td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\FinancialAccount the updated financial account</td> <td>1</td> </tr> <tr> <td>\Stripe\Treasury\OutboundTransfer the canceled outbound transfer</td> <td>1</td> </tr> <tr> <td>\Stripe\Apps\Secret the finded secret</td> <td>1</td> </tr> <tr> <td>\Stripe\Apps\Secret the deleted secret</td> <td>1</td> </tr> <tr> <td>SignatureVerificationException</td> <td>1</td> </tr> <tr> <td>InvalidRequestException</td> <td>1</td> </tr> <tr> <td>null|\Stripe\ErrorObject</td> <td>1</td> </tr> <tr> <td>null|array|\Stripe\Util\CaseInsensitiveArray</td> <td>1</td> </tr> <tr> <td>null|array<string, mixed></td> <td>1</td> </tr> <tr> <td>CardException</td> <td>1</td> </tr> <tr> <td>DataCollectorInterface</td> <td>1</td> </tr> <tr> <td>array[DataCollectorInterface]</td> <td>1</td> </tr> <tr> <td>RequestIdGeneratorInterface</td> <td>1</td> </tr> <tr> <td>StorageInterface</td> <td>1</td> </tr> <tr> <td>JavascriptRenderer</td> <td>1</td> </tr> <tr> <td>array|\Assetic\Asset\AssetCollection</td> <td>1</td> </tr> <tr> <td>\Assetic\Asset\AssetCollection</td> <td>1</td> </tr> <tr> <td>string Return "{--DEBUGBAR_OB_START_REPLACE_ME--}" or return an empty string if $here == false</td> <td>1</td> </tr> <tr> <td>array key-value-pairs of replacements, key = path on server, value = replacement</td> <td>1</td> </tr> <tr> <td>array[\Throwable]</td> <td>1</td> </tr> <tr> <td>bool TRUE on success or FALSE on failure.</td> <td>1</td> </tr> <tr> <td>int|bool PDO::exec returns the number of rows that were modified or deleted by the</td> <td>1</td> </tr> <tr> <td>mixed A successful call returns the value of the requested PDO attribute.</td> <td>1</td> </tr> <tr> <td>bool TRUE if a transaction is currently active, and FALSE if not.</td> <td>1</td> </tr> <tr> <td>string If a sequence name was not specified for the name parameter, PDO::lastInsertId</td> <td>1</td> </tr> <tr> <td>TraceablePDOStatement|bool If the database server successfully prepares the statement,</td> <td>1</td> </tr> <tr> <td>TraceablePDOStatement|bool PDO::query returns a PDOStatement object, or FALSE on</td> <td>1</td> </tr> <tr> <td>string|bool A quoted string that is theoretically safe to pass into an SQL statement.</td> <td>1</td> </tr> <tr> <td>mixed The result of the call</td> <td>1</td> </tr> <tr> <td>\Exception</td> <td>1</td> </tr> <tr> <td>TestHandler|null</td> <td>1</td> </tr> <tr> <td>Logger|null</td> <td>1</td> </tr> <tr> <td>DebugBarHtmlDumper</td> <td>1</td> </tr> <tr> <td>VarCloner</td> <td>1</td> </tr> <tr> <td>string Serialized variable data.</td> <td>1</td> </tr> <tr> <td>array Default parameters for curl connection(s)</td> <td>1</td> </tr> <tr> <td>array status_code, response, header</td> <td>1</td> </tr> <tr> <td>string Version</td> <td>1</td> </tr> <tr> <td>SimpleXMLElement</td> <td>1</td> </tr> <tr> <td>string HTML output</td> <td>1</td> </tr> <tr> <td>string html previous link</td> <td>1</td> </tr> <tr> <td>string html next link</td> <td>1</td> </tr> <tr> <td>string previous url</td> <td>1</td> </tr> <tr> <td>string next url</td> <td>1</td> </tr> <tr> <td>int result of compare</td> <td>1</td> </tr> <tr> <td>object Object loaded</td> <td>1</td> </tr> <tr> <td>array Array of thirdparty objects</td> <td>1</td> </tr> <tr> <td>int ID of thirdparty</td> <td>1</td> </tr> <tr> <td>Object|false Updated object</td> <td>1</td> </tr> <tr> <td>Object Return the resulted third party.</td> <td>1</td> </tr> <tr> <td>Object Thirdparty data without useless information</td> <td>1</td> </tr> <tr> <td>array|void</td> <td>1</td> </tr> <tr> <td>array List of outstandings proposals of thirdparty</td> <td>1</td> </tr> <tr> <td>array List of outstandings orders of thirdparty</td> <td>1</td> </tr> <tr> <td>array List of outstandings invoices of thirdparty</td> <td>1</td> </tr> <tr> <td>array List of representatives of thirdparty</td> <td>1</td> </tr> <tr> <td>array List of fixed discount of thirdparty</td> <td>1</td> </tr> <tr> <td>object cleaned Societe object</td> <td>1</td> </tr> <tr> <td>int Id of third party</td> <td>1</td> </tr> <tr> <td>object data without useless information</td> <td>1</td> </tr> <tr> <td>Contact[] Array of contact objects</td> <td>1</td> </tr> <tr> <td>int ID of contact</td> <td>1</td> </tr> <tr> <td>Object|false Updated object, false when issue toupdate</td> <td>1</td> </tr> <tr> <td>int ID of user</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, > 0 if OK (ID of newly created company bank account information)</td> <td>1</td> </tr> <tr> <td>string RIB</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int >=0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of discount record if OK</td> <td>1</td> </tr> <tr> <td>float|int<-1,-1> Return integer <0 if KO, Credit note amount otherwise</td> <td>1</td> </tr> <tr> <td>array|int Array of sales representatives of the current third party or <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>array Array of contacts emails</td> <td>1</td> </tr> <tr> <td>array Array of contacts emails</td> <td>1</td> </tr> <tr> <td>array Array of contacts emails or mobile. Example: array(id=>'Name <email>')</td> <td>1</td> </tr> <tr> <td>array array of contacts</td> <td>1</td> </tr> <tr> <td>array $contacts array of contacts</td> <td>1</td> </tr> <tr> <td>string Email of contact with format: "Full name <email>"</td> <td>1</td> </tr> <tr> <td>string Bank label or RUM or '' if no bank account found</td> <td>1</td> </tr> <tr> <td>CompanyBankAccount[]|int Return 0 if KO, Array of CompanyBankAccount if OK</td> <td>1</td> </tr> <tr> <td>int 0 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if OK</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <0 if $type is not valid</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK or 1 if at some level a parent company was the child to compare to</td> <td>1</td> </tr> <tr> <td>boolean true if the ID must be unique</td> <td>1</td> </tr> <tr> <td>boolean True if exists, False if not</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Url or empty string if no URL known</td> <td>1</td> </tr> <tr> <td>bool true if the company has projects, false otherwise</td> <td>1</td> </tr> <tr> <td>boolean if a company: true || if a user: false</td> <td>1</td> </tr> <tr> <td>boolean true = country inside EEC, false = country outside EEC</td> <td>1</td> </tr> <tr> <td>int 0 if success, <> 0 if error</td> <td>1</td> </tr> <tr> <td>int 0 if success, <> 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of created account if OK</td> <td>1</td> </tr> <tr> <td>string Label of prospect status</td> <td>1</td> </tr> <tr> <td>string Label of prospection status</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Label of prospection status</td> <td>1</td> </tr> <tr> <td>bool True if success, False if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO >0 OK</td> <td>1</td> </tr> <tr> <td>array|int Array of contacts, -1 if error</td> <td>1</td> </tr> <tr> <td>int -1 if error, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Id of created event, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-2,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-2,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>ActionComm[]|string Error string if KO, array with actions if OK</td> <td>1</td> </tr> <tr> <td>WorkboardResponse|int<-1,1> Return integer <0 if KO, WorkboardResponse if OK</td> <td>1</td> </tr> <tr> <td>string String with status</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>array{picto:string,ref?:string,title?:string,labeltype?:string,location?:string,transparency?:string,space?:string,mailtopic?:string,mailfrom?:string,mailto?:string,mailcc?:string,description?:string,note?:string,categories?:string}</td> <td>1</td> </tr> <tr> <td>string Chaine avec URL</td> <td>1</td> </tr> <tr> <td>string HTML String</td> <td>1</td> </tr> <tr> <td>int<-1,1> -1 = error on build export file, 0 = export okay</td> <td>1</td> </tr> <tr> <td>int<1,1> >0 if ok</td> <td>1</td> </tr> <tr> <td>int<-1,max> < if OK, else count of number of reminders</td> <td>1</td> </tr> <tr> <td>int<-1,1>|string 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int<-1,1> 1 when update of the event was successful, otherwise -1</td> <td>1</td> </tr> <tr> <td>string|null Content of remote file read or null if error</td> <td>1</td> </tr> <tr> <td>array{0:string,1:int}|array{0:string,1:array<string,int|string>}</td> <td>1</td> </tr> <tr> <td>array|false</td> <td>1</td> </tr> <tr> <td>array Array of Agenda Events objects</td> <td>1</td> </tr> <tr> <td>int ID of Agenda Event</td> <td>1</td> </tr> <tr> <td>Object|false Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>int 1=ok, 0=not found, -1=error</td> <td>1</td> </tr> <tr> <td>array|int Array of all event types if OK, <0 if KO. Key of array is id or code depending on parameter $idorcode.</td> <td>1</td> </tr> <tr> <td>string|-1 Label of action type, or -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 = nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer if KO <0 , if OK >0</td> <td>1</td> </tr> <tr> <td>array|int -1 if KO, array with result if OK</td> <td>1</td> </tr> <tr> <td>array Array of invoices</td> <td>1</td> </tr> <tr> <td>array|int Array of invoices id</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <=0 if KO</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int >0 si ok, <0 si ko</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>1</td> </tr> <tr> <td>int ID of proposal</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Sql to use for the where condition</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int 1 if OK, 0 if error</td> <td>1</td> </tr> <tr> <td>int Nb of target with status</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string select field</td> <td>1</td> </tr> <tr> <td>string HTML combo</td> <td>1</td> </tr> <tr> <td>string HTML combo</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string RIB</td> <td>1</td> </tr> <tr> <td>boolean true = country inside EEC, false = country outside EEC</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int >= 0 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int 1 if user has permission, 0 if not.</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of created user if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if error, if OK returns id of created user</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, if OK, return id of created account</td> <td>1</td> </tr> <tr> <td>integer erreur <0, si ok renvoi le nbre de droits par default positions</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si echec, >=0 si ok</td> <td>1</td> </tr> <tr> <td>int|string If OK return clear password, 0 if no change (warning, you may retrieve 1 instead of 0 even if password was same), < 0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 si erreur, > 0 si ok</td> <td>1</td> </tr> <tr> <td>string chaine erreur</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 0=Valid, >0 if not valid</td> <td>1</td> </tr> <tr> <td>string String with URL link</td> <td>1</td> </tr> <tr> <td>array Table with attribute information</td> <td>1</td> </tr> <tr> <td>int Number of users</td> <td>1</td> </tr> <tr> <td>User[]|int<-1,-1></td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|array<int,array{rowid:int,id:int,fk_user:int,fk_soc:int,firstname:string,lastname:string,login:string,statut:int,entity:int,email:string,gender:string|int<-1,-1>,admin:int<0,1>,photo:string,fullpath:string,fullname:string,level:int}> Array of user information (also: $this->users). Note: $this->parentof is also set.</td> <td>1</td> </tr> <tr> <td>array Array of user id lower than user (all levels under user). This overwrite this->users.</td> <td>1</td> </tr> <tr> <td>int<-1,1> Return integer < 0 if KO (infinite loop), >= 0 if OK</td> <td>1</td> </tr> <tr> <td>string Email of user with format: "Full name <email>"</td> <td>1</td> </tr> <tr> <td>string Url string link</td> <td>1</td> </tr> <tr> <td>int Return integer <0 = user was not found, >0 = The id of the user</td> <td>1</td> </tr> <tr> <td>array|int Array of groups objects</td> <td>1</td> </tr> <tr> <td>mixed Array of users or -1 on error</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array|mixed data without useless information</td> <td>1</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>1</td> </tr> <tr> <td>Object Updated object</td> <td>1</td> </tr> <tr> <td>array Array of group objects</td> <td>1</td> </tr> <tr> <td>int 1 if success</td> <td>1</td> </tr> <tr> <td>object object of User objects</td> <td>1</td> </tr> <tr> <td>array Array of cleaned object properties</td> <td>1</td> </tr> <tr> <td>string Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, array of batch</td> <td>1</td> </tr> <tr> <td>int|array Return integer <0 if KO, array of batch</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 = action disabled, >0 if OK</td> <td>1</td> </tr> <tr> <td>int id of clone</td> <td>1</td> </tr> <tr> <td>int >1 if OK, <=0 if KO</td> <td>1</td> </tr> <tr> <td>int Id of product/service if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int 0 if OK</td> <td>1</td> </tr> <tr> <td>int 1 if OK, -1 if ref already exists, -2 if other error</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 = Not possible, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array Sell or eat by mandatory list</td> <td>1</td> </tr> <tr> <td>string Sell or eat by mandatory label</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO >0 OK</td> <td>1</td> </tr> <tr> <td>array Array of price information array('pu_ht'=> , 'pu_ttc'=> , 'tva_tx'=>'X.Y (code)', ...), 'tva_npr'=>0, ...)</td> <td>1</td> </tr> <tr> <td>int|string Return integer <-1 if KO, -1 if qty not enough, 0 if OK but nothing found, id_product if OK and found. May also initialize some properties like (->ref_supplier, buyprice, fourn_pu, vatrate_supplier...), or printable result of hook</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_mo, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_bom, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_propale, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_proposal_supplier, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>integer Array of stats in $this->stats_commande (nb=nb of order, qty=qty ordered), <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_commande_fournisseur, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_expedition, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_reception, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>integer Array of stats in $this->stats_mrptoproduce (nb=nb of order, qty=qty ordered), <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_contrat, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>int Array of stats in $this->stats_facture_fournisseur, <0 if ko or >0 if ok</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return 1 or 0; -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if link already exists for this product, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array of vendor ids</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 si erreur, > 0 si ok</td> <td>1</td> </tr> <tr> <td>array Array with tree</td> <td>1</td> </tr> <tr> <td>int Nb of father + child</td> <td>1</td> </tr> <tr> <td>int Number of variants</td> <td>1</td> </tr> <tr> <td>bool|int Return true if the product is a variant, false if not, -1 if error</td> <td>1</td> </tr> <tr> <td>array|int Array of product</td> <td>1</td> </tr> <tr> <td>array|int Return array(prodid=>array(0=prodid, 1=>qty, 2=>product type, 3=>label, 4=>incdec, 5=>product ref)</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>string|int Return label or ''. -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>1</td> </tr> <tr> <td>array Array with record into product_batch</td> <td>1</td> </tr> <tr> <td>array Array of photos</td> <td>1</td> </tr> <tr> <td>boolean True if it's a product</td> <td>1</td> </tr> <tr> <td>boolean True if mandatory_period set to 1</td> <td>1</td> </tr> <tr> <td>boolean True if it's has</td> <td>1</td> </tr> <tr> <td>string|int Return integer <0 if ko, label if ok</td> <td>1</td> </tr> <tr> <td>int Minimum recommended price that is higher price among all suppliers * PRODUCT_MINIMUM_RECOMMENDED_PRICE</td> <td>1</td> </tr> <tr> <td>int -1 KO, 1 OK</td> <td>1</td> </tr> <tr> <td>float|-1 Duration in hours if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>string full label with all parents, separated by ' >> '</td> <td>1</td> </tr> <tr> <td>string|-1</td> <td>1</td> </tr> <tr> <td>string HTML datalist</td> <td>1</td> </tr> <tr> <td>int Nb of loaded lines, 0 if nothing loaded, <0 if KO</td> <td>1</td> </tr> <tr> <td>array Array of product objects</td> <td>1</td> </tr> <tr> <td>int ID of product</td> <td>1</td> </tr> <tr> <td>array Array of product objects</td> <td>1</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>1</td> </tr> <tr> <td>float total amount of Stock Transfer</td> <td>1</td> </tr> <tr> <td>int 1 if ok, <= 0 if ko</td> <td>1</td> </tr> <tr> <td>int ID of warehouse</td> <td>1</td> </tr> <tr> <td>int Return >0 if OK, =<0 if KO</td> <td>1</td> </tr> <tr> <td>int Return >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array Array list of warehouses</td> <td>1</td> </tr> <tr> <td>string String full path to current warehouse separated by " >> "</td> <td>1</td> </tr> <tr> <td>integer[] $TChildWarehouses array which will contain all children</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int|string Return integer <0 if KO, 0 if fk_product is null or product id does not exists, >0 if OK, or printabl result of hook</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Number</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, -2 if we try to update a product_batchid that does not exist, else return productbatch id</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, number of equipment found if OK</td> <td>1</td> </tr> <tr> <td>int 1 if OK,-1 if KO</td> <td>1</td> </tr> <tr> <td>int ID of stock movement</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>int|array Return integer <0 if KO, array if OK</td> <td>1</td> </tr> <tr> <td>int New id of clone</td> <td>1</td> </tr> <tr> <td>PriceExpression[]|int Array of price expressions, <0 if ko</td> <td>1</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if OK but not found, > 0 rowid</td> <td>1</td> </tr> <tr> <td>string Translated error</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 1 if KO</td> <td>1</td> </tr> <tr> <td>int > 0 if OK, < 1 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK but no global variable found, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of price global variables, <0 if ko</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>1</td> </tr> <tr> <td>int > 0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int -1 if KO, array with result if OK</td> <td>1</td> </tr> <tr> <td>int 1 if ok, otherwise if error</td> <td>1</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int ID of supplier proposal</td> <td>1</td> </tr> <tr> <td>array Array of reception objects</td> <td>1</td> </tr> <tr> <td>int ID of reception created</td> <td>1</td> </tr> <tr> <td>string Free reference for contract</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si erreur, id reception creee si ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Status of reception if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, index of line if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if deletion done but failed to delete files, <0 if KO</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>string Libelle</td> <td>1</td> </tr> <tr> <td>boolean|DoliDB Boolean of DoliDB</td> <td>1</td> </tr> <tr> <td>mixed Boolean or string</td> <td>1</td> </tr> <tr> <td>int =0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int =0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int 1=exists, 0=does not exists, -1=error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>string SQL String. Example "select s.rowid as r_rowid, s.status as s_status from ..."</td> <td>1</td> </tr> <tr> <td>string SQL string of then field ex : "field='xxx'"</td> <td>1</td> </tr> <tr> <td>string html string of the input field ex : "<input type=text name=... value=...>"</td> <td>1</td> </tr> <tr> <td>string html string of the input field ex : "<input type=text name=... value=...>"</td> <td>1</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int ID of knowledgerecord</td> <td>1</td> </tr> <tr> <td>array array of values</td> <td>1</td> </tr> <tr> <td>array|mixed data without useless information</td> <td>1</td> </tr> <tr> <td>array Array of roles</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of created project if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, 0 if not found, <0 if KO</td> <td>1</td> </tr> <tr> <td>string Substitute key</td> <td>1</td> </tr> <tr> <td>mixed Array list of object ids linked to project, < 0 or string if error</td> <td>1</td> </tr> <tr> <td>integer The count of the linked elements (the count is zero on request error too)</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already closed, >0 if OK</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>int >0 if user has permission, <0 if user has no permission</td> <td>1</td> </tr> <tr> <td>array|string Array of projects id, or string with projects id separated with "," if list is 1</td> <td>1</td> </tr> <tr> <td>int New id of clone</td> <td>1</td> </tr> <tr> <td>int 1 if OK or < 0 if KO</td> <td>1</td> </tr> <tr> <td>array Children of this project as objects with rowid & title as members</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>array|int<-1,-1> Array of values or <0 if error</td> <td>1</td> </tr> <tr> <td>array Array with amount by month</td> <td>1</td> </tr> <tr> <td>array|int Array of values or <0 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|string Array of tasks</td> <td>1</td> </tr> <tr> <td>array|int Array (projectid => 'list of roles for project' or taskid => 'list of roles for task')</td> <td>1</td> </tr> <tr> <td>array Array of id of contacts</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, array of time spent if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of info for task array('min_date', 'max_date', 'total_duration', 'total_amount', 'nblines', 'nblinesnull')</td> <td>1</td> </tr> <tr> <td>array Array of info for task array('amount','nbseconds','nblinesnull')</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, array of time spent if OK</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>int -1 if error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si ko, rowid du bookmark cree si ok</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, > if OK</td> <td>1</td> </tr> <tr> <td>mixed New object created, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return >0 if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <=0 if OK, 0=Nothing done, >0 if KO</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>array|int array of lines if OK, <0 if KO</td> <td>1</td> </tr> <tr> <td>string Object free reference</td> <td>1</td> </tr> <tr> <td>array|int of positions of user with for each of them the job fetched into that array</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>Position|string Last occupied position</td> <td>1</td> </tr> <tr> <td>Position[] Array of occupied positions</td> <td>1</td> </tr> <tr> <td>array|int list of ids skillranks</td> <td>1</td> </tr> <tr> <td>Evaluation|null</td> <td>1</td> </tr> <tr> <td>int > 0 if ok, < 0 if ko</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 if KO, array of skill level found</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, id of fichinter if OK</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO, 0 if not found</td> <td>1</td> </tr> <tr> <td>int 1 if OK, < 0 if KO</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if OK: Id of line</td> <td>1</td> </tr> <tr> <td>string String with URL</td> <td>1</td> </tr> <tr> <td>array Array of order objects</td> <td>1</td> </tr> <tr> <td>int ID of intervention</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>float Amount</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>string Free reference for intervention</td> <td>1</td> </tr> <tr> <td>int >0 if ok, <0 if ko</td> <td>1</td> </tr> <tr> <td>int >0 if ok, <0 if ko</td> <td>1</td> </tr> <tr> <td>mixed $response</td> <td>1</td> </tr> <tr> <td>int if OK: 0 (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>array Array with key => EmailCollector object</td> <td>1</td> </tr> <tr> <td>string|false Encoded string, or false if error</td> <td>1</td> </tr> <tr> <td>int 0=OK, Nb of error if error</td> <td>1</td> </tr> <tr> <td>string Converted string if conversion was successful, or the original string if not</td> <td>1</td> </tr> <tr> <td>string Decoded subject (in UTF-8)</td> <td>1</td> </tr> <tr> <td>string UID as string</td> <td>1</td> </tr> <tr> <td>int Return integer <0 si erreur, id delivery cree si ok</td> <td>1</td> </tr> <tr> <td>integer Return integer <=0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>integer Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Product remaining to be delivered or <0 if KO</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Number of lines loaded, 0 if already loaded, <0 if KO</td> <td>1</td> </tr> <tr> <td>int Number of lines loaded, 0 if already loaded, <0 if KO</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>array|int Array of thirdparties object</td> <td>1</td> </tr> <tr> <td>array|int Array of contacts object</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>array<array{id:int,email:string,firstname:string,lastname:string,libelle:string,socid:int,code:string,status:int}> Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status</td> <td>1</td> </tr> <tr> <td>array Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status</td> <td>1</td> </tr> <tr> <td>array Array of contacts for tickets</td> <td>1</td> </tr> <tr> <td>array Array of contacts</td> <td>1</td> </tr> <tr> <td>array<int|array{source:string,id:int,rowid:int,email:string,civility:string,firstname:string,lastname:string,labeltype:string,libelle:string,socid:int,code:string,status:int,statuscontact:string,fk_c_typecontact:string,phone:string,phone_mobile:string,nom:string}>|int<-1,-1> Array of array('email'=>..., 'lastname'=>...)</td> <td>1</td> </tr> <tr> <td>string Reference</td> <td>1</td> </tr> <tr> <td>array|int Array with final path/name/mime of files.</td> <td>1</td> </tr> <tr> <td>boolean True if mail sent to at least one receiver, false otherwise</td> <td>1</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Title of action</td> <td>1</td> </tr> <tr> <td>array Array of ticket objects</td> <td>1</td> </tr> <tr> <td>array Array of values</td> <td>1</td> </tr> <tr> <td>array Array of values</td> <td>1</td> </tr> <tr> <td>array Array of values</td> <td>1</td> </tr> <tr> <td>string|array Value cleaned</td> <td>1</td> </tr> <tr> <td>boolean|string True if valid, False if not valid</td> <td>1</td> </tr> <tr> <td>string Forged criteria. Example: "t.field like 'abc%'"</td> <td>1</td> </tr> <tr> <td>array [List of ordering methods]</td> <td>1</td> </tr> <tr> <td>array [List of ordering reasons]</td> <td>1</td> </tr> <tr> <td>array [List of payment types]</td> <td>1</td> </tr> <tr> <td>array List of regions</td> <td>1</td> </tr> <tr> <td>array List of states</td> <td>1</td> </tr> <tr> <td>array List of countries</td> <td>1</td> </tr> <tr> <td>array [List of availability]</td> <td>1</td> </tr> <tr> <td>array List of events types</td> <td>1</td> </tr> <tr> <td>array List of expense report types</td> <td>1</td> </tr> <tr> <td>array List of Contacts types</td> <td>1</td> </tr> <tr> <td>array List of civility types</td> <td>1</td> </tr> <tr> <td>array List of currencies</td> <td>1</td> </tr> <tr> <td>array List of extra fields</td> <td>1</td> </tr> <tr> <td>array List of extra fields</td> <td>1</td> </tr> <tr> <td>array List of towns</td> <td>1</td> </tr> <tr> <td>array List of payment terms</td> <td>1</td> </tr> <tr> <td>array List of shipping methods</td> <td>1</td> </tr> <tr> <td>array List of measuring unit</td> <td>1</td> </tr> <tr> <td>array List of legal form</td> <td>1</td> </tr> <tr> <td>array List of staff</td> <td>1</td> </tr> <tr> <td>array List of social networks</td> <td>1</td> </tr> <tr> <td>array List of ticket categories</td> <td>1</td> </tr> <tr> <td>array List of ticket severities</td> <td>1</td> </tr> <tr> <td>array List of ticket types</td> <td>1</td> </tr> <tr> <td>array List of incoterm types</td> <td>1</td> </tr> <tr> <td>array|mixed Mysoc object</td> <td>1</td> </tr> <tr> <td>array List of establishments</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>string Data without useless information</td> <td>1</td> </tr> <tr> <td>array Result of file and setup integrity check</td> <td>1</td> </tr> <tr> <td>array Array of documents with path</td> <td>1</td> </tr> <tr> <td>array Array with data of file</td> <td>1</td> </tr> <tr> <td>string Html for body</td> <td>1</td> </tr> <tr> <td>Adherent</td> <td>1</td> </tr> <tr> <td>string String with Url</td> <td>1</td> </tr> <tr> <td>string Full address string</td> <td>1</td> </tr> <tr> <td>string Html for input with label</td> <td>1</td> </tr> <tr> <td>string Html for input date</td> <td>1</td> </tr> <tr> <td>string HTML select string.</td> <td>1</td> </tr> <tr> <td>string Output string with HTML link of documents (might be empty string). This also fill the array ->infofiles</td> <td>1</td> </tr> <tr> <td>string Return HTML string</td> <td>1</td> </tr> <tr> <td>Partnership</td> <td>1</td> </tr> <tr> <td>Commande</td> <td>1</td> </tr> <tr> <td>Context Instance</td> <td>1</td> </tr> <tr> <td>string Web Portal root url</td> <td>1</td> </tr> <tr> <td>int Third-party account id || <0 if error</td> <td>1</td> </tr> <tr> <td>Facture</td> <td>1</td> </tr> <tr> <td>Propal</td> <td>1</td> </tr> <tr> <td>bool True if template found, else false</td> <td>1</td> </tr> <tr> <td>array|string[][]</td> <td>1</td> </tr> <tr> <td>int if OK: >0 || if KO: <0</td> <td>1</td> </tr> <tr> <td>int If KO: <0 || if OK number of lines loaded</td> <td>1</td> </tr> <tr> <td>array Array of resources</td> <td>1</td> </tr> <tr> <td>int Nb of resources loaded</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if already loaded: 0 || Number of lines loaded</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>1</td> </tr> <tr> <td>string|array HTML string with</td> <td>1</td> </tr> <tr> <td>int >0 if OK, <0 if KO, 0 if not found</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>1</td> </tr> <tr> <td>int ID of partnership</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>1</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>1</td> </tr> <tr> <td>int ID of category</td> <td>1</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>1</td> </tr> <tr> <td>int -1 : SQL error</td> <td>1</td> </tr> <tr> <td>int 1 : OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 KO >0 OK</td> <td>1</td> </tr> <tr> <td>int 1 : OK, -1 : erreur SQL, -2 : id not defined, -3 : Already linked</td> <td>1</td> </tr> <tr> <td>int 1 if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>CommonObject[]|int[]|int Return -1 if KO, array of instance of object if OK</td> <td>1</td> </tr> <tr> <td>int Number of occurrences</td> <td>1</td> </tr> <tr> <td>int<-1,0>|array<int,array{id:int,fk_parent:int,label:string,description:string,color:string,position:int,socid:int,type:string,entity:int,array_options:array<string,mixed>,visible:int,ref_ext:string,multilangs?:array{string,array{label:string,description:string,note?:string}}}> Array of categories, 0 if no cat, -1 on error</td> <td>1</td> </tr> <tr> <td>array|int Return integer <0 KO, array ok</td> <td>1</td> </tr> <tr> <td>int<-1,-1>|array<int,array{rowid:int,id:int,fk_parent:int,label:string,description:string,color:string,position:string,visible:int,ref_ext:string,picto:string,fullpath:string,fulllabel:string}> Array of categories. this->cats and this->motherof are set, -1 on error</td> <td>1</td> </tr> <tr> <td>array|int Table of Object Category, -1 on error</td> <td>1</td> </tr> <tr> <td>integer 1 if record already exist, 0 otherwise, -1 if error</td> <td>1</td> </tr> <tr> <td>int|array Return integer <0 KO, array OK</td> <td>1</td> </tr> <tr> <td>Categorie[]|int Array of category objects or < 0 if KO</td> <td>1</td> </tr> <tr> <td>Categorie[]|int Array of Categorie, -1 if error</td> <td>1</td> </tr> <tr> <td>array Tableau de photos</td> <td>1</td> </tr> <tr> <td>string Label of contact status</td> <td>1</td> </tr> <tr> <td>string A additional SQL JOIN query</td> <td>1</td> </tr> <tr> <td>string A additional SQL SELECT query</td> <td>1</td> </tr> <tr> <td>int Number of categories, -1 on error</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>1</td> </tr> <tr> <td>string Relative physical path</td> <td>1</td> </tr> <tr> <td>array|int Tableau de array if OK, -1 if KO</td> <td>1</td> </tr> <tr> <td>int -1 if KO, Nb of files in directory if OK</td> <td>1</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>1</td> </tr> <tr> <td>string blockchain</td> <td>1</td> </tr> <tr> <td>string hash md5 of blockchain</td> <td>1</td> </tr> <tr> <td>int Always 1</td> <td>1</td> </tr> <tr> <td>string URL string of source object</td> <td>1</td> </tr> <tr> <td>string Value serialized, an object (stdClass)</td> <td>1</td> </tr> <tr> <td>object Value unserialized, an object (stdClass)</td> <td>1</td> </tr> <tr> <td>boolean|array True if OK, False if KO</td> <td>1</td> </tr> <tr> <td>string Key for signature</td> <td>1</td> </tr> <tr> <td>string Hash of previous record (if beforeid is defined) or hash of last record (if beforeid is 0)</td> <td>1</td> </tr> <tr> <td>BlockedLog[]|int<-2,-1> Array of object log or <0 if error</td> <td>1</td> </tr> <tr> <td>string Signature of genesis-block for current conf->entity</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>1</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>1</td> </tr> <tr> <td>string Label of status</td> <td>1</td> </tr> <tr> <td>string Stripe account 'acc_....' or '' if no OAuth token found</td> <td>1</td> </tr> <tr> <td>\Stripe\Customer|null Stripe Customer or null if not found</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentMethod|null Stripe PaymentMethod or null if not found</td> <td>1</td> </tr> <tr> <td>\Stripe\Terminal\Reader|null Stripe Reader or null if not found</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentIntent|null Stripe PaymentIntent or null if not found and failed to create</td> <td>1</td> </tr> <tr> <td>\Stripe\SetupIntent|null Stripe SetupIntent or null if not found and failed to create</td> <td>1</td> </tr> <tr> <td>\Stripe\Card|\Stripe\PaymentMethod|null Stripe Card or null if not found</td> <td>1</td> </tr> <tr> <td>\Stripe\PaymentMethod|null Stripe SEPA or null if not found</td> <td>1</td> </tr> <tr> <td>Stripe</td> <td>1</td> </tr> <tr> <td>int 0</td> <td>1</td> </tr> <tr> <td>list<string|int|null></td> <td>1</td> </tr> <tr> <td>list<Title|Text></td> <td>1</td> </tr> <tr> <td>list<FurtherInformation></td> <td>1</td> </tr> <tr> <td>array<string, string>|null</td> <td>1</td> </tr> <tr> <td>list<AlternativeScheme></td> <td>1</td> </tr> <tr> <td>\GeoIp2\Model\City a City model for the requested IP address</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Model\Country a Country model for the requested IP address</td> <td>1</td> </tr> <tr> <td>\MaxMind\Db\Reader\Metadata object for the database</td> <td>1</td> </tr> <tr> <td>array<int,string></td> <td>1</td> </tr> <tr> <td>int<-1,0></td> <td>1</td> </tr> <tr> <td>FuncCall|Equal|Concat|ArrayDimFetch|void</td> <td>1</td> </tr> <tr> <td>\PhpParser\Node|\PhpParser\Node[]|\PhpParser\Node\Expr\MethodCall|void|null| int</td> <td>1</td> </tr> <tr> <td>int 0=Nothing translated, 1=Record translated</td> <td>1</td> </tr> <tr> <td>string Key</td> <td>1</td> </tr> <tr> <td>string Value</td> <td>1</td> </tr> <tr> <td>string Value translated</td> <td>1</td> </tr> <tr> <td>stdClass</td> <td>2</td> </tr> <tr> <td>array{result:array{result_code:string,result_label:string},id?:int,ref?:string,ref_ext?:string} Array result</td> <td>2</td> </tr> <tr> <td>array array of new order</td> <td>2</td> </tr> <tr> <td>boolean true or false</td> <td>2</td> </tr> <tr> <td>boolean True or false</td> <td>2</td> </tr> <tr> <td>string Folder sanitized</td> <td>2</td> </tr> <tr> <td>string Result</td> <td>2</td> </tr> <tr> <td>string String encoded</td> <td>2</td> </tr> <tr> <td>string Parsed content</td> <td>2</td> </tr> <tr> <td>array Array of tabs to show</td> <td>2</td> </tr> <tr> <td>array head</td> <td>2</td> </tr> <tr> <td>array Array of tabs to shoc</td> <td>2</td> </tr> <tr> <td>array head array with tabs</td> <td>2</td> </tr> <tr> <td>array{encoding:string,bars:string,text:string}|false array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info)</td> <td>2</td> </tr> <tr> <td>array{encoding:string,bars:string,text:string,error:string}|array{text:string,error:string} array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info, 'error': error message if error)</td> <td>2</td> </tr> <tr> <td>array Array of head tabs</td> <td>2</td> </tr> <tr> <td>array head array with tabs</td> <td>2</td> </tr> <tr> <td>string A HTML table that contains a list with customer invoice drafts</td> <td>2</td> </tr> <tr> <td>string A HTML table that contains a list with open (unpaid) supplier invoices</td> <td>2</td> </tr> <tr> <td>array Tableau de version (vermajeur,vermineur,autre)</td> <td>2</td> </tr> <tr> <td>int -1 if KO, 1 if OK</td> <td>2</td> </tr> <tr> <td>string A HTML table that contains a pie chart of customer invoices</td> <td>2</td> </tr> <tr> <td>int Return integer < 0 if KO, Nb of events in file if OK</td> <td>2</td> </tr> <tr> <td>string String converted</td> <td>2</td> </tr> <tr> <td>string String with line</td> <td>2</td> </tr> <tr> <td>boolean Always true</td> <td>2</td> </tr> <tr> <td>bool|resource</td> <td>2</td> </tr> <tr> <td>string PHP version</td> <td>2</td> </tr> <tr> <td>string|array String or array</td> <td>2</td> </tr> <tr> <td>int|string Date as a timestamp, '' if error</td> <td>2</td> </tr> <tr> <td>string sql request</td> <td>2</td> </tr> <tr> <td>string[] Array of errors, or empty array if not virus found</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>2</td> </tr> <tr> <td>string|array Value sanitized (string or array). It may be '' if format check fails.</td> <td>2</td> </tr> <tr> <td>string A calculated prefix</td> <td>2</td> </tr> <tr> <td>string String cleaned (a-zA-Z_)</td> <td>2</td> </tr> <tr> <td>string Escaped string.</td> <td>2</td> </tr> <tr> <td>string String converted</td> <td>2</td> </tr> <tr> <td>string String converted</td> <td>2</td> </tr> <tr> <td>string Return img tag</td> <td>2</td> </tr> <tr> <td>string Return img tag</td> <td>2</td> </tr> <tr> <td>string String encoded</td> <td>2</td> </tr> <tr> <td>array head</td> <td>2</td> </tr> <tr> <td>array Tabs for the payment section</td> <td>2</td> </tr> <tr> <td>string Url string</td> <td>2</td> </tr> <tr> <td>int 0</td> <td>2</td> </tr> <tr> <td>int Nb of menu entries</td> <td>2</td> </tr> <tr> <td>array Array of tabs</td> <td>2</td> </tr> <tr> <td>array<string, string></td> <td>2</td> </tr> <tr> <td>array<string, mixed></td> <td>2</td> </tr> <tr> <td>mixed|bool false if the file could not be included.</td> <td>2</td> </tr> <tr> <td>false|string ISO 8601 date string or false</td> <td>2</td> </tr> <tr> <td>false|int Unix timestamp (int) or false</td> <td>2</td> </tr> <tr> <td>int */</td> <td>2</td> </tr> <tr> <td>int Int <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>boolean True of false</td> <td>2</td> </tr> <tr> <td>Array of a PR</td> <td>2</td> </tr> <tr> <td>array Array of record</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done</td> <td>2</td> </tr> <tr> <td>int >0 if OK, 0 if not found, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>2</td> </tr> <tr> <td>string Text with description</td> <td>2</td> </tr> <tr> <td>int >0 if OK, Otherwise if KO</td> <td>2</td> </tr> <tr> <td>bool Return false if fail, true on success, set $this->error for error message</td> <td>2</td> </tr> <tr> <td>Object Object after update</td> <td>2</td> </tr> <tr> <td>Object|false Object with cleaned properties</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>2</td> </tr> <tr> <td>array Liste des id contacts facturation</td> <td>2</td> </tr> <tr> <td>int 0 < if KO, > 0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>boolean False in case of the query fails, true if it was successful</td> <td>2</td> </tr> <tr> <td>string Label of status</td> <td>2</td> </tr> <tr> <td>string String with URL</td> <td>2</td> </tr> <tr> <td>int retourne le nombre d'utilisateur</td> <td>2</td> </tr> <tr> <td>object Object loaded</td> <td>2</td> </tr> <tr> <td>array Array of amount each month</td> <td>2</td> </tr> <tr> <td>array Array of average each month</td> <td>2</td> </tr> <tr> <td>array Array of subscription objects</td> <td>2</td> </tr> <tr> <td>int ID of subscription</td> <td>2</td> </tr> <tr> <td>string Label</td> <td>2</td> </tr> <tr> <td>int >0 if OK, < 0 if KO</td> <td>2</td> </tr> <tr> <td>string Label of status</td> <td>2</td> </tr> <tr> <td>string Status label</td> <td>2</td> </tr> <tr> <td>string Return mail content of type or empty</td> <td>2</td> </tr> <tr> <td>string Return mail model content of type or empty</td> <td>2</td> </tr> <tr> <td>array Return array with validated mandatory fields and their value</td> <td>2</td> </tr> <tr> <td>string SQL string</td> <td>2</td> </tr> <tr> <td>array Array</td> <td>2</td> </tr> <tr> <td>string Date in a string YYYY-MM-DD HH:MM:SS</td> <td>2</td> </tr> <tr> <td>string lasterrno</td> <td>2</td> </tr> <tr> <td>int 1 if transaction successfully opened or already opened, 0 if error</td> <td>2</td> </tr> <tr> <td>array Version array</td> <td>2</td> </tr> <tr> <td>string Error text</td> <td>2</td> </tr> <tr> <td>string Last query</td> <td>2</td> </tr> <tr> <td>string String to provide syntax of a sort sql string</td> <td>2</td> </tr> <tr> <td>string Decrypted value if used</td> <td>2</td> </tr> <tr> <td>string lasterror</td> <td>2</td> </tr> <tr> <td>int Id of row</td> <td>2</td> </tr> <tr> <td>string Full path of restore program</td> <td>2</td> </tr> <tr> <td>resource|int 1 if cancellation is ok or transaction not open, 0 if error</td> <td>2</td> </tr> <tr> <td>string String with SQL syntax to add a limit and offset</td> <td>2</td> </tr> <tr> <td>string Collation value</td> <td>2</td> </tr> <tr> <td>string Full path of dump program</td> <td>2</td> </tr> <tr> <td>string Error code (Examples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)</td> <td>2</td> </tr> <tr> <td>array List of Charset</td> <td>2</td> </tr> <tr> <td>array List of Collation</td> <td>2</td> </tr> <tr> <td>string Version string</td> <td>2</td> </tr> <tr> <td>string Charset</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>2</td> </tr> <tr> <td>int|'' Date TMS or ''</td> <td>2</td> </tr> <tr> <td>int 1 if validation is OK or transaction level no started, 0 if ERROR</td> <td>2</td> </tr> <tr> <td>array Array with information on table</td> <td>2</td> </tr> <tr> <td>boolean True if disconnect successful, false otherwise</td> <td>2</td> </tr> <tr> <td>string lastqueryerror</td> <td>2</td> </tr> <tr> <td>\DebugBar\JavascriptRenderer String content</td> <td>2</td> </tr> <tr> <td>string HTML string</td> <td>2</td> </tr> <tr> <td>array Array of collected data</td> <td>2</td> </tr> <tr> <td>array Array</td> <td>2</td> </tr> <tr> <td>array Array</td> <td>2</td> </tr> <tr> <td>int >0 if ok</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing is done, >0 if OK</td> <td>2</td> </tr> <tr> <td>string label of level</td> <td>2</td> </tr> <tr> <td>string Label</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>string Chaine with URL</td> <td>2</td> </tr> <tr> <td>int Return integer <0 KO, >0 OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 KO, >0 OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 KO, >0 OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>array|int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered)</td> <td>2</td> </tr> <tr> <td>array of type</td> <td>2</td> </tr> <tr> <td>float|int|array Amount of payment already done, <0 and set ->error if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if a request already exists, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if OK, >0 if KO</td> <td>2</td> </tr> <tr> <td>array|string Array of keys for json or HTML component</td> <td>2</td> </tr> <tr> <td>int Nb of lines loaded, <0 if KO</td> <td>2</td> </tr> <tr> <td>string HTML select</td> <td>2</td> </tr> <tr> <td>string|array Return HTML string</td> <td>2</td> </tr> <tr> <td>string HTML string</td> <td>2</td> </tr> <tr> <td>array Color</td> <td>2</td> </tr> <tr> <td>string HTML select string</td> <td>2</td> </tr> <tr> <td>string HTML string component</td> <td>2</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>2</td> </tr> <tr> <td>boolean|int|float|NULL|mixed Result</td> <td>2</td> </tr> <tr> <td>array Output</td> <td>2</td> </tr> <tr> <td>false</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if already loaded or loading not required, >0 if OK</td> <td>2</td> </tr> <tr> <td>string translated string</td> <td>2</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>stdClass|null</td> <td>2</td> </tr> <tr> <td>string ???</td> <td>2</td> </tr> <tr> <td>array<int,string>|array<string,string>|null Array list of type of contacts (id->label if option=0, code->label if option=1), or null if error</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>2</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>array|int Array of record, -1 if empty</td> <td>2</td> </tr> <tr> <td>int Result of run_triggers</td> <td>2</td> </tr> <tr> <td>int<-1,1> -1=error, O=did nothing, 1=OK</td> <td>2</td> </tr> <tr> <td>int >0 if OK, 0 if not found, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>2</td> </tr> <tr> <td>string String with URL</td> <td>2</td> </tr> <tr> <td>boolean true or false</td> <td>2</td> </tr> <tr> <td>string Converted string</td> <td>2</td> </tr> <tr> <td>string Model name</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>2</td> </tr> <tr> <td>string Html output</td> <td>2</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int}> Array of nb each month</td> <td>2</td> </tr> <tr> <td>array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of values</td> <td>2</td> </tr> <tr> <td>string Country code (two letters)</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>string SQL request line converted</td> <td>2</td> </tr> <tr> <td>boolean true if OK, false if KO</td> <td>2</td> </tr> <tr> <td>bool True if disconnect successful, false otherwise</td> <td>2</td> </tr> <tr> <td>false|array Array or false if KO or end of cursor</td> <td>2</td> </tr> <tr> <td>int Id of row</td> <td>2</td> </tr> <tr> <td>string String with SQL syntax to add a limit and offset</td> <td>2</td> </tr> <tr> <td>false|array Array</td> <td>2</td> </tr> <tr> <td>string Error text</td> <td>2</td> </tr> <tr> <td>array|null List of Charset</td> <td>2</td> </tr> <tr> <td>array|null Liste of Collation</td> <td>2</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>2</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>2</td> </tr> <tr> <td>array Array list of widget</td> <td>2</td> </tr> <tr> <td>string Url link</td> <td>2</td> </tr> <tr> <td>string Url lien</td> <td>2</td> </tr> <tr> <td>string[] Array with SQL requests</td> <td>2</td> </tr> <tr> <td>array List of numbers</td> <td>2</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>2</td> </tr> <tr> <td>int Position pour suite</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>string Name of logger</td> <td>2</td> </tr> <tr> <td>array Return array of configuration data</td> <td>2</td> </tr> <tr> <td>float|int Return topshift value</td> <td>2</td> </tr> <tr> <td>string Description</td> <td>2</td> </tr> <tr> <td>string Next free value</td> <td>2</td> </tr> <tr> <td>string Example</td> <td>2</td> </tr> <tr> <td>string|-1 Value if OK, '' if module not configured, -1 if KO</td> <td>2</td> </tr> <tr> <td>int 0 or 1</td> <td>2</td> </tr> <tr> <td>array List of templates</td> <td>2</td> </tr> <tr> <td>string Value</td> <td>2</td> </tr> <tr> <td>array|int List of numbers</td> <td>2</td> </tr> <tr> <td>string Return next value</td> <td>2</td> </tr> <tr> <td>int >=0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>string|0 Value if OK, 0 if KO</td> <td>2</td> </tr> <tr> <td>int 1 if OK, <=0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int 0 if OK</td> <td>2</td> </tr> <tr> <td>int >0 if supported, 0 if not</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>array|boolean Array of field values. Data are UTF8 encoded. [fieldpos] => (['val']=>val, ['type']=>-1=null,0=blank,1=not empty string)</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>2</td> </tr> <tr> <td>array Array of invoice objects</td> <td>2</td> </tr> <tr> <td>Object|false Updated object</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>string Show delayed information</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, Nb of lines found if OK</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 si ok, >0 si ok</td> <td>2</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>2</td> </tr> <tr> <td>int|false false if KO, timestamp if OK</td> <td>2</td> </tr> <tr> <td>boolean False by default, True if maximum number of generation is reached</td> <td>2</td> </tr> <tr> <td>int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)</td> <td>2</td> </tr> <tr> <td>int 1 if OK, < 0 if KO</td> <td>2</td> </tr> <tr> <td>int ID of order</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not possible, >0 if OK</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>string Label</td> <td>2</td> </tr> <tr> <td>string Label of status</td> <td>2</td> </tr> <tr> <td>boolean True or false</td> <td>2</td> </tr> <tr> <td>int ID of link</td> <td>2</td> </tr> <tr> <td>array<string,string> Old property to new property mapping</td> <td>2</td> </tr> <tr> <td>string country code</td> <td>2</td> </tr> <tr> <td>int >0 if OK, 0 if KO</td> <td>2</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <O if KO, number of invoices if OK</td> <td>2</td> </tr> <tr> <td>int 0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if OK</td> <td>2</td> </tr> <tr> <td>string Label</td> <td>2</td> </tr> <tr> <td>int ID of MO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>2</td> </tr> <tr> <td>array|object|string</td> <td>2</td> </tr> <tr> <td>resource|string|callable</td> <td>2</td> </tr> <tr> <td>INode[]</td> <td>2</td> </tr> <tr> <td>NotificationInterface</td> <td>2</td> </tr> <tr> <td>VCalendar</td> <td>2</td> </tr> <tr> <td>ElementList</td> <td>2</td> </tr> <tr> <td>DateTimeZone</td> <td>2</td> </tr> <tr> <td>VObject\Property|null</td> <td>2</td> </tr> <tr> <td>\Composer\Autoload\ClassLoader</td> <td>2</td> </tr> <tr> <td>string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present</td> <td>2</td> </tr> <tr> <td>int number of available pages</td> <td>2</td> </tr> <tr> <td>(array) Array of parsed PDF document objects.</td> <td>2</td> </tr> <tr> <td>array containing object type, raw value and offset to next object</td> <td>2</td> </tr> <tr> <td>array containing decoded stream data and remaining filters.</td> <td>2</td> </tr> <tr> <td>string SVG code.</td> <td>2</td> </tr> <tr> <td>string HTML code.</td> <td>2</td> </tr> <tr> <td>array of page number aliases</td> <td>2</td> </tr> <tr> <td>image or false in case of error.</td> <td>2</td> </tr> <tr> <td>int object id</td> <td>2</td> </tr> <tr> <td>string escaped date string.</td> <td>2</td> </tr> <tr> <td>array() Array describing the basic font parameters: (family, style, size).</td> <td>2</td> </tr> <tr> <td>string hexadecimal representation</td> <td>2</td> </tr> <tr> <td>int page number</td> <td>2</td> </tr> <tr> <td>(string) The PDF command or empty string.</td> <td>2</td> </tr> <tr> <td>mixed int total string length or array of characted widths</td> <td>2</td> </tr> <tr> <td>float char width</td> <td>2</td> </tr> <tr> <td>alias of the current page group</td> <td>2</td> </tr> <tr> <td>array.</td> <td>2</td> </tr> <tr> <td>float Return the minimal height needed for multicell method for printing the $txt param.</td> <td>2</td> </tr> <tr> <td>array containing all margins measures</td> <td>2</td> </tr> <tr> <td>string XHTML code cleaned up</td> <td>2</td> </tr> <tr> <td>float value in points</td> <td>2</td> </tr> <tr> <td>$dom array</td> <td>2</td> </tr> <tr> <td>array text with soft hyphens</td> <td>2</td> </tr> <tr> <td>int the XObject Template ID in case of success or false in case of error.</td> <td>2</td> </tr> <tr> <td>String</td> <td>2</td> </tr> <tr> <td>pagedim array of page dimensions.</td> <td>2</td> </tr> <tr> <td>Return part of a string</td> <td>2</td> </tr> <tr> <td>integer Unicode value</td> <td>2</td> </tr> <tr> <td>array structure containing the image data</td> <td>2</td> </tr> <tr> <td>array barcode array readable by TCPDF;</td> <td>2</td> </tr> <tr> <td>int demerit</td> <td>2</td> </tr> <tr> <td>boolean true of false</td> <td>2</td> </tr> <tr> <td>array items</td> <td>2</td> </tr> <tr> <td>array padded merged byte stream</td> <td>2</td> </tr> <tr> <td>Array of unsigned char.</td> <td>2</td> </tr> <tr> <td>array Array of RS values:<ul><li>mm = Bits per symbol;</li><li>nn = Symbols per block;</li><li>alpha_to = log lookup table array;</li><li>index_of = Antilog lookup table array;</li><li>genpoly = Generator polynomial array;</li><li>nroots = Number of generator;</li><li>roots = number of parity symbols;</li><li>fcr = First consecutive root, index form;</li><li>prim = Primitive element, index form;</li><li>iprim = prim-th root of 1, index form;</li><li>pad = Padding bytes in shortened block;</li><li>gfpoly</ul>.</td> <td>2</td> </tr> <tr> <td>pad codeword</td> <td>2</td> </tr> <tr> <td>ServiceFactory</td> <td>2</td> </tr> <tr> <td>Uri</td> <td>2</td> </tr> <tr> <td>boolean If the loading was successful</td> <td>2</td> </tr> <tr> <td>boolean The status of the registration</td> <td>2</td> </tr> <tr> <td>boolean The status of the unregistration</td> <td>2</td> </tr> <tr> <td>ClientInterface</td> <td>2</td> </tr> <tr> <td>null|Worksheet</td> <td>2</td> </tr> <tr> <td>Calculation</td> <td>2</td> </tr> <tr> <td>Iterator</td> <td>2</td> </tr> <tr> <td>false|Style</td> <td>2</td> </tr> <tr> <td>bool true if workbook window is minimized</td> <td>2</td> </tr> <tr> <td>IComparable</td> <td>2</td> </tr> <tr> <td>Reader\IReader</td> <td>2</td> </tr> <tr> <td>string Updated cell range</td> <td>2</td> </tr> <tr> <td>array Highest column name and highest row number</td> <td>2</td> </tr> <tr> <td>string Highest column name</td> <td>2</td> </tr> <tr> <td>int Highest row number</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Cell\Cell</td> <td>2</td> </tr> <tr> <td>AutoFilter\Column</td> <td>2</td> </tr> <tr> <td>mixed[]</td> <td>2</td> </tr> <tr> <td>Column</td> <td>2</td> </tr> <tr> <td>string The valid string</td> <td>2</td> </tr> <tr> <td>RowDimension</td> <td>2</td> </tr> <tr> <td>Chart|false</td> <td>2</td> </tr> <tr> <td>null|Cell Cell that was found/created or null</td> <td>2</td> </tr> <tr> <td>Conditional[]</td> <td>2</td> </tr> <tr> <td>AutoFilter</td> <td>2</td> </tr> <tr> <td>Comment</td> <td>2</td> </tr> <tr> <td>Hyperlink</td> <td>2</td> </tr> <tr> <td>DataValidation</td> <td>2</td> </tr> <tr> <td>array Containing start column and end column, empty array if option unset</td> <td>2</td> </tr> <tr> <td>Column\Rule</td> <td>2</td> </tr> <tr> <td>Axis</td> <td>2</td> </tr> <tr> <td>GridLines</td> <td>2</td> </tr> <tr> <td>array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell</td> <td>2</td> </tr> <tr> <td>array of DataSeries</td> <td>2</td> </tr> <tr> <td>Alignment</td> <td>2</td> </tr> <tr> <td>string E.g. 'A1'</td> <td>2</td> </tr> <tr> <td>Font</td> <td>2</td> </tr> <tr> <td>Fill</td> <td>2</td> </tr> <tr> <td>NumberFormat</td> <td>2</td> </tr> <tr> <td>Borders</td> <td>2</td> </tr> <tr> <td>bool true on success, PEAR_Error on failure</td> <td>2</td> </tr> <tr> <td>Escher\DggContainer</td> <td>2</td> </tr> <tr> <td>Escher\DgContainer</td> <td>2</td> </tr> <tr> <td>int The width in pixels</td> <td>2</td> </tr> <tr> <td>DateTimeZone The timezone as a timezone object</td> <td>2</td> </tr> <tr> <td>float MS Excel serialized date/time value</td> <td>2</td> </tr> <tr> <td>Matrix V</td> <td>2</td> </tr> <tr> <td>mixed Element (int/float/double)</td> <td>2</td> </tr> <tr> <td>Matrix Sum</td> <td>2</td> </tr> <tr> <td>Matrix Division result</td> <td>2</td> </tr> <tr> <td>Matrix Matrix Aij</td> <td>2</td> </tr> <tr> <td>mixed true on success</td> <td>2</td> </tr> <tr> <td>array Range coordinates [Start Cell, End Cell]</td> <td>2</td> </tr> <tr> <td>string #Not Yet Implemented</td> <td>2</td> </tr> <tr> <td>number N converts values listed in the following table</td> <td>2</td> </tr> <tr> <td>array Flattened array</td> <td>2</td> </tr> <tr> <td>mixed Excel date/time serial value, or string if error</td> <td>2</td> </tr> <tr> <td>int|string Interval between the dates</td> <td>2</td> </tr> <tr> <td>int|string Week Number</td> <td>2</td> </tr> <tr> <td>array|bool</td> <td>2</td> </tr> <tr> <td>mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned.</td> <td>2</td> </tr> <tr> <td>mixed The value of errorpart or testValue determined by error condition</td> <td>2</td> </tr> <tr> <td>array of float</td> <td>2</td> </tr> <tr> <td>array|int|string The result, or a string containing an error</td> <td>2</td> </tr> <tr> <td>int|string Rounded Number, or a string containing an error</td> <td>2</td> </tr> <tr> <td>array|string The result, or a string containing an error</td> <td>2</td> </tr> <tr> <td>string Complete binary record data</td> <td>2</td> </tr> <tr> <td>string Binary data</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher</td> <td>2</td> </tr> <tr> <td>mixed the converted token on success</td> <td>2</td> </tr> <tr> <td>array Array with data and properties of the bitmap</td> <td>2</td> </tr> <tr> <td>string Text</td> <td>2</td> </tr> <tr> <td>array|null The next token or NULL if there are no more tokens ahead.</td> <td>2</td> </tr> <tr> <td>bool Whether the operation has succeeded</td> <td>2</td> </tr> <tr> <td>Swift_StreamFilter</td> <td>2</td> </tr> <tr> <td>int The number of sent e-mail's</td> <td>2</td> </tr> <tr> <td>Swift_CharacterReader</td> <td>2</td> </tr> <tr> <td>int The limit</td> <td>2</td> </tr> <tr> <td>string|null The server response, or null if pipelining is enabled</td> <td>2</td> </tr> <tr> <td>Swift_Transport_IoBuffer</td> <td>2</td> </tr> <tr> <td>int mapType</td> <td>2</td> </tr> <tr> <td>Swift_Mime_ContentEncoder</td> <td>2</td> </tr> <tr> <td>array An array of tokens as strings</td> <td>2</td> </tr> <tr> <td>Swift_Events_SendEvent</td> <td>2</td> </tr> <tr> <td>Swift_Events_CommandEvent</td> <td>2</td> </tr> <tr> <td>Swift_Events_ResponseEvent</td> <td>2</td> </tr> <tr> <td>Swift_Events_TransportChangeEvent</td> <td>2</td> </tr> <tr> <td>Swift_Events_TransportExceptionEvent</td> <td>2</td> </tr> <tr> <td>string String converted</td> <td>2</td> </tr> <tr> <td>true if openning has succeeded</td> <td>2</td> </tr> <tr> <td>the content of the file in a string</td> <td>2</td> </tr> <tr> <td>true</td> <td>2</td> </tr> <tr> <td>bool true if the file has been successful added</td> <td>2</td> </tr> <tr> <td>*/</td> <td>2</td> </tr> <tr> <td>string string to be used with WWW-Authenticate header</td> <td>2</td> </tr> <tr> <td>ApiMethodInfo</td> <td>2</td> </tr> <tr> <td>bool|mixed reference to discovered include or false</td> <td>2</td> </tr> <tr> <td>Tags</td> <td>2</td> </tr> <tr> <td>string[]|NULL</td> <td>2</td> </tr> <tr> <td>string|NULL</td> <td>2</td> </tr> <tr> <td>int Number of bytes to represent a row of this image</td> <td>2</td> </tr> <tr> <td>string Get the accumulated data that has been sent to this buffer.</td> <td>2</td> </tr> <tr> <td>string Data read from the printer, or false where reading is not possible.</td> <td>2</td> </tr> <tr> <td>CarbonTimeZone</td> <td>2</td> </tr> <tr> <td>CarbonTimeZone|false</td> <td>2</td> </tr> <tr> <td>Language[]</td> <td>2</td> </tr> <tr> <td>Closure|static the current instance used for testing</td> <td>2</td> </tr> <tr> <td>bool true if time match a relative date, false if absolute or invalid time string</td> <td>2</td> </tr> <tr> <td>bool true if there is a test instance, otherwise false</td> <td>2</td> </tr> <tr> <td>$this|static</td> <td>2</td> </tr> <tr> <td>CarbonImmutable</td> <td>2</td> </tr> <tr> <td>static|string</td> <td>2</td> </tr> <tr> <td>int|float|string</td> <td>2</td> </tr> <tr> <td>bool|CarbonInterface|CarbonInterval|int|null</td> <td>2</td> </tr> <tr> <td>DatePeriod</td> <td>2</td> </tr> <tr> <td>CarbonInterface[]</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\View\Factory</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Cache\Lock</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\Response|null</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Authenticatable|bool</td> <td>2</td> </tr> <tr> <td>\Illuminate\Auth\Access\Response</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Mail\Mailer</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\ServiceProvider</td> <td>2</td> </tr> <tr> <td>\Illuminate\Bus\PendingBatch</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Foundation\Application</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\View\View</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Queue\Queue</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Queue\Job|null</td> <td>2</td> </tr> <tr> <td>\Illuminate\Http\JsonResponse</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\StreamedResponse</td> <td>2</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\BinaryFileResponse</td> <td>2</td> </tr> <tr> <td>\Illuminate\Database\Eloquent\Model|null</td> <td>2</td> </tr> <tr> <td>string|array</td> <td>2</td> </tr> <tr> <td>\Ramsey\Uuid\UuidInterface</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Container\Container</td> <td>2</td> </tr> <tr> <td>\Illuminate\Bus\UpdatedBatchJobCounts</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\EventFake</td> <td>2</td> </tr> <tr> <td>\Illuminate\Database\Schema\Builder</td> <td>2</td> </tr> <tr> <td>Attribute|mixed</td> <td>2</td> </tr> <tr> <td>Attribute|mixed|null</td> <td>2</td> </tr> <tr> <td>Message|null</td> <td>2</td> </tr> <tr> <td>AttachmentCollection</td> <td>2</td> </tr> <tr> <td>FlagCollection</td> <td>2</td> </tr> <tr> <td>Protocol</td> <td>2</td> </tr> <tr> <td>array folders that matched $folder as array(name => array('delimiter' => .., 'flags' => ..))</td> <td>2</td> </tr> <tr> <td>array list of capabilities</td> <td>2</td> </tr> <tr> <td>string next line</td> <td>2</td> </tr> <tr> <td>MessageCollection</td> <td>2</td> </tr> <tr> <td>Exception|null</td> <td>2</td> </tr> <tr> <td>Data The cloned variable represented by a Data object</td> <td>2</td> </tr> <tr> <td>string The content-id (cid) of the attachment</td> <td>2</td> </tr> <tr> <td>array The attachments.</td> <td>2</td> </tr> <tr> <td>string the HTTP content type for the current request.</td> <td>2</td> </tr> <tr> <td>string the HTTP content type charset for the current request.</td> <td>2</td> </tr> <tr> <td>mixed value of the message, decoded into a PHP type</td> <td>2</td> </tr> <tr> <td>string the HTTP content type for the current response.</td> <td>2</td> </tr> <tr> <td>string the HTTP content type charset for the current response.</td> <td>2</td> </tr> <tr> <td>false|string parameters serialized as XML or false on error (e.g. operation not found)</td> <td>2</td> </tr> <tr> <td>string PHP/NuSOAP code for the proxy class</td> <td>2</td> </tr> <tr> <td>boolean always return true</td> <td>2</td> </tr> <tr> <td>bool True on success</td> <td>2</td> </tr> <tr> <td>object The multipart/mixed mimePart object</td> <td>2</td> </tr> <tr> <td>object The image mimePart object</td> <td>2</td> </tr> <tr> <td>mixed True or PEAR error object</td> <td>2</td> </tr> <tr> <td>string Encoded header data (without a name)</td> <td>2</td> </tr> <tr> <td>bool True if object is an instance of PEAR_Error</td> <td>2</td> </tr> <tr> <td>PEAR_Error Instance of PEAR_Error</td> <td>2</td> </tr> <tr> <td>string Encoded string</td> <td>2</td> </tr> <tr> <td>string Encoded character string</td> <td>2</td> </tr> <tr> <td>string The instance URL for this resource. It needs to be special</td> <td>2</td> </tr> <tr> <td>null|string the API key used by the client to send requests</td> <td>2</td> </tr> <tr> <td>null|string the client ID used by the client in OAuth requests</td> <td>2</td> </tr> <tr> <td>string the base URL for Stripe's API</td> <td>2</td> </tr> <tr> <td>string the base URL for Stripe's OAuth API</td> <td>2</td> </tr> <tr> <td>string the base URL for Stripe's Files API</td> <td>2</td> </tr> <tr> <td>\Stripe\StripeObject the object returned by Stripe's API</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection of ApiResources</td> <td>2</td> </tr> <tr> <td>\Stripe\SearchResult of ApiResources</td> <td>2</td> </tr> <tr> <td>array the filters</td> <td>2</td> </tr> <tr> <td>SearchResult<TStripeObject></td> <td>2</td> </tr> <tr> <td>int the number of objects in the current page</td> <td>2</td> </tr> <tr> <td>\Generator|TStripeObject[] A generator that can be used to</td> <td>2</td> </tr> <tr> <td>StripeObject object containing the response from the API</td> <td>2</td> </tr> <tr> <td>string the URL to Stripe's OAuth form</td> <td>2</td> </tr> <tr> <td>\Stripe\LoginLink</td> <td>2</td> </tr> <tr> <td>string the API URL for this Stripe account reversal</td> <td>2</td> </tr> <tr> <td>\Stripe\UsageRecord</td> <td>2</td> </tr> <tr> <td>\Stripe\CustomerCashBalanceTransaction</td> <td>2</td> </tr> <tr> <td>TStripeObject</td> <td>2</td> </tr> <tr> <td>string the API URL for this balance transaction</td> <td>2</td> </tr> <tr> <td>array tuple containing (the JSON response, $options)</td> <td>2</td> </tr> <tr> <td>array an array whose first element is raw request body, second</td> <td>2</td> </tr> <tr> <td>RequestOptions</td> <td>2</td> </tr> <tr> <td>string */</td> <td>2</td> </tr> <tr> <td>\Stripe\Terminal\Reader the processed reader</td> <td>2</td> </tr> <tr> <td>null|AbstractService|AbstractServiceFactory</td> <td>2</td> </tr> <tr> <td>\Stripe\File</td> <td>2</td> </tr> <tr> <td>\Stripe\Review</td> <td>2</td> </tr> <tr> <td>\Stripe\Token</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\CreditNoteLineItem></td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\PaymentMethod></td> <td>2</td> </tr> <tr> <td>\Stripe\EphemeralKey</td> <td>2</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\InvoiceLineItem></td> <td>2</td> </tr> <tr> <td>\Stripe\Reporting\ReportRun</td> <td>2</td> </tr> <tr> <td>\Stripe\FinancialConnections\Session</td> <td>2</td> </tr> <tr> <td>\Stripe\Treasury\ReceivedCredit</td> <td>2</td> </tr> <tr> <td>\Stripe\Treasury\ReceivedDebit</td> <td>2</td> </tr> <tr> <td>\Stripe\Issuing\Transaction</td> <td>2</td> </tr> <tr> <td>\Stripe\Treasury\CreditReversal</td> <td>2</td> </tr> <tr> <td>\Stripe\Treasury\DebitReversal</td> <td>2</td> </tr> <tr> <td>HttpDriverInterface</td> <td>2</td> </tr> <tr> <td>array PDO::errorInfo returns an array of error information</td> <td>2</td> </tr> <tr> <td>TracedStatement[]</td> <td>2</td> </tr> <tr> <td>string </td> <td>2</td> </tr> <tr> <td>string HTML rendering of the variable.</td> <td>2</td> </tr> <tr> <td>int 1</td> <td>2</td> </tr> <tr> <td>array|mixed Cleaned Societe object</td> <td>2</td> </tr> <tr> <td>Object|void</td> <td>2</td> </tr> <tr> <td>array|mixed Notification of thirdparty</td> <td>2</td> </tr> <tr> <td>int -1 if error 1 if correct deletion</td> <td>2</td> </tr> <tr> <td>array|mixed BankAccount of thirdparty</td> <td>2</td> </tr> <tr> <td>string Stripe customer ref 'cu_xxxxxxxxxxxxx' or ''</td> <td>2</td> </tr> <tr> <td>int 0=No, 1=Yes</td> <td>2</td> </tr> <tr> <td>int New id of clone</td> <td>2</td> </tr> <tr> <td>string Label of status</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int 0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>2</td> </tr> <tr> <td>string Reference libre pour la propale</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>2</td> </tr> <tr> <td>string HTML string with select</td> <td>2</td> </tr> <tr> <td>string combo list code</td> <td>2</td> </tr> <tr> <td>string HTML combo</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >= 0 if OK</td> <td>2</td> </tr> <tr> <td>int > 0 if OK, < 0 if KO</td> <td>2</td> </tr> <tr> <td>array Array of User objects</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>int 0 if OK, <0 if KO</td> <td>2</td> </tr> <tr> <td>int Array of stats in $this->stats_facture, <0 if ko or >0 if ok</td> <td>2</td> </tr> <tr> <td>int Return integer < 0 if KO, > 0 if OK</td> <td>2</td> </tr> <tr> <td>boolean True if it's a service</td> <td>2</td> </tr> <tr> <td>int Nb of loaded lines, 0 if already loaded, <0 if KO</td> <td>2</td> </tr> <tr> <td>string HTML select</td> <td>2</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>2</td> </tr> <tr> <td>int Result of deletion</td> <td>2</td> </tr> <tr> <td>array Array of warehouse objects</td> <td>2</td> </tr> <tr> <td>array|int Array('nb'=>Nb, 'value'=>Value)</td> <td>2</td> </tr> <tr> <td>array|null Array of errors or null if nothing done</td> <td>2</td> </tr> <tr> <td>int > 0 if OK, < 1 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>array|int Array of price global variable updaters</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>2</td> </tr> <tr> <td>array|int Array with value or -1 if error</td> <td>2</td> </tr> <tr> <td>array of values</td> <td>2</td> </tr> <tr> <td>array Array of values</td> <td>2</td> </tr> <tr> <td>array Array of project objects</td> <td>2</td> </tr> <tr> <td>int ID of project</td> <td>2</td> </tr> <tr> <td>int 1 if OK or < 0 if KO</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no children, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>2</td> </tr> <tr> <td>int Number of lines loaded, 0 if already loaded, <0 if KO</td> <td>2</td> </tr> <tr> <td>array Liste des id contacts suivi ticket</td> <td>2</td> </tr> <tr> <td>array Liste des id contacts intervenants</td> <td>2</td> </tr> <tr> <td>int ID of ticket</td> <td>2</td> </tr> <tr> <td>array Array of values</td> <td>2</td> </tr> <tr> <td>array Response status and user token</td> <td>2</td> </tr> <tr> <td>int ID of extrafield</td> <td>2</td> </tr> <tr> <td>string Html output</td> <td>2</td> </tr> <tr> <td>int Return integer < 0 on error, 0 on success, 1 to replace standard code</td> <td>2</td> </tr> <tr> <td>int if KO: <0 || if OK: Id of created object</td> <td>2</td> </tr> <tr> <td>array Array of category objects</td> <td>2</td> </tr> <tr> <td>string - name of PluginAwarePostAnalysisVisitor subclass</td> <td>2</td> </tr> <tr> <td>string HTML content</td> <td>3</td> </tr> <tr> <td>string encoded string</td> <td>3</td> </tr> <tr> <td>int 1</td> <td>3</td> </tr> <tr> <td>string HTML content</td> <td>3</td> </tr> <tr> <td>string|int</td> <td>3</td> </tr> <tr> <td>string Url string</td> <td>3</td> </tr> <tr> <td>boolean True or false</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, >0 if OK</td> <td>3</td> </tr> <tr> <td>string String ready for HTML output</td> <td>3</td> </tr> <tr> <td>string String cleaned</td> <td>3</td> </tr> <tr> <td>string String decoded</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>3</td> </tr> <tr> <td>Object|bool</td> <td>3</td> </tr> <tr> <td>array Tableau info des attributes</td> <td>3</td> </tr> <tr> <td>Object Data without useless information</td> <td>3</td> </tr> <tr> <td>array Array</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, id of payment if OK</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int Amount of payment already done, <0 if KO</td> <td>3</td> </tr> <tr> <td>int Return integer <0 KO >0 OK</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>3</td> </tr> <tr> <td>array Archive file list : array of ['path', 'name']</td> <td>3</td> </tr> <tr> <td>string Label of status</td> <td>3</td> </tr> <tr> <td>string HTML select string</td> <td>3</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>3</td> </tr> <tr> <td>string Formatted value</td> <td>3</td> </tr> <tr> <td>string Full address string</td> <td>3</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>boolean true or false</td> <td>3</td> </tr> <tr> <td>boolean if set LDAP option OK: true, if KO: false</td> <td>3</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>3</td> </tr> <tr> <td>string Valeur</td> <td>3</td> </tr> <tr> <td>boolean True</td> <td>3</td> </tr> <tr> <td>boolean true</td> <td>3</td> </tr> <tr> <td>int Max value</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int Nb of lines</td> <td>3</td> </tr> <tr> <td>string Error code (Examples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)</td> <td>3</td> </tr> <tr> <td>string Decrypted value if used</td> <td>3</td> </tr> <tr> <td>array Tableau des information des champs de la table</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>3</td> </tr> <tr> <td>string Charset</td> <td>3</td> </tr> <tr> <td>string Collation value</td> <td>3</td> </tr> <tr> <td>string Full path of dump program</td> <td>3</td> </tr> <tr> <td>string Full path of restore program</td> <td>3</td> </tr> <tr> <td>string SQL string</td> <td>3</td> </tr> <tr> <td>string String escaped</td> <td>3</td> </tr> <tr> <td>int Error count (0 if OK)</td> <td>3</td> </tr> <tr> <td>string Url lien</td> <td>3</td> </tr> <tr> <td>int Return integer < 0 si erreur, nb ajout si ok</td> <td>3</td> </tr> <tr> <td>string Url link</td> <td>3</td> </tr> <tr> <td>string Return next value</td> <td>3</td> </tr> <tr> <td>float|int Return topshift value</td> <td>3</td> </tr> <tr> <td>int Return height of bottom margin including footer text</td> <td>3</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>3</td> </tr> <tr> <td>int 1 if logger enabled</td> <td>3</td> </tr> <tr> <td>string|-1 Next value if OK, -1 if KO</td> <td>3</td> </tr> <tr> <td>string Description of text</td> <td>3</td> </tr> <tr> <td>int 0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>3</td> </tr> <tr> <td>string|0 Next free value, 0 if KO</td> <td>3</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>3</td> </tr> <tr> <td>array array of substitutions</td> <td>3</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>3</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>3</td> </tr> <tr> <td>int >=0 if OK, <0 if KO</td> <td>3</td> </tr> <tr> <td>string|0 Value if OK, 0 if KO</td> <td>3</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>3</td> </tr> <tr> <td>string|0 Value if OK, 0 if KO</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>3</td> </tr> <tr> <td>string Value cleaned</td> <td>3</td> </tr> <tr> <td>int 1 if OK, -1 if KO</td> <td>3</td> </tr> <tr> <td>int 0 if OK, <0 if KO</td> <td>3</td> </tr> <tr> <td>string Label</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>3</td> </tr> <tr> <td>int Payment ID</td> <td>3</td> </tr> <tr> <td>int >0 if OK, <0 if KO, 0 if not found</td> <td>3</td> </tr> <tr> <td>int 1 if OK, < 0 if KO</td> <td>3</td> </tr> <tr> <td>string String with URL</td> <td>3</td> </tr> <tr> <td>int >0 if OK, <0 if KO or if two records found for same ref or idprof, 0 if not found.</td> <td>3</td> </tr> <tr> <td>array Array of order objects</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if nothing done, 1 if OK</td> <td>3</td> </tr> <tr> <td>int >0 if OK, <0 if KO, 0 if not found</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, id of payment if OK</td> <td>3</td> </tr> <tr> <td>Object|false Object with cleaned properties</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>3</td> </tr> <tr> <td>string Label</td> <td>3</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>3</td> </tr> <tr> <td>LoggerInterface</td> <td>3</td> </tr> <tr> <td>DAV\INode[]</td> <td>3</td> </tr> <tr> <td>\Sabre\DAV\INode[]</td> <td>3</td> </tr> <tr> <td>Component</td> <td>3</td> </tr> <tr> <td>Document</td> <td>3</td> </tr> <tr> <td>Node</td> <td>3</td> </tr> <tr> <td>\Sabre\VObject\Component|null</td> <td>3</td> </tr> <tr> <td>\Sabre\VObject\Document</td> <td>3</td> </tr> <tr> <td>callable[]</td> <td>3</td> </tr> <tr> <td>Geometry</td> <td>3</td> </tr> <tr> <td>string escaped string.</td> <td>3</td> </tr> <tr> <td>string the PDF command</td> <td>3</td> </tr> <tr> <td>true in case of success, false in case of error.</td> <td>3</td> </tr> <tr> <td>String encrypted text</td> <td>3</td> </tr> <tr> <td>Returns the specified character.</td> <td>3</td> </tr> <tr> <td>boolean true or false</td> <td>3</td> </tr> <tr> <td>array frame</td> <td>3</td> </tr> <tr> <td>ServiceInterface</td> <td>3</td> </tr> <tr> <td>Style[]</td> <td>3</td> </tr> <tr> <td>string Human readable formula</td> <td>3</td> </tr> <tr> <td>Cells</td> <td>3</td> </tr> <tr> <td>ColumnDimension</td> <td>3</td> </tr> <tr> <td>Protection</td> <td>3</td> </tr> <tr> <td>array of DataSeriesValues</td> <td>3</td> </tr> <tr> <td>Layout</td> <td>3</td> </tr> <tr> <td>Title</td> <td>3</td> </tr> <tr> <td>array of mixed</td> <td>3</td> </tr> <tr> <td>int Value in pixels</td> <td>3</td> </tr> <tr> <td>Matrix Submatrix</td> <td>3</td> </tr> <tr> <td>float|mixed|string</td> <td>3</td> </tr> <tr> <td>mixed The value of the found cell</td> <td>3</td> </tr> <tr> <td>IWriter</td> <td>3</td> </tr> <tr> <td>null|\PhpOffice\PhpSpreadsheet\Style\Font</td> <td>3</td> </tr> <tr> <td>InvalidEmail|null</td> <td>3</td> </tr> <tr> <td>int The number of sent emails</td> <td>3</td> </tr> <tr> <td>odf</td> <td>3</td> </tr> <tr> <td>array|T</td> <td>3</td> </tr> <tr> <td>array list of dependencies for the format</td> <td>3</td> </tr> <tr> <td>string $charset Example utf-8</td> <td>3</td> </tr> <tr> <td>boolean is parsing the request supported?</td> <td>3</td> </tr> <tr> <td>boolean is composing response supported?</td> <td>3</td> </tr> <tr> <td>$this|string</td> <td>3</td> </tr> <tr> <td>Carbon</td> <td>3</td> </tr> <tr> <td>DateInterval</td> <td>3</td> </tr> <tr> <td>$this|string|null</td> <td>3</td> </tr> <tr> <td>\Illuminate\Redis\Connections\Connection</td> <td>3</td> </tr> <tr> <td>\Illuminate\Bus\Batch|null</td> <td>3</td> </tr> <tr> <td>\Illuminate\Contracts\Filesystem\Filesystem</td> <td>3</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\Response</td> <td>3</td> </tr> <tr> <td>\Illuminate\Contracts\Support\MessageBag</td> <td>3</td> </tr> <tr> <td>\Symfony\Component\HttpFoundation\Cookie</td> <td>3</td> </tr> <tr> <td>\Illuminate\Http\Response</td> <td>3</td> </tr> <tr> <td>\Illuminate\Support\MessageBag</td> <td>3</td> </tr> <tr> <td>\Illuminate\Foundation\Bus\PendingDispatch</td> <td>3</td> </tr> <tr> <td>\Illuminate\Bus\Batch</td> <td>3</td> </tr> <tr> <td>array|string message number for given message or all messages as array</td> <td>3</td> </tr> <tr> <td>int message number</td> <td>3</td> </tr> <tr> <td>bool|array new flags if $silent is false, else true or false depending on success</td> <td>3</td> </tr> <tr> <td>array message ids</td> <td>3</td> </tr> <tr> <td>LengthAwarePaginator</td> <td>3</td> </tr> <tr> <td>Collection</td> <td>3</td> </tr> <tr> <td>bool True on success and false on failure.</td> <td>3</td> </tr> <tr> <td>self A clone of $this</td> <td>3</td> </tr> <tr> <td>string data</td> <td>3</td> </tr> <tr> <td>string value serialized as an XML string</td> <td>3</td> </tr> <tr> <td>string the base URL for the given class</td> <td>3</td> </tr> <tr> <td>\ArrayIterator an iterator that can be used to iterate</td> <td>3</td> </tr> <tr> <td>\Stripe\StripeObject object containing the response from the API</td> <td>3</td> </tr> <tr> <td>Collection<TStripeObject></td> <td>3</td> </tr> <tr> <td>\Stripe\Price</td> <td>3</td> </tr> <tr> <td>\Stripe\Dispute</td> <td>3</td> </tr> <tr> <td>\Stripe\Transfer</td> <td>3</td> </tr> <tr> <td>\Stripe\FileLink</td> <td>3</td> </tr> <tr> <td>\Stripe\ApplePayDomain</td> <td>3</td> </tr> <tr> <td>\Stripe\PromotionCode</td> <td>3</td> </tr> <tr> <td>\Stripe\PaymentLink</td> <td>3</td> </tr> <tr> <td>\Stripe\ShippingRate</td> <td>3</td> </tr> <tr> <td>\Stripe\TaxRate</td> <td>3</td> </tr> <tr> <td>\Stripe\FinancialConnections\Account</td> <td>3</td> </tr> <tr> <td>\Stripe\Issuing\Cardholder</td> <td>3</td> </tr> <tr> <td>\Stripe\BillingPortal\Configuration</td> <td>3</td> </tr> <tr> <td>\Stripe\Checkout\Session</td> <td>3</td> </tr> <tr> <td>\Stripe\Radar\ValueListItem</td> <td>3</td> </tr> <tr> <td>\Stripe\Apps\Secret</td> <td>3</td> </tr> <tr> <td>array Collected data</td> <td>3</td> </tr> <tr> <td>DataFormatterInterface</td> <td>3</td> </tr> <tr> <td>array {</td> <td>3</td> </tr> <tr> <td>DebugBarVarDumper</td> <td>3</td> </tr> <tr> <td>array array('opened'=>Amount including tax that remains to pay, 'total_ht'=>Total amount without tax of all objects paid or not, 'total_ttc'=>Total amount including tax of all object paid or not)</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>3</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>3</td> </tr> <tr> <td>string String with URL</td> <td>3</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>3</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>3</td> </tr> <tr> <td>int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK</td> <td>3</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>3</td> </tr> <tr> <td>array Array with amount by month</td> <td>3</td> </tr> <tr> <td>array|mixed Data without useless information</td> <td>3</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>3</td> </tr> <tr> <td>array List of documents</td> <td>3</td> </tr> <tr> <td>string HTML Code for Kanban thumb.</td> <td>3</td> </tr> <tr> <td>string Label of status</td> <td>3</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>3</td> </tr> <tr> <td>FuncCall|BooleanNot</td> <td>3</td> </tr> <tr> <td>bool Return true if node is conf->global->XXX</td> <td>3</td> </tr> <tr> <td>Node|void Return the name of the constant</td> <td>3</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>4</td> </tr> <tr> <td>string Json encoded string</td> <td>4</td> </tr> <tr> <td>string Return tag img</td> <td>4</td> </tr> <tr> <td>string Retourne tag img</td> <td>4</td> </tr> <tr> <td>array Array with time spent for $fuser for each day of week on tasks in $lines and subtasks</td> <td>4</td> </tr> <tr> <td>string String with defined length</td> <td>4</td> </tr> <tr> <td>int|float</td> <td>4</td> </tr> <tr> <td>int Compare result (-1, 0, 1)</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if OK, >0 if KO</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer < 0 on error, 0 on success, 1 to replace standard code</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>string Label</td> <td>4</td> </tr> <tr> <td>string HTML Code for Kanban thumb.</td> <td>4</td> </tr> <tr> <td>string Title</td> <td>4</td> </tr> <tr> <td>string Label</td> <td>4</td> </tr> <tr> <td>int Number of EMailings</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>mixed Value</td> <td>4</td> </tr> <tr> <td>boolean True if at least one photo is available, False if not</td> <td>4</td> </tr> <tr> <td>string Label of status</td> <td>4</td> </tr> <tr> <td>string String with HTML select</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>4</td> </tr> <tr> <td>string String with full name</td> <td>4</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>4</td> </tr> <tr> <td>int<-1,1> Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>boolean true or false</td> <td>4</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>4</td> </tr> <tr> <td>array Array of substitution</td> <td>4</td> </tr> <tr> <td>string SQL string</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if error, number of emails added if ok</td> <td>4</td> </tr> <tr> <td>int 0 if OK</td> <td>4</td> </tr> <tr> <td>string Example of password</td> <td>4</td> </tr> <tr> <td>string Return a new generated password</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>string Description of module</td> <td>4</td> </tr> <tr> <td>string Description of module</td> <td>4</td> </tr> <tr> <td>string Return driver label</td> <td>4</td> </tr> <tr> <td>int 1</td> <td>4</td> </tr> <tr> <td>string Empty string</td> <td>4</td> </tr> <tr> <td>string String output</td> <td>4</td> </tr> <tr> <td>array Array of values</td> <td>4</td> </tr> <tr> <td>int Return integer <0 si ko, >0 si ok</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>4</td> </tr> <tr> <td>double Amount</td> <td>4</td> </tr> <tr> <td>int >0 if OK, 0 if KO</td> <td>4</td> </tr> <tr> <td>int ???</td> <td>4</td> </tr> <tr> <td>string Text with description</td> <td>4</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>4</td> </tr> <tr> <td>bool|array</td> <td>4</td> </tr> <tr> <td>INode</td> <td>4</td> </tr> <tr> <td>\Traversable</td> <td>4</td> </tr> <tr> <td>bool|null</td> <td>4</td> </tr> <tr> <td>\Sabre\DAV\Xml\Element\Sharee[]</td> <td>4</td> </tr> <tr> <td>VCalendar|null</td> <td>4</td> </tr> <tr> <td>array containing object data.</td> <td>4</td> </tr> <tr> <td>int run</td> <td>4</td> </tr> <tr> <td>int number of bits</td> <td>4</td> </tr> <tr> <td>RichText</td> <td>4</td> </tr> <tr> <td>null|int</td> <td>4</td> </tr> <tr> <td>DataSeriesValues</td> <td>4</td> </tr> <tr> <td>bool true on success</td> <td>4</td> </tr> <tr> <td>bool|mixed</td> <td>4</td> </tr> <tr> <td>string|bool</td> <td>4</td> </tr> <tr> <td>Swift_InputByteStream</td> <td>4</td> </tr> <tr> <td>DateTimeInterface</td> <td>4</td> </tr> <tr> <td>Swift_Signers_DKIMSigner</td> <td>4</td> </tr> <tr> <td>true if the file has been successful added</td> <td>4</td> </tr> <tr> <td>boolean true if cached</td> <td>4</td> </tr> <tr> <td>string encoded string</td> <td>4</td> </tr> <tr> <td>array list of mime strings for the format</td> <td>4</td> </tr> <tr> <td>string file extension</td> <td>4</td> </tr> <tr> <td>false|static</td> <td>4</td> </tr> <tr> <td>string|int|bool|DateTimeZone|null</td> <td>4</td> </tr> <tr> <td>CarbonInterval</td> <td>4</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Authenticatable|null</td> <td>4</td> </tr> <tr> <td>\Illuminate\Mail\PendingMail</td> <td>4</td> </tr> <tr> <td>$this|mixed</td> <td>4</td> </tr> <tr> <td>\Mockery\MockInterface</td> <td>4</td> </tr> <tr> <td>Attribute</td> <td>4</td> </tr> <tr> <td>mixed|string</td> <td>4</td> </tr> <tr> <td>bool|array see examineOrselect()</td> <td>4</td> </tr> <tr> <td>string The HTTP body, which includes the SOAP payload</td> <td>4</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\LineItem> list of LineItems</td> <td>4</td> </tr> <tr> <td>null|TStripeObject</td> <td>4</td> </tr> <tr> <td>\Stripe\Capability</td> <td>4</td> </tr> <tr> <td>\Stripe\CashBalance</td> <td>4</td> </tr> <tr> <td>\Stripe\Topup</td> <td>4</td> </tr> <tr> <td>\Stripe\Collection<\Stripe\LineItem></td> <td>4</td> </tr> <tr> <td>\Stripe\WebhookEndpoint</td> <td>4</td> </tr> <tr> <td>\Stripe\Coupon</td> <td>4</td> </tr> <tr> <td>\Stripe\Product</td> <td>4</td> </tr> <tr> <td>\Stripe\SubscriptionItem</td> <td>4</td> </tr> <tr> <td>\Stripe\InvoiceItem</td> <td>4</td> </tr> <tr> <td>\Stripe\Plan</td> <td>4</td> </tr> <tr> <td>\Stripe\Charge</td> <td>4</td> </tr> <tr> <td>\Stripe\TestHelpers\TestClock</td> <td>4</td> </tr> <tr> <td>\Stripe\Issuing\Dispute</td> <td>4</td> </tr> <tr> <td>\Stripe\Issuing\Authorization</td> <td>4</td> </tr> <tr> <td>\Stripe\Terminal\Configuration</td> <td>4</td> </tr> <tr> <td>\Stripe\Terminal\Location</td> <td>4</td> </tr> <tr> <td>\Stripe\Radar\ValueList</td> <td>4</td> </tr> <tr> <td>SimpleXMLElement status_code, response</td> <td>4</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>4</td> </tr> <tr> <td>int Array of stats in $this->stats_expedition, <0 if ko or >0 if ok</td> <td>4</td> </tr> <tr> <td>string Label of status</td> <td>4</td> </tr> <tr> <td>list<Title|Text|Placeholder></td> <td>4</td> </tr> <tr> <td>TwoNodeMatch|null</td> <td>4</td> </tr> <tr> <td>null</td> <td>5</td> </tr> <tr> <td>array|string</td> <td>5</td> </tr> <tr> <td>array Array of tabs to show</td> <td>5</td> </tr> <tr> <td>array<int,array<int,string>> head links</td> <td>5</td> </tr> <tr> <td>Array of head</td> <td>5</td> </tr> <tr> <td>array head array with tabs</td> <td>5</td> </tr> <tr> <td>boolean True if valid, False otherwise</td> <td>5</td> </tr> <tr> <td>int Return integer <=0 if KO, >0 if OK</td> <td>5</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>5</td> </tr> <tr> <td>array array with number by month</td> <td>5</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>5</td> </tr> <tr> <td>string DN</td> <td>5</td> </tr> <tr> <td>string XXX(field) or XXX('value') or field or 'value'</td> <td>5</td> </tr> <tr> <td>string Id connection</td> <td>5</td> </tr> <tr> <td>array Array</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>5</td> </tr> <tr> <td>string Label</td> <td>5</td> </tr> <tr> <td>string String with URL</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, 0=no, 1=yes</td> <td>5</td> </tr> <tr> <td>int Nb of lines loaded, <0 if KO</td> <td>5</td> </tr> <tr> <td>string HTML select string</td> <td>5</td> </tr> <tr> <td>int 0 if OK; >0 if KO</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>5</td> </tr> <tr> <td>string html</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>5</td> </tr> <tr> <td>string A html select zone</td> <td>5</td> </tr> <tr> <td>boolean false if KO (there is a conflict), true if OK</td> <td>5</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>5</td> </tr> <tr> <td>int Pos y</td> <td>5</td> </tr> <tr> <td>int 1 if OK, <=0 if KO</td> <td>5</td> </tr> <tr> <td>string HTML translated description</td> <td>5</td> </tr> <tr> <td>int 0 if available, <0 if KO</td> <td>5</td> </tr> <tr> <td>string Descriptive text</td> <td>5</td> </tr> <tr> <td>\Sabre\DAV\INode</td> <td>5</td> </tr> <tr> <td>DAV\INode</td> <td>5</td> </tr> <tr> <td>DateTime</td> <td>5</td> </tr> <tr> <td>Geometry|GeometryCollection</td> <td>5</td> </tr> <tr> <td>int 16 bit value</td> <td>5</td> </tr> <tr> <td>TokenInterface</td> <td>5</td> </tr> <tr> <td>number</td> <td>5</td> </tr> <tr> <td>float Y-Value</td> <td>5</td> </tr> <tr> <td>float X-Value</td> <td>5</td> </tr> <tr> <td>mixed The parsed ptg'd tree on success</td> <td>5</td> </tr> <tr> <td>Swift_Transport</td> <td>5</td> </tr> <tr> <td>Swift_Mime_Header</td> <td>5</td> </tr> <tr> <td>callable|null</td> <td>5</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface</td> <td>5</td> </tr> <tr> <td>CarbonPeriod</td> <td>5</td> </tr> <tr> <td>\Illuminate\Contracts\Support\Htmlable</td> <td>5</td> </tr> <tr> <td>\ArrayIterator</td> <td>5</td> </tr> <tr> <td>\Illuminate\Http\RedirectResponse</td> <td>5</td> </tr> <tr> <td>Message</td> <td>5</td> </tr> <tr> <td>\Stripe\SubscriptionSchedule</td> <td>5</td> </tr> <tr> <td>\Stripe\Source</td> <td>5</td> </tr> <tr> <td>\Stripe\CreditNote</td> <td>5</td> </tr> <tr> <td>\Stripe\Refund</td> <td>5</td> </tr> <tr> <td>\Stripe\Payout</td> <td>5</td> </tr> <tr> <td>\Stripe\PaymentMethod</td> <td>5</td> </tr> <tr> <td>\Stripe\Identity\VerificationSession</td> <td>5</td> </tr> <tr> <td>\Stripe\Treasury\FinancialAccount</td> <td>5</td> </tr> <tr> <td>Object</td> <td>5</td> </tr> <tr> <td>RuleDefinition</td> <td>5</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>6</td> </tr> <tr> <td>string Login if OK, '' if KO</td> <td>6</td> </tr> <tr> <td>string Label</td> <td>6</td> </tr> <tr> <td>int Return integer <0 if ko, >0 if ok</td> <td>6</td> </tr> <tr> <td>array Array with number by month</td> <td>6</td> </tr> <tr> <td>array Array with amount by month</td> <td>6</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>6</td> </tr> <tr> <td>int >0 if OK, <=0 if KO</td> <td>6</td> </tr> <tr> <td>int Return integer <0 KO, >0 OK</td> <td>6</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>6</td> </tr> <tr> <td>boolean true if module can be used</td> <td>6</td> </tr> <tr> <td>array Array of substitution key->code</td> <td>6</td> </tr> <tr> <td>string Retourne zone select</td> <td>6</td> </tr> <tr> <td>string|0 Next value if OK, 0 if KO</td> <td>6</td> </tr> <tr> <td>false|string</td> <td>6</td> </tr> <tr> <td>int 0 if OK, >0 if KO</td> <td>6</td> </tr> <tr> <td>array|mixed data without useless information</td> <td>6</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>6</td> </tr> <tr> <td>Array containing xref and trailer data.</td> <td>6</td> </tr> <tr> <td>TokenInterface $token</td> <td>6</td> </tr> <tr> <td>IReader</td> <td>6</td> </tr> <tr> <td>Segment</td> <td>6</td> </tr> <tr> <td>Flash</td> <td>6</td> </tr> <tr> <td>array associative array of the parsed data</td> <td>6</td> </tr> <tr> <td>static|int</td> <td>6</td> </tr> <tr> <td>CarbonInterface|null</td> <td>6</td> </tr> <tr> <td>Client</td> <td>6</td> </tr> <tr> <td>array|bool Tokens if operation successful, false if an error occurred</td> <td>6</td> </tr> <tr> <td>\Stripe\Account</td> <td>6</td> </tr> <tr> <td>\Stripe\TransferReversal</td> <td>6</td> </tr> <tr> <td>\Stripe\CustomerBalanceTransaction</td> <td>6</td> </tr> <tr> <td>\Stripe\TaxId</td> <td>6</td> </tr> <tr> <td>\Stripe\ApplicationFeeRefund</td> <td>6</td> </tr> <tr> <td>\Stripe\StripeObject</td> <td>6</td> </tr> <tr> <td>\Stripe\Subscription</td> <td>6</td> </tr> <tr> <td>\Stripe\Quote</td> <td>6</td> </tr> <tr> <td>\Stripe\SetupIntent</td> <td>6</td> </tr> <tr> <td>\Stripe\Treasury\InboundTransfer</td> <td>6</td> </tr> <tr> <td>\Stripe\Treasury\OutboundPayment</td> <td>6</td> </tr> <tr> <td>\Stripe\Treasury\OutboundTransfer</td> <td>6</td> </tr> <tr> <td>string Label of status</td> <td>6</td> </tr> <tr> <td>int|bool</td> <td>7</td> </tr> <tr> <td>mixed|null</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>7</td> </tr> <tr> <td>int Return >0 if OK, <0 if KO</td> <td>7</td> </tr> <tr> <td>string Label of status</td> <td>7</td> </tr> <tr> <td>array Array with number by year</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>7</td> </tr> <tr> <td>WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK</td> <td>7</td> </tr> <tr> <td>string Label of status</td> <td>7</td> </tr> <tr> <td>array|mixed</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if no triggered ran, >0 if OK</td> <td>7</td> </tr> <tr> <td>void|string</td> <td>7</td> </tr> <tr> <td>array Array with SQL requests</td> <td>7</td> </tr> <tr> <td>string Return string example</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>7</td> </tr> <tr> <td>int New id of clone</td> <td>7</td> </tr> <tr> <td>int Return integer <0 if KO, Id of line if OK</td> <td>7</td> </tr> <tr> <td>array input item</td> <td>7</td> </tr> <tr> <td>array bitstream</td> <td>7</td> </tr> <tr> <td>Color</td> <td>7</td> </tr> <tr> <td>float|string Rounded Number, or a string containing an error</td> <td>7</td> </tr> <tr> <td>HashTable</td> <td>7</td> </tr> <tr> <td>static|null</td> <td>7</td> </tr> <tr> <td>\Illuminate\Pagination\Cursor|null</td> <td>7</td> </tr> <tr> <td>\Closure</td> <td>7</td> </tr> <tr> <td>\Stripe\Issuing\Card</td> <td>7</td> </tr> <tr> <td>bool TRUE on success or FALSE on failure.</td> <td>7</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>8</td> </tr> <tr> <td>string Chaine avec URL</td> <td>8</td> </tr> <tr> <td>string free ref or last ref</td> <td>8</td> </tr> <tr> <td>string String escaped</td> <td>8</td> </tr> <tr> <td>string Version string</td> <td>8</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>8</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>8</td> </tr> <tr> <td>int New id of clone</td> <td>8</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>8</td> </tr> <tr> <td>string String with URL</td> <td>8</td> </tr> <tr> <td>int if KO: <0 || if OK: >0</td> <td>8</td> </tr> <tr> <td>string Label of status</td> <td>8</td> </tr> <tr> <td>int mask</td> <td>8</td> </tr> <tr> <td>TokenStorageInterface</td> <td>8</td> </tr> <tr> <td>Cell</td> <td>8</td> </tr> <tr> <td>boolean true if successful</td> <td>8</td> </tr> <tr> <td>\Illuminate\Routing\Route</td> <td>8</td> </tr> <tr> <td>\Stripe\BankAccount|\Stripe\Card</td> <td>8</td> </tr> <tr> <td>\Stripe\Person</td> <td>8</td> </tr> <tr> <td>\Stripe\Customer</td> <td>8</td> </tr> <tr> <td>array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11</td> <td>8</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>8</td> </tr> <tr> <td>int 1=OK, 0=KO</td> <td>9</td> </tr> <tr> <td>array Array of order objects</td> <td>9</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>9</td> </tr> <tr> <td>int Return integer <0 if KO, >=0 if OK</td> <td>9</td> </tr> <tr> <td>string|0 Value if OK, 0 if KO</td> <td>9</td> </tr> <tr> <td>boolean false if KO (there is a conflict), true if OK</td> <td>9</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>9</td> </tr> <tr> <td>resource</td> <td>9</td> </tr> <tr> <td>array[]</td> <td>9</td> </tr> <tr> <td>int value</td> <td>9</td> </tr> <tr> <td>bool Success or failure</td> <td>9</td> </tr> <tr> <td>Style</td> <td>9</td> </tr> <tr> <td>\Stripe\BankAccount|\Stripe\Card|\Stripe\Source</td> <td>9</td> </tr> <tr> <td>\Stripe\PaymentIntent</td> <td>9</td> </tr> <tr> <td>int Return integer < 0 on error, > 0 on success</td> <td>9</td> </tr> <tr> <td>array Array of tabs</td> <td>10</td> </tr> <tr> <td>string Return img tag</td> <td>10</td> </tr> <tr> <td>string|false</td> <td>10</td> </tr> <tr> <td>array Array of values</td> <td>10</td> </tr> <tr> <td>array List of tables in an array</td> <td>10</td> </tr> <tr> <td>array Array of key-values (key=>value)</td> <td>10</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>10</td> </tr> <tr> <td>int|string</td> <td>10</td> </tr> <tr> <td>int|string Nb of recipient, or <0 if error, or '' if NA</td> <td>10</td> </tr> <tr> <td>string|-1 Value if OK, -1 if KO</td> <td>10</td> </tr> <tr> <td>string Label</td> <td>10</td> </tr> <tr> <td>int New id of clone</td> <td>10</td> </tr> <tr> <td>int|static</td> <td>10</td> </tr> <tr> <td>\Stripe\Invoice</td> <td>10</td> </tr> <tr> <td>\Stripe\Terminal\Reader</td> <td>10</td> </tr> <tr> <td>array head array with tabs</td> <td>11</td> </tr> <tr> <td>boolean True if OK</td> <td>11</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>11</td> </tr> <tr> <td>int Error count (0 if OK)</td> <td>11</td> </tr> <tr> <td>DateTimeImmutable</td> <td>11</td> </tr> <tr> <td>Decoded data string.</td> <td>11</td> </tr> <tr> <td>int[]</td> <td>11</td> </tr> <tr> <td>Border</td> <td>11</td> </tr> <tr> <td>mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,</td> <td>11</td> </tr> <tr> <td>boolean false if conflict, true if ok</td> <td>12</td> </tr> <tr> <td>string Chaine avec URL</td> <td>12</td> </tr> <tr> <td>boolean Validity is ok or not</td> <td>12</td> </tr> <tr> <td>bool|string</td> <td>13</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>13</td> </tr> <tr> <td>int|null</td> <td>13</td> </tr> <tr> <td>array Array of values</td> <td>13</td> </tr> <tr> <td>UriInterface</td> <td>13</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>14</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>14</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>14</td> </tr> <tr> <td>array Return a substitution array</td> <td>14</td> </tr> <tr> <td>boolean false if conflict, true if ok</td> <td>14</td> </tr> <tr> <td>object</td> <td>15</td> </tr> <tr> <td>int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)</td> <td>15</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>15</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>15</td> </tr> <tr> <td>int Position pour suite</td> <td>15</td> </tr> <tr> <td>static|mixed</td> <td>15</td> </tr> <tr> <td>array|int array of lines if OK, <0 if KO</td> <td>16</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>16</td> </tr> <tr> <td>static|false</td> <td>16</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>17</td> </tr> <tr> <td>array barcode representation.</td> <td>17</td> </tr> <tr> <td>Worksheet</td> <td>17</td> </tr> <tr> <td>Object Updated object</td> <td>18</td> </tr> <tr> <td>int >0 if OK, <0 if KO</td> <td>18</td> </tr> <tr> <td>array Array of tabs</td> <td>19</td> </tr> <tr> <td>Query</td> <td>19</td> </tr> <tr> <td>int Return height of bottom margin including footer text</td> <td>20</td> </tr> <tr> <td>string Object free reference</td> <td>21</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>21</td> </tr> <tr> <td>string Description</td> <td>21</td> </tr> <tr> <td>int 1 if OK, <=0 if KO</td> <td>21</td> </tr> <tr> <td>Spreadsheet</td> <td>22</td> </tr> <tr> <td>float|string Result, or a string containing an error</td> <td>23</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>24</td> </tr> <tr> <td>int Return integer <=0 if OK, 0=Nothing done, >0 if KO</td> <td>24</td> </tr> <tr> <td>array|null</td> <td>24</td> </tr> <tr> <td>string Hash code</td> <td>24</td> </tr> <tr> <td>CarbonInterface</td> <td>24</td> </tr> <tr> <td>\Illuminate\Support\Collection</td> <td>25</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>25</td> </tr> <tr> <td>null|string</td> <td>25</td> </tr> <tr> <td>array Array result</td> <td>26</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>26</td> </tr> <tr> <td>integer</td> <td>27</td> </tr> <tr> <td>string String with URL</td> <td>27</td> </tr> <tr> <td>float|string The result, or a string containing an error</td> <td>27</td> </tr> <tr> <td>array|int int <0 if KO, array of pages if OK</td> <td>28</td> </tr> <tr> <td>float|int Return topshift value</td> <td>28</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>29</td> </tr> <tr> <td>string XML Output</td> <td>30</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>31</td> </tr> <tr> <td>bool success</td> <td>31</td> </tr> <tr> <td>string String with URL</td> <td>32</td> </tr> <tr> <td>mixed New object created, <0 if KO</td> <td>34</td> </tr> <tr> <td>WhereQuery</td> <td>34</td> </tr> <tr> <td>self</td> <td>35</td> </tr> <tr> <td>int 0 if KO, 1 if OK</td> <td>37</td> </tr> <tr> <td>array List of templates</td> <td>41</td> </tr> <tr> <td>array Array of tabs to show</td> <td>42</td> </tr> <tr> <td>int Return integer <0 if KO, Id of created object if OK</td> <td>43</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>46</td> </tr> <tr> <td>int Return integer <0 if KO, 0=Nothing done, >0 if OK</td> <td>48</td> </tr> <tr> <td>string HTML Code for Kanban thumb.</td> <td>50</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>51</td> </tr> <tr> <td>string[]</td> <td>52</td> </tr> <tr> <td>Object Object with cleaned properties</td> <td>53</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>55</td> </tr> <tr> <td>boolean</td> <td>61</td> </tr> <tr> <td>string Descriptive text</td> <td>65</td> </tr> <tr> <td>float|string</td> <td>65</td> </tr> <tr> <td>int 1 if OK, 0 if KO</td> <td>66</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>67</td> </tr> <tr> <td>int Return integer <0 if KO, 0 if not found, >0 if OK</td> <td>69</td> </tr> <tr> <td>string Example</td> <td>71</td> </tr> <tr> <td>int Return integer <0 if KO, >0 if OK</td> <td>122</td> </tr> <tr> <td>string|null</td> <td>125</td> </tr> <tr> <td>string Label of status</td> <td>128</td> </tr> <tr> <td>float</td> <td>137</td> </tr> <tr> <td>mixed</td> <td>372</td> </tr> <tr> <td>static</td> <td>522</td> </tr> <tr> <td>int</td> <td>553</td> </tr> <tr> <td>$this</td> <td>654</td> </tr> <tr> <td>bool</td> <td>888</td> </tr> <tr> <td>array</td> <td>924</td> </tr> <tr> <td>void</td> <td>1217</td> </tr> <tr> <td>string</td> <td>1464</td> </tr> <tr> <td rowspan="3" style="vertical-align: top;">@returns</td> <td>Point The outermost point</td> <td>1</td> </tr> <tr> <td>boolean Whether a skippable header was found.</td> <td>1</td> </tr> <tr> <td>string</td> <td>1</td> </tr> <tr> <td rowspan="605" style="vertical-align: top;">@see</td> <td>dol_hash(), dolJSToSetRandomPassword()</td> <td>1</td> </tr> <tr> <td>getRandomPassword()</td> <td>1</td> </tr> <tr> <td>dol_decode()</td> <td>1</td> </tr> <tr> <td>dol_encode()</td> <td>1</td> </tr> <tr> <td>dolDecrypt(), dol_hash()</td> <td>1</td> </tr> <tr> <td>dolEncrypt(), dol_hash()</td> <td>1</td> </tr> <tr> <td>getRandomPassword(), dol_verifyHash()</td> <td>1</td> </tr> <tr> <td>dol_hash()</td> <td>1</td> </tr> <tr> <td>dol_check_secure_access_document(), checkUserAccessToObject()</td> <td>1</td> </tr> <tr> <td>accessforbidden()</td> <td>1</td> </tr> <tr> <td>httponly_accessforbidden()</td> <td>1</td> </tr> <tr> <td>versiontostring()</td> <td>1</td> </tr> <tr> <td>dolibarr_get_const(), dolibarr_set_const(), dol_set_user_param()</td> <td>1</td> </tr> <tr> <td>dolibarr_del_const(), dolibarr_set_const(), dol_set_user_param()</td> <td>1</td> </tr> <tr> <td>dolibarr_del_const(), dolibarr_get_const(), dol_set_user_param()</td> <td>1</td> </tr> <tr> <td>dolStripPhpCode(), checkPHPCode()</td> <td>1</td> </tr> <tr> <td>dolWebsiteOutput() for function used to replace content in a web server context</td> <td>1</td> </tr> <tr> <td>dolWebsiteReplacementOfLinks() for function used to replace content in the backoffice context.</td> <td>1</td> </tr> <tr> <td>getNbOfImagePublicURLOfObject()</td> <td>1</td> </tr> <tr> <td>dolibarr_get_const(), dolibarr_set_const(), dolibarr_del_const()</td> <td>1</td> </tr> <tr> <td>versionphparray(), versioncompare()</td> <td>1</td> </tr> <tr> <td>versiondolibarrarray(), versioncompare()</td> <td>1</td> </tr> <tr> <td>colorStringToArray(), colorHexToRgb()</td> <td>1</td> </tr> <tr> <td>colorArrayToHex(), colorHexToRgb()</td> <td>1</td> </tr> <tr> <td>colorAdjustBrightness()</td> <td>1</td> </tr> <tr> <td>colorAgressiveness()</td> <td>1</td> </tr> <tr> <td>price2num() Format a numeric into a price for FEC files</td> <td>1</td> </tr> <tr> <td>rebuildObjectSql()</td> <td>1</td> </tr> <tr> <td>rebuildObjectClass()</td> <td>1</td> </tr> <tr> <td>json_encode()</td> <td>1</td> </tr> <tr> <td>json_decode()</td> <td>1</td> </tr> <tr> <td>convertSecondToTime(), convertTimeToSeconds()</td> <td>1</td> </tr> <tr> <td>convertSecondToTime()</td> <td>1</td> </tr> <tr> <td>convertTime2Seconds()</td> <td>1</td> </tr> <tr> <td>dol_print_date(), dol_mktime(), dol_getdate()</td> <td>1</td> </tr> <tr> <td>num_between_day(), num_open_day()</td> <td>1</td> </tr> <tr> <td>also num_public_holiday(), num_open_day()</td> <td>1</td> </tr> <tr> <td>selectArrayAjax() of html.form.class</td> <td>1</td> </tr> <tr> <td>dolSavePageContent()</td> <td>1</td> </tr> <tr> <td>dolSavePageAlias()</td> <td>1</td> </tr> <tr> <td>dol_dir_list_in_database()</td> <td>1</td> </tr> <tr> <td>dol_dir_list()</td> <td>1</td> </tr> <tr> <td>dol_nboflines()</td> <td>1</td> </tr> <tr> <td>dol_print_size()</td> <td>1</td> </tr> <tr> <td>dol_copy(), dolCopyDir()</td> <td>1</td> </tr> <tr> <td>dol_delete_file(), dolCopyDir()</td> <td>1</td> </tr> <tr> <td>dol_copy()</td> <td>1</td> </tr> <tr> <td>dol_move_uploaded_file()</td> <td>1</td> </tr> <tr> <td>dol_move()</td> <td>1</td> </tr> <tr> <td>dol_delete_dir()</td> <td>1</td> </tr> <tr> <td>dol_delete_file() dolCopyDir()</td> <td>1</td> </tr> <tr> <td>dol_remove_file_process()</td> <td>1</td> </tr> <tr> <td>dol_add_file_process()</td> <td>1</td> </tr> <tr> <td>dol_imageResizeOrCrop()</td> <td>1</td> </tr> <tr> <td>dol_uncompress(), dol_compress_dir()</td> <td>1</td> </tr> <tr> <td>dol_compress_file(), dol_compress_dir()</td> <td>1</td> </tr> <tr> <td>dol_uncompress(), dol_compress_file()</td> <td>1</td> </tr> <tr> <td>getDolUserString()</td> <td>1</td> </tr> <tr> <td>getDolUserInt()</td> <td>1</td> </tr> <tr> <td>https://php.net/manual/language.oop5.cloning.php</td> <td>1</td> </tr> <tr> <td>dol_string_nospecial(), dol_string_unaccent(), dol_sanitizePathName()</td> <td>1</td> </tr> <tr> <td>dol_string_nospecial(), dol_string_unaccent(), dol_sanitizeFileName()</td> <td>1</td> </tr> <tr> <td>dol_sanitizeFilename(), dol_string_nospecial()</td> <td>1</td> </tr> <tr> <td>dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nounprintableascii()</td> <td>1</td> </tr> <tr> <td>dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()</td> <td>1</td> </tr> <tr> <td>dolPrintHTMLForAttribute(), dolPrintHTMLFortextArea()</td> <td>1</td> </tr> <tr> <td>dolPrintHTML(), dolPrintHTMLFortextArea()</td> <td>1</td> </tr> <tr> <td>dolPrintHTML(), dolPrintHTMLForAttribute()</td> <td>1</td> </tr> <tr> <td>dol_string_nohtmltag(), dol_string_onlythesehtmltags(), dol_string_nospecial(), dol_string_unaccent(), dol_htmlentitiesbr()</td> <td>1</td> </tr> <tr> <td>dol_ucfirst(), dol_ucwords()</td> <td>1</td> </tr> <tr> <td>dol_strtoupper(), dol_ucwords()</td> <td>1</td> </tr> <tr> <td>dol_strtoupper(), dol_ucfirst()</td> <td>1</td> </tr> <tr> <td>dol_print_address()</td> <td>1</td> </tr> <tr> <td>dol_stringtotime()</td> <td>1</td> </tr> <tr> <td>dol_mktime(), dol_stringtotime(), dol_getdate(), selectDate()</td> <td>1</td> </tr> <tr> <td>dol_print_date(), dol_stringtotime(), dol_mktime()</td> <td>1</td> </tr> <tr> <td>dol_print_date(), dol_stringtotime(), dol_getdate()</td> <td>1</td> </tr> <tr> <td>dol_format_address()</td> <td>1</td> </tr> <tr> <td>isValidMXRecord()</td> <td>1</td> </tr> <tr> <td>isValidEmail()</td> <td>1</td> </tr> <tr> <td>img_object(), img_picto_common()</td> <td>1</td> </tr> <tr> <td>img_picto(), img_picto_common()</td> <td>1</td> </tr> <tr> <td>load_fiche_titre()</td> <td>1</td> </tr> <tr> <td>print_barre_liste()</td> <td>1</td> </tr> <tr> <td>price2num() Revert function of price</td> <td>1</td> </tr> <tr> <td>price() Opposite function of price2num</td> <td>1</td> </tr> <tr> <td>get_default_tva()</td> <td>1</td> </tr> <tr> <td>getTaxesFromId()</td> <td>1</td> </tr> <tr> <td>get_default_tva(), get_product_localtax_for_country()</td> <td>1</td> </tr> <tr> <td>get_product_vat_for_country()</td> <td>1</td> </tr> <tr> <td>get_default_localtax(), get_default_npr()</td> <td>1</td> </tr> <tr> <td>get_default_tva(), get_default_localtax()</td> <td>1</td> </tr> <tr> <td>get_default_tva(), get_default_npr()</td> <td>1</td> </tr> <tr> <td>getMultidirOutput()</td> <td>1</td> </tr> <tr> <td>dol_escape_htmltag() strip_tags() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags(), dolStripPhpCode()</td> <td>1</td> </tr> <tr> <td>dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_neverthesehtmltags()</td> <td>1</td> </tr> <tr> <td>dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags()</td> <td>1</td> </tr> <tr> <td>dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_onlythesehtmlattributes()</td> <td>1</td> </tr> <tr> <td>dol_nboflines_bis(), dol_string_nohtmltag(), dol_escape_htmltag()</td> <td>1</td> </tr> <tr> <td>dol_htmlentitiesbr(), dol_nboflines(), dolGetFirstLineOfText()</td> <td>1</td> </tr> <tr> <td>dol_escape_htmltag(), dolGetFirstLineOfText(), dol_string_onlythesehtmltags()</td> <td>1</td> </tr> <tr> <td>dol_htmlentitiesbr()</td> <td>1</td> </tr> <tr> <td>ascii_check()</td> <td>1</td> </tr> <tr> <td>dol_nboflines_bis(), dolGetFirstLineOfText()</td> <td>1</td> </tr> <tr> <td>dol_nboflines(), dolGetFirstLineOfText()</td> <td>1</td> </tr> <tr> <td>dol_concatdesc()</td> <td>1</td> </tr> <tr> <td>dol_textishtml()</td> <td>1</td> </tr> <tr> <td>setSubstitFromObject()</td> <td>1</td> </tr> <tr> <td>complete_substitutions_array(), getCommonSubstitutionArray()</td> <td>1</td> </tr> <tr> <td>make_substitutions()</td> <td>1</td> </tr> <tr> <td>utf8_valid()</td> <td>1</td> </tr> <tr> <td>utf8_check()</td> <td>1</td> </tr> <tr> <td>$langs->getLabelFromKey</td> <td>1</td> </tr> <tr> <td>verifCond()</td> <td>1</td> </tr> <tr> <td>dol_mimetype(), image_format_supported() from images.lib.php</td> <td>1</td> </tr> <tr> <td>dolIsAllowedForPreview(), image_format_supported() from images.lib.php</td> <td>1</td> </tr> <tr> <td>fetchObjectByElement(), getMultidirOutput()</td> <td>1</td> </tr> <tr> <td>finishSimpleTable()</td> <td>1</td> </tr> <tr> <td>startSimpleTable()</td> <td>1</td> </tr> <tr> <td>getTaskProgressBadge()</td> <td>1</td> </tr> <tr> <td>getTaskProgressView()</td> <td>1</td> </tr> <tr> <td>measuringUnitString() formproduct->selectMeasuringUnits()</td> <td>1</td> </tr> <tr> <td>formproduct->selectMeasuringUnits()</td> <td>1</td> </tr> <tr> <td>dol_getcache()</td> <td>1</td> </tr> <tr> <td>dol_setcache()</td> <td>1</td> </tr> <tr> <td>getStringHeight()</td> <td>1</td> </tr> <tr> <td>http://phpdebugbar.com/docs/base-collectors.html#base-collectors</td> <td>1</td> </tr> <tr> <td>https://www.php-fig.org/psr/psr-0/</td> <td>1</td> </tr> <tr> <td>https://www.php-fig.org/psr/psr-4/</td> <td>1</td> </tr> <tr> <td>http://en.wikipedia.org/wiki/Geohash</td> <td>1</td> </tr> <tr> <td>https://math.nist.gov/javanumerics/jama/</td> <td>1</td> </tr> <tr> <td>https://developers.google.com/google-apps/gmail/xoauth2_protocol</td> <td>1</td> </tr> <tr> <td>\Illuminate\Translation\Translator</td> <td>1</td> </tr> <tr> <td>\Illuminate\Hashing\HashManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Validation\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Events\Dispatcher</td> <td>1</td> </tr> <tr> <td>\Illuminate\Auth\AuthManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Guard</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\StatefulGuard</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Foundation\Application</td> <td>1</td> </tr> <tr> <td>\Illuminate\Mail\Mailer</td> <td>1</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\MailFake</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Auth\Access\Gate</td> <td>1</td> </tr> <tr> <td>\Illuminate\Cache\RateLimiter</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Routing\ResponseFactory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Cache\CacheManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Cache\Repository</td> <td>1</td> </tr> <tr> <td>\Illuminate\Session\SessionManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Session\Store</td> <td>1</td> </tr> <tr> <td>\Illuminate\Filesystem\Filesystem</td> <td>1</td> </tr> <tr> <td>\Illuminate\Cookie\CookieJar</td> <td>1</td> </tr> <tr> <td>\Illuminate\Http\Client\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Config\Repository</td> <td>1</td> </tr> <tr> <td>\Illuminate\Queue\QueueManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Queue\Queue</td> <td>1</td> </tr> <tr> <td>\Illuminate\Routing\UrlGenerator</td> <td>1</td> </tr> <tr> <td>\Illuminate\Http\Request</td> <td>1</td> </tr> <tr> <td>\Illuminate\Auth\Passwords\PasswordBroker</td> <td>1</td> </tr> <tr> <td>\Illuminate\Database\DatabaseManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Database\Connection</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Console\Kernel</td> <td>1</td> </tr> <tr> <td>\Illuminate\Routing\Router</td> <td>1</td> </tr> <tr> <td>\Illuminate\Redis\RedisManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Redis\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\View\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Filesystem\FilesystemManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\Log\Logger</td> <td>1</td> </tr> <tr> <td>\Illuminate\Database\Schema\Builder</td> <td>1</td> </tr> <tr> <td>\Illuminate\Routing\Redirector</td> <td>1</td> </tr> <tr> <td>\Illuminate\Encryption\Encrypter</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Bus\Dispatcher</td> <td>1</td> </tr> <tr> <td>\Illuminate\Notifications\ChannelManager</td> <td>1</td> </tr> <tr> <td>\Illuminate\View\Compilers\BladeCompiler</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Broadcasting\Factory</td> <td>1</td> </tr> <tr> <td>\Illuminate\Testing\ParallelTesting</td> <td>1</td> </tr> <tr> <td>\Twig\Extension\ProfilerExtension, \Twig\Profiler\Profile</td> <td>1</td> </tr> <tr> <td>\Twig_Extension_Profiler, \Twig_Profiler_Profile</td> <td>1</td> </tr> <tr> <td>https://developer.vimeo.com/api/authentication#scope</td> <td>1</td> </tr> <tr> <td>#attributes</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/api/cards/object#card_object-tokenization_method</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/api/cards/object#card_object-cvc_check</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/api/cards/object#card_object-funding</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/declines/codes</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/api/radar/reviews/object</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/error-codes</td> <td>1</td> </tr> <tr> <td>https://stripe.com/docs/api/external_account_bank_accounts/object#account_bank_account_object-status</td> <td>1</td> </tr> <tr> <td>CommonObject::call_trigger()</td> <td>1</td> </tr> <tr> <td>$price_ht</td> <td>1</td> </tr> <tr> <td>LoanSchedule::fetchAll()</td> <td>1</td> </tr> <tr> <td>$product_ref</td> <td>1</td> </tr> <tr> <td>$product_label</td> <td>1</td> </tr> <tr> <td>$cache_currencies</td> <td>1</td> </tr> <tr> <td>fetch_projet()</td> <td>1</td> </tr> <tr> <td>setProject(), project</td> <td>1</td> </tr> <tr> <td>$project</td> <td>1</td> </tr> <tr> <td>fetch_thirdparty()</td> <td>1</td> </tr> <tr> <td>fetch_user()</td> <td>1</td> </tr> <tr> <td>setStatut(), $status</td> <td>1</td> </tr> <tr> <td>setStatut()</td> <td>1</td> </tr> <tr> <td>getFullAddress(), country</td> <td>1</td> </tr> <tr> <td>getFullAddress(), isInEEC(), country</td> <td>1</td> </tr> <tr> <td>getFullAddress(), state</td> <td>1</td> </tr> <tr> <td>getFullAddress(), $state</td> <td>1</td> </tr> <tr> <td>getFullAddress(), $region_code, $region</td> <td>1</td> </tr> <tr> <td>getFullAddress(), $region_id, $region</td> <td>1</td> </tr> <tr> <td>getFullAddress(), $region_id, $region_code</td> <td>1</td> </tr> <tr> <td>fetch_barcode()</td> <td>1</td> </tr> <tr> <td>setPaymentMethods()</td> <td>1</td> </tr> <tr> <td>setTransportMode()</td> <td>1</td> </tr> <tr> <td>$cond_reglement_id</td> <td>1</td> </tr> <tr> <td>setDeliveryAddress()</td> <td>1</td> </tr> <tr> <td>SetBankAccount()</td> <td>1</td> </tr> <tr> <td>$note_private</td> <td>1</td> </tr> <tr> <td>fetchComments()</td> <td>1</td> </tr> <tr> <td>$date_modification</td> <td>1</td> </tr> <tr> <td>$totalpaid</td> <td>1</td> </tr> <tr> <td>$id</td> <td>1</td> </tr> <tr> <td>setIncoterms()</td> <td>1</td> </tr> <tr> <td>SetIncoterms()</td> <td>1</td> </tr> <tr> <td>display_incoterms()</td> <td>1</td> </tr> <tr> <td>https://wiki.dolibarr.org/index.php/List_of_modules_id</td> <td>1</td> </tr> <tr> <td>$familyinfo</td> <td>1</td> </tr> <tr> <td>$family</td> <td>1</td> </tr> <tr> <td>http://semver.org</td> <td>1</td> </tr> <tr> <td>$requiredby</td> <td>1</td> </tr> <tr> <td>atLeastOneBatch()</td> <td>1</td> </tr> <tr> <td>FactureFournisseur::STATUS_DRAFT, FactureFournisseur::STATUS_VALIDATED, FactureFournisseur::STATUS_PAID, FactureFournisseur::STATUS_ABANDONED</td> <td>1</td> </tr> <tr> <td>$subprice</td> <td>1</td> </tr> <tr> <td>$fk_commande</td> <td>1</td> </tr> <tr> <td>$currency_code</td> <td>1</td> </tr> <tr> <td>$accountid</td> <td>1</td> </tr> <tr> <td>http://php.net/manual/en/function.imap-open.php</td> <td>1</td> </tr> <tr> <td>calcSheetOffsets()</td> <td>1</td> </tr> <tr> <td>addContinue()</td> <td>1</td> </tr> <tr> <td>RFC6376 3.3: Signers MUST implement and SHOULD sign using rsa-sha256.</td> <td>1</td> </tr> <tr> <td>$name</td> <td>1</td> </tr> <tr> <td>$state_code</td> <td>1</td> </tr> <tr> <td>$state</td> <td>1</td> </tr> <tr> <td>$country</td> <td>1</td> </tr> <tr> <td>$idprof1</td> <td>1</td> </tr> <tr> <td>$idprof2</td> <td>1</td> </tr> <tr> <td>$idprof3</td> <td>1</td> </tr> <tr> <td>$code_compta_client</td> <td>1</td> </tr> <tr> <td>$note_public, $note_private</td> <td>1</td> </tr> <tr> <td>$status_buy</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_PRODUCT</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_SUPPLIER</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_CUSTOMER</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_MEMBER</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_CONTACT</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_USER</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_PROJECT</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_ACCOUNT</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_BANK_LINE</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_WAREHOUSE</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_ACTIONCOMM</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_WEBSITE_PAGE</td> <td>1</td> </tr> <tr> <td>Categorie::TYPE_TICKET</td> <td>1</td> </tr> <tr> <td>()</td> <td>1</td> </tr> <tr> <td>activateAll()</td> <td>1</td> </tr> <tr> <td>verifDateHolidayForTimestamp()</td> <td>1</td> </tr> <tr> <td>verifDateHolidayCP()</td> <td>1</td> </tr> <tr> <td>sendEmail()</td> <td>1</td> </tr> <tr> <td>updateRoles()</td> <td>1</td> </tr> <tr> <td>fetchRoles()</td> <td>1</td> </tr> <tr> <td>getCats(), getCptsCat()</td> <td>1</td> </tr> <tr> <td>getCatsCpts(), getCptsCat()</td> <td>1</td> </tr> <tr> <td>getCats(), getCatsCpts()</td> <td>1</td> </tr> <tr> <td>getSumDepositsUsed(), getSumCreditNotesUsed()</td> <td>1</td> </tr> <tr> <td>getSommePaiement(), getSumCreditNotesUsed()</td> <td>1</td> </tr> <tr> <td>getSommePaiement(), getSumDepositsUsed()</td> <td>1</td> </tr> <tr> <td>$error Empty string '' if no error.</td> <td>1</td> </tr> <tr> <td>textwithpicto() Use textwithpicto() instead of textwithtooltip if you can.</td> <td>1</td> </tr> <tr> <td>select_company()</td> <td>1</td> </tr> <tr> <td>select_categories()</td> <td>1</td> </tr> <tr> <td>selectDate()</td> <td>1</td> </tr> <tr> <td>multiselectarray(), selectArrayAjax(), selectArrayFilter()</td> <td>1</td> </tr> <tr> <td>selectArrayFilter(), ajax_combobox() in ajax.lib.php</td> <td>1</td> </tr> <tr> <td>selectArrayAjax(), ajax_combobox() in ajax.lib.php</td> <td>1</td> </tr> <tr> <td>selectarray(), selectArrayAjax(), selectArrayFilter()</td> <td>1</td> </tr> <tr> <td>selectarray()</td> <td>1</td> </tr> <tr> <td>select_all_categories()</td> <td>1</td> </tr> <tr> <td>showColor()</td> <td>1</td> </tr> <tr> <td>select_juridicalstatus()</td> <td>1</td> </tr> <tr> <td>loadLangs()</td> <td>1</td> </tr> <tr> <td>transcountrynoentities(), picto_from_langcode()</td> <td>1</td> </tr> <tr> <td>transcountry(), picto_from_langcode()</td> <td>1</td> </tr> <tr> <td>dol_getIdFromCode()</td> <td>1</td> </tr> <tr> <td>price()</td> <td>1</td> </tr> <tr> <td>https://wiki.dolibarr.org/index.php/Canvas_development</td> <td>1</td> </tr> <tr> <td>updateExtraField()</td> <td>1</td> </tr> <tr> <td>fetchObjectLinked(), updateObjectLinked(), deleteObjectLinked()</td> <td>1</td> </tr> <tr> <td>add_object_linked(), updateObjectLinked(), deleteObjectLinked()</td> <td>1</td> </tr> <tr> <td>fetchObjectLinked()</td> <td>1</td> </tr> <tr> <td>add_object_linked(), fetObjectLinked(), deleteObjectLinked()</td> <td>1</td> </tr> <tr> <td>add_object_linked(), updateObjectLinked(), fetchObjectLinked()</td> <td>1</td> </tr> <tr> <td>addFileIntoDatabaseIndex()</td> <td>1</td> </tr> <tr> <td>fetch_optionnals()</td> <td>1</td> </tr> <tr> <td>fetchValuesForExtraLanguages()</td> <td>1</td> </tr> <tr> <td>deleteExtraLanguages(), insertExtraField(), updateExtraField(), setValueFrom()</td> <td>1</td> </tr> <tr> <td>insertExtraLanguages(), updateExtraField(), deleteExtraField(), setValueFrom()</td> <td>1</td> </tr> <tr> <td>insertExtraFields(), updateExtraField(), setValueFrom()</td> <td>1</td> </tr> <tr> <td>updateExtraLanguages(), insertExtraFields(), deleteExtraFields(), setValueFrom()</td> <td>1</td> </tr> <tr> <td>updateExtraField(), insertExtraLanguages()</td> <td>1</td> </tr> <tr> <td>connect_bind renamed</td> <td>1</td> </tr> <tr> <td>unbind()</td> <td>1</td> </tr> <tr> <td>dump_content renamed</td> <td>1</td> </tr> <tr> <td>bind</td> <td>1</td> </tr> <tr> <td>bindauth</td> <td>1</td> </tr> <tr> <td>getName()</td> <td>1</td> </tr> <tr> <td>getCommonSubstitutionArray()</td> <td>1</td> </tr> <tr> <td>list_of_autoecmfiles()</td> <td>1</td> </tr> <tr> <td>list_of_documents()</td> <td>1</td> </tr> <tr> <td>draw_jflot() for syntax of data array</td> <td>1</td> </tr> <tr> <td>getArrayAddress()</td> <td>1</td> </tr> <tr> <td>getValidAddress()</td> <td>1</td> </tr> <tr> <td>getDefaultCollationDatabase()</td> <td>1</td> </tr> <tr> <td>getDefaultCharacterSetDatabase()</td> <td>1</td> </tr> <tr> <td>find_min_price_product_fournisseur()</td> <td>1</td> </tr> <tr> <td>list_product_fournisseur_price()</td> <td>1</td> </tr> <tr> <td>setDiscount()</td> <td>1</td> </tr> <tr> <td>useDetailedBBAN()</td> <td>1</td> </tr> <tr> <td>EnregDestinataireSEPA()</td> <td>1</td> </tr> <tr> <td>EnregDestinataire()</td> <td>1</td> </tr> <tr> <td>EnregEmetteurSEPA()</td> <td>1</td> </tr> <tr> <td>EnregEmetteur()</td> <td>1</td> </tr> <tr> <td>getAmountsArray()</td> <td>1</td> </tr> <tr> <td>getBillsArray()</td> <td>1</td> </tr> <tr> <td>getPropertiesIteratorForPath()</td> <td>1</td> </tr> <tr> <td>GeoAdapter::write()</td> <td>1</td> </tr> <tr> <td>GeoAdapter::read()</td> <td>1</td> </tr> <tr> <td>https://github.com/davetroy/geohash-js</td> <td>1</td> </tr> <tr> <td>https://github.com/lyokato/objc-geohash</td> <td>1</td> </tr> <tr> <td>https://github.com/lyokato/libgeohash</td> <td>1</td> </tr> <tr> <td>https://github.com/masuidrive/pr_geohash</td> <td>1</td> </tr> <tr> <td>https://github.com/sunng87/node-geohash</td> <td>1</td> </tr> <tr> <td>https://github.com/davidmoten/geo</td> <td>1</td> </tr> <tr> <td>http://en.wikipedia.org/wiki/Point%5Fin%5Fpolygon</td> <td>1</td> </tr> <tr> <td>Image()</td> <td>1</td> </tr> <tr> <td>SetY(), GetX(), SetX()</td> <td>1</td> </tr> <tr> <td>SetX(), SetY()</td> <td>1</td> </tr> <tr> <td>Close()</td> <td>1</td> </tr> <tr> <td>getPageSizeFromFormat()</td> <td>1</td> </tr> <tr> <td>Line(), Rect(), Cell(), MultiCell()</td> <td>1</td> </tr> <tr> <td>Line(), SetLineWidth()</td> <td>1</td> </tr> <tr> <td>SetLineWidth(), SetDrawColor(), SetLineStyle()</td> <td>1</td> </tr> <tr> <td>SetLineStyle()</td> <td>1</td> </tr> <tr> <td>SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()</td> <td>1</td> </tr> <tr> <td>SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()</td> <td>1</td> </tr> <tr> <td>SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()</td> <td>1</td> </tr> <tr> <td>SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()</td> <td>1</td> </tr> <tr> <td>getCellPaddings(), setCellPaddings()</td> <td>1</td> </tr> <tr> <td>getCellPaddings(), SetCellPadding()</td> <td>1</td> </tr> <tr> <td>setCellPaddings(), SetCellPadding()</td> <td>1</td> </tr> <tr> <td>getCellMargins()</td> <td>1</td> </tr> <tr> <td>setCellMargins()</td> <td>1</td> </tr> <tr> <td>Cell(), MultiCell(), AcceptPageBreak()</td> <td>1</td> </tr> <tr> <td>SetAuthor(), SetCreator(), SetKeywords(), SetSubject()</td> <td>1</td> </tr> <tr> <td>SetAuthor(), SetCreator(), SetKeywords(), SetTitle()</td> <td>1</td> </tr> <tr> <td>SetCreator(), SetKeywords(), SetSubject(), SetTitle()</td> <td>1</td> </tr> <tr> <td>SetAuthor(), SetCreator(), SetSubject(), SetTitle()</td> <td>1</td> </tr> <tr> <td>SetAuthor(), SetKeywords(), SetSubject(), SetTitle()</td> <td>1</td> </tr> <tr> <td>AddPage(), Close()</td> <td>1</td> </tr> <tr> <td>Open(), Output()</td> <td>1</td> </tr> <tr> <td>getPage(), lastpage(), getNumPages()</td> <td>1</td> </tr> <tr> <td>setPage(), getPage(), getNumPages()</td> <td>1</td> </tr> <tr> <td>setPage(), lastpage(), getNumPages()</td> <td>1</td> </tr> <tr> <td>setPage(), getPage(), lastpage()</td> <td>1</td> </tr> <tr> <td>AddPage(), startPage(), endPage(), endTOCPage()</td> <td>1</td> </tr> <tr> <td>AddPage(), startPage(), endPage(), addTOCPage()</td> <td>1</td> </tr> <tr> <td>startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()</td> <td>1</td> </tr> <tr> <td>AddPage(), startPage(), addTOCPage(), endTOCPage()</td> <td>1</td> </tr> <tr> <td>AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()</td> <td>1</td> </tr> <tr> <td>getAliasNbPages()</td> <td>1</td> </tr> <tr> <td>SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor()</td> <td>1</td> </tr> <tr> <td>AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()</td> <td>1</td> </tr> <tr> <td>AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()</td> <td>1</td> </tr> <tr> <td>AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()</td> <td>1</td> </tr> <tr> <td>SetDrawColor()</td> <td>1</td> </tr> <tr> <td>SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()</td> <td>1</td> </tr> <tr> <td>SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()</td> <td>1</td> </tr> <tr> <td>SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()</td> <td>1</td> </tr> <tr> <td>SetFont(), setFontSubsetting()</td> <td>1</td> </tr> <tr> <td>AddFont(), SetFontSize()</td> <td>1</td> </tr> <tr> <td>SetFont()</td> <td>1</td> </tr> <tr> <td>Cell(), Write(), Image(), Link(), SetLink()</td> <td>1</td> </tr> <tr> <td>AddLink()</td> <td>1</td> </tr> <tr> <td>AddLink(), Annotation(), Cell(), Write(), Image()</td> <td>1</td> </tr> <tr> <td>Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()</td> <td>1</td> </tr> <tr> <td>SetAutoPageBreak()</td> <td>1</td> </tr> <tr> <td>SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()</td> <td>1</td> </tr> <tr> <td>SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()</td> <td>1</td> </tr> <tr> <td>Multicell(), writeHTML()</td> <td>1</td> </tr> <tr> <td>addTOCPage(), endTOCPage(), addHTMLTOC()</td> <td>1</td> </tr> <tr> <td>addTOCPage(), endTOCPage(), addTOC()</td> <td>1</td> </tr> <tr> <td>endTemplate(), printTemplate()</td> <td>1</td> </tr> <tr> <td>startTemplate(), printTemplate()</td> <td>1</td> </tr> <tr> <td>startTemplate(), endTemplate()</td> <td>1</td> </tr> <tr> <td>setPageRegions(), addPageRegion()</td> <td>1</td> </tr> <tr> <td>addPageRegion(), getPageRegions()</td> <td>1</td> </tr> <tr> <td>addTOC(), addHTMLTOC()</td> <td>1</td> </tr> <tr> <td>https://www.etsy.com/developers/documentation/getting_started/oauth#section_permission_scopes</td> <td>1</td> </tr> <tr> <td>https://www.w3.org/TR/xmlschema11-2/#boolean</td> <td>1</td> </tr> <tr> <td>http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214</td> <td>1</td> </tr> <tr> <td>OLE_PPS_File::getStream()</td> <td>1</td> </tr> <tr> <td>getPivot</td> <td>1</td> </tr> <tr> <td>OLE::ascToUcs()</td> <td>1</td> </tr> <tr> <td>save()</td> <td>1</td> </tr> <tr> <td>https://github.com/LibreOffice/core/blob/9fc9bf3240f8c62ad7859947ab8a033ac1fe93fa/sc/source/filter/html/htmlexp.cxx#L1073-L1092</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook::addWorksheet()</td> <td>1</td> </tr> <tr> <td>fact()</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook::storeWorkbook()</td> <td>1</td> </tr> <tr> <td>writeWsbool()</td> <td>1</td> </tr> <tr> <td>asNewInstanceOf(), asSharedInstanceOf(), asValue()</td> <td>1</td> </tr> <tr> <td>withDependencies(), addConstructorValue(), addConstructorLookup()</td> <td>1</td> </tr> <tr> <td>addConstructorValue(), addConstructorLookup()</td> <td>1</td> </tr> <tr> <td>withDependencies(), addConstructorLookup()</td> <td>1</td> </tr> <tr> <td>withDependencies(), addConstructorValue()</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMimeEntity::__clone()</td> <td>1</td> </tr> <tr> <td>http://davenport.sourceforge.net/ntlm.html#theNtlmResponse</td> <td>1</td> </tr> <tr> <td>https://secure.php.net/manual/en/ref.hash.php</td> <td>1</td> </tr> <tr> <td>https://developers.google.com/google-apps/gmail/xoauth2_protocol#the_sasl_xoauth2_mechanism</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::flushContents()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::importByteStream()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::importString()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::read()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::readBytes()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::setPointer()</td> <td>1</td> </tr> <tr> <td>Swift_CharacterStream::write()</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMimeEntity::getIdField() */</td> <td>1</td> </tr> <tr> <td>LEVEL_RELATED}.</td> <td>1</td> </tr> <tr> <td>LEVEL_TOP, LEVEL_MIXED, LEVEL_RELATED, LEVEL_ALTERNATIVE</td> <td>1</td> </tr> <tr> <td>Swift_InputByteStream}.</td> <td>1</td> </tr> <tr> <td>LEVEL_TOP, LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED</td> <td>1</td> </tr> <tr> <td>setAddresses()</td> <td>1</td> </tr> <tr> <td>getAddresses()</td> <td>1</td> </tr> <tr> <td>getNameAddressStrings()</td> <td>1</td> </tr> <tr> <td>setNameAddresses()</td> <td>1</td> </tr> <tr> <td>RFC 2822 3.2.1</td> <td>1</td> </tr> <tr> <td>toString()} for that).</td> <td>1</td> </tr> <tr> <td>Swift_Mime_Header::getFieldName()</td> <td>1</td> </tr> <tr> <td>RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED}</td> <td>1</td> </tr> <tr> <td>https://secure.php.net/manual/en/openssl.ciphers.php</td> <td>1</td> </tr> <tr> <td>Swift_Signer::reset()</td> <td>1</td> </tr> <tr> <td>self::convertVarToOdf()</td> <td>1</td> </tr> <tr> <td>\Mike42\Escpos\Printer::initialize()</td> <td>1</td> </tr> <tr> <td>\Mike42\Escpos\Printer::text()</td> <td>1</td> </tr> <tr> <td>\Mike42\Escpos\Printer::feed()</td> <td>1</td> </tr> <tr> <td>timezone_name_from_abbr native PHP function.</td> <td>1</td> </tr> <tr> <td>multiply()</td> <td>1</td> </tr> <tr> <td>divide()</td> <td>1</td> </tr> <tr> <td>https://bugs.php.net/bug.php?id=72255</td> <td>1</td> </tr> <tr> <td>https://bugs.php.net/bug.php?id=74274</td> <td>1</td> </tr> <tr> <td>https://wiki.php.net/rfc/datetime_and_daylight_saving_time</td> <td>1</td> </tr> <tr> <td>follows()</td> <td>1</td> </tr> <tr> <td>isFollowedBy()</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-alnum</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-alpha</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-cntrl</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-digit</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-graph</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-lower</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-print</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-punct</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-space</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-upper</td> <td>1</td> </tr> <tr> <td>https://php.net/ctype-xdigit</td> <td>1</td> </tr> <tr> <td>addCasters</td> <td>1</td> </tr> <tr> <td>addComplexType</td> <td>1</td> </tr> <tr> <td>addSimpleType</td> <td>1</td> </tr> <tr> <td>addElement</td> <td>1</td> </tr> <tr> <td>nextPage()} when we know that there isn't a next page in order to</td> <td>1</td> </tr> <tr> <td>nextPage()}</td> <td>1</td> </tr> <tr> <td>\Stripe\ErrorObject} for possible</td> <td>1</td> </tr> <tr> <td>addControl()}</td> <td>1</td> </tr> <tr> <td>\DebugBar\JavascriptRenderer::addControl()}</td> <td>1</td> </tr> <tr> <td>getThirdPartyID()</td> <td>1</td> </tr> <tr> <td>getCustomerAccount()</td> <td>1</td> </tr> <tr> <td>setAsCustomer()</td> <td>1</td> </tr> <tr> <td>getTypeUrl()</td> <td>1</td> </tr> <tr> <td>clearrights(), addrights(), getrights(), hasRight()</td> <td>1</td> </tr> <tr> <td>getrights(), hasRight()</td> <td>1</td> </tr> <tr> <td>getAllChildIds()</td> <td>1</td> </tr> <tr> <td>get_children()</td> <td>1</td> </tr> <tr> <td>get_buyprice(), find_min_price_product_fournisseur()</td> <td>1</td> </tr> <tr> <td>getSellPrice(), find_min_price_product_fournisseur()</td> <td>1</td> </tr> <tr> <td>getFather(), get_sousproduits_arbo()</td> <td>1</td> </tr> <tr> <td>hasFatherOrChild()</td> <td>1</td> </tr> <tr> <td>load_virtual_stock(), loadBatchInfo()</td> <td>1</td> </tr> <tr> <td>load_stock(), loadBatchInfo()</td> <td>1</td> </tr> <tr> <td>load_stock(), load_virtual_stock()</td> <td>1</td> </tr> <tr> <td>fetchActions()</td> <td>1</td> </tr> <tr> <td>fetchFilters()</td> <td>1</td> </tr> <tr> <td>del_type()</td> <td>1</td> </tr> <tr> <td>add_type()</td> <td>1</td> </tr> <tr> <td>containsObject()</td> <td>1</td> </tr> <tr> <td>getObjectsInCateg()</td> <td>1</td> </tr> <tr> <td>get_full_arbo()</td> <td>1</td> </tr> <tr> <td>dol_convert_file()</td> <td>2</td> </tr> <tr> <td>restrictedArea()</td> <td>2</td> </tr> <tr> <td>dolKeepOnlyPhpCode()</td> <td>2</td> </tr> <tr> <td>dolWebsiteOutput()</td> <td>2</td> </tr> <tr> <td>natural_search()</td> <td>2</td> </tr> <tr> <td>img_object(), img_picto()</td> <td>2</td> </tr> <tr> <td>dol_htmloutput_events()</td> <td>2</td> </tr> <tr> <td>setEventMessages()</td> <td>2</td> </tr> <tr> <td>getElementProperties()</td> <td>2</td> </tr> <tr> <td>dolSqlDateFilter()</td> <td>2</td> </tr> <tr> <td>formproduct->selectMeasuringUnits</td> <td>2</td> </tr> <tr> <td>CommonObject</td> <td>2</td> </tr> <tr> <td>https://trac.calendarserver.org/browser/CalendarServer/trunk/doc/Extensions/caldav-sharing-02.txt</td> <td>2</td> </tr> <tr> <td>https://carbon.nesbot.com/docs/</td> <td>2</td> </tr> <tr> <td>https://github.com/briannesbitt/Carbon/blob/master/src/Carbon/Factory.php</td> <td>2</td> </tr> <tr> <td>$total_count} property is only available when</td> <td>2</td> </tr> <tr> <td>authenticate()</td> <td>2</td> </tr> <tr> <td>$fk_project</td> <td>2</td> </tr> <tr> <td>$label</td> <td>2</td> </tr> <tr> <td>fetch_contact()</td> <td>2</td> </tr> <tr> <td>getFullAddress()</td> <td>2</td> </tr> <tr> <td>setShippingMethod()</td> <td>2</td> </tr> <tr> <td>SetDocModel()</td> <td>2</td> </tr> <tr> <td>update_note()</td> <td>2</td> </tr> <tr> <td>$depends</td> <td>2</td> </tr> <tr> <td>$amount</td> <td>2</td> </tr> <tr> <td>$num_payment</td> <td>2</td> </tr> <tr> <td>Propal::STATUS_DRAFT, Propal::STATUS_VALIDATED, Propal::STATUS_SIGNED, Propal::STATUS_NOTSIGNED, Propal::STATUS_BILLED, Propal::STATUS_CANCELED</td> <td>2</td> </tr> <tr> <td>Product::TYPE_PRODUCT, Product::TYPE_SERVICE</td> <td>2</td> </tr> <tr> <td>updateElementResource()</td> <td>2</td> </tr> <tr> <td>fetchElementResource()</td> <td>2</td> </tr> <tr> <td>select_dolusers()</td> <td>2</td> </tr> <tr> <td>select_dolgroups()</td> <td>2</td> </tr> <tr> <td>form_date(), select_month(), select_year(), select_dayofweek()</td> <td>2</td> </tr> <tr> <td>selectForFormsList(), select_thirdparty_list()</td> <td>2</td> </tr> <tr> <td>selectForForms()</td> <td>2</td> </tr> <tr> <td>selectColor()</td> <td>2</td> </tr> <tr> <td>http://www.php.net/manual/en/function.uniqid.php#94959</td> <td>2</td> </tr> <tr> <td>https://github.com/asonge/php-geohash/issues/1</td> <td>2</td> </tr> <tr> <td>Cell()</td> <td>2</td> </tr> <tr> <td>SetX(), GetY(), SetY()</td> <td>2</td> </tr> <tr> <td>GetX(), GetY(), SetY(), SetXY()</td> <td>2</td> </tr> <tr> <td>SetFillColor()</td> <td>2</td> </tr> <tr> <td>PaneNo(), formatPageNumber()</td> <td>2</td> </tr> <tr> <td>setHtmlVSpace()</td> <td>2</td> </tr> <tr> <td>setPageRegions(), getPageRegions()</td> <td>2</td> </tr> <tr> <td>register()</td> <td>2</td> </tr> <tr> <td>__construct()</td> <td>2</td> </tr> <tr> <td>setValue()</td> <td>2</td> </tr> <tr> <td>getNameAddresses()</td> <td>2</td> </tr> <tr> <td>https://secure.php.net/manual/en/openssl.pkcs7.flags.php</td> <td>2</td> </tr> <tr> <td>PrintConnector::read()</td> <td>2</td> </tr> <tr> <td>create()</td> <td>2</td> </tr> <tr> <td>https://en.wikipedia.org/wiki/ISO_8601#Week_dates</td> <td>2</td> </tr> <tr> <td>max()</td> <td>2</td> </tr> <tr> <td>min()</td> <td>2</td> </tr> <tr> <td>https://php.net/manual/en/datetime.modify.php</td> <td>2</td> </tr> <tr> <td>https://php.net/manual/en/datetime.setdate.php</td> <td>2</td> </tr> <tr> <td>https://php.net/manual/en/datetime.setisodate.php</td> <td>2</td> </tr> <tr> <td>https://php.net/manual/en/datetime.settime.php</td> <td>2</td> </tr> <tr> <td>sub()</td> <td>2</td> </tr> <tr> <td>getTypeDef</td> <td>2</td> </tr> <tr> <td>clearrights(), delrights(), getrights(), hasRight()</td> <td>2</td> </tr> <tr> <td>clearrights(), delrights(), addrights(), hasRight()</td> <td>2</td> </tr> <tr> <td>versioncompare()</td> <td>3</td> </tr> <tr> <td>getImagePublicURLOfObject()</td> <td>3</td> </tr> <tr> <td>forgeSQLFromUniversalSearchCriteria()</td> <td>3</td> </tr> <tr> <td>dol_htmloutput_errors()</td> <td>3</td> </tr> <tr> <td>getLocalTaxesFromRate()</td> <td>3</td> </tr> <tr> <td>dol_htmloutput_mesg()</td> <td>3</td> </tr> <tr> <td>self::VERSIONS</td> <td>3</td> </tr> <tr> <td>measuringUnitString()</td> <td>3</td> </tr> <tr> <td>getLabelOfUnit()</td> <td>3</td> </tr> <tr> <td>fetch_origin()</td> <td>3</td> </tr> <tr> <td>$origin_object</td> <td>3</td> </tr> <tr> <td>fetch_barcode(), barcode_type</td> <td>3</td> </tr> <tr> <td>setPaymentTerms()</td> <td>3</td> </tr> <tr> <td>DebugBar\JavascriptRenderer::addControl()}</td> <td>3</td> </tr> <tr> <td>select_country()</td> <td>3</td> </tr> <tr> <td>add_product()</td> <td>3</td> </tr> <tr> <td>setAbsX(), setAbsY(), SetAbsXY()</td> <td>3</td> </tr> <tr> <td>getPageDimensions()</td> <td>3</td> </tr> <tr> <td>greaterThanOrEqualTo()</td> <td>3</td> </tr> <tr> <td>lessThanOrEqualTo()</td> <td>3</td> </tr> <tr> <td>https://php.net/manual/en/datetime.format.php</td> <td>3</td> </tr> <tr> <td>dol_print_error()</td> <td>4</td> </tr> <tr> <td>$status</td> <td>4</td> </tr> <tr> <td>num_rows()</td> <td>4</td> </tr> <tr> <td>writeUrl()</td> <td>4</td> </tr> <tr> <td>equalTo()</td> <td>4</td> </tr> <tr> <td>https://symfony.com/doc/current/components/translation.html#fallback-locales</td> <td>4</td> </tr> <tr> <td>notEqualTo()</td> <td>4</td> </tr> <tr> <td>update_price()</td> <td>5</td> </tr> <tr> <td>connect()</td> <td>5</td> </tr> <tr> <td>greaterThan()</td> <td>5</td> </tr> <tr> <td>lessThan()</td> <td>5</td> </tr> <tr> <td>$errors</td> <td>6</td> </tr> <tr> <td>close()</td> <td>6</td> </tr> <tr> <td>affected_rows()</td> <td>6</td> </tr> <tr> <td>nusoap_xmlschema</td> <td>6</td> </tr> <tr> <td>MODE_WRITE, MODE_APPEND</td> <td>8</td> </tr> <tr> <td>TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX</td> <td>8</td> </tr> <tr> <td>TYPE_DATE, TYPE_ID, TYPE_PATH</td> <td>8</td> </tr> <tr> <td>toString()</td> <td>9</td> </tr> <tr> <td>settings</td> <td>16</td> </tr> <tr> <td>StartTransform(), StopTransform()</td> <td>18</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@seealso</td> <td>num_between_day(), num_public_holiday()</td> <td>1</td> </tr> <tr> <td rowspan="110" style="vertical-align: top;">@since</td> <td>2004-10-27</td> <td>1</td> </tr> <tr> <td>Dolibarr V18</td> <td>1</td> </tr> <tr> <td>2.0</td> <td>1</td> </tr> <tr> <td>4.0.0</td> <td>1</td> </tr> <tr> <td>5.9.000 (2010-10-03)</td> <td>1</td> </tr> <tr> <td>5.9.000 (2010-10-04)</td> <td>1</td> </tr> <tr> <td>2004-06-14</td> <td>1</td> </tr> <tr> <td>2005-01-02</td> <td>1</td> </tr> <tr> <td>4.6.028 (2009-08-25)</td> <td>1</td> </tr> <tr> <td>8.0 Return dispatched quantity (qty).</td> <td>1</td> </tr> <tr> <td>4.0.018 (2008-08-06)</td> <td>1</td> </tr> <tr> <td>1.52.0.TC005 (2005-01-05)</td> <td>1</td> </tr> <tr> <td>5.8.017 (2010-08-24)</td> <td>1</td> </tr> <tr> <td>5.9.128 (2011-10-06)</td> <td>1</td> </tr> <tr> <td>6.3.0 (2019-09-19)</td> <td>1</td> </tr> <tr> <td>5.5.000 (2010-06-22)</td> <td>1</td> </tr> <tr> <td>3.0008 (2008-05-12)</td> <td>1</td> </tr> <tr> <td>4.8.003 (2009-09-15)</td> <td>1</td> </tr> <tr> <td>5.9.027 (2010-12-01)</td> <td>1</td> </tr> <tr> <td>4.6.018 (2009-07-10)</td> <td>1</td> </tr> <tr> <td>4.2.010 (2008-11-14)</td> <td>1</td> </tr> <tr> <td>5.9.098 (2011-06-23)</td> <td>1</td> </tr> <tr> <td>4.6.008 (2009-05-07)</td> <td>1</td> </tr> <tr> <td>2.9.000 (2008-03-26)</td> <td>1</td> </tr> <tr> <td>4.6.005 (2009-04-24)</td> <td>1</td> </tr> <tr> <td>5.3.011 (2010-06-17)</td> <td>1</td> </tr> <tr> <td>5.9.093 (2011-06-16)</td> <td>1</td> </tr> <tr> <td>5.9.099 (2011-06-27)</td> <td>1</td> </tr> <tr> <td>4.0.018 (2008-08-08)</td> <td>1</td> </tr> <tr> <td>3.2.000 (2008-07-01)</td> <td>1</td> </tr> <tr> <td>6.0.038 (2013-09-30)</td> <td>1</td> </tr> <tr> <td>5.7.000 (2010-08-02)</td> <td>1</td> </tr> <tr> <td>4.8.024 (2010-01-15)</td> <td>1</td> </tr> <tr> <td>5.0.001 (2010-05-06)</td> <td>1</td> </tr> <tr> <td>5.9.125 (2011-10-03)</td> <td>1</td> </tr> <tr> <td>5.9.137 (2011-12-01)</td> <td>1</td> </tr> <tr> <td>5.9.012 (2010-11-10)</td> <td>1</td> </tr> <tr> <td>6.0.000 (2013-03-16)</td> <td>1</td> </tr> <tr> <td>5.9.204 (2013-01-28)</td> <td>1</td> </tr> <tr> <td>(4.5.019) 2009-02-28</td> <td>1</td> </tr> <tr> <td>4.4.002 (2008-12-09)</td> <td>1</td> </tr> <tr> <td>4.5.044 (2009-04-16)</td> <td>1</td> </tr> <tr> <td>4.5.000 (2008-12-31)</td> <td>1</td> </tr> <tr> <td>4.5.029 (2009-03-19)</td> <td>1</td> </tr> <tr> <td>5.9.086</td> <td>1</td> </tr> <tr> <td>5.9.006 (2010-10-19)</td> <td>1</td> </tr> <tr> <td>TODO</td> <td>1</td> </tr> <tr> <td>4.2.005 (2008-11-06)</td> <td>1</td> </tr> <tr> <td>4.5.001 (2009-01-04)</td> <td>1</td> </tr> <tr> <td>5.9.017 (2010-11-16)</td> <td>1</td> </tr> <tr> <td>5.9.070 (2011-04-19)</td> <td>1</td> </tr> <tr> <td>4.4.004 (2008-12-10)</td> <td>1</td> </tr> <tr> <td>4.8.038 (2010-03-13)</td> <td>1</td> </tr> <tr> <td>5.0.000 (2010-04-30)</td> <td>1</td> </tr> <tr> <td>5.0.000 (2010-05-04)</td> <td>1</td> </tr> <tr> <td>6.0.023</td> <td>1</td> </tr> <tr> <td>4.5.027 (2009-03-16)</td> <td>1</td> </tr> <tr> <td>5.9.123 (2010-09-30)</td> <td>1</td> </tr> <tr> <td>5.9.123 (2011-09-29)</td> <td>1</td> </tr> <tr> <td>2.3.000 (2008-03-05)</td> <td>1</td> </tr> <tr> <td>1.53.0.TC005 (2005-01-05)</td> <td>1</td> </tr> <tr> <td>4.9.000 (2010-03-27)</td> <td>1</td> </tr> <tr> <td>2.4.000 (2008-03-06)</td> <td>1</td> </tr> <tr> <td>4.8.017 (2009-11-27)</td> <td>1</td> </tr> <tr> <td>1.7.0</td> <td>1</td> </tr> <tr> <td>1.8.0</td> <td>1</td> </tr> <tr> <td>dolibarr v19</td> <td>1</td> </tr> <tr> <td>dolibarr v17</td> <td>1</td> </tr> <tr> <td>v17</td> <td>2</td> </tr> <tr> <td>Dolibarr v10.0.7</td> <td>2</td> </tr> <tr> <td>2002-07-31</td> <td>2</td> </tr> <tr> <td>1.5.3</td> <td>2</td> </tr> <tr> <td>V18</td> <td>2</td> </tr> <tr> <td>3.2.000 (2008-06-23)</td> <td>2</td> </tr> <tr> <td>5.9.121 (2011-09-28)</td> <td>2</td> </tr> <tr> <td>5.0.005 (2010-05-11)</td> <td>2</td> </tr> <tr> <td>4.0.012 (2008-07-24)</td> <td>2</td> </tr> <tr> <td>5.9.101 (2011-07-06)</td> <td>2</td> </tr> <tr> <td>6.0.090 (2014-06-16)</td> <td>2</td> </tr> <tr> <td>5.9.186 (2012-09-13)</td> <td>2</td> </tr> <tr> <td>4.9.003 (2010-03-30)</td> <td>2</td> </tr> <tr> <td>4.4.000 (2008-12-07)</td> <td>2</td> </tr> <tr> <td>4.5.000 (2009-01-02)</td> <td>2</td> </tr> <tr> <td>4.6.025 (2009-08-17)</td> <td>2</td> </tr> <tr> <td>5.9.152 (2012-03-23)</td> <td>2</td> </tr> <tr> <td>6.0.025</td> <td>2</td> </tr> <tr> <td>4.8.023 (2010-01-15)</td> <td>2</td> </tr> <tr> <td>4.9.016 (2010-04-20)</td> <td>2</td> </tr> <tr> <td>1.6.1</td> <td>2</td> </tr> <tr> <td>2.1.000 (2008-01-08)</td> <td>3</td> </tr> <tr> <td>5.9.097 (2011-06-23)</td> <td>3</td> </tr> <tr> <td>4.8.000 (2009-09-06)</td> <td>3</td> </tr> <tr> <td>4.9.000 (2010-03-26)</td> <td>3</td> </tr> <tr> <td>4.5.037 (2009-04-07)</td> <td>3</td> </tr> <tr> <td>4.9.012 (2010-04-12)</td> <td>3</td> </tr> <tr> <td>5.0.005 (2010-05-12)</td> <td>3</td> </tr> <tr> <td>5.1.000 (2010-05-25)</td> <td>3</td> </tr> <tr> <td>5.9.123 (2011-09-30)</td> <td>3</td> </tr> <tr> <td>2.0.000 (2008-01-02)</td> <td>4</td> </tr> <tr> <td>2.1.002 (2008-02-12)</td> <td>4</td> </tr> <tr> <td>5.0.010 (2010-05-17)</td> <td>5</td> </tr> <tr> <td>5.2.000 (2010-06-02)</td> <td>6</td> </tr> <tr> <td>5.9.174 (2012-07-25)</td> <td>7</td> </tr> <tr> <td>4.8.000 (2009-09-07)</td> <td>7</td> </tr> <tr> <td>Dolibarr V20</td> <td>8</td> </tr> <tr> <td>5.0.000 (2010-05-02)</td> <td>9</td> </tr> <tr> <td>1.6.0</td> <td>9</td> </tr> <tr> <td>3.1.000 (2008-06-09)</td> <td>11</td> </tr> <tr> <td>1.0.000 (2011-05-23)</td> <td>14</td> </tr> <tr> <td>v18</td> <td>49</td> </tr> <tr> <td rowspan="4" style="vertical-align: top;">@static</td> <td>*/</td> <td>1</td> </tr> <tr> <td>* @return AutoLoader the current instance or new instance if none exists.</td> <td>1</td> </tr> <tr> <td>* @abstract</td> <td>1</td> </tr> <tr> <td>*</td> <td>20</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@status</td> <td>201</td> <td>1</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@string</td> <td>clicktodial url</td> <td>1</td> </tr> <tr> <td rowspan="6" style="vertical-align: top;">@subpackage</td> <td>GeoJSON</td> <td>1</td> </tr> <tr> <td>exception</td> <td>4</td> </tr> <tr> <td>result</td> <td>4</td> </tr> <tr> <td>Helper</td> <td>4</td> </tr> <tr> <td>auth</td> <td>4</td> </tr> <tr> <td>format</td> <td>26</td> </tr> <tr> <td rowspan="2" style="vertical-align: top;">@suppress</td> <td>PhanDeprecatedFunctionInternal Error in Phan plugins incorrectly tags some functions here</td> <td>1</td> </tr> <tr> <td>PhanPluginUnknownArrayMethodParamType Luracast limitation</td> <td>5</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@table</td> <td>(example 'fk_soc@societe')</td> <td>1</td> </tr> <tr> <td rowspan="3" style="vertical-align: top;">@template</td> <td>T of object</td> <td>1</td> </tr> <tr> <td>T of CarbonInterface</td> <td>1</td> </tr> <tr> <td>TStripeObject of StripeObject</td> <td>4</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@throttle</td> <td>3000` in php doc</td> <td>1</td> </tr> <tr> <td rowspan="356" style="vertical-align: top;">@throws</td> <td>RestException 503 System error</td> <td>1</td> </tr> <tr> <td>RestException 409 Nothing to do</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving Subscription list</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when creating Subscription</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when updating Subscription</td> <td>1</td> </tr> <tr> <td>RestException 409 No Subscription deleted</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when deleting Subscription</td> <td>1</td> </tr> <tr> <td>RestException 400 Error on SQL filters</td> <td>1</td> </tr> <tr> <td>RestException 404 No Member found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when creating Member</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when resiliating, validating, excluding, updating a Member</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when deleting a Member</td> <td>1</td> </tr> <tr> <td>RestException 404 Category not found</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving Category list</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when creating Member Type</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when updating Member Type</td> <td>1</td> </tr> <tr> <td>RestException 500 Error when deleting Member Type</td> <td>1</td> </tr> <tr> <td>RestException 401 Insufficient rights</td> <td>1</td> </tr> <tr> <td>RestException 404 Accountancy export period not found</td> <td>1</td> </tr> <tr> <td>RestException 404 Accountancy export start or end date not defined</td> <td>1</td> </tr> <tr> <td>RestException 404 Accountancy export format not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error on accountancy export</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad sqlfilters</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of boms</td> <td>1</td> </tr> <tr> <td>RestException 500 Error retrieving list of boms</td> <td>1</td> </tr> <tr> <td>RestException 500 Error updating bom</td> <td>1</td> </tr> <tr> <td>RestException 500 Error deleting bom</td> <td>1</td> </tr> <tr> <td>RestException 500 Error adding bom line</td> <td>1</td> </tr> <tr> <td>RestException 500 Error deleting bom line</td> <td>1</td> </tr> <tr> <td>Exception dol_syslog can throw Exceptions</td> <td>1</td> </tr> <tr> <td>exception</td> <td>1</td> </tr> <tr> <td>RestException 304 Error</td> <td>1</td> </tr> <tr> <td>RestException 405 Error</td> <td>1</td> </tr> <tr> <td>RestException 401 Unauthorized: User does not have permission to configure bank accounts</td> <td>1</td> </tr> <tr> <td>RestException 404 Not Found: Either the source or the destination bankaccount for the provided id does not exist</td> <td>1</td> </tr> <tr> <td>RestException 422 Unprocessable Entity: Refer to detailed exception message for the cause</td> <td>1</td> </tr> <tr> <td>RestException 500 Internal Server Error: Error(s) returned by the RDBMS</td> <td>1</td> </tr> <tr> <td>RestException 404 Invoice not found</td> <td>1</td> </tr> <tr> <td>RestException 401 Not allowed</td> <td>1</td> </tr> <tr> <td>RestException 404 Expense report not found</td> <td>1</td> </tr> <tr> <td>RestException 500 System error</td> <td>1</td> </tr> <tr> <td>NeedPrivileges</td> <td>1</td> </tr> <tr> <td>NotAuthenticated</td> <td>1</td> </tr> <tr> <td>InvalidResourceType</td> <td>1</td> </tr> <tr> <td>NotFound</td> <td>1</td> </tr> <tr> <td>Exception\Forbidden A permission denied exception is thrown whenever there was an attempt to supply a uri outside of the base uri</td> <td>1</td> </tr> <tr> <td>Exception\BadRequest upon missing or broken request headers</td> <td>1</td> </tr> <tr> <td>Exception\UnsupportedMediaType when trying to copy into a</td> <td>1</td> </tr> <tr> <td>Exception\PreconditionFailed if overwrite is set to false, but</td> <td>1</td> </tr> <tr> <td>Exception\Forbidden when source and destination paths are</td> <td>1</td> </tr> <tr> <td>Exception\Conflict when trying to copy a node into its own</td> <td>1</td> </tr> <tr> <td>Exception\InvalidResourceType</td> <td>1</td> </tr> <tr> <td>clientException, in case a curl error occurred</td> <td>1</td> </tr> <tr> <td>BadRequest</td> <td>1</td> </tr> <tr> <td>\Sabre\VObject\EofException</td> <td>1</td> </tr> <tr> <td>Exception If the class is nonexistent or does not implement a valid ServiceInterface</td> <td>1</td> </tr> <tr> <td>InvalidScopeException</td> <td>1</td> </tr> <tr> <td>ExpiredTokenException</td> <td>1</td> </tr> <tr> <td>InvalidAuthorizationStateException</td> <td>1</td> </tr> <tr> <td>Exception\InvalidScopeException</td> <td>1</td> </tr> <tr> <td>TokenNotFoundException</td> <td>1</td> </tr> <tr> <td>UnsupportedHashAlgorithmException</td> <td>1</td> </tr> <tr> <td>Writer\Exception</td> <td>1</td> </tr> <tr> <td>\Exception thrown if color is invalid</td> <td>1</td> </tr> <tr> <td>CalculationException illegalArgumentException Matrix row dimensions must agree</td> <td>1</td> </tr> <tr> <td>CalculationException runtimeException Matrix is singular</td> <td>1</td> </tr> <tr> <td>Exception when directory does not exist</td> <td>1</td> </tr> <tr> <td>WriterException when directory does not exist</td> <td>1</td> </tr> <tr> <td>OutOfBoundsException</td> <td>1</td> </tr> <tr> <td>Exception\OutOfBoundsException if the tolerance is not valid</td> <td>1</td> </tr> <tr> <td>Exception\OutOfBoundsException if $tol (the tolerance) is negative</td> <td>1</td> </tr> <tr> <td>Exception\BadDataException if $a = $b</td> <td>1</td> </tr> <tr> <td>ippException</td> <td>1</td> </tr> <tr> <td>Swift_DependencyException If the dependency is not found</td> <td>1</td> </tr> <tr> <td>Swift_AddressEncoderException if the email cannot be represented in</td> <td>1</td> </tr> <tr> <td>Swift_TransportException Allows the message to bubble up when authentication was not successful</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Pop_Pop3Exception if connection fails</td> <td>1</td> </tr> <tr> <td>Swift_RfcComplianceException if invalid</td> <td>1</td> </tr> <tr> <td>Swift_RfcComplianceException If address is invalid</td> <td>1</td> </tr> <tr> <td>Swift_AddressEncoderException If local-part contains non-ASCII characters</td> <td>1</td> </tr> <tr> <td>OdfExceptionSegmentNotFound</td> <td>1</td> </tr> <tr> <td>PhpZipProxyException</td> <td>1</td> </tr> <tr> <td>PclZipProxyException</td> <td>1</td> </tr> <tr> <td>Exception when the api service class is missing</td> <td>1</td> </tr> <tr> <td>RestException to send error response</td> <td>1</td> </tr> <tr> <td>\OutOfRangeException</td> <td>1</td> </tr> <tr> <td>RestException 403 security violation</td> <td>1</td> </tr> <tr> <td>\Twig\Error\LoaderError</td> <td>1</td> </tr> <tr> <td>\Twig\Error\RuntimeError</td> <td>1</td> </tr> <tr> <td>\Twig\Error\SyntaxError</td> <td>1</td> </tr> <tr> <td>RestException 500 on unsupported data</td> <td>1</td> </tr> <tr> <td>\Luracast\Restler\RestException 400 with information about the</td> <td>1</td> </tr> <tr> <td>Exception Where the image can't be read.</td> <td>1</td> </tr> <tr> <td>Exception Wrapped Imagick error if image can't be loaded</td> <td>1</td> </tr> <tr> <td>Exception Where Imagick is not loaded, or where a missing file</td> <td>1</td> </tr> <tr> <td>Exception Where the generated data is unsuitable for the printer</td> <td>1</td> </tr> <tr> <td>InvalidArgumentException Where the data is now known or computable.</td> <td>1</td> </tr> <tr> <td>\InvalidArgumentException Where the feature does not exist.</td> <td>1</td> </tr> <tr> <td>InvalidArgumentException Where the ID does not exist. Some similarly-named profiles will be suggested in the Exception text.</td> <td>1</td> </tr> <tr> <td>InvalidArgumentException Where the length or characters used in $content is invalid for the requested barcode format.</td> <td>1</td> </tr> <tr> <td>Exception If this profile indicates that PDF417 code is not supported</td> <td>1</td> </tr> <tr> <td>InvalidArgumentException Where the buffer is already attached to a different printer.</td> <td>1</td> </tr> <tr> <td>InvalidArgumentException Where the argument is not valid</td> <td>1</td> </tr> <tr> <td>Exception Where the socket cannot be opened.</td> <td>1</td> </tr> <tr> <td>\Carbon\Exceptions\ParseErrorException when the $interval cannot be parsed as an interval.</td> <td>1</td> </tr> <tr> <td>BadFluentSetterException|Throwable</td> <td>1</td> </tr> <tr> <td>UnknownUnitException|UnitNotConfiguredException</td> <td>1</td> </tr> <tr> <td>InvalidIntervalException</td> <td>1</td> </tr> <tr> <td>InvalidPeriodDateException</td> <td>1</td> </tr> <tr> <td>Throwable</td> <td>1</td> </tr> <tr> <td>InvalidTypeException</td> <td>1</td> </tr> <tr> <td>\InvalidArgumentException If $resource is not a file handle.</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Filesystem\FileExistsException</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Container\BindingResolutionException</td> <td>1</td> </tr> <tr> <td>Exceptions\MessageHeaderFetchingException</td> <td>1</td> </tr> <tr> <td>Exceptions\MessageFlagException</td> <td>1</td> </tr> <tr> <td>AuthFailedException|RuntimeException</td> <td>1</td> </tr> <tr> <td>ErrorException</td> <td>1</td> </tr> <tr> <td>BadMethodCallException when the method doesn't exist and doesn't start with 'is'</td> <td>1</td> </tr> <tr> <td>\Stripe\Exception\InvalidArgumentException if stripe_version is missing</td> <td>1</td> </tr> <tr> <td>\Stripe\Exception\AuthenticationException</td> <td>1</td> </tr> <tr> <td>Exception\UnexpectedValueException if $id is null</td> <td>1</td> </tr> <tr> <td>Exception\InvalidArgumentException</td> <td>1</td> </tr> <tr> <td>Exception\UnexpectedValueException if the payload is not valid JSON,</td> <td>1</td> </tr> <tr> <td>\Stripe\Exception\UnexpectedValueException if the source is not attached to a customer</td> <td>1</td> </tr> <tr> <td>\Stripe\Exception\InvalidArgumentException if $params exists and is not an array</td> <td>1</td> </tr> <tr> <td>PDOException</td> <td>1</td> </tr> <tr> <td>PrestaShopWebserviceException if curl is not loaded</td> <td>1</td> </tr> <tr> <td>PrestaShopWebserviceException if HTTP status code is not 200 or 201</td> <td>1</td> </tr> <tr> <td>RestException 400 Price level out of bounds</td> <td>1</td> </tr> <tr> <td>RestException 404 Thirdparty not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error fetching/setting price level</td> <td>1</td> </tr> <tr> <td>RestException 501 Request needs modules "Thirdparties" and "Products" and setting Multiprices activated</td> <td>1</td> </tr> <tr> <td>RestException 409 Conflict: An Account already exists for this company and site.</td> <td>1</td> </tr> <tr> <td>RestException 500 Internal Server Error: Error creating SocieteAccount account</td> <td>1</td> </tr> <tr> <td>RestException 409 Conflict: Another SocieteAccount entity already exists for this thirdparty with this site key.</td> <td>1</td> </tr> <tr> <td>RestException 404 Category or contact not found</td> <td>1</td> </tr> <tr> <td>RestException 404 Category or contact not found</td> <td>1</td> </tr> <tr> <td>RestException 404 User or group not found</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad request</td> <td>1</td> </tr> <tr> <td>RestException 401 Insufficient rights</td> <td>1</td> </tr> <tr> <td>RestException 404 User or group not found</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad request</td> <td>1</td> </tr> <tr> <td>RestException 401</td> <td>1</td> </tr> <tr> <td>RestException 403</td> <td>1</td> </tr> <tr> <td>RestException 404</td> <td>1</td> </tr> <tr> <td>RestException 401 Forbidden</td> <td>1</td> </tr> <tr> <td>RestException 503 Technical error</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of ordering methods</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of ordering origins</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of payment types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of regions</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving region</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving region</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of states</td> <td>1</td> </tr> <tr> <td>RestException 503 Error retrieving list of countries</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of availabilities</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of events types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of expense report types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of contacts types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of civilities</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of currencies</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of extra fields</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of towns</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of payments terms</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of shipping modes</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of measuring units</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of legal form</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of staff</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of social networks</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of tickets categories</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of tickets severities</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad value for sqlfilters</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of tickets types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of incoterms types</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving list of establishments</td> <td>1</td> </tr> <tr> <td>RestException 404 Establishment not found</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieving establishment</td> <td>1</td> </tr> <tr> <td>RestException 400 Error Bad or unknown value for constantname</td> <td>1</td> </tr> <tr> <td>RestException 404 Signature file not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Technical error</td> <td>1</td> </tr> <tr> <td>RestException 404 File not found</td> <td>1</td> </tr> <tr> <td>RestException 404 Invoice, Order, Proposal, Contract or Shipment not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error generating document</td> <td>1</td> </tr> <tr> <td>RestException 501 File not found</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad value for parameter modulepart, id or ref</td> <td>1</td> </tr> <tr> <td>RestException 404 Thirdparty, User, Member, Order, Invoice or Proposal not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error while fetching object</td> <td>1</td> </tr> <tr> <td>RestException 503 Error when retrieve ecm list</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad Request</td> <td>1</td> </tr> <tr> <td>RestException 404 Object not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error on file operationw</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad value for parameter modulepart</td> <td>1</td> </tr> <tr> <td>RestException 400 Bad value for parameter original_file</td> <td>1</td> </tr> <tr> <td>RestException 403 Access denied</td> <td>1</td> </tr> <tr> <td>RestException 404 File not found</td> <td>1</td> </tr> <tr> <td>RestException 500 Error on file operation</td> <td>1</td> </tr> <tr> <td>InvalidQrBillDataException</td> <td>1</td> </tr> <tr> <td>\InvalidArgumentException if arguments are passed to the method</td> <td>1</td> </tr> <tr> <td>\BadMethodCallException if the database has been closed</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Exception\AddressNotFoundException if the address you provided is not in our database (e.g.,</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Exception\OutOfQueriesException if your account is out of queries</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Exception\HttpException if an unexpected HTTP error</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Exception\GeoIp2Exception This serves as the parent class to the above exceptions. It</td> <td>1</td> </tr> <tr> <td>\Symplify\RuleDocGenerator\Exception\PoorDocumentationException</td> <td>1</td> </tr> <tr> <td>RestException 404 Member or ThirdParty not found</td> <td>2</td> </tr> <tr> <td>RestException 503 Error when retrieving Member list</td> <td>2</td> </tr> <tr> <td>RestException 400 Bad parameters</td> <td>2</td> </tr> <tr> <td>ParseException</td> <td>2</td> </tr> <tr> <td>DAV\Exception\InvalidResourceType</td> <td>2</td> </tr> <tr> <td>Exception\NotFound</td> <td>2</td> </tr> <tr> <td>VObject\InvalidDataException</td> <td>2</td> </tr> <tr> <td>MissingRefreshTokenException</td> <td>2</td> </tr> <tr> <td>\LogicException</td> <td>2</td> </tr> <tr> <td>Swift_Plugins_Pop_Pop3Exception</td> <td>2</td> </tr> <tr> <td>SegmentException</td> <td>2</td> </tr> <tr> <td>Exception when supplied with invalid class name</td> <td>2</td> </tr> <tr> <td>Exception if the image format is not supported,</td> <td>2</td> </tr> <tr> <td>InvalidArgumentException Where the input lengths are bad.</td> <td>2</td> </tr> <tr> <td>InvalidTimeZoneException</td> <td>2</td> </tr> <tr> <td>UnknownMethodException|BadMethodCallException|ReflectionException|Throwable</td> <td>2</td> </tr> <tr> <td>UnknownSetterException|ReflectionException</td> <td>2</td> </tr> <tr> <td>InvalidDateException</td> <td>2</td> </tr> <tr> <td>BadComparisonUnitException</td> <td>2</td> </tr> <tr> <td>ImmutableException|UnknownSetterException</td> <td>2</td> </tr> <tr> <td>Exception when the interval_spec (passed as $years) cannot be parsed as an interval.</td> <td>2</td> </tr> <tr> <td>UnknownSetterException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Encryption\EncryptException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Encryption\DecryptException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Auth\Access\AuthorizationException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Filesystem\FileNotFoundException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Validation\ValidationException</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\MultipleItemsFoundException</td> <td>2</td> </tr> <tr> <td>Exceptions\InvalidMessageDateException</td> <td>2</td> </tr> <tr> <td>Exceptions\MessageContentFetchingException</td> <td>2</td> </tr> <tr> <td>Exception\SignatureVerificationException if the verification fails</td> <td>2</td> </tr> <tr> <td>Exception\UnexpectedValueException</td> <td>2</td> </tr> <tr> <td>Exception\AuthenticationException</td> <td>2</td> </tr> <tr> <td>\Stripe\Exception\ApiConnectionException</td> <td>2</td> </tr> <tr> <td>\Stripe\Exception\UnexpectedValueException</td> <td>2</td> </tr> <tr> <td>RestException 500</td> <td>2</td> </tr> <tr> <td>RestException 404 User or Thirdparty not found</td> <td>2</td> </tr> <tr> <td>RestException 503</td> <td>2</td> </tr> <tr> <td>RestException 422 Unprocessable Entity: You must pass the site attribute in your request data !</td> <td>2</td> </tr> <tr> <td>RestException 500 Internal Server Error: Error updating SocieteAccount entity</td> <td>2</td> </tr> <tr> <td>RestException 401 Unauthorized: User does not have permission to delete thirdparties accounts</td> <td>2</td> </tr> <tr> <td>RestException 500 Internal Server Error: Error deleting SocieteAccount entity</td> <td>2</td> </tr> <tr> <td>RestException 401 Insufficient rights</td> <td>2</td> </tr> <tr> <td>RestException 403 Access denied</td> <td>2</td> </tr> <tr> <td>RestException 404 Region not found</td> <td>2</td> </tr> <tr> <td>RestException 404 State not found</td> <td>2</td> </tr> <tr> <td>RestException 503 Error retrieving state</td> <td>2</td> </tr> <tr> <td>RestException 400 Bad value for parameter modulepart or original_file</td> <td>2</td> </tr> <tr> <td>\GeoIp2\Exception\AddressNotFoundException if the address you</td> <td>2</td> </tr> <tr> <td>\GeoIp2\Exception\OutOfQueriesException if your account is out</td> <td>2</td> </tr> <tr> <td>\GeoIp2\Exception\HttpException if an unexpected HTTP error code or message was returned.</td> <td>2</td> </tr> <tr> <td>\GeoIp2\Exception\GeoIp2Exception This serves as the parent</td> <td>2</td> </tr> <tr> <td>Exception\Forbidden</td> <td>3</td> </tr> <tr> <td>\Psr\Log\InvalidArgumentException</td> <td>3</td> </tr> <tr> <td>Exception if the given value is invalid</td> <td>3</td> </tr> <tr> <td>ReaderException</td> <td>3</td> </tr> <tr> <td>Swift_SwiftException</td> <td>3</td> </tr> <tr> <td>Exceptions\GetMessagesFailedException</td> <td>3</td> </tr> <tr> <td>\Stripe\Exception\InvalidArgumentException</td> <td>3</td> </tr> <tr> <td>Exception\ApiConnectionException</td> <td>3</td> </tr> <tr> <td>RestException 401 Access not allowed for your login</td> <td>3</td> </tr> <tr> <td>RestException 404 User or group not found</td> <td>3</td> </tr> <tr> <td>RestException 404 Country not found</td> <td>3</td> </tr> <tr> <td>RestException 503 Error retrieving country</td> <td>3</td> </tr> <tr> <td>\GeoIp2\Exception\AuthenticationException if there is a problem</td> <td>3</td> </tr> <tr> <td>\GeoIp2\Exception\InvalidRequestException} if your request was received by the web service but is</td> <td>3</td> </tr> <tr> <td>\InvalidArgumentException if something other than a single IP address or "me" is</td> <td>3</td> </tr> <tr> <td>InvalidUriException</td> <td>4</td> </tr> <tr> <td>\Throwable</td> <td>4</td> </tr> <tr> <td>RestException 503 Error</td> <td>4</td> </tr> <tr> <td>RestException 404 No Subscription found</td> <td>4</td> </tr> <tr> <td>RestException 404 No Member Type found</td> <td>4</td> </tr> <tr> <td>RestException 401 Not allowed</td> <td>4</td> </tr> <tr> <td>\UnexpectedValueException</td> <td>4</td> </tr> <tr> <td>\ReflectionException</td> <td>4</td> </tr> <tr> <td>\Illuminate\Support\ItemNotFoundException</td> <td>4</td> </tr> <tr> <td>Exceptions\MaskNotFoundException</td> <td>4</td> </tr> <tr> <td>MessageSearchValidationException</td> <td>4</td> </tr> <tr> <td>\Stripe\Exception\OAuth\OAuthErrorException if the request fails</td> <td>4</td> </tr> <tr> <td>RestException 401 Unauthorized: User does not have permission to read thirdparties</td> <td>4</td> </tr> <tr> <td>RestException 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty</td> <td>4</td> </tr> <tr> <td>RestException 401 Insufficient rights</td> <td>4</td> </tr> <tr> <td>RestException 404 User not found</td> <td>4</td> </tr> <tr> <td>RestException 403 Forbidden</td> <td>4</td> </tr> <tr> <td>PoorDocumentationException</td> <td>4</td> </tr> <tr> <td>\JsonException</td> <td>5</td> </tr> <tr> <td>MethodNotFoundException</td> <td>5</td> </tr> <tr> <td>FolderFetchingException</td> <td>5</td> </tr> <tr> <td>AuthFailedException</td> <td>5</td> </tr> <tr> <td>RestException 404 Member not found</td> <td>6</td> </tr> <tr> <td>DAV\Exception\NotFound</td> <td>6</td> </tr> <tr> <td>DAV\Exception\Forbidden</td> <td>6</td> </tr> <tr> <td>Reader\Exception</td> <td>6</td> </tr> <tr> <td>InvalidArgumentException</td> <td>6</td> </tr> <tr> <td>BadMethodCallException</td> <td>6</td> </tr> <tr> <td>UnknownGetterException</td> <td>6</td> </tr> <tr> <td>\BadMethodCallException</td> <td>6</td> </tr> <tr> <td>Exceptions\FolderFetchingException</td> <td>6</td> </tr> <tr> <td>MaskNotFoundException</td> <td>6</td> </tr> <tr> <td>MethodNotSupportedException</td> <td>6</td> </tr> <tr> <td>RestException 404 BOM not found</td> <td>7</td> </tr> <tr> <td>EventNotFoundException</td> <td>7</td> </tr> <tr> <td>\Psr\SimpleCache\InvalidArgumentException</td> <td>7</td> </tr> <tr> <td>PrestaShopWebserviceException</td> <td>7</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Exception</td> <td>8</td> </tr> <tr> <td>MessageHeaderFetchingException</td> <td>8</td> </tr> <tr> <td>GetMessagesFailedException</td> <td>8</td> </tr> <tr> <td>\GeoIp2\Exception\AddressNotFoundException if the address is</td> <td>8</td> </tr> <tr> <td>OdfException</td> <td>9</td> </tr> <tr> <td>\RuntimeException</td> <td>9</td> </tr> <tr> <td>MessageNotFoundException</td> <td>9</td> </tr> <tr> <td>Exception\ApiErrorException</td> <td>9</td> </tr> <tr> <td>\MaxMind\Db\Reader\InvalidDatabaseException if the database</td> <td>9</td> </tr> <tr> <td>Exceptions\MessageNotFoundException</td> <td>10</td> </tr> <tr> <td>TokenResponseException</td> <td>11</td> </tr> <tr> <td>DebugBarException</td> <td>11</td> </tr> <tr> <td>RestException 304</td> <td>12</td> </tr> <tr> <td>MessageContentFetchingException</td> <td>12</td> </tr> <tr> <td>RestException 405</td> <td>13</td> </tr> <tr> <td>ReflectionException</td> <td>13</td> </tr> <tr> <td>\Stripe\Exception\BadMethodCallException</td> <td>13</td> </tr> <tr> <td>RestException 403 Not allowed</td> <td>15</td> </tr> <tr> <td>RestException 404 Not found</td> <td>15</td> </tr> <tr> <td>Swift_RfcComplianceException</td> <td>16</td> </tr> <tr> <td>Invalid</td> <td>16</td> </tr> <tr> <td>MessageFlagException</td> <td>17</td> </tr> <tr> <td>Exceptions\EventNotFoundException</td> <td>18</td> </tr> <tr> <td>\Exception</td> <td>20</td> </tr> <tr> <td>RestException 403</td> <td>20</td> </tr> <tr> <td>RestException 500 System error</td> <td>20</td> </tr> <tr> <td>RestException 500 System error</td> <td>21</td> </tr> <tr> <td>RestException 400</td> <td>21</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Exception</td> <td>21</td> </tr> <tr> <td>Swift_IoException</td> <td>21</td> </tr> <tr> <td>RestException 400 Bad value for sqlfilters</td> <td>22</td> </tr> <tr> <td>\InvalidArgumentException</td> <td>25</td> </tr> <tr> <td>InvalidMessageDateException</td> <td>25</td> </tr> <tr> <td>InvalidFormatException</td> <td>34</td> </tr> <tr> <td>ConnectionFailedException</td> <td>34</td> </tr> <tr> <td>Exceptions\ConnectionFailedException</td> <td>35</td> </tr> <tr> <td>InvalidWhereQueryCriteriaException</td> <td>37</td> </tr> <tr> <td>RestException 403 Access denied</td> <td>39</td> </tr> <tr> <td>Exceptions\RuntimeException</td> <td>45</td> </tr> <tr> <td>WriterException</td> <td>47</td> </tr> <tr> <td>PhpSpreadsheetException</td> <td>69</td> </tr> <tr> <td>RestException 404</td> <td>72</td> </tr> <tr> <td>RuntimeException</td> <td>78</td> </tr> <tr> <td>RestException 401</td> <td>79</td> </tr> <tr> <td>RestException</td> <td>152</td> </tr> <tr> <td>Exception</td> <td>155</td> </tr> <tr> <td>\Stripe\Exception\ApiErrorException if the request fails</td> <td>536</td> </tr> <tr> <td rowspan="13" style="vertical-align: top;">@todo</td> <td>Opera linux support</td> <td>1</td> </tr> <tr> <td>Windows support (IE, Google Chrome, Mozilla Firefox, Safari)</td> <td>1</td> </tr> <tr> <td>OSX support (Safari, Google Chrome, Mozilla Firefox)</td> <td>1</td> </tr> <tr> <td>Move to const array when PHP 5.6 will be our minimum target</td> <td>1</td> </tr> <tr> <td>A withdrawal line is today linked to one and only one invoice. So the function should return only one object ?</td> <td>1</td> </tr> <tr> <td>needs optimizing</td> <td>1</td> </tr> <tr> <td>currently we're only validating the first parameter of the passed</td> <td>1</td> </tr> <tr> <td>Warning. This implementation differs from the algorithm detailed on the MS</td> <td>1</td> </tr> <tr> <td>Try implementing P J Acklam's refinement algorithm for greater</td> <td>1</td> </tr> <tr> <td>Support for the optional a1 parameter introduced in Excel 2010</td> <td>1</td> </tr> <tr> <td>Remove the error supression from str_replace() call.</td> <td>1</td> </tr> <tr> <td>use an array for properties to clean</td> <td>1</td> </tr> <tr> <td>Move this into files.lib.php</td> <td>2</td> </tr> <tr> <td rowspan="235" style="vertical-align: top;">@url</td> <td>GET myobjects/{id}</td> <td>1</td> </tr> <tr> <td>GET /myobjects/</td> <td>1</td> </tr> <tr> <td>POST myobjects/</td> <td>1</td> </tr> <tr> <td>PUT myobjects/{id}</td> <td>1</td> </tr> <tr> <td>DELETE myobjects/{id}</td> <td>1</td> </tr> <tr> <td>GET /bycode/{code}</td> <td>1</td> </tr> <tr> <td>GET {id}/rates</td> <td>1</td> </tr> <tr> <td>PUT {id}/rates</td> <td>1</td> </tr> <tr> <td>PUT {id}/lines/{lineid}/activate</td> <td>1</td> </tr> <tr> <td>PUT {id}/lines/{lineid}/unactivate</td> <td>1</td> </tr> <tr> <td>GET thirdparty/{thirdparty}</td> <td>1</td> </tr> <tr> <td>GET thirdparty/email/{email}</td> <td>1</td> </tr> <tr> <td>GET thirdparty/barcode/{barcode}</td> <td>1</td> </tr> <tr> <td>GET {id}/subscriptions</td> <td>1</td> </tr> <tr> <td>POST {id}/subscriptions</td> <td>1</td> </tr> <tr> <td>GET /types/{id}</td> <td>1</td> </tr> <tr> <td>GET /types/</td> <td>1</td> </tr> <tr> <td>POST /types/</td> <td>1</td> </tr> <tr> <td>PUT /types/{id}</td> <td>1</td> </tr> <tr> <td>DELETE /types/{id}</td> <td>1</td> </tr> <tr> <td>GET exportdata</td> <td>1</td> </tr> <tr> <td>POST {id}/contact/{contactid}/{type}/{source}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/contact/{contactid}/{type}/{source}</td> <td>1</td> </tr> <tr> <td>POST {id}/approve</td> <td>1</td> </tr> <tr> <td>POST {id}/makeorder</td> <td>1</td> </tr> <tr> <td>POST {id}/receive</td> <td>1</td> </tr> <tr> <td>POST {id}/reopen</td> <td>1</td> </tr> <tr> <td>POST {id}/setinvoiced</td> <td>1</td> </tr> <tr> <td>POST /createfromproposal/{proposalid}</td> <td>1</td> </tr> <tr> <td>GET {id}/shipment</td> <td>1</td> </tr> <tr> <td>POST {id}/shipment/{warehouse_id}</td> <td>1</td> </tr> <tr> <td>GET /hooks/{id}</td> <td>1</td> </tr> <tr> <td>GET /getmoduleschoices/</td> <td>1</td> </tr> <tr> <td>GET /hooks/</td> <td>1</td> </tr> <tr> <td>POST /hook/</td> <td>1</td> </tr> <tr> <td>DELETE /hook/{id}</td> <td>1</td> </tr> <tr> <td>POST /transfer</td> <td>1</td> </tr> <tr> <td>POST {id}/lines/{line_id}/links</td> <td>1</td> </tr> <tr> <td>GET {id}/lines/{line_id}/links</td> <td>1</td> </tr> <tr> <td>PUT {id}/lines/{line_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/lines/{line_id}</td> <td>1</td> </tr> <tr> <td>POST /createfromorder/{orderid}</td> <td>1</td> </tr> <tr> <td>POST /createfromcontract/{contractid}</td> <td>1</td> </tr> <tr> <td>POST {id}/contacts</td> <td>1</td> </tr> <tr> <td>POST {id}/settopaid</td> <td>1</td> </tr> <tr> <td>POST {id}/settounpaid</td> <td>1</td> </tr> <tr> <td>GET {id}/discount</td> <td>1</td> </tr> <tr> <td>POST {id}/markAsCreditAvailable</td> <td>1</td> </tr> <tr> <td>POST {id}/usediscount/{discountid}</td> <td>1</td> </tr> <tr> <td>POST {id}/usecreditnote/{discountid}</td> <td>1</td> </tr> <tr> <td>POST /paymentsdistributed</td> <td>1</td> </tr> <tr> <td>PUT payments/{id}</td> <td>1</td> </tr> <tr> <td>GET templates/{id}</td> <td>1</td> </tr> <tr> <td>GET jobposition/{id}</td> <td>1</td> </tr> <tr> <td>GET candidature/{id}</td> <td>1</td> </tr> <tr> <td>GET /jobposition/</td> <td>1</td> </tr> <tr> <td>GET /candidature/</td> <td>1</td> </tr> <tr> <td>POST jobposition/</td> <td>1</td> </tr> <tr> <td>POST candidature/</td> <td>1</td> </tr> <tr> <td>PUT jobposition/{id}</td> <td>1</td> </tr> <tr> <td>PUT candidature/{id}</td> <td>1</td> </tr> <tr> <td>DELETE jobposition/{id}</td> <td>1</td> </tr> <tr> <td>DELETE candidature/{id}</td> <td>1</td> </tr> <tr> <td>POST {id}/produceandconsume</td> <td>1</td> </tr> <tr> <td>PUT {id}/payments</td> <td>1</td> </tr> <tr> <td>GET *</td> <td>1</td> </tr> <tr> <td>PUT {id}/merge/{idtodelete}</td> <td>1</td> </tr> <tr> <td>PUT {id}/setpricelevel/{priceLevel}</td> <td>1</td> </tr> <tr> <td>POST {id}/representative/{representative_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/representative/{representative_id}</td> <td>1</td> </tr> <tr> <td>GET {id}/supplier_categories</td> <td>1</td> </tr> <tr> <td>PUT {id}/supplier_categories/{category_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/supplier_categories/{category_id}</td> <td>1</td> </tr> <tr> <td>GET {id}/outstandingproposals</td> <td>1</td> </tr> <tr> <td>GET {id}/outstandingorders</td> <td>1</td> </tr> <tr> <td>GET {id}/outstandinginvoices</td> <td>1</td> </tr> <tr> <td>GET {id}/representatives</td> <td>1</td> </tr> <tr> <td>GET {id}/fixedamountdiscounts</td> <td>1</td> </tr> <tr> <td>GET {id}/getinvoicesqualifiedforreplacement</td> <td>1</td> </tr> <tr> <td>GET {id}/getinvoicesqualifiedforcreditnote</td> <td>1</td> </tr> <tr> <td>GET {id}/notifications</td> <td>1</td> </tr> <tr> <td>POST {id}/notifications</td> <td>1</td> </tr> <tr> <td>DELETE {id}/notifications/{notification_id}</td> <td>1</td> </tr> <tr> <td>PUT {id}/notifications/{notification_id}</td> <td>1</td> </tr> <tr> <td>GET {id}/bankaccounts</td> <td>1</td> </tr> <tr> <td>POST {id}/bankaccounts</td> <td>1</td> </tr> <tr> <td>PUT {id}/bankaccounts/{bankaccount_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/bankaccounts/{bankaccount_id}</td> <td>1</td> </tr> <tr> <td>GET {id}/generateBankAccountDocument/{companybankid}/{model}</td> <td>1</td> </tr> <tr> <td>GET {id}/accounts/</td> <td>1</td> </tr> <tr> <td>POST {id}/accounts</td> <td>1</td> </tr> <tr> <td>PUT {id}/accounts/{site}</td> <td>1</td> </tr> <tr> <td>PATCH {id}/accounts/{site}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/accounts/{site}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/accounts</td> <td>1</td> </tr> <tr> <td>POST {id}/createUser</td> <td>1</td> </tr> <tr> <td>POST {id}/line</td> <td>1</td> </tr> <tr> <td>POST {id}/setinvoiced</td> <td>1</td> </tr> <tr> <td>GET login/{login}</td> <td>1</td> </tr> <tr> <td>GET /info</td> <td>1</td> </tr> <tr> <td>GET {id}/groups</td> <td>1</td> </tr> <tr> <td>GET {id}/setGroup/{group}</td> <td>1</td> </tr> <tr> <td>GET /groups</td> <td>1</td> </tr> <tr> <td>GET /groups/{group}</td> <td>1</td> </tr> <tr> <td>GET {id}/subproducts</td> <td>1</td> </tr> <tr> <td>POST {id}/subproducts/add</td> <td>1</td> </tr> <tr> <td>DELETE {id}/subproducts/remove/{subproduct_id}</td> <td>1</td> </tr> <tr> <td>GET {id}/selling_multiprices/per_segment</td> <td>1</td> </tr> <tr> <td>GET {id}/selling_multiprices/per_customer</td> <td>1</td> </tr> <tr> <td>GET {id}/selling_multiprices/per_quantity</td> <td>1</td> </tr> <tr> <td>POST {id}/purchase_prices</td> <td>1</td> </tr> <tr> <td>DELETE {id}/purchase_prices/{priceid}</td> <td>1</td> </tr> <tr> <td>GET purchase_prices</td> <td>1</td> </tr> <tr> <td>GET {id}/purchase_prices</td> <td>1</td> </tr> <tr> <td>GET attributes</td> <td>1</td> </tr> <tr> <td>GET attributes/{id}</td> <td>1</td> </tr> <tr> <td>GET attributes/ref/{ref}</td> <td>1</td> </tr> <tr> <td>GET attributes/ref_ext/{ref_ext}</td> <td>1</td> </tr> <tr> <td>POST attributes</td> <td>1</td> </tr> <tr> <td>PUT attributes/{id}</td> <td>1</td> </tr> <tr> <td>DELETE attributes/{id}</td> <td>1</td> </tr> <tr> <td>GET attributes/values/{id}</td> <td>1</td> </tr> <tr> <td>GET attributes/{id}/values/ref/{ref}</td> <td>1</td> </tr> <tr> <td>DELETE attributes/{id}/values/ref/{ref}</td> <td>1</td> </tr> <tr> <td>GET attributes/{id}/values</td> <td>1</td> </tr> <tr> <td>GET attributes/ref/{ref}/values</td> <td>1</td> </tr> <tr> <td>POST attributes/{id}/values</td> <td>1</td> </tr> <tr> <td>PUT attributes/values/{id}</td> <td>1</td> </tr> <tr> <td>DELETE attributes/values/{id}</td> <td>1</td> </tr> <tr> <td>GET {id}/variants</td> <td>1</td> </tr> <tr> <td>GET ref/{ref}/variants</td> <td>1</td> </tr> <tr> <td>POST {id}/variants</td> <td>1</td> </tr> <tr> <td>POST ref/{ref}/variants</td> <td>1</td> </tr> <tr> <td>PUT variants/{id}</td> <td>1</td> </tr> <tr> <td>DELETE variants/{id}</td> <td>1</td> </tr> <tr> <td>GET {id}/stock</td> <td>1</td> </tr> <tr> <td>GET knowledgerecords/{id}</td> <td>1</td> </tr> <tr> <td>GET /knowledgerecords/{id}/categories</td> <td>1</td> </tr> <tr> <td>GET /knowledgerecords/</td> <td>1</td> </tr> <tr> <td>POST knowledgerecords/</td> <td>1</td> </tr> <tr> <td>PUT knowledgerecords/{id}</td> <td>1</td> </tr> <tr> <td>DELETE knowledgerecords/{id}</td> <td>1</td> </tr> <tr> <td>POST {id}/addtimespent</td> <td>1</td> </tr> <tr> <td>PUT {id}/timespent/{timespent_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/timespent/{timespent_id}</td> <td>1</td> </tr> <tr> <td>GET email_msgid/{email_msgid}</td> <td>1</td> </tr> <tr> <td>GET {id}/tasks</td> <td>1</td> </tr> <tr> <td>POST {id}/tasks</td> <td>1</td> </tr> <tr> <td>PUT {id}/tasks/{taskid}</td> <td>1</td> </tr> <tr> <td>GET track_id/{track_id}</td> <td>1</td> </tr> <tr> <td>POST /</td> <td>1</td> </tr> <tr> <td>GET dictionary/ordering_methods</td> <td>1</td> </tr> <tr> <td>GET dictionary/ordering_origins</td> <td>1</td> </tr> <tr> <td>GET dictionary/payment_types</td> <td>1</td> </tr> <tr> <td>GET dictionary/regions</td> <td>1</td> </tr> <tr> <td>GET dictionary/regions/{id}</td> <td>1</td> </tr> <tr> <td>GET dictionary/regions/byCode/{code}</td> <td>1</td> </tr> <tr> <td>GET dictionary/states</td> <td>1</td> </tr> <tr> <td>GET dictionary/states/{id}</td> <td>1</td> </tr> <tr> <td>GET dictionary/states/byCode/{code}</td> <td>1</td> </tr> <tr> <td>GET dictionary/countries</td> <td>1</td> </tr> <tr> <td>GET dictionary/countries/{id}</td> <td>1</td> </tr> <tr> <td>GET dictionary/countries/byCode/{code}</td> <td>1</td> </tr> <tr> <td>GET dictionary/countries/byISO/{iso}</td> <td>1</td> </tr> <tr> <td>GET dictionary/availability</td> <td>1</td> </tr> <tr> <td>GET dictionary/event_types</td> <td>1</td> </tr> <tr> <td>GET dictionary/expensereport_types</td> <td>1</td> </tr> <tr> <td>GET dictionary/contact_types</td> <td>1</td> </tr> <tr> <td>GET dictionary/civilities</td> <td>1</td> </tr> <tr> <td>GET dictionary/currencies</td> <td>1</td> </tr> <tr> <td>GET extrafields</td> <td>1</td> </tr> <tr> <td>DELETE extrafields/{elementtype}/{attrname}</td> <td>1</td> </tr> <tr> <td>GET extrafields/{elementtype}/{attrname}</td> <td>1</td> </tr> <tr> <td>POST extrafields/{elementtype}/{attrname}</td> <td>1</td> </tr> <tr> <td>PUT extrafields/{elementtype}/{attrname}</td> <td>1</td> </tr> <tr> <td>GET dictionary/towns</td> <td>1</td> </tr> <tr> <td>GET dictionary/payment_terms</td> <td>1</td> </tr> <tr> <td>GET dictionary/shipping_methods</td> <td>1</td> </tr> <tr> <td>GET dictionary/units</td> <td>1</td> </tr> <tr> <td>GET dictionary/legal_form</td> <td>1</td> </tr> <tr> <td>GET dictionary/staff</td> <td>1</td> </tr> <tr> <td>GET dictionary/socialnetworks</td> <td>1</td> </tr> <tr> <td>GET dictionary/ticket_categories</td> <td>1</td> </tr> <tr> <td>GET dictionary/ticket_severities</td> <td>1</td> </tr> <tr> <td>GET dictionary/ticket_types</td> <td>1</td> </tr> <tr> <td>GET dictionary/incoterms</td> <td>1</td> </tr> <tr> <td>GET /company</td> <td>1</td> </tr> <tr> <td>GET /establishments</td> <td>1</td> </tr> <tr> <td>GET establishments/{id}</td> <td>1</td> </tr> <tr> <td>GET conf/{constantname}</td> <td>1</td> </tr> <tr> <td>GET checkintegrity</td> <td>1</td> </tr> <tr> <td>GET /modules</td> <td>1</td> </tr> <tr> <td>GET /download</td> <td>1</td> </tr> <tr> <td>PUT /builddoc</td> <td>1</td> </tr> <tr> <td>POST /upload</td> <td>1</td> </tr> <tr> <td>DELETE /</td> <td>1</td> </tr> <tr> <td>GET partnerships/{id}</td> <td>1</td> </tr> <tr> <td>GET /partnerships/</td> <td>1</td> </tr> <tr> <td>POST partnerships/</td> <td>1</td> </tr> <tr> <td>PUT partnerships/{id}</td> <td>1</td> </tr> <tr> <td>DELETE partnerships/{id}</td> <td>1</td> </tr> <tr> <td>GET /object/{type}/{id}</td> <td>1</td> </tr> <tr> <td>POST {id}/objects/{type}/{object_id}</td> <td>1</td> </tr> <tr> <td>POST {id}/objects/{type}/ref/{object_ref}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/objects/{type}/{object_id}</td> <td>1</td> </tr> <tr> <td>DELETE {id}/objects/{type}/ref/{object_ref}</td> <td>1</td> </tr> <tr> <td>GET {id}/objects</td> <td>1</td> </tr> <tr> <td>GET {id}/payments</td> <td>2</td> </tr> <tr> <td>GET {id}/contacts</td> <td>2</td> </tr> <tr> <td>GET /payments</td> <td>2</td> </tr> <tr> <td>GET /payments/{pid}</td> <td>2</td> </tr> <tr> <td>DELETE {id}/payments</td> <td>2</td> </tr> <tr> <td>https://github.com/laravel/framework/blob/8.x/src/Illuminate/Support/Traits/Conditionable.php</td> <td>2</td> </tr> <tr> <td>GET barcode/{barcode}</td> <td>2</td> </tr> <tr> <td>PUT {id}/categories/{category_id}</td> <td>2</td> </tr> <tr> <td>DELETE {id}/categories/{category_id}</td> <td>2</td> </tr> <tr> <td>GET ref_ext/{ref_ext}</td> <td>2</td> </tr> <tr> <td>GET {id}/roles</td> <td>2</td> </tr> <tr> <td>GET {id}</td> <td>3</td> </tr> <tr> <td>GET ref/{ref}</td> <td>3</td> </tr> <tr> <td>GET ref_ext/{ref_ext}</td> <td>3</td> </tr> <tr> <td>POST {id}/contact/{contactid}/{type}</td> <td>3</td> </tr> <tr> <td>DELETE {id}/contact/{contactid}/{type}</td> <td>3</td> </tr> <tr> <td>POST {id}/settodraft</td> <td>3</td> </tr> <tr> <td>GET email/{email}</td> <td>3</td> </tr> <tr> <td>GET ref/{ref}</td> <td>3</td> </tr> <tr> <td>GET {id}/categories</td> <td>4</td> </tr> <tr> <td>POST {id}/payments</td> <td>5</td> </tr> <tr> <td>POST {id}/close</td> <td>6</td> </tr> <tr> <td>GET /</td> <td>7</td> </tr> <tr> <td>PUT {id}/lines/{lineid}</td> <td>7</td> </tr> <tr> <td>DELETE {id}/lines/{lineid}</td> <td>9</td> </tr> <tr> <td>GET {id}/lines</td> <td>9</td> </tr> <tr> <td>POST {id}/lines</td> <td>9</td> </tr> <tr> <td>POST {id}/validate</td> <td>12</td> </tr> <tr> <td rowspan="1" style="vertical-align: top;">@use</td> <td>CarbonTypeConverter<CarbonImmutable> */</td> <td>1</td> </tr> <tr> <td rowspan="2527" style="vertical-align: top;">@var</td> <td>string module is in development</td> <td>1</td> </tr> <tr> <td>string module is experimental</td> <td>1</td> </tr> <tr> <td>string module is dolibarr ready</td> <td>1</td> </tr> <tr> <td>array dictionary of possible module states</td> <td>1</td> </tr> <tr> <td>int LDAP to Dolibarr synchronization</td> <td>1</td> </tr> <tr> <td>int No LDAP synchronization</td> <td>1</td> </tr> <tr> <td>int Dolibarr to LDAP synchronization</td> <td>1</td> </tr> <tr> <td>string default base URL for Stripe's Files API */</td> <td>1</td> </tr> <tr> <td>string default base URL for Stripe's API */</td> <td>1</td> </tr> <tr> <td>string default base URL for Stripe's OAuth API */</td> <td>1</td> </tr> <tr> <td>array Mapping from object types to resource classes</td> <td>1</td> </tr> <tr> <td>string Minimal version of PrestaShop to use with this library */</td> <td>1</td> </tr> <tr> <td>string Maximal version of PrestaShop to use with this library */</td> <td>1</td> </tr> <tr> <td>string TRIGGER_PREFIX Dolibarr 16.0 and above use the prefix to prevent the creation of inconsistently</td> <td>1</td> </tr> <tr> <td>int ID of dolresource</td> <td>1</td> </tr> <tr> <td>string String with name of icon for workstation. Must be the part after the 'object_' into object_workstation.png</td> <td>1</td> </tr> <tr> <td>int rowid ID</td> <td>1</td> </tr> <tr> <td>string ref of workstation</td> <td>1</td> </tr> <tr> <td>string label of workstation</td> <td>1</td> </tr> <tr> <td>int status enabled or disabled</td> <td>1</td> </tr> <tr> <td>int nb operators required</td> <td>1</td> </tr> <tr> <td>float thm operator estimated</td> <td>1</td> </tr> <tr> <td>float thm machine estimated</td> <td>1</td> </tr> <tr> <td>int ID of user group</td> <td>1</td> </tr> <tr> <td>int warehouse id</td> <td>1</td> </tr> <tr> <td>string Tracking number</td> <td>1</td> </tr> <tr> <td>string Tracking url</td> <td>1</td> </tr> <tr> <td>string name of pdf model</td> <td>1</td> </tr> <tr> <td>integer|string Date delivery planned</td> <td>1</td> </tr> <tr> <td>int ID of order</td> <td>1</td> </tr> <tr> <td>Commande order</td> <td>1</td> </tr> <tr> <td>ExpeditionLigne[] array of shipping lines</td> <td>1</td> </tr> <tr> <td>string String with the name of icon for myobject. Can be an image filename like 'object_myobject.png' of a font awesome code 'fa-...'.</td> <td>1</td> </tr> <tr> <td>string Type of object the fk_element refers to. Example: 'order'.</td> <td>1</td> </tr> <tr> <td>int Id of shipment</td> <td>1</td> </tr> <tr> <td>float qty asked From llx_expeditiondet</td> <td>1</td> </tr> <tr> <td>float qty shipped</td> <td>1</td> </tr> <tr> <td>int Id of warehouse</td> <td>1</td> </tr> <tr> <td>float qty asked From llx_commandedet or llx_propaldet</td> <td>1</td> </tr> <tr> <td>string product ref</td> <td>1</td> </tr> <tr> <td>string product label</td> <td>1</td> </tr> <tr> <td>int rang of line</td> <td>1</td> </tr> <tr> <td>float weight</td> <td>1</td> </tr> <tr> <td>float length</td> <td>1</td> </tr> <tr> <td>float width</td> <td>1</td> </tr> <tr> <td>float height</td> <td>1</td> </tr> <tr> <td>float surface</td> <td>1</td> </tr> <tr> <td>float volume</td> <td>1</td> </tr> <tr> <td>float total without tax</td> <td>1</td> </tr> <tr> <td>float total with tax</td> <td>1</td> </tr> <tr> <td>float total vat</td> <td>1</td> </tr> <tr> <td>float total localtax 1</td> <td>1</td> </tr> <tr> <td>float total localtax 2</td> <td>1</td> </tr> <tr> <td>string Alphanumeric ID. Populated by the constructor.</td> <td>1</td> </tr> <tr> <td>string Box icon (in configuration page)</td> <td>1</td> </tr> <tr> <td>string Box label (in configuration page)</td> <td>1</td> </tr> <tr> <td>string[] Module dependencies</td> <td>1</td> </tr> <tr> <td>Expedition $shipment {@type Expedition}</td> <td>1</td> </tr> <tr> <td>string Base URL of the webserver under test */</td> <td>1</td> </tr> <tr> <td>string Dolibarr admin username</td> <td>1</td> </tr> <tr> <td>string Dolibarr admin password</td> <td>1</td> </tr> <tr> <td>int Dolibarr module ID */</td> <td>1</td> </tr> <tr> <td>array Browsers to test with */</td> <td>1</td> </tr> <tr> <td>int ID thirdparty</td> <td>1</td> </tr> <tr> <td>int ID user</td> <td>1</td> </tr> <tr> <td>string sql part from</td> <td>1</td> </tr> <tr> <td>string sql part join</td> <td>1</td> </tr> <tr> <td>string sql part fields</td> <td>1</td> </tr> <tr> <td>string sql part where</td> <td>1</td> </tr> <tr> <td>string If permission must be checkec with hasRight('mymodule', 'read') and not hasright('mymodyle', 'myobject', 'read'), you can uncomment this line</td> <td>1</td> </tr> <tr> <td>string String with name of icon for myobject. Must be a 'fa-xxx' fontawesome code (or 'fa-xxx_fa_color_size') or 'myobject@mymodule' if picto is file 'img/object_myobject.png'.</td> <td>1</td> </tr> <tr> <td>array Errors</td> <td>1</td> </tr> <tr> <td>array Hook results. Propagated to $hookmanager->resArray for later reuse</td> <td>1</td> </tr> <tr> <td>?string String displayed by executeHook() immediately after return</td> <td>1</td> </tr> <tr> <td>int Priority of hook (50 is used if value is not defined)</td> <td>1</td> </tr> <tr> <td>string String with name of icon for target. Must be the part after the 'object_' into object_target.png</td> <td>1</td> </tr> <tr> <td>MyObject $myobject {@type MyObject}</td> <td>1</td> </tr> <tr> <td>string List of trigger codes separated by a comma. Example: 'BILL_VALIDATE,PROPAL_DELETE,...'</td> <td>1</td> </tr> <tr> <td>string Id to identify managed objects</td> <td>1</td> </tr> <tr> <td>CurrencyRate[] Currency rates</td> <td>1</td> </tr> <tr> <td>string The currency code</td> <td>1</td> </tr> <tr> <td>string The currency name</td> <td>1</td> </tr> <tr> <td>?CurrencyRate The currency rate</td> <td>1</td> </tr> <tr> <td>double Rate</td> <td>1</td> </tr> <tr> <td>double Rate Indirect</td> <td>1</td> </tr> <tr> <td>integer Date synchronisation</td> <td>1</td> </tr> <tr> <td>int Id of currency</td> <td>1</td> </tr> <tr> <td>int Id of entity</td> <td>1</td> </tr> <tr> <td>string Name to use for 'features' parameter to check module permissions user->rights->feature with restrictedArea().</td> <td>1</td> </tr> <tr> <td>int ID</td> <td>1</td> </tr> <tr> <td>int Info bits</td> <td>1</td> </tr> <tr> <td>int ID of user that insert the service</td> <td>1</td> </tr> <tr> <td>int ID of user opening the service</td> <td>1</td> </tr> <tr> <td>int ID of user closing the service</td> <td>1</td> </tr> <tr> <td>string Comment</td> <td>1</td> </tr> <tr> <td>Contrat $contract {@type Contrat}</td> <td>1</td> </tr> <tr> <td>string ref ???</td> <td>1</td> </tr> <tr> <td>string declaration number</td> <td>1</td> </tr> <tr> <td>int Id of user author of the contract</td> <td>1</td> </tr> <tr> <td>User Object user that create the contract. Set by the info method.</td> <td>1</td> </tr> <tr> <td>User Object user that close the contract. Set by the info method.</td> <td>1</td> </tr> <tr> <td>integer|string Date of creation</td> <td>1</td> </tr> <tr> <td>integer|string Date of last modification. Not filled until you call ->info()</td> <td>1</td> </tr> <tr> <td>integer|string Date of validation</td> <td>1</td> </tr> <tr> <td>integer|string Date when contract was signed</td> <td>1</td> </tr> <tr> <td>ContratLigne[] Contract lines</td> <td>1</td> </tr> <tr> <td>string Date last modification (same as tms)</td> <td>1</td> </tr> <tr> <td>string Id sondage not an int</td> <td>1</td> </tr> <tr> <td>string Description</td> <td>1</td> </tr> <tr> <td>int Allow comments on this poll</td> <td>1</td> </tr> <tr> <td>int Allow users see others vote</td> <td>1</td> </tr> <tr> <td>string Subject</td> <td>1</td> </tr> <tr> <td>string Id sondage admin not an int</td> <td>1</td> </tr> <tr> <td>int|string Date start in PHP server TZ</td> <td>1</td> </tr> <tr> <td>int|string Date end in PHP server TZ</td> <td>1</td> </tr> <tr> <td>int|string Date start in GMT</td> <td>1</td> </tr> <tr> <td>int|string Date end in GMT</td> <td>1</td> </tr> <tr> <td>int|string 0:Full days, 2:Start afternoon end morning, -1:Start afternoon end afternoon, 1:Start morning end morning</td> <td>1</td> </tr> <tr> <td>int Status 1=draft, 2=validated, 3=approved, 4 canceled, 5 refused</td> <td>1</td> </tr> <tr> <td>int ID of user that must approve. Real user for approval is fk_user_valid (old version) or fk_user_approve (new versions)</td> <td>1</td> </tr> <tr> <td>int Date of validation or approval. TODO: Use date_valid instead for validation.</td> <td>1</td> </tr> <tr> <td>int ID of user that has validated</td> <td>1</td> </tr> <tr> <td>int Date approval</td> <td>1</td> </tr> <tr> <td>int ID of user that has approved</td> <td>1</td> </tr> <tr> <td>int Date for refuse</td> <td>1</td> </tr> <tr> <td>int ID for refuse</td> <td>1</td> </tr> <tr> <td>int Date for cancellation</td> <td>1</td> </tr> <tr> <td>int ID for cancellation</td> <td>1</td> </tr> <tr> <td>int ID for creation</td> <td>1</td> </tr> <tr> <td>string Detail of refuse</td> <td>1</td> </tr> <tr> <td>string[] array of messages</td> <td>1</td> </tr> <tr> <td>string login of member</td> <td>1</td> </tr> <tr> <td>string The civility code, not an integer (ex: 'MR', 'MME', 'MLE', etc.)</td> <td>1</td> </tr> <tr> <td>int socid</td> <td>1</td> </tr> <tr> <td>string Phone number</td> <td>1</td> </tr> <tr> <td>string Private Phone number</td> <td>1</td> </tr> <tr> <td>string Professional Phone number</td> <td>1</td> </tr> <tr> <td>string Mobile phone number</td> <td>1</td> </tr> <tr> <td>string Fax number</td> <td>1</td> </tr> <tr> <td>string Function</td> <td>1</td> </tr> <tr> <td>string mor or phy</td> <td>1</td> </tr> <tr> <td>int Info can be public</td> <td>1</td> </tr> <tr> <td>string photo of member</td> <td>1</td> </tr> <tr> <td>int|string date of birth</td> <td>1</td> </tr> <tr> <td>int id type member</td> <td>1</td> </tr> <tr> <td>string label type member</td> <td>1</td> </tr> <tr> <td>int need_subscription</td> <td>1</td> </tr> <tr> <td>int user_id</td> <td>1</td> </tr> <tr> <td>string user_login</td> <td>1</td> </tr> <tr> <td>string ip</td> <td>1</td> </tr> <tr> <td>Facture|null To store the created invoice into subscriptionComplementaryActions()</td> <td>1</td> </tr> <tr> <td>string Adherent type label</td> <td>1</td> </tr> <tr> <td>string Adherent type nature</td> <td>1</td> </tr> <tr> <td>int Subscription required (0 or 1)</td> <td>1</td> </tr> <tr> <td>float|string Amount for subscription (null or '' means not defined)</td> <td>1</td> </tr> <tr> <td>int Amount can be chosen by the visitor during subscription (0 or 1)</td> <td>1</td> </tr> <tr> <td>string Public note</td> <td>1</td> </tr> <tr> <td>string Public note */</td> <td>1</td> </tr> <tr> <td>integer Can vote */</td> <td>1</td> </tr> <tr> <td>string Email sent during validation of member */</td> <td>1</td> </tr> <tr> <td>string Email sent after recording a new subscription */</td> <td>1</td> </tr> <tr> <td>string Email sent after resiliation */</td> <td>1</td> </tr> <tr> <td>string Email sent after exclude */</td> <td>1</td> </tr> <tr> <td>array Array of members */</td> <td>1</td> </tr> <tr> <td>array multilangs</td> <td>1</td> </tr> <tr> <td>int Member ID</td> <td>1</td> </tr> <tr> <td>double amount subscription</td> <td>1</td> </tr> <tr> <td>int ID of bank in llx_bank</td> <td>1</td> </tr> <tr> <td>array Queries array</td> <td>1</td> </tr> <tr> <td>float Request start time in second + microseconds as decimal part (Example: 1712305485.1104)</td> <td>1</td> </tr> <tr> <td>int Request start memory</td> <td>1</td> </tr> <tr> <td>object Database handler</td> <td>1</td> </tr> <tr> <td>string default logs file path</td> <td>1</td> </tr> <tr> <td>int number of lines to show</td> <td>1</td> </tr> <tr> <td>int number of lines</td> <td>1</td> </tr> <tr> <td>int egroupware_id</td> <td>1</td> </tr> <tr> <td>int birthday_alert</td> <td>1</td> </tr> <tr> <td>string The civilite code, not an integer</td> <td>1</td> </tr> <tr> <td>string Name alias</td> <td>1</td> </tr> <tr> <td>int Id of department</td> <td>1</td> </tr> <tr> <td>string Code of department</td> <td>1</td> </tr> <tr> <td>string Label of department</td> <td>1</td> </tr> <tr> <td>string Job Position</td> <td>1</td> </tr> <tr> <td>int Status 0=inactive, 1=active</td> <td>1</td> </tr> <tr> <td>string filename for photo</td> <td>1</td> </tr> <tr> <td>string phone pro (professional/business)</td> <td>1</td> </tr> <tr> <td>string phone perso (personal/private)</td> <td>1</td> </tr> <tr> <td>string fax</td> <td>1</td> </tr> <tr> <td>int|string Date</td> <td>1</td> </tr> <tr> <td>string language for contact communication -- only with multilanguage enabled</td> <td>1</td> </tr> <tr> <td>int Number of invoices for which he is contact</td> <td>1</td> </tr> <tr> <td>int Number of contracts for which he is contact</td> <td>1</td> </tr> <tr> <td>int Number of orders for which he is contact</td> <td>1</td> </tr> <tr> <td>int Number of proposals for which he is contact</td> <td>1</td> </tr> <tr> <td>array roles</td> <td>1</td> </tr> <tr> <td>int|string Creation date</td> <td>1</td> </tr> <tr> <td>int|string Payment date</td> <td>1</td> </tr> <tr> <td>int Payment Type ID</td> <td>1</td> </tr> <tr> <td>int Loan Payment ID</td> <td>1</td> </tr> <tr> <td>LoanSchedule[]</td> <td>1</td> </tr> <tr> <td>string Loan label</td> <td>1</td> </tr> <tr> <td>float totalpaid</td> <td>1</td> </tr> <tr> <td>string String with name of icon for PaymentLoan</td> <td>1</td> </tr> <tr> <td>string Create date</td> <td>1</td> </tr> <tr> <td>string Payment date</td> <td>1</td> </tr> <tr> <td>array<float|int> Array of amounts</td> <td>1</td> </tr> <tr> <td>float|int Total amount of payment</td> <td>1</td> </tr> <tr> <td>int Payment mode ID</td> <td>1</td> </tr> <tr> <td>string Name of sub table line</td> <td>1</td> </tr> <tr> <td>string external ref</td> <td>1</td> </tr> <tr> <td>ProductAttributeValue[]</td> <td>1</td> </tr> <tr> <td>ProductAttributeValue</td> <td>1</td> </tr> <tr> <td>int Number of product that use this attribute</td> <td>1</td> </tr> <tr> <td>bool|array</td> <td>1</td> </tr> <tr> <td>ProductCombinationLevel[]</td> <td>1</td> </tr> <tr> <td>string[] array of errors</td> <td>1</td> </tr> <tr> <td>string[] Array of Errors code (or messages)</td> <td>1</td> </tr> <tr> <td>int pcg version</td> <td>1</td> </tr> <tr> <td>string Accountancy System numero</td> <td>1</td> </tr> <tr> <td>string Accountancy System label</td> <td>1</td> </tr> <tr> <td>string account parent</td> <td>1</td> </tr> <tr> <td>array $FIELDS Mandatory fields, checked when create and update object</td> <td>1</td> </tr> <tr> <td>BookKeeping $bookkeeping {@type BookKeeping}</td> <td>1</td> </tr> <tr> <td>AccountancyExport $accountancy_export {@type AccountancyExport}</td> <td>1</td> </tr> <tr> <td>string Name of element</td> <td>1</td> </tr> <tr> <td>string pcg version</td> <td>1</td> </tr> <tr> <td>int ID parent account</td> <td>1</td> </tr> <tr> <td>int ID category account</td> <td>1</td> </tr> <tr> <td>int Label category account</td> <td>1</td> </tr> <tr> <td>string Label of account</td> <td>1</td> </tr> <tr> <td>string Label short of account</td> <td>1</td> </tr> <tr> <td>int active (duplicate with status)</td> <td>1</td> </tr> <tr> <td>int reconcilable</td> <td>1</td> </tr> <tr> <td>array cache array</td> <td>1</td> </tr> <tr> <td>BookKeepingLine[] Lines</td> <td>1</td> </tr> <tr> <td>int Date of source document, in db date NOT NULL</td> <td>1</td> </tr> <tr> <td>string doc_type</td> <td>1</td> </tr> <tr> <td>string doc_ref</td> <td>1</td> </tr> <tr> <td>string thirdparty code</td> <td>1</td> </tr> <tr> <td>string subledger label</td> <td>1</td> </tr> <tr> <td>string doc_type</td> <td>1</td> </tr> <tr> <td>string label compte</td> <td>1</td> </tr> <tr> <td>string label operation</td> <td>1</td> </tr> <tr> <td>float FEC:Debit</td> <td>1</td> </tr> <tr> <td>float FEC:Credit</td> <td>1</td> </tr> <tr> <td>string FEC:Sens (Not necessary)</td> <td>1</td> </tr> <tr> <td>string key for import</td> <td>1</td> </tr> <tr> <td>string code journal</td> <td>1</td> </tr> <tr> <td>string label journal</td> <td>1</td> </tr> <tr> <td>BookKeepingLine[] Movement line array</td> <td>1</td> </tr> <tr> <td>BookKeepingLine[] export line array</td> <td>1</td> </tr> <tr> <td>integer|string date of movement validated & lock</td> <td>1</td> </tr> <tr> <td>integer|string date of movement who are noticed like exported</td> <td>1</td> </tr> <tr> <td>string[] SQL filter used for check if the bookkeeping record can be created/inserted/modified/deleted (cached)</td> <td>1</td> </tr> <tr> <td>float Amount</td> <td>1</td> </tr> <tr> <td>float Multicurrency amount</td> <td>1</td> </tr> <tr> <td>string Multicurrency code</td> <td>1</td> </tr> <tr> <td>string Sens</td> <td>1</td> </tr> <tr> <td>integer|string $date_export;</td> <td>1</td> </tr> <tr> <td>integer|string $date_lim_reglement;</td> <td>1</td> </tr> <tr> <td>string Accountancy code</td> <td>1</td> </tr> <tr> <td>string Accountancy Category label</td> <td>1</td> </tr> <tr> <td>string Accountancy range account</td> <td>1</td> </tr> <tr> <td>int Sens of the account: 0: credit - debit, 1: debit - credit</td> <td>1</td> </tr> <tr> <td>int Category type of accountancy</td> <td>1</td> </tr> <tr> <td>string Formula</td> <td>1</td> </tr> <tr> <td>int Position</td> <td>1</td> </tr> <tr> <td>int Is active</td> <td>1</td> </tr> <tr> <td>array Lines cptbk</td> <td>1</td> </tr> <tr> <td>array Lines display</td> <td>1</td> </tr> <tr> <td>mixed Sum debit credit</td> <td>1</td> </tr> <tr> <td>array Sum debit credit per month</td> <td>1</td> </tr> <tr> <td>array Sum debit credit per account</td> <td>1</td> </tr> <tr> <td>string Accounting journal code</td> <td>1</td> </tr> <tr> <td>string Accounting Journal label</td> <td>1</td> </tr> <tr> <td>int 1:various operations, 2:sale, 3:purchase, 4:bank, 5:expense-report, 8:inventory, 9: has-new</td> <td>1</td> </tr> <tr> <td>int is active or not</td> <td>1</td> </tr> <tr> <td>array Accounting account cached</td> <td>1</td> </tr> <tr> <td>array Nature mapping</td> <td>1</td> </tr> <tr> <td>string Separator</td> <td>1</td> </tr> <tr> <td>string End of line</td> <td>1</td> </tr> <tr> <td>array Generated file</td> <td>1</td> </tr> <tr> <td>string String with name of icon for bom. Must be the part after the 'object_' into object_bom.png</td> <td>1</td> </tr> <tr> <td>Product Object product of the BOM</td> <td>1</td> </tr> <tr> <td>int bomtype</td> <td>1</td> </tr> <tr> <td>int Id User creator</td> <td>1</td> </tr> <tr> <td>int product Id</td> <td>1</td> </tr> <tr> <td>string Fieldname with ID of parent key if this field has a parent</td> <td>1</td> </tr> <tr> <td>BOMLine[] Array of subtable lines</td> <td>1</td> </tr> <tr> <td>float Calculated cost for the BOM</td> <td>1</td> </tr> <tr> <td>float Calculated cost for 1 unit of the product in BOM</td> <td>1</td> </tr> <tr> <td>string String with name of icon for bomline. Must be the part after the 'object_' into object_bomline.png</td> <td>1</td> </tr> <tr> <td>int fk_bom</td> <td>1</td> </tr> <tr> <td>int Id of parent bom</td> <td>1</td> </tr> <tr> <td>double qty</td> <td>1</td> </tr> <tr> <td>float qty frozen</td> <td>1</td> </tr> <tr> <td>int disable stock change</td> <td>1</td> </tr> <tr> <td>double efficiency</td> <td>1</td> </tr> <tr> <td>int position of line</td> <td>1</td> </tr> <tr> <td>float Calculated cost for the BOM line</td> <td>1</td> </tr> <tr> <td>float Line unit cost based on product cost price or pmp</td> <td>1</td> </tr> <tr> <td>array array of Bom in line</td> <td>1</td> </tr> <tr> <td>BOM $bom {@type BOM}</td> <td>1</td> </tr> <tr> <td>mixed|string</td> <td>1</td> </tr> <tr> <td>string Description</td> <td>1</td> </tr> <tr> <td>int Date</td> <td>1</td> </tr> <tr> <td>string Label used as ref for template invoices</td> <td>1</td> </tr> <tr> <td>int Type of invoice (See TYPE_XXX constants)</td> <td>1</td> </tr> <tr> <td>int Sub type of invoice (A subtype code coming from llx_invoice_subtype table. May be used by some countries like Greece)</td> <td>1</td> </tr> <tr> <td>string Close code</td> <td>1</td> </tr> <tr> <td>string Close note</td> <td>1</td> </tr> <tr> <td>string[] Messages returned by an online payment module</td> <td>1</td> </tr> <tr> <td>string|float</td> <td>1</td> </tr> <tr> <td>int The ID of the state</td> <td>1</td> </tr> <tr> <td>string The code of the state</td> <td>1</td> </tr> <tr> <td>string The name of the state</td> <td>1</td> </tr> <tr> <td>array<string,int> */</td> <td>1</td> </tr> <tr> <td>?string String of results.</td> <td>1</td> </tr> <tr> <td>array Array of results.</td> <td>1</td> </tr> <tr> <td>array{html?:array{mimeType:string,data:string,dataText:string,md5?:string},plain?:array{mimeType:string,data:string,dataText:string,md5?:string},image:array<string,array{imageName:string,cid:string,md5?:string,data:string}>,attachment:array<string,array{filename:string,cid?:string,md5?:string,data:string}>} $msgContent Array of messages</td> <td>1</td> </tr> <tr> <td>int User Id</td> <td>1</td> </tr> <tr> <td>string Page</td> <td>1</td> </tr> <tr> <td>string Param</td> <td>1</td> </tr> <tr> <td>string Value</td> <td>1</td> </tr> <tr> <td>int Id of company</td> <td>1</td> </tr> <tr> <td>string end of line character</td> <td>1</td> </tr> <tr> <td>string address from</td> <td>1</td> </tr> <tr> <td>string address to</td> <td>1</td> </tr> <tr> <td>string[] array of tags</td> <td>1</td> </tr> <tr> <td>\Mike42\Escpos\Printer</td> <td>1</td> </tr> <tr> <td>array List of printers</td> <td>1</td> </tr> <tr> <td>array List of printer templates</td> <td>1</td> </tr> <tr> <td>Object Associative array with properties found in conf file</td> <td>1</td> </tr> <tr> <td>Object Associative array with some properties ->type, ->db, ...</td> <td>1</td> </tr> <tr> <td>Object To store global setup found into database</td> <td>1</td> </tr> <tr> <td>Object To store browser info (->name, ->os, ->version, ->ua, ->layout, ...)</td> <td>1</td> </tr> <tr> <td>array<string,string> List of activated modules</td> <td>1</td> </tr> <tr> <td>array<string,array<string,string|array>> List of activated modules</td> <td>1</td> </tr> <tr> <td>array<string,mixed> An array to store cache results ->cache['nameofcache']=...</td> <td>1</td> </tr> <tr> <td>int To tell header was output</td> <td>1</td> </tr> <tr> <td>LogHandler[]</td> <td>1</td> </tr> <tr> <td>int Used to store running instance for multi-company (default 1)</td> <td>1</td> </tr> <tr> <td>int[] Used to store list of entities to use for each element</td> <td>1</td> </tr> <tr> <td>stdClass Supplier</td> <td>1</td> </tr> <tr> <td>stdClass Product</td> <td>1</td> </tr> <tr> <td>mixed Sample line property 1</td> <td>1</td> </tr> <tr> <td>string Type resource line label</td> <td>1</td> </tr> <tr> <td>array record</td> <td>1</td> </tr> <tr> <td>string element</td> <td>1</td> </tr> <tr> <td>string table element</td> <td>1</td> </tr> <tr> <td>Translate $outputLang</td> <td>1</td> </tr> <tr> <td>string Used to return message</td> <td>1</td> </tr> <tr> <td>string[] Directory containing the /langs subdirectory</td> <td>1</td> </tr> <tr> <td>string Current language for current user</td> <td>1</td> </tr> <tr> <td>string Short language code for current user</td> <td>1</td> </tr> <tr> <td>string Codage used by "trans" method outputs</td> <td>1</td> </tr> <tr> <td>array Array of all translations key=>value</td> <td>1</td> </tr> <tr> <td>array Array to store result after loading each language file</td> <td>1</td> </tr> <tr> <td>array Cache for labels returned by getLabelFromKey method</td> <td>1</td> </tr> <tr> <td>array Cache to store currency symbols</td> <td>1</td> </tr> <tr> <td>bool True if all currencies have been loaded in this->cache_currencies</td> <td>1</td> </tr> <tr> <td>string Language to use</td> <td>1</td> </tr> <tr> <td>DoliDB Database handler</td> <td>1</td> </tr> <tr> <td>string Used by Cron method to return message</td> <td>1</td> </tr> <tr> <td>array{commandbackuplastdone:string,commandbackuptorun:string} Used by Cron method to return data</td> <td>1</td> </tr> <tr> <td>int ID of country</td> <td>1</td> </tr> <tr> <td>array<string,array{label:array<string,string>,type:array<string,string>,size:array<string,string>,default:array<string,string>,computed:array<string,string>,unique:array<string,int>,required:array<string,int>,param:array<string,mixed>,perms:array<string,mixed[]>,list:array<string,int|string>,pos:array<string,int>,totalizable:array<string,int>,help:array<string,string>,printable:array<string,int>,enabled:array<string,int>,langfile:array<string,string>,css:array<string,string>,csslist:array<string,string>,hidden:array<string,int>,mandatoryfieldsofotherentities:array<string,string>,loaded?:int,count:int}> New array to store extrafields definition Note: count set as present to avoid static analysis notices</td> <td>1</td> </tr> <tr> <td>array<string,bool> Array with boolean of status of groups</td> <td>1</td> </tr> <tr> <td>string DB Error number</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of type to label</td> <td>1</td> </tr> <tr> <td>string town</td> <td>1</td> </tr> <tr> <td>int $state_id</td> <td>1</td> </tr> <tr> <td>array New array to store extralanguages definition</td> <td>1</td> </tr> <tr> <td>string ID of module.</td> <td>1</td> </tr> <tr> <td>string Error string that is hidden but can be used to store additional technical code</td> <td>1</td> </tr> <tr> <td>array<string,string> To store error results of ->validateField()</td> <td>1</td> </tr> <tr> <td>string ID to identify managed object</td> <td>1</td> </tr> <tr> <td>string|int Field with ID of parent key if this field has a parent (a string). For example 'fk_product'.</td> <td>1</td> </tr> <tr> <td>string Name to use for 'features' parameter to check module permissions user->rights->feature with restrictedArea().</td> <td>1</td> </tr> <tr> <td>string Name of table without prefix where object is stored</td> <td>1</td> </tr> <tr> <td>string Name of subtable line</td> <td>1</td> </tr> <tr> <td>int<0,1>|string Does this object support multicompany module ?</td> <td>1</td> </tr> <tr> <td>string Key value used to track if data is coming from import wizard</td> <td>1</td> </tr> <tr> <td>array<string,mixed> Contains data to manage extrafields</td> <td>1</td> </tr> <tr> <td>array<string,array<string,string>> Array to store alternative languages values of object</td> <td>1</td> </tr> <tr> <td>array<int,array{parentId:int,source:string,socid:int,id:int,nom:string,civility:string,lastname:string,firstname:string,email:string,login:string,photo:string,statuscontact:int,rowid:int,code:string,libelle:string,status:string,fk_c_type_contact:int}> To store result of ->liste_contact()</td> <td>1</td> </tr> <tr> <td>mixed Array of linked objects, set and used when calling ->create() to be able to create links during the creation of object</td> <td>1</td> </tr> <tr> <td>int[][] Array of linked objects ids. Loaded by ->fetchObjectLinked</td> <td>1</td> </tr> <tr> <td>mixed Array of linked objects. Loaded by ->fetchObjectLinked</td> <td>1</td> </tr> <tr> <td>boolean[] Array of boolean with object id as key and value as true if linkedObjects full loaded for object id. Loaded by ->fetchObjectLinked. Important for pdf generation time reduction.</td> <td>1</td> </tr> <tr> <td>?static To store a cloned copy of the object before editing it (to keep track of its former properties)</td> <td>1</td> </tr> <tr> <td>string To store the old value of a modified reference</td> <td>1</td> </tr> <tr> <td>string Column name of the ref field.</td> <td>1</td> </tr> <tr> <td>integer 0=Default, 1=View may be restricted to sales representative only if no permission to see all or to company of external user if external user</td> <td>1</td> </tr> <tr> <td>array<string,mixed> Can be used to pass information when only the object is provided to the method</td> <td>1</td> </tr> <tr> <td>string Contains canvas name if record is an alternative canvas record</td> <td>1</td> </tr> <tr> <td>Project|null The related project object</td> <td>1</td> </tr> <tr> <td>int The related project ID</td> <td>1</td> </tr> <tr> <td>?Project The related project object</td> <td>1</td> </tr> <tr> <td>Contact|null A related contact object</td> <td>1</td> </tr> <tr> <td>int The related contact ID</td> <td>1</td> </tr> <tr> <td>Societe|null A related thirdparty object</td> <td>1</td> </tr> <tr> <td>User A related user</td> <td>1</td> </tr> <tr> <td>string The type of originating object. Combined with $origin_id, it allows to reload $origin_object</td> <td>1</td> </tr> <tr> <td>int The id of originating object. Combined with $origin_type, it allows to reload $origin_object</td> <td>1</td> </tr> <tr> <td>?CommonObject Origin object. This is set by fetch_origin() from this->origin_type and this->origin_id.</td> <td>1</td> </tr> <tr> <td>CommonObject|string|null Sometimes the type of the originating object ('commande', 'facture', ...), sometimes the object (as with MouvementStock)</td> <td>1</td> </tr> <tr> <td>string The object's reference</td> <td>1</td> </tr> <tr> <td>string An external reference to the object</td> <td>1</td> </tr> <tr> <td>string The object's previous reference</td> <td>1</td> </tr> <tr> <td>string The object's next reference</td> <td>1</td> </tr> <tr> <td>string Ref to store on object to save the new ref to use for example when making a validate() of an object</td> <td>1</td> </tr> <tr> <td>int|array<int, string> The object's status. Use status instead.</td> <td>1</td> </tr> <tr> <td>int|array<int, string> The object's status (an int).</td> <td>1</td> </tr> <tr> <td>string Country name</td> <td>1</td> </tr> <tr> <td>int Country ID</td> <td>1</td> </tr> <tr> <td>string ISO country code on 2 chars</td> <td>1</td> </tr> <tr> <td>string State name</td> <td>1</td> </tr> <tr> <td>string State code</td> <td>1</td> </tr> <tr> <td>int Region ID</td> <td>1</td> </tr> <tr> <td>string Region code</td> <td>1</td> </tr> <tr> <td>string Region name</td> <td>1</td> </tr> <tr> <td>int Barcode type</td> <td>1</td> </tr> <tr> <td>string Code of the barcode type</td> <td>1</td> </tr> <tr> <td>string Label of the barcode type</td> <td>1</td> </tr> <tr> <td>int Payment method ID (cheque, cash, ...)</td> <td>1</td> </tr> <tr> <td>int Payment terms ID</td> <td>1</td> </tr> <tr> <td>int Demand reason ID</td> <td>1</td> </tr> <tr> <td>int Transport mode ID (For module intracomm report)</td> <td>1</td> </tr> <tr> <td>int|string Payment terms ID</td> <td>1</td> </tr> <tr> <td>int|string Internal to detect deprecated access</td> <td>1</td> </tr> <tr> <td>int Delivery address ID</td> <td>1</td> </tr> <tr> <td>int Shipping method ID</td> <td>1</td> </tr> <tr> <td>string Shipping method label</td> <td>1</td> </tr> <tr> <td>string|string[] Multicurrency code</td> <td>1</td> </tr> <tr> <td>float|float[] Multicurrency rate ("tx" = "taux" in French)</td> <td>1</td> </tr> <tr> <td>float Multicurrency total amount excluding taxes (HT = "Hors Taxe" in French)</td> <td>1</td> </tr> <tr> <td>float Multicurrency total VAT amount (TVA = "Taxe sur la Valeur Ajoutée" in French)</td> <td>1</td> </tr> <tr> <td>float Multicurrency total amount including taxes (TTC = "Toutes Taxes Comprises" in French)</td> <td>1</td> </tr> <tr> <td>float Multicurrency total localta1</td> <td>1</td> </tr> <tr> <td>float Multicurrency total localtax2</td> <td>1</td> </tr> <tr> <td>int Bank account ID sometimes, ID of record into llx_bank sometimes</td> <td>1</td> </tr> <tr> <td>int Bank account ID</td> <td>1</td> </tr> <tr> <td>string Public note</td> <td>1</td> </tr> <tr> <td>string Private note</td> <td>1</td> </tr> <tr> <td>float Total amount excluding taxes (HT = "Hors Taxe" in French)</td> <td>1</td> </tr> <tr> <td>float Total VAT amount (TVA = "Taxe sur la Valeur Ajoutée" in French)</td> <td>1</td> </tr> <tr> <td>float Total local tax 1 amount</td> <td>1</td> </tr> <tr> <td>float Total local tax 2 amount</td> <td>1</td> </tr> <tr> <td>float Total amount including taxes (TTC = "Toutes Taxes Comprises" in French)</td> <td>1</td> </tr> <tr> <td>CommonObjectLine[]|CommonObject[]|stdClass[]</td> <td>1</td> </tr> <tr> <td>string Action type code to use to record auto event in agenda. For example 'AC_OTH_AUTO'</td> <td>1</td> </tr> <tr> <td>mixed Comments</td> <td>1</td> </tr> <tr> <td>string The name</td> <td>1</td> </tr> <tr> <td>string The lastname</td> <td>1</td> </tr> <tr> <td>string The firstname</td> <td>1</td> </tr> <tr> <td>string The civility code, not an integer</td> <td>1</td> </tr> <tr> <td>integer|string|null Object creation date</td> <td>1</td> </tr> <tr> <td>integer|string|null Object last validation date</td> <td>1</td> </tr> <tr> <td>integer|string|null Object last modification date</td> <td>1</td> </tr> <tr> <td>int|string|null</td> <td>1</td> </tr> <tr> <td>integer|string|null Object closing date</td> <td>1</td> </tr> <tr> <td>int User id author/creation</td> <td>1</td> </tr> <tr> <td>int|null User id of validation</td> <td>1</td> </tr> <tr> <td>int User id closing object</td> <td>1</td> </tr> <tr> <td>User User last modifier</td> <td>1</td> </tr> <tr> <td>int User ID who last modified the object</td> <td>1</td> </tr> <tr> <td>string XX</td> <td>1</td> </tr> <tr> <td>int<0,1> 1 if object is specimen</td> <td>1</td> </tr> <tr> <td>int[] Id of contacts to send objects (mails, etc.)</td> <td>1</td> </tr> <tr> <td>array<int,string> Array with labels of status</td> <td>1</td> </tr> <tr> <td>array<int,string> Array with short labels of status</td> <td>1</td> </tr> <tr> <td>array<string,int|string> Array to store lists of tpl</td> <td>1</td> </tr> <tr> <td>int show photo on popup</td> <td>1</td> </tr> <tr> <td>array{actionscomm?:int,banklines?:int,cheques?:int,contacts?:int,contracts?:int,customers?:int,dolresource?:int,donations?:int,expensereports?:int,holidays?:int,interventions?:int,invoices?:int,members?:int,orders?:int,products?:int,projects?:int,proposals?:int,prospects?:int,services?:int,supplier_invoices?:int,supplier_orders?:int,supplier_proposals?:int,suppliers?:int,tasks?:int,ticket?:int,users?:int} nb used in load_stateboard</td> <td>1</td> </tr> <tr> <td>int used for the return of show_photos()</td> <td>1</td> </tr> <tr> <td>string output content. Used topropagate information by cron jobs.</td> <td>1</td> </tr> <tr> <td>array|string extra parameters. Try to store here the array of parameters. Old code is sometimes storing a string.</td> <td>1</td> </tr> <tr> <td>string[]|array<string,string[]|array{parent:string,parentkey:string}> List of child tables. To test if we can delete object.</td> <td>1</td> </tr> <tr> <td>Product Populated by fetch_product()</td> <td>1</td> </tr> <tr> <td>int Populated by setPaymentTerms()</td> <td>1</td> </tr> <tr> <td>float Deposit percent for payment terms.</td> <td>1</td> </tr> <tr> <td>int Populated by setRetainedWarrantyPaymentTerms()</td> <td>1</td> </tr> <tr> <td>int Populated by setWarehouse()</td> <td>1</td> </tr> <tr> <td>int<0,1> Does object support extrafields ? 0=No, 1=Yes</td> <td>1</td> </tr> <tr> <td>string Last module name in error</td> <td>1</td> </tr> <tr> <td>string A hash value of the ticket. Duplicate of ref but for public purposes.</td> <td>1</td> </tr> <tr> <td>string Email $trackid. Used also for the $keytoavoidconflict to name session vars to upload files.</td> <td>1</td> </tr> <tr> <td>int $withsubstit Show substitution array</td> <td>1</td> </tr> <tr> <td>int withextrafields</td> <td>1</td> </tr> <tr> <td>array $substit Substitutions</td> <td>1</td> </tr> <tr> <td>int The code of the region</td> <td>1</td> </tr> <tr> <td>int The ID of the country of the region</td> <td>1</td> </tr> <tr> <td>string The name of the region</td> <td>1</td> </tr> <tr> <td>string The reference of the "chef-lieu" of the region</td> <td>1</td> </tr> <tr> <td>int ID of parent key (it's not the name of a field)</td> <td>1</td> </tr> <tr> <td>int Entity</td> <td>1</td> </tr> <tr> <td>string Import key</td> <td>1</td> </tr> <tr> <td>static Object oldcopy</td> <td>1</td> </tr> <tr> <td>string String with name of icon for emailsenderprofile</td> <td>1</td> </tr> <tr> <td>string Email Sender Profile label</td> <td>1</td> </tr> <tr> <td>array<array{url:string,titre:string,enabled:int<0,2>,target:string,mainmenu:string,leftmenu:string,position:int,level?:int,id:string,idsel:string,classname:string,prefix:string}></td> <td>1</td> </tr> <tr> <td>int type in line</td> <td>1</td> </tr> <tr> <td>int product id in line (when line is linked to a product or service)</td> <td>1</td> </tr> <tr> <td>Product Object product to store full product object after a fetch_product() on a line</td> <td>1</td> </tr> <tr> <td>string reference in product table</td> <td>1</td> </tr> <tr> <td>string label in product table</td> <td>1</td> </tr> <tr> <td>string barcode in product table</td> <td>1</td> </tr> <tr> <td>string description in product table</td> <td>1</td> </tr> <tr> <td>int type in product table</td> <td>1</td> </tr> <tr> <td>int multicurrency id</td> <td>1</td> </tr> <tr> <td>float Multicurrency subprice</td> <td>1</td> </tr> <tr> <td>float Multicurrency total without tax</td> <td>1</td> </tr> <tr> <td>float Multicurrency total vat</td> <td>1</td> </tr> <tr> <td>float Multicurrency total with tax</td> <td>1</td> </tr> <tr> <td>string threshold</td> <td>1</td> </tr> <tr> <td>string context</td> <td>1</td> </tr> <tr> <td>int ID of event action that trigger the notification</td> <td>1</td> </tr> <tr> <td>int Third-party ID</td> <td>1</td> </tr> <tr> <td>int (Third-party) Contact ID</td> <td>1</td> </tr> <tr> <td>string fk_user</td> <td>1</td> </tr> <tr> <td>int User ID Id utilisateur qui accorde la remise</td> <td>1</td> </tr> <tr> <td>int ID invoice line when a discount is used into an invoice line (for absolute discounts)</td> <td>1</td> </tr> <tr> <td>int ID invoice when a discount line is used into an invoice (for credit note)</td> <td>1</td> </tr> <tr> <td>int ID credit note or deposit used to create the discount</td> <td>1</td> </tr> <tr> <td>string Menu handler</td> <td>1</td> </tr> <tr> <td>string Module name if record is added by a module</td> <td>1</td> </tr> <tr> <td>string Menu top or left</td> <td>1</td> </tr> <tr> <td>string Name family/module for top menu (home, companies, ...)</td> <td>1</td> </tr> <tr> <td>int 0 or Id of mother menu line, or -1 if we use fk_mainmenu and fk_leftmenu</td> <td>1</td> </tr> <tr> <td>string fk_mainmenu</td> <td>1</td> </tr> <tr> <td>string fk_leftmenu</td> <td>1</td> </tr> <tr> <td>int Sort order of entry</td> <td>1</td> </tr> <tr> <td>string Relative (or absolute) url to go</td> <td>1</td> </tr> <tr> <td>string Target of Url link</td> <td>1</td> </tr> <tr> <td>string Prefix</td> <td>1</td> </tr> <tr> <td>string Lang file to load for translation</td> <td>1</td> </tr> <tr> <td>string Name family/module for left menu (setup, info, ...)</td> <td>1</td> </tr> <tr> <td>string Condition to show enabled or disabled</td> <td>1</td> </tr> <tr> <td>string Condition to show or hide</td> <td>1</td> </tr> <tr> <td>int 0 if menu for all users, 1 for external only, 2 for internal only</td> <td>1</td> </tr> <tr> <td>Menu menu</td> <td>1</td> </tr> <tr> <td>string Links label</td> <td>1</td> </tr> <tr> <td>string fiscal year label</td> <td>1</td> </tr> <tr> <td>array Servers (IP addresses or hostnames)</td> <td>1</td> </tr> <tr> <td>string Current connected server</td> <td>1</td> </tr> <tr> <td>int server port</td> <td>1</td> </tr> <tr> <td>string Base DN (e.g. "dc=foo,dc=com")</td> <td>1</td> </tr> <tr> <td>string Server type: OpenLDAP or Active Directory</td> <td>1</td> </tr> <tr> <td>string LDAP protocol version</td> <td>1</td> </tr> <tr> <td>string Server DN</td> <td>1</td> </tr> <tr> <td>string Server FQDN</td> <td>1</td> </tr> <tr> <td>bool LDAP bind</td> <td>1</td> </tr> <tr> <td>string LDAP administrator user</td> <td>1</td> </tr> <tr> <td>string LDAP administrator password</td> <td>1</td> </tr> <tr> <td>string Users DN</td> <td>1</td> </tr> <tr> <td>string Groups DN</td> <td>1</td> </tr> <tr> <td>int|null Error code provided by the LDAP server</td> <td>1</td> </tr> <tr> <td>string|null Error text message</td> <td>1</td> </tr> <tr> <td>string attr_login</td> <td>1</td> </tr> <tr> <td>string attr_sambalogin</td> <td>1</td> </tr> <tr> <td>string attr_name</td> <td>1</td> </tr> <tr> <td>string attr_firstname</td> <td>1</td> </tr> <tr> <td>string attr_mail</td> <td>1</td> </tr> <tr> <td>string attr_phone</td> <td>1</td> </tr> <tr> <td>string attr_fax</td> <td>1</td> </tr> <tr> <td>string attr_mobile</td> <td>1</td> </tr> <tr> <td>int badpwdtime</td> <td>1</td> </tr> <tr> <td>string LDAP user DN</td> <td>1</td> </tr> <tr> <td>string Fetched username</td> <td>1</td> </tr> <tr> <td>string Fetched user first name</td> <td>1</td> </tr> <tr> <td>string Fetched user login</td> <td>1</td> </tr> <tr> <td>string Fetched user phone number</td> <td>1</td> </tr> <tr> <td>string Fetched user fax number</td> <td>1</td> </tr> <tr> <td>string Fetched user email</td> <td>1</td> </tr> <tr> <td>string Fetched user mobile number</td> <td>1</td> </tr> <tr> <td>array UserAccountControl Flags</td> <td>1</td> </tr> <tr> <td>int Password last set time</td> <td>1</td> </tr> <tr> <td>string LDAP charset.</td> <td>1</td> </tr> <tr> <td>bool|resource The internal LDAP connection handle</td> <td>1</td> </tr> <tr> <td>bool|resource Result of any connections or search.</td> <td>1</td> </tr> <tr> <td>string Model name</td> <td>1</td> </tr> <tr> <td>string Version</td> <td>1</td> </tr> <tr> <td>string Error code (or message)</td> <td>1</td> </tr> <tr> <td>string[] Array of error strings</td> <td>1</td> </tr> <tr> <td>DoliDB Database handler.</td> <td>1</td> </tr> <tr> <td>int<0,1> Is Code optional 0 or 1</td> <td>1</td> </tr> <tr> <td>int<0,1> Is Code editable 0 or 1</td> <td>1</td> </tr> <tr> <td>int<0,1> Is Code editable if invalid 0 or 1</td> <td>1</td> </tr> <tr> <td>int<0,1> Is Code editable if null</td> <td>1</td> </tr> <tr> <td>int<0,1> Automatic numbering 0 or 1</td> <td>1</td> </tr> <tr> <td>int<0,1> The third party prefix field must be filled in when using {pre}</td> <td>1</td> </tr> <tr> <td>int 1 = Include HTML form tag and show submit button</td> <td>1</td> </tr> <tr> <td>string name from</td> <td>1</td> </tr> <tr> <td>string user, company, robot</td> <td>1</td> </tr> <tr> <td>int from ID</td> <td>1</td> </tr> <tr> <td>int also from robot</td> <td>1</td> </tr> <tr> <td>string thirdparty etc</td> <td>1</td> </tr> <tr> <td>string Reply-to name</td> <td>1</td> </tr> <tr> <td>string replyto email</td> <td>1</td> </tr> <tr> <td>string To name</td> <td>1</td> </tr> <tr> <td>string To email</td> <td>1</td> </tr> <tr> <td>string Track id</td> <td>1</td> </tr> <tr> <td>string If you know a MSGID of an email and want to send the email in reply to it. Will be added into header as In-Reply-To: <...></td> <td>1</td> </tr> <tr> <td>int|string|array</td> <td>1</td> </tr> <tr> <td>int|string 0 = Do not Show free text for recipient emails</td> <td>1</td> </tr> <tr> <td>int|string 0=No attaches files, 1=Show attached files, 2=Can add new attached files, 'text'=Show attached files and the text</td> <td>1</td> </tr> <tr> <td>int 1=Add a button "Fill with layout"</td> <td>1</td> </tr> <tr> <td>string 'text' or 'html' to add a button "Fill with AI generation"</td> <td>1</td> </tr> <tr> <td>int 1=Add a checkbox "Attach also main document" for mass actions (checked by default), -1=Add checkbox (not checked by default)</td> <td>1</td> </tr> <tr> <td>string ckeditortoolbar</td> <td>1</td> </tr> <tr> <td>array{}|array{models:string,langmodels?:string,fileinit?:string[],returnurl:string}</td> <td>1</td> </tr> <tr> <td>string Model mail label</td> <td>1</td> </tr> <tr> <td>int Owner of email template</td> <td>1</td> </tr> <tr> <td>int Is template private</td> <td>1</td> </tr> <tr> <td>string Model mail topic</td> <td>1</td> </tr> <tr> <td>string Model mail content</td> <td>1</td> </tr> <tr> <td>string Module the template is dedicated for</td> <td>1</td> </tr> <tr> <td>int Position of template in a combo list</td> <td>1</td> </tr> <tr> <td>string Model name</td> <td>1</td> </tr> <tr> <td>string Version</td> <td>1</td> </tr> <tr> <td>Extrafields object</td> <td>1</td> </tr> <tr> <td>int If set to 1, save the fullname of generated file with path as the main doc when generating a doc with this template.</td> <td>1</td> </tr> <tr> <td>string The name of constant to use to scan ODT files (Example: 'COMMANDE_ADDON_PDF_ODT_PATH')</td> <td>1</td> </tr> <tr> <td>string pdf, odt, etc</td> <td>1</td> </tr> <tr> <td>int Tab Title Height</td> <td>1</td> </tr> <tr> <td>array default title fields style</td> <td>1</td> </tr> <tr> <td>array default content fields style</td> <td>1</td> </tr> <tr> <td>Societe Issuer of document</td> <td>1</td> </tr> <tr> <td>array{fullpath:string} Array with result of doc generation. content is array('fullpath'=>$file)</td> <td>1</td> </tr> <tr> <td>FormSetupItem[] */</td> <td>1</td> </tr> <tr> <td>string $confKey the conf key used in database */</td> <td>1</td> </tr> <tr> <td>string|false $nameText */</td> <td>1</td> </tr> <tr> <td>string $helpText */</td> <td>1</td> </tr> <tr> <td>string $picto */</td> <td>1</td> </tr> <tr> <td>string $fieldValue */</td> <td>1</td> </tr> <tr> <td>string $defaultFieldValue */</td> <td>1</td> </tr> <tr> <td>array $fieldAttr fields attribute only for compatible fields like input text */</td> <td>1</td> </tr> <tr> <td>bool|string set this var to override field output will override $fieldInputOverride and $fieldOutputOverride too */</td> <td>1</td> </tr> <tr> <td>bool|string set this var to override field input */</td> <td>1</td> </tr> <tr> <td>bool|string set this var to override field output */</td> <td>1</td> </tr> <tr> <td>int $rank */</td> <td>1</td> </tr> <tr> <td>array set this var for options on select and multiselect items */</td> <td>1</td> </tr> <tr> <td>callable $saveCallBack */</td> <td>1</td> </tr> <tr> <td>callable $setValueFromPostCallBack */</td> <td>1</td> </tr> <tr> <td>string $type 'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'</td> <td>1</td> </tr> <tr> <td>string The css to use on the input field of item</td> <td>1</td> </tr> <tr> <td>string[] Context hookmanager was created for ('thirdpartycard', 'thirdpartydao', ...)</td> <td>1</td> </tr> <tr> <td>array<string,array{name:string,contexts:string[],file:string,line:string,count:int}> List of hooks called during this request (key = hash)</td> <td>1</td> </tr> <tr> <td>mixed[] Result</td> <td>1</td> </tr> <tr> <td>string Printable result</td> <td>1</td> </tr> <tr> <td>int Nb of qualified hook ran</td> <td>1</td> </tr> <tr> <td>string String with name of icon for timespent. Must be a 'fa-xxx' fontawesome code (or 'fa-xxx_fa_color_size') or 'timespent@timespent' if picto is file 'img/object_timespent.png'.</td> <td>1</td> </tr> <tr> <td>string To store the FROM part of the main table of the SQL request</td> <td>1</td> </tr> <tr> <td>string To store the WHERE part of the main table of the SQL request</td> <td>1</td> </tr> <tr> <td>string To store the field of the date</td> <td>1</td> </tr> <tr> <td>string To store the field for total HT</td> <td>1</td> </tr> <tr> <td>string error message</td> <td>1</td> </tr> <tr> <td>int year</td> <td>1</td> </tr> <tr> <td>int month</td> <td>1</td> </tr> <tr> <td>int ID incoterm.</td> <td>1</td> </tr> <tr> <td>string Label of incoterm. Used for tooltip.</td> <td>1</td> </tr> <tr> <td>string Location of incoterm.</td> <td>1</td> </tr> <tr> <td>array<string,array<string,string>></td> <td>1</td> </tr> <tr> <td>int Nb of accounts found</td> <td>1</td> </tr> <tr> <td>int Nb of accounts category found</td> <td>1</td> </tr> <tr> <td>int|string Width of graph. It can be a numeric for pixels or a string like '100%' or "100px'</td> <td>1</td> </tr> <tr> <td>int|string Height of graph. It can be a numeric for pixels or a string like '100%' or "100px'</td> <td>1</td> </tr> <tr> <td>boolean Mirrors graph values</td> <td>1</td> </tr> <tr> <td>GeoIp2\Database\Reader|string</td> <td>1</td> </tr> <tr> <td>array array of properties</td> <td>1</td> </tr> <tr> <td>string encoding</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database handler</td> <td>1</td> </tr> <tr> <td>string Subject of email</td> <td>1</td> </tr> <tr> <td>SMTPS (if this method is used)</td> <td>1</td> </tr> <tr> <td>Swift_Mailer (if the method is used)</td> <td>1</td> </tr> <tr> <td>Swift_SmtpTransport</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Loggers_ArrayLogger</td> <td>1</td> </tr> <tr> <td>string CSS</td> <td>1</td> </tr> <tr> <td>string Message-ID of the email to send (generated)</td> <td>1</td> </tr> <tr> <td>string Value to use in In-reply-to when email is set as an answer of another email (The Msg-Id of received email)</td> <td>1</td> </tr> <tr> <td>string References to add to the email to send (generated from the email we answer)</td> <td>1</td> </tr> <tr> <td>array fullfilenames list (full path of filename on file system)</td> <td>1</td> </tr> <tr> <td>array mimetypes of files list (List of MIME type of attached files)</td> <td>1</td> </tr> <tr> <td>array filenames list (List of attached file name in message)</td> <td>1</td> </tr> <tr> <td>array filenames cid</td> <td>1</td> </tr> <tr> <td>string IP</td> <td>1</td> </tr> <tr> <td>string User agent</td> <td>1</td> </tr> <tr> <td>string Prefix session obtained with method dol_getprefix()</td> <td>1</td> </tr> <tr> <td>string Authentication method used for USER_LOGIN with success</td> <td>1</td> </tr> <tr> <td>array Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.</td> <td>1</td> </tr> <tr> <td>string The code</td> <td>1</td> </tr> <tr> <td>string The label</td> <td>1</td> </tr> <tr> <td>int<0,1> 1 if the entry is active, 0 if not</td> <td>1</td> </tr> <tr> <td>Menu</td> <td>1</td> </tr> <tr> <td>SQLite3Result|boolean Resultset of last query</td> <td>1</td> </tr> <tr> <td>string Last query string</td> <td>1</td> </tr> <tr> <td>false|resource|mysqli|mysqliDoli|SQLite3|PgSql\Connection|DoliDB Database handler */</td> <td>1</td> </tr> <tr> <td>string Database type */</td> <td>1</td> </tr> <tr> <td>string Charset used to force charset when creating database */</td> <td>1</td> </tr> <tr> <td>string Collate used to force collate when creating database */</td> <td>1</td> </tr> <tr> <td>resource Resultset of last query */</td> <td>1</td> </tr> <tr> <td>bool true if connected, else false */</td> <td>1</td> </tr> <tr> <td>bool true if database selected, else false */</td> <td>1</td> </tr> <tr> <td>string Selected database name */</td> <td>1</td> </tr> <tr> <td>string Database username */</td> <td>1</td> </tr> <tr> <td>string Database host */</td> <td>1</td> </tr> <tr> <td>int Database port */</td> <td>1</td> </tr> <tr> <td>int >=1 if a transaction is opened, 0 otherwise */</td> <td>1</td> </tr> <tr> <td>string Last successful query */</td> <td>1</td> </tr> <tr> <td>string Last failed query */</td> <td>1</td> </tr> <tr> <td>string Last error message */</td> <td>1</td> </tr> <tr> <td>string Last error number. For example: 'DB_ERROR_RECORD_ALREADY_EXISTS', '12345', ... */</td> <td>1</td> </tr> <tr> <td>string If we need to set a prefix specific to the database so it can be reused (when defined instead of MAIN_DB_PREFIX) to forge requests */</td> <td>1</td> </tr> <tr> <td>bool Status */</td> <td>1</td> </tr> <tr> <td>boolean $unescapeslashquot Set this to 1 when calling SQL queries, to say that SQL is not standard but already escaped for Mysql. Used by PostgreSQL driver</td> <td>1</td> </tr> <tr> <td>boolean $standard_conforming_string Set this to true if postgres accept only standard encoding of string using '' and not \'</td> <td>1</td> </tr> <tr> <td>resource|boolean Resultset of last query */</td> <td>1</td> </tr> <tr> <td>mysqli Database object */</td> <td>1</td> </tr> <tr> <td>bool|mysqli_result Resultset of last query */</td> <td>1</td> </tr> <tr> <td>int Module unique ID</td> <td>1</td> </tr> <tr> <td>string Publisher name</td> <td>1</td> </tr> <tr> <td>string URL of module at publisher site</td> <td>1</td> </tr> <tr> <td>string URL of logo of the publisher. Must be image filename into the module/img directory followed with @modulename. Example: 'myimage.png@mymodule'.</td> <td>1</td> </tr> <tr> <td>string Family</td> <td>1</td> </tr> <tr> <td>array<string,array{position:string,label:string}> Custom family information</td> <td>1</td> </tr> <tr> <td>string Module position on 2 digits</td> <td>1</td> </tr> <tr> <td>string Module name</td> <td>1</td> </tr> <tr> <td>string[] Paths to create when module is activated</td> <td>1</td> </tr> <tr> <td>array Module boxes</td> <td>1</td> </tr> <tr> <td>array Module constants</td> <td>1</td> </tr> <tr> <td>array Module cron jobs entries</td> <td>1</td> </tr> <tr> <td>array Module access rights</td> <td>1</td> </tr> <tr> <td>int 1=Admin is always granted of permission of modules (even when module is disabled)</td> <td>1</td> </tr> <tr> <td>string Module access rights family</td> <td>1</td> </tr> <tr> <td>array|int Module menu entries (1 means the menu entries are not declared into module descriptor but are hardcoded into menu manager)</td> <td>1</td> </tr> <tr> <td>array{triggers?:int<0,1>,login?:int<0,1>,substitutions?:int<0,1>,menus?:int<0,1>,theme?:int<0,1>,tpl?:int<0,1>,barcode?:int<0,1>,models?:int<0,1>,printing?:int<0,1>,css?:string[],js?:string[],hooks?:array{data?:string[],entity?:string},moduleforexternal?:int<0,1>,websitetemplates?:int<0,1>,contactelement?:int<0,1>} Module parts</td> <td>1</td> </tr> <tr> <td>string[] Array of Errors messages</td> <td>1</td> </tr> <tr> <td>string Module version</td> <td>1</td> </tr> <tr> <td>string $lastVersion</td> <td>1</td> </tr> <tr> <td>bool $needUpdate</td> <td>1</td> </tr> <tr> <td>string Module description (short text)</td> <td>1</td> </tr> <tr> <td>string Module description (long text)</td> <td>1</td> </tr> <tr> <td>array dictionaries description</td> <td>1</td> </tr> <tr> <td>array tabs description</td> <td>1</td> </tr> <tr> <td>string Module export code</td> <td>1</td> </tr> <tr> <td>string[] Module export label</td> <td>1</td> </tr> <tr> <td>array export enabled</td> <td>1</td> </tr> <tr> <td>string Module import code</td> <td>1</td> </tr> <tr> <td>string[] Module import label</td> <td>1</td> </tr> <tr> <td>string Module constant name</td> <td>1</td> </tr> <tr> <td>bool Module can't be disabled</td> <td>1</td> </tr> <tr> <td>bool Module is disabled</td> <td>1</td> </tr> <tr> <td>int Module is enabled globally (Multicompany support)</td> <td>1</td> </tr> <tr> <td>string Name of image file used for this module</td> <td>1</td> </tr> <tr> <td>string[]|string List of config pages (Old modules uses a string. New one must use an array)</td> <td>1</td> </tr> <tr> <td>array List of module class names that must be enabled if this module is enabled. e.g.: array('modAnotherModule', 'FR'=>'modYetAnotherModule')</td> <td>1</td> </tr> <tr> <td>string[] List of module class names to disable if the module is disabled.</td> <td>1</td> </tr> <tr> <td>string[] List of module class names as string this module is in conflict with.</td> <td>1</td> </tr> <tr> <td>string[] Module language files</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of warnings to show when we activate the module</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of warnings to show when we activate an external module</td> <td>1</td> </tr> <tr> <td>array<string,string> Array of warnings to show when we disable the module</td> <td>1</td> </tr> <tr> <td>array Minimum version of PHP required by module.</td> <td>1</td> </tr> <tr> <td>array Minimum version of Dolibarr required by module.</td> <td>1</td> </tr> <tr> <td>bool|int Whether to hide the module.</td> <td>1</td> </tr> <tr> <td>string url to check for module update</td> <td>1</td> </tr> <tr> <td>array of errors</td> <td>1</td> </tr> <tr> <td>string Condition to be enabled</td> <td>1</td> </tr> <tr> <td>string Name of the module</td> <td>1</td> </tr> <tr> <td>string Description of the module</td> <td>1</td> </tr> <tr> <td>string Tooltip to show after description of the module</td> <td>1</td> </tr> <tr> <td>string To store the SQL string used to find the recipients</td> <td>1</td> </tr> <tr> <td>string Code for the handler</td> <td>1</td> </tr> <tr> <td>string[] Array of error messages</td> <td>1</td> </tr> <tr> <td>Conf dolibarr conf</td> <td>1</td> </tr> <tr> <td>Translate Translate Object</td> <td>1</td> </tr> <tr> <td>User user</td> <td>1</td> </tr> <tr> <td>int Save the name of generated file as the main doc when generating a doc with this template, 1 for yes, 0 if not</td> <td>1</td> </tr> <tr> <td>int Height reserved to output the info and total part</td> <td>1</td> </tr> <tr> <td>int Height reserved to output the free text on last page</td> <td>1</td> </tr> <tr> <td>int Height reserved to output the footer (value include bottom margin)</td> <td>1</td> </tr> <tr> <td>int x coordinate reserved to output the Signature area</td> <td>1</td> </tr> <tr> <td>float X position for the situation progress column</td> <td>1</td> </tr> <tr> <td>int heightforinfotot</td> <td>1</td> </tr> <tr> <td>int heightforfreetext</td> <td>1</td> </tr> <tr> <td>int heightforfooter</td> <td>1</td> </tr> <tr> <td>int tab_top_newpage</td> <td>1</td> </tr> <tr> <td>int tab_height</td> <td>1</td> </tr> <tr> <td>int line_height</td> <td>1</td> </tr> <tr> <td>int line per page</td> <td>1</td> </tr> <tr> <td>Account bank account</td> <td>1</td> </tr> <tr> <td>array lines</td> <td>1</td> </tr> <tr> <td>int Save the name of generated file as the main doc when generating a doc with this template</td> <td>1</td> </tr> <tr> <td>int Save the name of generated file as the main doc when generating a doc with this template</td> <td>1</td> </tr> <tr> <td>string Constant name</td> <td>1</td> </tr> <tr> <td>array<int,array<string,int|string>> array of setup values</td> <td>1</td> </tr> <tr> <td>string host</td> <td>1</td> </tr> <tr> <td>string port</td> <td>1</td> </tr> <tr> <td>string username</td> <td>1</td> </tr> <tr> <td>string login for printer host</td> <td>1</td> </tr> <tr> <td>string password for printer host</td> <td>1</td> </tr> <tr> <td>int Does CUPS connection use SSL ?</td> <td>1</td> </tr> <tr> <td>array module parameters</td> <td>1</td> </tr> <tr> <td>string google id</td> <td>1</td> </tr> <tr> <td>string google secret</td> <td>1</td> </tr> <tr> <td>string Name</td> <td>1</td> </tr> <tr> <td>string Html string returned for print</td> <td>1</td> </tr> <tr> <td>string search string</td> <td>1</td> </tr> <tr> <td>int Nombre de chiffres du compteur</td> <td>1</td> </tr> <tr> <td>string String de recherche</td> <td>1</td> </tr> <tr> <td>int Nombre de chiffres du compteur</td> <td>1</td> </tr> <tr> <td>int posx weight vol</td> <td>1</td> </tr> <tr> <td>int posx qty ordered</td> <td>1</td> </tr> <tr> <td>int posx qty to ship</td> <td>1</td> </tr> <tr> <td>int posx totalht</td> <td>1</td> </tr> <tr> <td>DoliDB $db</td> <td>1</td> </tr> <tr> <td>string 'P' or 'Portait' (default), 'L' or 'Landscape'</td> <td>1</td> </tr> <tr> <td>int posx lot</td> <td>1</td> </tr> <tr> <td>int posx weightvol</td> <td>1</td> </tr> <tr> <td>int posx warehousesource</td> <td>1</td> </tr> <tr> <td>int posx warehousedestination</td> <td>1</td> </tr> <tr> <td>bool True if at least one line of the StockTransfer object has a batch set.</td> <td>1</td> </tr> <tr> <td>string Export Excel label</td> <td>1</td> </tr> <tr> <td>Spreadsheet */</td> <td>1</td> </tr> <tr> <td>int col</td> <td>1</td> </tr> <tr> <td>int disabled</td> <td>1</td> </tr> <tr> <td>string ID ex: csv, tsv, excel...</td> <td>1</td> </tr> <tr> <td>string export files label</td> <td>1</td> </tr> <tr> <td>string Dolibarr version of the loaded document</td> <td>1</td> </tr> <tr> <td>string[] warnings codes (or messages)</td> <td>1</td> </tr> <tr> <td>string charset</td> <td>1</td> </tr> <tr> <td>Societe thirdparty</td> <td>1</td> </tr> <tr> <td>array Element mapping from table name</td> <td>1</td> </tr> <tr> <td>string boc label</td> <td>1</td> </tr> <tr> <td>string box label</td> <td>1</td> </tr> <tr> <td>string param</td> <td>1</td> </tr> <tr> <td>array box info heads</td> <td>1</td> </tr> <tr> <td>array box info content</td> <td>1</td> </tr> <tr> <td>int Maximum lines</td> <td>1</td> </tr> <tr> <td>bool|int Condition to have widget enabled</td> <td>1</td> </tr> <tr> <td>boolean Condition to have widget visible (in most cases, permissions)</td> <td>1</td> </tr> <tr> <td>int Box definition database ID</td> <td>1</td> </tr> <tr> <td>int Position?</td> <td>1</td> </tr> <tr> <td>string Display order</td> <td>1</td> </tr> <tr> <td>string Source file</td> <td>1</td> </tr> <tr> <td>string Class name</td> <td>1</td> </tr> <tr> <td>string Alphanumeric ID</td> <td>1</td> </tr> <tr> <td>string Note</td> <td>1</td> </tr> <tr> <td>string String with name of icon for asset. Must be the part after the 'object_' into object_asset.png</td> <td>1</td> </tr> <tr> <td>AssetDepreciationOptions Used for computed fields of depreciation options class.</td> <td>1</td> </tr> <tr> <td>array List of depreciation lines for each mode (sort by depreciation date).</td> <td>1</td> </tr> <tr> <td>array Array with all deprecation options info by mode.</td> <td>1</td> </tr> <tr> <td>array Array with all deprecation options by mode.</td> <td>1</td> </tr> <tr> <td>array Array with all accountancy codes info by mode.</td> <td>1</td> </tr> <tr> <td>array Array with all accountancy codes by mode.</td> <td>1</td> </tr> <tr> <td>string String with name of icon for assetmodel. Must be the part after the 'object_' into object_assetmodel.png</td> <td>1</td> </tr> <tr> <td>FactureFournisseur $invoice {@type FactureFournisseur}</td> <td>1</td> </tr> <tr> <td>int Purchase Order ID</td> <td>1</td> </tr> <tr> <td>string Supplier order reference</td> <td>1</td> </tr> <tr> <td>string Supplier reference</td> <td>1</td> </tr> <tr> <td>int Company ID</td> <td>1</td> </tr> <tr> <td>int Supplier ID</td> <td>1</td> </tr> <tr> <td>int Date</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order creation</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order validation</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order approval</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order second approval</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order ordering</td> <td>1</td> </tr> <tr> <td>int Expected Delivery Date</td> <td>1</td> </tr> <tr> <td>float Total value, excluding taxes (HT = "Hors Taxe" in French)</td> <td>1</td> </tr> <tr> <td>float Total VAT</td> <td>1</td> </tr> <tr> <td>float Total Local tax 1</td> <td>1</td> </tr> <tr> <td>float Total Local tax 2</td> <td>1</td> </tr> <tr> <td>float Total value, including taxes (TTC = "Toutes Taxes Comprises" in French)</td> <td>1</td> </tr> <tr> <td>int Payment conditions ID</td> <td>1</td> </tr> <tr> <td>string Payment conditions code</td> <td>1</td> </tr> <tr> <td>string Payment conditions label</td> <td>1</td> </tr> <tr> <td>string Payment conditions label on documents</td> <td>1</td> </tr> <tr> <td>int Account ID</td> <td>1</td> </tr> <tr> <td>int Payment choice ID</td> <td>1</td> </tr> <tr> <td>string Payment choice code</td> <td>1</td> </tr> <tr> <td>string Payment choice label</td> <td>1</td> </tr> <tr> <td>int User ID of the purchase order author</td> <td>1</td> </tr> <tr> <td>int User ID of the purchase order approver</td> <td>1</td> </tr> <tr> <td>int User ID of the purchase order second approver</td> <td>1</td> </tr> <tr> <td>CommandeFournisseurLigne[]</td> <td>1</td> </tr> <tr> <td>CommandeFournisseurLigne</td> <td>1</td> </tr> <tr> <td>int Date of the purchase order payment deadline</td> <td>1</td> </tr> <tr> <td>float Rate</td> <td>1</td> </tr> <tr> <td>float Total value in the other currency, excluding taxes (HT = "Hors Taxes" in French)</td> <td>1</td> </tr> <tr> <td>float Total VAT in the other currency (TVA = "Taxe sur la Valeur Ajoutée" in French)</td> <td>1</td> </tr> <tr> <td>float Total value in the other currency, including taxes (TTC = "Toutes Taxes Comprises in French)</td> <td>1</td> </tr> <tr> <td>string Ref supplier</td> <td>1</td> </tr> <tr> <td>string Label of invoice</td> <td>1</td> </tr> <tr> <td>string Label of invoice</td> <td>1</td> </tr> <tr> <td>float tva</td> <td>1</td> </tr> <tr> <td>int Transport mode id</td> <td>1</td> </tr> <tr> <td>int<0,1> VAT reverse charge can be used on the invoice</td> <td>1</td> </tr> <tr> <td>int Situation progress percentage</td> <td>1</td> </tr> <tr> <td>int rank of line</td> <td>1</td> </tr> <tr> <td>int nb generation done</td> <td>1</td> </tr> <tr> <td>int nb generation max</td> <td>1</td> </tr> <tr> <td>int<0,1> auto validate 0 to create in draft, 1 to create and validate the new invoice</td> <td>1</td> </tr> <tr> <td>DoliDB Database handler.</td> <td>1</td> </tr> <tr> <td>string Error code (or message)</td> <td>1</td> </tr> <tr> <td>int ID of ligne product-supplier</td> <td>1</td> </tr> <tr> <td>int The product lead time in days.</td> <td>1</td> </tr> <tr> <td>string The product reference of the supplier. Can be set by get_buyprice().</td> <td>1</td> </tr> <tr> <td>string The product description of the supplier.</td> <td>1</td> </tr> <tr> <td>float The VAT rate by default for this {supplier, qty, product}. Can be set by get_buyprice().</td> <td>1</td> </tr> <tr> <td>int The product ID.</td> <td>1</td> </tr> <tr> <td>string The product reference.</td> <td>1</td> </tr> <tr> <td>int The supplier ID.</td> <td>1</td> </tr> <tr> <td>string The supplier name.</td> <td>1</td> </tr> <tr> <td>float The Minimum Order Quantity (MOQ) for a given unit price. Can be set by get_buyprice().</td> <td>1</td> </tr> <tr> <td>float The unit price for a given Minimum Order Quantity (MOQ). Can be set by get_buyprice().</td> <td>1</td> </tr> <tr> <td>float The total price for a given Minimum Order Quantity (MOQ).</td> <td>1</td> </tr> <tr> <td>float The discount in percentage for a given Minimum Order Quantity (MOQ).</td> <td>1</td> </tr> <tr> <td>float The discount in value for a given Minimum Order Quantity (MOQ).</td> <td>1</td> </tr> <tr> <td>int product-supplier id</td> <td>1</td> </tr> <tr> <td>int ID user_id - user who created/updated supplier price</td> <td>1</td> </tr> <tr> <td>int ID availability delay - visible/used if option FOURN_PRODUCT_AVAILABILITY is on (duplicate information compared to delivery delay)</td> <td>1</td> </tr> <tr> <td>string reputation of supplier</td> <td>1</td> </tr> <tr> <td>string[] list of available supplier reputations</td> <td>1</td> </tr> <tr> <td>string $supplier_barcode - Supplier barcode</td> <td>1</td> </tr> <tr> <td>string $supplier_fk_barcode_type - Supplier barcode type</td> <td>1</td> </tr> <tr> <td>CommandeFournisseur $order {@type CommandeFournisseur}</td> <td>1</td> </tr> <tr> <td>string FROM</td> <td>1</td> </tr> <tr> <td>string field</td> <td>1</td> </tr> <tr> <td>string WHERE</td> <td>1</td> </tr> <tr> <td>string JOIN</td> <td>1</td> </tr> <tr> <td>Don $don {@type Don}</td> <td>1</td> </tr> <tr> <td>string String with name of icon for object don. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>int|string Date of the donation</td> <td>1</td> </tr> <tr> <td>integer Thirdparty ID</td> <td>1</td> </tr> <tr> <td>string Email</td> <td>1</td> </tr> <tr> <td>int 0 or 1</td> <td>1</td> </tr> <tr> <td>int project ID</td> <td>1</td> </tr> <tr> <td>int type payment ID</td> <td>1</td> </tr> <tr> <td>int payment mode id</td> <td>1</td> </tr> <tr> <td>Commande $commande {@type Commande}</td> <td>1</td> </tr> <tr> <td>string Name of class line</td> <td>1</td> </tr> <tr> <td>string Field name with ID of parent key if this field has a parent</td> <td>1</td> </tr> <tr> <td>string String with name of icon for commande class. Here is object_order.png</td> <td>1</td> </tr> <tr> <td>int Contact ID</td> <td>1</td> </tr> <tr> <td>int Status Billed or not</td> <td>1</td> </tr> <tr> <td>string Condition payment code</td> <td>1</td> </tr> <tr> <td>string Condition payment label</td> <td>1</td> </tr> <tr> <td>float Deposit percent for payment terms.</td> <td>1</td> </tr> <tr> <td>int bank account ID</td> <td>1</td> </tr> <tr> <td>string It holds the label of the payment mode. Use it in case translation cannot be found.</td> <td>1</td> </tr> <tr> <td>int Payment mode id</td> <td>1</td> </tr> <tr> <td>string Payment mode code</td> <td>1</td> </tr> <tr> <td>int Source demand reason Id</td> <td>1</td> </tr> <tr> <td>string Source reason code. Why we receive order (after a phone campaign, ...)</td> <td>1</td> </tr> <tr> <td>int Date expected of shipment (date of start of shipment, not the reception that occurs some days after)</td> <td>1</td> </tr> <tr> <td>int Warehouse Id</td> <td>1</td> </tr> <tr> <td>int User author ID</td> <td>1</td> </tr> <tr> <td>OrderLine one line of an order</td> <td>1</td> </tr> <tr> <td>OrderLine[]</td> <td>1</td> </tr> <tr> <td>array Array with line of all shipments</td> <td>1</td> </tr> <tr> <td>int Id of invoice</td> <td>1</td> </tr> <tr> <td>string External ref</td> <td>1</td> </tr> <tr> <td>string String with name of icon for hook. Must be the part after the 'object_' into object_hook.png</td> <td>1</td> </tr> <tr> <td>string url of webhook</td> <td>1</td> </tr> <tr> <td>int ID of user owner webhook</td> <td>1</td> </tr> <tr> <td>Hook $hook {@type Hook}</td> <td>1</td> </tr> <tr> <td>integer|string $date_ech</td> <td>1</td> </tr> <tr> <td>integer|string $date_validation</td> <td>1</td> </tr> <tr> <td>int account ID</td> <td>1</td> </tr> <tr> <td>int account ID (identical to fk_account)</td> <td>1</td> </tr> <tr> <td>int payment type (identical to mode_reglement_id in commonobject class)</td> <td>1</td> </tr> <tr> <td>double total</td> <td>1</td> </tr> <tr> <td>string module</td> <td>1</td> </tr> <tr> <td>array array of errors</td> <td>1</td> </tr> <tr> <td>int Creation date</td> <td>1</td> </tr> <tr> <td>int accountid</td> <td>1</td> </tr> <tr> <td>string lib</td> <td>1</td> </tr> <tr> <td>string bank categories label</td> <td>1</td> </tr> <tr> <td>array context</td> <td>1</td> </tr> <tr> <td>int Use id instead of rowid</td> <td>1</td> </tr> <tr> <td>string Label of journal</td> <td>1</td> </tr> <tr> <td>float Amount of payment in the bank account currency</td> <td>1</td> </tr> <tr> <td>float Amount in the currency of company if bank account use another currency</td> <td>1</td> </tr> <tr> <td>int ID</td> <td>1</td> </tr> <tr> <td>string Type of operation (ex: "SOLD", "VIR", "CHQ", "CB", "PPL")</td> <td>1</td> </tr> <tr> <td>int ID of cheque receipt</td> <td>1</td> </tr> <tr> <td>int ID of bank account</td> <td>1</td> </tr> <tr> <td>string Ref of bank account</td> <td>1</td> </tr> <tr> <td>string Label of bank account</td> <td>1</td> </tr> <tr> <td>string Bank account numero</td> <td>1</td> </tr> <tr> <td>string Name of check issuer</td> <td>1</td> </tr> <tr> <td>int<0,1> 1 if the line has been reconciled, 0 otherwise</td> <td>1</td> </tr> <tr> <td>string Name of the bank statement (if the line has been reconciled)</td> <td>1</td> </tr> <tr> <td>string Cheque number</td> <td>1</td> </tr> <tr> <td>string Bank name of the cheque</td> <td>1</td> </tr> <tr> <td>string Label of the bank transaction line</td> <td>1</td> </tr> <tr> <td>string Note</td> <td>1</td> </tr> <tr> <td>int<0,1> Payment direction (debit or credit)</td> <td>1</td> </tr> <tr> <td>int Payment type (fk_typepayment)</td> <td>1</td> </tr> <tr> <td>string Name of cheque writer</td> <td>1</td> </tr> <tr> <td>string Bank of cheque writer</td> <td>1</td> </tr> <tr> <td>int Category id</td> <td>1</td> </tr> <tr> <td>string various payments label</td> <td>1</td> </tr> <tr> <td>string accountancy code</td> <td>1</td> </tr> <tr> <td>int ID record into llx_bank</td> <td>1</td> </tr> <tr> <td>int transaction category</td> <td>1</td> </tr> <tr> <td>int Type of bank account if the payment is on a bank account</td> <td>1</td> </tr> <tr> <td>int 1 if the payment is on a bank account line that is conciliated</td> <td>1</td> </tr> <tr> <td>string ID of bank receipt</td> <td>1</td> </tr> <tr> <td>int Entity ID</td> <td>1</td> </tr> <tr> <td>Facture $invoice {@type Facture}</td> <td>1</td> </tr> <tr> <td>FactureRec $templte_invoice {@type FactureRec}</td> <td>1</td> </tr> <tr> <td>int|null ID</td> <td>1</td> </tr> <tr> <td>int Date expected for delivery</td> <td>1</td> </tr> <tr> <td>int ID Field to store bank id to use when payment mode is withdraw</td> <td>1</td> </tr> <tr> <td>int ID facture rec</td> <td>1</td> </tr> <tr> <td>int Situation counter inside the cycle</td> <td>1</td> </tr> <tr> <td>int Final situation flag</td> <td>1</td> </tr> <tr> <td>array Table of previous situations</td> <td>1</td> </tr> <tr> <td>array Table of next situations</td> <td>1</td> </tr> <tr> <td>double percentage of retainage</td> <td>1</td> </tr> <tr> <td>int timestamp of date limit of retainage</td> <td>1</td> </tr> <tr> <td>int Code in llx_c_paiement</td> <td>1</td> </tr> <tr> <td>float Percent of discount ("remise" in French)</td> <td>1</td> </tr> <tr> <td>string To store the batch to consume in stock when using a POS module</td> <td>1</td> </tr> <tr> <td>string To store the warehouse where to consume stock when using a POS module</td> <td>1</td> </tr> <tr> <td>integer Id in table llx_accounting_bookeeping to know accounting account for product line</td> <td>1</td> </tr> <tr> <td>int Situation advance percentage</td> <td>1</td> </tr> <tr> <td>string local tax</td> <td>1</td> </tr> <tr> <td>string String with name of icon for pos_cash_fence. Must be the part after the 'object_' into object_pos_cash_fence.png</td> <td>1</td> </tr> <tr> <td>int Object Id</td> <td>1</td> </tr> <tr> <td>integer|string $date_valid</td> <td>1</td> </tr> <tr> <td>array Reason of error</td> <td>1</td> </tr> <tr> <td>array Label status of invoicing</td> <td>1</td> </tr> <tr> <td>array Labels of reason</td> <td>1</td> </tr> <tr> <td>array Labels of invoicing status</td> <td>1</td> </tr> <tr> <td>int Socid</td> <td>1</td> </tr> <tr> <td>int Status of the line</td> <td>1</td> </tr> <tr> <td>string Ref of bon</td> <td>1</td> </tr> <tr> <td>int ID of bon</td> <td>1</td> </tr> <tr> <td>array<int,string></td> <td>1</td> </tr> <tr> <td>resource Handler of the file for direct debit or credit transfer order</td> <td>1</td> </tr> <tr> <td>int Current transport method, index to $methodes_trans</td> <td>1</td> </tr> <tr> <td>float km value formatted</td> <td>1</td> </tr> <tr> <td>int Thirdparty id</td> <td>1</td> </tr> <tr> <td>int Status 0=draft, 1=validated, 2=Refunded</td> <td>1</td> </tr> <tr> <td>int Invoice ID</td> <td>1</td> </tr> <tr> <td>int Company ID</td> <td>1</td> </tr> <tr> <td>int|string same than $datepaye</td> <td>1</td> </tr> <tr> <td>float Total amount of payment (in the main currency)</td> <td>1</td> </tr> <tr> <td>float Total amount of payment (in the currency of the bank account)</td> <td>1</td> </tr> <tr> <td>float[] array: invoice ID => amount for that invoice (in the main currency)</td> <td>1</td> </tr> <tr> <td>float[] array: invoice ID => amount for that invoice (in the invoice's currency)</td> <td>1</td> </tr> <tr> <td>float[] Multicurrency rate (array: invoice ID => currency rate ("taux" in French) for that invoice)</td> <td>1</td> </tr> <tr> <td>string[] Multicurrency code (array: invoice ID => currency code for that invoice)</td> <td>1</td> </tr> <tr> <td>float Excess received in TakePOS cash payment</td> <td>1</td> </tr> <tr> <td>int ID of mode of payment. Is saved into fields fk_paiement on llx_paiement = id of llx_c_paiement</td> <td>1</td> </tr> <tr> <td>string Code of mode of payment.</td> <td>1</td> </tr> <tr> <td>string Type of payment label</td> <td>1</td> </tr> <tr> <td>string Type of payment code (seems duplicate with $paiementcode);</td> <td>1</td> </tr> <tr> <td>int id of payment line in bank account</td> <td>1</td> </tr> <tr> <td>int payment id</td> <td>1</td> </tr> <tr> <td>string payment external reference</td> <td>1</td> </tr> <tr> <td>string ID to identify managed object</td> <td>1</td> </tr> <tr> <td>string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>int chid</td> <td>1</td> </tr> <tr> <td>int ID of the salary linked to the payment</td> <td>1</td> </tr> <tr> <td>int|string Payment creation date</td> <td>1</td> </tr> <tr> <td>float Total amount of payment</td> <td>1</td> </tr> <tr> <td>array Array of amounts</td> <td>1</td> </tr> <tr> <td>int Payment type ID</td> <td>1</td> </tr> <tr> <td>int ID of bank_line</td> <td>1</td> </tr> <tr> <td>int ID of the user who created the payment</td> <td>1</td> </tr> <tr> <td>int ID of the user who modified the payment</td> <td>1</td> </tr> <tr> <td>int Payment type</td> <td>1</td> </tr> <tr> <td>int Payment label</td> <td>1</td> </tr> <tr> <td>int Bank account description</td> <td>1</td> </tr> <tr> <td>int|string Payment validation date</td> <td>1</td> </tr> <tr> <td>array $FIELDS Mandatory fields, checked when creating an object</td> <td>1</td> </tr> <tr> <td>string salary payments label</td> <td>1</td> </tr> <tr> <td>user User</td> <td>1</td> </tr> <tr> <td>int 1 if salary paid COMPLETELY, 0 otherwise (do not use it anymore, use statut and close_code)</td> <td>1</td> </tr> <tr> <td>string String with name of icon for calendar. Must be a 'fa-xxx' fontawesome code (or 'fa-xxx_fa_color_size') or 'calendar@bookcal' if picto is file 'img/object_calendar.png'.</td> <td>1</td> </tr> <tr> <td>string String with name of icon for availabilities. Must be a 'fa-xxx' fontawesome code (or 'fa-xxx_fa_color_size') or 'availabilities@bookcal' if picto is file 'img/object_availabilities.png'.</td> <td>1</td> </tr> <tr> <td>int tabTitleHeight</td> <td>1</td> </tr> <tr> <td>array defaultContentsFieldsStyle</td> <td>1</td> </tr> <tr> <td>array defaultTitlesFieldsStyle</td> <td>1</td> </tr> <tr> <td>array<string,array{rank:int,width:float|int,title:array{textkey:string,label:string,align:string,padding:array{0:float,1:float,2:float,3:float}},content:array{align:string,padding:array{0:float,1:float,2:float,3:float}}}> Array of document tablecolumns</td> <td>1</td> </tr> <tr> <td>string String with name of icon for recruitmentcandidature. Must be the part after the 'object_' into object_recruitmentcandidature.png</td> <td>1</td> </tr> <tr> <td>int Do not exploit fields email_xxx into triggers.</td> <td>1</td> </tr> <tr> <td>RecruitmentJobPosition $jobposition {@type RecruitmentJobPosition}</td> <td>1</td> </tr> <tr> <td>RecruitmentCandidature $candidature {@type RecruitmentCandidature}</td> <td>1</td> </tr> <tr> <td>string String with name of icon for recruitmentjobposition. Must be the part after the 'object_' into object_recruitmentjobposition.png</td> <td>1</td> </tr> <tr> <td>string recruiter email</td> <td>1</td> </tr> <tr> <td>string suggested remuneration</td> <td>1</td> </tr> <tr> <td>string String with name of icon for website. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>string Main language of web site</td> <td>1</td> </tr> <tr> <td>string List of languages of web site ('fr', 'es_MX', ...)</td> <td>1</td> </tr> <tr> <td>integer date_creation</td> <td>1</td> </tr> <tr> <td>integer date_modification</td> <td>1</td> </tr> <tr> <td>integer Default home page</td> <td>1</td> </tr> <tr> <td>int User Create Id</td> <td>1</td> </tr> <tr> <td>int User Modification Id</td> <td>1</td> </tr> <tr> <td>string Virtual host</td> <td>1</td> </tr> <tr> <td>int Use a manifest file</td> <td>1</td> </tr> <tr> <td>int Position</td> <td>1</td> </tr> <tr> <td>string name of template</td> <td>1</td> </tr> <tr> <td>string String with name of icon for websitepage. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>string Field with ID of parent key if this field has a parent or for child tables</td> <td>1</td> </tr> <tr> <td>string image</td> <td>1</td> </tr> <tr> <td>string language code ('en', 'fr', 'en-gb', ..)</td> <td>1</td> </tr> <tr> <td>string author_alias</td> <td>1</td> </tr> <tr> <td>string path of external object</td> <td>1</td> </tr> <tr> <td>string id of external object</td> <td>1</td> </tr> <tr> <td>int Another ID that is the $id but with an offset so that ID of pages of the website start at 1</td> <td>1</td> </tr> <tr> <td>Mo $mo {@type Mo}</td> <td>1</td> </tr> <tr> <td>string String with name of icon for mo. Must be the part after the 'object_' into object_mo.png</td> <td>1</td> </tr> <tr> <td>int mrptype</td> <td>1</td> </tr> <tr> <td>string public note</td> <td>1</td> </tr> <tr> <td>string private note</td> <td>1</td> </tr> <tr> <td>int ID of product</td> <td>1</td> </tr> <tr> <td>Product product object</td> <td>1</td> </tr> <tr> <td>integer|string date_start_planned</td> <td>1</td> </tr> <tr> <td>integer|string date_end_planned</td> <td>1</td> </tr> <tr> <td>int ID bom</td> <td>1</td> </tr> <tr> <td>Bom bom</td> <td>1</td> </tr> <tr> <td>int ID project</td> <td>1</td> </tr> <tr> <td>double New quantity. When we update the quantity to produce, we set this to save old value before calling the ->update that call the updateProduction that need this</td> <td>1</td> </tr> <tr> <td>MoLine[] Array of subtable lines</td> <td>1</td> </tr> <tr> <td>MoLine|null MO line</td> <td>1</td> </tr> <tr> <td>int ID of parent line</td> <td>1</td> </tr> <tr> <td>array<string,int|string> tpl</td> <td>1</td> </tr> <tr> <td>string table element line name</td> <td>1</td> </tr> <tr> <td>ExpenseReportLine[] array of expensereport lines</td> <td>1</td> </tr> <tr> <td>ExpenseReportLine expensereport lines</td> <td>1</td> </tr> <tr> <td>int ID of user creator</td> <td>1</td> </tr> <tr> <td>int ID of user who reclaim expense report</td> <td>1</td> </tr> <tr> <td>int ID of user who cancel expense report</td> <td>1</td> </tr> <tr> <td>int User that is defined to approve</td> <td>1</td> </tr> <tr> <td>int ID of User making validation</td> <td>1</td> </tr> <tr> <td>int ID User that has approved</td> <td>1</td> </tr> <tr> <td>int ID into llx_ecm_files table to link line to attached file</td> <td>1</td> </tr> <tr> <td>ExpenseReport $expensereport {@type ExpenseReport}</td> <td>1</td> </tr> <tr> <td>\LibXMLError[]</td> <td>1</td> </tr> <tr> <td>MessageInterface</td> <td>1</td> </tr> <tr> <td>resource|string|callable</td> <td>1</td> </tr> <tr> <td>RequestInterface</td> <td>1</td> </tr> <tr> <td>Tree</td> <td>1</td> </tr> <tr> <td>HTTP\Response</td> <td>1</td> </tr> <tr> <td>HTTP\Request</td> <td>1</td> </tr> <tr> <td>HTTP\Sapi</td> <td>1</td> </tr> <tr> <td>Xml\Service</td> <td>1</td> </tr> <tr> <td>INode[]</td> <td>1</td> </tr> <tr> <td>ICollection</td> <td>1</td> </tr> <tr> <td>pdo</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\Xml\Element\Response[]</td> <td>1</td> </tr> <tr> <td>LockInfo[]</td> <td>1</td> </tr> <tr> <td>DateTime</td> <td>1</td> </tr> <tr> <td>\Sabre\DAV\Locks\LockInfo</td> <td>1</td> </tr> <tr> <td>Backend\AbstractBackend</td> <td>1</td> </tr> <tr> <td>CalDAV\Xml\Property\SupportedCalendarComponentSet</td> <td>1</td> </tr> <tr> <td>SubscriptionSupport</td> <td>1</td> </tr> <tr> <td>NotificationInterface</td> <td>1</td> </tr> <tr> <td>Node</td> <td>1</td> </tr> <tr> <td>ElementList</td> <td>1</td> </tr> <tr> <td>array<string, Component|Property></td> <td>1</td> </tr> <tr> <td>self */</td> <td>1</td> </tr> <tr> <td>TimezoneGuesser[] */</td> <td>1</td> </tr> <tr> <td>TimezoneFinder[] */</td> <td>1</td> </tr> <tr> <td>\Sabre\VObject\Component\VCalendar</td> <td>1</td> </tr> <tr> <td>MimeDir</td> <td>1</td> </tr> <tr> <td>\Sabre\VObject\Document</td> <td>1</td> </tr> <tr> <td>self[]</td> <td>1</td> </tr> <tr> <td>mixed[]|null</td> <td>1</td> </tr> <tr> <td>LoggerInterface|null</td> <td>1</td> </tr> <tr> <td>string A String defining the Prefix used as Template-Object-Names. Have to beginn with an /</td> <td>1</td> </tr> <tr> <td>ClientInterface</td> <td>1</td> </tr> <tr> <td>object|\Redis</td> <td>1</td> </tr> <tr> <td>string[] Several error codes (or messages)</td> <td>1</td> </tr> <tr> <td>string The user agent string passed to services</td> <td>1</td> </tr> <tr> <td>int The maximum number of redirects</td> <td>1</td> </tr> <tr> <td>int The maximum timeout</td> <td>1</td> </tr> <tr> <td>Credentials */</td> <td>1</td> </tr> <tr> <td>ClientInterface */</td> <td>1</td> </tr> <tr> <td>TokenStorageInterface */</td> <td>1</td> </tr> <tr> <td>Credentials</td> <td>1</td> </tr> <tr> <td>SignatureInterface */</td> <td>1</td> </tr> <tr> <td>CacheInterface</td> <td>1</td> </tr> <tr> <td>Document\Properties</td> <td>1</td> </tr> <tr> <td>Document\Security</td> <td>1</td> </tr> <tr> <td>Worksheet[]</td> <td>1</td> </tr> <tr> <td>NamedRange[]</td> <td>1</td> </tr> <tr> <td>IComparable[]</td> <td>1</td> </tr> <tr> <td>Style\Color</td> <td>1</td> </tr> <tr> <td>IReadFilter</td> <td>1</td> </tr> <tr> <td>XmlScanner</td> <td>1</td> </tr> <tr> <td>Xls\RC4</td> <td>1</td> </tr> <tr> <td>Xlsx\Theme</td> <td>1</td> </tr> <tr> <td>BSE|BstoreContainer|DgContainer|DggContainer|\PhpOffice\PhpSpreadsheet\Shared\Escher|SpContainer|SpgrContainer</td> <td>1</td> </tr> <tr> <td>Theme</td> <td>1</td> </tr> <tr> <td>\Psr\SimpleCache\CacheInterface</td> <td>1</td> </tr> <tr> <td>Cell</td> <td>1</td> </tr> <tr> <td>HeaderFooterDrawing[]</td> <td>1</td> </tr> <tr> <td>AutoFilter\Column[]</td> <td>1</td> </tr> <tr> <td>Drawing\Shadow</td> <td>1</td> </tr> <tr> <td>null|Hyperlink</td> <td>1</td> </tr> <tr> <td>RowDimension[]</td> <td>1</td> </tr> <tr> <td>RowDimension</td> <td>1</td> </tr> <tr> <td>ColumnDimension[]</td> <td>1</td> </tr> <tr> <td>ColumnDimension</td> <td>1</td> </tr> <tr> <td>BaseDrawing[]</td> <td>1</td> </tr> <tr> <td>Chart[]</td> <td>1</td> </tr> <tr> <td>PageSetup</td> <td>1</td> </tr> <tr> <td>PageMargins</td> <td>1</td> </tr> <tr> <td>HeaderFooter</td> <td>1</td> </tr> <tr> <td>SheetView</td> <td>1</td> </tr> <tr> <td>Comment[]</td> <td>1</td> </tr> <tr> <td>array Containing start column and end column, empty array if option unset</td> <td>1</td> </tr> <tr> <td>array Containing start row number and end row number, empty array if option unset</td> <td>1</td> </tr> <tr> <td>array of Column\Rule</td> <td>1</td> </tr> <tr> <td>Column</td> <td>1</td> </tr> <tr> <td>array of integer</td> <td>1</td> </tr> <tr> <td>array of mixed.</td> <td>1</td> </tr> <tr> <td>Legend</td> <td>1</td> </tr> <tr> <td>PlotArea</td> <td>1</td> </tr> <tr> <td>DataSeries[]</td> <td>1</td> </tr> <tr> <td>string|string[]</td> <td>1</td> </tr> <tr> <td>Spreadsheet|Style</td> <td>1</td> </tr> <tr> <td>Fill</td> <td>1</td> </tr> <tr> <td>Borders</td> <td>1</td> </tr> <tr> <td>Alignment</td> <td>1</td> </tr> <tr> <td>NumberFormat</td> <td>1</td> </tr> <tr> <td>Conditional[]</td> <td>1</td> </tr> <tr> <td>Root</td> <td>1</td> </tr> <tr> <td>Escher\DggContainer</td> <td>1</td> </tr> <tr> <td>Escher\DgContainer</td> <td>1</td> </tr> <tr> <td>null|\DateTimeZone</td> <td>1</td> </tr> <tr> <td>bestFit[]</td> <td>1</td> </tr> <tr> <td>int byte offset</td> <td>1</td> </tr> <tr> <td>DggContainer\BstoreContainer</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer</td> <td>1</td> </tr> <tr> <td>SpgrContainer</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer</td> <td>1</td> </tr> <tr> <td>BSE\Blip</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE</td> <td>1</td> </tr> <tr> <td>IValueBinder</td> <td>1</td> </tr> <tr> <td>Logger</td> <td>1</td> </tr> <tr> <td>FormulaToken[]</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet[]</td> <td>1</td> </tr> <tr> <td>Ods\WriterPart[]</td> <td>1</td> </tr> <tr> <td>Xlsx\WriterPart[]</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Xf[]</td> <td>1</td> </tr> <tr> <td>Font[]</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Style\Font</td> <td>1</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet</td> <td>1</td> </tr> <tr> <td>Ods</td> <td>1</td> </tr> <tr> <td>Xlsx</td> <td>1</td> </tr> <tr> <td>ITextElement[]</td> <td>1</td> </tr> <tr> <td>Warning\Warning[]</td> <td>1</td> </tr> <tr> <td>LocalPart</td> <td>1</td> </tr> <tr> <td>DomainPart</td> <td>1</td> </tr> <tr> <td>EmailParser|null</td> <td>1</td> </tr> <tr> <td>InvalidEmail[]</td> <td>1</td> </tr> <tr> <td>EmailValidation[]</td> <td>1</td> </tr> <tr> <td>MultipleErrors|null</td> <td>1</td> </tr> <tr> <td>Swift_Signers_HeaderSigner[]</td> <td>1</td> </tr> <tr> <td>Swift_Signers_BodySigner[]</td> <td>1</td> </tr> <tr> <td>Swift_Transport_EsmtpHandler[]</td> <td>1</td> </tr> <tr> <td>Swift_Transport_Esmtp_Authenticator[]</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Timer</td> <td>1</td> </tr> <tr> <td>Swift_Plugins_Reporter</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMessage[]</td> <td>1</td> </tr> <tr> <td>Swift_StreamFilter</td> <td>1</td> </tr> <tr> <td>Swift_CharacterReader</td> <td>1</td> </tr> <tr> <td>Swift_CharacterReaderFactory</td> <td>1</td> </tr> <tr> <td>Swift_StreamFilter[]</td> <td>1</td> </tr> <tr> <td>Swift_CharacterReaderFactory[]</td> <td>1</td> </tr> <tr> <td>Swift_Mime_ContentEncoder_QpContentEncoder</td> <td>1</td> </tr> <tr> <td>Swift_Mime_ContentEncoder_NativeQpContentEncoder</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleMessage</td> <td>1</td> </tr> <tr> <td>Swift_TransportException</td> <td>1</td> </tr> <tr> <td>resource|null</td> <td>1</td> </tr> <tr> <td>Swift_StreamFilters_StringReplacementFilterFactory</td> <td>1</td> </tr> <tr> <td>Swift_Mime_SimpleHeaderFactory</td> <td>1</td> </tr> <tr> <td>array http schemes supported. http or https or both http and https</td> <td>1</td> </tr> <tr> <td>string class that holds metadata as static properties</td> <td>1</td> </tr> <tr> <td>array type mapping for converting data types to JSON-Schema Draft 4</td> <td>1</td> </tr> <tr> <td>Flash</td> <td>1</td> </tr> <tr> <td>bool When restler is not running in production mode, this value will</td> <td>1</td> </tr> <tr> <td>RestException</td> <td>1</td> </tr> <tr> <td>iCache</td> <td>1</td> </tr> <tr> <td>int|null when specified it will override @status comment</td> <td>1</td> </tr> <tr> <td>string base url of the api service</td> <td>1</td> </tr> <tr> <td>bool Used for waiting till verifying @format</td> <td>1</td> </tr> <tr> <td>ApiMethodInfo</td> <td>1</td> </tr> <tr> <td>int for calculating execution time</td> <td>1</td> </tr> <tr> <td>null|Callable adding a resolver function that accepts</td> <td>1</td> </tr> <tr> <td>string the memcache server hostname / IP address. For the memcache </td> <td>1</td> </tr> <tr> <td>int the memcache server port. For the memcache cache method. </td> <td>1</td> </tr> <tr> <td>bool should we include newer apis in the list? works only when</td> <td>1</td> </tr> <tr> <td>array type mapping for converting data types to javascript / swagger</td> <td>1</td> </tr> <tr> <td>Restler instance injected at runtime</td> <td>1</td> </tr> <tr> <td>string full path of the directory where all the generated files will</td> <td>1</td> </tr> <tr> <td>string name of the class that implements \Luracast\Restler\iCompose</td> <td>1</td> </tr> <tr> <td>bool should auto routing for public and protected api methods</td> <td>1</td> </tr> <tr> <td>boolean avoids creating multiple routes that can increase the</td> <td>1</td> </tr> <tr> <td>boolean enables more ways of finding the parameter data in the request.</td> <td>1</td> </tr> <tr> <td>null|string name that is used for vendor specific media type and</td> <td>1</td> </tr> <tr> <td>bool set it to true to force vendor specific MIME for versioning.</td> <td>1</td> </tr> <tr> <td>bool set it to true to use enableUrl based versioning</td> <td>1</td> </tr> <tr> <td>string name to be used for the method parameter to capture the</td> <td>1</td> </tr> <tr> <td>string name of the property that can sent through $_GET or $_POST to</td> <td>1</td> </tr> <tr> <td>bool should auto validating api parameters should be enabled by</td> <td>1</td> </tr> <tr> <td>string name of the class that implements iUser interface to identify</td> <td>1</td> </tr> <tr> <td>bool HTTP status codes are set on all responses by default.</td> <td>1</td> </tr> <tr> <td>bool when set to true, it will exclude the response body</td> <td>1</td> </tr> <tr> <td>bool when set to true, the response will not be outputted directly into the buffer.</td> <td>1</td> </tr> <tr> <td>bool enables CORS support</td> <td>1</td> </tr> <tr> <td>array default Cache-Control template that used to set the</td> <td>1</td> </tr> <tr> <td>int sets the content to expire immediately when set to zero</td> <td>1</td> </tr> <tr> <td>int set the default api access mode</td> <td>1</td> </tr> <tr> <td>string authentication method to be called in iAuthenticate</td> <td>1</td> </tr> <tr> <td>int time in milliseconds for bandwidth throttling,</td> <td>1</td> </tr> <tr> <td>array use 'alternativeName'=> 'actualName' to set alternative</td> <td>1</td> </tr> <tr> <td>array determines the defaults that can be overridden by the api</td> <td>1</td> </tr> <tr> <td>array contains validation details for defaults to be used when</td> <td>1</td> </tr> <tr> <td>array determines what are the phpdoc comment tags that will</td> <td>1</td> </tr> <tr> <td>string path of the folder to hold cache files</td> <td>1</td> </tr> <tr> <td>array annotations that support array value</td> <td>1</td> </tr> <tr> <td>array prefix additional menu items with one of the following syntax</td> <td>1</td> </tr> <tr> <td>array suffix additional menu items with one of the following syntax</td> <td>1</td> </tr> <tr> <td>bool should we fill up the form using given data?</td> <td>1</td> </tr> <tr> <td>ValidationInfo</td> <td>1</td> </tr> <tr> <td>ApiMethodInfo;</td> <td>1</td> </tr> <tr> <td>Callable</td> <td>1</td> </tr> <tr> <td>boolean|null shim for json_encode option JSON_PRETTY_PRINT set</td> <td>1</td> </tr> <tr> <td>boolean|null shim for json_encode option JSON_UNESCAPED_SLASHES</td> <td>1</td> </tr> <tr> <td>boolean|null shim for json_encode JSON_UNESCAPED_UNICODE set it</td> <td>1</td> </tr> <tr> <td>boolean|null shim for json_decode JSON_BIGINT_AS_STRING set it to</td> <td>1</td> </tr> <tr> <td>boolean|null shim for json_decode JSON_NUMERIC_CHECK set it to</td> <td>1</td> </tr> <tr> <td>null|string defaults to template named folder in Defaults::$cacheDirectory</td> <td>1</td> </tr> <tr> <td>array global key value pair to be supplied to the templates. All</td> <td>1</td> </tr> <tr> <td>string set it to the location of your the view files. Defaults to</td> <td>1</td> </tr> <tr> <td>array template and its custom extension key value pair</td> <td>1</td> </tr> <tr> <td>bool used internally for error handling</td> <td>1</td> </tr> <tr> <td>Restler;</td> <td>1</td> </tr> <tr> <td>string $rootNodeName</td> <td>1</td> </tr> <tr> <td>boolean set it to true binary plist is preferred</td> <td>1</td> </tr> <tr> <td>\Luracast\Restler\Restler;</td> <td>1</td> </tr> <tr> <td>string group the current api belongs to</td> <td>1</td> </tr> <tr> <td>mixed given value for the parameter</td> <td>1</td> </tr> <tr> <td>string proper name for given parameter</td> <td>1</td> </tr> <tr> <td>string html element that can be used to represent the parameter for</td> <td>1</td> </tr> <tr> <td>mixed default value for the parameter</td> <td>1</td> </tr> <tr> <td>string variable name</td> <td>1</td> </tr> <tr> <td>bool is it required or not</td> <td>1</td> </tr> <tr> <td>string body or header or query where this parameter is coming from</td> <td>1</td> </tr> <tr> <td>string|array multiple types are specified it will be of</td> <td>1</td> </tr> <tr> <td>string|null when all the items in an array are of certain type, we</td> <td>1</td> </tr> <tr> <td>boolean true or false</td> <td>1</td> </tr> <tr> <td>array of children to be validated</td> <td>1</td> </tr> <tr> <td>array of choices to match to</td> <td>1</td> </tr> <tr> <td>number minimum value</td> <td>1</td> </tr> <tr> <td>number maximum value</td> <td>1</td> </tr> <tr> <td>string regular expression</td> <td>1</td> </tr> <tr> <td>array custom rule set</td> <td>1</td> </tr> <tr> <td>string custom error response</td> <td>1</td> </tr> <tr> <td>string validation method name</td> <td>1</td> </tr> <tr> <td>null|object will be null or api class instance</td> <td>1</td> </tr> <tr> <td>array key value pairs for fixing value types using functions.</td> <td>1</td> </tr> <tr> <td>string character that is used to identify sub objects</td> <td>1</td> </tr> <tr> <td>bool set it to true when empty arrays, blank strings, null values</td> <td>1</td> </tr> <tr> <td>bool set it to true to remove all null values from the result</td> <td>1</td> </tr> <tr> <td>string target url</td> <td>1</td> </tr> <tr> <td>array parameters to be passed to the api method</td> <td>1</td> </tr> <tr> <td>array information on parameters in the form of array(name => index)</td> <td>1</td> </tr> <tr> <td>array default values for parameters if any</td> <td>1</td> </tr> <tr> <td>array key => value pair of method meta information</td> <td>1</td> </tr> <tr> <td>int access level</td> <td>1</td> </tr> <tr> <td>int $imgHeight</td> <td>1</td> </tr> <tr> <td>int $imgWidth</td> <td>1</td> </tr> <tr> <td>string $imgData</td> <td>1</td> </tr> <tr> <td>array:string $imgColumnData</td> <td>1</td> </tr> <tr> <td>string $imgRasterData</td> <td>1</td> </tr> <tr> <td>boolean $allowOptimisations</td> <td>1</td> </tr> <tr> <td>array|null $data</td> <td>1</td> </tr> <tr> <td>string|null $iconv</td> <td>1</td> </tr> <tr> <td>string|null $notes</td> <td>1</td> </tr> <tr> <td>string $codePageCacheKey</td> <td>1</td> </tr> <tr> <td>array $codePages</td> <td>1</td> </tr> <tr> <td>array $colors</td> <td>1</td> </tr> <tr> <td>array $features</td> <td>1</td> </tr> <tr> <td>array $fonts</td> <td>1</td> </tr> <tr> <td>array $media</td> <td>1</td> </tr> <tr> <td>string $notes</td> <td>1</td> </tr> <tr> <td>string $profileId</td> <td>1</td> </tr> <tr> <td>string $vendor</td> <td>1</td> </tr> <tr> <td>array $encodings</td> <td>1</td> </tr> <tr> <td>array $profiles</td> <td>1</td> </tr> <tr> <td>PrintBuffer|null $buffer</td> <td>1</td> </tr> <tr> <td>PrintConnector $connector</td> <td>1</td> </tr> <tr> <td>CapabilityProfile $profile</td> <td>1</td> </tr> <tr> <td>int $characterTable</td> <td>1</td> </tr> <tr> <td>array $available</td> <td>1</td> </tr> <tr> <td>array $encode</td> <td>1</td> </tr> <tr> <td>Printer|null $printer</td> <td>1</td> </tr> <tr> <td>string|null font to use</td> <td>1</td> </tr> <tr> <td>string $hostname</td> <td>1</td> </tr> <tr> <td>boolean $isLocal</td> <td>1</td> </tr> <tr> <td>int $platform</td> <td>1</td> </tr> <tr> <td>string $userName</td> <td>1</td> </tr> <tr> <td>string $userPassword</td> <td>1</td> </tr> <tr> <td>string $workgroup</td> <td>1</td> </tr> <tr> <td>resource $fp</td> <td>1</td> </tr> <tr> <td>CarbonInterval</td> <td>1</td> </tr> <tr> <td>CarbonInterface|null</td> <td>1</td> </tr> <tr> <td>\DateTimeZone|null</td> <td>1</td> </tr> <tr> <td>bool|string|null</td> <td>1</td> </tr> <tr> <td>PhpMethodReflectionFactory</td> <td>1</td> </tr> <tr> <td>MacroScanner</td> <td>1</td> </tr> <tr> <td>ReflectionFunction|ReflectionMethod</td> <td>1</td> </tr> <tr> <td>class-string</td> <td>1</td> </tr> <tr> <td>ReflectionParameter[]</td> <td>1</td> </tr> <tr> <td>Closure|null</td> <td>1</td> </tr> <tr> <td>callable|null</td> <td>1</td> </tr> <tr> <td>Closure|static|null</td> <td>1</td> </tr> <tr> <td>string|Closure|null</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Pagination\LengthAwarePaginator</td> <td>1</td> </tr> <tr> <td>\Illuminate\Pagination\Cursor|null</td> <td>1</td> </tr> <tr> <td>\Dotenv\Repository\RepositoryInterface|null</td> <td>1</td> </tr> <tr> <td>\Illuminate\Filesystem\Filesystem</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Config\Repository</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Bus\QueueingDispatcher</td> <td>1</td> </tr> <tr> <td>\Illuminate\Contracts\Events\Dispatcher</td> <td>1</td> </tr> <tr> <td>callable|static</td> <td>1</td> </tr> <tr> <td>array $accounts</td> <td>1</td> </tr> <tr> <td>string $personal</td> <td>1</td> </tr> <tr> <td>string $mailbox</td> <td>1</td> </tr> <tr> <td>string $host</td> <td>1</td> </tr> <tr> <td>string $mail</td> <td>1</td> </tr> <tr> <td>string $full</td> <td>1</td> </tr> <tr> <td>string $name */</td> <td>1</td> </tr> <tr> <td>array $values</td> <td>1</td> </tr> <tr> <td>FolderCollection|array</td> <td>1</td> </tr> <tr> <td>Attribute[]|array $attributes</td> <td>1</td> </tr> <tr> <td>Part[] $parts</td> <td>1</td> </tr> <tr> <td>Message $oMessage</td> <td>1</td> </tr> <tr> <td>Part $part */</td> <td>1</td> </tr> <tr> <td>string $content</td> <td>1</td> </tr> <tr> <td>string $subtype</td> <td>1</td> </tr> <tr> <td>string $charset</td> <td>1</td> </tr> <tr> <td>int $encoding</td> <td>1</td> </tr> <tr> <td>boolean $ifdisposition</td> <td>1</td> </tr> <tr> <td>string $disposition</td> <td>1</td> </tr> <tr> <td>boolean $ifdescription</td> <td>1</td> </tr> <tr> <td>string $description</td> <td>1</td> </tr> <tr> <td>integer $bytes</td> <td>1</td> </tr> <tr> <td>string|null $content_type</td> <td>1</td> </tr> <tr> <td>Attribute[]|mixed[] $attributes</td> <td>1</td> </tr> <tr> <td>string $folder_path</td> <td>1</td> </tr> <tr> <td>null|string $raw_body</td> <td>1</td> </tr> <tr> <td>Structure $structure</td> <td>1</td> </tr> <tr> <td>array $bodies</td> <td>1</td> </tr> <tr> <td>AttachmentCollection $attachments */</td> <td>1</td> </tr> <tr> <td>FlagCollection $flags */</td> <td>1</td> </tr> <tr> <td>array $available_flags</td> <td>1</td> </tr> <tr> <td>boolean|Protocol|ProtocolInterface</td> <td>1</td> </tr> <tr> <td>int $timeout</td> <td>1</td> </tr> <tr> <td>string $default_message_mask</td> <td>1</td> </tr> <tr> <td>string $default_attachment_mask</td> <td>1</td> </tr> <tr> <td>array $default_account_config</td> <td>1</td> </tr> <tr> <td>false|resource</td> <td>1</td> </tr> <tr> <td>mixed $encryption</td> <td>1</td> </tr> <tr> <td>array $events</td> <td>1</td> </tr> <tr> <td>int $total</td> <td>1</td> </tr> <tr> <td>Message $parent */</td> <td>1</td> </tr> <tr> <td>Attachment $parent */</td> <td>1</td> </tr> <tr> <td>object $parent</td> <td>1</td> </tr> <tr> <td>Folder $old_folder */</td> <td>1</td> </tr> <tr> <td>Folder $new_folder */</td> <td>1</td> </tr> <tr> <td>Folder $folder */</td> <td>1</td> </tr> <tr> <td>Message $old_message */</td> <td>1</td> </tr> <tr> <td>Message $new_message */</td> <td>1</td> </tr> <tr> <td>string $flag */</td> <td>1</td> </tr> <tr> <td>array $available_criteria</td> <td>1</td> </tr> <tr> <td>Collection $query */</td> <td>1</td> </tr> <tr> <td>string $raw_query */</td> <td>1</td> </tr> <tr> <td>string $charset */</td> <td>1</td> </tr> <tr> <td>Client $client */</td> <td>1</td> </tr> <tr> <td>int $limit */</td> <td>1</td> </tr> <tr> <td>int $page */</td> <td>1</td> </tr> <tr> <td>int $fetch_options */</td> <td>1</td> </tr> <tr> <td>int $fetch_body */</td> <td>1</td> </tr> <tr> <td>int $fetch_flags */</td> <td>1</td> </tr> <tr> <td>int $sequence */</td> <td>1</td> </tr> <tr> <td>string $fetch_order */</td> <td>1</td> </tr> <tr> <td>string $date_format */</td> <td>1</td> </tr> <tr> <td>bool $soft_fail */</td> <td>1</td> </tr> <tr> <td>array $errors */</td> <td>1</td> </tr> <tr> <td>\XmlReader */</td> <td>1</td> </tr> <tr> <td>wsdl|null */</td> <td>1</td> </tr> <tr> <td>\Stripe\Service\CoreServiceFactory</td> <td>1</td> </tr> <tr> <td>array<string, mixed> */</td> <td>1</td> </tr> <tr> <td>\Stripe\Util\RequestOptions */</td> <td>1</td> </tr> <tr> <td>HttpClient\ClientInterface</td> <td>1</td> </tr> <tr> <td>HttpClient\StreamingClientInterface</td> <td>1</td> </tr> <tr> <td>RequestTelemetry</td> <td>1</td> </tr> <tr> <td>Util\RequestOptions */</td> <td>1</td> </tr> <tr> <td>null|array */</td> <td>1</td> </tr> <tr> <td>null|ApiResponse */</td> <td>1</td> </tr> <tr> <td>null|array|CaseInsensitiveArray</td> <td>1</td> </tr> <tr> <td>string The Stripe API key to be used for requests. */</td> <td>1</td> </tr> <tr> <td>string The Stripe client_id to be used for Connect requests. */</td> <td>1</td> </tr> <tr> <td>string The base URL for the Stripe API. */</td> <td>1</td> </tr> <tr> <td>string The base URL for the OAuth API. */</td> <td>1</td> </tr> <tr> <td>string The base URL for the Stripe API uploads endpoint. */</td> <td>1</td> </tr> <tr> <td>null|string The version of the Stripe API to use for requests. */</td> <td>1</td> </tr> <tr> <td>null|string The account ID for connected accounts requests. */</td> <td>1</td> </tr> <tr> <td>string Path to the CA bundle used to verify SSL certificates */</td> <td>1</td> </tr> <tr> <td>bool Defaults to true. */</td> <td>1</td> </tr> <tr> <td>array The application's information (name, version, URL) */</td> <td>1</td> </tr> <tr> <td>null|Util\LoggerInterface the logger to which the library will</td> <td>1</td> </tr> <tr> <td>int Maximum number of request retries */</td> <td>1</td> </tr> <tr> <td>bool Whether client telemetry is enabled. Defaults to true. */</td> <td>1</td> </tr> <tr> <td>float Maximum delay between retries, in seconds */</td> <td>1</td> </tr> <tr> <td>float Maximum delay between retries, in seconds, that will be respected from the Stripe API */</td> <td>1</td> </tr> <tr> <td>float Initial delay between retries, in seconds */</td> <td>1</td> </tr> <tr> <td>\Stripe\Util\RandomGenerator */</td> <td>1</td> </tr> <tr> <td>array<string> a list of headers that should be persisted across requests</td> <td>1</td> </tr> <tr> <td>array<string, string> */</td> <td>1</td> </tr> <tr> <td>\Stripe\StripeClientInterface */</td> <td>1</td> </tr> <tr> <td>array<string, AbstractService|AbstractServiceFactory> */</td> <td>1</td> </tr> <tr> <td>\Stripe\StripeClientInterface</td> <td>1</td> </tr> <tr> <td>\Stripe\StripeStreamingClientInterface</td> <td>1</td> </tr> <tr> <td>TracedStatement[] */</td> <td>1</td> </tr> <tr> <td>Profile</td> <td>1</td> </tr> <tr> <td>LoaderInterface|Environment|null</td> <td>1</td> </tr> <tr> <td>int $render_time</td> <td>1</td> </tr> <tr> <td>null|TestHandler</td> <td>1</td> </tr> <tr> <td>null|Logger</td> <td>1</td> </tr> <tr> <td>\Twig_Profiler_Profile</td> <td>1</td> </tr> <tr> <td>\Twig_LoaderInterface</td> <td>1</td> </tr> <tr> <td>int $render_time</td> <td>1</td> </tr> <tr> <td>\DebugBar\DataCollector\TimeDataCollector</td> <td>1</td> </tr> <tr> <td>\Predis\Client|\Redis */</td> <td>1</td> </tr> <tr> <td>VarCloner */</td> <td>1</td> </tr> <tr> <td>DebugBarHtmlDumper */</td> <td>1</td> </tr> <tr> <td>string Shop URL */</td> <td>1</td> </tr> <tr> <td>string Authentication key */</td> <td>1</td> </tr> <tr> <td>boolean is debug activated */</td> <td>1</td> </tr> <tr> <td>string PS version */</td> <td>1</td> </tr> <tr> <td>string String with name of icon for conferenceorboothattendee. Must be the part after the 'object_' into object_conferenceorboothattendee.png</td> <td>1</td> </tr> <tr> <td>string Used to add a filter in Form::showrefnav method</td> <td>1</td> </tr> <tr> <td>array $FIELDS Mandatory fields, checked when we create and update the object</td> <td>1</td> </tr> <tr> <td>Societe $company {@type Societe}</td> <td>1</td> </tr> <tr> <td>string String with name of icon for societeaccount. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>integer|string date_last_login</td> <td>1</td> </tr> <tr> <td>Contact $contact {@type Contact}</td> <td>1</td> </tr> <tr> <td>int state id</td> <td>1</td> </tr> <tr> <td>int $default_rib 1 = this object is the third party's default bank information, 0 if not</td> <td>1</td> </tr> <tr> <td>string currency code</td> <td>1</td> </tr> <tr> <td>string rum</td> <td>1</td> </tr> <tr> <td>int date rum</td> <td>1</td> </tr> <tr> <td>string external payment site</td> <td>1</td> </tr> <tr> <td>string comment</td> <td>1</td> </tr> <tr> <td>string ip address</td> <td>1</td> </tr> <tr> <td>string String with name of icon for companypaymentmode. Must be the part after the 'object_' into object_companypaymentmode.png</td> <td>1</td> </tr> <tr> <td>string company payment mode label</td> <td>1</td> </tr> <tr> <td>string iban</td> <td>1</td> </tr> <tr> <td>string Fields for combobox</td> <td>1</td> </tr> <tr> <td>static To store a cloned copy of object before to edit it and keep track of old properties</td> <td>1</td> </tr> <tr> <td>int Physical thirdparty not a company</td> <td>1</td> </tr> <tr> <td>string region code</td> <td>1</td> </tr> <tr> <td>string Region name</td> <td>1</td> </tr> <tr> <td>int country_id</td> <td>1</td> </tr> <tr> <td>string State code</td> <td>1</td> </tr> <tr> <td>int Set if company email found into unsubscribe of emailing list table</td> <td>1</td> </tr> <tr> <td>string Professional ID 1</td> <td>1</td> </tr> <tr> <td>string Professional ID 2</td> <td>1</td> </tr> <tr> <td>string Professional ID 3</td> <td>1</td> </tr> <tr> <td>string Prefix comm</td> <td>1</td> </tr> <tr> <td>int Vat concerned</td> <td>1</td> </tr> <tr> <td>string Intracommunitary VAT ID</td> <td>1</td> </tr> <tr> <td>int Vat reverse-charge concerned</td> <td>1</td> </tr> <tr> <td>string Manager</td> <td>1</td> </tr> <tr> <td>float Capital</td> <td>1</td> </tr> <tr> <td>int Type thirdparty</td> <td>1</td> </tr> <tr> <td>string second name</td> <td>1</td> </tr> <tr> <td>string outstanding limit</td> <td>1</td> </tr> <tr> <td>string Min order amount</td> <td>1</td> </tr> <tr> <td>string Supplier min order amount</td> <td>1</td> </tr> <tr> <td>string Logo</td> <td>1</td> </tr> <tr> <td>string logo small</td> <td>1</td> </tr> <tr> <td>string Logo mini</td> <td>1</td> </tr> <tr> <td>string Logo squarred</td> <td>1</td> </tr> <tr> <td>string Logo squarred small</td> <td>1</td> </tr> <tr> <td>string Logo squarred mini</td> <td>1</td> </tr> <tr> <td>string Accountancy account for sales</td> <td>1</td> </tr> <tr> <td>string Accountancy account for bought</td> <td>1</td> </tr> <tr> <td>Account|string Default BAN account</td> <td>1</td> </tr> <tr> <td>string Name of id column</td> <td>1</td> </tr> <tr> <td>string Name of icon for actioncomm object. Filename of icon is object_action.png</td> <td>1</td> </tr> <tr> <td>int<0,2> 0=Default</td> <td>1</td> </tr> <tr> <td>int Id of the event</td> <td>1</td> </tr> <tr> <td>string Id of the event. Use $id as possible</td> <td>1</td> </tr> <tr> <td>int Id into parent table llx_c_actioncomm (used only if option to use type is set)</td> <td>1</td> </tr> <tr> <td>string Calendar of event (Type of type of event). 'system'=Default calendar, 'systemauto'=Auto calendar, 'birthdate', 'holiday', 'module'=Calendar specific to a module</td> <td>1</td> </tr> <tr> <td>string Code into parent table llx_c_actioncomm (used only if option to use type is set). With default setup, should be AC_OTH_AUTO or AC_OTH.</td> <td>1</td> </tr> <tr> <td>string Type label</td> <td>1</td> </tr> <tr> <td>string Color into parent table llx_c_actioncomm (used only if option to use type is set)</td> <td>1</td> </tr> <tr> <td>string Picto for type of event (used only if option to use type is set)</td> <td>1</td> </tr> <tr> <td>string Free code to identify action. Ie: Agenda trigger add here AC_TRIGGERNAME ('AC_COMPANY_CREATE', 'AC_PROPAL_VALIDATE', ...)</td> <td>1</td> </tr> <tr> <td>int Date creation record (datec)</td> <td>1</td> </tr> <tr> <td>int Duration (duree)</td> <td>1</td> </tr> <tr> <td>int Date modification record (tms)</td> <td>1</td> </tr> <tr> <td>User Object user that create action</td> <td>1</td> </tr> <tr> <td>User Object user that modified action</td> <td>1</td> </tr> <tr> <td>int Id user that create action</td> <td>1</td> </tr> <tr> <td>int Id user that modified action</td> <td>1</td> </tr> <tr> <td>int Date action start (datep)</td> <td>1</td> </tr> <tr> <td>int Date action end (datef)</td> <td>1</td> </tr> <tr> <td>int This is date start action (datep) but modified to not be outside calendar view.</td> <td>1</td> </tr> <tr> <td>int This is date end action (datef) but modified to not be outside calendar view.</td> <td>1</td> </tr> <tr> <td>int Date action end (datep2)</td> <td>1</td> </tr> <tr> <td>int -1=Unknown duration</td> <td>1</td> </tr> <tr> <td>int 1=Event on full day</td> <td>1</td> </tr> <tr> <td>int 1=???</td> <td>1</td> </tr> <tr> <td>int<-1,100> Percentage</td> <td>1</td> </tr> <tr> <td>string Location</td> <td>1</td> </tr> <tr> <td>int Transparency (ical standard). Used to say if people assigned to event are busy or not by event. 0=available, 1=busy, 2=busy (refused events)</td> <td>1</td> </tr> <tr> <td>int (0 By default)</td> <td>1</td> </tr> <tr> <td>array<int,array{id:int,transparency:int<0,1>}> Array of users</td> <td>1</td> </tr> <tr> <td>int Id of user owner = fk_user_action into table</td> <td>1</td> </tr> <tr> <td>array<int,array{id:int,mandatory:int<0,1>,answer_status:int,transparency:int<0,1>}> Array of contact ids</td> <td>1</td> </tr> <tr> <td>int[] Array of other contact emails (not user, not contact)</td> <td>1</td> </tr> <tr> <td>array<int,ActionCommReminder> Array of reminders</td> <td>1</td> </tr> <tr> <td>int thirdparty id linked to action</td> <td>1</td> </tr> <tr> <td>int socpeople id linked to action</td> <td>1</td> </tr> <tr> <td>?Societe Company linked to action (optional)</td> <td>1</td> </tr> <tr> <td>?Contact Contact linked to action (optional)</td> <td>1</td> </tr> <tr> <td>int Id of linked object</td> <td>1</td> </tr> <tr> <td>int Id of linked object, alternative for API or other</td> <td>1</td> </tr> <tr> <td>string Type of record. This if property ->element of object linked to.</td> <td>1</td> </tr> <tr> <td>int id of calendar</td> <td>1</td> </tr> <tr> <td>string Ical name</td> <td>1</td> </tr> <tr> <td>string Ical color (Hex value for color on 6 nibles)</td> <td>1</td> </tr> <tr> <td>string Extraparam</td> <td>1</td> </tr> <tr> <td>array<int,array{id:int,type:string,actionparam:string,status:int}> Actions</td> <td>1</td> </tr> <tr> <td>string Email msgid</td> <td>1</td> </tr> <tr> <td>string Email from</td> <td>1</td> </tr> <tr> <td>string Email sender</td> <td>1</td> </tr> <tr> <td>string Email to</td> <td>1</td> </tr> <tr> <td>string Email tocc</td> <td>1</td> </tr> <tr> <td>string Email tobcc</td> <td>1</td> </tr> <tr> <td>string Email subject</td> <td>1</td> </tr> <tr> <td>string Email errors to</td> <td>1</td> </tr> <tr> <td>int number of vote for an event</td> <td>1</td> </tr> <tr> <td>int if event is paid</td> <td>1</td> </tr> <tr> <td>int status use but Event organisation module</td> <td>1</td> </tr> <tr> <td>string IP address</td> <td>1</td> </tr> <tr> <td>string A string YYYYMMDDHHMMSS shared by allevent of same series */</td> <td>1</td> </tr> <tr> <td>string Rule of recurring */</td> <td>1</td> </tr> <tr> <td>string Repeat until this date */</td> <td>1</td> </tr> <tr> <td>int Duration of phone call when the event is a phone call */</td> <td>1</td> </tr> <tr> <td>string String with name of icon for actioncommreminder. Must be the part after the 'object_' into object_actioncommreminder.png</td> <td>1</td> </tr> <tr> <td>string reminder type email, browser, sms</td> <td>1</td> </tr> <tr> <td>int offset value</td> <td>1</td> </tr> <tr> <td>string y, m, d, w, h, i</td> <td>1</td> </tr> <tr> <td>int Project</td> <td>1</td> </tr> <tr> <td>int Template Mail</td> <td>1</td> </tr> <tr> <td>string Name of remote HTTP file to read</td> <td>1</td> </tr> <tr> <td>string Text in file</td> <td>1</td> </tr> <tr> <td>array Array to save iCalendar parse data</td> <td>1</td> </tr> <tr> <td>int Number of Events</td> <td>1</td> </tr> <tr> <td>int Number of Todos</td> <td>1</td> </tr> <tr> <td>int Number of Freebusy</td> <td>1</td> </tr> <tr> <td>string Help variable save last key (multiline string)</td> <td>1</td> </tr> <tr> <td>ActionComm $actioncomm {@type ActionComm}</td> <td>1</td> </tr> <tr> <td>string Type of agenda event label</td> <td>1</td> </tr> <tr> <td>string color hex</td> <td>1</td> </tr> <tr> <td>array array of type_actions</td> <td>1</td> </tr> <tr> <td>array Used to return value by some methods</td> <td>1</td> </tr> <tr> <td>static oldcopy with propal properties</td> <td>1</td> </tr> <tr> <td>integer|string $date_creation;</td> <td>1</td> </tr> <tr> <td>integer|string $date_signature;</td> <td>1</td> </tr> <tr> <td>User $user_signature</td> <td>1</td> </tr> <tr> <td>integer|string date of the quote;</td> <td>1</td> </tr> <tr> <td>integer|string $delivery_date;</td> <td>1</td> </tr> <tr> <td>string availability code</td> <td>1</td> </tr> <tr> <td>string availability label</td> <td>1</td> </tr> <tr> <td>PropaleLigne[]</td> <td>1</td> </tr> <tr> <td>PropaleLigne</td> <td>1</td> </tr> <tr> <td>Propal $propal {@type Propal}</td> <td>1</td> </tr> <tr> <td>int element id (it's not the name of a field)</td> <td>1</td> </tr> <tr> <td>string type element</td> <td>1</td> </tr> <tr> <td>string filter value</td> <td>1</td> </tr> <tr> <td>int|string datec</td> <td>1</td> </tr> <tr> <td>array select target type</td> <td>1</td> </tr> <tr> <td>array type status comm prospect</td> <td>1</td> </tr> <tr> <td>string Type of message ('email', 'sms')</td> <td>1</td> </tr> <tr> <td>string subject</td> <td>1</td> </tr> <tr> <td>string body</td> <td>1</td> </tr> <tr> <td>int 1=Email will be sent even to email that has opt-out</td> <td>1</td> </tr> <tr> <td>int number of email</td> <td>1</td> </tr> <tr> <td>string background color</td> <td>1</td> </tr> <tr> <td>string background image</td> <td>1</td> </tr> <tr> <td>string email to</td> <td>1</td> </tr> <tr> <td>string email reply to</td> <td>1</td> </tr> <tr> <td>string email errors to</td> <td>1</td> </tr> <tr> <td>string first joined file</td> <td>1</td> </tr> <tr> <td>string second joined file</td> <td>1</td> </tr> <tr> <td>string third joined file</td> <td>1</td> </tr> <tr> <td>string fourth joined file</td> <td>1</td> </tr> <tr> <td>int date validate</td> <td>1</td> </tr> <tr> <td>int|null date sending</td> <td>1</td> </tr> <tr> <td>array statut dest</td> <td>1</td> </tr> <tr> <td>array substitutionarray</td> <td>1</td> </tr> <tr> <td>array substitutionarrayfortest</td> <td>1</td> </tr> <tr> <td>static old copy of User</td> <td>1</td> </tr> <tr> <td>string Open ID</td> <td>1</td> </tr> <tr> <td>string|int<-1,-1> gender (man|woman|other)</td> <td>1</td> </tr> <tr> <td>string personal email</td> <td>1</td> </tr> <tr> <td>array array of socialnetwo18dprks</td> <td>1</td> </tr> <tr> <td>string job position</td> <td>1</td> </tr> <tr> <td>string user signature</td> <td>1</td> </tr> <tr> <td>string office phone</td> <td>1</td> </tr> <tr> <td>string office fax</td> <td>1</td> </tr> <tr> <td>string personal phone mobile</td> <td>1</td> </tr> <tr> <td>int 1 if admin 0 if standard user</td> <td>1</td> </tr> <tr> <td>string user apikey</td> <td>1</td> </tr> <tr> <td>string Encrypted password in memory</td> <td>1</td> </tr> <tr> <td>string Temporary password</td> <td>1</td> </tr> <tr> <td>int If this is defined, it is an external user</td> <td>1</td> </tr> <tr> <td>int If this is defined, it is a user created from a contact</td> <td>1</td> </tr> <tr> <td>int User ID of supervisor</td> <td>1</td> </tr> <tr> <td>int User ID of expense validator</td> <td>1</td> </tr> <tr> <td>int User ID of holidays validator</td> <td>1</td> </tr> <tr> <td>string clicktodial login</td> <td>1</td> </tr> <tr> <td>string clicktodial password</td> <td>1</td> </tr> <tr> <td>string clicktodial poste</td> <td>1</td> </tr> <tr> <td>int 0 by default, 1 if click to dial data were already loaded for this user</td> <td>1</td> </tr> <tr> <td>string photo filename</td> <td>1</td> </tr> <tr> <td>string default language</td> <td>1</td> </tr> <tr> <td>stdClass Class of permissions user->rights->permx</td> <td>1</td> </tr> <tr> <td>int All permissions are loaded</td> <td>1</td> </tr> <tr> <td>int Number of rights granted to the user. Value loaded after a getrights().</td> <td>1</td> </tr> <tr> <td>array To store list of groups of user (used by API /info for example)</td> <td>1</td> </tr> <tr> <td>array Cache array of already loaded permissions</td> <td>1</td> </tr> <tr> <td>stdClass To store personal config</td> <td>1</td> </tr> <tr> <td>array<int,User>|array<int,array{rowid:int,id:int,fk_user:int,fk_soc:int,firstname:string,lastname:string,login:string,statut:int,entity:int,email:string,gender:string|int<-1,-1>,admin:int<0,1>,photo:string,fullpath:string,fullname:string,level:int}> Array of User (filled from fetchAll) or Array with hierarchy of user information (filled with get_full_tree()</td> <td>1</td> </tr> <tr> <td>string Define background color for user in agenda</td> <td>1</td> </tr> <tr> <td>string ref for employee</td> <td>1</td> </tr> <tr> <td>string national registration number</td> <td>1</td> </tr> <tr> <td>int id of warehouse</td> <td>1</td> </tr> <tr> <td>int id of establishment</td> <td>1</td> </tr> <tr> <td>string label of establishment</td> <td>1</td> </tr> <tr> <td>int egroupware id</td> <td>1</td> </tr> <tr> <td>int Entity of group</td> <td>1</td> </tr> <tr> <td>User[]</td> <td>1</td> </tr> <tr> <td>int all_permissions_are_loaded</td> <td>1</td> </tr> <tr> <td>User $user {@type User}</td> <td>1</td> </tr> <tr> <td>string Name of export profile</td> <td>1</td> </tr> <tr> <td>string Categories id separated by comma</td> <td>1</td> </tr> <tr> <td>InventoryLine[] Array of subtable lines</td> <td>1</td> </tr> <tr> <td>PriceByCustomerLine[]</td> <td>1</td> </tr> <tr> <td>int price level set after updateprice for trigger</td> <td>1</td> </tr> <tr> <td>?int</td> <td>1</td> </tr> <tr> <td>string|int Main Barcode value, -1 for auto code</td> <td>1</td> </tr> <tr> <td>int Main Barcode type ID</td> <td>1</td> </tr> <tr> <td>string Main Barcode type code</td> <td>1</td> </tr> <tr> <td>int Default warehouse Id</td> <td>1</td> </tr> <tr> <td>array Path of subproducts. Build from ->sousprods with get_arbo_each_prod()</td> <td>1</td> </tr> <tr> <td>string lang code</td> <td>1</td> </tr> <tr> <td>PropalmergepdfproductLine[]</td> <td>1</td> </tr> <tr> <td>string Code lang</td> <td>1</td> </tr> <tr> <td>string String with name of icon for productfournisseurprice. Must be the part after the 'object_' into object_productfournisseurprice.png</td> <td>1</td> </tr> <tr> <td>Product $product {@type Product}</td> <td>1</td> </tr> <tr> <td>ProductFournisseur $productsupplier {@type ProductFournisseur}</td> <td>1</td> </tr> <tr> <td>string String with name of icon for stocktransfer. Must be the part after the 'object_' into object_stocktransfer.png</td> <td>1</td> </tr> <tr> <td>StockTransferLine[] stock transfer line</td> <td>1</td> </tr> <tr> <td>string String with name of icon for stocktransferline. Must be the part after the 'object_' into object_stocktransferline.png</td> <td>1</td> </tr> <tr> <td>double pmp</td> <td>1</td> </tr> <tr> <td>Entrepot $warehouse {@type Entrepot}</td> <td>1</td> </tr> <tr> <td>string Label</td> <td>1</td> </tr> <tr> <td>string Place</td> <td>1</td> </tr> <tr> <td>string Phone</td> <td>1</td> </tr> <tr> <td>string Fax</td> <td>1</td> </tr> <tr> <td>int ID of parent</td> <td>1</td> </tr> <tr> <td>int ID of project</td> <td>1</td> </tr> <tr> <td>int Warehouse usage ID</td> <td>1</td> </tr> <tr> <td>int Product ID</td> <td>1</td> </tr> <tr> <td>string batch ref</td> <td>1</td> </tr> <tr> <td>int ID product</td> <td>1</td> </tr> <tr> <td>int Type of movement</td> <td>1</td> </tr> <tr> <td>int ID user author</td> <td>1</td> </tr> <tr> <td>string stock movements label</td> <td>1</td> </tr> <tr> <td>int Origin id</td> <td>1</td> </tr> <tr> <td>string origintype</td> <td>1</td> </tr> <tr> <td>string Origin type ('project', ...)</td> <td>1</td> </tr> <tr> <td>MouvementStock $stockmovement {@type MouvementStock}</td> <td>1</td> </tr> <tr> <td>string math expression</td> <td>1</td> </tr> <tr> <td>integer|string Date of proposal</td> <td>1</td> </tr> <tr> <td>integer|string date_livraison</td> <td>1</td> </tr> <tr> <td>SupplierProposal $supplier_proposal {@type SupplierProposal}</td> <td>1</td> </tr> <tr> <td>int ID of reception</td> <td>1</td> </tr> <tr> <td>string Type of object the fk_element refers to. Example: 'supplier_order'.</td> <td>1</td> </tr> <tr> <td>Reception $reception {@type Reception}</td> <td>1</td> </tr> <tr> <td>string element name</td> <td>1</td> </tr> <tr> <td>ReceptionLineBatch[]|CommandeFournisseurDispatch[]</td> <td>1</td> </tr> <tr> <td>string Last error code</td> <td>1</td> </tr> <tr> <td>string[] Error messages</td> <td>1</td> </tr> <tr> <td>string String with name of icon for knowledgerecord. Must be the part after the 'object_' into object_knowledgerecord.png</td> <td>1</td> </tr> <tr> <td>string question asked</td> <td>1</td> </tr> <tr> <td>string answer to question</td> <td>1</td> </tr> <tr> <td>KnowledgeRecord $knowledgerecord {@type KnowledgeRecord}</td> <td>1</td> </tr> <tr> <td>int priority</td> <td>1</td> </tr> <tr> <td>Project $project {@type Project}</td> <td>1</td> </tr> <tr> <td>string Name of field date</td> <td>1</td> </tr> <tr> <td>int parent project</td> <td>1</td> </tr> <tr> <td>int Date start event</td> <td>1</td> </tr> <tr> <td>int Date end event</td> <td>1</td> </tr> <tr> <td>string Location</td> <td>1</td> </tr> <tr> <td>int Date close</td> <td>1</td> </tr> <tr> <td>int user close id</td> <td>1</td> </tr> <tr> <td>float|string budget Amount (May need price2num)</td> <td>1</td> </tr> <tr> <td>integer Can use projects to follow opportunities</td> <td>1</td> </tr> <tr> <td>integer Can follow tasks on project and enter time spent on it</td> <td>1</td> </tr> <tr> <td>integer Use to bill task spend time</td> <td>1</td> </tr> <tr> <td>integer Event organization: Use Event Organization</td> <td>1</td> </tr> <tr> <td>integer Event organization: Allow unknown people to suggest new conferences</td> <td>1</td> </tr> <tr> <td>integer Event organization: Allow unknown people to suggest new booth</td> <td>1</td> </tr> <tr> <td>float|string Event organization: registration price (may need price2num)</td> <td>1</td> </tr> <tr> <td>float|string Event organization: booth price (may need price2num)</td> <td>1</td> </tr> <tr> <td>int|string Max attendees (may be empty/need cast to iint)</td> <td>1</td> </tr> <tr> <td>array Used to store workload details of a projet</td> <td>1</td> </tr> <tr> <td>array Used to store workload details of tasks of a projet</td> <td>1</td> </tr> <tr> <td>string Ip address</td> <td>1</td> </tr> <tr> <td>Task[]</td> <td>1</td> </tr> <tr> <td>string Name of table without prefix where object is stored</td> <td>1</td> </tr> <tr> <td>int ID parent task</td> <td>1</td> </tr> <tr> <td>string Label of task</td> <td>1</td> </tr> <tr> <td>float budget_amount</td> <td>1</td> </tr> <tr> <td>float project_budget_amount</td> <td>1</td> </tr> <tr> <td>string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png</td> <td>1</td> </tr> <tr> <td>string Last error number. For example: 'DB_ERROR_RECORD_ALREADY_EXISTS', '12345', ...</td> <td>1</td> </tr> <tr> <td>int User ID. If > 0, bookmark of one user. If == 0, bookmark public (for everybody)</td> <td>1</td> </tr> <tr> <td>int position of bookmark</td> <td>1</td> </tr> <tr> <td>string favicon</td> <td>1</td> </tr> <tr> <td>string String with name of icon for position. Must be the part after the 'object_' into object_position.png</td> <td>1</td> </tr> <tr> <td>string String with name of icon for skilldet. Must be the part after the 'object_' into object_skilldet.png</td> <td>1</td> </tr> <tr> <td>string String with name of icon for evaluationdet. Must be the part after the 'object_' into object_evaluationdet.png</td> <td>1</td> </tr> <tr> <td>string Zip</td> <td>1</td> </tr> <tr> <td>int Status 0=open, 1=closed</td> <td>1</td> </tr> <tr> <td>int date create</td> <td>1</td> </tr> <tr> <td>string String with name of icon for job. Must be the part after the 'object_' into object_job.png</td> <td>1</td> </tr> <tr> <td>string String with name of icon for evaluation. Must be the part after the 'object_' into object_evaluation.png</td> <td>1</td> </tr> <tr> <td>EvaluationLine[] Array of subtable lines</td> <td>1</td> </tr> <tr> <td>string String with name of icon for skillrank. Must be the part after the 'object_' into object_skillrank.png</td> <td>1</td> </tr> <tr> <td>string String with name of icon for skill. Must be the part after the 'object_' into object_skill.png</td> <td>1</td> </tr> <tr> <td>int Proposal Id</td> <td>1</td> </tr> <tr> <td>int number of generation done</td> <td>1</td> </tr> <tr> <td>int number of maximum generation</td> <td>1</td> </tr> <tr> <td>Fichinter $fichinter {@type fichinter}</td> <td>1</td> </tr> <tr> <td>int Thirdparty Id</td> <td>1</td> </tr> <tr> <td>int duration</td> <td>1</td> </tr> <tr> <td>FichinterLigne[] lines</td> <td>1</td> </tr> <tr> <td>string|int Delivery int</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database object</td> <td>1</td> </tr> <tr> <td>string $apiService</td> <td>1</td> </tr> <tr> <td>string $apiKey</td> <td>1</td> </tr> <tr> <td>string $apiEndpoint</td> <td>1</td> </tr> <tr> <td>string String with name of icon for emailcollector. Must be the part after the 'object_' into object_emailcollector.png</td> <td>1</td> </tr> <tr> <td>integer|string $datelastresult</td> <td>1</td> </tr> <tr> <td>string String with name of icon for emailcollectoraction. Must be the part after the 'object_' into object_emailcollectoraction.png</td> <td>1</td> </tr> <tr> <td>string String with name of icon for emailcollectorfilter. Must be the part after the 'object_' into object_emailcollectorfilter.png</td> <td>1</td> </tr> <tr> <td>int draft status</td> <td>1</td> </tr> <tr> <td>int thirdparty id</td> <td>1</td> </tr> <tr> <td>string ref customer</td> <td>1</td> </tr> <tr> <td>integer|string Date really received</td> <td>1</td> </tr> <tr> <td>string model pdf</td> <td>1</td> </tr> <tr> <td>DeliveryLine[] lines</td> <td>1</td> </tr> <tr> <td>int user_author_id</td> <td>1</td> </tr> <tr> <td>string delivery note lines label</td> <td>1</td> </tr> <tr> <td>string Name of field for link to tickets</td> <td>1</td> </tr> <tr> <td>string String with name of icon for ticketcore. Must be the part after the 'object_' into object_ticketcore.png</td> <td>1</td> </tr> <tr> <td>?string Hash to identify ticket publicly</td> <td>1</td> </tr> <tr> <td>?string Email of person who created the ticket</td> <td>1</td> </tr> <tr> <td>int User id who created the ticket</td> <td>1</td> </tr> <tr> <td>int User id who the ticket is assigned to</td> <td>1</td> </tr> <tr> <td>string Ticket message</td> <td>1</td> </tr> <tr> <td>string Private message</td> <td>1</td> </tr> <tr> <td>int Ticket statut</td> <td>1</td> </tr> <tr> <td>int Ticket status</td> <td>1</td> </tr> <tr> <td>string State resolution</td> <td>1</td> </tr> <tr> <td>int Progress in percent</td> <td>1</td> </tr> <tr> <td>string Duration for ticket</td> <td>1</td> </tr> <tr> <td>string Type code</td> <td>1</td> </tr> <tr> <td>string Category code</td> <td>1</td> </tr> <tr> <td>string Severity code</td> <td>1</td> </tr> <tr> <td>int Read date</td> <td>1</td> </tr> <tr> <td>int Last message date</td> <td>1</td> </tr> <tr> <td>int Close ticket date</td> <td>1</td> </tr> <tr> <td>array cache_types_tickets</td> <td>1</td> </tr> <tr> <td>array tickets categories</td> <td>1</td> </tr> <tr> <td>array cache msgs ticket</td> <td>1</td> </tr> <tr> <td>int Notify thirdparty at create</td> <td>1</td> </tr> <tr> <td>string Email MSGID</td> <td>1</td> </tr> <tr> <td>string Email Date</td> <td>1</td> </tr> <tr> <td>string IP address</td> <td>1</td> </tr> <tr> <td>static $oldcopy State of this ticket as it was stored before an update operation (for triggers)</td> <td>1</td> </tr> <tr> <td>Ticket[] array of Tickets</td> <td>1</td> </tr> <tr> <td>string Regex pour les images</td> <td>1</td> </tr> <tr> <td>Ticket Ticket</td> <td>1</td> </tr> <tr> <td>string ticket action label</td> <td>1</td> </tr> <tr> <td>array $FIELDS_MESSAGES Mandatory fields, checked when create and update object</td> <td>1</td> </tr> <tr> <td>Ticket $ticket {@type Ticket}</td> <td>1</td> </tr> <tr> <td>DoliDB $db Database object</td> <td>1</td> </tr> <tr> <td>Restler $r Restler object</td> <td>1</td> </tr> <tr> <td>array $requires role required by API method user / external / admin</td> <td>1</td> </tr> <tr> <td>string $role user role</td> <td>1</td> </tr> <tr> <td>User $user Loggued user</td> <td>1</td> </tr> <tr> <td>string Background of banner</td> <td>1</td> </tr> <tr> <td>int Use dark theme on banner</td> <td>1</td> </tr> <tr> <td>string Back to page</td> <td>1</td> </tr> <tr> <td>string Back to page for cancel</td> <td>1</td> </tr> <tr> <td>string Back to page for JS fields</td> <td>1</td> </tr> <tr> <td>string Cancel</td> <td>1</td> </tr> <tr> <td>string Element in english</td> <td>1</td> </tr> <tr> <td>int Id</td> <td>1</td> </tr> <tr> <td>int Permission to read</td> <td>1</td> </tr> <tr> <td>int Permission to add</td> <td>1</td> </tr> <tr> <td>int Permission to delete</td> <td>1</td> </tr> <tr> <td>int Permission to note</td> <td>1</td> </tr> <tr> <td>int Permission to delete links</td> <td>1</td> </tr> <tr> <td>Adherent Member for static methods</td> <td>1</td> </tr> <tr> <td>array $infofiles Array of file info</td> <td>1</td> </tr> <tr> <td>Partnership Partnership for static methods</td> <td>1</td> </tr> <tr> <td>Commande Order for static methods</td> <td>1</td> </tr> <tr> <td>Context Singleton</td> <td>1</td> </tr> <tr> <td>DoliDb $db Database handler</td> <td>1</td> </tr> <tr> <td>string $appliName</td> <td>1</td> </tr> <tr> <td>stdClass[]</td> <td>1</td> </tr> <tr> <td>Controller $controllerInstance</td> <td>1</td> </tr> <tr> <td>object $object</td> <td>1</td> </tr> <tr> <td>CommonObject Logged user</td> <td>1</td> </tr> <tr> <td>CommonObject Logged third-party</td> <td>1</td> </tr> <tr> <td>CommonObject Logged member</td> <td>1</td> </tr> <tr> <td>CommonObject Logged partnership</td> <td>1</td> </tr> <tr> <td>WebPortalTheme Theme data</td> <td>1</td> </tr> <tr> <td>Facture Invoice for static methods</td> <td>1</td> </tr> <tr> <td>Propal Propal for static methods</td> <td>1</td> </tr> <tr> <td>string Tpl path will use default context->tplPath if empty</td> <td>1</td> </tr> <tr> <td>int Limit (-1 to get limit from conf, 0 no limit, or Nb to show)</td> <td>1</td> </tr> <tr> <td>int Page (1 by default)</td> <td>1</td> </tr> <tr> <td>string Sort field</td> <td>1</td> </tr> <tr> <td>string Sort order</td> <td>1</td> </tr> <tr> <td>string Page context</td> <td>1</td> </tr> <tr> <td>array Search filters</td> <td>1</td> </tr> <tr> <td>array Array of fields</td> <td>1</td> </tr> <tr> <td>array Company static list (cache)</td> <td>1</td> </tr> <tr> <td>boolean Is Attachment</td> <td>1</td> </tr> <tr> <td>string Encoding</td> <td>1</td> </tr> <tr> <td>string File name</td> <td>1</td> </tr> <tr> <td>string Full path of original file</td> <td>1</td> </tr> <tr> <td>string Full path of original file with encoded for OS</td> <td>1</td> </tr> <tr> <td>string Module of document ('module', 'module_user_temp', 'module_user' or 'module_temp'). Example: 'medias', 'invoice', 'logs', 'tax-vat', ...</td> <td>1</td> </tr> <tr> <td>string Relative path with filename, relative to modulepart.</td> <td>1</td> </tr> <tr> <td>string Mime type of file</td> <td>1</td> </tr> <tr> <td>string telephone number</td> <td>1</td> </tr> <tr> <td>int Maximum users</td> <td>1</td> </tr> <tr> <td>int resource ID</td> <td>1</td> </tr> <tr> <td>string resource type</td> <td>1</td> </tr> <tr> <td>int element ID</td> <td>1</td> </tr> <tr> <td>array Cache of type of resources. TODO Use $conf->cache['type_of_resources'] instead</td> <td>1</td> </tr> <tr> <td>static Clone of object before changing it</td> <td>1</td> </tr> <tr> <td>string String with name of icon for partnership. Must be the part after the 'object_' into object_partnership.png</td> <td>1</td> </tr> <tr> <td>string Partnership code</td> <td>1</td> </tr> <tr> <td>string Partnership type label</td> <td>1</td> </tr> <tr> <td>Partnership $partnership {@type Partnership}</td> <td>1</td> </tr> <tr> <td>Categorie $category {@type Categorie}</td> <td>1</td> </tr> <tr> <td>array Table of mapping between type string and ID used for field 'type' in table llx_categories</td> <td>1</td> </tr> <tr> <td>array Code mapping from ID</td> <td>1</td> </tr> <tr> <td>array Foreign keys mapping from type string when value does not match</td> <td>1</td> </tr> <tr> <td>array Category tables mapping from type string (llx_categorie_...) when value does not match</td> <td>1</td> </tr> <tr> <td>array Object class mapping from type string</td> <td>1</td> </tr> <tr> <td>array Title Area mapping from type string</td> <td>1</td> </tr> <tr> <td>array Object table mapping from type string (table llx_...) when value of key does not match table name.</td> <td>1</td> </tr> <tr> <td>string Category label</td> <td>1</td> </tr> <tr> <td>string Color</td> <td>1</td> </tr> <tr> <td>int Position</td> <td>1</td> </tr> <tr> <td>int Visible</td> <td>1</td> </tr> <tr> <td>int Id of thirdparty when CATEGORY_ASSIGNED_TO_A_CUSTOMER is set</td> <td>1</td> </tr> <tr> <td>string Category type</td> <td>1</td> </tr> <tr> <td>array<int,array{rowid:int,id:int,fk_parent:int,label:string,description:string,color:string,position:string,visible:int,ref_ext:string,picto:string,fullpath:string,fulllabel:string}> Categories table in memory</td> <td>1</td> </tr> <tr> <td>array Mother of table</td> <td>1</td> </tr> <tr> <td>array children</td> <td>1</td> </tr> <tr> <td>?array{string,array{label:string,description:string,note?:string}} multilangs</td> <td>1</td> </tr> <tr> <td>int imgWidth</td> <td>1</td> </tr> <tr> <td>int imgHeight</td> <td>1</td> </tr> <tr> <td>string ECM directories label</td> <td>1</td> </tr> <tr> <td>int cache nb of doc</td> <td>1</td> </tr> <tr> <td>int date_c</td> <td>1</td> </tr> <tr> <td>int date_m</td> <td>1</td> </tr> <tr> <td>array array of categories</td> <td>1</td> </tr> <tr> <td>array array of children categories</td> <td>1</td> </tr> <tr> <td>array array of forbidden chars</td> <td>1</td> </tr> <tr> <td>array array of forbidden chars for dir</td> <td>1</td> </tr> <tr> <td>int 1 if full arbo loaded</td> <td>1</td> </tr> <tr> <td>string Ref hash of file path</td> <td>1</td> </tr> <tr> <td>string Ecm Files label</td> <td>1</td> </tr> <tr> <td>string hash for file sharing, empty by default (example: getRandomPassword(true))</td> <td>1</td> </tr> <tr> <td>string filename, Note: Into ecm database record, the entry $filename never ends with .noexe</td> <td>1</td> </tr> <tr> <td>string filepath</td> <td>1</td> </tr> <tr> <td>string fullpath origin</td> <td>1</td> </tr> <tr> <td>string cover</td> <td>1</td> </tr> <tr> <td>string can be 'generated', 'uploaded', 'unknown'</td> <td>1</td> </tr> <tr> <td>string extraparams</td> <td>1</td> </tr> <tr> <td>int|string date create</td> <td>1</td> </tr> <tr> <td>int|string date modify</td> <td>1</td> </tr> <tr> <td>string acl</td> <td>1</td> </tr> <tr> <td>string src object type</td> <td>1</td> </tr> <tr> <td>int src object id</td> <td>1</td> </tr> <tr> <td>int section_id ID of section = ID of EcmDirectory, directory of manual ECM (not stored into database)</td> <td>1</td> </tr> <tr> <td>string ECM files line label</td> <td>1</td> </tr> <tr> <td>string Ref of the authority</td> <td>1</td> </tr> <tr> <td>string Job type</td> <td>1</td> </tr> <tr> <td>string|int Date for cron job create</td> <td>1</td> </tr> <tr> <td>string Cron Job label</td> <td>1</td> </tr> <tr> <td>string Job command</td> <td>1</td> </tr> <tr> <td>string|int|null Date for last job execution</td> <td>1</td> </tr> <tr> <td>string|int Date for next job execution</td> <td>1</td> </tr> <tr> <td>string|int Date for end job execution</td> <td>1</td> </tr> <tr> <td>string|int Date for first start job execution</td> <td>1</td> </tr> <tr> <td>string|int|null Date for last result job execution</td> <td>1</td> </tr> <tr> <td>string Last result from end job execution</td> <td>1</td> </tr> <tr> <td>string Last output from end job execution</td> <td>1</td> </tr> <tr> <td>string Unit frequency of job execution ('60', '86400', 'd', 'm', ...)</td> <td>1</td> </tr> <tr> <td>int Frequency of job execution</td> <td>1</td> </tr> <tr> <td>int Status</td> <td>1</td> </tr> <tr> <td>int Is job running ?</td> <td>1</td> </tr> <tr> <td>int|null The job current PID</td> <td>1</td> </tr> <tr> <td>string Email when an error occurs</td> <td>1</td> </tr> <tr> <td>int User ID of creation</td> <td>1</td> </tr> <tr> <td>int User ID of last modification</td> <td>1</td> </tr> <tr> <td>int Number of run job execution</td> <td>1</td> </tr> <tr> <td>int Maximum run job execution</td> <td>1</td> </tr> <tr> <td>string Libname</td> <td>1</td> </tr> <tr> <td>string A test condition to know if job is visible/qualified</td> <td>1</td> </tr> <tr> <td>string Autodelete</td> <td>1</td> </tr> <tr> <td>CommonObjectLine[] Cronjob</td> <td>1</td> </tr> <tr> <td>string Message</td> <td>1</td> </tr> <tr> <td>bool this is true if the IP address belongs</td> <td>1</td> </tr> <tr> <td>bool this is true if the IP address is</td> <td>1</td> </tr> <tr> <td>bool this is true if the IP address is a Tor</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Continent continent data for the</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Country Country data for the requested</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\MaxMind data related to your MaxMind</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Country Registered country</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\RepresentedCountry * Represented country data for the requested IP address. The represented</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Traits data for the traits of the</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\City city data for the requested IP</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Location location data for the</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Subdivision An object</td> <td>1</td> </tr> <tr> <td>\GeoIp2\Record\Postal postal data for the</td> <td>1</td> </tr> <tr> <td>array<\GeoIp2\Record\Subdivision> An array of \GeoIp2\Record\Subdivision</td> <td>1</td> </tr> <tr> <td>string|null the name of the ISP associated with the IP</td> <td>1</td> </tr> <tr> <td>string|null the name of the organization associated</td> <td>1</td> </tr> <tr> <td>string|null The name based on the locales list</td> <td>1</td> </tr> <tr> <td>array An array map where the keys are locale codes</td> <td>1</td> </tr> <tr> <td>int|null The GeoName ID for the location level. This attribute</td> <td>1</td> </tr> <tr> <td>string|null A two character continent code like "NA" (North</td> <td>1</td> </tr> <tr> <td>int|null The GeoName ID for the continent. This</td> <td>1</td> </tr> <tr> <td>bool This is true if the country is a</td> <td>1</td> </tr> <tr> <td>string|null The two-character ISO 3166-1 alpha code</td> <td>1</td> </tr> <tr> <td>int|null The average income in US dollars</td> <td>1</td> </tr> <tr> <td>int|null The approximate accuracy radius in</td> <td>1</td> </tr> <tr> <td>float|null The approximate latitude of the location</td> <td>1</td> </tr> <tr> <td>float|null The approximate longitude of the location</td> <td>1</td> </tr> <tr> <td>int|null The metro code of the location if the location</td> <td>1</td> </tr> <tr> <td>int|null The estimated population per square</td> <td>1</td> </tr> <tr> <td>string|null The time zone associated with location, as</td> <td>1</td> </tr> <tr> <td>int|null the number of remaining queries you</td> <td>1</td> </tr> <tr> <td>string|null The postal code of the location. Postal codes</td> <td>1</td> </tr> <tr> <td>string|null A string indicating the type of entity that is</td> <td>1</td> </tr> <tr> <td>string|null This is a string up to three characters long</td> <td>1</td> </tr> <tr> <td>int|null The autonomous system number</td> <td>1</td> </tr> <tr> <td>string|null The organization</td> <td>1</td> </tr> <tr> <td>string|null The IP address that the data in the model</td> <td>1</td> </tr> <tr> <td>bool This is true if the IP address belongs to an [anycast</td> <td>1</td> </tr> <tr> <td>bool This is true if the IP address belongs</td> <td>1</td> </tr> <tr> <td>bool This attribute is true if MaxMind</td> <td>1</td> </tr> <tr> <td>bool This is true if the IP address is a Tor</td> <td>1</td> </tr> <tr> <td>string|null The name of the ISP associated with the IP</td> <td>1</td> </tr> <tr> <td>string|null The network in CIDR notation associated with</td> <td>1</td> </tr> <tr> <td>string|null The name of the organization</td> <td>1</td> </tr> <tr> <td>float|null An indicator of how static or</td> <td>1</td> </tr> <tr> <td>int|null The estimated number of users sharing</td> <td>1</td> </tr> <tr> <td>string|null <p>The user type associated with the IP</td> <td>1</td> </tr> <tr> <td>array{stock:string[],referent:string} */</td> <td>1</td> </tr> <tr> <td>DoliDB */</td> <td>1</td> </tr> <tr> <td>string[]|null</td> <td>1</td> </tr> <tr> <td>RRuleIterator</td> <td>1</td> </tr> <tr> <td>string $context</td> <td>1</td> </tr> <tr> <td>int $cert_validation</td> <td>1</td> </tr> <tr> <td>array $options</td> <td>1</td> </tr> <tr> <td>string $transport</td> <td>1</td> </tr> <tr> <td>mixed[] $arguments</td> <td>1</td> </tr> <tr> <td>integer|null $uid</td> <td>1</td> </tr> <tr> <td>bool A flag that can be set a behavior that will cause this</td> <td>1</td> </tr> <tr> <td>string $url</td> <td>1</td> </tr> <tr> <td>bool $ajax should be used to open the url instead of a normal links</td> <td>1</td> </tr> <tr> <td>string $table_element Table name in SQL */</td> <td>2</td> </tr> <tr> <td>string $element Name of the element (tip for better integration in Dolibarr: this value should be the reflection of the class name with ucfirst() function) */</td> <td>2</td> </tr> <tr> <td>int ID of workstation</td> <td>2</td> </tr> <tr> <td>int[] array of ID</td> <td>2</td> </tr> <tr> <td>int ID of user author</td> <td>2</td> </tr> <tr> <td>int Currency ID</td> <td>2</td> </tr> <tr> <td>string multicurrency code</td> <td>2</td> </tr> <tr> <td>Societe Object that emits</td> <td>2</td> </tr> <tr> <td>int ID Duplicate of origin_id (using origin_id is better)</td> <td>2</td> </tr> <tr> <td>int ID Duplicate of fk_element</td> <td>2</td> </tr> <tr> <td>int ID Duplicate of origin_line_id</td> <td>2</td> </tr> <tr> <td>int ID Duplicate of fk_elementdet</td> <td>2</td> </tr> <tr> <td>string Widget type ('graph' means the widget is a graph widget)</td> <td>2</td> </tr> <tr> <td>string amount</td> <td>2</td> </tr> <tr> <td>string public $last_main_doc</td> <td>2</td> </tr> <tr> <td>int The environment ID when using a multicompany module</td> <td>2</td> </tr> <tr> <td>mixed Sample property 2</td> <td>2</td> </tr> <tr> <td>int line rank</td> <td>2</td> </tr> <tr> <td>int[]</td> <td>2</td> </tr> <tr> <td>string Clear password in memory</td> <td>2</td> </tr> <tr> <td>string Clear password in database (defined if DATABASE_PWD_ENCRYPTED=0)</td> <td>2</td> </tr> <tr> <td>string Encrypted password in database (always defined)</td> <td>2</td> </tr> <tr> <td>string company name</td> <td>2</td> </tr> <tr> <td>array array of socialnetworks</td> <td>2</td> </tr> <tr> <td>string gender</td> <td>2</td> </tr> <tr> <td>string zip code</td> <td>2</td> </tr> <tr> <td>string phone mobile</td> <td>2</td> </tr> <tr> <td>string user login</td> <td>2</td> </tr> <tr> <td>string Prospect level. ie: 'PL_LOW', 'PL...'</td> <td>2</td> </tr> <tr> <td>int Loan ID</td> <td>2</td> </tr> <tr> <td>string Field with ID of parent key if this field has a parent or for child tables</td> <td>2</td> </tr> <tr> <td>string String with name of icon for conferenceorbooth. Must be the part after the 'object_' into object_conferenceorbooth.png</td> <td>2</td> </tr> <tr> <td>int active</td> <td>2</td> </tr> <tr> <td>string pcg type</td> <td>2</td> </tr> <tr> <td>string account number</td> <td>2</td> </tr> <tr> <td>string subledger account</td> <td>2</td> </tr> <tr> <td>float FEC:Amount (Not necessary)</td> <td>2</td> </tr> <tr> <td>int accounting transaction id</td> <td>2</td> </tr> <tr> <td>float Amount</td> <td>2</td> </tr> <tr> <td>integer|string $date_modification;</td> <td>2</td> </tr> <tr> <td>integer|string $date_validation;</td> <td>2</td> </tr> <tr> <td>int Situation cycle reference number</td> <td>2</td> </tr> <tr> <td>int<0,6> From 1 to 6, or 0 if not found</td> <td>2</td> </tr> <tr> <td>string[] Array of error strings</td> <td>2</td> </tr> <tr> <td>string Type</td> <td>2</td> </tr> <tr> <td>CtyperesourceLine[] Lines</td> <td>2</td> </tr> <tr> <td>string Error message</td> <td>2</td> </tr> <tr> <td>string[] Array of error messages</td> <td>2</td> </tr> <tr> <td>string DB Error number</td> <td>2</td> </tr> <tr> <td>int The object identifier</td> <td>2</td> </tr> <tr> <td>int The environment ID when using a multicompany module</td> <td>2</td> </tr> <tr> <td>string Properties set and used by Agenda trigger</td> <td>2</td> </tr> <tr> <td>int State ID</td> <td>2</td> </tr> <tr> <td>User User author/creation</td> <td>2</td> </tr> <tr> <td>User User of validation</td> <td>2</td> </tr> <tr> <td>float Amount already paid from getSommePaiement() (used to show correct status)</td> <td>2</td> </tr> <tr> <td>string element type</td> <td>2</td> </tr> <tr> <td>string Multicurrency code</td> <td>2</td> </tr> <tr> <td>int Thirdparty ID</td> <td>2</td> </tr> <tr> <td>string Key for menu translation</td> <td>2</td> </tr> <tr> <td>int status 0=open, 1=closed</td> <td>2</td> </tr> <tr> <td>string email from</td> <td>2</td> </tr> <tr> <td>array<int,array<string,float>></td> <td>2</td> </tr> <tr> <td>Translate */</td> <td>2</td> </tr> <tr> <td>Form */</td> <td>2</td> </tr> <tr> <td>string[] $errors</td> <td>2</td> </tr> <tr> <td>string To store the FROM part of the line table of the SQL request</td> <td>2</td> </tr> <tr> <td>string filename</td> <td>2</td> </tr> <tr> <td>string error message</td> <td>2</td> </tr> <tr> <td>array<string,array{rank:int,width:float|int,title:array{textkey:string,label:string,align:string,padding:array{0:float,1:float,2:float,3:float}},content:array{align:string,padding:array{0:float,1:float,2:float,3:float}}}> Array of document table columns</td> <td>2</td> </tr> <tr> <td>int posxdatestart</td> <td>2</td> </tr> <tr> <td>int posxdateend</td> <td>2</td> </tr> <tr> <td>int Category of operation</td> <td>2</td> </tr> <tr> <td>int tab_top</td> <td>2</td> </tr> <tr> <td>string module name</td> <td>2</td> </tr> <tr> <td>string escape</td> <td>2</td> </tr> <tr> <td>string enclosure</td> <td>2</td> </tr> <tr> <td>string boxcode</td> <td>2</td> </tr> <tr> <td>string box img</td> <td>2</td> </tr> <tr> <td>array box dependencies</td> <td>2</td> </tr> <tr> <td>static object oldcopy</td> <td>2</td> </tr> <tr> <td>string Id of prelevement</td> <td>2</td> </tr> <tr> <td>string num_prelevement</td> <td>2</td> </tr> <tr> <td>double $amount</td> <td>2</td> </tr> <tr> <td>double $remise</td> <td>2</td> </tr> <tr> <td>int Previous situation line id reference</td> <td>2</td> </tr> <tr> <td>string The label of recurring invoice</td> <td>2</td> </tr> <tr> <td>string The label of recurring invoice</td> <td>2</td> </tr> <tr> <td>string Label of invoice</td> <td>2</td> </tr> <tr> <td>int ID</td> <td>2</td> </tr> <tr> <td>string Id of external payment mode</td> <td>2</td> </tr> <tr> <td>string Name of external payment mode</td> <td>2</td> </tr> <tr> <td>string Zipcode</td> <td>2</td> </tr> <tr> <td>string Name of subtable line</td> <td>2</td> </tr> <tr> <td>string Thirdparty ref of order</td> <td>2</td> </tr> <tr> <td>int Date of order</td> <td>2</td> </tr> <tr> <td>string payment url</td> <td>2</td> </tr> <tr> <td>integer|string datepaye</td> <td>2</td> </tr> <tr> <td>integer|string $date_modification</td> <td>2</td> </tr> <tr> <td>array errors</td> <td>2</td> </tr> <tr> <td>int Bank account ID</td> <td>2</td> </tr> <tr> <td>int Frequency</td> <td>2</td> </tr> <tr> <td>string Unit frequency</td> <td>2</td> </tr> <tr> <td>string String with name of icon for myobject.</td> <td>2</td> </tr> <tr> <td>string customer ref</td> <td>2</td> </tr> <tr> <td>FactureLigne</td> <td>2</td> </tr> <tr> <td>int Status</td> <td>2</td> </tr> <tr> <td>int bank account id of payment</td> <td>2</td> </tr> <tr> <td>int|string Date of payment</td> <td>2</td> </tr> <tr> <td>string keywords</td> <td>2</td> </tr> <tr> <td>int Status</td> <td>2</td> </tr> <tr> <td>ResponseInterface</td> <td>2</td> </tr> <tr> <td>PrincipalBackend\BackendInterface</td> <td>2</td> </tr> <tr> <td>\Sabre\DAV\Server</td> <td>2</td> </tr> <tr> <td>\DateTime</td> <td>2</td> </tr> <tr> <td>\DateTime|null</td> <td>2</td> </tr> <tr> <td>CalDAV\Backend\NotificationSupport</td> <td>2</td> </tr> <tr> <td>DateTimeZone</td> <td>2</td> </tr> <tr> <td>Component</td> <td>2</td> </tr> <tr> <td>VEVENT</td> <td>2</td> </tr> <tr> <td>resource[]</td> <td>2</td> </tr> <tr> <td>bool[]</td> <td>2</td> </tr> <tr> <td>UriInterface|null */</td> <td>2</td> </tr> <tr> <td>string The namespace prefix for this instance.</td> <td>2</td> </tr> <tr> <td>string The filesystem prefix to use for this instance</td> <td>2</td> </tr> <tr> <td>Calculation</td> <td>2</td> </tr> <tr> <td>Style</td> <td>2</td> </tr> <tr> <td>null|array</td> <td>2</td> </tr> <tr> <td>RichText</td> <td>2</td> </tr> <tr> <td>ReferenceHelper</td> <td>2</td> </tr> <tr> <td>Cells</td> <td>2</td> </tr> <tr> <td>Protection</td> <td>2</td> </tr> <tr> <td>AutoFilter</td> <td>2</td> </tr> <tr> <td>Axis</td> <td>2</td> </tr> <tr> <td>GridLines</td> <td>2</td> </tr> <tr> <td>array (blockId => nextBlockId)</td> <td>2</td> </tr> <tr> <td>int number of octets per block</td> <td>2</td> </tr> <tr> <td>OLE</td> <td>2</td> </tr> <tr> <td>CyclicReferenceStack</td> <td>2</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Shared\Escher</td> <td>2</td> </tr> <tr> <td>Swift_Transport</td> <td>2</td> </tr> <tr> <td>Swift_Transport[]</td> <td>2</td> </tr> <tr> <td>Swift_Plugins_Sleeper</td> <td>2</td> </tr> <tr> <td>Swift_CharacterStream</td> <td>2</td> </tr> <tr> <td>Swift_InputByteStream[]</td> <td>2</td> </tr> <tr> <td>Swift_Encoder</td> <td>2</td> </tr> <tr> <td>Swift_KeyCache_KeyCacheInputStream</td> <td>2</td> </tr> <tr> <td>Swift_Mime_Headers_ParameterizedHeader</td> <td>2</td> </tr> <tr> <td>bool should protected resources be shown to unauthenticated users?</td> <td>2</td> </tr> <tr> <td>bool should we use format as extension?</td> <td>2</td> </tr> <tr> <td>array all http methods specified here will be excluded from</td> <td>2</td> </tr> <tr> <td>bool should we group all the operations with the same url or not</td> <td>2</td> </tr> <tr> <td>Restler instance of restler</td> <td>2</td> </tr> <tr> <td>string when format is not used as the extension this property is</td> <td>2</td> </tr> <tr> <td>array configurable symbols to differentiate public, hybrid and</td> <td>2</td> </tr> <tr> <td>bool|stdClass</td> <td>2</td> </tr> <tr> <td>Restler</td> <td>2</td> </tr> <tr> <td>iFormat</td> <td>2</td> </tr> <tr> <td>null|callable if the api methods are under access control mechanism</td> <td>2</td> </tr> <tr> <td>string of name of the class that implements</td> <td>2</td> </tr> <tr> <td>string charset encoding defaults to UTF8</td> <td>2</td> </tr> <tr> <td>\Luracast\Restler\Restler</td> <td>2</td> </tr> <tr> <td>bool|string|callable</td> <td>2</td> </tr> <tr> <td>string $filename</td> <td>2</td> </tr> <tr> <td>string $id</td> <td>2</td> </tr> <tr> <td>string $printerName</td> <td>2</td> </tr> <tr> <td>string data which the printer will provide on next read</td> <td>2</td> </tr> <tr> <td>CarbonInterface</td> <td>2</td> </tr> <tr> <td>callable|null */</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Collection</td> <td>2</td> </tr> <tr> <td>\Illuminate\Contracts\Container\Container</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Testing\Fakes\BusFake</td> <td>2</td> </tr> <tr> <td>\Illuminate\Support\Enumerable</td> <td>2</td> </tr> <tr> <td>Client</td> <td>2</td> </tr> <tr> <td>int $type</td> <td>2</td> </tr> <tr> <td>array $attributes</td> <td>2</td> </tr> <tr> <td>string $mask</td> <td>2</td> </tr> <tr> <td>integer $part_number</td> <td>2</td> </tr> <tr> <td>Message $message */</td> <td>2</td> </tr> <tr> <td>false|resource */</td> <td>2</td> </tr> <tr> <td>Util\Set */</td> <td>2</td> </tr> <tr> <td>PDO */</td> <td>2</td> </tr> <tr> <td>array[] {</td> <td>2</td> </tr> <tr> <td>string $render_time_str</td> <td>2</td> </tr> <tr> <td>string $memory_str</td> <td>2</td> </tr> <tr> <td>string $xdebug_link</td> <td>2</td> </tr> <tr> <td>int Thirdparty ID</td> <td>2</td> </tr> <tr> <td>User</td> <td>2</td> </tr> <tr> <td>string Agenda event label</td> <td>2</td> </tr> <tr> <td>string Last error message</td> <td>2</td> </tr> <tr> <td>int user author id</td> <td>2</td> </tr> <tr> <td>int user mod id</td> <td>2</td> </tr> <tr> <td>array extraparams</td> <td>2</td> </tr> <tr> <td>array<int> Entity in table llx_user_group</td> <td>2</td> </tr> <tr> <td>string String with name of icon for inventory</td> <td>2</td> </tr> <tr> <td>string Customer reference</td> <td>2</td> </tr> <tr> <td>string Filename</td> <td>2</td> </tr> <tr> <td>int Id user</td> <td>2</td> </tr> <tr> <td>string[] List of child tables. To know object to delete on cascade.</td> <td>2</td> </tr> <tr> <td>int ID warehouse</td> <td>2</td> </tr> <tr> <td>integer|string Effective delivery date</td> <td>2</td> </tr> <tr> <td>Task $task {@type Task}</td> <td>2</td> </tr> <tr> <td>int Date start</td> <td>2</td> </tr> <tr> <td>int Date end</td> <td>2</td> </tr> <tr> <td>int Modification date</td> <td>2</td> </tr> <tr> <td>array<string,string[]> List of child tables. To test if we can delete object.</td> <td>2</td> </tr> <tr> <td>string[] List of child tables. To know object to delete on cascade.</td> <td>2</td> </tr> <tr> <td>int Contract ID</td> <td>2</td> </tr> <tr> <td>int Date of intervention</td> <td>2</td> </tr> <tr> <td>int origin line ID</td> <td>2</td> </tr> <tr> <td>Form Instance of the Form</td> <td>2</td> </tr> <tr> <td>CommonObject Object</td> <td>2</td> </tr> <tr> <td>string Title key to translate</td> <td>2</td> </tr> <tr> <td>string Title desc key to translate</td> <td>2</td> </tr> <tr> <td>FormCardWebPortal Form for card</td> <td>2</td> </tr> <tr> <td>bool this is true if the IP address belongs to</td> <td>2</td> </tr> <tr> <td>int|null the autonomous system number</td> <td>2</td> </tr> <tr> <td>string|null the organization</td> <td>2</td> </tr> <tr> <td>string|null The connection type may take the</td> <td>2</td> </tr> <tr> <td>string|null The second level domain associated with the</td> <td>2</td> </tr> <tr> <td>string|null The [mobile country code</td> <td>2</td> </tr> <tr> <td>string|null The [mobile network code</td> <td>2</td> </tr> <tr> <td>int|null A value from 0-100 indicating MaxMind's</td> <td>2</td> </tr> <tr> <td>bool This is true if the IP address belongs to</td> <td>2</td> </tr> <tr> <td>Message[] $messages</td> <td>2</td> </tr> <tr> <td>Folder[] $folders</td> <td>2</td> </tr> <tr> <td>boolean $state</td> <td>2</td> </tr> <tr> <td>bool ajax</td> <td>2</td> </tr> <tr> <td>integer|string</td> <td>3</td> </tr> <tr> <td>integer|string date_valid</td> <td>3</td> </tr> <tr> <td>int Id of product</td> <td>3</td> </tr> <tr> <td>string product description</td> <td>3</td> </tr> <tr> <td>string import_key</td> <td>3</td> </tr> <tr> <td>string Name of table without prefix where object is stored</td> <td>3</td> </tr> <tr> <td>string Description</td> <td>3</td> </tr> <tr> <td>string fullname</td> <td>3</td> </tr> <tr> <td>string Thirdparty name</td> <td>3</td> </tr> <tr> <td>static</td> <td>3</td> </tr> <tr> <td>integer|string date_modification</td> <td>3</td> </tr> <tr> <td>int rowid</td> <td>3</td> </tr> <tr> <td>int position</td> <td>3</td> </tr> <tr> <td>string error</td> <td>3</td> </tr> <tr> <td>int country id</td> <td>3</td> </tr> <tr> <td>int Id User modifying</td> <td>3</td> </tr> <tr> <td>int|null ID of the unit of measurement (rowid in llx_c_units table)</td> <td>3</td> </tr> <tr> <td>int Service Workstation</td> <td>3</td> </tr> <tr> <td>string Label</td> <td>3</td> </tr> <tr> <td>CommonObject</td> <td>3</td> </tr> <tr> <td>int Project ID</td> <td>3</td> </tr> <tr> <td>string module description</td> <td>3</td> </tr> <tr> <td>string Code of driver</td> <td>3</td> </tr> <tr> <td>string ref supplier</td> <td>3</td> </tr> <tr> <td>CommonInvoiceLine[]</td> <td>3</td> </tr> <tr> <td>array<float|int></td> <td>3</td> </tr> <tr> <td>integer|string paiementtype</td> <td>3</td> </tr> <tr> <td>int availability ID</td> <td>3</td> </tr> <tr> <td>DAVACL\PrincipalBackend\BackendInterface</td> <td>3</td> </tr> <tr> <td>int|null</td> <td>3</td> </tr> <tr> <td>\PDO</td> <td>3</td> </tr> <tr> <td>DateTimeInterface|null</td> <td>3</td> </tr> <tr> <td>Document</td> <td>3</td> </tr> <tr> <td>callable[]</td> <td>3</td> </tr> <tr> <td>object|TokenInterface</td> <td>3</td> </tr> <tr> <td>Style[]</td> <td>3</td> </tr> <tr> <td>array of DataSeriesValues</td> <td>3</td> </tr> <tr> <td>Layout</td> <td>3</td> </tr> <tr> <td>Title</td> <td>3</td> </tr> <tr> <td>Font</td> <td>3</td> </tr> <tr> <td>float[]</td> <td>3</td> </tr> <tr> <td>\PhpOffice\PhpSpreadsheet\Writer\Xls\Parser</td> <td>3</td> </tr> <tr> <td>EmailLexer</td> <td>3</td> </tr> <tr> <td>EmailValidator</td> <td>3</td> </tr> <tr> <td>\Symfony\Component\Translation\TranslatorInterface</td> <td>3</td> </tr> <tr> <td>\Illuminate\Contracts\Foundation\Application</td> <td>3</td> </tr> <tr> <td>string $raw</td> <td>3</td> </tr> <tr> <td>Header $header</td> <td>3</td> </tr> <tr> <td>mixed */</td> <td>3</td> </tr> <tr> <td>null|string */</td> <td>3</td> </tr> <tr> <td>int Creation date</td> <td>3</td> </tr> <tr> <td>string Field with ID of parent key if this object has a parent</td> <td>3</td> </tr> <tr> <td>DoliDB Database</td> <td>3</td> </tr> <tr> <td>FormListWebPortal Form for list</td> <td>3</td> </tr> <tr> <td>bool This is true if the IP address is</td> <td>3</td> </tr> <tr> <td>integer $uid</td> <td>3</td> </tr> <tr> <td>string Customer ref</td> <td>4</td> </tr> <tr> <td>array<string,array{rank:int,width:float|int,title:array{textkey:string,label:string,align:string,padding:array{0:float,1:float,2:float,3:float}},content:array{align:string,padding:array{0:float,1:float,2:float,3:float}}}> Array of columns</td> <td>4</td> </tr> <tr> <td>string Town</td> <td>4</td> </tr> <tr> <td>int user ID</td> <td>4</td> </tr> <tr> <td>int Bank ID</td> <td>4</td> </tr> <tr> <td>string ref</td> <td>4</td> </tr> <tr> <td>string Error string</td> <td>4</td> </tr> <tr> <td>int status</td> <td>4</td> </tr> <tr> <td>string Name of subtable class that manage subtable lines</td> <td>4</td> </tr> <tr> <td>string[] Array of Error code (or message)</td> <td>4</td> </tr> <tr> <td>string Label</td> <td>4</td> </tr> <tr> <td>DoliDB Database handler (result of a new DoliDB)</td> <td>4</td> </tr> <tr> <td>string url</td> <td>4</td> </tr> <tr> <td>int<0,1></td> <td>4</td> </tr> <tr> <td>int timestamp</td> <td>4</td> </tr> <tr> <td>bool Situation invoice type</td> <td>4</td> </tr> <tr> <td>?string */</td> <td>4</td> </tr> <tr> <td>string Field with ID of parent key if this field has a parent</td> <td>4</td> </tr> <tr> <td>string Firstname Lastname</td> <td>4</td> </tr> <tr> <td>PDO</td> <td>4</td> </tr> <tr> <td>Server</td> <td>4</td> </tr> <tr> <td>Sharee[]</td> <td>4</td> </tr> <tr> <td>DateTimeImmutable</td> <td>4</td> </tr> <tr> <td>DateTimeInterface</td> <td>4</td> </tr> <tr> <td>object</td> <td>4</td> </tr> <tr> <td>null|int</td> <td>4</td> </tr> <tr> <td>array all paths beginning with any of the following will be excluded</td> <td>4</td> </tr> <tr> <td>array $buffer</td> <td>4</td> </tr> <tr> <td>string|callable|null</td> <td>4</td> </tr> <tr> <td>array Each array element in the return is an associative array with keys</td> <td>4</td> </tr> <tr> <td>string code</td> <td>4</td> </tr> <tr> <td>string Action</td> <td>4</td> </tr> <tr> <td>\Rector\Core\NodeManipulator\BinaryOpManipulator</td> <td>4</td> </tr> <tr> <td>string type</td> <td>5</td> </tr> <tr> <td>Societe</td> <td>5</td> </tr> <tr> <td>array{0:int,1:int} Minimum version of PHP required by module.</td> <td>5</td> </tr> <tr> <td>int The environment ID when using a multicompany module</td> <td>5</td> </tr> <tr> <td>string Address</td> <td>5</td> </tr> <tr> <td>integer|string date_validation</td> <td>5</td> </tr> <tr> <td>int Deadline for payment</td> <td>5</td> </tr> <tr> <td>string import key</td> <td>5</td> </tr> <tr> <td>float */</td> <td>5</td> </tr> <tr> <td>string title</td> <td>5</td> </tr> <tr> <td>bool|null</td> <td>5</td> </tr> <tr> <td>array of string</td> <td>5</td> </tr> <tr> <td>mixed[]</td> <td>5</td> </tr> <tr> <td>InvalidEmail|null</td> <td>5</td> </tr> <tr> <td>string $name</td> <td>5</td> </tr> <tr> <td>\Closure</td> <td>5</td> </tr> <tr> <td>array $config</td> <td>5</td> </tr> <tr> <td>string the IP address that the data in the model is</td> <td>5</td> </tr> <tr> <td>string The network in CIDR notation associated with</td> <td>5</td> </tr> <tr> <td>array of int</td> <td>5</td> </tr> <tr> <td>string email</td> <td>6</td> </tr> <tr> <td>DoliDB Database handler</td> <td>6</td> </tr> <tr> <td>string[] Array of error strings</td> <td>6</td> </tr> <tr> <td>array[]</td> <td>6</td> </tr> <tr> <td>bool */</td> <td>6</td> </tr> <tr> <td>null|string</td> <td>6</td> </tr> <tr> <td>Color</td> <td>6</td> </tr> <tr> <td>callable</td> <td>7</td> </tr> <tr> <td>string picto</td> <td>7</td> </tr> <tr> <td>float|int</td> <td>7</td> </tr> <tr> <td>DoliDB</td> <td>7</td> </tr> <tr> <td>string ID</td> <td>7</td> </tr> <tr> <td>array */</td> <td>7</td> </tr> <tr> <td>HashTable</td> <td>7</td> </tr> <tr> <td>int|string date</td> <td>8</td> </tr> <tr> <td>string[] List of child tables. To know object to delete on cascade.</td> <td>8</td> </tr> <tr> <td>string */</td> <td>8</td> </tr> <tr> <td>array<string, array<string>> List of child tables. To test if we can delete object.</td> <td>8</td> </tr> <tr> <td>string Fieldname with ID of parent key if this field has a parent</td> <td>9</td> </tr> <tr> <td>int special code</td> <td>9</td> </tr> <tr> <td>int Save the name of generated file as the main doc when generating a doc with this template</td> <td>10</td> </tr> <tr> <td>Backend\BackendInterface</td> <td>10</td> </tr> <tr> <td>Spreadsheet</td> <td>10</td> </tr> <tr> <td>Border</td> <td>10</td> </tr> <tr> <td>double</td> <td>11</td> </tr> <tr> <td>string Payment reference</td> <td>11</td> </tr> <tr> <td>DAV\Server</td> <td>11</td> </tr> <tr> <td>int User ID</td> <td>12</td> </tr> <tr> <td>int Status</td> <td>12</td> </tr> <tr> <td>string Id to identify managed objects</td> <td>12</td> </tr> <tr> <td>int */</td> <td>12</td> </tr> <tr> <td>resource</td> <td>12</td> </tr> <tr> <td>array|null</td> <td>12</td> </tr> <tr> <td>Worksheet</td> <td>12</td> </tr> <tr> <td>int Thirdparty ID</td> <td>13</td> </tr> <tr> <td>array of mixed</td> <td>13</td> </tr> <tr> <td>string Dolibarr version of the loaded document</td> <td>14</td> </tr> <tr> <td>int Save the name of generated file as the main doc when generating a doc with this template</td> <td>14</td> </tr> <tr> <td>string Ref</td> <td>15</td> </tr> <tr> <td>string label</td> <td>16</td> </tr> <tr> <td>boolean</td> <td>16</td> </tr> <tr> <td>array<string, string></td> <td>17</td> </tr> <tr> <td>string Field with ID of parent key if this field has a parent</td> <td>19</td> </tr> <tr> <td>int|string</td> <td>19</td> </tr> <tr> <td>string Name of subtable line</td> <td>20</td> </tr> <tr> <td>integer|string date_creation</td> <td>24</td> </tr> <tr> <td>string Nom du modele</td> <td>24</td> </tr> <tr> <td>string Error message</td> <td>25</td> </tr> <tr> <td>string description</td> <td>25</td> </tr> <tr> <td>string[] Error codes (or messages)</td> <td>25</td> </tr> <tr> <td>string|null</td> <td>25</td> </tr> <tr> <td>array $FIELDS Mandatory fields, checked when create and update object</td> <td>27</td> </tr> <tr> <td>int Entity</td> <td>27</td> </tr> <tr> <td>string ID to identify managed object.</td> <td>28</td> </tr> <tr> <td>string Name of table without prefix where object is stored. This is also the key used for extrafields management.</td> <td>30</td> </tr> <tr> <td>string document type</td> <td>30</td> </tr> <tr> <td>string ID of module.</td> <td>31</td> </tr> <tr> <td>string name</td> <td>32</td> </tr> <tr> <td>string model description (short text)</td> <td>32</td> </tr> <tr> <td>mixed</td> <td>33</td> </tr> <tr> <td>DoliDB Database handler</td> <td>36</td> </tr> <tr> <td>string[]</td> <td>40</td> </tr> <tr> <td>integer</td> <td>54</td> </tr> <tr> <td>string model name</td> <td>55</td> </tr> <tr> <td>string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png</td> <td>67</td> </tr> <tr> <td>float</td> <td>68</td> </tr> <tr> <td>array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.</td> <td>76</td> </tr> <tr> <td>DoliDB Database handler.</td> <td>80</td> </tr> <tr> <td>string ID to identify managed object</td> <td>101</td> </tr> <tr> <td>string Error code (or message)</td> <td>113</td> </tr> <tr> <td>string Name of table without prefix where object is stored</td> <td>125</td> </tr> <tr> <td>bool</td> <td>174</td> </tr> <tr> <td>int ID</td> <td>204</td> </tr> <tr> <td>array</td> <td>398</td> </tr> <tr> <td>int</td> <td>401</td> </tr> <tr> <td>string</td> <td>856</td> </tr> <tr> <td rowspan="29" style="vertical-align: top;">@version</td> <td>4.9.005</td> <td>1</td> </tr> <tr> <td>1.0</td> <td>1</td> </tr> <tr> <td>1.0.15</td> <td>1</td> </tr> <tr> <td>6.3.2</td> <td>1</td> </tr> <tr> <td>1.1.2</td> <td>1</td> </tr> <tr> <td>1.1.1</td> <td>1</td> </tr> <tr> <td>1.1.0</td> <td>1</td> </tr> <tr> <td>1.0.010</td> <td>1</td> </tr> <tr> <td>1.8</td> <td>1</td> </tr> <tr> <td>1.2</td> <td>1</td> </tr> <tr> <td>1.4.5 (last update 2013-04-07)</td> <td>1</td> </tr> <tr> <td>1.5.0</td> <td>1</td> </tr> <tr> <td>1.4</td> <td>1</td> </tr> <tr> <td>2.8.41</td> <td>1</td> </tr> <tr> <td>1.0.015</td> <td>2</td> </tr> <tr> <td>1.0.027</td> <td>2</td> </tr> <tr> <td>1.0.004</td> <td>2</td> </tr> <tr> <td>1.0.005</td> <td>2</td> </tr> <tr> <td>3.0.0rc5</td> <td>2</td> </tr> <tr> <td>3.1.0</td> <td>2</td> </tr> <tr> <td>$Id: class.wsdlcache.php,v 1.7 2007/04/17 16:34:03 snichol Exp $</td> <td>2</td> </tr> <tr> <td>CVS: $Id$</td> <td>2</td> </tr> <tr> <td>1.3</td> <td>3</td> </tr> <tr> <td>1.0.001</td> <td>4</td> </tr> <tr> <td>$Id: nusoapmime.php,v 1.13 2010/04/26 20:15:08 snichol Exp $</td> <td>4</td> </tr> <tr> <td>Release: @package_version@</td> <td>4</td> </tr> <tr> <td>1.1</td> <td>5</td> </tr> <tr> <td>3.0.0rc6</td> <td>6</td> </tr> <tr> <td>$Id: nusoap.php,v 1.123 2010/04/26 20:15:08 snichol Exp $</td> <td>18</td> </tr></table> </div> </div> </div> </div> </section> <!-- /.content --> </div> </div> <!-- /.content-wrapper --> <!-- Main Footer --> <footer class="main-footer"> <!-- To the right --> <div class="pull-right hidden-xs"> <span class="logo-exakat"> <img src="images/logo.png" alt="Exakat"> An <a href="https://www.exakat.io" title="exakat">Exakat</a> report </span> </div> <!-- Default to the left --> <strong>.</strong> </footer> <!-- Control Sidebar --> <aside class="control-sidebar control-sidebar-dark"> <!-- Create the tabs --> <ul class="nav nav-tabs nav-justified control-sidebar-tabs"> <li class="active"><a href="#control-sidebar-home-tab" data-toggle="tab"><i class="fa fa-home"></i></a></li> <li><a href="#control-sidebar-settings-tab" data-toggle="tab"><i class="fa fa-gears"></i></a></li> </ul> </aside> <!-- /.control-sidebar --> <!-- Add the sidebar's background. This div must be placed immediately after the control sidebar --> <div class="control-sidebar-bg"></div> </div> <!-- ./wrapper --> <script src="scripts/vendor.js"></script> <script src="scripts/exakat.js"></script> <script src="scripts/facetedsearch.js"></script> </body> </html>