Sledgehammer Framework

CrudFolder extends Folder
in package

Folder for basic CRUD operations on a Repository model.

Table of Contents

$current  : Folder
The current active VirtualFolder (Is used to detect the parent).
$requireDataOnSave  : mixed
$depth  : int
Diepte van deze virtual folder.
$depthIncrement  : int
Het aantal niveau's(submappen) dat door deze VirtualFolder wordt afgehandeld.
$handle_filenames_without_extension  : bool
Bepaald of deze VirtualFolder bestandsnamen zonder extenties accepteerd.
$maxRecursion  : mixed
$model  : mixed
$primaryKey  : string
Wordt gebruik om te id uit de $_REQUEST te halen. $idValue = $_POST[$this->id].
$publicMethods  : array<string|int, mixed>
automatisch gegenereerde array die bepaald of een methode via een url aangeroepen.
$repository  : mixed
$parent  : Folder
Deze virtuele map is een submap van .
__call()  : mixed
Report that the $method doesn't exist.
__callStatic()  : mixed
Report that the $method doesn't exist.
__construct()  : mixed
Constructor.
__get()  : mixed
Report that $property doesn't exist.
__set()  : mixed
Report that $property doesn't exist and set the property to the given $value.
__toString()  : string
The object is used as an string.
file()  : Component
Een bestand(snaam) afhandelen.
folder()  : Component
Een submap afhandelen.
generateContent()  : Component
Aan de hand van de url de betreffende action functie aanroepen.
getParentByClass()  : Folder
De VirtualFolder van een bepaalde class opvragen die zich hoger in de hierarchie bevind.
getPath()  : mixed
Het pad opvragen van deze VirtualFolder.
index()  : mixed
error()  : Json
Reports the error/exception to the ErrorHandler and returns the error as Json object.
format()  : mixed
getNewValues()  : array<string|int, mixed>
onFileNotFound()  : HttpError
Event dat getriggert wordt als een (virtuele) bestand niet gevonden wordt.
onFolderNotFound()  : HttpError
Event/Action voor het afhandelen van niet bestaande (virtuele) mappen.
read()  : Json
Stuur de gegevens van het record naar de client.
success()  : Json
Short for "new Json(array('success' => true))".
create()  : Json
delete()  : Json
De record verwijderen.
initDepth()  : int
Mits de $this->depth niet is ingesteld zal de waarde van $this->depth berekent worden.
load()  : mixed
save()  : Json
Aan de hand van de id bepalen of er een record toegevoegd of bijgewerkt moet worden.
update()  : Json

Properties

$current

The current active VirtualFolder (Is used to detect the parent).

public static Folder $current

$requireDataOnSave

public mixed $requireDataOnSave = 1

$depth

Diepte van deze virtual folder.

protected int $depth

Als deze VirtualFolder de inhoud van de map "http://domain/folder/" afhandeld, dan $depth == 1. Een VirtualFolder van "http://domain/folder/subfolder/" heeft $depth == 2.

$depthIncrement

Het aantal niveau's(submappen) dat door deze VirtualFolder wordt afgehandeld.

protected int $depthIncrement = 1

Deze variabele wordt gebruikt om de $depth van de submap uit te rekenen. Dit is handig als je een andere VirtualFolder wilt gebruiken terwijl je zelf al meerdere submappen gebruikt. Als je je de $depth_increment op 0 zet, dan wordt de andere VirtualFolder niet als subfolder,maar als de dezelfde folder gebruikt.

$handle_filenames_without_extension

Bepaald of deze VirtualFolder bestandsnamen zonder extenties accepteerd.

protected bool $handle_filenames_without_extension = false

Als deze niet geaccepteerd worden(false), zal de bestandsnaam (via een redirect) omgezet worden naar een mapnaam.

$primaryKey

Wordt gebruik om te id uit de $_REQUEST te halen. $idValue = $_POST[$this->id].

protected string $primaryKey = 'id'

$publicMethods

automatisch gegenereerde array die bepaald of een methode via een url aangeroepen.

protected array<string|int, mixed> $publicMethods

$repository

protected mixed $repository = 'default'

$parent

Deze virtuele map is een submap van .

private Folder $parent

..

Methods

__call()

Report that the $method doesn't exist.

public __call(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : string
$arguments : array<string|int, mixed>
Return values
mixed

__callStatic()

Report that the $method doesn't exist.

public static __callStatic(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : string
$arguments : array<string|int, mixed>
Return values
mixed

__construct()

Constructor.

public __construct(mixed $model[, mixed $options = [] ]) : mixed
Parameters
$model : mixed
$options : mixed = []
Return values
mixed

__get()

Report that $property doesn't exist.

public __get(string $property) : mixed
Parameters
$property : string
Return values
mixed

__set()

Report that $property doesn't exist and set the property to the given $value.

public __set(string $property, mixed $value) : mixed
Parameters
$property : string
$value : mixed
Return values
mixed

__toString()

The object is used as an string.

public __toString() : string
Return values
string

file()

Een bestand(snaam) afhandelen.

public file(mixed $filename) : Component
Parameters
$filename : mixed

De bestandsnaam die in deze virtuele map word opgevraagd

Return values
Component

folder()

Een submap afhandelen.

public folder(mixed $folder[, mixed $filename = false ]) : Component
Parameters
$folder : mixed

De submap die in deze virtuele map opgevraagd

$filename : mixed = false
Return values
Component

generateContent()

Aan de hand van de url de betreffende action functie aanroepen.

public generateContent() : Component

Valt terug op file() en folder() functies, als de geen action functie gevonden wordt.

Return values
Component

getParentByClass()

De VirtualFolder van een bepaalde class opvragen die zich hoger in de hierarchie bevind.

public getParentByClass(mixed $class) : Folder
Parameters
$class : mixed
Return values
Folder

getPath()

Het pad opvragen van deze VirtualFolder.

public getPath([bool $includeSubfolders = false ]) : mixed
Parameters
$includeSubfolders : bool = false

De actieve submap(pen) aan het path toevoegen (mappen die door deze VirtualFolder worden afgehandeld)

Return values
mixed

index()

public index(mixed $format) : mixed
Parameters
$format : mixed
Return values
mixed

error()

Reports the error/exception to the ErrorHandler and returns the error as Json object.

protected static error(string|Exception $error[, int $http = 400 ]) : Json

The javascript client should detect and report the error to the user: if (result.success !== true) { alert(result.error); }.

Parameters
$error : string|Exception

The error message or Exception

$http : int = 400

The HTTP status code (defaults to 400 Bad Request)

Return values
Json

format()

protected format(mixed $data, mixed $format) : mixed
Parameters
$data : mixed
$format : mixed
Return values
mixed

getNewValues()

protected getNewValues() : array<string|int, mixed>
Tags
todo

$_POST data filteren zodat eventuele $_POST elementen geen fouten geven set_object_vars()

Return values
array<string|int, mixed>

onFileNotFound()

Event dat getriggert wordt als een (virtuele) bestand niet gevonden wordt.

protected onFileNotFound() : HttpError

Geeft deze of een parent van deze virtualfolder de mogenlijkheid om een custom actie uit te voeren.

Return values
HttpError

onFolderNotFound()

Event/Action voor het afhandelen van niet bestaande (virtuele) mappen.

protected onFolderNotFound() : HttpError

Geeft deze of een parent van deze virtualfolder de mogenlijkheid om een custom actie uit te voeren.

Return values
HttpError

read()

Stuur de gegevens van het record naar de client.

protected read() : Json
Tags
throws
Exception

on failure

Return values
Json

success()

Short for "new Json(array('success' => true))".

protected static success([mixed $data = null ]) : Json
Parameters
$data : mixed = null

[optional] The data payload

Return values
Json

create()

private create() : Json
Tags
throws
Exception

on failure

Return values
Json

delete()

De record verwijderen.

private delete() : Json
Tags
throws
Exception

on failure

Return values
Json

initDepth()

Mits de $this->depth niet is ingesteld zal de waarde van $this->depth berekent worden.

private initDepth() : int

Hoe diep de handler genest is wordt aan de hand van de Parent->depth berekend.

Return values
int

load()

private load(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

save()

Aan de hand van de id bepalen of er een record toegevoegd of bijgewerkt moet worden.

private save() : Json
Tags
throws
Exception

on failure

Return values
Json

update()

private update() : Json
Tags
throws
Exception

on failure

Return values
Json

Search results