Function WithRequestDocumentRoot

requestoptions.go:33–60

WithRequestDocumentRoot sets the root directory of the PHP application. if resolveSymlink is true, oath declared as root directory will be resolved to its absolute value after the evaluation of any symbolic links. Due to the nature of PHP opcache, root directory path is cached: when using a symlinke

(documentRoot string, resolveSymlink bool)

// symlink is changed without PHP being restarted; enabling this
// directive will set $_SERVER['DOCUMENT_ROOT'] to the real directory path.
func WithRequestDocumentRoot(documentRoot string, resolveSymlink bool) RequestOption {
	return func(o *frankenPHPContext) (err error) {
		v, ok := documentRootCache.Load(documentRoot)
		if !ok {
			// make sure file root is absolute
			v, err = fastabs.FastAbs(documentRoot)
			if err != nil {
				return err
			}

			// prevent the cache to grow forever, this is a totally arbitrary value
			if documentRootCacheLen.Load() < 1024 {
				documentRootCache.LoadOrStore(documentRoot, v)
				documentRootCacheLen.Add(1)
			}
		}

		if resolveSymlink {
			if v, err = filepath.EvalSymlinks(v.(string)); err != nil {
				return err
			}
		}

		o.documentRoot = v.(string)

		return nil
	}
}

// WithRequestResolvedDocumentRoot is similar to WithRequestDocumentRoot
// but doesn't do any checks or resolving on the path to improve performance.