Merge pull request #11 from sebbmeyer/feature/custom-card

Adding custom card

Author: sebbmeyer

README.md

@@ -26,7 +26,20 @@ $connector->send($card);
 
 ### Custom card
 
-You can create your own cards for every purpose you need, just extend the **AbstractCard** class and implement the `getMessage()` function. This is an example of a [Laravel Forge deployment card](https://github.com/sebbmeyer/laravel-teams-connector)
+You can use the provided **CustomCard** class and add a color, facts, images, an activity, actions or a summary to it.
+
+```php
+// create a custom card
+$card  = new \Sebbmyr\Teams\Cards\CustomCard('Package update', 'A custom card class was added to the package.');
+// add information
+$card->setColor('01BC36')
+    ->addFactsText('Supported PHP versions',['<= 5.4.0','7.x'])
+    ->addFactsText('Unsupported PHP versions',['Before Version 5.4'])
+    ->addAction('Visit Github repository','https://github.com/sebbmeyer/php-microsoft-teams-connector')
+    ->addFacts('Facts Section',['Fact Name 1' => 'Fact Value 1','Fact Name 2' => 'Fact Value 2']);
+```
+
+Or you can create your own cards for every purpose you need, just extend the **AbstractCard** class and implement the `getMessage()` function. This is an example of a [Laravel Forge deployment card](https://github.com/sebbmeyer/laravel-teams-connector)
 
 ```php
 \\ Sebbmyr\LaravelTeams\Cards\ForgeCard.php

src/Cards/CustomCard.php

@@ -0,0 +1,261 @@
+<?php
+
+namespace Sebbmyr\Teams\Cards;
+
+use Sebbmyr\Teams\TeamsConnectorInterface;
+
+/**
+ * Sebbmyr\Teams\Cards\CustomCard
+ */
+class CustomCard implements TeamsConnectorInterface
+{
+    /**
+     * Theme color
+     * @var string
+     */
+    private $color;
+
+    /**
+     * Summary
+     * @var string
+     */
+    private $summary;
+
+    /**
+     * Title
+     * @var string
+     */
+    private $title;
+
+    /**
+     * Generic text
+     * @var string
+     */
+    private $text;
+
+    /**
+     * Action Buttons
+     * @var array
+     */
+    private $potentialAction;
+
+    /**
+     * Sections
+     * @var array
+     */
+    private $sections;
+
+    /**
+     * CustomCard constructor.
+     * @param null $title
+     * @param null $text
+     */
+    public function __construct($title = null, $text = null)
+    {
+        $this->title = $title ?: '';
+        $this->text = $text ?: '';
+    }
+
+    /**
+     * Formats data for API call
+     */
+    public function getMessage()
+    {
+        $message = [
+            "@type" => "MessageCard",
+            "@context" => "http://schema.org/extensions",
+        ];
+        if (isset($this->summary)) {
+            $message['summary'] = $this->summary;
+        }
+        if (isset($this->title)) {
+            $message['title'] = $this->title;
+        }
+        if (isset($this->text)) {
+            $message['text'] = $this->text;
+        }
+        if (isset($this->color)) {
+            $message['themeColor'] = $this->color;
+        }
+
+        if (isset($this->sections)) {
+            $message['sections'] = $this->sections;
+        }
+        if (isset($this->potentialAction)) {
+            $message['potentialAction'] = $this->potentialAction;
+        }
+
+        return $message;
+    }
+
+    /**
+     * Sets Card Title
+     * 
+     * @param string $title
+     * @return CustomCard
+     */
+    public function setTitle(string $title)
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Sets Card Text
+     * 
+     * @param string $text
+     * @return CustomCard
+     */
+    public function setText(string $text)
+    {
+        $this->text = $text;
+
+        return $this;
+    }
+
+    /**
+     * Sets Card Summary
+     * 
+     * @param string $summary
+     * @return CustomCard
+     */
+    public function setSummary(string $summary)
+    {
+        $this->summary = $summary;
+
+        return $this;
+    }
+
+    /**
+     * Sets Card Color
+     * 
+     * @param string $color
+     * @return CustomCard
+     */
+    public function setColor(string $color)
+    {
+        $this->color = $color;
+
+        return $this;
+    }
+
+    /**
+     * Adds activity section to card
+     * 
+     * @param string $text
+     * @param string|null $title
+     * @param string|null $image
+     * @return CustomCard
+     */
+    public function addActivity(string $text, string $title = null, string $image = null)
+    {
+        $activity = ['activityTitle' => $title];
+        if ($text !== null) {
+            $activity['activityText'] = $text;
+        }
+        if ($image !== null) {
+            $activity['activityImage'] = $image;
+        }
+        $this->sections[] = $activity;
+
+        return $this;
+    }
+
+    /**
+     * Adds text section to card
+     * 
+     * @param string $title
+     * @param array|null $array
+     * @return CustomCard
+     */
+    public function addFactsText(string $title, array $array = null)
+    {
+        $section = ['title' => $title];
+        if (!is_null($array)) {
+            $facts = [];
+            foreach ($array as $arr) {
+                $facts[] = ['name' => $arr];
+            }
+            $section['facts'] = $facts;
+        }
+        $this->sections[] = $section;
+
+        return $this;
+    }
+
+
+    /**
+     * Adds facts section to card
+     * 
+     * @param string $title
+     * @param array $array
+     * @return CustomCard
+     */
+    public function addFacts(string $title, array $array)
+    {
+        $section = ['title' => $title];
+        $facts = [];
+        foreach ($array as $name => $value) {
+            $facts[] = ['name' => $name, 'value' => $value];
+        }
+        $section['facts'] = $facts;
+        $this->sections[] = $section;
+
+        return $this;
+    }
+
+
+    /**
+     * Adds single image to card
+     * 
+     * @param string $title
+     * @param string $image
+     * @return CustomCard
+     */
+    public function addImage(string $title, string $image)
+    {
+        $this->addImages($title, [$image]);
+
+        return $this;
+    }
+
+    /**
+     * Adds images to card
+     * 
+     * @param string $title
+     * @param array $images
+     * @return CustomCard
+     */
+    public function addImages(string $title, array $images)
+    {
+        $section = ['title' => $title];
+        $sectionImages = [];
+        foreach ($images as $image) {
+            $sectionImages[] = ['image' => $image];
+        }
+        $section['images'] = $sectionImages;
+        $this->sections[] = $section;
+
+        return $this;
+    }
+
+    /**
+     * Adds action button to card
+     * 
+     * @param string $text
+     * @param string $url
+     * @return CustomCard
+     */
+    public function addAction(string $text, string $url)
+    {
+        $this->potentialAction[] = [
+            '@context' => 'http://schema.org',
+            '@type' => 'ViewAction',
+            'name' => $text,
+            'target' => [$url],
+        ];
+
+        return $this;
+    }
+}