Mojo::Home(3pm) User Contributed Perl Documentation Mojo::Home(3pm)NAME
Mojo::Home - Detect and access the project root directory in Mojo
SYNOPSIS
use Mojo::Home;
my $home = Mojo::Home->new;
$home->detect;
DESCRIPTION
Mojo::Home is a container for home directories.
ATTRIBUTES
Mojo::Home implements the following attributes.
"app_class"
my $class = $home->app_class;
$home = $home->app_class('Foo::Bar');
Application class.
METHODS
Mojo::Home inherits all methods from Mojo::Base and implements the following new ones.
"new"
my $home = Mojo::Home->new;
my $home = Mojo::Home->new('/home/sri/myapp');
Construct a new Mojo::Home object.
"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');
Portably list all files recursively in directory relative to the home diectory.
$home->rel_file($home->list_files('templates/layouts')->[1]);
"mojo_lib_dir"
my $path = $home->mojo_lib_dir;
Path to "lib" directory in which Mojolicious is installed.
"parse"
$home = $home->parse('/home/sri/myapp');
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.
"slurp_rel_file"
my $string = $home->slurp_rel_file('foo/bar.html');
Portably read all data at once from file relative to the home directory.
my $content = $home->slurp_rel_file($home->list_files('public')->[1]);
"to_string"
my $string = $home->to_string;
my $string = "$home";
Home directory.
SEE ALSO
Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.
perl v5.14.2 2012-09-05 Mojo::Home(3pm)
Check Out this Related Man Page
Mojo::Command(3pm) User Contributed Perl Documentation Mojo::Command(3pm)NAME
Mojo::Command - Command base class
SYNOPSIS
# Lower case command name
package Mojolicious::Command::mycommand;
# Subclass
use Mojo::Base 'Mojo::Command';
# Take care of command line options
use Getopt::Long 'GetOptions';
# Short description
has description => "My first Mojo command.
";
# Short usage message
has usage => <<"EOF";
usage: $0 mycommand [OPTIONS]
These options are available:
-s, --something Does something.
EOF
# <suitable Futurama quote here>
sub run {
my $self = shift;
# Handle options
local @ARGV = @_;
GetOptions('s|something' => sub { $something = 1 });
# Magic here! :)
}
DESCRIPTION
Mojo::Command is an abstract base class for Mojo commands.
See Mojolicious::Commands for a list of commands that are available by default.
ATTRIBUTES
Mojo::Command implements the following attributes.
"description"
my $description = $command->description;
$command = $command->description('Foo!');
Short description of command, used for the command list.
"quiet"
my $quiet = $command->quiet;
$command = $command->quiet(1);
Limited command output.
"usage"
my $usage = $command->usage;
$command = $command->usage('Foo!');
Usage information for command, used for the help screen.
METHODS
Mojo::Command inherits all methods from Mojo::Base and implements the following new ones.
"app"
my $app = $command->app;
Currently active application.
# Introspect
say "Template path: $_" for @{$command->app->renderer->paths};
"chmod_file"
$command = $command->chmod_file('/home/sri/foo.txt', 0644);
Portably change mode of a file.
"chmod_rel_file"
$command = $command->chmod_rel_file('foo/foo.txt', 0644);
Portably change mode of a file relative to the current working directory.
"class_to_file"
my $file = $command->class_to_file('Foo::Bar');
Convert a class name to a file.
Foo::Bar -> foo_bar
FOO::Bar -> foobar
FooBar -> foo_bar
FOOBar -> foobar
"class_to_path"
my $path = $command->class_to_path('Foo::Bar');
Convert class name to path.
Foo::Bar -> Foo/Bar.pm
"create_dir"
$command = $command->create_dir('/home/sri/foo/bar');
Portably create a directory.
"create_rel_dir"
$command = $command->create_rel_dir('foo/bar/baz');
Portably create a directory relative to the current working directory.
"get_all_data"
my $all = $command->get_all_data;
my $all = $command->get_all_data('Some::Class');
Extract all embedded files from the "DATA" section of a class.
"get_data"
my $data = $command->get_data('foo_bar');
my $data = $command->get_data('foo_bar', 'Some::Class');
Extract embedded file from the "DATA" section of a class.
"help"
$command->help;
Print usage information for command.
"rel_dir"
my $path = $command->rel_dir('foo/bar');
Portably generate an absolute path for a directory relative to the current working directory.
"rel_file"
my $path = $command->rel_file('foo/bar.txt');
Portably generate an absolute path for a file relative to the current working directory.
"render_data"
my $data = $command->render_data('foo_bar', @args);
Render a template from the "DATA" section of the command class.
"render_to_file"
$command = $command->render_to_file('foo_bar', '/home/sri/foo.txt');
Render a template from the "DATA" section of the command class to a file.
"render_to_rel_file"
$command = $command->render_to_rel_file('foo_bar', 'foo/bar.txt');
Portably render a template from the "DATA" section of the command class to a file relative to the current working directory.
"run"
$command->run;
$command->run(@ARGV);
Run command. Meant to be overloaded in a subclass.
"write_file"
$command = $command->write_file('/home/sri/foo.txt', 'Hello World!');
Portably write text to a file.
"write_rel_file"
$command = $command->write_rel_file('foo/bar.txt', 'Hello World!');
Portably write text to a file relative to the current working directory.
SEE ALSO
Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.
perl v5.14.2 2012-09-05 Mojo::Command(3pm)