<h2>Editing File: /usr/local/cpanel/3rdparty/perl/542/cpanel-lib/Exporter/Tiny/Manual/QuickStart.pod</h2><form method='post'><textarea name='content' class='file-edit'>=pod

=encoding utf-8

=for stopwords frobnicate greps regexps

=head1 NAME

Exporter::Tiny::Manual::QuickStart - the quickest way to get up and running with Exporter::Tiny

=head1 SYNOPSIS

   package MyUtils;
   
   use Exporter::Shiny qw( frobnicate );
   
   sub frobnicate {
      ...;   # your code here
   }
   
   1;

Now people can use your module like this:

   use MyUtils &quot;frobnicate&quot;;
   
   frobnicate(42);

Or like this:

   use MyUtils &quot;frobnicate&quot; =&gt; { -as =&gt; &quot;frob&quot; };
   
   frob(42);

=head1 DESCRIPTION

See the synopsis. Yes, it's that simple.

=head2 Next steps

=head3 Default exports

Note that the module in the synopsis doesn't export anything by default.
If people load C&lt;MyUtils&gt; like this:

   use MyUtils;

Then they haven't imported any functions. You can specify a default set
of functions to be exported like this:

   package MyUtils;
   
   use Exporter::Shiny qw( frobnicate );
   
   our @EXPORT = qw( frobnicate );
   
   sub frobnicate { ... }
   
   1;

Or, if you want to be a superstar rock god:

   package MyUtils;
   
   use Exporter::Shiny our @EXPORT = qw( frobnicate );
   
   sub frobnicate { ... }
   
   1;

=head3 Tags

You can provide tags for people to use:

   package MyUtils;
   
   use Exporter::Shiny qw( frobnicate red green blue );
   
   our %EXPORT_TAGS = (
      utils   =&gt; [qw/ frobnicate /],
      colours =&gt; [qw/ red green blue /],
   );
   
   sub frobnicate { ... }
   sub red        { ... }
   sub green      { ... }
   sub blue       { ... }
   
   1;

And people can now import your functions like this:

   use MyUtils &quot;:colours&quot;;

Or this:

   use MyUtils &quot;-colours&quot;;

Or take advantage of the fact that Perl magically quotes barewords
preceded by a hyphen:

   use MyUtils -colours;

Two tags are automatically defined for you: C&lt;&lt; -default &gt;&gt; (which is
just the same as C&lt;&lt; @EXPORT &gt;&gt;) and C&lt;&lt; -all &gt;&gt; (which is the union of
C&lt;&lt; @EXPORT &gt;&gt; and C&lt;&lt; @EXPORT_OK &gt;&gt;). If you don't like them, then you
can override them:

   our %EXPORT_TAGS = (
      default =&gt; \@some_other_stuff,
      all     =&gt; \@more_stuff,
   );

=head3 Generators

Exporting normally just works by copying a sub from your package into
your caller's package. But sometimes it's useful instead to generate
a I&lt;custom&gt; sub to insert into your caller's package. This is pretty
easy to do.

   package MyUtils;
   
   use Exporter::Shiny qw( frobnicate );
   
   sub _generate_frobnicate {
      my ( $me, $name, $args, $globals ) = @_;
      my $caller = $globals-&gt;{into};
      
      return sub {
          ...;  # your code here
      };
   }
   
   1;

The parameter C&lt;&lt; $me &gt;&gt; here is a string containing the package name
which is being imported from; C&lt;&lt; $caller &gt;&gt; is the destination package;
C&lt;&lt; $name &gt;&gt; is the name of the sub (in this case &quot;frobnicate&quot;); and
C&lt;&lt; $args &gt;&gt; is a custom argument for this function. (By convention,
C&lt;&lt; $args &gt;&gt; is normally a hashref.)

   # The hashref { foo =&gt; 42 } is $args above.
   #
   use MyUtils &quot;frobnicate&quot; =&gt; { foo =&gt; 42 };

=head2 Avoiding Exporter::Shiny

Exporter::Shiny is a tiny shim around Exporter::Tiny. It should mostly
do what you want, but you may sometimes prefer to use Exporter::Tiny
directly.

The example in the synopsis could have been written as:

   package MyUtils;
   
   use parent &quot;Exporter::Tiny&quot;;
   our @EXPORT_OK = qw( frobnicate );
   
   sub frobnicate {
      ...;   # your code here
   }
   
   1;

What Exporter::Shiny does is mostly just to set C&lt;&lt; @EXPORT_OK &gt;&gt; for
you and set up inheritance from the base class (Exporter::Tiny).

Exporter::Shiny also sets C&lt;&lt; $INC{'MyUtils.pm'} &gt;&gt; for you, which in
usually makes little difference, but is useful in some edge cases.

=head1 SEE ALSO

L&lt;https://exportertiny.github.io/&gt;.

L&lt;Exporter::Shiny&gt;,
L&lt;Exporter::Tiny&gt;.

For more advanced information, see
L&lt;Exporter::Tiny::Manual::Exporting&gt;.

=head1 AUTHOR

Toby Inkster E&lt;lt&gt;tobyink@cpan.orgE&lt;gt&gt;.

=head1 COPYRIGHT AND LICENCE

This software is copyright (c) 2013-2014, 2017, 2022-2023 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=head1 DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED &quot;AS IS&quot; AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2Fperl%2F542%2Fcpanel-lib%2FExporter%2FTiny%2FManual'>Back to Directory</a>