UnpublishFileMutationCreator deprecated
class UnpublishFileMutationCreator extends PublicationMutationCreator implements i18nEntityProvider (View source)
deprecated
Properties
| protected | string | $name | ||
| protected | string | $description | ||
| protected | array | $warningMessages | from PublicationMutationCreator |
Methods
Details
array
__construct(Manager $manager = null)
No description
attributes()
No description
Type
type()
No description
array
args()
No description
array
resolve(mixed $object, array $args, mixed $context, ResolveInfo $info)
No description
protected
addWarningMessage($msg)
No description
protected string
sourceStage()
The stage that the file should be fetched from before mutation
array
provideI18nEntities()
Returns the list of provided translations for this object.
Note: Pluralised forms are always returned in array format.
Example usage:
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [];
foreach($this->config()->get('my_static_array') as $key => $value) {
$entities["MyTestClass.my_static_array_{$key}"] = $value;
}
$entities["MyTestClass.PLURALS"] = [
'one' => 'A test class',
'other' => '{count} test classes',
]
return $entities;
}
}Example usage in DataObject->provideI18nEntities().
You can ask textcollector to add the provided entity to a different module. Simply wrap the returned value for any item in an array with the format: [ 'default' => $defaultValue, 'module' => $module ]
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [
'MyOtherModuleClass.MYENTITY' => [
'default' => $value,
'module' => 'myothermodule',
]
];
}
return $entities;
}
protected int
countLiveOwners(File $file)
Count number of live owners this file uses