Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:core:authorization

This is an old revision of the document!


Authorization

Layer: Core · Source: lib/core/Authorization.php:17 (lines 17–88)


class Authorization

Docblock Metadata

^ Tag ^ Value ^
| ''@category'' | core class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |

Inheritance

No parent, interface or trait. This is a root type.

Constants (0)

None.

Properties (0)

None declared.

Methods (5)

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 28 |
| public static | ''setAuthInstance()'' | Sets the Authentication instance | 41 |
| public static | ''getAuthInstance()'' | getAuthInstance | 57 |
| public static | ''authorizeRole()'' | authorizeRole | 69 |
| public static | ''authorizeLevel()'' | authorizeLevel | 83 |

__construct()

public function __construct(Authentication $authentication)

lines 28–31 (4)

^ Parameter ^ Type ^ Default ^ Description ^
| ''$authentication'' | [[scriptlog:lib:core:authentication|''Authentication'']] | //required// | //none// |

setAuthInstance()

public static function setAuthInstance($authentication): void

lines 41–49 (9)

Sets the Authentication instance

^ Parameter ^ Type ^ Default ^ Description ^
| ''$authentication'' | ''(untyped)'' | //required// | Instance to set |

Returns: void — void

Throws: \InvalidArgumentException

getAuthInstance()

public static function getAuthInstance(): ?Authentication

lines 57–60 (4)

getAuthInstance

Takes no parameters.

Returns: ''?Authentication'' — object

authorizeRole()

public static function authorizeRole(string $role): bool

lines 69–77 (9)

authorizeRole

^ Parameter ^ Type ^ Default ^ Description ^
| ''$role'' | ''string'' | //required// | //none// |

Returns: bool — false|true

authorizeLevel()

public static function authorizeLevel(): string

lines 83–87 (5)

authorizeLevel

Takes no parameters.

Returns: string — string


This page is generated from source by 'tools/gendoc'. Edits will be overwritten.

scriptlog/lib/core/authorization.1790413761.txt.gz · Last modified: by admin