ideasonpurpose / wp-data-model / #16

pending completion

Build # #16

Build Type

push

php-coveralls

Committed by

joemaller

Commit Message

update lockfile for GitHub Actions run

Run Details

211 of 234 relevant lines covered (90.17%)

2.73 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Rename.php

<?php

namespace IdeasOnPurpose\WP;

use IdeasOnPurpose\DataModel;

abstract class Rename
{
    /**
     * __callStatic is a magic method which renames the invoked thing using a string in the first
     * index of $args. Built-in types must be referenced by a known short name, eg. 'post', 'page',
     * 'category', 'tag', etc. Tags can be either 'tag' or 'post_tag'.
     *
     * A simple example call which renames 'Pages' to 'Chapters' looks like this:
     *
     *     WP\Rename::page('chapter');
     *
     * Set the second argument to false to disable singular/plural inflection. Renaming 'Categories'
     * to 'Class' would look like this:
     *
     *     WP\Rename::category('class', false);
     *
     * Individual labels can be overridden by sending an array in the third argument:
     *
     *     WP\Rename::tag('flavors', true, ['popular_items' => 'Most delicious flavors']);
     *
     * Unknown types will be ignored. Overrides should be an associative array and can include some
     * or all available labels.
     *
     * @param String $name - The name of the invoked magic method, use this as the thing to rename
     * @param Array $args - An array of additional args. Breaks down like this:
     *                      [ $labelBase, $inflect, $overrides ]
     */
    public static function __callStatic($name, $args)
    {
        $labelBase = $args[0] ?? null;
        $inflect = !!($args[1] ?? true);
        $overrides = $args[2] ?? [];

        if (!$labelBase) {
            return new Error('A new name must be provided when renaming.');
        }
        if (!is_array($overrides)) {
            return new Error('Overrides must be an array.');
        }

        /**
         * This is a Special case for "Tags" since WordPress stores them as "post_tag". We just re-map it.
         */
        $name = strtolower($name) === 'tag' ? 'post_tag' : $name;

        self::update($name, $labelBase, $inflect, $overrides);
    }

    /**
     * Generates a set of type-specific labels based on $labelBase, then assigns those labels
     * to the Post_type or Taxonomy $object
     */
    protected static function update($object, $labelBase, $inflect = true, $overrides = [])
    {
        global $wp_post_types, $wp_taxonomies;

        /**
         * Assign new labels to native objects
         */
        if (array_key_exists($object, $wp_post_types)) {
            $wp_post_types[$object]->labels = DataModel::postTypeLabels(
                $labelBase,
                $inflect,
                $overrides
            );
        } elseif (array_key_exists($object, $wp_taxonomies)) {
            $wp_taxonomies[$object]->labels = DataModel::taxonomyLabels(
                $labelBase,
                $inflect,
                $overrides
            );
        } else {
            new Error("'{$object}' is not a known Post_type or Taxonomy. Unable to rename.");
        }
    }
}

1	<?php
2
3	namespace IdeasOnPurpose\WP;
4
5	use IdeasOnPurpose\DataModel;
6
7	abstract class Rename
8	{
9	/**
10	* __callStatic is a magic method which renames the invoked thing using a string in the first
11	* index of $args. Built-in types must be referenced by a known short name, eg. 'post', 'page',
12	* 'category', 'tag', etc. Tags can be either 'tag' or 'post_tag'.
13	*
14	* A simple example call which renames 'Pages' to 'Chapters' looks like this:
15	*
16	* WP\Rename::page('chapter');
17	*
18	* Set the second argument to false to disable singular/plural inflection. Renaming 'Categories'
19	* to 'Class' would look like this:
20	*
21	* WP\Rename::category('class', false);
22	*
23	* Individual labels can be overridden by sending an array in the third argument:
24	*
25	* WP\Rename::tag('flavors', true, ['popular_items' => 'Most delicious flavors']);
26	*
27	* Unknown types will be ignored. Overrides should be an associative array and can include some
28	* or all available labels.
29	*
30	* @param String $name - The name of the invoked magic method, use this as the thing to rename
31	* @param Array $args - An array of additional args. Breaks down like this:
32	* [ $labelBase, $inflect, $overrides ]
33	*/
34	public static function __callStatic($name, $args)
35	{
36	$labelBase = $args[0] ?? null;	×
37	$inflect = !!($args[1] ?? true);	×
38	$overrides = $args[2] ?? [];	×
39
40	if (!$labelBase) {	×
41	return new Error('A new name must be provided when renaming.');	×
42	}
43	if (!is_array($overrides)) {	×
44	return new Error('Overrides must be an array.');	×
45	}
46
47	/**
48	* This is a Special case for "Tags" since WordPress stores them as "post_tag". We just re-map it.
49	*/
50	$name = strtolower($name) === 'tag' ? 'post_tag' : $name;	×
51
52	self::update($name, $labelBase, $inflect, $overrides);	×
53	}
54
55	/**
56	* Generates a set of type-specific labels based on $labelBase, then assigns those labels
57	* to the Post_type or Taxonomy $object
58	*/
59	protected static function update($object, $labelBase, $inflect = true, $overrides = [])
60	{
61	global $wp_post_types, $wp_taxonomies;	×
62
63	/**
64	* Assign new labels to native objects
65	*/
66	if (array_key_exists($object, $wp_post_types)) {	×
67	$wp_post_types[$object]->labels = DataModel::postTypeLabels(	×
68	$labelBase,	×
69	$inflect,	×
70	$overrides	×
71	);	×
72	} elseif (array_key_exists($object, $wp_taxonomies)) {	×
73	$wp_taxonomies[$object]->labels = DataModel::taxonomyLabels(	×
74	$labelBase,	×
75	$inflect,	×
76	$overrides	×
77	);	×
78	} else {
79	new Error("'{$object}' is not a known Post_type or Taxonomy. Unable to rename.");	×
80	}
81	}
82	}

ideasonpurpose / wp-data-model / #16

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous