Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Param(3)	      User Contributed Perl Documentation	      Param(3)

NAME
       APR::Request::Param - wrapper for libapreq2's param API.

SYNOPSIS
	 use APR::Request::Param;

	 $arg1 = $req->args('alpha');
	 $body = $req->body;
	 $body->param_class("APR::Request::Param");
	 ok $_->isa("APR::Request::Param") for values %$body;

	 @uploads = grep {$_->upload} values %$body;
	 $param	= $body->get('beta');
	 $param->upload_slurp(my $content);

DESCRIPTION
       The "APR::Request::Param" module	provides base methods for interfacing
       with libapreq2's	param API.  It also provides a few utility functions
       and constants.

       This manpage documents version 2.13 of the APR::Request::Param,
       APR::Request::Brigade, and APR::Request::Brigade::IO packages.

OVERLOADS
       APR::Request::Param

   ""
	   "$param"

       The double-quote	interpolation operator maps to
       "APR::Request::Param::value()".

METHODS
       APR::Request::Param

   name
	   $param->name()

       Returns the param's name.  This attribute cannot	be modified.

   value
	   $param->value()

       Returns the param's value.  This	attribute cannot be modified.

   is_tainted
	   $param->is_tainted()
	   $param->is_tainted($set)

       Get/set the param's internal tainted flag.  Note: if the	param's
       charset is APREQ_CHARSET_UTF8 (8), this also activates the SvUTF8_on
       flag during calls to name() and/or value().

	   $tainted = $param->is_tainted;
	   $param->is_tainted(0);
	   ok $param->is_tainted == 0;

   charset
	   $param->charset()
	   $param->charset($set)

       Get/set the param's internal charset.  The charset is a number between
       0 and 255; the current recognized values	are

       0 APREQ_CHARSET_ASCII	(7-bit us-ascii)
       1 APREQ_CHARSET_LATIN1	(8-bit iso-8859-1)
       2 APREQ_CHARSET_CP1252	(8-bit Windows-1252)
       8 APREQ_CHARSET_UTF8	(utf8 encoded Unicode)

       See is_tainted above for	info about how APREQ_CHARSET_UTF8 relates to
       perl's UTF-8 flag.

	   $charset = $param->charset;
	   $param->charset(2);
	   ok $param->charset == 2;

   make
	   APR::Request::Param->make($pool, $name, $value)

       Fast XS param constructor.

   info
	   $param->info()
	   $param->info($set)

       Get/set the APR::Table headers for this param.

   upload
	   $param->upload()
	   $param->upload($set)

       Get/set the APR::Brigade	file-upload content for	this param.

   upload_filename
	   $param->upload_filename()

       Returns the client-side filename	associated with	this param.

   upload_link
	   $param->upload_link($path)

       Links the file-upload content with the local file named $path.  Creates
       a hard-link if the spoolfile's (see upload_tempname) temporary
       directory is on the same	device as $path; otherwise this	writes a copy.

   upload_slurp
	   $param->upload_slurp($data)

       Reads the entire	file-upload content into $data.

   upload_size
	   $param->upload_size()

       Returns the size	of the param's file-upload content.

   upload_type
	   $param->upload_type()

       Returns the MIME-type of	the param's file-upload	content.

   upload_tempname
	   $param->upload_tempname()

       Returns the name	of the local spoolfile for this	param.

   upload_io
	   $param->upload_io()

       Returns an APR::Request::Brigade::IO object, which can be treated as a
       non-seekable IO stream.

   upload_fh
	   $param->upload_fh()

       Returns a seekable filehandle representing the file-upload content.

METHODS
       APR::Request::Brigade

       This class is derived from APR::Brigade,	providing additional methods
       for TIEHANDLE, READ and READLINE.  To be	memory efficient, these
       methods delete buckets from the brigade as soon as their	data is
       actually	read, so you cannot "seek" on handles tied to this class.
       Such handles have semantics similar to that of a	read-only socket.

   new,	TIEHANDLE
	   APR::Request::Brigade->TIEHANDLE($bb)

       Creates a copy of the bucket brigade represented	by $bb,	and blesses
       that copy into the APR::Request::Brigade	class.	This provides
       syntactic sugar for using perl's	builtin	"read",	"readline", and	"<>"
       operations on handles tied to this package:

	   use Symbol;
	   $fh = gensym;
	   tie *$fh, "APR::Request::Brigade", $bb;
	   print while <$fh>;

   READ
	   $bb->READ($contents)
	   $bb->READ($contents,	$length)
	   $bb->READ($contents,	$length, $offset)

       Reads data from the brigade $bb into $contents.	When omitted $length
       defaults	to "-1", which reads the first bucket into $contents.  A
       positive	$length	will read in $length bytes, or the remainder of	the
       brigade,	whichever is greater. $offset represents the index in $context
       to read the new data.

   READLINE
	   $bb->READLINE()

       Returns the first line of data from the bride. Lines are	terminated by
       linefeeds (the '\012' character), but we	may eventually use $/ instead.

METHODS
       APR::Request::Brigade::IO

   read
       OO interface to APR::Request::Brigade::READ.

   readline
       OO interface to APR::Request::Brigade::READLINE.

SEE ALSO
       APR::Request, APR::Table, APR::Brigade.

COPYRIGHT
	 Licensed to the Apache	Software Foundation (ASF) under	one or more
	 contributor license agreements.  See the NOTICE file distributed with
	 this work for additional information regarding	copyright ownership.
	 The ASF licenses this file to You under the Apache License, Version 2.0
	 (the "License"); you may not use this file except in compliance with
	 the License.  You may obtain a	copy of	the License at

	     http://www.apache.org/licenses/LICENSE-2.0

	 Unless	required by applicable law or agreed to	in writing, software
	 distributed under the License is distributed on an "AS	IS" BASIS,
	 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	 See the License for the specific language governing permissions and
	 limitations under the License.

perl v5.32.0			  2020-08-27			      Param(3)

NAME | SYNOPSIS | DESCRIPTION | OVERLOADS | METHODS | METHODS | METHODS | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=APR::Request::Param&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help