status = self::get_param( array( 'param' => 'form_type' ) );
parent::__construct( $args );
$this->screen->set_screen_reader_content(
array(
'heading_list' => esc_html__( 'Forms list', 'formidable' ),
)
);
}
/**
* @return void
*/
public function prepare_items() {
global $per_page, $mode;
$page = $this->get_pagenum();
$per_page = $this->get_items_per_page( 'formidable_page_formidable_per_page' );
$mode = self::get_param(
array(
'param' => 'mode',
'default' => 'list',
)
);
$orderby = self::get_param(
array(
'param' => 'orderby',
'default' => 'name',
)
);
$order = self::get_param(
array(
'param' => 'order',
'default' => 'ASC',
)
);
FrmAppController::apply_saved_sort_preference( $orderby, $order );
$start = self::get_param(
array(
'param' => 'start',
'default' => ( $page - 1 ) * $per_page,
)
);
$s_query = array(
array(
'or' => 1,
'parent_form_id' => null,
'parent_form_id <' => 1,
),
);
switch ( $this->status ) {
case 'draft':
$s_query['is_template'] = 0;
$s_query['status'] = 'draft';
break;
case 'trash':
$s_query['status'] = 'trash';
break;
default:
$s_query['is_template'] = 0;
$s_query['status !'] = 'trash';
break;
}
$s = self::get_param(
array(
'param' => 's',
'sanitize' => 'sanitize_text_field',
)
);
if ( $s !== '' ) {
preg_match_all( '/".*?("|$)|((?<=[\\s",+])|^)[^\\s",+]+/', $s, $matches );
$search_terms = array_map( 'trim', $matches[0] );
foreach ( $search_terms as $term ) {
$s_query[] = array(
'or' => true,
'name LIKE' => $term,
'description LIKE' => $term,
'created_at LIKE' => $term,
'form_key LIKE' => $term,
'id' => $term,
);
unset( $term );
}
}
$this->items = FrmForm::getAll( $s_query, $orderby . ' ' . $order, $start . ',' . $per_page );
$total_items = FrmDb::get_count( 'frm_forms', $s_query );
$this->total_items = $total_items;
$this->set_pagination_args(
array(
'total_items' => $total_items,
'per_page' => $per_page,
)
);
}
/**
* @return void
*/
public function no_items() {
$s = self::get_param(
array(
'param' => 's',
'sanitize' => 'sanitize_text_field',
)
);
if ( $s !== '' ) {
$current_url = set_url_scheme(
'http://' . FrmAppHelper::get_server_value( 'HTTP_HOST' ) . FrmAppHelper::get_server_value( 'REQUEST_URI' )
);
$clear_url = remove_query_arg( 's', $current_url );
echo '';
printf(
/* translators: %1$s: Start link HTML, %2$s: End link HTML */
esc_html__( 'No forms match your search. %1$sClear search%2$s', 'formidable' ),
'',
' '
);
echo '
';
return;
}
if ( $this->status === 'trash' ) {
echo '';
esc_html_e( 'No forms found in the trash.', 'formidable' );
// phpcs:disable Generic.WhiteSpace.ScopeIndent
?>
';
} else {
$title = __( 'No Forms Found', 'formidable' );
include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/_no_forms.php';
}
}
public function get_bulk_actions() {
$actions = array();
if ( 'trash' === $this->status ) {
if ( current_user_can( 'frm_edit_forms' ) ) {
$actions['bulk_untrash'] = __( 'Restore', 'formidable' );
}
if ( current_user_can( 'frm_delete_forms' ) ) {
$actions['bulk_delete'] = __( 'Delete Permanently', 'formidable' );
}
} elseif ( EMPTY_TRASH_DAYS && current_user_can( 'frm_delete_forms' ) ) {
$actions['bulk_trash'] = __( 'Move to Trash', 'formidable' );
} elseif ( current_user_can( 'frm_delete_forms' ) ) {
$actions['bulk_delete'] = __( 'Delete', 'formidable' );
}
return $actions;
}
/**
* @param string $which
*
* @return void
*/
public function extra_tablenav( $which ) {
if ( 'top' !== $which ) {
return;
}
if ( 'trash' !== $this->status || ! current_user_can( 'frm_delete_forms' ) ) {
return;
}
// phpcs:disable Generic.WhiteSpace.ScopeIndent
?>
__( 'My Forms', 'formidable' ),
'draft' => __( 'Drafts', 'formidable' ),
'trash' => __( 'Trash', 'formidable' ),
);
$links = array();
$counts = FrmForm::get_count();
$form_type = FrmAppHelper::simple_get( 'form_type', 'sanitize_title', 'published' );
if ( isset( $statuses[ $form_type ] ) ) {
$counts->$form_type = $this->total_items;
}
$form_type = self::get_param(
array(
'param' => 'form_type',
'default' => 'published',
)
);
foreach ( $statuses as $status => $name ) {
$class = $status == $form_type ? ' class="current"' : ''; // phpcs:ignore Universal.Operators.StrictComparisons
if ( $counts->{$status} || 'draft' !== $status ) {
/* translators: %1$s: Status, %2$s: Number of items */
$links[ $status ] = '' . sprintf( __( '%1$s (%2$s) ', 'formidable' ), $name, number_format_i18n( $counts->{$status} ) ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
}
unset( $status, $name );
}
return $links;
}
/**
* @param stdClass $item
* @param string $style
*
* @return string
*/
public function single_row( $item, $style = '' ) {
global $mode;
// Set up the hover actions for this user
$actions = array();
$edit_link = FrmForm::get_edit_link( $item->id );
$this->get_actions( $actions, $item, $edit_link );
$action_links = $this->row_actions( $actions );
$checkbox = $this->get_row_checkbox( $item );
$r = '';
list( $columns, $hidden ) = $this->get_column_info();
$format = 'Y/m/d';
if ( 'list' !== $mode ) {
$format .= ' \<\b\r \/\> g:i:s a';
}
foreach ( $columns as $column_name => $column_display_name ) {
$class = $column_name . ' column-' . $column_name . ( 'name' === $column_name ? ' post-title page-title column-title' : '' );
$style = '';
if ( in_array( $column_name, $hidden, true ) ) {
$class .= ' hidden';
}
if ( $column_name === 'name' ) {
$class .= ' column-primary';
}
$class = 'class="' . esc_attr( $class ) . '"';
$attributes = $class . $style . $this->get_column_data_attr( $column_name, $column_display_name );
switch ( $column_name ) {
case 'cb':
$r .= '' . $checkbox . ' ';
break;
case 'id':
case 'form_key':
$val = $item->{$column_name};
break;
case 'name':
$val = $this->get_form_name( $item, $actions, $edit_link, $mode );
$val .= $action_links;
break;
case 'created_at':
$date = gmdate( $format, strtotime( $item->created_at ) );
$val = '' . $date . ' ';
break;
case 'entries':
$val = $this->get_entries_column_value( $item );
break;
default:
if ( method_exists( $this, 'column_' . $column_name ) ) {
$val = call_user_func( array( $this, 'column_' . $column_name ), $item ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
break;
}//end switch
if ( isset( $val ) ) {
$r .= "";
$r .= $val;
$r .= ' ';
}
unset( $val );
}//end foreach
return $r . ' ';
}
/**
* @param string $column_name
* @param string $column_display_name
*
* @return string
*/
private function get_column_data_attr( $column_name, $column_display_name ) {
if ( 'settings' === $column_name ) {
return ' data-colname="' . esc_attr( trim( strip_tags( $column_display_name ) ) ) . '"';
}
return ' data-colname="' . esc_attr( $column_display_name ) . '"';
}
/**
* @param object $item
*
* @return string
*/
private function get_entries_column_value( $item ) {
if ( ! empty( $item->options['no_save'] ) ) {
return (string) FrmAppHelper::icon_by_class(
'frmfont frm_forbid_icon frm_bstooltip',
array(
'title' => __( 'Saving entries is disabled for this form', 'formidable' ),
'echo' => false,
)
);
}
$text = intval( FrmEntry::getRecordCount( $item->id ) );
return current_user_can( 'frm_view_entries' ) ? '' . $text . ' ' : (string) $text; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
}
/**
* @param object $item
*
* @return string
*/
private function get_row_checkbox( $item ) {
// Set up the checkbox (because the user is editable, otherwise it's empty).
$checkbox = '' . esc_html( $checkbox_label_text ) . ' ' . FrmAppHelper::icon_by_class( 'frmfont frm_code_icon', array( 'echo' => false ) ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
$val .= $this->column_style( $form );
$val .= $this->column_views( $form );
$val = apply_filters( 'frm_form_list_actions', $val, array( 'form' => $form ) );
// Remove the space hard coded in Landing pages.
$val = str_replace( ' ', '', $val );
return '' . $val . '
';
}
/**
* Get the HTML for the Style column in the form list.
*
* @since 6.0
*
* @param stdClass $form
*
* @return string
*/
protected function column_style( $form ) {
$style_setting = $form->options['custom_style'] ?? '';
$frm_settings = FrmAppHelper::get_settings();
if ( $style_setting === '0' || 'none' === $frm_settings->load_style ) {
// Don't show a link if styling is off.
return '';
}
$style = FrmStylesController::get_form_style( $form );
if ( ! $style ) {
// Do a second pass to avoid null values.
$frm_style = new FrmStyle( 'default' );
$style = $frm_style->get_one();
}
$href = FrmStylesHelper::get_edit_url( $style, $form->id );
return '' . FrmAppHelper::icon_by_class( 'frmfont frm_pallet_icon', array( 'echo' => false ) ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
}
/**
* Generate the HTML for the form Views page.
*
* @since 6.19
*
* @param stdClass $form Form object.
*
* @return string
*/
protected function column_views( $form ) {
$attributes = array(
'href' => admin_url( 'admin.php?page=formidable-views&form=' . absint( $form->id ) . '&show_nav=1' ),
'title' => __( 'Link to list of all views for this form.', 'formidable' ),
'target' => '_blank',
);
if ( class_exists( 'FrmViewsDisplay' ) ) {
$view_ids = FrmViewsDisplay::get_display_ids_by_form( $form->id );
$view_count = $view_ids ? count( $view_ids ) : 0;
} else {
$view_count = 0;
}
// phpcs:disable Generic.WhiteSpace.ScopeIndent
return '
' . intval( $view_count ) .
' ';
// phpcs:enable Generic.WhiteSpace.ScopeIndent
}
/**
* Get the HTML for the Settings column in the form list.
*
* @since 6.32
*
* @return string
*/
protected function column_settings() {
return ' ';
}
/**
* @param array $actions
* @param object $item
* @param string $edit_link
*
* @return void
*/
private function get_actions( &$actions, $item, $edit_link ) {
$new_actions = FrmFormsHelper::get_action_links( $item->id, $item );
foreach ( $new_actions as $link => $action ) {
$new_actions[ $link ] = FrmFormsHelper::format_link_html( $action, 'short' );
}
if ( 'trash' === $this->status ) {
$actions = $new_actions;
return;
}
if ( current_user_can( 'frm_edit_forms' ) ) {
$actions['frm_edit'] = '' . esc_html__( 'Edit', 'formidable' ) . ' ';
$actions['frm_settings'] = '' . esc_html__( 'Settings', 'formidable' ) . ' ';
}
$actions = array_merge( $actions, $new_actions );
$actions['embed'] = '' . esc_html__( 'Embed', 'formidable' ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
$actions['view'] = '' . esc_html__( 'Preview', 'formidable' ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
}
/**
* @param object $item
* @param array $actions
* @param string $edit_link
* @param string $mode
*
* @return string
*/
private function get_form_name( $item, $actions, $edit_link, $mode = 'list' ) {
$form_name = $item->name;
if ( is_null( $form_name ) || trim( $form_name ) === '' ) {
$form_name = FrmFormsHelper::get_no_title_text();
}
$form_name = FrmAppHelper::kses( $form_name );
if ( 'excerpt' !== $mode ) {
$form_name = FrmAppHelper::truncate( $form_name, 50 );
}
$val = '';
if ( 'trash' === $this->status ) {
$val .= $form_name;
} else {
$val .= '' . FrmAppHelper::kses( $form_name ) . ' '; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
}
$this->add_draft_label( $item, $val );
$val .= ' ';
$this->add_form_description( $item, $val );
return $val;
}
/**
* @param object $item
* @param string $val
*
* @return void
*/
private function add_draft_label( $item, &$val ) {
if ( 'draft' === $item->status && 'draft' !== $this->status ) {
$val .= ' - ' . esc_html__( 'Draft', 'formidable' ) . ' ';
}
}
/**
* @param object $item
* @param string $val
*
* @return void
*/
private function add_form_description( $item, &$val ) {
global $mode;
if ( 'excerpt' === $mode && ! is_null( $item->description ) ) {
$val .= FrmAppHelper::truncate( strip_tags( $item->description ), 50 );
}
}
/**
* @return string
*/
protected function confirm_bulk_delete() {
return __( 'ALL selected forms and their entries will be permanently deleted. Want to proceed?', 'formidable' );
}
/**
* @param stdClass $form
*
* @return string
*/
public function column_embeds( $form ) {
if ( $this->column_is_hidden( 'embeds' ) ) {
// Locating embeds means scanning post_content, so skip it when the column is hidden.
return '';
}
$posts = $this->get_posts_contain_form( $form );
if ( ! $posts ) {
return '0 ';
}
return FrmAppHelper::clip(
function () use ( $posts ) {
?>
get_column_info();
if ( ! isset( $column_info[1] ) || ! is_array( $column_info[1] ) ) {
return false;
}
return in_array( $column_name, $column_info[1], true );
}
/**
* Gets posts or pages that contain the form shortcode.
*
* @since 6.32
*
* @param stdClass $form Form object.
*
* @return array
*/
private function get_posts_contain_form( $form ) {
$cached_posts = FrmFormEmbedsHelper::get_cached_posts();
if ( ! isset( $cached_posts[ $form->id ] ) || ! is_array( $cached_posts[ $form->id ] ) ) {
// A single scan covers every form listed on this page, not just this one.
$cached_posts = $this->fill_embed_posts_cache( $form );
}
if ( ! isset( $cached_posts[ $form->id ] ) || ! is_array( $cached_posts[ $form->id ] ) ) {
return array();
}
// Links and title fallbacks are derived at render time, not stored. get_edit_post_link()
// depends on the current user, so caching it in a shared transient would hand one user's
// edit link to another, and a permalink cached now goes stale on any slug change.
return FrmFormEmbedsHelper::prepare_posts( $cached_posts[ $form->id ] );
}
/**
* Scans for embeds once and caches the result for every form listed on the current page.
*
* @since 6.35
*
* @param stdClass $form The form whose column is currently rendering.
*
* @return array Embed posts keyed by form ID.
*/
private function fill_embed_posts_cache( $form ) {
$cached_posts = FrmFormEmbedsHelper::get_cached_posts();
$search_map = array();
$forms = array();
foreach ( $this->get_forms_to_scan( $form ) as $form_id => $form_to_scan ) {
if ( isset( $cached_posts[ $form_id ] ) && is_array( $cached_posts[ $form_id ] ) ) {
continue;
}
$search_map[ $form_id ] = $this->get_search_strings_for_form( $form_id );
$forms[ $form_id ] = $form_to_scan;
}
if ( ! $forms ) {
return $cached_posts;
}
$matched = FrmFormEmbedsHelper::match_candidate_posts( $search_map );
foreach ( $forms as $form_id => $form_to_scan ) {
$posts = $this->filter_embed_posts( $matched[ $form_id ], $form_to_scan );
$cached_posts[ $form_id ] = FrmFormEmbedsHelper::slim_posts( $posts );
}
FrmFormEmbedsHelper::save_cached_posts( $cached_posts );
return $cached_posts;
}
/**
* Gets every form rendered on the current list page, keyed by form ID.
*
* @since 6.35
*
* @param stdClass $form The form whose column is currently rendering.
*
* @return array
*/
private function get_forms_to_scan( $form ) {
$forms = array( $form->id => $form );
if ( ! is_array( $this->items ) ) {
return $forms;
}
foreach ( $this->items as $item ) {
if ( is_object( $item ) && isset( $item->id ) ) {
$forms[ $item->id ] = $item;
}
}
return $forms;
}
/**
* Applies the frm_get_posts_contain_form filter to a form's embed posts.
*
* @since 6.35
*
* @param array $posts Posts that embed the form.
* @param stdClass $form Form object.
*
* @return array
*/
private function filter_embed_posts( $posts, $form ) {
/**
* @since 6.32
*
* @param stdClass[] $posts
* @param array $args
*/
$filtered_posts = apply_filters( 'frm_get_posts_contain_form', $posts, compact( 'form' ) );
if ( ! is_array( $filtered_posts ) ) {
_doing_it_wrong( 'frm_get_posts_contain_form', 'Filter should return an array.', '6.32' );
return $posts;
}
return $filtered_posts;
}
/**
* Gets search strings for a form inside a post.
*
* @since 6.32
*
* @param int $form_id Form ID.
*
* @return string[]
*/
protected function get_search_strings_for_form( $form_id ) {
return $this->get_base_search_strings_for_form( $form_id );
}
/**
* Gets the base search strings for a form inside a post.
*
* @since 6.32
*
* @param int $form_id Form ID.
*
* @return string[]
*/
protected function get_base_search_strings_for_form( $form_id ) {
$strings = array(
'