Child pages
  • cPanel API 2 Functions - PHPINI::getoptions

Versions Compared

Key

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

Description

Excerpt

This function retrieves PHP directive configuration information.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

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
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=PHPINI&cpanel_jsonapi_func=getoptions&dirlist="engine%7coutput_buffering%7cshort_open_tag%7c"&getnull="1"&php_prefix="%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2F"

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 info about PHP directives.
$get_php_directive_info = $cpanel->api2(
    'PHPINI', 'getoptions', 
    array(
        'dirlist'       => 'engine|output_buffering|short_open_tag',
        'getnull'       => '1',
        'php_prefix'    => '/usr/local/cpanel/3rdparty/',
    ) 
);

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 info about PHP directives.
my $get_php_directive_info = $cpliveapi->api2(
    'PHPINI', 'getoptions',
    { 
        'dirlist'       => 'engine|output_buffering|short_open_tag',
        'getnull'       => '1',
        'php_prefix'    => '/usr/local/cpanel/3rdparty/',
    }
);

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 PHPINI getoptions dirlist=engine%7Coutput_buffering%7Cshort_open_tag getnull=1 php_prefix=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2F

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getoptions",
    "data": [
      {
        "info": "Enable the PHP scripting language engine under Apache.",
        "dirvalue": "On",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "engine",
        "section": "PHP"
      },
      {
        "info": "Output buffering allows you to send header lines (including cookies) even\n after you send body content, at the price of slowing PHP's output layer a\n bit.  You can enable output buffering during runtime by calling the output\n buffering functions.  You can also enable output buffering for all files by\n setting this directive to On.  If you wish to limit the size of the buffer\n to a certain size - you can use a maximum number of bytes instead of 'On', as\n a value for this directive (e.g., output_buffering=4096).",
        "dirvalue": "Off",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "output_buffering",
        "section": "PHP"
      },
      {
        "info": "Allow the <? tag.  Otherwise, only <?php and <script> tags are recognized.  \n NOTE: Using short tags should be avoided when developing applications or\n libraries that are meant for redistribution, or deployment on PHP\n servers which are not under your control, because short tags may not\n be supported on the target server. For portable, redistributable code,\n be sure not to use short tags.",
        "dirvalue": "On",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "short_open_tag",
        "section": "PHP"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "PHPINI"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
dirliststring

Required

The list of directives to query.

Note
titleNote:

This function will not fail if you do not include the dirlist parameter. However, a dirlist value is required in order to return configuration information. 


One or more php.ini directives.

Note
titleNotes:
  • Separate multiple directives with the pipe character (|).
  • In WHM API calls, replace each pipe character with %7C.


engine|short_open_tag|output_buffering
getnullBoolean

Whether to include null values in the return data.

This parameter defaults to 0.

  • 1 — Include null values.
  • 0 — Skip null values.
1
php_prefixstring

The PHP installation location to query.

  • /usr/local/
  • /usr/local/php4/
  • /usr/local/cpanel/3rdparty/
Note
titleNote:

In WHM API calls, replace each forward slash character with %2F.


/usr/local/cpanel/3rdparty/

Returns

ReturnTypeDescriptionPossible valuesExample
infostringInformation from the php.ini file about the directive, if it exists.A valid string.
Enable the PHP scripting language engine under Apache.
dirvaluestringThe directive's current option.A valid string.On
commentedBooleanWhether the directive is disabled (commented out) in the php.ini file.
  • 1 — Commented out.
  • 0Not commented out.
0
subsectionstringThe php.ini file subsection that contains the directive.A valid string.Language Options
directivestringThe PHP directive.A PHP directive that you included in the dirlist input parameter.engine
sectionstringThe php.ini file section.A valid string.PHP
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

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