dolibarr 20.0.0
Website Class Reference

Class Website. More...

Inheritance diagram for Website:
Collaboration diagram for Website:

Public Member Functions

 __construct (DoliDB $db)
 Constructor.
 
 create (User $user, $notrigger=0)
 Create object into database.
 
 fetch ($id, $ref=null)
 Load object in memory from the database.
 
 fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
 Load all object in memory ($this->records) from the database.
 
 update (User $user, $notrigger=0)
 Update object into database.
 
 delete (User $user, $notrigger=0)
 Delete object in database.
 
 createFromClone ($user, $fromid, $newref, $newlang='')
 Load a website its id and create a new one in database.
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $maxlen=24, $morecss='')
 Return a link to the user card (with optionally the picto) Use this->id,this->lastname, this->firstname.
 
 getLibStatut ($mode=0)
 Return the label of the status.
 
 LibStatut ($status, $mode=0)
 Return the label of a given status.
 
 initAsSpecimen ()
 Initialise object with example values Id must be 0 if object instance is a specimen.
 
 exportWebSite ()
 Generate a zip with all data of web site.
 
 rebuildWebSiteFiles ()
 Rebuild all files of all the pages/containers of a website.
 
 isMultiLang ()
 Return if web site is a multilanguage web site.
 
 componentSelectLang ($languagecodes, $weblangs, $morecss='', $htmlname='')
 Component to select language inside a container (Full CSS Only)
 
 overwriteTemplate (string $pathtotmpzip, $exportPath='')
 Overite template by copying all files.
 
 setTemplateName ($name_template)
 update name_template in table after import template
 
 checkPreviousState ($pathname)
 check previous state for file
 
 saveState ($etat, $pathname)
 Save state for File.
 
 compareFichierModifie ($dossierSource, $dossierDestination, $fichierModifie)
 Compare two files has not same name but same content.
 
- Public Member Functions inherited from CommonObject
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty
 
 setErrorsFromObject ($object)
 setErrorsFromObject
 
 getTooltipContentArray ($params)
 Return array of data to show into a tooltip.
 
 getTooltipContent ($params)
 getTooltipContent
 
 errorsToString ()
 Method to output saved errors.
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output.
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output.
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact.
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download.
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact.
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current.
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line.
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line.
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts in llx_element_contact.
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 Get array of all contacts for an object.
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object.
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts.
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 Return array with list of possible values for type of contacts.
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code.
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contact_id into $this->contact.
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
 
 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.
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed 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.
 

Protected Member Functions

 extractNumberFromFilename ($filename)
 extract num of page
 
 showDifferences ($str1, $str2, $exceptNumPge=array())
 show difference between to string
 
 replaceLineUsingNum ($inplaceFile, $differences)
 Replace line by line in file using numbers of the lines.
 
- 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.
 

Private Member Functions

 normalizeString ($str)
 Remove spaces in string.
 

Additional Inherited Members

- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
 
static getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
 Function used to get an array with all items linked to an object id in association table.
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table.
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table.
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one.
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one.
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Detailed Description

Class Website.

Definition at line 38 of file website.class.php.

Constructor & Destructor Documentation

◆ __construct()

