Child pages
  • UAPI Functions - LangPHP::php_get_domain_handler

Versions Compared

Key

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

Description

Excerpt

This function returns a PHP version's assigned PHP handler.

Include Page
LIB:_EA4Note
LIB:_EA4Note

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_domain_handler?type=vhost&vhost=clearly.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve a virtual host's PHP handler.
$php_get_domain_handler = $cpanel->uapi(
    'LangPHP', 'php_get_domain_handler',
    array(
        'type'     => 'vhost', 
        'vhost'	  => 'clearly.com',
		)
);

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.
 
# Retrieve a virtual host's PHP handler.
my $php_get_domain_handler = $cpliveapi->uapi(
    'LangPHP', 'php_get_domain_handler',
    (
        'type'     => 'vhost', 
        'vhost'	  => 'clearly.com',
		)
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Get a hash of the data, then display the key values. -->
[% data = execute( 'LangPHP', 'php_get_domain_handler', {'type' => 'vhost', 'vhost' => 'clearly.com'} ); %]
[% FOREACH q = data.key %]
     <p>
         [% q.key %]
     </p>
[% END %]
   
<!-- Get only the default_value value. -->
[% execute('LangPHP', 'php_get_domain_handler', {'type' => 'vhost', 'vhost' => 'clearly.com'} ).data.default_value %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username LangPHP php_get_domain_handler type=vhost vhost=clearly.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{},
   "data":{  
      "php_handler":"cgi"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample

type

string

Required

The type of php.ini file.

Warning
titleImportant:
  • If you set this parameter to vhost, you must also include the vhost parameter.  
  • If you set this parameter to home, the system returns the system default PHP handler.


  • home
  • vhost


vhost

vhost

string

The name of a virtual host.

Warning
titleImportant:

If the type value is vhost, you must use this parameter.  


A virtual host on the system.

 

clearly.com

Returns

Return
Type
Description
Possible values
Example

php_handler

stringThe virtual host's PHP handler.

A valid PHP handler.

cgi