User Tools

Site Tools


Sidebar

en:objects:folder:get_info:get_all_items

This is an old revision of the document!


get_all_items

get_all_items($path,$include_subfolders=false,$only_folders=false,$timeout=60); - this function is used to get all items in the specified folder

The function accepts parameters as input:

  • $path – path to the folder where you want to get all the elements (string). It can be either absolute or relative (relative to the script folder).
  • $include_subfolders – whether to include subfolders (true - include, false - not include) .
  • $only_folders – include only folders (true - only folders, false - both folders and files) .
  • $timeout – maximum time to perform this operation (in seconds), by default - 60 seconds, if the operation is not completed during this time, the script continues to run further.

    After testing, the function returns the result of its work to the script :
  • string with paths to elements – a string with paths to elements in the specified folder, separated by <br> (string)
  • false – there is no such folder (boolean)

    PHP example:

    <?php $xhe_host = "127.0.0.1:7012";
     
    //connect the object to control the emulator, if not already connected
    if(!isset($path))
       $path = "../../../Templates/xweb_human_emulator.php";
    require($path);
     
    //Start
    echo "<hr> <font color = blue> folder->".basename(__FILE__)."</font> <hr>";
     
    //1
    echo "1.Get a list of all elements of the test1 directory from the directory where the script is located: <br>";
    echo $folder->get_all_items("test1")."<br> <br>";
     
    //2
    echo "2.Get a list of all items in the current directory: <br>";
    echo $folder_list = $folder->get_all_items("")."<br> <br>";
     
    //3
    echo "3.Get a list of all subfolders of the current directory including subfolders: <br>";
    echo $folder_list = $folder->get_all_items("", true, true);
     
    //end
    echo "<hr> <br>";
     
    //Quit
    $app->quit();
    ?>

    Python example:

    # Additional paths
    import sys
    sys.path.insert(0, '../../../Templates PY/')
     
    xhe_host = "127.0.0.1:7011"
    from xweb_human_emulator import *
     
    # Start
    echo("<hr> <font color = blue> folder.xxxxxxxxx </font> <hr>")
     
    # 1
    echo("1.Get a list of all elements of the test1 directory from the directory where the script is located: <br>")
    echo(folder.get_all_items("test1"), "<br> <br>")
     
    # 2
    echo("2.Get a list of all items in the current directory: <br>")
    echo(folder.get_all_items(""), "<br> <br>")
     
    # 3
    echo("3.Get a list of all subfolders of the current directory including subfolders: <br>")
    echo(folder.get_all_items("", true, true))
     
    # end
    echo("<hr> <br>")
     
    # Quit
    app.quit()

    C# example:

    #region using
     
    using System;
    using System.Diagnostics;
    using System.Collections.Generic;
    using System.Linq;
    using System.IO;
    using System.Text;
    using System.Threading;
     
    using XHE;
    using XHE.XHE_DOM;
    using XHE.XHE_System;
    using XHE.XHE_Window;
    using XHE.XHE_Web;
     
    #endregion
     
     class Program: XHEScript
     {
    static void Main(string [] args)
    {
    //init XHE
    server = "127.0.0.1:7010";
    InitXHE();
     
    //Start
    echo("<hr> <font color = blue> folder.get_all_items </font> <hr>");
     
    //1 step
    echo("1.Get a list of all elements of the test1 directory from the directory where the script is located: <br> <br>");
    echo(folder.get_all_items("test1") + "<br> <br>");
     
    //step 2
    echo("2.Get a list of all elements of the current directory: <br> <br>");
    echo(folder.get_all_items("") + "<br> <br>");
     
    //step 3
    echo("3.Get a list of all subfolders of the current directory including subfolders: <br> <br>");
    echo(folder.get_all_items("", true, true));
     
    //end
    echo("<hr> <br>");
     
    app.quit();
    }
    }

    Java Script example:

    //connect the object to control the emulator, if not already connected
    xhe_host = "127.0.0.1:7010";
    echo = require("../../../Templates JS/xweb_human_emulator.js");
     
    //Start
    echo("<hr> <font color = blue> folder.get_all_items </font> <hr>");
     
    //1 step
    echo("1.Get a list of all elements of the test1 directory from the directory where the script is located: <br>");
    echo(folder.get_all_items("test1") + "<br> <br>");
     
    //step 2
    echo("2.Get a list of all items in the current directory: <br>");
    echo(folder.get_all_items("") + "<br> <br>");
     
    //step 3
    echo("3.Get a list of all subfolders of the current directory including subfolders: <br>");
    echo(folder.get_all_items("", true, true));
     
    //end
    echo("<hr> <br>");
     
    //Quit
    app.quit();
  • en/objects/folder/get_info/get_all_items.1602678911.txt.gz · Last modified: 2020/10/14 15:35 by sales