Wordlift_Entity_Service::save_post() - Code Metrics - Inspection of "WIP: Feature/940 no vocabulary" - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#1328)

unknown

created 2021-03-31 10:18 UTC

Wordlift_Entity_Service::save_post() B

↳ Parent: Wordlift_Entity_Service

Complexity

Conditions	10
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
nc	6
nop	3
dl	0
loc	27
rs	7.6666
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * Services: Entity Service.
 *
 * @since 3.1.0
 * @package Wordlift
 * @subpackage Wordlift/includes
 */

use Wordlift\Object_Type_Enum;

/**
 * Provide entity-related services.
 *
 * @since 3.1.0
 * @package Wordlift
 * @subpackage Wordlift/includes
 */
class Wordlift_Entity_Service {

	/**
	 * The Log service.
	 *
	 * @since  3.2.0
	 * @access private
	 * @var \Wordlift_Log_Service $log The Log service.
	 */
	private $log;

	/**
	 * The UI service.
	 *
	 * @since  3.2.0
	 * @access private
	 * @var \Wordlift_UI_Service $ui_service The UI service.
	 */
	private $ui_service;

	/**
	 * The {@link Wordlift_Relation_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
	 */
	private $relation_service;

	/**
	 * The {@link Wordlift_Entity_Uri_Service} instance.
	 *
	 * @since  3.16.3
	 * @access private
	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
	 */
	private $entity_uri_service;

	/**
	 * The entity post type name.
	 *
	 * @since 3.1.0
	 */
	const TYPE_NAME = 'entity';

	/**
	 * The alternative label meta key.
	 *
	 * @since 3.2.0
	 */
	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';

	/**
	 * The alternative label input template.
	 *
	 * @since 3.2.0
	 */
	// TODO: this should be moved to a class that deals with HTML code.
	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                <button class="button wl-delete-button">%s</button>
                </div>';

	/**
	 * A singleton instance of the Entity service.
	 *
	 * @since  3.2.0
	 * @access private
	 * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
	 */
	private static $instance;

	/**
	 * Create a Wordlift_Entity_Service instance.
	 *
	 * @param \Wordlift_UI_Service $ui_service The UI service.
	 * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
	 *
	 * @since 3.2.0
	 *
	 */
	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {

		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );

		$this->ui_service         = $ui_service;
		$this->relation_service   = $relation_service;
		$this->entity_uri_service = $entity_uri_service;

