libapa...:Const(3pm)

📦

version 2.0.13 · 12 versions

💅 NAME 💅

Apache2::Const — the Perl Interface for Apache Constants, aka your little box of magic Apache words 🎀

✨ Synopsis ✨

okay so here's the three whole vibes you can roll with 👇

# make the constants available but don't import them
use Apache2::Const -compile => qw(constant names ...);

# w/o the => syntax sugar
use Apache2::Const ("-compile", qw(constant names ...));

# compile and import the constants
use Apache2::Const qw(constant names ...);

🌸 Description 🌸

This package is basically a lil treasure chest of constants that are specific to Apache features. 🫶

so here's the tea bestie: mod_perl 2.0 ships with several hundreds of constants, and you do not want all of them dumped into your Perl code by default, because that's a whole CPU and memory overhead situation 💀. So instead, when you want a specific constant, you have to explicitly ask for it to be made available. icon behavior honestly.

for example, this code right here:

use Apache2::Const -compile => qw(FORBIDDEN OK);

makes the constants Apache2::Const::FORBIDDEN and Apache2::Const::OK available to your code — but they are not imported. which means you have to use the fully qualified constant, like so:

return Apache2::Const::OK;

BUT if you drop the -compile argument and write:

use Apache2::Const qw(FORBIDDEN OK);

then both constants get imported straight into your code's namespace and you can use them standalone, like:

return OK;

ngl, both of these are kinda a lot... first because importing symbols means extra memory requirements, and second because there are constants in other namespaces (like APR:: and ModPerl::, plus non-mod_perl modules) that might contain the exact same names 👀. so importing constants is not recommended. basically, you want the -compile construct. periodt.

finally, a lil Perl moment: in Perl, => is almost the same as the comma operator. it's syntax sugar that makes it way clearer when there's a key-value relation between two arguments, and it also auto-parses its lefthand argument (the key) as a string, so you don't even need to quote it. slay.

and if that syntax isn't your vibe, instead of writing:

use Apache2::Const -compile => qw(FORBIDDEN OK);

you could write:

use Apache2::Const "-compile", qw(FORBIDDEN OK);

and for the parentheses-lovers out there 🙈:

use Apache2::Const ("-compile", qw(FORBIDDEN OK));

🎀 Constants 🎀

:cmd_how

use Apache2::Const -compile => qw(:cmd_how);

The :cmd_how constants group is the one used by Apache2::Module::add() and $cmds->args_how. 💅

Apache2::Const::FLAG — One of On or Off (full description). since: 2.0.00
Apache2::Const::ITERATE — One argument, occurring multiple times (full description). since: 2.0.00
Apache2::Const::ITERATE2 — Two arguments, the second occurs multiple times (full description). since: 2.0.00
Apache2::Const::NO_ARGS — No arguments at all (full description). since: 2.0.00
Apache2::Const::RAW_ARGS — The command will parse the command line itself (full description). since: 2.0.00
Apache2::Const::TAKE1 — One argument only (full description). since: 2.0.00
Apache2::Const::TAKE12 — One or two arguments (full description). since: 2.0.00
Apache2::Const::TAKE123 — One, two or three arguments (full description). since: 2.0.00
Apache2::Const::TAKE13 — One or three arguments (full description). since: 2.0.00
Apache2::Const::TAKE2 — Two arguments (full description). since: 2.0.00
Apache2::Const::TAKE23 — Two or three arguments (full description). since: 2.0.00
Apache2::Const::TAKE3 — Three arguments (full description). since: 2.0.00

:common

use Apache2::Const -compile => qw(:common);

The :common group is for XXX constants. 🦋

Apache2::Const::AUTH_REQUIRED since: 2.0.00
Apache2::Const::DECLINED since: 2.0.00
Apache2::Const::DONE since: 2.0.00
Apache2::Const::FORBIDDEN since: 2.0.00
Apache2::Const::NOT_FOUND since: 2.0.00
Apache2::Const::OK since: 2.0.00
Apache2::Const::REDIRECT since: 2.0.00
Apache2::Const::SERVER_ERROR since: 2.0.00

:config

use Apache2::Const -compile => qw(:config);

The :config group is for XXX constants. 🌈

Apache2::Const::DECLINE_CMD since: 2.0.00

:conn_keepalive

use Apache2::Const -compile => qw(:conn_keepalive);

The :conn_keepalive constants group is the one used by the $c->keepalive method. ✨

Apache2::Const::CONN_CLOSE — The connection will be closed at the end of the current HTTP request. since: 2.0.00
Apache2::Const::CONN_KEEPALIVE — The connection will be kept alive at the end of the current HTTP request. since: 2.0.00
Apache2::Const::CONN_UNKNOWN — The connection is at an unknown state, e.g., initialized but not open yet. since: 2.0.00

:context

use Apache2::Const -compile => qw(:context);

The :context group is used by the $parms->check_cmd_context method. 💜

