Skip to content

Routes ​

Type
Class
Namespace
craft\mcp\capabilities
Inherits
craft\mcp\capabilities\Routes
Since
5.12.0

View source

Public Methods ​

MethodDescription
__construct()
create()
delete()
get()
list()
update()

__construct() ​

View source

Arguments ​

  • $routes

create() ​

View source

Arguments ​

  • $uriParts (list<string|array{0: string, 1: string}>) – Literal strings and [name, regex] parameter tuples.
  • $template
  • $siteUid

Returns ​

array{route: array<string,mixed>}

delete() ​

View source

Arguments ​

  • $uid
  • $uri

Returns ​

array{deleted: true}

get() ​

View source

Arguments ​

  • $uid
  • $uri

Returns ​

array{route: array<string,mixed>}

list() ​

View source

Returns ​

array{count: int, routes: list<array<string,mixed>>}

update() ​

View source

Arguments ​

  • $context
  • $uid
  • $uri
  • $uriParts (list<string|array{0: string, 1: string}>) – Literal strings and [name, regex] parameter tuples.
  • $template
  • $siteUid

Returns ​

array{route: array<string,mixed>}

Constants ​

ConstantDescription
UriPartSchema