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())
	Format img tags to introduce viewimage on img src.

	includeContainer ($containerref)
	Clean an HTML page to report only content, so we can include it 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 ()
	Return HTML content to add structured data for an article, news or Blog Post.

	getNbOfImagePublicURLOfObject ($object)
	Return HTML content to add structured data for an article, news or Blog Post.

	getImagePublicURLOfObject ($object, $no=1, $extName='')
	Return HTML content to add structured data for an article, news or Blog Post.

	getPublicFilesOfObject ($object)
	Return list of 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.

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

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 452 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 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 page content $tmp.

If $modifylinks is set, links to images will be replace with a link to viewimage wrapper.

Parameters

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

Returns: void

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

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

◆ getImagePublicURLOfObject()

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

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

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')

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

See also: getNbOfImagePublicURLOfObject()

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

References $object, and getListOfPossibleImageExt().

◆ getNbOfImagePublicURLOfObject()

getNbOfImagePublicURLOfObject ( $object )

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

Parameters

Object $object Object

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

See also: getImagePublicURLOfObject()

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

References $object, and getListOfPossibleImageExt().

◆ 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
string	$sortorder	Sort order ('DESC' or 'ASC')
string	$langcode	Language code ('' or 'en', 'fr', 'es', ...)
array	$otherfilters	Other filters
int	$status	0 or 1, or -1 for both

Returns: array Array with results of search

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

◆ getPublicFilesOfObject()

getPublicFilesOfObject ( $object )

Return list of public files of a given object.

Parameters

Object $object Object

Returns: array List of public files of object

Definition at line 1110 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 $params Array of parameters

Returns: string HTML content

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

◆ getSocialNetworkSharingLinks()

getSocialNetworkSharingLinks ( )

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

Returns: string HTML content

Definition at line 938 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	$data	Array of data parameters for structured data

Returns: string HTML content

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

References dol_escape_json(), dol_print_date(), dol_string_nohtmltag(), and dolStripPhpCode().

◆ includeContainer()

includeContainer ( $containerref )

Clean an HTML page to report only content, so we can include it into another page.

It outputs content of file sanitized from html and body part.

Parameters

string $containerref Path to file to include (must be a page from website root. Example: 'mypage.php' means 'mywebsite/mypage.php')

Returns: void

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

◆ redirectToContainer()

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

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	$permanent	0=Use temporary redirect 302, 1=Use permanent redirect 301
array	$parameters	Array of parameters to append to the URL.

Returns: void

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

References setEventMessages().

Functions

Detailed Description

Function Documentation

◆ dolKeepOnlyPhpCode()

◆ dolReplaceSmileyCodeWithUTF8()

◆ dolStripPhpCode()

◆ dolWebsiteIncrementCounter()

◆ dolWebsiteOutput()

◆ dolWebsiteReplacementOfLinks()

◆ getAllImages()

◆ getImagePublicURLOfObject()

◆ getNbOfImagePublicURLOfObject()

◆ getPagesFromSearchCriterias()

◆ getPublicFilesOfObject()

◆ getSocialNetworkHeaderCards()

◆ getSocialNetworkSharingLinks()

◆ getStructuredData()

◆ includeContainer()

◆ redirectToContainer()