Mojo::Home

Section: User Contributed Perl Documentation (3)
Updated: 2019-01-27
Page Index

NAME

Mojo::Home - Home sweet home

SYNOPSIS

  use Mojo::Home;

  # Find and manage the project root directory
  my $home = Mojo::Home->new;
  $home->detect;
  say $home->child('templates', 'layouts', 'default.html.ep');
  say "$home";

DESCRIPTION

Mojo::Home is a container for home directories based on Mojo::File.

METHODS

Mojo::Home inherits all methods from Mojo::File and implements the following new ones.

detect

  $home = $home->detect;
  $home = $home->detect('My::App');

Detect home directory from the value of the "MOJO_HOME" environment variable or the location of the application class.

rel_file

  my $path = $home->rel_file('foo/bar.html');

Return a new Mojo::Home object relative to the home directory.

OPERATORS

Mojo::Home inherits all overloaded operators from Mojo::File.