GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOJO::HOME (3)

.ds Aq ’

NAME

Mojo::Home - Home sweet home

CONTENTS

SYNOPSIS



  use Mojo::Home;

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



DESCRIPTION

Mojo::Home is a container for home directories.

ATTRIBUTES

Mojo::Home implements the following attributes.

    parts



  my $parts = $home->parts;
  $home     = $home->parts([home, sri, myapp]);



Home directory parts.

METHODS

Mojo::Home inherits all methods from Mojo::Base 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 application class.

    lib_dir



  my $path = $home->lib_dir;



Path to lib directory of application.

    list_files



  my $files = $home->list_files;
  my $files = $home->list_files(foo/bar);
  my $files = $home->list_files(foo/bar, {hidden => 1});



Portably list all files recursively in directory relative to the home directory.



  # List layouts
  say for @{$home->list_files(templates/layouts)};



These options are currently available:
hidden


  hidden => 1



Include hidden files and directories.

    mojo_lib_dir



  my $path = $home->mojo_lib_dir;



Path to lib directory in which Mojolicious is installed.

    new



  my $home = Mojo::Home->new;
  my $home = Mojo::Home->new(/home/sri/my_app);



Construct a new Mojo::Home object and parse home directory if necessary.

    parse



  $home = $home->parse(/home/sri/my_app);



Parse home directory.

    rel_dir



  my $path = $home->rel_dir(foo/bar);



Portably generate an absolute path for a directory relative to the home directory.

    rel_file



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



Portably generate an absolute path for a file relative to the home directory.

    to_string



  my $str = $home->to_string;



Home directory.

OPERATORS

Mojo::Home overloads the following operators.

    bool



  my $bool = !!$home;



Always true.

    stringify



  my $str = "$home";



Alias for to_string.

SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicious.org>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOJO::HOME (3) 2016-03-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.