LLMS_Question_Manager
LLMS_Question_Manager class.
Contents
Source Source
File: includes/class.llms.question.manager.php
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | class LLMS_Question_Manager { /** * @var LLMS_Question|LLMS_Quiz * @since 3.16.0 */ public $parent; /** * Constructor * * @param obj $parent instance of the parent LLMS_Quiz or LLMS_Question * @since 3.16.0 * @version 3.16.0 */ public function __construct( $parent ) { $this->parent = $parent; } /** * Quick access to the parent attribute * * @return [type] * @since 3.16.0 * @version 3.16.0 */ private function get_parent() { return $this->parent; } /** * Quick access to parents type property * * @return string [llms_quiz|llms_question] * @since 3.16.0 * @version 3.16.0 */ private function get_parent_type() { return $this->parent->get( 'type' ); } /** * Retrieve the related LLMS_Quiz * * @return obj * @since 3.16.0 * @version 3.16.0 */ private function get_quiz() { if ( 'llms_quiz' === $this->get_parent_type() ) { return $this->parent; } return $this->parent->get_quiz(); } /** * Create a new question and add it to the quiz * * @param array $data array of question data * @return false|question id * @since 3.16.0 * @version 3.16.0 */ public function create_question( $data = array() ) { // Ensure the question belongs to this quiz. $data['parent_id'] = $this->get_parent()->get( 'id' ); $question = new LLMS_Question( 'new', $data ); if ( $question->get( 'id' ) ) { return $question->get( 'id' ); } return false; } /** * Delete a question associated with this quiz * skips trash and force deletes the question * * @param int $id WP Post ID of a question (must be associated with this quiz) * @return boolean true = deleted, false = error * @since 3.16.0 * @version 3.16.0 */ public function delete_question( $id ) { $question = $this->get_question( $id ); if ( ! $question ) { return false; } // Error. if ( ! wp_delete_post( $id, true ) ) { return false; } // Deleted. return true; } /** * Retrieve a question associated with this quiz by question ID * * @param int $id WP Post ID of the question * @return boolean * @since 3.16.0 * @version 3.27.0 */ public function get_question( $id ) { $question = llms_get_post( $id ); // Not valid question, return false. if ( empty( $question ) || ! is_a( $question, 'LLMS_Question' ) ) { return false; } $parent_id = $question->get( 'parent_id' ); // When parent id is set, only retrieve questions attached to this parent. if ( $parent_id && $parent_id !== $this->get_parent()->get( 'id' ) ) { if ( 'llms_question' === $this->get_parent_type() && $this->get_quiz()->get( 'id' ) === $question->get_quiz()->get( 'id' ) ) { return $question; } return false; } // Success. return $question; } /** * Get questions * * @param string $return type of return [ids|posts|questions] * @return array * @since 3.3.0 * @version 3.24.0 */ public function get_questions( $return = 'questions' ) { $query = new WP_Query( array( 'meta_query' => array( array( 'key' => '_llms_parent_id', 'value' => $this->get_parent()->get( 'id' ), ), ), 'order' => 'ASC', 'orderby' => 'menu_order', 'post_status' => 'publish', 'post_type' => 'llms_question', 'posts_per_page' => 500, ) ); if ( 'ids' === $return ) { $ret = wp_list_pluck( $query->posts, 'ID' ); } elseif ( 'posts' === $return ) { $ret = $query->posts; } else { $ret = array(); foreach ( $query->posts as $post ) { $ret[] = new LLMS_Question( $post ); } } return apply_filters( 'llms_quiz_get_questions', $ret, $this, $return ); } /** * Create or update questions * If 'id' passed in $data array will update existing question * Omit 'id' to create a new question * * @param array $data array of question data * @return false|question id * @since 3.16.0 * @version 3.17.2 */ public function update_question( $data = array() ) { // If there's no ID, we'll add a new question. if ( ! isset( $data['id'] ) ) { return $this->create_question( $data ); } // Get the question. $question = $this->get_question( $data['id'] ); if ( ! $question ) { return false; } // Update all submitted data. foreach ( $data as $key => $val ) { // Merge image data into the array. if ( 'image' === $key ) { $val = array_merge( array( 'enabled' => 'no', 'id' => '', 'src' => '', ), $question->get( $key ), $val ); } $question->set( $key, $val ); } // Return question ID. return $question->get( 'id' ); }} |
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor
- create_question — Create a new question and add it to the quiz
- delete_question — Delete a question associated with this quiz skips trash and force deletes the question
- get_parent — Quick access to the parent attribute
- get_parent_type — Quick access to parents type property
- get_question — Retrieve a question associated with this quiz by question ID
- get_questions — Get questions
- get_quiz — Retrieve the related LLMS_Quiz
- update_question — Create or update questions If 'id' passed in $data array will update existing question Omit 'id' to create a new question
Changelog Changelog
| Version | Description |
|---|---|
| 3.30.3 | Explicitly define class properties. |
| 3.16.0 | Introduced. |