Skip to content

Abstract the act of storing references to Subject class #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashfame merged 1 commit into from
Dec 4, 2024
Merged

Abstract the act of storing references to Subject class #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 17 additions & 22 deletions EXTEND.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ add_action( 'data_liberated_product', function( $subject ) {
$date = $subject->date;
$content = $subject->content;

// access entire html source of page
// access the entire HTML source of page
// $subject->source_html

// access transformation output
// $subject->transformed_post();
// access native transformation output
// $subject->get_transformed_post();

// Create a product in your custom post type
$my_product_id = wp_insert_post( array(
Expand All @@ -72,13 +72,11 @@ add_action( 'data_liberated_product', function( $subject ) {
'post_status' => 'publish',
) );

// Store a reference to the source
update_post_meta( $my_product_id, \DotOrg\TryWordPress\Transformer::META_KEY_LIBERATED_SOURCE, $subject->id() );
// Store reference, with a unique slug representing your plugin
$subject->store_reference( $my_product_id, 'mycompany_myplugin_unique_slug' );

// Store a reference to your transformation in the source
$unique_plugin_slug = 'mycompany_myplugin_my_product_type'; // make sure this is unique for your plugin
$meta_key = \DotOrg\TryWordPress\Transformer::META_KEY_LIBERATED_OUTPUT . '_' . $unique_plugin_slug; // definitely use this prefix
update_post_meta( $subject->id(), $meta_key, $my_product_id );
// access your plugin's transformation output
// $subject->get_transformed_post( 'mycompany_myplugin_unique_slug' );
} );
```

Expand All @@ -100,10 +98,9 @@ add_filter( 'data_liberation_preview_transformed_post_id', function( $default_po
}

// Find your transformed product
$unique_plugin_slug = 'mycompany_myplugin_my_product_type'; // make sure this is unique for your plugin
$meta_key = \DotOrg\TryWordPress\Transformer::META_KEY_LIBERATED_OUTPUT . '_' . $unique_plugin_slug; // definitely use this prefix
$product_id = get_post_meta( $subject->id(), $meta_key, true );
return $product_id ? $product_id : $default_post_id;
$post = $subject->get_transformed_post( 'mycompany_myplugin_unique_slug' );

return $post ? $post->ID : $default_post_id;
}, 10, 2 );
```

Expand All @@ -118,11 +115,11 @@ foreach( \DotOrg\TryWordPress\Subject_Repo::loop( 'product' ) as $subject ) {
$date = $subject->date;
$content = $subject->content;

// access entire html source of page
// access the entire HTML source of page
// $subject->source_html

// access transformation output
// $subject->transformed_post();
// access native transformation output
// $subject->get_transformed_post();

// Create a product in your custom post type
$my_product_id = wp_insert_post( array(
Expand All @@ -133,13 +130,11 @@ foreach( \DotOrg\TryWordPress\Subject_Repo::loop( 'product' ) as $subject ) {
'post_status' => 'publish',
) );

// Store a reference to the source
update_post_meta( $my_product_id, \DotOrg\TryWordPress\Transformer::META_KEY_LIBERATED_SOURCE, $subject->id() );
// Store reference, with a unique slug representing your plugin
$subject->store_reference( $my_product_id, 'mycompany_myplugin_unique_slug' );

// Store a reference to your transformation in the source
$unique_plugin_slug = 'mycompany_myplugin_my_product_type'; // make sure this is unique for your plugin
$meta_key = \DotOrg\TryWordPress\Transformer::META_KEY_LIBERATED_OUTPUT . '_' . $unique_plugin_slug; // definitely use this prefix
update_post_meta( $subject->id(), $meta_key, $my_product_id );
// access your plugin's transformation output
// $subject->get_transformed_post( 'mycompany_myplugin_unique_slug' );
}
```

Expand Down
22 changes: 17 additions & 5 deletions src/plugin/class-subject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
class Subject {

private int $id;
private int $transformed_post_id;

public string $source_html;
public string $type;
Expand Down Expand Up @@ -50,15 +49,28 @@ private function __construct( WP_Post $post ) {
$this->title = get_post_meta( $post->ID, 'raw_title', true );
$this->date = get_post_meta( $post->ID, 'raw_date', true );
$this->content = get_post_meta( $post->ID, 'raw_content', true );

$this->transformed_post_id = absint( get_post_meta( $post->ID, Transformer::META_KEY_LIBERATED_OUTPUT, true ) );
}

public function id(): int {
return $this->id;
}

public function transformed_post(): WP_Post {
return WP_Post::get_instance( $this->transformed_post_id );
public function get_transformed_post( string $unique_plugin_slug ): WP_Post {
$meta_key = Transformer::META_KEY_LIBERATED_OUTPUT;
if ( ! empty( $unique_plugin_slug ) ) {
$meta_key .= '_' . $unique_plugin_slug;
}
$transformed_post_id = absint( get_post_meta( $this->id, $meta_key, true ) );

return WP_Post::get_instance( $transformed_post_id );
}

public function store_reference( int $transformed_post_id, string $unique_plugin_slug ): void {
// Store a reference to the source
update_post_meta( $transformed_post_id, Transformer::META_KEY_LIBERATED_SOURCE, $this->id );

// Store a reference to your transformation in the source
$meta_key = Transformer::META_KEY_LIBERATED_OUTPUT . '_' . $unique_plugin_slug;
update_post_meta( $this->id, $meta_key, $transformed_post_id );
}
}