		// Set the singleton instance.
		self::$instance = $this;
	}

	/**
	 * Get the singleton instance of the Entity service.
	 *
	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
	 * @since 3.2.0
	 */
	public static function get_instance() {

		return self::$instance;
	}

	/**
	 * Determines whether a post is an entity or not. Entity is in this context
	 * something which is not an article.
	 *
	 * @param int $post_id A post id.
	 *
	 * @return bool Return true if the post is an entity otherwise false.
	 * @since 3.1.0
	 *
	 */
	public function is_entity( $post_id ) {

		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );

		if ( is_wp_error( $terms ) ) {
			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );

			return false;
		}

		if ( empty( $terms ) ) {
			return false;
		}

		/*
		 * We don't consider an `article` to be an entity.
		 *
		 * @since 3.20.0 At least one associated mustn't be an `article`.
		 *
		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
		 */
		foreach ( $terms as $term ) {
			if ( 1 !== preg_match( '~(^|-)article$~', $term->slug ) ) {
				return true;
			}
		}

		return false;
	}

	/**
	 * Get the proper classification scope for a given entity post
	 *
	 * @param integer $post_id An entity post id.
	 *
	 * @param string $default The default classification scope, `what` if not
	 *                         provided.
	 *
	 * @return string Returns a classification scope (e.g. 'what').
	 * @since 3.5.0
	 *
	 */
	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {

		if ( false === $this->is_entity( $post_id ) ) {
			return $default;
		}

		// Retrieve the entity type
		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
		// Retrieve classification boxes configuration
		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
		foreach ( $classification_boxes as $cb ) {
			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
				return $cb['id'];
			}
		}

		return $default;
	}

	/**
	 * Check whether a {@link WP_Post} is used.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
	 */
	public function is_used( $post_id ) {

		if ( false === $this->is_entity( $post_id ) ) {
			return null;
		}
		// Retrieve the post
		$entity = get_post( $post_id );

		global $wpdb;
		// Retrieve Wordlift relation instances table name
		$table_name = wl_core_get_relation_instances_table_name();

		// Check is it's referenced / related to another post / entity
		$stmt = $wpdb->prepare(
			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
			$entity->ID
		);

		// Perform the query
		$relation_instances = (int) $wpdb->get_var( $stmt );
		// If there is at least one relation instance for the current entity, then it's used
		if ( 0 < $relation_instances ) {
			return true;
		}

		// Check if the entity uri is used as meta_value
		$stmt = $wpdb->prepare(
			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
			$entity->ID,
			wl_get_entity_uri( $entity->ID )

		);
		// Perform the query
		$meta_instances = (int) $wpdb->get_var( $stmt );

		// If there is at least one meta that refers the current entity uri, then current entity is used
		if ( 0 < $meta_instances ) {
			return true;
		}

		// If we are here, it means the current entity is not used at the moment
		return false;
	}

	/**
	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
	 *
	 * @param string $uri The entity URI.
	 *
	 * @return WP_Post|null A WP_Post instance or null if not found.
	 * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
	 *
	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
	 * @since      3.2.0
	 *
	 */
	public function get_entity_post_by_uri( $uri ) {

		return $this->entity_uri_service->get_entity( $uri );
	}

	/**
	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
	 * we check that the post we're saving is the current post.
	 *
	 * @see   https://github.com/insideout10/wordlift-plugin/issues/363
	 *
	 * @since 3.2.0
	 *
	 * @param int $post_id Post ID.
	 * @param WP_Post $post Post object.
	 * @param bool $update Whether this is an existing post being updated or not.
	 */
	public function save_post( $post_id, $post, $update ) {


		// Avoid doing anything if post is autosave or a revision.
		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
			return;
		}

		// We're setting the alternative label that have been provided via the UI
		// (in fact we're using $_REQUEST), while save_post may be also called
		// programmatically by some other function: we need to check therefore if
		// the $post_id in the save_post call matches the post id set in the request.
		//
		// If this is not the current post being saved or if it's not an entity, return.
		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
			return;
		}

		// Get the alt labels from the request (or empty array).
		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();

		if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
			// This is via classic editor, so set the alternative labels.
			$this->set_alternative_labels( $post_id, $alt_labels );
		}


	}

	/**
	 * Set the alternative labels.
	 *
	 * @param int $post_id The post id.
	 * @param array $alt_labels An array of labels.
	 *
	 * @since 3.2.0
	 *
	 */
	public function set_alternative_labels( $post_id, $alt_labels ) {

		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
		// instead of post id.
		if ( ! is_numeric( $post_id ) ) {
			return;
		}

		// Force $alt_labels to be an array
		if ( ! is_array( $alt_labels ) ) {
			$alt_labels = array( $alt_labels );
		}

		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );

		// Delete all the existing alternate labels.
		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );

		// Set the alternative labels.
		foreach ( $alt_labels as $alt_label ) {
			if ( ! empty( $alt_label ) ) {
				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
			}
		}

	}

	/**
	 * Retrieve the alternate labels.
	 *
	 * @param int $post_id Post id.
	 *
	 * @return mixed An array  of alternative labels.
	 * @since 3.2.0
	 *
	 */
	public function get_alternative_labels( $post_id ) {

		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
	}

	/**
	 * Retrieve the labels for an entity, i.e. the title + the synonyms.
	 *
	 * @param int $post_id The entity {@link WP_Post} id.
	 *
	 * @return array An array with the entity title and labels.
	 * @since 3.12.0
	 *
	 */
	public function get_labels( $post_id ) {

		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
	}

	/**
	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
	 *
	 * @param WP_Post $post Post object.
	 *
	 * @since 3.2.0
	 *
	 */
	public function edit_form_before_permalink( $post ) {

		// If it's not an entity, return.
		if ( ! $this->is_entity( $post->ID ) ) {
			return;
		}

		// If disabled by filter, return.
		if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
			return;
		}

		// Print the input template.
		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );

		// Print all the currently set alternative labels.
		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {

			echo $this->get_alternative_label_input( $alt_label );

		};

		// Print the button.
		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );

	}

	/**
	 * Get the URI for the entity with the specified post id.
	 *
	 * @param int $post_id The entity post id.
	 *
	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
	 * @since 3.6.0
	 *
	 */
	private function get_uri_for_post( $post_id ) {

		$log = Wordlift_Log_Service::get_logger( get_class() );

		// If a null is given, nothing to do
		if ( is_null( $post_id ) ) {
			return null;
		}

		$dataset_uri = wl_configuration_get_redlink_dataset_uri();


		if ( empty( $dataset_uri ) ) {
			// Continue even if the dataset uri is not properly configured. It is handled in function wl_build_entity_uri()
			$log->debug( 'Continuing, dataset uri not configured...' );
		}

		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );

		/*
		 * Consider the URI invalid if it doesn't start with the dataset URI.
		 *
		 * @see https://github.com/insideout10/wordlift-plugin/issues/996
		 */
		if ( empty( $dataset_uri ) || 0 !== strpos( $uri, $dataset_uri ) ) {
			$uri = null;
		}

		// Set the URI if it isn't set yet.
		$post_status = get_post_status( $post_id );
		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'inherit' !== $post_status ) {
			$uri = wl_build_entity_uri( $post_id );
			wl_set_entity_uri( $post_id, $uri );
		}

		return $uri;
	}

	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {

		if ( Object_Type_Enum::POST === $type ) {
			return $this->get_uri_for_post( $object_id );
		}

		if ( Object_Type_Enum::USER === $type ) {
			$uri = Wordlift_User_Service::get_instance()->get_uri( $object_id );

			return ( false === $uri ? null : $uri );
		}

		return null;
	}

	/**
	 * Get the alternative label input HTML code.
	 *
	 * @param string $value The input value.
	 *
	 * @return string The input HTML code.
	 * @since 3.2.0
	 *
	 */
	private function get_alternative_label_input( $value = '' ) {

		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
	}

	/**
	 * Get the number of entity posts published in this blog.
	 *
	 * @return int The number of published entity posts.
	 * @since 3.6.0
	 *
	 */
	public function count() {
		global $wpdb;

		// Try to get the count from the transient.
		$count = get_transient( '_wl_entity_service__count' );
		if ( false !== $count ) {
			return $count;
		}

		// Query the count.
		$count = $wpdb->get_var( $wpdb->prepare(
			"SELECT COUNT( DISTINCT( tr.object_id ) )"
			. " FROM {$wpdb->term_relationships} tr"
			. " INNER JOIN {$wpdb->term_taxonomy} tt"
			. "  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
			. " INNER JOIN {$wpdb->terms} t"
			. "  ON t.term_id = tt.term_id AND t.name != %s",
			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
			'article'
		) );

		// Store the count in cache.
		set_transient( '_wl_entity_service__count', $count, 900 );

		return $count;
	}

	/**
	 * Add the entity filtering criterias to the arguments for a `get_posts`
	 * call.
	 *
	 * @param array $args The arguments for a `get_posts` call.
	 *
	 * @return array The arguments for a `get_posts` call.
	 * @since 3.15.0
	 *
	 */
	public static function add_criterias( $args ) {

		// Build an optimal tax-query.
		$tax_query = array(
			'relation' => 'AND',
			array(
				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
				'operator' => 'EXISTS',
			),
			array(
				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
				'field'    => 'slug',
				'terms'    => 'article',
				'operator' => 'NOT IN',
			),
		);

		return $args + array(
				'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
				/*
				 * Ensure compatibility with Polylang.
				 *
				 * @see https://github.com/insideout10/wordlift-plugin/issues/855.
				 * @see https://wordpress.org/support/topic/parse_query-filter-adds-language-taxonomy-to-query/.
				 *
				 * @since 3.19.5
				 */
				'lang'      => '',
				'tax_query' => $tax_query,
			);
	}

	/**
	 * Create a new entity.
	 *
	 * @param string $name The entity name.
	 * @param string $type_uri The entity's type URI.
	 * @param null $logo The entity logo id (or NULL if none).
	 * @param string $status The post status, by default 'publish'.
	 *
	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
	 * @since 3.9.0
	 *
	 */
	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {

		// Create an entity for the publisher.
		$post_id = @wp_insert_post( array(
			'post_type'    => self::TYPE_NAME,
			'post_title'   => $name,
			'post_status'  => $status,
			'post_content' => '',
		) );

		// Return the error if any.
		if ( is_wp_error( $post_id ) ) {
			return $post_id;
		}

		// Set the entity logo.
		if ( $logo && is_numeric( $logo ) ) {
			set_post_thumbnail( $post_id, $logo );
		}

		// Set the entity type.
		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );

		return $post_id;
	}

	/**
	 * Get the entities related to the one with the specified id. By default only
	 * published entities will be returned.
	 *
	 * @param int $id The post id.
	 * @param string $post_status The target post status (default = publish).
	 *
	 * @return array An array of post ids.
	 * @since 3.10.0
	 *
	 */
	public function get_related_entities( $id, $post_status = 'publish' ) {

		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
	}

	/**
	 * Get the list of entities.
	 *
	 * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
	 *
	 * @return array An array of entity posts.
	 * @since 3.12.2
	 *
	 */
	public function get( $params = array() ) {

		// Set the defaults.
		$defaults = array( 'post_type' => 'entity' );

		// Merge the defaults with the provided parameters.
		$args = wp_parse_args( $params, $defaults );

		// Call the `get_posts` function.
		return get_posts( $args );
	}

	/**
	 * The list of post type names which can be used for entities
	 *
	 * Criteria is that the post type is public. The list of valid post types
	 * can be overridden with a filter.
	 *
	 * @return array Array containing the names of the valid post types.
	 * @since 3.15.0
	 *
	 */
	static function valid_entity_post_types() {


		// Ignore builtins in the call to avoid getting attachments.
		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );

		return apply_filters( 'wl_valid_entity_post_types', $post_types );
	}

}


