{"id":8054,"date":"2021-08-17T13:16:09","date_gmt":"2021-08-17T13:16:09","guid":{"rendered":"https:\/\/www.scmgalaxy.com\/tutorials\/?p=8054"},"modified":"2021-08-17T13:16:12","modified_gmt":"2021-08-17T13:16:12","slug":"how-to-read-a-whole-file-at-once-in-php","status":"publish","type":"post","link":"https:\/\/www.scmgalaxy.com\/tutorials\/how-to-read-a-whole-file-at-once-in-php\/","title":{"rendered":"How to Read a Whole file at once in PHP?"},"content":{"rendered":"\n

How to Read a Whole file at once?<\/h3>\n\n\n\n

file_get_contents( )<\/code><\/span><\/strong> Function is used to read entire file into a string. This function is the preferred way to read the contents of a file into a string. Because it will use memory mapping techniques, if this is supported by the server, to enhance performance. This function is binary-safe (meaning that both binary data, like images, and character data can be written with this function). The function returns the read data or FALSE on failure.<\/p>\n\n\n\n

What is file_get_contents() Function?<\/h3>\n\n\n\n

The file_get_contents( )<\/code><\/span><\/strong> function in PHP is a built-in function for reading a file and converting it to a string. The function makes advantage of server-supported memory mapping methods, which improves speed and makes it a favored method of reading file data.<\/p>\n\n\n\n

Syntax:<\/strong><\/p>\n\n\n\n

file_get_contents($path, $include_path, $context, \r\n                              $start, $max_length)<\/strong><\/span><\/code><\/pre>\n\n\n\n
Parameters:<\/strong><\/p>\n\n\n\n
The PHP method file_get_contents()<\/strong><\/span><\/code> takes one necessary parameter and four optional options.<\/p>\n\n\n\n
  • $path<\/strong>: It provides the location of the file or directory to be examined.<\/li>
  • $include_path<\/strong>:\u00a0It’s an optional parameter that searches the include path (in php.ini) for a file even if it’s set to 1.<\/li>
  • $context<\/strong>: It is an optional argument for specifying a custom context.<\/li>
  • $start<\/strong>:\u00a0It’s an optional argument that specifies where to start reading from in the file.<\/li>
  • $max_length<\/strong>: It’s an optional parameter that specifies how many bytes should be read.<\/li><\/ul>\n\n\n\n
    Return Value:<\/strong><\/p>\n\n\n\n
    On success, it returns the read data; on failure, it returns FALSE.<\/p>\n\n\n\n
    Errors And Exception<\/strong>:\u00a0<\/p>\n\n\n\n
    • If you wish to open a file that contains special characters like spaces, you must first encode it with urlencode ()<\/span><\/code><\/strong>.<\/li>
    • The file_get_contents()<\/span><\/code><\/strong> method produces a non-Boolean result that evaluates to FALSE, but it can also return a Boolean value.<\/li>
    • If filename cannot be found, maxlength is less than zero, or searching to the given offset in the stream fails, an E WARNING level error is produced.<\/li><\/ul>\n\n\n\n
      Let’s take examples to explain how  file_get_contents()<\/span><\/code> <\/strong> works:-<\/h4>\n\n\n\n
      Input:  file_get_contents('https:\/\/www.scmgalaxy.com\/');\r\nOutput: A computer science portal for scmgalaxy\r\n\r\nInput:  file_get_contents('test.txt', FALSE, NULL, 0, 14);\r\nOutput: A computer science portal for scmgalaxy\n\n\n<\/code><\/pre>\n\n\n\n
      Example 1:-<\/strong><\/p>\n\n\n\n