class PartyHat in Party 7

The class used for hat entities.

Hierarchy

• class \Entity implements EntityInterface
  • class \PartyHat

1 string reference to 'PartyHat'

party_hat_entity_info in modules/party_hat/party_hat.module

Implements hook_entity_info().

File

modules/party_hat/includes/party_hat.entity.inc, line 17

Contains the controller classes for Party entities.

class PartyHat extends Entity {

  /**
   * The internal numeric id of the hat.
   *
   * @var integer
   */
  public $hid;

  /**
   * The machine name of a hat.
   *
   * @var string
   */
  public $name;

  /**
   * The machine name of this hat's parent.
   *
   * @var string
   */
  public $parent;

  /**
   * The label of the hat.
   *
   * @var string
   */
  public $label;

  /**
   * The description for the hat.
   *
   * @var string
   */
  public $description;

  /**
   * A serialized array of hat settings.
   *
   * This array contains:
   *   - dat_sets: An array settings keyed by data set name.
   *     - has: Whether or not this data set is allowed.
   *     - multiple: Whether or not this data set is allowed multiple.
   *
   * @var string
   */
  public $data;

  /**
   * Whether this hat is required by all parties.
   *
   * @var integer
   */
  public $required;

  /**
   * The exportable status of the entity.
   *
   * @var integer
   */
  public $status;

  /**
   * The name of the providing module if the entity has been defined in code.
   *
   * @var string
   */
  public $module;

  /**
   * Constructor for a PartyHat.
   *
   * @see Entity::__construct()
   */
  public function __construct($values = array()) {
    parent::__construct($values, 'party_hat');
  }

  /**
   * Return the label of the hat.
   */
  protected function defaultLabel() {
    return $this->label;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
PartyHat::$data	public	property	A serialized array of hat settings.
PartyHat::$description	public	property	The description for the hat.
PartyHat::$hid	public	property	The internal numeric id of the hat.
PartyHat::$label	public	property	The label of the hat.
PartyHat::$module	public	property	The name of the providing module if the entity has been defined in code.
PartyHat::$name	public	property	The machine name of a hat.
PartyHat::$parent	public	property	The machine name of this hat's parent.
PartyHat::$required	public	property	Whether this hat is required by all parties.
PartyHat::$status	public	property	The exportable status of the entity.
PartyHat::defaultLabel	protected	function	Return the label of the hat. Overrides Entity::defaultLabel
PartyHat::__construct	public	function	Constructor for a PartyHat. Overrides Entity::__construct