current code from svn, revision 62608

1 files changed, 194 insertions, 0 deletions

diff --git a/lib/models/Courseware/Block.php b/lib/models/Courseware/Block.php
new file mode 100755
index 0000000..57471fc
--- /dev/null
+++ b/lib/models/Courseware/Block.php
@@ -0,0 +1,194 @@
+<?php
+
+namespace Courseware;
+
+use User;
+
+/**
+ * Courseware's blocks.
+ *
+ * @author  Marcus Eibrink-Lunzenauer <lunzenauer@elan-ev.de>
+ * @author  Till Glöggler <gloeggler@elan-ev.de>
+ * @author  Ron Lucke <lucke@elan-ev.de>
+ * @license GPL2 or any later version
+ *
+ * @since   Stud.IP 5.0
+ *
+ * @property int                              $id              database column
+ * @property int                              $container_id    database column
+ * @property string                           $owner_id        database column
+ * @property string                           $editor_id       database column
+ * @property string                           $edit_blocker_id database column
+ * @property int                              $position        database column
+ * @property string                           $block_type      database column
+ * @property int                              $visible         database column
+ * @property string                           $payload         database column
+ * @property int                              $mkdate          database column
+ * @property int                              $chdate          database column
+ * @property \Courseware\BlockTypes\BlockType $type            computed column read/write
+ * @property string                           $files           computed column
+ * @property \SimpleORMapCollection           $data_fields     has_many Courseware\UserDataField
+ * @property \SimpleORMapCollection           $comments        has_many Courseware\BlockComment
+ * @property \SimpleORMapCollection           $block_feedback  has_many Courseware\BlockFeedback
+ * @property \SimpleORMapCollection           $progresses      has_many Courseware\UserProgress
+ * @property \User                            $owner           belongs_to User
+ * @property \User                            $editor          belongs_to User
+ * @property \User                            $edit_blocker    belongs_to User
+ * @property \Courseware\Container            $container       belongs_to Courseware\Container
+ */
+class Block extends \SimpleORMap
+{
+    protected static function configure($config = [])
+    {
+        $config['db_table'] = 'cw_blocks';
+
+        $config['belongs_to']['owner'] = [
+            'class_name' => User::class,
+            'foreign_key' => 'owner_id',
+        ];
+
+        $config['belongs_to']['editor'] = [
+            'class_name' => User::class,
+            'foreign_key' => 'editor_id',
+        ];
+
+        $config['belongs_to']['edit_blocker'] = [
+            'class_name' => User::class,
+            'foreign_key' => 'edit_blocker_id',
+        ];
+
+        $config['belongs_to']['container'] = [
+            'class_name' => Container::class,
+            'foreign_key' => 'container_id',
+        ];
+
+        $config['has_many']['data_fields'] = [
+            'class_name' => UserDataField::class,
+            'assoc_foreign_key' => 'block_id',
+            'on_delete' => 'delete',
+            'on_store' => 'store',
+            'order_by' => 'ORDER BY chdate',
+        ];
+
+        $config['has_many']['comments'] = [
+            'class_name' => BlockComment::class,
+            'assoc_foreign_key' => 'block_id',
+            'on_delete' => 'delete',
+            'on_store' => 'store',
+            'order_by' => 'ORDER BY chdate',
+        ];
+
+        $config['has_many']['block_feedback'] = [
+            'class_name' => BlockFeedback::class,
+            'assoc_foreign_key' => 'block_id',
+            'on_delete' => 'delete',
+            'on_store' => 'store',
+            'order_by' => 'ORDER BY chdate',
+        ];
+
+        $config['has_many']['progresses'] = [
+            'class_name' => UserProgress::class,
+            'assoc_foreign_key' => 'block_id',
+            'on_delete' => 'delete',
+            'on_store' => 'store',
+            'order_by' => 'ORDER BY chdate',
+        ];
+
+        $config['additional_fields']['type'] = [
+            'get' => function ($block) {
+                return BlockTypes\BlockType::factory($block);
+            },
+            'set' => false,
+        ];
+
+        $config['additional_fields']['files'] = [
+            'get' => function ($block) {
+                return array_filter($block->type->getFiles(), function ($file_ref) {
+                    $file = $file_ref->getFileType();
+                    return $file->isDownloadable();
+                });
+            },
+        ];
+
+        parent::configure($config);
+    }
+
+    /**
+     * Returns whether this block is blocked from editing.
+     */
+    public function isBlocked(): bool
+    {
+        return null != $this->edit_blocker;
+    }
+
+    /**
+     * Returns who is blocking this block from editing if at all.
+     *
+     * @return ?string either the blocker's ID or null if this block is not blocked
+     */
+    public function getBlockerUserId(): ?string
+    {
+        if ($this->isBlocked()) {
+            return $this->edit_blocker->id;
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Activates the edit block for a user.
+     *
+     * @param string $userId the ID of the user blocking this block
+     */
+    public function setBlockerId(string $userId): void
+    {
+        $this->edit_blocker_id = $userId;
+    }
+
+    /**
+     * Returns the full name of the user currently blocking this block.
+     *
+     * @return string the full name of the user currently blocking this block
+     */
+    public function getBlockerName(): string
+    {
+        /** @var \User $user */
+        $user = User::find($this->edit_blocker_id);
+
+        return $user->getFullName();
+    }
+
+    /**
+     * Copies this block into another container such that the given user is the owner of the copy.
+     *
+     * @param User      $user      the owner and editor of the new copy of this block
+     * @param Container $container the container this block will be copied into
+     *
+     * @return Block the copy of this block
+     */
+    public function copy(User $user, Container $container): Block
+    {
+        /** @var StructuralElement $struct */
+        $struct = StructuralElement::find($container->structural_element_id);
+        $rangeId = $struct->getRangeId();
+
+        $block = self::build([
+            'container_id' => $container->id,
+            'owner_id' => $user->id,
+            'editor_id' => $user->id,
+            'edit_blocker_id' => null,
+            'position' => $container->countBlocks(),
+            'block_type' => $this->type->getType(),
+            'payload' => json_encode($this->type->copyPayload($rangeId)),
+            'visible' => 1,
+        ]);
+
+        $block->store();
+
+        //update Container payload
+        $container->type->addBlock($block);
+        $container->store();
+
+        return $block;
+    }
+}