dolibarr
9.0.0
|
Class to manage proposals. More...
Public Member Functions | |
__construct ($db, $socid="", $propalid=0) | |
Constructor. More... | |
add_product ($idproduct, $qty, $remise_percent=0) | |
Add line into array products $this->thirdparty should be loaded. More... | |
insert_discount ($idremise) | |
Adding line of fixed discount in the proposal in DB. More... | |
addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $fk_product=0, $remise_percent=0.0, $price_base_type='HT', $pu_ttc=0.0, $info_bits=0, $type=0, $rang=-1, $special_code=0, $fk_parent_line=0, $fk_fournprice=0, $pa_ht=0, $label='', $date_start='', $date_end='', $array_options=0, $fk_unit=null, $origin='', $origin_id=0, $pu_ht_devise=0, $fk_remise_except=0) | |
Add a proposal line into database (linked to product/service or not) The parameters are already supposed to be appropriate and with final values to the call of this method. More... | |
updateline ($rowid, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=0, $pa_ht=0, $label='', $type=0, $date_start='', $date_end='', $array_options=0, $fk_unit=null, $pu_ht_devise=0, $notrigger=0) | |
Update a proposal line. More... | |
deleteline ($lineid) | |
Delete detail line. More... | |
create ($user, $notrigger=0) | |
Create commercial proposal into database this->ref can be set or empty. More... | |
create_from ($user) | |
Insert into DB a proposal object completely defined by its data members (ex, results from copy). More... | |
createFromClone ($socid=0) | |
Load an object from its id and create a new one in database. More... | |
fetch ($rowid, $ref='') | |
Load a proposal from database and its ligne array. More... | |
update (User $user, $notrigger=0) | |
Update database. More... | |
fetch_lines ($only_product=0) | |
Load array lines. More... | |
valid ($user, $notrigger=0) | |
Set status to validated. More... | |
set_date ($user, $date, $notrigger=0) | |
Define proposal date. More... | |
set_echeance ($user, $date_fin_validite, $notrigger=0) | |
Define end validity date. More... | |
set_date_livraison ($user, $date_livraison, $notrigger=0) | |
Set delivery date. More... | |
set_availability ($user, $id, $notrigger=0) | |
Set delivery. More... | |
set_demand_reason ($user, $id, $notrigger=0) | |
Set source of demand. More... | |
set_ref_client ($user, $ref_client, $notrigger=0) | |
Set customer reference number. More... | |
set_remise_percent ($user, $remise, $notrigger=0) | |
Set an overall discount on the proposal. More... | |
set_remise_absolue ($user, $remise, $notrigger=0) | |
Set an absolute overall discount on the proposal. More... | |
reopen ($user, $statut, $note='', $notrigger=0) | |
Reopen the commercial proposal. More... | |
cloture ($user, $statut, $note="", $notrigger=0) | |
Close the commercial proposal. More... | |
classifyBilled (User $user, $notrigger=0) | |
Class invoiced the Propal. More... | |
set_draft ($user, $notrigger=0) | |
Set draft status. More... | |
liste_array ($shortlist=0, $draft=0, $notcurrentuser=0, $socid=0, $limit=0, $offset=0, $sortfield='p.datep', $sortorder='DESC') | |
Return list of proposal (eventually filtered on user) into an array. More... | |
getInvoiceArrayList () | |
Returns an array with the numbers of related invoices. More... | |
InvoiceArrayList ($id) | |
Returns an array with id and ref of related invoices. More... | |
delete ($user, $notrigger=0) | |
Delete proposal. More... | |
availability ($availability_id, $notrigger=0) | |
Change the delivery time. More... | |
demand_reason ($demand_reason_id, $notrigger=0) | |
Change source demand. More... | |
info ($id) | |
Object Proposal Information. More... | |
getLibStatut ($mode=0) | |
Return label of status of proposal (draft, validated, ...) More... | |
LibStatut ($statut, $mode=1) | |
Return label of a status (draft, validated, ...) More... | |
load_board ($user, $mode) | |
Load indicators for dashboard (this->nbtodo and this->nbtodolate) More... | |
initAsSpecimen () | |
Initialise an instance with random values. More... | |
load_state_board () | |
Charge indicateurs this->nb de tableau de bord. More... | |
getNextNumRef ($soc) | |
Returns the reference to the following non used Proposal used depending on the active numbering module defined into PROPALE_ADDON. More... | |
getNomUrl ($withpicto=0, $option='', $get_params='', $notooltip=0, $save_lastsearch_value=-1) | |
Return clicable link of object (with eventually picto) More... | |
getLinesArray () | |
Retrieve an array of proposal lines. More... | |
generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null) | |
Create a document onto disk according to template module. More... | |
![]() | |
errorsToString () | |
Method to output saved errors. More... | |
getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0) | |
Return full name (civility+' '+name+' '+lastname) More... | |
getFullAddress ($withcountry=0, $sep="\, $withregion=0) | |
Return full address of contact. More... | |
getBannerAddress ($htmlkey, $object) | |
Return full address for banner. More... | |
getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0) | |
Return the link of last main doc file for direct public download. More... | |
add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0) | |
Add a link between element $this->element and a contact. More... | |
copy_linked_contact ($objFrom, $source='internal') | |
Copy contact from one element to current. More... | |
update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0) | |
Update a link to contact line. More... | |
delete_contact ($rowid, $notrigger=0) | |
Delete a link to contact line. More... | |
delete_linked_contact ($source='', $code='') | |
Delete all links between an object $this and all its contacts. More... | |
liste_contact ($statut=-1, $source='external', $list=0, $code='') | |
Get array of all contacts for an object. More... | |
swapContactStatus ($rowid) | |
Update status of a contact linked to object. More... | |
liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='') | |
Return array with list of possible values for type of contacts. More... | |
getIdContact ($source, $code, $status=0) | |
Return id of contacts for a source and a contact code. More... | |
fetch_contact ($contactid=null) | |
Load object contact with id=$this->contactid into $this->contact. More... | |
fetch_thirdparty ($force_thirdparty_id=0) | |
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More... | |
fetchOneLike ($ref) | |
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More... | |
fetch_barcode () | |
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More... | |
fetch_projet () | |
Load the project with id $this->fk_project into this->project. More... | |
fetch_product () | |
Load the product with id $this->fk_product into this->product. More... | |
fetch_user ($userid) | |
Load the user with id $userid into this->user. More... | |
fetch_origin () | |
Read linked origin object. More... | |
fetchObjectFrom ($table, $field, $key, $element=null) | |
Load object from specific field. More... | |
getValueFrom ($table, $id, $field) | |
Getter generic. More... | |
setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif') | |
Setter generic. More... | |
load_previous_next_ref ($filter, $fieldid, $nodbprefix=0) | |
Load properties id_previous and id_next by comparing $fieldid with $this->ref. More... | |
getListContactId ($source='external') | |
Return list of id of contacts of object. More... | |
setProject ($projectid) | |
Link element with a project. More... | |
setPaymentMethods ($id) | |
Change the payments methods. More... | |
setMulticurrencyCode ($code) | |
Change the multicurrency code. More... | |
setMulticurrencyRate ($rate, $mode=1) | |
Change the multicurrency rate. More... | |
setPaymentTerms ($id) | |
Change the payments terms. More... | |
setDeliveryAddress ($id) | |
Define delivery address. More... | |
setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null) | |
Change the shipping method. More... | |
setWarehouse ($warehouse_id) | |
Change the warehouse. More... | |
setDocModel ($user, $modelpdf) | |
Set last model used by doc generator. More... | |
setBankAccount ($fk_account, $notrigger=false, $userused=null) | |
Change the bank account. More... | |
line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true) | |
Save a new position (field rang) for details lines. More... | |
getChildrenOfLine ($id) | |
Get children of line. More... | |
line_up ($rowid, $fk_parent_line=true) | |
Update a line to have a lower rank. More... | |
line_down ($rowid, $fk_parent_line=true) | |
Update a line to have a higher rank. More... | |
updateRangOfLine ($rowid, $rang) | |
Update position of line (rang) More... | |
line_ajaxorder ($rows) | |
Update position of line with ajax (rang) More... | |
updateLineUp ($rowid, $rang) | |
Update position of line up (rang) More... | |
updateLineDown ($rowid, $rang, $max) | |
Update position of line down (rang) More... | |
getRangOfLine ($rowid) | |
Get position of line (rang) More... | |
getIdOfLine ($rang) | |
Get rowid of the line relative to its position. More... | |
line_max ($fk_parent_line=0) | |
Get max value used for position of line (rang) More... | |
update_ref_ext ($ref_ext) | |
Update external ref of element. More... | |
update_note ($note, $suffix='') | |
Update note of element. More... | |
update_note_public ($note) | |
Update public note (kept for backward compatibility) More... | |
update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null) | |
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More... | |
add_object_linked ($origin=null, $origin_id=null) | |
Add objects linked in llx_element_element. More... | |
fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1) | |
Fetch array of objects linked to current object (object of enabled modules only). More... | |
updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='') | |
Update object linked of a current object. More... | |
deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='') | |
Delete all links between an object $this. More... | |
setStatut ($status, $elementId=null, $elementType='', $trigkey='') | |
Set status of an object. More... | |
getCanvas ($id=0, $ref='') | |
Load type of canvas of an object if it exists. More... | |
getSpecialCode ($lineid) | |
Get special code of a line. More... | |
isObjectUsed ($id=0) | |
Function to check if an object is used by others. More... | |
hasProductsOrServices ($predefined=-1) | |
Function to say how many lines object contains. More... | |
getTotalDiscount () | |
Function that returns the total amount HT of discounts applied for all lines. More... | |
getTotalWeightVolume () | |
Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More... | |
setExtraParameters () | |
Set extra parameters. More... | |
display_incoterms () | |
Return incoterms informations TODO Use a cache for label get. More... | |
getIncotermsForPDF () | |
Return incoterms informations for pdf display. More... | |
setIncoterms ($id_incoterm, $location) | |
Define incoterms values of current object. More... | |
formAddObjectLine ($dateSelector, $seller, $buyer) | |
Show add free and predefined products/services form. More... | |
printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0) | |
Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More... | |
printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0) | |
Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More... | |
printOriginLinesList ($restrictlist='') | |
Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More... | |
printOriginLine ($line, $var, $restrictlist='') | |
Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More... | |
add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0) | |
Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More... | |
delete_resource ($rowid, $element, $notrigger=0) | |
Delete a link to resource line. More... | |
__clone () | |
Overwrite magic function to solve problem of cloning object that are kept as references. More... | |
addThumbs ($file) | |
Build thumb Move this into files.lib.php. More... | |
getDefaultCreateValueFor ($fieldname, $alternatevalue=null) | |
Return the default value to use for a field when showing the create form of object. More... | |
call_trigger ($trigger_name, $user) | |
Call trigger based on this instance. More... | |
fetch_optionals ($rowid=null, $optionsArray=null) | |
Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More... | |
deleteExtraFields () | |
Delete all extra fields values for the current object. More... | |
insertExtraFields ($trigger='', $userused=null) | |
Add/Update all extra fields values for the current object. More... | |
updateExtraField ($key, $trigger=null, $userused=null) | |
Update an extra field value for the current object. More... | |
showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0) | |
Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More... | |
showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0) | |
Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More... | |
showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0) | |
Function to show lines of extrafields with output datas. More... | |
getRights () | |
Returns the rights used for this class. More... | |
defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0) | |
Get buy price to use for margin calculation. More... | |
show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0) | |
Show photos of an object (nbmax maximum), into several columns. More... | |
isDate ($info) | |
Function test if type is date. More... | |
isInt ($info) | |
Function test if type is integer. More... | |
isFloat ($info) | |
Function test if type is float. More... | |
isText ($info) | |
Function test if type is text. More... | |
createCommon (User $user, $notrigger=false) | |
Create object into database. More... | |
fetchCommon ($id, $ref=null, $morewhere='') | |
Load object in memory from the database. More... | |
updateCommon (User $user, $notrigger=false) | |
Update object into database. More... | |
deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0) | |
Delete object in database. More... | |
initAsSpecimenCommon () | |
Initialise object with example values Id must be 0 if object instance is a specimen. More... | |
fetchComments () | |
Load comments linked with current task. More... | |
getNbComments () | |
Return nb comments already posted. More... | |
trimParameters ($parameters) | |
Trim object parameters. More... | |
Static Public Member Functions | |
static | replaceThirdparty (DoliDB $db, $origin_id, $dest_id) |
Function used to replace a thirdparty id with another one. More... | |
![]() | |
static | isExistingObject ($element, $id, $ref='', $ref_ext='') |
Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More... | |
static | commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
Function used to replace a thirdparty id with another one. More... | |
Public Attributes | |
$datec | |
$datev | |
$datep | |
$price | |
$tva | |
$total | |
const | STATUS_DRAFT = 0 |
Draft status. | |
const | STATUS_VALIDATED = 1 |
Validated status. | |
const | STATUS_SIGNED = 2 |
Signed quote. | |
const | STATUS_NOTSIGNED = 3 |
Not signed quote. | |
const | STATUS_BILLED = 4 |
Billed or processed quote. | |
![]() | |
$projet | |
$note | |
Protected Attributes | |
$table_ref_field = 'ref' | |
{} | |
Additional Inherited Members | |
![]() | |
commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
Common function for all objects extending CommonObject for generating documents. More... | |
isArray ($info) | |
Function test if type is array. More... | |
isNull ($info) | |
Function test if type is null. More... | |
isIndex ($info) | |
Function test if is indexed. More... | |
setSaveQuery () | |
Function to prepare the values to insert. More... | |
setVarsFromFetchObj (&$obj) | |
Function to load data from a SQL pointer into properties of current object $this. More... | |
getFieldList () | |
Function to concat keys of fields. More... | |
quote ($value, $fieldsentry) | |
Add quote to field value if necessary. More... | |
Class to manage proposals.
Definition at line 48 of file propal.class.php.
Propal::__construct | ( | $db, | |
$socid = "" , |
|||
$propalid = 0 |
|||
) |
Constructor.
Definition at line 242 of file propal.class.php.
Propal::add_product | ( | $idproduct, | |
$qty, | |||
$remise_percent = 0 |
|||
) |
Add line into array products $this->thirdparty should be loaded.
int | $idproduct | Product Id to add |
int | $qty | Quantity |
int | $remise_percent | Discount effected on Product |
TODO Replace calls to this function by generation objet Ligne inserted into table $this->products
Definition at line 270 of file propal.class.php.
Propal::addline | ( | $desc, | |
$pu_ht, | |||
$qty, | |||
$txtva, | |||
$txlocaltax1 = 0.0 , |
|||
$txlocaltax2 = 0.0 , |
|||
$fk_product = 0 , |
|||
$remise_percent = 0.0 , |
|||
$price_base_type = 'HT' , |
|||
$pu_ttc = 0.0 , |
|||
$info_bits = 0 , |
|||
$type = 0 , |
|||
$rang = -1 , |
|||
$special_code = 0 , |
|||
$fk_parent_line = 0 , |
|||
$fk_fournprice = 0 , |
|||
$pa_ht = 0 , |
|||
$label = '' , |
|||
$date_start = '' , |
|||
$date_end = '' , |
|||
$array_options = 0 , |
|||
$fk_unit = null , |
|||
$origin = '' , |
|||
$origin_id = 0 , |
|||
$pu_ht_devise = 0 , |
|||
$fk_remise_except = 0 |
|||
) |
Add a proposal line into database (linked to product/service or not) The parameters are already supposed to be appropriate and with final values to the call of this method.
Also, for the VAT rate, it must have already been defined by whose calling the method get_default_tva (societe_vendeuse, societe_acheteuse, '' product) and desc must already have the right value (it's up to the caller to manage multilanguage)
string | $desc | Description of line |
float | $pu_ht | Unit price |
float | $qty | Quantity |
float | $txtva | Force Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)') |
float | $txlocaltax1 | Local tax 1 rate (deprecated, use instead txtva with code inside) |
float | $txlocaltax2 | Local tax 2 rate (deprecated, use instead txtva with code inside) |
int | $fk_product | Id du produit/service predefini |
float | $remise_percent | Pourcentage de remise de la ligne |
string | $price_base_type | HT or TTC |
float | $pu_ttc | Prix unitaire TTC |
int | $info_bits | Bits de type de lignes |
int | $type | Type of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used. |
int | $rang | Position of line |
int | $special_code | Special code (also used by externals modules!) |
int | $fk_parent_line | Id of parent line |
int | $fk_fournprice | Id supplier price |
int | $pa_ht | Buying price without tax |
string | $label | ??? |
int | $date_start | Start date of the line |
int | $date_end | End date of the line |
array | $array_options | extrafields array |
string | $fk_unit | Code of the unit to use. Null to use the default one |
string | $origin | 'order', ... |
int | $origin_id | Id of origin object |
double | $pu_ht_devise | Unit price in currency |
int | $fk_remise_except | Id discount if line is from a discount |
Definition at line 437 of file propal.class.php.
Propal::availability | ( | $availability_id, | |
$notrigger = 0 |
|||
) |
Change the delivery time.
int | $availability_id | Id of new delivery time |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2965 of file propal.class.php.
Propal::classifyBilled | ( | User | $user, |
$notrigger = 0 |
|||
) |
Class invoiced the Propal.
User | $user | Object user |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2552 of file propal.class.php.
Propal::cloture | ( | $user, | |
$statut, | |||
$note = "" , |
|||
$notrigger = 0 |
|||
) |
Close the commercial proposal.
User | $user | Object user that close |
int | $statut | Statut |
string | $note | Complete private note with this note |
int | $notrigger | 1=Does not execute triggers, 0=Execute triggers |
Definition at line 2449 of file propal.class.php.
Propal::create | ( | $user, | |
$notrigger = 0 |
|||
) |
Create commercial proposal into database this->ref can be set or empty.
If empty, we will use "(PROVid)"
Definition at line 872 of file propal.class.php.
Referenced by create_from().
Propal::create_from | ( | $user | ) |
Propal::createFromClone | ( | $socid = 0 | ) |
Load an object from its id and create a new one in database.
int | $socid | Id of thirdparty |
Definition at line 1219 of file propal.class.php.
Propal::delete | ( | $user, | |
$notrigger = 0 |
|||
) |
Delete proposal.
User | $user | Object user that delete |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2841 of file propal.class.php.
Propal::deleteline | ( | $lineid | ) |
Delete detail line.
int | $lineid | Id of line to delete |
Definition at line 830 of file propal.class.php.
Propal::demand_reason | ( | $demand_reason_id, | |
$notrigger = 0 |
|||
) |
Change source demand.
int | $demand_reason_id | Id of new source demand |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 3036 of file propal.class.php.
Propal::fetch | ( | $rowid, | |
$ref = '' |
|||
) |
Load a proposal from database and its ligne array.
int | $rowid | id of object to load |
string | $ref | Ref of proposal |
Definition at line 1348 of file propal.class.php.
Propal::fetch_lines | ( | $only_product = 0 | ) |
Load array lines.
int | $only_product | Return only physical products |
Definition at line 1607 of file propal.class.php.
Referenced by getLinesArray().
Propal::generateDocument | ( | $modele, | |
$outputlangs, | |||
$hidedetails = 0 , |
|||
$hidedesc = 0 , |
|||
$hideref = 0 , |
|||
$moreparams = null |
|||
) |
Create a document onto disk according to template module.
string | $modele | Force model to use ('' to not force) |
Translate | $outputlangs | Object langs to use for output |
int | $hidedetails | Hide details of lines |
int | $hidedesc | Hide description |
int | $hideref | Hide ref |
null | array | $moreparams | Array to provide more information |
Definition at line 3593 of file propal.class.php.
Propal::getInvoiceArrayList | ( | ) |
Returns an array with the numbers of related invoices.
Definition at line 2742 of file propal.class.php.
References InvoiceArrayList().
Propal::getLibStatut | ( | $mode = 0 | ) |
Return label of status of proposal (draft, validated, ...)
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 |
Definition at line 3161 of file propal.class.php.
Propal::getLinesArray | ( | ) |
Retrieve an array of proposal lines.
Definition at line 3577 of file propal.class.php.
References fetch_lines().
Propal::getNextNumRef | ( | $soc | ) |
Returns the reference to the following non used Proposal used depending on the active numbering module defined into PROPALE_ADDON.
Societe | $soc | Object thirdparty |
Definition at line 3441 of file propal.class.php.
Propal::getNomUrl | ( | $withpicto = 0 , |
|
$option = '' , |
|||
$get_params = '' , |
|||
$notooltip = 0 , |
|||
$save_lastsearch_value = -1 |
|||
) |
Return clicable link of object (with eventually picto)
int | $withpicto | Add picto into link |
string | $option | Where point the link ('expedition', 'document', ...) |
string | $get_params | Parametres added to url |
int | $notooltip | 1=Disable tooltip |
int | $save_lastsearch_value | -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking |
Definition at line 3503 of file propal.class.php.
Propal::info | ( | $id | ) |
Object Proposal Information.
int | $id | Proposal id |
Definition at line 3106 of file propal.class.php.
Propal::initAsSpecimen | ( | ) |
Initialise an instance with random values.
Used to build previews or test instances. id must be 0 if object instance is a specimen.
Definition at line 3303 of file propal.class.php.
Propal::insert_discount | ( | $idremise | ) |
Adding line of fixed discount in the proposal in DB.
int | $idremise | Id of fixed discount |
Definition at line 326 of file propal.class.php.
Propal::InvoiceArrayList | ( | $id | ) |
Returns an array with id and ref of related invoices.
int | $id | Id propal |
Definition at line 2754 of file propal.class.php.
References CommonObject\fetchObjectLinked().
Referenced by getInvoiceArrayList().
Propal::LibStatut | ( | $statut, | |
$mode = 1 |
|||
) |
Return label of a status (draft, validated, ...)
int | $statut | id statut |
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 |
Definition at line 3174 of file propal.class.php.
Propal::liste_array | ( | $shortlist = 0 , |
|
$draft = 0 , |
|||
$notcurrentuser = 0 , |
|||
$socid = 0 , |
|||
$limit = 0 , |
|||
$offset = 0 , |
|||
$sortfield = 'p.datep' , |
|||
$sortorder = 'DESC' |
|||
) |
Return list of proposal (eventually filtered on user) into an array.
int | $shortlist | 0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name) |
int | $draft | 0=not draft, 1=draft |
int | $notcurrentuser | 0=all user, 1=not current user |
int | $socid | Id third pary |
int | $limit | For pagination |
int | $offset | For pagination |
string | $sortfield | Sort criteria |
string | $sortorder | Sort order |
Definition at line 2673 of file propal.class.php.
Propal::load_board | ( | $user, | |
$mode | |||
) |
Load indicators for dashboard (this->nbtodo and this->nbtodolate)
User | $user | Object user |
int | $mode | "opened" for proposal to close, "signed" for proposal to invoice |
Definition at line 3221 of file propal.class.php.
Propal::load_state_board | ( | ) |
Charge indicateurs this->nb de tableau de bord.
Definition at line 3395 of file propal.class.php.
Propal::reopen | ( | $user, | |
$statut, | |||
$note = '' , |
|||
$notrigger = 0 |
|||
) |
Reopen the commercial proposal.
User | $user | Object user that close |
int | $statut | Statut |
string | $note | Comment |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2388 of file propal.class.php.
|
static |
Function used to replace a thirdparty id with another one.
Definition at line 3623 of file propal.class.php.
References CommonObject\commonReplaceThirdparty().
Propal::set_availability | ( | $user, | |
$id, | |||
$notrigger = 0 |
|||
) |
Set delivery.
User | $user | Object user that modify |
int | $id | Availability id |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2043 of file propal.class.php.
Propal::set_date | ( | $user, | |
$date, | |||
$notrigger = 0 |
|||
) |
Define proposal date.
User | $user | Object user that modify |
int | $date | Date |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1850 of file propal.class.php.
Propal::set_date_livraison | ( | $user, | |
$date_livraison, | |||
$notrigger = 0 |
|||
) |
Set delivery date.
User | $user | Object user that modify |
int | $date_livraison | Delivery date |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1981 of file propal.class.php.
Propal::set_demand_reason | ( | $user, | |
$id, | |||
$notrigger = 0 |
|||
) |
Set source of demand.
User | $user | Object user that modify |
int | $id | Input reason id |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2114 of file propal.class.php.
Propal::set_draft | ( | $user, | |
$notrigger = 0 |
|||
) |
Set draft status.
User | $user | Object user that modify |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2608 of file propal.class.php.
Propal::set_echeance | ( | $user, | |
$date_fin_validite, | |||
$notrigger = 0 |
|||
) |
Define end validity date.
User | $user | Object user that modify |
int | $date_fin_validite | End of validity date |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1919 of file propal.class.php.
Propal::set_ref_client | ( | $user, | |
$ref_client, | |||
$notrigger = 0 |
|||
) |
Set customer reference number.
User | $user | Object user that modify |
string | $ref_client | Customer reference |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2187 of file propal.class.php.
Propal::set_remise_absolue | ( | $user, | |
$remise, | |||
$notrigger = 0 |
|||
) |
Set an absolute overall discount on the proposal.
User | $user | Object user that modify |
double | $remise | Amount discount |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2319 of file propal.class.php.
References price2num().
Propal::set_remise_percent | ( | $user, | |
$remise, | |||
$notrigger = 0 |
|||
) |
Set an overall discount on the proposal.
User | $user | Object user that modify |
double | $remise | Amount discount |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 2252 of file propal.class.php.
References price2num().
Propal::update | ( | User | $user, |
$notrigger = 0 |
|||
) |
Propal::updateline | ( | $rowid, | |
$pu, | |||
$qty, | |||
$remise_percent, | |||
$txtva, | |||
$txlocaltax1 = 0.0 , |
|||
$txlocaltax2 = 0.0 , |
|||
$desc = '' , |
|||
$price_base_type = 'HT' , |
|||
$info_bits = 0 , |
|||
$special_code = 0 , |
|||
$fk_parent_line = 0 , |
|||
$skip_update_total = 0 , |
|||
$fk_fournprice = 0 , |
|||
$pa_ht = 0 , |
|||
$label = '' , |
|||
$type = 0 , |
|||
$date_start = '' , |
|||
$date_end = '' , |
|||
$array_options = 0 , |
|||
$fk_unit = null , |
|||
$pu_ht_devise = 0 , |
|||
$notrigger = 0 |
|||
) |
Update a proposal line.
int | $rowid | Id de la ligne |
float | $pu | Prix unitaire (HT ou TTC selon price_base_type) |
float | $qty | Quantity |
float | $remise_percent | Remise effectuee sur le produit |
float | $txtva | Taux de TVA |
float | $txlocaltax1 | Local tax 1 rate |
float | $txlocaltax2 | Local tax 2 rate |
string | $desc | Description |
string | $price_base_type | HT ou TTC |
int | $info_bits | Miscellaneous informations |
int | $special_code | Special code (also used by externals modules!) |
int | $fk_parent_line | Id of parent line (0 in most cases, used by modules adding sublevels into lines). |
int | $skip_update_total | Keep fields total_xxx to 0 (used for special lines by some modules) |
int | $fk_fournprice | Id of origin supplier price |
int | $pa_ht | Price (without tax) of product when it was bought |
string | $label | ??? |
int | $type | 0/1=Product/service |
int | $date_start | Start date of the line |
int | $date_end | End date of the line |
array | $array_options | extrafields array |
string | $fk_unit | Code of the unit to use. Null to use the default one |
double | $pu_ht_devise | Unit price in currency |
int | $notrigger | disable line update trigger |
Definition at line 666 of file propal.class.php.
Propal::valid | ( | $user, | |
$notrigger = 0 |
|||
) |
Set status to validated.
User | $user | Object user that validate |
int | $notrigger | 1=Does not execute triggers, 0=execute triggers |
Definition at line 1726 of file propal.class.php.
Propal::$datec |
Propal::$datep |
Propal::$datev |
Propal::$price |
Propal::$total |
Propal::$tva |