Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F85031423
PhabricatorDashboardQueryPanelType.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Thu, Sep 26, 07:40
Size
3 KB
Mime Type
text/x-php
Expires
Sat, Sep 28, 07:40 (2 d)
Engine
blob
Format
Raw Data
Handle
21119652
Attached To
rPH Phabricator
PhabricatorDashboardQueryPanelType.php
View Options
<?php
final
class
PhabricatorDashboardQueryPanelType
extends
PhabricatorDashboardPanelType
{
public
function
getPanelTypeKey
()
{
return
'query'
;
}
public
function
getPanelTypeName
()
{
return
pht
(
'Query Panel'
);
}
public
function
getPanelTypeDescription
()
{
return
pht
(
'Show results of a search query, like the most recently filed tasks or '
.
'revisions you need to review.'
);
}
public
function
getFieldSpecifications
()
{
return
array
(
'class'
=>
array
(
'name'
=>
pht
(
'Search For'
),
'type'
=>
'search.application'
,
),
'key'
=>
array
(
'name'
=>
pht
(
'Query'
),
'type'
=>
'search.query'
,
'control.application'
=>
'class'
,
),
'limit'
=>
array
(
'name'
=>
pht
(
'Limit'
),
'caption'
=>
pht
(
'Leave this blank for the default number of items.'
),
'type'
=>
'text'
,
),
);
}
public
function
initializeFieldsFromRequest
(
PhabricatorDashboardPanel
$panel
,
PhabricatorCustomFieldList
$field_list
,
AphrontRequest
$request
)
{
$map
=
array
();
if
(
strlen
(
$request
->
getStr
(
'engine'
)))
{
$map
[
'class'
]
=
$request
->
getStr
(
'engine'
);
}
if
(
strlen
(
$request
->
getStr
(
'query'
)))
{
$map
[
'key'
]
=
$request
->
getStr
(
'query'
);
}
$full_map
=
array
();
foreach
(
$map
as
$key
=>
$value
)
{
$full_map
[
"std:dashboard:core:{$key}"
]
=
$value
;
}
foreach
(
$field_list
->
getFields
()
as
$field
)
{
$field_key
=
$field
->
getFieldKey
();
if
(
isset
(
$full_map
[
$field_key
]))
{
$field
->
setValueFromStorage
(
$full_map
[
$field_key
]);
}
}
}
public
function
renderPanelContent
(
PhabricatorUser
$viewer
,
PhabricatorDashboardPanel
$panel
,
PhabricatorDashboardPanelRenderingEngine
$engine
)
{
$engine
=
$this
->
getSearchEngine
(
$panel
);
$engine
->
setViewer
(
$viewer
);
$engine
->
setContext
(
PhabricatorApplicationSearchEngine
::
CONTEXT_PANEL
);
$key
=
$panel
->
getProperty
(
'key'
);
if
(
$engine
->
isBuiltinQuery
(
$key
))
{
$saved
=
$engine
->
buildSavedQueryFromBuiltin
(
$key
);
}
else
{
$saved
=
id
(
new
PhabricatorSavedQueryQuery
())
->
setViewer
(
$viewer
)
->
withEngineClassNames
(
array
(
get_class
(
$engine
)))
->
withQueryKeys
(
array
(
$key
))
->
executeOne
();
}
if
(!
$saved
)
{
throw
new
Exception
(
pht
(
'Query "%s" is unknown to application search engine "%s"!'
,
$key
,
get_class
(
$engine
)));
}
$query
=
$engine
->
buildQueryFromSavedQuery
(
$saved
);
$pager
=
$engine
->
newPagerForSavedQuery
(
$saved
);
if
(
$panel
->
getProperty
(
'limit'
))
{
$limit
=
(
int
)
$panel
->
getProperty
(
'limit'
);
if
(
$pager
->
getPageSize
()
!==
0xFFFF
)
{
$pager
->
setPageSize
(
$limit
);
}
}
$results
=
$engine
->
executeQuery
(
$query
,
$pager
);
return
$engine
->
renderResults
(
$results
,
$saved
);
}
public
function
adjustPanelHeader
(
PhabricatorUser
$viewer
,
PhabricatorDashboardPanel
$panel
,
PhabricatorDashboardPanelRenderingEngine
$engine
,
PHUIHeaderView
$header
)
{
$search_engine
=
$this
->
getSearchEngine
(
$panel
);
$key
=
$panel
->
getProperty
(
'key'
);
$href
=
$search_engine
->
getQueryResultsPageURI
(
$key
);
$icon
=
id
(
new
PHUIIconView
())
->
setIcon
(
'fa-search'
)
->
setHref
(
$href
);
$header
->
addActionIcon
(
$icon
);
return
$header
;
}
private
function
getSearchEngine
(
PhabricatorDashboardPanel
$panel
)
{
$class
=
$panel
->
getProperty
(
'class'
);
$engine
=
PhabricatorApplicationSearchEngine
::
getEngineByClassName
(
$class
);
if
(!
$engine
)
{
throw
new
Exception
(
pht
(
'The application search engine "%s" is not known to Phabricator!'
,
$class
));
}
if
(!
$engine
->
canUseInPanelContext
())
{
throw
new
Exception
(
pht
(
'Application search engines of class "%s" can not be used to build '
.
'dashboard panels.'
,
$class
));
}
return
$engine
;
}
}
Event Timeline
Log In to Comment