Fey::Role::HasAliasName - A role for objects that bring an alias with them


Fey documentation  | view source Contained in the Fey distribution.

Index


NAME

Top

Fey::Role::HasAliasName - A role for objects that bring an alias with them

VERSION

Top

version 0.40

SYNOPSIS

Top

  package My::Thing;

  use Moose;
  with 'Fey::Role::HasAliasName'
      => { generated_alias_prefix => 'THING' };

DESCRIPTION

Top

This role adds an alias_name attribute to objects, as well as some methods for making use of that alias.

PARAMETERS

Top

generated_alias_prefix

The prefix that generated aliases will have, e.g. LITERAL, FUNCTION, etc. Required.

sql_needs_parens

If true, sql_with_alias() will wrap the output of sql() when generating its own output. Default is false.

METHODS

Top

$obj->alias_name()

Returns the current alias name, if any.

$obj->set_alias_name()

  $obj->set_alias_name('my object');

Sets the current alias name.

$obj->alias()

  $obj->alias('my object')->do_something_else(...);

Sets the current alias name, then returns the object.

$obj->sql_with_alias()

$obj->sql_or_alias()

Returns the appropriate SQL snippet. sql_with_alias will generate an alias if one has not been set (using generated_alias_prefix, above).

BUGS

Top

See Fey for details on how to report bugs.

AUTHOR

Top

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

Top


Fey documentation  | view source Contained in the Fey distribution.