Library for website module. More...

Functions
	dolStripPhpCode ($str, $replacewith='')
	Remove PHP code part from a string.

	dolKeepOnlyPhpCode ($str)
	Keep only PHP code part from a HTML string page.

	dolWebsiteReplacementOfLinks ($website, $content, $removephppart=0, $contenttype='html', $containerid=0)
	Convert a page content to have correct links (based on DOL_URL_ROOT) into an html content.

	dolReplaceSmileyCodeWithUTF8 ($content)
	Converts smiley string into the utf8 sequence.

	dolWebsiteOutput ($content, $contenttype='html', $containerid=0)
	Render a string of an HTML content and output it.

	dolWebsiteIncrementCounter ($websiteid, $websitepagetype, $websitepageid)
	Increase the website counter of page access.

	redirectToContainer ($containerref, $containeraliasalt='', $containerid=0, $permanent=0, $parameters=array(), $parampropagation=1)
	Format img tags to introduce viewimage on img src.

	includeContainer ($containerref, $once=0, $cachedelay=0, $cachekey='')
	Execute content of a php page and report result to be included into another page.

	getStructuredData ($type, $data=array())
	Return HTML content to add structured data for an article, news or Blog Post.

	getSocialNetworkHeaderCards ($params=null)
	Return HTML content to add as header card for an article, news or Blog Post or home page.

	getSocialNetworkSharingLinks ($socialnetworks='')
	Return HTML content to add structured data for an article, news or Blog Post.

	getNbOfImagePublicURLOfObject ($object)
	Return nb of images known into inde files for an object;.

	getImagePublicURLOfObject ($object, $no=1, $extName='', $cover=1)
	Return the public image URL of an object.

	getPublicFilesOfObject ($object)
	Return array with list of all public files of a given object.

	getPagesFromSearchCriterias ($type, $algo, $searchstring, $max=25, $sortfield='date_creation', $sortorder='DESC', $langcode='', $otherfilters=[], $status=1)
	Return list of containers object that match a criteria.

	getImageFromHtmlContent ($htmlContent, $imageNumber=1)
	Return the URL of an image found into a HTML content.

	getAllImages ($object, $objectpage, $urltograb, &$tmp, &$action, $modifylinks=0, $grabimages=1, $grabimagesinto='subpage')
	Download all images found into an external URL.

	getNewsDetailsById ($postId)
	Retrieves the details of a news post by its ID.

Detailed Description

Library for website module.

Definition in file website.lib.php.

Function Documentation

◆ dolKeepOnlyPhpCode()

dolKeepOnlyPhpCode ( $str )

Keep only PHP code part from a HTML string page.

Parameters

string $str String to clean

Returns: string Result string with php code only

See also: dolStripPhpCode(), checkPHPCode()

Definition at line 78 of file website.lib.php.

Referenced by run_sql().

◆ dolReplaceSmileyCodeWithUTF8()

dolReplaceSmileyCodeWithUTF8 ( $content )

Converts smiley string into the utf8 sequence.

Parameters

string $content Content to replace

Returns: string Replacement of all smiley strings with their utf8 code

See also: dolWebsiteOutput()

Definition at line 233 of file website.lib.php.

Referenced by dolWebsiteOutput().

◆ dolStripPhpCode()

dolStripPhpCode	(		$str,
			$replacewith = '' )

Remove PHP code part from a string.

Parameters

string	$str	String to clean
string	$replacewith	String to use as replacement

Returns: string Result string without php code

See also: dolKeepOnlyPhpCode()

Definition at line 34 of file website.lib.php.

Referenced by dolWebsiteReplacementOfLinks(), and getStructuredData().

◆ dolWebsiteIncrementCounter()

dolWebsiteIncrementCounter	(	$websiteid,
		$websitepagetype,
		$websitepageid )

Increase the website counter of page access.

Parameters

int	$websiteid	ID of website
string	$websitepagetype	Type of page ('blogpost', 'page', ...)
int	$websitepageid	ID of page

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

Definition at line 453 of file website.lib.php.

References dol_getdate(), dol_mktime(), dol_now(), and getDolGlobalInt().

◆ dolWebsiteOutput()

dolWebsiteOutput	(	$content,
		$contenttype = 'html',
		$containerid = 0 )

Render a string of an HTML content and output it.

Used to output the page when viewed from a server (Dolibarr or Apache).

Parameters

string	$content	Content string
string	$contenttype	Content type
int	$containerid	Contenair id

Returns: void

See also: dolWebsiteReplacementOfLinks() for function used to replace content in the backoffice context.

Definition at line 284 of file website.lib.php.

