{
    "content": [
        {
            "type": "text",
            "text": "# HTML::Mason::ApacheHandler (info)\n\n## NAME\n\nHTML::Mason::ApacheHandler - Mason/modperl interface\n\n## SYNOPSIS\n\nuse HTML::Mason::ApacheHandler;\nmy $ah = HTML::Mason::ApacheHandler->new (..name/value params..);\n...\nsub handler {\nmy $r = shift;\n$ah->handlerequest($r);\n}\n\n## DESCRIPTION\n\nThe ApacheHandler object links Mason to modperl (version 1 or 2),\nrunning components in response to HTTP requests. It is controlled\nprimarily through parameters to the new() constructor.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **ACCESSOR METHODS**\n- **OTHER METHODS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "HTML::Mason::ApacheHandler",
        "section": "",
        "mode": "info",
        "summary": "HTML::Mason::ApacheHandler - Mason/modperl interface",
        "synopsis": "use HTML::Mason::ApacheHandler;\nmy $ah = HTML::Mason::ApacheHandler->new (..name/value params..);\n...\nsub handler {\nmy $r = shift;\n$ah->handlerequest($r);\n}",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 51,
                "subsections": []
            },
            {
                "name": "ACCESSOR METHODS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "OTHER METHODS",
                "lines": 47,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "HTML::Mason::ApacheHandler - Mason/modperl interface\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use HTML::Mason::ApacheHandler;\n\nmy $ah = HTML::Mason::ApacheHandler->new (..name/value params..);\n...\nsub handler {\nmy $r = shift;\n$ah->handlerequest($r);\n}\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The ApacheHandler object links Mason to modperl (version 1 or 2),\nrunning components in response to HTTP requests. It is controlled\nprimarily through parameters to the new() constructor.\n\nPARAMETERS TO THE new() CONSTRUCTOR\napachestatustitle\nTitle that you want this ApacheHandler to appear as under\nApache::Status.  Default is \"HTML::Mason status\".  This is useful\nif you create more than one ApacheHandler object and want them all\nvisible via Apache::Status.\n\nargsmethod\nMethod to use for unpacking GET and POST arguments. The valid\noptions are 'CGI' and 'modperl'; these indicate that a \"CGI.pm\" or\n\"Apache::Request\" object (respectively) will be created for the\npurposes of argument handling.\n\n'modperl' is the default under modperl-1 and requires that you\nhave installed the \"Apache::Request\" package.  Under modperl-2,\nthe default is 'CGI' because \"Apache2::Request\" is still in\ndevelopment.\n\nIf argsmethod is 'modperl', the $r global is upgraded to an\nApache::Request object. This object inherits all Apache methods and\nadds a few of its own, dealing with parameters and file uploads.\nSee \"Apache::Request\" for more information.\n\nIf the argsmethod is 'CGI', the Mason request object ($m) will\nhave a method called \"cgiobject\" available.  This method returns\nthe CGI object used for argument processing.\n\nWhile Mason will load \"Apache::Request\" or \"CGI\" as needed at\nruntime, it is recommended that you preload the relevant module\neither in your httpd.conf or handler.pl file, as this will save\nsome memory.\n\ndeclinedirs\nTrue or false, default is true. Indicates whether Mason should\ndecline directory requests, leaving Apache to serve up a directory\nindex or a \"FORBIDDEN\" error as appropriate. See the allowing\ndirectory requests section of the administrator's manual for more\ninformation about handling directories with Mason.\n\ninterp\nThe interpreter object to associate with this compiler. By default\na new object of the specified interpclass will be created.\n\ninterpclass\nThe class to use when creating a interpreter. Defaults to\nHTML::Mason::Interp.\n",
                "subsections": []
            },
            "ACCESSOR METHODS": {
                "content": "All of the above properties, except interpclass, have standard\naccessor methods of the same name: no arguments retrieves the value,\nand one argument sets it, except for argsmethod, which is not\nsettable.  For example:\n\nmy $ah = HTML::Mason::ApacheHandler->new;\nmy $declinedirs = $ah->declinedirs;\n$ah->declinedirs(1);\n",
                "subsections": []
            },
            "OTHER METHODS": {
                "content": "The ApacheHandler object has a few other publicly accessible methods\nthat may be of interest to end users.\n\nhandlerequest ($r)\nThis method takes an Apache or Apache::Request object representing\na request and translates that request into a form Mason can\nunderstand.  Its return value is an Apache status code.\n\nPassing an Apache::Request object is useful if you want to set\nApache::Request parameters, such as POSTMAX or DISABLEUPLOADS.\n\npreparerequest ($r)\nThis method takes an Apache object representing a request and\nreturns a new Mason request object or an Apache status code.  If it\nis a request object you can manipulate that object as you like, and\nthen call the request object's \"exec\" method to have it generate\noutput.\n\nIf this method returns an Apache status code, that means that it\ncould not create a Mason request object.\n\nThis method is useful if you would like to have a chance to decline\na request based on properties of the Mason request object or a\ncomponent object.  For example:\n\nmy $req = $ah->preparerequest($r);\n# $req must be an Apache status code if it's not an object\nreturn $req unless ref($req);\n\nreturn DECLINED\nunless $req->requestcomp->sourcefile =~ /\\.html$/;\n\n$req->exec;\n\nrequestargs ($r)\nGiven an Apache request object, this method returns a three item\nlist.  The first item is a hash reference containing the arguments\npassed by the client's request.\n\nThe second is an Apache request object.  This is returned for\nbackwards compatibility from when this method was responsible for\nturning a plain Apache object into an Apache::Request object.\n\nThe third item may be a CGI.pm object or \"undef\", depending on the\nvalue of the argsmethod parameter.\n\nperl v5.30.2                      2020-05-22   HTML::Mason::ApacheHandler(3pm)",
                "subsections": []
            }
        }
    }
}