dolibarr 21.0.0-beta
AdherentType Class Reference

Class to manage members type. More...

Inheritance diagram for AdherentType:
Collaboration diagram for AdherentType:

Public Member Functions

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

Public Attributes

 $fields
 Array with all fields and their property.
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Additional Inherited Members

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

Detailed Description

Class to manage members type.

Definition at line 37 of file adherent_type.class.php.

Constructor & Destructor Documentation

◆ __construct()

AdherentType::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 173 of file adherent_type.class.php.

References status.

Member Function Documentation

◆ _load_ldap_dn()

AdherentType::_load_ldap_dn ( $info,
$mode = 0 )

Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.

Parameters
array<string,mixed>$info Info array loaded by _load_ldap_info
int<0,2>$mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb) 1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb) 2=Return key only (uid=qqq)
Returns
string DN

Definition at line 851 of file adherent_type.class.php.

References getDolGlobalString().

◆ _load_ldap_info()

AdherentType::_load_ldap_info ( )

Initialize the info array (array of LDAP values) that will be used to call LDAP functions.

Returns
array<string,mixed> Info table with attributes

Definition at line 875 of file adherent_type.class.php.

References dol_string_nohtmltag(), and getDolGlobalString().

◆ amountByType()

AdherentType::amountByType ( $status = null)

Return the array of all amounts per membership type id.

Parameters
int$statusFilter on status of type
Returns
array<int,string> Array of membership type

Definition at line 605 of file adherent_type.class.php.

◆ create()

AdherentType::create ( $user,
$notrigger = 0 )

Function to create the member type.

Parameters
User$userUser making creation
int$notrigger1=do not execute triggers, 0 otherwise
Returns
int >0 if OK, < 0 if KO

Definition at line 339 of file adherent_type.class.php.

References $conf, CommonObject\call_trigger(), dol_syslog(), status, and update().

◆ delete()

AdherentType::delete ( $user)

Function to delete the member's status.

Parameters
User$userUser making the deletion
Returns
int > 0 if OK, 0 if not found, < 0 if KO

Definition at line 480 of file adherent_type.class.php.

References CommonObject\call_trigger().

◆ delMultiLangs()

AdherentType::delMultiLangs ( $langtodelete,
$user )

Delete a language for this member type.

Parameters
string$langtodeleteLanguage code to delete
User$userObject user making delete
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 308 of file adherent_type.class.php.

References CommonObject\call_trigger(), and dol_syslog().

◆ fetch()

AdherentType::fetch ( $rowid)

Function that retrieves the properties of a membership type.

Parameters
int$rowidId of member type to load
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 513 of file adherent_type.class.php.

References dol_strlen(), dol_syslog(), CommonObject\fetch_optionals(), getDolGlobalInt(), getMultiLangs(), ref, and status.

◆ getKanbanView()

