Overview

Classes

  • GF_Background_Upgrader
  • GF_Download
  • GF_Forms_Model_Legacy
  • GF_Query_Call
  • GF_Query_Column
  • GF_Query_Condition
  • GF_Query_Literal
  • GF_Query_Series
  • GF_Upgrade
  • GFAddOn
  • GFAddOnFeedsTable
  • GFAPI
  • GFFeedAddOn
  • GFPaymentAddOn
  • GFPaymentStatsTable
  • Gravity_Api

Functions

  • gapi
  • Overview
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 
<?php

/**
 * The Gravity Forms Query Call class.
 */
class GF_Query_Call {
    /**
     * @var string The function name.
     */
    private $_function_name = null;

    /**
     * @var array The parameters.
     */
    private $_parameters = array();

    /**
     * A function call.
     *
     * @param string $function_name The function to call.
     * @param array $parameters The function parameters. Default: []
     */
    public function __construct( $function_name, $parameters = array() ) {
        $this->_function_name = $function_name;
        $this->_parameters = $parameters;
    }

    /**
     * Generate the SQL.
     *
     * The default behavior is to just plop function_name( implode( ', ', $parameters ) ).
     * For other cases, like CAST, check the derived classes.
     *
     * @param GF_Query $query The query.
     *
     * @return string The generated SQL.
     */
    public function sql( $query ) {
        if ( method_exists( $this, strtolower( $this->function_name ) . '_sql' ) ) {
            return call_user_func( array( $this, strtolower( $this->function_name ) . '_sql' ), $query );
        }
        return sprintf( "{$this->function_name}(%s)", implode( ', ', $this->parameters ) );
    }

    /**
     * A cast call.
     *
     * @param GF_Query_Column $column The column to cast.
     * @param string $type The type to cast to.
     *
     * @return GF_Query_Call|null instance or null.
     */
    public static function CAST( $column, $type ) {
        if ( ! $column instanceof GF_Query_Column ) {
            return null;
        }

        return new self( 'CAST', array( $column, $type ) );
    }

    /**
     * A RAND call.
     *
     * @return GF_Query_Call|null instance or null.
     */
    public static function RAND( ) {
        return new self( 'RAND' );
    }

    /**
     * Generate the RAND call SQL.
     *
     * @return string The generated SQL.
     */
    private function rand_sql() {
        return 'RAND()';
    }

    /**
     * Generate the CAST call SQL.
     *
     * @param GF_Query $query The query.
     *
     * @return string The generated SQL.
     */
    private function cast_sql( $query ) {
        if ( ! $this->parameters || count( $this->parameters ) != 2 ) {
            return '';
        }

        list( $column, $type ) = $this->parameters;

        if ( ! in_array( $type, array( GF_Query::TYPE_SIGNED, GF_Query::TYPE_UNSIGNED ) ) ) {
            return '';
        }

        if ( ! $column->field_id || ! $column->source ) {
            return '';
        }

        $id = $column->is_entry_column() ? $column->field_id : 'meta_value';
        return sprintf( 'CAST(`%s`.`%s` AS %s)', $query->_alias( $column->field_id, $column->source, 'c' ), $id, $type );
    }

    /**
     * Retrieve all the columns from the parameters of this call.
     *
     * @return array The columns.
     */
    private function get_columns() {
        $columns = array();
        foreach ( $this->parameters as $p ) {
            if ( $p instanceof GF_Query_Column ) {
                $columns[] = $p;
            }
        }
        return $columns;
    }

    /**
     * Proxy read-only values.
     */
    public function __get( $key ) {
        switch ( $key ):
            case 'parameters':
                return $this->_parameters;
            case 'function_name':
                return $this->_function_name;
            case 'columns':
                return $this->get_columns();
        endswitch;
    }
}
Gravity Forms API API documentation generated by ApiGen