1. Documentation
  2. API
  3. Tailor
  4. Classes
  5. BlueprintIndexer

Tailor\Classes\BlueprintIndexer

Overview

BlueprintIndexer super class responsible for indexing blueprints

Public Properties

public static array $memoryCache

cache collection

Protected Properties

protected int $migrateCount

migrateCount number of migrations that occurred.

protected bool $debugChecked

debugChecked for the debug cache buster

protected Illuminate\Console\OutputStyle $notesOutput

protected Illuminate\Console\Command $notesCommand

protected string $fieldsCacheKey

protected string $globalsCacheKey

protected string $sectionsCacheKey

protected string $fieldsetsCacheKey

protected string $permissionCacheKey

protected string $navigationCacheKey

Public Methods

public static clearCache()

public static clearCache(): void

clearCache clears the disk cache

public find()

public find($uuid): Tailor\Classes\Blueprint|null

public findByHandle()

public findByHandle($handle): Tailor\Classes\Blueprint|null

public findContentFieldset()

public findContentFieldset($contentUuid): Tailor\Classes\Fieldset|null

findContentFieldset creates a compilation of fields based on shared content groups that is compiled on a first seen basis.

public findFieldset()

public findFieldset($uuid, $group = null): Tailor\Classes\Fieldset|null

public findGlobal()

public findGlobal($uuid): Tailor\Classes\Blueprint\GlobalBlueprint|null

public findGlobalByHandle()

public findGlobalByHandle(
    $handle
): Tailor\Classes\Blueprint\GlobalBlueprint|null

public findMixin()

public findMixin($uuid): Tailor\Classes\Blueprint\MixinBlueprint|null

public findPrimaryNavigation()

public findPrimaryNavigation($uuid): Tailor\Classes\NavigationItem|null

public findSecondaryNavigation()

public findSecondaryNavigation($uuid): Tailor\Classes\NavigationItem|null

public findSection()

public findSection($uuid): Tailor\Classes\Blueprint\EntryBlueprint|null

public findSectionByHandle()

public findSectionByHandle(
    $handle
): Tailor\Classes\Blueprint\EntryBlueprint|null

public static flushCache()

public static flushCache(): void

flushCache clears the memory cache

public getNavigationContentMainMenu()

public getNavigationContentMainMenu(): array

public getNavigationContentSideMenu()

public getNavigationContentSideMenu(): array

getNavigationContentMenu

public getNavigationMainMenu()

public getNavigationMainMenu(): array

public getNavigationSettingsMenu()

public getNavigationSettingsMenu(): array

public getNavigationSideMenu()

public getNavigationSideMenu($parentItem): array

public getNotesCommand()

public getNotesCommand(): Illuminate\Console\Command|null

getNotesOutput returns the note command object, if available.

public getNotesOutput()

public getNotesOutput(): Illuminate\Console\OutputStyle|null

getNotesOutput returns the note output, used by command line.

public getPageManagerTypeInfo()

public getPageManagerTypeInfo($type): array

public getPermissionDefinitions()

public getPermissionDefinitions(): array

public hasMixin()

public hasMixin($handleOrUuid): string

hasMixin is a quick way to resolve a mixin to a UUID

public hasSection()

public hasSection($handleOrUuid): string

hasSection is a quick way to resolve a section to a UUID

public indexFieldsets()

public indexFieldsets(): array

public indexGlobals()

public indexGlobals(): array

public indexMixins()

public indexMixins(): array

public indexNavigation()

public indexNavigation(): array

public indexPermissions()

public indexPermissions(): array

public indexSections()

public indexSections(): array

public static instance()

public static instance(): static

instance creates a new instance of this singleton

public listFieldsets()

public listFieldsets(): array

public listGlobals()

public listGlobals(): array

public listMixins()

public listMixins(): array

public listPageManagerTypes()

public listPageManagerTypes(): array

listPrimaryNavigation

public listSections()

public listSections(): array

public migrate()

