Feature: Include images & captions into export #117

bmarshall511 · 2023-06-12T15:47:27Z

Description of the Change

New feature to include images & captions in the export file, see #22

Closes #22

How to test the Change

Once there are some blog posts with images & captions, go to Print > Print Issues
Under "Export for InDesign, click "Export All"
Unzip the archive and view the .xml file to ensure the images & captions where exported with the rest of the content

Changelog Entry

Added - New feature to include images & captions in the export

Credits

Props @bmarshall511

Checklist:

I agree to follow this project's Code of Conduct.

…/images-captions-export-ben

bmarshall511 · 2023-06-12T16:35:20Z

Gonna open a separate PR for the PHP Standards Scrutinizer failures. Getting lots unrelated to these code changes.

peterwilsoncc · 2023-06-12T23:55:14Z

@bmarshall511 As you'll be opening another PR to address coding standards changes, is it possible to limit this PR to just the functional changes? That will aid with code review and keep the changelog more accurate.

…/images-captions-export-ben

bmarshall511 · 2023-06-13T12:00:34Z

@peterwilsoncc No problem! I've reverted back to the functional changes (minus my IDE auto-fixing some of the coding standard issues in the touched files) and merged develop back in. Let me know if that'll work

includes/functions/articles.php

includes/functions/plugins/article-export.php

dkotter · 2023-07-07T17:01:25Z

includes/functions/articles.php

 			$this->items[] = $post;
 		}
 	}

 	/**
 	 * Generates content for a single row of the table
 	 *
-	 * @param object $item The current item
+	 * @param object                                                         $item The current item


This looks to be an incorrect PHPCS fix because the line below is incorrect (it has the param name first and the type second and those should be switched)

dkotter · 2023-07-07T17:04:31Z

includes/functions/articles.php

@@ -260,7 +275,7 @@ function _column_title( $item, $classes = '', $data = '', $primary = false ) {
 	 */
 	function column_cb( $item ) {
 		return '<input type="checkbox" class="article-status" name="article-status[]" value="' .
-		       ( isset( $item->ID ) ? absint( $item->ID ) : '' ) . '" />';
+				( isset( $item->ID ) ? absint( $item->ID ) : '' ) . '" />';


Here, line 292, 298 and 303, I get these are automated PHPCS fixes but not sure we should even have extra line breaks here to begin with? I'd almost just delete the line break and keep everything on one line, to avoid having extra whitespace show in these inputs

includes/functions/plugins/article-export.php

dkotter · 2023-07-07T17:10:04Z

includes/functions/plugins/article-export.php

+	 * Builds the file name for the zip
+	 * Uses the print issue title & day/time
+	 *
+	 * @uses get_timezone


Doesn't seem like this comment is accurate as this method isn't used here but in get_zip_file_name

dkotter · 2023-07-07T17:12:22Z

includes/functions/plugins/article-status.php

+		'post_status' => __( 'Article Status', 'eight-day-week' ),
+	);
+
+			$title_offset = array_search( 'title', array_keys( $columns ) );


Seems like some extra spacing here

dkotter · 2023-07-07T17:16:39Z

includes/functions/plugins/article-export.php

