Skip to content

Adding visibility to class members and abstract/final to classes #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adding visibility to class members and abstract/final to classes #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52aed87
Added tentative visibility and abstract/final options
thuttinpasseron May 8, 2023
cd986c1
Moved visibility to relvant classes, added final and abstract options…
thuttinpasseron May 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 45 additions & 6 deletions sphinxcontrib/phpdomain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,8 +386,22 @@ class PhpClasslike(PhpObject):
(classes, exceptions, interfaces, traits, enums).
"""

option_spec = {
'noindex': directives.flag,
'noindexentry': directives.flag,
'nocontentsentry': directives.flag,
'module': directives.unchanged,
'final': directives.flag,
'abstract': directives.flag
}

def get_signature_prefix(self, sig):
return self.objtype + ' '
prefix = ''
if 'final' in self.options:
prefix += 'final '
elif self.objtype == 'class' and 'abstract' in self.options:
prefix += 'abstract '
return prefix + self.objtype + ' '

def get_index_text(self, modname, name_cls):
if self.objtype == 'class':
Expand Down Expand Up @@ -425,14 +439,39 @@ class PhpClassmember(PhpObject):
Description of a class member (methods, attributes).
"""

option_spec = {
'noindex': directives.flag,
'noindexentry': directives.flag,
'nocontentsentry': directives.flag,
'module': directives.unchanged,
'private': directives.flag,
'public': directives.flag,
'protected': directives.flag,
'static': directives.flag,
'final': directives.flag
}

def get_signature_prefix(self, sig):
prefix = ''
if self.objtype != 'case':
if self.objtype == 'method':
if 'final' in self.options:
prefix += 'final '
elif 'abstract' in self.options:
prefix += 'abstract '
if 'private' in self.options:
prefix += 'private '
elif 'protected' in self.options:
prefix += 'protected '
elif 'public' in self.options:
prefix += 'public '
if 'static' in self.options or self.objtype == 'staticmethod':
prefix += 'static '
if self.objtype == 'attr':
return _('property ')
if self.objtype == 'staticmethod':
return _('static ')
prefix += _('property ')
if self.objtype == 'case':
return _('case ')
return ''
prefix += _('case ')
return prefix

def needs_arglist(self):
return self.objtype == 'method'
Expand Down