1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Block
  7. \
  8. BlockType
  9. \
  10. BlockType

BlockType

class BlockType (View source)

Methods

static BlockType|null
getByHandle(string $btHandle)

Get a BlockType given its handle.

static BlockType|null
getByID(int $btID)

Get a BlockType given its ID.

static BlockType
installBlockType(string $btHandle, Package|Package|string|false $pkg = false)

Install a BlockType that is passed via a btHandle string. The core or override directories are parsed.

static string|null
getBlockTypeMappedClass(string $btHandle, string|false $pkgHandle = false)

Return the class file that this BlockType uses.

static 
clearCache()

Clears output and record caches.

static BlockType
installBlockTypeFromPackage(mixed $btHandle, mixed $pkg) deprecated

No description

Details

at line 22
static BlockType|null getByHandle(string $btHandle)

Get a BlockType given its handle.

Parameters

string $btHandle

Return Value

BlockType|null

at line 46
static BlockType|null getByID(int $btID)

Get a BlockType given its ID.

Parameters

int $btID

Return Value

BlockType|null

at line 85
static BlockType installBlockType(string $btHandle, Package|Package|string|false $pkg = false)

Install a BlockType that is passed via a btHandle string. The core or override directories are parsed.

Parameters

string $btHandle

The handle of the block type
Package|Package|string|false $pkg

The package owning the block type (or its handle)

Return Value

BlockType

at line 138
static string|null getBlockTypeMappedClass(string $btHandle, string|false $pkgHandle = false)

Return the class file that this BlockType uses.

Parameters

string $btHandle

The handle of the block type
string|false $pkgHandle

The handle of the package owning the block type

Return Value

string|null

at line 163
static clearCache()

Clears output and record caches.

at line 191
static BlockType installBlockTypeFromPackage(mixed $btHandle, mixed $pkg) deprecated

deprecated use the installBlockType method

No description

Parameters

mixed $btHandle
mixed $pkg

Return Value

BlockType