Automattic\WooCommerce\Admin\Notes

DataStore{} WC 1.0

WC Admin Note Data Store (Custom Tables)

Return

null. Nothing.

Usage

$DataStore = new DataStore();
// use class methods

Methods

1. ERROR: no method name found on line ``
2. isset( $note_row->is_read ) && $note->set_is_read( (bool) $note_row->is_read )
3. ERROR: no method name found on line ``
4. set_name( $note_row->name )
5. ERROR: no method name found on line ``
6. ERROR: no method name found on line ``
7. ERROR: no method name found on line ``
8. read_actions( &$note )
9. ERROR: no method name found on line ` * Fires when an admin note is loaded.`
10. ERROR: no method name found on line ``
11. ERROR: no method name found on line ``
12. ERROR: no method name found on line ``
13. ERROR: no method name found on line ` } else {`
14. gmdate( 'Y-m-d H:i:s', $date_created_timestamp )
15. ERROR: no method name found on line ` * Fires when an admin note is loaded.`
16. do_action( 'woocommerce_note_updated', $note->get_id() )
17. ERROR: no method name found on line ` * Fires when an admin note is loaded.`
18. set_is_deleted( (bool) $note_row->is_deleted )
19. ERROR: no method name found on line ` }`
20. ERROR: no method name found on line ` );`
21. ERROR: no method name found on line ``
22. ERROR: no method name found on line ``
23. ERROR: no method name found on line ` 'primary' => (bool) $action->is_primary,`
24. read( &$note )
25. ERROR: no method name found on line ``
26. if ( 0 !== $note_id || '0' !== $note_id )
27. ERROR: no method name found on line ` * @param int $note_id Note ID.`
28. ERROR: no method name found on line ` */`
29. ERROR: no method name found on line ` "SELECT * FROM {$wpdb->prefix}wc_admin_notes WHERE note_id = %d LIMIT 1",`
30. save_meta_data()
31. ERROR: no method name found on line ``
32. ERROR: no method name found on line ` }`
33. ERROR: no method name found on line ``
34. ERROR: no method name found on line ` */`
35. ERROR: no method name found on line ` * @param Note $note Admin note.`
36. ERROR: no method name found on line ` /**`
37. ERROR: no method name found on line ``
38. ERROR: no method name found on line ``
39. create( &$note )
40. ERROR: no method name found on line ``
41. delete( &$note, $args = array() )
42. ERROR: no method name found on line ``
43. ERROR: no method name found on line ``
44. ERROR: no method name found on line ``
45. get_notes_count( $type = array(), $status = array() )
46. ERROR: no method name found on line ` global $wpdb;`
47. ERROR: no method name found on line ``
48. ERROR: no method name found on line ``
49. ERROR: no method name found on line ``
50. update( &$note )
51. get_is_read()
52. set_date_reminder( $note_row->date_reminder )
53. ERROR: no method name found on line ` */`
54. ERROR: no method name found on line ` * @param string $name Name to search for.`
55. ERROR: no method name found on line ``
56. ERROR: no method name found on line ``
57. ERROR: no method name found on line ``
58. ERROR: no method name found on line ``
59. get_col(
60. ERROR: no method name found on line ` }`
61. ERROR: no method name found on line ` 'label' => $action->label,`
62. ERROR: no method name found on line ` * @param int $note_id Note ID.`
63. set_date_created( $note_row->date_created )
64. ERROR: no method name found on line ` return false;`
65. ERROR: no method name found on line ` global $wpdb;`
66. ERROR: no method name found on line ``
67. set_layout( $note_row->layout )
68. ERROR: no method name found on line ` "SELECT action_id, name, label, query, status, is_primary, actioned_text, nonce_action, nonce_name`
69. ERROR: no method name found on line ` } else {`
70. ERROR: no method name found on line ` /**`
71. ERROR: no method name found on line ` );`
72. ERROR: no method name found on line ` * @param Note $note Admin note.`
73. get_notes_where_clauses( $args = array() )
74. get_escaped_arguments_array_by_key( $args, 'status', $allowed_statuses )
75. ERROR: no method name found on line ``
76. ERROR: no method name found on line ``
77. ERROR: no method name found on line ` * Fires when an admin note is deleted.`
78. ERROR: no method name found on line ``
79. ERROR: no method name found on line ``
80. ERROR: no method name found on line ``
81. ERROR: no method name found on line ``
82. ERROR: no method name found on line ``
83. ERROR: no method name found on line ``
84. ERROR: no method name found on line ` *`
85. ERROR: no method name found on line ``
86. ERROR: no method name found on line ``
87. ERROR: no method name found on line ``
88. ERROR: no method name found on line ``
89. ERROR: no method name found on line ``
90. ERROR: no method name found on line ` 'date_created' => $date_created_to_db,`
91. ERROR: no method name found on line ``
92. ERROR: no method name found on line ` }`
93. ERROR: no method name found on line ` global $wpdb;`
94. ERROR: no method name found on line ` * @param Note $note Admin note.`
95. ERROR: no method name found on line ``
96. ERROR: no method name found on line ``
97. ERROR: no method name found on line ``
98. ERROR: no method name found on line ``
99. ERROR: no method name found on line ``
100. ERROR: no method name found on line ``
101. ERROR: no method name found on line ``
102. ERROR: no method name found on line ``
103. set_defaults()
104. ERROR: no method name found on line ``
105. ERROR: no method name found on line ``
106. get_notes( $args = array() )
107. get_notes_with_name( $name )
108. ERROR: no method name found on line ``
109. ERROR: no method name found on line ``
110. ERROR: no method name found on line ``
111. ERROR: no method name found on line ``
112. ERROR: no method name found on line ``
113. ERROR: no method name found on line ` /**`
114. ERROR: no method name found on line ` }`
115. ERROR: no method name found on line ` /**`
116. ERROR: no method name found on line ``
117. ERROR: no method name found on line ``
118. ERROR: no method name found on line ``
119. ERROR: no method name found on line ``
120. elseif ( is_array( $content_data ) )
121. ERROR: no method name found on line ` * Filter the notes WHERE clause before retrieving the data.`
122. implode( ',', $where_type_array )
123. get_title()
124. ERROR: no method name found on line ` *`
125. ERROR: no method name found on line ` }`
126. ERROR: no method name found on line ` *`
127. foreach ( $db_actions as $action )
128. ERROR: no method name found on line ``
129. ERROR: no method name found on line ` /**`
130. ERROR: no method name found on line ` $note_row = false;`
131. read_meta_data()
132. ERROR: no method name found on line ``
133. ERROR: no method name found on line ` 'nonce_name' => $action->nonce_name,`
134. ERROR: no method name found on line ` /**`
135. ERROR: no method name found on line ``
136. ERROR: no method name found on line ``
137. ERROR: no method name found on line ` }`
138. ERROR: no method name found on line ` 'nonce_action' => $action->nonce_action,`
139. ERROR: no method name found on line ``
140. ERROR: no method name found on line ` *`
141. ERROR: no method name found on line ` 'page' => 1,`
142. ERROR: no method name found on line ``
143. ERROR: no method name found on line ``
144. ERROR: no method name found on line ``
145. set_id( null )
146. ERROR: no method name found on line ` * @return array the escaped array of argument values.`
147. ERROR: no method name found on line ``
148. ERROR: no method name found on line ``
149. ERROR: no method name found on line ``
150. ERROR: no method name found on line ``
151. ERROR: no method name found on line ` * @param Note $note Admin note.`
152. ERROR: no method name found on line ` *`
153. ERROR: no method name found on line ` } else {`
154. ERROR: no method name found on line ` 'primary' => (bool) $action->is_primary,`
155. ERROR: no method name found on line ` * @param string $status Comma separated list of statuses.`
156. ERROR: no method name found on line ``
157. ERROR: no method name found on line ` * @param Note $note Note object.`
158. get_image()
159. wp_json_encode( $note->get_content_data() )
160. ERROR: no method name found on line ``
161. ERROR: no method name found on line ``
162. ERROR: no method name found on line ` '%s',`
163. set_image( $note_row->image )
164. ERROR: no method name found on line ``
165. ERROR: no method name found on line ``
166. save_actions( &$note )
167. ERROR: no method name found on line ``
168. ERROR: no method name found on line ``
169. ERROR: no method name found on line ` *`
170. ERROR: no method name found on line ` );`
171. json_decode( $note_row->content_data )
172. ERROR: no method name found on line ` $data_format`
173. ERROR: no method name found on line ` }`
174. ERROR: no method name found on line ``
175. ERROR: no method name found on line ` );`
176. ERROR: no method name found on line ``
177. ERROR: no method name found on line ` *`
178. ERROR: no method name found on line ` * Parses the query arguments passed in as arrays and escapes the values.`
179. ERROR: no method name found on line ``
180. ERROR: no method name found on line ``
181. ERROR: no method name found on line ``
182. ERROR: no method name found on line ` $escaped_is_deleted = '';`
183. ERROR: no method name found on line ``
184. prepare(
185. ERROR: no method name found on line ``

Code of DataStore{} DataStore{} ^{WC 6.1.1}

class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Interface {
	/**
	 * Method to create a new note in the database.
	 *
	 * @param Note $note Admin note.
	 */
	public function create( &$note ) {
		$date_created = time();
		$note->set_date_created( $date_created );

		global $wpdb;

		$note_to_be_inserted = array(
			'name'         => $note->get_name(),
			'type'         => $note->get_type(),
			'locale'       => $note->get_locale(),
			'title'        => $note->get_title(),
			'content'      => $note->get_content(),
			'status'       => $note->get_status(),
			'source'       => $note->get_source(),
			'is_snoozable' => (int) $note->get_is_snoozable(),
			'layout'       => $note->get_layout(),
			'image'        => $note->get_image(),
			'is_deleted'   => (int) $note->get_is_deleted(),
		);

		$note_to_be_inserted['content_data']  = wp_json_encode( $note->get_content_data() );
		$note_to_be_inserted['date_created']  = gmdate( 'Y-m-d H:i:s', $date_created );
		$note_to_be_inserted['date_reminder'] = null;

		$wpdb->insert( $wpdb->prefix . 'wc_admin_notes', $note_to_be_inserted );
		$note_id = $wpdb->insert_id;
		$note->set_id( $note_id );
		$note->save_meta_data();
		$this->save_actions( $note );
		$note->apply_changes();

		/**
		 * Fires when an admin note is created.
		 *
		 * @param int $note_id Note ID.
		 */
		do_action( 'woocommerce_note_created', $note_id );
	}

	/**
	 * Method to read a note.
	 *
	 * @param Note $note Admin note.
	 * @throws \Exception Throws exception when invalid data is found.
	 */
	public function read( &$note ) {
		global $wpdb;

		$note->set_defaults();
		$note_row = false;

		$note_id = $note->get_id();
		if ( 0 !== $note_id || '0' !== $note_id ) {
			$note_row = $wpdb->get_row(
				$wpdb->prepare(
					"SELECT * FROM {$wpdb->prefix}wc_admin_notes WHERE note_id = %d LIMIT 1",
					$note->get_id()
				)
			);
		}

		if ( 0 === $note->get_id() || '0' === $note->get_id() ) {
			$this->read_actions( $note );
			$note->read_meta_data();
			$note->set_object_read( true );

			/**
			 * Fires when an admin note is loaded.
			 *
			 * @param int $note_id Note ID.
			 */
			do_action( 'woocommerce_note_loaded', $note );
		} elseif ( $note_row ) {
			$note->set_name( $note_row->name );
			$note->set_type( $note_row->type );
			$note->set_locale( $note_row->locale );
			$note->set_title( $note_row->title );
			$note->set_content( $note_row->content );

			// The default for 'content_value' used to be an array, so there might be rows with invalid data!
			$content_data = json_decode( $note_row->content_data );
			if ( ! $content_data ) {
				$content_data = new \stdClass();
			} elseif ( is_array( $content_data ) ) {
				$content_data = (object) $content_data;
			}
			$note->set_content_data( $content_data );

			$note->set_status( $note_row->status );
			$note->set_source( $note_row->source );
			$note->set_date_created( $note_row->date_created );
			$note->set_date_reminder( $note_row->date_reminder );
			$note->set_is_snoozable( $note_row->is_snoozable );
			$note->set_is_deleted( (bool) $note_row->is_deleted );
			isset( $note_row->is_read ) && $note->set_is_read( (bool) $note_row->is_read );
			$note->set_layout( $note_row->layout );
			$note->set_image( $note_row->image );
			$this->read_actions( $note );
			$note->read_meta_data();
			$note->set_object_read( true );

			/**
			 * Fires when an admin note is loaded.
			 *
			 * @param int $note_id Note ID.
			 */
			do_action( 'woocommerce_note_loaded', $note );
		} else {
			throw new \Exception( __( 'Invalid admin note', 'woocommerce' ) );
		}
	}

	/**
	 * Updates a note in the database.
	 *
	 * @param Note $note Admin note.
	 */
	public function update( &$note ) {
		global $wpdb;

		if ( $note->get_id() ) {
			$date_created           = $note->get_date_created();
			$date_created_timestamp = $date_created->getTimestamp();
			$date_created_to_db     = gmdate( 'Y-m-d H:i:s', $date_created_timestamp );

			$date_reminder = $note->get_date_reminder();
			if ( is_null( $date_reminder ) ) {
				$date_reminder_to_db = null;
			} else {
				$date_reminder_timestamp = $date_reminder->getTimestamp();
				$date_reminder_to_db     = gmdate( 'Y-m-d H:i:s', $date_reminder_timestamp );
			}

			$wpdb->update(
				$wpdb->prefix . 'wc_admin_notes',
				array(
					'name'          => $note->get_name(),
					'type'          => $note->get_type(),
					'locale'        => $note->get_locale(),
					'title'         => $note->get_title(),
					'content'       => $note->get_content(),
					'content_data'  => wp_json_encode( $note->get_content_data() ),
					'status'        => $note->get_status(),
					'source'        => $note->get_source(),
					'date_created'  => $date_created_to_db,
					'date_reminder' => $date_reminder_to_db,
					'is_snoozable'  => $note->get_is_snoozable(),
					'layout'        => $note->get_layout(),
					'image'         => $note->get_image(),
					'is_deleted'    => $note->get_is_deleted(),
					'is_read'       => $note->get_is_read(),
				),
				array( 'note_id' => $note->get_id() )
			);
		}

		$note->save_meta_data();
		$this->save_actions( $note );
		$note->apply_changes();

		/**
		 * Fires when an admin note is updated.
		 *
		 * @param int $note_id Note ID.
		 */
		do_action( 'woocommerce_note_updated', $note->get_id() );
	}

	/**
	 * Deletes a note from the database.
	 *
	 * @param Note  $note Admin note.
	 * @param array $args Array of args to pass to the delete method (not used).
	 */
	public function delete( &$note, $args = array() ) {
		$note_id = $note->get_id();
		if ( $note_id ) {
			global $wpdb;
			$wpdb->delete( $wpdb->prefix . 'wc_admin_notes', array( 'note_id' => $note_id ) );
			$wpdb->delete( $wpdb->prefix . 'wc_admin_note_actions', array( 'note_id' => $note_id ) );
			$note->set_id( null );
		}

		/**
		 * Fires when an admin note is deleted.
		 *
		 * @param int $note_id Note ID.
		 */
		do_action( 'woocommerce_note_deleted', $note_id );
	}

	/**
	 * Read actions from the database.
	 *
	 * @param Note $note Admin note.
	 */
	private function read_actions( &$note ) {
		global $wpdb;

		$db_actions = $wpdb->get_results(
			$wpdb->prepare(
				"SELECT action_id, name, label, query, status, is_primary, actioned_text, nonce_action, nonce_name
				FROM {$wpdb->prefix}wc_admin_note_actions
				WHERE note_id = %d",
				$note->get_id()
			)
		);

		$note_actions = array();

		if ( $db_actions ) {
			foreach ( $db_actions as $action ) {
				$note_actions[] = (object) array(
					'id'            => (int) $action->action_id,
					'name'          => $action->name,
					'label'         => $action->label,
					'query'         => $action->query,
					'status'        => $action->status,
					'primary'       => (bool) $action->is_primary,
					'actioned_text' => $action->actioned_text,
					'nonce_action'  => $action->nonce_action,
					'nonce_name'    => $action->nonce_name,
				);
			}
		}

		$note->set_actions( $note_actions );
	}

	/**
	 * Save actions to the database.
	 * This function clears old actions, then re-inserts new if any changes are found.
	 *
	 * @param Note $note Note object.
	 *
	 * @return bool|void
	 */
	private function save_actions( &$note ) {
		global $wpdb;

		$changed_props = array_keys( $note->get_changes() );

		if ( ! in_array( 'actions', $changed_props, true ) ) {
			return false;
		}

		// Process action removal. Actions are removed from
		// the note if they aren't part of the changeset.
		// See Note::add_action().
		$changed_actions = $note->get_actions( 'edit' );
		$actions_to_keep = array();

		foreach ( $changed_actions as $action ) {
			if ( ! empty( $action->id ) ) {
				$actions_to_keep[] = (int) $action->id;
			}
		}

		$clear_actions_query = $wpdb->prepare(
			"DELETE FROM {$wpdb->prefix}wc_admin_note_actions WHERE note_id = %d",
			$note->get_id()
		);

		if ( $actions_to_keep ) {
			$clear_actions_query .= sprintf( ' AND action_id NOT IN (%s)', implode( ',', $actions_to_keep ) );
		}

		$wpdb->query( $clear_actions_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

		// Update/insert the actions in this changeset.
		foreach ( $changed_actions as $action ) {
			$action_data = array(
				'note_id'       => $note->get_id(),
				'name'          => $action->name,
				'label'         => $action->label,
				'query'         => $action->query,
				'status'        => $action->status,
				'is_primary'    => $action->primary,
				'actioned_text' => $action->actioned_text,
				'nonce_action'  => $action->nonce_action,
				'nonce_name'    => $action->nonce_name,
			);

			$data_format = array(
				'%d',
				'%s',
				'%s',
				'%s',
				'%s',
				'%d',
				'%s',
				'%s',
				'%s',
			);

			if ( ! empty( $action->id ) ) {
				$action_data['action_id'] = $action->id;
				$data_format[]            = '%d';
			}

			$wpdb->replace(
				$wpdb->prefix . 'wc_admin_note_actions',
				$action_data,
				$data_format
			);
		}

		// Update actions from DB (to grab new IDs).
		$this->read_actions( $note );
	}

	/**
	 * Return an ordered list of notes.
	 *
	 * @param array $args Query arguments.
	 * @return array An array of objects containing a note id.
	 */
	public function get_notes( $args = array() ) {
		global $wpdb;

		$defaults = array(
			'per_page' => get_option( 'posts_per_page' ),
			'page'     => 1,
			'order'    => 'DESC',
			'orderby'  => 'date_created',
		);
		$args     = wp_parse_args( $args, $defaults );

		$offset        = $args['per_page'] * ( $args['page'] - 1 );
		$where_clauses = $this->get_notes_where_clauses( $args );

		$query = $wpdb->prepare(
			// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
			"SELECT * FROM {$wpdb->prefix}wc_admin_notes WHERE 1=1{$where_clauses} ORDER BY {$args['orderby']} {$args['order']} LIMIT %d, %d",
			$offset,
			$args['per_page']
		);

		return $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
	}

	/**
	 * Return a count of notes.
	 *
	 * @param string $type Comma separated list of note types.
	 * @param string $status Comma separated list of statuses.
	 * @return array An array of objects containing a note id.
	 */
	public function get_notes_count( $type = array(), $status = array() ) {
		global $wpdb;

		$where_clauses = $this->get_notes_where_clauses(
			array(
				'type'   => $type,
				'status' => $status,
			)
		);

		if ( ! empty( $where_clauses ) ) {
			// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
			return $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_admin_notes WHERE 1=1{$where_clauses}" );
		}

		return $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_admin_notes" );
	}

	/**
	 * Parses the query arguments passed in as arrays and escapes the values.
	 *
	 * @param array      $args the query arguments.
	 * @param string     $key the key of the specific argument.
	 * @param array|null $allowed_types optional allowed_types if only a specific set is allowed.
	 * @return array the escaped array of argument values.
	 */
	private function get_escaped_arguments_array_by_key( $args = array(), $key = '', $allowed_types = null ) {
		$arg_array = array();
		if ( isset( $args[ $key ] ) ) {
			foreach ( $args[ $key ] as $args_type ) {
				$args_type = trim( $args_type );
				$allowed   = is_null( $allowed_types ) || in_array( $args_type, $allowed_types, true );
				if ( $allowed ) {
					$arg_array[] = sprintf( "'%s'", esc_sql( $args_type ) );
				}
			}
		}
		return $arg_array;
	}

	/**
	 * Return where clauses for getting notes by status and type. For use in both the count and listing queries.
	 *
	 *  @param array $args Array of args to pass.
	 * @return string Where clauses for the query.
	 */
	public function get_notes_where_clauses( $args = array() ) {
		$allowed_types    = Note::get_allowed_types();
		$where_type_array = $this->get_escaped_arguments_array_by_key( $args, 'type', $allowed_types );

		$allowed_statuses   = Note::get_allowed_statuses();
		$where_status_array = $this->get_escaped_arguments_array_by_key( $args, 'status', $allowed_statuses );

		$escaped_is_deleted = '';
		if ( isset( $args['is_deleted'] ) ) {
			$escaped_is_deleted = esc_sql( $args['is_deleted'] );
		}

		$where_name_array   = $this->get_escaped_arguments_array_by_key( $args, 'name' );
		$where_source_array = $this->get_escaped_arguments_array_by_key( $args, 'source' );

		$escaped_where_types  = implode( ',', $where_type_array );
		$escaped_where_status = implode( ',', $where_status_array );
		$escaped_where_names  = implode( ',', $where_name_array );
		$escaped_where_source = implode( ',', $where_source_array );
		$where_clauses        = '';

		if ( ! empty( $escaped_where_types ) ) {
			$where_clauses .= " AND type IN ($escaped_where_types)";
		}

		if ( ! empty( $escaped_where_status ) ) {
			$where_clauses .= " AND status IN ($escaped_where_status)";
		}

		if ( ! empty( $escaped_where_names ) ) {
			$where_clauses .= " AND name IN ($escaped_where_names)";
		}

		if ( ! empty( $escaped_where_source ) ) {
			$where_clauses .= " AND source IN ($escaped_where_source)";
		}

		$where_clauses .= $escaped_is_deleted ? ' AND is_deleted = 1' : ' AND is_deleted = 0';

		/**
		 * Filter the notes WHERE clause before retrieving the data.
		 *
		 * Allows modification of the notes select criterial.
		 *
		 * @param string $where_clauses The generated WHERE clause.
		 * @param array  $args          The original arguments for the request.
		 */
		return apply_filters( 'woocommerce_note_where_clauses', $where_clauses, $args );
	}

	/**
	 * Find all the notes with a given name.
	 *
	 * @param string $name Name to search for.
	 * @return array An array of matching note ids.
	 */
	public function get_notes_with_name( $name ) {
		global $wpdb;
		return $wpdb->get_col(
			$wpdb->prepare(
				"SELECT note_id FROM {$wpdb->prefix}wc_admin_notes WHERE name = %s ORDER BY note_id ASC",
				$name
			)
		);
	}
}