Child pages
  • cPanel API 2 Functions - Branding::resolve_file

Versions Compared

Key

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

 

Description

Excerpt
This function returns a file's path.

Warning
titleWarning:

We strongly recommend that you use the following UAPI functions instead of this function:

  • Branding::file

    Excerpt Include
    UAPI Functions - Branding::file
    UAPI Functions - Branding::file
    nopaneltrue

Include Page
LIB:_cPanelAPI2BrandingNote
LIB:_cPanelAPI2BrandingNote

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=resolve_file&file="file.ext"&skipdefault=0&checkmain=1

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the path to the file.ext file.
$get_path = $cpanel->api2(
    'Branding', 'resolve_file',
        array(       
            'file'         => 'file.ext',
            'skipdefault'  => '0',
            'checkmain'    => '1',
    )
 );

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.
 
# Get the path to the file.ext file.
my $get_path = $cpliveapi->api2(
    'Branding', 'resolve_file',
    {
            'file'         => 'file.ext',
            'skipdefault'  => '0',
            'checkmain'    => '1',
    }
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Branding resolve_file file=file.ext skipdefault=0 checkmain=1

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"resolve_file",
      "data":[  
         {  
            "file":"file.ext",
            "path":"/usr/local/cpanel/base/frontend/x3/branding/file.ext"
         }
      ],
      "event":{  
         "result":1
      },
      "module":"Branding"
   }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

 

Parameters

InputTypeDescriptionPossible valuesExample
filestring

Required

The file.

A valid filename.

 

file.ext

brandingpkgstring

A branding package name, to only search that package's files.

If you do not use this parameter, the function searches all packages.

A valid branding package name.mybrandingpkg
skipdefaultBoolean

Whether to ignore the theme default.

This parameter defaults to 0.

  • 1 — Ignore the theme default.
  • 0 — Do not ignore the theme default.
0
checkmainBoolean

Whether to search the main branding directory.

This parameter defaults to 0.

  • 1 — Include the main branding directory.
  • 0 — Do not include the main branding directory.
0

 

Returns

ReturnTypeDescriptionPossible valuesExample

file

stringThe file's name.The file input parameter's value.file.ext
pathstringThe path to the file.

The path to the file, relative to the user's home directory.

/usr/local/cpanel/base/frontend/x3/branding/file.ext
existsBooleanWhether the file exists.
  • 1 — The file exists.
  • 0 — The file does not exist.
1
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1