class EntityQueue in Entityqueue 7

Base class for entity queues.

Hierarchy

• class \EntityQueue

1 string reference to 'EntityQueue'

entityqueue_schema in ./entityqueue.install

Implements hook_schema().

File

includes/entityqueue_queue.class.inc, line 11

Defines the base class for entity queues.

class EntityQueue {

  /**
   * @var string $name
   */
  public $name = '';

  /**
   * @var string $label
   */
  public $label = '';

  /**
   * @var string $language
   */
  public $language = '';

  /**
   * @var string $handler
   */
  public $handler = '';

  /**
   * @var string $target_type
   */
  public $target_type = 'node';

  /**
   * @var array $settings
   */
  public $settings = array(
    'target_bundles' => array(),
    'min_size' => 0,
    'max_size' => 0,
    'subqueue_label' => '',
  );

  /**
   * @var int $export_type
   */
  public $export_type = '';

  /**
   * @var bool $is_new
   */
  public $is_new = FALSE;

  /**
   * Constructs a new EntityQueue object, without saving it to the database.
   *
   * @param array $values
   */
  public function __construct($values = array()) {
    $values = (array) $values;

    // Set initial values.
    foreach ($values as $key => $value) {
      $this->{$key} = $value;
    }
  }

  /**
   * Returns the label of this queue.
   *
   * @return string
   */
  public function label() {
    return $this->label;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityQueue::$export_type	public	property
EntityQueue::$handler	public	property
EntityQueue::$is_new	public	property
EntityQueue::$label	public	property
EntityQueue::$language	public	property
EntityQueue::$name	public	property
EntityQueue::$settings	public	property
EntityQueue::$target_type	public	property
EntityQueue::label	public	function	Returns the label of this queue.
EntityQueue::__construct	public	function	Constructs a new EntityQueue object, without saving it to the database.