public migrate(): void

public migrateBlueprint()

public migrateBlueprint($blueprint): void

public resolvePageManagerItem()

public resolvePageManagerItem($type, $item, $url, $theme): array

public setNotesCommand()

public setNotesCommand(Illuminate\Console\Command $command): void

setNotesCommand sets the fully qualified command for writing notes.

public setNotesOutput()

public setNotesOutput(Illuminate\Console\OutputStyle $output): self

setNotesOutput sets an output stream for writing notes.

Protected Methods

protected buildExtraNavigationConfig()

protected buildExtraNavigationConfig($blueprint): array|null

buildExtraNavigationConfig used to inject manually specified navigation definitions

protected buildNavigationConfig()

protected buildNavigationConfig($blueprint, $isPrimary = false): array|null

buildNavigationConfig builds navigation config based on blueprint relationships

protected buildParentNavigationPermissions()

protected buildParentNavigationPermissions($items): void

protected buildPermissionConfig()

protected buildPermissionConfig($blueprint): array|null

protected findAllFieldsetBlueprints()

protected findAllFieldsetBlueprints(): array

findAllFieldsetBlueprints will spin over all fieldset sources

protected findAllNavigationBlueprints()

protected findAllNavigationBlueprints(): array

findAllFieldsetBlueprints will spin over all fieldset sources

protected findAllPermissionBlueprints()

protected findAllPermissionBlueprints(): array

findAllFieldsetBlueprints will spin over all fieldset sources

protected findParentConfigUuid()

protected findParentConfigUuid($index, $handleOrUuid): string

protected getCache()

protected getCache($name): array

protected static getPageManagerPageUrl()

protected static getPageManagerPageUrl($pageCode, $record, $theme): void

protected static getPageManagerSites()

protected static getPageManagerSites($pageCode, $record, $theme): array

getPageManagerPageUrl

protected listBlueprintCmsPagesForPageInfo()

protected listBlueprintCmsPagesForPageInfo($model): void

protected listBlueprintPermissions()

protected listBlueprintPermissions(): array

protected listFieldsetsRaw()

protected listFieldsetsRaw(): array

listFieldsetsRaw without populating the Blueprint object

protected listGlobalsRaw()

protected listGlobalsRaw(): array

listGlobalsRaw without populating the Blueprint object

protected listMixinsRaw()

protected listMixinsRaw(): array

listMixinsRaw without populating the Blueprint object

protected listNavigationRaw()

protected listNavigationRaw(): array

protected listPermissionsRaw()

protected listPermissionsRaw(): array

protected listPrimaryNavigation()

protected listPrimaryNavigation(): array

protected listRecordOptionsForPageInfo()

protected listRecordOptionsForPageInfo($model, $query): void

protected listSecondaryNavigation()

protected listSecondaryNavigation(): array

protected listSectionsRaw()

protected listSectionsRaw(): array

listSectionsRaw without populating the Blueprint object

protected makeCacheFile()

protected makeCacheFile($name): string

protected migrateContentInternal()

protected migrateContentInternal($blueprint): void

protected note()

protected note(string $message): self

note writes a note event for the migrator.

protected pageManagerBlueprintToType()

protected pageManagerBlueprintToType($blueprint): string

protected pageManagerTypeToModel()

protected pageManagerTypeToModel($typeName): void

pageManagerTypeToModel returns the resolved model and its scoped query for a given type

protected putCache()

protected putCache($name, $contents): void

protected resetCacheInDebugMode()

protected resetCacheInDebugMode(): void

protected resolvePageManagerItemAsChildren()

protected resolvePageManagerItemAsChildren(
    $children,
    $item,
    $theme,
    $url,
    $recursive = true
): void

protected resolvePageManagerItemAsList()

protected resolvePageManagerItemAsList($type, $item, $url, $theme): array

protected resolvePageManagerItemAsReference()

protected resolvePageManagerItemAsReference($type, $item, $url, $theme): array