PHP | fgets( ) Function

The fgets() function in PHP is an inbuilt function which is used to return a line from an open file.

  • It is used to return a line from a file pointer and it stops returning at a specified length, on end of file(EOF) or on a new line, whichever comes first.
  • The file to be read and the number of bytes to be read are sent as parameters to the fgets() function and it returns a string of length -1 bytes from the file pointed by the user.
  • It returns False on failure.
  • Syntax:

    fgets(file, length)
    
    Parameters Used:
    The fgets() function in PHP accepts two parameters.
    file : It specifies the file from which characters have 
    to be extracted. 
    length : It specifies the number of bytes to be 
    read by the fgets() function. The default value 
    is 1024 bytes.

    Return Value : It returns a string of length -1 bytes from the file pointed by the user or False on failure.



    Errors And Exceptions

    1. The function is not optimised for large files since it reads a single line at a time and it may take a lot of time to completely read a long file.
    2. The buffer must be cleared if the fgets() function is used multiple times.
    3. The fgets() function returns Boolean False but many times it happens that it returns a non-Boolean value which evaluates to False.

    Suppose there is a file named “gfg.txt” which consists of :

    This is the first line.
    This is the second line.
    This is the third line.

    Program 1

    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

    <?php
    // file is opened using fopen() function
    $my_file = fopen("gfg.txt", "rw");
      
    // Prints a single line from the opened file pointer
    echo fgets($my_file);
      
    // file is closed using fclose() function
    fclose($my_file);
    ?>

    chevron_right

    
    

    Output:

    This is the first line.

    Program 2

    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

    <?php
    //file is opened using fopen() function
    $my_file = fopen("gfg.txt", "rw");
      
    // prints a single line at a time until end of file is reached
    while (! feof ($my_file))
      {
      echo fgets($my_file);
      }
      
    // file is closed using fclose() function
    fclose($my_file);
    ?>

    chevron_right

    
    

    Output:

    This is the first line.
    This is the second line.
    This is the third line.
    

    Reference:
    http://php.net/manual/en/function.fgets.php



    My Personal Notes arrow_drop_up

    I am a technology enthusiast who has a keen interest in programming I am pursuing Engineering in Computer Science from GEU, Dehradun I like to unwind by watching movies and English sitcomsI have a keen interest in music

    If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

    Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




    Article Tags :
    Practice Tags :


    1


    Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.