+
+		$content = $this->article->post_content;
+
+		if ( $post = get_post( get_post_thumbnail_id( $this->id ) ) ) {


We should move the assignment of a variable outside of the if statement:

Suggested change

if ( $post = get_post( get_post_thumbnail_id( $this->id ) ) ) {

$thumbnail = get_post( get_post_thumbnail_id( $this->id ) );

if ( $thumbnail ) {

dkotter · 2023-07-07T17:16:51Z

includes/functions/plugins/article-export.php

+		$content = $this->article->post_content;
+
+		if ( $post = get_post( get_post_thumbnail_id( $this->id ) ) ) {
+			if ( $image = $this->get_image_name( $post->ID ) ) {


Similar to above

dkotter · 2023-07-07T17:19:56Z

includes/functions/plugins/article-export.php

+			}
+		}
+
+		$content = preg_replace_callback(


We're doing a number of regex parsing here and this may be fine but parsing HTML using regex can be flaky. May want to consider using something like DOMDocument

dkotter · 2023-07-07T17:20:49Z

includes/functions/plugins/article-export.php

+				// return $image ? $this->get_image_tag($image[1], $caption) : '';
+				return '';


If I'm reading this correctly, seems like we never return the image since that line is commented out?

Yeah, that's a strange one. I was integrating the code from here, but seems like this block is unneeded as gallery images are still exported without it which is being taken care of here.

I've removed that block of code.

dkotter · 2023-07-07T17:21:21Z

includes/functions/plugins/article-export.php

+		if ( $featured_id = get_post_thumbnail_id( $this->id ) ) {
+			if ( $image = $this->get_image_name( $featured_id ) ) {


Similar to above comment on assigning a variable within an if statement

dkotter · 2023-07-07T17:22:57Z

I've not tested things out yet but did an initial review. I wouldn't be surprised if most of these are pre-existing issues but seems like a good time to fix those up if we're going to be touching those lines of code anyway. Let me know if there's any questions or concerns on that though.

…eight-day-week into feature/images-captions-export-ben

…tions-export-ben

jeffpaul · 2023-07-13T13:37:12Z

Probably good to resolve the items Darin called out here and then any additional ones can be handled in #120

… standards so they can be addressed in another pull request

bmarshall511 · 2023-07-14T18:50:52Z

@dkotter I've updated the code based on your comments & reverted the coding standard updates that were unrelated to this issue. Sorry for the confusion, as I got deeper, realized that would be better to move those updates to their own PR due to the massive amount instead on muddying up this one with a bunch of changes unrelated to the functionality of this PR.

With that being said, I'm not super familiar with this plugin or using the exported XML in programs like InDesign, but based on what I'm seeing in the export files, it all seems to be there. In my testing. worked with single images, gallery images & included captions.

Thanks for checking it out! Let me know if there's anything else I need to hit.

bmarshall511 added 2 commits June 12, 2023 10:18

Integrated code from xlesy for adding images to import, see #22

9b3f881

Code updates to better confirm to coding standards

275fdd9

bmarshall511 requested a review from a team as a code owner June 12, 2023 15:47

bmarshall511 requested review from peterwilsoncc and removed request for a team June 12, 2023 15:47

jeffpaul added this to the 1.3.0 milestone Jun 12, 2023

jeffpaul assigned bmarshall511 Jun 12, 2023

bmarshall511 changed the title ~~Feature/images captions export ben~~ Feature: Include images & captions into export Jun 12, 2023

Merge branch 'develop' of github.com:10up/eight-day-week into feature…

9caa6f2

…/images-captions-export-ben

Merge branch 'develop' of github.com:10up/eight-day-week into feature…

22b7163

…/images-captions-export-ben

bmarshall511 force-pushed the feature/images-captions-export-ben branch from 9caa6f2 to 22b7163 Compare June 13, 2023 11:56

bmarshall511 mentioned this pull request Jun 13, 2023

Update code to conform to WP coding standards #118

Closed

1 task

sksaju reviewed Jun 25, 2023

View reviewed changes

includes/functions/articles.php Outdated Show resolved Hide resolved

sksaju reviewed Jun 25, 2023

View reviewed changes

includes/functions/plugins/article-export.php Outdated Show resolved Hide resolved

sksaju reviewed Jun 25, 2023

View reviewed changes

includes/functions/plugins/article-export.php Outdated Show resolved Hide resolved

fix(qa): minor code updates from qa

1fdce6f

dkotter requested changes Jul 7, 2023

View reviewed changes

Sidsector9 added 2 commits July 11, 2023 13:55

Merge branch 'feature/images-captions-export-ben' of github.com:10up/…

f328881

…eight-day-week into feature/images-captions-export-ben

Merge remote-tracking branch 'origin/develop' into feature/images-cap…

e9f67ca

…tions-export-ben

jeffpaul requested a review from dkotter July 13, 2023 16:05

bmarshall511 added 4 commits July 14, 2023 13:01

revert(code standards): reverted changes that were specific to coding…

282b637

… standards so they can be addressed in another pull request

fix(code review): made code updates based on code review

9fb5ccd

fix(code review): made code updates based on code review

e229035

fix(code review): removed unneeded code

4d1a76d

bmarshall511 mentioned this pull request Jul 17, 2023

Updates to better conform to WP Coding Standards #120

Merged

1 task

dkotter approved these changes Jul 18, 2023

View reviewed changes

dkotter merged commit 424b0d2 into develop Jul 18, 2023

dkotter deleted the feature/images-captions-export-ben branch July 18, 2023 19:46

dkotter mentioned this pull request Sep 13, 2023

Fix a few issues related to PHPCS changes #131

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Include images & captions into export #117

Feature: Include images & captions into export #117

bmarshall511 commented Jun 12, 2023

bmarshall511 commented Jun 12, 2023

peterwilsoncc commented Jun 12, 2023

bmarshall511 commented Jun 13, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter Jul 7, 2023

bmarshall511 Jul 14, 2023

dkotter commented Jul 7, 2023

jeffpaul commented Jul 13, 2023

bmarshall511 commented Jul 14, 2023


		$content = $this->article->post_content;

		if ( $post = get_post( get_post_thumbnail_id( $this->id ) ) ) {

	if ( $post = get_post( get_post_thumbnail_id( $this->id ) ) ) {
	$thumbnail = get_post( get_post_thumbnail_id( $this->id ) );
	if ( $thumbnail ) {

		// return $image ? $this->get_image_tag($image[1], $caption) : '';
		return '';

		if ( $featured_id = get_post_thumbnail_id( $this->id ) ) {
		if ( $image = $this->get_image_name( $featured_id ) ) {

Feature: Include images & captions into export #117

Feature: Include images & captions into export #117

Conversation

bmarshall511 commented Jun 12, 2023

Description of the Change

How to test the Change

Changelog Entry

Credits

Checklist:

bmarshall511 commented Jun 12, 2023

peterwilsoncc commented Jun 12, 2023

bmarshall511 commented Jun 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkotter commented Jul 7, 2023

jeffpaul commented Jul 13, 2023

bmarshall511 commented Jul 14, 2023