class Bean in Bean (for Drupal 7) 7

The Bean entity class

Hierarchy

class \Entity implements EntityInterface
- class \Bean

Expanded class hierarchy of Bean

4 string references to 'Bean'

BeanTestPlugins::getInfo in tests/BeanTestPlugins.test: Define this test.
BeanTests::getInfo in tests/BeanTests.test: Define this test.
BeanUnitTests::getInfo in tests/BeanUnitTests.test: Define this test.
bean_entity_info in ./bean.module: Implements hook_entity_info().

File

includes/bean.core.inc, line 144: Bean classes and plugin interface

View source

class Bean extends Entity {
  public $label;
  public $description;
  public $title;
  public $type;
  public $data;
  public $delta;
  public $view_mode;
  public $bid;
  public $vid;
  public $created;
  public $changed;
  public $log;
  public $uid;
  public $default_revision;
  public $revisions = array();
  protected $plugin;

  /**
   * Get Plugin info
   *
   * @param $key
   *  The plugin key to get the info for.
   *
   * @return array|null
   */
  public function getInfo($key = NULL) {
    if ($this->plugin instanceof BeanTypePluginInterface) {
      return $this->plugin
        ->getInfo($key);
    }
    return NULL;
  }
  public function __construct(array $values = array()) {

    // If this is new then set the type first.
    if (isset($values['is_new'])) {
      $this->type = isset($values['type']) ? $values['type'] : '';
    }
    parent::__construct($values, 'bean');
  }
  public function adminTitle() {
    return filter_xss_admin($this->label);
  }
  protected function setUp() {
    parent::setUp();
    if (!empty($this->type)) {
      $plugin = bean_load_plugin_class($this->type);
      $this
        ->loadUp($plugin);
    }
    return $this;
  }

  /**
   * This is a work around for version of PDO that call __construct() before
   * it loads up the object with values from the DB.
   */
  public function loadUp($plugin) {
    if (empty($this->plugin)) {

      // If the plugin has been disabled, the $plugin will be a boolean.
      // just load the base plugin so something will render.
      if (!$plugin instanceof BeanTypePluginInterface) {
        $plugin = bean_load_plugin_class('bean_default');
      }
      $this
        ->setPlugin($plugin)
        ->setFields();
    }
    return $this;
  }

  /**
   * Load and set the plugin info.
   * This can be called externally via loadUP()
   */
  protected function setPlugin($plugin) {
    $this->plugin = $plugin;
    return $this;
  }

  /**
   * Set the fields from the defaults and plugin
   * This can be called externally via loadUP()
   */
  protected function setFields() {

    // NOTE: When setFields is called externally $this->data is already unserialized.
    if (!empty($this->plugin) && !empty($this->type)) {
      $values = is_array($this->data) ? $this->data : unserialize($this->data);
      foreach ($this->plugin
        ->values() as $field => $default) {
        $this->{$field} = isset($values[$field]) ? $values[$field] : $default;
      }
    }
    return $this;
  }

  /**
   * Override this in order to implement a custom default URI and specify
   * 'entity_class_uri' as 'uri callback' hook_entity_info().
   */
  protected function defaultUri() {
    return array(
      'path' => 'block/' . strtolower($this
        ->identifier()),
    );
  }

  /**
   * Get the default label
   *
   * @return string
   */
  protected function defaultLabel() {
    if (empty($this->title)) {
      return $this->label;
    }
    return $this->title;
  }

  /**
   * Set the revision as default
   *
   * @return Bean
   */
  public function setDefault() {
    $this->default_revision = TRUE;
    return $this;
  }

  /**
   * Get the plugin form
   */
  public function getForm($form, &$form_state) {
    return $this->plugin
      ->form($this, $form, $form_state);
  }

  /**
   * Validate the plugin form
   */
  public function validate($values, &$form_state) {
    $this->plugin
      ->validate($values, $form_state);
  }

  /**
   * URL string
   */
  public function url() {
    $uri = $this
      ->defaultUri();
    return $uri['path'];
  }

  /**
   * Build the URL string
   */
  protected function buildURL($type) {
    $url = $this
      ->url();
    return $url . '/' . $type;
  }

  /**
   * View URL
   */
  public function viewURL() {
    return $this
      ->buildURL('view');
  }

  /**
   * View URL
   */
  public function editURL() {
    return $this
      ->buildURL('edit');
  }

  /**
   * View URL
   */
  public function deleteURL() {
    return $this
      ->buildURL('delete');
  }

  /**
   * Type name
   */
  public function typeName() {
    return $this
      ->getInfo('label');
  }

  /**
   * Set the values from a plugin
   */
  public function setValues($values) {
    $this->data = array();
    foreach ($this->plugin
      ->values() as $field => $value) {
      $this->data[$field] = $values[$field];
    }
    return $this;
  }

