Description

This function returns a file's path.

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

Examples


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

$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',
    )
 );

 

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',
    }
 );

 

cpapi2 --user=username Branding resolve_file file=file.ext skipdefault=0 checkmain=1

{  
   "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"
   }
}

 

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