Page History

Include Page

	LIB:_cPanelAPI1Menu
	LIB:_cPanelAPI1Menu

Description

Excerpt
This function saves a string's contents to an HTML file.

Include Page

	LIB:_cPanelAPI1NoEquivalent
	LIB:_cPanelAPI1NoEquivalent

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledFileStorageRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	LiveAPI PHP Class

Code Block

language	php
linenumbers	true

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$save_file = $cpanel->api1('Fileman', 'savehtmlfile', array('public_html', 'myfile.html', '<p>This is the new string</p>', '1', '1')); // Call the function.

Include Page

	LIB:_LiveAPIPHPLink
	LIB:_LiveAPIPHPLink

Expand

title	LiveAPI Perl Module

Code Block

language	perl
linenumbers	true

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $save_file = $cpliveapi->api1('Fileman', 'savehtmlfile' ['public_html', 'myfile.txt', '<p>This is the new string</p>', '1', '1']); # Call the function.

Include Page

	LIB:_LiveAPIPerlLink
	LIB:_LiveAPIPerlLink

Expand

title	cPanel Tag System (deprecated)

Include Page

	LIB:_cPanelTagsWarning
	LIB:_cPanelTagsWarning

Code Block

language	text

<cpanel Module="Fileman::savehtmlfile ( $FORM('dir','file','page','skipfile','doublecode'))">

Expand

title	Command Line

Code Block
cpapi1 --user=username fileman savehtmlfile public_html myfile.txt "<p>This is the new string</p>" 1 1

Include Page

	LIB:_cPanelAPI1CLINote
	LIB:_cPanelAPI1CLINote

Expand

title	Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
`dir`	string	Required The directory in which to store the file.	Any valid directory that is relative to the account's `/home` directory.	`public_html`
`file`	string	Required The file.	Any valid filename.	`myfile.html`
`page`	string	Required The HTML code to save to the file.	Any single string.	`<p>This is a new string</p>.`
`skipfiles`	Boolean	Required Whether to open the directory before the function saves the file.	`0` — Open the directory. `1` — Do not open the directory.	`1`
`doubledecode`	Boolean	Required Whether to decode the URL values in the directory and file.	`0` — Do not decode the URL values. `1` — Decode the URL values.	`1`

Returns

This function does not return output.

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

Module:

Column
`Fileman`

Section

Column

width	40%

API Version:

Column
cPanel API 1

Section

Column

width	40%

Available in:

Column
cPanel 11+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`dir`, `file`, `page`, `skipfiles`, `doublecode`

Section

Column

width	40%

Return Formats:

Column
(none)

About this module

The Fileman module provides access to file functions.

Note

title	Notes:

This function requires access to the File Manager feature.
This function is not available in demo mode.

About cPanel API 1

Include Page

	LIB:_cPanelAPI1About
	LIB:_cPanelAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	cpanelapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "cpanelapi1" and label = "files"
labels	cpanelapi1, files

Child pages

Versions Compared

Old Version 7

New Version Current

Key

Description

Examples

Parameters

Returns

Function information

About this module

About cPanel API 1

Find a function

Related functions