You are here

README.txt in Include 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
[1]Include

   Installs and manages files and packages that need to reside on the
   [2]PHP [3]include_path.

   Any file not found on the default [4]include_path is added to the local
   repository, which is then added to the [5]include_path on every page
   load. If an error occurs, the original [6]include_path is restored and
   an error flag is set to prevent further damage.

   This very simple module contains only one externally useful function:

   include_check_path($path, $source = NULL, $type = 'file')
          Verifies or installs a file or directory into the include
          repository.

        Parameters
                $path The target path to install, relative to the include
                file root. If $path is empty or ends in a trailing slash,
                it is interpreted as a directory name, and both $source
                and $type are ignored.

                $source (optional) The file data, or a uri where it may be
                found. If unset or empty, then $path is a directory name,
                and $type is ignored.

                $type (optional) A string which determines how $source is
                to be interpreted. Must be one of the following:

               o 'dir' : $path is a directory name, and $source is
                 ignored.
               o 'file' : (Default) drupal_realpath($source) is a local
                 file.
               o 'url' : $source is a string containing the file data.

        Return value
                TRUE if the file was found or installed; otherwise FALSE.

References

   1. http://drupal.org/project/include
   2. http://php.net/
   3. http://php.net/manual/ini.core.php#ini.include-path
   4. http://php.net/manual/ini.core.php#ini.include-path
   5. http://php.net/manual/ini.core.php#ini.include-path
   6. http://php.net/manual/ini.core.php#ini.include-path

File

README.txt
View source
  1. [1]Include
  2. Installs and manages files and packages that need to reside on the
  3. [2]PHP [3]include_path.
  4. Any file not found on the default [4]include_path is added to the local
  5. repository, which is then added to the [5]include_path on every page
  6. load. If an error occurs, the original [6]include_path is restored and
  7. an error flag is set to prevent further damage.
  8. This very simple module contains only one externally useful function:
  9. include_check_path($path, $source = NULL, $type = 'file')
  10. Verifies or installs a file or directory into the include
  11. repository.
  12. Parameters
  13. $path The target path to install, relative to the include
  14. file root. If $path is empty or ends in a trailing slash,
  15. it is interpreted as a directory name, and both $source
  16. and $type are ignored.
  17. $source (optional) The file data, or a uri where it may be
  18. found. If unset or empty, then $path is a directory name,
  19. and $type is ignored.
  20. $type (optional) A string which determines how $source is
  21. to be interpreted. Must be one of the following:
  22. o 'dir' : $path is a directory name, and $source is
  23. ignored.
  24. o 'file' : (Default) drupal_realpath($source) is a local
  25. file.
  26. o 'url' : $source is a string containing the file data.
  27. Return value
  28. TRUE if the file was found or installed; otherwise FALSE.
  29. References
  30. 1. http://drupal.org/project/include
  31. 2. http://php.net/
  32. 3. http://php.net/manual/ini.core.php#ini.include-path
  33. 4. http://php.net/manual/ini.core.php#ini.include-path
  34. 5. http://php.net/manual/ini.core.php#ini.include-path
  35. 6. http://php.net/manual/ini.core.php#ini.include-path