Data::...r::File(3pm)

💖 Data::...r::File(3pm) — the manual, but make it cute 💖

okay bestie, this is the perl doc page for Data::Session::Driver::File, living in the Data::...r::File(3pm) slot of your man pages. it's giving "persistent session manager energy" and honestly? we're obsessed. let's get into it 🫶

---

✨ NAME ✨

Data::Session::Driver::File — a persistent session manager. yes queen, it manages sessions and it persists. 💅

---

🌸 Synopsis 🌸

See Data::Session for details. that's it, that's the synopsis. short king 👑

---

🦋 Description 🦋

Data::Session::Driver::File lets Data::Session manipulate sessions via files. files!! on your disk!! iconic behavior 🌈

to use this module, do this:

• Specify a driver of type File, as Data::Session -> new(type => 'driver:File ...')

---

💅 Case-sensitive Options 💅

See "Case-sensitive Options" in Data::Session for important information. no skimming, bestie, that part is load-bearing 😭

---

🎀 Method: new() 🎀

Creates a new object of type Data::Session::Driver::File. new object, new me, same slay ✨

new() takes a hash of key/value pairs, some of which might be mandatory. further, some combinations might be mandatory. so like, read the fine print, fr fr.

The keys are listed here in alphabetical order. 📚

They are lower-case because they are (also) method names, meaning they can be called to set or get the value at any time. lowercase = also callable = main character energy 👑

• debug => $Boolean — Specifies that debugging should be turned on (1) or off (0) in Data::Session::File::Driver and Data::Session::ID::AutoIncrement. When debug is 1, $! is included in error messages, but because this reveals directory names, it is 0 by default. (directory names stay private, periodt 💀) This key is optional. Default: 0.
• directory => $string — Specifies the path to the directory which will contain the session files. This key is normally passed in as Data::Session -> new(directory => $string). Default: File::Spec -> tmpdir. This key is optional.
• file_name => $string_containing_%s — Specifies the pattern to use for session file names. It must contain 1 '%s', which will be replaced by the session id before the pattern is used as a file name. (exactly one, bestie, not zero, not two 🙈) This key is normally passed in as Data::Session -> new(file_name => $string_containing_%s). Default: 'cgisess_%s'. This key is optional.
• no_flock => $boolean — Specifies (no_flock => 1) to not use flock() to obtain a lock on a session file before processing it, or (no_flock => 0) to use flock(). This key is normally passed in as Data::Session -> new(no_flock => $boolean). Default: 0. This key is optional.
• no_follow => $value — Influences the mode to use when calling sysopen() on session files. 'Influences' means the value is bit-wise ored with O_RDWR for reading and with O_WRONLY for writing. This key is normally passed in as Data::Session -> new(no_follow => $boolean). Default: eval{O_NOFOLLOW} || 0. This key is optional.
• umask => $octal_value — Specifies the mode to use when calling sysopen() on session files. This key is normally passed in as Data::Session -> new(umask => $octal_value). Default: 0660. This key is optional.
• verbose => $integer — Print to STDERR more or less information. Typical values are 0, 1 and 2. This key is normally passed in as Data::Session -> new(verbose => $integer). This key is optional.

---

🍓 Method: remove($id) 🍓

Deletes from storage the session identified by $id. bye babe, we won't miss you 💅

Returns 1 if it succeeds, and dies if it can't. no in-between, no "it's complicated" 😭

---

🧚 Method: retrieve($id) 🧚

Retrieves from storage the session identified by $id, or dies if it can't.

Returns the result of reading the session from the file identified by $id.

This result is a frozen session. This value must be thawed by calling the appropriate serialization driver's thaw() method. ❄️ → 🌸

Data::Session calls the right thaw() automatically. no manual thawing required, she handles it 🫶

---

👑 Method: store($id => $data) 👑

Writes to storage the session identified by $id, together with its data $data.

Storage is a file identified by $id.

Returns 1 if it succeeds, and dies if it can't. same rules as always, bestie 💀

---

🌈 Method: traverse($sub) 🌈

Retrieves all ids via their file names, and for each id calls the supplied subroutine with the id as the only parameter.

Returns 1. always 1. consistent queen ⭐

---

💜 Support 💜

Log a bug on RT: https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Session.

---

⭐ Author ⭐

Data::Session was written by Ron Savage <ron@savage.net.au> in 2010. thank you for your service, king 🫡

Home page: http://savage.net.au/index.html.

---

🌸 Copyright 🌸

Australian copyright (c) 2010, Ron Savage.

All Programs of mine are 'OSI Certified Open Source Software';
you can redistribute them and/or modify them under the terms of
The Artistic License, a copy of which is available at:
http://www.opensource.org/licenses/index.html

---

and that's the whole page, bestie!! 🎀 this was rendered by perl v5.36.0 and dated 2023-02-14 (yes, valentine's day, the romance is real 💖). go forth and manage those sessions, you absolute icon 👑✨