Page MenuHomePhorge
Diviner Tech Docs PhabricatorCalendarImportPHIDType

final class PhabricatorCalendarImportPHIDType
Phorge Technical Documentation (Calendar)

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

final public function getTypeConstant()
Inherited

This method is not documented.
Return
wild

public function getTypeName()

This method is not documented.
Return
wild

public function getTypeIcon()
Inherited

This method is not documented.
Return
wild

public function newObject()

This method is not documented.
Return
wild

public function getPHIDTypeApplicationClass()

PhabricatorPHIDType

Get the class name for the application this type belongs to.

PhabricatorCalendarImportPHIDType
This method is not documented.
Return
string|nullClass name of the corresponding application, or null if the type is not bound to an application.

protected function buildQueryForObjects($query, $phids)

PhabricatorPHIDType

Build a PhabricatorPolicyAwareQuery to load objects of this type by PHID.

If you can not build a single query which satisfies this requirement, you can provide a dummy implementation for this method and overload loadObjects() instead.

PhabricatorCalendarImportPHIDType
This method is not documented.
Parameters
PhabricatorObjectQuery$queryQuery being executed.
list<phid>$phidsPHIDs to load.
Return
PhabricatorPolicyAwareQueryQuery object which loads the specified PHIDs when executed.

public function loadObjects($query, $phids)
Inherited

PhabricatorPHIDType

Load objects of this type, by PHID. For most PHID types, it is only necessary to implement buildQueryForObjects() to get object loading to work.

Parameters
PhabricatorObjectQuery$queryQuery being executed.
list<phid>$phidsPHIDs to load.
Return
list<wild>Corresponding objects.

public function loadHandles($query, $handles, $objects)

PhabricatorPHIDType

Populate provided handles with application-specific data, like titles and URIs.

NOTE: The $handles and $objects lists are guaranteed to be nonempty and have the same keys: subclasses are expected to load information only for handles with visible objects.

Because of this guarantee, a safe implementation will typically look like*

foreach ($handles as $phid => $handle) {
  $object = $objects[$phid];

  $handle->setStuff($object->getStuff());
  // ...
}

In general, an implementation should call setName() and setURI() on each handle at a minimum. See PhabricatorObjectHandle for other handle properties.

PhabricatorCalendarImportPHIDType
This method is not documented.
Parameters
PhabricatorHandleQuery$queryIssuing query object.
list<PhabricatorObjectHandle>$handlesHandles to populate with data.
list<Object>$objectsObjects for these PHIDs loaded by @{method:buildQueryForObjects()}.
Return
void

public function canLoadNamedObject($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function loadNamedObjects($query, $names)
Inherited

This method is not documented.
Parameters
PhabricatorObjectQuery$query
array$names
Return
wild

final public static function getAllTypes()
Inherited

PhabricatorPHIDType

Get all known PHID types.

To get PHID types a given user has access to, see getAllInstalledTypes().

Return
dict<string, PhabricatorPHIDType>Map of type constants to types.

final public static function getTypes($types)
Inherited

This method is not documented.
Parameters
array$types
Return
wild

private static function newClassMapQuery()
Inherited

This method is not documented.
Return
wild

public static function getAllInstalledTypes($viewer)
Inherited

PhabricatorPHIDType

Get all PHID types of applications installed for a given viewer.

Parameters
PhabricatorUser$viewerViewing user.
Return
dict<string, PhabricatorPHIDType>Map of constants to installed types.

public static function getAllTypesForApplication($application)
Inherited

PhabricatorPHIDType

Get all PHID types of an application.

Parameters
string$applicationClass name of an application
Return
dict<string, PhabricatorPHIDType>Map of constants of application