Website::__construct ( DoliDB $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 141 of file website.class.php.

Member Function Documentation

◆ checkPreviousState()

Website::checkPreviousState ( $pathname)

check previous state for file

Parameters
string$pathnamepath of file
Returns
array|mixed

Definition at line 1801 of file website.class.php.

References dolChmod().

◆ compareFichierModifie()

Website::compareFichierModifie ( $dossierSource,
$dossierDestination,
$fichierModifie )

Compare two files has not same name but same content.

Parameters
string$dossierSourcefilepath of folder source
string$dossierDestinationfilepath of folder dest
mixed$fichierModifiefiles modified
Returns
array empty if KO, array if OK

Definition at line 1831 of file website.class.php.

References dol_dir_list(), extractNumberFromFilename(), and showDifferences().

◆ componentSelectLang()

Website::componentSelectLang ( $languagecodes,
$weblangs,
$morecss = '',
$htmlname = '' )

Component to select language inside a container (Full CSS Only)

Parameters
array | string$languagecodes'auto' to show all languages available for page, or language codes array like array('en','fr','de','es')
Translate$weblangsLanguage Object
string$morecssMore CSS class on component
string$htmlnameSuffix for HTML name
Returns
string HTML select component

Definition at line 1485 of file website.class.php.

◆ create()

Website::create ( User $user,
$notrigger = 0 )

Create object into database.

Parameters
User$userUser that creates
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, 0 if already exists, ID of created object if OK

Definition at line 155 of file website.class.php.

References description, dol_mkdir(), dol_now(), dol_strlen(), dol_syslog(), position, ref, and status.

◆ createFromClone()

Website::createFromClone ( $user,
$fromid,
$newref,
$newlang = '' )

Load a website its id and create a new one in database.

This copy website directories, regenerate all the pages + alias pages and recreate the medias link.

Parameters
User$userUser making the clone
int$fromidId of object to clone
string$newrefNew ref
string$newlangNew language
Returns
mixed New object created, <0 if KO

Definition at line 659 of file website.class.php.

References $object, dol_delete_dir_recursive(), dol_delete_file(), dol_mkdir(), dol_now(), dol_osencode(), dol_sanitizeFileName(), dol_syslog(), dolCopyDir(), dolSaveIndexPage(), dolSavePageAlias(), dolSavePageContent(), getDolGlobalString(), and setEventMessages().

◆ delete()

Website::delete ( User $user,
$notrigger = 0 )

Delete object in database.

Parameters
User$userUser that deletes
int$notrigger0=launch triggers, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 591 of file website.class.php.

References CommonObject\deleteCommon(), dol_delete_dir_recursive(), dol_syslog(), and ref.

◆ exportWebSite()

Website::exportWebSite ( )

Generate a zip with all data of web site.

Returns
string Path to file with zip or '' if error

Definition at line 934 of file website.class.php.

References dol_copy(), dol_delete_dir_recursive(), dol_delete_file(), dol_is_file(), dol_mkdir(), dol_now(), dol_print_date(), dol_syslog(), dolChmod(), dolCopyDir(), dolReplaceInFile(), getDolGlobalInt(), and setEventMessages().

◆ extractNumberFromFilename()

Website::extractNumberFromFilename ( $filename)
protected

extract num of page

Parameters
string$filenamename of file
Returns
int 1 if OK, -1 if KO

Definition at line 1766 of file website.class.php.

Referenced by compareFichierModifie().

◆ fetch()

Website::fetch ( $id,
$ref = null )

Load object in memory from the database.

Parameters
int$idId object
string$refRef
Returns
int Return integer <0 if KO, 0 if not found, >0 if OK

Definition at line 304 of file website.class.php.

References description, dol_syslog(), position, ref, and status.

◆ fetchAll()

Website::fetchAll ( $sortorder = '',
$sortfield = '',
$limit = 0,
$offset = 0,
$filter = '',
$filtermode = 'AND' )

Load all object in memory ($this->records) from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitlimit
int$offsetoffset limit
string | array$filterfilter array
string$filtermodefilter mode (AND or OR)
Returns
array|int int <0 if KO, array of pages if OK

Definition at line 384 of file website.class.php.

References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

◆ getLibStatut()

Website::getLibStatut ( $mode = 0)

Return the label of the status.

Parameters
int$mode0=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 864 of file website.class.php.

References LibStatut(), and status.

◆ getNomUrl()

Website::getNomUrl ( $withpicto = 0,
$option = '',
$notooltip = 0,
$maxlen = 24,
$morecss = '' )

Return a link to the user card (with optionally the picto) Use this->id,this->lastname, this->firstname.

Parameters
int$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string$optionOn what the link point to
integer$notooltip1=Disable tooltip
int$maxlenMax length of visible user name
string$morecssAdd more css on link
Returns
string String with URL

Definition at line 830 of file website.class.php.

References ref.

◆ initAsSpecimen()

Website::initAsSpecimen ( )

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns
int

Definition at line 906 of file website.class.php.

References description, dol_now(), ref, and status.

◆ isMultiLang()

Website::isMultiLang ( )

Return if web site is a multilanguage web site.

Return false if there is only 0 or 1 language.

Returns
boolean True if web site is a multilanguage web site

Definition at line 1471 of file website.class.php.

◆ LibStatut()

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

Return the label of a given status.

Parameters
int$statusId status
int$mode0=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 877 of file website.class.php.

Referenced by getLibStatut().

◆ normalizeString()

Website::normalizeString ( $str)
private

Remove spaces in string.

Parameters
string$strstring
Returns
string

Definition at line 1917 of file website.class.php.

Referenced by showDifferences().

◆ overwriteTemplate()

Website::overwriteTemplate ( string $pathtotmpzip,
$exportPath = '' )

Overite template by copying all files.

Parameters
string$pathtotmpzipPath to the tmp zip file
string$exportPathRelative path of directory to export files into (specified by the user)
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1667 of file website.class.php.

References dol_delete_file(), dol_is_file(), dol_mkdir(), dol_move(), dol_uncompress(), getDolGlobalString(), and setEventMessages().

◆ rebuildWebSiteFiles()

Website::rebuildWebSiteFiles ( )

Rebuild all files of all the pages/containers of a website.

Rebuild also the index and wrapper.php file. Note: Files are already regenerated during importWebSite so this function is useless when importing a website.

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

Definition at line 1383 of file website.class.php.

References $object, dolSaveIndexPage(), dolSavePageAlias(), and dolSavePageContent().

◆ replaceLineUsingNum()

Website::replaceLineUsingNum ( $inplaceFile,
$differences )
protected

Replace line by line in file using numbers of the lines.

Parameters
string$inplaceFilepath of file to modify in place
array$differencesarray of differences between files
Returns
int Return 0 if we can replace, <0 if not (-2=not writable)

Definition at line 2024 of file website.class.php.

References dolChmod(), and dolReplaceInFile().

◆ saveState()

Website::saveState ( $etat,
$pathname )

Save state for File.

Parameters
mixed$etatstate
mixed$pathnamepath of file
Returns
int|false

Definition at line 1819 of file website.class.php.

◆ setTemplateName()

Website::setTemplateName ( $name_template)

update name_template in table after import template

Parameters
string$name_templatename of template
Returns
int 1 if OK, -1 if KO

Definition at line 1780 of file website.class.php.

◆ showDifferences()

Website::showDifferences ( $str1,
$str2,
$exceptNumPge = array() )
protected

show difference between to string

Parameters
string$str1first string
string$str2second string
array$exceptNumPgenum of page files we don't want to change
Returns
array|int<-1,-1> -1 if KO, array if OK

Definition at line 1931 of file website.class.php.

References normalizeString(), and ref.

Referenced by compareFichierModifie().

◆ update()

Website::update ( User $user,
$notrigger = 0 )

Update object into database.

Parameters
User$userUser that modifies
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

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

References description, dol_mkdir(), dol_now(), dol_strlen(), dol_syslog(), ref, and status.


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