Apache2::Const::NOT_IN_VIRTUALHOST — The command is not in a <VirtualHost> block. since: 2.0.00
Apache2::Const::NOT_IN_LIMIT — The command is not in a <Limit> block. since: 2.0.00
Apache2::Const::NOT_IN_DIRECTORY — The command is not in a <Directory> block. since: 2.0.00
Apache2::Const::NOT_IN_LOCATION — The command is not in a <Location>/<LocationMatch> block. since: 2.0.00
Apache2::Const::NOT_IN_FILES — The command is not in a <Files>/<FilesMatch> block. since: 2.0.00
Apache2::Const::NOT_IN_DIR_LOC_FILE — The command is not in a <Files>/<FilesMatch>, <Location>/<LocationMatch> or <Directory> block. since: 2.0.00
Apache2::Const::GLOBAL_ONLY — The directive appears outside of any container directives. since: 2.0.00

:filter_type

use Apache2::Const -compile => qw(:filter_type);

The :filter_type group is for XXX constants. 🧚

Apache2::Const::FTYPE_CONNECTION since: 2.0.00
Apache2::Const::FTYPE_CONTENT_SET since: 2.0.00
Apache2::Const::FTYPE_NETWORK since: 2.0.00
Apache2::Const::FTYPE_PROTOCOL since: 2.0.00
Apache2::Const::FTYPE_RESOURCE since: 2.0.00
Apache2::Const::FTYPE_TRANSCODE since: 2.0.00

:http

use Apache2::Const -compile => qw(:http);

The :http group is for XXX constants. ⭐

Apache2::Const::HTTP_ACCEPTED since: 2.0.00
Apache2::Const::HTTP_BAD_GATEWAY since: 2.0.00
Apache2::Const::HTTP_BAD_REQUEST since: 2.0.00
Apache2::Const::HTTP_CONFLICT since: 2.0.00
Apache2::Const::HTTP_CONTINUE since: 2.0.00
Apache2::Const::HTTP_CREATED since: 2.0.00
Apache2::Const::HTTP_EXPECTATION_FAILED since: 2.0.00
Apache2::Const::HTTP_FAILED_DEPENDENCY since: 2.0.00
Apache2::Const::HTTP_FORBIDDEN since: 2.0.00
Apache2::Const::HTTP_GATEWAY_TIME_OUT since: 2.0.00
Apache2::Const::HTTP_GONE since: 2.0.00
Apache2::Const::HTTP_INSUFFICIENT_STORAGE since: 2.0.00
Apache2::Const::HTTP_INTERNAL_SERVER_ERROR since: 2.0.00
Apache2::Const::HTTP_LENGTH_REQUIRED since: 2.0.00
Apache2::Const::HTTP_LOCKED since: 2.0.00
Apache2::Const::HTTP_METHOD_NOT_ALLOWED since: 2.0.00
Apache2::Const::HTTP_MOVED_PERMANENTLY since: 2.0.00
Apache2::Const::HTTP_MOVED_TEMPORARILY since: 2.0.00
Apache2::Const::HTTP_MULTIPLE_CHOICES since: 2.0.00
Apache2::Const::HTTP_MULTI_STATUS since: 2.0.00
Apache2::Const::HTTP_NON_AUTHORITATIVE since: 2.0.00
Apache2::Const::HTTP_NOT_ACCEPTABLE since: 2.0.00
Apache2::Const::HTTP_NOT_EXTENDED since: 2.0.00
Apache2::Const::HTTP_NOT_FOUND since: 2.0.00
Apache2::Const::HTTP_NOT_IMPLEMENTED since: 2.0.00
Apache2::Const::HTTP_NOT_MODIFIED since: 2.0.00
Apache2::Const::HTTP_NO_CONTENT since: 2.0.00
Apache2::Const::HTTP_OK since: 2.0.00
Apache2::Const::HTTP_PARTIAL_CONTENT since: 2.0.00
Apache2::Const::HTTP_PAYMENT_REQUIRED since: 2.0.00
Apache2::Const::HTTP_PRECONDITION_FAILED since: 2.0.00
Apache2::Const::HTTP_PROCESSING since: 2.0.00
Apache2::Const::HTTP_PROXY_AUTHENTICATION_REQUIRED since: 2.0.00
Apache2::Const::HTTP_RANGE_NOT_SATISFIABLE since: 2.0.00
Apache2::Const::HTTP_REQUEST_ENTITY_TOO_LARGE since: 2.0.00
Apache2::Const::HTTP_REQUEST_TIME_OUT since: 2.0.00
Apache2::Const::HTTP_REQUEST_URI_TOO_LARGE since: 2.0.00
Apache2::Const::HTTP_RESET_CONTENT since: 2.0.00
Apache2::Const::HTTP_SEE_OTHER since: 2.0.00
Apache2::Const::HTTP_SERVICE_UNAVAILABLE since: 2.0.00
Apache2::Const::HTTP_SWITCHING_PROTOCOLS since: 2.0.00
Apache2::Const::HTTP_TEMPORARY_REDIRECT since: 2.0.00
Apache2::Const::HTTP_UNAUTHORIZED since: 2.0.00
Apache2::Const::HTTP_UNPROCESSABLE_ENTITY since: 2.0.00
Apache2::Const::HTTP_UNSUPPORTED_MEDIA_TYPE since: 2.0.00
Apache2::Const::HTTP_UPGRADE_REQUIRED since: 2.0.00
Apache2::Const::HTTP_USE_PROXY since: 2.0.00
Apache2::Const::HTTP_VARIANT_ALSO_VARIES since: 2.0.00