hydephp / develop

packages/publications/src/Publications.php

<?php

declare(strict_types=1);

namespace Hyde\Publications;

use Hyde\Hyde;
use Hyde\Publications\Concerns\PublicationFieldTypes;
use Hyde\Publications\Models\PublicationType;
use Hyde\Publications\Pages\PublicationPage;
use Hyde\Support\Filesystem\MediaFile;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

use function array_keys;
use function array_unique;
use function array_values;
use function collect;

/**
 * @see \Hyde\Publications\Testing\Feature\PublicationServiceTest
 */
class Publications
{
    /**
     * Return a collection of all defined publication types, indexed by the directory name.
     *
     * @return Collection<string, PublicationType>
     */
    public static function getPublicationTypes(): Collection
    {
        return Hyde::kernel()->getExtension(PublicationsExtension::class)->getTypes();

The method getTypes() does not exist on Hyde\Foundation\Concerns\HydeExtension. It seems like you code against a sub-type of Hyde\Foundation\Concerns\HydeExtension such as Hyde\Publications\PublicationsExtension.

    }

    /**
     * Return all publications for a given publication type.
     *
     * @return Collection<int, \Hyde\Publications\Pages\PublicationPage>
     */
    public static function getPublicationsForType(PublicationType $publicationType, ?string $sortField = null, ?bool $sortAscending = null): Collection
    {
        $publications = Hyde::pages()->getPages(PublicationPage::class);

The method pages() does not exist on Hyde\Hyde. Since you implemented __callStatic, consider adding a @method annotation.

        $sortAscending ??= $publicationType->sortAscending;
        $sortField ??= $publicationType->sortField;

        return $publications->sortBy(function (PublicationPage $page) use ($sortField): mixed {
            return $page->matter($sortField);
        }, descending: ! $sortAscending)->values()->toBase();
    }

    /**
     * Return all media items for a given publication type.
     */
    public static function getMediaForType(PublicationType $publicationType): Collection
    {
        return collect(MediaFile::all())->filter(function (MediaFile $file) use ($publicationType): bool {
            return Str::startsWith($file->getPath(), Hyde::getMediaDirectory().'/'.$publicationType->getDirectory());

The method getMediaDirectory() does not exist on Hyde\Hyde. Since you implemented __callStatic, consider adding a @method annotation.

        })->keys()->toBase();
    }

    /**
     * Get all available tags used in the publications.
     *
     * The tags are aggregated from the front matter of all publication pages, where the field type is "tag".
     *
     * @return array<string>
     */
    public static function getPublicationTags(): array
    {
        return array_values(array_unique(array_keys(self::getPublicationsGroupedByTags())));
    }

    /**
     * Get all pages grouped by their tags. Note that pages with multiple tags will appear multiple times.
     * It's also useful to count the number of times a tag is used by using `array_map('count', $pagesByTag)`.
     *
     * @experimental May be renamed to `getPublicationsGroupedByTag` before release.
     *
     * @return array<string, array<\Hyde\Publications\Pages\PublicationPage>>
     */
    public static function getPublicationsGroupedByTags(): array
    {
        $pagesByTag = [];

        /** @var PublicationPage $publication */
        foreach (PublicationPage::all() as $publication) {
            foreach (self::getPublicationTagFields($publication) as $field) {
                foreach ((array) $publication->matter($field->name) as $tag) {
                    $pagesByTag[$tag][] = $publication;
                }
            }
        }

        return $pagesByTag;
    }

    /**
     * Check whether a given publication type exists.
     */
    public static function publicationTypeExists(string $publicationTypeName): bool
    {
        return static::getPublicationTypes()->has(Str::slug($publicationTypeName));
    }

    protected static function getPublicationTagFields(PublicationPage $publication): Collection
    {
        return $publication->getType()->getFields()->whereStrict('type', PublicationFieldTypes::Tag);

The constant Hyde\Publications\Concerns\PublicationFieldTypes::Tag has been deprecated: May be renamed to Tags to better fit usage

    }
}