1			<?php
2			/**
3			* Services: Entity Service.
4			*
5			* @since 3.1.0
6			* @package Wordlift
7			* @subpackage Wordlift/includes
8			*/
9
10			use Wordlift\Object_Type_Enum;
11
12			/**
13			* Provide entity-related services.
14			*
15			* @since 3.1.0
16			* @package Wordlift
17			* @subpackage Wordlift/includes
18			*/
19			class Wordlift_Entity_Service {
20
21			/**
22			* The Log service.
23			*
24			* @since 3.2.0
25			* @access private
26			* @var \Wordlift_Log_Service $log The Log service.
27			*/
28			private $log;
29
30			/**
31			* The UI service.
32			*
33			* @since 3.2.0
34			* @access private
35			* @var \Wordlift_UI_Service $ui_service The UI service.
36			*/
37			private $ui_service;
38
39			/**
40			* The {@link Wordlift_Relation_Service} instance.
41			*
42			* @since 3.15.0
43			* @access private
44			* @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
45			*/
46			private $relation_service;
47
48			/**
49			* The {@link Wordlift_Entity_Uri_Service} instance.
50			*
51			* @since 3.16.3
52			* @access private
53			* @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
54			*/
55			private $entity_uri_service;
56
57			/**
58			* The entity post type name.
59			*
60			* @since 3.1.0
61			*/
62			const TYPE_NAME = 'entity';
63
64			/**
65			* The alternative label meta key.
66			*
67			* @since 3.2.0
68			*/
69			const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
70
71			/**
72			* The alternative label input template.
73			*
74			* @since 3.2.0
75			*/
76			// TODO: this should be moved to a class that deals with HTML code.
77			const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
78			<label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
79			<input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
80			<button class="button wl-delete-button">%s</button>
81			</div>';
82
83			/**
84			* A singleton instance of the Entity service.
85			*
86			* @since 3.2.0
87			* @access private
88			* @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
89			*/
90			private static $instance;
91
92			/**
93			* Create a Wordlift_Entity_Service instance.
94			*
95			* @param \Wordlift_UI_Service $ui_service The UI service.
96			* @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
97			* @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
98			*
99			* @since 3.2.0
100			*
101			*/
102			public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
103
104			$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
105
106			$this->ui_service = $ui_service;
107			$this->relation_service = $relation_service;
108			$this->entity_uri_service = $entity_uri_service;
109
110			// Set the singleton instance.
111			self::$instance = $this;
112			}
113
114			/**
115			* Get the singleton instance of the Entity service.
116			*
117			* @return \Wordlift_Entity_Service The singleton instance of the Entity service.
118			* @since 3.2.0
119			*/
120			public static function get_instance() {
121
122			return self::$instance;
123			}
124
125			/**
126			* Determines whether a post is an entity or not. Entity is in this context
127			* something which is not an article.
128			*
129			* @param int $post_id A post id.
130			*
131			* @return bool Return true if the post is an entity otherwise false.
132			* @since 3.1.0
133			*
134			*/
135			public function is_entity( $post_id ) {
136
137			$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
138
139			if ( is_wp_error( $terms ) ) {
140			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
141
142			return false;
143			}
144
145			if ( empty( $terms ) ) {
146			return false;
147			}
148
149			/*
150			* We don't consider an `article` to be an entity.
151			*
152			* @since 3.20.0 At least one associated mustn't be an `article`.
153			*
154			* @see https://github.com/insideout10/wordlift-plugin/issues/835
155			*/
156			foreach ( $terms as $term ) {
157			if ( 1 !== preg_match( '~(^\|-)article$~', $term->slug ) ) {
158			return true;
159			}
160			}
161
162			return false;
163			}
164
165			/**
166			* Get the proper classification scope for a given entity post
167			*
168			* @param integer $post_id An entity post id.
169			*
170			* @param string $default The default classification scope, `what` if not
171			* provided.
172			*
173			* @return string Returns a classification scope (e.g. 'what').
174			* @since 3.5.0
175			*
176			*/
177			public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
178
179			if ( false === $this->is_entity( $post_id ) ) {
180			return $default;
181			}
182
183			// Retrieve the entity type
184			$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
185			$entity_type = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
186			// Retrieve classification boxes configuration
187			$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
188			foreach ( $classification_boxes as $cb ) {
189			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
190			return $cb['id'];
191			}
192			}
193
194			return $default;
195			}
196
197			/**
198			* Check whether a {@link WP_Post} is used.
199			*
200			* @param int $post_id The {@link WP_Post}'s id.
201			*
202			* @return bool\|null Null if it's not an entity, otherwise true if it's used.
203			*/
204			public function is_used( $post_id ) {
205
206			if ( false === $this->is_entity( $post_id ) ) {
207			return null;
208			}
209			// Retrieve the post
210			$entity = get_post( $post_id );
211
212			global $wpdb;
213			// Retrieve Wordlift relation instances table name
214			$table_name = wl_core_get_relation_instances_table_name();
215
216			// Check is it's referenced / related to another post / entity
217			$stmt = $wpdb->prepare(
218			"SELECT COUNT(*) FROM $table_name WHERE object_id = %d",
219			$entity->ID
220			);
221
222			// Perform the query
223			$relation_instances = (int) $wpdb->get_var( $stmt );
224			// If there is at least one relation instance for the current entity, then it's used
225			if ( 0 < $relation_instances ) {
226			return true;
227			}
228
229			// Check if the entity uri is used as meta_value
230			$stmt = $wpdb->prepare(
231			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
232			$entity->ID,
233			wl_get_entity_uri( $entity->ID )
			0 ignored issues – show Deprecated Code introduced 2016-09-15 13:20 UTC by Report Bug Copy Issue Report The function `wl_get_entity_uri()` has been deprecated with message: use Wordlift_Entity_Service::get_instance()->get_uri( $post_id ) This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
234			);
235			// Perform the query
236			$meta_instances = (int) $wpdb->get_var( $stmt );
237
238			// If there is at least one meta that refers the current entity uri, then current entity is used
239			if ( 0 < $meta_instances ) {
240			return true;
241			}
242
243			// If we are here, it means the current entity is not used at the moment
244			return false;
245			}
246
247			/**
248			* Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
249			*
250			* @param string $uri The entity URI.
251			*
252			* @return WP_Post\|null A WP_Post instance or null if not found.
253			* @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
254			*
255			* @since 3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
256			* @since 3.2.0
257			*
258			*/
259			public function get_entity_post_by_uri( $uri ) {
260
261			return $this->entity_uri_service->get_entity( $uri );
262			}
263
264			/**
265			* Fires once a post has been saved. This function uses the $_REQUEST, therefore
266			* we check that the post we're saving is the current post.
267			*
268			* @see https://github.com/insideout10/wordlift-plugin/issues/363
269			*
270			* @since 3.2.0
271			*
272			* @param int $post_id Post ID.
273			* @param WP_Post $post Post object.
274			* @param bool $update Whether this is an existing post being updated or not.
275			*/
276			public function save_post( $post_id, $post, $update ) {
			0 ignored issues – show Unused Code introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report The parameter `$update` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
277
278			// Avoid doing anything if post is autosave or a revision.
279			if ( wp_is_post_autosave( $post ) \|\| wp_is_post_revision( $post ) ) {
280			return;
281			}
282
283			// We're setting the alternative label that have been provided via the UI
284			// (in fact we're using $_REQUEST), while save_post may be also called
285			// programmatically by some other function: we need to check therefore if
286			// the $post_id in the save_post call matches the post id set in the request.
287			//
288			// If this is not the current post being saved or if it's not an entity, return.
289			if ( ! isset( $_REQUEST['post_ID'] ) \|\| $_REQUEST['post_ID'] != $post_id \|\| ! $this->is_entity( $post_id ) ) {
290			return;
291			}
292
293			// Get the alt labels from the request (or empty array).
294			$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
295
296			if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) \|\| isset( $_REQUEST['wl_alternative_label'] ) ) {
297			// This is via classic editor, so set the alternative labels.
298			$this->set_alternative_labels( $post_id, $alt_labels );
299			}
300
301
302			}
303
304			/**
305			* Set the alternative labels.
306			*
307			* @param int $post_id The post id.
308			* @param array $alt_labels An array of labels.
309			*
310			* @since 3.2.0
311			*
312			*/
313			public function set_alternative_labels( $post_id, $alt_labels ) {
314
315			// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
316			// instead of post id.
317			if ( ! is_numeric( $post_id ) ) {
318			return;
319			}
320
321			// Force $alt_labels to be an array
322			if ( ! is_array( $alt_labels ) ) {
323			$alt_labels = array( $alt_labels );
324			}
325
326			$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
327
328			// Delete all the existing alternate labels.
329			delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
330
331			// Set the alternative labels.
332			foreach ( $alt_labels as $alt_label ) {
333			if ( ! empty( $alt_label ) ) {
334			add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
335			}
336			}
337
338			}
339
340			/**
341			* Retrieve the alternate labels.
342			*
343			* @param int $post_id Post id.
344			*
345			* @return mixed An array of alternative labels.
346			* @since 3.2.0
347			*
348			*/
349			public function get_alternative_labels( $post_id ) {
350
351			return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
352			}
353
354			/**
355			* Retrieve the labels for an entity, i.e. the title + the synonyms.
356			*
357			* @param int $post_id The entity {@link WP_Post} id.
358			*
359			* @return array An array with the entity title and labels.
360			* @since 3.12.0
361			*
362			*/
363			public function get_labels( $post_id ) {
364
365			return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
366			}
367
368			/**
369			* Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
370			*
371			* @param WP_Post $post Post object.
372			*
373			* @since 3.2.0
374			*
375			*/
376			public function edit_form_before_permalink( $post ) {
377
378			// If it's not an entity, return.
379			if ( ! $this->is_entity( $post->ID ) ) {
380			return;
381			}
382
383			// If disabled by filter, return.
384			if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
385			return;
386			}
387
388			// Print the input template.
389			$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
390
391			// Print all the currently set alternative labels.
392			foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
393
394			echo $this->get_alternative_label_input( $alt_label );
395
396			};
397
398			// Print the button.
399			$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
400
401			}
402
403			/**
404			* Get the URI for the entity with the specified post id.
405			*
406			* @param int $post_id The entity post id.
407			*
408			* @return null\|string The entity URI or NULL if not found or the dataset URI is not configured.
409			* @since 3.6.0
410			*
411			*/
412			private function get_uri_for_post( $post_id ) {
413
414			$log = Wordlift_Log_Service::get_logger( get_class() );
415
416			// If a null is given, nothing to do
417			if ( is_null( $post_id ) ) {
418			return null;
419			}
420
421			$dataset_uri = wl_configuration_get_redlink_dataset_uri();
			0 ignored issues – show Deprecated Code introduced 2017-01-29 17:36 UTC by Report Bug Copy Issue Report The function `wl_configuration_get_redlink_dataset_uri()` has been deprecated with message: use Wordlift_Configuration_Service::get_instance()->get_dataset_uri(); This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
422
423			if ( empty( $dataset_uri ) ) {
424			// Continue even if the dataset uri is not properly configured. It is handled in function wl_build_entity_uri()
425			$log->debug( 'Continuing, dataset uri not configured...' );
426			}
427
428			$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
429
430			/*
431			* Consider the URI invalid if it doesn't start with the dataset URI.
432			*
433			* @see https://github.com/insideout10/wordlift-plugin/issues/996
434			*/
435			if ( empty( $dataset_uri ) \|\| 0 !== strpos( $uri, $dataset_uri ) ) {
436			$uri = null;
437			}
438
439			// Set the URI if it isn't set yet.
440			$post_status = get_post_status( $post_id );
441			if ( empty( $uri ) && 'auto-draft' !== $post_status && 'inherit' !== $post_status ) {
442			$uri = wl_build_entity_uri( $post_id );
443			wl_set_entity_uri( $post_id, $uri );
444			}
445
446			return $uri;
447			}
448
449			public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
450
451			if ( Object_Type_Enum::POST === $type ) {
452			return $this->get_uri_for_post( $object_id );
453			}
454
455			if ( Object_Type_Enum::USER === $type ) {
456			$uri = Wordlift_User_Service::get_instance()->get_uri( $object_id );
457
458			return ( false === $uri ? null : $uri );
459			}
460
461			return null;
462			}
463
464			/**
465			* Get the alternative label input HTML code.
466			*
467			* @param string $value The input value.
468			*
469			* @return string The input HTML code.
470			* @since 3.2.0
471			*
472			*/
473			private function get_alternative_label_input( $value = '' ) {
474
475			return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
476			}
477
478			/**
479			* Get the number of entity posts published in this blog.
480			*
481			* @return int The number of published entity posts.
482			* @since 3.6.0
483			*
484			*/
485			public function count() {
486			global $wpdb;
487
488			// Try to get the count from the transient.
489			$count = get_transient( '_wl_entity_service__count' );
490			if ( false !== $count ) {
491			return $count;
492			}
493
494			// Query the count.
495			$count = $wpdb->get_var( $wpdb->prepare(
496			"SELECT COUNT( DISTINCT( tr.object_id ) )"
497			. " FROM {$wpdb->term_relationships} tr"
498			. " INNER JOIN {$wpdb->term_taxonomy} tt"
499			. " ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
500			. " INNER JOIN {$wpdb->terms} t"
501			. " ON t.term_id = tt.term_id AND t.name != %s",
502			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
503			'article'
504			) );
505
506			// Store the count in cache.
507			set_transient( '_wl_entity_service__count', $count, 900 );
508
509			return $count;
510			}
511
512			/**
513			* Add the entity filtering criterias to the arguments for a `get_posts`
514			* call.
515			*
516			* @param array $args The arguments for a `get_posts` call.
517			*
518			* @return array The arguments for a `get_posts` call.
519			* @since 3.15.0
520			*
521			*/
522			public static function add_criterias( $args ) {
523
524			// Build an optimal tax-query.
525			$tax_query = array(
526			'relation' => 'AND',
527			array(
528			'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
529			'operator' => 'EXISTS',
530			),
531			array(
532			'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
533			'field' => 'slug',
534			'terms' => 'article',
535			'operator' => 'NOT IN',
536			),
537			);
538
539			return $args + array(
540			'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
541			/*
542			* Ensure compatibility with Polylang.
543			*
544			* @see https://github.com/insideout10/wordlift-plugin/issues/855.
545			* @see https://wordpress.org/support/topic/parse_query-filter-adds-language-taxonomy-to-query/.
546			*
547			* @since 3.19.5
548			*/
549			'lang' => '',
550			'tax_query' => $tax_query,
551			);
552			}
553
554			/**
555			* Create a new entity.
556			*
557			* @param string $name The entity name.
558			* @param string $type_uri The entity's type URI.
559			* @param null $logo The entity logo id (or NULL if none).
560			* @param string $status The post status, by default 'publish'.
561			*
562			* @return int\|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
563			* @since 3.9.0
564			*
565			*/
566			public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
567
568			// Create an entity for the publisher.
569			$post_id = @wp_insert_post( array(
570			'post_type' => self::TYPE_NAME,
571			'post_title' => $name,
572			'post_status' => $status,
573			'post_content' => '',
574			) );
575
576			// Return the error if any.
577			if ( is_wp_error( $post_id ) ) {
578			return $post_id;
579			}
580
581			// Set the entity logo.
582			if ( $logo && is_numeric( $logo ) ) {
583			set_post_thumbnail( $post_id, $logo );
584			}
585
586			// Set the entity type.
587			Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
588
589			return $post_id;
590			}
591
592			/**
593			* Get the entities related to the one with the specified id. By default only
594			* published entities will be returned.
595			*
596			* @param int $id The post id.
597			* @param string $post_status The target post status (default = publish).
598			*
599			* @return array An array of post ids.
600			* @since 3.10.0
601			*
602			*/
603			public function get_related_entities( $id, $post_status = 'publish' ) {
604
605			return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
606			}
607
608			/**
609			* Get the list of entities.
610			*
611			* @param array $params Custom parameters for WordPress' own {@link get_posts} function.
612			*
613			* @return array An array of entity posts.
614			* @since 3.12.2
615			*
616			*/
617			public function get( $params = array() ) {
618
619			// Set the defaults.
620			$defaults = array( 'post_type' => 'entity' );
621
622			// Merge the defaults with the provided parameters.
623			$args = wp_parse_args( $params, $defaults );
624
625			// Call the `get_posts` function.
626			return get_posts( $args );
627			}
628
629			/**
630			* The list of post type names which can be used for entities
631			*
632			* Criteria is that the post type is public. The list of valid post types
633			* can be overridden with a filter.
634			*
635			* @return array Array containing the names of the valid post types.
636			* @since 3.15.0
637			*
638			*/
639			static function valid_entity_post_types() {
			0 ignored issues – show Best Practice introduced 2017-08-28 11:18 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
640
641			// Ignore builtins in the call to avoid getting attachments.
642			$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
643
644			return apply_filters( 'wl_valid_entity_post_types', $post_types );
645			}
646
647			}
648

insideout10 / wordlift-plugin

Pull Request — develop (#1328)

Wordlift_Entity_Service::save_post() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like