ILIAS\Blog\Posting\PostingList Class Reference

Collaboration diagram for ILIAS\Blog\Posting\PostingList:

Public Member Functions
	__construct (protected int $obj_id, protected PostingManager $posting_manager, protected \ILIAS\Blog\Settings\Settings $settings, protected PageManagerInterface $page_manager, protected bool $include_inactive=true)
	getPostingsForView (int $author_id=0, string $keyword="", string $month="")
	getByMonth (string $month)
	getByAuthor (int $author_id)
	getByKeyword (string $keyword)
	getPostingsGroupedByMonth ()
	prepareViewState (string $month, ?int $author)
	getMonthsWithPostings ()
	getAuthors ()
	hasAuthorPostings (int $user_id)

Protected Member Functions
	getPostings ()

Protected Attributes
array	$postings = null

Detailed Description

Definition at line 25 of file PostingList.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Blog\Posting\PostingList::__construct	(	protected int	$obj_id,
		protected PostingManager	$posting_manager,
		protected \ILIAS\Blog\Settings\Settings	$settings,
		protected PageManagerInterface	$page_manager,
		protected bool	$include_inactive = true
	)

Definition at line 30 of file PostingList.php.

      {
    }

Member Function Documentation

getAuthors()

ILIAS\Blog\Posting\PostingList::getAuthors

(

)

Returns

int[] user ids

Definition at line 189 of file PostingList.php.

                                : array
    {
        $authors = [];
        foreach ($this->getPostings() as $posting) {
            $author_id = $posting->getAuthor();
            if ($author_id > 0 && !in_array($author_id, $authors, true)) {
                $authors[] = $author_id;
            }
 
            foreach ($this->page_manager->getPageContributors("blp", $posting->getId()) as $editor) {
                $editor_id = (int) $editor["user_id"];
                if ($editor_id > 0 && !in_array($editor_id, $authors, true)) {
                    $authors[] = $editor_id;
                }
            }
        }
        return $authors;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getByAuthor()

ILIAS\Blog\Posting\PostingList::getByAuthor

(

int

$author_id

)

Returns

Posting[]

Definition at line 105 of file PostingList.php.

                                               : array
    {
        $res = [];
        foreach ($this->getPostings() as $posting) {
            if ($posting->getAuthor() === $author_id) {
                $res[$posting->getId()] = $posting;
                continue;
            }
            foreach ($this->page_manager->getPageContributors("blp", $posting->getId()) as $editor) {
                if ((int) $editor["user_id"] === $author_id) {
                    $res[$posting->getId()] = $posting;
                    break;
                }
            }
        }
        return $res;
    }

References $res.

Referenced by ILIAS\Blog\Posting\PostingList\getPostingsForView().

Here is the caller graph for this function:

getByKeyword()

ILIAS\Blog\Posting\PostingList::getByKeyword

(

string

$keyword

)

Returns

Posting[]

Definition at line 126 of file PostingList.php.

                                                 : array
    {
        $res = [];
        foreach ($this->getPostings() as $posting) {
            if (in_array(
                $keyword,
                $this->posting_manager->getKeywords($this->obj_id, $posting->getId()),
                true
            )) {
                $res[$posting->getId()] = $posting;
            }
        }
        return $res;
    }

References $res.

getByMonth()

ILIAS\Blog\Posting\PostingList::getByMonth

(

string

$month

)

Returns

Posting[]

Definition at line 91 of file PostingList.php.

                                             : array
    {
        $res = [];
        foreach ($this->getPostings() as $posting) {
            if (substr($posting->getCreated()->get(IL_CAL_DATE), 0, 7) === $month) {
                $res[$posting->getId()] = $posting;
            }
        }
        return $res;
    }

References $res, and IL_CAL_DATE.

getMonthsWithPostings()

ILIAS\Blog\Posting\PostingList::getMonthsWithPostings

(

)

Returns

string[] months (YYYY-MM)

Definition at line 173 of file PostingList.php.

                                           : array
    {
        $months = [];
        foreach ($this->getPostings() as $posting) {
            $month = substr($posting->getCreated()->get(IL_CAL_DATE), 0, 7);
            if (!in_array($month, $months, true)) {
                $months[] = $month;
            }
        }
        rsort($months);
        return $months;
    }

References IL_CAL_DATE.

getPostings()

ILIAS\Blog\Posting\PostingList::getPostings ( )

protected

Returns

Posting[]

Definition at line 75 of file PostingList.php.

                                    : array
    {
        if ($this->postings === null) {
            $this->postings = $this->posting_manager->getAllPostings($this->obj_id);
            if (!$this->include_inactive) {
                $this->postings = array_filter($this->postings, function (Posting $posting) {
                    return $posting->isActive();
                });
            }
        }
        return $this->postings;
    }

References ILIAS\Blog\Posting\Posting\isActive().

Here is the call graph for this function:

getPostingsForView()

ILIAS\Blog\Posting\PostingList::getPostingsForView	(	int	$author_id = 0,
		string	$keyword = "",
		string	$month = ""
	)

Returns

Posting[]

Definition at line 42 of file PostingList.php.

     : array {
        if ($author_id > 0) {
            return $this->getByAuthor($author_id);
        }
        if ($keyword !== "") {
            return $this->getByKeyword($keyword);
        }
 
        $max = $this->settings->getOverviewPostings();
        if ($month === "" && $max > 0) {
            $list_items = [];
            $all_items = $this->getPostingsGroupedByMonth();
            foreach ($all_items as $postings) {
                foreach ($postings as $id => $item) {
                    $list_items[$id] = $item;
                    if (count($list_items) >= $max) {
                        break(2);
                    }
                }
            }
            return $list_items;
        }
 
        return $this->getByMonth($month);
    }

References ILIAS\Blog\Posting\PostingList\getByAuthor().

Here is the call graph for this function:

getPostingsGroupedByMonth()

ILIAS\Blog\Posting\PostingList::getPostingsGroupedByMonth

(

)

Returns

array<string, array<int, Posting>> [month => [posting_id => Posting]]

Definition at line 144 of file PostingList.php.

                                               : array
    {
        $items = [];
        foreach ($this->getPostings() as $posting) {
            $month = substr($posting->getCreated()->get(IL_CAL_DATE), 0, 7);
            $items[$month][$posting->getId()] = $posting;
        }
        return $items;
    }

References IL_CAL_DATE.

hasAuthorPostings()

ILIAS\Blog\Posting\PostingList::hasAuthorPostings

(

int

$user_id

)

Definition at line 208 of file PostingList.php.

                                                   : bool
    {
        foreach ($this->getPostings() as $posting) {
            if ($posting->getAuthor() === $user_id) {
                return true;
            }
            foreach ($this->page_manager->getPageContributors("blp", $posting->getId()) as $editor) {
                if ((int) $editor["user_id"] === $user_id) {
                    return true;
                }
            }
        }
        return false;
    }

References $user_id.

prepareViewState()

ILIAS\Blog\Posting\PostingList::prepareViewState	(	string	$month,
		?int	$author
	)

Definition at line 154 of file PostingList.php.

     : PostingViewState {
        if ($author && !$this->hasAuthorPostings($author)) {
            $author = null;
        }
 
        $items = $this->getPostingsGroupedByMonth();
        if ($items && (!$month || !isset($items[$month]) || $items[$month] === [])) {
            $month = (string) array_key_first($items);
        }
 
        return new PostingViewState($month, $author);
    }

Field Documentation

$postings

array ILIAS\Blog\Posting\PostingList::$postings = null

protected

Definition at line 28 of file PostingList.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Blog/Posting/PostingList.php