TheSportsDb\Entity\EntityInterface

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
	update()	0	1	?
	raw()	0	1	?
	getEntityType()	0	1	?
	getPropertyMapDefinition()	0	1	?

<?php
/**
 * @file
 * Contains \TheSportsDb\Entity\EntityInterface.
 */

namespace TheSportsDb\Entity;

/**
 * Interface for entities.
 *
 * @author Jelle Sebreghts
 */
interface EntityInterface {

  /**
   * Creates a new entity.
   *
   * @param \stdClass $values
   *   The values to create this entity with.
   */
  public function __construct(\stdClass $values);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

  /**
   * Updates the entity.
   *
   * @param \stdClass $values
   *   The values to update the entity with
   *
   * @return void
   */
  public function update(\stdClass $values);

  /**
   * Get this entity as a raw (\stdClass) object.
   *
   * @return \stdClass
   *   The raw entity values.
   */
  public function raw();

  /**
   * Gets the entity type of this entity class.
   *
   * @return string
   *   The entity type of this entity class.
   */
  public static function getEntityType();

  /**
   * Gets the property map for this entity class.
   *
   * @return array
   *   The property map definition.
   */
  public static function getPropertyMapDefinition();
}