Document and enforce nummeric array keys starting at 0 for $views->result [#1368508]

Problem/Motivation

Currently there's now clear definition how the array in $views->result has to be indexed.
This lead to some confusion:

Will become superfluous: #1350814: EntityFieldHandlerHelper should not use views row_index as entity_id
#1351524: SearchApiViewsQuery::get_result_wrappers(): Do not use views row_index as entity_id.

Especially because there's views_content_plugin_style_ctools_context (see line 31-34) which enforces numeric keys starting at 0.

Proposed resolution

Enforce numeric array keys starting at 0 for $views->result.
Document the requirement for $views->result and enforce the standard in view::execute().
Update affected code to be compatible. Known projects:

Entity API
Search-API

Remaining tasks

Review patch and ensure the depending projects are ready for the change.
Related tickets:

Will become superfluous: #1350814: EntityFieldHandlerHelper should not use views row_index as entity_id
#1368548: Do not index views results by entity id

User interface changes

none.

API changes

Yes, see Proposed resolution

Comment	File	Size	Author
#4	views-1368508-4.patch	1.4 KB	tim.plunkett
#4
	views-document-enforce-numeric-keys-for-results-array.patch	1.38 KB	das-peter

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #0.0

das-peter CreditAttribution: das-peter commented 12 December 2011 at 15:17

Issue summary:

View changes

Updated issue summary.

Comment #1

das-peter CreditAttribution: das-peter commented 12 December 2011 at 15:37

Created patch for Search API views integration: #1368548: Do not index views results by entity id

Comment #2

merlinofchaos CreditAttribution: merlinofchaos commented 12 December 2011 at 15:52

I'm in favor of this.

Comment #2.0

merlinofchaos CreditAttribution: merlinofchaos commented 12 December 2011 at 15:52

Issue summary:

View changes

Updated issue summary.

Comment #3

dawehner

German

CreditAttribution: dawehner commented 14 December 2011 at 00:11

Status:

Needs review

» Reviewed & tested by the community

This looks fine from my perspective. I also support this idea as there might be some theming related code which already expects such a behavior.

Comment #4

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett commented 5 March 2012 at 17:03

File	Size
views-1368508-4.patch	1.4 KB

Rerolled around some docs changes.

Comment #5

drunken monkey

he/him

German

Vienna, Austria

CreditAttribution: drunken monkey commented 1 July 2012 at 14:15

I finally got round to responding in #1368548-6: Do not index views results by entity id. See there for commit planning discussion.

Comment #6

dawehner

German

CreditAttribution: dawehner commented 16 July 2012 at 07:59

Status:	Reviewed & tested by the community	» Needs work
Issue tags:		+Needs change record

Committed to both 7.x-3.x and 8.x-3.x

Thanks for the work, this is a step towards a 7.x-3.4 release.

This might require some chance notification.

Comment #7

chx CreditAttribution: chx commented 5 August 2012 at 16:32

I would love to sync an efq_views with a Views release after this -- Jorrit fixed efq_views in #1704612: EFQ efq_views_plugin_query::query() should return numeric array and I fixed my tests so we are ready.