SQL::S...nction(3pm)

📦
version 1.414 · 6 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

🌸 SQL::Statement::Function(3pm) 💅

okay so bestie 💖 welcome to the manual page for SQL::Statement::Function(3pm), coming at you live from the User Contributed Perl Documentation. and ngl, this page is not one module — it's a whole friend group 👑: one abstract base class plus five little function-executing terms that inherit from it. let's meet them one by one, no skipping, i promise. ✨

🎀 SQL::Statement::Function

NAME 💖

SQL::Statement::Function — the abstract base class for all function executing terms. she's the blueprint, not the building, and honestly? queen behavior.

SYNOPSIS 🌸

  # this class does not have a common constructor, because all derived classes
  # have their special requirements

DESCRIPTION ✨

SQL::Statement::Function is an abstract base class, and what she does is provide the interface for all function executing terms. literally the template everybody else copies off of. no cap.

INHERITANCE 👑

SQL::Statement::Function
ISA SQL::Statement::Term

METHODS 💅

DESTROY

Destroys the term, and while she's at it she undefines the weak reference to the owner and the reference to the parameter list. clean exit, tidy girl, iconic.

🦋 SQL::Statement::Function::UserFunc

NAME 💖

SQL::Statement::Function::UserFunc — this one implements executing a perl subroutine. yes, we're calling your own subs now, slay.

SYNOPSIS 🌸

  # create an user function term with an SQL::Statement object as owner,
  # specifying the function name, the subroutine name (full qualified)
  # and the parameters to the subroutine
  my $term = SQL::Statement::Function::UserFunc->new( $owner, $name, $sub, \@params );
  # access the result of that operation
  $term->value( $eval );

DESCRIPTION ✨

SQL::Statement::Function::UserFunc implements a term which returns the result of the specified subroutine. she's the middleman and she's thriving.

INHERITANCE 👑

SQL::Statement::Function
ISA SQL::Statement::Term

METHODS 💅

new

Instantiates a new "SQL::Statement::Function::UserFunc" instance. fresh out the box 🎀.

value

Invokes the given subroutine with the values of the params and returns its result — the vibe is exactly this:

    my @params = map { $_->value($eval); } @{ $self->{PARAMS} };
    return $subpkg->$subname( $self->{OWNER}, @params );

🌈 SQL::Statement::Function::NumericEval

NAME 💖

SQL::Statement::Function::NumericEval — implements numeric evaluation of a term. math girlies rise 🧮✨.

SYNOPSIS 🌸

  # create an user function term with an SQL::Statement object as owner,
  # specifying the expression to evaluate and the parameters to the subroutine
  my $term = SQL::Statement::Function::NumericEval->new( $owner, $expr, \@params );
  # access the result of that operation
  $term->value( $eval );

DESCRIPTION ✨

SQL::Statement::Function::NumericEval implements the numeric evaluation of a term. heads up bestie: all parameters are expected to be numeric. don't bring strings to a numbers party.

INHERITANCE 👑

SQL::Statement::Function::NumericEval
ISA SQL::Statement::Function
  ISA SQL::Statement::Term

METHODS 💅

new

Instantiates a new "SQL::Statement::Function::NumericEval" instance. Takes $owner, $expr and \@params as arguments, in exactly that order — order matters, periodt.

value

Returns the result of the evaluated expression. that's it, that's the whole job 💖.

🎀 SQL::Statement::Function::Trim

NAME 💖

SQL::Statement::Function::Trim — implements the built-in trim function support. she trims. it's giving haircut but for strings ✂️.

SYNOPSIS 🌸

  # create an trim function term with an SQL::Statement object as owner,
  # specifying the spec, char and the parameters to the subroutine
  my $term = SQL::Statement::Function::Trim->new( $owner, $spec, $char, \@params );
  # access the result of that operation
  $term->value( $eval );

DESCRIPTION ✨

SQL::Statement::Function::Trim implements string trimming. so clean, so fresh 🧼.

INHERITANCE 👑

SQL::Statement::Function::Trim
ISA SQL::Statement::Function
  ISA SQL::Statement::Term

METHODS 💅

new

Instantiates a new "SQL::Statement::Function::Trim" instance. Takes $owner, $spec, $char and \@params as arguments, in that exact specified order.

and now, the meaning of the parameters 🫶:

  • $spec — can be one of 'LEADING', 'TRAILING', 'BOTH'. Trims the leading chars, the trailing chars, or both ends, respectively. Defaults to 'BOTH'.
  • $char — the character to trim. defaults to ' '.
  • \@params — expected to be an array with exact 1 element (any more than that are not evaluated, so don't bother adding extras bestie).

value

Returns the trimmed value of the first parameter argument. 💅

🧚 SQL::Statement::Function::SubString

NAME 💖

SQL::Statement::Function::SubString — implements the built-in sub-string function support. slicing strings like a boss 🔥.

SYNOPSIS 🌸

  # create an substr function term with an SQL::Statement object as owner,
  # specifying the start and length of the sub string to extract from the
  # first element of \@params
  my $term = SQL::Statement::SubString->new( $owner, $start, $length, \@params );
  # access the result of that operation
  $term->value( $eval );

DESCRIPTION ✨

SQL::Statement::Function::SubString implements a sub-string extraction term. give her a string, she gives you a piece of it. generous.

INHERITANCE 👑

SQL::Statement::Function::SubString
ISA SQL::Statement::Function
  ISA SQL::Statement::Term

METHODS 💅

new

Instantiates a new "SQL::Statement::Function::SubString" instance. Takes $owner, $start, $length and \@params as arguments, in the specified order — yes, order, always order.

meaning of the parameters, let's break it down 🌸:

  • $start — specifies the start position to extract the sub-string. this is expected to be a SQL::Statement::Term instance. and the important detail: the first character in a string has the position 1. (not zero, bestie, do not come in here with your zero-indexed nonsense 🙈)
  • $length — specifies the length of the extracted sub-string. this is expected to be a SQL::Statement::Term instance. if omitted, everything to the end of the string is returned. so generous, so effortless ✨
  • \@params — expected to be an array with exact 1 element (more are not evaluated).

value

Returns the extracted sub-string value from the first parameter argument. periodt. 💅

💜 SQL::Statement::Function::StrConcat

NAME 💖

SQL::Statement::Function::StrConcat — implements the built-in string concatenation. she's the glue holding your strings together, literally 🫶.

SYNOPSIS 🌸

  # create an substr function term with an SQL::Statement object as owner
  # and \@params to concatenate
  my $term = SQL::Statement::StrConcat->new( $owner, \@params );
  # access the result of that operation
  $term->value( $eval );

DESCRIPTION ✨

SQL::Statement::Function::StrConcat implements a string concatenation term. smash those strings together, main character energy 👑.

INHERITANCE 👑

SQL::Statement::Function::StrConcat
ISA SQL::Statement::Function
  ISA SQL::Statement::Term

METHODS 💅

new

Instantiates a new "SQL::Statement::Function::StrConcat" instance. that's the whole description, she's lowkey simple like that.

value

Returns the concatenated string composed of the parameter values. all of them, joined, one happy little family 💖.

Copyright (c) 2009-2020 by Jens Rehsack: rehsackATcpan.org

All rights reserved.

You may distribute this module under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

and that's the whole page bestie 🎀 ty for reading to the end, you ate. this was SQL::S...nction(3pm) from perl v5.30.3, dated 2020-10-23, in the User Contributed Perl Documentation 💅✨ no cap, see you in the next man page. 🦋

📦 where this page comes from