References $conf, dol_syslog(), dolReplaceSmileyCodeWithUTF8(), and getDolGlobalString().

◆ dolWebsiteReplacementOfLinks()

dolWebsiteReplacementOfLinks	(	$website,
		$content,
		$removephppart = 0,
		$contenttype = 'html',
		$containerid = 0 )

Convert a page content to have correct links (based on DOL_URL_ROOT) into an html content.

It replaces also dynamic content with '...php...' Used to output the page on the Preview from backoffice.

Parameters

Website	$website	Web site object
string	$content	Content to replace
int	$removephppart	0=Replace PHP sections with a PHP badge. 1=Remove completely PHP sections.
string	$contenttype	Content type
int	$containerid	Contenair id

Returns: string html content

See also: dolWebsiteOutput() for function used to replace content in a web server context

Definition at line 123 of file website.lib.php.

References dol_syslog(), and dolStripPhpCode().

◆ getAllImages()

getAllImages	(		$object,
			$objectpage,
			$urltograb,
		&	$tmp,
		&	$action,
			$modifylinks = 0,
			$grabimages = 1,
			$grabimagesinto = 'subpage' )

Download all images found into an external URL.

It using a text regex parsing solution, not a DOM analysis. If $modifylinks is set, links to images will be replace with a link to viewimage wrapper. To extract an URL from a HTML text content, see instead getImageFromHtmlContent().

Parameters