AdherentType::getKanbanView ( $option = '',
$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array{string,mixed}$arraydata Array of data
Returns
string HTML Code for Kanban thumb.

Definition at line 1007 of file adherent_type.class.php.

References getNomUrl(), img_edit(), img_picto(), ref, and yn().

◆ getLibStatut()

AdherentType::getLibStatut ( $mode = 0)

Return label of status (activity, closed)

Parameters
int<0,6>$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
Returns
string Label of status

Definition at line 806 of file adherent_type.class.php.

References LibStatut(), and status.

Referenced by getTooltipContentArray().

◆ getMailOnExclude()

AdherentType::getMailOnExclude ( )

getMailOnExclude

Returns
string Return mail model content of type or empty

Definition at line 989 of file adherent_type.class.php.

References dol_htmlentitiesbr_decode().

◆ getMailOnResiliate()

AdherentType::getMailOnResiliate ( )

getMailOnResiliate

Returns
string Return mail model content of type or empty

Definition at line 974 of file adherent_type.class.php.

References dol_htmlentitiesbr_decode().

◆ getMailOnSubscription()

AdherentType::getMailOnSubscription ( )

getMailOnSubscription

Returns
string Return mail content of type or empty

Definition at line 959 of file adherent_type.class.php.

References dol_htmlentitiesbr_decode().

◆ getMailOnValid()

AdherentType::getMailOnValid ( )

getMailOnValid

Returns
string Return mail content of type or empty

Definition at line 945 of file adherent_type.class.php.

References dol_htmlentitiesbr_decode().

◆ getmorphylib()

AdherentType::getmorphylib ( $morphy = '')

Return translated label by the nature of a adherent (physical or moral)

Parameters
string$morphyNature of the adherent (physical or moral)
Returns
string Label

Definition at line 693 of file adherent_type.class.php.

◆ getMultiLangs()

AdherentType::getMultiLangs ( )

Load array this->multilangs.

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 186 of file adherent_type.class.php.

References description, and email.

Referenced by fetch().

◆ getNomUrl()

AdherentType::getNomUrl ( $withpicto = 0,
$maxlen = 0,
$notooltip = 0,
$morecss = '',
$save_lastsearch_value = -1 )

Return clickable name (with picto eventually)

Parameters
int<0,2>$withpicto 0=No picto, 1=Include picto into link, 2=Only picto
int$maxlenlength max label
int<0,1>$notooltip 1=Disable tooltip
string$morecssAdd more css on link
int<-1,1>$save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string String with URL

Definition at line 750 of file adherent_type.class.php.

References dol_trunc(), getDolGlobalInt(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

◆ getTooltipContentArray()

AdherentType::getTooltipContentArray ( $params)

getTooltipContentArray

Parameters
array<string,mixed>$params params to construct tooltip data
Since
v18
Returns
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}|array{optimize:string}

Reimplemented from CommonObject.

Definition at line 712 of file adherent_type.class.php.

References getLibStatut(), img_picto(), and yn().

Referenced by getNomUrl().

◆ initAsSpecimen()

AdherentType::initAsSpecimen ( )

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns
int

Definition at line 914 of file adherent_type.class.php.

References ref, and status.

◆ LibStatut()

AdherentType::LibStatut ( $status,
$mode = 0 )

Return the label of a given status.

Parameters
int$statusStatus id
int<0,6>$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
Returns
string Status label

Definition at line 819 of file adherent_type.class.php.

References dolGetStatus().

Referenced by getLibStatut().

◆ liste_array()

AdherentType::liste_array ( $status = -1)

Return list of members' type.

Parameters
int$statusFilter on status of type
Returns
array<int,string> List of types of members

Definition at line 566 of file adherent_type.class.php.

◆ listMembersForMemberType()

AdherentType::listMembersForMemberType ( $excludefilter = '',
$mode = 0 )

Return array of Member objects for member type this->id (or all if this->id not defined)

Parameters
string$excludefilterFilter to exclude. This value must not come from a user input.
int<0,2>$mode 0=Return array of member instance 1=Return array of member instance without extra data 2=Return array of members id only
Returns
Adherent[]|int<-1,-1> Array of members or -1 on error

Definition at line 645 of file adherent_type.class.php.

References dol_syslog().

◆ setMultiLangs()

AdherentType::setMultiLangs ( $user)

Update or add a translation for this member type.

Parameters
User$userObject user making update
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 222 of file adherent_type.class.php.

References CommonObject\call_trigger(), description, and dol_syslog().

Referenced by update().

◆ update()

AdherentType::update ( $user,
$notrigger = 0 )

Updating the type in the database.

Parameters
User$userObject user making change
int$notrigger1=do not execute triggers, 0 otherwise
Returns
int >0 if OK, < 0 if KO

Definition at line 402 of file adherent_type.class.php.

References CommonObject\call_trigger(), description, dol_syslog(), getDolGlobalInt(), CommonObject\insertExtraFields(), setMultiLangs(), and status.

Referenced by create().

Member Data Documentation

◆ $fields

AdherentType::$fields
Initial value:
= array(
"rowid" => array("type" => "integer", "label" => "TechnicalID", "enabled" => "1", 'position' => 10, 'notnull' => 1, "visible" => "-1",),
"tms" => array("type" => "timestamp", "label" => "DateModification", "enabled" => "1", 'position' => 20, 'notnull' => 1, "visible" => "-1",),
"statut" => array("type" => "smallint(6)", "label" => "Statut", "enabled" => "1", 'position' => 500, 'notnull' => 1, "visible" => "-1",),
"libelle" => array("type" => "varchar(50)", "label" => "Label", "enabled" => "1", 'position' => 30, 'notnull' => 1, "visible" => "-1",),
"subscription" => array("type" => "varchar(3)", "label" => "Subscription", "enabled" => "1", 'position' => 35, 'notnull' => 1, "visible" => "-1",),
"amount" => array("type" => "double(24,8)", "label" => "Amount", "enabled" => "1", 'position' => 40, 'notnull' => 0, "visible" => "-1",),
"caneditamount" => array("type" => "integer", "label" => "Caneditamount", "enabled" => "1", 'position' => 45, 'notnull' => 0, "visible" => "-1",),
"vote" => array("type" => "varchar(3)", "label" => "Vote", "enabled" => "1", 'position' => 50, 'notnull' => 1, "visible" => "-1",),
"note" => array("type" => "longtext", "label" => "Note", "enabled" => "1", 'position' => 55, 'notnull' => 0, "visible" => "-1",),
"mail_valid" => array("type" => "longtext", "label" => "Mailvalid", "enabled" => "1", 'position' => 60, 'notnull' => 0, "visible" => "-1",),
"morphy" => array("type" => "varchar(3)", "label" => "Morphy", "enabled" => "1", 'position' => 65, 'notnull' => 0, "visible" => "-1",),
"duration" => array("type" => "varchar(6)", "label" => "Duration", "enabled" => "1", 'position' => 70, 'notnull' => 0, "visible" => "-1",),
)

Array with all fields and their property.

Do not use it as a static var. It may be modified by constructor.

Definition at line 151 of file adherent_type.class.php.


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