// Copyright 2020 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. //go:build !gogit package git import "code.gitea.io/gitea/modules/log" // TreeEntry the leaf in the git tree type TreeEntry struct { ID SHA1 ptree *Tree entryMode EntryMode name string size int64 sized bool fullName string } // Name returns the name of the entry func (te *TreeEntry) Name() string { if te.fullName != "" { return te.fullName } return te.name } // Mode returns the mode of the entry func (te *TreeEntry) Mode() EntryMode { return te.entryMode } // Size returns the size of the entry func (te *TreeEntry) Size() int64 { if te.IsDir() { return 0 } else if te.sized { return te.size } wr, rd, cancel := te.ptree.repo.CatFileBatchCheck(te.ptree.repo.Ctx) defer cancel() _, err := wr.Write([]byte(te.ID.String() + "\n")) if err != nil { log.Debug("error whilst reading size for %s in %s. Error: %v", te.ID.String(), te.ptree.repo.Path, err) return 0 } _, _, te.size, err = ReadBatchLine(rd) if err != nil { log.Debug("error whilst reading size for %s in %s. Error: %v", te.ID.String(), te.ptree.repo.Path, err) return 0 } te.sized = true return te.size } // IsSubModule if the entry is a sub module func (te *TreeEntry) IsSubModule() bool { return te.entryMode == EntryModeCommit } // IsDir if the entry is a sub dir func (te *TreeEntry) IsDir() bool { return te.entryMode == EntryModeTree } // IsLink if the entry is a symlink func (te *TreeEntry) IsLink() bool { return te.entryMode == EntryModeSymlink } // IsRegular if the entry is a regular file func (te *TreeEntry) IsRegular() bool { return te.entryMode == EntryModeBlob } // IsExecutable if the entry is an executable file (not necessarily binary) func (te *TreeEntry) IsExecutable() bool { return te.entryMode == EntryModeExec } // Blob returns the blob object the entry func (te *TreeEntry) Blob() *Blob { return &Blob{ ID: te.ID, name: te.Name(), size: te.size, gotSize: te.sized, repo: te.ptree.repo, } } ion value='Jerome-Herbinet-internal-shares-parameter-better-distinction'>Jerome-Herbinet-internal-shares-parameter-better-distinction Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Reference/IReference.php
blob: eaa82c323b598524cefe45e4282e615361a7e68c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\Collaboration\Reference;

use JsonSerializable;

/**
 * @since 25.0.0
 */
interface IReference extends JsonSerializable {
	/**
	 * @since 25.0.0
	 */
	public function getId(): string;

	/**
	 * Accessible flag indicates if the user has access to the provided reference
	 *
	 * @since 25.0.0
	 */
	public function setAccessible(bool $accessible): void;

	/**
	 * Accessible flag indicates if the user has access to the provided reference
	 *
	 * @since 25.0.0
	 */
	public function getAccessible(): bool;

	/**
	 * @since 25.0.0
	 */
	public function setTitle(string $title): void;

	/**
	 * @since 25.0.0
	 */
	public function getTitle(): string;

	/**
	 * @since 25.0.0
	 */
	public function setDescription(?string $description): void;

	/**
	 * @since 25.0.0
	 */
	public function getDescription(): ?string;

	/**
	 * @since 25.0.0
	 */
	public function setImageUrl(?string $imageUrl): void;

	/**
	 * @since 25.0.0
	 */
	public function getImageUrl(): ?string;

	/**
	 * @since 25.0.0
	 */
	public function setImageContentType(?string $contentType): void;

	/**
	 * @since 25.0.0
	 */
	public function getImageContentType(): ?string;

	/**
	 * @since 25.0.0
	 */
	public function setUrl(?string $url): void;

	/**
	 * @since 25.0.0
	 */
	public function getUrl(): string;

	/**
	 * Set the reference specific rich object representation
	 *
	 * @since 25.0.0
	 */
	public function setRichObject(string $type, ?array $richObject): void;

	/**
	 * Returns the type of the reference specific rich object
	 *
	 * @since 25.0.0
	 */
	public function getRichObjectType(): string;

	/**
	 * Returns the reference specific rich object representation
	 *
	 * @since 25.0.0
	 */
	public function getRichObject(): array;

	/**
	 * Returns the opengraph rich object representation
	 *
	 * @since 25.0.0
	 */
	public function getOpenGraphObject(): array;

	/**
	 * @return array{richObjectType: string, richObject: array<string, mixed>, openGraphObject: array{id: string, name: string, description: ?string, thumb: ?string, link: string}, accessible: bool}
	 *
	 * @since 25.0.0
	 */
	public function jsonSerialize(): array;
}