'Entry', 'plural_name' => 'Entries', ); /** * Initialization tasks. */ public function init() { $this->labels = array( 'singular_name' => __( 'Entry', 'carbon-fields' ), 'plural_name' => __( 'Entries', 'carbon-fields' ), ); // Include the complex group Underscore templates $this->add_template( 'Complex-Group', array( $this, 'template_group' ) ); $this->add_template( 'Complex-Group-Tab-Item', array( $this, 'template_group_tab_item' ) ); parent::init(); } /** * Add a set/group of fields. * * @return $this */ public function add_fields() { $argv = func_get_args(); $argc = count( $argv ); if ( $argc == 1 ) { $fields = $argv[0]; $name = ''; $label = null; } else if ( $argc == 2 ) { if ( is_array( $argv[0] ) ) { list( $fields, $name ) = $argv; } else { list( $name, $fields ) = $argv; } $label = null; } else if ( $argc == 3 ) { if ( is_array( $argv[0] ) ) { list( $fields, $name, $label ) = $argv; } else { list( $name, $label, $fields ) = $argv; } } if ( array_key_exists( '_' . $name, $this->groups ) ) { Incorrect_Syntax_Exception::raise( 'Group with name "' . $name . '" in Complex Field "' . $this->get_label() . '" already exists.' ); } $group = new Group_Field($name, $label, $fields); $this->groups[ $group->get_name() ] = $group; return $this; } /** * Set the group label Underscore template. * * @param string|callable $template * @return $this */ public function set_header_template( $template ) { if ( count($this->groups) === 0 ) { Incorrect_Syntax_Exception::raise( "Can't set group label template. There are no present groups for Complex Field " . $this->get_label() . "." ); } $template = is_callable( $template ) ? call_user_func( $template ) : $template; // Assign the template to the group that was added last $values = array_values( $this->groups ); $group = end( $values ); $group->set_label_template( $template ); // Include the group label Underscore template $this->add_template( $group->get_group_id(), array( $group, 'template_label' ) ); $this->groups[ $group->get_name() ] = $group; return $this; } /** * Retrieve all groups of fields. * * @return array $fields */ public function get_fields() { $fields = array(); foreach ( $this->groups as $group ) { $group_fields = $group->get_fields(); $fields = array_merge( $fields, $group_fields ); } return $fields; } /** * Set the field labels. * Currently supported values: * - singular_name - the singular entry label * - plural_name - the plural entries label * * @param array $labels Labels */ public function setup_labels( $labels ) { $this->labels = array_merge( $this->labels, $labels ); return $this; } /** * Set the datastore of this field. * * @param Datastore_Interface $store */ public function set_datastore( Datastore_Interface $store ) { $this->store = $store; foreach ( $this->groups as $group ) { $group->set_datastore( $this->store ); } } /** * Load the field value from an input array based on it's name. * * @param array $input (optional) Array of field names and values. Defaults to $_POST **/ public function set_value_from_input( $input = null ) { $this->values = array(); if ( is_null( $input ) ) { $input = $_POST; } if ( ! isset( $input[ $this->get_name() ] ) ) { return; } $input_groups = $input[ $this->get_name() ]; $index = 0; foreach ( $input_groups as $values ) { $value_group = array(); if ( ! isset( $values['group'] ) || ! isset( $this->groups[ $values['group'] ] ) ) { continue; } $group = $this->groups[ $values['group'] ]; unset( $values['group'] ); $group_fields = $group->get_fields(); // trim input values to those used by the field $group_field_names = array_flip( $group->get_field_names() ); $values = array_intersect_key( $values, $group_field_names ); foreach ( $group_fields as $field ) { // set value from the group $tmp_field = clone $field; if ( is_a( $tmp_field, __NAMESPACE__ . '\\Complex_Field' ) ) { if ( ! isset( $values[ $tmp_field->get_name() ] ) ) { continue; // bail if the complex field is empty } $new_name = $this->get_name() . $group->get_name() . '-' . $field->get_name() . '_' . $index; $new_values = array( $new_name => $values[ $tmp_field->get_name() ] ); $tmp_field->set_name( $new_name ); $tmp_field->set_value_from_input( $new_values ); } else { $tmp_field->set_value_from_input( $values ); } // update name to group name $tmp_field->set_name( $this->get_name() . $group->get_name() . '-' . $field->get_name() . '_' . $index ); $value_group[] = $tmp_field; } $this->values[] = $value_group; $index++; } } /** * Load all groups of fields and their data. */ public function load() { // load existing groups $this->load_values(); } /** * Save all contained groups of fields. */ public function save() { $this->delete(); foreach ( $this->values as $value ) { foreach ( $value as $field ) { $field->save(); } } } /** * Delete the values of all contained fields. */ public function delete() { return $this->store->delete_values( $this ); } /** * Load and parse the field data. */ public function load_values() { return $this->load_values_from_db(); } /** * Load and parse the field data from the database. */ public function load_values_from_db() { $this->values = array(); $group_rows = $this->store->load_values( $this ); return $this->process_loaded_values( $group_rows ); } /** * Load and parse a raw set of field data. * * @param array $values Raw data entries * @return array Processed data entries */ public function load_values_from_array( $values ) { $this->values = array(); $group_rows = array(); $meta_key = $this->get_name(); foreach ( $values as $key => $value ) { if ( strpos( $key, $meta_key ) !== 0 ) { continue; } $group_rows[] = array( 'field_key' => preg_replace( '~^(' . preg_quote( $this->name, '~' ) . ')_\d+_~', '$1_', $key ), 'field_value' => $value, ); } return $this->process_loaded_values( $group_rows ); } /** * Parse groups of raw field data into the actual field hierarchy. * * @param array $group_rows Group rows */ public function process_loaded_values( $group_rows ) { $input_groups = array(); // Set default values $field_names = array(); foreach ( $this->groups as $group ) { $group_fields = $group->get_fields(); foreach ( $group_fields as $field ) { $field_names[] = $field->get_name(); $field->set_value( $field->get_default_value() ); } } if ( empty( $group_rows ) ) { return; } // load and parse values and group type foreach ( $group_rows as $row ) { if ( ! preg_match( Helper::get_complex_field_regex( $this->name, array_keys( $this->groups ), $field_names ), $row['field_key'], $field_name ) ) { continue; } $row['field_value'] = maybe_unserialize( $row['field_value'] ); $input_groups[ $field_name['index'] ]['type'] = $field_name['group']; if ( ! empty( $field_name['trailing'] ) ) { $input_groups[ $field_name['index'] ][ $field_name['key'] . '_' . $field_name['sub'] . '-' . $field_name['trailing'] ] = $row['field_value']; } else if ( ! empty( $field_name['sub'] ) ) { $input_groups[ $field_name['index'] ][ $field_name['key'] ][ $field_name['sub'] ] = $row['field_value']; } else { $input_groups[ $field_name['index'] ][ $field_name['key'] ] = $row['field_value']; } } // create groups list with loaded fields ksort( $input_groups ); foreach ( $input_groups as $index => $values ) { $value_group = array( 'type' => $values['type'] ); $group_fields = $this->groups[ $values['type'] ]->get_fields(); unset( $values['type'] ); foreach ( $group_fields as $field ) { // set value from the group $tmp_field = clone $field; if ( is_a( $field, __NAMESPACE__ . '\\Complex_Field' ) ) { $tmp_field->load_values_from_array( $values ); } else { $tmp_field->set_value_from_input( $values ); } $value_group[] = $tmp_field; } $this->values[] = $value_group; } } /** * Retrieve the field values. * @return array */ public function get_values() { return $this->values; } /** * Generate and set the field prefix. * @param string $prefix */ public function set_prefix( $prefix ) { parent::set_prefix( $prefix ); foreach ( $this->groups as $group ) { $group->set_prefix( $prefix ); } } /** * Returns an array that holds the field data, suitable for JSON representation. * This data will be available in the Underscore template and the Backbone Model. * * @param bool $load Should the value be loaded from the database or use the value from the current instance. * @return array */ public function to_json( $load ) { $complex_data = parent::to_json( $load ); $groups_data = array(); $values_data = array(); foreach ( $this->groups as $group ) { $groups_data[] = $group->to_json( false ); } foreach ( $this->values as $fields ) { $group = $this->get_group_by_name( $fields['type'] ); unset( $fields['type'] ); $data = array( 'name' => $group->get_name(), 'label' => $group->get_label(), 'group_id' => $group->get_group_id(), 'fields' => array(), ); foreach ( $fields as $index => $field ) { $data['fields'][] = $field->to_json( false ); } $values_data[] = $data; } $complex_data = array_merge( $complex_data, array( 'layout' => $this->layout, 'labels' => $this->labels, 'min' => $this->get_min(), 'max' => $this->get_max(), 'multiple_groups' => count( $groups_data ) > 1, 'groups' => $groups_data, 'value' => $values_data, ) ); return $complex_data; } /** * The main Underscore template. */ public function template() { ?>
{{{ crbl10n.complex_no_rows.replace('%s', labels.plural_name) }}}
<# if (layout === '' || layout === '' ) { #>
    + <# if (multiple_groups) { #> <# } #>
    <# } #>
    {{{ crbl10n.complex_add_button.replace('%s', labels.singular_name) }}} {{{ multiple_groups ? '⇩' : '' }}} <# if (multiple_groups) { #> <# } #>
    {{{ order + 1 }}}{{{ label_template || label }}}
    <# _.each(fields, function(field) { #>
    <# if (field.help_text) { #> {{{ field.help_text }}} <# } #>
    <# }) #>
  • <# if (label_template || label) { #> {{{ label_template || label }}} <# } #> {{{ order + 1 }}}
    • ' . self::LAYOUT_LIST . ' layout is deprecated, please use set_width() instead.', 'carbon_fields' ), null ); } $this->layout = $layout; return $this; } /** * Set the minimum number of entries. * * @param int $min */ public function set_min( $min ) { $this->values_min = intval( $min ); return $this; } /** * Get the minimum number of entries. * * @return int $min */ public function get_min() { return $this->values_min; } /** * Set the maximum number of entries. * * @param int $max */ public function set_max( $max ) { $this->values_max = intval( $max ); return $this; } /** * Get the maximum number of entries. * * @return int $max */ public function get_max() { return $this->values_max; } /** * Retrieve the groups of this field. * * @return array */ public function get_group_names() { return array_keys( $this->groups ); } /** * Retrieve a group by its name. * * @param string $group_name Group name * @return Group_Field $group_object Group object */ public function get_group_by_name( $group_name ) { $group_object = null; foreach ( $this->groups as $group ) { if ( $group->get_name() == $group_name ) { $group_object = $group; } } return $group_object; } }