class PartyHat in Party 8.2

The class used for hat entities.

Hierarchy

• class \Entity
  • 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
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.
PartyHat::__construct	public	function	Constructor for a PartyHat.