—————package
Articulate::Location;
use
strict;
use
warnings;
use
Moo;
use
Exporter::Declare;
default_exports
qw(new_location)
;
=head1 NAME
Articulate::Location - represent an item's location
=cut
=head1 DESCRIPTION
new_location ['zone', 'public', 'article', 'hello-world']
new_location 'zone/public/article/hello-world' # same thing
An object class which represents an item's location within the
Articulate ecosystem. It contains an array of slugs, and stringifies to
the 'file path' representation of them.
=cut
=head1 FUNCTIONS
=head3 new_location
C<new_location> is a constructor. It takes either a string (in the form
of a path) or an arrayref. Either will be stored as an arrayref in the
C<path> attribute.
=cut
sub
new_location {
if
( 1 ==
scalar
@_
) {
if
( blessed
$_
[0] and
$_
[0]->can(
'location'
) ) {
return
$_
[0];
}
elsif
(
ref
$_
[0] eq
'ARRAY'
) {
return
__PACKAGE__->new( {
path
=>
$_
[0] } );
}
elsif
( !
defined
$_
[0] ) {
return
__PACKAGE__->new;
}
elsif
( !
ref
$_
[0] ) {
return
__PACKAGE__->new(
{
path
=> [
grep
{
$_
ne
''
}
split
/\//,
$_
[0] ] } );
}
elsif
(
ref
$_
[0] eq
'HASH'
) {
return
__PACKAGE__->new(
$_
[0] );
}
}
}
=head1 ATTRIBUTE
=head3 path
An arrayref representing the path to the location. This is how the
location is actually stored and is used for overloaded array
dereferencing.
=cut
has
path
=> (
is
=>
'rw'
,
default
=>
sub
{ []; },
);
=head1 METHODS
=head3 location
$location->location->location # same as $location
This method always returns the object itself. It is useful when you
want to allow either an Item or a Location as an argument.
=cut
sub
location {
return
shift
;
}
=head3 to_file_path
Joins the contents of C<path> on C</> and returns the result. This is
used for overloaded stringification.
=cut
sub
to_file_path {
return
join
'/'
, @{
$_
[0]->path };
}
=head1 SEE ALSO
=over
=item * L<Articulate::Item>
=item * L<Articulate::LocationSpecification>
=item * L<Articulate::Navigation>
=back
=cut
1;