Jinya CMS

Folder extends Entity
in package
implements JsonSerializable

This class contains a folder. Folders are used to group other folders or files in the file manager.

In addition to tags, this gives more control on organization of files.

Tags

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

$id  : int
$name  : string
$parentId  : int|null
findRootFolders()  : Iterator
Finds all root folders
format()  : array<string, int|string|null|mixed|bool>
Formats the folder
getFiles()  : Iterator<string|int, File>
Gets all files in this folder
getFolders()  : Iterator<string|int, Folder>
Gets all folders in this folder
jsonSerialize()  : mixed

Properties

$name

public string $name = ''

The name of the folder

Tags

$parentId

public int|null $parentId = null

The ID of the parent folder

Tags

Methods

findRootFolders()

Finds all root folders

public static findRootFolders() : Iterator
Tags
Return values
Iterator

format()

Formats the folder

public format() : array<string, int|string|null|mixed|bool>
Tags
throws
Exception
Return values
array<string, int|string|null|mixed|bool>

getFiles()

Gets all files in this folder

public getFiles() : Iterator<string|int, File>
Tags
Return values
Iterator<string|int, File>

getFolders()

Gets all folders in this folder

public getFolders() : Iterator<string|int, Folder>
Tags
Return values
Iterator<string|int, Folder>

jsonSerialize()

public jsonSerialize() : mixed
Tags
Return values
mixed

Search results