How do I create a command for my app?

z4k · June 9, 2023, 8:13am

Hi everyone

I would like to create a command for my app and I searched in the official developer documentation and I found nothing on this subject Search — Nextcloud latest Developer Manual latest documentation

So, I looked in these repositories :

And I saw you use the private API OC\Core\Command\Base.

As a community developer, I cannot use this API.

How do I create a command with a public API ? Do I have to use this private API ?

Thanks in advance

tcit · June 9, 2023, 10:51am

I’m guessing there’s something extra in OC\Core\Command\Base that’s not been published to the public API, but that’s definitely not normal.

Here is an example of a command using only the public API:

github.com

nextcloud/server/blob/master/apps/dav/lib/Command/CreateAddressBook.php

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Björn Schießle <bjoern@schiessle.org>
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 * @author Joas Schilling <coding@schilljs.com>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *

This file has been truncated. show original

z4k · June 9, 2023, 12:56pm

That’s exactly what I thought…

May be for the community, we have to use Symfony\Component\Console\Command\Command ?

May be I will ask the chat directly

Thanks @tcit for your answer

tcit · June 9, 2023, 12:58pm

Yes, there’s not much added value to inherit the Base class anyway:

github.com

nextcloud/server/blob/master/core/Command/Base.php

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 * @author Daniel Kesselberg <mail@danielkesselberg.de>
 * @author Joas Schilling <coding@schilljs.com>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.

This file has been truncated. show original

christianlupus · June 11, 2023, 11:14pm

Do you need any special functions from your command? I found another app that uses only the public API: server/info.xml at 38aaab3fbf68db0b0b5da14fb17a8bf1dfee5f5d · nextcloud/server · GitHub

Does this help you?

z4k · July 11, 2023, 10:06am

Hi @tcit and @christianlupus

I’m sorry for the delay in replying

I paused this task because I worked on another one.

I will test on my project later ^^

Thank you for your help