Website	$object	Object website
WebsitePage	$objectpage	Object website page
string	$urltograb	URL to grab (example: https://www.nltechno.com/ or s://www.nltechno.com/dir1/ or https://www.nltechno.com/dir1/mapage1)
string	$tmp	Content to parse
string	$action	Var $action
	int<0,1>	$modifylinks 0=Do not modify content, 1=Replace links with a link to viewimage
	int<0,1>	$grabimages 0=Do not grab images, 1=Grab images
	'root'\|'subpage'	$grabimagesinto 'root' or 'subpage'

Returns: void

Definition at line 1446 of file website.lib.php.

References $conf, $object, dol_mkdir(), dol_syslog(), dolChmod(), getRootURLFromURL(), getURLContent(), and setEventMessages().

◆ getImageFromHtmlContent()

getImageFromHtmlContent	(		$htmlContent,
			$imageNumber = 1 )

Return the URL of an image found into a HTML content.

To get image from an external URL to download first, see getAllImages()

Parameters

string	$htmlContent	HTML content
int	$imageNumber	The position of image. 1 by default = first image found

Returns: string URL of image or '' if not foud

See also: getImagePublicURLOfObject()

Definition at line 1395 of file website.lib.php.

Referenced by build_rssfile(), and getStructuredData().

◆ getImagePublicURLOfObject()

getImagePublicURLOfObject	(	$object,
		$no = 1,
		$extName = '',
		$cover = 1 )

Return the public image URL of an object.

For example, you can get the public image URL of a product (image that is shared).

Parameters

Object	$object	Object
int	$no	Numero of image (if there is several images. 1st one by default)
string	$extName	Extension to differentiate thumb file name ('', '_small', '_mini')
int	$cover	1=Sort with cover then position, -1=Filter on cover last then position, 0=Exclude cover and filter on position first

Returns: string HTML img content or '' if no image found

See also: getNbOfImagePublicURLOfObject(), getPublicFilesOfObject(), getImageFromHtmlContent()

Definition at line 1087 of file website.lib.php.

References $object, and getListOfPossibleImageExt().

◆ getNbOfImagePublicURLOfObject()

getNbOfImagePublicURLOfObject ( $object )

Return nb of images known into inde files for an object;.

Parameters

Object $object Object

Returns: int HTML img content or '' if no image found

See also: getImagePublicURLOfObject()

Definition at line 1048 of file website.lib.php.

References $object, and getListOfPossibleImageExt().

◆ getNewsDetailsById()

getNewsDetailsById ( $postId )

Retrieves the details of a news post by its ID.

Parameters

string $postId The ID of the news post to retrieve.

Returns: array<string,mixed>|int<-1,-1> Return array if OK, -1 if KO

Definition at line 1603 of file website.lib.php.

◆ getPagesFromSearchCriterias()

getPagesFromSearchCriterias	(	$type,
		$algo,
		$searchstring,
		$max = 25,
		$sortfield = 'date_creation',
		$sortorder = 'DESC',
		$langcode = '',
		$otherfilters = [],
		$status = 1 )

Return list of containers object that match a criteria.

WARNING: This function can be used by websites.

Parameters

string	$type	Type of container to search into (Example: '', 'page', 'blogpost', 'page,blogpost', ...)
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')
string	$searchstring	Search string
int	$max	Max number of answers
string	$sortfield	Sort Fields
	'DESC'\|'ASC'	$sortorder Sort order ('DESC' or 'ASC')
string	$langcode	Language code ('' or 'en', 'fr', 'es', ...)
	array<string,mixed>	$otherfilters Other filters
	int<-1,1>	$status 0 or 1, or -1 for both

Returns: array{list?:WebsitePage[],code?:string,message?:string} Array with results of search

Definition at line 1226 of file website.lib.php.

References $conf.

◆ getPublicFilesOfObject()

getPublicFilesOfObject ( $object )

Return array with list of all public files of a given object.

Parameters

Object $object Object

Returns: array<array{filename:string,position:int,url:string}> List of public files of object

See also: getImagePublicURLOfObject()

Definition at line 1166 of file website.lib.php.

References $object, and getListOfPossibleImageExt().

◆ getSocialNetworkHeaderCards()

getSocialNetworkHeaderCards ( $params = null )

Return HTML content to add as header card for an article, news or Blog Post or home page.

Parameters

?array<string,mixed> $params Array of parameters

Returns: string HTML content

Definition at line 916 of file website.lib.php.

References $conf.

◆ getSocialNetworkSharingLinks()

getSocialNetworkSharingLinks ( $socialnetworks = '' )

Return HTML content to add structured data for an article, news or Blog Post.

Parameters

string $socialnetworks '' or list of social networks

Returns: string HTML content

Definition at line 992 of file website.lib.php.

References dol_escape_htmltag().

◆ getStructuredData()

getStructuredData	(		$type,
			$data = array() )

Return HTML content to add structured data for an article, news or Blog Post.

Use the json-ld format. Example: <?php getStructureData('blogpost'); ?> <?php getStructureData('software', array('name'=>'Name', 'os'=>'Windows', 'price'=>10)); ?>

Parameters

string	$type	'blogpost', 'product', 'software', 'organization', 'qa', ...
	array<string,mixed>	$data Array of data parameters for structured data

Returns: string HTML content

Definition at line 704 of file website.lib.php.

References $conf, dol_escape_json(), dol_print_date(), dol_string_nohtmltag(), dolStripPhpCode(), and getImageFromHtmlContent().

◆ includeContainer()

includeContainer	(	$containerref,
		$once = 0,
		$cachedelay = 0,
		$cachekey = '' )

Execute content of a php page and report result to be included into another page.

It outputs content of file where the html and body part have been removed.

Parameters

string	$containerref	Path to file to include (must be a page from website root. Example: 'mypage.php' means 'mywebsite/mypage.php')
int	$once	If set to 1, we use include_once.
int	$cachedelay	A cache delay in seconds.
string	$cachekey	Add a key into the name of the cache so the includeContainer can use different cache content for the same page.

Returns: void

Definition at line 608 of file website.lib.php.

References $conf, dolChmod(), and getDolGlobalString().

◆ redirectToContainer()

redirectToContainer	(	$containerref,
		$containeraliasalt = '',
		$containerid = 0,
		$permanent = 0,
		$parameters = array(),
		$parampropagation = 1 )

Format img tags to introduce viewimage on img src.

Parameters

string $content Content string

Returns: void

See also: dolWebsiteOutput() Make a redirect to another container.

Parameters

string	$containerref	Ref of container to redirect to (Example: 'mypage' or 'mypage.php').
string	$containeraliasalt	Ref of alternative aliases to redirect to.
int	$containerid	Id of container.
	int<0,1>	$permanent 0=Use temporary redirect 302 (default), 1=Use permanent redirect 301
	array<string,mixed>	$parameters Array of parameters to append to the URL.
	int<0,1>	$parampropagation 0=Do not propagate query parameter in URL when doing the redirect, 1=Keep parameters (default)

Returns: void

Definition at line 520 of file website.lib.php.

References setEventMessages().

Functions

Detailed Description

Function Documentation

◆ dolKeepOnlyPhpCode()

◆ dolReplaceSmileyCodeWithUTF8()

◆ dolStripPhpCode()

◆ dolWebsiteIncrementCounter()

◆ dolWebsiteOutput()

◆ dolWebsiteReplacementOfLinks()

◆ getAllImages()

◆ getImageFromHtmlContent()

◆ getImagePublicURLOfObject()

◆ getNbOfImagePublicURLOfObject()

◆ getNewsDetailsById()

◆ getPagesFromSearchCriterias()

◆ getPublicFilesOfObject()

◆ getSocialNetworkHeaderCards()

◆ getSocialNetworkSharingLinks()

◆ getStructuredData()

◆ includeContainer()

◆ redirectToContainer()