@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | $this->_wp_post_stati = $wp_post_statuses; |
| 81 | 81 | |
| 82 | 82 | foreach ($this->_wp_post_stati as $post_status => $args_object) { |
| 83 | - $this->_allowed_enum_values[ $post_status ] = $args_object->label; |
|
| 83 | + $this->_allowed_enum_values[$post_status] = $args_object->label; |
|
| 84 | 84 | } |
| 85 | 85 | } |
| 86 | 86 | |
@@ -111,6 +111,6 @@ discard block |
||
| 111 | 111 | */ |
| 112 | 112 | public function get_status_object($status) |
| 113 | 113 | { |
| 114 | - return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false; |
|
| 114 | + return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false; |
|
| 115 | 115 | } |
| 116 | 116 | } |
@@ -3,114 +3,114 @@ |
||
| 3 | 3 | class EE_WP_Post_Status_Field extends EE_Enum_Text_Field |
| 4 | 4 | { |
| 5 | 5 | |
| 6 | - protected $_wp_post_stati; |
|
| 6 | + protected $_wp_post_stati; |
|
| 7 | 7 | |
| 8 | 8 | |
| 9 | - /** |
|
| 10 | - * constructor |
|
| 11 | - * |
|
| 12 | - * @param string $table_column column on table |
|
| 13 | - * @param string $nicename nice name for column(field) |
|
| 14 | - * @param bool $nullable is this field nullable |
|
| 15 | - * @param string $default_value default status |
|
| 16 | - * @param array $new_stati If additional stati are to be used other than the default WP statuses then |
|
| 17 | - * they can be registered via this property. The format of the array should be |
|
| 18 | - * as follows: array( |
|
| 19 | - * 'status_reference' => array( |
|
| 20 | - * 'label' => esc_html__('Status Reference Label', 'event_espresso') |
|
| 21 | - * 'public' => true, //'Whether posts of this status should be shown on the |
|
| 22 | - * frontend of the site' |
|
| 23 | - * 'exclude_from_search' => false, //'Whether posts of this status should be |
|
| 24 | - * excluded from wp searches' |
|
| 25 | - * 'show_in_admin_all_list' => true, //whether posts of this status are included |
|
| 26 | - * in queries for the admin "all" view in list table views. |
|
| 27 | - * 'show_in_admin_status_list' => true, //Show in the list of statuses with post |
|
| 28 | - * counts at the top of the admin list tables (i.e. Status Reference(2) ) |
|
| 29 | - * 'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>', |
|
| 30 | - * 'Status References <span class="count">(%s)</span>' ), //the text to display |
|
| 31 | - * on the admin screen( or you won't see your status count ). |
|
| 32 | - * ) |
|
| 33 | - * ) |
|
| 34 | - * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
| 35 | - * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is |
|
| 36 | - * set to true, it will be stored as an INT |
|
| 37 | - */ |
|
| 38 | - public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()) |
|
| 39 | - { |
|
| 40 | - $this->_register_new_stati($new_stati); |
|
| 41 | - $this->_set_allowed_enum_values(); |
|
| 42 | - parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values); |
|
| 43 | - } |
|
| 9 | + /** |
|
| 10 | + * constructor |
|
| 11 | + * |
|
| 12 | + * @param string $table_column column on table |
|
| 13 | + * @param string $nicename nice name for column(field) |
|
| 14 | + * @param bool $nullable is this field nullable |
|
| 15 | + * @param string $default_value default status |
|
| 16 | + * @param array $new_stati If additional stati are to be used other than the default WP statuses then |
|
| 17 | + * they can be registered via this property. The format of the array should be |
|
| 18 | + * as follows: array( |
|
| 19 | + * 'status_reference' => array( |
|
| 20 | + * 'label' => esc_html__('Status Reference Label', 'event_espresso') |
|
| 21 | + * 'public' => true, //'Whether posts of this status should be shown on the |
|
| 22 | + * frontend of the site' |
|
| 23 | + * 'exclude_from_search' => false, //'Whether posts of this status should be |
|
| 24 | + * excluded from wp searches' |
|
| 25 | + * 'show_in_admin_all_list' => true, //whether posts of this status are included |
|
| 26 | + * in queries for the admin "all" view in list table views. |
|
| 27 | + * 'show_in_admin_status_list' => true, //Show in the list of statuses with post |
|
| 28 | + * counts at the top of the admin list tables (i.e. Status Reference(2) ) |
|
| 29 | + * 'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>', |
|
| 30 | + * 'Status References <span class="count">(%s)</span>' ), //the text to display |
|
| 31 | + * on the admin screen( or you won't see your status count ). |
|
| 32 | + * ) |
|
| 33 | + * ) |
|
| 34 | + * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
| 35 | + * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is |
|
| 36 | + * set to true, it will be stored as an INT |
|
| 37 | + */ |
|
| 38 | + public function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()) |
|
| 39 | + { |
|
| 40 | + $this->_register_new_stati($new_stati); |
|
| 41 | + $this->_set_allowed_enum_values(); |
|
| 42 | + parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * This registers any new statuses sent via the $new_stati array on construct |
|
| 48 | - * |
|
| 49 | - * @access protected |
|
| 50 | - * @param array $new_stati statuses |
|
| 51 | - * @return void |
|
| 52 | - */ |
|
| 53 | - protected function _register_new_stati($new_stati) |
|
| 54 | - { |
|
| 46 | + /** |
|
| 47 | + * This registers any new statuses sent via the $new_stati array on construct |
|
| 48 | + * |
|
| 49 | + * @access protected |
|
| 50 | + * @param array $new_stati statuses |
|
| 51 | + * @return void |
|
| 52 | + */ |
|
| 53 | + protected function _register_new_stati($new_stati) |
|
| 54 | + { |
|
| 55 | 55 | |
| 56 | - foreach ((array) $new_stati as $status_key => $status_args) { |
|
| 57 | - $args = array( |
|
| 58 | - 'label' => isset($status_args['label']) ? $status_args['label'] : $status_key, |
|
| 59 | - 'public' => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true, |
|
| 60 | - 'exclude_from_search' => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false, |
|
| 61 | - 'show_in_admin_all_list' => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false, |
|
| 62 | - 'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true, |
|
| 63 | - 'label_count' => isset($status_args['label_count']) ? $status_args['label_count'] : '', |
|
| 64 | - ); |
|
| 65 | - register_post_status($status_key, $status_args); |
|
| 66 | - } |
|
| 67 | - } |
|
| 56 | + foreach ((array) $new_stati as $status_key => $status_args) { |
|
| 57 | + $args = array( |
|
| 58 | + 'label' => isset($status_args['label']) ? $status_args['label'] : $status_key, |
|
| 59 | + 'public' => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true, |
|
| 60 | + 'exclude_from_search' => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false, |
|
| 61 | + 'show_in_admin_all_list' => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false, |
|
| 62 | + 'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true, |
|
| 63 | + 'label_count' => isset($status_args['label_count']) ? $status_args['label_count'] : '', |
|
| 64 | + ); |
|
| 65 | + register_post_status($status_key, $status_args); |
|
| 66 | + } |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * This sets the _allowed_enum_values property using the $wp_post_stati array |
|
| 72 | - * |
|
| 73 | - * @access protected |
|
| 74 | - * @regurn void |
|
| 75 | - */ |
|
| 76 | - protected function _set_allowed_enum_values() |
|
| 77 | - { |
|
| 78 | - // first let's get the post_statuses |
|
| 79 | - global $wp_post_statuses; |
|
| 80 | - $this->_wp_post_stati = $wp_post_statuses; |
|
| 70 | + /** |
|
| 71 | + * This sets the _allowed_enum_values property using the $wp_post_stati array |
|
| 72 | + * |
|
| 73 | + * @access protected |
|
| 74 | + * @regurn void |
|
| 75 | + */ |
|
| 76 | + protected function _set_allowed_enum_values() |
|
| 77 | + { |
|
| 78 | + // first let's get the post_statuses |
|
| 79 | + global $wp_post_statuses; |
|
| 80 | + $this->_wp_post_stati = $wp_post_statuses; |
|
| 81 | 81 | |
| 82 | - foreach ($this->_wp_post_stati as $post_status => $args_object) { |
|
| 83 | - $this->_allowed_enum_values[ $post_status ] = $args_object->label; |
|
| 84 | - } |
|
| 85 | - } |
|
| 82 | + foreach ($this->_wp_post_stati as $post_status => $args_object) { |
|
| 83 | + $this->_allowed_enum_values[ $post_status ] = $args_object->label; |
|
| 84 | + } |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Before calling parent, first double-checks our list of acceptable post |
|
| 89 | - * types is up-to-date |
|
| 90 | - * |
|
| 91 | - * @param string $value_inputted_for_field_on_model_object |
|
| 92 | - * @return string |
|
| 93 | - */ |
|
| 94 | - public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 95 | - { |
|
| 96 | - $this->_set_allowed_enum_values(); |
|
| 97 | - return parent::prepare_for_set($value_inputted_for_field_on_model_object); |
|
| 98 | - } |
|
| 87 | + /** |
|
| 88 | + * Before calling parent, first double-checks our list of acceptable post |
|
| 89 | + * types is up-to-date |
|
| 90 | + * |
|
| 91 | + * @param string $value_inputted_for_field_on_model_object |
|
| 92 | + * @return string |
|
| 93 | + */ |
|
| 94 | + public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 95 | + { |
|
| 96 | + $this->_set_allowed_enum_values(); |
|
| 97 | + return parent::prepare_for_set($value_inputted_for_field_on_model_object); |
|
| 98 | + } |
|
| 99 | 99 | |
| 100 | 100 | |
| 101 | 101 | |
| 102 | - // helper methods for getting various $wp_post_statuses stuff. |
|
| 102 | + // helper methods for getting various $wp_post_statuses stuff. |
|
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * This just returns the status object for the given status |
|
| 106 | - * |
|
| 107 | - * @access public |
|
| 108 | - * @see wp_register_post_status in wp-includes/post.php for a list of properties of the status object |
|
| 109 | - * @param string $status What status object you want |
|
| 110 | - * @return std_object the status object or FALSE if it doesn't exist. |
|
| 111 | - */ |
|
| 112 | - public function get_status_object($status) |
|
| 113 | - { |
|
| 114 | - return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false; |
|
| 115 | - } |
|
| 104 | + /** |
|
| 105 | + * This just returns the status object for the given status |
|
| 106 | + * |
|
| 107 | + * @access public |
|
| 108 | + * @see wp_register_post_status in wp-includes/post.php for a list of properties of the status object |
|
| 109 | + * @param string $status What status object you want |
|
| 110 | + * @return std_object the status object or FALSE if it doesn't exist. |
|
| 111 | + */ |
|
| 112 | + public function get_status_object($status) |
|
| 113 | + { |
|
| 114 | + return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false; |
|
| 115 | + } |
|
| 116 | 116 | } |
@@ -2,6 +2,6 @@ |
||
| 2 | 2 | |
| 3 | 3 | class EE_Trashed_Flag_Field extends EE_Boolean_Field |
| 4 | 4 | { |
| 5 | - // note: some client code simply checks if a field IS an EE_Trashed_Flag_Field |
|
| 6 | - // ...otherwise, these fields are mostly the same as boolean fields |
|
| 5 | + // note: some client code simply checks if a field IS an EE_Trashed_Flag_Field |
|
| 6 | + // ...otherwise, these fields are mostly the same as boolean fields |
|
| 7 | 7 | } |
@@ -6,26 +6,26 @@ |
||
| 6 | 6 | */ |
| 7 | 7 | class EE_Integer_Field extends EE_Model_Field_Base |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @param string $table_column |
|
| 11 | - * @param string $nicename |
|
| 12 | - * @param bool $nullable |
|
| 13 | - * @param null $default_value |
|
| 14 | - */ |
|
| 15 | - public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 16 | - { |
|
| 17 | - parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 18 | - $this->setSchemaType('integer'); |
|
| 19 | - } |
|
| 9 | + /** |
|
| 10 | + * @param string $table_column |
|
| 11 | + * @param string $nicename |
|
| 12 | + * @param bool $nullable |
|
| 13 | + * @param null $default_value |
|
| 14 | + */ |
|
| 15 | + public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 16 | + { |
|
| 17 | + parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 18 | + $this->setSchemaType('integer'); |
|
| 19 | + } |
|
| 20 | 20 | |
| 21 | 21 | |
| 22 | - public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 23 | - { |
|
| 24 | - return intval($value_inputted_for_field_on_model_object); |
|
| 25 | - } |
|
| 22 | + public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 23 | + { |
|
| 24 | + return intval($value_inputted_for_field_on_model_object); |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - public function prepare_for_set_from_db($value_inputted_for_field_on_model_object) |
|
| 28 | - { |
|
| 29 | - return intval($value_inputted_for_field_on_model_object); |
|
| 30 | - } |
|
| 27 | + public function prepare_for_set_from_db($value_inputted_for_field_on_model_object) |
|
| 28 | + { |
|
| 29 | + return intval($value_inputted_for_field_on_model_object); |
|
| 30 | + } |
|
| 31 | 31 | } |
@@ -2,24 +2,24 @@ |
||
| 2 | 2 | |
| 3 | 3 | abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name |
| 4 | 4 | { |
| 5 | - /** |
|
| 6 | - * Overrides parent so it doesn't need to provide so many non-applicable fields |
|
| 7 | - * |
|
| 8 | - * @param string $table_column |
|
| 9 | - * @param string $nicename |
|
| 10 | - */ |
|
| 11 | - public function __construct($table_column, $nicename, $default) |
|
| 12 | - { |
|
| 13 | - parent::__construct($table_column, $nicename, false, $default, null); |
|
| 14 | - } |
|
| 5 | + /** |
|
| 6 | + * Overrides parent so it doesn't need to provide so many non-applicable fields |
|
| 7 | + * |
|
| 8 | + * @param string $table_column |
|
| 9 | + * @param string $nicename |
|
| 10 | + */ |
|
| 11 | + public function __construct($table_column, $nicename, $default) |
|
| 12 | + { |
|
| 13 | + parent::__construct($table_column, $nicename, false, $default, null); |
|
| 14 | + } |
|
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @param $table_alias |
|
| 18 | - * @param $name |
|
| 19 | - */ |
|
| 20 | - public function _construct_finalize($table_alias, $name, $model_name) |
|
| 21 | - { |
|
| 22 | - $this->_model_name_pointed_to = $model_name; |
|
| 23 | - parent::_construct_finalize($table_alias, $name, $model_name); |
|
| 24 | - } |
|
| 16 | + /** |
|
| 17 | + * @param $table_alias |
|
| 18 | + * @param $name |
|
| 19 | + */ |
|
| 20 | + public function _construct_finalize($table_alias, $name, $model_name) |
|
| 21 | + { |
|
| 22 | + $this->_model_name_pointed_to = $model_name; |
|
| 23 | + parent::_construct_finalize($table_alias, $name, $model_name); |
|
| 24 | + } |
|
| 25 | 25 | } |
@@ -2,15 +2,15 @@ |
||
| 2 | 2 | |
| 3 | 3 | class EE_DB_Only_Int_Field extends EE_DB_Only_Field_Base |
| 4 | 4 | { |
| 5 | - /** |
|
| 6 | - * @param string $table_column |
|
| 7 | - * @param string $nicename |
|
| 8 | - * @param bool $nullable |
|
| 9 | - * @param null $default_value |
|
| 10 | - */ |
|
| 11 | - public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 12 | - { |
|
| 13 | - parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 14 | - $this->setSchemaType('integer'); |
|
| 15 | - } |
|
| 5 | + /** |
|
| 6 | + * @param string $table_column |
|
| 7 | + * @param string $nicename |
|
| 8 | + * @param bool $nullable |
|
| 9 | + * @param null $default_value |
|
| 10 | + */ |
|
| 11 | + public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 12 | + { |
|
| 13 | + parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 14 | + $this->setSchemaType('integer'); |
|
| 15 | + } |
|
| 16 | 16 | } |
@@ -28,7 +28,7 @@ discard block |
||
| 28 | 28 | */ |
| 29 | 29 | public function prepare_for_set($value) |
| 30 | 30 | { |
| 31 | - if (! current_user_can('unfiltered_html')) { |
|
| 31 | + if ( ! current_user_can('unfiltered_html')) { |
|
| 32 | 32 | $value = wp_kses("$value", wp_kses_allowed_html('post')); |
| 33 | 33 | } |
| 34 | 34 | return parent::prepare_for_set($value); |
@@ -96,8 +96,8 @@ discard block |
||
| 96 | 96 | */ |
| 97 | 97 | protected static function _setup_the_content_wp_core_only_filters() |
| 98 | 98 | { |
| 99 | - add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8); |
|
| 100 | - add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8); |
|
| 99 | + add_filter('the_content_wp_core_only', array($GLOBALS['wp_embed'], 'run_shortcode'), 8); |
|
| 100 | + add_filter('the_content_wp_core_only', array($GLOBALS['wp_embed'], 'autoembed'), 8); |
|
| 101 | 101 | add_filter('the_content_wp_core_only', 'wptexturize', 10); |
| 102 | 102 | add_filter('the_content_wp_core_only', 'wpautop', 10); |
| 103 | 103 | add_filter('the_content_wp_core_only', 'shortcode_unautop', 10); |
@@ -6,130 +6,130 @@ |
||
| 6 | 6 | */ |
| 7 | 7 | class EE_Post_Content_Field extends EE_Text_Field_Base |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @param string $table_column |
|
| 11 | - * @param string $nicename |
|
| 12 | - * @param bool $nullable |
|
| 13 | - * @param null $default_value |
|
| 14 | - */ |
|
| 15 | - public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 16 | - { |
|
| 17 | - parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 18 | - $this->setSchemaType('object'); |
|
| 19 | - } |
|
| 9 | + /** |
|
| 10 | + * @param string $table_column |
|
| 11 | + * @param string $nicename |
|
| 12 | + * @param bool $nullable |
|
| 13 | + * @param null $default_value |
|
| 14 | + */ |
|
| 15 | + public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
| 16 | + { |
|
| 17 | + parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
| 18 | + $this->setSchemaType('object'); |
|
| 19 | + } |
|
| 20 | 20 | |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * removes all tags which a WP Post wouldn't allow in its content normally |
|
| 24 | - * |
|
| 25 | - * @param string $value |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function prepare_for_set($value) |
|
| 29 | - { |
|
| 30 | - if (! current_user_can('unfiltered_html')) { |
|
| 31 | - $value = wp_kses("$value", wp_kses_allowed_html('post')); |
|
| 32 | - } |
|
| 33 | - return parent::prepare_for_set($value); |
|
| 34 | - } |
|
| 22 | + /** |
|
| 23 | + * removes all tags which a WP Post wouldn't allow in its content normally |
|
| 24 | + * |
|
| 25 | + * @param string $value |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function prepare_for_set($value) |
|
| 29 | + { |
|
| 30 | + if (! current_user_can('unfiltered_html')) { |
|
| 31 | + $value = wp_kses("$value", wp_kses_allowed_html('post')); |
|
| 32 | + } |
|
| 33 | + return parent::prepare_for_set($value); |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | 36 | |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Runs the content through `the_content`, or if prepares the content for placing in a form input |
|
| 40 | - * |
|
| 41 | - * @param string $value_on_field_to_be_outputted |
|
| 42 | - * @param string|null $schema possible values: 'form_input' or null (if null, will run through 'the_content') |
|
| 43 | - * @return string |
|
| 44 | - * @throws EE_Error when WP_DEBUG is on and recursive calling is detected |
|
| 45 | - */ |
|
| 46 | - public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null) |
|
| 47 | - { |
|
| 48 | - switch ($schema) { |
|
| 49 | - case 'form_input': |
|
| 50 | - return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema); |
|
| 51 | - case 'the_content': |
|
| 52 | - if (doing_filter('the_content')) { |
|
| 53 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 54 | - throw new EE_Error( |
|
| 55 | - sprintf( |
|
| 56 | - esc_html__('You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.', 'event_espresso'), |
|
| 57 | - 'EE_Post_Content_Field::prepare_for_pretty_echoing', |
|
| 58 | - '$schema', |
|
| 59 | - 'the_content', |
|
| 60 | - 'the_content_wp_core_only' |
|
| 61 | - ) |
|
| 62 | - ); |
|
| 63 | - } else { |
|
| 64 | - return $this->prepare_for_pretty_echoing($value_on_field_to_be_outputted, 'the_content_wp_core_only'); |
|
| 65 | - } |
|
| 66 | - } |
|
| 67 | - return apply_filters( |
|
| 68 | - 'the_content', |
|
| 69 | - parent::prepare_for_pretty_echoing( |
|
| 70 | - $value_on_field_to_be_outputted, |
|
| 71 | - $schema |
|
| 72 | - ) |
|
| 73 | - ); |
|
| 74 | - case 'the_content_wp_core_only': |
|
| 75 | - default: |
|
| 76 | - self::_setup_the_content_wp_core_only_filters(); |
|
| 77 | - $return_value = apply_filters( |
|
| 78 | - 'the_content_wp_core_only', |
|
| 79 | - parent::prepare_for_pretty_echoing( |
|
| 80 | - $value_on_field_to_be_outputted, |
|
| 81 | - $schema |
|
| 82 | - ) |
|
| 83 | - ); |
|
| 84 | - // ya know what? adding these filters is super fast. Let's just |
|
| 85 | - // avoid needing to maintain global state and set this up as-needed |
|
| 86 | - remove_all_filters('the_content_wp_core_only'); |
|
| 87 | - do_action('AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done'); |
|
| 88 | - return $return_value; |
|
| 89 | - } |
|
| 90 | - } |
|
| 38 | + /** |
|
| 39 | + * Runs the content through `the_content`, or if prepares the content for placing in a form input |
|
| 40 | + * |
|
| 41 | + * @param string $value_on_field_to_be_outputted |
|
| 42 | + * @param string|null $schema possible values: 'form_input' or null (if null, will run through 'the_content') |
|
| 43 | + * @return string |
|
| 44 | + * @throws EE_Error when WP_DEBUG is on and recursive calling is detected |
|
| 45 | + */ |
|
| 46 | + public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null) |
|
| 47 | + { |
|
| 48 | + switch ($schema) { |
|
| 49 | + case 'form_input': |
|
| 50 | + return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema); |
|
| 51 | + case 'the_content': |
|
| 52 | + if (doing_filter('the_content')) { |
|
| 53 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 54 | + throw new EE_Error( |
|
| 55 | + sprintf( |
|
| 56 | + esc_html__('You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.', 'event_espresso'), |
|
| 57 | + 'EE_Post_Content_Field::prepare_for_pretty_echoing', |
|
| 58 | + '$schema', |
|
| 59 | + 'the_content', |
|
| 60 | + 'the_content_wp_core_only' |
|
| 61 | + ) |
|
| 62 | + ); |
|
| 63 | + } else { |
|
| 64 | + return $this->prepare_for_pretty_echoing($value_on_field_to_be_outputted, 'the_content_wp_core_only'); |
|
| 65 | + } |
|
| 66 | + } |
|
| 67 | + return apply_filters( |
|
| 68 | + 'the_content', |
|
| 69 | + parent::prepare_for_pretty_echoing( |
|
| 70 | + $value_on_field_to_be_outputted, |
|
| 71 | + $schema |
|
| 72 | + ) |
|
| 73 | + ); |
|
| 74 | + case 'the_content_wp_core_only': |
|
| 75 | + default: |
|
| 76 | + self::_setup_the_content_wp_core_only_filters(); |
|
| 77 | + $return_value = apply_filters( |
|
| 78 | + 'the_content_wp_core_only', |
|
| 79 | + parent::prepare_for_pretty_echoing( |
|
| 80 | + $value_on_field_to_be_outputted, |
|
| 81 | + $schema |
|
| 82 | + ) |
|
| 83 | + ); |
|
| 84 | + // ya know what? adding these filters is super fast. Let's just |
|
| 85 | + // avoid needing to maintain global state and set this up as-needed |
|
| 86 | + remove_all_filters('the_content_wp_core_only'); |
|
| 87 | + do_action('AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done'); |
|
| 88 | + return $return_value; |
|
| 89 | + } |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | 92 | |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Verifies we've setup the standard WP core filters on 'the_content_wp_core_only' filter |
|
| 96 | - */ |
|
| 97 | - protected static function _setup_the_content_wp_core_only_filters() |
|
| 98 | - { |
|
| 99 | - add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8); |
|
| 100 | - add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8); |
|
| 101 | - add_filter('the_content_wp_core_only', 'wptexturize', 10); |
|
| 102 | - add_filter('the_content_wp_core_only', 'wpautop', 10); |
|
| 103 | - add_filter('the_content_wp_core_only', 'shortcode_unautop', 10); |
|
| 104 | - add_filter('the_content_wp_core_only', 'prepend_attachment', 10); |
|
| 105 | - if (function_exists('wp_filter_content_tags')) { |
|
| 106 | - add_filter('the_content_wp_core_only', 'wp_filter_content_tags', 10); |
|
| 107 | - } elseif (function_exists('wp_make_content_images_responsive')) { |
|
| 108 | - add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10); |
|
| 109 | - } |
|
| 110 | - add_filter('the_content_wp_core_only', 'do_shortcode', 11); |
|
| 111 | - add_filter('the_content_wp_core_only', 'convert_smilies', 20); |
|
| 112 | - } |
|
| 94 | + /** |
|
| 95 | + * Verifies we've setup the standard WP core filters on 'the_content_wp_core_only' filter |
|
| 96 | + */ |
|
| 97 | + protected static function _setup_the_content_wp_core_only_filters() |
|
| 98 | + { |
|
| 99 | + add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'run_shortcode'), 8); |
|
| 100 | + add_filter('the_content_wp_core_only', array( $GLOBALS['wp_embed'], 'autoembed'), 8); |
|
| 101 | + add_filter('the_content_wp_core_only', 'wptexturize', 10); |
|
| 102 | + add_filter('the_content_wp_core_only', 'wpautop', 10); |
|
| 103 | + add_filter('the_content_wp_core_only', 'shortcode_unautop', 10); |
|
| 104 | + add_filter('the_content_wp_core_only', 'prepend_attachment', 10); |
|
| 105 | + if (function_exists('wp_filter_content_tags')) { |
|
| 106 | + add_filter('the_content_wp_core_only', 'wp_filter_content_tags', 10); |
|
| 107 | + } elseif (function_exists('wp_make_content_images_responsive')) { |
|
| 108 | + add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10); |
|
| 109 | + } |
|
| 110 | + add_filter('the_content_wp_core_only', 'do_shortcode', 11); |
|
| 111 | + add_filter('the_content_wp_core_only', 'convert_smilies', 20); |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | 114 | |
| 115 | 115 | |
| 116 | - public function getSchemaProperties() |
|
| 117 | - { |
|
| 118 | - return array( |
|
| 119 | - 'raw' => array( |
|
| 120 | - 'description' => sprintf( |
|
| 121 | - esc_html__('%s - the content as it exists in the database.', 'event_espresso'), |
|
| 122 | - $this->get_nicename() |
|
| 123 | - ), |
|
| 124 | - 'type' => 'string' |
|
| 125 | - ), |
|
| 126 | - 'rendered' => array( |
|
| 127 | - 'description' => sprintf( |
|
| 128 | - esc_html__('%s - the content rendered for display.', 'event_espresso'), |
|
| 129 | - $this->get_nicename() |
|
| 130 | - ), |
|
| 131 | - 'type' => 'string' |
|
| 132 | - ) |
|
| 133 | - ); |
|
| 134 | - } |
|
| 116 | + public function getSchemaProperties() |
|
| 117 | + { |
|
| 118 | + return array( |
|
| 119 | + 'raw' => array( |
|
| 120 | + 'description' => sprintf( |
|
| 121 | + esc_html__('%s - the content as it exists in the database.', 'event_espresso'), |
|
| 122 | + $this->get_nicename() |
|
| 123 | + ), |
|
| 124 | + 'type' => 'string' |
|
| 125 | + ), |
|
| 126 | + 'rendered' => array( |
|
| 127 | + 'description' => sprintf( |
|
| 128 | + esc_html__('%s - the content rendered for display.', 'event_espresso'), |
|
| 129 | + $this->get_nicename() |
|
| 130 | + ), |
|
| 131 | + 'type' => 'string' |
|
| 132 | + ) |
|
| 133 | + ); |
|
| 134 | + } |
|
| 135 | 135 | } |
@@ -11,59 +11,59 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class EE_Maybe_Serialized_Simple_HTML_Field extends EE_Maybe_Serialized_Text_Field |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * removes all non-basic tags when setting |
|
| 16 | - * |
|
| 17 | - * @param string $value_inputted_for_field_on_model_object |
|
| 18 | - * @return string |
|
| 19 | - */ |
|
| 20 | - public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 21 | - { |
|
| 22 | - return parent::prepare_for_set($this->_remove_tags($value_inputted_for_field_on_model_object)); |
|
| 23 | - } |
|
| 14 | + /** |
|
| 15 | + * removes all non-basic tags when setting |
|
| 16 | + * |
|
| 17 | + * @param string $value_inputted_for_field_on_model_object |
|
| 18 | + * @return string |
|
| 19 | + */ |
|
| 20 | + public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
| 21 | + { |
|
| 22 | + return parent::prepare_for_set($this->_remove_tags($value_inputted_for_field_on_model_object)); |
|
| 23 | + } |
|
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Remove any non-"simple" html tags. @see EE_Simple_HTML_Field |
|
| 27 | - * |
|
| 28 | - * @param array|string $value |
|
| 29 | - * @return array|string |
|
| 30 | - */ |
|
| 31 | - protected function _remove_tags($value) |
|
| 32 | - { |
|
| 33 | - if (is_array($value)) { |
|
| 34 | - foreach ($value as $key => $v) { |
|
| 35 | - $value[ $key ] = $this->_remove_tags($v); |
|
| 36 | - } |
|
| 37 | - } elseif (is_string($value)) { |
|
| 38 | - $value = wp_kses("$value", $this->_get_allowed_tags()); |
|
| 39 | - } |
|
| 40 | - return $value; |
|
| 41 | - } |
|
| 25 | + /** |
|
| 26 | + * Remove any non-"simple" html tags. @see EE_Simple_HTML_Field |
|
| 27 | + * |
|
| 28 | + * @param array|string $value |
|
| 29 | + * @return array|string |
|
| 30 | + */ |
|
| 31 | + protected function _remove_tags($value) |
|
| 32 | + { |
|
| 33 | + if (is_array($value)) { |
|
| 34 | + foreach ($value as $key => $v) { |
|
| 35 | + $value[ $key ] = $this->_remove_tags($v); |
|
| 36 | + } |
|
| 37 | + } elseif (is_string($value)) { |
|
| 38 | + $value = wp_kses("$value", $this->_get_allowed_tags()); |
|
| 39 | + } |
|
| 40 | + return $value; |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * In case unsafe data somehow got inserted into the database, we want to remove tags again |
|
| 45 | - * |
|
| 46 | - * @param array|string $value_found_in_db_for_model_object |
|
| 47 | - * @return array|string |
|
| 48 | - */ |
|
| 49 | - public function prepare_for_set_from_db($value_found_in_db_for_model_object) |
|
| 50 | - { |
|
| 51 | - return $this->_remove_tags(parent::prepare_for_set_from_db($value_found_in_db_for_model_object)); |
|
| 52 | - } |
|
| 43 | + /** |
|
| 44 | + * In case unsafe data somehow got inserted into the database, we want to remove tags again |
|
| 45 | + * |
|
| 46 | + * @param array|string $value_found_in_db_for_model_object |
|
| 47 | + * @return array|string |
|
| 48 | + */ |
|
| 49 | + public function prepare_for_set_from_db($value_found_in_db_for_model_object) |
|
| 50 | + { |
|
| 51 | + return $this->_remove_tags(parent::prepare_for_set_from_db($value_found_in_db_for_model_object)); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Determines what tags to allow in this model field |
|
| 57 | - * |
|
| 58 | - * @global array $allowedtags |
|
| 59 | - * @return array |
|
| 60 | - */ |
|
| 61 | - public function _get_allowed_tags() |
|
| 62 | - { |
|
| 63 | - return apply_filters( |
|
| 64 | - 'FHEE__EE_Maybe_Serialized_Simple_HTML_Field___get_allowed_tags', |
|
| 65 | - EEH_HTML::get_simple_tags(), |
|
| 66 | - $this |
|
| 67 | - ); |
|
| 68 | - } |
|
| 55 | + /** |
|
| 56 | + * Determines what tags to allow in this model field |
|
| 57 | + * |
|
| 58 | + * @global array $allowedtags |
|
| 59 | + * @return array |
|
| 60 | + */ |
|
| 61 | + public function _get_allowed_tags() |
|
| 62 | + { |
|
| 63 | + return apply_filters( |
|
| 64 | + 'FHEE__EE_Maybe_Serialized_Simple_HTML_Field___get_allowed_tags', |
|
| 65 | + EEH_HTML::get_simple_tags(), |
|
| 66 | + $this |
|
| 67 | + ); |
|
| 68 | + } |
|
| 69 | 69 | } |
@@ -32,7 +32,7 @@ |
||
| 32 | 32 | { |
| 33 | 33 | if (is_array($value)) { |
| 34 | 34 | foreach ($value as $key => $v) { |
| 35 | - $value[ $key ] = $this->_remove_tags($v); |
|
| 35 | + $value[$key] = $this->_remove_tags($v); |
|
| 36 | 36 | } |
| 37 | 37 | } elseif (is_string($value)) { |
| 38 | 38 | $value = wp_kses("$value", $this->_get_allowed_tags()); |
@@ -49,7 +49,7 @@ |
||
| 49 | 49 | ); |
| 50 | 50 | $this->_model_chain_to_wp_user = 'Message_Template_Group'; |
| 51 | 51 | foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) { |
| 52 | - $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global'); |
|
| 52 | + $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global'); |
|
| 53 | 53 | } |
| 54 | 54 | $this->_caps_slug = 'messages'; |
| 55 | 55 | parent::__construct($timezone); |
@@ -14,45 +14,45 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class EEM_Message_Template extends EEM_Base |
| 16 | 16 | { |
| 17 | - // private instance of the EEM_Message_Template object |
|
| 18 | - protected static $_instance = null; |
|
| 17 | + // private instance of the EEM_Message_Template object |
|
| 18 | + protected static $_instance = null; |
|
| 19 | 19 | |
| 20 | 20 | |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * private constructor to prevent direct creation |
|
| 24 | - * |
|
| 25 | - * @Constructor |
|
| 26 | - * @access protected |
|
| 27 | - * @param string $timezone |
|
| 28 | - * @throws \EE_Error |
|
| 29 | - */ |
|
| 30 | - protected function __construct($timezone = null) |
|
| 31 | - { |
|
| 32 | - $this->singular_item = esc_html__('Message Template', 'event_espresso'); |
|
| 33 | - $this->plural_item = esc_html__('Message Templates', 'event_espresso'); |
|
| 22 | + /** |
|
| 23 | + * private constructor to prevent direct creation |
|
| 24 | + * |
|
| 25 | + * @Constructor |
|
| 26 | + * @access protected |
|
| 27 | + * @param string $timezone |
|
| 28 | + * @throws \EE_Error |
|
| 29 | + */ |
|
| 30 | + protected function __construct($timezone = null) |
|
| 31 | + { |
|
| 32 | + $this->singular_item = esc_html__('Message Template', 'event_espresso'); |
|
| 33 | + $this->plural_item = esc_html__('Message Templates', 'event_espresso'); |
|
| 34 | 34 | |
| 35 | - $this->_tables = array( |
|
| 36 | - 'Message_Template' => new EE_Primary_Table('esp_message_template', 'MTP_ID') |
|
| 37 | - ); |
|
| 38 | - $this->_fields = array( |
|
| 39 | - 'Message_Template' => array( |
|
| 40 | - 'MTP_ID' => new EE_Primary_Key_Int_Field('MTP_ID', esc_html__('Message Template ID', 'event_espresso')), |
|
| 41 | - 'GRP_ID' => new EE_Foreign_Key_Int_Field('GRP_ID', esc_html__('Message Template Group ID', 'event_espresso'), false, 0, 'Message_Template_Group'), |
|
| 42 | - 'MTP_template_field' => new EE_Plain_Text_Field('MTP_template_field', esc_html__('Field Name for this Template', 'event_espresso'), false, 'default'), |
|
| 43 | - 'MTP_context' => new EE_Plain_Text_Field('MTP_context', esc_html__('Message Type Context for this field', 'event_espresso'), false, 'admin'), |
|
| 44 | - 'MTP_content' => new EE_Serialized_Text_Field('MTP_content', esc_html__('The field content for the template', 'event_espresso'), false, ''), |
|
| 45 | - ) |
|
| 46 | - ); |
|
| 35 | + $this->_tables = array( |
|
| 36 | + 'Message_Template' => new EE_Primary_Table('esp_message_template', 'MTP_ID') |
|
| 37 | + ); |
|
| 38 | + $this->_fields = array( |
|
| 39 | + 'Message_Template' => array( |
|
| 40 | + 'MTP_ID' => new EE_Primary_Key_Int_Field('MTP_ID', esc_html__('Message Template ID', 'event_espresso')), |
|
| 41 | + 'GRP_ID' => new EE_Foreign_Key_Int_Field('GRP_ID', esc_html__('Message Template Group ID', 'event_espresso'), false, 0, 'Message_Template_Group'), |
|
| 42 | + 'MTP_template_field' => new EE_Plain_Text_Field('MTP_template_field', esc_html__('Field Name for this Template', 'event_espresso'), false, 'default'), |
|
| 43 | + 'MTP_context' => new EE_Plain_Text_Field('MTP_context', esc_html__('Message Type Context for this field', 'event_espresso'), false, 'admin'), |
|
| 44 | + 'MTP_content' => new EE_Serialized_Text_Field('MTP_content', esc_html__('The field content for the template', 'event_espresso'), false, ''), |
|
| 45 | + ) |
|
| 46 | + ); |
|
| 47 | 47 | |
| 48 | - $this->_model_relations = array( |
|
| 49 | - 'Message_Template_Group' => new EE_Belongs_To_Relation() |
|
| 50 | - ); |
|
| 51 | - $this->_model_chain_to_wp_user = 'Message_Template_Group'; |
|
| 52 | - foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) { |
|
| 53 | - $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global'); |
|
| 54 | - } |
|
| 55 | - $this->_caps_slug = 'messages'; |
|
| 56 | - parent::__construct($timezone); |
|
| 57 | - } |
|
| 48 | + $this->_model_relations = array( |
|
| 49 | + 'Message_Template_Group' => new EE_Belongs_To_Relation() |
|
| 50 | + ); |
|
| 51 | + $this->_model_chain_to_wp_user = 'Message_Template_Group'; |
|
| 52 | + foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) { |
|
| 53 | + $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global'); |
|
| 54 | + } |
|
| 55 | + $this->_caps_slug = 'messages'; |
|
| 56 | + parent::__construct($timezone); |
|
| 57 | + } |
|
| 58 | 58 | } |
@@ -35,19 +35,19 @@ |
||
| 35 | 35 | $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
| 36 | 36 | $model_relation_chain, |
| 37 | 37 | $this->get_this_model()->get_this_model_name() |
| 38 | - ) . $this_table_fk_field->get_table_alias(); |
|
| 39 | - $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 38 | + ).$this_table_fk_field->get_table_alias(); |
|
| 39 | + $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 40 | 40 | $model_relation_chain, |
| 41 | 41 | $this->get_other_model()->get_this_model_name() |
| 42 | - ) . $other_table_pk_field->get_table_alias(); |
|
| 43 | - $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias); |
|
| 42 | + ).$other_table_pk_field->get_table_alias(); |
|
| 43 | + $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias); |
|
| 44 | 44 | return $this->_left_join( |
| 45 | 45 | $other_table, |
| 46 | 46 | $other_table_alias, |
| 47 | 47 | $other_table_pk_field->get_table_column(), |
| 48 | 48 | $this_table_alias, |
| 49 | 49 | $this_table_fk_field->get_table_column(), |
| 50 | - $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'" |
|
| 50 | + $field_with_model_name->get_qualified_column()."='".$this->get_other_model()->get_this_model_name()."'" |
|
| 51 | 51 | ) |
| 52 | 52 | . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias); |
| 53 | 53 | } |
@@ -14,94 +14,94 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class EE_Belongs_To_Any_Relation extends EE_Belongs_To_Relation |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * get_join_statement |
|
| 19 | - * |
|
| 20 | - * @param string $model_relation_chain |
|
| 21 | - * @return string |
|
| 22 | - * @throws \EE_Error |
|
| 23 | - */ |
|
| 24 | - public function get_join_statement($model_relation_chain) |
|
| 25 | - { |
|
| 26 | - // create the sql string like |
|
| 27 | - $this_table_fk_field = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 28 | - // ALSO, need to get the field with the model name |
|
| 29 | - $field_with_model_name = $this->get_this_model()->get_field_containing_related_model_name(); |
|
| 17 | + /** |
|
| 18 | + * get_join_statement |
|
| 19 | + * |
|
| 20 | + * @param string $model_relation_chain |
|
| 21 | + * @return string |
|
| 22 | + * @throws \EE_Error |
|
| 23 | + */ |
|
| 24 | + public function get_join_statement($model_relation_chain) |
|
| 25 | + { |
|
| 26 | + // create the sql string like |
|
| 27 | + $this_table_fk_field = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 28 | + // ALSO, need to get the field with the model name |
|
| 29 | + $field_with_model_name = $this->get_this_model()->get_field_containing_related_model_name(); |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - $other_table_pk_field = $this->get_other_model()->get_primary_key_field(); |
|
| 33 | - $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 34 | - $model_relation_chain, |
|
| 35 | - $this->get_this_model()->get_this_model_name() |
|
| 36 | - ) . $this_table_fk_field->get_table_alias(); |
|
| 37 | - $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 38 | - $model_relation_chain, |
|
| 39 | - $this->get_other_model()->get_this_model_name() |
|
| 40 | - ) . $other_table_pk_field->get_table_alias(); |
|
| 41 | - $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias); |
|
| 42 | - return $this->_left_join( |
|
| 43 | - $other_table, |
|
| 44 | - $other_table_alias, |
|
| 45 | - $other_table_pk_field->get_table_column(), |
|
| 46 | - $this_table_alias, |
|
| 47 | - $this_table_fk_field->get_table_column(), |
|
| 48 | - $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'" |
|
| 49 | - ) |
|
| 50 | - . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias); |
|
| 51 | - } |
|
| 32 | + $other_table_pk_field = $this->get_other_model()->get_primary_key_field(); |
|
| 33 | + $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 34 | + $model_relation_chain, |
|
| 35 | + $this->get_this_model()->get_this_model_name() |
|
| 36 | + ) . $this_table_fk_field->get_table_alias(); |
|
| 37 | + $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix( |
|
| 38 | + $model_relation_chain, |
|
| 39 | + $this->get_other_model()->get_this_model_name() |
|
| 40 | + ) . $other_table_pk_field->get_table_alias(); |
|
| 41 | + $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias); |
|
| 42 | + return $this->_left_join( |
|
| 43 | + $other_table, |
|
| 44 | + $other_table_alias, |
|
| 45 | + $other_table_pk_field->get_table_column(), |
|
| 46 | + $this_table_alias, |
|
| 47 | + $this_table_fk_field->get_table_column(), |
|
| 48 | + $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'" |
|
| 49 | + ) |
|
| 50 | + . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if |
|
| 56 | - * you like. |
|
| 57 | - * |
|
| 58 | - * @param EE_Base_Class|int $this_obj_or_id |
|
| 59 | - * @param EE_Base_Class|int $other_obj_or_id |
|
| 60 | - * @param array $extra_join_model_fields_n_values |
|
| 61 | - * @return \EE_Base_Class |
|
| 62 | - * @throws \EE_Error |
|
| 63 | - */ |
|
| 64 | - public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) |
|
| 65 | - { |
|
| 66 | - $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
|
| 67 | - $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true); |
|
| 68 | - // find the field on THIS model which a foreign key to the other model |
|
| 69 | - $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 70 | - // set that field on the other model to this model's ID |
|
| 71 | - $this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID()); |
|
| 72 | - // and make sure this model's field with the foreign model name is set to the correct value |
|
| 73 | - $this_model_obj->set( |
|
| 74 | - $this->get_this_model()->get_field_containing_related_model_name()->get_name(), |
|
| 75 | - $this->get_other_model()->get_this_model_name() |
|
| 76 | - ); |
|
| 77 | - $this_model_obj->save(); |
|
| 78 | - return $other_model_obj; |
|
| 79 | - } |
|
| 54 | + /** |
|
| 55 | + * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if |
|
| 56 | + * you like. |
|
| 57 | + * |
|
| 58 | + * @param EE_Base_Class|int $this_obj_or_id |
|
| 59 | + * @param EE_Base_Class|int $other_obj_or_id |
|
| 60 | + * @param array $extra_join_model_fields_n_values |
|
| 61 | + * @return \EE_Base_Class |
|
| 62 | + * @throws \EE_Error |
|
| 63 | + */ |
|
| 64 | + public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) |
|
| 65 | + { |
|
| 66 | + $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
|
| 67 | + $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true); |
|
| 68 | + // find the field on THIS model which a foreign key to the other model |
|
| 69 | + $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 70 | + // set that field on the other model to this model's ID |
|
| 71 | + $this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID()); |
|
| 72 | + // and make sure this model's field with the foreign model name is set to the correct value |
|
| 73 | + $this_model_obj->set( |
|
| 74 | + $this->get_this_model()->get_field_containing_related_model_name()->get_name(), |
|
| 75 | + $this->get_other_model()->get_this_model_name() |
|
| 76 | + ); |
|
| 77 | + $this_model_obj->save(); |
|
| 78 | + return $other_model_obj; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Sets the this model object's foreign key to its default, instead of pointing to the other model object |
|
| 84 | - * |
|
| 85 | - * @param EE_Base_Class|int $this_obj_or_id |
|
| 86 | - * @param EE_Base_Class|int $other_obj_or_id |
|
| 87 | - * @param array $where_query |
|
| 88 | - * @return \EE_Base_Class |
|
| 89 | - * @throws \EE_Error |
|
| 90 | - */ |
|
| 91 | - public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) |
|
| 92 | - { |
|
| 93 | - $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
|
| 94 | - $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id); |
|
| 95 | - // find the field on the other model which is a foreign key to this model |
|
| 96 | - $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 97 | - // set that field on the other model to this model's ID |
|
| 98 | - $this_model_obj->set($fk_on_this_model->get_name(), null, true); |
|
| 99 | - $this_model_obj->set( |
|
| 100 | - $this->get_this_model()->get_field_containing_related_model_name()->get_name(), |
|
| 101 | - null, |
|
| 102 | - true |
|
| 103 | - ); |
|
| 104 | - $this_model_obj->save(); |
|
| 105 | - return $other_model_obj; |
|
| 106 | - } |
|
| 82 | + /** |
|
| 83 | + * Sets the this model object's foreign key to its default, instead of pointing to the other model object |
|
| 84 | + * |
|
| 85 | + * @param EE_Base_Class|int $this_obj_or_id |
|
| 86 | + * @param EE_Base_Class|int $other_obj_or_id |
|
| 87 | + * @param array $where_query |
|
| 88 | + * @return \EE_Base_Class |
|
| 89 | + * @throws \EE_Error |
|
| 90 | + */ |
|
| 91 | + public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) |
|
| 92 | + { |
|
| 93 | + $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
|
| 94 | + $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id); |
|
| 95 | + // find the field on the other model which is a foreign key to this model |
|
| 96 | + $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
| 97 | + // set that field on the other model to this model's ID |
|
| 98 | + $this_model_obj->set($fk_on_this_model->get_name(), null, true); |
|
| 99 | + $this_model_obj->set( |
|
| 100 | + $this->get_this_model()->get_field_containing_related_model_name()->get_name(), |
|
| 101 | + null, |
|
| 102 | + true |
|
| 103 | + ); |
|
| 104 | + $this_model_obj->save(); |
|
| 105 | + return $other_model_obj; |
|
| 106 | + } |
|
| 107 | 107 | } |