Issue #1495024 by aspilicious: documentation follow-up for convert the entity system to PSR-0.

8.0.x
catch 2012-05-17 11:33:40 +09:00
parent c176370239
commit 25713f0b25
6 changed files with 30 additions and 30 deletions

View File

@ -78,14 +78,14 @@ class Comment extends Entity {
public $homepage; public $homepage;
/** /**
* Implements EntityInterface::id(). * Implements Drupal\entity\EntityInterface::id().
*/ */
public function id() { public function id() {
return $this->cid; return $this->cid;
} }
/** /**
* Implements EntityInterface::bundle(). * Implements Drupal\entity\EntityInterface::bundle().
*/ */
public function bundle() { public function bundle() {
return $this->node_type; return $this->node_type;

View File

@ -13,13 +13,13 @@ use Drupal\entity\EntityDatabaseStorageController;
/** /**
* Defines the controller class for comments. * Defines the controller class for comments.
* *
* This extends the EntityDatabaseStorageController class, adding required * This extends the Drupal\entity\EntityDatabaseStorageController class, adding
* special handling for comment entities. * required special handling for comment entities.
*/ */
class CommentStorageController extends EntityDatabaseStorageController { class CommentStorageController extends EntityDatabaseStorageController {
/** /**
* Overrides EntityDatabaseStorageController::buildQuery(). * Overrides Drupal\entity\EntityDatabaseStorageController::buildQuery().
*/ */
protected function buildQuery($ids, $conditions = array(), $revision_id = FALSE) { protected function buildQuery($ids, $conditions = array(), $revision_id = FALSE) {
$query = parent::buildQuery($ids, $conditions, $revision_id); $query = parent::buildQuery($ids, $conditions, $revision_id);
@ -33,7 +33,7 @@ class CommentStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::attachLoad(). * Overrides Drupal\entity\EntityDatabaseStorageController::attachLoad().
*/ */
protected function attachLoad(&$comments, $revision_id = FALSE) { protected function attachLoad(&$comments, $revision_id = FALSE) {
// Set up standard comment properties. // Set up standard comment properties.
@ -47,7 +47,7 @@ class CommentStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::preSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::preSave().
* *
* @see comment_int_to_alphadecimal() * @see comment_int_to_alphadecimal()
* @see comment_increment_alphadecimal() * @see comment_increment_alphadecimal()
@ -129,7 +129,7 @@ class CommentStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::postSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::postSave().
*/ */
protected function postSave(EntityInterface $comment, $update) { protected function postSave(EntityInterface $comment, $update) {
// Update the {node_comment_statistics} table prior to executing the hook. // Update the {node_comment_statistics} table prior to executing the hook.
@ -140,7 +140,7 @@ class CommentStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::postDelete(). * Overrides Drupal\entity\EntityDatabaseStorageController::postDelete().
*/ */
protected function postDelete($comments) { protected function postDelete($comments) {
// Delete the comments' replies. // Delete the comments' replies.

View File

@ -145,21 +145,21 @@ class Node extends Entity {
public $revision_uid; public $revision_uid;
/** /**
* Implements EntityInterface::id(). * Implements Drupal\entity\EntityInterface::id().
*/ */
public function id() { public function id() {
return $this->nid; return $this->nid;
} }
/** /**
* Implements EntityInterface::bundle(). * Implements Drupal\entity\EntityInterface::bundle().
*/ */
public function bundle() { public function bundle() {
return $this->type; return $this->type;
} }
/** /**
* Overrides Entity::createDuplicate(). * Overrides Drupal\entity\Entity::createDuplicate().
*/ */
public function createDuplicate() { public function createDuplicate() {
$duplicate = clone $this; $duplicate = clone $this;

View File

@ -15,13 +15,13 @@ use Exception;
/** /**
* Controller class for nodes. * Controller class for nodes.
* *
* This extends the EntityDatabaseStorageController class, adding required * This extends the Drupal\entity\EntityDatabaseStorageController class, adding
* special handling for node entities. * required special handling for node entities.
*/ */
class NodeStorageController extends EntityDatabaseStorageController { class NodeStorageController extends EntityDatabaseStorageController {
/** /**
* Overrides EntityDatabaseStorageController::create(). * Overrides Drupal\entity\EntityDatabaseStorageController::create().
*/ */
public function create(array $values) { public function create(array $values) {
$node = parent::create($values); $node = parent::create($values);
@ -35,7 +35,7 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::delete(). * Overrides Drupal\entity\EntityDatabaseStorageController::delete().
*/ */
public function delete($ids) { public function delete($ids) {
$entities = $ids ? $this->load($ids) : FALSE; $entities = $ids ? $this->load($ids) : FALSE;
@ -80,7 +80,7 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::save(). * Overrides Drupal\entity\EntityDatabaseStorageController::save().
*/ */
public function save(EntityInterface $entity) { public function save(EntityInterface $entity) {
$transaction = db_transaction(); $transaction = db_transaction();
@ -192,7 +192,7 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::invokeHook(). * Overrides Drupal\entity\EntityDatabaseStorageController::invokeHook().
*/ */
protected function invokeHook($hook, EntityInterface $node) { protected function invokeHook($hook, EntityInterface $node) {
if ($hook == 'insert' || $hook == 'update') { if ($hook == 'insert' || $hook == 'update') {
@ -241,7 +241,7 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::preSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::preSave().
*/ */
protected function preSave(EntityInterface $node) { protected function preSave(EntityInterface $node) {
// Before saving the node, set changed and revision times. // Before saving the node, set changed and revision times.
@ -257,14 +257,14 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::postSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::postSave().
*/ */
function postSave(EntityInterface $node, $update) { function postSave(EntityInterface $node, $update) {
node_access_acquire_grants($node, $update); node_access_acquire_grants($node, $update);
} }
/** /**
* Overrides EntityDatabaseStorageController::preDelete(). * Overrides Drupal\entity\EntityDatabaseStorageController::preDelete().
*/ */
function preDelete($entities) { function preDelete($entities) {
if (module_exists('search')) { if (module_exists('search')) {
@ -275,7 +275,7 @@ class NodeStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::postDelete(). * Overrides Drupal\entity\EntityDatabaseStorageController::postDelete().
*/ */
protected function postDelete($nodes) { protected function postDelete($nodes) {
// Delete values from other tables also referencing this node. // Delete values from other tables also referencing this node.

View File

@ -136,7 +136,7 @@ class User extends Entity {
public $roles = array(); public $roles = array();
/** /**
* Implements EntityInterface::id(). * Implements Drupal\entity\EntityInterface::id().
*/ */
public function id() { public function id() {
return $this->uid; return $this->uid;

View File

@ -14,13 +14,13 @@ use Drupal\entity\EntityDatabaseStorageController;
/** /**
* Controller class for users. * Controller class for users.
* *
* This extends the EntityDatabaseStorageController class, adding required * This extends the Drupal\entity\EntityDatabaseStorageController class, adding
* special handling for user objects. * required special handling for user objects.
*/ */
class UserStorageController extends EntityDatabaseStorageController { class UserStorageController extends EntityDatabaseStorageController {
/** /**
* Overrides EntityDatabaseStorageController::attachLoad(). * Overrides Drupal\entity\EntityDatabaseStorageController::attachLoad().
*/ */
function attachLoad(&$queried_users, $revision_id = FALSE) { function attachLoad(&$queried_users, $revision_id = FALSE) {
// Build an array of user picture IDs so that these can be fetched later. // Build an array of user picture IDs so that these can be fetched later.
@ -60,7 +60,7 @@ class UserStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::create(). * Overrides Drupal\entity\EntityDatabaseStorageController::create().
*/ */
public function create(array $values) { public function create(array $values) {
if (!isset($values['created'])) { if (!isset($values['created'])) {
@ -73,7 +73,7 @@ class UserStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::save(). * Overrides Drupal\entity\EntityDatabaseStorageController::save().
*/ */
public function save(EntityInterface $entity) { public function save(EntityInterface $entity) {
if (empty($entity->uid)) { if (empty($entity->uid)) {
@ -84,7 +84,7 @@ class UserStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::preSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::preSave().
*/ */
protected function preSave(EntityInterface $entity) { protected function preSave(EntityInterface $entity) {
// Update the user password if it has changed. // Update the user password if it has changed.
@ -159,7 +159,7 @@ class UserStorageController extends EntityDatabaseStorageController {
} }
/** /**
* Overrides EntityDatabaseStorageController::postSave(). * Overrides Drupal\entity\EntityDatabaseStorageController::postSave().
*/ */
protected function postSave(EntityInterface $entity, $update) { protected function postSave(EntityInterface $entity, $update) {