Child pages
  • cPanel API 1 Functions - Fileman::savehtmlfile

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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



Expand
titleCommand 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
titleOutput (none)

This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory in which to store the file.

Any valid directory that is relative to the account's /home directory.public_html
filestring

Required

The file.

Any valid filename.myfile.html
pagestring

Required

The HTML code to save to the file.

Any single string.<p>This is a new string</p>.
skipfilesBoolean

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.