class-gv-entry-multi.php

Go to the documentation of this file.

<?php
namespace GV;

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

/**
 * The multi-entry Entry implementation.
 *
 * An entry that is really a join of 2+ entries.
 * Used for JOINS in the \GF_Query component.
 */
class Multi_Entry extends Entry implements \ArrayAccess {
    /**
     * The entries in this form.
     */
    public $entries = array();

    /**
     * @var string The identifier of the backend used for this entry.
     * @api
     * @since 2.0
     */
    public static $backend = 'multi';

    /**
     * Initialization.
     */
    private function __construct() {
    }

    /**
     * Construct a multientry from an array of entries.
     *
     * @param \GV\Entry[] $entries The entries.
     *
     * @return \GV\Multi_Entry A multientry object.
     */
    public static function from_entries( $entries ) {
        $_entry = new self();
        foreach ( $entries as &$entry ) {
            if ( ! $entry instanceof Entry ) {
                continue;
            }
            $_entry->entries[ $entry['form_id'] ]  = &$entry;
        }
        return $_entry;
    }

    /**
     * Fake legacy template support.
     *
     * Take the first entry and set it as the current entry.
     * But support nesting.
     *
     * @return array See \GV\Entry::as_entry()
     */
    public function as_entry() {
        $_entry = array();

        if ( $entry = reset( $this->entries ) ) {
            $_entry = $entry->as_entry();

            foreach ( $this->entries as $entry ) {
                $entry = $entry->as_entry();
                $_entry['_multi'][ $entry['form_id'] ] = $entry;
            }
        }

        return $_entry;
    }

    /**
     * Return the link to this multi entry in the supplied context.
     *
     * @api
     * @since 2.2
     *
     * @param \GV\View|null $view The View context.
     * @param \GV\Request $request The Request (current if null).
     * @param boolean $track_directory Keep the housing directory arguments intact (used for breadcrumbs, for example). Default: true.
     *
     * @return string The permalink to this entry.
     */
    public function get_permalink( \GV\View $view = null, \GV\Request $request = null, $track_directory = true ) {
        $slugs = array();
        add_filter( 'gravityview/entry/slug', $callback = function( $slug ) use ( &$slugs ) {
            $slugs[] = $slug;
            return implode( ',', $slugs );
        }, 10, 1 );

        foreach ( $this->entries as $entry ) {
            $permalink = call_user_func_array( array( $entry, __FUNCTION__ ), func_get_args() );
        }

        remove_filter( 'gravityview/entry/slug', $callback );

        return $permalink;
    }

    /**
     * ArrayAccess compatibility layer with a Gravity Forms entry array.
     *
     * @internal
     * @deprecated
     * @since 2.0
     * @return bool Whether the offset exists or not.
     */
    #[\ReturnTypeWillChange]
    public function offsetExists( $offset ) {
        return isset( $this->entries[ $offset ] );
    }

    /**
     * ArrayAccess compatibility layer with a Gravity Forms entry array.
     *
     * Maps the old keys to the new data;
     *
     * @internal
     * @deprecated
     * @since 2.0
     *
     * @return mixed The value of the requested entry data.
     */
    #[\ReturnTypeWillChange]
    public function offsetGet( $offset ) {
        if ( ! $this->offsetExists( $offset ) ) {
            return null;
        }
        return $this->entries[ $offset ];
    }

    /**
     * ArrayAccess compatibility layer with a Gravity Forms entry array.
     *
     * @internal
     * @deprecated
     * @since 2.0
     *
     * @return void
     */
    #[\ReturnTypeWillChange]
    public function offsetSet( $offset, $value ) {
        gravityview()->log->error( 'The underlying multi entry is immutable. This is a \GV\Entry object and should not be accessed as an array.' );
    }

    /**
     * ArrayAccess compatibility layer with a Gravity Forms entry array.
     *
     * @internal
     * @deprecated
     * @since 2.0
     * @return void
     */
    #[\ReturnTypeWillChange]
    public function offsetUnset( $offset ) {
        gravityview()->log->error( 'The underlying multi entry is immutable. This is a \GV\Entry object and should not be accessed as an array.' );
    }
}