WordPoints_Entity_Context

Complexity

Total Complexity

3

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	get_slug()	0	3	1
A	get_parent_slug()	0	3	1
	get_current_id()	0	1	?

<?php

/**
 * Entity context base class.
 *
 * @package wordpoints-hooks-api
 * @since   1.0.0
 */

/**
 * Bootstrap for representing an entity context.
 *
 * The entity API makes it possible to encapsulate different sorts of things (like
 * posts and users) so that their data can be accessed through a common set of
 * interfaces. Each entity has an ID—a single piece of data (like an integer or
 * string) that can be used to identify that entity. The ID is unique to that entity,
 * but it is not *globally unique*. That is, it is unique to that entity only within
 * a particular scope or "context". For example, on multisite a post's ID is unique
 * only in the context of the site on which that post was published. That same ID
 * would refer to a different post on each other site on the network. The job of the
 * context API is to encapsulate the different sorts of contexts in which entities
 * can exist. This allows us to, for example, create globally unique IDs (GUIDs) for
 * entities, so that they can be identified specifically even outside of their usual
 * context.
 *
 * @since 1.0.0
 */
abstract class WordPoints_Entity_Context {

	/**
	 * The slug of this context.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $slug;

	/**
	 * The slug of the parent of this context, if this is a sub-context.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $parent_slug;

	/**
	 * @since 1.0.0
	 *
	 * @param string $slug The slug of this context.
	 */
	public function __construct( $slug ) {
		$this->slug = $slug;
	}

	/**
	 * Get the slug of this context.
	 *
	 * @since 1.0.0
	 *
	 * @return string
	 */
	public function get_slug() {
		return $this->slug;
	}

	/**
	 * Get the slug of the parent of this context, if it is a sub-context.
	 *
	 * Most contexts are really children of other contexts. For example, the 'site'
	 * context is a child of the 'network' context, since sites can only exist within
	 * a network.
	 *
	 * @since 1.0.0
	 *
	 * @return string|null The slug of the parent context, or null if none.
	 */
	public function get_parent_slug() {
		return $this->parent_slug;
	}

	/**
	 * Get the current ID of this context.
	 *
	 * @since 1.0.0
	 *
	 * @return int|string|false The ID or slug of the context, or false if not
	 *                          currently in this context.
	 */
	abstract public function get_current_id();
}

// EOF