Column.php

<?php

namespace AC;

/**
 * @since 3.0
 */
class Column
{

    /**
     * @var string Unique Name
     */
    private $name;

    /**
     * @var string Unique type
     */
    private $type;

    /**
     * @var string|null Label which describes this column
     */
    private $label;

    /**
     * @var string Group name
     */
    private $group;

    /**
     * @var bool An original column will use the already defined column value and label.
     */
    private $original = false;

    /**
     * @var Settings\Column[]
     */
    private $settings;

    /**
     * @var Settings\FormatValue[]|Settings\FormatCollection[]
     */
    private $formatters;

    /**
     * @var ListScreen
     */
    protected $list_screen;

    /**
     * The options managed by the settings
     * @var array
     */
    protected $options = [];

    /**
     * Get the unique name of the column
     * @return string Column name
     * @since 2.3.4
     */
    public function get_name()
    {
        return $this->name;
    }

    /**
     * @param string $name
     *
     * @return $this
     */
    public function set_name($name)
    {
        $this->name = (string)$name;

        return $this;
    }

    /**
     * Get the type of the column.
     * @return string Type
     * @since 2.3.4
     */
    public function get_type()
    {
        return $this->type;
    }

    /**
     * @param string $type
     *
     * @return $this
     */
    public function set_type($type)
    {
        $this->type = (string)$type;

        return $this;
    }

    public function get_list_screen(): ListScreen
    {
        return $this->list_screen;
    }

    public function set_list_screen(ListScreen $list_screen): self
    {
        $this->list_screen = $list_screen;

        return $this;
    }

    public function get_meta_type(): string
    {
        return $this->list_screen->get_meta_type();
    }

    public function get_list_key(): string
    {
        return $this->list_screen->get_key();
    }

    public function get_list_singular_label(): string
    {
        return $this->list_screen->get_singular_label() ?: $this->get_label();
    }

    /**
     * Get the type of the column.
     * @return string Label of column's type
     * @since 2.4.9
     */
    public function get_label()
    {
        if (null === $this->label) {
            $this->set_label(
                $this->get_list_screen()->get_original_label($this->get_type())
            );
        }

        return (string)$this->label;
    }

    /**
     * @param string|null $label
     *
     * @return $this
     */
    public function set_label($label)
    {
        $this->label = $label ? (string)$label : null;

        return $this;
    }

    /**
     * @return string Group
     * @since 3.0
     */
    public function get_group()
    {
        if (null === $this->group) {
            $this->set_group('custom');

            if ($this->is_original()) {
                $this->set_group('default');
            }
        }

        return $this->group;
    }

    /**
     * @param string $group Group label
     *
     * @return $this
     */
    public function set_group($group)
    {
        $this->group = $group;

        return $this;
    }

    /**
     * @return string Post type
     */
    public function get_post_type()
    {
        return method_exists($this->list_screen, 'get_post_type') ? $this->list_screen->get_post_type() : false;
    }

    /**
     * @return string Taxonomy
     */
    public function get_taxonomy()
    {
        return method_exists($this->list_screen, 'get_taxonomy') ? $this->list_screen->get_taxonomy() : false;
    }

    /**
     * Return true when a default column has been replaced by a custom column.
     * An original column will then use the original label and value.
     * @since 3.0
     */
    public function is_original()
    {
        return $this->original;
    }

    /**
     * @param bool $boolean
     *
     * @return $this
     */
    public function set_original($boolean)
    {
        $this->original = (bool)$boolean;

        return $this;
    }

    /**
     * Overwrite this function in child class.
     * Determine whether this column type should be available
     * @return bool Whether the column type should be available
     * @since 2.2
     */
    public function is_valid()
    {
        return true;
    }

    /**
     * @param Settings\Column $setting
     *
     * @return $this
     */
    public function add_setting(Settings\Column $setting)
    {
        $setting->set_values($this->options);

        $this->settings[$setting->get_name()] = $setting;

        foreach ((array)$setting->get_dependent_settings() as $dependent_setting) {
            $this->add_setting($dependent_setting);
        }

        return $this;
    }

    /**
     * @param string $id Settings ID
     */
    public function remove_setting($id)
    {
        if (isset($this->settings[$id])) {
            unset($this->settings[$id]);
        }
    }

    /**
     * @param string $id
     *
     * @return Settings\Column|Settings\Column\User|Settings\Column\Separator|Settings\Column\Label
     */
    public function get_setting($id)
    {
        return $this->get_settings()->get($id);
    }

    public function get_formatters()
    {
        if (null === $this->formatters) {
            foreach ($this->get_settings() as $setting) {
                if ($setting instanceof Settings\FormatValue || $setting instanceof Settings\FormatCollection) {
                    $this->formatters[] = $setting;
                }
            }
        }

        return $this->formatters;
    }

    /**
     * @return string
     * @since 3.2.5
     */
    public function get_custom_label()
    {
        /**
         * @param string $label
         * @param Column $column
         *
         * @since 3.0
         */
        return (string)apply_filters('ac/headings/label', $this->get_setting('label')->get_value(), $this);
    }

    /**
     * @return Collection
     */
    public function get_settings()
    {
        if (null === $this->settings) {
            $settings = [
                new Settings\Column\Type($this),
                new Settings\Column\Label($this),
                new Settings\Column\Width($this),
            ];

            foreach ($settings as $setting) {
                $this->add_setting($setting);
            }

            $this->register_settings();

            do_action('ac/column/settings', $this);
        }

        return new Collection($this->settings);
    }

    /**
     * Register settings
     */
    protected function register_settings()
    {
        // Overwrite in child class
    }

    /**
     * @param string $key
     *
     * @return null|string|bool
     */
    public function get_option($key)
    {
        $options = $this->get_options();

        return isset($options[$key]) ? $options[$key] : null;
    }

    /**
     * @param array $options
     *
     * @return $this
     */
    public function set_options(array $options)
    {
        $this->options = $options;

        return $this;
    }

    /**
     * Get the current options
     * @return array
     */
    public function get_options()
    {
        return $this->options;
    }

    /**
     * Enqueue CSS + JavaScript on the admin listings screen!
     * This action is called in the admin_head action on the listings screen where your column values are displayed.
     * Use this action to add CSS + JavaScript
     * @since 2.3.4
     */
    public function scripts()
    {
        // Overwrite in child class
    }

    /**
     * Apply available formatters (recursive) on the value
     *
     * @param mixed $value
     * @param mixed $original_value
     * @param int   $current Current index of self::$formatters
     *
     * @return mixed
     */
    public function get_formatted_value($value, $original_value = null, $current = 0)
    {
        $formatters = $this->get_formatters();
        $available = count((array)$formatters);

        if (null === $original_value) {
            $original_value = $value;
        }

        if ($available > $current) {
            $is_collection = $value instanceof Collection;
            $is_value_formatter = $formatters[$current] instanceof Settings\FormatValue;

            if ($is_collection && $is_value_formatter) {
                foreach ($value as $k => $v) {
                    $value->put($k, $this->get_formatted_value($v, null, $current));
                }

                while ($available > $current) {
                    if ($formatters[$current] instanceof Settings\FormatCollection) {
                        return $this->get_formatted_value($value, $original_value, $current);
                    }

                    ++$current;
                }
            } elseif (($is_collection && ! $is_value_formatter) || $is_value_formatter) {
                $value = $formatters[$current]->format($value, $original_value);

                return $this->get_formatted_value($value, $original_value, ++$current);
            }
        }

        return $value;
    }

    /**
     * Get the raw, underlying value for the column
     * Not suitable for direct display, use get_value() for that
     *
     * @param int $id
     *
     * @return string|array
     * @since 2.0.3
     */
    public function get_raw_value($id)
    {
        return null;
    }

    /**
     * Display value
     *
     * @param int $id
     *
     * @return string
     */
    public function get_value($id)
    {
        $value = $this->get_formatted_value($this->get_raw_value($id), $id);

        if ($value instanceof Collection) {
            $value = $value->filter()->implode($this->get_separator());
        }

        if ( ! $this->is_original() && ac_helper()->string->is_empty($value)) {
            $value = $this->get_empty_char();
        }

        return (string)$value;
    }

    /**
     * @return string
     */
    public function get_separator()
    {
        return (new ApplyFilter\ColumnSeparator($this))->apply_filters(', ');
    }

    /**
     * @return string
     */
    public function get_empty_char()
    {
        return '&ndash;';
    }

}