class-gv-source-internal.php

Go to the documentation of this file.

<?php
namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
    die();
}

/**
 * The \GV\Internal_Source class.
 *
 * Data that comes from within the View itself (like custom content).
 */
class Internal_Source extends Source {
    
    /**
     * @var string The identifier of the backend used for this source.
     *
     * @api
     * @since 2.0
     */
    public static $backend = self::BACKEND_INTERNAL;

    /**
     * Get a \GV\Field by Field ID for this data source.
     *
     * @param int $field_id The internal field ID (custom content, etc.)
     *
     * @return \GV\Field|null The requested field or null if not found.
     */
    public static function get_field( /** varargs */ ) {
        $args = func_get_args();

        if ( ! is_array( $args ) || count( $args ) != 1 ) {
            gravityview()->log->error( '{source} expects 1 arguments for ::get_field ($field_id)', array( 'source' => __CLASS__ ) );
            return null;
        }

        /** Unwrap the arguments. */
        list( $field_id ) = $args;

        /** Wrap it up into a \GV\Field. */
        return \GV\Internal_Field::by_id( $field_id );
    }
}