  /**
   * Generate an array for rendering the entity.
   *
   * @see entity_view()
   */
  public function view($view_mode = 'default', $langcode = NULL, $page = NULL) {
    $content = parent::view($view_mode, $langcode);
    if (empty($this->plugin)) {
      return $content;
    }
    return $this->plugin
      ->view($this, $content, $view_mode, $langcode);
  }

  /**
   * Override the save to add clearing of caches
   */
  public function save() {
    $this
      ->setUid()
      ->checkDelta();
    if (empty($this->created)) {
      $this->created = REQUEST_TIME;
    }
    $this->changed = REQUEST_TIME;
    $this->plugin
      ->submit($this);
    $return = parent::save();
    bean_reset(TRUE, TRUE);
    if (module_exists('block')) {
      bean_cache_clear_block($this);
    }
    return $return;
  }

  /**
   * Get the user
   */
  protected function setUid() {
    global $user;
    $this->uid = empty($this->uid) ? $user->uid : $this->uid;
    return $this;
  }

  /**
   * Set the delta function
   */
  protected function checkDelta() {
    if (empty($this->delta)) {
      $max_length = 32;

      // Base it on the label and make sure it isn't too long for the database.
      if (module_exists('transliteration')) {
        $delta = drupal_clean_css_identifier(strtolower(transliteration_get($this->label)));
      }
      else {
        $delta = drupal_clean_css_identifier(strtolower($this->label));
      }

      // Add 'bean-' prefix when it's need to avoid a purely numeric delta.
      if (is_numeric($delta)) {
        $delta = 'bean-' . $delta;
      }
      $this->delta = substr($delta, 0, $max_length);

      // Check if delta is unique.
      if ($this
        ->deltaExists($this->delta)) {
        $i = 0;
        $separator = '-';
        $original_delta = $this->delta;
        do {
          $unique_suffix = $separator . $i++;
          $this->delta = substr($original_delta, 0, $max_length - drupal_strlen($unique_suffix)) . $unique_suffix;
        } while ($this
          ->deltaExists($this->delta));
      }
    }
    return $this;
  }

  /**
   * Check against the Database if a specific delta exists.
   */
  protected function deltaExists($delta) {
    return db_select('bean', 'b')
      ->fields('b', array(
      'bid',
    ))
      ->condition('delta', $delta)
      ->execute()
      ->fetchField();
  }

  /**
   * Load the revisions from the DB
   */
  public function loadRevisions() {
    $this->revisions = db_select('bean_revision', 'br')
      ->condition('delta', $this
      ->identifier())
      ->fields('br')
      ->execute();
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Bean::$bid	public	property
Bean::$changed	public	property
Bean::$created	public	property
Bean::$data	public	property
Bean::$default_revision	public	property
Bean::$delta	public	property
Bean::$description	public	property
Bean::$label	public	property
Bean::$log	public	property
Bean::$plugin	protected	property
Bean::$revisions	public	property
Bean::$title	public	property
Bean::$type	public	property
Bean::$uid	public	property
Bean::$vid	public	property
Bean::$view_mode	public	property
Bean::adminTitle	public	function
Bean::buildURL	protected	function	Build the URL string
Bean::checkDelta	protected	function	Set the delta function
Bean::defaultLabel	protected	function	Get the default label Overrides Entity::defaultLabel
Bean::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info(). Overrides Entity::defaultUri
Bean::deleteURL	public	function	View URL
Bean::deltaExists	protected	function	Check against the Database if a specific delta exists.
Bean::editURL	public	function	View URL
Bean::getForm	public	function	Get the plugin form
Bean::getInfo	public	function	Get Plugin info
Bean::loadRevisions	public	function	Load the revisions from the DB
Bean::loadUp	public	function	This is a work around for version of PDO that call __construct() before it loads up the object with values from the DB.
Bean::save	public	function	Override the save to add clearing of caches Overrides Entity::save
Bean::setDefault	public	function	Set the revision as default
Bean::setFields	protected	function	Set the fields from the defaults and plugin This can be called externally via loadUP()
Bean::setPlugin	protected	function	Load and set the plugin info. This can be called externally via loadUP()
Bean::setUid	protected	function	Get the user
Bean::setUp	protected	function	Set up the object instance on construction or unserializiation. Overrides Entity::setUp
Bean::setValues	public	function	Set the values from a plugin
Bean::typeName	public	function	Type name
Bean::url	public	function	URL string
Bean::validate	public	function	Validate the plugin form
Bean::view	public	function	Generate an array for rendering the entity. Overrides Entity::view
Bean::viewURL	public	function	View URL
Bean::__construct	public	function	Overrides Entity::__construct
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::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::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
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.

You are here

class Bean in Bean (for Drupal 7) 7

Hierarchy

File

Members

API Navigation