NAME

JsonSQL::Param::OrderBy - JsonSQL::Param::OrderBy object. Stores an array of JsonSQL::Param::Order objects to use for constructing JsonSQL::Query objects.

VERSION

version 0.41

SYNOPSIS

This module constructs a Perl object container of JsonSQL::Param::Order objects.

DESCRIPTION

Object properties:

Array of JsonSQL::Param::Order objects.

Generated parameters:

$orderingArray => \@arrayref

METHODS

Constructor new($orderarrayref, $queryObj, $default_table_rules)

Instantiates and returns a new JsonSQL::Param::OrderBy object, which is an array of JsonSQL::Param::Order objects.

    $orderarrayref              => An arrayref of order hashes used to construct the object.
    $queryObj                   => A reference to the JsonSQL::Query object that will own this object.
    $default_table_rules        => The default whitelist table rules to use to validate access when the table params 
                                   are not provided to the field object. Usually, these are acquired from the table params
                                   of another object (ex: the FROM clause of a SELECT statement).

Returns a JsonSQL::Error object on failure.

ObjectMethod get_ordering -> \@orderingArray

Generates parameters represented by the object for the SQL statement. Returns:

    $orderingArray           => Arrayref of ordering parameters to use for the query. Constructed from child L<JsonSQL::Param::Order> objects.

AUTHOR

Chris Hoefler <bhoefler@draper.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Chris Hoefler.

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