« Back to Product

Documentation

IPS_GetScript

 array IPS_GetScript (int $ScriptID) 

Parameters

ScriptID

ID of the script

Returns

The following information is available as key => value pairs:

Index Type Description
IsBroken (until 3.4) boolean TRUE if an error occured during the last execution of the script, otherwise FALSE (since 4.0 replaced by ScriptIsBroken)
LastExecute (until 3.4) float Unix timestamp of the last call (since 4.0 replaced by ScriptExecuted)
ScriptIsBroken (since 4.0) boolean TRUE if an error occured during the last execution of the script, otherwise FALSE
ScriptExecuted (since 4.0) integer Unix timestamp of the last call
ScriptFile string Filename of the script
ScriptID integer ID of the script
ScriptType integer Type of the script (0: PHP script, 1: Flow script, 2: IPSWorkflow)

Description

This function returns an array containing information about the script with the ID ScriptID.

Warning

Since version 4.0 the functionality of version 3.4 and before can be accessed with the function "array IPS_GetScriptCompatibility( integer $ScriptID )".

Example

// Since version 4.0
print_r(IPS_GetScript(46413)); 
/* Examplary output:
Array
(
    [ScriptIsBroken] => 
    [ScriptExecuted] => 1204933792
    [ScriptFile] => 46413.ips.php
    [ScriptID] => 46413
    [ScriptType] => 0
)
*/
 
print_r(IPS_GetScriptCompatibility(46413));
/* Examplary output:
Array
(
    [IsBroken] => 
    [LastExecute] => 1204933792
    [ScriptFile] => 46413.ips.php
    [ScriptID] => 46413
    [ScriptType] => 0
)
*/
 
 
// Until version 3.4
print_r(IPS_GetScript(46413));
/* Examplary output:
Array
(
    [IsBroken] => 
    [LastExecute] => 1204933792
    [ScriptFile] => 46413.ips.php
    [ScriptID] => 46413
    [ScriptType] => 0
)
*/
Any questions?