maybe_init_style_manager(); $this->register_block(); } /** * Override this method to set you style controls */ protected function jsm_controls() { } public function get_css_scheme() { return array(); } public function use_preset() { return true; } public function rep_item_id() { return $this->get_name(); } /** * Returns block name/slug * * @return string */ abstract public function get_name(); /** * Returns renderer class instance for current block * * @param null $wp_block * * @return [type] [description] */ abstract public function get_block_renderer( $wp_block = null ); protected function iterate_args_metadata_block(): \Generator { /** @var Module $module */ /** @noinspection PhpUnhandledExceptionInspection */ $module = jet_form_builder()->module( 'blocks' ); yield 'render_callback' => $module->render_callback( $this ); } public function get_path_metadata_block() { $path_parts = array( 'assets', 'blocks-src', $this->get_name() ); $path = implode( DIRECTORY_SEPARATOR, $path_parts ); return jet_form_builder()->plugin_dir( $path ); } protected function register_block() { if ( ! function_exists( 'register_block_type_from_metadata' ) ) { return; } $block = register_block_type_from_metadata( $this->get_path_metadata_block(), iterator_to_array( $this->iterate_args_metadata_block() ) ); if ( ! $block ) { _doing_it_wrong( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped static::class . '::' . __FUNCTION__, esc_html__( 'Unsuccessful field (block) registration. Perhaps the path to the block scheme (block.json) is incorrectly specified', 'jet-form-builder' ), '2.1.0' ); return; } $this->attrs = $block->attributes; $this->uses_context = $block->uses_context; $this->provides_context = $block->provides_context; } /** * @return array */ public function get_uses_context(): array { return $this->uses_context; } /** * @return array */ public function get_provides_context(): array { return $this->provides_context; } private function maybe_init_style_manager() { if ( ! Compatibility::has_jet_sm() || ! $this->use_style_manager ) { return; } $this->css_scheme = array_merge( $this->general_css_scheme(), $this->get_css_scheme() ); $this->controls_manager = new Controls_Manager( $this->block_name() ); $this->run_jsm_controls(); $this->general_style_manager_options(); } /** * Set style manager class instance * * @return Base */ private function run_jsm_controls(): Base { if ( method_exists( $this, '_jsm_register_controls' ) ) { $this->_jsm_register_controls(); return $this; } $this->jsm_controls(); return $this; } /** * Render callback for the block * * @param array $attrs * @param $content * * @param null $wp_block * * @return string */ public function render_callback_field( array $attrs, $content = null, $wp_block = null ) { try { $before = $this->before_render_field( $attrs, $content, $wp_block ); $render = $before . $this->render_field( $attrs, $content, $wp_block ); $after = $this->after_render_field( $attrs, $content, $wp_block ); return $render . $after; } catch ( Render_Empty_Field $exception ) { return ''; } } /** * @param array $attrs * @param null $content * @param null $wp_block * * @return string * @throws Render_Empty_Field */ protected function render_field( array $attrs, $content = null, $wp_block = null ): string { if ( ! Live_Form::instance()->form_id ) { throw new Render_Empty_Field( 'empty_form_id' ); } $this->set_block_data( $attrs, $content, $wp_block ); $this->set_preset(); $result = array(); $result[] = $this->start_form_row(); if ( $this->is_field_visible() ) { /** * $wp_block should not save in $this, * like $attributes & $content * because it's too large */ $parsed_block = $wp_block ? $wp_block->parsed_block : null; $result[] = $this->get_block_renderer( $parsed_block ); } $result[] = $this->end_form_row(); return implode( "\n", $result ); } protected function before_render_field( array $attrs, $content = null, $wp_block = null ): string { return apply_filters( 'jet-form-builder/before-render-field', '', $this->get_name(), $attrs, $content, $wp_block ); } protected function after_render_field( array $attrs, $content = null, $wp_block = null ): string { return apply_filters( 'jet-form-builder/after-render-field', '', $this->get_name(), $attrs, $content, $wp_block ); } /** * @param $attributes * @param null $content * @param \WP_Block $wp_block * * @throws Repository_Exception */ public function set_block_data( $attributes, $content = null, $wp_block = null ) { $this->block_content = $content; $this->block_attrs = array_merge( $this->get_default_attributes(), $attributes ); $this->set_context( $wp_block->context ?? array() ); $this->block_attrs['blockName'] = $this->block_name(); $this->block_attrs['type'] = $this->get_name(); foreach ( $this->attrs as $name => $settings ) { if ( ! array_key_exists( $name, $this->block_attrs ) ) { continue; } $this->block_attrs[ $name ] = $this->apply_attribute( $name ); } } public function set_context( array $context ): Base { $this->block_context = $context; return $this; } public function set_preset() { if ( ! $this->use_preset() ) { return; } $this->block_attrs['default'] = $this->get_prepared_default( $this->get_default_from_preset() ); } /** * @param string $name * * @return mixed * @throws Repository_Exception */ protected function apply_attribute( string $name ) { $shortcode = $this->attrs[ $name ]['jfb']['shortcode'] ?? false; $rich = $this->attrs[ $name ]['jfb']['rich'] ?? false; $rich_no_preset = $this->attrs[ $name ]['jfb']['rich-no-preset'] ?? false; $value = $this->block_attrs[ $name ]; if ( is_numeric( $value ) ) { return $value; } if ( $rich ) { // immediately return, because rich method also parsing preset and shortcodes return Rich_Content\Module::rich( $value ); } /** * Removes dynamic preset support in rich-content. * Because it will break preset value for several fields */ if ( $rich_no_preset ) { /** @var Rich_Content\Module $rich */ $rich = jet_form_builder()->module( 'rich-content' ); remove_filter( 'jet-form-builder/rich-content', array( $rich, 'apply_dynamic_preset' ) ); $value = Rich_Content\Module::rich( $value ); add_filter( 'jet-form-builder/rich-content', array( $rich, 'apply_dynamic_preset' ) ); // immediately return, because rich method also parsing preset and shortcodes return $value; } // backward compatibility if ( $shortcode ) { $value = do_shortcode( $value ); } return $value; } /** * @param $value * * @return mixed * @since 3.1.0 Added case for PRESET_LIST & make public * @see Base::PRESET_LIST */ public function get_prepared_default( $value ) { $format = $this->expected_preset_type()[0] ?? false; switch ( $format ) { case self::PRESET_EXACTLY: return $value; case self::PRESET_ARRAY: if ( ! is_array( $value ) ) { $value = array( $value ); } return array_map( 'strval', $value ); case self::PRESET_LIST: if ( is_string( $value ) ) { $value = explode( ',', $value ); $value = array_map( 'trim', $value ); } if ( ! is_array( $value ) ) { $value = array( $value ); } return array_map( array( Tools::class, 'to_string' ), $value ); case self::PRESET_RAW: default: if ( is_array( $value ) ) { foreach ( $value as $item ) { return $item; } } return $value; } } /** * @param array $attributes * * @return mixed|string|void * @since 3.1.0 Make public */ public function get_default_from_preset( $attributes = array() ) { jet_fb_preset( jet_fb_live()->form_id ); $index = $this->get_repeater_index(); if ( ! $this->get_repeater_name() || - 1 === $index ) { return $this->get_field_value( $attributes ); } $name = $this->block_attrs['name'] ?? ''; $row = $this->block_context[ Block_Type_Row::CONTEXT_DEFAULT ] ?? array(); $custom_value = $this->get_value_from_repeater( $row, $name ); if ( false !== $custom_value ) { return $custom_value; } $value = ( $row[ $name ] ?? $this->get_field_value( $attributes ) ); return Preset_Manager::instance()->prepare_result( $this->get_name(), $value ); } /** * @param array $row * @param string $name * * @return mixed */ protected function get_value_from_repeater( array $row, string $name ) { return false; } /** * Returns field ID with repeater prefix if needed * * @param string $name * * @return mixed|string */ public function get_field_id( $name = '', $for_element = 'input' ) { if ( $name && is_array( $name ) ) { $name = $name['name'] ?? ''; } if ( ! $name ) { $name = $this->block_attrs['name'] ?? ''; } $index = $this->get_repeater_index(); if ( $this->get_repeater_name() ) { $name = sprintf( '%1$s_%2$s_%3$s', $this->get_repeater_name(), - 1 === $index ? '__i__' : $index, $name ); } return Builder_Helper::get_unique_id( $name, $for_element ); } /** * Returns field name with repeater prefix if needed * * @param $name * * @return string */ public function get_field_name( $name = '' ) { if ( ! $name ) { $name = $this->block_attrs['name'] ?? ''; } $index = $this->get_repeater_index(); if ( $this->get_repeater_name() ) { $name = sprintf( '%1$s[%2$s][%3$s]', $this->get_repeater_name(), - 1 === $index ? '__i__' : $index, $name ); } return $name; } protected function get_repeater_index(): int { return intval( $this->block_context[ Block_Type_Row::CONTEXT_INDEX ] ?? - 1 ); } /** * You can override this method * to set your own template path * * @return false|string */ public function fields_templates_path() { return false; } /** * You can override this method * to set your own template path * * @return false|string */ public function common_templates_path() { return false; } /** * You can rewrite this method * so as not to display an additional html wrapper. * * Or you can add it yourself under some condition * using the Base::start_form_row & Base::end_form_row methods * * @return bool */ public function render_row_layout() { return true; } /** * Returns full block name * * @return [type] [description] */ public function block_name(): string { return jet_form_builder()->form::NAMESPACE_FIELDS . $this->get_name(); } /** * Get required attribute value * * @param [type] $args [description] * * @return [type] [description] */ public function get_required_val() { if ( ! empty( $this->block_attrs['required'] ) && ( 'required' === $this->block_attrs['required'] || true === $this->block_attrs['required'] ) ) { return 'required'; } return ''; } public function get_required_attr() { $required = $this->get_required_val(); if ( $required ) { return "required=\"$required\""; } return ''; } /** * Returns template path * * @param [type] $path [description] * * @return [type] [description] */ public function get_field_template( $path ) { $fields_path = $this->fields_templates_path(); if ( ! $fields_path ) { $fields_path = JET_FORM_BUILDER_PATH . 'templates/fields/'; } return $fields_path . $path; } public function get_common_template( $path ) { $fields_path = $this->common_templates_path(); if ( ! $fields_path ) { $fields_path = JET_FORM_BUILDER_PATH . 'templates/common/'; } return $fields_path . $path; } public function get_default_attributes() { $default = array(); foreach ( $this->attrs as $name => $value ) { if ( isset( $value['default'] ) ) { $default[ $name ] = $value['default']; } } return $default; } /** * Register blocks specific JS variables * * @param [type] $editor [description] * @param [type] $handle [description] */ public function block_data( $editor, $handle ) { } public function get_attributes() { return $this->attrs; } /** * Open form wrapper * * @param bool $force * * @return false|string [type] [description] */ public function start_form_row( $force = false ) { if ( ! $force && ! $this->render_row_layout() ) { return ''; } ob_start(); do_action( 'jet-form-builder/before-start-form-row', $this ); include $this->get_global_template( 'common/start-form-row.php' ); do_action( 'jet-form-builder/after-start-form-row', $this ); return ob_get_clean(); } /** * Close form wrapper * * @param bool $force * * @return false|string [type] [description] */ public function end_form_row( $force = false ) { if ( ! $force && ! $this->render_row_layout() ) { return ''; } ob_start(); do_action( 'jet-form-builder/before-end-form-row', $this ); include $this->get_global_template( 'common/end-form-row.php' ); do_action( 'jet-form-builder/after-end-form-row', $this ); return ob_get_clean(); } /** * Returns true if field is visible * * @param $field * * @return boolean [description] */ public function is_field_visible() { $visibility = $this->block_attrs['visibility'] ?? false; // For backward compatibility and hidden fields if ( empty( $visibility ) ) { return true; } // If is visible for all - show field if ( 'all' === $visibility ) { return true; } // If is visible for logged in users and user is logged in - show field if ( 'logged_id' === $visibility && is_user_logged_in() ) { return true; } // If is visible for not logged in users and user is not logged in - show field if ( 'not_logged_in' === $visibility && ! is_user_logged_in() ) { return true; } return false; } public function after_set_pages( Form_Break $form_break ) { } /** * @return Form_Break */ public function get_current_form_break() { $context_name = 'jet-forms/conditional-block--name'; if ( ! isset( $this->block_context[ $context_name ] ) ) { return Live_Form::instance()->get_form_break(); } $name = $this->block_context[ $context_name ]; $break = Live_Form::instance()->get_form_break( $name ); if ( ! $break->get_pages() ) { $conditional = Plugin::instance()->form->get_field_by_name( 0, $name, Live_Form::instance()->blocks ); $break->set_pages( $conditional['innerBlocks'], false ); $this->after_set_pages( $break ); } return $break; } public function get_repeater_name(): string { return $this->block_context[ Block_Type::CONTEXT_NAME ] ?? ''; } public function get_field_value( $attributes = array() ) { if ( ! $attributes ) { $attributes = $this->block_attrs; } return Preset_Manager::instance()->get_field_value( $attributes ); } /** * Possible values: * 'raw' - get what is, unchanged; * 'array'; * * @return array */ public function expected_preset_type(): array { return array( self::PRESET_RAW ); } public function set_attribute( string $key, $value ) { $this->block_attrs[ $key ] = $value; if ( is_array( \WP_Block_Supports::$block_to_render ) && ! empty( \WP_Block_Supports::$block_to_render['attrs'] ) ) { \WP_Block_Supports::$block_to_render['attrs'][ $key ] = $value; } } }